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.5\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2010-11-12 22:55+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:1224 ../src/guestfs.pod:1229 ../src/guestfs.pod:1233 ../src/guestfs.pod:1449 ../src/guestfs.pod:1454 ../src/guestfs.pod:1458 ../src/guestfs.pod:1560 ../src/guestfs.pod:1564 ../src/guestfs.pod:1568 ../src/guestfs.pod:1573 ../src/guestfs.pod:1581 ../src/guestfs.pod:1600 ../src/guestfs.pod:1608 ../src/guestfs.pod:1838 ../src/guestfs.pod:1844 ../src/guestfs.pod:1849 ../src/guestfs.pod:1855 ../src/guestfs.pod:1962 ../src/guestfs.pod:1966 ../src/guestfs.pod:1970 ../src/guestfs.pod:1974 ../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:550 ../inspector/virt-inspector.pl:554 ../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."
825 #: ../src/guestfs.pod:411
827 "The two main API calls to run commands are L</guestfs_command> and "
828 "L</guestfs_sh> (there are also variations)."
832 #: ../src/guestfs.pod:414
834 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
835 "shell globs, redirections, etc will work."
839 #: ../src/guestfs.pod:417
840 msgid "CONFIGURATION FILES"
844 #: ../src/guestfs.pod:419
846 "To read and write configuration files in Linux guest filesystems, we "
847 "strongly recommend using Augeas. For example, Augeas understands how to "
848 "read and write, say, a Linux shadow password file or X.org configuration "
849 "file, and so avoids you having to write that code."
853 #: ../src/guestfs.pod:424
855 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
856 "document Augeas itself here because there is excellent documentation on the "
857 "L<http://augeas.net/> website."
861 #: ../src/guestfs.pod:428
863 "If you don't want to use Augeas (you fool!) then try calling "
864 "L</guestfs_read_lines> to get the file as a list of lines which you can "
869 #: ../src/guestfs.pod:432
874 #: ../src/guestfs.pod:434
876 "We support SELinux guests. To ensure that labeling happens correctly in "
877 "SELinux guests, you need to enable SELinux and load the guest's policy:"
881 #: ../src/guestfs.pod:440 ../src/guestfs.pod:953
886 #: ../src/guestfs.pod:442
887 msgid "Before launching, do:"
891 #: ../src/guestfs.pod:444
894 " guestfs_set_selinux (g, 1);\n"
899 #: ../src/guestfs.pod:446 ../src/guestfs.pod:957
904 #: ../src/guestfs.pod:448
906 "After mounting the guest's filesystem(s), load the policy. This is best "
907 "done by running the L<load_policy(8)> command in the guest itself:"
911 #: ../src/guestfs.pod:452
914 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
919 #: ../src/guestfs.pod:454
921 "(Older versions of C<load_policy> require you to specify the name of the "
926 #: ../src/guestfs.pod:457 ../src/guestfs.pod:963
931 #: ../src/guestfs.pod:459
933 "Optionally, set the security context for the API. The correct security "
934 "context to use can only be known by inspecting the guest. As an example:"
938 #: ../src/guestfs.pod:463
941 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
946 #: ../src/guestfs.pod:467
947 msgid "This will work for running commands and editing existing files."
951 #: ../src/guestfs.pod:469
953 "When new files are created, you may need to label them explicitly, for "
954 "example by running the external command C<restorecon pathname>."
958 #: ../src/guestfs.pod:473
963 #: ../src/guestfs.pod:475
965 "Certain calls are affected by the current file mode creation mask (the "
966 "\"umask\"). In particular ones which create files or directories, such as "
967 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
968 "either the default mode that the file is created with or modifies the mode "
973 #: ../src/guestfs.pod:481
975 "The default umask is C<022>, so files are created with modes such as C<0644> "
976 "and directories with C<0755>."
980 #: ../src/guestfs.pod:484
982 "There are two ways to avoid being affected by umask. Either set umask to 0 "
983 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
984 "L</guestfs_chmod> after creating each file or directory."
988 #: ../src/guestfs.pod:488
989 msgid "For more information about umask, see L<umask(2)>."
993 #: ../src/guestfs.pod:490 ../fish/guestfish.pod:669
994 msgid "ENCRYPTED DISKS"
998 #: ../src/guestfs.pod:492
1000 "Libguestfs allows you to access Linux guests which have been encrypted using "
1001 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1002 "standard. This includes nearly all whole disk encryption systems used by "
1003 "modern Linux guests."
1007 #: ../src/guestfs.pod:498
1009 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1010 "returns the string C<crypto_LUKS>)."
1014 #: ../src/guestfs.pod:501
1016 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1017 "will require the passphrase!"
1021 #: ../src/guestfs.pod:504
1023 "Opening a LUKS device creates a new device mapper device called "
1024 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1025 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
1026 "decrypted from and encrypted to the underlying block device respectively."
1030 #: ../src/guestfs.pod:510
1032 "LVM volume groups on the device can be made visible by calling "
1033 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
1034 "volume(s) can now be mounted in the usual way."
1038 #: ../src/guestfs.pod:514
1040 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1041 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1042 "[\"/dev/VG\"])>. Then close the mapper device by calling "
1043 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1044 "underlying encrypted block device)."
1048 #: ../src/guestfs.pod:521
1053 #: ../src/guestfs.pod:523
1055 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1056 "contains operating systems. (These APIs used to be in a separate Perl-only "
1057 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1058 "frequently used part of this library has been rewritten in C and moved into "
1063 #: ../src/guestfs.pod:529
1065 "Add all disks belonging to the unknown virtual machine and call "
1066 "L</guestfs_launch> in the usual way."
1070 #: ../src/guestfs.pod:532
1072 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1073 "and certain heuristics, and returns a list of operating systems that were "
1074 "found. An empty list means none were found. A single element is the root "
1075 "filesystem of the operating system. For dual- or multi-boot guests, "
1076 "multiple roots can be returned, each one corresponding to a separate "
1077 "operating system. (Multi-boot virtual machines are extremely rare in the "
1078 "world of virtualization, but since this scenario can happen, we have built "
1079 "libguestfs to deal with it.)"
1083 #: ../src/guestfs.pod:541
1085 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1086 "to get additional details about that operating system. For example, call "
1087 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1088 "Windows and Linux-based operating systems respectively."
1092 #: ../src/guestfs.pod:547
1094 "Un*x-like and Linux-based operating systems usually consist of several "
1095 "filesystems which are mounted at boot time (for example, a separate boot "
1096 "partition mounted on C</boot>). The inspection rules are able to detect how "
1097 "filesystems correspond to mount points. Call "
1098 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1099 "hash table like this example:"
1103 #: ../src/guestfs.pod:554
1106 " /boot => /dev/sda1\n"
1107 " / => /dev/vg_guest/lv_root\n"
1108 " /usr => /dev/vg_guest/lv_usr\n"
1113 #: ../src/guestfs.pod:558
1115 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1116 "filesystems as suggested."
1120 #: ../src/guestfs.pod:561
1122 "Be careful to mount filesystems in the right order (eg. C</> before "
1123 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
1128 #: ../src/guestfs.pod:565
1130 "Inspection currently only works for some common operating systems. "
1131 "Contributors are welcome to send patches for other operating systems that we "
1132 "currently cannot detect."
1136 #: ../src/guestfs.pod:569
1138 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1139 "for more details. The L</guestfs_inspect_os> function just ignores any "
1140 "encrypted devices."
1144 #: ../src/guestfs.pod:573
1146 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1147 "inspection and caches the results in the guest handle. Subsequent calls to "
1148 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
1149 "re-read the disks. If you change the content of the guest disks, you can "
1150 "redo inspection by calling L</guestfs_inspect_os> again."
1154 #: ../src/guestfs.pod:580
1155 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1159 #: ../src/guestfs.pod:582
1161 "Libguestfs can mount NTFS partitions. It does this using the "
1162 "L<http://www.ntfs-3g.org/> driver."
1166 #: ../src/guestfs.pod:585
1168 "DOS and Windows still use drive letters, and the filesystems are always "
1169 "treated as case insensitive by Windows itself, and therefore you might find "
1170 "a Windows configuration file referring to a path like "
1171 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1172 "that directory might be referred to as C</WINDOWS/System32>."
1176 #: ../src/guestfs.pod:591
1178 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1179 "libguestfs to read the appropriate Windows Registry and configuration files, "
1180 "to determine yourself how drives are mapped (see also L<hivex(3)> and "
1181 "L<virt-inspector(1)>)."
1185 #: ../src/guestfs.pod:596
1187 "Replacing backslash characters with forward slash characters is also outside "
1188 "the scope of libguestfs, but something that you can easily do."
1192 #: ../src/guestfs.pod:599
1194 "Where we can help is in resolving the case insensitivity of paths. For "
1195 "this, call L</guestfs_case_sensitive_path>."
1199 #: ../src/guestfs.pod:602
1201 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1202 "files, through the library C<hivex> which is part of the libguestfs project "
1203 "although ships as a separate tarball. You have to locate and download the "
1204 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1205 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1206 "L<virt-win-reg(1)> for more help on this issue."
1210 #: ../src/guestfs.pod:610
1211 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1215 #: ../src/guestfs.pod:612
1217 "Although we don't want to discourage you from using the C API, we will "
1218 "mention here that the same API is also available in other languages."
1222 #: ../src/guestfs.pod:615
1224 "The API is broadly identical in all supported languages. This means that "
1225 "the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, "
1226 "C<g.mount(path)> in Python, and C<Guestfs.mount g path> in OCaml. In other "
1227 "words, a straightforward, predictable isomorphism between each language."
1231 #: ../src/guestfs.pod:621
1233 "Error messages are automatically transformed into exceptions if the language "
1238 #: ../src/guestfs.pod:624
1240 "We don't try to \"object orientify\" parts of the API in OO languages, "
1241 "although contributors are welcome to write higher level APIs above what we "
1242 "provide in their favourite languages if they wish."
1246 #: ../src/guestfs.pod:630
1251 #: ../src/guestfs.pod:632
1253 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1254 "identical to the C API. C++ classes and exceptions are not used."
1258 #: ../src/guestfs.pod:636
1263 #: ../src/guestfs.pod:638
1265 "The C# bindings are highly experimental. Please read the warnings at the "
1266 "top of C<csharp/Libguestfs.cs>."
1270 #: ../src/guestfs.pod:641
1275 #: ../src/guestfs.pod:643
1277 "This is the only language binding that is working but incomplete. Only "
1278 "calls which return simple integers have been bound in Haskell, and we are "
1279 "looking for help to complete this binding."
1283 #: ../src/guestfs.pod:647
1288 #: ../src/guestfs.pod:649
1290 "Full documentation is contained in the Javadoc which is distributed with "
1295 #: ../src/guestfs.pod:652
1300 #: ../src/guestfs.pod:654
1301 msgid "For documentation see the file C<guestfs.mli>."
1305 #: ../src/guestfs.pod:656
1310 #: ../src/guestfs.pod:658
1311 msgid "For documentation see L<Sys::Guestfs(3)>."
1315 #: ../src/guestfs.pod:660
1320 #: ../src/guestfs.pod:662
1322 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1323 "the php-libguestfs package for your distribution."
1327 #: ../src/guestfs.pod:665
1328 msgid "The PHP binding only works correctly on 64 bit machines."
1332 #: ../src/guestfs.pod:667
1337 #: ../src/guestfs.pod:669
1338 msgid "For documentation do:"
1342 #: ../src/guestfs.pod:671
1346 " >>> import guestfs\n"
1347 " >>> help (guestfs)\n"
1352 #: ../src/guestfs.pod:675
1357 #: ../src/guestfs.pod:677
1359 "Use the Guestfs module. There is no Ruby-specific documentation, but you "
1360 "can find examples written in Ruby in the libguestfs source."
1364 #: ../src/guestfs.pod:680
1365 msgid "B<shell scripts>"
1369 #: ../src/guestfs.pod:682
1370 msgid "For documentation see L<guestfish(1)>."
1374 #: ../src/guestfs.pod:686
1375 msgid "LIBGUESTFS GOTCHAS"
1379 #: ../src/guestfs.pod:688
1381 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1382 "system [...] that works in the way it is documented but is counterintuitive "
1383 "and almost invites mistakes.\""
1387 #: ../src/guestfs.pod:692
1389 "Since we developed libguestfs and the associated tools, there are several "
1390 "things we would have designed differently, but are now stuck with for "
1391 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1392 "release, you can expect these to change. Beware of them."
1396 #: ../src/guestfs.pod:700
1397 msgid "Autosync / forgetting to sync."
1401 #: ../src/guestfs.pod:702
1403 "When modifying a filesystem from C or another language, you B<must> unmount "
1404 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1405 "libguestfs handle. You can also call:"
1409 #: ../src/guestfs.pod:706
1412 " guestfs_set_autosync (g, 1);\n"
1417 #: ../src/guestfs.pod:708
1419 "to have the unmount/sync done automatically for you when the handle 'g' is "
1420 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1425 #: ../src/guestfs.pod:712
1427 "If you forget to do this, then it is entirely possible that your changes "
1428 "won't be written out, or will be partially written, or (very rarely) that "
1429 "you'll get disk corruption."
1433 #: ../src/guestfs.pod:716
1435 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1436 "guestfish scripts that forget to sync will work just fine, which can make "
1437 "this very puzzling if you are trying to debug a problem."
1441 #: ../src/guestfs.pod:720
1443 "Update: Autosync is enabled by default for all API users starting from "
1444 "libguestfs 1.5.24."
1448 #: ../src/guestfs.pod:723
1449 msgid "Mount option C<-o sync> should not be the default."
1453 #: ../src/guestfs.pod:725
1455 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1456 "However C<-o sync> does not add any reliability benefit, but does have a "
1457 "very large performance impact."
1461 #: ../src/guestfs.pod:729
1463 "The work around is to use L</guestfs_mount_options> and set the mount "
1464 "options that you actually want to use."
1468 #: ../src/guestfs.pod:732
1469 msgid "Read-only should be the default."
1473 #: ../src/guestfs.pod:734
1475 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1476 "specify I<--rw> if you want to make changes to the image."
1480 #: ../src/guestfs.pod:737
1481 msgid "This would reduce the potential to corrupt live VM images."
1485 #: ../src/guestfs.pod:739
1487 "Note that many filesystems change the disk when you just mount and unmount, "
1488 "even if you didn't perform any writes. You need to use "
1489 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1493 #: ../src/guestfs.pod:743
1494 msgid "guestfish command line is hard to use."
1498 #: ../src/guestfs.pod:745
1500 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1501 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1502 "exist, so it fails. In earlier versions of guestfish the error message was "
1503 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1504 "we should have used C<guestfish -c command> to run commands."
1508 #: ../src/guestfs.pod:752
1509 msgid "guestfish megabyte modifiers don't work right on all commands"
1513 #: ../src/guestfs.pod:754
1515 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1516 "other modifiers). What guestfish actually does is to multiply the number "
1517 "part by the modifier part and pass the result to the C API. However this "
1518 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1519 "expecting some other unit (eg. megabytes)."
1523 #: ../src/guestfs.pod:761
1524 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1528 #: ../src/guestfs.pod:763
1531 " lvcreate LV VG 100M\n"
1536 #: ../src/guestfs.pod:765
1538 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1539 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1540 "megabytes * megabytes) logical volume. The error message you get from this "
1541 "is also a little obscure."
1545 #: ../src/guestfs.pod:770
1547 "This could be fixed in the generator by specially marking parameters and "
1548 "return values which take bytes or other units."
1552 #: ../src/guestfs.pod:773
1553 msgid "Ambiguity between devices and paths"
1557 #: ../src/guestfs.pod:775
1559 "There is a subtle ambiguity in the API between a device name "
1560 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1561 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1565 #: ../src/guestfs.pod:780
1567 "In the current API we usually resolve this ambiguity by having two separate "
1568 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1569 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1570 "detecting if the path supplied begins with C</dev/>."
1574 #: ../src/guestfs.pod:786
1576 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1577 "make paths/devices into structured names. One way to do this would be to "
1578 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1579 "aspect of grub. Another way would be to use a structured type, equivalent "
1580 "to this OCaml type:"
1584 #: ../src/guestfs.pod:792
1587 " type path = Path of string | Device of int | Partition of int * int\n"
1592 #: ../src/guestfs.pod:794
1593 msgid "which would allow you to pass arguments like:"
1597 #: ../src/guestfs.pod:796
1600 " Path \"/foo/bar\"\n"
1601 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1602 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1603 " Path \"/dev/sdb2\" (* not a device *)\n"
1608 #: ../src/guestfs.pod:801
1610 "As you can see there are still problems to resolve even with this "
1611 "representation. Also consider how it might work in guestfish."
1615 #: ../src/guestfs.pod:806
1616 msgid "PROTOCOL LIMITS"
1620 #: ../src/guestfs.pod:808
1622 "Internally libguestfs uses a message-based protocol to pass API calls and "
1623 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1624 "plenty more detail about this). The maximum message size used by the "
1625 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1626 "aware of this limit. The API calls which may be affected are individually "
1627 "documented, with a link back to this section of the documentation."
1631 #: ../src/guestfs.pod:816
1633 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1634 "a simple string. Because this string is at some point internally encoded as "
1635 "a message, the maximum size that it can return is slightly under 4 MB. If "
1636 "the requested file is larger than this then you will get an error."
1640 #: ../src/guestfs.pod:822
1642 "In order to transfer large files into and out of the guest filesystem, you "
1643 "need to use particular calls that support this. The sections L</UPLOADING> "
1644 "and L</DOWNLOADING> document how to do this."
1648 #: ../src/guestfs.pod:826
1650 "You might also consider mounting the disk image using our FUSE filesystem "
1651 "support (L<guestmount(1)>)."
1655 #: ../src/guestfs.pod:829
1656 msgid "KEYS AND PASSPHRASES"
1660 #: ../src/guestfs.pod:831
1662 "Certain libguestfs calls take a parameter that contains sensitive key "
1663 "material, passed in as a C string."
1667 #: ../src/guestfs.pod:834
1669 "In the future we would hope to change the libguestfs implementation so that "
1670 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1671 "swap. However this is I<not> done at the moment, because of the complexity "
1672 "of such an implementation."
1676 #: ../src/guestfs.pod:839
1678 "Therefore you should be aware that any key parameter you pass to libguestfs "
1679 "might end up being written out to the swap partition. If this is a concern, "
1680 "scrub the swap partition or don't use libguestfs on encrypted devices."
1684 #: ../src/guestfs.pod:844
1685 msgid "CONNECTION MANAGEMENT"
1689 #: ../src/guestfs.pod:846
1694 #: ../src/guestfs.pod:848
1696 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
1697 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
1698 "handle and release all resources used."
1702 #: ../src/guestfs.pod:852
1704 "For information on using multiple handles and threads, see the section "
1705 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
1709 #: ../src/guestfs.pod:855
1710 msgid "guestfs_create"
1714 #: ../src/guestfs.pod:857
1717 " guestfs_h *guestfs_create (void);\n"
1722 #: ../src/guestfs.pod:859
1723 msgid "Create a connection handle."
1727 #: ../src/guestfs.pod:861
1729 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
1730 "on the handle at least once."
1734 #: ../src/guestfs.pod:864
1736 "This function returns a non-NULL pointer to a handle on success or NULL on "
1741 #: ../src/guestfs.pod:867
1742 msgid "After configuring the handle, you have to call L</guestfs_launch>."
1746 #: ../src/guestfs.pod:869
1748 "You may also want to configure error handling for the handle. See L</ERROR "
1749 "HANDLING> section below."
1753 #: ../src/guestfs.pod:872
1754 msgid "guestfs_close"
1758 #: ../src/guestfs.pod:874
1761 " void guestfs_close (guestfs_h *g);\n"
1766 #: ../src/guestfs.pod:876
1767 msgid "This closes the connection handle and frees up all resources used."
1771 #: ../src/guestfs.pod:878
1772 msgid "ERROR HANDLING"
1776 #: ../src/guestfs.pod:880
1778 "API functions can return errors. For example, almost all functions that "
1779 "return C<int> will return C<-1> to indicate an error."
1783 #: ../src/guestfs.pod:883
1785 "Additional information is available for errors: an error message string and "
1786 "optionally an error number (errno) if the thing that failed was a system "
1791 #: ../src/guestfs.pod:887
1793 "You can get at the additional information about the last error on the handle "
1794 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
1795 "up an error handler with L</guestfs_set_error_handler>."
1799 #: ../src/guestfs.pod:892
1801 "When the handle is created, a default error handler is installed which "
1802 "prints the error message string to C<stderr>. For small short-running "
1803 "command line programs it is sufficient to do:"
1807 #: ../src/guestfs.pod:896
1810 " if (guestfs_launch (g) == -1)\n"
1811 " exit (EXIT_FAILURE);\n"
1816 #: ../src/guestfs.pod:899
1818 "since the default error handler will ensure that an error message has been "
1819 "printed to C<stderr> before the program exits."
1823 #: ../src/guestfs.pod:902
1825 "For other programs the caller will almost certainly want to install an "
1826 "alternate error handler or do error handling in-line like this:"
1830 #: ../src/guestfs.pod:905
1833 " g = guestfs_create ();\n"
1838 #: ../src/guestfs.pod:907
1841 " /* This disables the default behaviour of printing errors\n"
1843 " guestfs_set_error_handler (g, NULL, NULL);\n"
1848 #: ../src/guestfs.pod:911
1851 " if (guestfs_launch (g) == -1) {\n"
1852 " /* Examine the error message and print it etc. */\n"
1853 " char *msg = guestfs_last_error (g);\n"
1854 " int errnum = guestfs_last_errno (g);\n"
1855 " fprintf (stderr, \"%s\\n\", msg);\n"
1862 #: ../src/guestfs.pod:919
1864 "Out of memory errors are handled differently. The default action is to call "
1865 "L<abort(3)>. If this is undesirable, then you can set a handler using "
1866 "L</guestfs_set_out_of_memory_handler>."
1870 #: ../src/guestfs.pod:923
1872 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
1873 "because there is no handle if this happens there is no way to get additional "
1874 "error information. However L</guestfs_create> is supposed to be a "
1875 "lightweight operation which can only fail because of insufficient memory (it "
1876 "returns NULL in this case)."
1880 #: ../src/guestfs.pod:929
1881 msgid "guestfs_last_error"
1885 #: ../src/guestfs.pod:931
1888 " const char *guestfs_last_error (guestfs_h *g);\n"
1893 #: ../src/guestfs.pod:933
1895 "This returns the last error message that happened on C<g>. If there has not "
1896 "been an error since the handle was created, then this returns C<NULL>."
1900 #: ../src/guestfs.pod:937
1902 "The lifetime of the returned string is until the next error occurs, or "
1903 "L</guestfs_close> is called."
1907 #: ../src/guestfs.pod:940
1908 msgid "guestfs_last_errno"
1912 #: ../src/guestfs.pod:942
1915 " int guestfs_last_errno (guestfs_h *g);\n"
1920 #: ../src/guestfs.pod:944
1921 msgid "This returns the last error number (errno) that happened on C<g>."
1925 #: ../src/guestfs.pod:946
1926 msgid "If successful, an errno integer not equal to zero is returned."
1930 #: ../src/guestfs.pod:948
1931 msgid "If no error, this returns 0. This call can return 0 in three situations:"
1935 #: ../src/guestfs.pod:955
1936 msgid "There has not been any error on the handle."
1940 #: ../src/guestfs.pod:959
1942 "There has been an error but the errno was meaningless. This corresponds to "
1943 "the case where the error did not come from a failed system call, but for "
1944 "some other reason."
1948 #: ../src/guestfs.pod:965
1950 "There was an error from a failed system call, but for some reason the errno "
1951 "was not captured and returned. This usually indicates a bug in libguestfs."
1955 #: ../src/guestfs.pod:971
1957 "Libguestfs tries to convert the errno from inside the applicance into a "
1958 "corresponding errno for the caller (not entirely trivial: the appliance "
1959 "might be running a completely different operating system from the library "
1960 "and error numbers are not standardized across Un*xen). If this could not be "
1961 "done, then the error is translated to C<EINVAL>. In practice this should "
1962 "only happen in very rare circumstances."
1966 #: ../src/guestfs.pod:979
1967 msgid "guestfs_set_error_handler"
1971 #: ../src/guestfs.pod:981
1974 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
1976 " const char *msg);\n"
1977 " void guestfs_set_error_handler (guestfs_h *g,\n"
1978 " guestfs_error_handler_cb cb,\n"
1984 #: ../src/guestfs.pod:988
1986 "The callback C<cb> will be called if there is an error. The parameters "
1987 "passed to the callback are an opaque data pointer and the error message "
1992 #: ../src/guestfs.pod:992
1994 "C<errno> is not passed to the callback. To get that the callback must call "
1995 "L</guestfs_last_errno>."
1999 #: ../src/guestfs.pod:995
2001 "Note that the message string C<msg> is freed as soon as the callback "
2002 "function returns, so if you want to stash it somewhere you must make your "
2007 #: ../src/guestfs.pod:999
2008 msgid "The default handler prints messages on C<stderr>."
2012 #: ../src/guestfs.pod:1001
2013 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2017 #: ../src/guestfs.pod:1003
2018 msgid "guestfs_get_error_handler"
2022 #: ../src/guestfs.pod:1005
2025 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2026 " void **opaque_rtn);\n"
2031 #: ../src/guestfs.pod:1008
2032 msgid "Returns the current error handler callback."
2036 #: ../src/guestfs.pod:1010
2037 msgid "guestfs_set_out_of_memory_handler"
2041 #: ../src/guestfs.pod:1012
2044 " typedef void (*guestfs_abort_cb) (void);\n"
2045 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2046 " guestfs_abort_cb);\n"
2051 #: ../src/guestfs.pod:1016
2053 "The callback C<cb> will be called if there is an out of memory situation. "
2054 "I<Note this callback must not return>."
2058 #: ../src/guestfs.pod:1019
2059 msgid "The default is to call L<abort(3)>."
2063 #: ../src/guestfs.pod:1021
2064 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2068 #: ../src/guestfs.pod:1024
2069 msgid "guestfs_get_out_of_memory_handler"
2073 #: ../src/guestfs.pod:1026
2076 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2081 #: ../src/guestfs.pod:1028
2082 msgid "This returns the current out of memory handler."
2086 #: ../src/guestfs.pod:1030
2091 #: ../src/guestfs.pod:1032
2093 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
2098 #: ../src/guestfs.pod:1035
2100 "By default it looks for these in the directory C<$libdir/guestfs> "
2101 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2105 #: ../src/guestfs.pod:1038
2107 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2108 "to change the directories that libguestfs will search in. The value is a "
2109 "colon-separated list of paths. The current directory is I<not> searched "
2110 "unless the path contains an empty element or C<.>. For example "
2111 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2112 "then C</usr/lib/guestfs>."
2116 #: ../src/guestfs.pod:1045
2117 msgid "HIGH-LEVEL API ACTIONS"
2121 #: ../src/guestfs.pod:1047
2122 msgid "ABI GUARANTEE"
2126 #: ../src/guestfs.pod:1049
2128 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2129 "actions as outlined in this section. Although we will deprecate some "
2130 "actions, for example if they get replaced by newer calls, we will keep the "
2131 "old actions forever. This allows you the developer to program in confidence "
2132 "against the libguestfs API."
2136 #: ../src/guestfs.pod:1055 ../fish/guestfish.pod:907
2141 #: ../src/guestfs.pod:1057
2146 #: ../src/guestfs.pod:1059
2151 #: ../src/guestfs.pod:1061
2152 msgid "AVAILABILITY"
2156 #: ../src/guestfs.pod:1063
2157 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2161 #: ../src/guestfs.pod:1065
2163 "Using L</guestfs_available> you can test availability of the following "
2164 "groups of functions. This test queries the appliance to see if the "
2165 "appliance you are currently using supports the functionality."
2169 #: ../src/guestfs.pod:1070
2170 msgid "@AVAILABILITY@"
2174 #: ../src/guestfs.pod:1072
2175 msgid "GUESTFISH supported COMMAND"
2179 #: ../src/guestfs.pod:1074
2181 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2182 "prints out the available groups and whether they are supported by this build "
2183 "of libguestfs. Note however that you have to do C<run> first."
2187 #: ../src/guestfs.pod:1079
2188 msgid "SINGLE CALLS AT COMPILE TIME"
2192 #: ../src/guestfs.pod:1081
2194 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2195 "function, such as:"
2199 #: ../src/guestfs.pod:1084
2202 " #define LIBGUESTFS_HAVE_DD 1\n"
2207 #: ../src/guestfs.pod:1086
2208 msgid "if L</guestfs_dd> is available."
2212 #: ../src/guestfs.pod:1088
2214 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2215 "function is available at compile time, we recommended using build tools such "
2216 "as autoconf or cmake. For example in autotools you could use:"
2220 #: ../src/guestfs.pod:1093
2223 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2224 " AC_CHECK_FUNCS([guestfs_dd])\n"
2229 #: ../src/guestfs.pod:1096
2231 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2236 #: ../src/guestfs.pod:1099
2237 msgid "SINGLE CALLS AT RUN TIME"
2241 #: ../src/guestfs.pod:1101
2243 "Testing at compile time doesn't guarantee that a function really exists in "
2244 "the library. The reason is that you might be dynamically linked against a "
2245 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2246 "This situation unfortunately results in a segmentation fault, which is a "
2247 "shortcoming of the C dynamic linking system itself."
2251 #: ../src/guestfs.pod:1108
2253 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2254 "in this example program (note that you still need the compile time check as "
2259 #: ../src/guestfs.pod:1112
2262 " #include <stdio.h>\n"
2263 " #include <stdlib.h>\n"
2264 " #include <unistd.h>\n"
2265 " #include <dlfcn.h>\n"
2266 " #include <guestfs.h>\n"
2271 #: ../src/guestfs.pod:1118
2276 " #ifdef LIBGUESTFS_HAVE_DD\n"
2278 " int has_function;\n"
2283 #: ../src/guestfs.pod:1124
2286 " /* Test if the function guestfs_dd is really available. */\n"
2287 " dl = dlopen (NULL, RTLD_LAZY);\n"
2289 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2290 " exit (EXIT_FAILURE);\n"
2292 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2298 #: ../src/guestfs.pod:1133
2301 " if (!has_function)\n"
2302 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2304 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2305 " /* Now it's safe to call\n"
2306 " guestfs_dd (g, \"foo\", \"bar\");\n"
2310 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2317 #: ../src/guestfs.pod:1146
2319 "You may think the above is an awful lot of hassle, and it is. There are "
2320 "other ways outside of the C linking system to ensure that this kind of "
2321 "incompatibility never arises, such as using package versioning:"
2325 #: ../src/guestfs.pod:1151
2328 " Requires: libguestfs >= 1.0.80\n"
2333 #: ../src/guestfs.pod:1153
2334 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2338 #: ../src/guestfs.pod:1155
2340 "A recent feature of the API is the introduction of calls which take optional "
2341 "arguments. In C these are declared 3 ways. The main way is as a call which "
2342 "takes variable arguments (ie. C<...>), as in this example:"
2346 #: ../src/guestfs.pod:1160
2349 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2354 #: ../src/guestfs.pod:1162
2356 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2357 "call with no optional arguments specified:"
2361 #: ../src/guestfs.pod:1165
2364 " guestfs_add_drive_opts (g, filename, -1);\n"
2369 #: ../src/guestfs.pod:1167
2370 msgid "With a single optional argument:"
2374 #: ../src/guestfs.pod:1169
2377 " guestfs_add_drive_opts (g, filename,\n"
2378 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2384 #: ../src/guestfs.pod:1173
2389 #: ../src/guestfs.pod:1175
2392 " guestfs_add_drive_opts (g, filename,\n"
2393 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2394 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
2400 #: ../src/guestfs.pod:1180
2402 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
2407 #: ../src/guestfs.pod:1183
2408 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
2412 #: ../src/guestfs.pod:1185
2414 "The second variant has the same name with the suffix C<_va>, which works the "
2415 "same way but takes a C<va_list>. See the C manual for details. For the "
2416 "example function, this is declared:"
2420 #: ../src/guestfs.pod:1189
2423 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
2429 #: ../src/guestfs.pod:1192
2430 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
2434 #: ../src/guestfs.pod:1194
2436 "The third variant is useful where you need to construct these calls. You "
2437 "pass in a structure where you fill in the optional fields. The structure "
2438 "has a bitmask as the first element which you must set to indicate which "
2439 "fields you have filled in. For our example function the structure and call "
2444 #: ../src/guestfs.pod:1200
2447 " struct guestfs_add_drive_opts_argv {\n"
2448 " uint64_t bitmask;\n"
2450 " const char *format;\n"
2453 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
2454 " const struct guestfs_add_drive_opts_argv *optargs);\n"
2459 #: ../src/guestfs.pod:1209
2460 msgid "You could call it like this:"
2464 #: ../src/guestfs.pod:1211
2467 " struct guestfs_add_drive_opts_argv optargs = {\n"
2468 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
2469 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
2471 " .format = \"qcow2\"\n"
2477 #: ../src/guestfs.pod:1218
2480 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
2485 #: ../src/guestfs.pod:1220 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1255
2490 #: ../src/guestfs.pod:1226
2491 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
2495 #: ../src/guestfs.pod:1231
2496 msgid "You do not need to fill in all fields of the structure."
2500 #: ../src/guestfs.pod:1235
2502 "There must be a one-to-one correspondence between fields of the structure "
2503 "that are filled in, and bits set in the bitmask."
2507 #: ../src/guestfs.pod:1240
2508 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
2512 #: ../src/guestfs.pod:1242
2514 "In other languages, optional arguments are expressed in the way that is "
2515 "natural for that language. We refer you to the language-specific "
2516 "documentation for more details on that."
2520 #: ../src/guestfs.pod:1246
2521 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
2525 #: ../src/guestfs.pod:1248 ../src/guestfs.pod:1253
2530 #: ../src/guestfs.pod:1250
2532 "<!-- old anchor for the next section --> <a "
2533 "name=\"state_machine_and_low_level_event_api\"/>"
2537 #: ../src/guestfs.pod:1255
2538 msgid "ARCHITECTURE"
2542 #: ../src/guestfs.pod:1257
2544 "Internally, libguestfs is implemented by running an appliance (a special "
2545 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
2546 "process of the main program."
2550 #: ../src/guestfs.pod:1261
2553 " ___________________\n"
2555 " | main program |\n"
2557 " | | child process / appliance\n"
2558 " | | __________________________\n"
2560 " +-------------------+ RPC | +-----------------+ |\n"
2561 " | libguestfs <--------------------> guestfsd | |\n"
2562 " | | | +-----------------+ |\n"
2563 " \\___________________/ | | Linux kernel | |\n"
2564 " | +--^--------------+ |\n"
2565 " \\_________|________________/\n"
2571 " \\______________/\n"
2576 #: ../src/guestfs.pod:1281
2578 "The library, linked to the main program, creates the child process and hence "
2579 "the appliance in the L</guestfs_launch> function."
2583 #: ../src/guestfs.pod:1284
2585 "Inside the appliance is a Linux kernel and a complete stack of userspace "
2586 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
2587 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
2588 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
2589 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
2590 "attached to the qemu process which translates device access by the "
2591 "appliance's Linux kernel into accesses to the image."
2595 #: ../src/guestfs.pod:1293
2597 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
2598 "Although the disk image you are attached to might also be used by some "
2599 "virtual machine, libguestfs doesn't know or care about this. (But you will "
2600 "care if both libguestfs's qemu process and your virtual machine are trying "
2601 "to update the disk image at the same time, since these usually results in "
2602 "massive disk corruption)."
2606 #: ../src/guestfs.pod:1300
2607 msgid "STATE MACHINE"
2611 #: ../src/guestfs.pod:1302
2612 msgid "libguestfs uses a state machine to model the child process:"
2616 #: ../src/guestfs.pod:1304
2628 " / | \\ \\ guestfs_launch\n"
2629 " / | _\\__V______\n"
2631 " / | | LAUNCHING |\n"
2632 " / | \\___________/\n"
2634 " / | guestfs_launch\n"
2636 " ______ / __|____V\n"
2637 " / \\ ------> / \\\n"
2638 " | BUSY | | READY |\n"
2639 " \\______/ <------ \\________/\n"
2644 #: ../src/guestfs.pod:1326
2646 "The normal transitions are (1) CONFIG (when the handle is created, but there "
2647 "is no child process), (2) LAUNCHING (when the child process is booting up), "
2648 "(3) alternating between READY and BUSY as commands are issued to, and "
2649 "carried out by, the child process."
2653 #: ../src/guestfs.pod:1331
2655 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
2656 "asynchronously at any time (eg. due to some internal error), and that causes "
2657 "the state to transition back to CONFIG."
2661 #: ../src/guestfs.pod:1335
2663 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
2664 "issued when in the CONFIG state."
2668 #: ../src/guestfs.pod:1338
2670 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
2671 "L</guestfs_launch> blocks until the child process is READY to accept "
2672 "commands (or until some failure or timeout). L</guestfs_launch> internally "
2673 "moves the state from CONFIG to LAUNCHING while it is running."
2677 #: ../src/guestfs.pod:1344
2679 "API actions such as L</guestfs_mount> can only be issued when in the READY "
2680 "state. These API calls block waiting for the command to be carried out "
2681 "(ie. the state to transition to BUSY and then back to READY). There are no "
2682 "non-blocking versions, and no way to issue more than one command per handle "
2687 #: ../src/guestfs.pod:1350
2689 "Finally, the child process sends asynchronous messages back to the main "
2690 "program, such as kernel log messages. You can register a callback to "
2691 "receive these messages."
2695 #: ../src/guestfs.pod:1354
2696 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
2700 #: ../src/guestfs.pod:1356
2702 "The child process generates events in some situations. Current events "
2703 "include: receiving a log message, the child process exits."
2707 #: ../src/guestfs.pod:1359
2709 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
2714 #: ../src/guestfs.pod:1362
2716 "Only I<one callback of each type> can be registered for each handle. "
2717 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
2718 "that type. Cancel all callbacks of this type by calling this function with "
2719 "C<cb> set to C<NULL>."
2723 #: ../src/guestfs.pod:1367
2724 msgid "guestfs_set_log_message_callback"
2728 #: ../src/guestfs.pod:1369
2731 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
2732 " char *buf, int len);\n"
2733 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
2734 " guestfs_log_message_cb cb,\n"
2740 #: ../src/guestfs.pod:1375
2742 "The callback function C<cb> will be called whenever qemu or the guest writes "
2743 "anything to the console."
2747 #: ../src/guestfs.pod:1378
2748 msgid "Use this function to capture kernel messages and similar."
2752 #: ../src/guestfs.pod:1380
2754 "Normally there is no log message handler, and log messages are just "
2759 #: ../src/guestfs.pod:1383
2760 msgid "guestfs_set_subprocess_quit_callback"
2764 #: ../src/guestfs.pod:1385
2767 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
2768 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
2769 " guestfs_subprocess_quit_cb cb,\n"
2775 #: ../src/guestfs.pod:1390
2777 "The callback function C<cb> will be called when the child process quits, "
2778 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
2779 "corresponds to a transition from any state to the CONFIG state)."
2783 #: ../src/guestfs.pod:1395
2784 msgid "guestfs_set_launch_done_callback"
2788 #: ../src/guestfs.pod:1397
2791 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
2792 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
2793 " guestfs_launch_done_cb cb,\n"
2799 #: ../src/guestfs.pod:1402
2801 "The callback function C<cb> will be called when the child process becomes "
2802 "ready first time after it has been launched. (This corresponds to a "
2803 "transition from LAUNCHING to the READY state)."
2807 #: ../src/guestfs.pod:1406
2808 msgid "guestfs_set_close_callback"
2812 #: ../src/guestfs.pod:1408
2815 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
2816 " void guestfs_set_close_callback (guestfs_h *g,\n"
2817 " guestfs_close_cb cb,\n"
2823 #: ../src/guestfs.pod:1413
2825 "The callback function C<cb> will be called while the handle is being closed "
2826 "(synchronously from L</guestfs_close>)."
2830 #: ../src/guestfs.pod:1416
2832 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
2833 "handles that are open when the program exits. This means that this callback "
2834 "might be called indirectly from L<exit(3)>, which can cause unexpected "
2835 "problems in higher-level languages (eg. if your HLL interpreter has already "
2836 "been cleaned up by the time this is called, and if your callback then jumps "
2837 "into some HLL function)."
2841 #: ../src/guestfs.pod:1424
2842 msgid "guestfs_set_progress_callback"
2846 #: ../src/guestfs.pod:1426
2849 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
2850 " int proc_nr, int serial,\n"
2851 " uint64_t position, uint64_t total);\n"
2852 " void guestfs_set_progress_callback (guestfs_h *g,\n"
2853 " guestfs_progress_cb cb,\n"
2859 #: ../src/guestfs.pod:1433
2861 "Some long-running operations can generate progress messages. If this "
2862 "callback is registered, then it will be called each time a progress message "
2863 "is generated (usually two seconds after the operation started, and three "
2864 "times per second thereafter until it completes, although the frequency may "
2865 "change in future versions)."
2869 #: ../src/guestfs.pod:1439
2871 "The callback receives two numbers: C<position> and C<total>. The units of "
2872 "C<total> are not defined, although for some operations C<total> may relate "
2873 "in some way to the amount of data to be transferred (eg. in bytes or "
2874 "megabytes), and C<position> may be the portion which has been transferred."
2878 #: ../src/guestfs.pod:1445
2879 msgid "The only defined and stable parts of the API are:"
2883 #: ../src/guestfs.pod:1451
2885 "The callback can display to the user some type of progress bar or indicator "
2886 "which shows the ratio of C<position>:C<total>."
2890 #: ../src/guestfs.pod:1456
2891 msgid "0 E<lt>= C<position> E<lt>= C<total>"
2895 #: ../src/guestfs.pod:1460
2897 "If any progress notification is sent during a call, then a final progress "
2898 "notification is always sent when C<position> = C<total>."
2902 #: ../src/guestfs.pod:1463
2904 "This is to simplify caller code, so callers can easily set the progress "
2905 "indicator to \"100%\" at the end of the operation, without requiring special "
2906 "code to detect this case."
2910 #: ../src/guestfs.pod:1469
2912 "The callback also receives the procedure number and serial number of the "
2913 "call. These are only useful for debugging protocol issues, and the callback "
2914 "can normally ignore them. The callback may want to print these numbers in "
2915 "error messages or debugging messages."
2919 #: ../src/guestfs.pod:1474
2920 msgid "PRIVATE DATA AREA"
2924 #: ../src/guestfs.pod:1476
2926 "You can attach named pieces of private data to the libguestfs handle, and "
2927 "fetch them by name for the lifetime of the handle. This is called the "
2928 "private data area and is only available from the C API."
2932 #: ../src/guestfs.pod:1480
2933 msgid "To attach a named piece of data, use the following call:"
2937 #: ../src/guestfs.pod:1482
2940 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
2945 #: ../src/guestfs.pod:1484
2947 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
2948 "pointer (which can be C<NULL>). Any previous item with the same name is "
2953 #: ../src/guestfs.pod:1488
2955 "You can use any C<key> you want, but names beginning with an underscore "
2956 "character are reserved for internal libguestfs purposes (for implementing "
2957 "language bindings). It is recommended to prefix the name with some unique "
2958 "string to avoid collisions with other users."
2962 #: ../src/guestfs.pod:1493
2963 msgid "To retrieve the pointer, use:"
2967 #: ../src/guestfs.pod:1495
2970 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
2975 #: ../src/guestfs.pod:1497
2977 "This function returns C<NULL> if either no data is found associated with "
2978 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
2983 #: ../src/guestfs.pod:1501
2985 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
2986 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
2987 "all. In particular, libguestfs does I<not> try to free the data when the "
2988 "handle is closed. If the data must be freed, then the caller must either "
2989 "free it before calling L</guestfs_close> or must set up a close callback to "
2990 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
2991 "can be registered for a handle)."
2995 #: ../src/guestfs.pod:1509
2997 "The private data area is implemented using a hash table, and should be "
2998 "reasonably efficient for moderate numbers of keys."
3002 #: ../src/guestfs.pod:1512
3003 msgid "BLOCK DEVICE NAMING"
3007 #: ../src/guestfs.pod:1514
3009 "In the kernel there is now quite a profusion of schemata for naming block "
3010 "devices (in this context, by I<block device> I mean a physical or virtual "
3011 "hard drive). The original Linux IDE driver used names starting with "
3012 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
3013 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
3014 "replacement for the old IDE driver (particularly for SATA devices) those "
3015 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
3016 "machines with paravirtualized drivers. This has created several different "
3017 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
3022 #: ../src/guestfs.pod:1526
3024 "As discussed above, libguestfs uses a qemu appliance running an embedded "
3025 "Linux kernel to access block devices. We can run a variety of appliances "
3026 "based on a variety of Linux kernels."
3030 #: ../src/guestfs.pod:1530
3032 "This causes a problem for libguestfs because many API calls use device or "
3033 "partition names. Working scripts and the recipe (example) scripts that we "
3034 "make available over the internet could fail if the naming scheme changes."
3038 #: ../src/guestfs.pod:1535
3040 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
3041 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
3042 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
3043 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
3047 #: ../src/guestfs.pod:1541
3049 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
3050 "L</guestfs_list_partitions> and similar calls return the true names of the "
3051 "devices and partitions as known to the appliance."
3055 #: ../src/guestfs.pod:1546
3056 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
3060 #: ../src/guestfs.pod:1548
3062 "Usually this translation is transparent. However in some (very rare) cases "
3063 "you may need to know the exact algorithm. Such cases include where you use "
3064 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
3065 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
3070 #: ../src/guestfs.pod:1554
3072 "The algorithm is applied only to I<parameters> which are known to be either "
3073 "device or partition names. Return values from functions such as "
3074 "L</guestfs_list_devices> are never changed."
3078 #: ../src/guestfs.pod:1562
3079 msgid "Is the string a parameter which is a device or partition name?"
3083 #: ../src/guestfs.pod:1566
3084 msgid "Does the string begin with C</dev/sd>?"
3088 #: ../src/guestfs.pod:1570
3090 "Does the named device exist? If so, we use that device. However if I<not> "
3091 "then we continue with this algorithm."
3095 #: ../src/guestfs.pod:1575
3096 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
3100 #: ../src/guestfs.pod:1577
3101 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
3105 #: ../src/guestfs.pod:1579
3106 msgid "If that named device exists, use it. If not, continue."
3110 #: ../src/guestfs.pod:1583
3111 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
3115 #: ../src/guestfs.pod:1585
3116 msgid "If that named device exists, use it. If not, return an error."
3120 #: ../src/guestfs.pod:1589
3121 msgid "PORTABILITY CONCERNS"
3125 #: ../src/guestfs.pod:1591
3127 "Although the standard naming scheme and automatic translation is useful for "
3128 "simple programs and guestfish scripts, for larger programs it is best not to "
3129 "rely on this mechanism."
3133 #: ../src/guestfs.pod:1595
3135 "Where possible for maximum future portability programs using libguestfs "
3136 "should use these future-proof techniques:"
3140 #: ../src/guestfs.pod:1602
3142 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
3143 "device names, and then use those names directly."
3147 #: ../src/guestfs.pod:1605
3148 msgid "Since those device names exist by definition, they will never be translated."
3152 #: ../src/guestfs.pod:1610
3154 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
3155 "filesystem labels."
3159 #: ../src/guestfs.pod:1615
3164 #: ../src/guestfs.pod:1617
3165 msgid "COMMUNICATION PROTOCOL"
3169 #: ../src/guestfs.pod:1619
3171 "Don't rely on using this protocol directly. This section documents how it "
3172 "currently works, but it may change at any time."
3176 #: ../src/guestfs.pod:1622
3178 "The protocol used to talk between the library and the daemon running inside "
3179 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3180 "1014, RFC 1832, RFC 4506)."
3184 #: ../src/guestfs.pod:1626
3186 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3187 "this file is automatically generated)."
3191 #: ../src/guestfs.pod:1629
3193 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3194 "and C<FileOut> parameters, which are handled with very simple request/reply "
3195 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3196 "parameters, which use the same request and reply messages, but they may also "
3197 "be followed by files sent using a chunked encoding."
3201 #: ../src/guestfs.pod:1636
3202 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3206 #: ../src/guestfs.pod:1638
3207 msgid "For ordinary functions, the request message is:"
3211 #: ../src/guestfs.pod:1640
3214 " total length (header + arguments,\n"
3215 " but not including the length word itself)\n"
3216 " struct guestfs_message_header (encoded as XDR)\n"
3217 " struct guestfs_<foo>_args (encoded as XDR)\n"
3222 #: ../src/guestfs.pod:1645
3224 "The total length field allows the daemon to allocate a fixed size buffer "
3225 "into which it slurps the rest of the message. As a result, the total length "
3226 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3227 "effective size of any request is limited to somewhere under this size."
3231 #: ../src/guestfs.pod:1651
3233 "Note also that many functions don't take any arguments, in which case the "
3234 "C<guestfs_I<foo>_args> is completely omitted."
3238 #: ../src/guestfs.pod:1654
3240 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3241 "receiver knows what type of args structure to expect, or none at all."
3245 #: ../src/guestfs.pod:1658
3246 msgid "The reply message for ordinary functions is:"
3250 #: ../src/guestfs.pod:1660
3253 " total length (header + ret,\n"
3254 " but not including the length word itself)\n"
3255 " struct guestfs_message_header (encoded as XDR)\n"
3256 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3261 #: ../src/guestfs.pod:1665
3263 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3264 "functions that return no formal return values."
3268 #: ../src/guestfs.pod:1668
3269 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3273 #: ../src/guestfs.pod:1671
3275 "In the case of an error, a flag is set in the header, and the reply message "
3276 "is slightly changed:"
3280 #: ../src/guestfs.pod:1674
3283 " total length (header + error,\n"
3284 " but not including the length word itself)\n"
3285 " struct guestfs_message_header (encoded as XDR)\n"
3286 " struct guestfs_message_error (encoded as XDR)\n"
3291 #: ../src/guestfs.pod:1679
3293 "The C<guestfs_message_error> structure contains the error message as a "
3298 #: ../src/guestfs.pod:1682
3299 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3303 #: ../src/guestfs.pod:1684
3305 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3306 "The normal request message is sent (see above). However this is followed by "
3307 "a sequence of file chunks."
3311 #: ../src/guestfs.pod:1688
3314 " total length (header + arguments,\n"
3315 " but not including the length word itself,\n"
3316 " and not including the chunks)\n"
3317 " struct guestfs_message_header (encoded as XDR)\n"
3318 " struct guestfs_<foo>_args (encoded as XDR)\n"
3319 " sequence of chunks for FileIn param #0\n"
3320 " sequence of chunks for FileIn param #1 etc.\n"
3325 #: ../src/guestfs.pod:1696
3326 msgid "The \"sequence of chunks\" is:"
3330 #: ../src/guestfs.pod:1698
3333 " length of chunk (not including length word itself)\n"
3334 " struct guestfs_chunk (encoded as XDR)\n"
3335 " length of chunk\n"
3336 " struct guestfs_chunk (encoded as XDR)\n"
3338 " length of chunk\n"
3339 " struct guestfs_chunk (with data.data_len == 0)\n"
3344 #: ../src/guestfs.pod:1706
3346 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3347 "is set in the final chunk to indicate either successful completion or early "
3352 #: ../src/guestfs.pod:1710
3354 "At time of writing there are no functions that have more than one FileIn "
3355 "parameter. However this is (theoretically) supported, by sending the "
3356 "sequence of chunks for each FileIn parameter one after another (from left to "
3361 #: ../src/guestfs.pod:1715
3363 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3364 "transfer. The library does this by sending a chunk with a special flag set "
3365 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3366 "RPC, does I<not> send any reply, and goes back to reading the next request."
3370 #: ../src/guestfs.pod:1721
3372 "The daemon may also cancel. It does this by writing a special word "
3373 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3374 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3375 "cancel chunk). The special word is chosen so that even if cancellation "
3376 "happens right at the end of the transfer (after the library has finished "
3377 "writing and has started listening for the reply), the \"spurious\" cancel "
3378 "flag will not be confused with the reply message."
3382 #: ../src/guestfs.pod:1730
3384 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3385 "limit), and also files where the size is not known in advance (eg. from "
3386 "pipes or sockets). However the chunks are rather small "
3387 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3388 "to keep much in memory."
3392 #: ../src/guestfs.pod:1736
3393 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3397 #: ../src/guestfs.pod:1738
3399 "The protocol for FileOut parameters is exactly the same as for FileIn "
3400 "parameters, but with the roles of daemon and library reversed."
3404 #: ../src/guestfs.pod:1741
3407 " total length (header + ret,\n"
3408 " but not including the length word itself,\n"
3409 " and not including the chunks)\n"
3410 " struct guestfs_message_header (encoded as XDR)\n"
3411 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3412 " sequence of chunks for FileOut param #0\n"
3413 " sequence of chunks for FileOut param #1 etc.\n"
3418 #: ../src/guestfs.pod:1749
3419 msgid "INITIAL MESSAGE"
3423 #: ../src/guestfs.pod:1751
3425 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3426 "which indicates that the guest and daemon is alive. This is what "
3427 "L</guestfs_launch> waits for."
3431 #: ../src/guestfs.pod:1755
3432 msgid "PROGRESS NOTIFICATION MESSAGES"
3436 #: ../src/guestfs.pod:1757
3438 "The daemon may send progress notification messages at any time. These are "
3439 "distinguished by the normal length word being replaced by "
3440 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3444 #: ../src/guestfs.pod:1761
3446 "The library turns them into progress callbacks (see "
3447 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3448 "discards them if not."
3452 #: ../src/guestfs.pod:1765
3454 "The daemon self-limits the frequency of progress messages it sends (see "
3455 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3460 #: ../src/guestfs.pod:1769
3461 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
3465 #: ../src/guestfs.pod:1771
3467 "All high-level libguestfs actions are synchronous. If you want to use "
3468 "libguestfs asynchronously then you must create a thread."
3472 #: ../src/guestfs.pod:1774
3474 "Only use the handle from a single thread. Either use the handle exclusively "
3475 "from one thread, or provide your own mutex so that two threads cannot issue "
3476 "calls on the same handle at the same time."
3480 #: ../src/guestfs.pod:1778
3482 "See the graphical program guestfs-browser for one possible architecture for "
3483 "multithreaded programs using libvirt and libguestfs."
3487 #: ../src/guestfs.pod:1781
3488 msgid "QEMU WRAPPERS"
3492 #: ../src/guestfs.pod:1783
3494 "If you want to compile your own qemu, run qemu from a non-standard location, "
3495 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
3500 #: ../src/guestfs.pod:1787
3502 "There is one important rule to remember: you I<must C<exec qemu>> as the "
3503 "last command in the shell script (so that qemu replaces the shell and "
3504 "becomes the direct child of the libguestfs-using program). If you don't do "
3505 "this, then the qemu process won't be cleaned up correctly."
3509 #: ../src/guestfs.pod:1792
3511 "Here is an example of a wrapper, where I have built my own copy of qemu from "
3516 #: ../src/guestfs.pod:1795
3520 " qemudir=/home/rjones/d/qemu\n"
3521 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
3527 #: ../src/guestfs.pod:1799
3529 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
3530 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
3535 #: ../src/guestfs.pod:1803
3538 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
3543 #: ../src/guestfs.pod:1805
3545 "Note that libguestfs also calls qemu with the -help and -version options in "
3546 "order to determine features."
3550 #: ../src/guestfs.pod:1808
3551 msgid "LIBGUESTFS VERSION NUMBERS"
3555 #: ../src/guestfs.pod:1810
3557 "Since April 2010, libguestfs has started to make separate development and "
3558 "stable releases, along with corresponding branches in our git repository. "
3559 "These separate releases can be identified by version number:"
3563 #: ../src/guestfs.pod:1815
3566 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3567 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3573 " | `-------- sub-version\n"
3575 " `------ always '1' because we don't change the ABI\n"
3580 #: ../src/guestfs.pod:1826
3581 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3585 #: ../src/guestfs.pod:1828
3587 "As time passes we cherry pick fixes from the development branch and backport "
3588 "those into the stable branch, the effect being that the stable branch should "
3589 "get more stable and less buggy over time. So the stable releases are ideal "
3590 "for people who don't need new features but would just like the software to "
3595 #: ../src/guestfs.pod:1834
3596 msgid "Our criteria for backporting changes are:"
3600 #: ../src/guestfs.pod:1840
3602 "Documentation changes which don't affect any code are backported unless the "
3603 "documentation refers to a future feature which is not in stable."
3607 #: ../src/guestfs.pod:1846
3609 "Bug fixes which are not controversial, fix obvious problems, and have been "
3610 "well tested are backported."
3614 #: ../src/guestfs.pod:1851
3616 "Simple rearrangements of code which shouldn't affect how it works get "
3617 "backported. This is so that the code in the two branches doesn't get too "
3618 "far out of step, allowing us to backport future fixes more easily."
3622 #: ../src/guestfs.pod:1857
3624 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3625 "exceptional case: the new feature is required in order to implement an "
3626 "important bug fix."
3630 #: ../src/guestfs.pod:1863
3632 "A new stable branch starts when we think the new features in development are "
3633 "substantial and compelling enough over the current stable branch to warrant "
3634 "it. When that happens we create new stable and development versions 1.N.0 "
3635 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
3636 "stable at this point, but by backporting fixes from development, that branch "
3637 "will stabilize over time."
3641 #: ../src/guestfs.pod:1871 ../fish/guestfish.pod:914 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 ../tools/virt-rescue.pl:255
3642 msgid "ENVIRONMENT VARIABLES"
3646 #: ../src/guestfs.pod:1875 ../fish/guestfish.pod:940
3647 msgid "LIBGUESTFS_APPEND"
3651 #: ../src/guestfs.pod:1877 ../fish/guestfish.pod:942
3652 msgid "Pass additional options to the guest kernel."
3656 #: ../src/guestfs.pod:1879 ../fish/guestfish.pod:944
3657 msgid "LIBGUESTFS_DEBUG"
3661 #: ../src/guestfs.pod:1881
3663 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
3664 "effect as calling C<guestfs_set_verbose (g, 1)>."
3668 #: ../src/guestfs.pod:1884 ../fish/guestfish.pod:949
3669 msgid "LIBGUESTFS_MEMSIZE"
3673 #: ../src/guestfs.pod:1886 ../fish/guestfish.pod:951
3674 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
3678 #: ../src/guestfs.pod:1889 ../fish/guestfish.pod:954
3681 " LIBGUESTFS_MEMSIZE=700\n"
3686 #: ../src/guestfs.pod:1891 ../fish/guestfish.pod:956
3687 msgid "LIBGUESTFS_PATH"
3691 #: ../src/guestfs.pod:1893
3693 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
3694 "the discussion of paths in section PATH above."
3698 #: ../src/guestfs.pod:1896 ../fish/guestfish.pod:961
3699 msgid "LIBGUESTFS_QEMU"
3703 #: ../src/guestfs.pod:1898 ../fish/guestfish.pod:963
3705 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
3706 "which was found at compile time by the configure script is used."
3710 #: ../src/guestfs.pod:1902
3711 msgid "See also L</QEMU WRAPPERS> above."
3715 #: ../src/guestfs.pod:1904 ../fish/guestfish.pod:967
3716 msgid "LIBGUESTFS_TRACE"
3720 #: ../src/guestfs.pod:1906
3722 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
3723 "effect as calling C<guestfs_set_trace (g, 1)>."
3727 #: ../src/guestfs.pod:1909 ../fish/guestfish.pod:976
3732 #: ../src/guestfs.pod:1911 ../fish/guestfish.pod:978
3733 msgid "Location of temporary directory, defaults to C</tmp>."
3737 #: ../src/guestfs.pod:1913 ../fish/guestfish.pod:980
3739 "If libguestfs was compiled to use the supermin appliance then the real "
3740 "appliance is cached in this directory, shared between all handles belonging "
3741 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
3742 "use in case C</tmp> is not large enough."
3746 #: ../src/guestfs.pod:1921 ../fish/guestfish.pod:1038 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 ../inspector/virt-inspector.pl:536 ../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
3751 #: ../src/guestfs.pod:1923
3753 "L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
3754 "L<virt-edit(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
3755 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
3756 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
3757 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
3761 #: ../src/guestfs.pod:1941
3763 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
3764 "L<lvm(8)>, L<disktype(1)>."
3768 #: ../src/guestfs.pod:1948 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548
3773 #: ../src/guestfs.pod:1950
3774 msgid "To get a list of bugs against libguestfs use this link:"
3778 #: ../src/guestfs.pod:1952
3779 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
3783 #: ../src/guestfs.pod:1954
3784 msgid "To report a new bug against libguestfs use this link:"
3788 #: ../src/guestfs.pod:1956
3789 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
3793 #: ../src/guestfs.pod:1958
3794 msgid "When reporting a bug, please check:"
3798 #: ../src/guestfs.pod:1964
3799 msgid "That the bug hasn't been reported already."
3803 #: ../src/guestfs.pod:1968
3804 msgid "That you are testing a recent version."
3808 #: ../src/guestfs.pod:1972
3809 msgid "Describe the bug accurately, and give a way to reproduce it."
3813 #: ../src/guestfs.pod:1976
3815 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
3820 #: ../src/guestfs.pod:1981 ../fish/guestfish.pod:1055 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244 ../inspector/virt-inspector.pl:546
3825 #: ../src/guestfs.pod:1983 ../fish/guestfish.pod:1057 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
3826 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
3830 #: ../src/guestfs.pod:1985 ../fish/guestfish.pod:1059 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 ../inspector/virt-inspector.pl:560 ../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
3835 #: ../src/guestfs.pod:1987 ../fish/guestfish.pod:1061 ../fuse/guestmount.pod:250
3836 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
3840 #: ../src/guestfs.pod:1990
3842 "This library is free software; you can redistribute it and/or modify it "
3843 "under the terms of the GNU Lesser General Public License as published by the "
3844 "Free Software Foundation; either version 2 of the License, or (at your "
3845 "option) any later version."
3849 #: ../src/guestfs.pod:1995
3851 "This library is distributed in the hope that it will be useful, but WITHOUT "
3852 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
3853 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
3858 #: ../src/guestfs.pod:2000
3860 "You should have received a copy of the GNU Lesser General Public License "
3861 "along with this library; if not, write to the Free Software Foundation, "
3862 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
3866 #: ../src/guestfs-actions.pod:1
3867 msgid "guestfs_add_cdrom"
3871 #: ../src/guestfs-actions.pod:3
3875 " guestfs_add_cdrom (guestfs_h *g,\n"
3876 " const char *filename);\n"
3881 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
3882 msgid "This function adds a virtual CD-ROM disk image to the guest."
3886 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
3887 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
3891 #: ../src/guestfs-actions.pod:17
3893 "This call checks for the existence of C<filename>. This stops you from "
3894 "specifying other types of drive which are supported by qemu such as C<nbd:> "
3895 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
3900 #: ../src/guestfs-actions.pod:24
3902 "If you just want to add an ISO file (often you use this as an efficient way "
3903 "to transfer large files into the guest), then you should probably use "
3904 "C<guestfs_add_drive_ro> instead."
3908 #: ../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:3045 ../src/guestfs-actions.pod:3060 ../src/guestfs-actions.pod:3080 ../src/guestfs-actions.pod:3205 ../src/guestfs-actions.pod:3219 ../src/guestfs-actions.pod:3232 ../src/guestfs-actions.pod:3246 ../src/guestfs-actions.pod:3261 ../src/guestfs-actions.pod:3297 ../src/guestfs-actions.pod:3369 ../src/guestfs-actions.pod:3389 ../src/guestfs-actions.pod:3406 ../src/guestfs-actions.pod:3429 ../src/guestfs-actions.pod:3452 ../src/guestfs-actions.pod:3484 ../src/guestfs-actions.pod:3503 ../src/guestfs-actions.pod:3522 ../src/guestfs-actions.pod:3557 ../src/guestfs-actions.pod:3569 ../src/guestfs-actions.pod:3605 ../src/guestfs-actions.pod:3621 ../src/guestfs-actions.pod:3634 ../src/guestfs-actions.pod:3649 ../src/guestfs-actions.pod:3666 ../src/guestfs-actions.pod:3759 ../src/guestfs-actions.pod:3779 ../src/guestfs-actions.pod:3792 ../src/guestfs-actions.pod:3843 ../src/guestfs-actions.pod:3861 ../src/guestfs-actions.pod:3879 ../src/guestfs-actions.pod:3895 ../src/guestfs-actions.pod:3909 ../src/guestfs-actions.pod:3923 ../src/guestfs-actions.pod:3940 ../src/guestfs-actions.pod:3955 ../src/guestfs-actions.pod:3975 ../src/guestfs-actions.pod:4024 ../src/guestfs-actions.pod:4055 ../src/guestfs-actions.pod:4074 ../src/guestfs-actions.pod:4093 ../src/guestfs-actions.pod:4105 ../src/guestfs-actions.pod:4122 ../src/guestfs-actions.pod:4135 ../src/guestfs-actions.pod:4150 ../src/guestfs-actions.pod:4165 ../src/guestfs-actions.pod:4200 ../src/guestfs-actions.pod:4215 ../src/guestfs-actions.pod:4235 ../src/guestfs-actions.pod:4249 ../src/guestfs-actions.pod:4266 ../src/guestfs-actions.pod:4315 ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:4366 ../src/guestfs-actions.pod:4394 ../src/guestfs-actions.pod:4411 ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:4563 ../src/guestfs-actions.pod:4620 ../src/guestfs-actions.pod:4642 ../src/guestfs-actions.pod:4660 ../src/guestfs-actions.pod:4692 ../src/guestfs-actions.pod:4758 ../src/guestfs-actions.pod:4775 ../src/guestfs-actions.pod:4788 ../src/guestfs-actions.pod:4802 ../src/guestfs-actions.pod:5091 ../src/guestfs-actions.pod:5110 ../src/guestfs-actions.pod:5124 ../src/guestfs-actions.pod:5136 ../src/guestfs-actions.pod:5150 ../src/guestfs-actions.pod:5162 ../src/guestfs-actions.pod:5176 ../src/guestfs-actions.pod:5192 ../src/guestfs-actions.pod:5213 ../src/guestfs-actions.pod:5232 ../src/guestfs-actions.pod:5251 ../src/guestfs-actions.pod:5269 ../src/guestfs-actions.pod:5292 ../src/guestfs-actions.pod:5310 ../src/guestfs-actions.pod:5329 ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:5369 ../src/guestfs-actions.pod:5386 ../src/guestfs-actions.pod:5414 ../src/guestfs-actions.pod:5438 ../src/guestfs-actions.pod:5457 ../src/guestfs-actions.pod:5481 ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:5511 ../src/guestfs-actions.pod:5530 ../src/guestfs-actions.pod:5567 ../src/guestfs-actions.pod:5590 ../src/guestfs-actions.pod:5616 ../src/guestfs-actions.pod:5724 ../src/guestfs-actions.pod:5845 ../src/guestfs-actions.pod:5857 ../src/guestfs-actions.pod:5870 ../src/guestfs-actions.pod:5883 ../src/guestfs-actions.pod:5905 ../src/guestfs-actions.pod:5918 ../src/guestfs-actions.pod:5931 ../src/guestfs-actions.pod:5944 ../src/guestfs-actions.pod:5959 ../src/guestfs-actions.pod:6018 ../src/guestfs-actions.pod:6035 ../src/guestfs-actions.pod:6051 ../src/guestfs-actions.pod:6067 ../src/guestfs-actions.pod:6084 ../src/guestfs-actions.pod:6097 ../src/guestfs-actions.pod:6117 ../src/guestfs-actions.pod:6153 ../src/guestfs-actions.pod:6167 ../src/guestfs-actions.pod:6208 ../src/guestfs-actions.pod:6221 ../src/guestfs-actions.pod:6239 ../src/guestfs-actions.pod:6268 ../src/guestfs-actions.pod:6299 ../src/guestfs-actions.pod:6418 ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:6450 ../src/guestfs-actions.pod:6505 ../src/guestfs-actions.pod:6518 ../src/guestfs-actions.pod:6563 ../src/guestfs-actions.pod:6596 ../src/guestfs-actions.pod:6650 ../src/guestfs-actions.pod:6676 ../src/guestfs-actions.pod:6742 ../src/guestfs-actions.pod:6761 ../src/guestfs-actions.pod:6790
3909 msgid "This function returns 0 on success or -1 on error."
3913 #: ../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
3915 "This function is deprecated. In new code, use the C<add_drive_opts> call "
3920 #: ../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:6684 ../src/guestfs-actions.pod:6853 ../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:4423 ../fish/guestfish-actions.pod:4520
3922 "Deprecated functions will not be removed from the API, but the fact that "
3923 "they are deprecated indicates that there are problems with correct use of "
3928 #: ../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:3047 ../src/guestfs-actions.pod:3062 ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:5271 ../src/guestfs-actions.pod:5388 ../src/guestfs-actions.pod:5498 ../src/guestfs-actions.pod:5961 ../src/guestfs-actions.pod:6086 ../src/guestfs-actions.pod:6598
3929 msgid "(Added in 0.3)"
3933 #: ../src/guestfs-actions.pod:41
3934 msgid "guestfs_add_domain"
3938 #: ../src/guestfs-actions.pod:43
3942 " guestfs_add_domain (guestfs_h *g,\n"
3943 " const char *dom,\n"
3949 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137
3951 "You may supply a list of optional arguments to this call. Use zero or more "
3952 "of the following pairs of parameters, and terminate the list with C<-1> on "
3953 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
3957 #: ../src/guestfs-actions.pod:53
3960 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
3961 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
3962 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
3967 #: ../src/guestfs-actions.pod:57
3969 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
3970 "It works by connecting to libvirt, requesting the domain and domain XML from "
3971 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
3976 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
3978 "The number of disks added is returned. This operation is atomic: if an "
3979 "error is returned, then no disks are added."
3983 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
3985 "This function does some minimal checks to make sure the libvirt domain is "
3986 "not running (unless C<readonly> is true). In a future version we will try "
3987 "to acquire the libvirt lock on each disk."
3991 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
3993 "Disks must be accessible locally. This often means that adding disks from a "
3994 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
3995 "unless those disks are accessible via the same device path locally too."
3999 #: ../src/guestfs-actions.pod:74
4001 "The optional C<libvirturi> parameter sets the libvirt URI (see "
4002 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
4003 "default libvirt URI (or one set through an environment variable, see the "
4004 "libvirt documentation for full details). If you are using the C API "
4005 "directly then it is more flexible to create the libvirt connection object "
4006 "yourself, get the domain object, and call C<guestfs_add_libvirt_dom>."
4010 #: ../src/guestfs-actions.pod:82
4012 "The other optional parameters are passed directly through to "
4013 "C<guestfs_add_drive_opts>."
4017 #: ../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:2602 ../src/guestfs-actions.pod:2623 ../src/guestfs-actions.pod:4338 ../src/guestfs-actions.pod:4466 ../src/guestfs-actions.pod:4872 ../src/guestfs-actions.pod:4898 ../src/guestfs-actions.pod:6194 ../src/guestfs-actions.pod:6609 ../src/guestfs-actions.pod:6622 ../src/guestfs-actions.pod:6635
4018 msgid "On error this function returns -1."
4022 #: ../src/guestfs-actions.pod:87
4023 msgid "guestfs_add_domain_va"
4027 #: ../src/guestfs-actions.pod:89
4031 " guestfs_add_domain_va (guestfs_h *g,\n"
4032 " const char *dom,\n"
4038 #: ../src/guestfs-actions.pod:94
4039 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
4043 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107 ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211
4044 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4048 #: ../src/guestfs-actions.pod:98
4049 msgid "guestfs_add_domain_argv"
4053 #: ../src/guestfs-actions.pod:100
4057 " guestfs_add_domain_argv (guestfs_h *g,\n"
4058 " const char *dom,\n"
4059 " const struct guestfs_add_domain_argv *optargs);\n"
4064 #: ../src/guestfs-actions.pod:105
4065 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
4069 #: ../src/guestfs-actions.pod:109
4070 msgid "guestfs_add_drive"
4074 #: ../src/guestfs-actions.pod:111
4078 " guestfs_add_drive (guestfs_h *g,\n"
4079 " const char *filename);\n"
4084 #: ../src/guestfs-actions.pod:115
4086 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
4087 "optional parameters, so the disk is added writable, with the format being "
4088 "detected automatically."
4092 #: ../src/guestfs-actions.pod:119
4094 "Automatic detection of the format opens you up to a potential security hole "
4095 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4096 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4097 "you should think about replacing calls to this function with calls to "
4098 "C<guestfs_add_drive_opts>, and specifying the format."
4102 #: ../src/guestfs-actions.pod:130
4103 msgid "guestfs_add_drive_opts"
4107 #: ../src/guestfs-actions.pod:132
4111 " guestfs_add_drive_opts (guestfs_h *g,\n"
4112 " const char *filename,\n"
4118 #: ../src/guestfs-actions.pod:142
4121 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
4122 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
4123 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
4128 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:92
4130 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4131 "The first time you call this function, the disk appears as C</dev/sda>, the "
4132 "second time as C</dev/sdb>, and so on."
4136 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:97
4138 "You don't necessarily need to be root when using libguestfs. However you "
4139 "obviously do need sufficient permissions to access the filename for whatever "
4140 "operations you want to perform (ie. read access if you just want to read the "
4141 "image or write access if you want to modify the image)."
4145 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:103
4146 msgid "This call checks that C<filename> exists."
4150 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:105
4151 msgid "The optional arguments are:"
4155 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:109
4160 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:111
4162 "If true then the image is treated as read-only. Writes are still allowed, "
4163 "but they are stored in a temporary snapshot overlay which is discarded at "
4164 "the end. The disk that you add is not modified."
4168 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:115
4173 #: ../src/guestfs-actions.pod:171
4175 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4176 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4177 "Possible formats include C<raw> and C<qcow2>."
4181 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:121
4183 "Automatic detection of the format opens you up to a potential security hole "
4184 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4185 "RHBZ#642934. Specifying the format closes this security hole."
4189 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:126
4194 #: ../src/guestfs-actions.pod:182
4196 "This rarely-used option lets you emulate the behaviour of the deprecated "
4197 "C<guestfs_add_drive_with_if> call (q.v.)"
4201 #: ../src/guestfs-actions.pod:189
4202 msgid "(Added in 1.5.23)"
4206 #: ../src/guestfs-actions.pod:191
4207 msgid "guestfs_add_drive_opts_va"
4211 #: ../src/guestfs-actions.pod:193
4215 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
4216 " const char *filename,\n"
4222 #: ../src/guestfs-actions.pod:198
4223 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4227 #: ../src/guestfs-actions.pod:202
4228 msgid "guestfs_add_drive_opts_argv"
4232 #: ../src/guestfs-actions.pod:204
4236 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4237 " const char *filename,\n"
4238 " const struct guestfs_add_drive_opts_argv "
4244 #: ../src/guestfs-actions.pod:209
4245 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4249 #: ../src/guestfs-actions.pod:213
4250 msgid "guestfs_add_drive_ro"
4254 #: ../src/guestfs-actions.pod:215
4258 " guestfs_add_drive_ro (guestfs_h *g,\n"
4259 " const char *filename);\n"
4264 #: ../src/guestfs-actions.pod:219
4266 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4267 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4268 "disk is added read-only, with the format being detected automatically."
4272 #: ../src/guestfs-actions.pod:226
4273 msgid "(Added in 1.0.38)"
4277 #: ../src/guestfs-actions.pod:228
4278 msgid "guestfs_add_drive_ro_with_if"
4282 #: ../src/guestfs-actions.pod:230
4286 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4287 " const char *filename,\n"
4288 " const char *iface);\n"
4293 #: ../src/guestfs-actions.pod:235
4295 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4296 "QEMU interface emulation to use at run time."
4300 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268 ../src/guestfs-actions.pod:2303
4301 msgid "(Added in 1.0.84)"
4305 #: ../src/guestfs-actions.pod:249
4306 msgid "guestfs_add_drive_with_if"
4310 #: ../src/guestfs-actions.pod:251
4314 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4315 " const char *filename,\n"
4316 " const char *iface);\n"
4321 #: ../src/guestfs-actions.pod:256
4323 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4324 "QEMU interface emulation to use at run time."
4328 #: ../src/guestfs-actions.pod:270
4329 msgid "guestfs_aug_clear"
4333 #: ../src/guestfs-actions.pod:272
4337 " guestfs_aug_clear (guestfs_h *g,\n"
4338 " const char *augpath);\n"
4343 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:178
4345 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4346 "L<augtool(1)> C<clear> command."
4350 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2083
4351 msgid "(Added in 1.3.4)"
4355 #: ../src/guestfs-actions.pod:283
4356 msgid "guestfs_aug_close"
4360 #: ../src/guestfs-actions.pod:285
4364 " guestfs_aug_close (guestfs_h *g);\n"
4369 #: ../src/guestfs-actions.pod:288
4371 "Close the current Augeas handle and free up any resources used by it. After "
4372 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4373 "any other Augeas functions."
4377 #: ../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:4949
4378 msgid "(Added in 0.7)"
4382 #: ../src/guestfs-actions.pod:297
4383 msgid "guestfs_aug_defnode"
4387 #: ../src/guestfs-actions.pod:299
4390 " struct guestfs_int_bool *\n"
4391 " guestfs_aug_defnode (guestfs_h *g,\n"
4392 " const char *name,\n"
4393 " const char *expr,\n"
4394 " const char *val);\n"
4399 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:194
4400 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4404 #: ../src/guestfs-actions.pod:308
4406 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4407 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4408 "containing that single node."
4412 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:201
4414 "On success this returns a pair containing the number of nodes in the "
4415 "nodeset, and a boolean flag if a node was created."
4419 #: ../src/guestfs-actions.pod:316
4421 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4422 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4426 #: ../src/guestfs-actions.pod:322
4427 msgid "guestfs_aug_defvar"
4431 #: ../src/guestfs-actions.pod:324
4435 " guestfs_aug_defvar (guestfs_h *g,\n"
4436 " const char *name,\n"
4437 " const char *expr);\n"
4442 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:209
4444 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4445 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4449 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:213
4451 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4452 "evaluates to something which is not a nodeset."
4456 #: ../src/guestfs-actions.pod:340
4457 msgid "guestfs_aug_get"
4461 #: ../src/guestfs-actions.pod:342
4465 " guestfs_aug_get (guestfs_h *g,\n"
4466 " const char *augpath);\n"
4471 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:220
4473 "Look up the value associated with C<path>. If C<path> matches exactly one "
4474 "node, the C<value> is returned."
4478 #: ../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:2548 ../src/guestfs-actions.pod:2684 ../src/guestfs-actions.pod:2713 ../src/guestfs-actions.pod:2735 ../src/guestfs-actions.pod:2791 ../src/guestfs-actions.pod:2814 ../src/guestfs-actions.pod:3191 ../src/guestfs-actions.pod:3541 ../src/guestfs-actions.pod:3711 ../src/guestfs-actions.pod:3821 ../src/guestfs-actions.pod:4484 ../src/guestfs-actions.pod:4677 ../src/guestfs-actions.pod:4847 ../src/guestfs-actions.pod:5025 ../src/guestfs-actions.pod:5074 ../src/guestfs-actions.pod:5637 ../src/guestfs-actions.pod:5653 ../src/guestfs-actions.pod:5670 ../src/guestfs-actions.pod:5694 ../src/guestfs-actions.pod:6358 ../src/guestfs-actions.pod:6377 ../src/guestfs-actions.pod:6395 ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:6847
4480 "This function returns a string, or NULL on error. I<The caller must free "
4481 "the returned string after use>."
4485 #: ../src/guestfs-actions.pod:354
4486 msgid "guestfs_aug_init"
4490 #: ../src/guestfs-actions.pod:356
4494 " guestfs_aug_init (guestfs_h *g,\n"
4495 " const char *root,\n"
4501 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:227
4503 "Create a new Augeas handle for editing configuration files. If there was "
4504 "any previous Augeas handle associated with this guestfs session, then it is "
4509 #: ../src/guestfs-actions.pod:365
4510 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4514 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:234
4515 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4519 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:237
4521 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4522 "logical I<or> of the following integers:"
4526 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:243
4527 msgid "C<AUG_SAVE_BACKUP> = 1"
4531 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:245
4532 msgid "Keep the original file with a C<.augsave> extension."
4536 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:247
4537 msgid "C<AUG_SAVE_NEWFILE> = 2"
4541 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:249
4543 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4544 "original. Overrides C<AUG_SAVE_BACKUP>."
4548 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:252
4549 msgid "C<AUG_TYPE_CHECK> = 4"
4553 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:254
4554 msgid "Typecheck lenses (can be expensive)."
4558 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:256
4559 msgid "C<AUG_NO_STDINC> = 8"
4563 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:258
4564 msgid "Do not use standard load path for modules."
4568 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:260
4569 msgid "C<AUG_SAVE_NOOP> = 16"
4573 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:262
4574 msgid "Make save a no-op, just record what would have been changed."
4578 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:264
4579 msgid "C<AUG_NO_LOAD> = 32"
4583 #: ../src/guestfs-actions.pod:400
4584 msgid "Do not load the tree in C<guestfs_aug_init>."
4588 #: ../src/guestfs-actions.pod:404
4589 msgid "To close the handle, you can call C<guestfs_aug_close>."
4593 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:272
4594 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4598 #: ../src/guestfs-actions.pod:412
4599 msgid "guestfs_aug_insert"
4603 #: ../src/guestfs-actions.pod:414
4607 " guestfs_aug_insert (guestfs_h *g,\n"
4608 " const char *augpath,\n"
4609 " const char *label,\n"
4615 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:278
4617 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4618 "or after C<path> (depending on the boolean flag C<before>)."
4622 #: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:282
4624 "C<path> must match exactly one existing node in the tree, and C<label> must "
4625 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4629 #: ../src/guestfs-actions.pod:432
4630 msgid "guestfs_aug_load"
4634 #: ../src/guestfs-actions.pod:434
4638 " guestfs_aug_load (guestfs_h *g);\n"
4643 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:290
4644 msgid "Load files into the tree."
4648 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:292
4649 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4653 #: ../src/guestfs-actions.pod:446
4654 msgid "guestfs_aug_ls"
4658 #: ../src/guestfs-actions.pod:448
4662 " guestfs_aug_ls (guestfs_h *g,\n"
4663 " const char *augpath);\n"
4668 #: ../src/guestfs-actions.pod:452
4670 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
4671 "sorting the resulting nodes into alphabetical order."
4675 #: ../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:2573 ../src/guestfs-actions.pod:2754 ../src/guestfs-actions.pod:2856 ../src/guestfs-actions.pod:3111 ../src/guestfs-actions.pod:3173 ../src/guestfs-actions.pod:3278 ../src/guestfs-actions.pod:3683 ../src/guestfs-actions.pod:4299 ../src/guestfs-actions.pod:4819 ../src/guestfs-actions.pod:4945 ../src/guestfs-actions.pod:5059 ../src/guestfs-actions.pod:5710 ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5826 ../src/guestfs-actions.pod:5972 ../src/guestfs-actions.pod:5996 ../src/guestfs-actions.pod:6468 ../src/guestfs-actions.pod:6488 ../src/guestfs-actions.pod:6535 ../src/guestfs-actions.pod:6700 ../src/guestfs-actions.pod:6719 ../src/guestfs-actions.pod:6804 ../src/guestfs-actions.pod:6823 ../src/guestfs-actions.pod:6869 ../src/guestfs-actions.pod:6888
4677 "This function returns a NULL-terminated array of strings (like "
4678 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
4679 "strings and the array after use>."
4683 #: ../src/guestfs-actions.pod:459 ../src/guestfs-actions.pod:990 ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1413 ../src/guestfs-actions.pod:2934 ../src/guestfs-actions.pod:2965 ../src/guestfs-actions.pod:3524 ../src/guestfs-actions.pod:3574 ../src/guestfs-actions.pod:3761 ../src/guestfs-actions.pod:3794 ../src/guestfs-actions.pod:3957 ../src/guestfs-actions.pod:4303 ../src/guestfs-actions.pod:4760 ../src/guestfs-actions.pod:5138 ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5164 ../src/guestfs-actions.pod:5572 ../src/guestfs-actions.pod:6210 ../src/guestfs-actions.pod:6223 ../src/guestfs-actions.pod:6452 ../src/guestfs-actions.pod:6655 ../src/guestfs-actions.pod:6688
4684 msgid "(Added in 0.8)"
4688 #: ../src/guestfs-actions.pod:461
4689 msgid "guestfs_aug_match"
4693 #: ../src/guestfs-actions.pod:463
4697 " guestfs_aug_match (guestfs_h *g,\n"
4698 " const char *augpath);\n"
4703 #: ../src/guestfs-actions.pod:467 ../fish/guestfish-actions.pod:306
4705 "Returns a list of paths which match the path expression C<path>. The "
4706 "returned paths are sufficiently qualified so that they match exactly one "
4707 "node in the current tree."
4711 #: ../src/guestfs-actions.pod:477
4712 msgid "guestfs_aug_mv"
4716 #: ../src/guestfs-actions.pod:479
4720 " guestfs_aug_mv (guestfs_h *g,\n"
4721 " const char *src,\n"
4722 " const char *dest);\n"
4727 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:314
4729 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4730 "C<dest> is overwritten if it exists."
4734 #: ../src/guestfs-actions.pod:491
4735 msgid "guestfs_aug_rm"
4739 #: ../src/guestfs-actions.pod:493
4743 " guestfs_aug_rm (guestfs_h *g,\n"
4744 " const char *augpath);\n"
4749 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:321
4750 msgid "Remove C<path> and all of its children."
4754 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:323
4755 msgid "On success this returns the number of entries which were removed."
4759 #: ../src/guestfs-actions.pod:505
4760 msgid "guestfs_aug_save"
4764 #: ../src/guestfs-actions.pod:507
4768 " guestfs_aug_save (guestfs_h *g);\n"
4773 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:329
4774 msgid "This writes all pending changes to disk."
4778 #: ../src/guestfs-actions.pod:512
4780 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
4785 #: ../src/guestfs-actions.pod:519
4786 msgid "guestfs_aug_set"
4790 #: ../src/guestfs-actions.pod:521
4794 " guestfs_aug_set (guestfs_h *g,\n"
4795 " const char *augpath,\n"
4796 " const char *val);\n"
4801 #: ../src/guestfs-actions.pod:526 ../fish/guestfish-actions.pod:338
4802 msgid "Set the value associated with C<path> to C<val>."
4806 #: ../src/guestfs-actions.pod:528
4808 "In the Augeas API, it is possible to clear a node by setting the value to "
4809 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
4810 "this call. Instead you must use the C<guestfs_aug_clear> call."
4814 #: ../src/guestfs-actions.pod:537
4815 msgid "guestfs_available"
4819 #: ../src/guestfs-actions.pod:539
4823 " guestfs_available (guestfs_h *g,\n"
4824 " char *const *groups);\n"
4829 #: ../src/guestfs-actions.pod:543 ../fish/guestfish-actions.pod:349
4831 "This command is used to check the availability of some groups of "
4832 "functionality in the appliance, which not all builds of the libguestfs "
4833 "appliance will be able to provide."
4837 #: ../src/guestfs-actions.pod:547
4839 "The libguestfs groups, and the functions that those groups correspond to, "
4840 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
4841 "runtime by calling C<guestfs_available_all_groups>."
4845 #: ../src/guestfs-actions.pod:552 ../fish/guestfish-actions.pod:358
4847 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
4848 "\"augeas\"]> would check for the availability of the Linux inotify functions "
4849 "and Augeas (configuration file editing) functions."
4853 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:363
4854 msgid "The command returns no error if I<all> requested groups are available."
4858 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:365
4860 "It fails with an error if one or more of the requested groups is unavailable "
4865 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:368
4867 "If an unknown group name is included in the list of groups then an error is "
4872 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:371
4877 #: ../src/guestfs-actions.pod:571
4878 msgid "You must call C<guestfs_launch> before calling this function."
4882 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:379
4884 "The reason is because we don't know what groups are supported by the "
4885 "appliance/daemon until it is running and can be queried."
4889 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:385
4891 "If a group of functions is available, this does not necessarily mean that "
4892 "they will work. You still have to check for errors when calling individual "
4893 "API functions even if they are available."
4897 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:392
4899 "It is usually the job of distro packagers to build complete functionality "
4900 "into the libguestfs appliance. Upstream libguestfs, if built from source "
4901 "with all requirements satisfied, will support everything."
4905 #: ../src/guestfs-actions.pod:593
4907 "This call was added in version C<1.0.80>. In previous versions of "
4908 "libguestfs all you could do would be to speculatively execute a command to "
4909 "find out if the daemon implemented it. See also C<guestfs_version>."
4913 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:1163
4914 msgid "(Added in 1.0.80)"
4918 #: ../src/guestfs-actions.pod:604
4919 msgid "guestfs_available_all_groups"
4923 #: ../src/guestfs-actions.pod:606
4927 " guestfs_available_all_groups (guestfs_h *g);\n"
4932 #: ../src/guestfs-actions.pod:609
4934 "This command returns a list of all optional groups that this daemon knows "
4935 "about. Note this returns both supported and unsupported groups. To find "
4936 "out which ones the daemon can actually support you have to call "
4937 "C<guestfs_available> on each member of the returned list."
4941 #: ../src/guestfs-actions.pod:615
4942 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
4946 #: ../src/guestfs-actions.pod:621
4947 msgid "(Added in 1.3.15)"
4951 #: ../src/guestfs-actions.pod:623
4952 msgid "guestfs_base64_in"
4956 #: ../src/guestfs-actions.pod:625
4960 " guestfs_base64_in (guestfs_h *g,\n"
4961 " const char *base64file,\n"
4962 " const char *filename);\n"
4967 #: ../src/guestfs-actions.pod:630 ../fish/guestfish-actions.pod:422
4968 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
4972 #: ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649
4973 msgid "(Added in 1.3.5)"
4977 #: ../src/guestfs-actions.pod:637
4978 msgid "guestfs_base64_out"
4982 #: ../src/guestfs-actions.pod:639
4986 " guestfs_base64_out (guestfs_h *g,\n"
4987 " const char *filename,\n"
4988 " const char *base64file);\n"
4993 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:431
4995 "This command downloads the contents of C<filename>, writing it out to local "
4996 "file C<base64file> encoded as base64."
5000 #: ../src/guestfs-actions.pod:651
5001 msgid "guestfs_blockdev_flushbufs"
5005 #: ../src/guestfs-actions.pod:653
5009 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
5010 " const char *device);\n"
5015 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:440
5016 msgid "This tells the kernel to flush internal buffers associated with C<device>."
5020 #: ../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
5021 msgid "This uses the L<blockdev(8)> command."
5025 #: ../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
5026 msgid "(Added in 0.9.3)"
5030 #: ../src/guestfs-actions.pod:666
5031 msgid "guestfs_blockdev_getbsz"
5035 #: ../src/guestfs-actions.pod:668
5039 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
5040 " const char *device);\n"
5045 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:449
5046 msgid "This returns the block size of a device."
5050 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:774 ../fish/guestfish-actions.pod:451 ../fish/guestfish-actions.pod:514
5052 "(Note this is different from both I<size in blocks> and I<filesystem block "
5057 #: ../src/guestfs-actions.pod:683
5058 msgid "guestfs_blockdev_getro"
5062 #: ../src/guestfs-actions.pod:685
5066 " guestfs_blockdev_getro (guestfs_h *g,\n"
5067 " const char *device);\n"
5072 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:460
5074 "Returns a boolean indicating if the block device is read-only (true if "
5075 "read-only, false if not)."
5079 #: ../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:2873 ../src/guestfs-actions.pod:2887 ../src/guestfs-actions.pod:2902 ../src/guestfs-actions.pod:2916 ../src/guestfs-actions.pod:2932 ../src/guestfs-actions.pod:2947 ../src/guestfs-actions.pod:2963 ../src/guestfs-actions.pod:2977 ../src/guestfs-actions.pod:2990 ../src/guestfs-actions.pod:3004 ../src/guestfs-actions.pod:3019 ../src/guestfs-actions.pod:3034 ../src/guestfs-actions.pod:4448
5080 msgid "This function returns a C truth value on success or -1 on error."
5084 #: ../src/guestfs-actions.pod:698
5085 msgid "guestfs_blockdev_getsize64"
5089 #: ../src/guestfs-actions.pod:700
5093 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
5094 " const char *device);\n"
5099 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:469
5100 msgid "This returns the size of the device in bytes."
5104 #: ../src/guestfs-actions.pod:706
5105 msgid "See also C<guestfs_blockdev_getsz>."
5109 #: ../src/guestfs-actions.pod:714
5110 msgid "guestfs_blockdev_getss"
5114 #: ../src/guestfs-actions.pod:716
5118 " guestfs_blockdev_getss (guestfs_h *g,\n"
5119 " const char *device);\n"
5124 #: ../src/guestfs-actions.pod:720 ../fish/guestfish-actions.pod:479
5126 "This returns the size of sectors on a block device. Usually 512, but can be "
5127 "larger for modern devices."
5131 #: ../src/guestfs-actions.pod:723
5133 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
5138 #: ../src/guestfs-actions.pod:732
5139 msgid "guestfs_blockdev_getsz"
5143 #: ../src/guestfs-actions.pod:734
5147 " guestfs_blockdev_getsz (guestfs_h *g,\n"
5148 " const char *device);\n"
5153 #: ../src/guestfs-actions.pod:738 ../fish/guestfish-actions.pod:491
5155 "This returns the size of the device in units of 512-byte sectors (even if "
5156 "the sectorsize isn't 512 bytes ... weird)."
5160 #: ../src/guestfs-actions.pod:741
5162 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
5163 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
5167 #: ../src/guestfs-actions.pod:751
5168 msgid "guestfs_blockdev_rereadpt"
5172 #: ../src/guestfs-actions.pod:753
5176 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5177 " const char *device);\n"
5182 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:504
5183 msgid "Reread the partition table on C<device>."
5187 #: ../src/guestfs-actions.pod:765
5188 msgid "guestfs_blockdev_setbsz"
5192 #: ../src/guestfs-actions.pod:767
5196 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5197 " const char *device,\n"
5198 " int blocksize);\n"
5203 #: ../src/guestfs-actions.pod:772 ../fish/guestfish-actions.pod:512
5204 msgid "This sets the block size of a device."
5208 #: ../src/guestfs-actions.pod:783
5209 msgid "guestfs_blockdev_setro"
5213 #: ../src/guestfs-actions.pod:785
5217 " guestfs_blockdev_setro (guestfs_h *g,\n"
5218 " const char *device);\n"
5223 #: ../src/guestfs-actions.pod:789 ../fish/guestfish-actions.pod:523
5224 msgid "Sets the block device named C<device> to read-only."
5228 #: ../src/guestfs-actions.pod:797
5229 msgid "guestfs_blockdev_setrw"
5233 #: ../src/guestfs-actions.pod:799
5237 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5238 " const char *device);\n"
5243 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:531
5244 msgid "Sets the block device named C<device> to read-write."
5248 #: ../src/guestfs-actions.pod:811
5249 msgid "guestfs_case_sensitive_path"
5253 #: ../src/guestfs-actions.pod:813
5257 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5258 " const char *path);\n"
5263 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:539
5265 "This can be used to resolve case insensitive paths on a filesystem which is "
5266 "case sensitive. The use case is to resolve paths which you have read from "
5267 "Windows configuration files or the Windows Registry, to the true path."
5271 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:544
5273 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5274 "(and probably others), which is that although the underlying filesystem is "
5275 "case-insensitive, the driver exports the filesystem to Linux as "
5280 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:549
5282 "One consequence of this is that special directories such as C<c:\\windows> "
5283 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5284 "precise details of how they were created. In Windows itself this would not "
5289 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:555
5291 "Bug or feature? You decide: "
5292 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
5296 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:558
5298 "This function resolves the true case of each element in the path and returns "
5299 "the case-sensitive path."
5303 #: ../src/guestfs-actions.pod:839
5305 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
5306 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5307 "how the directories were originally created under Windows)."
5311 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:566
5312 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5316 #: ../src/guestfs-actions.pod:847
5317 msgid "See also C<guestfs_realpath>."
5321 #: ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:6380
5322 msgid "(Added in 1.0.75)"
5326 #: ../src/guestfs-actions.pod:854
5331 #: ../src/guestfs-actions.pod:856
5335 " guestfs_cat (guestfs_h *g,\n"
5336 " const char *path);\n"
5341 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:4935 ../fish/guestfish-actions.pod:575 ../fish/guestfish-actions.pod:3267
5342 msgid "Return the contents of the file named C<path>."
5346 #: ../src/guestfs-actions.pod:862
5348 "Note that this function cannot correctly handle binary files (specifically, "
5349 "files containing C<\\0> character which is treated as end of string). For "
5350 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5351 "functions which have a more complex interface."
5355 #: ../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:4717 ../src/guestfs-actions.pod:4743 ../src/guestfs-actions.pod:4874 ../src/guestfs-actions.pod:4900 ../src/guestfs-actions.pod:4924 ../src/guestfs-actions.pod:5775 ../src/guestfs-actions.pod:5830 ../src/guestfs-actions.pod:5976 ../src/guestfs-actions.pod:6000 ../src/guestfs-actions.pod:6652 ../src/guestfs-actions.pod:6678 ../src/guestfs-actions.pod:6704 ../src/guestfs-actions.pod:6723 ../src/guestfs-actions.pod:6808 ../src/guestfs-actions.pod:6827 ../src/guestfs-actions.pod:6873 ../src/guestfs-actions.pod:6892 ../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:3137 ../fish/guestfish-actions.pod:3152 ../fish/guestfish-actions.pod:3228 ../fish/guestfish-actions.pod:3245 ../fish/guestfish-actions.pod:3260 ../fish/guestfish-actions.pod:3843 ../fish/guestfish-actions.pod:3889 ../fish/guestfish-actions.pod:3974 ../fish/guestfish-actions.pod:3989 ../fish/guestfish-actions.pod:4399 ../fish/guestfish-actions.pod:4417 ../fish/guestfish-actions.pod:4434 ../fish/guestfish-actions.pod:4444 ../fish/guestfish-actions.pod:4492 ../fish/guestfish-actions.pod:4502 ../fish/guestfish-actions.pod:4531 ../fish/guestfish-actions.pod:4541
5357 "Because of the message protocol, there is a transfer limit of somewhere "
5358 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5362 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:3115 ../src/guestfs-actions.pod:3177 ../src/guestfs-actions.pod:3194 ../src/guestfs-actions.pod:3282 ../src/guestfs-actions.pod:3687 ../src/guestfs-actions.pod:3701 ../src/guestfs-actions.pod:4823 ../src/guestfs-actions.pod:4837 ../src/guestfs-actions.pod:6539 ../src/guestfs-actions.pod:6553
5363 msgid "(Added in 0.4)"
5367 #: ../src/guestfs-actions.pod:875
5368 msgid "guestfs_checksum"
5372 #: ../src/guestfs-actions.pod:877
5376 " guestfs_checksum (guestfs_h *g,\n"
5377 " const char *csumtype,\n"
5378 " const char *path);\n"
5383 #: ../src/guestfs-actions.pod:882 ../fish/guestfish-actions.pod:589
5384 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5388 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:592
5390 "The type of checksum to compute is given by the C<csumtype> parameter which "
5391 "must have one of the following values:"
5395 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:597
5400 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:599
5402 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5407 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:602
5412 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:604
5413 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5417 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:606
5422 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:608
5423 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5427 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:610
5432 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:612
5433 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5437 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:614
5442 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:616
5443 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5447 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:618
5452 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:620
5453 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5457 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:622
5462 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:624
5463 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5467 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:628
5468 msgid "The checksum is returned as a printable string."
5472 #: ../src/guestfs-actions.pod:923
5473 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
5477 #: ../src/guestfs-actions.pod:925
5478 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
5482 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:2889 ../src/guestfs-actions.pod:2918 ../src/guestfs-actions.pod:2979 ../src/guestfs-actions.pod:3006 ../src/guestfs-actions.pod:6241
5483 msgid "(Added in 1.0.2)"
5487 #: ../src/guestfs-actions.pod:932
5488 msgid "guestfs_checksum_device"
5492 #: ../src/guestfs-actions.pod:934
5496 " guestfs_checksum_device (guestfs_h *g,\n"
5497 " const char *csumtype,\n"
5498 " const char *device);\n"
5503 #: ../src/guestfs-actions.pod:939
5505 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5506 "device named C<device>. For the types of checksums supported see the "
5507 "C<guestfs_checksum> command."
5511 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:4354 ../src/guestfs-actions.pod:4413 ../src/guestfs-actions.pod:4450 ../src/guestfs-actions.pod:4468 ../src/guestfs-actions.pod:4644 ../src/guestfs-actions.pod:6155 ../src/guestfs-actions.pod:6169 ../src/guestfs-actions.pod:6565
5512 msgid "(Added in 1.3.2)"
5516 #: ../src/guestfs-actions.pod:948
5517 msgid "guestfs_checksums_out"
5521 #: ../src/guestfs-actions.pod:950
5525 " guestfs_checksums_out (guestfs_h *g,\n"
5526 " const char *csumtype,\n"
5527 " const char *directory,\n"
5528 " const char *sumsfile);\n"
5533 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:646
5535 "This command computes the checksums of all regular files in C<directory> and "
5536 "then emits a list of those checksums to the local output file C<sumsfile>."
5540 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:650
5542 "This can be used for verifying the integrity of a virtual machine. However "
5543 "to be properly secure you should pay attention to the output of the checksum "
5544 "command (it uses the ones from GNU coreutils). In particular when the "
5545 "filename is not printable, coreutils uses a special backslash syntax. For "
5546 "more information, see the GNU coreutils info file."
5550 #: ../src/guestfs-actions.pod:970
5551 msgid "(Added in 1.3.7)"
5555 #: ../src/guestfs-actions.pod:972
5556 msgid "guestfs_chmod"
5560 #: ../src/guestfs-actions.pod:974
5564 " guestfs_chmod (guestfs_h *g,\n"
5566 " const char *path);\n"
5571 #: ../src/guestfs-actions.pod:979 ../fish/guestfish-actions.pod:664
5573 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5578 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:667
5580 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5581 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5586 #: ../src/guestfs-actions.pod:986 ../src/guestfs-actions.pod:3938 ../src/guestfs-actions.pod:4053 ../src/guestfs-actions.pod:4072 ../src/guestfs-actions.pod:4091 ../fish/guestfish-actions.pod:671 ../fish/guestfish-actions.pod:2627 ../fish/guestfish-actions.pod:2712 ../fish/guestfish-actions.pod:2722 ../fish/guestfish-actions.pod:2732
5587 msgid "The mode actually set is affected by the umask."
5591 #: ../src/guestfs-actions.pod:992
5592 msgid "guestfs_chown"
5596 #: ../src/guestfs-actions.pod:994
5600 " guestfs_chown (guestfs_h *g,\n"
5603 " const char *path);\n"
5608 #: ../src/guestfs-actions.pod:1000 ../fish/guestfish-actions.pod:677
5609 msgid "Change the file owner to C<owner> and group to C<group>."
5613 #: ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:3076 ../fish/guestfish-actions.pod:679 ../fish/guestfish-actions.pod:2105
5615 "Only numeric uid and gid are supported. If you want to use names, you will "
5616 "need to locate and parse the password file yourself (Augeas support makes "
5617 "this relatively easy)."
5621 #: ../src/guestfs-actions.pod:1010
5622 msgid "guestfs_command"
5626 #: ../src/guestfs-actions.pod:1012
5630 " guestfs_command (guestfs_h *g,\n"
5631 " char *const *arguments);\n"
5636 #: ../src/guestfs-actions.pod:1016 ../fish/guestfish-actions.pod:687
5638 "This call runs a command from the guest filesystem. The filesystem must be "
5639 "mounted, and must contain a compatible operating system (ie. something "
5640 "Linux, with the same or compatible processor architecture)."
5644 #: ../src/guestfs-actions.pod:1021
5646 "The single parameter is an argv-style list of arguments. The first element "
5647 "is the name of the program to run. Subsequent elements are parameters. The "
5648 "list must be non-empty (ie. must contain a program name). Note that the "
5649 "command runs directly, and is I<not> invoked via the shell (see "
5654 #: ../src/guestfs-actions.pod:1028 ../fish/guestfish-actions.pod:699
5655 msgid "The return value is anything printed to I<stdout> by the command."
5659 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:702
5661 "If the command returns a non-zero exit status, then this function returns an "
5662 "error message. The error message string is the content of I<stderr> from "
5667 #: ../src/guestfs-actions.pod:1035 ../fish/guestfish-actions.pod:706
5669 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
5670 "C</bin>. If you require a program from another location, you should provide "
5671 "the full path in the first parameter."
5675 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:711
5677 "Shared libraries and data files required by the program must be available on "
5678 "filesystems which are mounted in the correct places. It is the caller's "
5679 "responsibility to ensure all filesystems that are needed are mounted at the "
5684 #: ../src/guestfs-actions.pod:1052 ../src/guestfs-actions.pod:1072 ../src/guestfs-actions.pod:1535
5685 msgid "(Added in 0.9.1)"
5689 #: ../src/guestfs-actions.pod:1054
5690 msgid "guestfs_command_lines"
5694 #: ../src/guestfs-actions.pod:1056
5698 " guestfs_command_lines (guestfs_h *g,\n"
5699 " char *const *arguments);\n"
5704 #: ../src/guestfs-actions.pod:1060
5706 "This is the same as C<guestfs_command>, but splits the result into a list of "
5711 #: ../src/guestfs-actions.pod:1063
5712 msgid "See also: C<guestfs_sh_lines>"
5716 #: ../src/guestfs-actions.pod:1074
5717 msgid "guestfs_config"
5721 #: ../src/guestfs-actions.pod:1076
5725 " guestfs_config (guestfs_h *g,\n"
5726 " const char *qemuparam,\n"
5727 " const char *qemuvalue);\n"
5732 #: ../src/guestfs-actions.pod:1081 ../fish/guestfish-actions.pod:736
5734 "This can be used to add arbitrary qemu command line parameters of the form "
5735 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
5736 "setting some parameters which would interfere with parameters that we use."
5740 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:741
5741 msgid "The first character of C<param> string must be a C<-> (dash)."
5745 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:743
5746 msgid "C<value> can be NULL."
5750 #: ../src/guestfs-actions.pod:1094
5751 msgid "guestfs_copy_size"
5755 #: ../src/guestfs-actions.pod:1096
5759 " guestfs_copy_size (guestfs_h *g,\n"
5760 " const char *src,\n"
5761 " const char *dest,\n"
5767 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:749
5769 "This command copies exactly C<size> bytes from one source device or file "
5770 "C<src> to another destination device or file C<dest>."
5774 #: ../src/guestfs-actions.pod:1105 ../fish/guestfish-actions.pod:752
5776 "Note this will fail if the source is too short or if the destination is not "
5781 #: ../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:6744 ../src/guestfs-actions.pod:6763
5783 "This long-running command can generate progress notification messages so "
5784 "that the caller can display a progress bar or indicator. To receive these "
5785 "messages, the caller must register a progress callback. See "
5786 "L<guestfs(3)/guestfs_set_progress_callback>."
5790 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:3714 ../src/guestfs-actions.pod:4850 ../src/guestfs-actions.pod:6472 ../src/guestfs-actions.pod:6492 ../src/guestfs-actions.pod:6578
5791 msgid "(Added in 1.0.87)"
5795 #: ../src/guestfs-actions.pod:1117
5800 #: ../src/guestfs-actions.pod:1119
5804 " guestfs_cp (guestfs_h *g,\n"
5805 " const char *src,\n"
5806 " const char *dest);\n"
5811 #: ../src/guestfs-actions.pod:1124 ../fish/guestfish-actions.pod:759
5813 "This copies a file from C<src> to C<dest> where C<dest> is either a "
5814 "destination filename or destination directory."
5818 #: ../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:4317 ../src/guestfs-actions.pod:4694
5819 msgid "(Added in 1.0.18)"
5823 #: ../src/guestfs-actions.pod:1131
5824 msgid "guestfs_cp_a"
5828 #: ../src/guestfs-actions.pod:1133
5832 " guestfs_cp_a (guestfs_h *g,\n"
5833 " const char *src,\n"
5834 " const char *dest);\n"
5839 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:766
5841 "This copies a file or directory from C<src> to C<dest> recursively using the "
5846 #: ../src/guestfs-actions.pod:1145
5851 #: ../src/guestfs-actions.pod:1147
5855 " guestfs_dd (guestfs_h *g,\n"
5856 " const char *src,\n"
5857 " const char *dest);\n"
5862 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:773
5864 "This command copies from one source device or file C<src> to another "
5865 "destination device or file C<dest>. Normally you would use this to copy to "
5866 "or from a device or partition, for example to duplicate a filesystem."
5870 #: ../src/guestfs-actions.pod:1157
5872 "If the destination is a device, it must be as large or larger than the "
5873 "source file or device, otherwise the copy will fail. This command cannot do "
5874 "partial copies (see C<guestfs_copy_size>)."
5878 #: ../src/guestfs-actions.pod:1165
5883 #: ../src/guestfs-actions.pod:1167
5887 " guestfs_df (guestfs_h *g);\n"
5892 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:786
5893 msgid "This command runs the C<df> command to report disk space used."
5897 #: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:1189 ../fish/guestfish-actions.pod:788 ../fish/guestfish-actions.pod:799
5899 "This command is mostly useful for interactive sessions. It is I<not> "
5900 "intended that you try to parse the output string. Use C<statvfs> from "
5905 #: ../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:3824 ../src/guestfs-actions.pod:4217 ../src/guestfs-actions.pod:5979 ../src/guestfs-actions.pod:6003 ../src/guestfs-actions.pod:6611 ../src/guestfs-actions.pod:6624 ../src/guestfs-actions.pod:6637
5906 msgid "(Added in 1.0.54)"
5910 #: ../src/guestfs-actions.pod:1181
5911 msgid "guestfs_df_h"
5915 #: ../src/guestfs-actions.pod:1183
5919 " guestfs_df_h (guestfs_h *g);\n"
5924 #: ../src/guestfs-actions.pod:1186 ../fish/guestfish-actions.pod:796
5926 "This command runs the C<df -h> command to report disk space used in "
5927 "human-readable format."
5931 #: ../src/guestfs-actions.pod:1198
5932 msgid "guestfs_dmesg"
5936 #: ../src/guestfs-actions.pod:1200
5940 " guestfs_dmesg (guestfs_h *g);\n"
5945 #: ../src/guestfs-actions.pod:1203 ../fish/guestfish-actions.pod:807
5947 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
5948 "This is sometimes useful for extended debugging of problems."
5952 #: ../src/guestfs-actions.pod:1207
5954 "Another way to get the same information is to enable verbose messages with "
5955 "C<guestfs_set_verbose> or by setting the environment variable "
5956 "C<LIBGUESTFS_DEBUG=1> before running the program."
5960 #: ../src/guestfs-actions.pod:1217
5961 msgid "guestfs_download"
5965 #: ../src/guestfs-actions.pod:1219
5969 " guestfs_download (guestfs_h *g,\n"
5970 " const char *remotefilename,\n"
5971 " const char *filename);\n"
5976 #: ../src/guestfs-actions.pod:1224 ../src/guestfs-actions.pod:1249 ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:833
5978 "Download file C<remotefilename> and save it as C<filename> on the local "
5983 #: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:6235 ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:4147
5984 msgid "C<filename> can also be a named pipe."
5988 #: ../src/guestfs-actions.pod:1229
5989 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
5993 #: ../src/guestfs-actions.pod:1240
5994 msgid "guestfs_download_offset"
5998 #: ../src/guestfs-actions.pod:1242
6002 " guestfs_download_offset (guestfs_h *g,\n"
6003 " const char *remotefilename,\n"
6004 " const char *filename,\n"
6005 " int64_t offset,\n"
6011 #: ../src/guestfs-actions.pod:1252 ../fish/guestfish-actions.pod:836
6013 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6014 "region must be within the file or device)."
6018 #: ../src/guestfs-actions.pod:1255
6020 "Note that there is no limit on the amount of data that can be downloaded "
6021 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
6022 "full amount unless an error occurs."
6026 #: ../src/guestfs-actions.pod:1260
6027 msgid "See also C<guestfs_download>, C<guestfs_pread>."
6031 #: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:6270
6032 msgid "(Added in 1.5.17)"
6036 #: ../src/guestfs-actions.pod:1271
6037 msgid "guestfs_drop_caches"
6041 #: ../src/guestfs-actions.pod:1273
6045 " guestfs_drop_caches (guestfs_h *g,\n"
6046 " int whattodrop);\n"
6051 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:852
6053 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6054 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6055 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6059 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:857
6060 msgid "Setting C<whattodrop> to 3 should drop everything."
6064 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:859
6066 "This automatically calls L<sync(2)> before the operation, so that the "
6067 "maximum guest memory is freed."
6071 #: ../src/guestfs-actions.pod:1291
6076 #: ../src/guestfs-actions.pod:1293
6080 " guestfs_du (guestfs_h *g,\n"
6081 " const char *path);\n"
6086 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:866
6088 "This command runs the C<du -s> command to estimate file space usage for "
6093 #: ../src/guestfs-actions.pod:1300 ../fish/guestfish-actions.pod:869
6095 "C<path> can be a file or a directory. If C<path> is a directory then the "
6096 "estimate includes the contents of the directory and all subdirectories "
6101 #: ../src/guestfs-actions.pod:1304 ../fish/guestfish-actions.pod:873
6102 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6106 #: ../src/guestfs-actions.pod:1311
6107 msgid "guestfs_e2fsck_f"
6111 #: ../src/guestfs-actions.pod:1313
6115 " guestfs_e2fsck_f (guestfs_h *g,\n"
6116 " const char *device);\n"
6121 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:880
6123 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6124 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
6129 #: ../src/guestfs-actions.pod:1321
6131 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
6132 "Normally you should use C<guestfs_fsck>."
6136 #: ../src/guestfs-actions.pod:1326
6137 msgid "(Added in 1.0.29)"
6141 #: ../src/guestfs-actions.pod:1328
6142 msgid "guestfs_echo_daemon"
6146 #: ../src/guestfs-actions.pod:1330
6150 " guestfs_echo_daemon (guestfs_h *g,\n"
6151 " char *const *words);\n"
6156 #: ../src/guestfs-actions.pod:1334 ../fish/guestfish-actions.pod:891
6158 "This command concatenates the list of C<words> passed with single spaces "
6159 "between them and returns the resulting string."
6163 #: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:894
6164 msgid "You can use this command to test the connection through to the daemon."
6168 #: ../src/guestfs-actions.pod:1339
6169 msgid "See also C<guestfs_ping_daemon>."
6173 #: ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:5483
6174 msgid "(Added in 1.0.69)"
6178 #: ../src/guestfs-actions.pod:1346
6179 msgid "guestfs_egrep"
6183 #: ../src/guestfs-actions.pod:1348
6187 " guestfs_egrep (guestfs_h *g,\n"
6188 " const char *regex,\n"
6189 " const char *path);\n"
6194 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:902
6195 msgid "This calls the external C<egrep> program and returns the matching lines."
6199 #: ../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:3207 ../src/guestfs-actions.pod:3221 ../src/guestfs-actions.pod:3234 ../src/guestfs-actions.pod:3248 ../src/guestfs-actions.pod:4152 ../src/guestfs-actions.pod:5028 ../src/guestfs-actions.pod:5077 ../src/guestfs-actions.pod:5847 ../src/guestfs-actions.pod:5859 ../src/guestfs-actions.pod:5872 ../src/guestfs-actions.pod:5885 ../src/guestfs-actions.pod:5907 ../src/guestfs-actions.pod:5920 ../src/guestfs-actions.pod:5933 ../src/guestfs-actions.pod:5946 ../src/guestfs-actions.pod:6707 ../src/guestfs-actions.pod:6726 ../src/guestfs-actions.pod:6811 ../src/guestfs-actions.pod:6830 ../src/guestfs-actions.pod:6876 ../src/guestfs-actions.pod:6895
6200 msgid "(Added in 1.0.66)"
6204 #: ../src/guestfs-actions.pod:1365
6205 msgid "guestfs_egrepi"
6209 #: ../src/guestfs-actions.pod:1367
6213 " guestfs_egrepi (guestfs_h *g,\n"
6214 " const char *regex,\n"
6215 " const char *path);\n"
6220 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
6221 msgid "This calls the external C<egrep -i> program and returns the matching lines."
6225 #: ../src/guestfs-actions.pod:1384
6226 msgid "guestfs_equal"
6230 #: ../src/guestfs-actions.pod:1386
6234 " guestfs_equal (guestfs_h *g,\n"
6235 " const char *file1,\n"
6236 " const char *file2);\n"
6241 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
6243 "This compares the two files C<file1> and C<file2> and returns true if their "
6244 "content is exactly equal, or false otherwise."
6248 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:925
6249 msgid "The external L<cmp(1)> program is used for the comparison."
6253 #: ../src/guestfs-actions.pod:1400
6254 msgid "guestfs_exists"
6258 #: ../src/guestfs-actions.pod:1402
6262 " guestfs_exists (guestfs_h *g,\n"
6263 " const char *path);\n"
6268 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:931
6270 "This returns C<true> if and only if there is a file, directory (or anything) "
6271 "with the given C<path> name."
6275 #: ../src/guestfs-actions.pod:1409
6276 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6280 #: ../src/guestfs-actions.pod:1415
6281 msgid "guestfs_fallocate"
6285 #: ../src/guestfs-actions.pod:1417
6289 " guestfs_fallocate (guestfs_h *g,\n"
6290 " const char *path,\n"
6296 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1448 ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:959
6298 "This command preallocates a file (containing zero bytes) named C<path> of "
6299 "size C<len> bytes. If the file exists already, it is overwritten."
6303 #: ../src/guestfs-actions.pod:1426 ../fish/guestfish-actions.pod:944
6305 "Do not confuse this with the guestfish-specific C<alloc> command which "
6306 "allocates a file in the host and attaches it as a device."
6310 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:948
6312 "This function is deprecated. In new code, use the C<fallocate64> call "
6317 #: ../src/guestfs-actions.pod:1441
6318 msgid "guestfs_fallocate64"
6322 #: ../src/guestfs-actions.pod:1443
6326 " guestfs_fallocate64 (guestfs_h *g,\n"
6327 " const char *path,\n"
6333 #: ../src/guestfs-actions.pod:1452
6335 "Note that this call allocates disk blocks for the file. To create a sparse "
6336 "file use C<guestfs_truncate_size> instead."
6340 #: ../src/guestfs-actions.pod:1455
6342 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6343 "oversight it only allowed 30 bit lengths to be specified, effectively "
6344 "limiting the maximum size of files created through that call to 1GB."
6348 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:971
6350 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6351 "commands which create a file in the host and attach it as a device."
6355 #: ../src/guestfs-actions.pod:1466
6356 msgid "(Added in 1.3.17)"
6360 #: ../src/guestfs-actions.pod:1468
6361 msgid "guestfs_fgrep"
6365 #: ../src/guestfs-actions.pod:1470
6369 " guestfs_fgrep (guestfs_h *g,\n"
6370 " const char *pattern,\n"
6371 " const char *path);\n"
6376 #: ../src/guestfs-actions.pod:1475 ../fish/guestfish-actions.pod:979
6377 msgid "This calls the external C<fgrep> program and returns the matching lines."
6381 #: ../src/guestfs-actions.pod:1487
6382 msgid "guestfs_fgrepi"
6386 #: ../src/guestfs-actions.pod:1489
6390 " guestfs_fgrepi (guestfs_h *g,\n"
6391 " const char *pattern,\n"
6392 " const char *path);\n"
6397 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
6398 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
6402 #: ../src/guestfs-actions.pod:1506
6403 msgid "guestfs_file"
6407 #: ../src/guestfs-actions.pod:1508
6411 " guestfs_file (guestfs_h *g,\n"
6412 " const char *path);\n"
6417 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:999
6419 "This call uses the standard L<file(1)> command to determine the type or "
6420 "contents of the file."
6424 #: ../src/guestfs-actions.pod:1515 ../fish/guestfish-actions.pod:1002
6426 "This call will also transparently look inside various types of compressed "
6431 #: ../src/guestfs-actions.pod:1518 ../fish/guestfish-actions.pod:1005
6433 "The exact command which runs is C<file -zb path>. Note in particular that "
6434 "the filename is not prepended to the output (the C<-b> option)."
6438 #: ../src/guestfs-actions.pod:1522
6440 "This command can also be used on C</dev/> devices (and partitions, LV "
6441 "names). You can for example use this to determine if a device contains a "
6442 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
6446 #: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1014
6448 "If the C<path> does not begin with C</dev/> then this command only works for "
6449 "the content of regular files. For other file types (directory, symbolic "
6450 "link etc) it will just return the string C<directory> etc."
6454 #: ../src/guestfs-actions.pod:1537
6455 msgid "guestfs_file_architecture"
6459 #: ../src/guestfs-actions.pod:1539
6463 " guestfs_file_architecture (guestfs_h *g,\n"
6464 " const char *filename);\n"
6469 #: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1023
6471 "This detects the architecture of the binary C<filename>, and returns it if "
6476 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1026
6477 msgid "Currently defined architectures are:"
6481 #: ../src/guestfs-actions.pod:1550 ../fish/guestfish-actions.pod:1030
6486 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1032
6488 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6489 "irrespective of the precise processor requirements of the binary."
6493 #: ../src/guestfs-actions.pod:1555 ../fish/guestfish-actions.pod:1035
6498 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1037
6499 msgid "64 bit x86-64."
6503 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1039
6508 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1041
6509 msgid "32 bit SPARC."
6513 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1043
6518 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1045
6519 msgid "64 bit SPARC V9 and above."
6523 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1047
6528 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1049
6529 msgid "Intel Itanium."
6533 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1051
6538 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1053
6539 msgid "32 bit Power PC."
6543 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1055
6548 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1057
6549 msgid "64 bit Power PC."
6553 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1061
6554 msgid "Libguestfs may return other architecture strings in future."
6558 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1063
6559 msgid "The function works on at least the following types of files:"
6563 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1069
6564 msgid "many types of Un*x and Linux binary"
6568 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1073
6569 msgid "many types of Un*x and Linux shared library"
6573 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1077
6574 msgid "Windows Win32 and Win64 binaries"
6578 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1081
6579 msgid "Windows Win32 and Win64 DLLs"
6583 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1083
6584 msgid "Win32 binaries and DLLs return C<i386>."
6588 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1085
6589 msgid "Win64 binaries and DLLs return C<x86_64>."
6593 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1089
6594 msgid "Linux kernel modules"
6598 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1093
6599 msgid "Linux new-style initrd images"
6603 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1097
6604 msgid "some non-x86 Linux vmlinuz kernels"
6608 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1101
6609 msgid "What it can't do currently:"
6613 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1107
6614 msgid "static libraries (libfoo.a)"
6618 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1111
6619 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6623 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1115
6624 msgid "x86 Linux vmlinuz kernels"
6628 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1117
6630 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6631 "compressed code, and are horribly hard to unpack. If you want to find the "
6632 "architecture of a kernel, use the architecture of the associated initrd or "
6633 "kernel module(s) instead."
6637 #: ../src/guestfs-actions.pod:1647 ../src/guestfs-actions.pod:1810 ../src/guestfs-actions.pod:1827 ../src/guestfs-actions.pod:2478 ../src/guestfs-actions.pod:2551 ../src/guestfs-actions.pod:2577 ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2625 ../src/guestfs-actions.pod:2658 ../src/guestfs-actions.pod:2738 ../src/guestfs-actions.pod:2794 ../src/guestfs-actions.pod:2860 ../src/guestfs-actions.pod:2992
6638 msgid "(Added in 1.5.3)"
6642 #: ../src/guestfs-actions.pod:1649
6643 msgid "guestfs_filesize"
6647 #: ../src/guestfs-actions.pod:1651
6651 " guestfs_filesize (guestfs_h *g,\n"
6652 " const char *file);\n"
6657 #: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1128
6658 msgid "This command returns the size of C<file> in bytes."
6662 #: ../src/guestfs-actions.pod:1657
6664 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
6665 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
6666 "devices, use C<guestfs_blockdev_getsize64>."
6670 #: ../src/guestfs-actions.pod:1663
6671 msgid "(Added in 1.0.82)"
6675 #: ../src/guestfs-actions.pod:1665
6676 msgid "guestfs_fill"
6680 #: ../src/guestfs-actions.pod:1667
6684 " guestfs_fill (guestfs_h *g,\n"
6687 " const char *path);\n"
6692 #: ../src/guestfs-actions.pod:1673 ../fish/guestfish-actions.pod:1138
6694 "This command creates a new file called C<path>. The initial content of the "
6695 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
6700 #: ../src/guestfs-actions.pod:1677
6702 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6703 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
6704 "bytes use C<guestfs_fill_pattern>."
6708 #: ../src/guestfs-actions.pod:1689
6709 msgid "(Added in 1.0.79)"
6713 #: ../src/guestfs-actions.pod:1691
6714 msgid "guestfs_fill_pattern"
6718 #: ../src/guestfs-actions.pod:1693
6722 " guestfs_fill_pattern (guestfs_h *g,\n"
6723 " const char *pattern,\n"
6725 " const char *path);\n"
6730 #: ../src/guestfs-actions.pod:1699
6732 "This function is like C<guestfs_fill> except that it creates a new file of "
6733 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
6734 "pattern is truncated if necessary to ensure the length of the file is "
6735 "exactly C<len> bytes."
6739 #: ../src/guestfs-actions.pod:1711
6740 msgid "(Added in 1.3.12)"
6744 #: ../src/guestfs-actions.pod:1713
6745 msgid "guestfs_find"
6749 #: ../src/guestfs-actions.pod:1715
6753 " guestfs_find (guestfs_h *g,\n"
6754 " const char *directory);\n"
6759 #: ../src/guestfs-actions.pod:1719 ../fish/guestfish-actions.pod:1160
6761 "This command lists out all files and directories, recursively, starting at "
6762 "C<directory>. It is essentially equivalent to running the shell command "
6763 "C<find directory -print> but some post-processing happens on the output, "
6768 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1165
6770 "This returns a list of strings I<without any prefix>. Thus if the directory "
6775 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1168
6785 #: ../src/guestfs-actions.pod:1731
6786 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
6790 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1175
6801 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1180
6802 msgid "If C<directory> is not a directory, then this command returns an error."
6806 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1183
6807 msgid "The returned list is sorted."
6811 #: ../src/guestfs-actions.pod:1744
6812 msgid "See also C<guestfs_find0>."
6816 #: ../src/guestfs-actions.pod:1753 ../src/guestfs-actions.pod:3651 ../src/guestfs-actions.pod:5112
6817 msgid "(Added in 1.0.27)"
6821 #: ../src/guestfs-actions.pod:1755
6822 msgid "guestfs_find0"
6826 #: ../src/guestfs-actions.pod:1757
6830 " guestfs_find0 (guestfs_h *g,\n"
6831 " const char *directory,\n"
6832 " const char *files);\n"
6837 #: ../src/guestfs-actions.pod:1762 ../fish/guestfish-actions.pod:1194
6839 "This command lists out all files and directories, recursively, starting at "
6840 "C<directory>, placing the resulting list in the external file called "
6845 #: ../src/guestfs-actions.pod:1766
6847 "This command works the same way as C<guestfs_find> with the following "
6852 #: ../src/guestfs-actions.pod:1773 ../fish/guestfish-actions.pod:1205
6853 msgid "The resulting list is written to an external file."
6857 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1209
6859 "Items (filenames) in the result are separated by C<\\0> characters. See "
6860 "L<find(1)> option I<-print0>."
6864 #: ../src/guestfs-actions.pod:1782 ../fish/guestfish-actions.pod:1214
6865 msgid "This command is not limited in the number of names that it can return."
6869 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1219
6870 msgid "The result list is not sorted."
6874 #: ../src/guestfs-actions.pod:1793
6875 msgid "(Added in 1.0.74)"
6879 #: ../src/guestfs-actions.pod:1795
6880 msgid "guestfs_findfs_label"
6884 #: ../src/guestfs-actions.pod:1797
6888 " guestfs_findfs_label (guestfs_h *g,\n"
6889 " const char *label);\n"
6894 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1229
6896 "This command searches the filesystems and returns the one which has the "
6897 "given label. An error is returned if no such filesystem can be found."
6901 #: ../src/guestfs-actions.pod:1805
6902 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
6906 #: ../src/guestfs-actions.pod:1812
6907 msgid "guestfs_findfs_uuid"
6911 #: ../src/guestfs-actions.pod:1814
6915 " guestfs_findfs_uuid (guestfs_h *g,\n"
6916 " const char *uuid);\n"
6921 #: ../src/guestfs-actions.pod:1818 ../fish/guestfish-actions.pod:1239
6923 "This command searches the filesystems and returns the one which has the "
6924 "given UUID. An error is returned if no such filesystem can be found."
6928 #: ../src/guestfs-actions.pod:1822
6929 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
6933 #: ../src/guestfs-actions.pod:1829
6934 msgid "guestfs_fsck"
6938 #: ../src/guestfs-actions.pod:1831
6942 " guestfs_fsck (guestfs_h *g,\n"
6943 " const char *fstype,\n"
6944 " const char *device);\n"
6949 #: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1249
6951 "This runs the filesystem checker (fsck) on C<device> which should have "
6952 "filesystem type C<fstype>."
6956 #: ../src/guestfs-actions.pod:1839 ../fish/guestfish-actions.pod:1252
6958 "The returned integer is the status. See L<fsck(8)> for the list of status "
6959 "codes from C<fsck>."
6963 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1261
6964 msgid "Multiple status codes can be summed together."
6968 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1265
6970 "A non-zero return code can mean \"success\", for example if errors have been "
6971 "corrected on the filesystem."
6975 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1270
6976 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
6980 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1275
6981 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
6985 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:6749
6986 msgid "(Added in 1.0.16)"
6990 #: ../src/guestfs-actions.pod:1868
6991 msgid "guestfs_get_append"
6995 #: ../src/guestfs-actions.pod:1870
6999 " guestfs_get_append (guestfs_h *g);\n"
7004 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1281
7006 "Return the additional kernel options which are added to the guest kernel "
7011 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1284
7012 msgid "If C<NULL> then no options are added."
7016 #: ../src/guestfs-actions.pod:1878
7018 "This function returns a string which may be NULL. There is no way to return "
7019 "an error from this function. The string is owned by the guest handle and "
7020 "must I<not> be freed."
7024 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:4790 ../src/guestfs-actions.pod:5253 ../src/guestfs-actions.pod:5621 ../src/guestfs-actions.pod:5640 ../src/guestfs-actions.pod:5656 ../src/guestfs-actions.pod:5673 ../src/guestfs-actions.pod:6420 ../src/guestfs-actions.pod:6438 ../src/guestfs-actions.pod:6792
7025 msgid "(Added in 1.0.26)"
7029 #: ../src/guestfs-actions.pod:1884
7030 msgid "guestfs_get_autosync"
7034 #: ../src/guestfs-actions.pod:1886
7038 " guestfs_get_autosync (guestfs_h *g);\n"
7043 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1290
7044 msgid "Get the autosync flag."
7048 #: ../src/guestfs-actions.pod:1895
7049 msgid "guestfs_get_direct"
7053 #: ../src/guestfs-actions.pod:1897
7057 " guestfs_get_direct (guestfs_h *g);\n"
7062 #: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1296
7063 msgid "Return the direct appliance mode flag."
7067 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:5294
7068 msgid "(Added in 1.0.72)"
7072 #: ../src/guestfs-actions.pod:1906
7073 msgid "guestfs_get_e2label"
7077 #: ../src/guestfs-actions.pod:1908
7081 " guestfs_get_e2label (guestfs_h *g,\n"
7082 " const char *device);\n"
7087 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1302
7088 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7092 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1305
7094 "This function is deprecated. In new code, use the C<vfs_label> call "
7099 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:5312 ../src/guestfs-actions.pod:5331
7100 msgid "(Added in 1.0.15)"
7104 #: ../src/guestfs-actions.pod:1927
7105 msgid "guestfs_get_e2uuid"
7109 #: ../src/guestfs-actions.pod:1929
7113 " guestfs_get_e2uuid (guestfs_h *g,\n"
7114 " const char *device);\n"
7119 #: ../src/guestfs-actions.pod:1933 ../fish/guestfish-actions.pod:1316
7120 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7124 #: ../src/guestfs-actions.pod:1939 ../fish/guestfish-actions.pod:1319
7125 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
7129 #: ../src/guestfs-actions.pod:1948
7130 msgid "guestfs_get_memsize"
7134 #: ../src/guestfs-actions.pod:1950
7138 " guestfs_get_memsize (guestfs_h *g);\n"
7143 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1330
7144 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
7148 #: ../src/guestfs-actions.pod:1956
7150 "If C<guestfs_set_memsize> was not called on this handle, and if "
7151 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7152 "value for memsize."
7156 #: ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2041 ../src/guestfs-actions.pod:5347 ../src/guestfs-actions.pod:5454 ../fish/guestfish-actions.pod:1337 ../fish/guestfish-actions.pod:1388 ../fish/guestfish-actions.pod:3554 ../fish/guestfish-actions.pod:3641
7157 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7161 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:3942 ../src/guestfs-actions.pod:4057 ../src/guestfs-actions.pod:4076 ../src/guestfs-actions.pod:4095 ../src/guestfs-actions.pod:4107 ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4137 ../src/guestfs-actions.pod:5015 ../src/guestfs-actions.pod:5352 ../src/guestfs-actions.pod:5595 ../src/guestfs-actions.pod:6196
7162 msgid "(Added in 1.0.55)"
7166 #: ../src/guestfs-actions.pod:1967
7167 msgid "guestfs_get_network"
7171 #: ../src/guestfs-actions.pod:1969
7175 " guestfs_get_network (guestfs_h *g);\n"
7180 #: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1344
7181 msgid "This returns the enable network flag."
7185 #: ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:5371
7186 msgid "(Added in 1.5.4)"
7190 #: ../src/guestfs-actions.pod:1978
7191 msgid "guestfs_get_path"
7195 #: ../src/guestfs-actions.pod:1980
7199 " guestfs_get_path (guestfs_h *g);\n"
7204 #: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1350
7205 msgid "Return the current search path."
7209 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1352
7211 "This is always non-NULL. If it wasn't set already, then this will return "
7216 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2017
7218 "This function returns a string, or NULL on error. The string is owned by "
7219 "the guest handle and must I<not> be freed."
7223 #: ../src/guestfs-actions.pod:1993
7224 msgid "guestfs_get_pid"
7228 #: ../src/guestfs-actions.pod:1995
7232 " guestfs_get_pid (guestfs_h *g);\n"
7237 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1361
7239 "Return the process ID of the qemu subprocess. If there is no qemu "
7240 "subprocess, then this will return an error."
7244 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1364
7245 msgid "This is an internal call used for debugging and testing."
7249 #: ../src/guestfs-actions.pod:2005
7250 msgid "(Added in 1.0.56)"
7254 #: ../src/guestfs-actions.pod:2007
7255 msgid "guestfs_get_qemu"
7259 #: ../src/guestfs-actions.pod:2009
7263 " guestfs_get_qemu (guestfs_h *g);\n"
7268 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1370
7269 msgid "Return the current qemu binary."
7273 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1372
7275 "This is always non-NULL. If it wasn't set already, then this will return "
7276 "the default qemu binary name."
7280 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5416
7281 msgid "(Added in 1.0.6)"
7285 #: ../src/guestfs-actions.pod:2022
7286 msgid "guestfs_get_recovery_proc"
7290 #: ../src/guestfs-actions.pod:2024
7294 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7299 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1379
7300 msgid "Return the recovery process enabled flag."
7304 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:3082 ../src/guestfs-actions.pod:3349 ../src/guestfs-actions.pod:3749 ../src/guestfs-actions.pod:3781 ../src/guestfs-actions.pod:4720 ../src/guestfs-actions.pod:5063 ../src/guestfs-actions.pod:5440 ../src/guestfs-actions.pod:6099 ../src/guestfs-actions.pod:6119 ../src/guestfs-actions.pod:6301
7305 msgid "(Added in 1.0.77)"
7309 #: ../src/guestfs-actions.pod:2033
7310 msgid "guestfs_get_selinux"
7314 #: ../src/guestfs-actions.pod:2035
7318 " guestfs_get_selinux (guestfs_h *g);\n"
7323 #: ../src/guestfs-actions.pod:2038
7325 "This returns the current setting of the selinux flag which is passed to the "
7326 "appliance at boot time. See C<guestfs_set_selinux>."
7330 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2109 ../src/guestfs-actions.pod:5459 ../src/guestfs-actions.pod:5513
7331 msgid "(Added in 1.0.67)"
7335 #: ../src/guestfs-actions.pod:2048
7336 msgid "guestfs_get_state"
7340 #: ../src/guestfs-actions.pod:2050
7344 " guestfs_get_state (guestfs_h *g);\n"
7349 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1395
7351 "This returns the current state as an opaque integer. This is only useful "
7352 "for printing debug and internal error messages."
7356 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:2885 ../src/guestfs-actions.pod:2914 ../src/guestfs-actions.pod:2975 ../src/guestfs-actions.pod:3002 ../fish/guestfish-actions.pod:1398 ../fish/guestfish-actions.pod:1987 ../fish/guestfish-actions.pod:2005 ../fish/guestfish-actions.pod:2043 ../fish/guestfish-actions.pod:2059
7357 msgid "For more information on states, see L<guestfs(3)>."
7361 #: ../src/guestfs-actions.pod:2062
7362 msgid "guestfs_get_trace"
7366 #: ../src/guestfs-actions.pod:2064
7370 " guestfs_get_trace (guestfs_h *g);\n"
7375 #: ../src/guestfs-actions.pod:2067 ../fish/guestfish-actions.pod:1404
7376 msgid "Return the command trace flag."
7380 #: ../src/guestfs-actions.pod:2073
7381 msgid "guestfs_get_umask"
7385 #: ../src/guestfs-actions.pod:2075
7389 " guestfs_get_umask (guestfs_h *g);\n"
7394 #: ../src/guestfs-actions.pod:2078
7396 "Return the current umask. By default the umask is C<022> unless it has been "
7397 "set by calling C<guestfs_umask>."
7401 #: ../src/guestfs-actions.pod:2085
7402 msgid "guestfs_get_verbose"
7406 #: ../src/guestfs-actions.pod:2087
7410 " guestfs_get_verbose (guestfs_h *g);\n"
7415 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1417
7416 msgid "This returns the verbose messages flag."
7420 #: ../src/guestfs-actions.pod:2096
7421 msgid "guestfs_getcon"
7425 #: ../src/guestfs-actions.pod:2098
7429 " guestfs_getcon (guestfs_h *g);\n"
7434 #: ../src/guestfs-actions.pod:2101 ../fish/guestfish-actions.pod:1423
7435 msgid "This gets the SELinux security context of the daemon."
7439 #: ../src/guestfs-actions.pod:2103
7440 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
7444 #: ../src/guestfs-actions.pod:2111
7445 msgid "guestfs_getxattrs"
7449 #: ../src/guestfs-actions.pod:2113
7452 " struct guestfs_xattr_list *\n"
7453 " guestfs_getxattrs (guestfs_h *g,\n"
7454 " const char *path);\n"
7459 #: ../src/guestfs-actions.pod:2117 ../fish/guestfish-actions.pod:1432
7460 msgid "This call lists the extended attributes of the file or directory C<path>."
7464 #: ../src/guestfs-actions.pod:2120 ../fish/guestfish-actions.pod:1435
7466 "At the system call level, this is a combination of the L<listxattr(2)> and "
7467 "L<getxattr(2)> calls."
7471 #: ../src/guestfs-actions.pod:2123
7472 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
7476 #: ../src/guestfs-actions.pod:2125 ../src/guestfs-actions.pod:3094 ../src/guestfs-actions.pod:3745
7478 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
7479 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
7483 #: ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:3098 ../src/guestfs-actions.pod:3263 ../src/guestfs-actions.pod:3299 ../src/guestfs-actions.pod:5093 ../src/guestfs-actions.pod:5532 ../src/guestfs-actions.pod:6857
7484 msgid "(Added in 1.0.59)"
7488 #: ../src/guestfs-actions.pod:2131
7489 msgid "guestfs_glob_expand"
7493 #: ../src/guestfs-actions.pod:2133
7497 " guestfs_glob_expand (guestfs_h *g,\n"
7498 " const char *pattern);\n"
7503 #: ../src/guestfs-actions.pod:2137 ../fish/guestfish-actions.pod:1444
7505 "This command searches for all the pathnames matching C<pattern> according to "
7506 "the wildcard expansion rules used by the shell."
7510 #: ../src/guestfs-actions.pod:2141 ../fish/guestfish-actions.pod:1448
7511 msgid "If no paths match, then this returns an empty list (note: not an error)."
7515 #: ../src/guestfs-actions.pod:2144 ../fish/guestfish-actions.pod:1451
7517 "It is just a wrapper around the C L<glob(3)> function with flags "
7518 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
7522 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:5697 ../src/guestfs-actions.pod:5714
7523 msgid "(Added in 1.0.50)"
7527 #: ../src/guestfs-actions.pod:2154
7528 msgid "guestfs_grep"
7532 #: ../src/guestfs-actions.pod:2156
7536 " guestfs_grep (guestfs_h *g,\n"
7537 " const char *regex,\n"
7538 " const char *path);\n"
7543 #: ../src/guestfs-actions.pod:2161 ../fish/guestfish-actions.pod:1459
7544 msgid "This calls the external C<grep> program and returns the matching lines."
7548 #: ../src/guestfs-actions.pod:2173
7549 msgid "guestfs_grepi"
7553 #: ../src/guestfs-actions.pod:2175
7557 " guestfs_grepi (guestfs_h *g,\n"
7558 " const char *regex,\n"
7559 " const char *path);\n"
7564 #: ../src/guestfs-actions.pod:2180 ../fish/guestfish-actions.pod:1469
7565 msgid "This calls the external C<grep -i> program and returns the matching lines."
7569 #: ../src/guestfs-actions.pod:2192
7570 msgid "guestfs_grub_install"
7574 #: ../src/guestfs-actions.pod:2194
7578 " guestfs_grub_install (guestfs_h *g,\n"
7579 " const char *root,\n"
7580 " const char *device);\n"
7585 #: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1479
7587 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
7588 "the root directory being C<root>."
7592 #: ../src/guestfs-actions.pod:2202 ../fish/guestfish-actions.pod:1482
7594 "Note: If grub-install reports the error \"No suitable drive was found in the "
7595 "generated device map.\" it may be that you need to create a "
7596 "C</boot/grub/device.map> file first that contains the mapping between grub "
7597 "device names and Linux device names. It is usually sufficient to create a "
7602 #: ../src/guestfs-actions.pod:2209 ../fish/guestfish-actions.pod:1489
7610 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1491
7611 msgid "replacing C</dev/vda> with the name of the installation device."
7615 #: ../src/guestfs-actions.pod:2215
7616 msgid "(Added in 1.0.17)"
7620 #: ../src/guestfs-actions.pod:2217
7621 msgid "guestfs_head"
7625 #: ../src/guestfs-actions.pod:2219
7629 " guestfs_head (guestfs_h *g,\n"
7630 " const char *path);\n"
7635 #: ../src/guestfs-actions.pod:2223 ../fish/guestfish-actions.pod:1497
7637 "This command returns up to the first 10 lines of a file as a list of "
7642 #: ../src/guestfs-actions.pod:2235
7643 msgid "guestfs_head_n"
7647 #: ../src/guestfs-actions.pod:2237
7651 " guestfs_head_n (guestfs_h *g,\n"
7653 " const char *path);\n"
7658 #: ../src/guestfs-actions.pod:2242 ../fish/guestfish-actions.pod:1507
7660 "If the parameter C<nrlines> is a positive number, this returns the first "
7661 "C<nrlines> lines of the file C<path>."
7665 #: ../src/guestfs-actions.pod:2245 ../fish/guestfish-actions.pod:1510
7667 "If the parameter C<nrlines> is a negative number, this returns lines from "
7668 "the file C<path>, excluding the last C<nrlines> lines."
7672 #: ../src/guestfs-actions.pod:2248 ../src/guestfs-actions.pod:5994 ../fish/guestfish-actions.pod:1513 ../fish/guestfish-actions.pod:3987
7673 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7677 #: ../src/guestfs-actions.pod:2259
7678 msgid "guestfs_hexdump"
7682 #: ../src/guestfs-actions.pod:2261
7686 " guestfs_hexdump (guestfs_h *g,\n"
7687 " const char *path);\n"
7692 #: ../src/guestfs-actions.pod:2265 ../fish/guestfish-actions.pod:1522
7694 "This runs C<hexdump -C> on the given C<path>. The result is the "
7695 "human-readable, canonical hex dump of the file."
7699 #: ../src/guestfs-actions.pod:2274 ../src/guestfs-actions.pod:5778 ../src/guestfs-actions.pod:5833
7700 msgid "(Added in 1.0.22)"
7704 #: ../src/guestfs-actions.pod:2276
7705 msgid "guestfs_initrd_cat"
7709 #: ../src/guestfs-actions.pod:2278
7713 " guestfs_initrd_cat (guestfs_h *g,\n"
7714 " const char *initrdpath,\n"
7715 " const char *filename,\n"
7716 " size_t *size_r);\n"
7721 #: ../src/guestfs-actions.pod:2284 ../fish/guestfish-actions.pod:1532
7723 "This command unpacks the file C<filename> from the initrd file called "
7724 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7729 #: ../src/guestfs-actions.pod:2288 ../fish/guestfish-actions.pod:1536
7731 "For example, in guestfish you could use the following command to examine the "
7732 "boot script (usually called C</init>) contained in a Linux initrd or "
7737 #: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1540
7740 " initrd-cat /boot/initrd-<version>.img init\n"
7745 #: ../src/guestfs-actions.pod:2294
7746 msgid "See also C<guestfs_initrd_list>."
7750 #: ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:4713 ../src/guestfs-actions.pod:4739 ../src/guestfs-actions.pod:4920
7752 "This function returns a buffer, or NULL on error. The size of the returned "
7753 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
7758 #: ../src/guestfs-actions.pod:2305
7759 msgid "guestfs_initrd_list"
7763 #: ../src/guestfs-actions.pod:2307
7767 " guestfs_initrd_list (guestfs_h *g,\n"
7768 " const char *path);\n"
7773 #: ../src/guestfs-actions.pod:2311 ../fish/guestfish-actions.pod:1551
7774 msgid "This command lists out files contained in an initrd."
7778 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1553
7780 "The files are listed without any initial C</> character. The files are "
7781 "listed in the order they appear (not necessarily alphabetical). Directory "
7782 "names are listed as separate items."
7786 #: ../src/guestfs-actions.pod:2317 ../fish/guestfish-actions.pod:1557
7788 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
7789 "initrd. We I<only> support the newer initramfs format (compressed cpio "
7794 #: ../src/guestfs-actions.pod:2327
7795 msgid "guestfs_inotify_add_watch"
7799 #: ../src/guestfs-actions.pod:2329
7803 " guestfs_inotify_add_watch (guestfs_h *g,\n"
7804 " const char *path,\n"
7810 #: ../src/guestfs-actions.pod:2334 ../fish/guestfish-actions.pod:1565
7811 msgid "Watch C<path> for the events listed in C<mask>."
7815 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1567
7817 "Note that if C<path> is a directory then events within that directory are "
7818 "watched, but this does I<not> happen recursively (in subdirectories)."
7822 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1571
7824 "Note for non-C or non-Linux callers: the inotify events are defined by the "
7825 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
7829 #: ../src/guestfs-actions.pod:2348
7830 msgid "guestfs_inotify_close"
7834 #: ../src/guestfs-actions.pod:2350
7838 " guestfs_inotify_close (guestfs_h *g);\n"
7843 #: ../src/guestfs-actions.pod:2353 ../fish/guestfish-actions.pod:1579
7845 "This closes the inotify handle which was previously opened by inotify_init. "
7846 "It removes all watches, throws away any pending events, and deallocates all "
7851 #: ../src/guestfs-actions.pod:2361
7852 msgid "guestfs_inotify_files"
7856 #: ../src/guestfs-actions.pod:2363
7860 " guestfs_inotify_files (guestfs_h *g);\n"
7865 #: ../src/guestfs-actions.pod:2366
7867 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
7868 "returns a list of pathnames of objects that were touched. The returned "
7869 "pathnames are sorted and deduplicated."
7873 #: ../src/guestfs-actions.pod:2376
7874 msgid "guestfs_inotify_init"
7878 #: ../src/guestfs-actions.pod:2378
7882 " guestfs_inotify_init (guestfs_h *g,\n"
7883 " int maxevents);\n"
7888 #: ../src/guestfs-actions.pod:2382 ../fish/guestfish-actions.pod:1595
7890 "This command creates a new inotify handle. The inotify subsystem can be "
7891 "used to notify events which happen to objects in the guest filesystem."
7895 #: ../src/guestfs-actions.pod:2386
7897 "C<maxevents> is the maximum number of events which will be queued up between "
7898 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
7899 "passed as C<0>, then the kernel (or previously set) default is used. For "
7900 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
7901 "throws away events, but records the fact that it threw them away by setting "
7902 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
7903 "C<guestfs_inotify_read>)."
7907 #: ../src/guestfs-actions.pod:2396
7909 "Before any events are generated, you have to add some watches to the "
7910 "internal watch list. See: C<guestfs_inotify_add_watch>, "
7911 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
7915 #: ../src/guestfs-actions.pod:2402
7917 "Queued up events should be read periodically by calling "
7918 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
7919 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
7920 "often enough then you risk the internal queue overflowing."
7924 #: ../src/guestfs-actions.pod:2409
7926 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
7927 "This also removes any watches automatically."
7931 #: ../src/guestfs-actions.pod:2413 ../fish/guestfish-actions.pod:1626
7933 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
7934 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
7935 "that there is one global inotify handle per libguestfs instance."
7939 #: ../src/guestfs-actions.pod:2422
7940 msgid "guestfs_inotify_read"
7944 #: ../src/guestfs-actions.pod:2424
7947 " struct guestfs_inotify_event_list *\n"
7948 " guestfs_inotify_read (guestfs_h *g);\n"
7953 #: ../src/guestfs-actions.pod:2427 ../fish/guestfish-actions.pod:1635
7955 "Return the complete queue of events that have happened since the previous "
7960 #: ../src/guestfs-actions.pod:2430 ../fish/guestfish-actions.pod:1638
7961 msgid "If no events have happened, this returns an empty list."
7965 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1640
7967 "I<Note>: In order to make sure that all events have been read, you must call "
7968 "this function repeatedly until it returns an empty list. The reason is that "
7969 "the call will read events up to the maximum appliance-to-host message size "
7970 "and leave remaining events in the queue."
7974 #: ../src/guestfs-actions.pod:2438
7976 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
7977 "there was an error. I<The caller must call "
7978 "C<guestfs_free_inotify_event_list> after use>."
7982 #: ../src/guestfs-actions.pod:2444
7983 msgid "guestfs_inotify_rm_watch"
7987 #: ../src/guestfs-actions.pod:2446
7991 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
7997 #: ../src/guestfs-actions.pod:2450
7999 "Remove a previously defined inotify watch. See "
8000 "C<guestfs_inotify_add_watch>."
8004 #: ../src/guestfs-actions.pod:2457
8005 msgid "guestfs_inspect_get_arch"
8009 #: ../src/guestfs-actions.pod:2459
8013 " guestfs_inspect_get_arch (guestfs_h *g,\n"
8014 " const char *root);\n"
8019 #: ../src/guestfs-actions.pod:2463 ../src/guestfs-actions.pod:2486 ../src/guestfs-actions.pod:2559 ../src/guestfs-actions.pod:2585 ../src/guestfs-actions.pod:2612 ../src/guestfs-actions.pod:2633 ../src/guestfs-actions.pod:2666 ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2764 ../src/guestfs-actions.pod:2802
8021 "This function should only be called with a root device string as returned by "
8022 "C<guestfs_inspect_os>."
8026 #: ../src/guestfs-actions.pod:2466
8028 "This returns the architecture of the inspected operating system. The "
8029 "possible return values are listed under C<guestfs_file_architecture>."
8033 #: ../src/guestfs-actions.pod:2470 ../fish/guestfish-actions.pod:1664
8035 "If the architecture could not be determined, then the string C<unknown> is "
8040 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:2600 ../src/guestfs-actions.pod:2682 ../src/guestfs-actions.pod:2711 ../src/guestfs-actions.pod:2733 ../src/guestfs-actions.pod:2752 ../src/guestfs-actions.pod:2789 ../src/guestfs-actions.pod:2812 ../src/guestfs-actions.pod:2852 ../fish/guestfish-actions.pod:1667 ../fish/guestfish-actions.pod:1733 ../fish/guestfish-actions.pod:1772 ../fish/guestfish-actions.pod:1832 ../fish/guestfish-actions.pod:1856 ../fish/guestfish-actions.pod:1873 ../fish/guestfish-actions.pod:1886 ../fish/guestfish-actions.pod:1917 ../fish/guestfish-actions.pod:1933 ../fish/guestfish-actions.pod:1967
8041 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
8045 #: ../src/guestfs-actions.pod:2480
8046 msgid "guestfs_inspect_get_distro"
8050 #: ../src/guestfs-actions.pod:2482
8054 " guestfs_inspect_get_distro (guestfs_h *g,\n"
8055 " const char *root);\n"
8060 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1676
8061 msgid "This returns the distro (distribution) of the inspected operating system."
8065 #: ../src/guestfs-actions.pod:2492 ../fish/guestfish-actions.pod:1679
8066 msgid "Currently defined distros are:"
8070 #: ../src/guestfs-actions.pod:2496 ../fish/guestfish-actions.pod:1683
8071 msgid "\"archlinux\""
8075 #: ../src/guestfs-actions.pod:2498 ../fish/guestfish-actions.pod:1685
8080 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1687
8085 #: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1689
8086 msgid "Debian or a Debian-derived distro such as Ubuntu."
8090 #: ../src/guestfs-actions.pod:2504 ../fish/guestfish-actions.pod:1691
8095 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1693
8100 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1695
8105 #: ../src/guestfs-actions.pod:2510 ../fish/guestfish-actions.pod:1697
8110 #: ../src/guestfs-actions.pod:2512 ../fish/guestfish-actions.pod:1699
8115 #: ../src/guestfs-actions.pod:2514 ../fish/guestfish-actions.pod:1701
8120 #: ../src/guestfs-actions.pod:2516 ../fish/guestfish-actions.pod:1703
8125 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1705
8130 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1707
8131 msgid "\"redhat-based\""
8135 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1709
8136 msgid "Some Red Hat-derived distro."
8140 #: ../src/guestfs-actions.pod:2524 ../fish/guestfish-actions.pod:1711
8145 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1713
8146 msgid "Red Hat Enterprise Linux and some derivatives."
8150 #: ../src/guestfs-actions.pod:2528 ../src/guestfs-actions.pod:2776 ../fish/guestfish-actions.pod:1715 ../fish/guestfish-actions.pod:1904
8155 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1717
8157 "Windows does not have distributions. This string is returned if the OS type "
8162 #: ../src/guestfs-actions.pod:2533 ../fish/guestfish-actions.pod:1720
8167 #: ../src/guestfs-actions.pod:2535 ../fish/guestfish-actions.pod:1722
8172 #: ../src/guestfs-actions.pod:2537 ../src/guestfs-actions.pod:2780 ../fish/guestfish-actions.pod:1724 ../fish/guestfish-actions.pod:1908
8177 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1726
8178 msgid "The distro could not be determined."
8182 #: ../src/guestfs-actions.pod:2543 ../src/guestfs-actions.pod:2786 ../fish/guestfish-actions.pod:1730 ../fish/guestfish-actions.pod:1914
8184 "Future versions of libguestfs may return other strings here. The caller "
8185 "should be prepared to handle any string."
8189 #: ../src/guestfs-actions.pod:2553
8190 msgid "guestfs_inspect_get_filesystems"
8194 #: ../src/guestfs-actions.pod:2555
8198 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
8199 " const char *root);\n"
8204 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1742
8206 "This returns a list of all the filesystems that we think are associated with "
8207 "this operating system. This includes the root filesystem, other ordinary "
8208 "filesystems, and non-mounted devices like swap partitions."
8212 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1747
8214 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8215 "to be shared between operating systems."
8219 #: ../src/guestfs-actions.pod:2570
8221 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8222 "C<guestfs_inspect_get_mountpoints>."
8226 #: ../src/guestfs-actions.pod:2579
8227 msgid "guestfs_inspect_get_major_version"
8231 #: ../src/guestfs-actions.pod:2581
8235 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
8236 " const char *root);\n"
8241 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1760
8242 msgid "This returns the major version number of the inspected operating system."
8246 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1763
8248 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8249 "popular public names used by the operating system. Notably the operating "
8250 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8251 "1). You can find out the real versions corresponding to releases of Windows "
8252 "by consulting Wikipedia or MSDN."
8256 #: ../src/guestfs-actions.pod:2598 ../src/guestfs-actions.pod:2618 ../fish/guestfish-actions.pod:1770 ../fish/guestfish-actions.pod:1784
8257 msgid "If the version could not be determined, then C<0> is returned."
8261 #: ../src/guestfs-actions.pod:2606
8262 msgid "guestfs_inspect_get_minor_version"
8266 #: ../src/guestfs-actions.pod:2608
8270 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
8271 " const char *root);\n"
8276 #: ../src/guestfs-actions.pod:2615 ../fish/guestfish-actions.pod:1781
8277 msgid "This returns the minor version number of the inspected operating system."
8281 #: ../src/guestfs-actions.pod:2620
8283 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8284 "C<guestfs_inspect_get_major_version>."
8288 #: ../src/guestfs-actions.pod:2627
8289 msgid "guestfs_inspect_get_mountpoints"
8293 #: ../src/guestfs-actions.pod:2629
8297 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
8298 " const char *root);\n"
8303 #: ../src/guestfs-actions.pod:2636 ../fish/guestfish-actions.pod:1796
8305 "This returns a hash of where we think the filesystems associated with this "
8306 "operating system should be mounted. Callers should note that this is at "
8307 "best an educated guess made by reading configuration files such as "
8312 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1801
8314 "Each element in the returned hashtable has a key which is the path of the "
8315 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8316 "mounted there (eg. C</dev/sda1>)."
8320 #: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1806
8321 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
8325 #: ../src/guestfs-actions.pod:2649
8327 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8328 "C<guestfs_inspect_get_filesystems>."
8332 #: ../src/guestfs-actions.pod:2652 ../src/guestfs-actions.pod:3151 ../src/guestfs-actions.pod:4279 ../src/guestfs-actions.pod:6135
8334 "This function returns a NULL-terminated array of strings, or NULL if there "
8335 "was an error. The array of strings will always have length C<2n+1>, where "
8336 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
8337 "caller must free the strings and the array after use>."
8341 #: ../src/guestfs-actions.pod:2660
8342 msgid "guestfs_inspect_get_package_format"
8346 #: ../src/guestfs-actions.pod:2662
8350 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
8351 " const char *root);\n"
8356 #: ../src/guestfs-actions.pod:2669
8358 "This function and C<guestfs_inspect_get_package_management> return the "
8359 "package format and package management tool used by the inspected operating "
8360 "system. For example for Fedora these functions would return C<rpm> (package "
8361 "format) and C<yum> (package management)."
8365 #: ../src/guestfs-actions.pod:2675 ../fish/guestfish-actions.pod:1825
8367 "This returns the string C<unknown> if we could not determine the package "
8368 "format I<or> if the operating system does not have a real packaging system "
8373 #: ../src/guestfs-actions.pod:2679 ../fish/guestfish-actions.pod:1829
8375 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
8376 "Future versions of libguestfs may return other strings."
8380 #: ../src/guestfs-actions.pod:2687
8381 msgid "guestfs_inspect_get_package_management"
8385 #: ../src/guestfs-actions.pod:2689
8389 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
8390 " const char *root);\n"
8395 #: ../src/guestfs-actions.pod:2696
8397 "C<guestfs_inspect_get_package_format> and this function return the package "
8398 "format and package management tool used by the inspected operating system. "
8399 "For example for Fedora these functions would return C<rpm> (package format) "
8400 "and C<yum> (package management)."
8404 #: ../src/guestfs-actions.pod:2702 ../fish/guestfish-actions.pod:1847
8406 "This returns the string C<unknown> if we could not determine the package "
8407 "management tool I<or> if the operating system does not have a real packaging "
8408 "system (eg. Windows)."
8412 #: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1851
8414 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
8415 "derivatives), C<portage>, C<pisi>, C<pacman>. Future versions of libguestfs "
8416 "may return other strings."
8420 #: ../src/guestfs-actions.pod:2716
8421 msgid "guestfs_inspect_get_product_name"
8425 #: ../src/guestfs-actions.pod:2718
8429 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
8430 " const char *root);\n"
8435 #: ../src/guestfs-actions.pod:2725 ../fish/guestfish-actions.pod:1865
8437 "This returns the product name of the inspected operating system. The "
8438 "product name is generally some freeform string which can be displayed to the "
8439 "user, but should not be parsed by programs."
8443 #: ../src/guestfs-actions.pod:2730 ../fish/guestfish-actions.pod:1870
8445 "If the product name could not be determined, then the string C<unknown> is "
8450 #: ../src/guestfs-actions.pod:2740
8451 msgid "guestfs_inspect_get_roots"
8455 #: ../src/guestfs-actions.pod:2742
8459 " guestfs_inspect_get_roots (guestfs_h *g);\n"
8464 #: ../src/guestfs-actions.pod:2745
8466 "This function is a convenient way to get the list of root devices, as "
8467 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
8468 "the whole inspection process."
8472 #: ../src/guestfs-actions.pod:2749
8474 "This returns an empty list if either no root devices were found or the "
8475 "caller has not called C<guestfs_inspect_os>."
8479 #: ../src/guestfs-actions.pod:2758
8480 msgid "guestfs_inspect_get_type"
8484 #: ../src/guestfs-actions.pod:2760
8488 " guestfs_inspect_get_type (guestfs_h *g,\n"
8489 " const char *root);\n"
8494 #: ../src/guestfs-actions.pod:2767 ../fish/guestfish-actions.pod:1895
8496 "This returns the type of the inspected operating system. Currently defined "
8501 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1900
8506 #: ../src/guestfs-actions.pod:2774 ../fish/guestfish-actions.pod:1902
8507 msgid "Any Linux-based operating system."
8511 #: ../src/guestfs-actions.pod:2778 ../fish/guestfish-actions.pod:1906
8512 msgid "Any Microsoft Windows operating system."
8516 #: ../src/guestfs-actions.pod:2782 ../fish/guestfish-actions.pod:1910
8517 msgid "The operating system type could not be determined."
8521 #: ../src/guestfs-actions.pod:2796
8522 msgid "guestfs_inspect_get_windows_systemroot"
8526 #: ../src/guestfs-actions.pod:2798
8530 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
8531 " const char *root);\n"
8536 #: ../src/guestfs-actions.pod:2805 ../fish/guestfish-actions.pod:1926
8538 "This returns the Windows systemroot of the inspected guest. The systemroot "
8539 "is a directory path such as C</WINDOWS>."
8543 #: ../src/guestfs-actions.pod:2808 ../fish/guestfish-actions.pod:1929
8545 "This call assumes that the guest is Windows and that the systemroot could be "
8546 "determined by inspection. If this is not the case then an error is "
8551 #: ../src/guestfs-actions.pod:2817
8552 msgid "(Added in 1.5.25)"
8556 #: ../src/guestfs-actions.pod:2819
8557 msgid "guestfs_inspect_os"
8561 #: ../src/guestfs-actions.pod:2821
8565 " guestfs_inspect_os (guestfs_h *g);\n"
8570 #: ../src/guestfs-actions.pod:2824 ../fish/guestfish-actions.pod:1939
8572 "This function uses other libguestfs functions and certain heuristics to "
8573 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
8574 "for operating systems."
8578 #: ../src/guestfs-actions.pod:2828 ../fish/guestfish-actions.pod:1943
8579 msgid "The list returned is empty if no operating systems were found."
8583 #: ../src/guestfs-actions.pod:2830 ../fish/guestfish-actions.pod:1945
8585 "If one operating system was found, then this returns a list with a single "
8586 "element, which is the name of the root filesystem of this operating system. "
8587 "It is also possible for this function to return a list containing more than "
8588 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
8589 "element being the root filesystem of one of the operating systems."
8593 #: ../src/guestfs-actions.pod:2837
8595 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
8596 "functions in order to query further information about each operating system, "
8597 "such as the name and version."
8601 #: ../src/guestfs-actions.pod:2842
8603 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
8604 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
8605 "the contents. This should be called with no disks currently mounted. The "
8606 "function may also use Augeas, so any existing Augeas handle will be closed."
8610 #: ../src/guestfs-actions.pod:2848 ../fish/guestfish-actions.pod:1963
8612 "This function cannot decrypt encrypted disks. The caller must do that first "
8613 "(supplying the necessary keys) if the disk is encrypted."
8617 #: ../src/guestfs-actions.pod:2854 ../src/guestfs-actions.pod:3109 ../src/guestfs-actions.pod:3171
8618 msgid "See also C<guestfs_list_filesystems>."
8622 #: ../src/guestfs-actions.pod:2862
8623 msgid "guestfs_is_blockdev"
8627 #: ../src/guestfs-actions.pod:2864
8631 " guestfs_is_blockdev (guestfs_h *g,\n"
8632 " const char *path);\n"
8637 #: ../src/guestfs-actions.pod:2868 ../fish/guestfish-actions.pod:1975
8639 "This returns C<true> if and only if there is a block device with the given "
8644 #: ../src/guestfs-actions.pod:2871 ../src/guestfs-actions.pod:2900 ../src/guestfs-actions.pod:2930 ../src/guestfs-actions.pod:2945 ../src/guestfs-actions.pod:2961 ../src/guestfs-actions.pod:3017 ../src/guestfs-actions.pod:3032
8645 msgid "See also C<guestfs_stat>."
8649 #: ../src/guestfs-actions.pod:2875 ../src/guestfs-actions.pod:2904 ../src/guestfs-actions.pod:2949 ../src/guestfs-actions.pod:3021 ../src/guestfs-actions.pod:3036
8650 msgid "(Added in 1.5.10)"
8654 #: ../src/guestfs-actions.pod:2877
8655 msgid "guestfs_is_busy"
8659 #: ../src/guestfs-actions.pod:2879
8663 " guestfs_is_busy (guestfs_h *g);\n"
8668 #: ../src/guestfs-actions.pod:2882 ../fish/guestfish-actions.pod:1984
8670 "This returns true iff this handle is busy processing a command (in the "
8675 #: ../src/guestfs-actions.pod:2891
8676 msgid "guestfs_is_chardev"
8680 #: ../src/guestfs-actions.pod:2893
8684 " guestfs_is_chardev (guestfs_h *g,\n"
8685 " const char *path);\n"
8690 #: ../src/guestfs-actions.pod:2897 ../fish/guestfish-actions.pod:1993
8692 "This returns C<true> if and only if there is a character device with the "
8693 "given C<path> name."
8697 #: ../src/guestfs-actions.pod:2906
8698 msgid "guestfs_is_config"
8702 #: ../src/guestfs-actions.pod:2908
8706 " guestfs_is_config (guestfs_h *g);\n"
8711 #: ../src/guestfs-actions.pod:2911 ../fish/guestfish-actions.pod:2002
8713 "This returns true iff this handle is being configured (in the C<CONFIG> "
8718 #: ../src/guestfs-actions.pod:2920
8719 msgid "guestfs_is_dir"
8723 #: ../src/guestfs-actions.pod:2922
8727 " guestfs_is_dir (guestfs_h *g,\n"
8728 " const char *path);\n"
8733 #: ../src/guestfs-actions.pod:2926 ../fish/guestfish-actions.pod:2011
8735 "This returns C<true> if and only if there is a directory with the given "
8736 "C<path> name. Note that it returns false for other objects like files."
8740 #: ../src/guestfs-actions.pod:2936
8741 msgid "guestfs_is_fifo"
8745 #: ../src/guestfs-actions.pod:2938
8749 " guestfs_is_fifo (guestfs_h *g,\n"
8750 " const char *path);\n"
8755 #: ../src/guestfs-actions.pod:2942 ../fish/guestfish-actions.pod:2021
8757 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
8758 "given C<path> name."
8762 #: ../src/guestfs-actions.pod:2951
8763 msgid "guestfs_is_file"
8767 #: ../src/guestfs-actions.pod:2953
8771 " guestfs_is_file (guestfs_h *g,\n"
8772 " const char *path);\n"
8777 #: ../src/guestfs-actions.pod:2957 ../fish/guestfish-actions.pod:2030
8779 "This returns C<true> if and only if there is a regular file with the given "
8780 "C<path> name. Note that it returns false for other objects like "
8785 #: ../src/guestfs-actions.pod:2967
8786 msgid "guestfs_is_launching"
8790 #: ../src/guestfs-actions.pod:2969
8794 " guestfs_is_launching (guestfs_h *g);\n"
8799 #: ../src/guestfs-actions.pod:2972 ../fish/guestfish-actions.pod:2040
8801 "This returns true iff this handle is launching the subprocess (in the "
8802 "C<LAUNCHING> state)."
8806 #: ../src/guestfs-actions.pod:2981
8807 msgid "guestfs_is_lv"
8811 #: ../src/guestfs-actions.pod:2983
8815 " guestfs_is_lv (guestfs_h *g,\n"
8816 " const char *device);\n"
8821 #: ../src/guestfs-actions.pod:2987 ../fish/guestfish-actions.pod:2049
8823 "This command tests whether C<device> is a logical volume, and returns true "
8824 "iff this is the case."
8828 #: ../src/guestfs-actions.pod:2994
8829 msgid "guestfs_is_ready"
8833 #: ../src/guestfs-actions.pod:2996
8837 " guestfs_is_ready (guestfs_h *g);\n"
8842 #: ../src/guestfs-actions.pod:2999 ../fish/guestfish-actions.pod:2056
8844 "This returns true iff this handle is ready to accept commands (in the "
8849 #: ../src/guestfs-actions.pod:3008
8850 msgid "guestfs_is_socket"
8854 #: ../src/guestfs-actions.pod:3010
8858 " guestfs_is_socket (guestfs_h *g,\n"
8859 " const char *path);\n"
8864 #: ../src/guestfs-actions.pod:3014 ../fish/guestfish-actions.pod:2065
8866 "This returns C<true> if and only if there is a Unix domain socket with the "
8867 "given C<path> name."
8871 #: ../src/guestfs-actions.pod:3023
8872 msgid "guestfs_is_symlink"
8876 #: ../src/guestfs-actions.pod:3025
8880 " guestfs_is_symlink (guestfs_h *g,\n"
8881 " const char *path);\n"
8886 #: ../src/guestfs-actions.pod:3029 ../fish/guestfish-actions.pod:2074
8888 "This returns C<true> if and only if there is a symbolic link with the given "
8893 #: ../src/guestfs-actions.pod:3038
8894 msgid "guestfs_kill_subprocess"
8898 #: ../src/guestfs-actions.pod:3040
8902 " guestfs_kill_subprocess (guestfs_h *g);\n"
8907 #: ../src/guestfs-actions.pod:3043 ../fish/guestfish-actions.pod:2083
8908 msgid "This kills the qemu subprocess. You should never need to call this."
8912 #: ../src/guestfs-actions.pod:3049
8913 msgid "guestfs_launch"
8917 #: ../src/guestfs-actions.pod:3051
8921 " guestfs_launch (guestfs_h *g);\n"
8926 #: ../src/guestfs-actions.pod:3054 ../fish/guestfish-actions.pod:2091
8928 "Internally libguestfs is implemented by running a virtual machine using "
8933 #: ../src/guestfs-actions.pod:3057 ../fish/guestfish-actions.pod:2094
8935 "You should call this after configuring the handle (eg. adding drives) but "
8936 "before performing any actions."
8940 #: ../src/guestfs-actions.pod:3064
8941 msgid "guestfs_lchown"
8945 #: ../src/guestfs-actions.pod:3066
8949 " guestfs_lchown (guestfs_h *g,\n"
8952 " const char *path);\n"
8957 #: ../src/guestfs-actions.pod:3072
8959 "Change the file owner to C<owner> and group to C<group>. This is like "
8960 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
8961 "changed, not the target."
8965 #: ../src/guestfs-actions.pod:3084
8966 msgid "guestfs_lgetxattrs"
8970 #: ../src/guestfs-actions.pod:3086
8973 " struct guestfs_xattr_list *\n"
8974 " guestfs_lgetxattrs (guestfs_h *g,\n"
8975 " const char *path);\n"
8980 #: ../src/guestfs-actions.pod:3090
8982 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
8983 "then it returns the extended attributes of the link itself."
8987 #: ../src/guestfs-actions.pod:3100
8988 msgid "guestfs_list_devices"
8992 #: ../src/guestfs-actions.pod:3102
8996 " guestfs_list_devices (guestfs_h *g);\n"
9001 #: ../src/guestfs-actions.pod:3105 ../fish/guestfish-actions.pod:2121
9002 msgid "List all the block devices."
9006 #: ../src/guestfs-actions.pod:3107 ../fish/guestfish-actions.pod:2123
9007 msgid "The full block device names are returned, eg. C</dev/sda>."
9011 #: ../src/guestfs-actions.pod:3117
9012 msgid "guestfs_list_filesystems"
9016 #: ../src/guestfs-actions.pod:3119
9020 " guestfs_list_filesystems (guestfs_h *g);\n"
9025 #: ../src/guestfs-actions.pod:3122 ../fish/guestfish-actions.pod:2131
9027 "This inspection command looks for filesystems on partitions, block devices "
9028 "and logical volumes, returning a list of devices containing filesystems and "
9033 #: ../src/guestfs-actions.pod:3126 ../fish/guestfish-actions.pod:2135
9035 "The return value is a hash, where the keys are the devices containing "
9036 "filesystems, and the values are the filesystem types. For example:"
9040 #: ../src/guestfs-actions.pod:3130 ../fish/guestfish-actions.pod:2139
9043 " \"/dev/sda1\" => \"ntfs\"\n"
9044 " \"/dev/sda2\" => \"ext2\"\n"
9045 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9046 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9051 #: ../src/guestfs-actions.pod:3135 ../fish/guestfish-actions.pod:2144
9053 "The value can have the special value \"unknown\", meaning the content of the "
9054 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9058 #: ../src/guestfs-actions.pod:3139
9060 "This command runs other libguestfs commands, which might include "
9061 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
9062 "soon after launch and only when nothing is mounted."
9066 #: ../src/guestfs-actions.pod:3143
9068 "Not all of the filesystems returned will be mountable. In particular, swap "
9069 "partitions are returned in the list. Also this command does not check that "
9070 "each filesystem found is valid and mountable, and some filesystems might be "
9071 "mountable but require special options. Filesystems may not all belong to a "
9072 "single logical operating system (use C<guestfs_inspect_os> to look for "
9077 #: ../src/guestfs-actions.pod:3157 ../src/guestfs-actions.pod:4680
9078 msgid "(Added in 1.5.15)"
9082 #: ../src/guestfs-actions.pod:3159
9083 msgid "guestfs_list_partitions"
9087 #: ../src/guestfs-actions.pod:3161
9091 " guestfs_list_partitions (guestfs_h *g);\n"
9096 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2164
9097 msgid "List all the partitions detected on all block devices."
9101 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2166
9102 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9106 #: ../src/guestfs-actions.pod:3168
9108 "This does not return logical volumes. For that you will need to call "
9113 #: ../src/guestfs-actions.pod:3179
9118 #: ../src/guestfs-actions.pod:3181
9122 " guestfs_ll (guestfs_h *g,\n"
9123 " const char *directory);\n"
9128 #: ../src/guestfs-actions.pod:3185 ../fish/guestfish-actions.pod:2177
9130 "List the files in C<directory> (relative to the root directory, there is no "
9131 "cwd) in the format of 'ls -la'."
9135 #: ../src/guestfs-actions.pod:3188 ../fish/guestfish-actions.pod:2180
9137 "This command is mostly useful for interactive sessions. It is I<not> "
9138 "intended that you try to parse the output string."
9142 #: ../src/guestfs-actions.pod:3196
9147 #: ../src/guestfs-actions.pod:3198
9151 " guestfs_ln (guestfs_h *g,\n"
9152 " const char *target,\n"
9153 " const char *linkname);\n"
9158 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2187
9159 msgid "This command creates a hard link using the C<ln> command."
9163 #: ../src/guestfs-actions.pod:3209
9164 msgid "guestfs_ln_f"
9168 #: ../src/guestfs-actions.pod:3211
9172 " guestfs_ln_f (guestfs_h *g,\n"
9173 " const char *target,\n"
9174 " const char *linkname);\n"
9179 #: ../src/guestfs-actions.pod:3216 ../fish/guestfish-actions.pod:2193
9181 "This command creates a hard link using the C<ln -f> command. The C<-f> "
9182 "option removes the link (C<linkname>) if it exists already."
9186 #: ../src/guestfs-actions.pod:3223
9187 msgid "guestfs_ln_s"
9191 #: ../src/guestfs-actions.pod:3225
9195 " guestfs_ln_s (guestfs_h *g,\n"
9196 " const char *target,\n"
9197 " const char *linkname);\n"
9202 #: ../src/guestfs-actions.pod:3230 ../fish/guestfish-actions.pod:2200
9203 msgid "This command creates a symbolic link using the C<ln -s> command."
9207 #: ../src/guestfs-actions.pod:3236
9208 msgid "guestfs_ln_sf"
9212 #: ../src/guestfs-actions.pod:3238
9216 " guestfs_ln_sf (guestfs_h *g,\n"
9217 " const char *target,\n"
9218 " const char *linkname);\n"
9223 #: ../src/guestfs-actions.pod:3243 ../fish/guestfish-actions.pod:2206
9225 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
9226 "option removes the link (C<linkname>) if it exists already."
9230 #: ../src/guestfs-actions.pod:3250
9231 msgid "guestfs_lremovexattr"
9235 #: ../src/guestfs-actions.pod:3252
9239 " guestfs_lremovexattr (guestfs_h *g,\n"
9240 " const char *xattr,\n"
9241 " const char *path);\n"
9246 #: ../src/guestfs-actions.pod:3257
9248 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
9249 "link, then it removes an extended attribute of the link itself."
9253 #: ../src/guestfs-actions.pod:3265
9258 #: ../src/guestfs-actions.pod:3267
9262 " guestfs_ls (guestfs_h *g,\n"
9263 " const char *directory);\n"
9268 #: ../src/guestfs-actions.pod:3271 ../fish/guestfish-actions.pod:2221
9270 "List the files in C<directory> (relative to the root directory, there is no "
9271 "cwd). The '.' and '..' entries are not returned, but hidden files are "
9276 #: ../src/guestfs-actions.pod:3275
9278 "This command is mostly useful for interactive sessions. Programs should "
9279 "probably use C<guestfs_readdir> instead."
9283 #: ../src/guestfs-actions.pod:3284
9284 msgid "guestfs_lsetxattr"
9288 #: ../src/guestfs-actions.pod:3286
9292 " guestfs_lsetxattr (guestfs_h *g,\n"
9293 " const char *xattr,\n"
9294 " const char *val,\n"
9296 " const char *path);\n"
9301 #: ../src/guestfs-actions.pod:3293
9303 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
9304 "then it sets an extended attribute of the link itself."
9308 #: ../src/guestfs-actions.pod:3301
9309 msgid "guestfs_lstat"
9313 #: ../src/guestfs-actions.pod:3303
9316 " struct guestfs_stat *\n"
9317 " guestfs_lstat (guestfs_h *g,\n"
9318 " const char *path);\n"
9323 #: ../src/guestfs-actions.pod:3307 ../src/guestfs-actions.pod:5734 ../fish/guestfish-actions.pod:2240 ../fish/guestfish-actions.pod:3822
9324 msgid "Returns file information for the given C<path>."
9328 #: ../src/guestfs-actions.pod:3309
9330 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
9331 "link, then the link is stat-ed, not the file it refers to."
9335 #: ../src/guestfs-actions.pod:3313 ../fish/guestfish-actions.pod:2246
9336 msgid "This is the same as the C<lstat(2)> system call."
9340 #: ../src/guestfs-actions.pod:3315 ../src/guestfs-actions.pod:5738
9342 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
9343 "error. I<The caller must call C<guestfs_free_stat> after use>."
9347 #: ../src/guestfs-actions.pod:3319 ../src/guestfs-actions.pod:5742 ../src/guestfs-actions.pod:5760 ../src/guestfs-actions.pod:6141
9348 msgid "(Added in 0.9.2)"
9352 #: ../src/guestfs-actions.pod:3321
9353 msgid "guestfs_lstatlist"
9357 #: ../src/guestfs-actions.pod:3323
9360 " struct guestfs_stat_list *\n"
9361 " guestfs_lstatlist (guestfs_h *g,\n"
9362 " const char *path,\n"
9363 " char *const *names);\n"
9368 #: ../src/guestfs-actions.pod:3328
9370 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
9371 "files, where all files are in the directory C<path>. C<names> is the list "
9372 "of files from this directory."
9376 #: ../src/guestfs-actions.pod:3332 ../fish/guestfish-actions.pod:2256
9378 "On return you get a list of stat structs, with a one-to-one correspondence "
9379 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9380 "then the C<ino> field of that structure is set to C<-1>."
9384 #: ../src/guestfs-actions.pod:3337
9386 "This call is intended for programs that want to efficiently list a directory "
9387 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
9388 "for a similarly efficient call for getting extended attributes. Very long "
9389 "directory listings might cause the protocol message size to be exceeded, "
9390 "causing this call to fail. The caller must split up such requests into "
9391 "smaller groups of names."
9395 #: ../src/guestfs-actions.pod:3345
9397 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
9398 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
9402 #: ../src/guestfs-actions.pod:3351
9403 msgid "guestfs_luks_add_key"
9407 #: ../src/guestfs-actions.pod:3353
9411 " guestfs_luks_add_key (guestfs_h *g,\n"
9412 " const char *device,\n"
9413 " const char *key,\n"
9414 " const char *newkey,\n"
9420 #: ../src/guestfs-actions.pod:3360 ../fish/guestfish-actions.pod:2273
9422 "This command adds a new key on LUKS device C<device>. C<key> is any "
9423 "existing key, and is used to access the device. C<newkey> is the new key to "
9424 "add. C<keyslot> is the key slot that will be replaced."
9428 #: ../src/guestfs-actions.pod:3365
9430 "Note that if C<keyslot> already contains a key, then this command will "
9431 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
9435 #: ../src/guestfs-actions.pod:3371 ../src/guestfs-actions.pod:3411 ../src/guestfs-actions.pod:3434 ../src/guestfs-actions.pod:3454 ../src/guestfs-actions.pod:3486 ../src/guestfs-actions.pod:3505
9437 "This function takes a key or passphrase parameter which could contain "
9438 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
9443 #: ../src/guestfs-actions.pod:3375 ../src/guestfs-actions.pod:3415 ../src/guestfs-actions.pod:3438 ../src/guestfs-actions.pod:3458
9444 msgid "(Added in 1.5.2)"
9448 #: ../src/guestfs-actions.pod:3377
9449 msgid "guestfs_luks_close"
9453 #: ../src/guestfs-actions.pod:3379
9457 " guestfs_luks_close (guestfs_h *g,\n"
9458 " const char *device);\n"
9463 #: ../src/guestfs-actions.pod:3383
9465 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
9466 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
9467 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
9468 "underlying block device."
9472 #: ../src/guestfs-actions.pod:3391 ../src/guestfs-actions.pod:3490 ../src/guestfs-actions.pod:3509 ../src/guestfs-actions.pod:3559 ../src/guestfs-actions.pod:3607
9473 msgid "(Added in 1.5.1)"
9477 #: ../src/guestfs-actions.pod:3393
9478 msgid "guestfs_luks_format"
9482 #: ../src/guestfs-actions.pod:3395
9486 " guestfs_luks_format (guestfs_h *g,\n"
9487 " const char *device,\n"
9488 " const char *key,\n"
9494 #: ../src/guestfs-actions.pod:3401 ../fish/guestfish-actions.pod:2299
9496 "This command erases existing data on C<device> and formats the device as a "
9497 "LUKS encrypted device. C<key> is the initial key, which is added to key "
9498 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
9502 #: ../src/guestfs-actions.pod:3408 ../src/guestfs-actions.pod:3431 ../src/guestfs-actions.pod:3571 ../src/guestfs-actions.pod:4431 ../src/guestfs-actions.pod:5194 ../src/guestfs-actions.pod:5569 ../src/guestfs-actions.pod:5592 ../src/guestfs-actions.pod:5618 ../src/guestfs-actions.pod:6768 ../fish/guestfish-actions.pod:2307 ../fish/guestfish-actions.pod:2320 ../fish/guestfish-actions.pod:2404 ../fish/guestfish-actions.pod:2934 ../fish/guestfish-actions.pod:3441 ../fish/guestfish-actions.pod:3721 ../fish/guestfish-actions.pod:3737 ../fish/guestfish-actions.pod:3752 ../fish/guestfish-actions.pod:4467
9504 "B<This command is dangerous. Without careful use you can easily destroy all "
9509 #: ../src/guestfs-actions.pod:3417
9510 msgid "guestfs_luks_format_cipher"
9514 #: ../src/guestfs-actions.pod:3419
9518 " guestfs_luks_format_cipher (guestfs_h *g,\n"
9519 " const char *device,\n"
9520 " const char *key,\n"
9522 " const char *cipher);\n"
9527 #: ../src/guestfs-actions.pod:3426
9529 "This command is the same as C<guestfs_luks_format> but it also allows you to "
9530 "set the C<cipher> used."
9534 #: ../src/guestfs-actions.pod:3440
9535 msgid "guestfs_luks_kill_slot"
9539 #: ../src/guestfs-actions.pod:3442
9543 " guestfs_luks_kill_slot (guestfs_h *g,\n"
9544 " const char *device,\n"
9545 " const char *key,\n"
9551 #: ../src/guestfs-actions.pod:3448 ../fish/guestfish-actions.pod:2327
9553 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
9554 "device C<device>. C<key> must be one of the I<other> keys."
9558 #: ../src/guestfs-actions.pod:3460
9559 msgid "guestfs_luks_open"
9563 #: ../src/guestfs-actions.pod:3462
9567 " guestfs_luks_open (guestfs_h *g,\n"
9568 " const char *device,\n"
9569 " const char *key,\n"
9570 " const char *mapname);\n"
9575 #: ../src/guestfs-actions.pod:3468 ../fish/guestfish-actions.pod:2338
9577 "This command opens a block device which has been encrypted according to the "
9578 "Linux Unified Key Setup (LUKS) standard."
9582 #: ../src/guestfs-actions.pod:3471 ../fish/guestfish-actions.pod:2341
9583 msgid "C<device> is the encrypted block device or partition."
9587 #: ../src/guestfs-actions.pod:3473 ../fish/guestfish-actions.pod:2343
9589 "The caller must supply one of the keys associated with the LUKS block "
9590 "device, in the C<key> parameter."
9594 #: ../src/guestfs-actions.pod:3476 ../fish/guestfish-actions.pod:2346
9596 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
9597 "writes to this block device are decrypted from and encrypted to the "
9598 "underlying C<device> respectively."
9602 #: ../src/guestfs-actions.pod:3480
9604 "If this block device contains LVM volume groups, then calling "
9605 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
9610 #: ../src/guestfs-actions.pod:3492
9611 msgid "guestfs_luks_open_ro"
9615 #: ../src/guestfs-actions.pod:3494
9619 " guestfs_luks_open_ro (guestfs_h *g,\n"
9620 " const char *device,\n"
9621 " const char *key,\n"
9622 " const char *mapname);\n"
9627 #: ../src/guestfs-actions.pod:3500
9629 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
9634 #: ../src/guestfs-actions.pod:3511
9635 msgid "guestfs_lvcreate"
9639 #: ../src/guestfs-actions.pod:3513
9643 " guestfs_lvcreate (guestfs_h *g,\n"
9644 " const char *logvol,\n"
9645 " const char *volgroup,\n"
9651 #: ../src/guestfs-actions.pod:3519 ../fish/guestfish-actions.pod:2371
9653 "This creates an LVM logical volume called C<logvol> on the volume group "
9654 "C<volgroup>, with C<size> megabytes."
9658 #: ../src/guestfs-actions.pod:3526
9659 msgid "guestfs_lvm_canonical_lv_name"
9663 #: ../src/guestfs-actions.pod:3528
9667 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
9668 " const char *lvname);\n"
9673 #: ../src/guestfs-actions.pod:3532 ../fish/guestfish-actions.pod:2378
9675 "This converts alternative naming schemes for LVs that you might find to the "
9676 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
9681 #: ../src/guestfs-actions.pod:3536 ../fish/guestfish-actions.pod:2382
9683 "This command returns an error if the C<lvname> parameter does not refer to a "
9688 #: ../src/guestfs-actions.pod:3539
9689 msgid "See also C<guestfs_is_lv>."
9693 #: ../src/guestfs-actions.pod:3544
9694 msgid "(Added in 1.5.24)"
9698 #: ../src/guestfs-actions.pod:3546
9699 msgid "guestfs_lvm_clear_filter"
9703 #: ../src/guestfs-actions.pod:3548
9707 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
9712 #: ../src/guestfs-actions.pod:3551
9714 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
9715 "see every block device."
9719 #: ../src/guestfs-actions.pod:3554 ../src/guestfs-actions.pod:3596 ../fish/guestfish-actions.pod:2394 ../fish/guestfish-actions.pod:2425
9720 msgid "This command also clears the LVM cache and performs a volume group scan."
9724 #: ../src/guestfs-actions.pod:3561
9725 msgid "guestfs_lvm_remove_all"
9729 #: ../src/guestfs-actions.pod:3563
9733 " guestfs_lvm_remove_all (guestfs_h *g);\n"
9738 #: ../src/guestfs-actions.pod:3566 ../fish/guestfish-actions.pod:2401
9740 "This command removes all LVM logical volumes, volume groups and physical "
9745 #: ../src/guestfs-actions.pod:3576
9746 msgid "guestfs_lvm_set_filter"
9750 #: ../src/guestfs-actions.pod:3578
9754 " guestfs_lvm_set_filter (guestfs_h *g,\n"
9755 " char *const *devices);\n"
9760 #: ../src/guestfs-actions.pod:3582 ../fish/guestfish-actions.pod:2411
9762 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
9763 "block devices in the list C<devices>, and will ignore all other attached "
9768 #: ../src/guestfs-actions.pod:3586 ../fish/guestfish-actions.pod:2415
9770 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
9771 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
9772 "there are two types of duplication possible: either cloned PVs/VGs which "
9773 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
9774 "same name. In normal operation you cannot create this situation, but you "
9775 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
9776 "inside the LVM metadata."
9780 #: ../src/guestfs-actions.pod:3599 ../fish/guestfish-actions.pod:2428
9781 msgid "You can filter whole block devices or individual partitions."
9785 #: ../src/guestfs-actions.pod:3601 ../fish/guestfish-actions.pod:2430
9787 "You cannot use this if any VG is currently in use (eg. contains a mounted "
9788 "filesystem), even if you are not filtering out that VG."
9792 #: ../src/guestfs-actions.pod:3609
9793 msgid "guestfs_lvremove"
9797 #: ../src/guestfs-actions.pod:3611
9801 " guestfs_lvremove (guestfs_h *g,\n"
9802 " const char *device);\n"
9807 #: ../src/guestfs-actions.pod:3615 ../fish/guestfish-actions.pod:2438
9809 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
9810 "LV, such as C</dev/VG/LV>."
9814 #: ../src/guestfs-actions.pod:3618 ../fish/guestfish-actions.pod:2441
9816 "You can also remove all LVs in a volume group by specifying the VG name, "
9821 #: ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:4777 ../src/guestfs-actions.pod:6507
9822 msgid "(Added in 1.0.13)"
9826 #: ../src/guestfs-actions.pod:3625
9827 msgid "guestfs_lvrename"
9831 #: ../src/guestfs-actions.pod:3627
9835 " guestfs_lvrename (guestfs_h *g,\n"
9836 " const char *logvol,\n"
9837 " const char *newlogvol);\n"
9842 #: ../src/guestfs-actions.pod:3632 ../fish/guestfish-actions.pod:2448
9843 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
9847 #: ../src/guestfs-actions.pod:3636 ../src/guestfs-actions.pod:6520
9848 msgid "(Added in 1.0.83)"
9852 #: ../src/guestfs-actions.pod:3638
9853 msgid "guestfs_lvresize"
9857 #: ../src/guestfs-actions.pod:3640
9861 " guestfs_lvresize (guestfs_h *g,\n"
9862 " const char *device,\n"
9868 #: ../src/guestfs-actions.pod:3645 ../fish/guestfish-actions.pod:2454
9870 "This resizes (expands or shrinks) an existing LVM logical volume to "
9871 "C<mbytes>. When reducing, data in the reduced part is lost."
9875 #: ../src/guestfs-actions.pod:3653
9876 msgid "guestfs_lvresize_free"
9880 #: ../src/guestfs-actions.pod:3655
9884 " guestfs_lvresize_free (guestfs_h *g,\n"
9885 " const char *lv,\n"
9891 #: ../src/guestfs-actions.pod:3660 ../fish/guestfish-actions.pod:2462
9893 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
9894 "remaining free space in the volume group. Commonly you would call this with "
9895 "pc = 100 which expands the logical volume as much as possible, using all "
9896 "remaining free space in the volume group."
9900 #: ../src/guestfs-actions.pod:3668
9901 msgid "(Added in 1.3.3)"
9905 #: ../src/guestfs-actions.pod:3670
9910 #: ../src/guestfs-actions.pod:3672
9914 " guestfs_lvs (guestfs_h *g);\n"
9919 #: ../src/guestfs-actions.pod:3675 ../fish/guestfish-actions.pod:2472
9921 "List all the logical volumes detected. This is the equivalent of the "
9922 "L<lvs(8)> command."
9926 #: ../src/guestfs-actions.pod:3678 ../fish/guestfish-actions.pod:2475
9928 "This returns a list of the logical volume device names "
9929 "(eg. C</dev/VolGroup00/LogVol00>)."
9933 #: ../src/guestfs-actions.pod:3681
9934 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
9938 #: ../src/guestfs-actions.pod:3689
9939 msgid "guestfs_lvs_full"
9943 #: ../src/guestfs-actions.pod:3691
9946 " struct guestfs_lvm_lv_list *\n"
9947 " guestfs_lvs_full (guestfs_h *g);\n"
9952 #: ../src/guestfs-actions.pod:3694 ../fish/guestfish-actions.pod:2484
9954 "List all the logical volumes detected. This is the equivalent of the "
9955 "L<lvs(8)> command. The \"full\" version includes all fields."
9959 #: ../src/guestfs-actions.pod:3697
9961 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
9962 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
9967 #: ../src/guestfs-actions.pod:3703
9968 msgid "guestfs_lvuuid"
9972 #: ../src/guestfs-actions.pod:3705
9976 " guestfs_lvuuid (guestfs_h *g,\n"
9977 " const char *device);\n"
9982 #: ../src/guestfs-actions.pod:3709 ../fish/guestfish-actions.pod:2491
9983 msgid "This command returns the UUID of the LVM LV C<device>."
9987 #: ../src/guestfs-actions.pod:3716
9988 msgid "guestfs_lxattrlist"
9992 #: ../src/guestfs-actions.pod:3718
9995 " struct guestfs_xattr_list *\n"
9996 " guestfs_lxattrlist (guestfs_h *g,\n"
9997 " const char *path,\n"
9998 " char *const *names);\n"
10003 #: ../src/guestfs-actions.pod:3723 ../fish/guestfish-actions.pod:2497
10005 "This call allows you to get the extended attributes of multiple files, where "
10006 "all files are in the directory C<path>. C<names> is the list of files from "
10011 #: ../src/guestfs-actions.pod:3727 ../fish/guestfish-actions.pod:2501
10013 "On return you get a flat list of xattr structs which must be interpreted "
10014 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10015 "C<attrval> in this struct is zero-length to indicate there was an error "
10016 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10017 "number (the number of following attributes for this file, which could be "
10018 "C<\"0\">). Then after the first xattr struct are the zero or more "
10019 "attributes for the first named file. This repeats for the second and "
10020 "subsequent files."
10024 #: ../src/guestfs-actions.pod:3737
10026 "This call is intended for programs that want to efficiently list a directory "
10027 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
10028 "a similarly efficient call for getting standard stats. Very long directory "
10029 "listings might cause the protocol message size to be exceeded, causing this "
10030 "call to fail. The caller must split up such requests into smaller groups of "
10035 #: ../src/guestfs-actions.pod:3751
10036 msgid "guestfs_mkdir"
10040 #: ../src/guestfs-actions.pod:3753
10044 " guestfs_mkdir (guestfs_h *g,\n"
10045 " const char *path);\n"
10050 #: ../src/guestfs-actions.pod:3757 ../fish/guestfish-actions.pod:2523
10051 msgid "Create a directory named C<path>."
10055 #: ../src/guestfs-actions.pod:3763
10056 msgid "guestfs_mkdir_mode"
10060 #: ../src/guestfs-actions.pod:3765
10064 " guestfs_mkdir_mode (guestfs_h *g,\n"
10065 " const char *path,\n"
10071 #: ../src/guestfs-actions.pod:3770 ../fish/guestfish-actions.pod:2529
10073 "This command creates a directory, setting the initial permissions of the "
10074 "directory to C<mode>."
10078 #: ../src/guestfs-actions.pod:3773 ../fish/guestfish-actions.pod:2532
10080 "For common Linux filesystems, the actual mode which is set will be C<mode & "
10081 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
10086 #: ../src/guestfs-actions.pod:3777
10087 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
10091 #: ../src/guestfs-actions.pod:3783
10092 msgid "guestfs_mkdir_p"
10096 #: ../src/guestfs-actions.pod:3785
10100 " guestfs_mkdir_p (guestfs_h *g,\n"
10101 " const char *path);\n"
10106 #: ../src/guestfs-actions.pod:3789 ../fish/guestfish-actions.pod:2542
10108 "Create a directory named C<path>, creating any parent directories as "
10109 "necessary. This is like the C<mkdir -p> shell command."
10113 #: ../src/guestfs-actions.pod:3796
10114 msgid "guestfs_mkdtemp"
10118 #: ../src/guestfs-actions.pod:3798
10122 " guestfs_mkdtemp (guestfs_h *g,\n"
10123 " const char *template);\n"
10128 #: ../src/guestfs-actions.pod:3802 ../fish/guestfish-actions.pod:2549
10130 "This command creates a temporary directory. The C<template> parameter "
10131 "should be a full pathname for the temporary directory name with the final "
10132 "six characters being \"XXXXXX\"."
10136 #: ../src/guestfs-actions.pod:3807 ../fish/guestfish-actions.pod:2554
10138 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10139 "being suitable for Windows filesystems."
10143 #: ../src/guestfs-actions.pod:3810 ../fish/guestfish-actions.pod:2557
10144 msgid "The name of the temporary directory that was created is returned."
10148 #: ../src/guestfs-actions.pod:3813 ../fish/guestfish-actions.pod:2560
10149 msgid "The temporary directory is created with mode 0700 and is owned by root."
10153 #: ../src/guestfs-actions.pod:3816 ../fish/guestfish-actions.pod:2563
10155 "The caller is responsible for deleting the temporary directory and its "
10156 "contents after use."
10160 #: ../src/guestfs-actions.pod:3819 ../fish/guestfish-actions.pod:2566
10161 msgid "See also: L<mkdtemp(3)>"
10165 #: ../src/guestfs-actions.pod:3826
10166 msgid "guestfs_mke2fs_J"
10170 #: ../src/guestfs-actions.pod:3828
10174 " guestfs_mke2fs_J (guestfs_h *g,\n"
10175 " const char *fstype,\n"
10176 " int blocksize,\n"
10177 " const char *device,\n"
10178 " const char *journal);\n"
10183 #: ../src/guestfs-actions.pod:3835 ../fish/guestfish-actions.pod:2572
10185 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10186 "C<journal>. It is equivalent to the command:"
10190 #: ../src/guestfs-actions.pod:3839 ../fish/guestfish-actions.pod:2576
10193 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10198 #: ../src/guestfs-actions.pod:3841
10199 msgid "See also C<guestfs_mke2journal>."
10203 #: ../src/guestfs-actions.pod:3845 ../src/guestfs-actions.pod:3863 ../src/guestfs-actions.pod:3881 ../src/guestfs-actions.pod:3897 ../src/guestfs-actions.pod:3911 ../src/guestfs-actions.pod:3925 ../src/guestfs-actions.pod:3977 ../src/guestfs-actions.pod:4167
10204 msgid "(Added in 1.0.68)"
10208 #: ../src/guestfs-actions.pod:3847
10209 msgid "guestfs_mke2fs_JL"
10213 #: ../src/guestfs-actions.pod:3849
10217 " guestfs_mke2fs_JL (guestfs_h *g,\n"
10218 " const char *fstype,\n"
10219 " int blocksize,\n"
10220 " const char *device,\n"
10221 " const char *label);\n"
10226 #: ../src/guestfs-actions.pod:3856 ../fish/guestfish-actions.pod:2584
10228 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10229 "the journal labeled C<label>."
10233 #: ../src/guestfs-actions.pod:3859
10234 msgid "See also C<guestfs_mke2journal_L>."
10238 #: ../src/guestfs-actions.pod:3865
10239 msgid "guestfs_mke2fs_JU"
10243 #: ../src/guestfs-actions.pod:3867
10247 " guestfs_mke2fs_JU (guestfs_h *g,\n"
10248 " const char *fstype,\n"
10249 " int blocksize,\n"
10250 " const char *device,\n"
10251 " const char *uuid);\n"
10256 #: ../src/guestfs-actions.pod:3874 ../fish/guestfish-actions.pod:2593
10258 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10259 "the journal with UUID C<uuid>."
10263 #: ../src/guestfs-actions.pod:3877
10264 msgid "See also C<guestfs_mke2journal_U>."
10268 #: ../src/guestfs-actions.pod:3883
10269 msgid "guestfs_mke2journal"
10273 #: ../src/guestfs-actions.pod:3885
10277 " guestfs_mke2journal (guestfs_h *g,\n"
10278 " int blocksize,\n"
10279 " const char *device);\n"
10284 #: ../src/guestfs-actions.pod:3890 ../fish/guestfish-actions.pod:2602
10286 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10291 #: ../src/guestfs-actions.pod:3893 ../fish/guestfish-actions.pod:2605
10294 " mke2fs -O journal_dev -b blocksize device\n"
10299 #: ../src/guestfs-actions.pod:3899
10300 msgid "guestfs_mke2journal_L"
10304 #: ../src/guestfs-actions.pod:3901
10308 " guestfs_mke2journal_L (guestfs_h *g,\n"
10309 " int blocksize,\n"
10310 " const char *label,\n"
10311 " const char *device);\n"
10316 #: ../src/guestfs-actions.pod:3907 ../fish/guestfish-actions.pod:2611
10317 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10321 #: ../src/guestfs-actions.pod:3913
10322 msgid "guestfs_mke2journal_U"
10326 #: ../src/guestfs-actions.pod:3915
10330 " guestfs_mke2journal_U (guestfs_h *g,\n"
10331 " int blocksize,\n"
10332 " const char *uuid,\n"
10333 " const char *device);\n"
10338 #: ../src/guestfs-actions.pod:3921 ../fish/guestfish-actions.pod:2617
10339 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10343 #: ../src/guestfs-actions.pod:3927
10344 msgid "guestfs_mkfifo"
10348 #: ../src/guestfs-actions.pod:3929
10352 " guestfs_mkfifo (guestfs_h *g,\n"
10354 " const char *path);\n"
10359 #: ../src/guestfs-actions.pod:3934
10361 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10362 "is just a convenient wrapper around C<guestfs_mknod>."
10366 #: ../src/guestfs-actions.pod:3944
10367 msgid "guestfs_mkfs"
10371 #: ../src/guestfs-actions.pod:3946
10375 " guestfs_mkfs (guestfs_h *g,\n"
10376 " const char *fstype,\n"
10377 " const char *device);\n"
10382 #: ../src/guestfs-actions.pod:3951 ../fish/guestfish-actions.pod:2633
10384 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10385 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10389 #: ../src/guestfs-actions.pod:3959
10390 msgid "guestfs_mkfs_b"
10394 #: ../src/guestfs-actions.pod:3961
10398 " guestfs_mkfs_b (guestfs_h *g,\n"
10399 " const char *fstype,\n"
10400 " int blocksize,\n"
10401 " const char *device);\n"
10406 #: ../src/guestfs-actions.pod:3967
10408 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
10409 "block size of the resulting filesystem. Supported block sizes depend on the "
10410 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10414 #: ../src/guestfs-actions.pod:3972 ../fish/guestfish-actions.pod:2646
10416 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10421 #: ../src/guestfs-actions.pod:3979
10422 msgid "guestfs_mkmountpoint"
10426 #: ../src/guestfs-actions.pod:3981
10430 " guestfs_mkmountpoint (guestfs_h *g,\n"
10431 " const char *exemptpath);\n"
10436 #: ../src/guestfs-actions.pod:3985
10438 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
10439 "that can be used to create extra mountpoints before mounting the first "
10444 #: ../src/guestfs-actions.pod:3989 ../fish/guestfish-actions.pod:2657
10446 "These calls are I<only> necessary in some very limited circumstances, mainly "
10447 "the case where you want to mount a mix of unrelated and/or read-only "
10448 "filesystems together."
10452 #: ../src/guestfs-actions.pod:3993 ../fish/guestfish-actions.pod:2661
10454 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10455 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10456 "inside that. You can unpack this as follows in guestfish:"
10460 #: ../src/guestfs-actions.pod:3998 ../fish/guestfish-actions.pod:2666
10463 " add-ro Fedora-11-i686-Live.iso\n"
10465 " mkmountpoint /cd\n"
10466 " mkmountpoint /sqsh\n"
10467 " mkmountpoint /ext3fs\n"
10468 " mount /dev/sda /cd\n"
10469 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10470 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10475 #: ../src/guestfs-actions.pod:4007 ../fish/guestfish-actions.pod:2675
10476 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
10480 #: ../src/guestfs-actions.pod:4009
10482 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
10483 "may get unexpected errors if you try to mix these calls. It is safest to "
10484 "manually unmount filesystems and remove mountpoints after use."
10488 #: ../src/guestfs-actions.pod:4013
10490 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
10491 "first, so for this to work for manual mountpoints, you must ensure that the "
10492 "innermost mountpoints have the longest pathnames, as in the example code "
10497 #: ../src/guestfs-actions.pod:4018 ../fish/guestfish-actions.pod:2686
10498 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
10502 #: ../src/guestfs-actions.pod:4020
10504 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
10505 "means that C<guestfs_umount_all> is called when the handle is closed which "
10506 "can also trigger these issues."
10510 #: ../src/guestfs-actions.pod:4026 ../src/guestfs-actions.pod:4285 ../src/guestfs-actions.pod:5178
10511 msgid "(Added in 1.0.62)"
10515 #: ../src/guestfs-actions.pod:4028
10516 msgid "guestfs_mknod"
10520 #: ../src/guestfs-actions.pod:4030
10524 " guestfs_mknod (guestfs_h *g,\n"
10528 " const char *path);\n"
10533 #: ../src/guestfs-actions.pod:4037 ../fish/guestfish-actions.pod:2696
10535 "This call creates block or character special devices, or named pipes "
10540 #: ../src/guestfs-actions.pod:4040 ../fish/guestfish-actions.pod:2699
10542 "The C<mode> parameter should be the mode, using the standard constants. "
10543 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
10544 "used when creating block and character special devices."
10548 #: ../src/guestfs-actions.pod:4045
10550 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
10551 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
10552 "regular file). These constants are available in the standard Linux header "
10553 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
10554 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
10555 "the appropriate constant for you."
10559 #: ../src/guestfs-actions.pod:4059
10560 msgid "guestfs_mknod_b"
10564 #: ../src/guestfs-actions.pod:4061
10568 " guestfs_mknod_b (guestfs_h *g,\n"
10572 " const char *path);\n"
10577 #: ../src/guestfs-actions.pod:4068
10579 "This call creates a block device node called C<path> with mode C<mode> and "
10580 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10581 "wrapper around C<guestfs_mknod>."
10585 #: ../src/guestfs-actions.pod:4078
10586 msgid "guestfs_mknod_c"
10590 #: ../src/guestfs-actions.pod:4080
10594 " guestfs_mknod_c (guestfs_h *g,\n"
10598 " const char *path);\n"
10603 #: ../src/guestfs-actions.pod:4087
10605 "This call creates a char device node called C<path> with mode C<mode> and "
10606 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10607 "wrapper around C<guestfs_mknod>."
10611 #: ../src/guestfs-actions.pod:4097
10612 msgid "guestfs_mkswap"
10616 #: ../src/guestfs-actions.pod:4099
10620 " guestfs_mkswap (guestfs_h *g,\n"
10621 " const char *device);\n"
10626 #: ../src/guestfs-actions.pod:4103 ../fish/guestfish-actions.pod:2738
10627 msgid "Create a swap partition on C<device>."
10631 #: ../src/guestfs-actions.pod:4109
10632 msgid "guestfs_mkswap_L"
10636 #: ../src/guestfs-actions.pod:4111
10640 " guestfs_mkswap_L (guestfs_h *g,\n"
10641 " const char *label,\n"
10642 " const char *device);\n"
10647 #: ../src/guestfs-actions.pod:4116 ../fish/guestfish-actions.pod:2744
10648 msgid "Create a swap partition on C<device> with label C<label>."
10652 #: ../src/guestfs-actions.pod:4118 ../fish/guestfish-actions.pod:2746
10654 "Note that you cannot attach a swap label to a block device "
10655 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
10656 "the kernel or swap tools."
10660 #: ../src/guestfs-actions.pod:4126
10661 msgid "guestfs_mkswap_U"
10665 #: ../src/guestfs-actions.pod:4128
10669 " guestfs_mkswap_U (guestfs_h *g,\n"
10670 " const char *uuid,\n"
10671 " const char *device);\n"
10676 #: ../src/guestfs-actions.pod:4133 ../fish/guestfish-actions.pod:2754
10677 msgid "Create a swap partition on C<device> with UUID C<uuid>."
10681 #: ../src/guestfs-actions.pod:4139
10682 msgid "guestfs_mkswap_file"
10686 #: ../src/guestfs-actions.pod:4141
10690 " guestfs_mkswap_file (guestfs_h *g,\n"
10691 " const char *path);\n"
10696 #: ../src/guestfs-actions.pod:4145 ../fish/guestfish-actions.pod:2760
10697 msgid "Create a swap file."
10701 #: ../src/guestfs-actions.pod:4147
10703 "This command just writes a swap file signature to an existing file. To "
10704 "create the file itself, use something like C<guestfs_fallocate>."
10708 #: ../src/guestfs-actions.pod:4154
10709 msgid "guestfs_modprobe"
10713 #: ../src/guestfs-actions.pod:4156
10717 " guestfs_modprobe (guestfs_h *g,\n"
10718 " const char *modulename);\n"
10723 #: ../src/guestfs-actions.pod:4160 ../fish/guestfish-actions.pod:2769
10724 msgid "This loads a kernel module in the appliance."
10728 #: ../src/guestfs-actions.pod:4162 ../fish/guestfish-actions.pod:2771
10730 "The kernel module must have been whitelisted when libguestfs was built (see "
10731 "C<appliance/kmod.whitelist.in> in the source)."
10735 #: ../src/guestfs-actions.pod:4169
10736 msgid "guestfs_mount"
10740 #: ../src/guestfs-actions.pod:4171
10744 " guestfs_mount (guestfs_h *g,\n"
10745 " const char *device,\n"
10746 " const char *mountpoint);\n"
10751 #: ../src/guestfs-actions.pod:4176 ../fish/guestfish-actions.pod:2778
10753 "Mount a guest disk at a position in the filesystem. Block devices are named "
10754 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
10755 "those block devices contain partitions, they will have the usual names "
10756 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
10760 #: ../src/guestfs-actions.pod:4182 ../fish/guestfish-actions.pod:2784
10762 "The rules are the same as for L<mount(2)>: A filesystem must first be "
10763 "mounted on C</> before others can be mounted. Other filesystems can only be "
10764 "mounted on directories which already exist."
10768 #: ../src/guestfs-actions.pod:4187 ../fish/guestfish-actions.pod:2789
10770 "The mounted filesystem is writable, if we have sufficient permissions on the "
10771 "underlying device."
10775 #: ../src/guestfs-actions.pod:4190
10777 "B<Important note:> When you use this call, the filesystem options C<sync> "
10778 "and C<noatime> are set implicitly. This was originally done because we "
10779 "thought it would improve reliability, but it turns out that I<-o sync> has a "
10780 "very large negative performance impact and negligible effect on "
10781 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
10782 "in any code that needs performance, and instead use C<guestfs_mount_options> "
10783 "(use an empty string for the first parameter if you don't want any options)."
10787 #: ../src/guestfs-actions.pod:4204
10788 msgid "guestfs_mount_loop"
10792 #: ../src/guestfs-actions.pod:4206
10796 " guestfs_mount_loop (guestfs_h *g,\n"
10797 " const char *file,\n"
10798 " const char *mountpoint);\n"
10803 #: ../src/guestfs-actions.pod:4211 ../fish/guestfish-actions.pod:2806
10805 "This command lets you mount C<file> (a filesystem image in a file) on a "
10806 "mount point. It is entirely equivalent to the command C<mount -o loop file "
10811 #: ../src/guestfs-actions.pod:4219
10812 msgid "guestfs_mount_options"
10816 #: ../src/guestfs-actions.pod:4221
10820 " guestfs_mount_options (guestfs_h *g,\n"
10821 " const char *options,\n"
10822 " const char *device,\n"
10823 " const char *mountpoint);\n"
10828 #: ../src/guestfs-actions.pod:4227
10830 "This is the same as the C<guestfs_mount> command, but it allows you to set "
10831 "the mount options as for the L<mount(8)> I<-o> flag."
10835 #: ../src/guestfs-actions.pod:4231 ../fish/guestfish-actions.pod:2818
10837 "If the C<options> parameter is an empty string, then no options are passed "
10838 "(all options default to whatever the filesystem uses)."
10842 #: ../src/guestfs-actions.pod:4237 ../src/guestfs-actions.pod:4251 ../src/guestfs-actions.pod:4268
10843 msgid "(Added in 1.0.10)"
10847 #: ../src/guestfs-actions.pod:4239
10848 msgid "guestfs_mount_ro"
10852 #: ../src/guestfs-actions.pod:4241
10856 " guestfs_mount_ro (guestfs_h *g,\n"
10857 " const char *device,\n"
10858 " const char *mountpoint);\n"
10863 #: ../src/guestfs-actions.pod:4246
10865 "This is the same as the C<guestfs_mount> command, but it mounts the "
10866 "filesystem with the read-only (I<-o ro>) flag."
10870 #: ../src/guestfs-actions.pod:4253
10871 msgid "guestfs_mount_vfs"
10875 #: ../src/guestfs-actions.pod:4255
10879 " guestfs_mount_vfs (guestfs_h *g,\n"
10880 " const char *options,\n"
10881 " const char *vfstype,\n"
10882 " const char *device,\n"
10883 " const char *mountpoint);\n"
10888 #: ../src/guestfs-actions.pod:4262
10890 "This is the same as the C<guestfs_mount> command, but it allows you to set "
10891 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
10896 #: ../src/guestfs-actions.pod:4270
10897 msgid "guestfs_mountpoints"
10901 #: ../src/guestfs-actions.pod:4272
10905 " guestfs_mountpoints (guestfs_h *g);\n"
10910 #: ../src/guestfs-actions.pod:4275
10912 "This call is similar to C<guestfs_mounts>. That call returns a list of "
10913 "devices. This one returns a hash table (map) of device name to directory "
10914 "where the device is mounted."
10918 #: ../src/guestfs-actions.pod:4287
10919 msgid "guestfs_mounts"
10923 #: ../src/guestfs-actions.pod:4289
10927 " guestfs_mounts (guestfs_h *g);\n"
10932 #: ../src/guestfs-actions.pod:4292 ../fish/guestfish-actions.pod:2849
10934 "This returns the list of currently mounted filesystems. It returns the list "
10935 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
10939 #: ../src/guestfs-actions.pod:4295 ../fish/guestfish-actions.pod:2852
10940 msgid "Some internal mounts are not shown."
10944 #: ../src/guestfs-actions.pod:4297
10945 msgid "See also: C<guestfs_mountpoints>"
10949 #: ../src/guestfs-actions.pod:4305
10954 #: ../src/guestfs-actions.pod:4307
10958 " guestfs_mv (guestfs_h *g,\n"
10959 " const char *src,\n"
10960 " const char *dest);\n"
10965 #: ../src/guestfs-actions.pod:4312 ../fish/guestfish-actions.pod:2860
10967 "This moves a file from C<src> to C<dest> where C<dest> is either a "
10968 "destination filename or destination directory."
10972 #: ../src/guestfs-actions.pod:4319
10973 msgid "guestfs_ntfs_3g_probe"
10977 #: ../src/guestfs-actions.pod:4321
10981 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
10983 " const char *device);\n"
10988 #: ../src/guestfs-actions.pod:4326 ../fish/guestfish-actions.pod:2867
10990 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
10991 "C<device> for mountability. (Not all NTFS volumes can be mounted "
10992 "read-write, and some cannot be mounted at all)."
10996 #: ../src/guestfs-actions.pod:4330 ../fish/guestfish-actions.pod:2871
10998 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
10999 "can be mounted read-write. Set it to false if you want to test if the "
11000 "volume can be mounted read-only."
11004 #: ../src/guestfs-actions.pod:4334 ../fish/guestfish-actions.pod:2875
11006 "The return value is an integer which C<0> if the operation would succeed, or "
11007 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11011 #: ../src/guestfs-actions.pod:4340
11012 msgid "(Added in 1.0.43)"
11016 #: ../src/guestfs-actions.pod:4342
11017 msgid "guestfs_ntfsresize"
11021 #: ../src/guestfs-actions.pod:4344
11025 " guestfs_ntfsresize (guestfs_h *g,\n"
11026 " const char *device);\n"
11031 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2883
11033 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
11034 "size of the underlying device. See also L<ntfsresize(8)>."
11038 #: ../src/guestfs-actions.pod:4356
11039 msgid "guestfs_ntfsresize_size"
11043 #: ../src/guestfs-actions.pod:4358
11047 " guestfs_ntfsresize_size (guestfs_h *g,\n"
11048 " const char *device,\n"
11049 " int64_t size);\n"
11054 #: ../src/guestfs-actions.pod:4363
11056 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
11057 "to specify the new size (in bytes) explicitly."
11061 #: ../src/guestfs-actions.pod:4368 ../src/guestfs-actions.pod:4804 ../src/guestfs-actions.pod:4877 ../src/guestfs-actions.pod:5126
11062 msgid "(Added in 1.3.14)"
11066 #: ../src/guestfs-actions.pod:4370
11067 msgid "guestfs_part_add"
11071 #: ../src/guestfs-actions.pod:4372
11075 " guestfs_part_add (guestfs_h *g,\n"
11076 " const char *device,\n"
11077 " const char *prlogex,\n"
11078 " int64_t startsect,\n"
11079 " int64_t endsect);\n"
11084 #: ../src/guestfs-actions.pod:4379
11086 "This command adds a partition to C<device>. If there is no partition table "
11087 "on the device, call C<guestfs_part_init> first."
11091 #: ../src/guestfs-actions.pod:4382 ../fish/guestfish-actions.pod:2901
11093 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11094 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11095 "C<logical>) and C<e> (or C<extended>) partition types."
11099 #: ../src/guestfs-actions.pod:4387 ../fish/guestfish-actions.pod:2906
11101 "C<startsect> and C<endsect> are the start and end of the partition in "
11102 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11103 "from the end of the disk (C<-1> is the last sector)."
11107 #: ../src/guestfs-actions.pod:4391
11109 "Creating a partition which covers the whole disk is not so easy. Use "
11110 "C<guestfs_part_disk> to do that."
11114 #: ../src/guestfs-actions.pod:4396 ../src/guestfs-actions.pod:4434 ../src/guestfs-actions.pod:4487 ../src/guestfs-actions.pod:4565 ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:4622 ../src/guestfs-actions.pod:4662
11115 msgid "(Added in 1.0.78)"
11119 #: ../src/guestfs-actions.pod:4398
11120 msgid "guestfs_part_del"
11124 #: ../src/guestfs-actions.pod:4400
11128 " guestfs_part_del (guestfs_h *g,\n"
11129 " const char *device,\n"
11135 #: ../src/guestfs-actions.pod:4405 ../fish/guestfish-actions.pod:2917
11136 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11140 #: ../src/guestfs-actions.pod:4407 ../fish/guestfish-actions.pod:2919
11142 "Note that in the case of MBR partitioning, deleting an extended partition "
11143 "also deletes any logical partitions it contains."
11147 #: ../src/guestfs-actions.pod:4415
11148 msgid "guestfs_part_disk"
11152 #: ../src/guestfs-actions.pod:4417
11156 " guestfs_part_disk (guestfs_h *g,\n"
11157 " const char *device,\n"
11158 " const char *parttype);\n"
11163 #: ../src/guestfs-actions.pod:4422
11165 "This command is simply a combination of C<guestfs_part_init> followed by "
11166 "C<guestfs_part_add> to create a single primary partition covering the whole "
11171 #: ../src/guestfs-actions.pod:4426
11173 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11174 "possible values are described in C<guestfs_part_init>."
11178 #: ../src/guestfs-actions.pod:4436
11179 msgid "guestfs_part_get_bootable"
11183 #: ../src/guestfs-actions.pod:4438
11187 " guestfs_part_get_bootable (guestfs_h *g,\n"
11188 " const char *device,\n"
11194 #: ../src/guestfs-actions.pod:4443 ../fish/guestfish-actions.pod:2941
11196 "This command returns true if the partition C<partnum> on C<device> has the "
11197 "bootable flag set."
11201 #: ../src/guestfs-actions.pod:4446
11202 msgid "See also C<guestfs_part_set_bootable>."
11206 #: ../src/guestfs-actions.pod:4452
11207 msgid "guestfs_part_get_mbr_id"
11211 #: ../src/guestfs-actions.pod:4454
11215 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
11216 " const char *device,\n"
11222 #: ../src/guestfs-actions.pod:4459 ../fish/guestfish-actions.pod:2950
11224 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11225 "partition C<partnum>."
11229 #: ../src/guestfs-actions.pod:4462 ../src/guestfs-actions.pod:4638
11231 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11232 "undefined results for other partition table types (see "
11233 "C<guestfs_part_get_parttype>)."
11237 #: ../src/guestfs-actions.pod:4470
11238 msgid "guestfs_part_get_parttype"
11242 #: ../src/guestfs-actions.pod:4472
11246 " guestfs_part_get_parttype (guestfs_h *g,\n"
11247 " const char *device);\n"
11252 #: ../src/guestfs-actions.pod:4476 ../fish/guestfish-actions.pod:2961
11254 "This command examines the partition table on C<device> and returns the "
11255 "partition table type (format) being used."
11259 #: ../src/guestfs-actions.pod:4479
11261 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11262 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11263 "possible, although unusual. See C<guestfs_part_init> for a full list."
11267 #: ../src/guestfs-actions.pod:4489
11268 msgid "guestfs_part_init"
11272 #: ../src/guestfs-actions.pod:4491
11276 " guestfs_part_init (guestfs_h *g,\n"
11277 " const char *device,\n"
11278 " const char *parttype);\n"
11283 #: ../src/guestfs-actions.pod:4496 ../fish/guestfish-actions.pod:2973
11285 "This creates an empty partition table on C<device> of one of the partition "
11286 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11287 "(for large disks)."
11291 #: ../src/guestfs-actions.pod:4500
11293 "Initially there are no partitions. Following this, you should call "
11294 "C<guestfs_part_add> for each partition required."
11298 #: ../src/guestfs-actions.pod:4503 ../fish/guestfish-actions.pod:2980
11299 msgid "Possible values for C<parttype> are:"
11303 #: ../src/guestfs-actions.pod:4507 ../fish/guestfish-actions.pod:2984
11304 msgid "B<efi> | B<gpt>"
11308 #: ../src/guestfs-actions.pod:4509 ../fish/guestfish-actions.pod:2986
11309 msgid "Intel EFI / GPT partition table."
11313 #: ../src/guestfs-actions.pod:4511 ../fish/guestfish-actions.pod:2988
11315 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11316 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11317 "the C<mbr> format."
11321 #: ../src/guestfs-actions.pod:4515 ../fish/guestfish-actions.pod:2992
11322 msgid "B<mbr> | B<msdos>"
11326 #: ../src/guestfs-actions.pod:4517 ../fish/guestfish-actions.pod:2994
11328 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11329 "Windows. This partition type will B<only> work for device sizes up to 2 "
11330 "TB. For large disks we recommend using C<gpt>."
11334 #: ../src/guestfs-actions.pod:4524 ../fish/guestfish-actions.pod:3001
11335 msgid "Other partition table types that may work but are not supported include:"
11339 #: ../src/guestfs-actions.pod:4529 ../fish/guestfish-actions.pod:3006
11344 #: ../src/guestfs-actions.pod:4531 ../fish/guestfish-actions.pod:3008
11345 msgid "AIX disk labels."
11349 #: ../src/guestfs-actions.pod:4533 ../fish/guestfish-actions.pod:3010
11350 msgid "B<amiga> | B<rdb>"
11354 #: ../src/guestfs-actions.pod:4535 ../fish/guestfish-actions.pod:3012
11355 msgid "Amiga \"Rigid Disk Block\" format."
11359 #: ../src/guestfs-actions.pod:4537 ../fish/guestfish-actions.pod:3014
11364 #: ../src/guestfs-actions.pod:4539 ../fish/guestfish-actions.pod:3016
11365 msgid "BSD disk labels."
11369 #: ../src/guestfs-actions.pod:4541 ../fish/guestfish-actions.pod:3018
11374 #: ../src/guestfs-actions.pod:4543 ../fish/guestfish-actions.pod:3020
11375 msgid "DASD, used on IBM mainframes."
11379 #: ../src/guestfs-actions.pod:4545 ../fish/guestfish-actions.pod:3022
11384 #: ../src/guestfs-actions.pod:4547 ../fish/guestfish-actions.pod:3024
11385 msgid "MIPS/SGI volumes."
11389 #: ../src/guestfs-actions.pod:4549 ../fish/guestfish-actions.pod:3026
11394 #: ../src/guestfs-actions.pod:4551 ../fish/guestfish-actions.pod:3028
11395 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11399 #: ../src/guestfs-actions.pod:4553 ../fish/guestfish-actions.pod:3030
11404 #: ../src/guestfs-actions.pod:4555 ../fish/guestfish-actions.pod:3032
11405 msgid "NEC PC-98 format, common in Japan apparently."
11409 #: ../src/guestfs-actions.pod:4557 ../fish/guestfish-actions.pod:3034
11414 #: ../src/guestfs-actions.pod:4559 ../fish/guestfish-actions.pod:3036
11415 msgid "Sun disk labels."
11419 #: ../src/guestfs-actions.pod:4567
11420 msgid "guestfs_part_list"
11424 #: ../src/guestfs-actions.pod:4569
11427 " struct guestfs_partition_list *\n"
11428 " guestfs_part_list (guestfs_h *g,\n"
11429 " const char *device);\n"
11434 #: ../src/guestfs-actions.pod:4573 ../fish/guestfish-actions.pod:3044
11436 "This command parses the partition table on C<device> and returns the list of "
11437 "partitions found."
11441 #: ../src/guestfs-actions.pod:4576 ../fish/guestfish-actions.pod:3047
11442 msgid "The fields in the returned structure are:"
11446 #: ../src/guestfs-actions.pod:4580 ../fish/guestfish-actions.pod:3051
11447 msgid "B<part_num>"
11451 #: ../src/guestfs-actions.pod:4582 ../fish/guestfish-actions.pod:3053
11452 msgid "Partition number, counting from 1."
11456 #: ../src/guestfs-actions.pod:4584 ../fish/guestfish-actions.pod:3055
11457 msgid "B<part_start>"
11461 #: ../src/guestfs-actions.pod:4586
11463 "Start of the partition I<in bytes>. To get sectors you have to divide by "
11464 "the device's sector size, see C<guestfs_blockdev_getss>."
11468 #: ../src/guestfs-actions.pod:4589 ../fish/guestfish-actions.pod:3060
11469 msgid "B<part_end>"
11473 #: ../src/guestfs-actions.pod:4591 ../fish/guestfish-actions.pod:3062
11474 msgid "End of the partition in bytes."
11478 #: ../src/guestfs-actions.pod:4593 ../fish/guestfish-actions.pod:3064
11479 msgid "B<part_size>"
11483 #: ../src/guestfs-actions.pod:4595 ../fish/guestfish-actions.pod:3066
11484 msgid "Size of the partition in bytes."
11488 #: ../src/guestfs-actions.pod:4599
11490 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
11491 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
11496 #: ../src/guestfs-actions.pod:4605
11497 msgid "guestfs_part_set_bootable"
11501 #: ../src/guestfs-actions.pod:4607
11505 " guestfs_part_set_bootable (guestfs_h *g,\n"
11506 " const char *device,\n"
11508 " int bootable);\n"
11513 #: ../src/guestfs-actions.pod:4613 ../fish/guestfish-actions.pod:3074
11515 "This sets the bootable flag on partition numbered C<partnum> on device "
11516 "C<device>. Note that partitions are numbered from 1."
11520 #: ../src/guestfs-actions.pod:4616 ../fish/guestfish-actions.pod:3077
11522 "The bootable flag is used by some operating systems (notably Windows) to "
11523 "determine which partition to boot from. It is by no means universally "
11528 #: ../src/guestfs-actions.pod:4624
11529 msgid "guestfs_part_set_mbr_id"
11533 #: ../src/guestfs-actions.pod:4626
11537 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
11538 " const char *device,\n"
11545 #: ../src/guestfs-actions.pod:4632 ../fish/guestfish-actions.pod:3085
11547 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
11548 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
11549 "documentation are in fact hexadecimal numbers, but usually documented "
11550 "without any leading \"0x\" which might be confusing."
11554 #: ../src/guestfs-actions.pod:4646
11555 msgid "guestfs_part_set_name"
11559 #: ../src/guestfs-actions.pod:4648
11563 " guestfs_part_set_name (guestfs_h *g,\n"
11564 " const char *device,\n"
11566 " const char *name);\n"
11571 #: ../src/guestfs-actions.pod:4654 ../fish/guestfish-actions.pod:3099
11573 "This sets the partition name on partition numbered C<partnum> on device "
11574 "C<device>. Note that partitions are numbered from 1."
11578 #: ../src/guestfs-actions.pod:4657 ../fish/guestfish-actions.pod:3102
11580 "The partition name can only be set on certain types of partition table. "
11581 "This works on C<gpt> but not on C<mbr> partitions."
11585 #: ../src/guestfs-actions.pod:4664
11586 msgid "guestfs_part_to_dev"
11590 #: ../src/guestfs-actions.pod:4666
11594 " guestfs_part_to_dev (guestfs_h *g,\n"
11595 " const char *partition);\n"
11600 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3109
11602 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
11603 "partition number, returning the device name (eg. \"/dev/sdb\")."
11607 #: ../src/guestfs-actions.pod:4674
11609 "The named partition must exist, for example as a string returned from "
11610 "C<guestfs_list_partitions>."
11614 #: ../src/guestfs-actions.pod:4682
11615 msgid "guestfs_ping_daemon"
11619 #: ../src/guestfs-actions.pod:4684
11623 " guestfs_ping_daemon (guestfs_h *g);\n"
11628 #: ../src/guestfs-actions.pod:4687 ../fish/guestfish-actions.pod:3120
11630 "This is a test probe into the guestfs daemon running inside the qemu "
11631 "subprocess. Calling this function checks that the daemon responds to the "
11632 "ping message, without affecting the daemon or attached block device(s) in "
11637 #: ../src/guestfs-actions.pod:4696
11638 msgid "guestfs_pread"
11642 #: ../src/guestfs-actions.pod:4698
11646 " guestfs_pread (guestfs_h *g,\n"
11647 " const char *path,\n"
11649 " int64_t offset,\n"
11650 " size_t *size_r);\n"
11655 #: ../src/guestfs-actions.pod:4705 ../fish/guestfish-actions.pod:3129
11657 "This command lets you read part of a file. It reads C<count> bytes of the "
11658 "file, starting at C<offset>, from file C<path>."
11662 #: ../src/guestfs-actions.pod:4708 ../src/guestfs-actions.pod:4734 ../fish/guestfish-actions.pod:3132 ../fish/guestfish-actions.pod:3147
11664 "This may read fewer bytes than requested. For further details see the "
11665 "L<pread(2)> system call."
11669 #: ../src/guestfs-actions.pod:4711
11670 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
11674 #: ../src/guestfs-actions.pod:4722
11675 msgid "guestfs_pread_device"
11679 #: ../src/guestfs-actions.pod:4724
11683 " guestfs_pread_device (guestfs_h *g,\n"
11684 " const char *device,\n"
11686 " int64_t offset,\n"
11687 " size_t *size_r);\n"
11692 #: ../src/guestfs-actions.pod:4731 ../fish/guestfish-actions.pod:3144
11694 "This command lets you read part of a file. It reads C<count> bytes of "
11695 "C<device>, starting at C<offset>."
11699 #: ../src/guestfs-actions.pod:4737
11700 msgid "See also C<guestfs_pread>."
11704 #: ../src/guestfs-actions.pod:4746
11705 msgid "(Added in 1.5.21)"
11709 #: ../src/guestfs-actions.pod:4748
11710 msgid "guestfs_pvcreate"
11714 #: ../src/guestfs-actions.pod:4750
11718 " guestfs_pvcreate (guestfs_h *g,\n"
11719 " const char *device);\n"
11724 #: ../src/guestfs-actions.pod:4754 ../fish/guestfish-actions.pod:3159
11726 "This creates an LVM physical volume on the named C<device>, where C<device> "
11727 "should usually be a partition name such as C</dev/sda1>."
11731 #: ../src/guestfs-actions.pod:4762
11732 msgid "guestfs_pvremove"
11736 #: ../src/guestfs-actions.pod:4764
11740 " guestfs_pvremove (guestfs_h *g,\n"
11741 " const char *device);\n"
11746 #: ../src/guestfs-actions.pod:4768 ../fish/guestfish-actions.pod:3167
11748 "This wipes a physical volume C<device> so that LVM will no longer recognise "
11753 #: ../src/guestfs-actions.pod:4771 ../fish/guestfish-actions.pod:3170
11755 "The implementation uses the C<pvremove> command which refuses to wipe "
11756 "physical volumes that contain any volume groups, so you have to remove those "
11761 #: ../src/guestfs-actions.pod:4779
11762 msgid "guestfs_pvresize"
11766 #: ../src/guestfs-actions.pod:4781
11770 " guestfs_pvresize (guestfs_h *g,\n"
11771 " const char *device);\n"
11776 #: ../src/guestfs-actions.pod:4785 ../fish/guestfish-actions.pod:3178
11778 "This resizes (expands or shrinks) an existing LVM physical volume to match "
11779 "the new size of the underlying device."
11783 #: ../src/guestfs-actions.pod:4792
11784 msgid "guestfs_pvresize_size"
11788 #: ../src/guestfs-actions.pod:4794
11792 " guestfs_pvresize_size (guestfs_h *g,\n"
11793 " const char *device,\n"
11794 " int64_t size);\n"
11799 #: ../src/guestfs-actions.pod:4799
11801 "This command is the same as C<guestfs_pvresize> except that it allows you to "
11802 "specify the new size (in bytes) explicitly."
11806 #: ../src/guestfs-actions.pod:4806
11807 msgid "guestfs_pvs"
11811 #: ../src/guestfs-actions.pod:4808
11815 " guestfs_pvs (guestfs_h *g);\n"
11820 #: ../src/guestfs-actions.pod:4811 ../fish/guestfish-actions.pod:3192
11822 "List all the physical volumes detected. This is the equivalent of the "
11823 "L<pvs(8)> command."
11827 #: ../src/guestfs-actions.pod:4814 ../fish/guestfish-actions.pod:3195
11829 "This returns a list of just the device names that contain PVs "
11830 "(eg. C</dev/sda2>)."
11834 #: ../src/guestfs-actions.pod:4817
11835 msgid "See also C<guestfs_pvs_full>."
11839 #: ../src/guestfs-actions.pod:4825
11840 msgid "guestfs_pvs_full"
11844 #: ../src/guestfs-actions.pod:4827
11847 " struct guestfs_lvm_pv_list *\n"
11848 " guestfs_pvs_full (guestfs_h *g);\n"
11853 #: ../src/guestfs-actions.pod:4830 ../fish/guestfish-actions.pod:3204
11855 "List all the physical volumes detected. This is the equivalent of the "
11856 "L<pvs(8)> command. The \"full\" version includes all fields."
11860 #: ../src/guestfs-actions.pod:4833
11862 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
11863 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
11868 #: ../src/guestfs-actions.pod:4839
11869 msgid "guestfs_pvuuid"
11873 #: ../src/guestfs-actions.pod:4841
11877 " guestfs_pvuuid (guestfs_h *g,\n"
11878 " const char *device);\n"
11883 #: ../src/guestfs-actions.pod:4845 ../fish/guestfish-actions.pod:3211
11884 msgid "This command returns the UUID of the LVM PV C<device>."
11888 #: ../src/guestfs-actions.pod:4852
11889 msgid "guestfs_pwrite"
11893 #: ../src/guestfs-actions.pod:4854
11897 " guestfs_pwrite (guestfs_h *g,\n"
11898 " const char *path,\n"
11899 " const char *content,\n"
11900 " size_t content_size,\n"
11901 " int64_t offset);\n"
11906 #: ../src/guestfs-actions.pod:4861 ../fish/guestfish-actions.pod:3217
11908 "This command writes to part of a file. It writes the data buffer C<content> "
11909 "to the file C<path> starting at offset C<offset>."
11913 #: ../src/guestfs-actions.pod:4864 ../fish/guestfish-actions.pod:3220
11915 "This command implements the L<pwrite(2)> system call, and like that system "
11916 "call it may not write the full data requested. The return value is the "
11917 "number of bytes that were actually written to the file. This could even be "
11918 "0, although short writes are unlikely for regular files in ordinary "
11923 #: ../src/guestfs-actions.pod:4870
11924 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
11928 #: ../src/guestfs-actions.pod:4879
11929 msgid "guestfs_pwrite_device"
11933 #: ../src/guestfs-actions.pod:4881
11937 " guestfs_pwrite_device (guestfs_h *g,\n"
11938 " const char *device,\n"
11939 " const char *content,\n"
11940 " size_t content_size,\n"
11941 " int64_t offset);\n"
11946 #: ../src/guestfs-actions.pod:4888 ../fish/guestfish-actions.pod:3235
11948 "This command writes to part of a device. It writes the data buffer "
11949 "C<content> to C<device> starting at offset C<offset>."
11953 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3238
11955 "This command implements the L<pwrite(2)> system call, and like that system "
11956 "call it may not write the full data requested (although short writes to disk "
11957 "devices and partitions are probably impossible with standard Linux kernels)."
11961 #: ../src/guestfs-actions.pod:4896
11962 msgid "See also C<guestfs_pwrite>."
11966 #: ../src/guestfs-actions.pod:4903
11967 msgid "(Added in 1.5.20)"
11971 #: ../src/guestfs-actions.pod:4905
11972 msgid "guestfs_read_file"
11976 #: ../src/guestfs-actions.pod:4907
11980 " guestfs_read_file (guestfs_h *g,\n"
11981 " const char *path,\n"
11982 " size_t *size_r);\n"
11987 #: ../src/guestfs-actions.pod:4912 ../fish/guestfish-actions.pod:3252
11988 msgid "This calls returns the contents of the file C<path> as a buffer."
11992 #: ../src/guestfs-actions.pod:4915
11994 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
11995 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
11996 "function is limited in the total size of file that can be handled."
12000 #: ../src/guestfs-actions.pod:4927
12001 msgid "(Added in 1.0.63)"
12005 #: ../src/guestfs-actions.pod:4929
12006 msgid "guestfs_read_lines"
12010 #: ../src/guestfs-actions.pod:4931
12014 " guestfs_read_lines (guestfs_h *g,\n"
12015 " const char *path);\n"
12020 #: ../src/guestfs-actions.pod:4937 ../fish/guestfish-actions.pod:3269
12022 "The file contents are returned as a list of lines. Trailing C<LF> and "
12023 "C<CRLF> character sequences are I<not> returned."
12027 #: ../src/guestfs-actions.pod:4940
12029 "Note that this function cannot correctly handle binary files (specifically, "
12030 "files containing C<\\0> character which is treated as end of line). For "
12031 "those you need to use the C<guestfs_read_file> function which has a more "
12032 "complex interface."
12036 #: ../src/guestfs-actions.pod:4951
12037 msgid "guestfs_readdir"
12041 #: ../src/guestfs-actions.pod:4953
12044 " struct guestfs_dirent_list *\n"
12045 " guestfs_readdir (guestfs_h *g,\n"
12046 " const char *dir);\n"
12051 #: ../src/guestfs-actions.pod:4957 ../fish/guestfish-actions.pod:3281
12052 msgid "This returns the list of directory entries in directory C<dir>."
12056 #: ../src/guestfs-actions.pod:4959 ../fish/guestfish-actions.pod:3283
12058 "All entries in the directory are returned, including C<.> and C<..>. The "
12059 "entries are I<not> sorted, but returned in the same order as the underlying "
12064 #: ../src/guestfs-actions.pod:4963 ../fish/guestfish-actions.pod:3287
12066 "Also this call returns basic file type information about each file. The "
12067 "C<ftyp> field will contain one of the following characters:"
12071 #: ../src/guestfs-actions.pod:4968 ../fish/guestfish-actions.pod:3292
12076 #: ../src/guestfs-actions.pod:4970 ../fish/guestfish-actions.pod:3294
12077 msgid "Block special"
12081 #: ../src/guestfs-actions.pod:4972 ../fish/guestfish-actions.pod:3296
12086 #: ../src/guestfs-actions.pod:4974 ../fish/guestfish-actions.pod:3298
12087 msgid "Char special"
12091 #: ../src/guestfs-actions.pod:4976 ../fish/guestfish-actions.pod:3300
12096 #: ../src/guestfs-actions.pod:4978 ../fish/guestfish-actions.pod:3302
12101 #: ../src/guestfs-actions.pod:4980 ../fish/guestfish-actions.pod:3304
12106 #: ../src/guestfs-actions.pod:4982 ../fish/guestfish-actions.pod:3306
12107 msgid "FIFO (named pipe)"
12111 #: ../src/guestfs-actions.pod:4984 ../fish/guestfish-actions.pod:3308
12116 #: ../src/guestfs-actions.pod:4986 ../fish/guestfish-actions.pod:3310
12117 msgid "Symbolic link"
12121 #: ../src/guestfs-actions.pod:4988 ../fish/guestfish-actions.pod:3312
12126 #: ../src/guestfs-actions.pod:4990 ../fish/guestfish-actions.pod:3314
12127 msgid "Regular file"
12131 #: ../src/guestfs-actions.pod:4992 ../fish/guestfish-actions.pod:3316
12136 #: ../src/guestfs-actions.pod:4994 ../fish/guestfish-actions.pod:3318
12141 #: ../src/guestfs-actions.pod:4996 ../fish/guestfish-actions.pod:3320
12146 #: ../src/guestfs-actions.pod:4998 ../fish/guestfish-actions.pod:3322
12147 msgid "Unknown file type"
12151 #: ../src/guestfs-actions.pod:5000 ../fish/guestfish-actions.pod:3324
12156 #: ../src/guestfs-actions.pod:5002 ../fish/guestfish-actions.pod:3326
12157 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12161 #: ../src/guestfs-actions.pod:5007
12163 "This function is primarily intended for use by programs. To get a simple "
12164 "list of names, use C<guestfs_ls>. To get a printable directory for human "
12165 "consumption, use C<guestfs_ll>."
12169 #: ../src/guestfs-actions.pod:5011
12171 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
12172 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
12177 #: ../src/guestfs-actions.pod:5017
12178 msgid "guestfs_readlink"
12182 #: ../src/guestfs-actions.pod:5019
12186 " guestfs_readlink (guestfs_h *g,\n"
12187 " const char *path);\n"
12192 #: ../src/guestfs-actions.pod:5023 ../fish/guestfish-actions.pod:3339
12193 msgid "This command reads the target of a symbolic link."
12197 #: ../src/guestfs-actions.pod:5030
12198 msgid "guestfs_readlinklist"
12202 #: ../src/guestfs-actions.pod:5032
12206 " guestfs_readlinklist (guestfs_h *g,\n"
12207 " const char *path,\n"
12208 " char *const *names);\n"
12213 #: ../src/guestfs-actions.pod:5037 ../fish/guestfish-actions.pod:3345
12215 "This call allows you to do a C<readlink> operation on multiple files, where "
12216 "all files are in the directory C<path>. C<names> is the list of files from "
12221 #: ../src/guestfs-actions.pod:5041 ../fish/guestfish-actions.pod:3349
12223 "On return you get a list of strings, with a one-to-one correspondence to the "
12224 "C<names> list. Each string is the value of the symbolic link."
12228 #: ../src/guestfs-actions.pod:5045 ../fish/guestfish-actions.pod:3353
12230 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12231 "result string is the empty string C<\"\">. However the whole operation is "
12232 "completed even if there were C<readlink(2)> errors, and so you can call this "
12233 "function with names where you don't know if they are symbolic links already "
12234 "(albeit slightly less efficient)."
12238 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3360
12240 "This call is intended for programs that want to efficiently list a directory "
12241 "contents without making many round-trips. Very long directory listings "
12242 "might cause the protocol message size to be exceeded, causing this call to "
12243 "fail. The caller must split up such requests into smaller groups of names."
12247 #: ../src/guestfs-actions.pod:5065
12248 msgid "guestfs_realpath"
12252 #: ../src/guestfs-actions.pod:5067
12256 " guestfs_realpath (guestfs_h *g,\n"
12257 " const char *path);\n"
12262 #: ../src/guestfs-actions.pod:5071 ../fish/guestfish-actions.pod:3371
12264 "Return the canonicalized absolute pathname of C<path>. The returned path "
12265 "has no C<.>, C<..> or symbolic link path elements."
12269 #: ../src/guestfs-actions.pod:5079
12270 msgid "guestfs_removexattr"
12274 #: ../src/guestfs-actions.pod:5081
12278 " guestfs_removexattr (guestfs_h *g,\n"
12279 " const char *xattr,\n"
12280 " const char *path);\n"
12285 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3378
12286 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
12290 #: ../src/guestfs-actions.pod:5089
12291 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
12295 #: ../src/guestfs-actions.pod:5095
12296 msgid "guestfs_resize2fs"
12300 #: ../src/guestfs-actions.pod:5097
12304 " guestfs_resize2fs (guestfs_h *g,\n"
12305 " const char *device);\n"
12310 #: ../src/guestfs-actions.pod:5101 ../fish/guestfish-actions.pod:3387
12312 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12313 "underlying device."
12317 #: ../src/guestfs-actions.pod:5104
12319 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
12320 "C<device> before calling this command. For unknown reasons C<resize2fs> "
12321 "sometimes gives an error about this and sometimes not. In any case, it is "
12322 "always safe to call C<guestfs_e2fsck_f> before calling this function."
12326 #: ../src/guestfs-actions.pod:5114
12327 msgid "guestfs_resize2fs_size"
12331 #: ../src/guestfs-actions.pod:5116
12335 " guestfs_resize2fs_size (guestfs_h *g,\n"
12336 " const char *device,\n"
12337 " int64_t size);\n"
12342 #: ../src/guestfs-actions.pod:5121
12344 "This command is the same as C<guestfs_resize2fs> except that it allows you "
12345 "to specify the new size (in bytes) explicitly."
12349 #: ../src/guestfs-actions.pod:5128
12354 #: ../src/guestfs-actions.pod:5130
12358 " guestfs_rm (guestfs_h *g,\n"
12359 " const char *path);\n"
12364 #: ../src/guestfs-actions.pod:5134 ../fish/guestfish-actions.pod:3407
12365 msgid "Remove the single file C<path>."
12369 #: ../src/guestfs-actions.pod:5140
12370 msgid "guestfs_rm_rf"
12374 #: ../src/guestfs-actions.pod:5142
12378 " guestfs_rm_rf (guestfs_h *g,\n"
12379 " const char *path);\n"
12384 #: ../src/guestfs-actions.pod:5146 ../fish/guestfish-actions.pod:3413
12386 "Remove the file or directory C<path>, recursively removing the contents if "
12387 "its a directory. This is like the C<rm -rf> shell command."
12391 #: ../src/guestfs-actions.pod:5154
12392 msgid "guestfs_rmdir"
12396 #: ../src/guestfs-actions.pod:5156
12400 " guestfs_rmdir (guestfs_h *g,\n"
12401 " const char *path);\n"
12406 #: ../src/guestfs-actions.pod:5160 ../fish/guestfish-actions.pod:3421
12407 msgid "Remove the single directory C<path>."
12411 #: ../src/guestfs-actions.pod:5166
12412 msgid "guestfs_rmmountpoint"
12416 #: ../src/guestfs-actions.pod:5168
12420 " guestfs_rmmountpoint (guestfs_h *g,\n"
12421 " const char *exemptpath);\n"
12426 #: ../src/guestfs-actions.pod:5172
12428 "This calls removes a mountpoint that was previously created with "
12429 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
12433 #: ../src/guestfs-actions.pod:5180
12434 msgid "guestfs_scrub_device"
12438 #: ../src/guestfs-actions.pod:5182
12442 " guestfs_scrub_device (guestfs_h *g,\n"
12443 " const char *device);\n"
12448 #: ../src/guestfs-actions.pod:5186 ../fish/guestfish-actions.pod:3435
12450 "This command writes patterns over C<device> to make data retrieval more "
12455 #: ../src/guestfs-actions.pod:5189 ../src/guestfs-actions.pod:5210 ../src/guestfs-actions.pod:5229 ../fish/guestfish-actions.pod:3438 ../fish/guestfish-actions.pod:3453 ../fish/guestfish-actions.pod:3466
12457 "It is an interface to the L<scrub(1)> program. See that manual page for "
12462 #: ../src/guestfs-actions.pod:5197 ../src/guestfs-actions.pod:5215 ../src/guestfs-actions.pod:5234
12463 msgid "(Added in 1.0.52)"
12467 #: ../src/guestfs-actions.pod:5199
12468 msgid "guestfs_scrub_file"
12472 #: ../src/guestfs-actions.pod:5201
12476 " guestfs_scrub_file (guestfs_h *g,\n"
12477 " const char *file);\n"
12482 #: ../src/guestfs-actions.pod:5205 ../fish/guestfish-actions.pod:3448
12484 "This command writes patterns over a file to make data retrieval more "
12489 #: ../src/guestfs-actions.pod:5208 ../fish/guestfish-actions.pod:3451
12490 msgid "The file is I<removed> after scrubbing."
12494 #: ../src/guestfs-actions.pod:5217
12495 msgid "guestfs_scrub_freespace"
12499 #: ../src/guestfs-actions.pod:5219
12503 " guestfs_scrub_freespace (guestfs_h *g,\n"
12504 " const char *dir);\n"
12509 #: ../src/guestfs-actions.pod:5223
12511 "This command creates the directory C<dir> and then fills it with files until "
12512 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
12513 "and deletes them. The intention is to scrub any free space on the partition "
12514 "containing C<dir>."
12518 #: ../src/guestfs-actions.pod:5236
12519 msgid "guestfs_set_append"
12523 #: ../src/guestfs-actions.pod:5238
12527 " guestfs_set_append (guestfs_h *g,\n"
12528 " const char *append);\n"
12533 #: ../src/guestfs-actions.pod:5242 ../fish/guestfish-actions.pod:3475
12535 "This function is used to add additional options to the guest kernel command "
12540 #: ../src/guestfs-actions.pod:5245 ../fish/guestfish-actions.pod:3478
12542 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
12543 "environment variable."
12547 #: ../src/guestfs-actions.pod:5248 ../fish/guestfish-actions.pod:3481
12549 "Setting C<append> to C<NULL> means I<no> additional options are passed "
12550 "(libguestfs always adds a few of its own)."
12554 #: ../src/guestfs-actions.pod:5255
12555 msgid "guestfs_set_autosync"
12559 #: ../src/guestfs-actions.pod:5257
12563 " guestfs_set_autosync (guestfs_h *g,\n"
12564 " int autosync);\n"
12569 #: ../src/guestfs-actions.pod:5261
12571 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
12572 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
12573 "the handle is closed (also if the program exits without closing handles)."
12577 #: ../src/guestfs-actions.pod:5266 ../fish/guestfish-actions.pod:3495
12579 "This is enabled by default (since libguestfs 1.5.24, previously it was "
12580 "disabled by default)."
12584 #: ../src/guestfs-actions.pod:5273
12585 msgid "guestfs_set_direct"
12589 #: ../src/guestfs-actions.pod:5275
12593 " guestfs_set_direct (guestfs_h *g,\n"
12599 #: ../src/guestfs-actions.pod:5279 ../fish/guestfish-actions.pod:3504
12601 "If the direct appliance mode flag is enabled, then stdin and stdout are "
12602 "passed directly through to the appliance once it is launched."
12606 #: ../src/guestfs-actions.pod:5283
12608 "One consequence of this is that log messages aren't caught by the library "
12609 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
12614 #: ../src/guestfs-actions.pod:5287 ../fish/guestfish-actions.pod:3512
12615 msgid "You probably don't want to use this unless you know what you are doing."
12619 #: ../src/guestfs-actions.pod:5290 ../fish/guestfish-actions.pod:3515
12620 msgid "The default is disabled."
12624 #: ../src/guestfs-actions.pod:5296
12625 msgid "guestfs_set_e2label"
12629 #: ../src/guestfs-actions.pod:5298
12633 " guestfs_set_e2label (guestfs_h *g,\n"
12634 " const char *device,\n"
12635 " const char *label);\n"
12640 #: ../src/guestfs-actions.pod:5303 ../fish/guestfish-actions.pod:3521
12642 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
12643 "C<label>. Filesystem labels are limited to 16 characters."
12647 #: ../src/guestfs-actions.pod:5307
12649 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
12650 "the existing label on a filesystem."
12654 #: ../src/guestfs-actions.pod:5314
12655 msgid "guestfs_set_e2uuid"
12659 #: ../src/guestfs-actions.pod:5316
12663 " guestfs_set_e2uuid (guestfs_h *g,\n"
12664 " const char *device,\n"
12665 " const char *uuid);\n"
12670 #: ../src/guestfs-actions.pod:5321 ../fish/guestfish-actions.pod:3532
12672 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
12673 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
12674 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
12678 #: ../src/guestfs-actions.pod:5326
12680 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
12681 "the existing UUID of a filesystem."
12685 #: ../src/guestfs-actions.pod:5333
12686 msgid "guestfs_set_memsize"
12690 #: ../src/guestfs-actions.pod:5335
12694 " guestfs_set_memsize (guestfs_h *g,\n"
12700 #: ../src/guestfs-actions.pod:5339
12702 "This sets the memory size in megabytes allocated to the qemu subprocess. "
12703 "This only has any effect if called before C<guestfs_launch>."
12707 #: ../src/guestfs-actions.pod:5343 ../fish/guestfish-actions.pod:3550
12709 "You can also change this by setting the environment variable "
12710 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
12714 #: ../src/guestfs-actions.pod:5354
12715 msgid "guestfs_set_network"
12719 #: ../src/guestfs-actions.pod:5356
12723 " guestfs_set_network (guestfs_h *g,\n"
12729 #: ../src/guestfs-actions.pod:5360 ../fish/guestfish-actions.pod:3563
12731 "If C<network> is true, then the network is enabled in the libguestfs "
12732 "appliance. The default is false."
12736 #: ../src/guestfs-actions.pod:5363 ../fish/guestfish-actions.pod:3566
12738 "This affects whether commands are able to access the network (see "
12739 "L<guestfs(3)/RUNNING COMMANDS>)."
12743 #: ../src/guestfs-actions.pod:5366
12745 "You must call this before calling C<guestfs_launch>, otherwise it has no "
12750 #: ../src/guestfs-actions.pod:5373
12751 msgid "guestfs_set_path"
12755 #: ../src/guestfs-actions.pod:5375
12759 " guestfs_set_path (guestfs_h *g,\n"
12760 " const char *searchpath);\n"
12765 #: ../src/guestfs-actions.pod:5379 ../fish/guestfish-actions.pod:3578
12766 msgid "Set the path that libguestfs searches for kernel and initrd.img."
12770 #: ../src/guestfs-actions.pod:5381 ../fish/guestfish-actions.pod:3580
12772 "The default is C<$libdir/guestfs> unless overridden by setting "
12773 "C<LIBGUESTFS_PATH> environment variable."
12777 #: ../src/guestfs-actions.pod:5384 ../fish/guestfish-actions.pod:3583
12778 msgid "Setting C<path> to C<NULL> restores the default path."
12782 #: ../src/guestfs-actions.pod:5390
12783 msgid "guestfs_set_qemu"
12787 #: ../src/guestfs-actions.pod:5392
12791 " guestfs_set_qemu (guestfs_h *g,\n"
12792 " const char *qemu);\n"
12797 #: ../src/guestfs-actions.pod:5396 ../fish/guestfish-actions.pod:3591
12798 msgid "Set the qemu binary that we will use."
12802 #: ../src/guestfs-actions.pod:5398 ../fish/guestfish-actions.pod:3593
12803 msgid "The default is chosen when the library was compiled by the configure script."
12807 #: ../src/guestfs-actions.pod:5401 ../fish/guestfish-actions.pod:3596
12809 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
12814 #: ../src/guestfs-actions.pod:5404 ../fish/guestfish-actions.pod:3599
12815 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
12819 #: ../src/guestfs-actions.pod:5406 ../fish/guestfish-actions.pod:3601
12821 "Note that you should call this function as early as possible after creating "
12822 "the handle. This is because some pre-launch operations depend on testing "
12823 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
12824 "don't retest features, and so you might see inconsistent results. Using the "
12825 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
12826 "the qemu binary at the same time as the handle is created."
12830 #: ../src/guestfs-actions.pod:5418
12831 msgid "guestfs_set_recovery_proc"
12835 #: ../src/guestfs-actions.pod:5420
12839 " guestfs_set_recovery_proc (guestfs_h *g,\n"
12840 " int recoveryproc);\n"
12845 #: ../src/guestfs-actions.pod:5424
12847 "If this is called with the parameter C<false> then C<guestfs_launch> does "
12848 "not create a recovery process. The purpose of the recovery process is to "
12849 "stop runaway qemu processes in the case where the main program aborts "
12854 #: ../src/guestfs-actions.pod:5429
12856 "This only has any effect if called before C<guestfs_launch>, and the default "
12861 #: ../src/guestfs-actions.pod:5432 ../fish/guestfish-actions.pod:3623
12863 "About the only time when you would want to disable this is if the main "
12864 "process will fork itself into the background (\"daemonize\" itself). In "
12865 "this case the recovery process thinks that the main program has disappeared "
12866 "and so kills qemu, which is not very helpful."
12870 #: ../src/guestfs-actions.pod:5442
12871 msgid "guestfs_set_selinux"
12875 #: ../src/guestfs-actions.pod:5444
12879 " guestfs_set_selinux (guestfs_h *g,\n"
12885 #: ../src/guestfs-actions.pod:5448 ../fish/guestfish-actions.pod:3635
12887 "This sets the selinux flag that is passed to the appliance at boot time. "
12888 "The default is C<selinux=0> (disabled)."
12892 #: ../src/guestfs-actions.pod:5451 ../fish/guestfish-actions.pod:3638
12894 "Note that if SELinux is enabled, it is always in Permissive mode "
12895 "(C<enforcing=0>)."
12899 #: ../src/guestfs-actions.pod:5461
12900 msgid "guestfs_set_trace"
12904 #: ../src/guestfs-actions.pod:5463
12908 " guestfs_set_trace (guestfs_h *g,\n"
12914 #: ../src/guestfs-actions.pod:5467 ../fish/guestfish-actions.pod:3650
12916 "If the command trace flag is set to 1, then commands are printed on stderr "
12917 "before they are executed in a format which is very similar to the one used "
12918 "by guestfish. In other words, you can run a program with this enabled, and "
12919 "you will get out a script which you can feed to guestfish to perform the "
12920 "same set of actions."
12924 #: ../src/guestfs-actions.pod:5474 ../fish/guestfish-actions.pod:3657
12926 "If you want to trace C API calls into libguestfs (and other libraries) then "
12927 "possibly a better way is to use the external ltrace(1) command."
12931 #: ../src/guestfs-actions.pod:5478 ../fish/guestfish-actions.pod:3661
12933 "Command traces are disabled unless the environment variable "
12934 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
12938 #: ../src/guestfs-actions.pod:5485
12939 msgid "guestfs_set_verbose"
12943 #: ../src/guestfs-actions.pod:5487
12947 " guestfs_set_verbose (guestfs_h *g,\n"
12953 #: ../src/guestfs-actions.pod:5491 ../fish/guestfish-actions.pod:3670
12954 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
12958 #: ../src/guestfs-actions.pod:5493 ../fish/guestfish-actions.pod:3672
12960 "Verbose messages are disabled unless the environment variable "
12961 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
12965 #: ../src/guestfs-actions.pod:5500
12966 msgid "guestfs_setcon"
12970 #: ../src/guestfs-actions.pod:5502
12974 " guestfs_setcon (guestfs_h *g,\n"
12975 " const char *context);\n"
12980 #: ../src/guestfs-actions.pod:5506 ../fish/guestfish-actions.pod:3679
12982 "This sets the SELinux security context of the daemon to the string "
12987 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3682
12988 msgid "See the documentation about SELINUX in L<guestfs(3)>."
12992 #: ../src/guestfs-actions.pod:5515
12993 msgid "guestfs_setxattr"
12997 #: ../src/guestfs-actions.pod:5517
13001 " guestfs_setxattr (guestfs_h *g,\n"
13002 " const char *xattr,\n"
13003 " const char *val,\n"
13005 " const char *path);\n"
13010 #: ../src/guestfs-actions.pod:5524 ../fish/guestfish-actions.pod:3688
13012 "This call sets the extended attribute named C<xattr> of the file C<path> to "
13013 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
13017 #: ../src/guestfs-actions.pod:5528
13018 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
13022 #: ../src/guestfs-actions.pod:5534
13023 msgid "guestfs_sfdisk"
13027 #: ../src/guestfs-actions.pod:5536
13031 " guestfs_sfdisk (guestfs_h *g,\n"
13032 " const char *device,\n"
13036 " char *const *lines);\n"
13041 #: ../src/guestfs-actions.pod:5544 ../fish/guestfish-actions.pod:3698
13043 "This is a direct interface to the L<sfdisk(8)> program for creating "
13044 "partitions on block devices."
13048 #: ../src/guestfs-actions.pod:5547 ../fish/guestfish-actions.pod:3701
13049 msgid "C<device> should be a block device, for example C</dev/sda>."
13053 #: ../src/guestfs-actions.pod:5549 ../fish/guestfish-actions.pod:3703
13055 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
13056 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
13057 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
13058 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
13059 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
13060 "the kernel) cannot work out the right geometry and you will need to tell it."
13064 #: ../src/guestfs-actions.pod:5557 ../fish/guestfish-actions.pod:3711
13066 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
13067 "refer to the L<sfdisk(8)> manpage."
13071 #: ../src/guestfs-actions.pod:5560 ../fish/guestfish-actions.pod:3714
13073 "To create a single partition occupying the whole disk, you would pass "
13074 "C<lines> as a single element list, when the single element being the string "
13079 #: ../src/guestfs-actions.pod:5564
13080 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
13084 #: ../src/guestfs-actions.pod:5574
13085 msgid "guestfs_sfdiskM"
13089 #: ../src/guestfs-actions.pod:5576
13093 " guestfs_sfdiskM (guestfs_h *g,\n"
13094 " const char *device,\n"
13095 " char *const *lines);\n"
13100 #: ../src/guestfs-actions.pod:5581
13102 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
13103 "partition sizes are specified in megabytes only (rounded to the nearest "
13104 "cylinder) and you don't need to specify the cyls, heads and sectors "
13105 "parameters which were rarely if ever used anyway."
13109 #: ../src/guestfs-actions.pod:5587
13111 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
13112 "C<guestfs_part_disk>"
13116 #: ../src/guestfs-actions.pod:5597
13117 msgid "guestfs_sfdisk_N"
13121 #: ../src/guestfs-actions.pod:5599
13125 " guestfs_sfdisk_N (guestfs_h *g,\n"
13126 " const char *device,\n"
13131 " const char *line);\n"
13136 #: ../src/guestfs-actions.pod:5608 ../fish/guestfish-actions.pod:3744
13138 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13139 "(note: C<n> counts from 1)."
13143 #: ../src/guestfs-actions.pod:5611
13145 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
13146 "for the cyls/heads/sectors parameters."
13150 #: ../src/guestfs-actions.pod:5614
13151 msgid "See also: C<guestfs_part_add>"
13155 #: ../src/guestfs-actions.pod:5623
13156 msgid "guestfs_sfdisk_disk_geometry"
13160 #: ../src/guestfs-actions.pod:5625
13164 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
13165 " const char *device);\n"
13170 #: ../src/guestfs-actions.pod:5629
13172 "This displays the disk geometry of C<device> read from the partition table. "
13173 "Especially in the case where the underlying block device has been resized, "
13174 "this can be different from the kernel's idea of the geometry (see "
13175 "C<guestfs_sfdisk_kernel_geometry>)."
13179 #: ../src/guestfs-actions.pod:5634 ../src/guestfs-actions.pod:5650 ../fish/guestfish-actions.pod:3764 ../fish/guestfish-actions.pod:3773
13180 msgid "The result is in human-readable format, and not designed to be parsed."
13184 #: ../src/guestfs-actions.pod:5642
13185 msgid "guestfs_sfdisk_kernel_geometry"
13189 #: ../src/guestfs-actions.pod:5644
13193 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
13194 " const char *device);\n"
13199 #: ../src/guestfs-actions.pod:5648 ../fish/guestfish-actions.pod:3771
13200 msgid "This displays the kernel's idea of the geometry of C<device>."
13204 #: ../src/guestfs-actions.pod:5658
13205 msgid "guestfs_sfdisk_l"
13209 #: ../src/guestfs-actions.pod:5660
13213 " guestfs_sfdisk_l (guestfs_h *g,\n"
13214 " const char *device);\n"
13219 #: ../src/guestfs-actions.pod:5664 ../fish/guestfish-actions.pod:3780
13221 "This displays the partition table on C<device>, in the human-readable output "
13222 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13226 #: ../src/guestfs-actions.pod:5668
13227 msgid "See also: C<guestfs_part_list>"
13231 #: ../src/guestfs-actions.pod:5675
13236 #: ../src/guestfs-actions.pod:5677
13240 " guestfs_sh (guestfs_h *g,\n"
13241 " const char *command);\n"
13246 #: ../src/guestfs-actions.pod:5681 ../fish/guestfish-actions.pod:3790
13248 "This call runs a command from the guest filesystem via the guest's "
13253 #: ../src/guestfs-actions.pod:5684
13254 msgid "This is like C<guestfs_command>, but passes the command to:"
13258 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3795
13261 " /bin/sh -c \"command\"\n"
13266 #: ../src/guestfs-actions.pod:5688 ../fish/guestfish-actions.pod:3797
13268 "Depending on the guest's shell, this usually results in wildcards being "
13269 "expanded, shell expressions being interpolated and so on."
13273 #: ../src/guestfs-actions.pod:5692
13274 msgid "All the provisos about C<guestfs_command> apply to this call."
13278 #: ../src/guestfs-actions.pod:5699
13279 msgid "guestfs_sh_lines"
13283 #: ../src/guestfs-actions.pod:5701
13287 " guestfs_sh_lines (guestfs_h *g,\n"
13288 " const char *command);\n"
13293 #: ../src/guestfs-actions.pod:5705
13295 "This is the same as C<guestfs_sh>, but splits the result into a list of "
13300 #: ../src/guestfs-actions.pod:5708
13301 msgid "See also: C<guestfs_command_lines>"
13305 #: ../src/guestfs-actions.pod:5716
13306 msgid "guestfs_sleep"
13310 #: ../src/guestfs-actions.pod:5718
13314 " guestfs_sleep (guestfs_h *g,\n"
13320 #: ../src/guestfs-actions.pod:5722 ../fish/guestfish-actions.pod:3816
13321 msgid "Sleep for C<secs> seconds."
13325 #: ../src/guestfs-actions.pod:5726
13326 msgid "(Added in 1.0.41)"
13330 #: ../src/guestfs-actions.pod:5728 ../src/guestfs-structs.pod:109
13331 msgid "guestfs_stat"
13335 #: ../src/guestfs-actions.pod:5730
13338 " struct guestfs_stat *\n"
13339 " guestfs_stat (guestfs_h *g,\n"
13340 " const char *path);\n"
13345 #: ../src/guestfs-actions.pod:5736 ../fish/guestfish-actions.pod:3824
13346 msgid "This is the same as the C<stat(2)> system call."
13350 #: ../src/guestfs-actions.pod:5744 ../src/guestfs-structs.pod:135
13351 msgid "guestfs_statvfs"
13355 #: ../src/guestfs-actions.pod:5746
13358 " struct guestfs_statvfs *\n"
13359 " guestfs_statvfs (guestfs_h *g,\n"
13360 " const char *path);\n"
13365 #: ../src/guestfs-actions.pod:5750 ../fish/guestfish-actions.pod:3830
13367 "Returns file system statistics for any mounted file system. C<path> should "
13368 "be a file or directory in the mounted file system (typically it is the mount "
13369 "point itself, but it doesn't need to be)."
13373 #: ../src/guestfs-actions.pod:5754 ../fish/guestfish-actions.pod:3834
13374 msgid "This is the same as the C<statvfs(2)> system call."
13378 #: ../src/guestfs-actions.pod:5756
13380 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
13381 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
13385 #: ../src/guestfs-actions.pod:5762
13386 msgid "guestfs_strings"
13390 #: ../src/guestfs-actions.pod:5764
13394 " guestfs_strings (guestfs_h *g,\n"
13395 " const char *path);\n"
13400 #: ../src/guestfs-actions.pod:5768 ../fish/guestfish-actions.pod:3840
13402 "This runs the L<strings(1)> command on a file and returns the list of "
13403 "printable strings found."
13407 #: ../src/guestfs-actions.pod:5780
13408 msgid "guestfs_strings_e"
13412 #: ../src/guestfs-actions.pod:5782
13416 " guestfs_strings_e (guestfs_h *g,\n"
13417 " const char *encoding,\n"
13418 " const char *path);\n"
13423 #: ../src/guestfs-actions.pod:5787
13425 "This is like the C<guestfs_strings> command, but allows you to specify the "
13426 "encoding of strings that are looked for in the source file C<path>."
13430 #: ../src/guestfs-actions.pod:5791 ../fish/guestfish-actions.pod:3854
13431 msgid "Allowed encodings are:"
13435 #: ../src/guestfs-actions.pod:5795 ../fish/guestfish-actions.pod:3858
13440 #: ../src/guestfs-actions.pod:5797
13442 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13443 "ISO-8859-X (this is what C<guestfs_strings> uses)."
13447 #: ../src/guestfs-actions.pod:5800 ../fish/guestfish-actions.pod:3863
13452 #: ../src/guestfs-actions.pod:5802 ../fish/guestfish-actions.pod:3865
13453 msgid "Single 8-bit-byte characters."
13457 #: ../src/guestfs-actions.pod:5804 ../fish/guestfish-actions.pod:3867
13462 #: ../src/guestfs-actions.pod:5806 ../fish/guestfish-actions.pod:3869
13463 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13467 #: ../src/guestfs-actions.pod:5809 ../fish/guestfish-actions.pod:3872
13468 msgid "l (lower case letter L)"
13472 #: ../src/guestfs-actions.pod:5811 ../fish/guestfish-actions.pod:3874
13474 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
13475 "examining binaries in Windows guests."
13479 #: ../src/guestfs-actions.pod:5814 ../fish/guestfish-actions.pod:3877
13484 #: ../src/guestfs-actions.pod:5816 ../fish/guestfish-actions.pod:3879
13485 msgid "32-bit big endian such as UCS-4BE."
13489 #: ../src/guestfs-actions.pod:5818 ../fish/guestfish-actions.pod:3881
13494 #: ../src/guestfs-actions.pod:5820 ../fish/guestfish-actions.pod:3883
13495 msgid "32-bit little endian such as UCS-4LE."
13499 #: ../src/guestfs-actions.pod:5824 ../fish/guestfish-actions.pod:3887
13500 msgid "The returned strings are transcoded to UTF-8."
13504 #: ../src/guestfs-actions.pod:5835
13505 msgid "guestfs_swapoff_device"
13509 #: ../src/guestfs-actions.pod:5837
13513 " guestfs_swapoff_device (guestfs_h *g,\n"
13514 " const char *device);\n"
13519 #: ../src/guestfs-actions.pod:5841
13521 "This command disables the libguestfs appliance swap device or partition "
13522 "named C<device>. See C<guestfs_swapon_device>."
13526 #: ../src/guestfs-actions.pod:5849
13527 msgid "guestfs_swapoff_file"
13531 #: ../src/guestfs-actions.pod:5851
13535 " guestfs_swapoff_file (guestfs_h *g,\n"
13536 " const char *file);\n"
13541 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3904
13542 msgid "This command disables the libguestfs appliance swap on file."
13546 #: ../src/guestfs-actions.pod:5861
13547 msgid "guestfs_swapoff_label"
13551 #: ../src/guestfs-actions.pod:5863
13555 " guestfs_swapoff_label (guestfs_h *g,\n"
13556 " const char *label);\n"
13561 #: ../src/guestfs-actions.pod:5867 ../fish/guestfish-actions.pod:3910
13563 "This command disables the libguestfs appliance swap on labeled swap "
13568 #: ../src/guestfs-actions.pod:5874
13569 msgid "guestfs_swapoff_uuid"
13573 #: ../src/guestfs-actions.pod:5876
13577 " guestfs_swapoff_uuid (guestfs_h *g,\n"
13578 " const char *uuid);\n"
13583 #: ../src/guestfs-actions.pod:5880 ../fish/guestfish-actions.pod:3917
13585 "This command disables the libguestfs appliance swap partition with the given "
13590 #: ../src/guestfs-actions.pod:5887
13591 msgid "guestfs_swapon_device"
13595 #: ../src/guestfs-actions.pod:5889
13599 " guestfs_swapon_device (guestfs_h *g,\n"
13600 " const char *device);\n"
13605 #: ../src/guestfs-actions.pod:5893
13607 "This command enables the libguestfs appliance to use the swap device or "
13608 "partition named C<device>. The increased memory is made available for all "
13609 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
13613 #: ../src/guestfs-actions.pod:5898 ../fish/guestfish-actions.pod:3929
13615 "Note that you should not swap to existing guest swap partitions unless you "
13616 "know what you are doing. They may contain hibernation information, or other "
13617 "information that the guest doesn't want you to trash. You also risk leaking "
13618 "information about the host to the guest this way. Instead, attach a new "
13619 "host device to the guest and swap on that."
13623 #: ../src/guestfs-actions.pod:5909
13624 msgid "guestfs_swapon_file"
13628 #: ../src/guestfs-actions.pod:5911
13632 " guestfs_swapon_file (guestfs_h *g,\n"
13633 " const char *file);\n"
13638 #: ../src/guestfs-actions.pod:5915
13640 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
13645 #: ../src/guestfs-actions.pod:5922
13646 msgid "guestfs_swapon_label"
13650 #: ../src/guestfs-actions.pod:5924
13654 " guestfs_swapon_label (guestfs_h *g,\n"
13655 " const char *label);\n"
13660 #: ../src/guestfs-actions.pod:5928
13662 "This command enables swap to a labeled swap partition. See "
13663 "C<guestfs_swapon_device> for other notes."
13667 #: ../src/guestfs-actions.pod:5935
13668 msgid "guestfs_swapon_uuid"
13672 #: ../src/guestfs-actions.pod:5937
13676 " guestfs_swapon_uuid (guestfs_h *g,\n"
13677 " const char *uuid);\n"
13682 #: ../src/guestfs-actions.pod:5941
13684 "This command enables swap to a swap partition with the given UUID. See "
13685 "C<guestfs_swapon_device> for other notes."
13689 #: ../src/guestfs-actions.pod:5948
13690 msgid "guestfs_sync"
13694 #: ../src/guestfs-actions.pod:5950
13698 " guestfs_sync (guestfs_h *g);\n"
13703 #: ../src/guestfs-actions.pod:5953 ../fish/guestfish-actions.pod:3961
13705 "This syncs the disk, so that any writes are flushed through to the "
13706 "underlying disk image."
13710 #: ../src/guestfs-actions.pod:5956 ../fish/guestfish-actions.pod:3964
13712 "You should always call this if you have modified a disk image, before "
13713 "closing the handle."
13717 #: ../src/guestfs-actions.pod:5963
13718 msgid "guestfs_tail"
13722 #: ../src/guestfs-actions.pod:5965
13726 " guestfs_tail (guestfs_h *g,\n"
13727 " const char *path);\n"
13732 #: ../src/guestfs-actions.pod:5969 ../fish/guestfish-actions.pod:3971
13733 msgid "This command returns up to the last 10 lines of a file as a list of strings."
13737 #: ../src/guestfs-actions.pod:5981
13738 msgid "guestfs_tail_n"
13742 #: ../src/guestfs-actions.pod:5983
13746 " guestfs_tail_n (guestfs_h *g,\n"
13748 " const char *path);\n"
13753 #: ../src/guestfs-actions.pod:5988 ../fish/guestfish-actions.pod:3981
13755 "If the parameter C<nrlines> is a positive number, this returns the last "
13756 "C<nrlines> lines of the file C<path>."
13760 #: ../src/guestfs-actions.pod:5991 ../fish/guestfish-actions.pod:3984
13762 "If the parameter C<nrlines> is a negative number, this returns lines from "
13763 "the file C<path>, starting with the C<-nrlines>th line."
13767 #: ../src/guestfs-actions.pod:6005
13768 msgid "guestfs_tar_in"
13772 #: ../src/guestfs-actions.pod:6007
13776 " guestfs_tar_in (guestfs_h *g,\n"
13777 " const char *tarfile,\n"
13778 " const char *directory);\n"
13783 #: ../src/guestfs-actions.pod:6012 ../fish/guestfish-actions.pod:3996
13785 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
13786 "tar file) into C<directory>."
13790 #: ../src/guestfs-actions.pod:6015
13791 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
13795 #: ../src/guestfs-actions.pod:6020 ../src/guestfs-actions.pod:6037 ../src/guestfs-actions.pod:6053 ../src/guestfs-actions.pod:6069
13796 msgid "(Added in 1.0.3)"
13800 #: ../src/guestfs-actions.pod:6022
13801 msgid "guestfs_tar_out"
13805 #: ../src/guestfs-actions.pod:6024
13809 " guestfs_tar_out (guestfs_h *g,\n"
13810 " const char *directory,\n"
13811 " const char *tarfile);\n"
13816 #: ../src/guestfs-actions.pod:6029 ../fish/guestfish-actions.pod:4008
13818 "This command packs the contents of C<directory> and downloads it to local "
13823 #: ../src/guestfs-actions.pod:6032
13825 "To download a compressed tarball, use C<guestfs_tgz_out> or "
13826 "C<guestfs_txz_out>."
13830 #: ../src/guestfs-actions.pod:6039
13831 msgid "guestfs_tgz_in"
13835 #: ../src/guestfs-actions.pod:6041
13839 " guestfs_tgz_in (guestfs_h *g,\n"
13840 " const char *tarball,\n"
13841 " const char *directory);\n"
13846 #: ../src/guestfs-actions.pod:6046 ../fish/guestfish-actions.pod:4020
13848 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
13849 "tar file) into C<directory>."
13853 #: ../src/guestfs-actions.pod:6049
13854 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
13858 #: ../src/guestfs-actions.pod:6055
13859 msgid "guestfs_tgz_out"
13863 #: ../src/guestfs-actions.pod:6057
13867 " guestfs_tgz_out (guestfs_h *g,\n"
13868 " const char *directory,\n"
13869 " const char *tarball);\n"
13874 #: ../src/guestfs-actions.pod:6062 ../fish/guestfish-actions.pod:4031
13876 "This command packs the contents of C<directory> and downloads it to local "
13881 #: ../src/guestfs-actions.pod:6065
13882 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
13886 #: ../src/guestfs-actions.pod:6071
13887 msgid "guestfs_touch"
13891 #: ../src/guestfs-actions.pod:6073
13895 " guestfs_touch (guestfs_h *g,\n"
13896 " const char *path);\n"
13901 #: ../src/guestfs-actions.pod:6077 ../fish/guestfish-actions.pod:4042
13903 "Touch acts like the L<touch(1)> command. It can be used to update the "
13904 "timestamps on a file, or, if the file does not exist, to create a new "
13905 "zero-length file."
13909 #: ../src/guestfs-actions.pod:6081 ../fish/guestfish-actions.pod:4046
13911 "This command only works on regular files, and will fail on other file types "
13912 "such as directories, symbolic links, block special etc."
13916 #: ../src/guestfs-actions.pod:6088
13917 msgid "guestfs_truncate"
13921 #: ../src/guestfs-actions.pod:6090
13925 " guestfs_truncate (guestfs_h *g,\n"
13926 " const char *path);\n"
13931 #: ../src/guestfs-actions.pod:6094 ../fish/guestfish-actions.pod:4053
13933 "This command truncates C<path> to a zero-length file. The file must exist "
13938 #: ../src/guestfs-actions.pod:6101
13939 msgid "guestfs_truncate_size"
13943 #: ../src/guestfs-actions.pod:6103
13947 " guestfs_truncate_size (guestfs_h *g,\n"
13948 " const char *path,\n"
13949 " int64_t size);\n"
13954 #: ../src/guestfs-actions.pod:6108 ../fish/guestfish-actions.pod:4060
13956 "This command truncates C<path> to size C<size> bytes. The file must exist "
13961 #: ../src/guestfs-actions.pod:6111
13963 "If the current file size is less than C<size> then the file is extended to "
13964 "the required size with zero bytes. This creates a sparse file (ie. disk "
13965 "blocks are not allocated for the file until you write to it). To create a "
13966 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
13970 #: ../src/guestfs-actions.pod:6121
13971 msgid "guestfs_tune2fs_l"
13975 #: ../src/guestfs-actions.pod:6123
13979 " guestfs_tune2fs_l (guestfs_h *g,\n"
13980 " const char *device);\n"
13985 #: ../src/guestfs-actions.pod:6127 ../fish/guestfish-actions.pod:4073
13987 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
13992 #: ../src/guestfs-actions.pod:6130 ../fish/guestfish-actions.pod:4076
13994 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
13995 "for more details. The list of fields returned isn't clearly defined, and "
13996 "depends on both the version of C<tune2fs> that libguestfs was built against, "
13997 "and the filesystem itself."
14001 #: ../src/guestfs-actions.pod:6143
14002 msgid "guestfs_txz_in"
14006 #: ../src/guestfs-actions.pod:6145
14010 " guestfs_txz_in (guestfs_h *g,\n"
14011 " const char *tarball,\n"
14012 " const char *directory);\n"
14017 #: ../src/guestfs-actions.pod:6150 ../fish/guestfish-actions.pod:4085
14019 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
14020 "tar file) into C<directory>."
14024 #: ../src/guestfs-actions.pod:6157
14025 msgid "guestfs_txz_out"
14029 #: ../src/guestfs-actions.pod:6159
14033 " guestfs_txz_out (guestfs_h *g,\n"
14034 " const char *directory,\n"
14035 " const char *tarball);\n"
14040 #: ../src/guestfs-actions.pod:6164 ../fish/guestfish-actions.pod:4094
14042 "This command packs the contents of C<directory> and downloads it to local "
14043 "file C<tarball> (as an xz compressed tar archive)."
14047 #: ../src/guestfs-actions.pod:6171
14048 msgid "guestfs_umask"
14052 #: ../src/guestfs-actions.pod:6173
14056 " guestfs_umask (guestfs_h *g,\n"
14062 #: ../src/guestfs-actions.pod:6177 ../fish/guestfish-actions.pod:4103
14064 "This function sets the mask used for creating new files and device nodes to "
14069 #: ../src/guestfs-actions.pod:6180 ../fish/guestfish-actions.pod:4106
14071 "Typical umask values would be C<022> which creates new files with "
14072 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
14073 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
14077 #: ../src/guestfs-actions.pod:6185 ../fish/guestfish-actions.pod:4111
14079 "The default umask is C<022>. This is important because it means that "
14080 "directories and device nodes will be created with C<0644> or C<0755> mode "
14081 "even if you specify C<0777>."
14085 #: ../src/guestfs-actions.pod:6189
14087 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
14088 "C<guestfs_mkdir>."
14092 #: ../src/guestfs-actions.pod:6192 ../fish/guestfish-actions.pod:4118
14093 msgid "This call returns the previous umask."
14097 #: ../src/guestfs-actions.pod:6198
14098 msgid "guestfs_umount"
14102 #: ../src/guestfs-actions.pod:6200
14106 " guestfs_umount (guestfs_h *g,\n"
14107 " const char *pathordevice);\n"
14112 #: ../src/guestfs-actions.pod:6204 ../fish/guestfish-actions.pod:4126
14114 "This unmounts the given filesystem. The filesystem may be specified either "
14115 "by its mountpoint (path) or the device which contains the filesystem."
14119 #: ../src/guestfs-actions.pod:6212
14120 msgid "guestfs_umount_all"
14124 #: ../src/guestfs-actions.pod:6214
14128 " guestfs_umount_all (guestfs_h *g);\n"
14133 #: ../src/guestfs-actions.pod:6217 ../fish/guestfish-actions.pod:4136
14134 msgid "This unmounts all mounted filesystems."
14138 #: ../src/guestfs-actions.pod:6219 ../fish/guestfish-actions.pod:4138
14139 msgid "Some internal mounts are not unmounted by this call."
14143 #: ../src/guestfs-actions.pod:6225
14144 msgid "guestfs_upload"
14148 #: ../src/guestfs-actions.pod:6227
14152 " guestfs_upload (guestfs_h *g,\n"
14153 " const char *filename,\n"
14154 " const char *remotefilename);\n"
14159 #: ../src/guestfs-actions.pod:6232 ../src/guestfs-actions.pod:6251 ../fish/guestfish-actions.pod:4144 ../fish/guestfish-actions.pod:4157
14160 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14164 #: ../src/guestfs-actions.pod:6237
14165 msgid "See also C<guestfs_download>."
14169 #: ../src/guestfs-actions.pod:6243
14170 msgid "guestfs_upload_offset"
14174 #: ../src/guestfs-actions.pod:6245
14178 " guestfs_upload_offset (guestfs_h *g,\n"
14179 " const char *filename,\n"
14180 " const char *remotefilename,\n"
14181 " int64_t offset);\n"
14186 #: ../src/guestfs-actions.pod:6254 ../fish/guestfish-actions.pod:4160
14188 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14189 "The intention is to overwrite parts of existing files or devices, although "
14190 "if a non-existant file is specified then it is created with a \"hole\" "
14191 "before C<offset>. The size of the data written is implicit in the size of "
14192 "the source C<filename>."
14196 #: ../src/guestfs-actions.pod:6261
14198 "Note that there is no limit on the amount of data that can be uploaded with "
14199 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
14200 "full amount unless an error occurs."
14204 #: ../src/guestfs-actions.pod:6266
14205 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
14209 #: ../src/guestfs-actions.pod:6272
14210 msgid "guestfs_utimens"
14214 #: ../src/guestfs-actions.pod:6274
14218 " guestfs_utimens (guestfs_h *g,\n"
14219 " const char *path,\n"
14220 " int64_t atsecs,\n"
14221 " int64_t atnsecs,\n"
14222 " int64_t mtsecs,\n"
14223 " int64_t mtnsecs);\n"
14228 #: ../src/guestfs-actions.pod:6282 ../fish/guestfish-actions.pod:4180
14229 msgid "This command sets the timestamps of a file with nanosecond precision."
14233 #: ../src/guestfs-actions.pod:6285 ../fish/guestfish-actions.pod:4183
14235 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14240 #: ../src/guestfs-actions.pod:6288 ../fish/guestfish-actions.pod:4186
14242 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14243 "nanoseconds from the epoch."
14247 #: ../src/guestfs-actions.pod:6291 ../fish/guestfish-actions.pod:4189
14249 "If the C<*nsecs> field contains the special value C<-1> then the "
14250 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14251 "ignored in this case)."
14255 #: ../src/guestfs-actions.pod:6295 ../fish/guestfish-actions.pod:4193
14257 "If the C<*nsecs> field contains the special value C<-2> then the "
14258 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14263 #: ../src/guestfs-actions.pod:6303 ../src/guestfs-structs.pod:175
14264 msgid "guestfs_version"
14268 #: ../src/guestfs-actions.pod:6305
14271 " struct guestfs_version *\n"
14272 " guestfs_version (guestfs_h *g);\n"
14277 #: ../src/guestfs-actions.pod:6308 ../fish/guestfish-actions.pod:4201
14278 msgid "Return the libguestfs version number that the program is linked against."
14282 #: ../src/guestfs-actions.pod:6311 ../fish/guestfish-actions.pod:4204
14284 "Note that because of dynamic linking this is not necessarily the version of "
14285 "libguestfs that you compiled against. You can compile the program, and then "
14286 "at runtime dynamically link against a completely different C<libguestfs.so> "
14291 #: ../src/guestfs-actions.pod:6316 ../fish/guestfish-actions.pod:4209
14293 "This call was added in version C<1.0.58>. In previous versions of "
14294 "libguestfs there was no way to get the version number. From C code you can "
14295 "use dynamic linker functions to find out if this symbol exists (if it "
14296 "doesn't, then it's an earlier version)."
14300 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4215
14302 "The call returns a structure with four elements. The first three (C<major>, "
14303 "C<minor> and C<release>) are numbers and correspond to the usual version "
14304 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14305 "but may be used for distro-specific information."
14309 #: ../src/guestfs-actions.pod:6328 ../fish/guestfish-actions.pod:4221
14310 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
14314 #: ../src/guestfs-actions.pod:6331 ../fish/guestfish-actions.pod:4224
14315 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14319 #: ../src/guestfs-actions.pod:6333
14321 "I<Note:> Don't use this call to test for availability of features. In "
14322 "enterprise distributions we backport features from later versions into "
14323 "earlier versions, making this an unreliable way to test for features. Use "
14324 "C<guestfs_available> instead."
14328 #: ../src/guestfs-actions.pod:6339
14330 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
14331 "error. I<The caller must call C<guestfs_free_version> after use>."
14335 #: ../src/guestfs-actions.pod:6343
14336 msgid "(Added in 1.0.58)"
14340 #: ../src/guestfs-actions.pod:6345
14341 msgid "guestfs_vfs_label"
14345 #: ../src/guestfs-actions.pod:6347
14349 " guestfs_vfs_label (guestfs_h *g,\n"
14350 " const char *device);\n"
14355 #: ../src/guestfs-actions.pod:6351 ../fish/guestfish-actions.pod:4236
14356 msgid "This returns the filesystem label of the filesystem on C<device>."
14360 #: ../src/guestfs-actions.pod:6354 ../fish/guestfish-actions.pod:4239
14361 msgid "If the filesystem is unlabeled, this returns the empty string."
14365 #: ../src/guestfs-actions.pod:6356
14366 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
14370 #: ../src/guestfs-actions.pod:6361 ../src/guestfs-actions.pod:6398
14371 msgid "(Added in 1.3.18)"
14375 #: ../src/guestfs-actions.pod:6363
14376 msgid "guestfs_vfs_type"
14380 #: ../src/guestfs-actions.pod:6365
14384 " guestfs_vfs_type (guestfs_h *g,\n"
14385 " const char *device);\n"
14390 #: ../src/guestfs-actions.pod:6369 ../fish/guestfish-actions.pod:4247
14392 "This command gets the filesystem type corresponding to the filesystem on "
14397 #: ../src/guestfs-actions.pod:6372 ../fish/guestfish-actions.pod:4250
14399 "For most filesystems, the result is the name of the Linux VFS module which "
14400 "would be used to mount this filesystem if you mounted it without specifying "
14401 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14405 #: ../src/guestfs-actions.pod:6382
14406 msgid "guestfs_vfs_uuid"
14410 #: ../src/guestfs-actions.pod:6384
14414 " guestfs_vfs_uuid (guestfs_h *g,\n"
14415 " const char *device);\n"
14420 #: ../src/guestfs-actions.pod:6388 ../fish/guestfish-actions.pod:4259
14421 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14425 #: ../src/guestfs-actions.pod:6391 ../fish/guestfish-actions.pod:4262
14426 msgid "If the filesystem does not have a UUID, this returns the empty string."
14430 #: ../src/guestfs-actions.pod:6393
14431 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
14435 #: ../src/guestfs-actions.pod:6400
14436 msgid "guestfs_vg_activate"
14440 #: ../src/guestfs-actions.pod:6402
14444 " guestfs_vg_activate (guestfs_h *g,\n"
14446 " char *const *volgroups);\n"
14451 #: ../src/guestfs-actions.pod:6407 ../fish/guestfish-actions.pod:4270
14453 "This command activates or (if C<activate> is false) deactivates all logical "
14454 "volumes in the listed volume groups C<volgroups>. If activated, then they "
14455 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
14456 "deactivated, then those devices disappear."
14460 #: ../src/guestfs-actions.pod:6413 ../fish/guestfish-actions.pod:4276
14461 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14465 #: ../src/guestfs-actions.pod:6415 ../fish/guestfish-actions.pod:4278
14467 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14468 "activated or deactivated."
14472 #: ../src/guestfs-actions.pod:6422
14473 msgid "guestfs_vg_activate_all"
14477 #: ../src/guestfs-actions.pod:6424
14481 " guestfs_vg_activate_all (guestfs_h *g,\n"
14482 " int activate);\n"
14487 #: ../src/guestfs-actions.pod:6428 ../fish/guestfish-actions.pod:4285
14489 "This command activates or (if C<activate> is false) deactivates all logical "
14490 "volumes in all volume groups. If activated, then they are made known to the "
14491 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
14492 "those devices disappear."
14496 #: ../src/guestfs-actions.pod:6434 ../fish/guestfish-actions.pod:4291
14497 msgid "This command is the same as running C<vgchange -a y|n>"
14501 #: ../src/guestfs-actions.pod:6440
14502 msgid "guestfs_vgcreate"
14506 #: ../src/guestfs-actions.pod:6442
14510 " guestfs_vgcreate (guestfs_h *g,\n"
14511 " const char *volgroup,\n"
14512 " char *const *physvols);\n"
14517 #: ../src/guestfs-actions.pod:6447 ../fish/guestfish-actions.pod:4297
14519 "This creates an LVM volume group called C<volgroup> from the non-empty list "
14520 "of physical volumes C<physvols>."
14524 #: ../src/guestfs-actions.pod:6454
14525 msgid "guestfs_vglvuuids"
14529 #: ../src/guestfs-actions.pod:6456
14533 " guestfs_vglvuuids (guestfs_h *g,\n"
14534 " const char *vgname);\n"
14539 #: ../src/guestfs-actions.pod:6460 ../fish/guestfish-actions.pod:4304
14541 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
14542 "volumes created in this volume group."
14546 #: ../src/guestfs-actions.pod:6463
14548 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
14549 "associate logical volumes and volume groups."
14553 #: ../src/guestfs-actions.pod:6466
14554 msgid "See also C<guestfs_vgpvuuids>."
14558 #: ../src/guestfs-actions.pod:6474
14559 msgid "guestfs_vgpvuuids"
14563 #: ../src/guestfs-actions.pod:6476
14567 " guestfs_vgpvuuids (guestfs_h *g,\n"
14568 " const char *vgname);\n"
14573 #: ../src/guestfs-actions.pod:6480 ../fish/guestfish-actions.pod:4316
14575 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
14576 "volumes that this volume group resides on."
14580 #: ../src/guestfs-actions.pod:6483
14582 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
14583 "associate physical volumes and volume groups."
14587 #: ../src/guestfs-actions.pod:6486
14588 msgid "See also C<guestfs_vglvuuids>."
14592 #: ../src/guestfs-actions.pod:6494
14593 msgid "guestfs_vgremove"
14597 #: ../src/guestfs-actions.pod:6496
14601 " guestfs_vgremove (guestfs_h *g,\n"
14602 " const char *vgname);\n"
14607 #: ../src/guestfs-actions.pod:6500 ../fish/guestfish-actions.pod:4328
14608 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
14612 #: ../src/guestfs-actions.pod:6502 ../fish/guestfish-actions.pod:4330
14613 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
14617 #: ../src/guestfs-actions.pod:6509
14618 msgid "guestfs_vgrename"
14622 #: ../src/guestfs-actions.pod:6511
14626 " guestfs_vgrename (guestfs_h *g,\n"
14627 " const char *volgroup,\n"
14628 " const char *newvolgroup);\n"
14633 #: ../src/guestfs-actions.pod:6516 ../fish/guestfish-actions.pod:4337
14634 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
14638 #: ../src/guestfs-actions.pod:6522
14639 msgid "guestfs_vgs"
14643 #: ../src/guestfs-actions.pod:6524
14647 " guestfs_vgs (guestfs_h *g);\n"
14652 #: ../src/guestfs-actions.pod:6527 ../fish/guestfish-actions.pod:4343
14654 "List all the volumes groups detected. This is the equivalent of the "
14655 "L<vgs(8)> command."
14659 #: ../src/guestfs-actions.pod:6530 ../fish/guestfish-actions.pod:4346
14661 "This returns a list of just the volume group names that were detected "
14662 "(eg. C<VolGroup00>)."
14666 #: ../src/guestfs-actions.pod:6533
14667 msgid "See also C<guestfs_vgs_full>."
14671 #: ../src/guestfs-actions.pod:6541
14672 msgid "guestfs_vgs_full"
14676 #: ../src/guestfs-actions.pod:6543
14679 " struct guestfs_lvm_vg_list *\n"
14680 " guestfs_vgs_full (guestfs_h *g);\n"
14685 #: ../src/guestfs-actions.pod:6546 ../fish/guestfish-actions.pod:4355
14687 "List all the volumes groups detected. This is the equivalent of the "
14688 "L<vgs(8)> command. The \"full\" version includes all fields."
14692 #: ../src/guestfs-actions.pod:6549
14694 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
14695 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
14700 #: ../src/guestfs-actions.pod:6555
14701 msgid "guestfs_vgscan"
14705 #: ../src/guestfs-actions.pod:6557
14709 " guestfs_vgscan (guestfs_h *g);\n"
14714 #: ../src/guestfs-actions.pod:6560 ../fish/guestfish-actions.pod:4362
14716 "This rescans all block devices and rebuilds the list of LVM physical "
14717 "volumes, volume groups and logical volumes."
14721 #: ../src/guestfs-actions.pod:6567
14722 msgid "guestfs_vguuid"
14726 #: ../src/guestfs-actions.pod:6569
14730 " guestfs_vguuid (guestfs_h *g,\n"
14731 " const char *vgname);\n"
14736 #: ../src/guestfs-actions.pod:6573 ../fish/guestfish-actions.pod:4369
14737 msgid "This command returns the UUID of the LVM VG named C<vgname>."
14741 #: ../src/guestfs-actions.pod:6580
14742 msgid "guestfs_wait_ready"
14746 #: ../src/guestfs-actions.pod:6582
14750 " guestfs_wait_ready (guestfs_h *g);\n"
14755 #: ../src/guestfs-actions.pod:6585
14756 msgid "This function is a no op."
14760 #: ../src/guestfs-actions.pod:6587
14762 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
14763 "calling C<guestfs_launch> to wait for the launch to complete. However this "
14764 "is no longer necessary because C<guestfs_launch> now does the waiting."
14768 #: ../src/guestfs-actions.pod:6592
14770 "If you see any calls to this function in code then you can just remove them, "
14771 "unless you want to retain compatibility with older versions of the API."
14775 #: ../src/guestfs-actions.pod:6600
14776 msgid "guestfs_wc_c"
14780 #: ../src/guestfs-actions.pod:6602
14784 " guestfs_wc_c (guestfs_h *g,\n"
14785 " const char *path);\n"
14790 #: ../src/guestfs-actions.pod:6606 ../fish/guestfish-actions.pod:4375
14792 "This command counts the characters in a file, using the C<wc -c> external "
14797 #: ../src/guestfs-actions.pod:6613
14798 msgid "guestfs_wc_l"
14802 #: ../src/guestfs-actions.pod:6615
14806 " guestfs_wc_l (guestfs_h *g,\n"
14807 " const char *path);\n"
14812 #: ../src/guestfs-actions.pod:6619 ../fish/guestfish-actions.pod:4382
14814 "This command counts the lines in a file, using the C<wc -l> external "
14819 #: ../src/guestfs-actions.pod:6626
14820 msgid "guestfs_wc_w"
14824 #: ../src/guestfs-actions.pod:6628
14828 " guestfs_wc_w (guestfs_h *g,\n"
14829 " const char *path);\n"
14834 #: ../src/guestfs-actions.pod:6632 ../fish/guestfish-actions.pod:4389
14836 "This command counts the words in a file, using the C<wc -w> external "
14841 #: ../src/guestfs-actions.pod:6639
14842 msgid "guestfs_write"
14846 #: ../src/guestfs-actions.pod:6641
14850 " guestfs_write (guestfs_h *g,\n"
14851 " const char *path,\n"
14852 " const char *content,\n"
14853 " size_t content_size);\n"
14858 #: ../src/guestfs-actions.pod:6647 ../fish/guestfish-actions.pod:4396
14860 "This call creates a file called C<path>. The content of the file is the "
14861 "string C<content> (which can contain any 8 bit data)."
14865 #: ../src/guestfs-actions.pod:6657
14866 msgid "guestfs_write_file"
14870 #: ../src/guestfs-actions.pod:6659
14874 " guestfs_write_file (guestfs_h *g,\n"
14875 " const char *path,\n"
14876 " const char *content,\n"
14882 #: ../src/guestfs-actions.pod:6665 ../fish/guestfish-actions.pod:4406
14884 "This call creates a file called C<path>. The contents of the file is the "
14885 "string C<content> (which can contain any 8 bit data), with length C<size>."
14889 #: ../src/guestfs-actions.pod:6669 ../fish/guestfish-actions.pod:4410
14891 "As a special case, if C<size> is C<0> then the length is calculated using "
14892 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
14896 #: ../src/guestfs-actions.pod:6673 ../fish/guestfish-actions.pod:4414
14898 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
14899 "I<not> work, even if the length is specified."
14903 #: ../src/guestfs-actions.pod:6681 ../fish/guestfish-actions.pod:4420
14904 msgid "This function is deprecated. In new code, use the C<write> call instead."
14908 #: ../src/guestfs-actions.pod:6690
14909 msgid "guestfs_zegrep"
14913 #: ../src/guestfs-actions.pod:6692
14917 " guestfs_zegrep (guestfs_h *g,\n"
14918 " const char *regex,\n"
14919 " const char *path);\n"
14924 #: ../src/guestfs-actions.pod:6697 ../fish/guestfish-actions.pod:4431
14925 msgid "This calls the external C<zegrep> program and returns the matching lines."
14929 #: ../src/guestfs-actions.pod:6709
14930 msgid "guestfs_zegrepi"
14934 #: ../src/guestfs-actions.pod:6711
14938 " guestfs_zegrepi (guestfs_h *g,\n"
14939 " const char *regex,\n"
14940 " const char *path);\n"
14945 #: ../src/guestfs-actions.pod:6716 ../fish/guestfish-actions.pod:4441
14946 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
14950 #: ../src/guestfs-actions.pod:6728
14951 msgid "guestfs_zero"
14955 #: ../src/guestfs-actions.pod:6730
14959 " guestfs_zero (guestfs_h *g,\n"
14960 " const char *device);\n"
14965 #: ../src/guestfs-actions.pod:6734 ../fish/guestfish-actions.pod:4451
14966 msgid "This command writes zeroes over the first few blocks of C<device>."
14970 #: ../src/guestfs-actions.pod:6736 ../fish/guestfish-actions.pod:4453
14972 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
14973 "securely wipe the device). It should be sufficient to remove any partition "
14974 "tables, filesystem superblocks and so on."
14978 #: ../src/guestfs-actions.pod:6740
14979 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
14983 #: ../src/guestfs-actions.pod:6751
14984 msgid "guestfs_zero_device"
14988 #: ../src/guestfs-actions.pod:6753
14992 " guestfs_zero_device (guestfs_h *g,\n"
14993 " const char *device);\n"
14998 #: ../src/guestfs-actions.pod:6757
15000 "This command writes zeroes over the entire C<device>. Compare with "
15001 "C<guestfs_zero> which just zeroes the first few blocks of a device."
15005 #: ../src/guestfs-actions.pod:6771
15006 msgid "(Added in 1.3.1)"
15010 #: ../src/guestfs-actions.pod:6773
15011 msgid "guestfs_zerofree"
15015 #: ../src/guestfs-actions.pod:6775
15019 " guestfs_zerofree (guestfs_h *g,\n"
15020 " const char *device);\n"
15025 #: ../src/guestfs-actions.pod:6779 ../fish/guestfish-actions.pod:4474
15027 "This runs the I<zerofree> program on C<device>. This program claims to zero "
15028 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
15029 "possible to compress the filesystem more effectively."
15033 #: ../src/guestfs-actions.pod:6784 ../fish/guestfish-actions.pod:4479
15034 msgid "You should B<not> run this program if the filesystem is mounted."
15038 #: ../src/guestfs-actions.pod:6787 ../fish/guestfish-actions.pod:4482
15040 "It is possible that using this program can damage the filesystem or data on "
15045 #: ../src/guestfs-actions.pod:6794
15046 msgid "guestfs_zfgrep"
15050 #: ../src/guestfs-actions.pod:6796
15054 " guestfs_zfgrep (guestfs_h *g,\n"
15055 " const char *pattern,\n"
15056 " const char *path);\n"
15061 #: ../src/guestfs-actions.pod:6801 ../fish/guestfish-actions.pod:4489
15062 msgid "This calls the external C<zfgrep> program and returns the matching lines."
15066 #: ../src/guestfs-actions.pod:6813
15067 msgid "guestfs_zfgrepi"
15071 #: ../src/guestfs-actions.pod:6815
15075 " guestfs_zfgrepi (guestfs_h *g,\n"
15076 " const char *pattern,\n"
15077 " const char *path);\n"
15082 #: ../src/guestfs-actions.pod:6820 ../fish/guestfish-actions.pod:4499
15083 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
15087 #: ../src/guestfs-actions.pod:6832
15088 msgid "guestfs_zfile"
15092 #: ../src/guestfs-actions.pod:6834
15096 " guestfs_zfile (guestfs_h *g,\n"
15097 " const char *meth,\n"
15098 " const char *path);\n"
15103 #: ../src/guestfs-actions.pod:6839 ../fish/guestfish-actions.pod:4509
15104 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
15108 #: ../src/guestfs-actions.pod:6842 ../fish/guestfish-actions.pod:4512
15109 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
15113 #: ../src/guestfs-actions.pod:6844
15115 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
15120 #: ../src/guestfs-actions.pod:6850 ../fish/guestfish-actions.pod:4517
15121 msgid "This function is deprecated. In new code, use the C<file> call instead."
15125 #: ../src/guestfs-actions.pod:6859
15126 msgid "guestfs_zgrep"
15130 #: ../src/guestfs-actions.pod:6861
15134 " guestfs_zgrep (guestfs_h *g,\n"
15135 " const char *regex,\n"
15136 " const char *path);\n"
15141 #: ../src/guestfs-actions.pod:6866 ../fish/guestfish-actions.pod:4528
15142 msgid "This calls the external C<zgrep> program and returns the matching lines."
15146 #: ../src/guestfs-actions.pod:6878
15147 msgid "guestfs_zgrepi"
15151 #: ../src/guestfs-actions.pod:6880
15155 " guestfs_zgrepi (guestfs_h *g,\n"
15156 " const char *regex,\n"
15157 " const char *path);\n"
15162 #: ../src/guestfs-actions.pod:6885 ../fish/guestfish-actions.pod:4538
15163 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
15167 #: ../src/guestfs-availability.pod:3
15172 #: ../src/guestfs-availability.pod:5
15174 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
15175 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
15176 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
15177 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
15178 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
15182 #: ../src/guestfs-availability.pod:21
15187 #: ../src/guestfs-availability.pod:23
15189 "The following functions: L</guestfs_inotify_add_watch> "
15190 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
15191 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
15195 #: ../src/guestfs-availability.pod:31
15196 msgid "B<linuxfsuuid>"
15200 #: ../src/guestfs-availability.pod:33
15202 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
15203 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
15207 #: ../src/guestfs-availability.pod:40
15208 msgid "B<linuxmodules>"
15212 #: ../src/guestfs-availability.pod:42
15213 msgid "The following functions: L</guestfs_modprobe>"
15217 #: ../src/guestfs-availability.pod:45
15218 msgid "B<linuxxattrs>"
15222 #: ../src/guestfs-availability.pod:47
15224 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> "
15225 "L</guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> "
15226 "L</guestfs_removexattr> L</guestfs_setxattr>"
15230 #: ../src/guestfs-availability.pod:56
15235 #: ../src/guestfs-availability.pod:58
15237 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
15238 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
15239 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
15243 #: ../src/guestfs-availability.pod:67
15248 #: ../src/guestfs-availability.pod:69
15250 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
15251 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
15252 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
15253 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
15254 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
15255 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
15256 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
15257 "L</guestfs_vgs_full>"
15261 #: ../src/guestfs-availability.pod:92
15266 #: ../src/guestfs-availability.pod:94
15268 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
15269 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
15273 #: ../src/guestfs-availability.pod:100
15278 #: ../src/guestfs-availability.pod:102
15279 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
15283 #: ../src/guestfs-availability.pod:105
15284 msgid "B<ntfsprogs>"
15288 #: ../src/guestfs-availability.pod:107
15289 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
15293 #: ../src/guestfs-availability.pod:111
15294 msgid "B<realpath>"
15298 #: ../src/guestfs-availability.pod:113
15299 msgid "The following functions: L</guestfs_realpath>"
15303 #: ../src/guestfs-availability.pod:116
15308 #: ../src/guestfs-availability.pod:118
15310 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
15311 "L</guestfs_scrub_freespace>"
15315 #: ../src/guestfs-availability.pod:123
15320 #: ../src/guestfs-availability.pod:125
15321 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
15325 #: ../src/guestfs-availability.pod:129
15330 #: ../src/guestfs-availability.pod:131
15331 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
15335 #: ../src/guestfs-availability.pod:135
15336 msgid "B<zerofree>"
15340 #: ../src/guestfs-availability.pod:137
15341 msgid "The following functions: L</guestfs_zerofree>"
15345 #: ../src/guestfs-structs.pod:1
15346 msgid "guestfs_int_bool"
15350 #: ../src/guestfs-structs.pod:3
15353 " struct guestfs_int_bool {\n"
15361 #: ../src/guestfs-structs.pod:8
15364 " struct guestfs_int_bool_list {\n"
15365 " uint32_t len; /* Number of elements in list. */\n"
15366 " struct guestfs_int_bool *val; /* Elements. */\n"
15372 #: ../src/guestfs-structs.pod:13
15375 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
15376 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
15381 #: ../src/guestfs-structs.pod:16
15382 msgid "guestfs_lvm_pv"
15386 #: ../src/guestfs-structs.pod:18
15389 " struct guestfs_lvm_pv {\n"
15390 " char *pv_name;\n"
15391 " /* The next field is NOT nul-terminated, be careful when printing it: "
15393 " char pv_uuid[32];\n"
15395 " uint64_t pv_size;\n"
15396 " uint64_t dev_size;\n"
15397 " uint64_t pv_free;\n"
15398 " uint64_t pv_used;\n"
15399 " char *pv_attr;\n"
15400 " int64_t pv_pe_count;\n"
15401 " int64_t pv_pe_alloc_count;\n"
15402 " char *pv_tags;\n"
15403 " uint64_t pe_start;\n"
15404 " int64_t pv_mda_count;\n"
15405 " uint64_t pv_mda_free;\n"
15411 #: ../src/guestfs-structs.pod:36
15414 " struct guestfs_lvm_pv_list {\n"
15415 " uint32_t len; /* Number of elements in list. */\n"
15416 " struct guestfs_lvm_pv *val; /* Elements. */\n"
15422 #: ../src/guestfs-structs.pod:41
15425 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
15426 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
15431 #: ../src/guestfs-structs.pod:44
15432 msgid "guestfs_lvm_vg"
15436 #: ../src/guestfs-structs.pod:46
15439 " struct guestfs_lvm_vg {\n"
15440 " char *vg_name;\n"
15441 " /* The next field is NOT nul-terminated, be careful when printing it: "
15443 " char vg_uuid[32];\n"
15445 " char *vg_attr;\n"
15446 " uint64_t vg_size;\n"
15447 " uint64_t vg_free;\n"
15448 " char *vg_sysid;\n"
15449 " uint64_t vg_extent_size;\n"
15450 " int64_t vg_extent_count;\n"
15451 " int64_t vg_free_count;\n"
15452 " int64_t max_lv;\n"
15453 " int64_t max_pv;\n"
15454 " int64_t pv_count;\n"
15455 " int64_t lv_count;\n"
15456 " int64_t snap_count;\n"
15457 " int64_t vg_seqno;\n"
15458 " char *vg_tags;\n"
15459 " int64_t vg_mda_count;\n"
15460 " uint64_t vg_mda_free;\n"
15466 #: ../src/guestfs-structs.pod:69
15469 " struct guestfs_lvm_vg_list {\n"
15470 " uint32_t len; /* Number of elements in list. */\n"
15471 " struct guestfs_lvm_vg *val; /* Elements. */\n"
15477 #: ../src/guestfs-structs.pod:74
15480 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
15481 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
15486 #: ../src/guestfs-structs.pod:77
15487 msgid "guestfs_lvm_lv"
15491 #: ../src/guestfs-structs.pod:79
15494 " struct guestfs_lvm_lv {\n"
15495 " char *lv_name;\n"
15496 " /* The next field is NOT nul-terminated, be careful when printing it: "
15498 " char lv_uuid[32];\n"
15499 " char *lv_attr;\n"
15500 " int64_t lv_major;\n"
15501 " int64_t lv_minor;\n"
15502 " int64_t lv_kernel_major;\n"
15503 " int64_t lv_kernel_minor;\n"
15504 " uint64_t lv_size;\n"
15505 " int64_t seg_count;\n"
15507 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
15508 " float snap_percent;\n"
15509 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
15510 " float copy_percent;\n"
15511 " char *move_pv;\n"
15512 " char *lv_tags;\n"
15513 " char *mirror_log;\n"
15514 " char *modules;\n"
15520 #: ../src/guestfs-structs.pod:101
15523 " struct guestfs_lvm_lv_list {\n"
15524 " uint32_t len; /* Number of elements in list. */\n"
15525 " struct guestfs_lvm_lv *val; /* Elements. */\n"
15531 #: ../src/guestfs-structs.pod:106
15534 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
15535 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
15540 #: ../src/guestfs-structs.pod:111
15543 " struct guestfs_stat {\n"
15547 " int64_t nlink;\n"
15552 " int64_t blksize;\n"
15553 " int64_t blocks;\n"
15554 " int64_t atime;\n"
15555 " int64_t mtime;\n"
15556 " int64_t ctime;\n"
15562 #: ../src/guestfs-structs.pod:127
15565 " struct guestfs_stat_list {\n"
15566 " uint32_t len; /* Number of elements in list. */\n"
15567 " struct guestfs_stat *val; /* Elements. */\n"
15573 #: ../src/guestfs-structs.pod:132
15576 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
15577 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
15582 #: ../src/guestfs-structs.pod:137
15585 " struct guestfs_statvfs {\n"
15586 " int64_t bsize;\n"
15587 " int64_t frsize;\n"
15588 " int64_t blocks;\n"
15589 " int64_t bfree;\n"
15590 " int64_t bavail;\n"
15591 " int64_t files;\n"
15592 " int64_t ffree;\n"
15593 " int64_t favail;\n"
15596 " int64_t namemax;\n"
15602 #: ../src/guestfs-structs.pod:151
15605 " struct guestfs_statvfs_list {\n"
15606 " uint32_t len; /* Number of elements in list. */\n"
15607 " struct guestfs_statvfs *val; /* Elements. */\n"
15613 #: ../src/guestfs-structs.pod:156
15616 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
15617 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
15622 #: ../src/guestfs-structs.pod:159
15623 msgid "guestfs_dirent"
15627 #: ../src/guestfs-structs.pod:161
15630 " struct guestfs_dirent {\n"
15639 #: ../src/guestfs-structs.pod:167
15642 " struct guestfs_dirent_list {\n"
15643 " uint32_t len; /* Number of elements in list. */\n"
15644 " struct guestfs_dirent *val; /* Elements. */\n"
15650 #: ../src/guestfs-structs.pod:172
15653 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
15654 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
15659 #: ../src/guestfs-structs.pod:177
15662 " struct guestfs_version {\n"
15663 " int64_t major;\n"
15664 " int64_t minor;\n"
15665 " int64_t release;\n"
15672 #: ../src/guestfs-structs.pod:184
15675 " struct guestfs_version_list {\n"
15676 " uint32_t len; /* Number of elements in list. */\n"
15677 " struct guestfs_version *val; /* Elements. */\n"
15683 #: ../src/guestfs-structs.pod:189
15686 " void guestfs_free_version (struct guestfs_free_version *);\n"
15687 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
15692 #: ../src/guestfs-structs.pod:192
15693 msgid "guestfs_xattr"
15697 #: ../src/guestfs-structs.pod:194
15700 " struct guestfs_xattr {\n"
15701 " char *attrname;\n"
15702 " /* The next two fields describe a byte array. */\n"
15703 " uint32_t attrval_len;\n"
15704 " char *attrval;\n"
15710 #: ../src/guestfs-structs.pod:201
15713 " struct guestfs_xattr_list {\n"
15714 " uint32_t len; /* Number of elements in list. */\n"
15715 " struct guestfs_xattr *val; /* Elements. */\n"
15721 #: ../src/guestfs-structs.pod:206
15724 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
15725 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
15730 #: ../src/guestfs-structs.pod:209
15731 msgid "guestfs_inotify_event"
15735 #: ../src/guestfs-structs.pod:211
15738 " struct guestfs_inotify_event {\n"
15739 " int64_t in_wd;\n"
15740 " uint32_t in_mask;\n"
15741 " uint32_t in_cookie;\n"
15742 " char *in_name;\n"
15748 #: ../src/guestfs-structs.pod:218
15751 " struct guestfs_inotify_event_list {\n"
15752 " uint32_t len; /* Number of elements in list. */\n"
15753 " struct guestfs_inotify_event *val; /* Elements. */\n"
15759 #: ../src/guestfs-structs.pod:223
15762 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
15763 " void guestfs_free_inotify_event_list (struct "
15764 "guestfs_free_inotify_event_list *);\n"
15769 #: ../src/guestfs-structs.pod:226
15770 msgid "guestfs_partition"
15774 #: ../src/guestfs-structs.pod:228
15777 " struct guestfs_partition {\n"
15778 " int32_t part_num;\n"
15779 " uint64_t part_start;\n"
15780 " uint64_t part_end;\n"
15781 " uint64_t part_size;\n"
15787 #: ../src/guestfs-structs.pod:235
15790 " struct guestfs_partition_list {\n"
15791 " uint32_t len; /* Number of elements in list. */\n"
15792 " struct guestfs_partition *val; /* Elements. */\n"
15798 #: ../src/guestfs-structs.pod:240
15801 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
15802 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
15807 #: ../fish/guestfish.pod:5
15808 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
15812 #: ../fish/guestfish.pod:9
15815 " guestfish [--options] [commands]\n"
15820 #: ../fish/guestfish.pod:11
15828 #: ../fish/guestfish.pod:13
15831 " guestfish [--ro|--rw] -a disk.img\n"
15836 #: ../fish/guestfish.pod:15
15839 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
15844 #: ../fish/guestfish.pod:17
15847 " guestfish -d libvirt-domain\n"
15852 #: ../fish/guestfish.pod:19
15855 " guestfish [--ro|--rw] -a disk.img -i\n"
15860 #: ../fish/guestfish.pod:21
15863 " guestfish -d libvirt-domain -i\n"
15868 #: ../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
15873 #: ../fish/guestfish.pod:25
15875 "Using guestfish in read/write mode on live virtual machines can be "
15876 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
15877 "option to use guestfish safely if the disk image or virtual machine might be "
15882 #: ../fish/guestfish.pod:32
15884 "Guestfish is a shell and command-line tool for examining and modifying "
15885 "virtual machine filesystems. It uses libguestfs and exposes all of the "
15886 "functionality of the guestfs API, see L<guestfs(3)>."
15890 #: ../fish/guestfish.pod:36
15892 "Guestfish gives you structured access to the libguestfs API, from shell "
15893 "scripts or the command line or interactively. If you want to rescue a "
15894 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
15899 #: ../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
15904 #: ../fish/guestfish.pod:43
15905 msgid "As an interactive shell"
15909 #: ../fish/guestfish.pod:45
15917 #: ../fish/guestfish.pod:47
15920 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
15921 " editing virtual machine filesystems.\n"
15926 #: ../fish/guestfish.pod:50
15929 " Type: 'help' for a list of commands\n"
15930 " 'man' to read the manual\n"
15931 " 'quit' to quit the shell\n"
15936 #: ../fish/guestfish.pod:54
15939 " ><fs> add-ro disk.img\n"
15941 " ><fs> list-filesystems\n"
15942 " /dev/sda1: ext4\n"
15943 " /dev/vg_guest/lv_root: ext4\n"
15944 " /dev/vg_guest/lv_swap: swap\n"
15945 " ><fs> mount /dev/vg_guest/lv_root /\n"
15946 " ><fs> cat /etc/fstab\n"
15948 " # Created by anaconda\n"
15955 #: ../fish/guestfish.pod:67
15956 msgid "From shell scripts"
15960 #: ../fish/guestfish.pod:69
15961 msgid "Create a new C</etc/motd> file in a guest or disk image:"
15965 #: ../fish/guestfish.pod:71
15968 " guestfish <<_EOF_\n"
15971 " mount /dev/vg_guest/lv_root /\n"
15972 " write /etc/motd \"Welcome, new users\"\n"
15978 #: ../fish/guestfish.pod:78
15979 msgid "List the LVM logical volumes in a disk image:"
15983 #: ../fish/guestfish.pod:80
15986 " guestfish -a disk.img --ro <<_EOF_\n"
15994 #: ../fish/guestfish.pod:85
15995 msgid "List all the filesystems in a disk image:"
15999 #: ../fish/guestfish.pod:87
16002 " guestfish -a disk.img --ro <<_EOF_\n"
16004 " list-filesystems\n"
16010 #: ../fish/guestfish.pod:92
16011 msgid "On one command line"
16015 #: ../fish/guestfish.pod:94
16016 msgid "Update C</etc/resolv.conf> in a guest:"
16020 #: ../fish/guestfish.pod:96
16024 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
16025 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
16030 #: ../fish/guestfish.pod:100
16031 msgid "Edit C</boot/grub/grub.conf> interactively:"
16035 #: ../fish/guestfish.pod:102
16038 " guestfish --rw --add disk.img \\\n"
16039 " --mount /dev/vg_guest/lv_root \\\n"
16040 " --mount /dev/sda1:/boot \\\n"
16041 " edit /boot/grub/grub.conf\n"
16046 #: ../fish/guestfish.pod:107
16047 msgid "Mount disks automatically"
16051 #: ../fish/guestfish.pod:109
16053 "Use the I<-i> option to automatically mount the disks from a virtual "
16058 #: ../fish/guestfish.pod:112
16061 " guestfish --ro -a disk.img -i cat /etc/group\n"
16066 #: ../fish/guestfish.pod:114
16069 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
16074 #: ../fish/guestfish.pod:116
16075 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
16079 #: ../fish/guestfish.pod:118
16082 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
16087 #: ../fish/guestfish.pod:120
16088 msgid "As a script interpreter"
16092 #: ../fish/guestfish.pod:122
16093 msgid "Create a 100MB disk containing an ext2-formatted partition:"
16097 #: ../fish/guestfish.pod:124
16100 " #!/usr/bin/guestfish -f\n"
16101 " sparse test1.img 100M\n"
16103 " part-disk /dev/sda mbr\n"
16104 " mkfs ext2 /dev/sda1\n"
16109 #: ../fish/guestfish.pod:130
16110 msgid "Start with a prepared disk"
16114 #: ../fish/guestfish.pod:132
16116 "An alternate way to create a 100MB disk called C<test1.img> containing a "
16117 "single ext2-formatted partition:"
16121 #: ../fish/guestfish.pod:135
16124 " guestfish -N fs\n"
16129 #: ../fish/guestfish.pod:137
16130 msgid "To list what is available do:"
16134 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:837
16137 " guestfish -N help | less\n"
16142 #: ../fish/guestfish.pod:141
16143 msgid "Remote control"
16147 #: ../fish/guestfish.pod:143
16150 " eval \"`guestfish --listen`\"\n"
16151 " guestfish --remote add-ro disk.img\n"
16152 " guestfish --remote run\n"
16153 " guestfish --remote lvs\n"
16158 #: ../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
16163 #: ../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
16168 #: ../fish/guestfish.pod:154
16169 msgid "Displays general help on options."
16173 #: ../fish/guestfish.pod:156
16174 msgid "B<-h> | B<--cmd-help>"
16178 #: ../fish/guestfish.pod:158
16179 msgid "Lists all available guestfish commands."
16183 #: ../fish/guestfish.pod:160
16184 msgid "B<-h cmd> | B<--cmd-help cmd>"
16188 #: ../fish/guestfish.pod:162
16189 msgid "Displays detailed help on a single command C<cmd>."
16193 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
16194 msgid "B<-a image> | B<--add image>"
16198 #: ../fish/guestfish.pod:166
16199 msgid "Add a block device or virtual machine image to the shell."
16203 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
16205 "The format of the disk image is auto-detected. To override this and force a "
16206 "particular format use the I<--format=..> option."
16210 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
16211 msgid "B<-c URI> | B<--connect URI>"
16215 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
16217 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16218 "URI to use. The default is to use the default libvirt connection."
16222 #: ../fish/guestfish.pod:177
16227 #: ../fish/guestfish.pod:179
16229 "If using the I<--listen> option and a csh-like shell, use this option. See "
16230 "section L</REMOTE CONTROL AND CSH> below."
16234 #: ../fish/guestfish.pod:182 ../fuse/guestmount.pod:90
16235 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
16239 #: ../fish/guestfish.pod:184 ../fuse/guestmount.pod:92
16241 "Add disks from the named libvirt domain. If the I<--ro> option is also "
16242 "used, then any libvirt domain can be used. However in write mode, only "
16243 "libvirt domains which are shut down can be named here."
16247 #: ../fish/guestfish.pod:188
16248 msgid "B<-D> | B<--no-dest-paths>"
16252 #: ../fish/guestfish.pod:190
16254 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
16255 "to hit the tab key to complete paths on the guest filesystem, but this "
16256 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
16257 "allow this feature to be disabled."
16261 #: ../fish/guestfish.pod:195 ../fuse/guestmount.pod:108
16262 msgid "B<--echo-keys>"
16266 #: ../fish/guestfish.pod:197 ../fuse/guestmount.pod:110
16268 "When prompting for keys and passphrases, guestfish normally turns echoing "
16269 "off so you cannot see what you are typing. If you are not worried about "
16270 "Tempest attacks and there is no one else in the room you can specify this "
16271 "flag to see what you are typing."
16275 #: ../fish/guestfish.pod:202
16276 msgid "B<-f file> | B<--file file>"
16280 #: ../fish/guestfish.pod:204
16281 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
16285 #: ../fish/guestfish.pod:207
16288 " #!/usr/bin/guestfish -f\n"
16293 #: ../fish/guestfish.pod:209 ../fuse/guestmount.pod:115
16294 msgid "B<--format=raw|qcow2|..> | B<--format>"
16298 #: ../fish/guestfish.pod:211 ../fuse/guestmount.pod:117
16300 "The default for the I<-a> option is to auto-detect the format of the disk "
16301 "image. Using this forces the disk format for I<-a> options which follow on "
16302 "the command line. Using I<--format> with no argument switches back to "
16303 "auto-detection for subsequent I<-a> options."
16307 #: ../fish/guestfish.pod:216 ../fish/guestfish.pod:543 ../inspector/virt-inspector.pl:515
16308 msgid "For example:"
16312 #: ../fish/guestfish.pod:218
16315 " guestfish --format=raw -a disk.img\n"
16320 #: ../fish/guestfish.pod:220
16321 msgid "forces raw format (no auto-detection) for C<disk.img>."
16325 #: ../fish/guestfish.pod:222
16328 " guestfish --format=raw -a disk.img --format -a another.img\n"
16333 #: ../fish/guestfish.pod:224
16335 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
16336 "auto-detection for C<another.img>."
16340 #: ../fish/guestfish.pod:227
16342 "If you have untrusted raw-format guest disk images, you should use this "
16343 "option to specify the disk format. This avoids a possible security problem "
16344 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
16348 #: ../fish/guestfish.pod:232 ../fuse/guestmount.pod:135
16349 msgid "B<-i> | B<--inspector>"
16353 #: ../fish/guestfish.pod:234 ../fuse/guestmount.pod:137
16355 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
16356 "system and mount filesystems as they would be mounted on the real virtual "
16361 #: ../fish/guestfish.pod:238
16362 msgid "Typical usage is either:"
16366 #: ../fish/guestfish.pod:240
16369 " guestfish -d myguest -i\n"
16374 #: ../fish/guestfish.pod:242
16375 msgid "(for an inactive libvirt domain called I<myguest>), or:"
16379 #: ../fish/guestfish.pod:244
16382 " guestfish --ro -d myguest -i\n"
16387 #: ../fish/guestfish.pod:246
16388 msgid "(for active domains, readonly), or specify the block device directly:"
16392 #: ../fish/guestfish.pod:248
16395 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
16400 #: ../fish/guestfish.pod:250
16402 "Note that the command line syntax changed slightly over older versions of "
16403 "guestfish. You can still use the old syntax:"
16407 #: ../fish/guestfish.pod:253
16410 " guestfish [--ro] -i disk.img\n"
16415 #: ../fish/guestfish.pod:255
16418 " guestfish [--ro] -i libvirt-domain\n"
16423 #: ../fish/guestfish.pod:257 ../fuse/guestmount.pod:141
16424 msgid "B<--keys-from-stdin>"
16428 #: ../fish/guestfish.pod:259 ../fuse/guestmount.pod:143
16430 "Read key or passphrase parameters from stdin. The default is to try to read "
16431 "passphrases from the user by opening C</dev/tty>."
16435 #: ../fish/guestfish.pod:262
16436 msgid "B<--listen>"
16440 #: ../fish/guestfish.pod:264
16442 "Fork into the background and listen for remote commands. See section "
16443 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
16447 #: ../fish/guestfish.pod:267
16448 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
16452 #: ../fish/guestfish.pod:269
16453 msgid "Mount the named partition or logical volume on the given mountpoint."
16457 #: ../fish/guestfish.pod:271
16458 msgid "If the mountpoint is omitted, it defaults to C</>."
16462 #: ../fish/guestfish.pod:273
16463 msgid "You have to mount something on C</> before most commands will work."
16467 #: ../fish/guestfish.pod:275
16469 "If any I<-m> or I<--mount> options are given, the guest is automatically "
16474 #: ../fish/guestfish.pod:278
16476 "If you don't know what filesystems a disk image contains, you can either run "
16477 "guestfish without this option, then list the partitions and LVs available "
16478 "(see L</list-partitions> and L</lvs> commands), or you can use the "
16479 "L<virt-list-filesystems(1)> program."
16483 #: ../fish/guestfish.pod:283 ../fuse/guestmount.pod:154
16484 msgid "B<-n> | B<--no-sync>"
16488 #: ../fish/guestfish.pod:285
16490 "Disable autosync. This is enabled by default. See the discussion of "
16491 "autosync in the L<guestfs(3)> manpage."
16495 #: ../fish/guestfish.pod:288
16496 msgid "B<-N type> | B<--new type> | B<-N help>"
16500 #: ../fish/guestfish.pod:290
16502 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
16503 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
16504 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
16509 #: ../fish/guestfish.pod:295
16510 msgid "B<--progress-bars>"
16514 #: ../fish/guestfish.pod:297
16515 msgid "Enable progress bars, even when guestfish is used non-interactively."
16519 #: ../fish/guestfish.pod:299
16521 "Progress bars are enabled by default when guestfish is used as an "
16522 "interactive shell."
16526 #: ../fish/guestfish.pod:302
16527 msgid "B<--no-progress-bars>"
16531 #: ../fish/guestfish.pod:304
16532 msgid "Disable progress bars."
16536 #: ../fish/guestfish.pod:306
16537 msgid "B<--remote[=pid]>"
16541 #: ../fish/guestfish.pod:308
16543 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
16544 "CONTROL GUESTFISH OVER A SOCKET> below."
16548 #: ../fish/guestfish.pod:311 ../fuse/guestmount.pod:196
16549 msgid "B<-r> | B<--ro>"
16553 #: ../fish/guestfish.pod:313
16555 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
16556 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
16560 #: ../fish/guestfish.pod:316 ../tools/virt-rescue.pl:187
16562 "The option must always be used if the disk image or virtual machine might be "
16563 "running, and is generally recommended in cases where you don't need write "
16564 "access to the disk."
16568 #: ../fish/guestfish.pod:320
16570 "Note that prepared disk images created with I<-N> are not affected by the "
16575 #: ../fish/guestfish.pod:323
16576 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
16580 #: ../fish/guestfish.pod:325 ../fuse/guestmount.pod:208 ../tools/virt-rescue.pl:195
16581 msgid "B<--selinux>"
16585 #: ../fish/guestfish.pod:327
16586 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
16590 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:212
16591 msgid "B<-v> | B<--verbose>"
16595 #: ../fish/guestfish.pod:331
16597 "Enable very verbose messages. This is particularly useful if you find a "
16602 #: ../fish/guestfish.pod:334 ../fuse/guestmount.pod:216
16603 msgid "B<-V> | B<--version>"
16607 #: ../fish/guestfish.pod:336
16608 msgid "Display the guestfish / libguestfs version number and exit."
16612 #: ../fish/guestfish.pod:338 ../fuse/guestmount.pod:220
16613 msgid "B<-w> | B<--rw>"
16617 #: ../fish/guestfish.pod:340
16619 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
16624 #: ../fish/guestfish.pod:343
16629 #: ../fish/guestfish.pod:345
16630 msgid "Echo each command before executing it."
16634 #: ../fish/guestfish.pod:349
16635 msgid "COMMANDS ON COMMAND LINE"
16639 #: ../fish/guestfish.pod:351
16640 msgid "Any additional (non-option) arguments are treated as commands to execute."
16644 #: ../fish/guestfish.pod:354
16646 "Commands to execute should be separated by a colon (C<:>), where the colon "
16647 "is a separate parameter. Thus:"
16651 #: ../fish/guestfish.pod:357
16654 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
16659 #: ../fish/guestfish.pod:359
16661 "If there are no additional arguments, then we enter a shell, either an "
16662 "interactive shell with a prompt (if the input is a terminal) or a "
16663 "non-interactive shell."
16667 #: ../fish/guestfish.pod:363
16669 "In either command line mode or non-interactive shell, the first command that "
16670 "gives an error causes the whole shell to exit. In interactive mode (with a "
16671 "prompt) if a command fails, you can continue to enter commands."
16675 #: ../fish/guestfish.pod:368
16676 msgid "USING launch (OR run)"
16680 #: ../fish/guestfish.pod:370
16682 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
16683 "then launch it, then mount any disks you need, and finally issue "
16684 "actions/commands. So the general order of the day is:"
16688 #: ../fish/guestfish.pod:378
16689 msgid "add or -a/--add"
16693 #: ../fish/guestfish.pod:382
16694 msgid "launch (aka run)"
16698 #: ../fish/guestfish.pod:386
16699 msgid "mount or -m/--mount"
16703 #: ../fish/guestfish.pod:390
16704 msgid "any other commands"
16708 #: ../fish/guestfish.pod:394
16710 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
16711 "guest before mounting or performing any other commands."
16715 #: ../fish/guestfish.pod:397
16717 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
16718 "I<--new> options were given then C<run> is done automatically, simply "
16719 "because guestfish can't perform the action you asked for without doing this."
16723 #: ../fish/guestfish.pod:402
16724 msgid "OPENING DISKS FOR READ AND WRITE"
16728 #: ../fish/guestfish.pod:404
16730 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
16731 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
16732 "open disk images read-only or for writing."
16736 #: ../fish/guestfish.pod:408
16738 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
16739 "disk images supplied on the command line for write. To open a disk image "
16740 "read-only you have to do I<-a image --ro>."
16744 #: ../fish/guestfish.pod:412
16746 "This matters: If you accidentally open a live VM disk image writable then "
16747 "you will cause irreversible disk corruption."
16751 #: ../fish/guestfish.pod:415
16753 "By libguestfs 1.8 we intend to change the default the other way. Disk "
16754 "images will be opened read-only. You will have to either specify "
16755 "I<guestfish --rw> or change a configuration file in order to get write "
16756 "access for disk images specified by those other command line options."
16760 #: ../fish/guestfish.pod:420
16762 "This version of guestfish has a I<--rw> option which does nothing (it is "
16763 "already the default). However it is highly recommended that you use this "
16764 "option to indicate that guestfish needs write access, and to prepare your "
16765 "scripts for the day when this option will be required for write access."
16769 #: ../fish/guestfish.pod:426
16771 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
16772 "other libguestfs program apart from guestfish and guestmount."
16776 #: ../fish/guestfish.pod:429
16781 #: ../fish/guestfish.pod:431
16783 "You can quote ordinary parameters using either single or double quotes. For "
16788 #: ../fish/guestfish.pod:434
16791 " add \"file with a space.img\"\n"
16796 #: ../fish/guestfish.pod:436
16799 " rm '/file name'\n"
16804 #: ../fish/guestfish.pod:438
16812 #: ../fish/guestfish.pod:440
16814 "A few commands require a list of strings to be passed. For these, use a "
16815 "whitespace-separated list, enclosed in quotes. Strings containing "
16816 "whitespace to be passed through must be enclosed in single quotes. A "
16817 "literal single quote must be escaped with a backslash."
16821 #: ../fish/guestfish.pod:445
16824 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
16825 " command \"/bin/echo 'foo bar'\"\n"
16826 " command \"/bin/echo \\'foo\\'\"\n"
16831 #: ../fish/guestfish.pod:449
16832 msgid "OPTIONAL ARGUMENTS"
16836 #: ../fish/guestfish.pod:451
16838 "Some commands take optional arguments. These arguments appear in this "
16839 "documentation as C<[argname:..]>. You can use them as in these examples:"
16843 #: ../fish/guestfish.pod:455
16846 " add-drive-opts filename\n"
16851 #: ../fish/guestfish.pod:457
16854 " add-drive-opts filename readonly:true\n"
16859 #: ../fish/guestfish.pod:459
16862 " add-drive-opts filename format:qcow2 readonly:false\n"
16867 #: ../fish/guestfish.pod:461
16869 "Each optional argument can appear at most once. All optional arguments must "
16870 "appear after the required ones."
16874 #: ../fish/guestfish.pod:464
16879 #: ../fish/guestfish.pod:466
16880 msgid "This section applies to all commands which can take integers as parameters."
16884 #: ../fish/guestfish.pod:469
16885 msgid "SIZE SUFFIX"
16889 #: ../fish/guestfish.pod:471
16891 "When the command takes a parameter measured in bytes, you can use one of the "
16892 "following suffixes to specify kilobytes, megabytes and larger sizes:"
16896 #: ../fish/guestfish.pod:477
16897 msgid "B<k> or B<K> or B<KiB>"
16901 #: ../fish/guestfish.pod:479
16902 msgid "The size in kilobytes (multiplied by 1024)."
16906 #: ../fish/guestfish.pod:481
16911 #: ../fish/guestfish.pod:483
16912 msgid "The size in SI 1000 byte units."
16916 #: ../fish/guestfish.pod:485
16917 msgid "B<M> or B<MiB>"
16921 #: ../fish/guestfish.pod:487
16922 msgid "The size in megabytes (multiplied by 1048576)."
16926 #: ../fish/guestfish.pod:489
16931 #: ../fish/guestfish.pod:491
16932 msgid "The size in SI 1000000 byte units."
16936 #: ../fish/guestfish.pod:493
16937 msgid "B<G> or B<GiB>"
16941 #: ../fish/guestfish.pod:495
16942 msgid "The size in gigabytes (multiplied by 2**30)."
16946 #: ../fish/guestfish.pod:497
16951 #: ../fish/guestfish.pod:499
16952 msgid "The size in SI 10**9 byte units."
16956 #: ../fish/guestfish.pod:501
16957 msgid "B<T> or B<TiB>"
16961 #: ../fish/guestfish.pod:503
16962 msgid "The size in terabytes (multiplied by 2**40)."
16966 #: ../fish/guestfish.pod:505
16971 #: ../fish/guestfish.pod:507
16972 msgid "The size in SI 10**12 byte units."
16976 #: ../fish/guestfish.pod:509
16977 msgid "B<P> or B<PiB>"
16981 #: ../fish/guestfish.pod:511
16982 msgid "The size in petabytes (multiplied by 2**50)."
16986 #: ../fish/guestfish.pod:513
16991 #: ../fish/guestfish.pod:515
16992 msgid "The size in SI 10**15 byte units."
16996 #: ../fish/guestfish.pod:517
16997 msgid "B<E> or B<EiB>"
17001 #: ../fish/guestfish.pod:519
17002 msgid "The size in exabytes (multiplied by 2**60)."
17006 #: ../fish/guestfish.pod:521
17011 #: ../fish/guestfish.pod:523
17012 msgid "The size in SI 10**18 byte units."
17016 #: ../fish/guestfish.pod:525
17017 msgid "B<Z> or B<ZiB>"
17021 #: ../fish/guestfish.pod:527
17022 msgid "The size in zettabytes (multiplied by 2**70)."
17026 #: ../fish/guestfish.pod:529
17031 #: ../fish/guestfish.pod:531
17032 msgid "The size in SI 10**21 byte units."
17036 #: ../fish/guestfish.pod:533
17037 msgid "B<Y> or B<YiB>"
17041 #: ../fish/guestfish.pod:535
17042 msgid "The size in yottabytes (multiplied by 2**80)."
17046 #: ../fish/guestfish.pod:537
17051 #: ../fish/guestfish.pod:539
17052 msgid "The size in SI 10**24 byte units."
17056 #: ../fish/guestfish.pod:545
17059 " truncate-size /file 1G\n"
17064 #: ../fish/guestfish.pod:547
17065 msgid "would truncate the file to 1 gigabyte."
17069 #: ../fish/guestfish.pod:549
17071 "Be careful because a few commands take sizes in kilobytes or megabytes "
17072 "(eg. the parameter to L</memsize> is specified in megabytes already). "
17073 "Adding a suffix will probably not do what you expect."
17077 #: ../fish/guestfish.pod:553
17078 msgid "OCTAL AND HEXADECIMAL NUMBERS"
17082 #: ../fish/guestfish.pod:555
17084 "For specifying the radix (base) use the C convention: C<0> to prefix an "
17085 "octal number or C<0x> to prefix a hexadecimal number. For example:"
17089 #: ../fish/guestfish.pod:558
17092 " 1234 decimal number 1234\n"
17093 " 02322 octal number, equivalent to decimal 1234\n"
17094 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
17099 #: ../fish/guestfish.pod:562
17101 "When using the C<chmod> command, you almost always want to specify an octal "
17102 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
17103 "L<chmod(1)> program):"
17107 #: ../fish/guestfish.pod:566
17110 " chmod 0777 /public # OK\n"
17111 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
17116 #: ../fish/guestfish.pod:569
17118 "Commands that return numbers usually print them in decimal, but some "
17119 "commands print numbers in other radices (eg. C<umask> prints the mode in "
17120 "octal, preceeded by C<0>)."
17124 #: ../fish/guestfish.pod:573
17125 msgid "WILDCARDS AND GLOBBING"
17129 #: ../fish/guestfish.pod:575
17131 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
17132 "(globbing) by default. So for example the following will not do what you "
17137 #: ../fish/guestfish.pod:579
17145 #: ../fish/guestfish.pod:581
17147 "Assuming you don't have a directory called literally C</home/*> then the "
17148 "above command will return an error."
17152 #: ../fish/guestfish.pod:584
17153 msgid "To perform wildcard expansion, use the C<glob> command."
17157 #: ../fish/guestfish.pod:586
17160 " glob rm-rf /home/*\n"
17165 #: ../fish/guestfish.pod:588
17167 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
17168 "many times), equivalent to:"
17172 #: ../fish/guestfish.pod:591
17175 " rm-rf /home/jim\n"
17176 " rm-rf /home/joe\n"
17177 " rm-rf /home/mary\n"
17182 #: ../fish/guestfish.pod:595
17183 msgid "C<glob> only works on simple guest paths and not on device names."
17187 #: ../fish/guestfish.pod:597
17189 "If you have several parameters, each containing a wildcard, then glob will "
17190 "perform a Cartesian product."
17194 #: ../fish/guestfish.pod:600
17199 #: ../fish/guestfish.pod:602
17201 "Any line which starts with a I<#> character is treated as a comment and "
17202 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
17203 "a command. For example:"
17207 #: ../fish/guestfish.pod:606
17210 " # this is a comment\n"
17211 " # this is a comment\n"
17212 " foo # NOT a comment\n"
17217 #: ../fish/guestfish.pod:610
17218 msgid "Blank lines are also ignored."
17222 #: ../fish/guestfish.pod:612
17223 msgid "RUNNING COMMANDS LOCALLY"
17227 #: ../fish/guestfish.pod:614
17229 "Any line which starts with a I<!> character is treated as a command sent to "
17230 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
17234 #: ../fish/guestfish.pod:618
17238 " tgz-out /remote local/remote-data.tar.gz\n"
17243 #: ../fish/guestfish.pod:621
17245 "will create a directory C<local> on the host, and then export the contents "
17246 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17247 "(See C<tgz-out>)."
17251 #: ../fish/guestfish.pod:625
17253 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17254 "effect, due to the way that subprocesses work in Unix."
17258 #: ../fish/guestfish.pod:628
17263 #: ../fish/guestfish.pod:630
17265 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17266 "command (a guestfish command) to the second command (any host command). For "
17271 #: ../fish/guestfish.pod:634
17274 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17279 #: ../fish/guestfish.pod:636
17281 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17282 "program). The above command would list all accounts in the guest filesystem "
17283 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17287 #: ../fish/guestfish.pod:641
17290 " hexdump /bin/ls | head\n"
17291 " list-devices | tail -1\n"
17292 " tgz-out / - | tar ztf -\n"
17297 #: ../fish/guestfish.pod:645
17299 "The space before the pipe symbol is required, any space after the pipe "
17300 "symbol is optional. Everything after the pipe symbol is just passed "
17301 "straight to the host shell, so it can contain redirections, globs and "
17302 "anything else that makes sense on the host side."
17306 #: ../fish/guestfish.pod:650
17308 "To use a literal argument which begins with a pipe symbol, you have to quote "
17313 #: ../fish/guestfish.pod:653
17321 #: ../fish/guestfish.pod:655
17322 msgid "HOME DIRECTORIES"
17326 #: ../fish/guestfish.pod:657
17328 "If a parameter starts with the character C<~> then the tilde may be expanded "
17329 "as a home directory path (either C<~> for the current user's home directory, "
17330 "or C<~user> for another user)."
17334 #: ../fish/guestfish.pod:661
17336 "Note that home directory expansion happens for users known I<on the host>, "
17337 "not in the guest filesystem."
17341 #: ../fish/guestfish.pod:664
17343 "To use a literal argument which begins with a tilde, you have to quote it, "
17348 #: ../fish/guestfish.pod:667
17356 #: ../fish/guestfish.pod:671
17358 "Libguestfs has some support for Linux guests encrypted according to the "
17359 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17360 "disk encryption systems used by modern Linux guests. Currently only "
17361 "LVM-on-LUKS is supported."
17365 #: ../fish/guestfish.pod:676
17366 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17370 #: ../fish/guestfish.pod:678
17373 " ><fs> vfs-type /dev/sda2\n"
17379 #: ../fish/guestfish.pod:681
17381 "Then open those devices using L</luks-open>. This creates a device-mapper "
17382 "device called C</dev/mapper/luksdev>."
17386 #: ../fish/guestfish.pod:684
17389 " ><fs> luks-open /dev/sda2 luksdev\n"
17390 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17395 #: ../fish/guestfish.pod:687
17397 "Finally you have to tell LVM to scan for volume groups on the newly created "
17402 #: ../fish/guestfish.pod:690
17406 " vg-activate-all true\n"
17411 #: ../fish/guestfish.pod:693
17412 msgid "The logical volume(s) can now be mounted in the usual way."
17416 #: ../fish/guestfish.pod:695
17418 "Before closing a LUKS device you must unmount any logical volumes on it and "
17419 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17420 "one. Then you can close the mapper device:"
17424 #: ../fish/guestfish.pod:699
17427 " vg-activate false /dev/VG\n"
17428 " luks-close /dev/mapper/luksdev\n"
17433 #: ../fish/guestfish.pod:702
17434 msgid "WINDOWS PATHS"
17438 #: ../fish/guestfish.pod:704
17440 "If a path is prefixed with C<win:> then you can use Windows-style paths "
17441 "(with some limitations). The following commands are equivalent:"
17445 #: ../fish/guestfish.pod:707
17448 " file /WINDOWS/system32/config/system.LOG\n"
17453 #: ../fish/guestfish.pod:709
17456 " file win:/windows/system32/config/system.log\n"
17461 #: ../fish/guestfish.pod:711
17464 " file win:\\windows\\system32\\config\\system.log\n"
17469 #: ../fish/guestfish.pod:713
17472 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
17477 #: ../fish/guestfish.pod:715
17479 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
17480 "handles case insensitivity like Windows would. This only works in argument "
17481 "positions that expect a path."
17485 #: ../fish/guestfish.pod:719
17486 msgid "UPLOADING AND DOWNLOADING FILES"
17490 #: ../fish/guestfish.pod:721
17492 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
17493 "others which upload from or download to a local file, you can use the "
17494 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
17498 #: ../fish/guestfish.pod:725
17506 #: ../fish/guestfish.pod:727
17507 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
17511 #: ../fish/guestfish.pod:730
17514 " tar-out /etc - | tar tf -\n"
17519 #: ../fish/guestfish.pod:732
17521 "writes the tarball to stdout and then pipes that into the external \"tar\" "
17522 "command (see L</PIPES>)."
17526 #: ../fish/guestfish.pod:735
17528 "When using C<-> to read from stdin, the input is read up to the end of "
17529 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
17530 "some arbitrary end marker:"
17534 #: ../fish/guestfish.pod:739
17537 " upload -<<END /foo\n"
17546 #: ../fish/guestfish.pod:745
17548 "Any string of characters can be used instead of C<END>. The end marker must "
17549 "appear on a line of its own, without any preceeding or following characters "
17550 "(not even spaces)."
17554 #: ../fish/guestfish.pod:749
17556 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
17557 "upload local files (so-called \"FileIn\" parameters in the generator)."
17561 #: ../fish/guestfish.pod:752
17562 msgid "EXIT ON ERROR BEHAVIOUR"
17566 #: ../fish/guestfish.pod:754
17568 "By default, guestfish will ignore any errors when in interactive mode "
17569 "(ie. taking commands from a human over a tty), and will exit on the first "
17570 "error in non-interactive mode (scripts, commands given on the command line)."
17574 #: ../fish/guestfish.pod:759
17576 "If you prefix a command with a I<-> character, then that command will not "
17577 "cause guestfish to exit, even if that (one) command returns an error."
17581 #: ../fish/guestfish.pod:763
17582 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
17586 #: ../fish/guestfish.pod:765
17588 "Guestfish can be remote-controlled over a socket. This is useful "
17589 "particularly in shell scripts where you want to make several different "
17590 "changes to a filesystem, but you don't want the overhead of starting up a "
17591 "guestfish process each time."
17595 #: ../fish/guestfish.pod:770
17596 msgid "Start a guestfish server process using:"
17600 #: ../fish/guestfish.pod:772
17603 " eval \"`guestfish --listen`\"\n"
17608 #: ../fish/guestfish.pod:774
17609 msgid "and then send it commands by doing:"
17613 #: ../fish/guestfish.pod:776
17616 " guestfish --remote cmd [...]\n"
17621 #: ../fish/guestfish.pod:778
17622 msgid "To cause the server to exit, send it the exit command:"
17626 #: ../fish/guestfish.pod:780
17629 " guestfish --remote exit\n"
17634 #: ../fish/guestfish.pod:782
17636 "Note that the server will normally exit if there is an error in a command. "
17637 "You can change this in the usual way. See section L</EXIT ON ERROR "
17642 #: ../fish/guestfish.pod:786
17643 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
17647 #: ../fish/guestfish.pod:788
17649 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
17650 "is how the I<--remote> option knows where to send the commands. You can "
17651 "have several guestfish listener processes running using:"
17655 #: ../fish/guestfish.pod:792
17658 " eval \"`guestfish --listen`\"\n"
17659 " pid1=$GUESTFISH_PID\n"
17660 " eval \"`guestfish --listen`\"\n"
17661 " pid2=$GUESTFISH_PID\n"
17663 " guestfish --remote=$pid1 cmd\n"
17664 " guestfish --remote=$pid2 cmd\n"
17669 #: ../fish/guestfish.pod:800
17670 msgid "REMOTE CONTROL AND CSH"
17674 #: ../fish/guestfish.pod:802
17676 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
17681 #: ../fish/guestfish.pod:805
17684 " eval \"`guestfish --listen --csh`\"\n"
17689 #: ../fish/guestfish.pod:807
17690 msgid "REMOTE CONTROL DETAILS"
17694 #: ../fish/guestfish.pod:809
17696 "Remote control happens over a Unix domain socket called "
17697 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
17698 "of the process, and C<$PID> is the process ID of the server."
17702 #: ../fish/guestfish.pod:813
17703 msgid "Guestfish client and server versions must match exactly."
17707 #: ../fish/guestfish.pod:815
17708 msgid "PREPARED DISK IMAGES"
17712 #: ../fish/guestfish.pod:817
17714 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
17715 "preformatted disk images that guestfish can make for you to save typing. "
17716 "This is particularly useful for testing purposes. This option is used "
17717 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
17718 "can be mixed with I<-a>)."
17722 #: ../fish/guestfish.pod:823
17724 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
17725 "the second and so on. Existing files in the current directory are "
17730 #: ../fish/guestfish.pod:827
17732 "The type briefly describes how the disk should be sized, partitioned, how "
17733 "filesystem(s) should be created, and how content should be added. "
17734 "Optionally the type can be followed by extra parameters, separated by C<:> "
17735 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
17736 "sparsely-allocated disk, containing a single partition, with the partition "
17737 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
17738 "on a 1GB disk instead."
17742 #: ../fish/guestfish.pod:835
17743 msgid "To list the available types and any extra parameters they take, run:"
17747 #: ../fish/guestfish.pod:839
17749 "Note that the prepared filesystem is not mounted. You would usually have to "
17750 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
17754 #: ../fish/guestfish.pod:843
17756 "If any I<-N> or I<--new> options are given, the guest is automatically "
17761 #: ../fish/guestfish.pod:848
17762 msgid "Create a 100MB disk with an ext4-formatted partition:"
17766 #: ../fish/guestfish.pod:850
17769 " guestfish -N fs:ext4\n"
17774 #: ../fish/guestfish.pod:852
17775 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
17779 #: ../fish/guestfish.pod:854
17782 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
17787 #: ../fish/guestfish.pod:856
17788 msgid "Create a blank 200MB disk:"
17792 #: ../fish/guestfish.pod:858
17795 " guestfish -N disk:200M\n"
17800 #: ../fish/guestfish.pod:860
17801 msgid "PROGRESS BARS"
17805 #: ../fish/guestfish.pod:862
17807 "Some (not all) long-running commands send progress notification messages as "
17808 "they are running. Guestfish turns these messages into progress bars."
17812 #: ../fish/guestfish.pod:866
17814 "When a command that supports progress bars takes longer than two seconds to "
17815 "run, and if progress bars are enabled, then you will see one appearing below "
17820 #: ../fish/guestfish.pod:870
17823 " ><fs> copy-size /large-file /another-file 2048M\n"
17824 " / 10% [#####-----------------------------------------] 00:30\n"
17829 #: ../fish/guestfish.pod:873
17831 "The spinner on the left hand side moves round once for every progress "
17832 "notification received from the backend. This is a (reasonably) golden "
17833 "assurance that the command is \"doing something\" even if the progress bar "
17834 "is not moving, because the command is able to send the progress "
17835 "notifications. When the bar reaches 100% and the command finishes, the "
17836 "spinner disappears."
17840 #: ../fish/guestfish.pod:880
17842 "Progress bars are enabled by default when guestfish is used interactively. "
17843 "You can enable them even for non-interactive modes using I<--progress-bars>, "
17844 "and you can disable them completely using I<--no-progress-bars>."
17848 #: ../fish/guestfish.pod:885
17849 msgid "GUESTFISH COMMANDS"
17853 #: ../fish/guestfish.pod:887
17855 "The commands in this section are guestfish convenience commands, in other "
17856 "words, they are not part of the L<guestfs(3)> API."
17860 #: ../fish/guestfish.pod:890
17865 #: ../fish/guestfish.pod:892
17874 #: ../fish/guestfish.pod:895
17875 msgid "Without any parameter, this provides general help."
17879 #: ../fish/guestfish.pod:897
17880 msgid "With a C<cmd> parameter, this displays detailed help for that command."
17884 #: ../fish/guestfish.pod:899
17885 msgid "quit | exit"
17889 #: ../fish/guestfish.pod:901
17890 msgid "This exits guestfish. You can also use C<^D> key."
17894 #: ../fish/guestfish.pod:903
17895 msgid "@FISH_COMMANDS@"
17899 #: ../fish/guestfish.pod:905
17904 #: ../fish/guestfish.pod:909 ../test-tool/libguestfs-test-tool.pod:83
17909 #: ../fish/guestfish.pod:911
17911 "guestfish returns 0 if the commands completed without error, or 1 if there "
17916 #: ../fish/guestfish.pod:918
17921 #: ../fish/guestfish.pod:920
17923 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
17928 #: ../fish/guestfish.pod:923
17929 msgid "GUESTFISH_PID"
17933 #: ../fish/guestfish.pod:925
17935 "Used with the I<--remote> option to specify the remote guestfish process to "
17936 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
17940 #: ../fish/guestfish.pod:929
17945 #: ../fish/guestfish.pod:931
17947 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
17948 "not specified, the external L<hexedit(1)> program is used."
17952 #: ../fish/guestfish.pod:935
17957 #: ../fish/guestfish.pod:937
17959 "If compiled with GNU readline support, various files in the home directory "
17960 "can be used. See L</FILES>."
17964 #: ../fish/guestfish.pod:946
17966 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
17967 "effect as using the B<-v> option."
17971 #: ../fish/guestfish.pod:958
17973 "Set the path that guestfish uses to search for kernel and initrd.img. See "
17974 "the discussion of paths in L<guestfs(3)>."
17978 #: ../fish/guestfish.pod:969
17979 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
17983 #: ../fish/guestfish.pod:971
17988 #: ../fish/guestfish.pod:973
17990 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
17995 #: ../fish/guestfish.pod:988 ../test-tool/libguestfs-test-tool.pod:88
18000 #: ../fish/guestfish.pod:992
18001 msgid "$HOME/.guestfish"
18005 #: ../fish/guestfish.pod:994
18007 "If compiled with GNU readline support, then the command history is saved in "
18012 #: ../fish/guestfish.pod:997
18013 msgid "$HOME/.inputrc"
18017 #: ../fish/guestfish.pod:999
18018 msgid "/etc/inputrc"
18022 #: ../fish/guestfish.pod:1001
18024 "If compiled with GNU readline support, then these files can be used to "
18025 "configure readline. For further information, please see "
18026 "L<readline(3)/INITIALIZATION FILE>."
18030 #: ../fish/guestfish.pod:1005
18031 msgid "To write rules which only apply to guestfish, use:"
18035 #: ../fish/guestfish.pod:1007
18045 #: ../fish/guestfish.pod:1011
18047 "Variables that you can set in inputrc that change the behaviour of guestfish "
18048 "in useful ways include:"
18052 #: ../fish/guestfish.pod:1016
18053 msgid "completion-ignore-case (default: on)"
18057 #: ../fish/guestfish.pod:1018
18059 "By default, guestfish will ignore case when tab-completing paths on the "
18064 #: ../fish/guestfish.pod:1021
18067 " set completion-ignore-case off\n"
18072 #: ../fish/guestfish.pod:1023
18073 msgid "to make guestfish case sensitive."
18077 #: ../fish/guestfish.pod:1027
18082 #: ../fish/guestfish.pod:1029
18083 msgid "test2.img (etc)"
18087 #: ../fish/guestfish.pod:1031
18089 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
18090 "will be created in the file C<test1.img> in the current directory. The "
18091 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
18092 "the same name will be overwritten."
18096 #: ../fish/guestfish.pod:1040
18098 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
18099 "L<virt-edit(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, "
18100 "L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, "
18101 "L<virt-tar(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
18105 #: ../fish/guestfish.pod:1064 ../test-tool/libguestfs-test-tool.pod:124 ../fuse/guestmount.pod:253 ../inspector/virt-inspector.pl:564 ../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
18107 "This program is free software; you can redistribute it and/or modify it "
18108 "under the terms of the GNU General Public License as published by the Free "
18109 "Software Foundation; either version 2 of the License, or (at your option) "
18110 "any later version."
18114 #: ../fish/guestfish.pod:1069 ../test-tool/libguestfs-test-tool.pod:129 ../fuse/guestmount.pod:258 ../inspector/virt-inspector.pl:569 ../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
18116 "This program is distributed in the hope that it will be useful, but WITHOUT "
18117 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
18118 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
18123 #: ../fish/guestfish.pod:1074 ../test-tool/libguestfs-test-tool.pod:134 ../fuse/guestmount.pod:263 ../inspector/virt-inspector.pl:574 ../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
18125 "You should have received a copy of the GNU General Public License along with "
18126 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
18127 "Ave, Cambridge, MA 02139, USA."
18131 #: ../fish/guestfish-actions.pod:1
18136 #: ../fish/guestfish-actions.pod:3
18139 " add-cdrom filename\n"
18144 #: ../fish/guestfish-actions.pod:15
18146 "This call checks for the existence of C<filename>. This stops you from "
18147 "specifying other types of drive which are supported by qemu such as C<nbd:> "
18148 "and C<http:> URLs. To specify those, use the general L</config> call "
18153 #: ../fish/guestfish-actions.pod:22
18155 "If you just want to add an ISO file (often you use this as an efficient way "
18156 "to transfer large files into the guest), then you should probably use "
18157 "L</add-drive-ro> instead."
18161 #: ../fish/guestfish-actions.pod:35
18166 #: ../fish/guestfish-actions.pod:37
18171 #: ../fish/guestfish-actions.pod:39
18174 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
18179 #: ../fish/guestfish-actions.pod:41
18181 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
18182 "It works by connecting to libvirt, requesting the domain and domain XML from "
18183 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
18187 #: ../fish/guestfish-actions.pod:58
18189 "The optional C<libvirturi> parameter sets the libvirt URI (see "
18190 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
18191 "default libvirt URI (or one set through an environment variable, see the "
18192 "libvirt documentation for full details). If you are using the C API "
18193 "directly then it is more flexible to create the libvirt connection object "
18194 "yourself, get the domain object, and call L</add-libvirt-dom>."
18198 #: ../fish/guestfish-actions.pod:66
18200 "The other optional parameters are passed directly through to "
18201 "L</add-drive-opts>."
18205 #: ../fish/guestfish-actions.pod:69 ../fish/guestfish-actions.pod:133
18207 "This command has one or more optional arguments. See L</OPTIONAL "
18212 #: ../fish/guestfish-actions.pod:71
18217 #: ../fish/guestfish-actions.pod:73
18220 " add-drive filename\n"
18225 #: ../fish/guestfish-actions.pod:75
18227 "This function is the equivalent of calling L</add-drive-opts> with no "
18228 "optional parameters, so the disk is added writable, with the format being "
18229 "detected automatically."
18233 #: ../fish/guestfish-actions.pod:79
18235 "Automatic detection of the format opens you up to a potential security hole "
18236 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
18237 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
18238 "you should think about replacing calls to this function with calls to "
18239 "L</add-drive-opts>, and specifying the format."
18243 #: ../fish/guestfish-actions.pod:86
18244 msgid "add-drive-opts"
18248 #: ../fish/guestfish-actions.pod:88
18253 #: ../fish/guestfish-actions.pod:90
18256 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
18261 #: ../fish/guestfish-actions.pod:117
18263 "This forces the image format. If you omit this (or use L</add-drive> or "
18264 "L</add-drive-ro>) then the format is automatically detected. Possible "
18265 "formats include C<raw> and C<qcow2>."
18269 #: ../fish/guestfish-actions.pod:128
18271 "This rarely-used option lets you emulate the behaviour of the deprecated "
18272 "L</add-drive-with-if> call (q.v.)"
18276 #: ../fish/guestfish-actions.pod:135
18277 msgid "add-drive-ro"
18281 #: ../fish/guestfish-actions.pod:137
18286 #: ../fish/guestfish-actions.pod:139
18289 " add-drive-ro filename\n"
18294 #: ../fish/guestfish-actions.pod:141
18296 "This function is the equivalent of calling L</add-drive-opts> with the "
18297 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
18298 "is added read-only, with the format being detected automatically."
18302 #: ../fish/guestfish-actions.pod:146
18303 msgid "add-drive-ro-with-if"
18307 #: ../fish/guestfish-actions.pod:148
18310 " add-drive-ro-with-if filename iface\n"
18315 #: ../fish/guestfish-actions.pod:150
18317 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
18318 "interface emulation to use at run time."
18322 #: ../fish/guestfish-actions.pod:160
18323 msgid "add-drive-with-if"
18327 #: ../fish/guestfish-actions.pod:162
18330 " add-drive-with-if filename iface\n"
18335 #: ../fish/guestfish-actions.pod:164
18337 "This is the same as L</add-drive> but it allows you to specify the QEMU "
18338 "interface emulation to use at run time."
18342 #: ../fish/guestfish-actions.pod:174
18347 #: ../fish/guestfish-actions.pod:176
18350 " aug-clear augpath\n"
18355 #: ../fish/guestfish-actions.pod:181
18360 #: ../fish/guestfish-actions.pod:183
18368 #: ../fish/guestfish-actions.pod:185
18370 "Close the current Augeas handle and free up any resources used by it. After "
18371 "calling this, you have to call L</aug-init> again before you can use any "
18372 "other Augeas functions."
18376 #: ../fish/guestfish-actions.pod:190
18377 msgid "aug-defnode"
18381 #: ../fish/guestfish-actions.pod:192
18384 " aug-defnode name expr val\n"
18389 #: ../fish/guestfish-actions.pod:197
18391 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
18392 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
18393 "containing that single node."
18397 #: ../fish/guestfish-actions.pod:205
18402 #: ../fish/guestfish-actions.pod:207
18405 " aug-defvar name expr\n"
18410 #: ../fish/guestfish-actions.pod:216
18415 #: ../fish/guestfish-actions.pod:218
18418 " aug-get augpath\n"
18423 #: ../fish/guestfish-actions.pod:223
18428 #: ../fish/guestfish-actions.pod:225
18431 " aug-init root flags\n"
18436 #: ../fish/guestfish-actions.pod:231
18437 msgid "You must call this before using any other L</aug-*> commands."
18441 #: ../fish/guestfish-actions.pod:266
18442 msgid "Do not load the tree in L</aug-init>."
18446 #: ../fish/guestfish-actions.pod:270
18447 msgid "To close the handle, you can call L</aug-close>."
18451 #: ../fish/guestfish-actions.pod:274
18456 #: ../fish/guestfish-actions.pod:276
18459 " aug-insert augpath label true|false\n"
18464 #: ../fish/guestfish-actions.pod:286
18469 #: ../fish/guestfish-actions.pod:288
18477 #: ../fish/guestfish-actions.pod:295
18482 #: ../fish/guestfish-actions.pod:297
18485 " aug-ls augpath\n"
18490 #: ../fish/guestfish-actions.pod:299
18492 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
18493 "resulting nodes into alphabetical order."
18497 #: ../fish/guestfish-actions.pod:302
18502 #: ../fish/guestfish-actions.pod:304
18505 " aug-match augpath\n"
18510 #: ../fish/guestfish-actions.pod:310
18515 #: ../fish/guestfish-actions.pod:312
18518 " aug-mv src dest\n"
18523 #: ../fish/guestfish-actions.pod:317
18528 #: ../fish/guestfish-actions.pod:319
18531 " aug-rm augpath\n"
18536 #: ../fish/guestfish-actions.pod:325
18541 #: ../fish/guestfish-actions.pod:327
18549 #: ../fish/guestfish-actions.pod:331
18551 "The flags which were passed to L</aug-init> affect exactly how files are "
18556 #: ../fish/guestfish-actions.pod:334
18561 #: ../fish/guestfish-actions.pod:336
18564 " aug-set augpath val\n"
18569 #: ../fish/guestfish-actions.pod:340
18571 "In the Augeas API, it is possible to clear a node by setting the value to "
18572 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
18573 "this call. Instead you must use the L</aug-clear> call."
18577 #: ../fish/guestfish-actions.pod:345
18582 #: ../fish/guestfish-actions.pod:347
18585 " available 'groups ...'\n"
18590 #: ../fish/guestfish-actions.pod:353
18592 "The libguestfs groups, and the functions that those groups correspond to, "
18593 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
18594 "runtime by calling L</available-all-groups>."
18598 #: ../fish/guestfish-actions.pod:377
18599 msgid "You must call L</launch> before calling this function."
18603 #: ../fish/guestfish-actions.pod:399
18605 "This call was added in version C<1.0.80>. In previous versions of "
18606 "libguestfs all you could do would be to speculatively execute a command to "
18607 "find out if the daemon implemented it. See also L</version>."
18611 #: ../fish/guestfish-actions.pod:406
18612 msgid "available-all-groups"
18616 #: ../fish/guestfish-actions.pod:408
18619 " available-all-groups\n"
18624 #: ../fish/guestfish-actions.pod:410
18626 "This command returns a list of all optional groups that this daemon knows "
18627 "about. Note this returns both supported and unsupported groups. To find "
18628 "out which ones the daemon can actually support you have to call "
18629 "L</available> on each member of the returned list."
18633 #: ../fish/guestfish-actions.pod:416
18634 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
18638 #: ../fish/guestfish-actions.pod:418
18643 #: ../fish/guestfish-actions.pod:420
18646 " base64-in (base64file|-) filename\n"
18651 #: ../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:4002 ../fish/guestfish-actions.pod:4014 ../fish/guestfish-actions.pod:4025 ../fish/guestfish-actions.pod:4036 ../fish/guestfish-actions.pod:4088 ../fish/guestfish-actions.pod:4097 ../fish/guestfish-actions.pod:4151 ../fish/guestfish-actions.pod:4174
18652 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
18656 #: ../fish/guestfish-actions.pod:427
18661 #: ../fish/guestfish-actions.pod:429
18664 " base64-out filename (base64file|-)\n"
18669 #: ../fish/guestfish-actions.pod:436
18670 msgid "blockdev-flushbufs"
18674 #: ../fish/guestfish-actions.pod:438
18677 " blockdev-flushbufs device\n"
18682 #: ../fish/guestfish-actions.pod:445
18683 msgid "blockdev-getbsz"
18687 #: ../fish/guestfish-actions.pod:447
18690 " blockdev-getbsz device\n"
18695 #: ../fish/guestfish-actions.pod:456
18696 msgid "blockdev-getro"
18700 #: ../fish/guestfish-actions.pod:458
18703 " blockdev-getro device\n"
18708 #: ../fish/guestfish-actions.pod:465
18709 msgid "blockdev-getsize64"
18713 #: ../fish/guestfish-actions.pod:467
18716 " blockdev-getsize64 device\n"
18721 #: ../fish/guestfish-actions.pod:471
18722 msgid "See also L</blockdev-getsz>."
18726 #: ../fish/guestfish-actions.pod:475
18727 msgid "blockdev-getss"
18731 #: ../fish/guestfish-actions.pod:477
18734 " blockdev-getss device\n"
18739 #: ../fish/guestfish-actions.pod:482
18740 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
18744 #: ../fish/guestfish-actions.pod:487
18745 msgid "blockdev-getsz"
18749 #: ../fish/guestfish-actions.pod:489
18752 " blockdev-getsz device\n"
18757 #: ../fish/guestfish-actions.pod:494
18759 "See also L</blockdev-getss> for the real sector size of the device, and "
18760 "L</blockdev-getsize64> for the more useful I<size in bytes>."
18764 #: ../fish/guestfish-actions.pod:500
18765 msgid "blockdev-rereadpt"
18769 #: ../fish/guestfish-actions.pod:502
18772 " blockdev-rereadpt device\n"
18777 #: ../fish/guestfish-actions.pod:508
18778 msgid "blockdev-setbsz"
18782 #: ../fish/guestfish-actions.pod:510
18785 " blockdev-setbsz device blocksize\n"
18790 #: ../fish/guestfish-actions.pod:519
18791 msgid "blockdev-setro"
18795 #: ../fish/guestfish-actions.pod:521
18798 " blockdev-setro device\n"
18803 #: ../fish/guestfish-actions.pod:527
18804 msgid "blockdev-setrw"
18808 #: ../fish/guestfish-actions.pod:529
18811 " blockdev-setrw device\n"
18816 #: ../fish/guestfish-actions.pod:535
18817 msgid "case-sensitive-path"
18821 #: ../fish/guestfish-actions.pod:537
18824 " case-sensitive-path path\n"
18829 #: ../fish/guestfish-actions.pod:561
18831 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
18832 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
18833 "how the directories were originally created under Windows)."
18837 #: ../fish/guestfish-actions.pod:569
18838 msgid "See also L</realpath>."
18842 #: ../fish/guestfish-actions.pod:571
18847 #: ../fish/guestfish-actions.pod:573
18855 #: ../fish/guestfish-actions.pod:577
18857 "Note that this function cannot correctly handle binary files (specifically, "
18858 "files containing C<\\0> character which is treated as end of string). For "
18859 "those you need to use the L</read-file> or L</download> functions which have "
18860 "a more complex interface."
18864 #: ../fish/guestfish-actions.pod:585
18869 #: ../fish/guestfish-actions.pod:587
18872 " checksum csumtype path\n"
18877 #: ../fish/guestfish-actions.pod:630
18878 msgid "To get the checksum for a device, use L</checksum-device>."
18882 #: ../fish/guestfish-actions.pod:632
18883 msgid "To get the checksums for many files, use L</checksums-out>."
18887 #: ../fish/guestfish-actions.pod:634
18888 msgid "checksum-device"
18892 #: ../fish/guestfish-actions.pod:636
18895 " checksum-device csumtype device\n"
18900 #: ../fish/guestfish-actions.pod:638
18902 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
18903 "device named C<device>. For the types of checksums supported see the "
18904 "L</checksum> command."
18908 #: ../fish/guestfish-actions.pod:642
18909 msgid "checksums-out"
18913 #: ../fish/guestfish-actions.pod:644
18916 " checksums-out csumtype directory (sumsfile|-)\n"
18921 #: ../fish/guestfish-actions.pod:660
18926 #: ../fish/guestfish-actions.pod:662
18929 " chmod mode path\n"
18934 #: ../fish/guestfish-actions.pod:673
18939 #: ../fish/guestfish-actions.pod:675
18942 " chown owner group path\n"
18947 #: ../fish/guestfish-actions.pod:683
18952 #: ../fish/guestfish-actions.pod:685
18955 " command 'arguments ...'\n"
18960 #: ../fish/guestfish-actions.pod:692
18962 "The single parameter is an argv-style list of arguments. The first element "
18963 "is the name of the program to run. Subsequent elements are parameters. The "
18964 "list must be non-empty (ie. must contain a program name). Note that the "
18965 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
18969 #: ../fish/guestfish-actions.pod:720
18970 msgid "command-lines"
18974 #: ../fish/guestfish-actions.pod:722
18977 " command-lines 'arguments ...'\n"
18982 #: ../fish/guestfish-actions.pod:724
18983 msgid "This is the same as L</command>, but splits the result into a list of lines."
18987 #: ../fish/guestfish-actions.pod:727
18988 msgid "See also: L</sh-lines>"
18992 #: ../fish/guestfish-actions.pod:732
18997 #: ../fish/guestfish-actions.pod:734
19000 " config qemuparam qemuvalue\n"
19005 #: ../fish/guestfish-actions.pod:745
19010 #: ../fish/guestfish-actions.pod:747
19013 " copy-size src dest size\n"
19018 #: ../fish/guestfish-actions.pod:755
19023 #: ../fish/guestfish-actions.pod:757
19031 #: ../fish/guestfish-actions.pod:762
19036 #: ../fish/guestfish-actions.pod:764
19044 #: ../fish/guestfish-actions.pod:769
19049 #: ../fish/guestfish-actions.pod:771
19057 #: ../fish/guestfish-actions.pod:778
19059 "If the destination is a device, it must be as large or larger than the "
19060 "source file or device, otherwise the copy will fail. This command cannot do "
19061 "partial copies (see L</copy-size>)."
19065 #: ../fish/guestfish-actions.pod:782
19070 #: ../fish/guestfish-actions.pod:784
19078 #: ../fish/guestfish-actions.pod:792
19083 #: ../fish/guestfish-actions.pod:794
19091 #: ../fish/guestfish-actions.pod:803
19096 #: ../fish/guestfish-actions.pod:805
19104 #: ../fish/guestfish-actions.pod:811
19106 "Another way to get the same information is to enable verbose messages with "
19107 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
19108 "before running the program."
19112 #: ../fish/guestfish-actions.pod:816
19117 #: ../fish/guestfish-actions.pod:818
19120 " download remotefilename (filename|-)\n"
19125 #: ../fish/guestfish-actions.pod:825
19126 msgid "See also L</upload>, L</cat>."
19130 #: ../fish/guestfish-actions.pod:829
19131 msgid "download-offset"
19135 #: ../fish/guestfish-actions.pod:831
19138 " download-offset remotefilename (filename|-) offset size\n"
19143 #: ../fish/guestfish-actions.pod:839
19145 "Note that there is no limit on the amount of data that can be downloaded "
19146 "with this call, unlike with L</pread>, and this call always reads the full "
19147 "amount unless an error occurs."
19151 #: ../fish/guestfish-actions.pod:844
19152 msgid "See also L</download>, L</pread>."
19156 #: ../fish/guestfish-actions.pod:848
19157 msgid "drop-caches"
19161 #: ../fish/guestfish-actions.pod:850
19164 " drop-caches whattodrop\n"
19169 #: ../fish/guestfish-actions.pod:862
19174 #: ../fish/guestfish-actions.pod:864
19182 #: ../fish/guestfish-actions.pod:876
19187 #: ../fish/guestfish-actions.pod:878
19190 " e2fsck-f device\n"
19195 #: ../fish/guestfish-actions.pod:884
19197 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
19198 "should use L</fsck>."
19202 #: ../fish/guestfish-actions.pod:887
19203 msgid "echo-daemon"
19207 #: ../fish/guestfish-actions.pod:889
19210 " echo-daemon 'words ...'\n"
19215 #: ../fish/guestfish-actions.pod:896
19216 msgid "See also L</ping-daemon>."
19220 #: ../fish/guestfish-actions.pod:898
19225 #: ../fish/guestfish-actions.pod:900
19228 " egrep regex path\n"
19233 #: ../fish/guestfish-actions.pod:908
19238 #: ../fish/guestfish-actions.pod:910
19241 " egrepi regex path\n"
19246 #: ../fish/guestfish-actions.pod:918
19251 #: ../fish/guestfish-actions.pod:920
19254 " equal file1 file2\n"
19259 #: ../fish/guestfish-actions.pod:927
19264 #: ../fish/guestfish-actions.pod:929
19272 #: ../fish/guestfish-actions.pod:934
19273 msgid "See also L</is-file>, L</is-dir>, L</stat>."
19277 #: ../fish/guestfish-actions.pod:936
19282 #: ../fish/guestfish-actions.pod:938
19285 " fallocate path len\n"
19290 #: ../fish/guestfish-actions.pod:955
19291 msgid "fallocate64"
19295 #: ../fish/guestfish-actions.pod:957
19298 " fallocate64 path len\n"
19303 #: ../fish/guestfish-actions.pod:963
19305 "Note that this call allocates disk blocks for the file. To create a sparse "
19306 "file use L</truncate-size> instead."
19310 #: ../fish/guestfish-actions.pod:966
19312 "The deprecated call L</fallocate> does the same, but owing to an oversight "
19313 "it only allowed 30 bit lengths to be specified, effectively limiting the "
19314 "maximum size of files created through that call to 1GB."
19318 #: ../fish/guestfish-actions.pod:975
19323 #: ../fish/guestfish-actions.pod:977
19326 " fgrep pattern path\n"
19331 #: ../fish/guestfish-actions.pod:985
19336 #: ../fish/guestfish-actions.pod:987
19339 " fgrepi pattern path\n"
19344 #: ../fish/guestfish-actions.pod:995
19349 #: ../fish/guestfish-actions.pod:997
19357 #: ../fish/guestfish-actions.pod:1009
19359 "This command can also be used on C</dev/> devices (and partitions, LV "
19360 "names). You can for example use this to determine if a device contains a "
19361 "filesystem, although it's usually better to use L</vfs-type>."
19365 #: ../fish/guestfish-actions.pod:1019
19366 msgid "file-architecture"
19370 #: ../fish/guestfish-actions.pod:1021
19373 " file-architecture filename\n"
19378 #: ../fish/guestfish-actions.pod:1124
19383 #: ../fish/guestfish-actions.pod:1126
19391 #: ../fish/guestfish-actions.pod:1130
19393 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
19394 "L</is-file> etc. To get the size of block devices, use "
19395 "L</blockdev-getsize64>."
19399 #: ../fish/guestfish-actions.pod:1134
19404 #: ../fish/guestfish-actions.pod:1136
19407 " fill c len path\n"
19412 #: ../fish/guestfish-actions.pod:1142
19414 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
19415 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
19416 "L</fill-pattern>."
19420 #: ../fish/guestfish-actions.pod:1147
19421 msgid "fill-pattern"
19425 #: ../fish/guestfish-actions.pod:1149
19428 " fill-pattern pattern len path\n"
19433 #: ../fish/guestfish-actions.pod:1151
19435 "This function is like L</fill> except that it creates a new file of length "
19436 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
19437 "is truncated if necessary to ensure the length of the file is exactly C<len> "
19442 #: ../fish/guestfish-actions.pod:1156
19447 #: ../fish/guestfish-actions.pod:1158
19450 " find directory\n"
19455 #: ../fish/guestfish-actions.pod:1172
19456 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
19460 #: ../fish/guestfish-actions.pod:1185
19461 msgid "See also L</find0>."
19465 #: ../fish/guestfish-actions.pod:1190
19470 #: ../fish/guestfish-actions.pod:1192
19473 " find0 directory (files|-)\n"
19478 #: ../fish/guestfish-actions.pod:1198
19479 msgid "This command works the same way as L</find> with the following exceptions:"
19483 #: ../fish/guestfish-actions.pod:1225
19484 msgid "findfs-label"
19488 #: ../fish/guestfish-actions.pod:1227
19491 " findfs-label label\n"
19496 #: ../fish/guestfish-actions.pod:1233
19497 msgid "To find the label of a filesystem, use L</vfs-label>."
19501 #: ../fish/guestfish-actions.pod:1235
19502 msgid "findfs-uuid"
19506 #: ../fish/guestfish-actions.pod:1237
19509 " findfs-uuid uuid\n"
19514 #: ../fish/guestfish-actions.pod:1243
19515 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
19519 #: ../fish/guestfish-actions.pod:1245
19524 #: ../fish/guestfish-actions.pod:1247
19527 " fsck fstype device\n"
19532 #: ../fish/guestfish-actions.pod:1277
19537 #: ../fish/guestfish-actions.pod:1279
19545 #: ../fish/guestfish-actions.pod:1286
19546 msgid "get-autosync"
19550 #: ../fish/guestfish-actions.pod:1288
19558 #: ../fish/guestfish-actions.pod:1292
19563 #: ../fish/guestfish-actions.pod:1294
19571 #: ../fish/guestfish-actions.pod:1298
19572 msgid "get-e2label"
19576 #: ../fish/guestfish-actions.pod:1300
19579 " get-e2label device\n"
19584 #: ../fish/guestfish-actions.pod:1312
19589 #: ../fish/guestfish-actions.pod:1314
19592 " get-e2uuid device\n"
19597 #: ../fish/guestfish-actions.pod:1326
19598 msgid "get-memsize"
19602 #: ../fish/guestfish-actions.pod:1328
19610 #: ../fish/guestfish-actions.pod:1333
19612 "If L</set-memsize> was not called on this handle, and if "
19613 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
19614 "value for memsize."
19618 #: ../fish/guestfish-actions.pod:1340
19619 msgid "get-network"
19623 #: ../fish/guestfish-actions.pod:1342
19631 #: ../fish/guestfish-actions.pod:1346
19636 #: ../fish/guestfish-actions.pod:1348
19644 #: ../fish/guestfish-actions.pod:1355
19649 #: ../fish/guestfish-actions.pod:1357
19654 #: ../fish/guestfish-actions.pod:1359
19662 #: ../fish/guestfish-actions.pod:1366
19667 #: ../fish/guestfish-actions.pod:1368
19675 #: ../fish/guestfish-actions.pod:1375
19676 msgid "get-recovery-proc"
19680 #: ../fish/guestfish-actions.pod:1377
19683 " get-recovery-proc\n"
19688 #: ../fish/guestfish-actions.pod:1381
19689 msgid "get-selinux"
19693 #: ../fish/guestfish-actions.pod:1383
19701 #: ../fish/guestfish-actions.pod:1385
19703 "This returns the current setting of the selinux flag which is passed to the "
19704 "appliance at boot time. See L</set-selinux>."
19708 #: ../fish/guestfish-actions.pod:1391
19713 #: ../fish/guestfish-actions.pod:1393
19721 #: ../fish/guestfish-actions.pod:1400
19726 #: ../fish/guestfish-actions.pod:1402
19734 #: ../fish/guestfish-actions.pod:1406
19739 #: ../fish/guestfish-actions.pod:1408
19747 #: ../fish/guestfish-actions.pod:1410
19749 "Return the current umask. By default the umask is C<022> unless it has been "
19750 "set by calling L</umask>."
19754 #: ../fish/guestfish-actions.pod:1413
19755 msgid "get-verbose"
19759 #: ../fish/guestfish-actions.pod:1415
19767 #: ../fish/guestfish-actions.pod:1419
19772 #: ../fish/guestfish-actions.pod:1421
19780 #: ../fish/guestfish-actions.pod:1425
19781 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
19785 #: ../fish/guestfish-actions.pod:1428
19790 #: ../fish/guestfish-actions.pod:1430
19793 " getxattrs path\n"
19798 #: ../fish/guestfish-actions.pod:1438
19799 msgid "See also: L</lgetxattrs>, L<attr(5)>."
19803 #: ../fish/guestfish-actions.pod:1440
19804 msgid "glob-expand"
19808 #: ../fish/guestfish-actions.pod:1442
19811 " glob-expand pattern\n"
19816 #: ../fish/guestfish-actions.pod:1455
19821 #: ../fish/guestfish-actions.pod:1457
19824 " grep regex path\n"
19829 #: ../fish/guestfish-actions.pod:1465
19834 #: ../fish/guestfish-actions.pod:1467
19837 " grepi regex path\n"
19842 #: ../fish/guestfish-actions.pod:1475
19843 msgid "grub-install"
19847 #: ../fish/guestfish-actions.pod:1477
19850 " grub-install root device\n"
19855 #: ../fish/guestfish-actions.pod:1493
19860 #: ../fish/guestfish-actions.pod:1495
19868 #: ../fish/guestfish-actions.pod:1503
19873 #: ../fish/guestfish-actions.pod:1505
19876 " head-n nrlines path\n"
19881 #: ../fish/guestfish-actions.pod:1518
19886 #: ../fish/guestfish-actions.pod:1520
19894 #: ../fish/guestfish-actions.pod:1528
19899 #: ../fish/guestfish-actions.pod:1530
19902 " initrd-cat initrdpath filename\n"
19907 #: ../fish/guestfish-actions.pod:1542
19908 msgid "See also L</initrd-list>."
19912 #: ../fish/guestfish-actions.pod:1547
19913 msgid "initrd-list"
19917 #: ../fish/guestfish-actions.pod:1549
19920 " initrd-list path\n"
19925 #: ../fish/guestfish-actions.pod:1561
19926 msgid "inotify-add-watch"
19930 #: ../fish/guestfish-actions.pod:1563
19933 " inotify-add-watch path mask\n"
19938 #: ../fish/guestfish-actions.pod:1575
19939 msgid "inotify-close"
19943 #: ../fish/guestfish-actions.pod:1577
19951 #: ../fish/guestfish-actions.pod:1583
19952 msgid "inotify-files"
19956 #: ../fish/guestfish-actions.pod:1585
19964 #: ../fish/guestfish-actions.pod:1587
19966 "This function is a helpful wrapper around L</inotify-read> which just "
19967 "returns a list of pathnames of objects that were touched. The returned "
19968 "pathnames are sorted and deduplicated."
19972 #: ../fish/guestfish-actions.pod:1591
19973 msgid "inotify-init"
19977 #: ../fish/guestfish-actions.pod:1593
19980 " inotify-init maxevents\n"
19985 #: ../fish/guestfish-actions.pod:1599
19987 "C<maxevents> is the maximum number of events which will be queued up between "
19988 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
19989 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
19990 "default was 16384 events. Beyond this limit, the kernel throws away events, "
19991 "but records the fact that it threw them away by setting a flag "
19992 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
19996 #: ../fish/guestfish-actions.pod:1609
19998 "Before any events are generated, you have to add some watches to the "
19999 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
20000 "L</inotify-watch-all>."
20004 #: ../fish/guestfish-actions.pod:1615
20006 "Queued up events should be read periodically by calling L</inotify-read> (or "
20007 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
20008 "If you don't read the events out often enough then you risk the internal "
20009 "queue overflowing."
20013 #: ../fish/guestfish-actions.pod:1622
20015 "The handle should be closed after use by calling L</inotify-close>. This "
20016 "also removes any watches automatically."
20020 #: ../fish/guestfish-actions.pod:1631
20021 msgid "inotify-read"
20025 #: ../fish/guestfish-actions.pod:1633
20033 #: ../fish/guestfish-actions.pod:1646
20034 msgid "inotify-rm-watch"
20038 #: ../fish/guestfish-actions.pod:1648
20041 " inotify-rm-watch wd\n"
20046 #: ../fish/guestfish-actions.pod:1650
20047 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
20051 #: ../fish/guestfish-actions.pod:1653
20052 msgid "inspect-get-arch"
20056 #: ../fish/guestfish-actions.pod:1655
20059 " inspect-get-arch root\n"
20064 #: ../fish/guestfish-actions.pod:1657 ../fish/guestfish-actions.pod:1673 ../fish/guestfish-actions.pod:1739 ../fish/guestfish-actions.pod:1757 ../fish/guestfish-actions.pod:1778 ../fish/guestfish-actions.pod:1793 ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1838 ../fish/guestfish-actions.pod:1862 ../fish/guestfish-actions.pod:1892 ../fish/guestfish-actions.pod:1923
20066 "This function should only be called with a root device string as returned by "
20071 #: ../fish/guestfish-actions.pod:1660
20073 "This returns the architecture of the inspected operating system. The "
20074 "possible return values are listed under L</file-architecture>."
20078 #: ../fish/guestfish-actions.pod:1669
20079 msgid "inspect-get-distro"
20083 #: ../fish/guestfish-actions.pod:1671
20086 " inspect-get-distro root\n"
20091 #: ../fish/guestfish-actions.pod:1735
20092 msgid "inspect-get-filesystems"
20096 #: ../fish/guestfish-actions.pod:1737
20099 " inspect-get-filesystems root\n"
20104 #: ../fish/guestfish-actions.pod:1750
20106 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20107 "L</inspect-get-mountpoints>."
20111 #: ../fish/guestfish-actions.pod:1753
20112 msgid "inspect-get-major-version"
20116 #: ../fish/guestfish-actions.pod:1755
20119 " inspect-get-major-version root\n"
20124 #: ../fish/guestfish-actions.pod:1774
20125 msgid "inspect-get-minor-version"
20129 #: ../fish/guestfish-actions.pod:1776
20132 " inspect-get-minor-version root\n"
20137 #: ../fish/guestfish-actions.pod:1786
20139 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20140 "L</inspect-get-major-version>."
20144 #: ../fish/guestfish-actions.pod:1789
20145 msgid "inspect-get-mountpoints"
20149 #: ../fish/guestfish-actions.pod:1791
20152 " inspect-get-mountpoints root\n"
20157 #: ../fish/guestfish-actions.pod:1809
20159 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20160 "L</inspect-get-filesystems>."
20164 #: ../fish/guestfish-actions.pod:1812
20165 msgid "inspect-get-package-format"
20169 #: ../fish/guestfish-actions.pod:1814
20172 " inspect-get-package-format root\n"
20177 #: ../fish/guestfish-actions.pod:1819
20179 "This function and L</inspect-get-package-management> return the package "
20180 "format and package management tool used by the inspected operating system. "
20181 "For example for Fedora these functions would return C<rpm> (package format) "
20182 "and C<yum> (package management)."
20186 #: ../fish/guestfish-actions.pod:1834
20187 msgid "inspect-get-package-management"
20191 #: ../fish/guestfish-actions.pod:1836
20194 " inspect-get-package-management root\n"
20199 #: ../fish/guestfish-actions.pod:1841
20201 "L</inspect-get-package-format> and this function return the package format "
20202 "and package management tool used by the inspected operating system. For "
20203 "example for Fedora these functions would return C<rpm> (package format) and "
20204 "C<yum> (package management)."
20208 #: ../fish/guestfish-actions.pod:1858
20209 msgid "inspect-get-product-name"
20213 #: ../fish/guestfish-actions.pod:1860
20216 " inspect-get-product-name root\n"
20221 #: ../fish/guestfish-actions.pod:1875
20222 msgid "inspect-get-roots"
20226 #: ../fish/guestfish-actions.pod:1877
20229 " inspect-get-roots\n"
20234 #: ../fish/guestfish-actions.pod:1879
20236 "This function is a convenient way to get the list of root devices, as "
20237 "returned from a previous call to L</inspect-os>, but without redoing the "
20238 "whole inspection process."
20242 #: ../fish/guestfish-actions.pod:1883
20244 "This returns an empty list if either no root devices were found or the "
20245 "caller has not called L</inspect-os>."
20249 #: ../fish/guestfish-actions.pod:1888
20250 msgid "inspect-get-type"
20254 #: ../fish/guestfish-actions.pod:1890
20257 " inspect-get-type root\n"
20262 #: ../fish/guestfish-actions.pod:1919
20263 msgid "inspect-get-windows-systemroot"
20267 #: ../fish/guestfish-actions.pod:1921
20270 " inspect-get-windows-systemroot root\n"
20275 #: ../fish/guestfish-actions.pod:1935
20280 #: ../fish/guestfish-actions.pod:1937
20288 #: ../fish/guestfish-actions.pod:1952
20290 "You can pass the root string(s) returned to other L</inspect-get-*> "
20291 "functions in order to query further information about each operating system, "
20292 "such as the name and version."
20296 #: ../fish/guestfish-actions.pod:1957
20298 "This function uses other libguestfs features such as L</mount-ro> and "
20299 "L</umount-all> in order to mount and unmount filesystems and look at the "
20300 "contents. This should be called with no disks currently mounted. The "
20301 "function may also use Augeas, so any existing Augeas handle will be closed."
20305 #: ../fish/guestfish-actions.pod:1969 ../fish/guestfish-actions.pod:2125 ../fish/guestfish-actions.pod:2171
20306 msgid "See also L</list-filesystems>."
20310 #: ../fish/guestfish-actions.pod:1971
20311 msgid "is-blockdev"
20315 #: ../fish/guestfish-actions.pod:1973
20318 " is-blockdev path\n"
20323 #: ../fish/guestfish-actions.pod:1978 ../fish/guestfish-actions.pod:1996 ../fish/guestfish-actions.pod:2015 ../fish/guestfish-actions.pod:2024 ../fish/guestfish-actions.pod:2034 ../fish/guestfish-actions.pod:2068 ../fish/guestfish-actions.pod:2077
20324 msgid "See also L</stat>."
20328 #: ../fish/guestfish-actions.pod:1980
20333 #: ../fish/guestfish-actions.pod:1982
20341 #: ../fish/guestfish-actions.pod:1989
20346 #: ../fish/guestfish-actions.pod:1991
20349 " is-chardev path\n"
20354 #: ../fish/guestfish-actions.pod:1998
20359 #: ../fish/guestfish-actions.pod:2000
20367 #: ../fish/guestfish-actions.pod:2007
20372 #: ../fish/guestfish-actions.pod:2009
20380 #: ../fish/guestfish-actions.pod:2017
20385 #: ../fish/guestfish-actions.pod:2019
20393 #: ../fish/guestfish-actions.pod:2026
20398 #: ../fish/guestfish-actions.pod:2028
20406 #: ../fish/guestfish-actions.pod:2036
20407 msgid "is-launching"
20411 #: ../fish/guestfish-actions.pod:2038
20419 #: ../fish/guestfish-actions.pod:2045
20424 #: ../fish/guestfish-actions.pod:2047
20432 #: ../fish/guestfish-actions.pod:2052
20437 #: ../fish/guestfish-actions.pod:2054
20445 #: ../fish/guestfish-actions.pod:2061
20450 #: ../fish/guestfish-actions.pod:2063
20453 " is-socket path\n"
20458 #: ../fish/guestfish-actions.pod:2070
20463 #: ../fish/guestfish-actions.pod:2072
20466 " is-symlink path\n"
20471 #: ../fish/guestfish-actions.pod:2079
20472 msgid "kill-subprocess"
20476 #: ../fish/guestfish-actions.pod:2081
20479 " kill-subprocess\n"
20484 #: ../fish/guestfish-actions.pod:2085
20489 #: ../fish/guestfish-actions.pod:2087
20494 #: ../fish/guestfish-actions.pod:2089
20502 #: ../fish/guestfish-actions.pod:2097
20507 #: ../fish/guestfish-actions.pod:2099
20510 " lchown owner group path\n"
20515 #: ../fish/guestfish-actions.pod:2101
20517 "Change the file owner to C<owner> and group to C<group>. This is like "
20518 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
20523 #: ../fish/guestfish-actions.pod:2109
20528 #: ../fish/guestfish-actions.pod:2111
20531 " lgetxattrs path\n"
20536 #: ../fish/guestfish-actions.pod:2113
20538 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
20539 "it returns the extended attributes of the link itself."
20543 #: ../fish/guestfish-actions.pod:2117
20544 msgid "list-devices"
20548 #: ../fish/guestfish-actions.pod:2119
20556 #: ../fish/guestfish-actions.pod:2127
20557 msgid "list-filesystems"
20561 #: ../fish/guestfish-actions.pod:2129
20564 " list-filesystems\n"
20569 #: ../fish/guestfish-actions.pod:2148
20571 "This command runs other libguestfs commands, which might include L</mount> "
20572 "and L</umount>, and therefore you should use this soon after launch and only "
20573 "when nothing is mounted."
20577 #: ../fish/guestfish-actions.pod:2152
20579 "Not all of the filesystems returned will be mountable. In particular, swap "
20580 "partitions are returned in the list. Also this command does not check that "
20581 "each filesystem found is valid and mountable, and some filesystems might be "
20582 "mountable but require special options. Filesystems may not all belong to a "
20583 "single logical operating system (use L</inspect-os> to look for OSes)."
20587 #: ../fish/guestfish-actions.pod:2160
20588 msgid "list-partitions"
20592 #: ../fish/guestfish-actions.pod:2162
20595 " list-partitions\n"
20600 #: ../fish/guestfish-actions.pod:2168
20602 "This does not return logical volumes. For that you will need to call "
20607 #: ../fish/guestfish-actions.pod:2173
20612 #: ../fish/guestfish-actions.pod:2175
20620 #: ../fish/guestfish-actions.pod:2183
20625 #: ../fish/guestfish-actions.pod:2185
20628 " ln target linkname\n"
20633 #: ../fish/guestfish-actions.pod:2189
20638 #: ../fish/guestfish-actions.pod:2191
20641 " ln-f target linkname\n"
20646 #: ../fish/guestfish-actions.pod:2196
20651 #: ../fish/guestfish-actions.pod:2198
20654 " ln-s target linkname\n"
20659 #: ../fish/guestfish-actions.pod:2202
20664 #: ../fish/guestfish-actions.pod:2204
20667 " ln-sf target linkname\n"
20672 #: ../fish/guestfish-actions.pod:2209
20673 msgid "lremovexattr"
20677 #: ../fish/guestfish-actions.pod:2211
20680 " lremovexattr xattr path\n"
20685 #: ../fish/guestfish-actions.pod:2213
20687 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
20688 "it removes an extended attribute of the link itself."
20692 #: ../fish/guestfish-actions.pod:2217
20697 #: ../fish/guestfish-actions.pod:2219
20705 #: ../fish/guestfish-actions.pod:2225
20707 "This command is mostly useful for interactive sessions. Programs should "
20708 "probably use L</readdir> instead."
20712 #: ../fish/guestfish-actions.pod:2228
20717 #: ../fish/guestfish-actions.pod:2230
20720 " lsetxattr xattr val vallen path\n"
20725 #: ../fish/guestfish-actions.pod:2232
20727 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
20728 "sets an extended attribute of the link itself."
20732 #: ../fish/guestfish-actions.pod:2236
20737 #: ../fish/guestfish-actions.pod:2238
20745 #: ../fish/guestfish-actions.pod:2242
20747 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
20748 "the link is stat-ed, not the file it refers to."
20752 #: ../fish/guestfish-actions.pod:2248
20757 #: ../fish/guestfish-actions.pod:2250
20760 " lstatlist path 'names ...'\n"
20765 #: ../fish/guestfish-actions.pod:2252
20767 "This call allows you to perform the L</lstat> operation on multiple files, "
20768 "where all files are in the directory C<path>. C<names> is the list of files "
20769 "from this directory."
20773 #: ../fish/guestfish-actions.pod:2261
20775 "This call is intended for programs that want to efficiently list a directory "
20776 "contents without making many round-trips. See also L</lxattrlist> for a "
20777 "similarly efficient call for getting extended attributes. Very long "
20778 "directory listings might cause the protocol message size to be exceeded, "
20779 "causing this call to fail. The caller must split up such requests into "
20780 "smaller groups of names."
20784 #: ../fish/guestfish-actions.pod:2269
20785 msgid "luks-add-key"
20789 #: ../fish/guestfish-actions.pod:2271
20792 " luks-add-key device keyslot\n"
20797 #: ../fish/guestfish-actions.pod:2278
20799 "Note that if C<keyslot> already contains a key, then this command will "
20800 "fail. You have to use L</luks-kill-slot> first to remove that key."
20804 #: ../fish/guestfish-actions.pod:2282 ../fish/guestfish-actions.pod:2304 ../fish/guestfish-actions.pod:2317 ../fish/guestfish-actions.pod:2331 ../fish/guestfish-actions.pod:2354 ../fish/guestfish-actions.pod:2364
20806 "This command has one or more key or passphrase parameters. Guestfish will "
20807 "prompt for these separately."
20811 #: ../fish/guestfish-actions.pod:2285
20816 #: ../fish/guestfish-actions.pod:2287
20819 " luks-close device\n"
20824 #: ../fish/guestfish-actions.pod:2289
20826 "This closes a LUKS device that was created earlier by L</luks-open> or "
20827 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
20828 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
20829 "underlying block device."
20833 #: ../fish/guestfish-actions.pod:2295
20834 msgid "luks-format"
20838 #: ../fish/guestfish-actions.pod:2297
20841 " luks-format device keyslot\n"
20846 #: ../fish/guestfish-actions.pod:2310
20847 msgid "luks-format-cipher"
20851 #: ../fish/guestfish-actions.pod:2312
20854 " luks-format-cipher device keyslot cipher\n"
20859 #: ../fish/guestfish-actions.pod:2314
20861 "This command is the same as L</luks-format> but it also allows you to set "
20862 "the C<cipher> used."
20866 #: ../fish/guestfish-actions.pod:2323
20867 msgid "luks-kill-slot"
20871 #: ../fish/guestfish-actions.pod:2325
20874 " luks-kill-slot device keyslot\n"
20879 #: ../fish/guestfish-actions.pod:2334
20884 #: ../fish/guestfish-actions.pod:2336
20887 " luks-open device mapname\n"
20892 #: ../fish/guestfish-actions.pod:2350
20894 "If this block device contains LVM volume groups, then calling L</vgscan> "
20895 "followed by L</vg-activate-all> will make them visible."
20899 #: ../fish/guestfish-actions.pod:2357
20900 msgid "luks-open-ro"
20904 #: ../fish/guestfish-actions.pod:2359
20907 " luks-open-ro device mapname\n"
20912 #: ../fish/guestfish-actions.pod:2361
20914 "This is the same as L</luks-open> except that a read-only mapping is "
20919 #: ../fish/guestfish-actions.pod:2367
20924 #: ../fish/guestfish-actions.pod:2369
20927 " lvcreate logvol volgroup mbytes\n"
20932 #: ../fish/guestfish-actions.pod:2374
20933 msgid "lvm-canonical-lv-name"
20937 #: ../fish/guestfish-actions.pod:2376
20940 " lvm-canonical-lv-name lvname\n"
20945 #: ../fish/guestfish-actions.pod:2385
20946 msgid "See also L</is-lv>."
20950 #: ../fish/guestfish-actions.pod:2387
20951 msgid "lvm-clear-filter"
20955 #: ../fish/guestfish-actions.pod:2389
20958 " lvm-clear-filter\n"
20963 #: ../fish/guestfish-actions.pod:2391
20965 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
20970 #: ../fish/guestfish-actions.pod:2397
20971 msgid "lvm-remove-all"
20975 #: ../fish/guestfish-actions.pod:2399
20978 " lvm-remove-all\n"
20983 #: ../fish/guestfish-actions.pod:2407
20984 msgid "lvm-set-filter"
20988 #: ../fish/guestfish-actions.pod:2409
20991 " lvm-set-filter 'devices ...'\n"
20996 #: ../fish/guestfish-actions.pod:2434
21001 #: ../fish/guestfish-actions.pod:2436
21004 " lvremove device\n"
21009 #: ../fish/guestfish-actions.pod:2444
21014 #: ../fish/guestfish-actions.pod:2446
21017 " lvrename logvol newlogvol\n"
21022 #: ../fish/guestfish-actions.pod:2450
21027 #: ../fish/guestfish-actions.pod:2452
21030 " lvresize device mbytes\n"
21035 #: ../fish/guestfish-actions.pod:2458
21036 msgid "lvresize-free"
21040 #: ../fish/guestfish-actions.pod:2460
21043 " lvresize-free lv percent\n"
21048 #: ../fish/guestfish-actions.pod:2468
21053 #: ../fish/guestfish-actions.pod:2470
21061 #: ../fish/guestfish-actions.pod:2478
21062 msgid "See also L</lvs-full>, L</list-filesystems>."
21066 #: ../fish/guestfish-actions.pod:2480
21071 #: ../fish/guestfish-actions.pod:2482
21079 #: ../fish/guestfish-actions.pod:2487
21084 #: ../fish/guestfish-actions.pod:2489
21092 #: ../fish/guestfish-actions.pod:2493
21097 #: ../fish/guestfish-actions.pod:2495
21100 " lxattrlist path 'names ...'\n"
21105 #: ../fish/guestfish-actions.pod:2511
21107 "This call is intended for programs that want to efficiently list a directory "
21108 "contents without making many round-trips. See also L</lstatlist> for a "
21109 "similarly efficient call for getting standard stats. Very long directory "
21110 "listings might cause the protocol message size to be exceeded, causing this "
21111 "call to fail. The caller must split up such requests into smaller groups of "
21116 #: ../fish/guestfish-actions.pod:2519
21121 #: ../fish/guestfish-actions.pod:2521
21129 #: ../fish/guestfish-actions.pod:2525
21134 #: ../fish/guestfish-actions.pod:2527
21137 " mkdir-mode path mode\n"
21142 #: ../fish/guestfish-actions.pod:2536
21143 msgid "See also L</mkdir>, L</umask>"
21147 #: ../fish/guestfish-actions.pod:2538
21152 #: ../fish/guestfish-actions.pod:2540
21160 #: ../fish/guestfish-actions.pod:2545
21165 #: ../fish/guestfish-actions.pod:2547
21168 " mkdtemp template\n"
21173 #: ../fish/guestfish-actions.pod:2568
21178 #: ../fish/guestfish-actions.pod:2570
21181 " mke2fs-J fstype blocksize device journal\n"
21186 #: ../fish/guestfish-actions.pod:2578
21187 msgid "See also L</mke2journal>."
21191 #: ../fish/guestfish-actions.pod:2580
21196 #: ../fish/guestfish-actions.pod:2582
21199 " mke2fs-JL fstype blocksize device label\n"
21204 #: ../fish/guestfish-actions.pod:2587
21205 msgid "See also L</mke2journal-L>."
21209 #: ../fish/guestfish-actions.pod:2589
21214 #: ../fish/guestfish-actions.pod:2591
21217 " mke2fs-JU fstype blocksize device uuid\n"
21222 #: ../fish/guestfish-actions.pod:2596
21223 msgid "See also L</mke2journal-U>."
21227 #: ../fish/guestfish-actions.pod:2598
21228 msgid "mke2journal"
21232 #: ../fish/guestfish-actions.pod:2600
21235 " mke2journal blocksize device\n"
21240 #: ../fish/guestfish-actions.pod:2607
21241 msgid "mke2journal-L"
21245 #: ../fish/guestfish-actions.pod:2609
21248 " mke2journal-L blocksize label device\n"
21253 #: ../fish/guestfish-actions.pod:2613
21254 msgid "mke2journal-U"
21258 #: ../fish/guestfish-actions.pod:2615
21261 " mke2journal-U blocksize uuid device\n"
21266 #: ../fish/guestfish-actions.pod:2619
21271 #: ../fish/guestfish-actions.pod:2621
21274 " mkfifo mode path\n"
21279 #: ../fish/guestfish-actions.pod:2623
21281 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
21282 "is just a convenient wrapper around L</mknod>."
21286 #: ../fish/guestfish-actions.pod:2629
21291 #: ../fish/guestfish-actions.pod:2631
21294 " mkfs fstype device\n"
21299 #: ../fish/guestfish-actions.pod:2637
21304 #: ../fish/guestfish-actions.pod:2639
21307 " mkfs-b fstype blocksize device\n"
21312 #: ../fish/guestfish-actions.pod:2641
21314 "This call is similar to L</mkfs>, but it allows you to control the block "
21315 "size of the resulting filesystem. Supported block sizes depend on the "
21316 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
21320 #: ../fish/guestfish-actions.pod:2649
21321 msgid "mkmountpoint"
21325 #: ../fish/guestfish-actions.pod:2651
21328 " mkmountpoint exemptpath\n"
21333 #: ../fish/guestfish-actions.pod:2653
21335 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
21336 "to create extra mountpoints before mounting the first filesystem."
21340 #: ../fish/guestfish-actions.pod:2677
21342 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
21343 "unexpected errors if you try to mix these calls. It is safest to manually "
21344 "unmount filesystems and remove mountpoints after use."
21348 #: ../fish/guestfish-actions.pod:2681
21350 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
21351 "for this to work for manual mountpoints, you must ensure that the innermost "
21352 "mountpoints have the longest pathnames, as in the example code above."
21356 #: ../fish/guestfish-actions.pod:2688
21358 "Autosync [see L</set-autosync>, this is set by default on handles] means "
21359 "that L</umount-all> is called when the handle is closed which can also "
21360 "trigger these issues."
21364 #: ../fish/guestfish-actions.pod:2692
21369 #: ../fish/guestfish-actions.pod:2694
21372 " mknod mode devmajor devminor path\n"
21377 #: ../fish/guestfish-actions.pod:2704
21379 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
21380 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
21381 "regular file). These constants are available in the standard Linux header "
21382 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
21383 "wrappers around this command which bitwise OR in the appropriate constant "
21388 #: ../fish/guestfish-actions.pod:2714
21393 #: ../fish/guestfish-actions.pod:2716
21396 " mknod-b mode devmajor devminor path\n"
21401 #: ../fish/guestfish-actions.pod:2718
21403 "This call creates a block device node called C<path> with mode C<mode> and "
21404 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
21405 "wrapper around L</mknod>."
21409 #: ../fish/guestfish-actions.pod:2724
21414 #: ../fish/guestfish-actions.pod:2726
21417 " mknod-c mode devmajor devminor path\n"
21422 #: ../fish/guestfish-actions.pod:2728
21424 "This call creates a char device node called C<path> with mode C<mode> and "
21425 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
21426 "wrapper around L</mknod>."
21430 #: ../fish/guestfish-actions.pod:2734
21435 #: ../fish/guestfish-actions.pod:2736
21443 #: ../fish/guestfish-actions.pod:2740
21448 #: ../fish/guestfish-actions.pod:2742
21451 " mkswap-L label device\n"
21456 #: ../fish/guestfish-actions.pod:2750
21461 #: ../fish/guestfish-actions.pod:2752
21464 " mkswap-U uuid device\n"
21469 #: ../fish/guestfish-actions.pod:2756
21470 msgid "mkswap-file"
21474 #: ../fish/guestfish-actions.pod:2758
21477 " mkswap-file path\n"
21482 #: ../fish/guestfish-actions.pod:2762
21484 "This command just writes a swap file signature to an existing file. To "
21485 "create the file itself, use something like L</fallocate>."
21489 #: ../fish/guestfish-actions.pod:2765
21494 #: ../fish/guestfish-actions.pod:2767
21497 " modprobe modulename\n"
21502 #: ../fish/guestfish-actions.pod:2774
21507 #: ../fish/guestfish-actions.pod:2776
21510 " mount device mountpoint\n"
21515 #: ../fish/guestfish-actions.pod:2792
21517 "B<Important note:> When you use this call, the filesystem options C<sync> "
21518 "and C<noatime> are set implicitly. This was originally done because we "
21519 "thought it would improve reliability, but it turns out that I<-o sync> has a "
21520 "very large negative performance impact and negligible effect on "
21521 "reliability. Therefore we recommend that you avoid using L</mount> in any "
21522 "code that needs performance, and instead use L</mount-options> (use an empty "
21523 "string for the first parameter if you don't want any options)."
21527 #: ../fish/guestfish-actions.pod:2802
21532 #: ../fish/guestfish-actions.pod:2804
21535 " mount-loop file mountpoint\n"
21540 #: ../fish/guestfish-actions.pod:2810
21541 msgid "mount-options"
21545 #: ../fish/guestfish-actions.pod:2812
21548 " mount-options options device mountpoint\n"
21553 #: ../fish/guestfish-actions.pod:2814
21555 "This is the same as the L</mount> command, but it allows you to set the "
21556 "mount options as for the L<mount(8)> I<-o> flag."
21560 #: ../fish/guestfish-actions.pod:2822
21565 #: ../fish/guestfish-actions.pod:2824
21568 " mount-ro device mountpoint\n"
21573 #: ../fish/guestfish-actions.pod:2826
21575 "This is the same as the L</mount> command, but it mounts the filesystem with "
21576 "the read-only (I<-o ro>) flag."
21580 #: ../fish/guestfish-actions.pod:2829
21585 #: ../fish/guestfish-actions.pod:2831
21588 " mount-vfs options vfstype device mountpoint\n"
21593 #: ../fish/guestfish-actions.pod:2833
21595 "This is the same as the L</mount> command, but it allows you to set both the "
21596 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
21600 #: ../fish/guestfish-actions.pod:2837
21601 msgid "mountpoints"
21605 #: ../fish/guestfish-actions.pod:2839
21613 #: ../fish/guestfish-actions.pod:2841
21615 "This call is similar to L</mounts>. That call returns a list of devices. "
21616 "This one returns a hash table (map) of device name to directory where the "
21617 "device is mounted."
21621 #: ../fish/guestfish-actions.pod:2845
21626 #: ../fish/guestfish-actions.pod:2847
21634 #: ../fish/guestfish-actions.pod:2854
21635 msgid "See also: L</mountpoints>"
21639 #: ../fish/guestfish-actions.pod:2856
21644 #: ../fish/guestfish-actions.pod:2858
21652 #: ../fish/guestfish-actions.pod:2863
21653 msgid "ntfs-3g-probe"
21657 #: ../fish/guestfish-actions.pod:2865
21660 " ntfs-3g-probe true|false device\n"
21665 #: ../fish/guestfish-actions.pod:2879
21670 #: ../fish/guestfish-actions.pod:2881
21673 " ntfsresize device\n"
21678 #: ../fish/guestfish-actions.pod:2887
21679 msgid "ntfsresize-size"
21683 #: ../fish/guestfish-actions.pod:2889
21686 " ntfsresize-size device size\n"
21691 #: ../fish/guestfish-actions.pod:2891
21693 "This command is the same as L</ntfsresize> except that it allows you to "
21694 "specify the new size (in bytes) explicitly."
21698 #: ../fish/guestfish-actions.pod:2894
21703 #: ../fish/guestfish-actions.pod:2896
21706 " part-add device prlogex startsect endsect\n"
21711 #: ../fish/guestfish-actions.pod:2898
21713 "This command adds a partition to C<device>. If there is no partition table "
21714 "on the device, call L</part-init> first."
21718 #: ../fish/guestfish-actions.pod:2910
21720 "Creating a partition which covers the whole disk is not so easy. Use "
21721 "L</part-disk> to do that."
21725 #: ../fish/guestfish-actions.pod:2913
21730 #: ../fish/guestfish-actions.pod:2915
21733 " part-del device partnum\n"
21738 #: ../fish/guestfish-actions.pod:2923
21743 #: ../fish/guestfish-actions.pod:2925
21746 " part-disk device parttype\n"
21751 #: ../fish/guestfish-actions.pod:2927
21753 "This command is simply a combination of L</part-init> followed by "
21754 "L</part-add> to create a single primary partition covering the whole disk."
21758 #: ../fish/guestfish-actions.pod:2931
21760 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
21761 "possible values are described in L</part-init>."
21765 #: ../fish/guestfish-actions.pod:2937
21766 msgid "part-get-bootable"
21770 #: ../fish/guestfish-actions.pod:2939
21773 " part-get-bootable device partnum\n"
21778 #: ../fish/guestfish-actions.pod:2944
21779 msgid "See also L</part-set-bootable>."
21783 #: ../fish/guestfish-actions.pod:2946
21784 msgid "part-get-mbr-id"
21788 #: ../fish/guestfish-actions.pod:2948
21791 " part-get-mbr-id device partnum\n"
21796 #: ../fish/guestfish-actions.pod:2953 ../fish/guestfish-actions.pod:3091
21798 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
21799 "undefined results for other partition table types (see "
21800 "L</part-get-parttype>)."
21804 #: ../fish/guestfish-actions.pod:2957
21805 msgid "part-get-parttype"
21809 #: ../fish/guestfish-actions.pod:2959
21812 " part-get-parttype device\n"
21817 #: ../fish/guestfish-actions.pod:2964
21819 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
21820 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
21821 "possible, although unusual. See L</part-init> for a full list."
21825 #: ../fish/guestfish-actions.pod:2969
21830 #: ../fish/guestfish-actions.pod:2971
21833 " part-init device parttype\n"
21838 #: ../fish/guestfish-actions.pod:2977
21840 "Initially there are no partitions. Following this, you should call "
21841 "L</part-add> for each partition required."
21845 #: ../fish/guestfish-actions.pod:3040
21850 #: ../fish/guestfish-actions.pod:3042
21853 " part-list device\n"
21858 #: ../fish/guestfish-actions.pod:3057
21860 "Start of the partition I<in bytes>. To get sectors you have to divide by "
21861 "the device's sector size, see L</blockdev-getss>."
21865 #: ../fish/guestfish-actions.pod:3070
21866 msgid "part-set-bootable"
21870 #: ../fish/guestfish-actions.pod:3072
21873 " part-set-bootable device partnum true|false\n"
21878 #: ../fish/guestfish-actions.pod:3081
21879 msgid "part-set-mbr-id"
21883 #: ../fish/guestfish-actions.pod:3083
21886 " part-set-mbr-id device partnum idbyte\n"
21891 #: ../fish/guestfish-actions.pod:3095
21892 msgid "part-set-name"
21896 #: ../fish/guestfish-actions.pod:3097
21899 " part-set-name device partnum name\n"
21904 #: ../fish/guestfish-actions.pod:3105
21905 msgid "part-to-dev"
21909 #: ../fish/guestfish-actions.pod:3107
21912 " part-to-dev partition\n"
21917 #: ../fish/guestfish-actions.pod:3113
21919 "The named partition must exist, for example as a string returned from "
21920 "L</list-partitions>."
21924 #: ../fish/guestfish-actions.pod:3116
21925 msgid "ping-daemon"
21929 #: ../fish/guestfish-actions.pod:3118
21937 #: ../fish/guestfish-actions.pod:3125
21942 #: ../fish/guestfish-actions.pod:3127
21945 " pread path count offset\n"
21950 #: ../fish/guestfish-actions.pod:3135
21951 msgid "See also L</pwrite>, L</pread-device>."
21955 #: ../fish/guestfish-actions.pod:3140
21956 msgid "pread-device"
21960 #: ../fish/guestfish-actions.pod:3142
21963 " pread-device device count offset\n"
21968 #: ../fish/guestfish-actions.pod:3150
21969 msgid "See also L</pread>."
21973 #: ../fish/guestfish-actions.pod:3155
21978 #: ../fish/guestfish-actions.pod:3157
21981 " pvcreate device\n"
21986 #: ../fish/guestfish-actions.pod:3163
21991 #: ../fish/guestfish-actions.pod:3165
21994 " pvremove device\n"
21999 #: ../fish/guestfish-actions.pod:3174
22004 #: ../fish/guestfish-actions.pod:3176
22007 " pvresize device\n"
22012 #: ../fish/guestfish-actions.pod:3181
22013 msgid "pvresize-size"
22017 #: ../fish/guestfish-actions.pod:3183
22020 " pvresize-size device size\n"
22025 #: ../fish/guestfish-actions.pod:3185
22027 "This command is the same as L</pvresize> except that it allows you to "
22028 "specify the new size (in bytes) explicitly."
22032 #: ../fish/guestfish-actions.pod:3188
22037 #: ../fish/guestfish-actions.pod:3190
22045 #: ../fish/guestfish-actions.pod:3198
22046 msgid "See also L</pvs-full>."
22050 #: ../fish/guestfish-actions.pod:3200
22055 #: ../fish/guestfish-actions.pod:3202
22063 #: ../fish/guestfish-actions.pod:3207
22068 #: ../fish/guestfish-actions.pod:3209
22076 #: ../fish/guestfish-actions.pod:3213
22081 #: ../fish/guestfish-actions.pod:3215
22084 " pwrite path content offset\n"
22089 #: ../fish/guestfish-actions.pod:3226
22090 msgid "See also L</pread>, L</pwrite-device>."
22094 #: ../fish/guestfish-actions.pod:3231
22095 msgid "pwrite-device"
22099 #: ../fish/guestfish-actions.pod:3233
22102 " pwrite-device device content offset\n"
22107 #: ../fish/guestfish-actions.pod:3243
22108 msgid "See also L</pwrite>."
22112 #: ../fish/guestfish-actions.pod:3248
22117 #: ../fish/guestfish-actions.pod:3250
22120 " read-file path\n"
22125 #: ../fish/guestfish-actions.pod:3255
22127 "Unlike L</cat>, this function can correctly handle files that contain "
22128 "embedded ASCII NUL characters. However unlike L</download>, this function "
22129 "is limited in the total size of file that can be handled."
22133 #: ../fish/guestfish-actions.pod:3263
22138 #: ../fish/guestfish-actions.pod:3265
22141 " read-lines path\n"
22146 #: ../fish/guestfish-actions.pod:3272
22148 "Note that this function cannot correctly handle binary files (specifically, "
22149 "files containing C<\\0> character which is treated as end of line). For "
22150 "those you need to use the L</read-file> function which has a more complex "
22155 #: ../fish/guestfish-actions.pod:3277
22160 #: ../fish/guestfish-actions.pod:3279
22168 #: ../fish/guestfish-actions.pod:3331
22170 "This function is primarily intended for use by programs. To get a simple "
22171 "list of names, use L</ls>. To get a printable directory for human "
22172 "consumption, use L</ll>."
22176 #: ../fish/guestfish-actions.pod:3335
22181 #: ../fish/guestfish-actions.pod:3337
22189 #: ../fish/guestfish-actions.pod:3341
22190 msgid "readlinklist"
22194 #: ../fish/guestfish-actions.pod:3343
22197 " readlinklist path 'names ...'\n"
22202 #: ../fish/guestfish-actions.pod:3367
22207 #: ../fish/guestfish-actions.pod:3369
22215 #: ../fish/guestfish-actions.pod:3374
22216 msgid "removexattr"
22220 #: ../fish/guestfish-actions.pod:3376
22223 " removexattr xattr path\n"
22228 #: ../fish/guestfish-actions.pod:3381
22229 msgid "See also: L</lremovexattr>, L<attr(5)>."
22233 #: ../fish/guestfish-actions.pod:3383
22238 #: ../fish/guestfish-actions.pod:3385
22241 " resize2fs device\n"
22246 #: ../fish/guestfish-actions.pod:3390
22248 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
22249 "before calling this command. For unknown reasons C<resize2fs> sometimes "
22250 "gives an error about this and sometimes not. In any case, it is always safe "
22251 "to call L</e2fsck-f> before calling this function."
22255 #: ../fish/guestfish-actions.pod:3396
22256 msgid "resize2fs-size"
22260 #: ../fish/guestfish-actions.pod:3398
22263 " resize2fs-size device size\n"
22268 #: ../fish/guestfish-actions.pod:3400
22270 "This command is the same as L</resize2fs> except that it allows you to "
22271 "specify the new size (in bytes) explicitly."
22275 #: ../fish/guestfish-actions.pod:3403
22280 #: ../fish/guestfish-actions.pod:3405
22288 #: ../fish/guestfish-actions.pod:3409
22293 #: ../fish/guestfish-actions.pod:3411
22301 #: ../fish/guestfish-actions.pod:3417
22306 #: ../fish/guestfish-actions.pod:3419
22314 #: ../fish/guestfish-actions.pod:3423
22315 msgid "rmmountpoint"
22319 #: ../fish/guestfish-actions.pod:3425
22322 " rmmountpoint exemptpath\n"
22327 #: ../fish/guestfish-actions.pod:3427
22329 "This calls removes a mountpoint that was previously created with "
22330 "L</mkmountpoint>. See L</mkmountpoint> for full details."
22334 #: ../fish/guestfish-actions.pod:3431
22335 msgid "scrub-device"
22339 #: ../fish/guestfish-actions.pod:3433
22342 " scrub-device device\n"
22347 #: ../fish/guestfish-actions.pod:3444
22352 #: ../fish/guestfish-actions.pod:3446
22355 " scrub-file file\n"
22360 #: ../fish/guestfish-actions.pod:3456
22361 msgid "scrub-freespace"
22365 #: ../fish/guestfish-actions.pod:3458
22368 " scrub-freespace dir\n"
22373 #: ../fish/guestfish-actions.pod:3460
22375 "This command creates the directory C<dir> and then fills it with files until "
22376 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
22377 "deletes them. The intention is to scrub any free space on the partition "
22378 "containing C<dir>."
22382 #: ../fish/guestfish-actions.pod:3469
22387 #: ../fish/guestfish-actions.pod:3471
22392 #: ../fish/guestfish-actions.pod:3473
22395 " set-append append\n"
22400 #: ../fish/guestfish-actions.pod:3484
22401 msgid "set-autosync"
22405 #: ../fish/guestfish-actions.pod:3486
22410 #: ../fish/guestfish-actions.pod:3488
22413 " set-autosync true|false\n"
22418 #: ../fish/guestfish-actions.pod:3490
22420 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
22421 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
22422 "closed (also if the program exits without closing handles)."
22426 #: ../fish/guestfish-actions.pod:3498
22431 #: ../fish/guestfish-actions.pod:3500
22436 #: ../fish/guestfish-actions.pod:3502
22439 " set-direct true|false\n"
22444 #: ../fish/guestfish-actions.pod:3508
22446 "One consequence of this is that log messages aren't caught by the library "
22447 "and handled by L</set-log-message-callback>, but go straight to stdout."
22451 #: ../fish/guestfish-actions.pod:3517
22452 msgid "set-e2label"
22456 #: ../fish/guestfish-actions.pod:3519
22459 " set-e2label device label\n"
22464 #: ../fish/guestfish-actions.pod:3525
22466 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
22467 "label on a filesystem."
22471 #: ../fish/guestfish-actions.pod:3528
22476 #: ../fish/guestfish-actions.pod:3530
22479 " set-e2uuid device uuid\n"
22484 #: ../fish/guestfish-actions.pod:3537
22486 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
22487 "UUID of a filesystem."
22491 #: ../fish/guestfish-actions.pod:3540
22492 msgid "set-memsize"
22496 #: ../fish/guestfish-actions.pod:3542
22501 #: ../fish/guestfish-actions.pod:3544
22504 " set-memsize memsize\n"
22509 #: ../fish/guestfish-actions.pod:3546
22511 "This sets the memory size in megabytes allocated to the qemu subprocess. "
22512 "This only has any effect if called before L</launch>."
22516 #: ../fish/guestfish-actions.pod:3557
22517 msgid "set-network"
22521 #: ../fish/guestfish-actions.pod:3559
22526 #: ../fish/guestfish-actions.pod:3561
22529 " set-network true|false\n"
22534 #: ../fish/guestfish-actions.pod:3569
22535 msgid "You must call this before calling L</launch>, otherwise it has no effect."
22539 #: ../fish/guestfish-actions.pod:3572
22544 #: ../fish/guestfish-actions.pod:3574
22549 #: ../fish/guestfish-actions.pod:3576
22552 " set-path searchpath\n"
22557 #: ../fish/guestfish-actions.pod:3585
22562 #: ../fish/guestfish-actions.pod:3587
22567 #: ../fish/guestfish-actions.pod:3589
22575 #: ../fish/guestfish-actions.pod:3609
22576 msgid "set-recovery-proc"
22580 #: ../fish/guestfish-actions.pod:3611
22581 msgid "recovery-proc"
22585 #: ../fish/guestfish-actions.pod:3613
22588 " set-recovery-proc true|false\n"
22593 #: ../fish/guestfish-actions.pod:3615
22595 "If this is called with the parameter C<false> then L</launch> does not "
22596 "create a recovery process. The purpose of the recovery process is to stop "
22597 "runaway qemu processes in the case where the main program aborts abruptly."
22601 #: ../fish/guestfish-actions.pod:3620
22603 "This only has any effect if called before L</launch>, and the default is "
22608 #: ../fish/guestfish-actions.pod:3629
22609 msgid "set-selinux"
22613 #: ../fish/guestfish-actions.pod:3631
22618 #: ../fish/guestfish-actions.pod:3633
22621 " set-selinux true|false\n"
22626 #: ../fish/guestfish-actions.pod:3644
22631 #: ../fish/guestfish-actions.pod:3646
22636 #: ../fish/guestfish-actions.pod:3648
22639 " set-trace true|false\n"
22644 #: ../fish/guestfish-actions.pod:3664
22645 msgid "set-verbose"
22649 #: ../fish/guestfish-actions.pod:3666
22654 #: ../fish/guestfish-actions.pod:3668
22657 " set-verbose true|false\n"
22662 #: ../fish/guestfish-actions.pod:3675
22667 #: ../fish/guestfish-actions.pod:3677
22670 " setcon context\n"
22675 #: ../fish/guestfish-actions.pod:3684
22680 #: ../fish/guestfish-actions.pod:3686
22683 " setxattr xattr val vallen path\n"
22688 #: ../fish/guestfish-actions.pod:3692
22689 msgid "See also: L</lsetxattr>, L<attr(5)>."
22693 #: ../fish/guestfish-actions.pod:3694
22698 #: ../fish/guestfish-actions.pod:3696
22701 " sfdisk device cyls heads sectors 'lines ...'\n"
22706 #: ../fish/guestfish-actions.pod:3718
22707 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
22711 #: ../fish/guestfish-actions.pod:3724
22716 #: ../fish/guestfish-actions.pod:3726
22719 " sfdiskM device 'lines ...'\n"
22724 #: ../fish/guestfish-actions.pod:3728
22726 "This is a simplified interface to the L</sfdisk> command, where partition "
22727 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
22728 "you don't need to specify the cyls, heads and sectors parameters which were "
22729 "rarely if ever used anyway."
22733 #: ../fish/guestfish-actions.pod:3734
22734 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
22738 #: ../fish/guestfish-actions.pod:3740
22743 #: ../fish/guestfish-actions.pod:3742
22746 " sfdisk-N device partnum cyls heads sectors line\n"
22751 #: ../fish/guestfish-actions.pod:3747
22753 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
22754 "cyls/heads/sectors parameters."
22758 #: ../fish/guestfish-actions.pod:3750
22759 msgid "See also: L</part-add>"
22763 #: ../fish/guestfish-actions.pod:3755
22764 msgid "sfdisk-disk-geometry"
22768 #: ../fish/guestfish-actions.pod:3757
22771 " sfdisk-disk-geometry device\n"
22776 #: ../fish/guestfish-actions.pod:3759
22778 "This displays the disk geometry of C<device> read from the partition table. "
22779 "Especially in the case where the underlying block device has been resized, "
22780 "this can be different from the kernel's idea of the geometry (see "
22781 "L</sfdisk-kernel-geometry>)."
22785 #: ../fish/guestfish-actions.pod:3767
22786 msgid "sfdisk-kernel-geometry"
22790 #: ../fish/guestfish-actions.pod:3769
22793 " sfdisk-kernel-geometry device\n"
22798 #: ../fish/guestfish-actions.pod:3776
22803 #: ../fish/guestfish-actions.pod:3778
22806 " sfdisk-l device\n"
22811 #: ../fish/guestfish-actions.pod:3784
22812 msgid "See also: L</part-list>"
22816 #: ../fish/guestfish-actions.pod:3786
22821 #: ../fish/guestfish-actions.pod:3788
22829 #: ../fish/guestfish-actions.pod:3793
22830 msgid "This is like L</command>, but passes the command to:"
22834 #: ../fish/guestfish-actions.pod:3801
22835 msgid "All the provisos about L</command> apply to this call."
22839 #: ../fish/guestfish-actions.pod:3803
22844 #: ../fish/guestfish-actions.pod:3805
22847 " sh-lines command\n"
22852 #: ../fish/guestfish-actions.pod:3807
22853 msgid "This is the same as L</sh>, but splits the result into a list of lines."
22857 #: ../fish/guestfish-actions.pod:3810
22858 msgid "See also: L</command-lines>"
22862 #: ../fish/guestfish-actions.pod:3812
22867 #: ../fish/guestfish-actions.pod:3814
22875 #: ../fish/guestfish-actions.pod:3818
22880 #: ../fish/guestfish-actions.pod:3820
22888 #: ../fish/guestfish-actions.pod:3826
22893 #: ../fish/guestfish-actions.pod:3828
22901 #: ../fish/guestfish-actions.pod:3836
22906 #: ../fish/guestfish-actions.pod:3838
22914 #: ../fish/guestfish-actions.pod:3846
22919 #: ../fish/guestfish-actions.pod:3848
22922 " strings-e encoding path\n"
22927 #: ../fish/guestfish-actions.pod:3850
22929 "This is like the L</strings> command, but allows you to specify the encoding "
22930 "of strings that are looked for in the source file C<path>."
22934 #: ../fish/guestfish-actions.pod:3860
22936 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
22937 "ISO-8859-X (this is what L</strings> uses)."
22941 #: ../fish/guestfish-actions.pod:3892
22942 msgid "swapoff-device"
22946 #: ../fish/guestfish-actions.pod:3894
22949 " swapoff-device device\n"
22954 #: ../fish/guestfish-actions.pod:3896
22956 "This command disables the libguestfs appliance swap device or partition "
22957 "named C<device>. See L</swapon-device>."
22961 #: ../fish/guestfish-actions.pod:3900
22962 msgid "swapoff-file"
22966 #: ../fish/guestfish-actions.pod:3902
22969 " swapoff-file file\n"
22974 #: ../fish/guestfish-actions.pod:3906
22975 msgid "swapoff-label"
22979 #: ../fish/guestfish-actions.pod:3908
22982 " swapoff-label label\n"
22987 #: ../fish/guestfish-actions.pod:3913
22988 msgid "swapoff-uuid"
22992 #: ../fish/guestfish-actions.pod:3915
22995 " swapoff-uuid uuid\n"
23000 #: ../fish/guestfish-actions.pod:3920
23001 msgid "swapon-device"
23005 #: ../fish/guestfish-actions.pod:3922
23008 " swapon-device device\n"
23013 #: ../fish/guestfish-actions.pod:3924
23015 "This command enables the libguestfs appliance to use the swap device or "
23016 "partition named C<device>. The increased memory is made available for all "
23017 "commands, for example those run using L</command> or L</sh>."
23021 #: ../fish/guestfish-actions.pod:3936
23022 msgid "swapon-file"
23026 #: ../fish/guestfish-actions.pod:3938
23029 " swapon-file file\n"
23034 #: ../fish/guestfish-actions.pod:3940
23035 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
23039 #: ../fish/guestfish-actions.pod:3943
23040 msgid "swapon-label"
23044 #: ../fish/guestfish-actions.pod:3945
23047 " swapon-label label\n"
23052 #: ../fish/guestfish-actions.pod:3947
23054 "This command enables swap to a labeled swap partition. See "
23055 "L</swapon-device> for other notes."
23059 #: ../fish/guestfish-actions.pod:3950
23060 msgid "swapon-uuid"
23064 #: ../fish/guestfish-actions.pod:3952
23067 " swapon-uuid uuid\n"
23072 #: ../fish/guestfish-actions.pod:3954
23074 "This command enables swap to a swap partition with the given UUID. See "
23075 "L</swapon-device> for other notes."
23079 #: ../fish/guestfish-actions.pod:3957
23084 #: ../fish/guestfish-actions.pod:3959
23092 #: ../fish/guestfish-actions.pod:3967
23097 #: ../fish/guestfish-actions.pod:3969
23105 #: ../fish/guestfish-actions.pod:3977
23110 #: ../fish/guestfish-actions.pod:3979
23113 " tail-n nrlines path\n"
23118 #: ../fish/guestfish-actions.pod:3992
23123 #: ../fish/guestfish-actions.pod:3994
23126 " tar-in (tarfile|-) directory\n"
23131 #: ../fish/guestfish-actions.pod:3999
23132 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
23136 #: ../fish/guestfish-actions.pod:4004
23141 #: ../fish/guestfish-actions.pod:4006
23144 " tar-out directory (tarfile|-)\n"
23149 #: ../fish/guestfish-actions.pod:4011
23150 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
23154 #: ../fish/guestfish-actions.pod:4016
23159 #: ../fish/guestfish-actions.pod:4018
23162 " tgz-in (tarball|-) directory\n"
23167 #: ../fish/guestfish-actions.pod:4023
23168 msgid "To upload an uncompressed tarball, use L</tar-in>."
23172 #: ../fish/guestfish-actions.pod:4027
23177 #: ../fish/guestfish-actions.pod:4029
23180 " tgz-out directory (tarball|-)\n"
23185 #: ../fish/guestfish-actions.pod:4034
23186 msgid "To download an uncompressed tarball, use L</tar-out>."
23190 #: ../fish/guestfish-actions.pod:4038
23195 #: ../fish/guestfish-actions.pod:4040
23203 #: ../fish/guestfish-actions.pod:4049
23208 #: ../fish/guestfish-actions.pod:4051
23216 #: ../fish/guestfish-actions.pod:4056
23217 msgid "truncate-size"
23221 #: ../fish/guestfish-actions.pod:4058
23224 " truncate-size path size\n"
23229 #: ../fish/guestfish-actions.pod:4063
23231 "If the current file size is less than C<size> then the file is extended to "
23232 "the required size with zero bytes. This creates a sparse file (ie. disk "
23233 "blocks are not allocated for the file until you write to it). To create a "
23234 "non-sparse file of zeroes, use L</fallocate64> instead."
23238 #: ../fish/guestfish-actions.pod:4069
23243 #: ../fish/guestfish-actions.pod:4071
23246 " tune2fs-l device\n"
23251 #: ../fish/guestfish-actions.pod:4081
23256 #: ../fish/guestfish-actions.pod:4083
23259 " txz-in (tarball|-) directory\n"
23264 #: ../fish/guestfish-actions.pod:4090
23269 #: ../fish/guestfish-actions.pod:4092
23272 " txz-out directory (tarball|-)\n"
23277 #: ../fish/guestfish-actions.pod:4099
23282 #: ../fish/guestfish-actions.pod:4101
23290 #: ../fish/guestfish-actions.pod:4115
23291 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
23295 #: ../fish/guestfish-actions.pod:4120
23300 #: ../fish/guestfish-actions.pod:4122
23305 #: ../fish/guestfish-actions.pod:4124
23308 " umount pathordevice\n"
23313 #: ../fish/guestfish-actions.pod:4130
23318 #: ../fish/guestfish-actions.pod:4132
23319 msgid "unmount-all"
23323 #: ../fish/guestfish-actions.pod:4134
23331 #: ../fish/guestfish-actions.pod:4140
23336 #: ../fish/guestfish-actions.pod:4142
23339 " upload (filename|-) remotefilename\n"
23344 #: ../fish/guestfish-actions.pod:4149
23345 msgid "See also L</download>."
23349 #: ../fish/guestfish-actions.pod:4153
23350 msgid "upload-offset"
23354 #: ../fish/guestfish-actions.pod:4155
23357 " upload-offset (filename|-) remotefilename offset\n"
23362 #: ../fish/guestfish-actions.pod:4167
23364 "Note that there is no limit on the amount of data that can be uploaded with "
23365 "this call, unlike with L</pwrite>, and this call always writes the full "
23366 "amount unless an error occurs."
23370 #: ../fish/guestfish-actions.pod:4172
23371 msgid "See also L</upload>, L</pwrite>."
23375 #: ../fish/guestfish-actions.pod:4176
23380 #: ../fish/guestfish-actions.pod:4178
23383 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
23388 #: ../fish/guestfish-actions.pod:4197
23393 #: ../fish/guestfish-actions.pod:4199
23401 #: ../fish/guestfish-actions.pod:4226
23403 "I<Note:> Don't use this call to test for availability of features. In "
23404 "enterprise distributions we backport features from later versions into "
23405 "earlier versions, making this an unreliable way to test for features. Use "
23406 "L</available> instead."
23410 #: ../fish/guestfish-actions.pod:4232
23415 #: ../fish/guestfish-actions.pod:4234
23418 " vfs-label device\n"
23423 #: ../fish/guestfish-actions.pod:4241
23424 msgid "To find a filesystem from the label, use L</findfs-label>."
23428 #: ../fish/guestfish-actions.pod:4243
23433 #: ../fish/guestfish-actions.pod:4245
23436 " vfs-type device\n"
23441 #: ../fish/guestfish-actions.pod:4255
23446 #: ../fish/guestfish-actions.pod:4257
23449 " vfs-uuid device\n"
23454 #: ../fish/guestfish-actions.pod:4264
23455 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
23459 #: ../fish/guestfish-actions.pod:4266
23460 msgid "vg-activate"
23464 #: ../fish/guestfish-actions.pod:4268
23467 " vg-activate true|false 'volgroups ...'\n"
23472 #: ../fish/guestfish-actions.pod:4281
23473 msgid "vg-activate-all"
23477 #: ../fish/guestfish-actions.pod:4283
23480 " vg-activate-all true|false\n"
23485 #: ../fish/guestfish-actions.pod:4293
23490 #: ../fish/guestfish-actions.pod:4295
23493 " vgcreate volgroup 'physvols ...'\n"
23498 #: ../fish/guestfish-actions.pod:4300
23503 #: ../fish/guestfish-actions.pod:4302
23506 " vglvuuids vgname\n"
23511 #: ../fish/guestfish-actions.pod:4307
23513 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
23514 "logical volumes and volume groups."
23518 #: ../fish/guestfish-actions.pod:4310
23519 msgid "See also L</vgpvuuids>."
23523 #: ../fish/guestfish-actions.pod:4312
23528 #: ../fish/guestfish-actions.pod:4314
23531 " vgpvuuids vgname\n"
23536 #: ../fish/guestfish-actions.pod:4319
23538 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
23539 "physical volumes and volume groups."
23543 #: ../fish/guestfish-actions.pod:4322
23544 msgid "See also L</vglvuuids>."
23548 #: ../fish/guestfish-actions.pod:4324
23553 #: ../fish/guestfish-actions.pod:4326
23556 " vgremove vgname\n"
23561 #: ../fish/guestfish-actions.pod:4333
23566 #: ../fish/guestfish-actions.pod:4335
23569 " vgrename volgroup newvolgroup\n"
23574 #: ../fish/guestfish-actions.pod:4339
23579 #: ../fish/guestfish-actions.pod:4341
23587 #: ../fish/guestfish-actions.pod:4349
23588 msgid "See also L</vgs-full>."
23592 #: ../fish/guestfish-actions.pod:4351
23597 #: ../fish/guestfish-actions.pod:4353
23605 #: ../fish/guestfish-actions.pod:4358
23610 #: ../fish/guestfish-actions.pod:4360
23618 #: ../fish/guestfish-actions.pod:4365
23623 #: ../fish/guestfish-actions.pod:4367
23631 #: ../fish/guestfish-actions.pod:4371
23636 #: ../fish/guestfish-actions.pod:4373
23644 #: ../fish/guestfish-actions.pod:4378
23649 #: ../fish/guestfish-actions.pod:4380
23657 #: ../fish/guestfish-actions.pod:4385
23662 #: ../fish/guestfish-actions.pod:4387
23670 #: ../fish/guestfish-actions.pod:4392
23675 #: ../fish/guestfish-actions.pod:4394
23678 " write path content\n"
23683 #: ../fish/guestfish-actions.pod:4402
23688 #: ../fish/guestfish-actions.pod:4404
23691 " write-file path content size\n"
23696 #: ../fish/guestfish-actions.pod:4427
23701 #: ../fish/guestfish-actions.pod:4429
23704 " zegrep regex path\n"
23709 #: ../fish/guestfish-actions.pod:4437
23714 #: ../fish/guestfish-actions.pod:4439
23717 " zegrepi regex path\n"
23722 #: ../fish/guestfish-actions.pod:4447
23727 #: ../fish/guestfish-actions.pod:4449
23735 #: ../fish/guestfish-actions.pod:4457
23736 msgid "See also: L</zero-device>, L</scrub-device>."
23740 #: ../fish/guestfish-actions.pod:4459
23741 msgid "zero-device"
23745 #: ../fish/guestfish-actions.pod:4461
23748 " zero-device device\n"
23753 #: ../fish/guestfish-actions.pod:4463
23755 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
23756 "which just zeroes the first few blocks of a device."
23760 #: ../fish/guestfish-actions.pod:4470
23765 #: ../fish/guestfish-actions.pod:4472
23768 " zerofree device\n"
23773 #: ../fish/guestfish-actions.pod:4485
23778 #: ../fish/guestfish-actions.pod:4487
23781 " zfgrep pattern path\n"
23786 #: ../fish/guestfish-actions.pod:4495
23791 #: ../fish/guestfish-actions.pod:4497
23794 " zfgrepi pattern path\n"
23799 #: ../fish/guestfish-actions.pod:4505
23804 #: ../fish/guestfish-actions.pod:4507
23807 " zfile meth path\n"
23812 #: ../fish/guestfish-actions.pod:4514
23813 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
23817 #: ../fish/guestfish-actions.pod:4524
23822 #: ../fish/guestfish-actions.pod:4526
23825 " zgrep regex path\n"
23830 #: ../fish/guestfish-actions.pod:4534
23835 #: ../fish/guestfish-actions.pod:4536
23838 " zgrepi regex path\n"
23843 #: ../fish/guestfish-commands.pod:1
23848 #: ../fish/guestfish-commands.pod:3
23853 #: ../fish/guestfish-commands.pod:5
23856 " alloc filename size\n"
23861 #: ../fish/guestfish-commands.pod:7
23863 "This creates an empty (zeroed) file of the given size, and then adds so it "
23864 "can be further examined."
23868 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
23869 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
23873 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
23874 msgid "Size can be specified using standard suffixes, eg. C<1M>."
23878 #: ../fish/guestfish-commands.pod:14
23880 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
23881 "image, see L</PREPARED DISK IMAGES>."
23885 #: ../fish/guestfish-commands.pod:17
23890 #: ../fish/guestfish-commands.pod:19
23893 " copy-in local [local ...] /remotedir\n"
23898 #: ../fish/guestfish-commands.pod:21
23900 "C<copy-in> copies local files or directories recursively into the disk "
23901 "image, placing them in the directory called C</remotedir> (which must "
23902 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
23903 "other commands as necessary."
23907 #: ../fish/guestfish-commands.pod:26
23909 "Multiple local files and directories can be specified, but the last "
23910 "parameter must always be a remote directory. Wildcards cannot be used."
23914 #: ../fish/guestfish-commands.pod:30
23919 #: ../fish/guestfish-commands.pod:32
23922 " copy-out remote [remote ...] localdir\n"
23927 #: ../fish/guestfish-commands.pod:34
23929 "C<copy-out> copies remote files or directories recursively out of the disk "
23930 "image, placing them on the host disk in a local directory called C<localdir> "
23931 "(which must exist). This guestfish meta-command turns into a sequence of "
23932 "L</download>, L</tar-out> and other commands as necessary."
23936 #: ../fish/guestfish-commands.pod:40
23938 "Multiple remote files and directories can be specified, but the last "
23939 "parameter must always be a local directory. To download to the current "
23940 "directory, use C<.> as in:"
23944 #: ../fish/guestfish-commands.pod:44
23947 " copy-out /home .\n"
23952 #: ../fish/guestfish-commands.pod:46
23954 "Wildcards cannot be used in the ordinary command, but you can use them with "
23955 "the help of L</glob> like this:"
23959 #: ../fish/guestfish-commands.pod:49
23962 " glob copy-out /home/* .\n"
23967 #: ../fish/guestfish-commands.pod:51
23972 #: ../fish/guestfish-commands.pod:53
23975 " echo [params ...]\n"
23980 #: ../fish/guestfish-commands.pod:55
23981 msgid "This echos the parameters to the terminal."
23985 #: ../fish/guestfish-commands.pod:57
23990 #: ../fish/guestfish-commands.pod:59
23995 #: ../fish/guestfish-commands.pod:61
24000 #: ../fish/guestfish-commands.pod:63
24008 #: ../fish/guestfish-commands.pod:65
24010 "This is used to edit a file. It downloads the file, edits it locally using "
24011 "your editor, then uploads the result."
24015 #: ../fish/guestfish-commands.pod:68
24017 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
24018 "or C<emacs> you will get those corresponding editors."
24022 #: ../fish/guestfish-commands.pod:72
24027 #: ../fish/guestfish-commands.pod:74
24030 " glob command args...\n"
24035 #: ../fish/guestfish-commands.pod:76
24037 "Expand wildcards in any paths in the args list, and run C<command> "
24038 "repeatedly on each matching path."
24042 #: ../fish/guestfish-commands.pod:79
24043 msgid "See L</WILDCARDS AND GLOBBING>."
24047 #: ../fish/guestfish-commands.pod:81
24052 #: ../fish/guestfish-commands.pod:83
24055 " hexedit <filename|device>\n"
24056 " hexedit <filename|device> <max>\n"
24057 " hexedit <filename|device> <start> <max>\n"
24062 #: ../fish/guestfish-commands.pod:87
24064 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
24069 #: ../fish/guestfish-commands.pod:90
24071 "This command works by downloading potentially the whole file or device, "
24072 "editing it locally, then uploading it. If the file or device is large, you "
24073 "have to specify which part you wish to edit by using C<max> and/or C<start> "
24074 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
24075 "usual modifiers allowed such as C<1M> (1 megabyte)."
24079 #: ../fish/guestfish-commands.pod:97
24080 msgid "For example to edit the first few sectors of a disk you might do:"
24084 #: ../fish/guestfish-commands.pod:100
24087 " hexedit /dev/sda 1M\n"
24092 #: ../fish/guestfish-commands.pod:102
24094 "which would allow you to edit anywhere within the first megabyte of the "
24099 #: ../fish/guestfish-commands.pod:105
24100 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
24104 #: ../fish/guestfish-commands.pod:107
24107 " hexedit /dev/sda1 0x400 0x400\n"
24112 #: ../fish/guestfish-commands.pod:109
24113 msgid "(assuming the superblock is in the standard location)."
24117 #: ../fish/guestfish-commands.pod:111
24119 "This command requires the external L<hexedit(1)> program. You can specify "
24120 "another program to use by setting the C<HEXEDITOR> environment variable."
24124 #: ../fish/guestfish-commands.pod:115
24125 msgid "See also L</hexdump>."
24129 #: ../fish/guestfish-commands.pod:117
24134 #: ../fish/guestfish-commands.pod:119
24142 #: ../fish/guestfish-commands.pod:121
24143 msgid "Change the local directory, ie. the current directory of guestfish itself."
24147 #: ../fish/guestfish-commands.pod:124
24148 msgid "Note that C<!cd> won't do what you might expect."
24152 #: ../fish/guestfish-commands.pod:126
24157 #: ../fish/guestfish-commands.pod:128
24162 #: ../fish/guestfish-commands.pod:130
24170 #: ../fish/guestfish-commands.pod:132
24171 msgid "Opens the manual page for guestfish."
24175 #: ../fish/guestfish-commands.pod:134
24180 #: ../fish/guestfish-commands.pod:136
24185 #: ../fish/guestfish-commands.pod:138
24193 #: ../fish/guestfish-commands.pod:140
24201 #: ../fish/guestfish-commands.pod:142
24202 msgid "This is used to view a file."
24206 #: ../fish/guestfish-commands.pod:144
24208 "The default viewer is C<$PAGER>. However if you use the alternate command "
24209 "C<less> you will get the C<less> command specifically."
24213 #: ../fish/guestfish-commands.pod:147
24218 #: ../fish/guestfish-commands.pod:149
24226 #: ../fish/guestfish-commands.pod:151
24228 "Close and reopen the libguestfs handle. It is not necessary to use this "
24229 "normally, because the handle is closed properly when guestfish exits. "
24230 "However this is occasionally useful for testing."
24234 #: ../fish/guestfish-commands.pod:155
24239 #: ../fish/guestfish-commands.pod:157
24242 " sparse filename size\n"
24247 #: ../fish/guestfish-commands.pod:159
24249 "This creates an empty sparse file of the given size, and then adds so it can "
24250 "be further examined."
24254 #: ../fish/guestfish-commands.pod:162
24256 "In all respects it works the same as the L</alloc> command, except that the "
24257 "image file is allocated sparsely, which means that disk blocks are not "
24258 "assigned to the file until they are needed. Sparse disk files only use "
24259 "space when written to, but they are slower and there is a danger you could "
24260 "run out of real disk space during a write operation."
24264 #: ../fish/guestfish-commands.pod:172
24269 #: ../fish/guestfish-commands.pod:174
24277 #: ../fish/guestfish-commands.pod:176
24279 "This command returns a list of the optional groups known to the daemon, and "
24280 "indicates which ones are supported by this build of the libguestfs "
24285 #: ../fish/guestfish-commands.pod:180
24286 msgid "See also L<guestfs(3)/AVAILABILITY>."
24290 #: ../fish/guestfish-commands.pod:182
24295 #: ../fish/guestfish-commands.pod:184
24298 " time command args...\n"
24303 #: ../fish/guestfish-commands.pod:186
24305 "Run the command as usual, but print the elapsed time afterwards. This can "
24306 "be useful for benchmarking operations."
24310 #: ../test-tool/libguestfs-test-tool.pod:5
24311 msgid "libguestfs-test-tool - End user tests for libguestfs"
24315 #: ../test-tool/libguestfs-test-tool.pod:9
24318 " libguestfs-test-tool [--options]\n"
24323 #: ../test-tool/libguestfs-test-tool.pod:13
24325 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
24326 "and developers, to allow them to check basic libguestfs functionality is "
24327 "working. This is needed because libguestfs occasionally breaks for reasons "
24328 "beyond our control: usually because of changes in the underlying qemu or "
24329 "kernel packages, or the host environment."
24333 #: ../test-tool/libguestfs-test-tool.pod:20
24334 msgid "If you suspect a problem in libguestfs, then just run:"
24338 #: ../test-tool/libguestfs-test-tool.pod:22
24341 " libguestfs-test-tool\n"
24346 #: ../test-tool/libguestfs-test-tool.pod:24
24347 msgid "It will print lots of diagnostic messages."
24351 #: ../test-tool/libguestfs-test-tool.pod:26
24352 msgid "If it runs to completion successfully, you will see this near the end:"
24356 #: ../test-tool/libguestfs-test-tool.pod:28
24359 " ===== TEST FINISHED OK =====\n"
24364 #: ../test-tool/libguestfs-test-tool.pod:30
24365 msgid "and the test tool will exit with code 0."
24369 #: ../test-tool/libguestfs-test-tool.pod:32
24371 "If it fails (and/or exits with non-zero error code), please paste the "
24372 "B<complete, unedited> output of the test tool into a bug report. More "
24373 "information about reporting bugs can be found on the "
24374 "L<http://libguestfs.org/> website."
24378 #: ../test-tool/libguestfs-test-tool.pod:41
24383 #: ../test-tool/libguestfs-test-tool.pod:43
24384 msgid "Display short usage information and exit."
24388 #: ../test-tool/libguestfs-test-tool.pod:45
24389 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
24393 #: ../test-tool/libguestfs-test-tool.pod:47
24395 "Pass an alternate name for the helper program. libguestfs-test-tool will "
24396 "normally look in the C<$libexec> directory that was configured when the tool "
24401 #: ../test-tool/libguestfs-test-tool.pod:51
24402 msgid "I<--qemu qemu_binary>"
24406 #: ../test-tool/libguestfs-test-tool.pod:53
24408 "If you have downloaded another qemu binary, point this option at the full "
24409 "path of the binary to try it."
24413 #: ../test-tool/libguestfs-test-tool.pod:56
24414 msgid "I<--qemudir qemu_source_dir>"
24418 #: ../test-tool/libguestfs-test-tool.pod:58
24420 "If you have compiled qemu from source, point this option at the source "
24421 "directory to try it."
24425 #: ../test-tool/libguestfs-test-tool.pod:61
24426 msgid "I<--timeout N>"
24430 #: ../test-tool/libguestfs-test-tool.pod:63
24432 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
24433 "does not usually need to be adjusted unless your machine is very slow."
24437 #: ../test-tool/libguestfs-test-tool.pod:69
24438 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
24442 #: ../test-tool/libguestfs-test-tool.pod:71
24444 "If you have compiled another version of qemu from source and would like to "
24445 "try that, then you can use the I<--qemudir> option to point to the qemu "
24446 "source directory."
24450 #: ../test-tool/libguestfs-test-tool.pod:75
24452 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
24453 "option to point to the binary."
24457 #: ../test-tool/libguestfs-test-tool.pod:78
24459 "When using an alternate qemu with libguestfs, usually you would need to "
24460 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
24461 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
24462 "when you use either of the I<--qemudir> or I<--qemu> options."
24466 #: ../test-tool/libguestfs-test-tool.pod:85
24468 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
24469 "I<1> if there was an error."
24473 #: ../test-tool/libguestfs-test-tool.pod:92
24474 msgid "/usr/libexec/libguestfs-test-tool-helper"
24478 #: ../test-tool/libguestfs-test-tool.pod:94
24480 "This helper program is run inside the appliance and provides additional "
24485 #: ../test-tool/libguestfs-test-tool.pod:97
24486 msgid "/usr/bin/mkisofs"
24490 #: ../test-tool/libguestfs-test-tool.pod:99
24492 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
24493 "which is used as part of the tests."
24497 #: ../test-tool/libguestfs-test-tool.pod:106
24499 "For the full list of environment variables which may affect libguestfs, "
24500 "please see the L<guestfs(3)> manual page."
24504 #: ../test-tool/libguestfs-test-tool.pod:111
24505 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
24509 #: ../test-tool/libguestfs-test-tool.pod:121
24510 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
24514 #: ../fuse/guestmount.pod:5
24515 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
24519 #: ../fuse/guestmount.pod:9
24522 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
24527 #: ../fuse/guestmount.pod:11
24530 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
24535 #: ../fuse/guestmount.pod:13
24538 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
24543 #: ../fuse/guestmount.pod:17
24545 "You must I<not> use C<guestmount> in read-write mode on live virtual "
24546 "machines. If you do this, you risk disk corruption in the VM."
24550 #: ../fuse/guestmount.pod:22
24552 "The guestmount program can be used to mount virtual machine filesystems and "
24553 "other disk images on the host. It uses libguestfs for access to the guest "
24554 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
24555 "a mountable device."
24559 #: ../fuse/guestmount.pod:27
24561 "Along with other options, you have to give at least one device (I<-a> "
24562 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
24563 "option) or use the I<-i> inspection option. How this works is better "
24564 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
24569 #: ../fuse/guestmount.pod:33
24571 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
24572 "by you, and the filesystem will not be visible to any other users unless you "
24573 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
24574 "the filesystem, use the C<fusermount -u> command."
24578 #: ../fuse/guestmount.pod:41
24580 "For a typical Windows guest which has its main filesystem on the first "
24585 #: ../fuse/guestmount.pod:44
24588 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
24593 #: ../fuse/guestmount.pod:46
24595 "For a typical Linux guest which has a /boot filesystem on the first "
24596 "partition, and the root filesystem on a logical volume:"
24600 #: ../fuse/guestmount.pod:49
24603 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
24608 #: ../fuse/guestmount.pod:51
24609 msgid "To get libguestfs to detect guest mountpoints for you:"
24613 #: ../fuse/guestmount.pod:53
24616 " guestmount -a guest.img -i --ro /mnt\n"
24621 #: ../fuse/guestmount.pod:55
24622 msgid "For a libvirt guest called \"Guest\" you could do:"
24626 #: ../fuse/guestmount.pod:57
24629 " guestmount -d Guest -i --ro /mnt\n"
24634 #: ../fuse/guestmount.pod:59
24636 "If you don't know what filesystems are contained in a guest or disk image, "
24637 "use L<virt-list-filesystems(1)> first:"
24641 #: ../fuse/guestmount.pod:62
24644 " virt-list-filesystems MyGuest\n"
24649 #: ../fuse/guestmount.pod:64
24651 "If you want to trace the libguestfs calls but without excessive debugging "
24652 "information, we recommend:"
24656 #: ../fuse/guestmount.pod:67
24659 " guestmount [...] --trace /mnt\n"
24664 #: ../fuse/guestmount.pod:69
24665 msgid "If you want to debug the program, we recommend:"
24669 #: ../fuse/guestmount.pod:71
24672 " guestmount [...] --trace --verbose /mnt\n"
24677 #: ../fuse/guestmount.pod:79
24678 msgid "Add a block device or virtual machine image."
24682 #: ../fuse/guestmount.pod:96
24683 msgid "B<--dir-cache-timeout N>"
24687 #: ../fuse/guestmount.pod:98
24689 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
24690 "seconds. The readdir cache [actually, there are several semi-independent "
24691 "caches] is populated after a readdir(2) call with the stat and extended "
24692 "attributes of the files in the directory, in anticipation that they will be "
24693 "requested soon after."
24697 #: ../fuse/guestmount.pod:104
24699 "There is also a different attribute cache implemented by FUSE (see the FUSE "
24700 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
24701 "requests, only cache existing ones."
24705 #: ../fuse/guestmount.pod:122
24707 "If you have untrusted raw-format guest disk images, you should use this "
24708 "option to specify the disk format. This avoids a possible security problem "
24709 "with malicious guests (CVE-2010-3851). See also "
24710 "L<guestfs(3)/guestfs_add_drive_opts>."
24714 #: ../fuse/guestmount.pod:127
24715 msgid "B<--fuse-help>"
24719 #: ../fuse/guestmount.pod:129
24720 msgid "Display help on special FUSE options (see I<-o> below)."
24724 #: ../fuse/guestmount.pod:133
24725 msgid "Display brief help and exit."
24729 #: ../fuse/guestmount.pod:146
24730 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
24734 #: ../fuse/guestmount.pod:148
24736 "Mount the named partition or logical volume on the given mountpoint B<in the "
24737 "guest> (this has nothing to do with mountpoints in the host)."
24741 #: ../fuse/guestmount.pod:151
24743 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
24744 "something on C</>."
24748 #: ../fuse/guestmount.pod:156
24750 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
24751 "unmounted. If you specify this option, then we don't attempt to sync the "
24752 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
24756 #: ../fuse/guestmount.pod:161
24757 msgid "B<-o option> | B<--option option>"
24761 #: ../fuse/guestmount.pod:163
24762 msgid "Pass extra options to FUSE."
24766 #: ../fuse/guestmount.pod:165
24768 "To get a list of all the extra options supported by FUSE, use the command "
24769 "below. Note that only the FUSE I<-o> options can be passed, and only some "
24770 "of them are a good idea."
24774 #: ../fuse/guestmount.pod:169
24777 " guestmount --fuse-help\n"
24782 #: ../fuse/guestmount.pod:171
24783 msgid "Some potentially useful FUSE options:"
24787 #: ../fuse/guestmount.pod:175
24788 msgid "B<-o allow_other>"
24792 #: ../fuse/guestmount.pod:177
24793 msgid "Allow other users to see the filesystem."
24797 #: ../fuse/guestmount.pod:179
24798 msgid "B<-o attr_timeout=N>"
24802 #: ../fuse/guestmount.pod:181
24803 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
24807 #: ../fuse/guestmount.pod:183
24808 msgid "B<-o kernel_cache>"
24812 #: ../fuse/guestmount.pod:185
24814 "Allow the kernel to cache files (reduces the number of reads that have to go "
24815 "through the L<guestfs(3)> API). This is generally a good idea if you can "
24816 "afford the extra memory usage."
24820 #: ../fuse/guestmount.pod:189
24821 msgid "B<-o uid=N> B<-o gid=N>"
24825 #: ../fuse/guestmount.pod:191
24827 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
24828 "the chosen values."
24832 #: ../fuse/guestmount.pod:198
24834 "Add devices and mount everything read-only. Also disallow writes and make "
24835 "the disk appear read-only to FUSE."
24839 #: ../fuse/guestmount.pod:201
24841 "This is highly recommended if you are not going to edit the guest disk. If "
24842 "the guest is running and this option is I<not> supplied, then there is a "
24843 "strong risk of disk corruption in the guest. We try to prevent this from "
24844 "happening, but it is not always possible."
24848 #: ../fuse/guestmount.pod:206
24849 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
24853 #: ../fuse/guestmount.pod:210
24854 msgid "Enable SELinux support for the guest."
24858 #: ../fuse/guestmount.pod:214
24859 msgid "Enable verbose messages from underlying libguestfs."
24863 #: ../fuse/guestmount.pod:218
24864 msgid "Display the program version and exit."
24868 #: ../fuse/guestmount.pod:222
24870 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
24871 "FOR READ AND WRITE>."
24875 #: ../fuse/guestmount.pod:225
24876 msgid "B<-x> | B<--trace>"
24880 #: ../fuse/guestmount.pod:227
24881 msgid "Trace libguestfs calls."
24885 #: ../fuse/guestmount.pod:229
24886 msgid "This also stops the daemon from forking into the background."
24890 #: ../fuse/guestmount.pod:235
24892 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
24893 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
24894 "L<http://fuse.sf.net/>."
24898 #: ../inspector/virt-inspector.pl:35
24900 "virt-inspector - Display operating system version and other information "
24901 "about a virtual machine"
24905 #: ../inspector/virt-inspector.pl:39
24908 " virt-inspector [--connect URI] domname\n"
24913 #: ../inspector/virt-inspector.pl:41
24916 " virt-inspector guest.img [guest.img ...]\n"
24921 #: ../inspector/virt-inspector.pl:45
24923 "B<virt-inspector> examines a virtual machine or disk image and tries to "
24924 "determine the version of the operating system and other information about "
24925 "the virtual machine."
24929 #: ../inspector/virt-inspector.pl:49
24930 msgid "Virt-inspector produces XML output for feeding into other programs."
24934 #: ../inspector/virt-inspector.pl:51
24936 "In the normal usage, use C<virt-inspector domname> where C<domname> is the "
24937 "libvirt domain (see: C<virsh list --all>)."
24941 #: ../inspector/virt-inspector.pl:54
24943 "You can also run virt-inspector directly on disk images from a single "
24944 "virtual machine. Use C<virt-inspector guest.img>. In rare cases a domain "
24945 "has several block devices, in which case you should list them one after "
24946 "another, with the first corresponding to the guest's C</dev/sda>, the second "
24947 "to the guest's C</dev/sdb> and so on."
24951 #: ../inspector/virt-inspector.pl:60
24953 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
24954 "inspect several virtual machines, you have to run virt-inspector several "
24955 "times (for example, from a shell script for-loop)."
24959 #: ../inspector/virt-inspector.pl:65
24961 "Because virt-inspector needs direct access to guest images, it won't "
24962 "normally work over remote libvirt connections."
24966 #: ../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
24967 msgid "Display brief help."
24971 #: ../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
24972 msgid "B<--version>"
24976 #: ../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
24977 msgid "Display version number and exit."
24981 #: ../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
24982 msgid "B<--connect URI> | B<-c URI>"
24986 #: ../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
24988 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
24989 "to the default libvirt hypervisor."
24993 #: ../inspector/virt-inspector.pl:97
24995 "Libvirt is only used if you specify a C<domname> on the command line. If "
24996 "you specify guest block devices directly, then libvirt is not used at all."
25000 #: ../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
25001 msgid "B<--format> raw"
25005 #: ../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
25007 "Specify the format of disk images given on the command line. If this is "
25008 "omitted then the format is autodetected from the content of the disk image."
25012 #: ../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
25014 "If disk images are requested from libvirt, then this program asks libvirt "
25015 "for this information. In this case, the value of the format parameter is "
25020 #: ../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
25022 "If working with untrusted raw-format guest disk images, you should ensure "
25023 "the format is always specified."
25027 #: ../inspector/virt-inspector.pl:149
25032 #: ../inspector/virt-inspector.pl:151
25034 "The virt-inspector XML is described precisely in a RELAX NG schema which is "
25035 "supplied with libguestfs. This section is just an overview."
25039 #: ../inspector/virt-inspector.pl:154
25041 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
25042 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
25043 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
25044 "which is vanishingly rare in real world VMs."
25048 #: ../inspector/virt-inspector.pl:159
25049 msgid "E<lt>operatingsystemE<gt>"
25053 #: ../inspector/virt-inspector.pl:161
25055 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
25056 "describe the operating system, its architecture, the descriptive \"product "
25057 "name\" string, the type of OS and so on, as in this example:"
25061 #: ../inspector/virt-inspector.pl:165
25064 " <operatingsystems>\n"
25065 " <operatingsystem>\n"
25066 " <root>/dev/sda2</root>\n"
25067 " <name>windows</name>\n"
25068 " <arch>i386</arch>\n"
25069 " <distro>windows</distro>\n"
25070 " <product_name>Windows 7 Enterprise</product_name>\n"
25071 " <major_version>6</major_version>\n"
25072 " <minor_version>1</minor_version>\n"
25073 " <windows_systemroot>/Windows</windows_systemroot>\n"
25078 #: ../inspector/virt-inspector.pl:176
25080 "These fields are derived from the libguestfs inspection API, and you can "
25081 "find more details in L<guestfs(3)/INSPECTION>."
25085 #: ../inspector/virt-inspector.pl:179
25087 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
25088 "of view of libguestfs (block devices may have completely different names "
25089 "inside the VM itself)."
25093 #: ../inspector/virt-inspector.pl:240
25094 msgid "E<lt>mountpointsE<gt>"
25098 #: ../inspector/virt-inspector.pl:242
25100 "Un*x-like guests typically have multiple filesystems which are mounted at "
25101 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
25102 "element which looks like this:"
25106 #: ../inspector/virt-inspector.pl:246
25109 " <operatingsystems>\n"
25110 " <operatingsystem>\n"
25113 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
25114 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
25115 " </mountpoints>\n"
25120 #: ../inspector/virt-inspector.pl:254
25122 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
25123 "and may have completely different names inside the guest. Only mountable "
25124 "filesystems appear in this list, not things like swap devices."
25128 #: ../inspector/virt-inspector.pl:276
25129 msgid "E<lt>filesystemsE<gt>"
25133 #: ../inspector/virt-inspector.pl:278
25135 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
25136 "filesystems belonging to the guest, including swap and empty partitions. "
25137 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
25138 "this OS or shared by this OS and other OSes)."
25142 #: ../inspector/virt-inspector.pl:283
25143 msgid "You might see something like this:"
25147 #: ../inspector/virt-inspector.pl:285
25150 " <operatingsystems>\n"
25151 " <operatingsystem>\n"
25154 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
25155 " <type>ext4</type>\n"
25156 " <label>Fedora-13-x86_64</label>\n"
25157 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
25163 #: ../inspector/virt-inspector.pl:295
25165 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
25166 "the label, and the UUID."
25170 #: ../inspector/virt-inspector.pl:337
25171 msgid "E<lt>applicationsE<gt>"
25175 #: ../inspector/virt-inspector.pl:339
25177 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
25178 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
25179 "machine. At the moment we are only able to list RPMs and Debian packages "
25180 "installed, but in future we will support other Linux distros and Windows."
25184 #: ../inspector/virt-inspector.pl:345
25186 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
25187 "Typical values would be C<rpm> and C<deb>."
25191 #: ../inspector/virt-inspector.pl:348
25193 "E<lt>package_managementE<gt>, if present, describes the package manager. "
25194 "Typical values include C<yum>, C<up2date> and C<apt>"
25198 #: ../inspector/virt-inspector.pl:351
25199 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
25203 #: ../inspector/virt-inspector.pl:354
25206 " <operatingsystems>\n"
25207 " <operatingsystem>\n"
25209 " <applications>\n"
25211 " <name>coreutils</name>\n"
25212 " <version>8.5</version>\n"
25213 " <release>1</release>\n"
25214 " </application>\n"
25219 #: ../inspector/virt-inspector.pl:364
25221 "(The version and release fields may not be available for some package "
25226 #: ../inspector/virt-inspector.pl:510
25227 msgid "USING XPATH"
25231 #: ../inspector/virt-inspector.pl:512
25233 "You can use the XPath query language, and/or the xpath tool, in order to "
25234 "select parts of the XML."
25238 #: ../inspector/virt-inspector.pl:517
25241 " $ virt-inspector Guest | xpath //filesystems\n"
25242 " Found 1 nodes:\n"
25245 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
25246 " <type>ext4</type>\n"
25252 #: ../inspector/virt-inspector.pl:525
25255 " $ virt-inspector Guest | \\\n"
25256 " xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
25257 " Query didn't return a nodeset. Value: ext4\n"
25262 #: ../inspector/virt-inspector.pl:529 ../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
25263 msgid "SHELL QUOTING"
25267 #: ../inspector/virt-inspector.pl:531 ../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
25269 "Libvirt guest names can contain arbitrary characters, some of which have "
25270 "meaning to the shell such as C<#> and space. You may need to quote or "
25271 "escape these characters on the command line. See the shell manual page "
25272 "L<sh(1)> for details."
25276 #: ../inspector/virt-inspector.pl:538
25278 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
25279 "L<Sys::Virt(3)>, L<http://www.w3.org/TR/xpath/>, L<http://libguestfs.org/>."
25283 #: ../inspector/virt-inspector.pl:552 ../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
25284 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
25288 #: ../inspector/virt-inspector.pl:556
25289 msgid "Matthew Booth L<mbooth@redhat.com>"
25293 #: ../inspector/virt-inspector.pl:562 ../tools/virt-win-reg.pl:516 ../tools/virt-resize.pl:1514 ../tools/virt-make-fs.pl:565
25294 msgid "Copyright (C) 2010 Red Hat Inc."
25298 #: ../tools/virt-edit.pl:34
25299 msgid "virt-edit - Edit a file in a virtual machine"
25303 #: ../tools/virt-edit.pl:38
25306 " virt-edit [--options] domname file\n"
25311 #: ../tools/virt-edit.pl:40
25314 " virt-edit [--options] disk.img [disk.img ...] file\n"
25319 #: ../tools/virt-edit.pl:42
25322 " virt-edit [domname|disk.img] file -e 'expr'\n"
25327 #: ../tools/virt-edit.pl:46
25329 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
25330 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
25331 "doing this, but doesn't catch all cases."
25335 #: ../tools/virt-edit.pl:52
25337 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
25338 "the named virtual machine (or disk image)."
25342 #: ../tools/virt-edit.pl:55
25344 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
25345 "you should look at the L<guestfish(1)> tool."
25349 #: ../tools/virt-edit.pl:60
25350 msgid "Edit the named files interactively:"
25354 #: ../tools/virt-edit.pl:62
25357 " virt-edit mydomain /boot/grub/grub.conf\n"
25362 #: ../tools/virt-edit.pl:64
25365 " virt-edit mydomain /etc/passwd\n"
25370 #: ../tools/virt-edit.pl:66
25372 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
25373 "below). To change the init default level to 5:"
25377 #: ../tools/virt-edit.pl:70
25380 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
25385 #: ../tools/virt-edit.pl:96
25386 msgid "B<--backup extension> | B<-b extension>"
25390 #: ../tools/virt-edit.pl:98
25392 "Create a backup of the original file I<in the guest disk image>. The backup "
25393 "has the original filename with C<extension> added."
25397 #: ../tools/virt-edit.pl:101
25399 "Usually the first character of C<extension> would be a dot C<.> so you would "
25404 #: ../tools/virt-edit.pl:104
25407 " virt-edit -b .orig [etc]\n"
25412 #: ../tools/virt-edit.pl:106
25413 msgid "By default, no backup file is made."
25417 #: ../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
25419 "If you specify guest block devices directly, then libvirt is not used at "
25424 #: ../tools/virt-edit.pl:141
25425 msgid "B<--expr EXPR> | B<-e EXPR>"
25429 #: ../tools/virt-edit.pl:143
25431 "Instead of launching the external editor, non-interactively apply the Perl "
25432 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
25437 #: ../tools/virt-edit.pl:147
25439 "Be careful to properly quote the expression to prevent it from being altered "
25444 #: ../tools/virt-edit.pl:268
25445 msgid "NON-INTERACTIVE EDITING"
25449 #: ../tools/virt-edit.pl:270
25451 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
25452 "administrator can interactively edit the file."
25456 #: ../tools/virt-edit.pl:273
25458 "There are two ways also to use C<virt-edit> from scripts in order to make "
25459 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
25460 "like this, it's less error-prone to write scripts directly using the "
25461 "libguestfs API and Augeas for configuration file editing.)"
25465 #: ../tools/virt-edit.pl:279
25467 "The first method is to temporarily set C<$EDITOR> to any script or program "
25468 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
25469 "update C<tmpfile> in place however it likes."
25473 #: ../tools/virt-edit.pl:283
25475 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
25476 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
25477 "instances of C<foo> with C<bar> in a file:"
25481 #: ../tools/virt-edit.pl:287
25484 " virt-edit domname filename -e 's/foo/bar/'\n"
25489 #: ../tools/virt-edit.pl:289
25491 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
25492 "For example to delete root's password you could do:"
25496 #: ../tools/virt-edit.pl:292
25499 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
25504 #: ../tools/virt-edit.pl:294
25506 "What really happens is that the snippet is evaluated as a Perl expression "
25507 "for each line of the file. The line, including the final C<\\n>, is passed "
25508 "in C<$_> and the expression should update C<$_> or leave it unchanged."
25512 #: ../tools/virt-edit.pl:299
25514 "To delete a line, set C<$_> to the empty string. For example, to delete the "
25515 "C<apache> user account from the password file you can do:"
25519 #: ../tools/virt-edit.pl:302
25522 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
25527 #: ../tools/virt-edit.pl:304
25529 "To insert a line, prepend or append it to C<$_>. However appending lines to "
25530 "the end of the file is rather difficult this way since there is no concept "
25531 "of \"last line of the file\" - your expression just doesn't get called "
25532 "again. You might want to use the first method (setting C<$EDITOR>) if you "
25537 #: ../tools/virt-edit.pl:310
25539 "The variable C<$lineno> contains the current line number. As is "
25540 "traditional, the first line in the file is number C<1>."
25544 #: ../tools/virt-edit.pl:313
25546 "The return value from the expression is ignored, but the expression may call "
25547 "C<die> in order to abort the whole program, leaving the original file "
25552 #: ../tools/virt-edit.pl:317
25554 "Remember when matching the end of a line that C<$_> may contain the final "
25555 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
25556 "newline then neither of these. Thus to match or substitute some text at the "
25557 "end of a line, use this regular expression:"
25561 #: ../tools/virt-edit.pl:322
25564 " /some text(\\r?\\n)?$/\n"
25569 #: ../tools/virt-edit.pl:324
25571 "Alternately, use the perl C<chomp> function, being careful not to chomp "
25572 "C<$_> itself (since that would remove all newlines from the file):"
25576 #: ../tools/virt-edit.pl:328
25579 " my $m = $_; chomp $m; $m =~ /some text$/\n"
25584 #: ../tools/virt-edit.pl:334
25589 #: ../tools/virt-edit.pl:336
25591 "If set, this string is used as the editor. It may contain arguments, "
25592 "eg. C<\"emacs -nw\">"
25596 #: ../tools/virt-edit.pl:339
25597 msgid "If not set, C<vi> is used."
25601 #: ../tools/virt-edit.pl:352
25603 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
25604 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, "
25605 "L<perl(1)>, L<perlre(1)>."
25609 #: ../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
25614 #: ../tools/virt-edit.pl:368 ../tools/virt-df.pl:655 ../tools/virt-rescue.pl:283 ../tools/virt-list-partitions.pl:271
25615 msgid "Copyright (C) 2009-2010 Red Hat Inc."
25619 #: ../tools/virt-win-reg.pl:37
25621 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
25626 #: ../tools/virt-win-reg.pl:41
25629 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
25634 #: ../tools/virt-win-reg.pl:43
25637 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
25642 #: ../tools/virt-win-reg.pl:45
25645 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
25650 #: ../tools/virt-win-reg.pl:47
25653 " virt-win-reg --merge domname [input.reg ...]\n"
25658 #: ../tools/virt-win-reg.pl:49
25661 " virt-win-reg [--options] disk.img ... # instead of domname\n"
25666 #: ../tools/virt-win-reg.pl:53
25668 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
25669 "virtual machines. If you do this, you I<will> get irreversible disk "
25670 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
25671 "but doesn't catch all cases."
25675 #: ../tools/virt-win-reg.pl:58
25677 "Modifying the Windows Registry is an inherently risky operation. The format "
25678 "is deliberately obscure and undocumented, and Registry changes can leave the "
25679 "system unbootable. Therefore when using the C<--merge> option, make sure "
25680 "you have a reliable backup first."
25684 #: ../tools/virt-win-reg.pl:65
25686 "This program can export and merge Windows Registry entries from a Windows "
25691 #: ../tools/virt-win-reg.pl:68
25693 "The first parameter is the libvirt guest name or the raw disk image of a "
25698 #: ../tools/virt-win-reg.pl:71
25700 "If C<--merge> is I<not> specified, then the chosen registry key is "
25701 "displayed/exported (recursively). For example:"
25705 #: ../tools/virt-win-reg.pl:74
25708 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
25713 #: ../tools/virt-win-reg.pl:76
25714 msgid "You can also display single values from within registry keys, for example:"
25718 #: ../tools/virt-win-reg.pl:79
25721 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
25722 " $ virt-win-reg Windows7 $cvkey ProductName\n"
25723 " Windows 7 Enterprise\n"
25728 #: ../tools/virt-win-reg.pl:83
25730 "With C<--merge>, you can merge a textual regedit file into the Windows "
25735 #: ../tools/virt-win-reg.pl:86
25738 " $ virt-win-reg --merge Windows7 changes.reg\n"
25743 #: ../tools/virt-win-reg.pl:88
25744 msgid "SUPPORTED SYSTEMS"
25748 #: ../tools/virt-win-reg.pl:90
25750 "The program currently supports Windows NT-derived guests starting with "
25751 "Windows XP through to at least Windows 7."
25755 #: ../tools/virt-win-reg.pl:93
25757 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
25758 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
25759 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
25763 #: ../tools/virt-win-reg.pl:97
25765 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
25770 #: ../tools/virt-win-reg.pl:100
25772 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
25777 #: ../tools/virt-win-reg.pl:103
25782 #: ../tools/virt-win-reg.pl:105
25784 "This program is only meant for simple access to the registry. If you want "
25785 "to do complicated things with the registry, we suggest you download the "
25786 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
25787 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
25788 "L<hivexregedit(1)>."
25792 #: ../tools/virt-win-reg.pl:111
25797 #: ../tools/virt-win-reg.pl:113
25799 "C<virt-win-reg> expects that regedit files have already been reencoded in "
25800 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
25801 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
25802 "with Windows-style line endings, you may need to reencode the whole file "
25803 "before or after processing."
25807 #: ../tools/virt-win-reg.pl:119
25809 "To reencode a file from Windows format to Linux (before processing it with "
25810 "the C<--merge> option), you would do something like this:"
25814 #: ../tools/virt-win-reg.pl:122
25817 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
25822 #: ../tools/virt-win-reg.pl:124
25824 "To go in the opposite direction, after exporting and before sending the file "
25825 "to a Windows user, do something like this:"
25829 #: ../tools/virt-win-reg.pl:127
25832 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
25837 #: ../tools/virt-win-reg.pl:129
25838 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
25842 #: ../tools/virt-win-reg.pl:131
25844 "If you are unsure about the current encoding, use the L<file(1)> command. "
25845 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
25846 "Windows-style (CRLF) line endings, like this:"
25850 #: ../tools/virt-win-reg.pl:135
25853 " $ file software.reg\n"
25854 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
25855 " with CRLF line terminators\n"
25860 #: ../tools/virt-win-reg.pl:139
25861 msgid "This file would need conversion before you could C<--merge> it."
25865 #: ../tools/virt-win-reg.pl:143
25867 "Be careful when passing parameters containing C<\\> (backslash) in the "
25868 "shell. Usually you will have to use 'single quotes' or double backslashes "
25869 "(but not both) to protect them from the shell."
25873 #: ../tools/virt-win-reg.pl:147
25874 msgid "Paths and value names are case-insensitive."
25878 #: ../tools/virt-win-reg.pl:149
25879 msgid "CurrentControlSet etc."
25883 #: ../tools/virt-win-reg.pl:151
25885 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
25886 "Registry at the level of the hive file, and therefore you cannot modify "
25891 #: ../tools/virt-win-reg.pl:155
25893 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
25894 "circumstances it might refer to another control set. The way to find out is "
25895 "to look at the C<HKLM\\SYSTEM\\Select> key:"
25899 #: ../tools/virt-win-reg.pl:159
25902 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
25903 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
25904 " \"Current\"=dword:00000001\n"
25905 " \"Default\"=dword:00000001\n"
25906 " \"Failed\"=dword:00000000\n"
25907 " \"LastKnownGood\"=dword:00000002\n"
25912 #: ../tools/virt-win-reg.pl:166
25913 msgid "\"Current\" is the one which Windows will choose when it boots."
25917 #: ../tools/virt-win-reg.pl:168
25918 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
25922 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
25927 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:501
25928 msgid "Enable debugging messages."
25932 #: ../tools/virt-win-reg.pl:232
25937 #: ../tools/virt-win-reg.pl:234
25939 "In merge mode, this merges a textual regedit file into the Windows Registry "
25940 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
25941 "displays or exports Registry entries instead."
25945 #: ../tools/virt-win-reg.pl:238
25947 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
25948 "result in disk corruption. However exporting (without this flag) is always "
25953 #: ../tools/virt-win-reg.pl:246
25954 msgid "B<--encoding> UTF-16LE|ASCII"
25958 #: ../tools/virt-win-reg.pl:248
25960 "When merging (only), you may need to specify the encoding for strings to be "
25961 "used in the hive file. This is explained in detail in "
25962 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
25966 #: ../tools/virt-win-reg.pl:252
25968 "The default is to use UTF-16LE, which should work with recent versions of "
25973 #: ../tools/virt-win-reg.pl:486
25975 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
25976 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
25977 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
25978 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
25982 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
25984 "When reporting bugs, please enable debugging and capture the I<complete> "
25989 #: ../tools/virt-win-reg.pl:504
25992 " export LIBGUESTFS_DEBUG=1\n"
25993 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
25998 #: ../tools/virt-win-reg.pl:507
26000 "Attach /tmp/virt-win-reg.log to a new bug report at "
26001 "L<https://bugzilla.redhat.com/>"
26005 #: ../tools/virt-df.pl:36
26006 msgid "virt-df - Display free space on virtual filesystems"
26010 #: ../tools/virt-df.pl:40
26013 " virt-df [--options]\n"
26018 #: ../tools/virt-df.pl:42
26021 " virt-df [--options] domname\n"
26026 #: ../tools/virt-df.pl:44
26029 " virt-df [--options] disk.img [disk.img ...]\n"
26034 #: ../tools/virt-df.pl:48
26036 "C<virt-df> is a command line tool to display free space on virtual machine "
26037 "filesystems. Unlike other tools, it doesn't just display the amount of "
26038 "space allocated to a virtual machine, but can look inside the virtual "
26039 "machine to see how much space is really being used."
26043 #: ../tools/virt-df.pl:53
26045 "It is like the L<df(1)> command, but for virtual machines, except that it "
26046 "also works for Windows virtual machines."
26050 #: ../tools/virt-df.pl:56
26052 "If used without any arguments, C<virt-df> checks with libvirt to get a list "
26053 "of all active and inactive guests, and performs a C<df>-type operation on "
26054 "each one in turn, printing out the results."
26058 #: ../tools/virt-df.pl:60
26060 "If used with any argument(s), C<virt-df> performs a C<df>-type operation on "
26061 "either the single named libvirt domain, or on the disk image(s) listed on "
26062 "the command line (which must all belong to a single VM). In this mode (with "
26063 "arguments), C<virt-df> will I<only work for a single guest>. If you want to "
26064 "run on multiple guests, then you have to invoke C<virt-df> multiple times."
26068 #: ../tools/virt-df.pl:67
26070 "Use the C<--csv> option to get a format which can be easily parsed by other "
26071 "programs. Other options are mostly similar to standard C<df> options. See "
26072 "below for the complete list."
26076 #: ../tools/virt-df.pl:107
26081 #: ../tools/virt-df.pl:109
26083 "Write out the results in CSV format (comma-separated values). This format "
26084 "can be imported easily into databases and spreadsheets, but read L</NOTE "
26085 "ABOUT CSV FORMAT> below."
26089 #: ../tools/virt-df.pl:134
26090 msgid "B<--human-readable> | B<-h>"
26094 #: ../tools/virt-df.pl:136
26095 msgid "Print sizes in human-readable format."
26099 #: ../tools/virt-df.pl:138
26100 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
26104 #: ../tools/virt-df.pl:144
26105 msgid "B<--inodes> | B<-i>"
26109 #: ../tools/virt-df.pl:146
26110 msgid "Print inodes instead of blocks."
26114 #: ../tools/virt-df.pl:152
26115 msgid "B<--one-per-guest>"
26119 #: ../tools/virt-df.pl:154
26121 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
26122 "disks from several guests to a single libguestfs appliance."
26126 #: ../tools/virt-df.pl:157
26127 msgid "You might use this option in the following circumstances:"
26131 #: ../tools/virt-df.pl:163
26133 "If you think an untrusted guest might actively try to exploit the libguestfs "
26134 "appliance kernel, then this prevents one guest from interfering with the "
26135 "stats printed for another guest."
26139 #: ../tools/virt-df.pl:169
26141 "If the kernel has a bug which stops it from accessing a filesystem in one "
26142 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
26143 "and report stats for further guests."
26147 #: ../tools/virt-df.pl:180
26152 #: ../tools/virt-df.pl:182
26154 "Print UUIDs instead of names. This is useful for following a guest even "
26155 "when the guest is migrated or renamed, or when two guests happen to have the "
26160 #: ../tools/virt-df.pl:186
26162 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
26163 "images, we still print the disk image name even when this option is "
26168 #: ../tools/virt-df.pl:609
26169 msgid "NOTE ABOUT CSV FORMAT"
26173 #: ../tools/virt-df.pl:611
26175 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
26176 "should be easy to parse, but it is definitely not easy to parse."
26180 #: ../tools/virt-df.pl:614
26182 "Myth: Just split fields at commas. Reality: This does I<not> work "
26183 "reliably. This example has two columns:"
26187 #: ../tools/virt-df.pl:617
26190 " \"foo,bar\",baz\n"
26195 #: ../tools/virt-df.pl:619
26197 "Myth: Read the file one line at a time. Reality: This does I<not> work "
26198 "reliably. This example has one row:"
26202 #: ../tools/virt-df.pl:622
26211 #: ../tools/virt-df.pl:625
26213 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
26214 "packaged in major Linux distributions)."
26218 #: ../tools/virt-df.pl:628
26220 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
26221 "or Python's built-in csv library)."
26225 #: ../tools/virt-df.pl:631
26226 msgid "Most spreadsheets and databases can import CSV directly."
26230 #: ../tools/virt-df.pl:642
26232 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
26233 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26237 #: ../tools/virt-ls.pl:34
26238 msgid "virt-ls - List files in a virtual machine"
26242 #: ../tools/virt-ls.pl:38
26245 " virt-ls [--options] domname directory\n"
26250 #: ../tools/virt-ls.pl:40
26253 " virt-ls [--options] disk.img [disk.img ...] directory\n"
26258 #: ../tools/virt-ls.pl:44
26260 "C<virt-ls> is a command line tool to list the names of files in a directory "
26261 "inside a virtual machine or disk image."
26265 #: ../tools/virt-ls.pl:47
26267 "C<virt-ls> is just a simple wrapper around L<libguestfs(3)> functionality. "
26268 "For more complex cases you should look at the L<guestfish(1)> tool."
26272 #: ../tools/virt-ls.pl:51
26274 "C<virt-ls> can be used in one of three modes: simple, long and recursive. A "
26275 "simple listing is like the ordinary L<ls(1)> command:"
26279 #: ../tools/virt-ls.pl:54
26282 " $ virt-ls myguest /\n"
26290 #: ../tools/virt-ls.pl:59
26291 msgid "With the C<-l> (C<--long>) option, C<virt-ls> shows more detail:"
26295 #: ../tools/virt-ls.pl:61
26298 " $ virt-ls -l myguest /\n"
26300 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
26301 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
26307 #: ../tools/virt-ls.pl:67
26309 "With the C<-R> (C<--recursive>) option, C<virt-ls> lists the names of files "
26310 "and directories recursively:"
26314 #: ../tools/virt-ls.pl:70
26317 " $ virt-ls -R myguest /tmp\n"
26325 #: ../tools/virt-ls.pl:75
26327 "You I<cannot> combine these options. To do more complicated things, use "
26332 #: ../tools/virt-ls.pl:131 ../tools/virt-list-filesystems.pl:103 ../tools/virt-list-partitions.pl:112
26333 msgid "B<-l> | B<--long>"
26337 #: ../tools/virt-ls.pl:133
26338 msgid "B<-R> | B<--recursive>"
26342 #: ../tools/virt-ls.pl:135
26344 "Select the mode. With neither of these options, C<virt-ls> produces a "
26345 "simple, flat list of the files in the named directory."
26349 #: ../tools/virt-ls.pl:138
26351 "C<virt-ls -l> produces a \"long listing\", which shows more detail (just "
26352 "like the plain C<ls -l> command)."
26356 #: ../tools/virt-ls.pl:141
26358 "C<virt-ls -R> produces a recursive list of files starting at the named "
26359 "directory. See the documentation for L<guestfs(3)/guestfs_find> for precise "
26364 #: ../tools/virt-ls.pl:145
26365 msgid "You cannot combine these options."
26369 #: ../tools/virt-ls.pl:234
26371 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
26372 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
26373 "L<http://libguestfs.org/>."
26377 #: ../tools/virt-ls.pl:249 ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:298
26378 msgid "Copyright (C) 2009 Red Hat Inc."
26382 #: ../tools/virt-resize.pl:42
26383 msgid "virt-resize - Resize a virtual machine disk"
26387 #: ../tools/virt-resize.pl:46
26390 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
26391 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
26392 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
26397 #: ../tools/virt-resize.pl:52
26399 "Virt-resize is a tool which can resize a virtual machine disk, making it "
26400 "larger or smaller overall, and resizing or deleting any partitions contained "
26405 #: ../tools/virt-resize.pl:56
26407 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
26408 "not> be used on live virtual machines - for consistent results, shut the "
26409 "virtual machine down before resizing it."
26413 #: ../tools/virt-resize.pl:60
26415 "If you are not familiar with the associated tools: "
26416 "L<virt-list-partitions(1)>, L<virt-list-filesystems(1)> and L<virt-df(1)>, "
26417 "we recommend you go and read those manual pages first."
26421 #: ../tools/virt-resize.pl:68
26423 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
26424 "fill the extra 5GB of space."
26428 #: ../tools/virt-resize.pl:71
26431 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
26432 " virt-list-partitions -lht olddisk\n"
26433 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
26434 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
26439 #: ../tools/virt-resize.pl:76
26441 "As above, but make the /boot partition 200MB bigger, while giving the "
26442 "remaining space to /dev/sda2:"
26446 #: ../tools/virt-resize.pl:79
26449 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
26454 #: ../tools/virt-resize.pl:81
26455 msgid "As above, but the output format will be uncompressed qcow2:"
26459 #: ../tools/virt-resize.pl:83
26462 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
26463 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
26468 #: ../tools/virt-resize.pl:86
26469 msgid "DETAILED USAGE"
26473 #: ../tools/virt-resize.pl:88
26474 msgid "EXPANDING A VIRTUAL MACHINE DISK"
26478 #: ../tools/virt-resize.pl:92
26479 msgid "1. Shut down the virtual machine"
26483 #: ../tools/virt-resize.pl:94
26484 msgid "2. Locate input disk image"
26488 #: ../tools/virt-resize.pl:96
26490 "Locate the input disk image (ie. the file or device on the host containing "
26491 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
26492 "dumpxml> like this to find the disk image name:"
26496 #: ../tools/virt-resize.pl:100
26499 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
26500 " Found 1 nodes:\n"
26502 " <source dev=\"/dev/vg/lv_guest\" />\n"
26507 #: ../tools/virt-resize.pl:105
26508 msgid "3. Look at current sizing"
26512 #: ../tools/virt-resize.pl:107
26513 msgid "Use L<virt-list-partitions(1)> to display the current partitions and sizes:"
26517 #: ../tools/virt-resize.pl:110
26520 " # virt-list-partitions -lht /dev/vg/lv_guest\n"
26521 " /dev/sda1 ext3 101.9M\n"
26522 " /dev/sda2 pv 7.9G\n"
26523 " /dev/sda device 8.0G\n"
26528 #: ../tools/virt-resize.pl:115
26530 "(This example is a virtual machine with an 8 GB disk which we would like to "
26531 "expand up to 10 GB)."
26535 #: ../tools/virt-resize.pl:118
26536 msgid "4. Create output disk"
26540 #: ../tools/virt-resize.pl:120
26542 "Virt-resize cannot do in-place disk modifications. You have to have space "
26543 "to store the resized output disk."
26547 #: ../tools/virt-resize.pl:123
26548 msgid "To store the resized disk image in a file, create a file of a suitable size:"
26552 #: ../tools/virt-resize.pl:126
26555 " # rm -f outdisk\n"
26556 " # truncate -s 10G outdisk\n"
26561 #: ../tools/virt-resize.pl:129
26562 msgid "Or use L<lvcreate(1)> to create a logical volume:"
26566 #: ../tools/virt-resize.pl:131
26569 " # lvcreate -L 10G -n lv_name vg_name\n"
26574 #: ../tools/virt-resize.pl:133
26575 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
26579 #: ../tools/virt-resize.pl:135
26582 " # virsh pool-list\n"
26583 " # virsh vol-create-as poolname newvol 10G\n"
26588 #: ../tools/virt-resize.pl:138
26593 #: ../tools/virt-resize.pl:140
26595 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
26596 "file) and the output disk. The output disk is the one created in the "
26601 #: ../tools/virt-resize.pl:144
26604 " # virt-resize indisk outdisk\n"
26609 #: ../tools/virt-resize.pl:146
26611 "This command just copies disk image C<indisk> to disk image C<outdisk> "
26612 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
26613 "larger, then an extra, empty partition is created at the end of the disk "
26614 "covering the extra space. If C<outdisk> is smaller, then it will give an "
26619 #: ../tools/virt-resize.pl:152
26621 "More realistically you'd want to expand existing partitions in the disk "
26622 "image by passing extra options (for the full list see the L</OPTIONS> "
26627 #: ../tools/virt-resize.pl:156
26629 "L</--expand> is the most useful option. It expands the named partition "
26630 "within the disk to fill any extra space:"
26634 #: ../tools/virt-resize.pl:159
26637 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
26642 #: ../tools/virt-resize.pl:161
26644 "(In this case, an extra partition is I<not> created at the end of the disk, "
26645 "because there will be no unused space)."
26649 #: ../tools/virt-resize.pl:164
26651 "L</--resize> is the other commonly used option. The following would "
26652 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
26653 "rest of the available space:"
26657 #: ../tools/virt-resize.pl:168
26660 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
26661 " indisk outdisk\n"
26666 #: ../tools/virt-resize.pl:171
26668 "If the expanded partition in the image contains a filesystem or LVM PV, then "
26669 "if virt-resize knows how, it will resize the contents, the equivalent of "
26670 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
26671 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
26672 "filesystems, so you would have to online resize them after booting the "
26673 "guest. And virt-resize also does not resize anything inside an LVM PV, it "
26674 "just resizes the PV itself and leaves the user to resize any LVs inside that "
26679 #: ../tools/virt-resize.pl:180
26680 msgid "Other options are covered below."
26684 #: ../tools/virt-resize.pl:182
26689 #: ../tools/virt-resize.pl:184
26690 msgid "Thoroughly test the new disk image I<before> discarding the old one."
26694 #: ../tools/virt-resize.pl:186
26695 msgid "If you are using libvirt, edit the XML to point at the new disk:"
26699 #: ../tools/virt-resize.pl:188
26702 " # virsh edit guestname\n"
26707 #: ../tools/virt-resize.pl:190
26709 "Change E<lt>source ...E<gt>, see "
26710 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
26714 #: ../tools/virt-resize.pl:193
26715 msgid "Then start up the domain with the new, resized disk:"
26719 #: ../tools/virt-resize.pl:195
26722 " # virsh start guestname\n"
26727 #: ../tools/virt-resize.pl:197
26729 "and check that it still works. See also the L</NOTES> section below for "
26730 "additional information."
26734 #: ../tools/virt-resize.pl:200
26735 msgid "7. Resize LVs etc inside the guest"
26739 #: ../tools/virt-resize.pl:202
26740 msgid "(This can also be done offline using L<guestfish(1)>)"
26744 #: ../tools/virt-resize.pl:204
26746 "Once the guest has booted you should see the new space available, at least "
26747 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
26748 "may need to resize LVs inside PVs, and also resize filesystem types that "
26749 "virt-resize does not know how to expand."
26753 #: ../tools/virt-resize.pl:211
26754 msgid "SHRINKING A VIRTUAL MACHINE DISK"
26758 #: ../tools/virt-resize.pl:213
26760 "Shrinking is somewhat more complex than expanding, and only an overview is "
26765 #: ../tools/virt-resize.pl:216
26767 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
26768 "filesystems). The user has to shrink content before passing the disk image "
26769 "to virt-resize, and virt-resize will check that the content has been shrunk "
26774 #: ../tools/virt-resize.pl:221
26775 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
26779 #: ../tools/virt-resize.pl:223
26781 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
26782 "steps 3 and 4 above to allocate a new disk image."
26786 #: ../tools/virt-resize.pl:226
26787 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
26791 #: ../tools/virt-resize.pl:229
26792 msgid "IGNORING OR DELETING PARTITIONS"
26796 #: ../tools/virt-resize.pl:231
26798 "virt-resize also gives a convenient way to ignore or delete partitions when "
26799 "copying from the input disk to the output disk. Ignoring a partition speeds "
26800 "up the copy where you don't care about the existing contents of a "
26801 "partition. Deleting a partition removes it completely, but note that it "
26802 "also renumbers any partitions after the one which is deleted, which can "
26803 "leave some guests unbootable."
26807 #: ../tools/virt-resize.pl:238
26808 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
26812 #: ../tools/virt-resize.pl:240
26814 "If the input disk is in qcow2 format, then you may prefer that the output is "
26815 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
26816 "the fly. The output format is simply determined by the format of the empty "
26817 "output container that you provide. Thus to create qcow2 output, use:"
26821 #: ../tools/virt-resize.pl:246
26824 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
26829 #: ../tools/virt-resize.pl:248
26830 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
26834 #: ../tools/virt-resize.pl:250
26835 msgid "Similarly, to get non-sparse raw output use:"
26839 #: ../tools/virt-resize.pl:252
26842 " fallocate -l size outdisk\n"
26847 #: ../tools/virt-resize.pl:254
26849 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
26850 "if=/dev/zero of=outdisk bs=1M count=..>)"
26854 #: ../tools/virt-resize.pl:267
26855 msgid "Display help."
26859 #: ../tools/virt-resize.pl:281
26860 msgid "B<--resize part=size>"
26864 #: ../tools/virt-resize.pl:283
26866 "Resize the named partition (expanding or shrinking it) so that it has the "
26871 #: ../tools/virt-resize.pl:286
26873 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
26874 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
26875 "Exabytes; or as a percentage of the current size; or as a relative number or "
26876 "percentage. For example:"
26880 #: ../tools/virt-resize.pl:291
26883 " --resize /dev/sda2=10G\n"
26888 #: ../tools/virt-resize.pl:293
26891 " --resize /dev/sda4=90%\n"
26896 #: ../tools/virt-resize.pl:295
26899 " --resize /dev/sda2=+1G\n"
26904 #: ../tools/virt-resize.pl:297
26907 " --resize /dev/sda2=-200M\n"
26912 #: ../tools/virt-resize.pl:299
26915 " --resize /dev/sda1=+128K\n"
26920 #: ../tools/virt-resize.pl:301
26923 " --resize /dev/sda1=+10%\n"
26928 #: ../tools/virt-resize.pl:303
26931 " --resize /dev/sda1=-10%\n"
26936 #: ../tools/virt-resize.pl:305
26938 "You can increase the size of any partition. Virt-resize will expand the "
26939 "direct content of the partition if it knows how (see C<--expand> below)."
26943 #: ../tools/virt-resize.pl:309
26945 "You can only I<decrease> the size of partitions that contain filesystems or "
26946 "PVs which have already been shrunk. Virt-resize will check this has been "
26947 "done before proceeding, or else will print an error (see also "
26948 "C<--resize-force>)."
26952 #: ../tools/virt-resize.pl:314 ../tools/virt-resize.pl:406 ../tools/virt-resize.pl:423
26953 msgid "You can give this option multiple times."
26957 #: ../tools/virt-resize.pl:320
26958 msgid "B<--resize-force part=size>"
26962 #: ../tools/virt-resize.pl:322
26964 "This is the same as C<--resize> except that it will let you decrease the "
26965 "size of any partition. Generally this means you will lose any data which "
26966 "was at the end of the partition you shrink, but you may not care about that "
26967 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
26968 "as a swap partition)."
26972 #: ../tools/virt-resize.pl:328
26973 msgid "See also the C<--ignore> option."
26977 #: ../tools/virt-resize.pl:334
26978 msgid "B<--expand part>"
26982 #: ../tools/virt-resize.pl:336
26984 "Expand the named partition so it uses up all extra space (space left over "
26985 "after any other resize changes that you request have been done)."
26989 #: ../tools/virt-resize.pl:339
26991 "If virt-resize knows how, it will expand the direct content of the "
26992 "partition. For example, if the partition is an LVM PV, it will expand the "
26993 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
26994 "content it doesn't know about alone."
26998 #: ../tools/virt-resize.pl:344
26999 msgid "Currently virt-resize can resize:"
27003 #: ../tools/virt-resize.pl:350
27005 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
27010 #: ../tools/virt-resize.pl:355
27012 "NTFS filesystems contained directly in a partition, if libguestfs was "
27013 "compiled with support for NTFS."
27017 #: ../tools/virt-resize.pl:358
27019 "The filesystem must have been shut down consistently last time it was used. "
27020 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
27021 "consistency check, so at the first boot after resizing Windows will check "
27026 #: ../tools/virt-resize.pl:365
27028 "LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
27029 "inside the PV. The user will have to resize LVs as desired."
27033 #: ../tools/virt-resize.pl:371 ../tools/virt-resize.pl:393
27034 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
27038 #: ../tools/virt-resize.pl:377
27039 msgid "B<--shrink part>"
27043 #: ../tools/virt-resize.pl:379
27045 "Shrink the named partition until the overall disk image fits in the "
27046 "destination. The named partition B<must> contain a filesystem or PV which "
27047 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
27048 "online tools). Virt-resize will check this and give an error if it has not "
27053 #: ../tools/virt-resize.pl:385
27055 "The amount by which the overall disk must be shrunk (after carrying out all "
27056 "other operations requested by the user) is called the \"deficit\". For "
27057 "example, a straight copy (assume no other operations) from a 5GB disk image "
27058 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
27059 "would give an error unless the user specified a partition to shrink and that "
27060 "partition had more than a gigabyte of free space."
27064 #: ../tools/virt-resize.pl:399
27065 msgid "B<--ignore part>"
27069 #: ../tools/virt-resize.pl:401
27071 "Ignore the named partition. Effectively this means the partition is "
27072 "allocated on the destination disk, but the content is not copied across from "
27073 "the source disk. The content of the partition will be blank (all zero "
27078 #: ../tools/virt-resize.pl:412
27079 msgid "B<--delete part>"
27083 #: ../tools/virt-resize.pl:414
27085 "Delete the named partition. It would be more accurate to describe this as "
27086 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
27087 "the original disk image is left intact."
27091 #: ../tools/virt-resize.pl:418
27093 "Note that when you delete a partition, then anything contained in the "
27094 "partition is also deleted. Furthermore, this causes any partitions that "
27095 "come after to be I<renumbered>, which can easily make your guest unbootable."
27099 #: ../tools/virt-resize.pl:429
27100 msgid "B<--LV-expand logvol>"
27104 #: ../tools/virt-resize.pl:431
27106 "This takes the logical volume and, as a final step, expands it to fill all "
27107 "the space available in its volume group. A typical usage, assuming a Linux "
27108 "guest with a single PV C</dev/sda2> and a root device called "
27109 "C</dev/vg_guest/lv_root> would be:"
27113 #: ../tools/virt-resize.pl:436
27116 " virt-resize indisk outdisk \\\n"
27117 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
27122 #: ../tools/virt-resize.pl:439
27124 "This would first expand the partition (and PV), and then expand the root "
27125 "device to fill the extra space in the PV."
27129 #: ../tools/virt-resize.pl:442
27131 "The contents of the LV are also resized if virt-resize knows how to do "
27132 "that. You can stop virt-resize from trying to expand the content by using "
27133 "the option C<--no-expand-content>."
27137 #: ../tools/virt-resize.pl:446
27138 msgid "Use L<virt-list-filesystems(1)> to list the filesystems in the guest."
27142 #: ../tools/virt-resize.pl:449
27144 "You can give this option multiple times, I<but> it doesn't make sense to do "
27145 "this unless the logical volumes you specify are all in different volume "
27150 #: ../tools/virt-resize.pl:457
27151 msgid "B<--no-copy-boot-loader>"
27155 #: ../tools/virt-resize.pl:459
27157 "By default, virt-resize copies over some sectors at the start of the disk "
27158 "(up to the beginning of the first partition). Commonly these sectors "
27159 "contain the Master Boot Record (MBR) and the boot loader, and are required "
27160 "in order for the guest to boot correctly."
27164 #: ../tools/virt-resize.pl:464
27166 "If you specify this flag, then this initial copy is not done. You may need "
27167 "to reinstall the boot loader in this case."
27171 #: ../tools/virt-resize.pl:472
27172 msgid "B<--no-extra-partition>"
27176 #: ../tools/virt-resize.pl:474
27178 "By default, virt-resize creates an extra partition if there is any extra, "
27179 "unused space after all resizing has happened. Use this option to prevent "
27180 "the extra partition from being created. If you do this then the extra space "
27181 "will be inaccessible until you run fdisk, parted, or some other partitioning "
27182 "tool in the guest."
27186 #: ../tools/virt-resize.pl:480
27188 "Note that if the surplus space is smaller than 10 MB, no extra partition "
27193 #: ../tools/virt-resize.pl:487
27194 msgid "B<--no-expand-content>"
27198 #: ../tools/virt-resize.pl:489
27200 "By default, virt-resize will try to expand the direct contents of "
27201 "partitions, if it knows how (see C<--expand> option above)."
27205 #: ../tools/virt-resize.pl:492
27207 "If you give the C<--no-expand-content> option then virt-resize will not "
27212 #: ../tools/virt-resize.pl:499
27213 msgid "B<-d> | B<--debug>"
27217 #: ../tools/virt-resize.pl:507
27218 msgid "B<-n> | B<--dryrun>"
27222 #: ../tools/virt-resize.pl:509
27223 msgid "Print a summary of what would be done, but don't do anything."
27227 #: ../tools/virt-resize.pl:515
27228 msgid "B<-q> | B<--quiet>"
27232 #: ../tools/virt-resize.pl:517
27233 msgid "Don't print the summary."
27237 #: ../tools/virt-resize.pl:525
27239 "Specify the format of the input disk image. If this flag is not given then "
27240 "it is auto-detected from the image itself."
27244 #: ../tools/virt-resize.pl:531
27246 "Note that this option I<does not> affect the output format. See L</QCOW2 "
27247 "AND NON-SPARSE RAW FORMATS>."
27251 #: ../tools/virt-resize.pl:538
27252 msgid "B<--output-format> raw"
27256 #: ../tools/virt-resize.pl:540
27258 "Specify the format of the output disk image. If this flag is not given then "
27259 "it is auto-detected from the image itself."
27263 #: ../tools/virt-resize.pl:546
27265 "Note that you still need to create the output disk with the right format. "
27266 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
27270 #: ../tools/virt-resize.pl:1422 ../tools/virt-rescue.pl:90
27275 #: ../tools/virt-resize.pl:1424
27276 msgid "\"Partition 1 does not end on cylinder boundary.\""
27280 #: ../tools/virt-resize.pl:1426
27282 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
27283 "means the partitions will not be aligned to the ancient CHS geometry. "
27284 "However CHS geometry is meaningless for disks manufactured since the early "
27285 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
27286 "cylinders is not required by any modern operating system."
27290 #: ../tools/virt-resize.pl:1433
27291 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
27295 #: ../tools/virt-resize.pl:1435
27297 "In Windows Vista and later versions, Microsoft switched to using a separate "
27298 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
27299 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
27300 "the boot partition. Doing so seems to break the guest completely. However "
27301 "expanding the second partition (ie. C: drive) should work."
27305 #: ../tools/virt-resize.pl:1442
27307 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
27308 "NTFS partitions have been expanded. This is just a safety check and (unless "
27309 "it find errors) is nothing to worry about."
27313 #: ../tools/virt-resize.pl:1446
27314 msgid "GUEST BOOT STUCK AT \"GRUB\""
27318 #: ../tools/virt-resize.pl:1448
27320 "If a Linux guest does not boot after resizing, and the boot is stuck after "
27321 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
27322 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
27323 "although we think is to do with partition alignment."
27327 #: ../tools/virt-resize.pl:1453
27330 " guestfish -i -a newdisk\n"
27331 " ><fs> cat /boot/grub/device.map\n"
27332 " # check the contents of this file are sensible or\n"
27333 " # edit the file if necessary\n"
27334 " ><fs> grub-install / /dev/vda\n"
27340 #: ../tools/virt-resize.pl:1460
27342 "For more flexible guest reconfiguration, including if you need to specify "
27343 "other parameters to grub-install, use L<virt-rescue(1)>."
27347 #: ../tools/virt-resize.pl:1463
27348 msgid "ALTERNATIVE TOOLS"
27352 #: ../tools/virt-resize.pl:1465
27354 "There are several proprietary tools for resizing partitions. We won't "
27355 "mention any here."
27359 #: ../tools/virt-resize.pl:1468
27361 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
27362 "operations on disk images. They can resize and move partitions, but I don't "
27363 "think they can do anything with the contents, and they certainly don't "
27368 #: ../tools/virt-resize.pl:1473
27370 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
27371 "but at a much lower level. You will probably end up hand-calculating sector "
27372 "offsets, which is something that virt-resize was designed to avoid. If you "
27373 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
27378 #: ../tools/virt-resize.pl:1488
27380 "L<virt-list-partitions(1)>, L<virt-list-filesystems(1)>, L<virt-df(1)>, "
27381 "L<guestfs(3)>, L<guestfish(1)>, L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, "
27382 "L<resize2fs(8)>, L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, "
27383 "L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, "
27384 "L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
27388 #: ../tools/virt-list-filesystems.pl:32
27389 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
27393 #: ../tools/virt-list-filesystems.pl:36
27396 " virt-list-filesystems [--options] domname\n"
27401 #: ../tools/virt-list-filesystems.pl:38
27404 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
27409 #: ../tools/virt-list-filesystems.pl:42
27411 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
27412 "are contained in a virtual machine or disk image."
27416 #: ../tools/virt-list-filesystems.pl:46
27418 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
27419 "functionality. For more complex cases you should look at the "
27420 "L<guestfish(1)> tool."
27424 #: ../tools/virt-list-filesystems.pl:105
27426 "With this option, C<virt-list-filesystems> displays the type of each "
27427 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
27431 #: ../tools/virt-list-filesystems.pl:112
27432 msgid "B<-a> | B<--all>"
27436 #: ../tools/virt-list-filesystems.pl:114
27438 "Normally we only show mountable filesystems. If this option is given then "
27439 "swap devices are shown too."
27443 #: ../tools/virt-list-filesystems.pl:188
27445 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
27446 "L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
27447 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27451 #: ../tools/virt-tar.pl:33
27452 msgid "virt-tar - Extract or upload files to a virtual machine"
27456 #: ../tools/virt-tar.pl:37
27459 " virt-tar [--options] -x domname directory tarball\n"
27464 #: ../tools/virt-tar.pl:39
27467 " virt-tar [--options] -u domname tarball directory\n"
27472 #: ../tools/virt-tar.pl:41
27475 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
27480 #: ../tools/virt-tar.pl:43
27483 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
27488 #: ../tools/virt-tar.pl:47
27489 msgid "Download C</home> from the VM into a local tarball:"
27493 #: ../tools/virt-tar.pl:49
27496 " virt-tar -x domname /home home.tar\n"
27501 #: ../tools/virt-tar.pl:51
27504 " virt-tar -zx domname /home home.tar.gz\n"
27509 #: ../tools/virt-tar.pl:53
27510 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
27514 #: ../tools/virt-tar.pl:55
27517 " virt-tar -u domname uploadstuff.tar /tmp\n"
27522 #: ../tools/virt-tar.pl:57
27525 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
27530 #: ../tools/virt-tar.pl:61
27532 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
27533 "virtual machines. If you do this, you risk disk corruption in the VM. "
27534 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
27538 #: ../tools/virt-tar.pl:66
27540 "You can use C<-x> (extract) on live virtual machines, but you might get "
27541 "inconsistent results or errors if there is filesystem activity inside the "
27542 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
27543 "work, but the only way to guarantee consistent results is if the virtual "
27544 "machine is shut down."
27548 #: ../tools/virt-tar.pl:74
27550 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
27551 "parts of a guest filesystem. There are many possibilities: making backups, "
27552 "uploading data files, snooping on guest activity, fixing or customizing "
27557 #: ../tools/virt-tar.pl:79
27559 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
27560 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
27561 "should look at the L<guestfish(1)> tool."
27565 #: ../tools/virt-tar.pl:83
27567 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
27568 "its contents (recursively) from the virtual machine into a local tarball. "
27569 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
27570 "virtual machine. You cannot use these two options together."
27574 #: ../tools/virt-tar.pl:89
27576 "In addition, you may need to use the C<-z> (gZip) option to enable "
27577 "compression. When uploading, you have to specify C<-z> if the upload file "
27578 "is compressed because virt-tar won't detect this on its own."
27582 #: ../tools/virt-tar.pl:93
27584 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
27585 "example it cannot do PKZip files or bzip2 compression. If you want that "
27586 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
27587 "the L<libguestfs(3)> API)."
27591 #: ../tools/virt-tar.pl:151
27592 msgid "B<-x> | B<--extract> | B<--download>"
27596 #: ../tools/virt-tar.pl:153
27597 msgid "B<-u> | B<--upload>"
27601 #: ../tools/virt-tar.pl:155
27603 "Use C<-x> to extract (download) a directory from a virtual machine to a "
27608 #: ../tools/virt-tar.pl:158
27610 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
27611 "Please read the L</WARNING> section above before using this option."
27615 #: ../tools/virt-tar.pl:162
27616 msgid "You must specify exactly one of these options."
27620 #: ../tools/virt-tar.pl:168
27621 msgid "B<-z> | B<--gzip>"
27625 #: ../tools/virt-tar.pl:170
27626 msgid "Specify that the input or output tarball is gzip-compressed."
27630 #: ../tools/virt-tar.pl:283
27632 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
27633 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
27634 "L<http://libguestfs.org/>."
27638 #: ../tools/virt-rescue.pl:33
27639 msgid "virt-rescue - Run a rescue shell on a virtual machine"
27643 #: ../tools/virt-rescue.pl:37
27646 " virt-rescue [--options] domname\n"
27651 #: ../tools/virt-rescue.pl:39
27654 " virt-rescue [--options] disk.img [disk.img ...]\n"
27659 #: ../tools/virt-rescue.pl:43
27661 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
27662 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
27663 "you from doing this, but doesn't catch all cases."
27667 #: ../tools/virt-rescue.pl:47
27669 "However if you use the I<--ro> (read only) option, then you can attach a "
27670 "shell to a live virtual machine. The results might be strange or "
27671 "inconsistent at times but you won't get disk corruption."
27675 #: ../tools/virt-rescue.pl:53
27677 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
27678 "need for a CD. virt-rescue gives you a rescue shell and some simple "
27679 "recovery tools which you can use to examine or rescue a virtual machine or "
27684 #: ../tools/virt-rescue.pl:58
27686 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
27687 "on disk image(s):"
27691 #: ../tools/virt-rescue.pl:61
27694 " virt-rescue GuestName\n"
27699 #: ../tools/virt-rescue.pl:63
27702 " virt-rescue --ro /path/to/disk.img\n"
27707 #: ../tools/virt-rescue.pl:65
27710 " virt-rescue /dev/sdc\n"
27715 #: ../tools/virt-rescue.pl:67
27716 msgid "For live VMs you I<must> use the --ro option."
27720 #: ../tools/virt-rescue.pl:69
27722 "When you run virt-rescue on a virtual machine or disk image, you are placed "
27723 "in an interactive bash shell where you can use many ordinary Linux "
27724 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
27725 "appliance. You must mount the virtual machine's filesystems by hand. There "
27726 "is an empty directory called C</sysroot> where you can mount filesystems."
27730 #: ../tools/virt-rescue.pl:76
27732 "In the example below, we list logical volumes, then choose one to mount "
27733 "under C</sysroot>:"
27737 #: ../tools/virt-rescue.pl:79
27741 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
27742 " lv_root vg_f11x64 -wi-a- 8.83G\n"
27743 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
27744 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
27745 " ><rescue> ls /sysroot\n"
27750 #: ../tools/virt-rescue.pl:86
27752 "If you don't know what filesystems are available on the virtual machine then "
27753 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
27757 #: ../tools/virt-rescue.pl:92
27759 "Virt-rescue can be used on I<any> disk image file or device, not just a "
27760 "virtual machine. For example you can use it on a blank file if you want to "
27761 "partition that file (although we would recommend using L<guestfish(1)> "
27762 "instead as it is more suitable for this purpose). You can even use "
27763 "virt-rescue on things like SD cards."
27767 #: ../tools/virt-rescue.pl:98
27769 "This tool is just designed for quick interactive hacking on a virtual "
27770 "machine. For more structured access to a virtual machine disk image, you "
27771 "should use L<guestfs(3)>. To get a structured shell that you can use to "
27772 "make scripted changes to guests, use L<guestfish(1)>."
27776 #: ../tools/virt-rescue.pl:127
27777 msgid "B<--append kernelopts>"
27781 #: ../tools/virt-rescue.pl:129
27782 msgid "Pass additional options to the rescue kernel."
27786 #: ../tools/virt-rescue.pl:164
27787 msgid "B<--memsize MB> | B<-m MB>"
27791 #: ../tools/virt-rescue.pl:166
27793 "Change the amount of memory allocated to the rescue system. The default is "
27794 "set by libguestfs and is small but adequate for running system tools. The "
27795 "occasional program might need more memory. The parameter is specified in "
27800 #: ../tools/virt-rescue.pl:175
27801 msgid "B<--network MB>"
27805 #: ../tools/virt-rescue.pl:177
27806 msgid "Enable QEMU user networking in the guest."
27810 #: ../tools/virt-rescue.pl:183
27811 msgid "B<--ro> | B<-r>"
27815 #: ../tools/virt-rescue.pl:185
27816 msgid "Open the image read-only."
27820 #: ../tools/virt-rescue.pl:197
27822 "Enable SELinux in the rescue appliance. You should read "
27823 "L<guestfs(3)/SELINUX> before using this option."
27827 #: ../tools/virt-rescue.pl:257
27829 "Several environment variables affect virt-rescue. See "
27830 "L<guestfs(3)/ENVIRONMENT VARIABLES> for the complete list."
27834 #: ../tools/virt-rescue.pl:269
27836 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
27837 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27841 #: ../tools/virt-make-fs.pl:37
27842 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
27846 #: ../tools/virt-make-fs.pl:41
27849 " virt-make-fs [--options] input.tar output.img\n"
27854 #: ../tools/virt-make-fs.pl:43
27857 " virt-make-fs [--options] input.tar.gz output.img\n"
27862 #: ../tools/virt-make-fs.pl:45
27865 " virt-make-fs [--options] directory output.img\n"
27870 #: ../tools/virt-make-fs.pl:49
27872 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
27873 "archive or some files in a directory. It is similar to tools like "
27874 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
27875 "it can create common filesystem types like ext2/3 or NTFS, which can be "
27876 "useful if you want to attach these filesystems to existing virtual machines "
27877 "(eg. to import large amounts of read-only data to a VM)."
27881 #: ../tools/virt-make-fs.pl:57
27882 msgid "Basic usage is:"
27886 #: ../tools/virt-make-fs.pl:59
27889 " virt-make-fs input output\n"
27894 #: ../tools/virt-make-fs.pl:61
27896 "where C<input> is either a directory containing files that you want to add, "
27897 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
27898 "C<output> is a disk image. The input type is detected automatically. The "
27899 "output disk image defaults to a raw ext2 image unless you specify extra "
27900 "flags (see L</OPTIONS> below)."
27904 #: ../tools/virt-make-fs.pl:67
27905 msgid "EXTRA SPACE"
27909 #: ../tools/virt-make-fs.pl:69
27911 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
27912 "the files that it contains, but might have extra space. Depending on how "
27913 "you are going to use the output, you might think this extra space is wasted "
27914 "and want to minimize it, or you might want to leave space so that more files "
27915 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
27916 "but you can use the C<--size> flag to leave space in the filesystem if you "
27921 #: ../tools/virt-make-fs.pl:77
27923 "An alternative way to leave extra space but not make the output image any "
27924 "bigger is to use an alternative disk image format (instead of the default "
27925 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
27926 "image format (check your hypervisor supports this before using it). This "
27927 "allows you to choose a large C<--size> but the extra space won't actually be "
27928 "allocated in the image until you try to store something in it."
27932 #: ../tools/virt-make-fs.pl:85
27934 "Don't forget that you can also use local commands including L<resize2fs(8)> "
27935 "and L<virt-resize(1)> to resize existing filesystems, or rerun "
27936 "virt-make-resize to build another image from scratch."
27940 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
27945 #: ../tools/virt-make-fs.pl:91
27948 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
27953 #: ../tools/virt-make-fs.pl:93
27954 msgid "FILESYSTEM TYPE"
27958 #: ../tools/virt-make-fs.pl:95
27960 "The default filesystem type is C<ext2>. Just about any filesystem type that "
27961 "libguestfs supports can be used (but I<not> read-only formats like "
27962 "ISO9660). Here are some of the more common choices:"
27966 #: ../tools/virt-make-fs.pl:101
27971 #: ../tools/virt-make-fs.pl:103
27973 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
27974 "you are not going to use the filesystem in a way that requires the journal, "
27975 "then this is just wasted overhead."
27979 #: ../tools/virt-make-fs.pl:107
27980 msgid "I<ntfs> or I<vfat>"
27984 #: ../tools/virt-make-fs.pl:109
27985 msgid "Useful if exporting data to a Windows guest."
27989 #: ../tools/virt-make-fs.pl:111
27991 "I<Note for vfat>: The tar archive or local directory must only contain files "
27992 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
27993 "program running within libguestfs is unable to change the ownership of "
27994 "non-root files, since vfat itself does not support this."
27998 #: ../tools/virt-make-fs.pl:116
28003 #: ../tools/virt-make-fs.pl:118
28005 "Lower overhead than C<ext2>, but certain limitations on filename length and "
28006 "total filesystem size."
28010 #: ../tools/virt-make-fs.pl:125
28013 " virt-make-fs --type=minix input minixfs.img\n"
28018 #: ../tools/virt-make-fs.pl:127
28019 msgid "TO PARTITION OR NOT TO PARTITION"
28023 #: ../tools/virt-make-fs.pl:129
28024 msgid "Optionally virt-make-fs can add a partition table to the output disk."
28028 #: ../tools/virt-make-fs.pl:131
28030 "Adding a partition can make the disk image more compatible with certain "
28031 "virtualized operating systems which don't expect to see a filesystem "
28032 "directly located on a block device (Linux doesn't care and will happily "
28033 "handle both types)."
28037 #: ../tools/virt-make-fs.pl:136
28039 "On the other hand, if you have a partition table then the output image is no "
28040 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
28041 "directly on a partitioned disk image. (However libguestfs tools such as "
28042 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
28046 #: ../tools/virt-make-fs.pl:144
28047 msgid "Add an MBR partition:"
28051 #: ../tools/virt-make-fs.pl:146
28054 " virt-make-fs --partition -- input disk.img\n"
28059 #: ../tools/virt-make-fs.pl:148
28061 "If the output disk image could be terabyte-sized or larger, it's better to "
28062 "use an EFI/GPT-compatible partition table:"
28066 #: ../tools/virt-make-fs.pl:151
28069 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
28074 #: ../tools/virt-make-fs.pl:179
28075 msgid "Enable debugging information."
28079 #: ../tools/virt-make-fs.pl:185
28080 msgid "B<--size=E<lt>NE<gt>>"
28084 #: ../tools/virt-make-fs.pl:187
28085 msgid "B<--size=+E<lt>NE<gt>>"
28089 #: ../tools/virt-make-fs.pl:189
28090 msgid "B<-s E<lt>NE<gt>>"
28094 #: ../tools/virt-make-fs.pl:191
28095 msgid "B<-s +E<lt>NE<gt>>"
28099 #: ../tools/virt-make-fs.pl:193
28100 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
28104 #: ../tools/virt-make-fs.pl:196
28106 "If this option is I<not> given, then the output image will be just large "
28107 "enough to contain all the files, with not much wasted space."
28111 #: ../tools/virt-make-fs.pl:199
28113 "To choose a fixed size output disk, specify an absolute number followed by "
28114 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28115 "Petabytes or Exabytes. This must be large enough to contain all the input "
28116 "files, else you will get an error."
28120 #: ../tools/virt-make-fs.pl:204
28122 "To leave extra space, specify C<+> (plus sign) and a number followed by "
28123 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28124 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
28125 "the input files, and (approximately) an extra 200 MB free space."
28129 #: ../tools/virt-make-fs.pl:210
28131 "Note that virt-make-fs estimates free space, and therefore will not produce "
28132 "filesystems containing precisely the free space requested. (It is much more "
28133 "expensive and time-consuming to produce a filesystem which has precisely the "
28134 "desired free space)."
28138 #: ../tools/virt-make-fs.pl:219
28139 msgid "B<--format=E<lt>fmtE<gt>>"
28143 #: ../tools/virt-make-fs.pl:221
28144 msgid "B<-F E<lt>fmtE<gt>>"
28148 #: ../tools/virt-make-fs.pl:223
28149 msgid "Choose the output disk image format."
28153 #: ../tools/virt-make-fs.pl:225
28154 msgid "The default is C<raw> (raw disk image)."
28158 #: ../tools/virt-make-fs.pl:227
28160 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
28161 "that would really make sense here is C<qcow2>."
28165 #: ../tools/virt-make-fs.pl:234
28166 msgid "B<--type=E<lt>fsE<gt>>"
28170 #: ../tools/virt-make-fs.pl:236
28171 msgid "B<-t E<lt>fsE<gt>>"
28175 #: ../tools/virt-make-fs.pl:238
28176 msgid "Choose the output filesystem type."
28180 #: ../tools/virt-make-fs.pl:240
28181 msgid "The default is C<ext2>."
28185 #: ../tools/virt-make-fs.pl:242
28186 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
28190 #: ../tools/virt-make-fs.pl:249
28191 msgid "B<--partition>"
28195 #: ../tools/virt-make-fs.pl:251
28196 msgid "B<--partition=E<lt>parttypeE<gt>>"
28200 #: ../tools/virt-make-fs.pl:253
28202 "If specified, this flag adds an MBR partition table to the output disk "
28207 #: ../tools/virt-make-fs.pl:256
28209 "You can change the partition table type, eg. C<--partition=gpt> for large "
28214 #: ../tools/virt-make-fs.pl:259
28216 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
28217 "might consider the next parameter to be the partition type. For example:"
28221 #: ../tools/virt-make-fs.pl:263
28224 " virt-make-fs --partition input.tar ...\n"
28229 #: ../tools/virt-make-fs.pl:265
28231 "would cause virt-make-fs to think you wanted to use a partition type of "
28232 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
28233 "dash) between options and the input file argument:"
28237 #: ../tools/virt-make-fs.pl:269
28240 " virt-make-fs --partition -- input.tar ...\n"
28245 #: ../tools/virt-make-fs.pl:536
28247 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
28248 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
28249 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28253 #: ../tools/virt-make-fs.pl:553
28256 " export LIBGUESTFS_DEBUG=1\n"
28257 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
28262 #: ../tools/virt-make-fs.pl:556
28264 "Attach /tmp/virt-make-fs.log to a new bug report at "
28265 "L<https://bugzilla.redhat.com/>"
28269 #: ../tools/virt-list-partitions.pl:32
28270 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
28274 #: ../tools/virt-list-partitions.pl:36
28277 " virt-list-partitions [--options] domname\n"
28282 #: ../tools/virt-list-partitions.pl:38
28285 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
28290 #: ../tools/virt-list-partitions.pl:42
28292 "C<virt-list-partitions> is a command line tool to list the partitions that "
28293 "are contained in a virtual machine or disk image. It is mainly useful as a "
28294 "first step to using L<virt-resize(1)>."
28298 #: ../tools/virt-list-partitions.pl:47
28300 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
28301 "functionality. For more complex cases you should look at the "
28302 "L<guestfish(1)> tool."
28306 #: ../tools/virt-list-partitions.pl:104
28307 msgid "B<-h> | B<--human-readable>"
28311 #: ../tools/virt-list-partitions.pl:106
28312 msgid "Show sizes in human-readable form (eg. \"1G\")."
28316 #: ../tools/virt-list-partitions.pl:114
28318 "With this option, C<virt-list-partitions> displays the type and size of each "
28319 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
28323 #: ../tools/virt-list-partitions.pl:121
28324 msgid "B<-t> | B<--total>"
28328 #: ../tools/virt-list-partitions.pl:123
28329 msgid "Display the total size of each block device (as a separate row or rows)."
28333 #: ../tools/virt-list-partitions.pl:256
28335 "L<guestfs(3)>, L<guestfish(1)>, L<virt-list-filesystems(1)>, "
28336 "L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
28337 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."