1 # SOME DESCRIPTIVE TITLE.
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
8 "Project-Id-Version: PACKAGE VERSION\n"
9 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
10 "POT-Creation-Date: 2010-09-21 22:15+0200\n"
11 "PO-Revision-Date: 2010-09-02 14:46+0100\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
20 #: ../src/guestfs.pod:1 ../fish/guestfish.pod:1
21 #: ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1
22 #: ../inspector/virt-inspector.pl:36 ../tools/virt-cat.pl:30
23 #: ../tools/virt-df.pl:32 ../tools/virt-edit.pl:31
24 #: ../tools/virt-list-filesystems.pl:28 ../tools/virt-list-partitions.pl:28
25 #: ../tools/virt-ls.pl:31 ../tools/virt-make-fs.pl:33
26 #: ../tools/virt-rescue.pl:29 ../tools/virt-resize.pl:38
27 #: ../tools/virt-tar.pl:30 ../tools/virt-win-reg.pl:34
32 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
33 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
34 #: ../inspector/virt-inspector.pl:38 ../tools/virt-cat.pl:32
35 #: ../tools/virt-df.pl:34 ../tools/virt-edit.pl:33
36 #: ../tools/virt-list-filesystems.pl:30 ../tools/virt-list-partitions.pl:30
37 #: ../tools/virt-ls.pl:33 ../tools/virt-make-fs.pl:35
38 #: ../tools/virt-rescue.pl:31 ../tools/virt-resize.pl:40
39 #: ../tools/virt-tar.pl:32 ../tools/virt-win-reg.pl:36
44 #: ../src/guestfs.pod:5
45 msgid "guestfs - Library for accessing and modifying virtual machine images"
49 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
50 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
51 #: ../inspector/virt-inspector.pl:42 ../tools/virt-cat.pl:36
52 #: ../tools/virt-df.pl:38 ../tools/virt-edit.pl:37
53 #: ../tools/virt-list-filesystems.pl:34 ../tools/virt-list-partitions.pl:34
54 #: ../tools/virt-ls.pl:37 ../tools/virt-make-fs.pl:39
55 #: ../tools/virt-rescue.pl:35 ../tools/virt-resize.pl:44
56 #: ../tools/virt-tar.pl:36 ../tools/virt-win-reg.pl:40
61 #: ../src/guestfs.pod:9
64 " #include <guestfs.h>\n"
69 #: ../src/guestfs.pod:11
72 " guestfs_h *g = guestfs_create ();\n"
73 " guestfs_add_drive (g, \"guest.img\");\n"
74 " guestfs_launch (g);\n"
75 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
76 " guestfs_touch (g, \"/hello\");\n"
77 " guestfs_umount (g, \"/\");\n"
78 " guestfs_sync (g);\n"
79 " guestfs_close (g);\n"
84 #: ../src/guestfs.pod:20
87 " cc prog.c -o prog -lguestfs\n"
89 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
94 #: ../src/guestfs.pod:24 ../fish/guestfish.pod:115
95 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:16
96 #: ../inspector/virt-inspector.pl:48 ../tools/virt-cat.pl:42
97 #: ../tools/virt-df.pl:46 ../tools/virt-edit.pl:51
98 #: ../tools/virt-list-filesystems.pl:40 ../tools/virt-list-partitions.pl:40
99 #: ../tools/virt-ls.pl:43 ../tools/virt-make-fs.pl:47
100 #: ../tools/virt-rescue.pl:51 ../tools/virt-resize.pl:50
101 #: ../tools/virt-tar.pl:73 ../tools/virt-win-reg.pl:64
106 #: ../src/guestfs.pod:26
108 "Libguestfs is a library for accessing and modifying guest disk images. "
109 "Amongst the things this is good for: making batch configuration changes to "
110 "guests, getting disk used/free statistics (see also: virt-df), migrating "
111 "between virtualization systems (see also: virt-p2v), performing partial "
112 "backups, performing partial guest clones, cloning guests and changing "
113 "registry/UUID/hostname info, and much else besides."
117 #: ../src/guestfs.pod:34
119 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
120 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
121 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
126 #: ../src/guestfs.pod:39
128 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
129 "what filesystem is in each LV, etc.). It can also run commands in the "
130 "context of the guest. Also you can access filesystems over FUSE."
134 #: ../src/guestfs.pod:44
136 "Libguestfs is a library that can be linked with C and C++ management "
137 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
138 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
143 #: ../src/guestfs.pod:49
145 "You don't need to be root to use libguestfs, although obviously you do need "
146 "enough permissions to access the disk images."
150 #: ../src/guestfs.pod:52
152 "Libguestfs is a large API because it can do many things. For a gentle "
153 "introduction, please read the L</API OVERVIEW> section next."
157 #: ../src/guestfs.pod:55
162 #: ../src/guestfs.pod:57
164 "This section provides a gentler overview of the libguestfs API. We also try "
165 "to group API calls together, where that may not be obvious from reading "
166 "about the individual calls in the main section of this manual."
170 #: ../src/guestfs.pod:62
175 #: ../src/guestfs.pod:64
177 "Before you can use libguestfs calls, you have to create a handle. Then you "
178 "must add at least one disk image to the handle, followed by launching the "
179 "handle, then performing whatever operations you want, and finally closing "
180 "the handle. By convention we use the single letter C<g> for the name of the "
181 "handle variable, although of course you can use any name you want."
185 #: ../src/guestfs.pod:71
186 msgid "The general structure of all libguestfs-using programs looks like this:"
190 #: ../src/guestfs.pod:74
193 " guestfs_h *g = guestfs_create ();\n"
198 #: ../src/guestfs.pod:76
201 " /* Call guestfs_add_drive additional times if there are\n"
202 " * multiple disk images.\n"
204 " guestfs_add_drive (g, \"guest.img\");\n"
209 #: ../src/guestfs.pod:81
212 " /* Most manipulation calls won't work until you've launched\n"
213 " * the handle 'g'. You have to do this _after_ adding drives\n"
214 " * and _before_ other commands.\n"
216 " guestfs_launch (g);\n"
221 #: ../src/guestfs.pod:87
224 " /* Now you can examine what partitions, LVs etc are available.\n"
226 " char **partitions = guestfs_list_partitions (g);\n"
227 " char **logvols = guestfs_lvs (g);\n"
232 #: ../src/guestfs.pod:92
235 " /* To access a filesystem in the image, you must mount it.\n"
237 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
242 #: ../src/guestfs.pod:96
245 " /* Now you can perform filesystem actions on the guest\n"
248 " guestfs_touch (g, \"/hello\");\n"
253 #: ../src/guestfs.pod:101
256 " /* You only need to call guestfs_sync if you have made\n"
257 " * changes to the guest image. (But if you've made changes\n"
258 " * then you *must* sync). See also: guestfs_umount and\n"
259 " * guestfs_umount_all calls.\n"
261 " guestfs_sync (g);\n"
266 #: ../src/guestfs.pod:108
269 " /* Close the handle 'g'. */\n"
270 " guestfs_close (g);\n"
275 #: ../src/guestfs.pod:111
277 "The code above doesn't include any error checking. In real code you should "
278 "check return values carefully for errors. In general all functions that "
279 "return integers return C<-1> on error, and all functions that return "
280 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
281 "how to handle errors, and consult the documentation for each function call "
282 "below to see precisely how they return error indications."
286 #: ../src/guestfs.pod:119
291 #: ../src/guestfs.pod:121
293 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
294 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
295 "actual block device, or simply an empty file of zeroes that you have created "
296 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
301 #: ../src/guestfs.pod:127
303 "You can add a disk read-only using L</guestfs_add_drive_ro>, in which case "
304 "libguestfs won't modify the file."
308 #: ../src/guestfs.pod:130
310 "Be extremely cautious if the disk image is in use, eg. if it is being used "
311 "by a virtual machine. Adding it read-write will almost certainly cause disk "
312 "corruption, but adding it read-only is safe."
316 #: ../src/guestfs.pod:134
318 "You must add at least one disk image, and you may add multiple disk images. "
319 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
320 "first one you added), C</dev/sdb> (for the second one you added), etc."
324 #: ../src/guestfs.pod:139
326 "Once L</guestfs_launch> has been called you cannot add any more images. You "
327 "can call L</guestfs_list_devices> to get a list of the device names, in the "
328 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
332 #: ../src/guestfs.pod:144
337 #: ../src/guestfs.pod:146
339 "Before you can read or write files, create directories and so on in a disk "
340 "image that contains filesystems, you have to mount those filesystems using "
341 "L</guestfs_mount>. If you already know that a disk image contains (for "
342 "example) one partition with a filesystem on that partition, then you can "
347 #: ../src/guestfs.pod:152
350 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
355 #: ../src/guestfs.pod:154
357 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
358 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
359 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>)."
363 #: ../src/guestfs.pod:158
365 "If you are given a disk image and you don't know what it contains then you "
366 "have to find out. Libguestfs can do that too: use L</"
367 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
368 "LVs, and either try mounting each to see what is mountable, or else examine "
369 "them with L</guestfs_vfs_type> or L</guestfs_file>. Libguestfs also has a "
370 "set of APIs for inspection of disk images (see L</INSPECTION> below). But "
371 "you might find it easier to look at higher level programs built on top of "
372 "libguestfs, in particular L<virt-inspector(1)>."
376 #: ../src/guestfs.pod:168
378 "To mount a disk image read-only, use L</guestfs_mount_ro>. There are "
379 "several other variations of the C<guestfs_mount_*> call."
383 #: ../src/guestfs.pod:171
384 msgid "FILESYSTEM ACCESS AND MODIFICATION"
388 #: ../src/guestfs.pod:173
390 "The majority of the libguestfs API consists of fairly low-level calls for "
391 "accessing and modifying the files, directories, symlinks etc on mounted "
392 "filesystems. There are over a hundred such calls which you can find listed "
393 "in detail below in this man page, and we don't even pretend to cover them "
394 "all in this overview."
398 #: ../src/guestfs.pod:179
400 "Specify filenames as full paths, starting with C<\"/\"> and including the "
405 #: ../src/guestfs.pod:182
407 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
408 "the file called C<\"etc/passwd\"> then you could do:"
412 #: ../src/guestfs.pod:185
415 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
420 #: ../src/guestfs.pod:187
422 "This would return C<data> as a newly allocated buffer containing the full "
423 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
424 "or C<NULL> if there was an error."
428 #: ../src/guestfs.pod:191
430 "As another example, to create a top-level directory on that filesystem "
431 "called C<\"var\"> you would do:"
435 #: ../src/guestfs.pod:194
438 " guestfs_mkdir (g, \"/var\");\n"
443 #: ../src/guestfs.pod:196
444 msgid "To create a symlink you could do:"
448 #: ../src/guestfs.pod:198
451 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
452 " \"/etc/rc3.d/S30portmap\");\n"
457 #: ../src/guestfs.pod:201
459 "Libguestfs will reject attempts to use relative paths and there is no "
460 "concept of a current working directory."
464 #: ../src/guestfs.pod:204
466 "Libguestfs can return errors in many situations: for example if the "
467 "filesystem isn't writable, or if a file or directory that you requested "
468 "doesn't exist. If you are using the C API (documented here) you have to "
469 "check for those error conditions after each call. (Other language bindings "
470 "turn these errors into exceptions)."
474 #: ../src/guestfs.pod:210
476 "File writes are affected by the per-handle umask, set by calling L</"
477 "guestfs_umask> and defaulting to 022. See L</UMASK>."
481 #: ../src/guestfs.pod:213
486 #: ../src/guestfs.pod:215
488 "Libguestfs contains API calls to read, create and modify partition tables on "
493 #: ../src/guestfs.pod:218
495 "In the common case where you want to create a single partition covering the "
496 "whole disk, you should use the L</guestfs_part_disk> call:"
500 #: ../src/guestfs.pod:222
503 " const char *parttype = \"mbr\";\n"
504 " if (disk_is_larger_than_2TB)\n"
505 " parttype = \"gpt\";\n"
506 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
511 #: ../src/guestfs.pod:227
513 "Obviously this effectively wipes anything that was on that disk image before."
517 #: ../src/guestfs.pod:230
522 #: ../src/guestfs.pod:232
524 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
525 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
526 "you familiarize yourself with the concepts of physical volumes, volume "
527 "groups and logical volumes."
531 #: ../src/guestfs.pod:237
533 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
534 "tldp.org/HOWTO/LVM-HOWTO/>."
538 #: ../src/guestfs.pod:240
543 #: ../src/guestfs.pod:242
545 "Use L</guestfs_cat> to download small, text only files. This call is "
546 "limited to files which are less than 2 MB and which cannot contain any ASCII "
547 "NUL (C<\\0>) characters. However it has a very simple to use API."
551 #: ../src/guestfs.pod:247
553 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
554 "bit data, since it returns a (pointer, size) pair. However it is still "
555 "limited to \"small\" files, less than 2 MB."
559 #: ../src/guestfs.pod:251
561 "L</guestfs_download> can be used to download any file, with no limits on "
562 "content or size (even files larger than 4 GB)."
566 #: ../src/guestfs.pod:254
568 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
572 #: ../src/guestfs.pod:257
577 #: ../src/guestfs.pod:259
579 "It's often the case that you want to write a file or files to the disk image."
583 #: ../src/guestfs.pod:262
585 "To write a small file with fixed content, use L</guestfs_write>. To create "
586 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
587 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
588 "of other functions for creating test files, for example L</guestfs_fill> and "
589 "L</guestfs_fill_pattern>."
593 #: ../src/guestfs.pod:268
595 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
596 "file content or size (even files larger than 4 GB)."
600 #: ../src/guestfs.pod:271
602 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
606 #: ../src/guestfs.pod:273
608 "However the fastest way to upload I<large numbers of arbitrary files> is to "
609 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
610 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
611 "in a predictable way (eg. adding it last after all other drives) then you "
612 "can get the device name from L</guestfs_list_devices> and mount it directly "
613 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
614 "portable between kernel versions, and they don't support labels or UUIDs. "
615 "If you want to pre-build an image or you need to mount it using a label or "
616 "UUID, use an ISO image instead."
620 #: ../src/guestfs.pod:284
625 #: ../src/guestfs.pod:286
627 "There are various different commands for copying between files and devices "
628 "and in and out of the guest filesystem. These are summarised in the table "
633 #: ../src/guestfs.pod:292
634 msgid "B<file> to B<file>"
638 #: ../src/guestfs.pod:294
640 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
641 "directories recursively."
645 #: ../src/guestfs.pod:297
646 msgid "B<file or device> to B<file or device>"
650 #: ../src/guestfs.pod:299
652 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
653 "devices in the guest."
657 #: ../src/guestfs.pod:302
658 msgid "Example: duplicate the contents of an LV:"
662 #: ../src/guestfs.pod:304
665 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
670 #: ../src/guestfs.pod:306
672 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
673 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
674 "guestfs_copy_size>."
678 #: ../src/guestfs.pod:310
679 msgid "B<file on the host> to B<file or device>"
683 #: ../src/guestfs.pod:312
684 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
688 #: ../src/guestfs.pod:314
689 msgid "B<file or device> to B<file on the host>"
693 #: ../src/guestfs.pod:316
694 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
698 #: ../src/guestfs.pod:320
699 msgid "LISTING FILES"
703 #: ../src/guestfs.pod:322
705 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
706 "L<guestfish(1)>-equivalent command C<ll>)."
710 #: ../src/guestfs.pod:325
712 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
713 "programs, as a flat list of strings."
717 #: ../src/guestfs.pod:328
719 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
720 "directory, plus additional information about each one. It is more "
721 "equivalent to using the L<readdir(3)> call on a local filesystem."
725 #: ../src/guestfs.pod:332
727 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
731 #: ../src/guestfs.pod:335
732 msgid "RUNNING COMMANDS"
736 #: ../src/guestfs.pod:337
738 "Although libguestfs is primarily an API for manipulating files inside guest "
739 "images, we also provide some limited facilities for running commands inside "
744 #: ../src/guestfs.pod:341
745 msgid "There are many limitations to this:"
749 #: ../src/guestfs.pod:345 ../src/guestfs.pod:350 ../src/guestfs.pod:355
750 #: ../src/guestfs.pod:359 ../src/guestfs.pod:364 ../src/guestfs.pod:368
751 #: ../src/guestfs.pod:373 ../src/guestfs.pod:1223 ../src/guestfs.pod:1228
752 #: ../src/guestfs.pod:1232 ../src/guestfs.pod:1334 ../src/guestfs.pod:1338
753 #: ../src/guestfs.pod:1342 ../src/guestfs.pod:1347 ../src/guestfs.pod:1355
754 #: ../src/guestfs.pod:1374 ../src/guestfs.pod:1382 ../src/guestfs.pod:1612
755 #: ../src/guestfs.pod:1618 ../src/guestfs.pod:1623 ../src/guestfs.pod:1629
756 #: ../src/guestfs.pod:1736 ../src/guestfs.pod:1740 ../src/guestfs.pod:1744
757 #: ../src/guestfs.pod:1748 ../src/guestfs-actions.pod:14
758 #: ../src/guestfs-actions.pod:21 ../src/guestfs-actions.pod:372
759 #: ../src/guestfs-actions.pod:380 ../src/guestfs-actions.pod:387
760 #: ../src/guestfs-actions.pod:394 ../src/guestfs-actions.pod:1285
761 #: ../src/guestfs-actions.pod:1289 ../src/guestfs-actions.pod:1293
762 #: ../src/guestfs-actions.pod:1297 ../src/guestfs-actions.pod:1305
763 #: ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:1313
764 #: ../src/guestfs-actions.pod:1323 ../src/guestfs-actions.pod:1327
765 #: ../src/guestfs-actions.pod:1331 ../src/guestfs-actions.pod:1454
766 #: ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1463
767 #: ../src/guestfs-actions.pod:1468 ../src/guestfs-actions.pod:1520
768 #: ../src/guestfs-actions.pod:1524 ../src/guestfs-actions.pod:1529
769 #: ../fish/guestfish.pod:316 ../fish/guestfish.pod:320
770 #: ../fish/guestfish.pod:324 ../fish/guestfish.pod:328
771 #: ../fish/guestfish-actions.pod:15 ../fish/guestfish-actions.pod:22
772 #: ../fish/guestfish-actions.pod:306 ../fish/guestfish-actions.pod:314
773 #: ../fish/guestfish-actions.pod:321 ../fish/guestfish-actions.pod:328
774 #: ../fish/guestfish-actions.pod:1023 ../fish/guestfish-actions.pod:1027
775 #: ../fish/guestfish-actions.pod:1031 ../fish/guestfish-actions.pod:1035
776 #: ../fish/guestfish-actions.pod:1043 ../fish/guestfish-actions.pod:1047
777 #: ../fish/guestfish-actions.pod:1051 ../fish/guestfish-actions.pod:1061
778 #: ../fish/guestfish-actions.pod:1065 ../fish/guestfish-actions.pod:1069
779 #: ../fish/guestfish-actions.pod:1159 ../fish/guestfish-actions.pod:1163
780 #: ../fish/guestfish-actions.pod:1168 ../fish/guestfish-actions.pod:1173
781 #: ../fish/guestfish-actions.pod:1215 ../fish/guestfish-actions.pod:1219
782 #: ../fish/guestfish-actions.pod:1224 ../tools/virt-df.pl:144
783 #: ../tools/virt-df.pl:150 ../tools/virt-resize.pl:324
784 #: ../tools/virt-resize.pl:329 ../tools/virt-resize.pl:339
789 #: ../src/guestfs.pod:347
791 "The kernel version that the command runs under will be different from what "
796 #: ../src/guestfs.pod:352
798 "If the command needs to communicate with daemons, then most likely they "
803 #: ../src/guestfs.pod:357
804 msgid "The command will be running in limited memory."
808 #: ../src/guestfs.pod:361
810 "The network may not be available unless you enable it (see L</"
811 "guestfs_set_network>)."
815 #: ../src/guestfs.pod:366
816 msgid "Only supports Linux guests (not Windows, BSD, etc)."
820 #: ../src/guestfs.pod:370
822 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
826 #: ../src/guestfs.pod:375
828 "For SELinux guests, you may need to enable SELinux and load policy first. "
829 "See L</SELINUX> in this manpage."
833 #: ../src/guestfs.pod:380
835 "The two main API calls to run commands are L</guestfs_command> and L</"
836 "guestfs_sh> (there are also variations)."
840 #: ../src/guestfs.pod:383
842 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
843 "shell globs, redirections, etc will work."
847 #: ../src/guestfs.pod:386
848 msgid "CONFIGURATION FILES"
852 #: ../src/guestfs.pod:388
854 "To read and write configuration files in Linux guest filesystems, we "
855 "strongly recommend using Augeas. For example, Augeas understands how to "
856 "read and write, say, a Linux shadow password file or X.org configuration "
857 "file, and so avoids you having to write that code."
861 #: ../src/guestfs.pod:393
863 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
864 "document Augeas itself here because there is excellent documentation on the "
865 "L<http://augeas.net/> website."
869 #: ../src/guestfs.pod:397
871 "If you don't want to use Augeas (you fool!) then try calling L</"
872 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
877 #: ../src/guestfs.pod:401
882 #: ../src/guestfs.pod:403
884 "We support SELinux guests. To ensure that labeling happens correctly in "
885 "SELinux guests, you need to enable SELinux and load the guest's policy:"
889 #: ../src/guestfs.pod:409
894 #: ../src/guestfs.pod:411
895 msgid "Before launching, do:"
899 #: ../src/guestfs.pod:413
902 " guestfs_set_selinux (g, 1);\n"
907 #: ../src/guestfs.pod:415
912 #: ../src/guestfs.pod:417
914 "After mounting the guest's filesystem(s), load the policy. This is best "
915 "done by running the L<load_policy(8)> command in the guest itself:"
919 #: ../src/guestfs.pod:421
922 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
927 #: ../src/guestfs.pod:423
929 "(Older versions of C<load_policy> require you to specify the name of the "
934 #: ../src/guestfs.pod:426
939 #: ../src/guestfs.pod:428
941 "Optionally, set the security context for the API. The correct security "
942 "context to use can only be known by inspecting the guest. As an example:"
946 #: ../src/guestfs.pod:432
949 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
954 #: ../src/guestfs.pod:436
955 msgid "This will work for running commands and editing existing files."
959 #: ../src/guestfs.pod:438
961 "When new files are created, you may need to label them explicitly, for "
962 "example by running the external command C<restorecon pathname>."
966 #: ../src/guestfs.pod:442
971 #: ../src/guestfs.pod:444
973 "Certain calls are affected by the current file mode creation mask (the "
974 "\"umask\"). In particular ones which create files or directories, such as "
975 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
976 "either the default mode that the file is created with or modifies the mode "
981 #: ../src/guestfs.pod:450
983 "The default umask is C<022>, so files are created with modes such as C<0644> "
984 "and directories with C<0755>."
988 #: ../src/guestfs.pod:453
990 "There are two ways to avoid being affected by umask. Either set umask to 0 "
991 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
992 "guestfs_chmod> after creating each file or directory."
996 #: ../src/guestfs.pod:457
997 msgid "For more information about umask, see L<umask(2)>."
1001 #: ../src/guestfs.pod:459 ../fish/guestfish.pod:566
1002 msgid "ENCRYPTED DISKS"
1006 #: ../src/guestfs.pod:461
1008 "Libguestfs allows you to access Linux guests which have been encrypted using "
1009 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1010 "standard. This includes nearly all whole disk encryption systems used by "
1011 "modern Linux guests."
1015 #: ../src/guestfs.pod:467
1017 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1018 "returns the string C<crypto_LUKS>)."
1022 #: ../src/guestfs.pod:470
1024 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1025 "will require the passphrase!"
1029 #: ../src/guestfs.pod:473
1031 "Opening a LUKS device creates a new device mapper device called C</dev/"
1032 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1033 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1034 "from and encrypted to the underlying block device respectively."
1038 #: ../src/guestfs.pod:479
1040 "LVM volume groups on the device can be made visible by calling L</"
1041 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1042 "(s) can now be mounted in the usual way."
1046 #: ../src/guestfs.pod:483
1048 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1049 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1050 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1051 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1052 "underlying encrypted block device)."
1056 #: ../src/guestfs.pod:490
1061 #: ../src/guestfs.pod:492
1063 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1064 "contains operating systems. (These APIs used to be in a separate Perl-only "
1065 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1066 "frequently used part of this library has been rewritten in C and moved into "
1071 #: ../src/guestfs.pod:498
1073 "Add all disks belonging to the unknown virtual machine and call L</"
1074 "guestfs_launch> in the usual way."
1078 #: ../src/guestfs.pod:501
1080 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1081 "and certain heuristics, and returns a list of operating systems that were "
1082 "found. An empty list means none were found. A single element is the root "
1083 "filesystem of the operating system. For dual- or multi-boot guests, "
1084 "multiple roots can be returned, each one corresponding to a separate "
1085 "operating system. (Multi-boot virtual machines are extremely rare in the "
1086 "world of virtualization, but since this scenario can happen, we have built "
1087 "libguestfs to deal with it.)"
1091 #: ../src/guestfs.pod:510
1093 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1094 "to get additional details about that operating system. For example, call L</"
1095 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1096 "Windows and Linux-based operating systems respectively."
1100 #: ../src/guestfs.pod:516
1102 "Un*x-like and Linux-based operating systems usually consist of several "
1103 "filesystems which are mounted at boot time (for example, a separate boot "
1104 "partition mounted on C</boot>). The inspection rules are able to detect how "
1105 "filesystems correspond to mount points. Call "
1106 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1107 "hash table like this example:"
1111 #: ../src/guestfs.pod:523
1114 " /boot => /dev/sda1\n"
1115 " / => /dev/vg_guest/lv_root\n"
1116 " /usr => /dev/vg_guest/lv_usr\n"
1121 #: ../src/guestfs.pod:527
1123 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1124 "filesystems as suggested."
1128 #: ../src/guestfs.pod:530
1130 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1131 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1135 #: ../src/guestfs.pod:534
1137 "Inspection currently only works for some common operating systems. "
1138 "Contributors are welcome to send patches for other operating systems that we "
1139 "currently cannot detect."
1143 #: ../src/guestfs.pod:538
1145 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1146 "for more details. The L</guestfs_inspect_os> function just ignores any "
1147 "encrypted devices."
1151 #: ../src/guestfs.pod:542
1153 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1154 "inspection and caches the results in the guest handle. Subsequent calls to "
1155 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1156 "read the disks. If you change the content of the guest disks, you can redo "
1157 "inspection by calling L</guestfs_inspect_os> again."
1161 #: ../src/guestfs.pod:549
1162 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1166 #: ../src/guestfs.pod:551
1168 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1169 "ntfs-3g.org/> driver."
1173 #: ../src/guestfs.pod:554
1175 "DOS and Windows still use drive letters, and the filesystems are always "
1176 "treated as case insensitive by Windows itself, and therefore you might find "
1177 "a Windows configuration file referring to a path like C<c:\\windows"
1178 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1179 "might be referred to as C</WINDOWS/System32>."
1183 #: ../src/guestfs.pod:560
1185 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1186 "libguestfs to read the appropriate Windows Registry and configuration files, "
1187 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1192 #: ../src/guestfs.pod:565
1194 "Replacing backslash characters with forward slash characters is also outside "
1195 "the scope of libguestfs, but something that you can easily do."
1199 #: ../src/guestfs.pod:568
1201 "Where we can help is in resolving the case insensitivity of paths. For "
1202 "this, call L</guestfs_case_sensitive_path>."
1206 #: ../src/guestfs.pod:571
1208 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1209 "files, through the library C<hivex> which is part of the libguestfs project "
1210 "although ships as a separate tarball. You have to locate and download the "
1211 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1212 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1213 "reg(1)> for more help on this issue."
1217 #: ../src/guestfs.pod:579
1218 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1222 #: ../src/guestfs.pod:581
1224 "Although we don't want to discourage you from using the C API, we will "
1225 "mention here that the same API is also available in other languages."
1229 #: ../src/guestfs.pod:584
1231 "The API is broadly identical in all supported languages. This means that "
1232 "the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, C<g."
1233 "mount(path)> in Python, and C<Guestfs.mount g path> in OCaml. In other "
1234 "words, a straightforward, predictable isomorphism between each language."
1238 #: ../src/guestfs.pod:590
1240 "Error messages are automatically transformed into exceptions if the language "
1245 #: ../src/guestfs.pod:593
1247 "We don't try to \"object orientify\" parts of the API in OO languages, "
1248 "although contributors are welcome to write higher level APIs above what we "
1249 "provide in their favourite languages if they wish."
1253 #: ../src/guestfs.pod:599
1258 #: ../src/guestfs.pod:601
1260 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1261 "identical to the C API. C++ classes and exceptions are not used."
1265 #: ../src/guestfs.pod:605
1270 #: ../src/guestfs.pod:607
1272 "The C# bindings are highly experimental. Please read the warnings at the "
1273 "top of C<csharp/Libguestfs.cs>."
1277 #: ../src/guestfs.pod:610
1282 #: ../src/guestfs.pod:612
1284 "This is the only language binding that is working but incomplete. Only "
1285 "calls which return simple integers have been bound in Haskell, and we are "
1286 "looking for help to complete this binding."
1290 #: ../src/guestfs.pod:616
1295 #: ../src/guestfs.pod:618
1297 "Full documentation is contained in the Javadoc which is distributed with "
1302 #: ../src/guestfs.pod:621
1307 #: ../src/guestfs.pod:623
1308 msgid "For documentation see the file C<guestfs.mli>."
1312 #: ../src/guestfs.pod:625
1317 #: ../src/guestfs.pod:627
1318 msgid "For documentation see L<Sys::Guestfs(3)>."
1322 #: ../src/guestfs.pod:629
1327 #: ../src/guestfs.pod:631
1329 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1330 "the php-libguestfs package for your distribution."
1334 #: ../src/guestfs.pod:634
1335 msgid "The PHP binding only works correctly on 64 bit machines."
1339 #: ../src/guestfs.pod:636
1344 #: ../src/guestfs.pod:638
1345 msgid "For documentation do:"
1349 #: ../src/guestfs.pod:640
1353 " >>> import guestfs\n"
1354 " >>> help (guestfs)\n"
1359 #: ../src/guestfs.pod:644
1364 #: ../src/guestfs.pod:646
1366 "Use the Guestfs module. There is no Ruby-specific documentation, but you "
1367 "can find examples written in Ruby in the libguestfs source."
1371 #: ../src/guestfs.pod:649
1372 msgid "B<shell scripts>"
1376 #: ../src/guestfs.pod:651
1377 msgid "For documentation see L<guestfish(1)>."
1381 #: ../src/guestfs.pod:655
1382 msgid "LIBGUESTFS GOTCHAS"
1386 #: ../src/guestfs.pod:657
1388 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1389 "system [...] that works in the way it is documented but is counterintuitive "
1390 "and almost invites mistakes.\""
1394 #: ../src/guestfs.pod:661
1396 "Since we developed libguestfs and the associated tools, there are several "
1397 "things we would have designed differently, but are now stuck with for "
1398 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1399 "release, you can expect these to change. Beware of them."
1403 #: ../src/guestfs.pod:669
1404 msgid "Autosync / forgetting to sync."
1408 #: ../src/guestfs.pod:671
1410 "When modifying a filesystem from C or another language, you B<must> unmount "
1411 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1412 "libguestfs handle. You can also call:"
1416 #: ../src/guestfs.pod:675
1419 " guestfs_set_autosync (g, 1);\n"
1424 #: ../src/guestfs.pod:677
1426 "to have the unmount/sync done automatically for you when the handle 'g' is "
1427 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1431 #: ../src/guestfs.pod:681
1433 "If you forget to do this, then it is entirely possible that your changes "
1434 "won't be written out, or will be partially written, or (very rarely) that "
1435 "you'll get disk corruption."
1439 #: ../src/guestfs.pod:685
1441 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1442 "guestfish scripts that forget to sync will work just fine, which can make "
1443 "this very puzzling if you are trying to debug a problem."
1447 #: ../src/guestfs.pod:689
1448 msgid "Mount option C<-o sync> should not be the default."
1452 #: ../src/guestfs.pod:691
1454 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1455 "However C<-o sync> does not add any reliability benefit, but does have a "
1456 "very large performance impact."
1460 #: ../src/guestfs.pod:695
1462 "The work around is to use L</guestfs_mount_options> and set the mount "
1463 "options that you actually want to use."
1467 #: ../src/guestfs.pod:698
1468 msgid "Read-only should be the default."
1472 #: ../src/guestfs.pod:700
1474 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1475 "specify I<--rw> if you want to make changes to the image."
1479 #: ../src/guestfs.pod:703
1480 msgid "This would reduce the potential to corrupt live VM images."
1484 #: ../src/guestfs.pod:705
1486 "Note that many filesystems change the disk when you just mount and unmount, "
1487 "even if you didn't perform any writes. You need to use L</"
1488 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1492 #: ../src/guestfs.pod:709
1493 msgid "guestfish command line is hard to use."
1497 #: ../src/guestfs.pod:711
1499 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1500 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1501 "exist, so it fails. In earlier versions of guestfish the error message was "
1502 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1503 "we should have used C<guestfish -c command> to run commands."
1507 #: ../src/guestfs.pod:718
1508 msgid "guestfish megabyte modifiers don't work right on all commands"
1512 #: ../src/guestfs.pod:720
1514 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1515 "other modifiers). What guestfish actually does is to multiply the number "
1516 "part by the modifier part and pass the result to the C API. However this "
1517 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1518 "expecting some other unit (eg. megabytes)."
1522 #: ../src/guestfs.pod:727
1523 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1527 #: ../src/guestfs.pod:729
1530 " lvcreate LV VG 100M\n"
1535 #: ../src/guestfs.pod:731
1537 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1538 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1539 "megabytes * megabytes) logical volume. The error message you get from this "
1540 "is also a little obscure."
1544 #: ../src/guestfs.pod:736
1546 "This could be fixed in the generator by specially marking parameters and "
1547 "return values which take bytes or other units."
1551 #: ../src/guestfs.pod:739
1552 msgid "Library should return errno with error messages."
1556 #: ../src/guestfs.pod:741
1558 "It would be a nice-to-have to be able to get the original value of 'errno' "
1559 "from inside the appliance along error paths (where set). Currently "
1560 "L<guestmount(1)> goes through hoops to try to reverse the error message "
1561 "string into an errno, see the function error() in fuse/guestmount.c."
1565 #: ../src/guestfs.pod:747
1567 "In libguestfs 1.5.4, the protocol was changed so that the Linux errno is "
1568 "sent back from the daemon."
1572 #: ../src/guestfs.pod:752
1573 msgid "PROTOCOL LIMITS"
1577 #: ../src/guestfs.pod:754
1579 "Internally libguestfs uses a message-based protocol to pass API calls and "
1580 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1581 "plenty more detail about this). The maximum message size used by the "
1582 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1583 "aware of this limit. The API calls which may be affected are individually "
1584 "documented, with a link back to this section of the documentation."
1588 #: ../src/guestfs.pod:762
1590 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1591 "a simple string. Because this string is at some point internally encoded as "
1592 "a message, the maximum size that it can return is slightly under 4 MB. If "
1593 "the requested file is larger than this then you will get an error."
1597 #: ../src/guestfs.pod:768
1599 "In order to transfer large files into and out of the guest filesystem, you "
1600 "need to use particular calls that support this. The sections L</UPLOADING> "
1601 "and L</DOWNLOADING> document how to do this."
1605 #: ../src/guestfs.pod:772
1607 "You might also consider mounting the disk image using our FUSE filesystem "
1608 "support (L<guestmount(1)>)."
1612 #: ../src/guestfs.pod:775
1613 msgid "KEYS AND PASSPHRASES"
1617 #: ../src/guestfs.pod:777
1619 "Certain libguestfs calls take a parameter that contains sensitive key "
1620 "material, passed in as a C string."
1624 #: ../src/guestfs.pod:780
1626 "In the future we would hope to change the libguestfs implementation so that "
1627 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1628 "swap. However this is I<not> done at the moment, because of the complexity "
1629 "of such an implementation."
1633 #: ../src/guestfs.pod:785
1635 "Therefore you should be aware that any key parameter you pass to libguestfs "
1636 "might end up being written out to the swap partition. If this is a concern, "
1637 "scrub the swap partition or don't use libguestfs on encrypted devices."
1641 #: ../src/guestfs.pod:790
1642 msgid "CONNECTION MANAGEMENT"
1646 #: ../src/guestfs.pod:792
1651 #: ../src/guestfs.pod:794
1653 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
1654 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
1655 "handle and release all resources used."
1659 #: ../src/guestfs.pod:798
1661 "For information on using multiple handles and threads, see the section L</"
1662 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
1666 #: ../src/guestfs.pod:801
1667 msgid "guestfs_create"
1671 #: ../src/guestfs.pod:803
1674 " guestfs_h *guestfs_create (void);\n"
1679 #: ../src/guestfs.pod:805
1680 msgid "Create a connection handle."
1684 #: ../src/guestfs.pod:807
1685 msgid "You have to call L</guestfs_add_drive> on the handle at least once."
1689 #: ../src/guestfs.pod:809
1691 "This function returns a non-NULL pointer to a handle on success or NULL on "
1696 #: ../src/guestfs.pod:812
1697 msgid "After configuring the handle, you have to call L</guestfs_launch>."
1701 #: ../src/guestfs.pod:814
1703 "You may also want to configure error handling for the handle. See L</ERROR "
1704 "HANDLING> section below."
1708 #: ../src/guestfs.pod:817
1709 msgid "guestfs_close"
1713 #: ../src/guestfs.pod:819
1716 " void guestfs_close (guestfs_h *g);\n"
1721 #: ../src/guestfs.pod:821
1722 msgid "This closes the connection handle and frees up all resources used."
1726 #: ../src/guestfs.pod:823
1727 msgid "ERROR HANDLING"
1731 #: ../src/guestfs.pod:825
1733 "The convention in all functions that return C<int> is that they return C<-1> "
1734 "to indicate an error. You can get additional information on errors by "
1735 "calling L</guestfs_last_error> and/or by setting up an error handler with L</"
1736 "guestfs_set_error_handler>."
1740 #: ../src/guestfs.pod:830
1741 msgid "The default error handler prints the information string to C<stderr>."
1745 #: ../src/guestfs.pod:832
1747 "Out of memory errors are handled differently. The default action is to call "
1748 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
1749 "guestfs_set_out_of_memory_handler>."
1753 #: ../src/guestfs.pod:836
1754 msgid "guestfs_last_error"
1758 #: ../src/guestfs.pod:838
1761 " const char *guestfs_last_error (guestfs_h *g);\n"
1766 #: ../src/guestfs.pod:840
1768 "This returns the last error message that happened on C<g>. If there has not "
1769 "been an error since the handle was created, then this returns C<NULL>."
1773 #: ../src/guestfs.pod:844
1775 "The lifetime of the returned string is until the next error occurs, or L</"
1776 "guestfs_close> is called."
1780 #: ../src/guestfs.pod:847
1782 "The error string is not localized (ie. is always in English), because this "
1783 "makes searching for error messages in search engines give the largest number "
1788 #: ../src/guestfs.pod:851
1789 msgid "guestfs_set_error_handler"
1793 #: ../src/guestfs.pod:853
1796 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
1798 " const char *msg);\n"
1799 " void guestfs_set_error_handler (guestfs_h *g,\n"
1800 " guestfs_error_handler_cb cb,\n"
1806 #: ../src/guestfs.pod:860
1808 "The callback C<cb> will be called if there is an error. The parameters "
1809 "passed to the callback are an opaque data pointer and the error message "
1814 #: ../src/guestfs.pod:864
1816 "Note that the message string C<msg> is freed as soon as the callback "
1817 "function returns, so if you want to stash it somewhere you must make your "
1822 #: ../src/guestfs.pod:868
1823 msgid "The default handler prints messages on C<stderr>."
1827 #: ../src/guestfs.pod:870
1828 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
1832 #: ../src/guestfs.pod:872
1833 msgid "guestfs_get_error_handler"
1837 #: ../src/guestfs.pod:874
1840 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
1841 " void **opaque_rtn);\n"
1846 #: ../src/guestfs.pod:877
1847 msgid "Returns the current error handler callback."
1851 #: ../src/guestfs.pod:879
1852 msgid "guestfs_set_out_of_memory_handler"
1856 #: ../src/guestfs.pod:881
1859 " typedef void (*guestfs_abort_cb) (void);\n"
1860 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
1861 " guestfs_abort_cb);\n"
1866 #: ../src/guestfs.pod:885
1868 "The callback C<cb> will be called if there is an out of memory situation. "
1869 "I<Note this callback must not return>."
1873 #: ../src/guestfs.pod:888
1874 msgid "The default is to call L<abort(3)>."
1878 #: ../src/guestfs.pod:890
1880 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
1884 #: ../src/guestfs.pod:893
1885 msgid "guestfs_get_out_of_memory_handler"
1889 #: ../src/guestfs.pod:895
1892 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
1897 #: ../src/guestfs.pod:897
1898 msgid "This returns the current out of memory handler."
1902 #: ../src/guestfs.pod:899
1907 #: ../src/guestfs.pod:901
1909 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
1914 #: ../src/guestfs.pod:904
1916 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1917 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1921 #: ../src/guestfs.pod:907
1923 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1924 "to change the directories that libguestfs will search in. The value is a "
1925 "colon-separated list of paths. The current directory is I<not> searched "
1926 "unless the path contains an empty element or C<.>. For example "
1927 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1928 "then C</usr/lib/guestfs>."
1932 #: ../src/guestfs.pod:914
1933 msgid "HIGH-LEVEL API ACTIONS"
1937 #: ../src/guestfs.pod:916
1938 msgid "ABI GUARANTEE"
1942 #: ../src/guestfs.pod:918
1944 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
1945 "actions as outlined in this section. Although we will deprecate some "
1946 "actions, for example if they get replaced by newer calls, we will keep the "
1947 "old actions forever. This allows you the developer to program in confidence "
1948 "against the libguestfs API."
1952 #: ../src/guestfs.pod:924 ../fish/guestfish.pod:796
1957 #: ../src/guestfs.pod:926
1962 #: ../src/guestfs.pod:928
1967 #: ../src/guestfs.pod:930
1968 msgid "AVAILABILITY"
1972 #: ../src/guestfs.pod:932
1973 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
1977 #: ../src/guestfs.pod:934
1979 "Using L</guestfs_available> you can test availability of the following "
1980 "groups of functions. This test queries the appliance to see if the "
1981 "appliance you are currently using supports the functionality."
1985 #: ../src/guestfs.pod:939
1986 msgid "@AVAILABILITY@"
1990 #: ../src/guestfs.pod:941
1991 msgid "GUESTFISH supported COMMAND"
1995 #: ../src/guestfs.pod:943
1997 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
1998 "prints out the available groups and whether they are supported by this build "
1999 "of libguestfs. Note however that you have to do C<run> first."
2003 #: ../src/guestfs.pod:948
2004 msgid "SINGLE CALLS AT COMPILE TIME"
2008 #: ../src/guestfs.pod:950
2010 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2011 "function, such as:"
2015 #: ../src/guestfs.pod:953
2018 " #define LIBGUESTFS_HAVE_DD 1\n"
2023 #: ../src/guestfs.pod:955
2024 msgid "if L</guestfs_dd> is available."
2028 #: ../src/guestfs.pod:957
2030 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2031 "function is available at compile time, we recommended using build tools such "
2032 "as autoconf or cmake. For example in autotools you could use:"
2036 #: ../src/guestfs.pod:962
2039 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2040 " AC_CHECK_FUNCS([guestfs_dd])\n"
2045 #: ../src/guestfs.pod:965
2047 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2052 #: ../src/guestfs.pod:968
2053 msgid "SINGLE CALLS AT RUN TIME"
2057 #: ../src/guestfs.pod:970
2059 "Testing at compile time doesn't guarantee that a function really exists in "
2060 "the library. The reason is that you might be dynamically linked against a "
2061 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2062 "This situation unfortunately results in a segmentation fault, which is a "
2063 "shortcoming of the C dynamic linking system itself."
2067 #: ../src/guestfs.pod:977
2069 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2070 "in this example program (note that you still need the compile time check as "
2075 #: ../src/guestfs.pod:981
2078 " #include <stdio.h>\n"
2079 " #include <stdlib.h>\n"
2080 " #include <unistd.h>\n"
2081 " #include <dlfcn.h>\n"
2082 " #include <guestfs.h>\n"
2087 #: ../src/guestfs.pod:987
2092 " #ifdef LIBGUESTFS_HAVE_DD\n"
2094 " int has_function;\n"
2099 #: ../src/guestfs.pod:993
2102 " /* Test if the function guestfs_dd is really available. */\n"
2103 " dl = dlopen (NULL, RTLD_LAZY);\n"
2105 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2106 " exit (EXIT_FAILURE);\n"
2108 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2114 #: ../src/guestfs.pod:1002
2117 " if (!has_function)\n"
2118 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2120 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2121 " /* Now it's safe to call\n"
2122 " guestfs_dd (g, \"foo\", \"bar\");\n"
2126 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2133 #: ../src/guestfs.pod:1015
2135 "You may think the above is an awful lot of hassle, and it is. There are "
2136 "other ways outside of the C linking system to ensure that this kind of "
2137 "incompatibility never arises, such as using package versioning:"
2141 #: ../src/guestfs.pod:1020
2144 " Requires: libguestfs >= 1.0.80\n"
2149 #: ../src/guestfs.pod:1022 ../src/guestfs.pod:1027
2154 #: ../src/guestfs.pod:1024
2156 "<!-- old anchor for the next section --> <a name="
2157 "\"state_machine_and_low_level_event_api\"/>"
2161 #: ../src/guestfs.pod:1029
2162 msgid "ARCHITECTURE"
2166 #: ../src/guestfs.pod:1031
2168 "Internally, libguestfs is implemented by running an appliance (a special "
2169 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
2170 "process of the main program."
2174 #: ../src/guestfs.pod:1035
2177 " ___________________\n"
2179 " | main program |\n"
2181 " | | child process / appliance\n"
2182 " | | __________________________\n"
2184 " +-------------------+ RPC | +-----------------+ |\n"
2185 " | libguestfs <--------------------> guestfsd | |\n"
2186 " | | | +-----------------+ |\n"
2187 " \\___________________/ | | Linux kernel | |\n"
2188 " | +--^--------------+ |\n"
2189 " \\_________|________________/\n"
2195 " \\______________/\n"
2200 #: ../src/guestfs.pod:1055
2202 "The library, linked to the main program, creates the child process and hence "
2203 "the appliance in the L</guestfs_launch> function."
2207 #: ../src/guestfs.pod:1058
2209 "Inside the appliance is a Linux kernel and a complete stack of userspace "
2210 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
2211 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
2212 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
2213 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
2214 "attached to the qemu process which translates device access by the "
2215 "appliance's Linux kernel into accesses to the image."
2219 #: ../src/guestfs.pod:1067
2221 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
2222 "Although the disk image you are attached to might also be used by some "
2223 "virtual machine, libguestfs doesn't know or care about this. (But you will "
2224 "care if both libguestfs's qemu process and your virtual machine are trying "
2225 "to update the disk image at the same time, since these usually results in "
2226 "massive disk corruption)."
2230 #: ../src/guestfs.pod:1074
2231 msgid "STATE MACHINE"
2235 #: ../src/guestfs.pod:1076
2236 msgid "libguestfs uses a state machine to model the child process:"
2240 #: ../src/guestfs.pod:1078
2252 " / | \\ \\ guestfs_launch\n"
2253 " / | _\\__V______\n"
2255 " / | | LAUNCHING |\n"
2256 " / | \\___________/\n"
2258 " / | guestfs_launch\n"
2260 " ______ / __|____V\n"
2261 " / \\ ------> / \\\n"
2262 " | BUSY | | READY |\n"
2263 " \\______/ <------ \\________/\n"
2268 #: ../src/guestfs.pod:1100
2270 "The normal transitions are (1) CONFIG (when the handle is created, but there "
2271 "is no child process), (2) LAUNCHING (when the child process is booting up), "
2272 "(3) alternating between READY and BUSY as commands are issued to, and "
2273 "carried out by, the child process."
2277 #: ../src/guestfs.pod:1105
2279 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
2280 "asynchronously at any time (eg. due to some internal error), and that causes "
2281 "the state to transition back to CONFIG."
2285 #: ../src/guestfs.pod:1109
2287 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
2288 "issued when in the CONFIG state."
2292 #: ../src/guestfs.pod:1112
2294 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
2295 "L</guestfs_launch> blocks until the child process is READY to accept "
2296 "commands (or until some failure or timeout). L</guestfs_launch> internally "
2297 "moves the state from CONFIG to LAUNCHING while it is running."
2301 #: ../src/guestfs.pod:1118
2303 "API actions such as L</guestfs_mount> can only be issued when in the READY "
2304 "state. These API calls block waiting for the command to be carried out (ie. "
2305 "the state to transition to BUSY and then back to READY). There are no non-"
2306 "blocking versions, and no way to issue more than one command per handle at "
2311 #: ../src/guestfs.pod:1124
2313 "Finally, the child process sends asynchronous messages back to the main "
2314 "program, such as kernel log messages. You can register a callback to "
2315 "receive these messages."
2319 #: ../src/guestfs.pod:1128
2320 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
2324 #: ../src/guestfs.pod:1130
2326 "The child process generates events in some situations. Current events "
2327 "include: receiving a log message, the child process exits."
2331 #: ../src/guestfs.pod:1133
2333 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
2338 #: ../src/guestfs.pod:1136
2340 "Only I<one callback of each type> can be registered for each handle. "
2341 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
2342 "that type. Cancel all callbacks of this type by calling this function with "
2343 "C<cb> set to C<NULL>."
2347 #: ../src/guestfs.pod:1141
2348 msgid "guestfs_set_log_message_callback"
2352 #: ../src/guestfs.pod:1143
2355 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
2356 " char *buf, int len);\n"
2357 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
2358 " guestfs_log_message_cb cb,\n"
2364 #: ../src/guestfs.pod:1149
2366 "The callback function C<cb> will be called whenever qemu or the guest writes "
2367 "anything to the console."
2371 #: ../src/guestfs.pod:1152
2372 msgid "Use this function to capture kernel messages and similar."
2376 #: ../src/guestfs.pod:1154
2378 "Normally there is no log message handler, and log messages are just "
2383 #: ../src/guestfs.pod:1157
2384 msgid "guestfs_set_subprocess_quit_callback"
2388 #: ../src/guestfs.pod:1159
2391 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
2392 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
2393 " guestfs_subprocess_quit_cb cb,\n"
2399 #: ../src/guestfs.pod:1164
2401 "The callback function C<cb> will be called when the child process quits, "
2402 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
2403 "corresponds to a transition from any state to the CONFIG state)."
2407 #: ../src/guestfs.pod:1169
2408 msgid "guestfs_set_launch_done_callback"
2412 #: ../src/guestfs.pod:1171
2415 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
2416 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
2417 " guestfs_launch_done_cb cb,\n"
2423 #: ../src/guestfs.pod:1176
2425 "The callback function C<cb> will be called when the child process becomes "
2426 "ready first time after it has been launched. (This corresponds to a "
2427 "transition from LAUNCHING to the READY state)."
2431 #: ../src/guestfs.pod:1180
2432 msgid "guestfs_set_close_callback"
2436 #: ../src/guestfs.pod:1182
2439 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
2440 " void guestfs_set_close_callback (guestfs_h *g,\n"
2441 " guestfs_close_cb cb,\n"
2447 #: ../src/guestfs.pod:1187
2449 "The callback function C<cb> will be called while the handle is being closed "
2450 "(synchronously from L</guestfs_close>)."
2454 #: ../src/guestfs.pod:1190
2456 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
2457 "handles that are open when the program exits. This means that this callback "
2458 "might be called indirectly from L<exit(3)>, which can cause unexpected "
2459 "problems in higher-level languages (eg. if your HLL interpreter has already "
2460 "been cleaned up by the time this is called, and if your callback then jumps "
2461 "into some HLL function)."
2465 #: ../src/guestfs.pod:1198
2466 msgid "guestfs_set_progress_callback"
2470 #: ../src/guestfs.pod:1200
2473 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
2474 " int proc_nr, int serial,\n"
2475 " uint64_t position, uint64_t total);\n"
2476 " void guestfs_set_progress_callback (guestfs_h *g,\n"
2477 " guestfs_progress_cb cb,\n"
2483 #: ../src/guestfs.pod:1207
2485 "Some long-running operations can generate progress messages. If this "
2486 "callback is registered, then it will be called each time a progress message "
2487 "is generated (usually two seconds after the operation started, and three "
2488 "times per second thereafter until it completes, although the frequency may "
2489 "change in future versions)."
2493 #: ../src/guestfs.pod:1213
2495 "The callback receives two numbers: C<position> and C<total>. The units of "
2496 "C<total> are not defined, although for some operations C<total> may relate "
2497 "in some way to the amount of data to be transferred (eg. in bytes or "
2498 "megabytes), and C<position> may be the portion which has been transferred."
2502 #: ../src/guestfs.pod:1219
2503 msgid "The only defined and stable parts of the API are:"
2507 #: ../src/guestfs.pod:1225
2509 "The callback can display to the user some type of progress bar or indicator "
2510 "which shows the ratio of C<position>:C<total>."
2514 #: ../src/guestfs.pod:1230
2515 msgid "0 E<lt>= C<position> E<lt>= C<total>"
2519 #: ../src/guestfs.pod:1234
2521 "If any progress notification is sent during a call, then a final progress "
2522 "notification is always sent when C<position> = C<total>."
2526 #: ../src/guestfs.pod:1237
2528 "This is to simplify caller code, so callers can easily set the progress "
2529 "indicator to \"100%\" at the end of the operation, without requiring special "
2530 "code to detect this case."
2534 #: ../src/guestfs.pod:1243
2536 "The callback also receives the procedure number and serial number of the "
2537 "call. These are only useful for debugging protocol issues, and the callback "
2538 "can normally ignore them. The callback may want to print these numbers in "
2539 "error messages or debugging messages."
2543 #: ../src/guestfs.pod:1248
2544 msgid "PRIVATE DATA AREA"
2548 #: ../src/guestfs.pod:1250
2550 "You can attach named pieces of private data to the libguestfs handle, and "
2551 "fetch them by name for the lifetime of the handle. This is called the "
2552 "private data area and is only available from the C API."
2556 #: ../src/guestfs.pod:1254
2557 msgid "To attach a named piece of data, use the following call:"
2561 #: ../src/guestfs.pod:1256
2564 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
2569 #: ../src/guestfs.pod:1258
2571 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
2572 "pointer (which can be C<NULL>). Any previous item with the same name is "
2577 #: ../src/guestfs.pod:1262
2579 "You can use any C<key> you want, but names beginning with an underscore "
2580 "character are reserved for internal libguestfs purposes (for implementing "
2581 "language bindings). It is recommended to prefix the name with some unique "
2582 "string to avoid collisions with other users."
2586 #: ../src/guestfs.pod:1267
2587 msgid "To retrieve the pointer, use:"
2591 #: ../src/guestfs.pod:1269
2594 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
2599 #: ../src/guestfs.pod:1271
2601 "This function returns C<NULL> if either no data is found associated with "
2602 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
2607 #: ../src/guestfs.pod:1275
2609 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
2610 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
2611 "all. In particular, libguestfs does I<not> try to free the data when the "
2612 "handle is closed. If the data must be freed, then the caller must either "
2613 "free it before calling L</guestfs_close> or must set up a close callback to "
2614 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
2615 "can be registered for a handle)."
2619 #: ../src/guestfs.pod:1283
2621 "The private data area is implemented using a hash table, and should be "
2622 "reasonably efficient for moderate numbers of keys."
2626 #: ../src/guestfs.pod:1286
2627 msgid "BLOCK DEVICE NAMING"
2631 #: ../src/guestfs.pod:1288
2633 "In the kernel there is now quite a profusion of schemata for naming block "
2634 "devices (in this context, by I<block device> I mean a physical or virtual "
2635 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2636 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2637 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2638 "for the old IDE driver (particularly for SATA devices) those devices also "
2639 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2640 "paravirtualized drivers. This has created several different naming systems, "
2641 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2645 #: ../src/guestfs.pod:1300
2647 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2648 "Linux kernel to access block devices. We can run a variety of appliances "
2649 "based on a variety of Linux kernels."
2653 #: ../src/guestfs.pod:1304
2655 "This causes a problem for libguestfs because many API calls use device or "
2656 "partition names. Working scripts and the recipe (example) scripts that we "
2657 "make available over the internet could fail if the naming scheme changes."
2661 #: ../src/guestfs.pod:1309
2663 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2664 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2665 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2666 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2670 #: ../src/guestfs.pod:1315
2672 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2673 "L</guestfs_list_partitions> and similar calls return the true names of the "
2674 "devices and partitions as known to the appliance."
2678 #: ../src/guestfs.pod:1320
2679 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2683 #: ../src/guestfs.pod:1322
2685 "Usually this translation is transparent. However in some (very rare) cases "
2686 "you may need to know the exact algorithm. Such cases include where you use "
2687 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2688 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2692 #: ../src/guestfs.pod:1328
2694 "The algorithm is applied only to I<parameters> which are known to be either "
2695 "device or partition names. Return values from functions such as L</"
2696 "guestfs_list_devices> are never changed."
2700 #: ../src/guestfs.pod:1336
2701 msgid "Is the string a parameter which is a device or partition name?"
2705 #: ../src/guestfs.pod:1340
2706 msgid "Does the string begin with C</dev/sd>?"
2710 #: ../src/guestfs.pod:1344
2712 "Does the named device exist? If so, we use that device. However if I<not> "
2713 "then we continue with this algorithm."
2717 #: ../src/guestfs.pod:1349
2718 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2722 #: ../src/guestfs.pod:1351
2723 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2727 #: ../src/guestfs.pod:1353
2728 msgid "If that named device exists, use it. If not, continue."
2732 #: ../src/guestfs.pod:1357
2733 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2737 #: ../src/guestfs.pod:1359
2738 msgid "If that named device exists, use it. If not, return an error."
2742 #: ../src/guestfs.pod:1363
2743 msgid "PORTABILITY CONCERNS"
2747 #: ../src/guestfs.pod:1365
2749 "Although the standard naming scheme and automatic translation is useful for "
2750 "simple programs and guestfish scripts, for larger programs it is best not to "
2751 "rely on this mechanism."
2755 #: ../src/guestfs.pod:1369
2757 "Where possible for maximum future portability programs using libguestfs "
2758 "should use these future-proof techniques:"
2762 #: ../src/guestfs.pod:1376
2764 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2765 "device names, and then use those names directly."
2769 #: ../src/guestfs.pod:1379
2771 "Since those device names exist by definition, they will never be translated."
2775 #: ../src/guestfs.pod:1384
2777 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2778 "filesystem labels."
2782 #: ../src/guestfs.pod:1389
2787 #: ../src/guestfs.pod:1391
2788 msgid "COMMUNICATION PROTOCOL"
2792 #: ../src/guestfs.pod:1393
2794 "Don't rely on using this protocol directly. This section documents how it "
2795 "currently works, but it may change at any time."
2799 #: ../src/guestfs.pod:1396
2801 "The protocol used to talk between the library and the daemon running inside "
2802 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
2803 "1014, RFC 1832, RFC 4506)."
2807 #: ../src/guestfs.pod:1400
2809 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
2810 "this file is automatically generated)."
2814 #: ../src/guestfs.pod:1403
2816 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
2817 "and C<FileOut> parameters, which are handled with very simple request/reply "
2818 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
2819 "parameters, which use the same request and reply messages, but they may also "
2820 "be followed by files sent using a chunked encoding."
2824 #: ../src/guestfs.pod:1410
2825 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
2829 #: ../src/guestfs.pod:1412
2830 msgid "For ordinary functions, the request message is:"
2834 #: ../src/guestfs.pod:1414
2837 " total length (header + arguments,\n"
2838 " but not including the length word itself)\n"
2839 " struct guestfs_message_header (encoded as XDR)\n"
2840 " struct guestfs_<foo>_args (encoded as XDR)\n"
2845 #: ../src/guestfs.pod:1419
2847 "The total length field allows the daemon to allocate a fixed size buffer "
2848 "into which it slurps the rest of the message. As a result, the total length "
2849 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
2850 "effective size of any request is limited to somewhere under this size."
2854 #: ../src/guestfs.pod:1425
2856 "Note also that many functions don't take any arguments, in which case the "
2857 "C<guestfs_I<foo>_args> is completely omitted."
2861 #: ../src/guestfs.pod:1428
2863 "The header contains the procedure number (C<guestfs_proc>) which is how the "
2864 "receiver knows what type of args structure to expect, or none at all."
2868 #: ../src/guestfs.pod:1432
2869 msgid "The reply message for ordinary functions is:"
2873 #: ../src/guestfs.pod:1434
2876 " total length (header + ret,\n"
2877 " but not including the length word itself)\n"
2878 " struct guestfs_message_header (encoded as XDR)\n"
2879 " struct guestfs_<foo>_ret (encoded as XDR)\n"
2884 #: ../src/guestfs.pod:1439
2886 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
2887 "functions that return no formal return values."
2891 #: ../src/guestfs.pod:1442
2893 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
2897 #: ../src/guestfs.pod:1445
2899 "In the case of an error, a flag is set in the header, and the reply message "
2900 "is slightly changed:"
2904 #: ../src/guestfs.pod:1448
2907 " total length (header + error,\n"
2908 " but not including the length word itself)\n"
2909 " struct guestfs_message_header (encoded as XDR)\n"
2910 " struct guestfs_message_error (encoded as XDR)\n"
2915 #: ../src/guestfs.pod:1453
2917 "The C<guestfs_message_error> structure contains the error message as a "
2922 #: ../src/guestfs.pod:1456
2923 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
2927 #: ../src/guestfs.pod:1458
2929 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
2930 "The normal request message is sent (see above). However this is followed by "
2931 "a sequence of file chunks."
2935 #: ../src/guestfs.pod:1462
2938 " total length (header + arguments,\n"
2939 " but not including the length word itself,\n"
2940 " and not including the chunks)\n"
2941 " struct guestfs_message_header (encoded as XDR)\n"
2942 " struct guestfs_<foo>_args (encoded as XDR)\n"
2943 " sequence of chunks for FileIn param #0\n"
2944 " sequence of chunks for FileIn param #1 etc.\n"
2949 #: ../src/guestfs.pod:1470
2950 msgid "The \"sequence of chunks\" is:"
2954 #: ../src/guestfs.pod:1472
2957 " length of chunk (not including length word itself)\n"
2958 " struct guestfs_chunk (encoded as XDR)\n"
2959 " length of chunk\n"
2960 " struct guestfs_chunk (encoded as XDR)\n"
2962 " length of chunk\n"
2963 " struct guestfs_chunk (with data.data_len == 0)\n"
2968 #: ../src/guestfs.pod:1480
2970 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
2971 "is set in the final chunk to indicate either successful completion or early "
2976 #: ../src/guestfs.pod:1484
2978 "At time of writing there are no functions that have more than one FileIn "
2979 "parameter. However this is (theoretically) supported, by sending the "
2980 "sequence of chunks for each FileIn parameter one after another (from left to "
2985 #: ../src/guestfs.pod:1489
2987 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
2988 "transfer. The library does this by sending a chunk with a special flag set "
2989 "to indicate cancellation. When the daemon sees this, it cancels the whole "
2990 "RPC, does I<not> send any reply, and goes back to reading the next request."
2994 #: ../src/guestfs.pod:1495
2996 "The daemon may also cancel. It does this by writing a special word "
2997 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
2998 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
2999 "cancel chunk). The special word is chosen so that even if cancellation "
3000 "happens right at the end of the transfer (after the library has finished "
3001 "writing and has started listening for the reply), the \"spurious\" cancel "
3002 "flag will not be confused with the reply message."
3006 #: ../src/guestfs.pod:1504
3008 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3009 "limit), and also files where the size is not known in advance (eg. from "
3010 "pipes or sockets). However the chunks are rather small "
3011 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3012 "to keep much in memory."
3016 #: ../src/guestfs.pod:1510
3017 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3021 #: ../src/guestfs.pod:1512
3023 "The protocol for FileOut parameters is exactly the same as for FileIn "
3024 "parameters, but with the roles of daemon and library reversed."
3028 #: ../src/guestfs.pod:1515
3031 " total length (header + ret,\n"
3032 " but not including the length word itself,\n"
3033 " and not including the chunks)\n"
3034 " struct guestfs_message_header (encoded as XDR)\n"
3035 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3036 " sequence of chunks for FileOut param #0\n"
3037 " sequence of chunks for FileOut param #1 etc.\n"
3042 #: ../src/guestfs.pod:1523
3043 msgid "INITIAL MESSAGE"
3047 #: ../src/guestfs.pod:1525
3049 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3050 "which indicates that the guest and daemon is alive. This is what L</"
3051 "guestfs_launch> waits for."
3055 #: ../src/guestfs.pod:1529
3056 msgid "PROGRESS NOTIFICATION MESSAGES"
3060 #: ../src/guestfs.pod:1531
3062 "The daemon may send progress notification messages at any time. These are "
3063 "distinguished by the normal length word being replaced by "
3064 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3068 #: ../src/guestfs.pod:1535
3070 "The library turns them into progress callbacks (see "
3071 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3072 "discards them if not."
3076 #: ../src/guestfs.pod:1539
3078 "The daemon self-limits the frequency of progress messages it sends (see "
3079 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3084 #: ../src/guestfs.pod:1543
3085 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
3089 #: ../src/guestfs.pod:1545
3091 "All high-level libguestfs actions are synchronous. If you want to use "
3092 "libguestfs asynchronously then you must create a thread."
3096 #: ../src/guestfs.pod:1548
3098 "Only use the handle from a single thread. Either use the handle exclusively "
3099 "from one thread, or provide your own mutex so that two threads cannot issue "
3100 "calls on the same handle at the same time."
3104 #: ../src/guestfs.pod:1552
3106 "See the graphical program guestfs-browser for one possible architecture for "
3107 "multithreaded programs using libvirt and libguestfs."
3111 #: ../src/guestfs.pod:1555
3112 msgid "QEMU WRAPPERS"
3116 #: ../src/guestfs.pod:1557
3118 "If you want to compile your own qemu, run qemu from a non-standard location, "
3119 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
3124 #: ../src/guestfs.pod:1561
3126 "There is one important rule to remember: you I<must C<exec qemu>> as the "
3127 "last command in the shell script (so that qemu replaces the shell and "
3128 "becomes the direct child of the libguestfs-using program). If you don't do "
3129 "this, then the qemu process won't be cleaned up correctly."
3133 #: ../src/guestfs.pod:1566
3135 "Here is an example of a wrapper, where I have built my own copy of qemu from "
3140 #: ../src/guestfs.pod:1569
3144 " qemudir=/home/rjones/d/qemu\n"
3145 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
3150 #: ../src/guestfs.pod:1573
3152 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
3153 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
3158 #: ../src/guestfs.pod:1577
3161 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
3166 #: ../src/guestfs.pod:1579
3168 "Note that libguestfs also calls qemu with the -help and -version options in "
3169 "order to determine features."
3173 #: ../src/guestfs.pod:1582
3174 msgid "LIBGUESTFS VERSION NUMBERS"
3178 #: ../src/guestfs.pod:1584
3180 "Since April 2010, libguestfs has started to make separate development and "
3181 "stable releases, along with corresponding branches in our git repository. "
3182 "These separate releases can be identified by version number:"
3186 #: ../src/guestfs.pod:1589
3189 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3190 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3196 " | `-------- sub-version\n"
3198 " `------ always '1' because we don't change the ABI\n"
3203 #: ../src/guestfs.pod:1600
3204 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3208 #: ../src/guestfs.pod:1602
3210 "As time passes we cherry pick fixes from the development branch and backport "
3211 "those into the stable branch, the effect being that the stable branch should "
3212 "get more stable and less buggy over time. So the stable releases are ideal "
3213 "for people who don't need new features but would just like the software to "
3218 #: ../src/guestfs.pod:1608
3219 msgid "Our criteria for backporting changes are:"
3223 #: ../src/guestfs.pod:1614
3225 "Documentation changes which don't affect any code are backported unless the "
3226 "documentation refers to a future feature which is not in stable."
3230 #: ../src/guestfs.pod:1620
3232 "Bug fixes which are not controversial, fix obvious problems, and have been "
3233 "well tested are backported."
3237 #: ../src/guestfs.pod:1625
3239 "Simple rearrangements of code which shouldn't affect how it works get "
3240 "backported. This is so that the code in the two branches doesn't get too "
3241 "far out of step, allowing us to backport future fixes more easily."
3245 #: ../src/guestfs.pod:1631
3247 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3248 "exceptional case: the new feature is required in order to implement an "
3249 "important bug fix."
3253 #: ../src/guestfs.pod:1637
3255 "A new stable branch starts when we think the new features in development are "
3256 "substantial and compelling enough over the current stable branch to warrant "
3257 "it. When that happens we create new stable and development versions 1.N.0 "
3258 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
3259 "stable at this point, but by backporting fixes from development, that branch "
3260 "will stabilize over time."
3264 #: ../src/guestfs.pod:1645 ../fish/guestfish.pod:803
3265 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:312
3266 #: ../tools/virt-rescue.pl:226
3267 msgid "ENVIRONMENT VARIABLES"
3271 #: ../src/guestfs.pod:1649 ../fish/guestfish.pod:829
3272 msgid "LIBGUESTFS_APPEND"
3276 #: ../src/guestfs.pod:1651 ../fish/guestfish.pod:831
3277 msgid "Pass additional options to the guest kernel."
3281 #: ../src/guestfs.pod:1653 ../fish/guestfish.pod:833
3282 msgid "LIBGUESTFS_DEBUG"
3286 #: ../src/guestfs.pod:1655
3288 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
3289 "effect as calling C<guestfs_set_verbose (g, 1)>."
3293 #: ../src/guestfs.pod:1658 ../fish/guestfish.pod:838
3294 msgid "LIBGUESTFS_MEMSIZE"
3298 #: ../src/guestfs.pod:1660 ../fish/guestfish.pod:840
3300 "Set the memory allocated to the qemu process, in megabytes. For example:"
3304 #: ../src/guestfs.pod:1663 ../fish/guestfish.pod:843
3307 " LIBGUESTFS_MEMSIZE=700\n"
3312 #: ../src/guestfs.pod:1665 ../fish/guestfish.pod:845
3313 msgid "LIBGUESTFS_PATH"
3317 #: ../src/guestfs.pod:1667
3319 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
3320 "the discussion of paths in section PATH above."
3324 #: ../src/guestfs.pod:1670 ../fish/guestfish.pod:850
3325 msgid "LIBGUESTFS_QEMU"
3329 #: ../src/guestfs.pod:1672 ../fish/guestfish.pod:852
3331 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
3332 "which was found at compile time by the configure script is used."
3336 #: ../src/guestfs.pod:1676
3337 msgid "See also L</QEMU WRAPPERS> above."
3341 #: ../src/guestfs.pod:1678 ../fish/guestfish.pod:856
3342 msgid "LIBGUESTFS_TRACE"
3346 #: ../src/guestfs.pod:1680
3348 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
3349 "effect as calling C<guestfs_set_trace (g, 1)>."
3353 #: ../src/guestfs.pod:1683 ../fish/guestfish.pod:865
3358 #: ../src/guestfs.pod:1685 ../fish/guestfish.pod:867
3359 msgid "Location of temporary directory, defaults to C</tmp>."
3363 #: ../src/guestfs.pod:1687 ../fish/guestfish.pod:869
3365 "If libguestfs was compiled to use the supermin appliance then each handle "
3366 "will require rather a large amount of space in this directory for short "
3367 "periods of time (~ 80 MB). You can use C<$TMPDIR> to configure another "
3368 "directory to use in case C</tmp> is not large enough."
3372 #: ../src/guestfs.pod:1695 ../fish/guestfish.pod:927
3373 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:178
3374 #: ../inspector/virt-inspector.pl:846 ../tools/virt-cat.pl:163
3375 #: ../tools/virt-df.pl:536 ../tools/virt-edit.pl:325
3376 #: ../tools/virt-list-filesystems.pl:191 ../tools/virt-list-partitions.pl:229
3377 #: ../tools/virt-ls.pl:210 ../tools/virt-make-fs.pl:527
3378 #: ../tools/virt-rescue.pl:231 ../tools/virt-resize.pl:1390
3379 #: ../tools/virt-tar.pl:257 ../tools/virt-win-reg.pl:461
3384 #: ../src/guestfs.pod:1697
3386 "L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, L<virt-edit"
3387 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
3388 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
3389 "tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
3390 "L<http://libguestfs.org/>."
3394 #: ../src/guestfs.pod:1715
3396 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
3397 "(8)>, L<disktype(1)>."
3401 #: ../src/guestfs.pod:1722 ../tools/virt-make-fs.pl:541
3402 #: ../tools/virt-win-reg.pl:476
3407 #: ../src/guestfs.pod:1724
3408 msgid "To get a list of bugs against libguestfs use this link:"
3412 #: ../src/guestfs.pod:1726
3414 "L<https://bugzilla.redhat.com/buglist.cgi?"
3415 "component=libguestfs&product=Virtualization+Tools>"
3419 #: ../src/guestfs.pod:1728
3420 msgid "To report a new bug against libguestfs use this link:"
3424 #: ../src/guestfs.pod:1730
3426 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
3427 "component=libguestfs&product=Virtualization+Tools>"
3431 #: ../src/guestfs.pod:1732
3432 msgid "When reporting a bug, please check:"
3436 #: ../src/guestfs.pod:1738
3437 msgid "That the bug hasn't been reported already."
3441 #: ../src/guestfs.pod:1742
3442 msgid "That you are testing a recent version."
3446 #: ../src/guestfs.pod:1746
3447 msgid "Describe the bug accurately, and give a way to reproduce it."
3451 #: ../src/guestfs.pod:1750
3453 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
3458 #: ../src/guestfs.pod:1755 ../fish/guestfish.pod:944
3459 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:189
3460 #: ../inspector/virt-inspector.pl:855
3465 #: ../src/guestfs.pod:1757 ../fish/guestfish.pod:946
3466 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:191
3467 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
3471 #: ../src/guestfs.pod:1759 ../fish/guestfish.pod:948
3472 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:193
3473 #: ../inspector/virt-inspector.pl:861 ../tools/virt-cat.pl:177
3474 #: ../tools/virt-df.pl:549 ../tools/virt-edit.pl:341
3475 #: ../tools/virt-list-filesystems.pl:207 ../tools/virt-list-partitions.pl:244
3476 #: ../tools/virt-ls.pl:225 ../tools/virt-make-fs.pl:556
3477 #: ../tools/virt-rescue.pl:245 ../tools/virt-resize.pl:1411
3478 #: ../tools/virt-tar.pl:272 ../tools/virt-win-reg.pl:491
3483 #: ../src/guestfs.pod:1761 ../fish/guestfish.pod:950
3484 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
3488 #: ../src/guestfs.pod:1764
3490 "This library is free software; you can redistribute it and/or modify it "
3491 "under the terms of the GNU Lesser General Public License as published by the "
3492 "Free Software Foundation; either version 2 of the License, or (at your "
3493 "option) any later version."
3497 #: ../src/guestfs.pod:1769
3499 "This library is distributed in the hope that it will be useful, but WITHOUT "
3500 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
3501 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
3506 #: ../src/guestfs.pod:1774
3508 "You should have received a copy of the GNU Lesser General Public License "
3509 "along with this library; if not, write to the Free Software Foundation, "
3510 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
3514 #: ../src/guestfs-actions.pod:1
3515 msgid "guestfs_add_cdrom"
3519 #: ../src/guestfs-actions.pod:3
3522 " int guestfs_add_cdrom (guestfs_h *g,\n"
3523 "\t\tconst char *filename);\n"
3528 #: ../src/guestfs-actions.pod:6 ../fish/guestfish-actions.pod:7
3529 msgid "This function adds a virtual CD-ROM disk image to the guest."
3533 #: ../src/guestfs-actions.pod:8 ../fish/guestfish-actions.pod:9
3534 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
3538 #: ../src/guestfs-actions.pod:10 ../src/guestfs-actions.pod:1516
3539 #: ../fish/guestfish-actions.pod:11 ../fish/guestfish-actions.pod:1211
3544 #: ../src/guestfs-actions.pod:16
3546 "This call checks for the existence of C<filename>. This stops you from "
3547 "specifying other types of drive which are supported by qemu such as C<nbd:> "
3548 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
3553 #: ../src/guestfs-actions.pod:23
3555 "If you just want to add an ISO file (often you use this as an efficient way "
3556 "to transfer large files into the guest), then you should probably use "
3557 "C<guestfs_add_drive_ro> instead."
3561 #: ../src/guestfs-actions.pod:29 ../src/guestfs-actions.pod:63
3562 #: ../src/guestfs-actions.pod:92 ../src/guestfs-actions.pod:103
3563 #: ../src/guestfs-actions.pod:114 ../src/guestfs-actions.pod:124
3564 #: ../src/guestfs-actions.pod:135 ../src/guestfs-actions.pod:238
3565 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:266
3566 #: ../src/guestfs-actions.pod:302 ../src/guestfs-actions.pod:324
3567 #: ../src/guestfs-actions.pod:339 ../src/guestfs-actions.pod:403
3568 #: ../src/guestfs-actions.pod:430 ../src/guestfs-actions.pod:441
3569 #: ../src/guestfs-actions.pod:453 ../src/guestfs-actions.pod:534
3570 #: ../src/guestfs-actions.pod:549 ../src/guestfs-actions.pod:560
3571 #: ../src/guestfs-actions.pod:571 ../src/guestfs-actions.pod:717
3572 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:749
3573 #: ../src/guestfs-actions.pod:824 ../src/guestfs-actions.pod:839
3574 #: ../src/guestfs-actions.pod:855 ../src/guestfs-actions.pod:866
3575 #: ../src/guestfs-actions.pod:883 ../src/guestfs-actions.pod:916
3576 #: ../src/guestfs-actions.pod:974 ../src/guestfs-actions.pod:1002
3577 #: ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:1055
3578 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1174
3579 #: ../src/guestfs-actions.pod:1374 ../src/guestfs-actions.pod:1393
3580 #: ../src/guestfs-actions.pod:1474 ../src/guestfs-actions.pod:1822
3581 #: ../src/guestfs-actions.pod:1945 ../src/guestfs-actions.pod:2000
3582 #: ../src/guestfs-actions.pod:2030 ../src/guestfs-actions.pod:2439
3583 #: ../src/guestfs-actions.pod:2451 ../src/guestfs-actions.pod:2468
3584 #: ../src/guestfs-actions.pod:2576 ../src/guestfs-actions.pod:2587
3585 #: ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2608
3586 #: ../src/guestfs-actions.pod:2620 ../src/guestfs-actions.pod:2650
3587 #: ../src/guestfs-actions.pod:2714 ../src/guestfs-actions.pod:2731
3588 #: ../src/guestfs-actions.pod:2745 ../src/guestfs-actions.pod:2765
3589 #: ../src/guestfs-actions.pod:2785 ../src/guestfs-actions.pod:2814
3590 #: ../src/guestfs-actions.pod:2830 ../src/guestfs-actions.pod:2846
3591 #: ../src/guestfs-actions.pod:2858 ../src/guestfs-actions.pod:2867
3592 #: ../src/guestfs-actions.pod:2900 ../src/guestfs-actions.pod:2913
3593 #: ../src/guestfs-actions.pod:2923 ../src/guestfs-actions.pod:2935
3594 #: ../src/guestfs-actions.pod:2949 ../src/guestfs-actions.pod:3029
3595 #: ../src/guestfs-actions.pod:3046 ../src/guestfs-actions.pod:3056
3596 #: ../src/guestfs-actions.pod:3101 ../src/guestfs-actions.pod:3116
3597 #: ../src/guestfs-actions.pod:3131 ../src/guestfs-actions.pod:3144
3598 #: ../src/guestfs-actions.pod:3155 ../src/guestfs-actions.pod:3166
3599 #: ../src/guestfs-actions.pod:3180 ../src/guestfs-actions.pod:3192
3600 #: ../src/guestfs-actions.pod:3209 ../src/guestfs-actions.pod:3240
3601 #: ../src/guestfs-actions.pod:3268 ../src/guestfs-actions.pod:3284
3602 #: ../src/guestfs-actions.pod:3300 ../src/guestfs-actions.pod:3309
3603 #: ../src/guestfs-actions.pod:3323 ../src/guestfs-actions.pod:3333
3604 #: ../src/guestfs-actions.pod:3345 ../src/guestfs-actions.pod:3357
3605 #: ../src/guestfs-actions.pod:3389 ../src/guestfs-actions.pod:3401
3606 #: ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3429
3607 #: ../src/guestfs-actions.pod:3443 ../src/guestfs-actions.pod:3483
3608 #: ../src/guestfs-actions.pod:3514 ../src/guestfs-actions.pod:3525
3609 #: ../src/guestfs-actions.pod:3550 ../src/guestfs-actions.pod:3564
3610 #: ../src/guestfs-actions.pod:3579 ../src/guestfs-actions.pod:3701
3611 #: ../src/guestfs-actions.pod:3753 ../src/guestfs-actions.pod:3772
3612 #: ../src/guestfs-actions.pod:3787 ../src/guestfs-actions.pod:3813
3613 #: ../src/guestfs-actions.pod:3847 ../src/guestfs-actions.pod:3861
3614 #: ../src/guestfs-actions.pod:3871 ../src/guestfs-actions.pod:3882
3615 #: ../src/guestfs-actions.pod:4114 ../src/guestfs-actions.pod:4130
3616 #: ../src/guestfs-actions.pod:4141 ../src/guestfs-actions.pod:4150
3617 #: ../src/guestfs-actions.pod:4161 ../src/guestfs-actions.pod:4170
3618 #: ../src/guestfs-actions.pod:4181 ../src/guestfs-actions.pod:4194
3619 #: ../src/guestfs-actions.pod:4212 ../src/guestfs-actions.pod:4228
3620 #: ../src/guestfs-actions.pod:4244 ../src/guestfs-actions.pod:4259
3621 #: ../src/guestfs-actions.pod:4279 ../src/guestfs-actions.pod:4294
3622 #: ../src/guestfs-actions.pod:4310 ../src/guestfs-actions.pod:4328
3623 #: ../src/guestfs-actions.pod:4344 ../src/guestfs-actions.pod:4358
3624 #: ../src/guestfs-actions.pod:4383 ../src/guestfs-actions.pod:4404
3625 #: ../src/guestfs-actions.pod:4420 ../src/guestfs-actions.pod:4441
3626 #: ../src/guestfs-actions.pod:4453 ../src/guestfs-actions.pod:4465
3627 #: ../src/guestfs-actions.pod:4481 ../src/guestfs-actions.pod:4515
3628 #: ../src/guestfs-actions.pod:4535 ../src/guestfs-actions.pod:4558
3629 #: ../src/guestfs-actions.pod:4648 ../src/guestfs-actions.pod:4754
3630 #: ../src/guestfs-actions.pod:4763 ../src/guestfs-actions.pod:4773
3631 #: ../src/guestfs-actions.pod:4783 ../src/guestfs-actions.pod:4802
3632 #: ../src/guestfs-actions.pod:4812 ../src/guestfs-actions.pod:4822
3633 #: ../src/guestfs-actions.pod:4832 ../src/guestfs-actions.pod:4844
3634 #: ../src/guestfs-actions.pod:4894 ../src/guestfs-actions.pod:4908
3635 #: ../src/guestfs-actions.pod:4921 ../src/guestfs-actions.pod:4934
3636 #: ../src/guestfs-actions.pod:4948 ../src/guestfs-actions.pod:4958
3637 #: ../src/guestfs-actions.pod:4975 ../src/guestfs-actions.pod:5005
3638 #: ../src/guestfs-actions.pod:5016 ../src/guestfs-actions.pod:5051
3639 #: ../src/guestfs-actions.pod:5061 ../src/guestfs-actions.pod:5076
3640 #: ../src/guestfs-actions.pod:5102 ../src/guestfs-actions.pod:5130
3641 #: ../src/guestfs-actions.pod:5234 ../src/guestfs-actions.pod:5249
3642 #: ../src/guestfs-actions.pod:5260 ../src/guestfs-actions.pod:5306
3643 #: ../src/guestfs-actions.pod:5316 ../src/guestfs-actions.pod:5353
3644 #: ../src/guestfs-actions.pod:5380 ../src/guestfs-actions.pod:5422
3645 #: ../src/guestfs-actions.pod:5445 ../src/guestfs-actions.pod:5502
3646 #: ../src/guestfs-actions.pod:5518 ../src/guestfs-actions.pod:5544
3647 msgid "This function returns 0 on success or -1 on error."
3651 #: ../src/guestfs-actions.pod:31
3652 msgid "guestfs_add_drive"
3656 #: ../src/guestfs-actions.pod:33
3659 " int guestfs_add_drive (guestfs_h *g,\n"
3660 "\t\tconst char *filename);\n"
3665 #: ../src/guestfs-actions.pod:36 ../fish/guestfish-actions.pod:36
3667 "This function adds a virtual machine disk image C<filename> to the guest. "
3668 "The first time you call this function, the disk appears as IDE disk 0 (C</"
3669 "dev/sda>) in the guest, the second time as C</dev/sdb>, and so on."
3673 #: ../src/guestfs-actions.pod:41 ../fish/guestfish-actions.pod:41
3675 "You don't necessarily need to be root when using libguestfs. However you "
3676 "obviously do need sufficient permissions to access the filename for whatever "
3677 "operations you want to perform (ie. read access if you just want to read the "
3678 "image or write access if you want to modify the image)."
3682 #: ../src/guestfs-actions.pod:47 ../fish/guestfish-actions.pod:47
3684 "This is equivalent to the qemu parameter C<-drive file=filename,cache=off,"
3689 #: ../src/guestfs-actions.pod:50 ../fish/guestfish-actions.pod:50
3691 "C<cache=off> is omitted in cases where it is not supported by the underlying "
3696 #: ../src/guestfs-actions.pod:53 ../src/guestfs-actions.pod:82
3698 "C<if=...> is set at compile time by the configuration option C<./configure --"
3699 "with-drive-if=...>. In the rare case where you might need to change this at "
3700 "run time, use C<guestfs_add_drive_with_if> or "
3701 "C<guestfs_add_drive_ro_with_if>."
3705 #: ../src/guestfs-actions.pod:58 ../src/guestfs-actions.pod:87
3707 "Note that this call checks for the existence of C<filename>. This stops you "
3708 "from specifying other types of drive which are supported by qemu such as "
3709 "C<nbd:> and C<http:> URLs. To specify those, use the general "
3710 "C<guestfs_config> call instead."
3714 #: ../src/guestfs-actions.pod:65
3715 msgid "guestfs_add_drive_ro"
3719 #: ../src/guestfs-actions.pod:67
3722 " int guestfs_add_drive_ro (guestfs_h *g,\n"
3723 "\t\tconst char *filename);\n"
3728 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:69
3729 msgid "This adds a drive in snapshot mode, making it effectively read-only."
3733 #: ../src/guestfs-actions.pod:73 ../fish/guestfish-actions.pod:72
3735 "Note that writes to the device are allowed, and will be seen for the "
3736 "duration of the guestfs handle, but they are written to a temporary file "
3737 "which is discarded as soon as the guestfs handle is closed. We don't "
3738 "currently have any method to enable changes to be committed, although qemu "
3743 #: ../src/guestfs-actions.pod:79 ../fish/guestfish-actions.pod:78
3745 "This is equivalent to the qemu parameter C<-drive file=filename,snapshot=on,"
3750 #: ../src/guestfs-actions.pod:94
3751 msgid "guestfs_add_drive_ro_with_if"
3755 #: ../src/guestfs-actions.pod:96
3758 " int guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
3759 "\t\tconst char *filename,\n"
3760 "\t\tconst char *iface);\n"
3765 #: ../src/guestfs-actions.pod:100
3767 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
3768 "QEMU interface emulation to use at run time."
3772 #: ../src/guestfs-actions.pod:105
3773 msgid "guestfs_add_drive_with_if"
3777 #: ../src/guestfs-actions.pod:107
3780 " int guestfs_add_drive_with_if (guestfs_h *g,\n"
3781 "\t\tconst char *filename,\n"
3782 "\t\tconst char *iface);\n"
3787 #: ../src/guestfs-actions.pod:111
3789 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
3790 "QEMU interface emulation to use at run time."
3794 #: ../src/guestfs-actions.pod:116
3795 msgid "guestfs_aug_clear"
3799 #: ../src/guestfs-actions.pod:118
3802 " int guestfs_aug_clear (guestfs_h *g,\n"
3803 "\t\tconst char *augpath);\n"
3808 #: ../src/guestfs-actions.pod:121 ../fish/guestfish-actions.pod:109
3810 "Set the value associated with C<path> to C<NULL>. This is the same as the "
3811 "L<augtool(1)> C<clear> command."
3815 #: ../src/guestfs-actions.pod:126
3816 msgid "guestfs_aug_close"
3820 #: ../src/guestfs-actions.pod:128
3823 " int guestfs_aug_close (guestfs_h *g);\n"
3828 #: ../src/guestfs-actions.pod:130
3830 "Close the current Augeas handle and free up any resources used by it. After "
3831 "calling this, you have to call C<guestfs_aug_init> again before you can use "
3832 "any other Augeas functions."
3836 #: ../src/guestfs-actions.pod:137
3837 msgid "guestfs_aug_defnode"
3841 #: ../src/guestfs-actions.pod:139
3844 " struct guestfs_int_bool *guestfs_aug_defnode (guestfs_h *g,\n"
3845 "\t\tconst char *name,\n"
3846 "\t\tconst char *expr,\n"
3847 "\t\tconst char *val);\n"
3852 #: ../src/guestfs-actions.pod:144 ../fish/guestfish-actions.pod:125
3854 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
3858 #: ../src/guestfs-actions.pod:147
3860 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
3861 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
3862 "containing that single node."
3866 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:132
3868 "On success this returns a pair containing the number of nodes in the "
3869 "nodeset, and a boolean flag if a node was created."
3873 #: ../src/guestfs-actions.pod:155
3875 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
3876 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
3880 #: ../src/guestfs-actions.pod:159
3881 msgid "guestfs_aug_defvar"
3885 #: ../src/guestfs-actions.pod:161
3888 " int guestfs_aug_defvar (guestfs_h *g,\n"
3889 "\t\tconst char *name,\n"
3890 "\t\tconst char *expr);\n"
3895 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:140
3897 "Defines an Augeas variable C<name> whose value is the result of evaluating "
3898 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
3902 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:144
3904 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
3905 "evaluates to something which is not a nodeset."
3909 #: ../src/guestfs-actions.pod:172 ../src/guestfs-actions.pod:313
3910 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:492
3911 #: ../src/guestfs-actions.pod:507 ../src/guestfs-actions.pod:523
3912 #: ../src/guestfs-actions.pod:1041 ../src/guestfs-actions.pod:1356
3913 #: ../src/guestfs-actions.pod:1538 ../src/guestfs-actions.pod:1619
3914 #: ../src/guestfs-actions.pod:1650 ../src/guestfs-actions.pod:1693
3915 #: ../src/guestfs-actions.pod:1710 ../src/guestfs-actions.pod:1935
3916 #: ../src/guestfs-actions.pod:2147 ../src/guestfs-actions.pod:2165
3917 #: ../src/guestfs-actions.pod:3503 ../src/guestfs-actions.pod:3610
3918 #: ../src/guestfs-actions.pod:3941 ../src/guestfs-actions.pod:5040
3919 #: ../src/guestfs-actions.pod:5390 ../src/guestfs-actions.pod:5400
3920 #: ../src/guestfs-actions.pod:5410
3921 msgid "On error this function returns -1."
3925 #: ../src/guestfs-actions.pod:174
3926 msgid "guestfs_aug_get"
3930 #: ../src/guestfs-actions.pod:176
3933 " char *guestfs_aug_get (guestfs_h *g,\n"
3934 "\t\tconst char *augpath);\n"
3939 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:151
3941 "Look up the value associated with C<path>. If C<path> matches exactly one "
3942 "node, the C<value> is returned."
3946 #: ../src/guestfs-actions.pod:182 ../src/guestfs-actions.pod:610
3947 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:682
3948 #: ../src/guestfs-actions.pod:695 ../src/guestfs-actions.pod:786
3949 #: ../src/guestfs-actions.pod:899 ../src/guestfs-actions.pod:928
3950 #: ../src/guestfs-actions.pod:942 ../src/guestfs-actions.pod:958
3951 #: ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1233
3952 #: ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:1487
3953 #: ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1577
3954 #: ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1729
3955 #: ../src/guestfs-actions.pod:1868 ../src/guestfs-actions.pod:2049
3956 #: ../src/guestfs-actions.pod:2099 ../src/guestfs-actions.pod:2215
3957 #: ../src/guestfs-actions.pod:2250 ../src/guestfs-actions.pod:2565
3958 #: ../src/guestfs-actions.pod:2986 ../src/guestfs-actions.pod:3082
3959 #: ../src/guestfs-actions.pod:3625 ../src/guestfs-actions.pod:3801
3960 #: ../src/guestfs-actions.pod:3919 ../src/guestfs-actions.pod:4057
3961 #: ../src/guestfs-actions.pod:4100 ../src/guestfs-actions.pod:4576
3962 #: ../src/guestfs-actions.pod:4589 ../src/guestfs-actions.pod:4603
3963 #: ../src/guestfs-actions.pod:4624 ../src/guestfs-actions.pod:5183
3964 #: ../src/guestfs-actions.pod:5199 ../src/guestfs-actions.pod:5214
3965 #: ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5592
3967 "This function returns a string, or NULL on error. I<The caller must free "
3968 "the returned string after use>."
3972 #: ../src/guestfs-actions.pod:185
3973 msgid "guestfs_aug_init"
3977 #: ../src/guestfs-actions.pod:187
3980 " int guestfs_aug_init (guestfs_h *g,\n"
3981 "\t\tconst char *root,\n"
3987 #: ../src/guestfs-actions.pod:191 ../fish/guestfish-actions.pod:158
3989 "Create a new Augeas handle for editing configuration files. If there was "
3990 "any previous Augeas handle associated with this guestfs session, then it is "
3995 #: ../src/guestfs-actions.pod:195
3996 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4000 #: ../src/guestfs-actions.pod:198 ../fish/guestfish-actions.pod:165
4002 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4006 #: ../src/guestfs-actions.pod:201 ../fish/guestfish-actions.pod:168
4008 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4009 "logical I<or> of the following integers:"
4013 #: ../src/guestfs-actions.pod:207 ../fish/guestfish-actions.pod:174
4014 msgid "C<AUG_SAVE_BACKUP> = 1"
4018 #: ../src/guestfs-actions.pod:209 ../fish/guestfish-actions.pod:176
4019 msgid "Keep the original file with a C<.augsave> extension."
4023 #: ../src/guestfs-actions.pod:211 ../fish/guestfish-actions.pod:178
4024 msgid "C<AUG_SAVE_NEWFILE> = 2"
4028 #: ../src/guestfs-actions.pod:213 ../fish/guestfish-actions.pod:180
4030 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4031 "original. Overrides C<AUG_SAVE_BACKUP>."
4035 #: ../src/guestfs-actions.pod:216 ../fish/guestfish-actions.pod:183
4036 msgid "C<AUG_TYPE_CHECK> = 4"
4040 #: ../src/guestfs-actions.pod:218 ../fish/guestfish-actions.pod:185
4041 msgid "Typecheck lenses (can be expensive)."
4045 #: ../src/guestfs-actions.pod:220 ../fish/guestfish-actions.pod:187
4046 msgid "C<AUG_NO_STDINC> = 8"
4050 #: ../src/guestfs-actions.pod:222 ../fish/guestfish-actions.pod:189
4051 msgid "Do not use standard load path for modules."
4055 #: ../src/guestfs-actions.pod:224 ../fish/guestfish-actions.pod:191
4056 msgid "C<AUG_SAVE_NOOP> = 16"
4060 #: ../src/guestfs-actions.pod:226 ../fish/guestfish-actions.pod:193
4061 msgid "Make save a no-op, just record what would have been changed."
4065 #: ../src/guestfs-actions.pod:228 ../fish/guestfish-actions.pod:195
4066 msgid "C<AUG_NO_LOAD> = 32"
4070 #: ../src/guestfs-actions.pod:230
4071 msgid "Do not load the tree in C<guestfs_aug_init>."
4075 #: ../src/guestfs-actions.pod:234
4076 msgid "To close the handle, you can call C<guestfs_aug_close>."
4080 #: ../src/guestfs-actions.pod:236 ../fish/guestfish-actions.pod:203
4081 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4085 #: ../src/guestfs-actions.pod:240
4086 msgid "guestfs_aug_insert"
4090 #: ../src/guestfs-actions.pod:242
4093 " int guestfs_aug_insert (guestfs_h *g,\n"
4094 "\t\tconst char *augpath,\n"
4095 "\t\tconst char *label,\n"
4096 "\t\tint before);\n"
4101 #: ../src/guestfs-actions.pod:247 ../fish/guestfish-actions.pod:209
4103 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4104 "or after C<path> (depending on the boolean flag C<before>)."
4108 #: ../src/guestfs-actions.pod:251 ../fish/guestfish-actions.pod:213
4110 "C<path> must match exactly one existing node in the tree, and C<label> must "
4111 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4115 #: ../src/guestfs-actions.pod:257
4116 msgid "guestfs_aug_load"
4120 #: ../src/guestfs-actions.pod:259
4123 " int guestfs_aug_load (guestfs_h *g);\n"
4128 #: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:221
4129 msgid "Load files into the tree."
4133 #: ../src/guestfs-actions.pod:263 ../fish/guestfish-actions.pod:223
4134 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4138 #: ../src/guestfs-actions.pod:268
4139 msgid "guestfs_aug_ls"
4143 #: ../src/guestfs-actions.pod:270
4146 " char **guestfs_aug_ls (guestfs_h *g,\n"
4147 "\t\tconst char *augpath);\n"
4152 #: ../src/guestfs-actions.pod:273
4154 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
4155 "sorting the resulting nodes into alphabetical order."
4159 #: ../src/guestfs-actions.pod:276 ../src/guestfs-actions.pod:289
4160 #: ../src/guestfs-actions.pod:417 ../src/guestfs-actions.pod:802
4161 #: ../src/guestfs-actions.pod:1081 ../src/guestfs-actions.pod:1097
4162 #: ../src/guestfs-actions.pod:1185 ../src/guestfs-actions.pod:1201
4163 #: ../src/guestfs-actions.pod:1432 ../src/guestfs-actions.pod:1766
4164 #: ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1795
4165 #: ../src/guestfs-actions.pod:1832 ../src/guestfs-actions.pod:1853
4166 #: ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1955
4167 #: ../src/guestfs-actions.pod:2121 ../src/guestfs-actions.pod:2289
4168 #: ../src/guestfs-actions.pod:2494 ../src/guestfs-actions.pod:2550
4169 #: ../src/guestfs-actions.pod:2634 ../src/guestfs-actions.pod:2963
4170 #: ../src/guestfs-actions.pod:3470 ../src/guestfs-actions.pod:3896
4171 #: ../src/guestfs-actions.pod:3982 ../src/guestfs-actions.pod:4088
4172 #: ../src/guestfs-actions.pod:4637 ../src/guestfs-actions.pod:4686
4173 #: ../src/guestfs-actions.pod:4738 ../src/guestfs-actions.pod:4854
4174 #: ../src/guestfs-actions.pod:4875 ../src/guestfs-actions.pod:5275
4175 #: ../src/guestfs-actions.pod:5292 ../src/guestfs-actions.pod:5330
4176 #: ../src/guestfs-actions.pod:5466 ../src/guestfs-actions.pod:5482
4177 #: ../src/guestfs-actions.pod:5555 ../src/guestfs-actions.pod:5571
4178 #: ../src/guestfs-actions.pod:5611 ../src/guestfs-actions.pod:5627
4180 "This function returns a NULL-terminated array of strings (like L<environ(3)"
4181 ">), or NULL if there was an error. I<The caller must free the strings and "
4182 "the array after use>."
4186 #: ../src/guestfs-actions.pod:280
4187 msgid "guestfs_aug_match"
4191 #: ../src/guestfs-actions.pod:282
4194 " char **guestfs_aug_match (guestfs_h *g,\n"
4195 "\t\tconst char *augpath);\n"
4200 #: ../src/guestfs-actions.pod:285 ../fish/guestfish-actions.pod:237
4202 "Returns a list of paths which match the path expression C<path>. The "
4203 "returned paths are sufficiently qualified so that they match exactly one "
4204 "node in the current tree."
4208 #: ../src/guestfs-actions.pod:293
4209 msgid "guestfs_aug_mv"
4213 #: ../src/guestfs-actions.pod:295
4216 " int guestfs_aug_mv (guestfs_h *g,\n"
4217 "\t\tconst char *src,\n"
4218 "\t\tconst char *dest);\n"
4223 #: ../src/guestfs-actions.pod:299 ../fish/guestfish-actions.pod:245
4225 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4226 "C<dest> is overwritten if it exists."
4230 #: ../src/guestfs-actions.pod:304
4231 msgid "guestfs_aug_rm"
4235 #: ../src/guestfs-actions.pod:306
4238 " int guestfs_aug_rm (guestfs_h *g,\n"
4239 "\t\tconst char *augpath);\n"
4244 #: ../src/guestfs-actions.pod:309 ../fish/guestfish-actions.pod:252
4245 msgid "Remove C<path> and all of its children."
4249 #: ../src/guestfs-actions.pod:311 ../fish/guestfish-actions.pod:254
4250 msgid "On success this returns the number of entries which were removed."
4254 #: ../src/guestfs-actions.pod:315
4255 msgid "guestfs_aug_save"
4259 #: ../src/guestfs-actions.pod:317
4262 " int guestfs_aug_save (guestfs_h *g);\n"
4267 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:260
4268 msgid "This writes all pending changes to disk."
4272 #: ../src/guestfs-actions.pod:321
4274 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
4279 #: ../src/guestfs-actions.pod:326
4280 msgid "guestfs_aug_set"
4284 #: ../src/guestfs-actions.pod:328
4287 " int guestfs_aug_set (guestfs_h *g,\n"
4288 "\t\tconst char *augpath,\n"
4289 "\t\tconst char *val);\n"
4294 #: ../src/guestfs-actions.pod:332 ../fish/guestfish-actions.pod:269
4295 msgid "Set the value associated with C<path> to C<val>."
4299 #: ../src/guestfs-actions.pod:334
4301 "In the Augeas API, it is possible to clear a node by setting the value to "
4302 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
4303 "this call. Instead you must use the C<guestfs_aug_clear> call."
4307 #: ../src/guestfs-actions.pod:341
4308 msgid "guestfs_available"
4312 #: ../src/guestfs-actions.pod:343
4315 " int guestfs_available (guestfs_h *g,\n"
4316 "\t\tchar *const *groups);\n"
4321 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:280
4323 "This command is used to check the availability of some groups of "
4324 "functionality in the appliance, which not all builds of the libguestfs "
4325 "appliance will be able to provide."
4329 #: ../src/guestfs-actions.pod:350
4331 "The libguestfs groups, and the functions that those groups correspond to, "
4332 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
4333 "runtime by calling C<guestfs_available_all_groups>."
4337 #: ../src/guestfs-actions.pod:355 ../fish/guestfish-actions.pod:289
4339 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
4340 "\"]> would check for the availability of the Linux inotify functions and "
4341 "Augeas (configuration file editing) functions."
4345 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:294
4346 msgid "The command returns no error if I<all> requested groups are available."
4350 #: ../src/guestfs-actions.pod:362 ../fish/guestfish-actions.pod:296
4352 "It fails with an error if one or more of the requested groups is unavailable "
4357 #: ../src/guestfs-actions.pod:365 ../fish/guestfish-actions.pod:299
4359 "If an unknown group name is included in the list of groups then an error is "
4364 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:302
4369 #: ../src/guestfs-actions.pod:374
4370 msgid "You must call C<guestfs_launch> before calling this function."
4374 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:310
4376 "The reason is because we don't know what groups are supported by the "
4377 "appliance/daemon until it is running and can be queried."
4381 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:316
4383 "If a group of functions is available, this does not necessarily mean that "
4384 "they will work. You still have to check for errors when calling individual "
4385 "API functions even if they are available."
4389 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:323
4391 "It is usually the job of distro packagers to build complete functionality "
4392 "into the libguestfs appliance. Upstream libguestfs, if built from source "
4393 "with all requirements satisfied, will support everything."
4397 #: ../src/guestfs-actions.pod:396
4399 "This call was added in version C<1.0.80>. In previous versions of "
4400 "libguestfs all you could do would be to speculatively execute a command to "
4401 "find out if the daemon implemented it. See also C<guestfs_version>."
4405 #: ../src/guestfs-actions.pod:405
4406 msgid "guestfs_available_all_groups"
4410 #: ../src/guestfs-actions.pod:407
4413 " char **guestfs_available_all_groups (guestfs_h *g);\n"
4418 #: ../src/guestfs-actions.pod:409
4420 "This command returns a list of all optional groups that this daemon knows "
4421 "about. Note this returns both supported and unsupported groups. To find "
4422 "out which ones the daemon can actually support you have to call "
4423 "C<guestfs_available> on each member of the returned list."
4427 #: ../src/guestfs-actions.pod:415
4428 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
4432 #: ../src/guestfs-actions.pod:421
4433 msgid "guestfs_base64_in"
4437 #: ../src/guestfs-actions.pod:423
4440 " int guestfs_base64_in (guestfs_h *g,\n"
4441 "\t\tconst char *base64file,\n"
4442 "\t\tconst char *filename);\n"
4447 #: ../src/guestfs-actions.pod:427 ../fish/guestfish-actions.pod:353
4449 "This command uploads base64-encoded data from C<base64file> to C<filename>."
4453 #: ../src/guestfs-actions.pod:432
4454 msgid "guestfs_base64_out"
4458 #: ../src/guestfs-actions.pod:434
4461 " int guestfs_base64_out (guestfs_h *g,\n"
4462 "\t\tconst char *filename,\n"
4463 "\t\tconst char *base64file);\n"
4468 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:362
4470 "This command downloads the contents of C<filename>, writing it out to local "
4471 "file C<base64file> encoded as base64."
4475 #: ../src/guestfs-actions.pod:443
4476 msgid "guestfs_blockdev_flushbufs"
4480 #: ../src/guestfs-actions.pod:445
4483 " int guestfs_blockdev_flushbufs (guestfs_h *g,\n"
4484 "\t\tconst char *device);\n"
4489 #: ../src/guestfs-actions.pod:448 ../fish/guestfish-actions.pod:371
4491 "This tells the kernel to flush internal buffers associated with C<device>."
4495 #: ../src/guestfs-actions.pod:451 ../src/guestfs-actions.pod:465
4496 #: ../src/guestfs-actions.pod:477 ../src/guestfs-actions.pod:490
4497 #: ../src/guestfs-actions.pod:505 ../src/guestfs-actions.pod:521
4498 #: ../src/guestfs-actions.pod:532 ../src/guestfs-actions.pod:547
4499 #: ../src/guestfs-actions.pod:558 ../src/guestfs-actions.pod:569
4500 #: ../fish/guestfish-actions.pod:374 ../fish/guestfish-actions.pod:385
4501 #: ../fish/guestfish-actions.pod:394 ../fish/guestfish-actions.pod:404
4502 #: ../fish/guestfish-actions.pod:416 ../fish/guestfish-actions.pod:429
4503 #: ../fish/guestfish-actions.pod:437 ../fish/guestfish-actions.pod:448
4504 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:464
4505 msgid "This uses the L<blockdev(8)> command."
4509 #: ../src/guestfs-actions.pod:455
4510 msgid "guestfs_blockdev_getbsz"
4514 #: ../src/guestfs-actions.pod:457
4517 " int guestfs_blockdev_getbsz (guestfs_h *g,\n"
4518 "\t\tconst char *device);\n"
4523 #: ../src/guestfs-actions.pod:460 ../fish/guestfish-actions.pod:380
4524 msgid "This returns the block size of a device."
4528 #: ../src/guestfs-actions.pod:462 ../src/guestfs-actions.pod:544
4529 #: ../fish/guestfish-actions.pod:382 ../fish/guestfish-actions.pod:445
4531 "(Note this is different from both I<size in blocks> and I<filesystem block "
4536 #: ../src/guestfs-actions.pod:469
4537 msgid "guestfs_blockdev_getro"
4541 #: ../src/guestfs-actions.pod:471
4544 " int guestfs_blockdev_getro (guestfs_h *g,\n"
4545 "\t\tconst char *device);\n"
4550 #: ../src/guestfs-actions.pod:474 ../fish/guestfish-actions.pod:391
4552 "Returns a boolean indicating if the block device is read-only (true if read-"
4553 "only, false if not)."
4557 #: ../src/guestfs-actions.pod:479 ../src/guestfs-actions.pod:1115
4558 #: ../src/guestfs-actions.pod:1127 ../src/guestfs-actions.pod:1559
4559 #: ../src/guestfs-actions.pod:1567 ../src/guestfs-actions.pod:1627
4560 #: ../src/guestfs-actions.pod:1670 ../src/guestfs-actions.pod:1682
4561 #: ../src/guestfs-actions.pod:1701 ../src/guestfs-actions.pod:1718
4562 #: ../src/guestfs-actions.pod:2303 ../src/guestfs-actions.pod:2314
4563 #: ../src/guestfs-actions.pod:2326 ../src/guestfs-actions.pod:2337
4564 #: ../src/guestfs-actions.pod:2350 ../src/guestfs-actions.pod:2362
4565 #: ../src/guestfs-actions.pod:2375 ../src/guestfs-actions.pod:2386
4566 #: ../src/guestfs-actions.pod:2396 ../src/guestfs-actions.pod:2407
4567 #: ../src/guestfs-actions.pod:2419 ../src/guestfs-actions.pod:2431
4568 #: ../src/guestfs-actions.pod:3595
4569 msgid "This function returns a C truth value on success or -1 on error."
4573 #: ../src/guestfs-actions.pod:481
4574 msgid "guestfs_blockdev_getsize64"
4578 #: ../src/guestfs-actions.pod:483
4581 " int64_t guestfs_blockdev_getsize64 (guestfs_h *g,\n"
4582 "\t\tconst char *device);\n"
4587 #: ../src/guestfs-actions.pod:486 ../fish/guestfish-actions.pod:400
4588 msgid "This returns the size of the device in bytes."
4592 #: ../src/guestfs-actions.pod:488
4593 msgid "See also C<guestfs_blockdev_getsz>."
4597 #: ../src/guestfs-actions.pod:494
4598 msgid "guestfs_blockdev_getss"
4602 #: ../src/guestfs-actions.pod:496
4605 " int guestfs_blockdev_getss (guestfs_h *g,\n"
4606 "\t\tconst char *device);\n"
4611 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:410
4613 "This returns the size of sectors on a block device. Usually 512, but can be "
4614 "larger for modern devices."
4618 #: ../src/guestfs-actions.pod:502
4620 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
4625 #: ../src/guestfs-actions.pod:509
4626 msgid "guestfs_blockdev_getsz"
4630 #: ../src/guestfs-actions.pod:511
4633 " int64_t guestfs_blockdev_getsz (guestfs_h *g,\n"
4634 "\t\tconst char *device);\n"
4639 #: ../src/guestfs-actions.pod:514 ../fish/guestfish-actions.pod:422
4641 "This returns the size of the device in units of 512-byte sectors (even if "
4642 "the sectorsize isn't 512 bytes ... weird)."
4646 #: ../src/guestfs-actions.pod:517
4648 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
4649 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
4653 #: ../src/guestfs-actions.pod:525
4654 msgid "guestfs_blockdev_rereadpt"
4658 #: ../src/guestfs-actions.pod:527
4661 " int guestfs_blockdev_rereadpt (guestfs_h *g,\n"
4662 "\t\tconst char *device);\n"
4667 #: ../src/guestfs-actions.pod:530 ../fish/guestfish-actions.pod:435
4668 msgid "Reread the partition table on C<device>."
4672 #: ../src/guestfs-actions.pod:536
4673 msgid "guestfs_blockdev_setbsz"
4677 #: ../src/guestfs-actions.pod:538
4680 " int guestfs_blockdev_setbsz (guestfs_h *g,\n"
4681 "\t\tconst char *device,\n"
4682 "\t\tint blocksize);\n"
4687 #: ../src/guestfs-actions.pod:542 ../fish/guestfish-actions.pod:443
4688 msgid "This sets the block size of a device."
4692 #: ../src/guestfs-actions.pod:551
4693 msgid "guestfs_blockdev_setro"
4697 #: ../src/guestfs-actions.pod:553
4700 " int guestfs_blockdev_setro (guestfs_h *g,\n"
4701 "\t\tconst char *device);\n"
4706 #: ../src/guestfs-actions.pod:556 ../fish/guestfish-actions.pod:454
4707 msgid "Sets the block device named C<device> to read-only."
4711 #: ../src/guestfs-actions.pod:562
4712 msgid "guestfs_blockdev_setrw"
4716 #: ../src/guestfs-actions.pod:564
4719 " int guestfs_blockdev_setrw (guestfs_h *g,\n"
4720 "\t\tconst char *device);\n"
4725 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:462
4726 msgid "Sets the block device named C<device> to read-write."
4730 #: ../src/guestfs-actions.pod:573
4731 msgid "guestfs_case_sensitive_path"
4735 #: ../src/guestfs-actions.pod:575
4738 " char *guestfs_case_sensitive_path (guestfs_h *g,\n"
4739 "\t\tconst char *path);\n"
4744 #: ../src/guestfs-actions.pod:578 ../fish/guestfish-actions.pod:470
4746 "This can be used to resolve case insensitive paths on a filesystem which is "
4747 "case sensitive. The use case is to resolve paths which you have read from "
4748 "Windows configuration files or the Windows Registry, to the true path."
4752 #: ../src/guestfs-actions.pod:583 ../fish/guestfish-actions.pod:475
4754 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
4755 "(and probably others), which is that although the underlying filesystem is "
4756 "case-insensitive, the driver exports the filesystem to Linux as case-"
4761 #: ../src/guestfs-actions.pod:588 ../fish/guestfish-actions.pod:480
4763 "One consequence of this is that special directories such as C<c:\\windows> "
4764 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
4765 "precise details of how they were created. In Windows itself this would not "
4770 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:486
4772 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
4777 #: ../src/guestfs-actions.pod:597 ../fish/guestfish-actions.pod:489
4779 "This function resolves the true case of each element in the path and returns "
4780 "the case-sensitive path."
4784 #: ../src/guestfs-actions.pod:600
4786 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
4787 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
4788 "how the directories were originally created under Windows)."
4792 #: ../src/guestfs-actions.pod:605 ../fish/guestfish-actions.pod:497
4793 msgid "I<Note>: This function does not handle drive names, backslashes etc."
4797 #: ../src/guestfs-actions.pod:608
4798 msgid "See also C<guestfs_realpath>."
4802 #: ../src/guestfs-actions.pod:613
4807 #: ../src/guestfs-actions.pod:615
4810 " char *guestfs_cat (guestfs_h *g,\n"
4811 "\t\tconst char *path);\n"
4816 #: ../src/guestfs-actions.pod:618 ../src/guestfs-actions.pod:3972
4817 #: ../fish/guestfish-actions.pod:506 ../fish/guestfish-actions.pod:3068
4818 msgid "Return the contents of the file named C<path>."
4822 #: ../src/guestfs-actions.pod:620
4824 "Note that this function cannot correctly handle binary files (specifically, "
4825 "files containing C<\\0> character which is treated as end of string). For "
4826 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
4827 "functions which have a more complex interface."
4831 #: ../src/guestfs-actions.pod:628 ../src/guestfs-actions.pod:789
4832 #: ../src/guestfs-actions.pod:806 ../src/guestfs-actions.pod:1085
4833 #: ../src/guestfs-actions.pod:1101 ../src/guestfs-actions.pod:1189
4834 #: ../src/guestfs-actions.pod:1205 ../src/guestfs-actions.pod:1436
4835 #: ../src/guestfs-actions.pod:1783 ../src/guestfs-actions.pod:1799
4836 #: ../src/guestfs-actions.pod:1836 ../src/guestfs-actions.pod:1857
4837 #: ../src/guestfs-actions.pod:1871 ../src/guestfs-actions.pod:1897
4838 #: ../src/guestfs-actions.pod:3835 ../src/guestfs-actions.pod:3943
4839 #: ../src/guestfs-actions.pod:3964 ../src/guestfs-actions.pod:4690
4840 #: ../src/guestfs-actions.pod:4742 ../src/guestfs-actions.pod:4858
4841 #: ../src/guestfs-actions.pod:4879 ../src/guestfs-actions.pod:5424
4842 #: ../src/guestfs-actions.pod:5447 ../src/guestfs-actions.pod:5470
4843 #: ../src/guestfs-actions.pod:5486 ../src/guestfs-actions.pod:5559
4844 #: ../src/guestfs-actions.pod:5575 ../src/guestfs-actions.pod:5615
4845 #: ../src/guestfs-actions.pod:5631 ../fish/guestfish-actions.pod:513
4846 #: ../fish/guestfish-actions.pod:648 ../fish/guestfish-actions.pod:660
4847 #: ../fish/guestfish-actions.pod:861 ../fish/guestfish-actions.pod:871
4848 #: ../fish/guestfish-actions.pod:938 ../fish/guestfish-actions.pod:948
4849 #: ../fish/guestfish-actions.pod:1143 ../fish/guestfish-actions.pod:1418
4850 #: ../fish/guestfish-actions.pod:1428 ../fish/guestfish-actions.pod:1456
4851 #: ../fish/guestfish-actions.pod:1471 ../fish/guestfish-actions.pod:1481
4852 #: ../fish/guestfish-actions.pod:1500 ../fish/guestfish-actions.pod:2970
4853 #: ../fish/guestfish-actions.pod:3046 ../fish/guestfish-actions.pod:3061
4854 #: ../fish/guestfish-actions.pod:3644 ../fish/guestfish-actions.pod:3690
4855 #: ../fish/guestfish-actions.pod:3775 ../fish/guestfish-actions.pod:3790
4856 #: ../fish/guestfish-actions.pod:4200 ../fish/guestfish-actions.pod:4218
4857 #: ../fish/guestfish-actions.pod:4235 ../fish/guestfish-actions.pod:4245
4858 #: ../fish/guestfish-actions.pod:4293 ../fish/guestfish-actions.pod:4303
4859 #: ../fish/guestfish-actions.pod:4332 ../fish/guestfish-actions.pod:4342
4861 "Because of the message protocol, there is a transfer limit of somewhere "
4862 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
4866 #: ../src/guestfs-actions.pod:631
4867 msgid "guestfs_checksum"
4871 #: ../src/guestfs-actions.pod:633
4874 " char *guestfs_checksum (guestfs_h *g,\n"
4875 "\t\tconst char *csumtype,\n"
4876 "\t\tconst char *path);\n"
4881 #: ../src/guestfs-actions.pod:637 ../fish/guestfish-actions.pod:520
4883 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
4887 #: ../src/guestfs-actions.pod:640 ../fish/guestfish-actions.pod:523
4889 "The type of checksum to compute is given by the C<csumtype> parameter which "
4890 "must have one of the following values:"
4894 #: ../src/guestfs-actions.pod:645 ../fish/guestfish-actions.pod:528
4899 #: ../src/guestfs-actions.pod:647 ../fish/guestfish-actions.pod:530
4901 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
4906 #: ../src/guestfs-actions.pod:650 ../fish/guestfish-actions.pod:533
4911 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:535
4912 msgid "Compute the MD5 hash (using the C<md5sum> program)."
4916 #: ../src/guestfs-actions.pod:654 ../fish/guestfish-actions.pod:537
4921 #: ../src/guestfs-actions.pod:656 ../fish/guestfish-actions.pod:539
4922 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
4926 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:541
4931 #: ../src/guestfs-actions.pod:660 ../fish/guestfish-actions.pod:543
4932 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
4936 #: ../src/guestfs-actions.pod:662 ../fish/guestfish-actions.pod:545
4941 #: ../src/guestfs-actions.pod:664 ../fish/guestfish-actions.pod:547
4942 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
4946 #: ../src/guestfs-actions.pod:666 ../fish/guestfish-actions.pod:549
4951 #: ../src/guestfs-actions.pod:668 ../fish/guestfish-actions.pod:551
4952 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
4956 #: ../src/guestfs-actions.pod:670 ../fish/guestfish-actions.pod:553
4961 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:555
4962 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
4966 #: ../src/guestfs-actions.pod:676 ../fish/guestfish-actions.pod:559
4967 msgid "The checksum is returned as a printable string."
4971 #: ../src/guestfs-actions.pod:678
4972 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
4976 #: ../src/guestfs-actions.pod:680
4977 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
4981 #: ../src/guestfs-actions.pod:685
4982 msgid "guestfs_checksum_device"
4986 #: ../src/guestfs-actions.pod:687
4989 " char *guestfs_checksum_device (guestfs_h *g,\n"
4990 "\t\tconst char *csumtype,\n"
4991 "\t\tconst char *device);\n"
4996 #: ../src/guestfs-actions.pod:691
4998 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
4999 "device named C<device>. For the types of checksums supported see the "
5000 "C<guestfs_checksum> command."
5004 #: ../src/guestfs-actions.pod:698
5005 msgid "guestfs_checksums_out"
5009 #: ../src/guestfs-actions.pod:700
5012 " int guestfs_checksums_out (guestfs_h *g,\n"
5013 "\t\tconst char *csumtype,\n"
5014 "\t\tconst char *directory,\n"
5015 "\t\tconst char *sumsfile);\n"
5020 #: ../src/guestfs-actions.pod:705 ../fish/guestfish-actions.pod:577
5022 "This command computes the checksums of all regular files in C<directory> and "
5023 "then emits a list of those checksums to the local output file C<sumsfile>."
5027 #: ../src/guestfs-actions.pod:709 ../fish/guestfish-actions.pod:581
5029 "This can be used for verifying the integrity of a virtual machine. However "
5030 "to be properly secure you should pay attention to the output of the checksum "
5031 "command (it uses the ones from GNU coreutils). In particular when the "
5032 "filename is not printable, coreutils uses a special backslash syntax. For "
5033 "more information, see the GNU coreutils info file."
5037 #: ../src/guestfs-actions.pod:719
5038 msgid "guestfs_chmod"
5042 #: ../src/guestfs-actions.pod:721
5045 " int guestfs_chmod (guestfs_h *g,\n"
5047 "\t\tconst char *path);\n"
5052 #: ../src/guestfs-actions.pod:725 ../fish/guestfish-actions.pod:595
5054 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5059 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:598
5061 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5062 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5067 #: ../src/guestfs-actions.pod:732 ../src/guestfs-actions.pod:3178
5068 #: ../src/guestfs-actions.pod:3266 ../src/guestfs-actions.pod:3282
5069 #: ../src/guestfs-actions.pod:3298 ../fish/guestfish-actions.pod:602
5070 #: ../fish/guestfish-actions.pod:2475 ../fish/guestfish-actions.pod:2545
5071 #: ../fish/guestfish-actions.pod:2555 ../fish/guestfish-actions.pod:2565
5072 msgid "The mode actually set is affected by the umask."
5076 #: ../src/guestfs-actions.pod:736
5077 msgid "guestfs_chown"
5081 #: ../src/guestfs-actions.pod:738
5084 " int guestfs_chown (guestfs_h *g,\n"
5087 "\t\tconst char *path);\n"
5092 #: ../src/guestfs-actions.pod:743 ../fish/guestfish-actions.pod:608
5093 msgid "Change the file owner to C<owner> and group to C<group>."
5097 #: ../src/guestfs-actions.pod:745 ../src/guestfs-actions.pod:2464
5098 #: ../fish/guestfish-actions.pod:610 ../fish/guestfish-actions.pod:1966
5100 "Only numeric uid and gid are supported. If you want to use names, you will "
5101 "need to locate and parse the password file yourself (Augeas support makes "
5102 "this relatively easy)."
5106 #: ../src/guestfs-actions.pod:751
5107 msgid "guestfs_command"
5111 #: ../src/guestfs-actions.pod:753
5114 " char *guestfs_command (guestfs_h *g,\n"
5115 "\t\tchar *const *arguments);\n"
5120 #: ../src/guestfs-actions.pod:756 ../fish/guestfish-actions.pod:618
5122 "This call runs a command from the guest filesystem. The filesystem must be "
5123 "mounted, and must contain a compatible operating system (ie. something "
5124 "Linux, with the same or compatible processor architecture)."
5128 #: ../src/guestfs-actions.pod:761
5130 "The single parameter is an argv-style list of arguments. The first element "
5131 "is the name of the program to run. Subsequent elements are parameters. The "
5132 "list must be non-empty (ie. must contain a program name). Note that the "
5133 "command runs directly, and is I<not> invoked via the shell (see "
5138 #: ../src/guestfs-actions.pod:768 ../fish/guestfish-actions.pod:630
5139 msgid "The return value is anything printed to I<stdout> by the command."
5143 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:633
5145 "If the command returns a non-zero exit status, then this function returns an "
5146 "error message. The error message string is the content of I<stderr> from "
5151 #: ../src/guestfs-actions.pod:775 ../fish/guestfish-actions.pod:637
5153 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
5154 "bin>. If you require a program from another location, you should provide "
5155 "the full path in the first parameter."
5159 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:642
5161 "Shared libraries and data files required by the program must be available on "
5162 "filesystems which are mounted in the correct places. It is the caller's "
5163 "responsibility to ensure all filesystems that are needed are mounted at the "
5168 #: ../src/guestfs-actions.pod:792
5169 msgid "guestfs_command_lines"
5173 #: ../src/guestfs-actions.pod:794
5176 " char **guestfs_command_lines (guestfs_h *g,\n"
5177 "\t\tchar *const *arguments);\n"
5182 #: ../src/guestfs-actions.pod:797
5184 "This is the same as C<guestfs_command>, but splits the result into a list of "
5189 #: ../src/guestfs-actions.pod:800
5190 msgid "See also: C<guestfs_sh_lines>"
5194 #: ../src/guestfs-actions.pod:809
5195 msgid "guestfs_config"
5199 #: ../src/guestfs-actions.pod:811
5202 " int guestfs_config (guestfs_h *g,\n"
5203 "\t\tconst char *qemuparam,\n"
5204 "\t\tconst char *qemuvalue);\n"
5209 #: ../src/guestfs-actions.pod:815 ../fish/guestfish-actions.pod:667
5211 "This can be used to add arbitrary qemu command line parameters of the form "
5212 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
5213 "setting some parameters which would interfere with parameters that we use."
5217 #: ../src/guestfs-actions.pod:820 ../fish/guestfish-actions.pod:672
5218 msgid "The first character of C<param> string must be a C<-> (dash)."
5222 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:674
5223 msgid "C<value> can be NULL."
5227 #: ../src/guestfs-actions.pod:826
5228 msgid "guestfs_copy_size"
5232 #: ../src/guestfs-actions.pod:828
5235 " int guestfs_copy_size (guestfs_h *g,\n"
5236 "\t\tconst char *src,\n"
5237 "\t\tconst char *dest,\n"
5238 "\t\tint64_t size);\n"
5243 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:680
5245 "This command copies exactly C<size> bytes from one source device or file "
5246 "C<src> to another destination device or file C<dest>."
5250 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:683
5252 "Note this will fail if the source is too short or if the destination is not "
5257 #: ../src/guestfs-actions.pod:841 ../src/guestfs-actions.pod:976
5258 #: ../src/guestfs-actions.pod:1004 ../src/guestfs-actions.pod:1376
5259 #: ../src/guestfs-actions.pod:1395 ../src/guestfs-actions.pod:5504
5260 #: ../src/guestfs-actions.pod:5520
5262 "This long-running command can generate progress notification messages so "
5263 "that the caller can display a progress bar or indicator. To receive these "
5264 "messages, the caller must register a progress callback. See L<guestfs(3)/"
5265 "guestfs_set_progress_callback>."
5269 #: ../src/guestfs-actions.pod:846
5274 #: ../src/guestfs-actions.pod:848
5277 " int guestfs_cp (guestfs_h *g,\n"
5278 "\t\tconst char *src,\n"
5279 "\t\tconst char *dest);\n"
5284 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:690
5286 "This copies a file from C<src> to C<dest> where C<dest> is either a "
5287 "destination filename or destination directory."
5291 #: ../src/guestfs-actions.pod:857
5292 msgid "guestfs_cp_a"
5296 #: ../src/guestfs-actions.pod:859
5299 " int guestfs_cp_a (guestfs_h *g,\n"
5300 "\t\tconst char *src,\n"
5301 "\t\tconst char *dest);\n"
5306 #: ../src/guestfs-actions.pod:863 ../fish/guestfish-actions.pod:697
5308 "This copies a file or directory from C<src> to C<dest> recursively using the "
5313 #: ../src/guestfs-actions.pod:868
5318 #: ../src/guestfs-actions.pod:870
5321 " int guestfs_dd (guestfs_h *g,\n"
5322 "\t\tconst char *src,\n"
5323 "\t\tconst char *dest);\n"
5328 #: ../src/guestfs-actions.pod:874 ../fish/guestfish-actions.pod:704
5330 "This command copies from one source device or file C<src> to another "
5331 "destination device or file C<dest>. Normally you would use this to copy to "
5332 "or from a device or partition, for example to duplicate a filesystem."
5336 #: ../src/guestfs-actions.pod:879
5338 "If the destination is a device, it must be as large or larger than the "
5339 "source file or device, otherwise the copy will fail. This command cannot do "
5340 "partial copies (see C<guestfs_copy_size>)."
5344 #: ../src/guestfs-actions.pod:885
5345 msgid "guestfs_debug"
5349 #: ../src/guestfs-actions.pod:887
5352 " char *guestfs_debug (guestfs_h *g,\n"
5353 "\t\tconst char *subcmd,\n"
5354 "\t\tchar *const *extraargs);\n"
5359 #: ../src/guestfs-actions.pod:891
5361 "The C<guestfs_debug> command exposes some internals of C<guestfsd> (the "
5362 "guestfs daemon) that runs inside the qemu subprocess."
5366 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:721
5368 "There is no comprehensive help for this command. You have to look at the "
5369 "file C<daemon/debug.c> in the libguestfs source to find out what you can do."
5373 #: ../src/guestfs-actions.pod:902
5374 msgid "guestfs_debug_upload"
5378 #: ../src/guestfs-actions.pod:904
5381 " int guestfs_debug_upload (guestfs_h *g,\n"
5382 "\t\tconst char *filename,\n"
5383 "\t\tconst char *tmpname,\n"
5389 #: ../src/guestfs-actions.pod:909
5391 "The C<guestfs_debug_upload> command uploads a file to the libguestfs "
5396 #: ../src/guestfs-actions.pod:912 ../fish/guestfish-actions.pod:732
5398 "There is no comprehensive help for this command. You have to look at the "
5399 "file C<daemon/debug.c> in the libguestfs source to find out what it is for."
5403 #: ../src/guestfs-actions.pod:918
5408 #: ../src/guestfs-actions.pod:920
5411 " char *guestfs_df (guestfs_h *g);\n"
5416 #: ../src/guestfs-actions.pod:922 ../fish/guestfish-actions.pod:742
5417 msgid "This command runs the C<df> command to report disk space used."
5421 #: ../src/guestfs-actions.pod:924 ../src/guestfs-actions.pod:938
5422 #: ../fish/guestfish-actions.pod:744 ../fish/guestfish-actions.pod:755
5424 "This command is mostly useful for interactive sessions. It is I<not> "
5425 "intended that you try to parse the output string. Use C<statvfs> from "
5430 #: ../src/guestfs-actions.pod:931
5431 msgid "guestfs_df_h"
5435 #: ../src/guestfs-actions.pod:933
5438 " char *guestfs_df_h (guestfs_h *g);\n"
5443 #: ../src/guestfs-actions.pod:935 ../fish/guestfish-actions.pod:752
5445 "This command runs the C<df -h> command to report disk space used in human-"
5450 #: ../src/guestfs-actions.pod:945
5451 msgid "guestfs_dmesg"
5455 #: ../src/guestfs-actions.pod:947
5458 " char *guestfs_dmesg (guestfs_h *g);\n"
5463 #: ../src/guestfs-actions.pod:949 ../fish/guestfish-actions.pod:763
5465 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
5466 "This is sometimes useful for extended debugging of problems."
5470 #: ../src/guestfs-actions.pod:953
5472 "Another way to get the same information is to enable verbose messages with "
5473 "C<guestfs_set_verbose> or by setting the environment variable "
5474 "C<LIBGUESTFS_DEBUG=1> before running the program."
5478 #: ../src/guestfs-actions.pod:961
5479 msgid "guestfs_download"
5483 #: ../src/guestfs-actions.pod:963
5486 " int guestfs_download (guestfs_h *g,\n"
5487 "\t\tconst char *remotefilename,\n"
5488 "\t\tconst char *filename);\n"
5493 #: ../src/guestfs-actions.pod:967 ../src/guestfs-actions.pod:989
5494 #: ../fish/guestfish-actions.pod:776 ../fish/guestfish-actions.pod:789
5496 "Download file C<remotefilename> and save it as C<filename> on the local "
5501 #: ../src/guestfs-actions.pod:970 ../src/guestfs-actions.pod:5072
5502 #: ../fish/guestfish-actions.pod:779 ../fish/guestfish-actions.pod:3948
5503 msgid "C<filename> can also be a named pipe."
5507 #: ../src/guestfs-actions.pod:972
5508 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
5512 #: ../src/guestfs-actions.pod:981
5513 msgid "guestfs_download_offset"
5517 #: ../src/guestfs-actions.pod:983
5520 " int guestfs_download_offset (guestfs_h *g,\n"
5521 "\t\tconst char *remotefilename,\n"
5522 "\t\tconst char *filename,\n"
5523 "\t\tint64_t offset,\n"
5524 "\t\tint64_t size);\n"
5529 #: ../src/guestfs-actions.pod:992 ../fish/guestfish-actions.pod:792
5531 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
5532 "region must be within the file or device)."
5536 #: ../src/guestfs-actions.pod:995
5538 "Note that there is no limit on the amount of data that can be downloaded "
5539 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
5540 "full amount unless an error occurs."
5544 #: ../src/guestfs-actions.pod:1000
5545 msgid "See also C<guestfs_download>, C<guestfs_pread>."
5549 #: ../src/guestfs-actions.pod:1009
5550 msgid "guestfs_drop_caches"
5554 #: ../src/guestfs-actions.pod:1011
5557 " int guestfs_drop_caches (guestfs_h *g,\n"
5558 "\t\tint whattodrop);\n"
5563 #: ../src/guestfs-actions.pod:1014 ../fish/guestfish-actions.pod:808
5565 "This instructs the guest kernel to drop its page cache, and/or dentries and "
5566 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
5567 "to drop, see L<http://linux-mm.org/Drop_Caches>"
5571 #: ../src/guestfs-actions.pod:1019 ../fish/guestfish-actions.pod:813
5572 msgid "Setting C<whattodrop> to 3 should drop everything."
5576 #: ../src/guestfs-actions.pod:1021 ../fish/guestfish-actions.pod:815
5578 "This automatically calls L<sync(2)> before the operation, so that the "
5579 "maximum guest memory is freed."
5583 #: ../src/guestfs-actions.pod:1026
5588 #: ../src/guestfs-actions.pod:1028
5591 " int64_t guestfs_du (guestfs_h *g,\n"
5592 "\t\tconst char *path);\n"
5597 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:822
5599 "This command runs the C<du -s> command to estimate file space usage for "
5604 #: ../src/guestfs-actions.pod:1034 ../fish/guestfish-actions.pod:825
5606 "C<path> can be a file or a directory. If C<path> is a directory then the "
5607 "estimate includes the contents of the directory and all subdirectories "
5612 #: ../src/guestfs-actions.pod:1038 ../fish/guestfish-actions.pod:829
5614 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
5618 #: ../src/guestfs-actions.pod:1043
5619 msgid "guestfs_e2fsck_f"
5623 #: ../src/guestfs-actions.pod:1045
5626 " int guestfs_e2fsck_f (guestfs_h *g,\n"
5627 "\t\tconst char *device);\n"
5632 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:836
5634 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
5635 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
5640 #: ../src/guestfs-actions.pod:1052
5642 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
5643 "Normally you should use C<guestfs_fsck>."
5647 #: ../src/guestfs-actions.pod:1057
5648 msgid "guestfs_echo_daemon"
5652 #: ../src/guestfs-actions.pod:1059
5655 " char *guestfs_echo_daemon (guestfs_h *g,\n"
5656 "\t\tchar *const *words);\n"
5661 #: ../src/guestfs-actions.pod:1062 ../fish/guestfish-actions.pod:847
5663 "This command concatenates the list of C<words> passed with single spaces "
5664 "between them and returns the resulting string."
5668 #: ../src/guestfs-actions.pod:1065 ../fish/guestfish-actions.pod:850
5669 msgid "You can use this command to test the connection through to the daemon."
5673 #: ../src/guestfs-actions.pod:1067
5674 msgid "See also C<guestfs_ping_daemon>."
5678 #: ../src/guestfs-actions.pod:1072
5679 msgid "guestfs_egrep"
5683 #: ../src/guestfs-actions.pod:1074
5686 " char **guestfs_egrep (guestfs_h *g,\n"
5687 "\t\tconst char *regex,\n"
5688 "\t\tconst char *path);\n"
5693 #: ../src/guestfs-actions.pod:1078 ../fish/guestfish-actions.pod:858
5695 "This calls the external C<egrep> program and returns the matching lines."
5699 #: ../src/guestfs-actions.pod:1088
5700 msgid "guestfs_egrepi"
5704 #: ../src/guestfs-actions.pod:1090
5707 " char **guestfs_egrepi (guestfs_h *g,\n"
5708 "\t\tconst char *regex,\n"
5709 "\t\tconst char *path);\n"
5714 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:868
5716 "This calls the external C<egrep -i> program and returns the matching lines."
5720 #: ../src/guestfs-actions.pod:1104
5721 msgid "guestfs_equal"
5725 #: ../src/guestfs-actions.pod:1106
5728 " int guestfs_equal (guestfs_h *g,\n"
5729 "\t\tconst char *file1,\n"
5730 "\t\tconst char *file2);\n"
5735 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:878
5737 "This compares the two files C<file1> and C<file2> and returns true if their "
5738 "content is exactly equal, or false otherwise."
5742 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:881
5743 msgid "The external L<cmp(1)> program is used for the comparison."
5747 #: ../src/guestfs-actions.pod:1117
5748 msgid "guestfs_exists"
5752 #: ../src/guestfs-actions.pod:1119
5755 " int guestfs_exists (guestfs_h *g,\n"
5756 "\t\tconst char *path);\n"
5761 #: ../src/guestfs-actions.pod:1122 ../fish/guestfish-actions.pod:887
5763 "This returns C<true> if and only if there is a file, directory (or anything) "
5764 "with the given C<path> name."
5768 #: ../src/guestfs-actions.pod:1125
5769 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
5773 #: ../src/guestfs-actions.pod:1129
5774 msgid "guestfs_fallocate"
5778 #: ../src/guestfs-actions.pod:1131
5781 " int guestfs_fallocate (guestfs_h *g,\n"
5782 "\t\tconst char *path,\n"
5788 #: ../src/guestfs-actions.pod:1135 ../src/guestfs-actions.pod:1158
5789 #: ../fish/guestfish-actions.pod:896 ../fish/guestfish-actions.pod:915
5791 "This command preallocates a file (containing zero bytes) named C<path> of "
5792 "size C<len> bytes. If the file exists already, it is overwritten."
5796 #: ../src/guestfs-actions.pod:1139 ../fish/guestfish-actions.pod:900
5798 "Do not confuse this with the guestfish-specific C<alloc> command which "
5799 "allocates a file in the host and attaches it as a device."
5803 #: ../src/guestfs-actions.pod:1145 ../fish/guestfish-actions.pod:904
5805 "This function is deprecated. In new code, use the C<fallocate64> call "
5810 #: ../src/guestfs-actions.pod:1148 ../src/guestfs-actions.pod:1583
5811 #: ../src/guestfs-actions.pod:1601 ../src/guestfs-actions.pod:5453
5812 #: ../src/guestfs-actions.pod:5598 ../fish/guestfish-actions.pod:907
5813 #: ../fish/guestfish-actions.pod:1264 ../fish/guestfish-actions.pod:1278
5814 #: ../fish/guestfish-actions.pod:4224 ../fish/guestfish-actions.pod:4321
5816 "Deprecated functions will not be removed from the API, but the fact that "
5817 "they are deprecated indicates that there are problems with correct use of "
5822 #: ../src/guestfs-actions.pod:1152
5823 msgid "guestfs_fallocate64"
5827 #: ../src/guestfs-actions.pod:1154
5830 " int guestfs_fallocate64 (guestfs_h *g,\n"
5831 "\t\tconst char *path,\n"
5832 "\t\tint64_t len);\n"
5837 #: ../src/guestfs-actions.pod:1162
5839 "Note that this call allocates disk blocks for the file. To create a sparse "
5840 "file use C<guestfs_truncate_size> instead."
5844 #: ../src/guestfs-actions.pod:1165
5846 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
5847 "oversight it only allowed 30 bit lengths to be specified, effectively "
5848 "limiting the maximum size of files created through that call to 1GB."
5852 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:927
5854 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
5855 "commands which create a file in the host and attach it as a device."
5859 #: ../src/guestfs-actions.pod:1176
5860 msgid "guestfs_fgrep"
5864 #: ../src/guestfs-actions.pod:1178
5867 " char **guestfs_fgrep (guestfs_h *g,\n"
5868 "\t\tconst char *pattern,\n"
5869 "\t\tconst char *path);\n"
5874 #: ../src/guestfs-actions.pod:1182 ../fish/guestfish-actions.pod:935
5876 "This calls the external C<fgrep> program and returns the matching lines."
5880 #: ../src/guestfs-actions.pod:1192
5881 msgid "guestfs_fgrepi"
5885 #: ../src/guestfs-actions.pod:1194
5888 " char **guestfs_fgrepi (guestfs_h *g,\n"
5889 "\t\tconst char *pattern,\n"
5890 "\t\tconst char *path);\n"
5895 #: ../src/guestfs-actions.pod:1198 ../fish/guestfish-actions.pod:945
5897 "This calls the external C<fgrep -i> program and returns the matching lines."
5901 #: ../src/guestfs-actions.pod:1208
5902 msgid "guestfs_file"
5906 #: ../src/guestfs-actions.pod:1210
5909 " char *guestfs_file (guestfs_h *g,\n"
5910 "\t\tconst char *path);\n"
5915 #: ../src/guestfs-actions.pod:1213 ../fish/guestfish-actions.pod:955
5917 "This call uses the standard L<file(1)> command to determine the type or "
5918 "contents of the file."
5922 #: ../src/guestfs-actions.pod:1216 ../fish/guestfish-actions.pod:958
5924 "This call will also transparently look inside various types of compressed "
5929 #: ../src/guestfs-actions.pod:1219 ../fish/guestfish-actions.pod:961
5931 "The exact command which runs is C<file -zb path>. Note in particular that "
5932 "the filename is not prepended to the output (the C<-b> option)."
5936 #: ../src/guestfs-actions.pod:1223
5938 "This command can also be used on C</dev/> devices (and partitions, LV "
5939 "names). You can for example use this to determine if a device contains a "
5940 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
5944 #: ../src/guestfs-actions.pod:1228 ../fish/guestfish-actions.pod:970
5946 "If the C<path> does not begin with C</dev/> then this command only works for "
5947 "the content of regular files. For other file types (directory, symbolic "
5948 "link etc) it will just return the string C<directory> etc."
5952 #: ../src/guestfs-actions.pod:1236
5953 msgid "guestfs_file_architecture"
5957 #: ../src/guestfs-actions.pod:1238
5960 " char *guestfs_file_architecture (guestfs_h *g,\n"
5961 "\t\tconst char *filename);\n"
5966 #: ../src/guestfs-actions.pod:1241 ../fish/guestfish-actions.pod:979
5968 "This detects the architecture of the binary C<filename>, and returns it if "
5973 #: ../src/guestfs-actions.pod:1244 ../fish/guestfish-actions.pod:982
5974 msgid "Currently defined architectures are:"
5978 #: ../src/guestfs-actions.pod:1248 ../fish/guestfish-actions.pod:986
5983 #: ../src/guestfs-actions.pod:1250 ../fish/guestfish-actions.pod:988
5985 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
5986 "irrespective of the precise processor requirements of the binary."
5990 #: ../src/guestfs-actions.pod:1253 ../fish/guestfish-actions.pod:991
5995 #: ../src/guestfs-actions.pod:1255 ../fish/guestfish-actions.pod:993
5996 msgid "64 bit x86-64."
6000 #: ../src/guestfs-actions.pod:1257 ../fish/guestfish-actions.pod:995
6005 #: ../src/guestfs-actions.pod:1259 ../fish/guestfish-actions.pod:997
6006 msgid "32 bit SPARC."
6010 #: ../src/guestfs-actions.pod:1261 ../fish/guestfish-actions.pod:999
6015 #: ../src/guestfs-actions.pod:1263 ../fish/guestfish-actions.pod:1001
6016 msgid "64 bit SPARC V9 and above."
6020 #: ../src/guestfs-actions.pod:1265 ../fish/guestfish-actions.pod:1003
6025 #: ../src/guestfs-actions.pod:1267 ../fish/guestfish-actions.pod:1005
6026 msgid "Intel Itanium."
6030 #: ../src/guestfs-actions.pod:1269 ../fish/guestfish-actions.pod:1007
6035 #: ../src/guestfs-actions.pod:1271 ../fish/guestfish-actions.pod:1009
6036 msgid "32 bit Power PC."
6040 #: ../src/guestfs-actions.pod:1273 ../fish/guestfish-actions.pod:1011
6045 #: ../src/guestfs-actions.pod:1275 ../fish/guestfish-actions.pod:1013
6046 msgid "64 bit Power PC."
6050 #: ../src/guestfs-actions.pod:1279 ../fish/guestfish-actions.pod:1017
6051 msgid "Libguestfs may return other architecture strings in future."
6055 #: ../src/guestfs-actions.pod:1281 ../fish/guestfish-actions.pod:1019
6056 msgid "The function works on at least the following types of files:"
6060 #: ../src/guestfs-actions.pod:1287 ../fish/guestfish-actions.pod:1025
6061 msgid "many types of Un*x and Linux binary"
6065 #: ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:1029
6066 msgid "many types of Un*x and Linux shared library"
6070 #: ../src/guestfs-actions.pod:1295 ../fish/guestfish-actions.pod:1033
6071 msgid "Windows Win32 and Win64 binaries"
6075 #: ../src/guestfs-actions.pod:1299 ../fish/guestfish-actions.pod:1037
6076 msgid "Windows Win32 and Win64 DLLs"
6080 #: ../src/guestfs-actions.pod:1301 ../fish/guestfish-actions.pod:1039
6081 msgid "Win32 binaries and DLLs return C<i386>."
6085 #: ../src/guestfs-actions.pod:1303 ../fish/guestfish-actions.pod:1041
6086 msgid "Win64 binaries and DLLs return C<x86_64>."
6090 #: ../src/guestfs-actions.pod:1307 ../fish/guestfish-actions.pod:1045
6091 msgid "Linux kernel modules"
6095 #: ../src/guestfs-actions.pod:1311 ../fish/guestfish-actions.pod:1049
6096 msgid "Linux new-style initrd images"
6100 #: ../src/guestfs-actions.pod:1315 ../fish/guestfish-actions.pod:1053
6101 msgid "some non-x86 Linux vmlinuz kernels"
6105 #: ../src/guestfs-actions.pod:1319 ../fish/guestfish-actions.pod:1057
6106 msgid "What it can't do currently:"
6110 #: ../src/guestfs-actions.pod:1325 ../fish/guestfish-actions.pod:1063
6111 msgid "static libraries (libfoo.a)"
6115 #: ../src/guestfs-actions.pod:1329 ../fish/guestfish-actions.pod:1067
6116 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6120 #: ../src/guestfs-actions.pod:1333 ../fish/guestfish-actions.pod:1071
6121 msgid "x86 Linux vmlinuz kernels"
6125 #: ../src/guestfs-actions.pod:1335 ../fish/guestfish-actions.pod:1073
6127 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6128 "compressed code, and are horribly hard to unpack. If you want to find the "
6129 "architecture of a kernel, use the architecture of the associated initrd or "
6130 "kernel module(s) instead."
6134 #: ../src/guestfs-actions.pod:1345
6135 msgid "guestfs_filesize"
6139 #: ../src/guestfs-actions.pod:1347
6142 " int64_t guestfs_filesize (guestfs_h *g,\n"
6143 "\t\tconst char *file);\n"
6148 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:1084
6149 msgid "This command returns the size of C<file> in bytes."
6153 #: ../src/guestfs-actions.pod:1352
6155 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
6156 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
6157 "devices, use C<guestfs_blockdev_getsize64>."
6161 #: ../src/guestfs-actions.pod:1358
6162 msgid "guestfs_fill"
6166 #: ../src/guestfs-actions.pod:1360
6169 " int guestfs_fill (guestfs_h *g,\n"
6172 "\t\tconst char *path);\n"
6177 #: ../src/guestfs-actions.pod:1365 ../fish/guestfish-actions.pod:1094
6179 "This command creates a new file called C<path>. The initial content of the "
6180 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
6185 #: ../src/guestfs-actions.pod:1369
6187 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6188 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
6189 "bytes use C<guestfs_fill_pattern>."
6193 #: ../src/guestfs-actions.pod:1381
6194 msgid "guestfs_fill_pattern"
6198 #: ../src/guestfs-actions.pod:1383
6201 " int guestfs_fill_pattern (guestfs_h *g,\n"
6202 "\t\tconst char *pattern,\n"
6204 "\t\tconst char *path);\n"
6209 #: ../src/guestfs-actions.pod:1388
6211 "This function is like C<guestfs_fill> except that it creates a new file of "
6212 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
6213 "pattern is truncated if necessary to ensure the length of the file is "
6214 "exactly C<len> bytes."
6218 #: ../src/guestfs-actions.pod:1400
6219 msgid "guestfs_find"
6223 #: ../src/guestfs-actions.pod:1402
6226 " char **guestfs_find (guestfs_h *g,\n"
6227 "\t\tconst char *directory);\n"
6232 #: ../src/guestfs-actions.pod:1405 ../fish/guestfish-actions.pod:1116
6234 "This command lists out all files and directories, recursively, starting at "
6235 "C<directory>. It is essentially equivalent to running the shell command "
6236 "C<find directory -print> but some post-processing happens on the output, "
6241 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:1121
6243 "This returns a list of strings I<without any prefix>. Thus if the directory "
6248 #: ../src/guestfs-actions.pod:1413 ../fish/guestfish-actions.pod:1124
6258 #: ../src/guestfs-actions.pod:1417
6260 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
6264 #: ../src/guestfs-actions.pod:1420 ../fish/guestfish-actions.pod:1131
6275 #: ../src/guestfs-actions.pod:1425 ../fish/guestfish-actions.pod:1136
6276 msgid "If C<directory> is not a directory, then this command returns an error."
6280 #: ../src/guestfs-actions.pod:1428 ../fish/guestfish-actions.pod:1139
6281 msgid "The returned list is sorted."
6285 #: ../src/guestfs-actions.pod:1430
6286 msgid "See also C<guestfs_find0>."
6290 #: ../src/guestfs-actions.pod:1439
6291 msgid "guestfs_find0"
6295 #: ../src/guestfs-actions.pod:1441
6298 " int guestfs_find0 (guestfs_h *g,\n"
6299 "\t\tconst char *directory,\n"
6300 "\t\tconst char *files);\n"
6305 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:1150
6307 "This command lists out all files and directories, recursively, starting at "
6308 "C<directory>, placing the resulting list in the external file called "
6313 #: ../src/guestfs-actions.pod:1449
6315 "This command works the same way as C<guestfs_find> with the following "
6320 #: ../src/guestfs-actions.pod:1456 ../fish/guestfish-actions.pod:1161
6321 msgid "The resulting list is written to an external file."
6325 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:1165
6327 "Items (filenames) in the result are separated by C<\\0> characters. See "
6328 "L<find(1)> option I<-print0>."
6332 #: ../src/guestfs-actions.pod:1465 ../fish/guestfish-actions.pod:1170
6333 msgid "This command is not limited in the number of names that it can return."
6337 #: ../src/guestfs-actions.pod:1470 ../fish/guestfish-actions.pod:1175
6338 msgid "The result list is not sorted."
6342 #: ../src/guestfs-actions.pod:1476
6343 msgid "guestfs_findfs_label"
6347 #: ../src/guestfs-actions.pod:1478
6350 " char *guestfs_findfs_label (guestfs_h *g,\n"
6351 "\t\tconst char *label);\n"
6356 #: ../src/guestfs-actions.pod:1481 ../fish/guestfish-actions.pod:1185
6358 "This command searches the filesystems and returns the one which has the "
6359 "given label. An error is returned if no such filesystem can be found."
6363 #: ../src/guestfs-actions.pod:1485
6364 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
6368 #: ../src/guestfs-actions.pod:1490
6369 msgid "guestfs_findfs_uuid"
6373 #: ../src/guestfs-actions.pod:1492
6376 " char *guestfs_findfs_uuid (guestfs_h *g,\n"
6377 "\t\tconst char *uuid);\n"
6382 #: ../src/guestfs-actions.pod:1495 ../fish/guestfish-actions.pod:1195
6384 "This command searches the filesystems and returns the one which has the "
6385 "given UUID. An error is returned if no such filesystem can be found."
6389 #: ../src/guestfs-actions.pod:1499
6390 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
6394 #: ../src/guestfs-actions.pod:1504
6395 msgid "guestfs_fsck"
6399 #: ../src/guestfs-actions.pod:1506
6402 " int guestfs_fsck (guestfs_h *g,\n"
6403 "\t\tconst char *fstype,\n"
6404 "\t\tconst char *device);\n"
6409 #: ../src/guestfs-actions.pod:1510 ../fish/guestfish-actions.pod:1205
6411 "This runs the filesystem checker (fsck) on C<device> which should have "
6412 "filesystem type C<fstype>."
6416 #: ../src/guestfs-actions.pod:1513 ../fish/guestfish-actions.pod:1208
6418 "The returned integer is the status. See L<fsck(8)> for the list of status "
6419 "codes from C<fsck>."
6423 #: ../src/guestfs-actions.pod:1522 ../fish/guestfish-actions.pod:1217
6424 msgid "Multiple status codes can be summed together."
6428 #: ../src/guestfs-actions.pod:1526 ../fish/guestfish-actions.pod:1221
6430 "A non-zero return code can mean \"success\", for example if errors have been "
6431 "corrected on the filesystem."
6435 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1226
6436 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
6440 #: ../src/guestfs-actions.pod:1536 ../fish/guestfish-actions.pod:1231
6442 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
6446 #: ../src/guestfs-actions.pod:1540
6447 msgid "guestfs_get_append"
6451 #: ../src/guestfs-actions.pod:1542
6454 " const char *guestfs_get_append (guestfs_h *g);\n"
6459 #: ../src/guestfs-actions.pod:1544 ../fish/guestfish-actions.pod:1237
6461 "Return the additional kernel options which are added to the guest kernel "
6466 #: ../src/guestfs-actions.pod:1547 ../fish/guestfish-actions.pod:1240
6467 msgid "If C<NULL> then no options are added."
6471 #: ../src/guestfs-actions.pod:1549
6473 "This function returns a string which may be NULL. There is no way to return "
6474 "an error from this function. The string is owned by the guest handle and "
6475 "must I<not> be freed."
6479 #: ../src/guestfs-actions.pod:1553
6480 msgid "guestfs_get_autosync"
6484 #: ../src/guestfs-actions.pod:1555
6487 " int guestfs_get_autosync (guestfs_h *g);\n"
6492 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1246
6493 msgid "Get the autosync flag."
6497 #: ../src/guestfs-actions.pod:1561
6498 msgid "guestfs_get_direct"
6502 #: ../src/guestfs-actions.pod:1563
6505 " int guestfs_get_direct (guestfs_h *g);\n"
6510 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1252
6511 msgid "Return the direct appliance mode flag."
6515 #: ../src/guestfs-actions.pod:1569
6516 msgid "guestfs_get_e2label"
6520 #: ../src/guestfs-actions.pod:1571
6523 " char *guestfs_get_e2label (guestfs_h *g,\n"
6524 "\t\tconst char *device);\n"
6529 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1258
6531 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
6535 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1261
6537 "This function is deprecated. In new code, use the C<vfs_label> call instead."
6541 #: ../src/guestfs-actions.pod:1587
6542 msgid "guestfs_get_e2uuid"
6546 #: ../src/guestfs-actions.pod:1589
6549 " char *guestfs_get_e2uuid (guestfs_h *g,\n"
6550 "\t\tconst char *device);\n"
6555 #: ../src/guestfs-actions.pod:1592 ../fish/guestfish-actions.pod:1272
6557 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
6561 #: ../src/guestfs-actions.pod:1598 ../fish/guestfish-actions.pod:1275
6563 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
6567 #: ../src/guestfs-actions.pod:1605
6568 msgid "guestfs_get_memsize"
6572 #: ../src/guestfs-actions.pod:1607
6575 " int guestfs_get_memsize (guestfs_h *g);\n"
6580 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1286
6582 "This gets the memory size in megabytes allocated to the qemu subprocess."
6586 #: ../src/guestfs-actions.pod:1612
6588 "If C<guestfs_set_memsize> was not called on this handle, and if "
6589 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
6590 "value for memsize."
6594 #: ../src/guestfs-actions.pod:1616 ../src/guestfs-actions.pod:1679
6595 #: ../src/guestfs-actions.pod:4325 ../src/guestfs-actions.pod:4417
6596 #: ../fish/guestfish-actions.pod:1293 ../fish/guestfish-actions.pod:1344
6597 #: ../fish/guestfish-actions.pod:3355 ../fish/guestfish-actions.pod:3442
6599 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
6603 #: ../src/guestfs-actions.pod:1621
6604 msgid "guestfs_get_network"
6608 #: ../src/guestfs-actions.pod:1623
6611 " int guestfs_get_network (guestfs_h *g);\n"
6616 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1300
6617 msgid "This returns the enable network flag."
6621 #: ../src/guestfs-actions.pod:1629
6622 msgid "guestfs_get_path"
6626 #: ../src/guestfs-actions.pod:1631
6629 " const char *guestfs_get_path (guestfs_h *g);\n"
6634 #: ../src/guestfs-actions.pod:1633 ../fish/guestfish-actions.pod:1306
6635 msgid "Return the current search path."
6639 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1308
6641 "This is always non-NULL. If it wasn't set already, then this will return "
6646 #: ../src/guestfs-actions.pod:1638 ../src/guestfs-actions.pod:1661
6648 "This function returns a string, or NULL on error. The string is owned by "
6649 "the guest handle and must I<not> be freed."
6653 #: ../src/guestfs-actions.pod:1641
6654 msgid "guestfs_get_pid"
6658 #: ../src/guestfs-actions.pod:1643
6661 " int guestfs_get_pid (guestfs_h *g);\n"
6666 #: ../src/guestfs-actions.pod:1645 ../fish/guestfish-actions.pod:1317
6668 "Return the process ID of the qemu subprocess. If there is no qemu "
6669 "subprocess, then this will return an error."
6673 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1320
6674 msgid "This is an internal call used for debugging and testing."
6678 #: ../src/guestfs-actions.pod:1652
6679 msgid "guestfs_get_qemu"
6683 #: ../src/guestfs-actions.pod:1654
6686 " const char *guestfs_get_qemu (guestfs_h *g);\n"
6691 #: ../src/guestfs-actions.pod:1656 ../fish/guestfish-actions.pod:1326
6692 msgid "Return the current qemu binary."
6696 #: ../src/guestfs-actions.pod:1658 ../fish/guestfish-actions.pod:1328
6698 "This is always non-NULL. If it wasn't set already, then this will return "
6699 "the default qemu binary name."
6703 #: ../src/guestfs-actions.pod:1664
6704 msgid "guestfs_get_recovery_proc"
6708 #: ../src/guestfs-actions.pod:1666
6711 " int guestfs_get_recovery_proc (guestfs_h *g);\n"
6716 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1335
6717 msgid "Return the recovery process enabled flag."
6721 #: ../src/guestfs-actions.pod:1672
6722 msgid "guestfs_get_selinux"
6726 #: ../src/guestfs-actions.pod:1674
6729 " int guestfs_get_selinux (guestfs_h *g);\n"
6734 #: ../src/guestfs-actions.pod:1676
6736 "This returns the current setting of the selinux flag which is passed to the "
6737 "appliance at boot time. See C<guestfs_set_selinux>."
6741 #: ../src/guestfs-actions.pod:1684
6742 msgid "guestfs_get_state"
6746 #: ../src/guestfs-actions.pod:1686
6749 " int guestfs_get_state (guestfs_h *g);\n"
6754 #: ../src/guestfs-actions.pod:1688 ../fish/guestfish-actions.pod:1351
6756 "This returns the current state as an opaque integer. This is only useful "
6757 "for printing debug and internal error messages."
6761 #: ../src/guestfs-actions.pod:1691 ../src/guestfs-actions.pod:2312
6762 #: ../src/guestfs-actions.pod:2335 ../src/guestfs-actions.pod:2384
6763 #: ../src/guestfs-actions.pod:2405 ../fish/guestfish-actions.pod:1354
6764 #: ../fish/guestfish-actions.pod:1848 ../fish/guestfish-actions.pod:1866
6765 #: ../fish/guestfish-actions.pod:1904 ../fish/guestfish-actions.pod:1920
6766 msgid "For more information on states, see L<guestfs(3)>."
6770 #: ../src/guestfs-actions.pod:1695
6771 msgid "guestfs_get_trace"
6775 #: ../src/guestfs-actions.pod:1697
6778 " int guestfs_get_trace (guestfs_h *g);\n"
6783 #: ../src/guestfs-actions.pod:1699 ../fish/guestfish-actions.pod:1360
6784 msgid "Return the command trace flag."
6788 #: ../src/guestfs-actions.pod:1703
6789 msgid "guestfs_get_umask"
6793 #: ../src/guestfs-actions.pod:1705
6796 " int guestfs_get_umask (guestfs_h *g);\n"
6801 #: ../src/guestfs-actions.pod:1707
6803 "Return the current umask. By default the umask is C<022> unless it has been "
6804 "set by calling C<guestfs_umask>."
6808 #: ../src/guestfs-actions.pod:1712
6809 msgid "guestfs_get_verbose"
6813 #: ../src/guestfs-actions.pod:1714
6816 " int guestfs_get_verbose (guestfs_h *g);\n"
6821 #: ../src/guestfs-actions.pod:1716 ../fish/guestfish-actions.pod:1373
6822 msgid "This returns the verbose messages flag."
6826 #: ../src/guestfs-actions.pod:1720
6827 msgid "guestfs_getcon"
6831 #: ../src/guestfs-actions.pod:1722
6834 " char *guestfs_getcon (guestfs_h *g);\n"
6839 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1379
6840 msgid "This gets the SELinux security context of the daemon."
6844 #: ../src/guestfs-actions.pod:1726
6846 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
6850 #: ../src/guestfs-actions.pod:1732
6851 msgid "guestfs_getxattrs"
6855 #: ../src/guestfs-actions.pod:1734
6858 " struct guestfs_xattr_list *guestfs_getxattrs (guestfs_h *g,\n"
6859 "\t\tconst char *path);\n"
6864 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1388
6866 "This call lists the extended attributes of the file or directory C<path>."
6870 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1391
6872 "At the system call level, this is a combination of the L<listxattr(2)> and "
6873 "L<getxattr(2)> calls."
6877 #: ../src/guestfs-actions.pod:1743
6878 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
6882 #: ../src/guestfs-actions.pod:1745 ../src/guestfs-actions.pod:2479
6883 #: ../src/guestfs-actions.pod:3017
6885 "This function returns a C<struct guestfs_xattr_list *> (see E<lt>guestfs-"
6886 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
6887 "C<guestfs_free_xattr_list> after use>."
6891 #: ../src/guestfs-actions.pod:1750
6892 msgid "guestfs_glob_expand"
6896 #: ../src/guestfs-actions.pod:1752
6899 " char **guestfs_glob_expand (guestfs_h *g,\n"
6900 "\t\tconst char *pattern);\n"
6905 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1400
6907 "This command searches for all the pathnames matching C<pattern> according to "
6908 "the wildcard expansion rules used by the shell."
6912 #: ../src/guestfs-actions.pod:1759 ../fish/guestfish-actions.pod:1404
6914 "If no paths match, then this returns an empty list (note: not an error)."
6918 #: ../src/guestfs-actions.pod:1762 ../fish/guestfish-actions.pod:1407
6920 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
6921 "GLOB_BRACE>. See that manual page for more details."
6925 #: ../src/guestfs-actions.pod:1770
6926 msgid "guestfs_grep"
6930 #: ../src/guestfs-actions.pod:1772
6933 " char **guestfs_grep (guestfs_h *g,\n"
6934 "\t\tconst char *regex,\n"
6935 "\t\tconst char *path);\n"
6940 #: ../src/guestfs-actions.pod:1776 ../fish/guestfish-actions.pod:1415
6941 msgid "This calls the external C<grep> program and returns the matching lines."
6945 #: ../src/guestfs-actions.pod:1786
6946 msgid "guestfs_grepi"
6950 #: ../src/guestfs-actions.pod:1788
6953 " char **guestfs_grepi (guestfs_h *g,\n"
6954 "\t\tconst char *regex,\n"
6955 "\t\tconst char *path);\n"
6960 #: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1425
6962 "This calls the external C<grep -i> program and returns the matching lines."
6966 #: ../src/guestfs-actions.pod:1802
6967 msgid "guestfs_grub_install"
6971 #: ../src/guestfs-actions.pod:1804
6974 " int guestfs_grub_install (guestfs_h *g,\n"
6975 "\t\tconst char *root,\n"
6976 "\t\tconst char *device);\n"
6981 #: ../src/guestfs-actions.pod:1808 ../fish/guestfish-actions.pod:1435
6983 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
6984 "the root directory being C<root>."
6988 #: ../src/guestfs-actions.pod:1811 ../fish/guestfish-actions.pod:1438
6990 "Note: If grub-install reports the error \"No suitable drive was found in the "
6991 "generated device map.\" it may be that you need to create a C</boot/grub/"
6992 "device.map> file first that contains the mapping between grub device names "
6993 "and Linux device names. It is usually sufficient to create a file "
6998 #: ../src/guestfs-actions.pod:1818 ../fish/guestfish-actions.pod:1445
7006 #: ../src/guestfs-actions.pod:1820 ../fish/guestfish-actions.pod:1447
7007 msgid "replacing C</dev/vda> with the name of the installation device."
7011 #: ../src/guestfs-actions.pod:1824
7012 msgid "guestfs_head"
7016 #: ../src/guestfs-actions.pod:1826
7019 " char **guestfs_head (guestfs_h *g,\n"
7020 "\t\tconst char *path);\n"
7025 #: ../src/guestfs-actions.pod:1829 ../fish/guestfish-actions.pod:1453
7027 "This command returns up to the first 10 lines of a file as a list of strings."
7031 #: ../src/guestfs-actions.pod:1839
7032 msgid "guestfs_head_n"
7036 #: ../src/guestfs-actions.pod:1841
7039 " char **guestfs_head_n (guestfs_h *g,\n"
7040 "\t\tint nrlines,\n"
7041 "\t\tconst char *path);\n"
7046 #: ../src/guestfs-actions.pod:1845 ../fish/guestfish-actions.pod:1463
7048 "If the parameter C<nrlines> is a positive number, this returns the first "
7049 "C<nrlines> lines of the file C<path>."
7053 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1466
7055 "If the parameter C<nrlines> is a negative number, this returns lines from "
7056 "the file C<path>, excluding the last C<nrlines> lines."
7060 #: ../src/guestfs-actions.pod:1851 ../src/guestfs-actions.pod:4873
7061 #: ../fish/guestfish-actions.pod:1469 ../fish/guestfish-actions.pod:3788
7062 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7066 #: ../src/guestfs-actions.pod:1860
7067 msgid "guestfs_hexdump"
7071 #: ../src/guestfs-actions.pod:1862
7074 " char *guestfs_hexdump (guestfs_h *g,\n"
7075 "\t\tconst char *path);\n"
7080 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1478
7082 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
7083 "readable, canonical hex dump of the file."
7087 #: ../src/guestfs-actions.pod:1874
7088 msgid "guestfs_initrd_cat"
7092 #: ../src/guestfs-actions.pod:1876
7095 " char *guestfs_initrd_cat (guestfs_h *g,\n"
7096 "\t\tconst char *initrdpath,\n"
7097 "\t\tconst char *filename,\n"
7098 "\t\tsize_t *size_r);\n"
7103 #: ../src/guestfs-actions.pod:1881 ../fish/guestfish-actions.pod:1488
7105 "This command unpacks the file C<filename> from the initrd file called "
7106 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7111 #: ../src/guestfs-actions.pod:1885 ../fish/guestfish-actions.pod:1492
7113 "For example, in guestfish you could use the following command to examine the "
7114 "boot script (usually called C</init>) contained in a Linux initrd or "
7119 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1496
7122 " initrd-cat /boot/initrd-<version>.img init\n"
7127 #: ../src/guestfs-actions.pod:1891
7128 msgid "See also C<guestfs_initrd_list>."
7132 #: ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:3831
7133 #: ../src/guestfs-actions.pod:3960
7135 "This function returns a buffer, or NULL on error. The size of the returned "
7136 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
7141 #: ../src/guestfs-actions.pod:1900
7142 msgid "guestfs_initrd_list"
7146 #: ../src/guestfs-actions.pod:1902
7149 " char **guestfs_initrd_list (guestfs_h *g,\n"
7150 "\t\tconst char *path);\n"
7155 #: ../src/guestfs-actions.pod:1905 ../fish/guestfish-actions.pod:1507
7156 msgid "This command lists out files contained in an initrd."
7160 #: ../src/guestfs-actions.pod:1907 ../fish/guestfish-actions.pod:1509
7162 "The files are listed without any initial C</> character. The files are "
7163 "listed in the order they appear (not necessarily alphabetical). Directory "
7164 "names are listed as separate items."
7168 #: ../src/guestfs-actions.pod:1911 ../fish/guestfish-actions.pod:1513
7170 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
7171 "initrd. We I<only> support the newer initramfs format (compressed cpio "
7176 #: ../src/guestfs-actions.pod:1919
7177 msgid "guestfs_inotify_add_watch"
7181 #: ../src/guestfs-actions.pod:1921
7184 " int64_t guestfs_inotify_add_watch (guestfs_h *g,\n"
7185 "\t\tconst char *path,\n"
7191 #: ../src/guestfs-actions.pod:1925 ../fish/guestfish-actions.pod:1521
7192 msgid "Watch C<path> for the events listed in C<mask>."
7196 #: ../src/guestfs-actions.pod:1927 ../fish/guestfish-actions.pod:1523
7198 "Note that if C<path> is a directory then events within that directory are "
7199 "watched, but this does I<not> happen recursively (in subdirectories)."
7203 #: ../src/guestfs-actions.pod:1931 ../fish/guestfish-actions.pod:1527
7205 "Note for non-C or non-Linux callers: the inotify events are defined by the "
7206 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
7210 #: ../src/guestfs-actions.pod:1937
7211 msgid "guestfs_inotify_close"
7215 #: ../src/guestfs-actions.pod:1939
7218 " int guestfs_inotify_close (guestfs_h *g);\n"
7223 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1535
7225 "This closes the inotify handle which was previously opened by inotify_init. "
7226 "It removes all watches, throws away any pending events, and deallocates all "
7231 #: ../src/guestfs-actions.pod:1947
7232 msgid "guestfs_inotify_files"
7236 #: ../src/guestfs-actions.pod:1949
7239 " char **guestfs_inotify_files (guestfs_h *g);\n"
7244 #: ../src/guestfs-actions.pod:1951
7246 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
7247 "returns a list of pathnames of objects that were touched. The returned "
7248 "pathnames are sorted and deduplicated."
7252 #: ../src/guestfs-actions.pod:1959
7253 msgid "guestfs_inotify_init"
7257 #: ../src/guestfs-actions.pod:1961
7260 " int guestfs_inotify_init (guestfs_h *g,\n"
7261 "\t\tint maxevents);\n"
7266 #: ../src/guestfs-actions.pod:1964 ../fish/guestfish-actions.pod:1551
7268 "This command creates a new inotify handle. The inotify subsystem can be "
7269 "used to notify events which happen to objects in the guest filesystem."
7273 #: ../src/guestfs-actions.pod:1968
7275 "C<maxevents> is the maximum number of events which will be queued up between "
7276 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
7277 "passed as C<0>, then the kernel (or previously set) default is used. For "
7278 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
7279 "throws away events, but records the fact that it threw them away by setting "
7280 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
7281 "C<guestfs_inotify_read>)."
7285 #: ../src/guestfs-actions.pod:1978
7287 "Before any events are generated, you have to add some watches to the "
7288 "internal watch list. See: C<guestfs_inotify_add_watch>, "
7289 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
7293 #: ../src/guestfs-actions.pod:1984
7295 "Queued up events should be read periodically by calling "
7296 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
7297 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
7298 "often enough then you risk the internal queue overflowing."
7302 #: ../src/guestfs-actions.pod:1991
7304 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
7305 "This also removes any watches automatically."
7309 #: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1582
7311 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
7312 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
7313 "that there is one global inotify handle per libguestfs instance."
7317 #: ../src/guestfs-actions.pod:2002
7318 msgid "guestfs_inotify_read"
7322 #: ../src/guestfs-actions.pod:2004
7325 " struct guestfs_inotify_event_list *guestfs_inotify_read (guestfs_h *g);\n"
7330 #: ../src/guestfs-actions.pod:2006 ../fish/guestfish-actions.pod:1591
7332 "Return the complete queue of events that have happened since the previous "
7337 #: ../src/guestfs-actions.pod:2009 ../fish/guestfish-actions.pod:1594
7338 msgid "If no events have happened, this returns an empty list."
7342 #: ../src/guestfs-actions.pod:2011 ../fish/guestfish-actions.pod:1596
7344 "I<Note>: In order to make sure that all events have been read, you must call "
7345 "this function repeatedly until it returns an empty list. The reason is that "
7346 "the call will read events up to the maximum appliance-to-host message size "
7347 "and leave remaining events in the queue."
7351 #: ../src/guestfs-actions.pod:2017
7353 "This function returns a C<struct guestfs_inotify_event_list *> (see "
7354 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
7355 "must call C<guestfs_free_inotify_event_list> after use>."
7359 #: ../src/guestfs-actions.pod:2022
7360 msgid "guestfs_inotify_rm_watch"
7364 #: ../src/guestfs-actions.pod:2024
7367 " int guestfs_inotify_rm_watch (guestfs_h *g,\n"
7373 #: ../src/guestfs-actions.pod:2027
7375 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
7379 #: ../src/guestfs-actions.pod:2032
7380 msgid "guestfs_inspect_get_arch"
7384 #: ../src/guestfs-actions.pod:2034
7387 " char *guestfs_inspect_get_arch (guestfs_h *g,\n"
7388 "\t\tconst char *root);\n"
7393 #: ../src/guestfs-actions.pod:2037 ../src/guestfs-actions.pod:2057
7394 #: ../src/guestfs-actions.pod:2107 ../src/guestfs-actions.pod:2130
7395 #: ../src/guestfs-actions.pod:2154 ../src/guestfs-actions.pod:2172
7396 #: ../src/guestfs-actions.pod:2202 ../src/guestfs-actions.pod:2223
7398 "This function should only be called with a root device string as returned by "
7399 "C<guestfs_inspect_os>."
7403 #: ../src/guestfs-actions.pod:2040
7405 "This returns the architecture of the inspected operating system. The "
7406 "possible return values are listed under C<guestfs_file_architecture>."
7410 #: ../src/guestfs-actions.pod:2044 ../fish/guestfish-actions.pod:1620
7412 "If the architecture could not be determined, then the string C<unknown> is "
7417 #: ../src/guestfs-actions.pod:2047 ../src/guestfs-actions.pod:2097
7418 #: ../src/guestfs-actions.pod:2145 ../src/guestfs-actions.pod:2213
7419 #: ../src/guestfs-actions.pod:2248 ../src/guestfs-actions.pod:2285
7420 #: ../fish/guestfish-actions.pod:1623 ../fish/guestfish-actions.pod:1669
7421 #: ../fish/guestfish-actions.pod:1708 ../fish/guestfish-actions.pod:1763
7422 #: ../fish/guestfish-actions.pod:1794 ../fish/guestfish-actions.pod:1828
7423 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
7427 #: ../src/guestfs-actions.pod:2052
7428 msgid "guestfs_inspect_get_distro"
7432 #: ../src/guestfs-actions.pod:2054
7435 " char *guestfs_inspect_get_distro (guestfs_h *g,\n"
7436 "\t\tconst char *root);\n"
7441 #: ../src/guestfs-actions.pod:2060 ../fish/guestfish-actions.pod:1632
7443 "This returns the distro (distribution) of the inspected operating system."
7447 #: ../src/guestfs-actions.pod:2063 ../fish/guestfish-actions.pod:1635
7448 msgid "Currently defined distros are:"
7452 #: ../src/guestfs-actions.pod:2067 ../fish/guestfish-actions.pod:1639
7457 #: ../src/guestfs-actions.pod:2069 ../fish/guestfish-actions.pod:1641
7458 msgid "Debian or a Debian-derived distro such as Ubuntu."
7462 #: ../src/guestfs-actions.pod:2071 ../fish/guestfish-actions.pod:1643
7467 #: ../src/guestfs-actions.pod:2073 ../fish/guestfish-actions.pod:1645
7472 #: ../src/guestfs-actions.pod:2075 ../fish/guestfish-actions.pod:1647
7473 msgid "\"redhat-based\""
7477 #: ../src/guestfs-actions.pod:2077 ../fish/guestfish-actions.pod:1649
7478 msgid "Some Red Hat-derived distro."
7482 #: ../src/guestfs-actions.pod:2079 ../fish/guestfish-actions.pod:1651
7487 #: ../src/guestfs-actions.pod:2081 ../fish/guestfish-actions.pod:1653
7488 msgid "Red Hat Enterprise Linux and some derivatives."
7492 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2235
7493 #: ../fish/guestfish-actions.pod:1655 ../fish/guestfish-actions.pod:1781
7498 #: ../src/guestfs-actions.pod:2085 ../fish/guestfish-actions.pod:1657
7500 "Windows does not have distributions. This string is returned if the OS type "
7505 #: ../src/guestfs-actions.pod:2088 ../src/guestfs-actions.pod:2239
7506 #: ../fish/guestfish-actions.pod:1660 ../fish/guestfish-actions.pod:1785
7511 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1662
7512 msgid "The distro could not be determined."
7516 #: ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:2245
7517 #: ../fish/guestfish-actions.pod:1666 ../fish/guestfish-actions.pod:1791
7519 "Future versions of libguestfs may return other strings here. The caller "
7520 "should be prepared to handle any string."
7524 #: ../src/guestfs-actions.pod:2102
7525 msgid "guestfs_inspect_get_filesystems"
7529 #: ../src/guestfs-actions.pod:2104
7532 " char **guestfs_inspect_get_filesystems (guestfs_h *g,\n"
7533 "\t\tconst char *root);\n"
7538 #: ../src/guestfs-actions.pod:2110 ../fish/guestfish-actions.pod:1678
7540 "This returns a list of all the filesystems that we think are associated with "
7541 "this operating system. This includes the root filesystem, other ordinary "
7542 "filesystems, and non-mounted devices like swap partitions."
7546 #: ../src/guestfs-actions.pod:2115 ../fish/guestfish-actions.pod:1683
7548 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
7549 "to be shared between operating systems."
7553 #: ../src/guestfs-actions.pod:2118
7555 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7556 "C<guestfs_inspect_get_mountpoints>."
7560 #: ../src/guestfs-actions.pod:2125
7561 msgid "guestfs_inspect_get_major_version"
7565 #: ../src/guestfs-actions.pod:2127
7568 " int guestfs_inspect_get_major_version (guestfs_h *g,\n"
7569 "\t\tconst char *root);\n"
7574 #: ../src/guestfs-actions.pod:2133 ../fish/guestfish-actions.pod:1696
7576 "This returns the major version number of the inspected operating system."
7580 #: ../src/guestfs-actions.pod:2136 ../fish/guestfish-actions.pod:1699
7582 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
7583 "popular public names used by the operating system. Notably the operating "
7584 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
7585 "1). You can find out the real versions corresponding to releases of Windows "
7586 "by consulting Wikipedia or MSDN."
7590 #: ../src/guestfs-actions.pod:2143 ../src/guestfs-actions.pod:2160
7591 #: ../fish/guestfish-actions.pod:1706 ../fish/guestfish-actions.pod:1720
7592 msgid "If the version could not be determined, then C<0> is returned."
7596 #: ../src/guestfs-actions.pod:2149
7597 msgid "guestfs_inspect_get_minor_version"
7601 #: ../src/guestfs-actions.pod:2151
7604 " int guestfs_inspect_get_minor_version (guestfs_h *g,\n"
7605 "\t\tconst char *root);\n"
7610 #: ../src/guestfs-actions.pod:2157 ../fish/guestfish-actions.pod:1717
7612 "This returns the minor version number of the inspected operating system."
7616 #: ../src/guestfs-actions.pod:2162
7618 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7619 "C<guestfs_inspect_get_major_version>."
7623 #: ../src/guestfs-actions.pod:2167
7624 msgid "guestfs_inspect_get_mountpoints"
7628 #: ../src/guestfs-actions.pod:2169
7631 " char **guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
7632 "\t\tconst char *root);\n"
7637 #: ../src/guestfs-actions.pod:2175 ../fish/guestfish-actions.pod:1732
7639 "This returns a hash of where we think the filesystems associated with this "
7640 "operating system should be mounted. Callers should note that this is at "
7641 "best an educated guess made by reading configuration files such as C</etc/"
7646 #: ../src/guestfs-actions.pod:2180 ../fish/guestfish-actions.pod:1737
7648 "Each element in the returned hashtable has a key which is the path of the "
7649 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
7650 "mounted there (eg. C</dev/sda1>)."
7654 #: ../src/guestfs-actions.pod:2185 ../fish/guestfish-actions.pod:1742
7656 "Non-mounted devices such as swap devices are I<not> returned in this list."
7660 #: ../src/guestfs-actions.pod:2188
7662 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7663 "C<guestfs_inspect_get_filesystems>."
7667 #: ../src/guestfs-actions.pod:2191 ../src/guestfs-actions.pod:2531
7668 #: ../src/guestfs-actions.pod:3453 ../src/guestfs-actions.pod:4990
7670 "This function returns a NULL-terminated array of strings, or NULL if there "
7671 "was an error. The array of strings will always have length C<2n+1>, where "
7672 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
7673 "caller must free the strings and the array after use>."
7677 #: ../src/guestfs-actions.pod:2197
7678 msgid "guestfs_inspect_get_product_name"
7682 #: ../src/guestfs-actions.pod:2199
7685 " char *guestfs_inspect_get_product_name (guestfs_h *g,\n"
7686 "\t\tconst char *root);\n"
7691 #: ../src/guestfs-actions.pod:2205 ../fish/guestfish-actions.pod:1755
7693 "This returns the product name of the inspected operating system. The "
7694 "product name is generally some freeform string which can be displayed to the "
7695 "user, but should not be parsed by programs."
7699 #: ../src/guestfs-actions.pod:2210 ../fish/guestfish-actions.pod:1760
7701 "If the product name could not be determined, then the string C<unknown> is "
7706 #: ../src/guestfs-actions.pod:2218
7707 msgid "guestfs_inspect_get_type"
7711 #: ../src/guestfs-actions.pod:2220
7714 " char *guestfs_inspect_get_type (guestfs_h *g,\n"
7715 "\t\tconst char *root);\n"
7720 #: ../src/guestfs-actions.pod:2226 ../fish/guestfish-actions.pod:1772
7722 "This returns the type of the inspected operating system. Currently defined "
7727 #: ../src/guestfs-actions.pod:2231 ../fish/guestfish-actions.pod:1777
7732 #: ../src/guestfs-actions.pod:2233 ../fish/guestfish-actions.pod:1779
7733 msgid "Any Linux-based operating system."
7737 #: ../src/guestfs-actions.pod:2237 ../fish/guestfish-actions.pod:1783
7738 msgid "Any Microsoft Windows operating system."
7742 #: ../src/guestfs-actions.pod:2241 ../fish/guestfish-actions.pod:1787
7743 msgid "The operating system type could not be determined."
7747 #: ../src/guestfs-actions.pod:2253
7748 msgid "guestfs_inspect_os"
7752 #: ../src/guestfs-actions.pod:2255
7755 " char **guestfs_inspect_os (guestfs_h *g);\n"
7760 #: ../src/guestfs-actions.pod:2257 ../fish/guestfish-actions.pod:1800
7762 "This function uses other libguestfs functions and certain heuristics to "
7763 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
7764 "for operating systems."
7768 #: ../src/guestfs-actions.pod:2261 ../fish/guestfish-actions.pod:1804
7769 msgid "The list returned is empty if no operating systems were found."
7773 #: ../src/guestfs-actions.pod:2263 ../fish/guestfish-actions.pod:1806
7775 "If one operating system was found, then this returns a list with a single "
7776 "element, which is the name of the root filesystem of this operating system. "
7777 "It is also possible for this function to return a list containing more than "
7778 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
7779 "element being the root filesystem of one of the operating systems."
7783 #: ../src/guestfs-actions.pod:2270
7785 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
7786 "functions in order to query further information about each operating system, "
7787 "such as the name and version."
7791 #: ../src/guestfs-actions.pod:2275
7793 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
7794 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
7795 "the contents. This should be called with no disks currently mounted. The "
7796 "function may also use Augeas, so any existing Augeas handle will be closed."
7800 #: ../src/guestfs-actions.pod:2281 ../fish/guestfish-actions.pod:1824
7802 "This function cannot decrypt encrypted disks. The caller must do that first "
7803 "(supplying the necessary keys) if the disk is encrypted."
7807 #: ../src/guestfs-actions.pod:2287 ../src/guestfs-actions.pod:2492
7808 #: ../src/guestfs-actions.pod:2548
7809 msgid "See also C<guestfs_list_filesystems>."
7813 #: ../src/guestfs-actions.pod:2293
7814 msgid "guestfs_is_blockdev"
7818 #: ../src/guestfs-actions.pod:2295
7821 " int guestfs_is_blockdev (guestfs_h *g,\n"
7822 "\t\tconst char *path);\n"
7827 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1836
7829 "This returns C<true> if and only if there is a block device with the given "
7834 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:2324
7835 #: ../src/guestfs-actions.pod:2348 ../src/guestfs-actions.pod:2360
7836 #: ../src/guestfs-actions.pod:2373 ../src/guestfs-actions.pod:2417
7837 #: ../src/guestfs-actions.pod:2429
7838 msgid "See also C<guestfs_stat>."
7842 #: ../src/guestfs-actions.pod:2305
7843 msgid "guestfs_is_busy"
7847 #: ../src/guestfs-actions.pod:2307
7850 " int guestfs_is_busy (guestfs_h *g);\n"
7855 #: ../src/guestfs-actions.pod:2309 ../fish/guestfish-actions.pod:1845
7857 "This returns true iff this handle is busy processing a command (in the "
7862 #: ../src/guestfs-actions.pod:2316
7863 msgid "guestfs_is_chardev"
7867 #: ../src/guestfs-actions.pod:2318
7870 " int guestfs_is_chardev (guestfs_h *g,\n"
7871 "\t\tconst char *path);\n"
7876 #: ../src/guestfs-actions.pod:2321 ../fish/guestfish-actions.pod:1854
7878 "This returns C<true> if and only if there is a character device with the "
7879 "given C<path> name."
7883 #: ../src/guestfs-actions.pod:2328
7884 msgid "guestfs_is_config"
7888 #: ../src/guestfs-actions.pod:2330
7891 " int guestfs_is_config (guestfs_h *g);\n"
7896 #: ../src/guestfs-actions.pod:2332 ../fish/guestfish-actions.pod:1863
7898 "This returns true iff this handle is being configured (in the C<CONFIG> "
7903 #: ../src/guestfs-actions.pod:2339
7904 msgid "guestfs_is_dir"
7908 #: ../src/guestfs-actions.pod:2341
7911 " int guestfs_is_dir (guestfs_h *g,\n"
7912 "\t\tconst char *path);\n"
7917 #: ../src/guestfs-actions.pod:2344 ../fish/guestfish-actions.pod:1872
7919 "This returns C<true> if and only if there is a directory with the given "
7920 "C<path> name. Note that it returns false for other objects like files."
7924 #: ../src/guestfs-actions.pod:2352
7925 msgid "guestfs_is_fifo"
7929 #: ../src/guestfs-actions.pod:2354
7932 " int guestfs_is_fifo (guestfs_h *g,\n"
7933 "\t\tconst char *path);\n"
7938 #: ../src/guestfs-actions.pod:2357 ../fish/guestfish-actions.pod:1882
7940 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
7941 "given C<path> name."
7945 #: ../src/guestfs-actions.pod:2364
7946 msgid "guestfs_is_file"
7950 #: ../src/guestfs-actions.pod:2366
7953 " int guestfs_is_file (guestfs_h *g,\n"
7954 "\t\tconst char *path);\n"
7959 #: ../src/guestfs-actions.pod:2369 ../fish/guestfish-actions.pod:1891
7961 "This returns C<true> if and only if there is a regular file with the given "
7962 "C<path> name. Note that it returns false for other objects like directories."
7966 #: ../src/guestfs-actions.pod:2377
7967 msgid "guestfs_is_launching"
7971 #: ../src/guestfs-actions.pod:2379
7974 " int guestfs_is_launching (guestfs_h *g);\n"
7979 #: ../src/guestfs-actions.pod:2381 ../fish/guestfish-actions.pod:1901
7981 "This returns true iff this handle is launching the subprocess (in the "
7982 "C<LAUNCHING> state)."
7986 #: ../src/guestfs-actions.pod:2388
7987 msgid "guestfs_is_lv"
7991 #: ../src/guestfs-actions.pod:2390
7994 " int guestfs_is_lv (guestfs_h *g,\n"
7995 "\t\tconst char *device);\n"
8000 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1910
8002 "This command tests whether C<device> is a logical volume, and returns true "
8003 "iff this is the case."
8007 #: ../src/guestfs-actions.pod:2398
8008 msgid "guestfs_is_ready"
8012 #: ../src/guestfs-actions.pod:2400
8015 " int guestfs_is_ready (guestfs_h *g);\n"
8020 #: ../src/guestfs-actions.pod:2402 ../fish/guestfish-actions.pod:1917
8022 "This returns true iff this handle is ready to accept commands (in the "
8027 #: ../src/guestfs-actions.pod:2409
8028 msgid "guestfs_is_socket"
8032 #: ../src/guestfs-actions.pod:2411
8035 " int guestfs_is_socket (guestfs_h *g,\n"
8036 "\t\tconst char *path);\n"
8041 #: ../src/guestfs-actions.pod:2414 ../fish/guestfish-actions.pod:1926
8043 "This returns C<true> if and only if there is a Unix domain socket with the "
8044 "given C<path> name."
8048 #: ../src/guestfs-actions.pod:2421
8049 msgid "guestfs_is_symlink"
8053 #: ../src/guestfs-actions.pod:2423
8056 " int guestfs_is_symlink (guestfs_h *g,\n"
8057 "\t\tconst char *path);\n"
8062 #: ../src/guestfs-actions.pod:2426 ../fish/guestfish-actions.pod:1935
8064 "This returns C<true> if and only if there is a symbolic link with the given "
8069 #: ../src/guestfs-actions.pod:2433
8070 msgid "guestfs_kill_subprocess"
8074 #: ../src/guestfs-actions.pod:2435
8077 " int guestfs_kill_subprocess (guestfs_h *g);\n"
8082 #: ../src/guestfs-actions.pod:2437 ../fish/guestfish-actions.pod:1944
8083 msgid "This kills the qemu subprocess. You should never need to call this."
8087 #: ../src/guestfs-actions.pod:2441
8088 msgid "guestfs_launch"
8092 #: ../src/guestfs-actions.pod:2443
8095 " int guestfs_launch (guestfs_h *g);\n"
8100 #: ../src/guestfs-actions.pod:2445 ../fish/guestfish-actions.pod:1952
8102 "Internally libguestfs is implemented by running a virtual machine using "
8107 #: ../src/guestfs-actions.pod:2448 ../fish/guestfish-actions.pod:1955
8109 "You should call this after configuring the handle (eg. adding drives) but "
8110 "before performing any actions."
8114 #: ../src/guestfs-actions.pod:2453
8115 msgid "guestfs_lchown"
8119 #: ../src/guestfs-actions.pod:2455
8122 " int guestfs_lchown (guestfs_h *g,\n"
8125 "\t\tconst char *path);\n"
8130 #: ../src/guestfs-actions.pod:2460
8132 "Change the file owner to C<owner> and group to C<group>. This is like "
8133 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
8134 "changed, not the target."
8138 #: ../src/guestfs-actions.pod:2470
8139 msgid "guestfs_lgetxattrs"
8143 #: ../src/guestfs-actions.pod:2472
8146 " struct guestfs_xattr_list *guestfs_lgetxattrs (guestfs_h *g,\n"
8147 "\t\tconst char *path);\n"
8152 #: ../src/guestfs-actions.pod:2475
8154 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
8155 "then it returns the extended attributes of the link itself."
8159 #: ../src/guestfs-actions.pod:2484
8160 msgid "guestfs_list_devices"
8164 #: ../src/guestfs-actions.pod:2486
8167 " char **guestfs_list_devices (guestfs_h *g);\n"
8172 #: ../src/guestfs-actions.pod:2488 ../fish/guestfish-actions.pod:1982
8173 msgid "List all the block devices."
8177 #: ../src/guestfs-actions.pod:2490 ../fish/guestfish-actions.pod:1984
8178 msgid "The full block device names are returned, eg. C</dev/sda>."
8182 #: ../src/guestfs-actions.pod:2498
8183 msgid "guestfs_list_filesystems"
8187 #: ../src/guestfs-actions.pod:2500
8190 " char **guestfs_list_filesystems (guestfs_h *g);\n"
8195 #: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1992
8197 "This inspection command looks for filesystems on partitions, block devices "
8198 "and logical volumes, returning a list of devices containing filesystems and "
8203 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1996
8205 "The return value is a hash, where the keys are the devices containing "
8206 "filesystems, and the values are the filesystem types. For example:"
8210 #: ../src/guestfs-actions.pod:2510 ../fish/guestfish-actions.pod:2000
8213 " \"/dev/sda1\" => \"ntfs\"\n"
8214 " \"/dev/sda2\" => \"ext2\"\n"
8215 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
8216 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
8221 #: ../src/guestfs-actions.pod:2515 ../fish/guestfish-actions.pod:2005
8223 "The value can have the special value \"unknown\", meaning the content of the "
8224 "device is undetermined or empty. \"swap\" means a Linux swap partition."
8228 #: ../src/guestfs-actions.pod:2519
8230 "This command runs other libguestfs commands, which might include "
8231 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
8232 "soon after launch and only when nothing is mounted."
8236 #: ../src/guestfs-actions.pod:2523
8238 "Not all of the filesystems returned will be mountable. In particular, swap "
8239 "partitions are returned in the list. Also this command does not check that "
8240 "each filesystem found is valid and mountable, and some filesystems might be "
8241 "mountable but require special options. Filesystems may not all belong to a "
8242 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
8246 #: ../src/guestfs-actions.pod:2537
8247 msgid "guestfs_list_partitions"
8251 #: ../src/guestfs-actions.pod:2539
8254 " char **guestfs_list_partitions (guestfs_h *g);\n"
8259 #: ../src/guestfs-actions.pod:2541 ../fish/guestfish-actions.pod:2025
8260 msgid "List all the partitions detected on all block devices."
8264 #: ../src/guestfs-actions.pod:2543 ../fish/guestfish-actions.pod:2027
8265 msgid "The full partition device names are returned, eg. C</dev/sda1>"
8269 #: ../src/guestfs-actions.pod:2545
8271 "This does not return logical volumes. For that you will need to call "
8276 #: ../src/guestfs-actions.pod:2554
8281 #: ../src/guestfs-actions.pod:2556
8284 " char *guestfs_ll (guestfs_h *g,\n"
8285 "\t\tconst char *directory);\n"
8290 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:2038
8292 "List the files in C<directory> (relative to the root directory, there is no "
8293 "cwd) in the format of 'ls -la'."
8297 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:2041
8299 "This command is mostly useful for interactive sessions. It is I<not> "
8300 "intended that you try to parse the output string."
8304 #: ../src/guestfs-actions.pod:2568
8309 #: ../src/guestfs-actions.pod:2570
8312 " int guestfs_ln (guestfs_h *g,\n"
8313 "\t\tconst char *target,\n"
8314 "\t\tconst char *linkname);\n"
8319 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:2048
8320 msgid "This command creates a hard link using the C<ln> command."
8324 #: ../src/guestfs-actions.pod:2578
8325 msgid "guestfs_ln_f"
8329 #: ../src/guestfs-actions.pod:2580
8332 " int guestfs_ln_f (guestfs_h *g,\n"
8333 "\t\tconst char *target,\n"
8334 "\t\tconst char *linkname);\n"
8339 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:2054
8341 "This command creates a hard link using the C<ln -f> command. The C<-f> "
8342 "option removes the link (C<linkname>) if it exists already."
8346 #: ../src/guestfs-actions.pod:2589
8347 msgid "guestfs_ln_s"
8351 #: ../src/guestfs-actions.pod:2591
8354 " int guestfs_ln_s (guestfs_h *g,\n"
8355 "\t\tconst char *target,\n"
8356 "\t\tconst char *linkname);\n"
8361 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:2061
8362 msgid "This command creates a symbolic link using the C<ln -s> command."
8366 #: ../src/guestfs-actions.pod:2599
8367 msgid "guestfs_ln_sf"
8371 #: ../src/guestfs-actions.pod:2601
8374 " int guestfs_ln_sf (guestfs_h *g,\n"
8375 "\t\tconst char *target,\n"
8376 "\t\tconst char *linkname);\n"
8381 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:2067
8383 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
8384 "option removes the link (C<linkname>) if it exists already."
8388 #: ../src/guestfs-actions.pod:2610
8389 msgid "guestfs_lremovexattr"
8393 #: ../src/guestfs-actions.pod:2612
8396 " int guestfs_lremovexattr (guestfs_h *g,\n"
8397 "\t\tconst char *xattr,\n"
8398 "\t\tconst char *path);\n"
8403 #: ../src/guestfs-actions.pod:2616
8405 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
8406 "link, then it removes an extended attribute of the link itself."
8410 #: ../src/guestfs-actions.pod:2622
8415 #: ../src/guestfs-actions.pod:2624
8418 " char **guestfs_ls (guestfs_h *g,\n"
8419 "\t\tconst char *directory);\n"
8424 #: ../src/guestfs-actions.pod:2627 ../fish/guestfish-actions.pod:2082
8426 "List the files in C<directory> (relative to the root directory, there is no "
8427 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
8431 #: ../src/guestfs-actions.pod:2631
8433 "This command is mostly useful for interactive sessions. Programs should "
8434 "probably use C<guestfs_readdir> instead."
8438 #: ../src/guestfs-actions.pod:2638
8439 msgid "guestfs_lsetxattr"
8443 #: ../src/guestfs-actions.pod:2640
8446 " int guestfs_lsetxattr (guestfs_h *g,\n"
8447 "\t\tconst char *xattr,\n"
8448 "\t\tconst char *val,\n"
8450 "\t\tconst char *path);\n"
8455 #: ../src/guestfs-actions.pod:2646
8457 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
8458 "then it sets an extended attribute of the link itself."
8462 #: ../src/guestfs-actions.pod:2652
8463 msgid "guestfs_lstat"
8467 #: ../src/guestfs-actions.pod:2654
8470 " struct guestfs_stat *guestfs_lstat (guestfs_h *g,\n"
8471 "\t\tconst char *path);\n"
8476 #: ../src/guestfs-actions.pod:2657 ../src/guestfs-actions.pod:4655
8477 #: ../fish/guestfish-actions.pod:2101 ../fish/guestfish-actions.pod:3623
8478 msgid "Returns file information for the given C<path>."
8482 #: ../src/guestfs-actions.pod:2659
8484 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
8485 "link, then the link is stat-ed, not the file it refers to."
8489 #: ../src/guestfs-actions.pod:2663 ../fish/guestfish-actions.pod:2107
8490 msgid "This is the same as the C<lstat(2)> system call."
8494 #: ../src/guestfs-actions.pod:2665 ../src/guestfs-actions.pod:4659
8496 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
8497 "error. I<The caller must call C<guestfs_free_stat> after use>."
8501 #: ../src/guestfs-actions.pod:2669
8502 msgid "guestfs_lstatlist"
8506 #: ../src/guestfs-actions.pod:2671
8509 " struct guestfs_stat_list *guestfs_lstatlist (guestfs_h *g,\n"
8510 "\t\tconst char *path,\n"
8511 "\t\tchar *const *names);\n"
8516 #: ../src/guestfs-actions.pod:2675
8518 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
8519 "files, where all files are in the directory C<path>. C<names> is the list "
8520 "of files from this directory."
8524 #: ../src/guestfs-actions.pod:2679 ../fish/guestfish-actions.pod:2117
8526 "On return you get a list of stat structs, with a one-to-one correspondence "
8527 "to the C<names> list. If any name did not exist or could not be lstat'd, "
8528 "then the C<ino> field of that structure is set to C<-1>."
8532 #: ../src/guestfs-actions.pod:2684
8534 "This call is intended for programs that want to efficiently list a directory "
8535 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
8536 "for a similarly efficient call for getting extended attributes. Very long "
8537 "directory listings might cause the protocol message size to be exceeded, "
8538 "causing this call to fail. The caller must split up such requests into "
8539 "smaller groups of names."
8543 #: ../src/guestfs-actions.pod:2692
8545 "This function returns a C<struct guestfs_stat_list *> (see E<lt>guestfs-"
8546 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
8547 "C<guestfs_free_stat_list> after use>."
8551 #: ../src/guestfs-actions.pod:2697
8552 msgid "guestfs_luks_add_key"
8556 #: ../src/guestfs-actions.pod:2699
8559 " int guestfs_luks_add_key (guestfs_h *g,\n"
8560 "\t\tconst char *device,\n"
8561 "\t\tconst char *key,\n"
8562 "\t\tconst char *newkey,\n"
8563 "\t\tint keyslot);\n"
8568 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:2134
8570 "This command adds a new key on LUKS device C<device>. C<key> is any "
8571 "existing key, and is used to access the device. C<newkey> is the new key to "
8572 "add. C<keyslot> is the key slot that will be replaced."
8576 #: ../src/guestfs-actions.pod:2710
8578 "Note that if C<keyslot> already contains a key, then this command will "
8579 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
8583 #: ../src/guestfs-actions.pod:2716 ../src/guestfs-actions.pod:2750
8584 #: ../src/guestfs-actions.pod:2770 ../src/guestfs-actions.pod:2787
8585 #: ../src/guestfs-actions.pod:2816 ../src/guestfs-actions.pod:2832
8587 "This function takes a key or passphrase parameter which could contain "
8588 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
8593 #: ../src/guestfs-actions.pod:2720
8594 msgid "guestfs_luks_close"
8598 #: ../src/guestfs-actions.pod:2722
8601 " int guestfs_luks_close (guestfs_h *g,\n"
8602 "\t\tconst char *device);\n"
8607 #: ../src/guestfs-actions.pod:2725
8609 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
8610 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
8611 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
8612 "underlying block device."
8616 #: ../src/guestfs-actions.pod:2733
8617 msgid "guestfs_luks_format"
8621 #: ../src/guestfs-actions.pod:2735
8624 " int guestfs_luks_format (guestfs_h *g,\n"
8625 "\t\tconst char *device,\n"
8626 "\t\tconst char *key,\n"
8627 "\t\tint keyslot);\n"
8632 #: ../src/guestfs-actions.pod:2740 ../fish/guestfish-actions.pod:2160
8634 "This command erases existing data on C<device> and formats the device as a "
8635 "LUKS encrypted device. C<key> is the initial key, which is added to key "
8636 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
8640 #: ../src/guestfs-actions.pod:2747 ../src/guestfs-actions.pod:2767
8641 #: ../src/guestfs-actions.pod:2869 ../src/guestfs-actions.pod:3581
8642 #: ../src/guestfs-actions.pod:4196 ../src/guestfs-actions.pod:4517
8643 #: ../src/guestfs-actions.pod:4537 ../src/guestfs-actions.pod:4560
8644 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:2168
8645 #: ../fish/guestfish-actions.pod:2181 ../fish/guestfish-actions.pod:2252
8646 #: ../fish/guestfish-actions.pod:2767 ../fish/guestfish-actions.pod:3242
8647 #: ../fish/guestfish-actions.pod:3522 ../fish/guestfish-actions.pod:3538
8648 #: ../fish/guestfish-actions.pod:3553 ../fish/guestfish-actions.pod:4268
8650 "B<This command is dangerous. Without careful use you can easily destroy all "
8655 #: ../src/guestfs-actions.pod:2754
8656 msgid "guestfs_luks_format_cipher"
8660 #: ../src/guestfs-actions.pod:2756
8663 " int guestfs_luks_format_cipher (guestfs_h *g,\n"
8664 "\t\tconst char *device,\n"
8665 "\t\tconst char *key,\n"
8666 "\t\tint keyslot,\n"
8667 "\t\tconst char *cipher);\n"
8672 #: ../src/guestfs-actions.pod:2762
8674 "This command is the same as C<guestfs_luks_format> but it also allows you to "
8675 "set the C<cipher> used."
8679 #: ../src/guestfs-actions.pod:2774
8680 msgid "guestfs_luks_kill_slot"
8684 #: ../src/guestfs-actions.pod:2776
8687 " int guestfs_luks_kill_slot (guestfs_h *g,\n"
8688 "\t\tconst char *device,\n"
8689 "\t\tconst char *key,\n"
8690 "\t\tint keyslot);\n"
8695 #: ../src/guestfs-actions.pod:2781 ../fish/guestfish-actions.pod:2188
8697 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
8698 "device C<device>. C<key> must be one of the I<other> keys."
8702 #: ../src/guestfs-actions.pod:2791
8703 msgid "guestfs_luks_open"
8707 #: ../src/guestfs-actions.pod:2793
8710 " int guestfs_luks_open (guestfs_h *g,\n"
8711 "\t\tconst char *device,\n"
8712 "\t\tconst char *key,\n"
8713 "\t\tconst char *mapname);\n"
8718 #: ../src/guestfs-actions.pod:2798 ../fish/guestfish-actions.pod:2199
8720 "This command opens a block device which has been encrypted according to the "
8721 "Linux Unified Key Setup (LUKS) standard."
8725 #: ../src/guestfs-actions.pod:2801 ../fish/guestfish-actions.pod:2202
8726 msgid "C<device> is the encrypted block device or partition."
8730 #: ../src/guestfs-actions.pod:2803 ../fish/guestfish-actions.pod:2204
8732 "The caller must supply one of the keys associated with the LUKS block "
8733 "device, in the C<key> parameter."
8737 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:2207
8739 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
8740 "writes to this block device are decrypted from and encrypted to the "
8741 "underlying C<device> respectively."
8745 #: ../src/guestfs-actions.pod:2810
8747 "If this block device contains LVM volume groups, then calling "
8748 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
8753 #: ../src/guestfs-actions.pod:2820
8754 msgid "guestfs_luks_open_ro"
8758 #: ../src/guestfs-actions.pod:2822
8761 " int guestfs_luks_open_ro (guestfs_h *g,\n"
8762 "\t\tconst char *device,\n"
8763 "\t\tconst char *key,\n"
8764 "\t\tconst char *mapname);\n"
8769 #: ../src/guestfs-actions.pod:2827
8771 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
8776 #: ../src/guestfs-actions.pod:2836
8777 msgid "guestfs_lvcreate"
8781 #: ../src/guestfs-actions.pod:2838
8784 " int guestfs_lvcreate (guestfs_h *g,\n"
8785 "\t\tconst char *logvol,\n"
8786 "\t\tconst char *volgroup,\n"
8787 "\t\tint mbytes);\n"
8792 #: ../src/guestfs-actions.pod:2843 ../fish/guestfish-actions.pod:2232
8794 "This creates an LVM logical volume called C<logvol> on the volume group "
8795 "C<volgroup>, with C<size> megabytes."
8799 #: ../src/guestfs-actions.pod:2848
8800 msgid "guestfs_lvm_clear_filter"
8804 #: ../src/guestfs-actions.pod:2850
8807 " int guestfs_lvm_clear_filter (guestfs_h *g);\n"
8812 #: ../src/guestfs-actions.pod:2852
8814 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
8815 "see every block device."
8819 #: ../src/guestfs-actions.pod:2855 ../src/guestfs-actions.pod:2891
8820 #: ../fish/guestfish-actions.pod:2242 ../fish/guestfish-actions.pod:2273
8822 "This command also clears the LVM cache and performs a volume group scan."
8826 #: ../src/guestfs-actions.pod:2860
8827 msgid "guestfs_lvm_remove_all"
8831 #: ../src/guestfs-actions.pod:2862
8834 " int guestfs_lvm_remove_all (guestfs_h *g);\n"
8839 #: ../src/guestfs-actions.pod:2864 ../fish/guestfish-actions.pod:2249
8841 "This command removes all LVM logical volumes, volume groups and physical "
8846 #: ../src/guestfs-actions.pod:2872
8847 msgid "guestfs_lvm_set_filter"
8851 #: ../src/guestfs-actions.pod:2874
8854 " int guestfs_lvm_set_filter (guestfs_h *g,\n"
8855 "\t\tchar *const *devices);\n"
8860 #: ../src/guestfs-actions.pod:2877 ../fish/guestfish-actions.pod:2259
8862 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
8863 "block devices in the list C<devices>, and will ignore all other attached "
8868 #: ../src/guestfs-actions.pod:2881 ../fish/guestfish-actions.pod:2263
8870 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
8871 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
8872 "there are two types of duplication possible: either cloned PVs/VGs which "
8873 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
8874 "same name. In normal operation you cannot create this situation, but you "
8875 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
8876 "inside the LVM metadata."
8880 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:2276
8881 msgid "You can filter whole block devices or individual partitions."
8885 #: ../src/guestfs-actions.pod:2896 ../fish/guestfish-actions.pod:2278
8887 "You cannot use this if any VG is currently in use (eg. contains a mounted "
8888 "filesystem), even if you are not filtering out that VG."
8892 #: ../src/guestfs-actions.pod:2902
8893 msgid "guestfs_lvremove"
8897 #: ../src/guestfs-actions.pod:2904
8900 " int guestfs_lvremove (guestfs_h *g,\n"
8901 "\t\tconst char *device);\n"
8906 #: ../src/guestfs-actions.pod:2907 ../fish/guestfish-actions.pod:2286
8908 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
8909 "LV, such as C</dev/VG/LV>."
8913 #: ../src/guestfs-actions.pod:2910 ../fish/guestfish-actions.pod:2289
8915 "You can also remove all LVs in a volume group by specifying the VG name, C</"
8920 #: ../src/guestfs-actions.pod:2915
8921 msgid "guestfs_lvrename"
8925 #: ../src/guestfs-actions.pod:2917
8928 " int guestfs_lvrename (guestfs_h *g,\n"
8929 "\t\tconst char *logvol,\n"
8930 "\t\tconst char *newlogvol);\n"
8935 #: ../src/guestfs-actions.pod:2921 ../fish/guestfish-actions.pod:2296
8936 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
8940 #: ../src/guestfs-actions.pod:2925
8941 msgid "guestfs_lvresize"
8945 #: ../src/guestfs-actions.pod:2927
8948 " int guestfs_lvresize (guestfs_h *g,\n"
8949 "\t\tconst char *device,\n"
8950 "\t\tint mbytes);\n"
8955 #: ../src/guestfs-actions.pod:2931 ../fish/guestfish-actions.pod:2302
8957 "This resizes (expands or shrinks) an existing LVM logical volume to "
8958 "C<mbytes>. When reducing, data in the reduced part is lost."
8962 #: ../src/guestfs-actions.pod:2937
8963 msgid "guestfs_lvresize_free"
8967 #: ../src/guestfs-actions.pod:2939
8970 " int guestfs_lvresize_free (guestfs_h *g,\n"
8971 "\t\tconst char *lv,\n"
8972 "\t\tint percent);\n"
8977 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2310
8979 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
8980 "remaining free space in the volume group. Commonly you would call this with "
8981 "pc = 100 which expands the logical volume as much as possible, using all "
8982 "remaining free space in the volume group."
8986 #: ../src/guestfs-actions.pod:2951
8991 #: ../src/guestfs-actions.pod:2953
8994 " char **guestfs_lvs (guestfs_h *g);\n"
8999 #: ../src/guestfs-actions.pod:2955 ../fish/guestfish-actions.pod:2320
9001 "List all the logical volumes detected. This is the equivalent of the L<lvs"
9006 #: ../src/guestfs-actions.pod:2958 ../fish/guestfish-actions.pod:2323
9008 "This returns a list of the logical volume device names (eg. C</dev/"
9009 "VolGroup00/LogVol00>)."
9013 #: ../src/guestfs-actions.pod:2961
9014 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
9018 #: ../src/guestfs-actions.pod:2967
9019 msgid "guestfs_lvs_full"
9023 #: ../src/guestfs-actions.pod:2969
9026 " struct guestfs_lvm_lv_list *guestfs_lvs_full (guestfs_h *g);\n"
9031 #: ../src/guestfs-actions.pod:2971 ../fish/guestfish-actions.pod:2332
9033 "List all the logical volumes detected. This is the equivalent of the L<lvs"
9034 "(8)> command. The \"full\" version includes all fields."
9038 #: ../src/guestfs-actions.pod:2974
9040 "This function returns a C<struct guestfs_lvm_lv_list *> (see E<lt>guestfs-"
9041 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
9042 "C<guestfs_free_lvm_lv_list> after use>."
9046 #: ../src/guestfs-actions.pod:2979
9047 msgid "guestfs_lvuuid"
9051 #: ../src/guestfs-actions.pod:2981
9054 " char *guestfs_lvuuid (guestfs_h *g,\n"
9055 "\t\tconst char *device);\n"
9060 #: ../src/guestfs-actions.pod:2984 ../fish/guestfish-actions.pod:2339
9061 msgid "This command returns the UUID of the LVM LV C<device>."
9065 #: ../src/guestfs-actions.pod:2989
9066 msgid "guestfs_lxattrlist"
9070 #: ../src/guestfs-actions.pod:2991
9073 " struct guestfs_xattr_list *guestfs_lxattrlist (guestfs_h *g,\n"
9074 "\t\tconst char *path,\n"
9075 "\t\tchar *const *names);\n"
9080 #: ../src/guestfs-actions.pod:2995 ../fish/guestfish-actions.pod:2345
9082 "This call allows you to get the extended attributes of multiple files, where "
9083 "all files are in the directory C<path>. C<names> is the list of files from "
9088 #: ../src/guestfs-actions.pod:2999 ../fish/guestfish-actions.pod:2349
9090 "On return you get a flat list of xattr structs which must be interpreted "
9091 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
9092 "C<attrval> in this struct is zero-length to indicate there was an error "
9093 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
9094 "number (the number of following attributes for this file, which could be C<"
9095 "\"0\">). Then after the first xattr struct are the zero or more attributes "
9096 "for the first named file. This repeats for the second and subsequent files."
9100 #: ../src/guestfs-actions.pod:3009
9102 "This call is intended for programs that want to efficiently list a directory "
9103 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
9104 "a similarly efficient call for getting standard stats. Very long directory "
9105 "listings might cause the protocol message size to be exceeded, causing this "
9106 "call to fail. The caller must split up such requests into smaller groups of "
9111 #: ../src/guestfs-actions.pod:3022
9112 msgid "guestfs_mkdir"
9116 #: ../src/guestfs-actions.pod:3024
9119 " int guestfs_mkdir (guestfs_h *g,\n"
9120 "\t\tconst char *path);\n"
9125 #: ../src/guestfs-actions.pod:3027 ../fish/guestfish-actions.pod:2371
9126 msgid "Create a directory named C<path>."
9130 #: ../src/guestfs-actions.pod:3031
9131 msgid "guestfs_mkdir_mode"
9135 #: ../src/guestfs-actions.pod:3033
9138 " int guestfs_mkdir_mode (guestfs_h *g,\n"
9139 "\t\tconst char *path,\n"
9145 #: ../src/guestfs-actions.pod:3037 ../fish/guestfish-actions.pod:2377
9147 "This command creates a directory, setting the initial permissions of the "
9148 "directory to C<mode>."
9152 #: ../src/guestfs-actions.pod:3040 ../fish/guestfish-actions.pod:2380
9154 "For common Linux filesystems, the actual mode which is set will be C<mode & "
9155 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
9160 #: ../src/guestfs-actions.pod:3044
9161 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
9165 #: ../src/guestfs-actions.pod:3048
9166 msgid "guestfs_mkdir_p"
9170 #: ../src/guestfs-actions.pod:3050
9173 " int guestfs_mkdir_p (guestfs_h *g,\n"
9174 "\t\tconst char *path);\n"
9179 #: ../src/guestfs-actions.pod:3053 ../fish/guestfish-actions.pod:2390
9181 "Create a directory named C<path>, creating any parent directories as "
9182 "necessary. This is like the C<mkdir -p> shell command."
9186 #: ../src/guestfs-actions.pod:3058
9187 msgid "guestfs_mkdtemp"
9191 #: ../src/guestfs-actions.pod:3060
9194 " char *guestfs_mkdtemp (guestfs_h *g,\n"
9195 "\t\tconst char *template);\n"
9200 #: ../src/guestfs-actions.pod:3063 ../fish/guestfish-actions.pod:2397
9202 "This command creates a temporary directory. The C<template> parameter "
9203 "should be a full pathname for the temporary directory name with the final "
9204 "six characters being \"XXXXXX\"."
9208 #: ../src/guestfs-actions.pod:3068 ../fish/guestfish-actions.pod:2402
9210 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
9211 "being suitable for Windows filesystems."
9215 #: ../src/guestfs-actions.pod:3071 ../fish/guestfish-actions.pod:2405
9216 msgid "The name of the temporary directory that was created is returned."
9220 #: ../src/guestfs-actions.pod:3074 ../fish/guestfish-actions.pod:2408
9221 msgid "The temporary directory is created with mode 0700 and is owned by root."
9225 #: ../src/guestfs-actions.pod:3077 ../fish/guestfish-actions.pod:2411
9227 "The caller is responsible for deleting the temporary directory and its "
9228 "contents after use."
9232 #: ../src/guestfs-actions.pod:3080 ../fish/guestfish-actions.pod:2414
9233 msgid "See also: L<mkdtemp(3)>"
9237 #: ../src/guestfs-actions.pod:3085
9238 msgid "guestfs_mke2fs_J"
9242 #: ../src/guestfs-actions.pod:3087
9245 " int guestfs_mke2fs_J (guestfs_h *g,\n"
9246 "\t\tconst char *fstype,\n"
9247 "\t\tint blocksize,\n"
9248 "\t\tconst char *device,\n"
9249 "\t\tconst char *journal);\n"
9254 #: ../src/guestfs-actions.pod:3093 ../fish/guestfish-actions.pod:2420
9256 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
9257 "C<journal>. It is equivalent to the command:"
9261 #: ../src/guestfs-actions.pod:3097 ../fish/guestfish-actions.pod:2424
9264 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
9269 #: ../src/guestfs-actions.pod:3099
9270 msgid "See also C<guestfs_mke2journal>."
9274 #: ../src/guestfs-actions.pod:3103
9275 msgid "guestfs_mke2fs_JL"
9279 #: ../src/guestfs-actions.pod:3105
9282 " int guestfs_mke2fs_JL (guestfs_h *g,\n"
9283 "\t\tconst char *fstype,\n"
9284 "\t\tint blocksize,\n"
9285 "\t\tconst char *device,\n"
9286 "\t\tconst char *label);\n"
9291 #: ../src/guestfs-actions.pod:3111 ../fish/guestfish-actions.pod:2432
9293 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
9294 "the journal labeled C<label>."
9298 #: ../src/guestfs-actions.pod:3114
9299 msgid "See also C<guestfs_mke2journal_L>."
9303 #: ../src/guestfs-actions.pod:3118
9304 msgid "guestfs_mke2fs_JU"
9308 #: ../src/guestfs-actions.pod:3120
9311 " int guestfs_mke2fs_JU (guestfs_h *g,\n"
9312 "\t\tconst char *fstype,\n"
9313 "\t\tint blocksize,\n"
9314 "\t\tconst char *device,\n"
9315 "\t\tconst char *uuid);\n"
9320 #: ../src/guestfs-actions.pod:3126 ../fish/guestfish-actions.pod:2441
9322 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
9323 "the journal with UUID C<uuid>."
9327 #: ../src/guestfs-actions.pod:3129
9328 msgid "See also C<guestfs_mke2journal_U>."
9332 #: ../src/guestfs-actions.pod:3133
9333 msgid "guestfs_mke2journal"
9337 #: ../src/guestfs-actions.pod:3135
9340 " int guestfs_mke2journal (guestfs_h *g,\n"
9341 "\t\tint blocksize,\n"
9342 "\t\tconst char *device);\n"
9347 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2450
9349 "This creates an ext2 external journal on C<device>. It is equivalent to the "
9354 #: ../src/guestfs-actions.pod:3142 ../fish/guestfish-actions.pod:2453
9357 " mke2fs -O journal_dev -b blocksize device\n"
9362 #: ../src/guestfs-actions.pod:3146
9363 msgid "guestfs_mke2journal_L"
9367 #: ../src/guestfs-actions.pod:3148
9370 " int guestfs_mke2journal_L (guestfs_h *g,\n"
9371 "\t\tint blocksize,\n"
9372 "\t\tconst char *label,\n"
9373 "\t\tconst char *device);\n"
9378 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2459
9379 msgid "This creates an ext2 external journal on C<device> with label C<label>."
9383 #: ../src/guestfs-actions.pod:3157
9384 msgid "guestfs_mke2journal_U"
9388 #: ../src/guestfs-actions.pod:3159
9391 " int guestfs_mke2journal_U (guestfs_h *g,\n"
9392 "\t\tint blocksize,\n"
9393 "\t\tconst char *uuid,\n"
9394 "\t\tconst char *device);\n"
9399 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2465
9400 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
9404 #: ../src/guestfs-actions.pod:3168
9405 msgid "guestfs_mkfifo"
9409 #: ../src/guestfs-actions.pod:3170
9412 " int guestfs_mkfifo (guestfs_h *g,\n"
9414 "\t\tconst char *path);\n"
9419 #: ../src/guestfs-actions.pod:3174
9421 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
9422 "is just a convenient wrapper around C<guestfs_mknod>."
9426 #: ../src/guestfs-actions.pod:3182
9427 msgid "guestfs_mkfs"
9431 #: ../src/guestfs-actions.pod:3184
9434 " int guestfs_mkfs (guestfs_h *g,\n"
9435 "\t\tconst char *fstype,\n"
9436 "\t\tconst char *device);\n"
9441 #: ../src/guestfs-actions.pod:3188 ../fish/guestfish-actions.pod:2481
9443 "This creates a filesystem on C<device> (usually a partition or LVM logical "
9444 "volume). The filesystem type is C<fstype>, for example C<ext3>."
9448 #: ../src/guestfs-actions.pod:3194
9449 msgid "guestfs_mkfs_b"
9453 #: ../src/guestfs-actions.pod:3196
9456 " int guestfs_mkfs_b (guestfs_h *g,\n"
9457 "\t\tconst char *fstype,\n"
9458 "\t\tint blocksize,\n"
9459 "\t\tconst char *device);\n"
9464 #: ../src/guestfs-actions.pod:3201
9466 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
9467 "block size of the resulting filesystem. Supported block sizes depend on the "
9468 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
9472 #: ../src/guestfs-actions.pod:3206 ../fish/guestfish-actions.pod:2494
9474 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
9479 #: ../src/guestfs-actions.pod:3211
9480 msgid "guestfs_mkmountpoint"
9484 #: ../src/guestfs-actions.pod:3213
9487 " int guestfs_mkmountpoint (guestfs_h *g,\n"
9488 "\t\tconst char *exemptpath);\n"
9493 #: ../src/guestfs-actions.pod:3216
9495 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
9496 "that can be used to create extra mountpoints before mounting the first "
9501 #: ../src/guestfs-actions.pod:3220 ../fish/guestfish-actions.pod:2505
9503 "These calls are I<only> necessary in some very limited circumstances, mainly "
9504 "the case where you want to mount a mix of unrelated and/or read-only "
9505 "filesystems together."
9509 #: ../src/guestfs-actions.pod:3224 ../fish/guestfish-actions.pod:2509
9511 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
9512 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
9513 "inside that. You can unpack this as follows in guestfish:"
9517 #: ../src/guestfs-actions.pod:3229 ../fish/guestfish-actions.pod:2514
9520 " add-ro Fedora-11-i686-Live.iso\n"
9522 " mkmountpoint /cd\n"
9523 " mkmountpoint /squash\n"
9524 " mkmountpoint /ext3\n"
9525 " mount /dev/sda /cd\n"
9526 " mount-loop /cd/LiveOS/squashfs.img /squash\n"
9527 " mount-loop /squash/LiveOS/ext3fs.img /ext3\n"
9532 #: ../src/guestfs-actions.pod:3238 ../fish/guestfish-actions.pod:2523
9533 msgid "The inner filesystem is now unpacked under the /ext3 mountpoint."
9537 #: ../src/guestfs-actions.pod:3242
9538 msgid "guestfs_mknod"
9542 #: ../src/guestfs-actions.pod:3244
9545 " int guestfs_mknod (guestfs_h *g,\n"
9547 "\t\tint devmajor,\n"
9548 "\t\tint devminor,\n"
9549 "\t\tconst char *path);\n"
9554 #: ../src/guestfs-actions.pod:3250 ../fish/guestfish-actions.pod:2529
9556 "This call creates block or character special devices, or named pipes (FIFOs)."
9560 #: ../src/guestfs-actions.pod:3253 ../fish/guestfish-actions.pod:2532
9562 "The C<mode> parameter should be the mode, using the standard constants. "
9563 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
9564 "used when creating block and character special devices."
9568 #: ../src/guestfs-actions.pod:3258
9570 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
9571 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
9572 "regular file). These constants are available in the standard Linux header "
9573 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
9574 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
9575 "the appropriate constant for you."
9579 #: ../src/guestfs-actions.pod:3270
9580 msgid "guestfs_mknod_b"
9584 #: ../src/guestfs-actions.pod:3272
9587 " int guestfs_mknod_b (guestfs_h *g,\n"
9589 "\t\tint devmajor,\n"
9590 "\t\tint devminor,\n"
9591 "\t\tconst char *path);\n"
9596 #: ../src/guestfs-actions.pod:3278
9598 "This call creates a block device node called C<path> with mode C<mode> and "
9599 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
9600 "wrapper around C<guestfs_mknod>."
9604 #: ../src/guestfs-actions.pod:3286
9605 msgid "guestfs_mknod_c"
9609 #: ../src/guestfs-actions.pod:3288
9612 " int guestfs_mknod_c (guestfs_h *g,\n"
9614 "\t\tint devmajor,\n"
9615 "\t\tint devminor,\n"
9616 "\t\tconst char *path);\n"
9621 #: ../src/guestfs-actions.pod:3294
9623 "This call creates a char device node called C<path> with mode C<mode> and "
9624 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
9625 "wrapper around C<guestfs_mknod>."
9629 #: ../src/guestfs-actions.pod:3302
9630 msgid "guestfs_mkswap"
9634 #: ../src/guestfs-actions.pod:3304
9637 " int guestfs_mkswap (guestfs_h *g,\n"
9638 "\t\tconst char *device);\n"
9643 #: ../src/guestfs-actions.pod:3307 ../fish/guestfish-actions.pod:2571
9644 msgid "Create a swap partition on C<device>."
9648 #: ../src/guestfs-actions.pod:3311
9649 msgid "guestfs_mkswap_L"
9653 #: ../src/guestfs-actions.pod:3313
9656 " int guestfs_mkswap_L (guestfs_h *g,\n"
9657 "\t\tconst char *label,\n"
9658 "\t\tconst char *device);\n"
9663 #: ../src/guestfs-actions.pod:3317 ../fish/guestfish-actions.pod:2577
9664 msgid "Create a swap partition on C<device> with label C<label>."
9668 #: ../src/guestfs-actions.pod:3319 ../fish/guestfish-actions.pod:2579
9670 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
9671 "sda>), just to a partition. This appears to be a limitation of the kernel "
9676 #: ../src/guestfs-actions.pod:3325
9677 msgid "guestfs_mkswap_U"
9681 #: ../src/guestfs-actions.pod:3327
9684 " int guestfs_mkswap_U (guestfs_h *g,\n"
9685 "\t\tconst char *uuid,\n"
9686 "\t\tconst char *device);\n"
9691 #: ../src/guestfs-actions.pod:3331 ../fish/guestfish-actions.pod:2587
9692 msgid "Create a swap partition on C<device> with UUID C<uuid>."
9696 #: ../src/guestfs-actions.pod:3335
9697 msgid "guestfs_mkswap_file"
9701 #: ../src/guestfs-actions.pod:3337
9704 " int guestfs_mkswap_file (guestfs_h *g,\n"
9705 "\t\tconst char *path);\n"
9710 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2593
9711 msgid "Create a swap file."
9715 #: ../src/guestfs-actions.pod:3342
9717 "This command just writes a swap file signature to an existing file. To "
9718 "create the file itself, use something like C<guestfs_fallocate>."
9722 #: ../src/guestfs-actions.pod:3347
9723 msgid "guestfs_modprobe"
9727 #: ../src/guestfs-actions.pod:3349
9730 " int guestfs_modprobe (guestfs_h *g,\n"
9731 "\t\tconst char *modulename);\n"
9736 #: ../src/guestfs-actions.pod:3352 ../fish/guestfish-actions.pod:2602
9737 msgid "This loads a kernel module in the appliance."
9741 #: ../src/guestfs-actions.pod:3354 ../fish/guestfish-actions.pod:2604
9743 "The kernel module must have been whitelisted when libguestfs was built (see "
9744 "C<appliance/kmod.whitelist.in> in the source)."
9748 #: ../src/guestfs-actions.pod:3359
9749 msgid "guestfs_mount"
9753 #: ../src/guestfs-actions.pod:3361
9756 " int guestfs_mount (guestfs_h *g,\n"
9757 "\t\tconst char *device,\n"
9758 "\t\tconst char *mountpoint);\n"
9763 #: ../src/guestfs-actions.pod:3365 ../fish/guestfish-actions.pod:2611
9765 "Mount a guest disk at a position in the filesystem. Block devices are named "
9766 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
9767 "those block devices contain partitions, they will have the usual names (eg. "
9768 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
9772 #: ../src/guestfs-actions.pod:3371 ../fish/guestfish-actions.pod:2617
9774 "The rules are the same as for L<mount(2)>: A filesystem must first be "
9775 "mounted on C</> before others can be mounted. Other filesystems can only be "
9776 "mounted on directories which already exist."
9780 #: ../src/guestfs-actions.pod:3376 ../fish/guestfish-actions.pod:2622
9782 "The mounted filesystem is writable, if we have sufficient permissions on the "
9783 "underlying device."
9787 #: ../src/guestfs-actions.pod:3379
9789 "B<Important note:> When you use this call, the filesystem options C<sync> "
9790 "and C<noatime> are set implicitly. This was originally done because we "
9791 "thought it would improve reliability, but it turns out that I<-o sync> has a "
9792 "very large negative performance impact and negligible effect on "
9793 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
9794 "in any code that needs performance, and instead use C<guestfs_mount_options> "
9795 "(use an empty string for the first parameter if you don't want any options)."
9799 #: ../src/guestfs-actions.pod:3391
9800 msgid "guestfs_mount_loop"
9804 #: ../src/guestfs-actions.pod:3393
9807 " int guestfs_mount_loop (guestfs_h *g,\n"
9808 "\t\tconst char *file,\n"
9809 "\t\tconst char *mountpoint);\n"
9814 #: ../src/guestfs-actions.pod:3397 ../fish/guestfish-actions.pod:2639
9816 "This command lets you mount C<file> (a filesystem image in a file) on a "
9817 "mount point. It is entirely equivalent to the command C<mount -o loop file "
9822 #: ../src/guestfs-actions.pod:3403
9823 msgid "guestfs_mount_options"
9827 #: ../src/guestfs-actions.pod:3405
9830 " int guestfs_mount_options (guestfs_h *g,\n"
9831 "\t\tconst char *options,\n"
9832 "\t\tconst char *device,\n"
9833 "\t\tconst char *mountpoint);\n"
9838 #: ../src/guestfs-actions.pod:3410
9840 "This is the same as the C<guestfs_mount> command, but it allows you to set "
9841 "the mount options as for the L<mount(8)> I<-o> flag."
9845 #: ../src/guestfs-actions.pod:3414 ../fish/guestfish-actions.pod:2651
9847 "If the C<options> parameter is an empty string, then no options are passed "
9848 "(all options default to whatever the filesystem uses)."
9852 #: ../src/guestfs-actions.pod:3420
9853 msgid "guestfs_mount_ro"
9857 #: ../src/guestfs-actions.pod:3422
9860 " int guestfs_mount_ro (guestfs_h *g,\n"
9861 "\t\tconst char *device,\n"
9862 "\t\tconst char *mountpoint);\n"
9867 #: ../src/guestfs-actions.pod:3426
9869 "This is the same as the C<guestfs_mount> command, but it mounts the "
9870 "filesystem with the read-only (I<-o ro>) flag."
9874 #: ../src/guestfs-actions.pod:3431
9875 msgid "guestfs_mount_vfs"
9879 #: ../src/guestfs-actions.pod:3433
9882 " int guestfs_mount_vfs (guestfs_h *g,\n"
9883 "\t\tconst char *options,\n"
9884 "\t\tconst char *vfstype,\n"
9885 "\t\tconst char *device,\n"
9886 "\t\tconst char *mountpoint);\n"
9891 #: ../src/guestfs-actions.pod:3439
9893 "This is the same as the C<guestfs_mount> command, but it allows you to set "
9894 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
9899 #: ../src/guestfs-actions.pod:3445
9900 msgid "guestfs_mountpoints"
9904 #: ../src/guestfs-actions.pod:3447
9907 " char **guestfs_mountpoints (guestfs_h *g);\n"
9912 #: ../src/guestfs-actions.pod:3449
9914 "This call is similar to C<guestfs_mounts>. That call returns a list of "
9915 "devices. This one returns a hash table (map) of device name to directory "
9916 "where the device is mounted."
9920 #: ../src/guestfs-actions.pod:3459
9921 msgid "guestfs_mounts"
9925 #: ../src/guestfs-actions.pod:3461
9928 " char **guestfs_mounts (guestfs_h *g);\n"
9933 #: ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:2682
9935 "This returns the list of currently mounted filesystems. It returns the list "
9936 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
9940 #: ../src/guestfs-actions.pod:3466 ../fish/guestfish-actions.pod:2685
9941 msgid "Some internal mounts are not shown."
9945 #: ../src/guestfs-actions.pod:3468
9946 msgid "See also: C<guestfs_mountpoints>"
9950 #: ../src/guestfs-actions.pod:3474
9955 #: ../src/guestfs-actions.pod:3476
9958 " int guestfs_mv (guestfs_h *g,\n"
9959 "\t\tconst char *src,\n"
9960 "\t\tconst char *dest);\n"
9965 #: ../src/guestfs-actions.pod:3480 ../fish/guestfish-actions.pod:2693
9967 "This moves a file from C<src> to C<dest> where C<dest> is either a "
9968 "destination filename or destination directory."
9972 #: ../src/guestfs-actions.pod:3485
9973 msgid "guestfs_ntfs_3g_probe"
9977 #: ../src/guestfs-actions.pod:3487
9980 " int guestfs_ntfs_3g_probe (guestfs_h *g,\n"
9982 "\t\tconst char *device);\n"
9987 #: ../src/guestfs-actions.pod:3491 ../fish/guestfish-actions.pod:2700
9989 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
9990 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
9991 "write, and some cannot be mounted at all)."
9995 #: ../src/guestfs-actions.pod:3495 ../fish/guestfish-actions.pod:2704
9997 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
9998 "can be mounted read-write. Set it to false if you want to test if the "
9999 "volume can be mounted read-only."
10003 #: ../src/guestfs-actions.pod:3499 ../fish/guestfish-actions.pod:2708
10005 "The return value is an integer which C<0> if the operation would succeed, or "
10006 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
10010 #: ../src/guestfs-actions.pod:3505
10011 msgid "guestfs_ntfsresize"
10015 #: ../src/guestfs-actions.pod:3507
10018 " int guestfs_ntfsresize (guestfs_h *g,\n"
10019 "\t\tconst char *device);\n"
10024 #: ../src/guestfs-actions.pod:3510 ../fish/guestfish-actions.pod:2716
10026 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
10027 "size of the underlying device. See also L<ntfsresize(8)>."
10031 #: ../src/guestfs-actions.pod:3516
10032 msgid "guestfs_ntfsresize_size"
10036 #: ../src/guestfs-actions.pod:3518
10039 " int guestfs_ntfsresize_size (guestfs_h *g,\n"
10040 "\t\tconst char *device,\n"
10041 "\t\tint64_t size);\n"
10046 #: ../src/guestfs-actions.pod:3522
10048 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
10049 "to specify the new size (in bytes) explicitly."
10053 #: ../src/guestfs-actions.pod:3527
10054 msgid "guestfs_part_add"
10058 #: ../src/guestfs-actions.pod:3529
10061 " int guestfs_part_add (guestfs_h *g,\n"
10062 "\t\tconst char *device,\n"
10063 "\t\tconst char *prlogex,\n"
10064 "\t\tint64_t startsect,\n"
10065 "\t\tint64_t endsect);\n"
10070 #: ../src/guestfs-actions.pod:3535
10072 "This command adds a partition to C<device>. If there is no partition table "
10073 "on the device, call C<guestfs_part_init> first."
10077 #: ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:2734
10079 "The C<prlogex> parameter is the type of partition. Normally you should pass "
10080 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
10081 "C<logical>) and C<e> (or C<extended>) partition types."
10085 #: ../src/guestfs-actions.pod:3543 ../fish/guestfish-actions.pod:2739
10087 "C<startsect> and C<endsect> are the start and end of the partition in "
10088 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
10089 "from the end of the disk (C<-1> is the last sector)."
10093 #: ../src/guestfs-actions.pod:3547
10095 "Creating a partition which covers the whole disk is not so easy. Use "
10096 "C<guestfs_part_disk> to do that."
10100 #: ../src/guestfs-actions.pod:3552
10101 msgid "guestfs_part_del"
10105 #: ../src/guestfs-actions.pod:3554
10108 " int guestfs_part_del (guestfs_h *g,\n"
10109 "\t\tconst char *device,\n"
10110 "\t\tint partnum);\n"
10115 #: ../src/guestfs-actions.pod:3558 ../fish/guestfish-actions.pod:2750
10116 msgid "This command deletes the partition numbered C<partnum> on C<device>."
10120 #: ../src/guestfs-actions.pod:3560 ../fish/guestfish-actions.pod:2752
10122 "Note that in the case of MBR partitioning, deleting an extended partition "
10123 "also deletes any logical partitions it contains."
10127 #: ../src/guestfs-actions.pod:3566
10128 msgid "guestfs_part_disk"
10132 #: ../src/guestfs-actions.pod:3568
10135 " int guestfs_part_disk (guestfs_h *g,\n"
10136 "\t\tconst char *device,\n"
10137 "\t\tconst char *parttype);\n"
10142 #: ../src/guestfs-actions.pod:3572
10144 "This command is simply a combination of C<guestfs_part_init> followed by "
10145 "C<guestfs_part_add> to create a single primary partition covering the whole "
10150 #: ../src/guestfs-actions.pod:3576
10152 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
10153 "possible values are described in C<guestfs_part_init>."
10157 #: ../src/guestfs-actions.pod:3584
10158 msgid "guestfs_part_get_bootable"
10162 #: ../src/guestfs-actions.pod:3586
10165 " int guestfs_part_get_bootable (guestfs_h *g,\n"
10166 "\t\tconst char *device,\n"
10167 "\t\tint partnum);\n"
10172 #: ../src/guestfs-actions.pod:3590 ../fish/guestfish-actions.pod:2774
10174 "This command returns true if the partition C<partnum> on C<device> has the "
10175 "bootable flag set."
10179 #: ../src/guestfs-actions.pod:3593
10180 msgid "See also C<guestfs_part_set_bootable>."
10184 #: ../src/guestfs-actions.pod:3597
10185 msgid "guestfs_part_get_mbr_id"
10189 #: ../src/guestfs-actions.pod:3599
10192 " int guestfs_part_get_mbr_id (guestfs_h *g,\n"
10193 "\t\tconst char *device,\n"
10194 "\t\tint partnum);\n"
10199 #: ../src/guestfs-actions.pod:3603 ../fish/guestfish-actions.pod:2783
10201 "Returns the MBR type byte (also known as the ID byte) from the numbered "
10202 "partition C<partnum>."
10206 #: ../src/guestfs-actions.pod:3606 ../src/guestfs-actions.pod:3768
10208 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
10209 "undefined results for other partition table types (see "
10210 "C<guestfs_part_get_parttype>)."
10214 #: ../src/guestfs-actions.pod:3612
10215 msgid "guestfs_part_get_parttype"
10219 #: ../src/guestfs-actions.pod:3614
10222 " char *guestfs_part_get_parttype (guestfs_h *g,\n"
10223 "\t\tconst char *device);\n"
10228 #: ../src/guestfs-actions.pod:3617 ../fish/guestfish-actions.pod:2794
10230 "This command examines the partition table on C<device> and returns the "
10231 "partition table type (format) being used."
10235 #: ../src/guestfs-actions.pod:3620
10237 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
10238 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
10239 "possible, although unusual. See C<guestfs_part_init> for a full list."
10243 #: ../src/guestfs-actions.pod:3628
10244 msgid "guestfs_part_init"
10248 #: ../src/guestfs-actions.pod:3630
10251 " int guestfs_part_init (guestfs_h *g,\n"
10252 "\t\tconst char *device,\n"
10253 "\t\tconst char *parttype);\n"
10258 #: ../src/guestfs-actions.pod:3634 ../fish/guestfish-actions.pod:2806
10260 "This creates an empty partition table on C<device> of one of the partition "
10261 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
10262 "(for large disks)."
10266 #: ../src/guestfs-actions.pod:3638
10268 "Initially there are no partitions. Following this, you should call "
10269 "C<guestfs_part_add> for each partition required."
10273 #: ../src/guestfs-actions.pod:3641 ../fish/guestfish-actions.pod:2813
10274 msgid "Possible values for C<parttype> are:"
10278 #: ../src/guestfs-actions.pod:3645 ../fish/guestfish-actions.pod:2817
10279 msgid "B<efi> | B<gpt>"
10283 #: ../src/guestfs-actions.pod:3647 ../fish/guestfish-actions.pod:2819
10284 msgid "Intel EFI / GPT partition table."
10288 #: ../src/guestfs-actions.pod:3649 ../fish/guestfish-actions.pod:2821
10290 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
10291 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
10292 "the C<mbr> format."
10296 #: ../src/guestfs-actions.pod:3653 ../fish/guestfish-actions.pod:2825
10297 msgid "B<mbr> | B<msdos>"
10301 #: ../src/guestfs-actions.pod:3655 ../fish/guestfish-actions.pod:2827
10303 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
10304 "Windows. This partition type will B<only> work for device sizes up to 2 "
10305 "TB. For large disks we recommend using C<gpt>."
10309 #: ../src/guestfs-actions.pod:3662 ../fish/guestfish-actions.pod:2834
10311 "Other partition table types that may work but are not supported include:"
10315 #: ../src/guestfs-actions.pod:3667 ../fish/guestfish-actions.pod:2839
10320 #: ../src/guestfs-actions.pod:3669 ../fish/guestfish-actions.pod:2841
10321 msgid "AIX disk labels."
10325 #: ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:2843
10326 msgid "B<amiga> | B<rdb>"
10330 #: ../src/guestfs-actions.pod:3673 ../fish/guestfish-actions.pod:2845
10331 msgid "Amiga \"Rigid Disk Block\" format."
10335 #: ../src/guestfs-actions.pod:3675 ../fish/guestfish-actions.pod:2847
10340 #: ../src/guestfs-actions.pod:3677 ../fish/guestfish-actions.pod:2849
10341 msgid "BSD disk labels."
10345 #: ../src/guestfs-actions.pod:3679 ../fish/guestfish-actions.pod:2851
10350 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2853
10351 msgid "DASD, used on IBM mainframes."
10355 #: ../src/guestfs-actions.pod:3683 ../fish/guestfish-actions.pod:2855
10360 #: ../src/guestfs-actions.pod:3685 ../fish/guestfish-actions.pod:2857
10361 msgid "MIPS/SGI volumes."
10365 #: ../src/guestfs-actions.pod:3687 ../fish/guestfish-actions.pod:2859
10370 #: ../src/guestfs-actions.pod:3689 ../fish/guestfish-actions.pod:2861
10371 msgid "Old Mac partition format. Modern Macs use C<gpt>."
10375 #: ../src/guestfs-actions.pod:3691 ../fish/guestfish-actions.pod:2863
10380 #: ../src/guestfs-actions.pod:3693 ../fish/guestfish-actions.pod:2865
10381 msgid "NEC PC-98 format, common in Japan apparently."
10385 #: ../src/guestfs-actions.pod:3695 ../fish/guestfish-actions.pod:2867
10390 #: ../src/guestfs-actions.pod:3697 ../fish/guestfish-actions.pod:2869
10391 msgid "Sun disk labels."
10395 #: ../src/guestfs-actions.pod:3703
10396 msgid "guestfs_part_list"
10400 #: ../src/guestfs-actions.pod:3705
10403 " struct guestfs_partition_list *guestfs_part_list (guestfs_h *g,\n"
10404 "\t\tconst char *device);\n"
10409 #: ../src/guestfs-actions.pod:3708 ../fish/guestfish-actions.pod:2877
10411 "This command parses the partition table on C<device> and returns the list of "
10412 "partitions found."
10416 #: ../src/guestfs-actions.pod:3711 ../fish/guestfish-actions.pod:2880
10417 msgid "The fields in the returned structure are:"
10421 #: ../src/guestfs-actions.pod:3715 ../fish/guestfish-actions.pod:2884
10422 msgid "B<part_num>"
10426 #: ../src/guestfs-actions.pod:3717 ../fish/guestfish-actions.pod:2886
10427 msgid "Partition number, counting from 1."
10431 #: ../src/guestfs-actions.pod:3719 ../fish/guestfish-actions.pod:2888
10432 msgid "B<part_start>"
10436 #: ../src/guestfs-actions.pod:3721
10438 "Start of the partition I<in bytes>. To get sectors you have to divide by "
10439 "the device's sector size, see C<guestfs_blockdev_getss>."
10443 #: ../src/guestfs-actions.pod:3724 ../fish/guestfish-actions.pod:2893
10444 msgid "B<part_end>"
10448 #: ../src/guestfs-actions.pod:3726 ../fish/guestfish-actions.pod:2895
10449 msgid "End of the partition in bytes."
10453 #: ../src/guestfs-actions.pod:3728 ../fish/guestfish-actions.pod:2897
10454 msgid "B<part_size>"
10458 #: ../src/guestfs-actions.pod:3730 ../fish/guestfish-actions.pod:2899
10459 msgid "Size of the partition in bytes."
10463 #: ../src/guestfs-actions.pod:3734
10465 "This function returns a C<struct guestfs_partition_list *> (see E<lt>guestfs-"
10466 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
10467 "C<guestfs_free_partition_list> after use>."
10471 #: ../src/guestfs-actions.pod:3739
10472 msgid "guestfs_part_set_bootable"
10476 #: ../src/guestfs-actions.pod:3741
10479 " int guestfs_part_set_bootable (guestfs_h *g,\n"
10480 "\t\tconst char *device,\n"
10481 "\t\tint partnum,\n"
10482 "\t\tint bootable);\n"
10487 #: ../src/guestfs-actions.pod:3746 ../fish/guestfish-actions.pod:2907
10489 "This sets the bootable flag on partition numbered C<partnum> on device "
10490 "C<device>. Note that partitions are numbered from 1."
10494 #: ../src/guestfs-actions.pod:3749 ../fish/guestfish-actions.pod:2910
10496 "The bootable flag is used by some operating systems (notably Windows) to "
10497 "determine which partition to boot from. It is by no means universally "
10502 #: ../src/guestfs-actions.pod:3755
10503 msgid "guestfs_part_set_mbr_id"
10507 #: ../src/guestfs-actions.pod:3757
10510 " int guestfs_part_set_mbr_id (guestfs_h *g,\n"
10511 "\t\tconst char *device,\n"
10512 "\t\tint partnum,\n"
10513 "\t\tint idbyte);\n"
10518 #: ../src/guestfs-actions.pod:3762 ../fish/guestfish-actions.pod:2918
10520 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
10521 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
10522 "documentation are in fact hexadecimal numbers, but usually documented "
10523 "without any leading \"0x\" which might be confusing."
10527 #: ../src/guestfs-actions.pod:3774
10528 msgid "guestfs_part_set_name"
10532 #: ../src/guestfs-actions.pod:3776
10535 " int guestfs_part_set_name (guestfs_h *g,\n"
10536 "\t\tconst char *device,\n"
10537 "\t\tint partnum,\n"
10538 "\t\tconst char *name);\n"
10543 #: ../src/guestfs-actions.pod:3781 ../fish/guestfish-actions.pod:2932
10545 "This sets the partition name on partition numbered C<partnum> on device "
10546 "C<device>. Note that partitions are numbered from 1."
10550 #: ../src/guestfs-actions.pod:3784 ../fish/guestfish-actions.pod:2935
10552 "The partition name can only be set on certain types of partition table. "
10553 "This works on C<gpt> but not on C<mbr> partitions."
10557 #: ../src/guestfs-actions.pod:3789
10558 msgid "guestfs_part_to_dev"
10562 #: ../src/guestfs-actions.pod:3791
10565 " char *guestfs_part_to_dev (guestfs_h *g,\n"
10566 "\t\tconst char *partition);\n"
10571 #: ../src/guestfs-actions.pod:3794 ../fish/guestfish-actions.pod:2942
10573 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
10574 "partition number, returning the device name (eg. \"/dev/sdb\")."
10578 #: ../src/guestfs-actions.pod:3798
10580 "The named partition must exist, for example as a string returned from "
10581 "C<guestfs_list_partitions>."
10585 #: ../src/guestfs-actions.pod:3804
10586 msgid "guestfs_ping_daemon"
10590 #: ../src/guestfs-actions.pod:3806
10593 " int guestfs_ping_daemon (guestfs_h *g);\n"
10598 #: ../src/guestfs-actions.pod:3808 ../fish/guestfish-actions.pod:2953
10600 "This is a test probe into the guestfs daemon running inside the qemu "
10601 "subprocess. Calling this function checks that the daemon responds to the "
10602 "ping message, without affecting the daemon or attached block device(s) in "
10607 #: ../src/guestfs-actions.pod:3815
10608 msgid "guestfs_pread"
10612 #: ../src/guestfs-actions.pod:3817
10615 " char *guestfs_pread (guestfs_h *g,\n"
10616 "\t\tconst char *path,\n"
10618 "\t\tint64_t offset,\n"
10619 "\t\tsize_t *size_r);\n"
10624 #: ../src/guestfs-actions.pod:3823 ../fish/guestfish-actions.pod:2962
10626 "This command lets you read part of a file. It reads C<count> bytes of the "
10627 "file, starting at C<offset>, from file C<path>."
10631 #: ../src/guestfs-actions.pod:3826 ../fish/guestfish-actions.pod:2965
10633 "This may read fewer bytes than requested. For further details see the "
10634 "L<pread(2)> system call."
10638 #: ../src/guestfs-actions.pod:3829
10639 msgid "See also C<guestfs_pwrite>."
10643 #: ../src/guestfs-actions.pod:3838
10644 msgid "guestfs_pvcreate"
10648 #: ../src/guestfs-actions.pod:3840
10651 " int guestfs_pvcreate (guestfs_h *g,\n"
10652 "\t\tconst char *device);\n"
10657 #: ../src/guestfs-actions.pod:3843 ../fish/guestfish-actions.pod:2977
10659 "This creates an LVM physical volume on the named C<device>, where C<device> "
10660 "should usually be a partition name such as C</dev/sda1>."
10664 #: ../src/guestfs-actions.pod:3849
10665 msgid "guestfs_pvremove"
10669 #: ../src/guestfs-actions.pod:3851
10672 " int guestfs_pvremove (guestfs_h *g,\n"
10673 "\t\tconst char *device);\n"
10678 #: ../src/guestfs-actions.pod:3854 ../fish/guestfish-actions.pod:2985
10680 "This wipes a physical volume C<device> so that LVM will no longer recognise "
10685 #: ../src/guestfs-actions.pod:3857 ../fish/guestfish-actions.pod:2988
10687 "The implementation uses the C<pvremove> command which refuses to wipe "
10688 "physical volumes that contain any volume groups, so you have to remove those "
10693 #: ../src/guestfs-actions.pod:3863
10694 msgid "guestfs_pvresize"
10698 #: ../src/guestfs-actions.pod:3865
10701 " int guestfs_pvresize (guestfs_h *g,\n"
10702 "\t\tconst char *device);\n"
10707 #: ../src/guestfs-actions.pod:3868 ../fish/guestfish-actions.pod:2996
10709 "This resizes (expands or shrinks) an existing LVM physical volume to match "
10710 "the new size of the underlying device."
10714 #: ../src/guestfs-actions.pod:3873
10715 msgid "guestfs_pvresize_size"
10719 #: ../src/guestfs-actions.pod:3875
10722 " int guestfs_pvresize_size (guestfs_h *g,\n"
10723 "\t\tconst char *device,\n"
10724 "\t\tint64_t size);\n"
10729 #: ../src/guestfs-actions.pod:3879
10731 "This command is the same as C<guestfs_pvresize> except that it allows you to "
10732 "specify the new size (in bytes) explicitly."
10736 #: ../src/guestfs-actions.pod:3884
10737 msgid "guestfs_pvs"
10741 #: ../src/guestfs-actions.pod:3886
10744 " char **guestfs_pvs (guestfs_h *g);\n"
10749 #: ../src/guestfs-actions.pod:3888 ../fish/guestfish-actions.pod:3010
10751 "List all the physical volumes detected. This is the equivalent of the L<pvs"
10756 #: ../src/guestfs-actions.pod:3891 ../fish/guestfish-actions.pod:3013
10758 "This returns a list of just the device names that contain PVs (eg. C</dev/"
10763 #: ../src/guestfs-actions.pod:3894
10764 msgid "See also C<guestfs_pvs_full>."
10768 #: ../src/guestfs-actions.pod:3900
10769 msgid "guestfs_pvs_full"
10773 #: ../src/guestfs-actions.pod:3902
10776 " struct guestfs_lvm_pv_list *guestfs_pvs_full (guestfs_h *g);\n"
10781 #: ../src/guestfs-actions.pod:3904 ../fish/guestfish-actions.pod:3022
10783 "List all the physical volumes detected. This is the equivalent of the L<pvs"
10784 "(8)> command. The \"full\" version includes all fields."
10788 #: ../src/guestfs-actions.pod:3907
10790 "This function returns a C<struct guestfs_lvm_pv_list *> (see E<lt>guestfs-"
10791 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
10792 "C<guestfs_free_lvm_pv_list> after use>."
10796 #: ../src/guestfs-actions.pod:3912
10797 msgid "guestfs_pvuuid"
10801 #: ../src/guestfs-actions.pod:3914
10804 " char *guestfs_pvuuid (guestfs_h *g,\n"
10805 "\t\tconst char *device);\n"
10810 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:3029
10811 msgid "This command returns the UUID of the LVM PV C<device>."
10815 #: ../src/guestfs-actions.pod:3922
10816 msgid "guestfs_pwrite"
10820 #: ../src/guestfs-actions.pod:3924
10823 " int guestfs_pwrite (guestfs_h *g,\n"
10824 "\t\tconst char *path,\n"
10825 "\t\tconst char *content,\n"
10826 "\t\tsize_t content_size,\n"
10827 "\t\tint64_t offset);\n"
10832 #: ../src/guestfs-actions.pod:3930 ../fish/guestfish-actions.pod:3035
10834 "This command writes to part of a file. It writes the data buffer C<content> "
10835 "to the file C<path> starting at offset C<offset>."
10839 #: ../src/guestfs-actions.pod:3933 ../fish/guestfish-actions.pod:3038
10841 "This command implements the L<pwrite(2)> system call, and like that system "
10842 "call it may not write the full data requested. The return value is the "
10843 "number of bytes that were actually written to the file. This could even be "
10844 "0, although short writes are unlikely for regular files in ordinary "
10849 #: ../src/guestfs-actions.pod:3939
10850 msgid "See also C<guestfs_pread>."
10854 #: ../src/guestfs-actions.pod:3946
10855 msgid "guestfs_read_file"
10859 #: ../src/guestfs-actions.pod:3948
10862 " char *guestfs_read_file (guestfs_h *g,\n"
10863 "\t\tconst char *path,\n"
10864 "\t\tsize_t *size_r);\n"
10869 #: ../src/guestfs-actions.pod:3952 ../fish/guestfish-actions.pod:3053
10870 msgid "This calls returns the contents of the file C<path> as a buffer."
10874 #: ../src/guestfs-actions.pod:3955
10876 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
10877 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
10878 "function is limited in the total size of file that can be handled."
10882 #: ../src/guestfs-actions.pod:3967
10883 msgid "guestfs_read_lines"
10887 #: ../src/guestfs-actions.pod:3969
10890 " char **guestfs_read_lines (guestfs_h *g,\n"
10891 "\t\tconst char *path);\n"
10896 #: ../src/guestfs-actions.pod:3974 ../fish/guestfish-actions.pod:3070
10898 "The file contents are returned as a list of lines. Trailing C<LF> and "
10899 "C<CRLF> character sequences are I<not> returned."
10903 #: ../src/guestfs-actions.pod:3977
10905 "Note that this function cannot correctly handle binary files (specifically, "
10906 "files containing C<\\0> character which is treated as end of line). For "
10907 "those you need to use the C<guestfs_read_file> function which has a more "
10908 "complex interface."
10912 #: ../src/guestfs-actions.pod:3986
10913 msgid "guestfs_readdir"
10917 #: ../src/guestfs-actions.pod:3988
10920 " struct guestfs_dirent_list *guestfs_readdir (guestfs_h *g,\n"
10921 "\t\tconst char *dir);\n"
10926 #: ../src/guestfs-actions.pod:3991 ../fish/guestfish-actions.pod:3082
10927 msgid "This returns the list of directory entries in directory C<dir>."
10931 #: ../src/guestfs-actions.pod:3993 ../fish/guestfish-actions.pod:3084
10933 "All entries in the directory are returned, including C<.> and C<..>. The "
10934 "entries are I<not> sorted, but returned in the same order as the underlying "
10939 #: ../src/guestfs-actions.pod:3997 ../fish/guestfish-actions.pod:3088
10941 "Also this call returns basic file type information about each file. The "
10942 "C<ftyp> field will contain one of the following characters:"
10946 #: ../src/guestfs-actions.pod:4002 ../fish/guestfish-actions.pod:3093
10951 #: ../src/guestfs-actions.pod:4004 ../fish/guestfish-actions.pod:3095
10952 msgid "Block special"
10956 #: ../src/guestfs-actions.pod:4006 ../fish/guestfish-actions.pod:3097
10961 #: ../src/guestfs-actions.pod:4008 ../fish/guestfish-actions.pod:3099
10962 msgid "Char special"
10966 #: ../src/guestfs-actions.pod:4010 ../fish/guestfish-actions.pod:3101
10971 #: ../src/guestfs-actions.pod:4012 ../fish/guestfish-actions.pod:3103
10976 #: ../src/guestfs-actions.pod:4014 ../fish/guestfish-actions.pod:3105
10981 #: ../src/guestfs-actions.pod:4016 ../fish/guestfish-actions.pod:3107
10982 msgid "FIFO (named pipe)"
10986 #: ../src/guestfs-actions.pod:4018 ../fish/guestfish-actions.pod:3109
10991 #: ../src/guestfs-actions.pod:4020 ../fish/guestfish-actions.pod:3111
10992 msgid "Symbolic link"
10996 #: ../src/guestfs-actions.pod:4022 ../fish/guestfish-actions.pod:3113
11001 #: ../src/guestfs-actions.pod:4024 ../fish/guestfish-actions.pod:3115
11002 msgid "Regular file"
11006 #: ../src/guestfs-actions.pod:4026 ../fish/guestfish-actions.pod:3117
11011 #: ../src/guestfs-actions.pod:4028 ../fish/guestfish-actions.pod:3119
11016 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:3121
11021 #: ../src/guestfs-actions.pod:4032 ../fish/guestfish-actions.pod:3123
11022 msgid "Unknown file type"
11026 #: ../src/guestfs-actions.pod:4034 ../fish/guestfish-actions.pod:3125
11031 #: ../src/guestfs-actions.pod:4036 ../fish/guestfish-actions.pod:3127
11033 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
11037 #: ../src/guestfs-actions.pod:4041
11039 "This function is primarily intended for use by programs. To get a simple "
11040 "list of names, use C<guestfs_ls>. To get a printable directory for human "
11041 "consumption, use C<guestfs_ll>."
11045 #: ../src/guestfs-actions.pod:4045
11047 "This function returns a C<struct guestfs_dirent_list *> (see E<lt>guestfs-"
11048 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
11049 "C<guestfs_free_dirent_list> after use>."
11053 #: ../src/guestfs-actions.pod:4050
11054 msgid "guestfs_readlink"
11058 #: ../src/guestfs-actions.pod:4052
11061 " char *guestfs_readlink (guestfs_h *g,\n"
11062 "\t\tconst char *path);\n"
11067 #: ../src/guestfs-actions.pod:4055 ../fish/guestfish-actions.pod:3140
11068 msgid "This command reads the target of a symbolic link."
11072 #: ../src/guestfs-actions.pod:4060
11073 msgid "guestfs_readlinklist"
11077 #: ../src/guestfs-actions.pod:4062
11080 " char **guestfs_readlinklist (guestfs_h *g,\n"
11081 "\t\tconst char *path,\n"
11082 "\t\tchar *const *names);\n"
11087 #: ../src/guestfs-actions.pod:4066 ../fish/guestfish-actions.pod:3146
11089 "This call allows you to do a C<readlink> operation on multiple files, where "
11090 "all files are in the directory C<path>. C<names> is the list of files from "
11095 #: ../src/guestfs-actions.pod:4070 ../fish/guestfish-actions.pod:3150
11097 "On return you get a list of strings, with a one-to-one correspondence to the "
11098 "C<names> list. Each string is the value of the symbolic link."
11102 #: ../src/guestfs-actions.pod:4074 ../fish/guestfish-actions.pod:3154
11104 "If the C<readlink(2)> operation fails on any name, then the corresponding "
11105 "result string is the empty string C<\"\">. However the whole operation is "
11106 "completed even if there were C<readlink(2)> errors, and so you can call this "
11107 "function with names where you don't know if they are symbolic links already "
11108 "(albeit slightly less efficient)."
11112 #: ../src/guestfs-actions.pod:4081 ../fish/guestfish-actions.pod:3161
11114 "This call is intended for programs that want to efficiently list a directory "
11115 "contents without making many round-trips. Very long directory listings "
11116 "might cause the protocol message size to be exceeded, causing this call to "
11117 "fail. The caller must split up such requests into smaller groups of names."
11121 #: ../src/guestfs-actions.pod:4092
11122 msgid "guestfs_realpath"
11126 #: ../src/guestfs-actions.pod:4094
11129 " char *guestfs_realpath (guestfs_h *g,\n"
11130 "\t\tconst char *path);\n"
11135 #: ../src/guestfs-actions.pod:4097 ../fish/guestfish-actions.pod:3172
11137 "Return the canonicalized absolute pathname of C<path>. The returned path "
11138 "has no C<.>, C<..> or symbolic link path elements."
11142 #: ../src/guestfs-actions.pod:4103
11143 msgid "guestfs_removexattr"
11147 #: ../src/guestfs-actions.pod:4105
11150 " int guestfs_removexattr (guestfs_h *g,\n"
11151 "\t\tconst char *xattr,\n"
11152 "\t\tconst char *path);\n"
11157 #: ../src/guestfs-actions.pod:4109 ../fish/guestfish-actions.pod:3179
11159 "This call removes the extended attribute named C<xattr> of the file C<path>."
11163 #: ../src/guestfs-actions.pod:4112
11164 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
11168 #: ../src/guestfs-actions.pod:4116
11169 msgid "guestfs_resize2fs"
11173 #: ../src/guestfs-actions.pod:4118
11176 " int guestfs_resize2fs (guestfs_h *g,\n"
11177 "\t\tconst char *device);\n"
11182 #: ../src/guestfs-actions.pod:4121 ../fish/guestfish-actions.pod:3188
11184 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
11185 "underlying device."
11189 #: ../src/guestfs-actions.pod:4124
11191 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
11192 "C<device> before calling this command. For unknown reasons C<resize2fs> "
11193 "sometimes gives an error about this and sometimes not. In any case, it is "
11194 "always safe to call C<guestfs_e2fsck_f> before calling this function."
11198 #: ../src/guestfs-actions.pod:4132
11199 msgid "guestfs_resize2fs_size"
11203 #: ../src/guestfs-actions.pod:4134
11206 " int guestfs_resize2fs_size (guestfs_h *g,\n"
11207 "\t\tconst char *device,\n"
11208 "\t\tint64_t size);\n"
11213 #: ../src/guestfs-actions.pod:4138
11215 "This command is the same as C<guestfs_resize2fs> except that it allows you "
11216 "to specify the new size (in bytes) explicitly."
11220 #: ../src/guestfs-actions.pod:4143
11225 #: ../src/guestfs-actions.pod:4145
11228 " int guestfs_rm (guestfs_h *g,\n"
11229 "\t\tconst char *path);\n"
11234 #: ../src/guestfs-actions.pod:4148 ../fish/guestfish-actions.pod:3208
11235 msgid "Remove the single file C<path>."
11239 #: ../src/guestfs-actions.pod:4152
11240 msgid "guestfs_rm_rf"
11244 #: ../src/guestfs-actions.pod:4154
11247 " int guestfs_rm_rf (guestfs_h *g,\n"
11248 "\t\tconst char *path);\n"
11253 #: ../src/guestfs-actions.pod:4157 ../fish/guestfish-actions.pod:3214
11255 "Remove the file or directory C<path>, recursively removing the contents if "
11256 "its a directory. This is like the C<rm -rf> shell command."
11260 #: ../src/guestfs-actions.pod:4163
11261 msgid "guestfs_rmdir"
11265 #: ../src/guestfs-actions.pod:4165
11268 " int guestfs_rmdir (guestfs_h *g,\n"
11269 "\t\tconst char *path);\n"
11274 #: ../src/guestfs-actions.pod:4168 ../fish/guestfish-actions.pod:3222
11275 msgid "Remove the single directory C<path>."
11279 #: ../src/guestfs-actions.pod:4172
11280 msgid "guestfs_rmmountpoint"
11284 #: ../src/guestfs-actions.pod:4174
11287 " int guestfs_rmmountpoint (guestfs_h *g,\n"
11288 "\t\tconst char *exemptpath);\n"
11293 #: ../src/guestfs-actions.pod:4177
11295 "This calls removes a mountpoint that was previously created with "
11296 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
11300 #: ../src/guestfs-actions.pod:4183
11301 msgid "guestfs_scrub_device"
11305 #: ../src/guestfs-actions.pod:4185
11308 " int guestfs_scrub_device (guestfs_h *g,\n"
11309 "\t\tconst char *device);\n"
11314 #: ../src/guestfs-actions.pod:4188 ../fish/guestfish-actions.pod:3236
11316 "This command writes patterns over C<device> to make data retrieval more "
11321 #: ../src/guestfs-actions.pod:4191 ../src/guestfs-actions.pod:4209
11322 #: ../src/guestfs-actions.pod:4225 ../fish/guestfish-actions.pod:3239
11323 #: ../fish/guestfish-actions.pod:3254 ../fish/guestfish-actions.pod:3267
11325 "It is an interface to the L<scrub(1)> program. See that manual page for "
11330 #: ../src/guestfs-actions.pod:4199
11331 msgid "guestfs_scrub_file"
11335 #: ../src/guestfs-actions.pod:4201
11338 " int guestfs_scrub_file (guestfs_h *g,\n"
11339 "\t\tconst char *file);\n"
11344 #: ../src/guestfs-actions.pod:4204 ../fish/guestfish-actions.pod:3249
11346 "This command writes patterns over a file to make data retrieval more "
11351 #: ../src/guestfs-actions.pod:4207 ../fish/guestfish-actions.pod:3252
11352 msgid "The file is I<removed> after scrubbing."
11356 #: ../src/guestfs-actions.pod:4214
11357 msgid "guestfs_scrub_freespace"
11361 #: ../src/guestfs-actions.pod:4216
11364 " int guestfs_scrub_freespace (guestfs_h *g,\n"
11365 "\t\tconst char *dir);\n"
11370 #: ../src/guestfs-actions.pod:4219
11372 "This command creates the directory C<dir> and then fills it with files until "
11373 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
11374 "and deletes them. The intention is to scrub any free space on the partition "
11375 "containing C<dir>."
11379 #: ../src/guestfs-actions.pod:4230
11380 msgid "guestfs_set_append"
11384 #: ../src/guestfs-actions.pod:4232
11387 " int guestfs_set_append (guestfs_h *g,\n"
11388 "\t\tconst char *append);\n"
11393 #: ../src/guestfs-actions.pod:4235 ../fish/guestfish-actions.pod:3276
11395 "This function is used to add additional options to the guest kernel command "
11400 #: ../src/guestfs-actions.pod:4238 ../fish/guestfish-actions.pod:3279
11402 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
11403 "environment variable."
11407 #: ../src/guestfs-actions.pod:4241 ../fish/guestfish-actions.pod:3282
11409 "Setting C<append> to C<NULL> means I<no> additional options are passed "
11410 "(libguestfs always adds a few of its own)."
11414 #: ../src/guestfs-actions.pod:4246
11415 msgid "guestfs_set_autosync"
11419 #: ../src/guestfs-actions.pod:4248
11422 " int guestfs_set_autosync (guestfs_h *g,\n"
11423 "\t\tint autosync);\n"
11428 #: ../src/guestfs-actions.pod:4251
11430 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
11431 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
11432 "the handle is closed (also if the program exits without closing handles)."
11436 #: ../src/guestfs-actions.pod:4256 ../fish/guestfish-actions.pod:3296
11438 "This is disabled by default (except in guestfish where it is enabled by "
11443 #: ../src/guestfs-actions.pod:4261
11444 msgid "guestfs_set_direct"
11448 #: ../src/guestfs-actions.pod:4263
11451 " int guestfs_set_direct (guestfs_h *g,\n"
11452 "\t\tint direct);\n"
11457 #: ../src/guestfs-actions.pod:4266 ../fish/guestfish-actions.pod:3305
11459 "If the direct appliance mode flag is enabled, then stdin and stdout are "
11460 "passed directly through to the appliance once it is launched."
11464 #: ../src/guestfs-actions.pod:4270
11466 "One consequence of this is that log messages aren't caught by the library "
11467 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
11472 #: ../src/guestfs-actions.pod:4274 ../fish/guestfish-actions.pod:3313
11473 msgid "You probably don't want to use this unless you know what you are doing."
11477 #: ../src/guestfs-actions.pod:4277 ../fish/guestfish-actions.pod:3316
11478 msgid "The default is disabled."
11482 #: ../src/guestfs-actions.pod:4281
11483 msgid "guestfs_set_e2label"
11487 #: ../src/guestfs-actions.pod:4283
11490 " int guestfs_set_e2label (guestfs_h *g,\n"
11491 "\t\tconst char *device,\n"
11492 "\t\tconst char *label);\n"
11497 #: ../src/guestfs-actions.pod:4287 ../fish/guestfish-actions.pod:3322
11499 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
11500 "C<label>. Filesystem labels are limited to 16 characters."
11504 #: ../src/guestfs-actions.pod:4291
11506 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
11507 "the existing label on a filesystem."
11511 #: ../src/guestfs-actions.pod:4296
11512 msgid "guestfs_set_e2uuid"
11516 #: ../src/guestfs-actions.pod:4298
11519 " int guestfs_set_e2uuid (guestfs_h *g,\n"
11520 "\t\tconst char *device,\n"
11521 "\t\tconst char *uuid);\n"
11526 #: ../src/guestfs-actions.pod:4302 ../fish/guestfish-actions.pod:3333
11528 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
11529 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
11530 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
11534 #: ../src/guestfs-actions.pod:4307
11536 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
11537 "the existing UUID of a filesystem."
11541 #: ../src/guestfs-actions.pod:4312
11542 msgid "guestfs_set_memsize"
11546 #: ../src/guestfs-actions.pod:4314
11549 " int guestfs_set_memsize (guestfs_h *g,\n"
11550 "\t\tint memsize);\n"
11555 #: ../src/guestfs-actions.pod:4317
11557 "This sets the memory size in megabytes allocated to the qemu subprocess. "
11558 "This only has any effect if called before C<guestfs_launch>."
11562 #: ../src/guestfs-actions.pod:4321 ../fish/guestfish-actions.pod:3351
11564 "You can also change this by setting the environment variable "
11565 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
11569 #: ../src/guestfs-actions.pod:4330
11570 msgid "guestfs_set_network"
11574 #: ../src/guestfs-actions.pod:4332
11577 " int guestfs_set_network (guestfs_h *g,\n"
11578 "\t\tint network);\n"
11583 #: ../src/guestfs-actions.pod:4335 ../fish/guestfish-actions.pod:3364
11585 "If C<network> is true, then the network is enabled in the libguestfs "
11586 "appliance. The default is false."
11590 #: ../src/guestfs-actions.pod:4338 ../fish/guestfish-actions.pod:3367
11592 "This affects whether commands are able to access the network (see L<guestfs"
11593 "(3)/RUNNING COMMANDS>)."
11597 #: ../src/guestfs-actions.pod:4341
11599 "You must call this before calling C<guestfs_launch>, otherwise it has no "
11604 #: ../src/guestfs-actions.pod:4346
11605 msgid "guestfs_set_path"
11609 #: ../src/guestfs-actions.pod:4348
11612 " int guestfs_set_path (guestfs_h *g,\n"
11613 "\t\tconst char *searchpath);\n"
11618 #: ../src/guestfs-actions.pod:4351 ../fish/guestfish-actions.pod:3379
11619 msgid "Set the path that libguestfs searches for kernel and initrd.img."
11623 #: ../src/guestfs-actions.pod:4353 ../fish/guestfish-actions.pod:3381
11625 "The default is C<$libdir/guestfs> unless overridden by setting "
11626 "C<LIBGUESTFS_PATH> environment variable."
11630 #: ../src/guestfs-actions.pod:4356 ../fish/guestfish-actions.pod:3384
11631 msgid "Setting C<path> to C<NULL> restores the default path."
11635 #: ../src/guestfs-actions.pod:4360
11636 msgid "guestfs_set_qemu"
11640 #: ../src/guestfs-actions.pod:4362
11643 " int guestfs_set_qemu (guestfs_h *g,\n"
11644 "\t\tconst char *qemu);\n"
11649 #: ../src/guestfs-actions.pod:4365 ../fish/guestfish-actions.pod:3392
11650 msgid "Set the qemu binary that we will use."
11654 #: ../src/guestfs-actions.pod:4367 ../fish/guestfish-actions.pod:3394
11656 "The default is chosen when the library was compiled by the configure script."
11660 #: ../src/guestfs-actions.pod:4370 ../fish/guestfish-actions.pod:3397
11662 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
11667 #: ../src/guestfs-actions.pod:4373 ../fish/guestfish-actions.pod:3400
11668 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
11672 #: ../src/guestfs-actions.pod:4375 ../fish/guestfish-actions.pod:3402
11674 "Note that you should call this function as early as possible after creating "
11675 "the handle. This is because some pre-launch operations depend on testing "
11676 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
11677 "don't retest features, and so you might see inconsistent results. Using the "
11678 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
11679 "the qemu binary at the same time as the handle is created."
11683 #: ../src/guestfs-actions.pod:4385
11684 msgid "guestfs_set_recovery_proc"
11688 #: ../src/guestfs-actions.pod:4387
11691 " int guestfs_set_recovery_proc (guestfs_h *g,\n"
11692 "\t\tint recoveryproc);\n"
11697 #: ../src/guestfs-actions.pod:4390
11699 "If this is called with the parameter C<false> then C<guestfs_launch> does "
11700 "not create a recovery process. The purpose of the recovery process is to "
11701 "stop runaway qemu processes in the case where the main program aborts "
11706 #: ../src/guestfs-actions.pod:4395
11708 "This only has any effect if called before C<guestfs_launch>, and the default "
11713 #: ../src/guestfs-actions.pod:4398 ../fish/guestfish-actions.pod:3424
11715 "About the only time when you would want to disable this is if the main "
11716 "process will fork itself into the background (\"daemonize\" itself). In "
11717 "this case the recovery process thinks that the main program has disappeared "
11718 "and so kills qemu, which is not very helpful."
11722 #: ../src/guestfs-actions.pod:4406
11723 msgid "guestfs_set_selinux"
11727 #: ../src/guestfs-actions.pod:4408
11730 " int guestfs_set_selinux (guestfs_h *g,\n"
11731 "\t\tint selinux);\n"
11736 #: ../src/guestfs-actions.pod:4411 ../fish/guestfish-actions.pod:3436
11738 "This sets the selinux flag that is passed to the appliance at boot time. "
11739 "The default is C<selinux=0> (disabled)."
11743 #: ../src/guestfs-actions.pod:4414 ../fish/guestfish-actions.pod:3439
11745 "Note that if SELinux is enabled, it is always in Permissive mode "
11746 "(C<enforcing=0>)."
11750 #: ../src/guestfs-actions.pod:4422
11751 msgid "guestfs_set_trace"
11755 #: ../src/guestfs-actions.pod:4424
11758 " int guestfs_set_trace (guestfs_h *g,\n"
11759 "\t\tint trace);\n"
11764 #: ../src/guestfs-actions.pod:4427 ../fish/guestfish-actions.pod:3451
11766 "If the command trace flag is set to 1, then commands are printed on stderr "
11767 "before they are executed in a format which is very similar to the one used "
11768 "by guestfish. In other words, you can run a program with this enabled, and "
11769 "you will get out a script which you can feed to guestfish to perform the "
11770 "same set of actions."
11774 #: ../src/guestfs-actions.pod:4434 ../fish/guestfish-actions.pod:3458
11776 "If you want to trace C API calls into libguestfs (and other libraries) then "
11777 "possibly a better way is to use the external ltrace(1) command."
11781 #: ../src/guestfs-actions.pod:4438 ../fish/guestfish-actions.pod:3462
11783 "Command traces are disabled unless the environment variable "
11784 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
11788 #: ../src/guestfs-actions.pod:4443
11789 msgid "guestfs_set_verbose"
11793 #: ../src/guestfs-actions.pod:4445
11796 " int guestfs_set_verbose (guestfs_h *g,\n"
11797 "\t\tint verbose);\n"
11802 #: ../src/guestfs-actions.pod:4448 ../fish/guestfish-actions.pod:3471
11803 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
11807 #: ../src/guestfs-actions.pod:4450 ../fish/guestfish-actions.pod:3473
11809 "Verbose messages are disabled unless the environment variable "
11810 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
11814 #: ../src/guestfs-actions.pod:4455
11815 msgid "guestfs_setcon"
11819 #: ../src/guestfs-actions.pod:4457
11822 " int guestfs_setcon (guestfs_h *g,\n"
11823 "\t\tconst char *context);\n"
11828 #: ../src/guestfs-actions.pod:4460 ../fish/guestfish-actions.pod:3480
11830 "This sets the SELinux security context of the daemon to the string "
11835 #: ../src/guestfs-actions.pod:4463 ../fish/guestfish-actions.pod:3483
11836 msgid "See the documentation about SELINUX in L<guestfs(3)>."
11840 #: ../src/guestfs-actions.pod:4467
11841 msgid "guestfs_setxattr"
11845 #: ../src/guestfs-actions.pod:4469
11848 " int guestfs_setxattr (guestfs_h *g,\n"
11849 "\t\tconst char *xattr,\n"
11850 "\t\tconst char *val,\n"
11851 "\t\tint vallen,\n"
11852 "\t\tconst char *path);\n"
11857 #: ../src/guestfs-actions.pod:4475 ../fish/guestfish-actions.pod:3489
11859 "This call sets the extended attribute named C<xattr> of the file C<path> to "
11860 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
11864 #: ../src/guestfs-actions.pod:4479
11865 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
11869 #: ../src/guestfs-actions.pod:4483
11870 msgid "guestfs_sfdisk"
11874 #: ../src/guestfs-actions.pod:4485
11877 " int guestfs_sfdisk (guestfs_h *g,\n"
11878 "\t\tconst char *device,\n"
11881 "\t\tint sectors,\n"
11882 "\t\tchar *const *lines);\n"
11887 #: ../src/guestfs-actions.pod:4492 ../fish/guestfish-actions.pod:3499
11889 "This is a direct interface to the L<sfdisk(8)> program for creating "
11890 "partitions on block devices."
11894 #: ../src/guestfs-actions.pod:4495 ../fish/guestfish-actions.pod:3502
11895 msgid "C<device> should be a block device, for example C</dev/sda>."
11899 #: ../src/guestfs-actions.pod:4497 ../fish/guestfish-actions.pod:3504
11901 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
11902 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
11903 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
11904 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
11905 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
11906 "the kernel) cannot work out the right geometry and you will need to tell it."
11910 #: ../src/guestfs-actions.pod:4505 ../fish/guestfish-actions.pod:3512
11912 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
11913 "refer to the L<sfdisk(8)> manpage."
11917 #: ../src/guestfs-actions.pod:4508 ../fish/guestfish-actions.pod:3515
11919 "To create a single partition occupying the whole disk, you would pass "
11920 "C<lines> as a single element list, when the single element being the string "
11925 #: ../src/guestfs-actions.pod:4512
11927 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
11931 #: ../src/guestfs-actions.pod:4520
11932 msgid "guestfs_sfdiskM"
11936 #: ../src/guestfs-actions.pod:4522
11939 " int guestfs_sfdiskM (guestfs_h *g,\n"
11940 "\t\tconst char *device,\n"
11941 "\t\tchar *const *lines);\n"
11946 #: ../src/guestfs-actions.pod:4526
11948 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
11949 "partition sizes are specified in megabytes only (rounded to the nearest "
11950 "cylinder) and you don't need to specify the cyls, heads and sectors "
11951 "parameters which were rarely if ever used anyway."
11955 #: ../src/guestfs-actions.pod:4532
11957 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
11958 "C<guestfs_part_disk>"
11962 #: ../src/guestfs-actions.pod:4540
11963 msgid "guestfs_sfdisk_N"
11967 #: ../src/guestfs-actions.pod:4542
11970 " int guestfs_sfdisk_N (guestfs_h *g,\n"
11971 "\t\tconst char *device,\n"
11972 "\t\tint partnum,\n"
11975 "\t\tint sectors,\n"
11976 "\t\tconst char *line);\n"
11981 #: ../src/guestfs-actions.pod:4550 ../fish/guestfish-actions.pod:3545
11983 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
11984 "(note: C<n> counts from 1)."
11988 #: ../src/guestfs-actions.pod:4553
11990 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
11991 "for the cyls/heads/sectors parameters."
11995 #: ../src/guestfs-actions.pod:4556
11996 msgid "See also: C<guestfs_part_add>"
12000 #: ../src/guestfs-actions.pod:4563
12001 msgid "guestfs_sfdisk_disk_geometry"
12005 #: ../src/guestfs-actions.pod:4565
12008 " char *guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
12009 "\t\tconst char *device);\n"
12014 #: ../src/guestfs-actions.pod:4568
12016 "This displays the disk geometry of C<device> read from the partition table. "
12017 "Especially in the case where the underlying block device has been resized, "
12018 "this can be different from the kernel's idea of the geometry (see "
12019 "C<guestfs_sfdisk_kernel_geometry>)."
12023 #: ../src/guestfs-actions.pod:4573 ../src/guestfs-actions.pod:4586
12024 #: ../fish/guestfish-actions.pod:3565 ../fish/guestfish-actions.pod:3574
12025 msgid "The result is in human-readable format, and not designed to be parsed."
12029 #: ../src/guestfs-actions.pod:4579
12030 msgid "guestfs_sfdisk_kernel_geometry"
12034 #: ../src/guestfs-actions.pod:4581
12037 " char *guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
12038 "\t\tconst char *device);\n"
12043 #: ../src/guestfs-actions.pod:4584 ../fish/guestfish-actions.pod:3572
12044 msgid "This displays the kernel's idea of the geometry of C<device>."
12048 #: ../src/guestfs-actions.pod:4592
12049 msgid "guestfs_sfdisk_l"
12053 #: ../src/guestfs-actions.pod:4594
12056 " char *guestfs_sfdisk_l (guestfs_h *g,\n"
12057 "\t\tconst char *device);\n"
12062 #: ../src/guestfs-actions.pod:4597 ../fish/guestfish-actions.pod:3581
12064 "This displays the partition table on C<device>, in the human-readable output "
12065 "of the L<sfdisk(8)> command. It is not intended to be parsed."
12069 #: ../src/guestfs-actions.pod:4601
12070 msgid "See also: C<guestfs_part_list>"
12074 #: ../src/guestfs-actions.pod:4606
12079 #: ../src/guestfs-actions.pod:4608
12082 " char *guestfs_sh (guestfs_h *g,\n"
12083 "\t\tconst char *command);\n"
12088 #: ../src/guestfs-actions.pod:4611 ../fish/guestfish-actions.pod:3591
12090 "This call runs a command from the guest filesystem via the guest's C</bin/"
12095 #: ../src/guestfs-actions.pod:4614
12096 msgid "This is like C<guestfs_command>, but passes the command to:"
12100 #: ../src/guestfs-actions.pod:4616 ../fish/guestfish-actions.pod:3596
12103 " /bin/sh -c \"command\"\n"
12108 #: ../src/guestfs-actions.pod:4618 ../fish/guestfish-actions.pod:3598
12110 "Depending on the guest's shell, this usually results in wildcards being "
12111 "expanded, shell expressions being interpolated and so on."
12115 #: ../src/guestfs-actions.pod:4622
12116 msgid "All the provisos about C<guestfs_command> apply to this call."
12120 #: ../src/guestfs-actions.pod:4627
12121 msgid "guestfs_sh_lines"
12125 #: ../src/guestfs-actions.pod:4629
12128 " char **guestfs_sh_lines (guestfs_h *g,\n"
12129 "\t\tconst char *command);\n"
12134 #: ../src/guestfs-actions.pod:4632
12136 "This is the same as C<guestfs_sh>, but splits the result into a list of "
12141 #: ../src/guestfs-actions.pod:4635
12142 msgid "See also: C<guestfs_command_lines>"
12146 #: ../src/guestfs-actions.pod:4641
12147 msgid "guestfs_sleep"
12151 #: ../src/guestfs-actions.pod:4643
12154 " int guestfs_sleep (guestfs_h *g,\n"
12160 #: ../src/guestfs-actions.pod:4646 ../fish/guestfish-actions.pod:3617
12161 msgid "Sleep for C<secs> seconds."
12165 #: ../src/guestfs-actions.pod:4650 ../src/guestfs-structs.pod:109
12166 msgid "guestfs_stat"
12170 #: ../src/guestfs-actions.pod:4652
12173 " struct guestfs_stat *guestfs_stat (guestfs_h *g,\n"
12174 "\t\tconst char *path);\n"
12179 #: ../src/guestfs-actions.pod:4657 ../fish/guestfish-actions.pod:3625
12180 msgid "This is the same as the C<stat(2)> system call."
12184 #: ../src/guestfs-actions.pod:4663 ../src/guestfs-structs.pod:135
12185 msgid "guestfs_statvfs"
12189 #: ../src/guestfs-actions.pod:4665
12192 " struct guestfs_statvfs *guestfs_statvfs (guestfs_h *g,\n"
12193 "\t\tconst char *path);\n"
12198 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3631
12200 "Returns file system statistics for any mounted file system. C<path> should "
12201 "be a file or directory in the mounted file system (typically it is the mount "
12202 "point itself, but it doesn't need to be)."
12206 #: ../src/guestfs-actions.pod:4672 ../fish/guestfish-actions.pod:3635
12207 msgid "This is the same as the C<statvfs(2)> system call."
12211 #: ../src/guestfs-actions.pod:4674
12213 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
12214 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
12218 #: ../src/guestfs-actions.pod:4678
12219 msgid "guestfs_strings"
12223 #: ../src/guestfs-actions.pod:4680
12226 " char **guestfs_strings (guestfs_h *g,\n"
12227 "\t\tconst char *path);\n"
12232 #: ../src/guestfs-actions.pod:4683 ../fish/guestfish-actions.pod:3641
12234 "This runs the L<strings(1)> command on a file and returns the list of "
12235 "printable strings found."
12239 #: ../src/guestfs-actions.pod:4693
12240 msgid "guestfs_strings_e"
12244 #: ../src/guestfs-actions.pod:4695
12247 " char **guestfs_strings_e (guestfs_h *g,\n"
12248 "\t\tconst char *encoding,\n"
12249 "\t\tconst char *path);\n"
12254 #: ../src/guestfs-actions.pod:4699
12256 "This is like the C<guestfs_strings> command, but allows you to specify the "
12257 "encoding of strings that are looked for in the source file C<path>."
12261 #: ../src/guestfs-actions.pod:4703 ../fish/guestfish-actions.pod:3655
12262 msgid "Allowed encodings are:"
12266 #: ../src/guestfs-actions.pod:4707 ../fish/guestfish-actions.pod:3659
12271 #: ../src/guestfs-actions.pod:4709
12273 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
12274 "ISO-8859-X (this is what C<guestfs_strings> uses)."
12278 #: ../src/guestfs-actions.pod:4712 ../fish/guestfish-actions.pod:3664
12283 #: ../src/guestfs-actions.pod:4714 ../fish/guestfish-actions.pod:3666
12284 msgid "Single 8-bit-byte characters."
12288 #: ../src/guestfs-actions.pod:4716 ../fish/guestfish-actions.pod:3668
12293 #: ../src/guestfs-actions.pod:4718 ../fish/guestfish-actions.pod:3670
12294 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
12298 #: ../src/guestfs-actions.pod:4721 ../fish/guestfish-actions.pod:3673
12299 msgid "l (lower case letter L)"
12303 #: ../src/guestfs-actions.pod:4723 ../fish/guestfish-actions.pod:3675
12305 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
12306 "examining binaries in Windows guests."
12310 #: ../src/guestfs-actions.pod:4726 ../fish/guestfish-actions.pod:3678
12315 #: ../src/guestfs-actions.pod:4728 ../fish/guestfish-actions.pod:3680
12316 msgid "32-bit big endian such as UCS-4BE."
12320 #: ../src/guestfs-actions.pod:4730 ../fish/guestfish-actions.pod:3682
12325 #: ../src/guestfs-actions.pod:4732 ../fish/guestfish-actions.pod:3684
12326 msgid "32-bit little endian such as UCS-4LE."
12330 #: ../src/guestfs-actions.pod:4736 ../fish/guestfish-actions.pod:3688
12331 msgid "The returned strings are transcoded to UTF-8."
12335 #: ../src/guestfs-actions.pod:4745
12336 msgid "guestfs_swapoff_device"
12340 #: ../src/guestfs-actions.pod:4747
12343 " int guestfs_swapoff_device (guestfs_h *g,\n"
12344 "\t\tconst char *device);\n"
12349 #: ../src/guestfs-actions.pod:4750
12351 "This command disables the libguestfs appliance swap device or partition "
12352 "named C<device>. See C<guestfs_swapon_device>."
12356 #: ../src/guestfs-actions.pod:4756
12357 msgid "guestfs_swapoff_file"
12361 #: ../src/guestfs-actions.pod:4758
12364 " int guestfs_swapoff_file (guestfs_h *g,\n"
12365 "\t\tconst char *file);\n"
12370 #: ../src/guestfs-actions.pod:4761 ../fish/guestfish-actions.pod:3705
12371 msgid "This command disables the libguestfs appliance swap on file."
12375 #: ../src/guestfs-actions.pod:4765
12376 msgid "guestfs_swapoff_label"
12380 #: ../src/guestfs-actions.pod:4767
12383 " int guestfs_swapoff_label (guestfs_h *g,\n"
12384 "\t\tconst char *label);\n"
12389 #: ../src/guestfs-actions.pod:4770 ../fish/guestfish-actions.pod:3711
12391 "This command disables the libguestfs appliance swap on labeled swap "
12396 #: ../src/guestfs-actions.pod:4775
12397 msgid "guestfs_swapoff_uuid"
12401 #: ../src/guestfs-actions.pod:4777
12404 " int guestfs_swapoff_uuid (guestfs_h *g,\n"
12405 "\t\tconst char *uuid);\n"
12410 #: ../src/guestfs-actions.pod:4780 ../fish/guestfish-actions.pod:3718
12412 "This command disables the libguestfs appliance swap partition with the given "
12417 #: ../src/guestfs-actions.pod:4785
12418 msgid "guestfs_swapon_device"
12422 #: ../src/guestfs-actions.pod:4787
12425 " int guestfs_swapon_device (guestfs_h *g,\n"
12426 "\t\tconst char *device);\n"
12431 #: ../src/guestfs-actions.pod:4790
12433 "This command enables the libguestfs appliance to use the swap device or "
12434 "partition named C<device>. The increased memory is made available for all "
12435 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
12439 #: ../src/guestfs-actions.pod:4795 ../fish/guestfish-actions.pod:3730
12441 "Note that you should not swap to existing guest swap partitions unless you "
12442 "know what you are doing. They may contain hibernation information, or other "
12443 "information that the guest doesn't want you to trash. You also risk leaking "
12444 "information about the host to the guest this way. Instead, attach a new "
12445 "host device to the guest and swap on that."
12449 #: ../src/guestfs-actions.pod:4804
12450 msgid "guestfs_swapon_file"
12454 #: ../src/guestfs-actions.pod:4806
12457 " int guestfs_swapon_file (guestfs_h *g,\n"
12458 "\t\tconst char *file);\n"
12463 #: ../src/guestfs-actions.pod:4809
12465 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
12470 #: ../src/guestfs-actions.pod:4814
12471 msgid "guestfs_swapon_label"
12475 #: ../src/guestfs-actions.pod:4816
12478 " int guestfs_swapon_label (guestfs_h *g,\n"
12479 "\t\tconst char *label);\n"
12484 #: ../src/guestfs-actions.pod:4819
12486 "This command enables swap to a labeled swap partition. See "
12487 "C<guestfs_swapon_device> for other notes."
12491 #: ../src/guestfs-actions.pod:4824
12492 msgid "guestfs_swapon_uuid"
12496 #: ../src/guestfs-actions.pod:4826
12499 " int guestfs_swapon_uuid (guestfs_h *g,\n"
12500 "\t\tconst char *uuid);\n"
12505 #: ../src/guestfs-actions.pod:4829
12507 "This command enables swap to a swap partition with the given UUID. See "
12508 "C<guestfs_swapon_device> for other notes."
12512 #: ../src/guestfs-actions.pod:4834
12513 msgid "guestfs_sync"
12517 #: ../src/guestfs-actions.pod:4836
12520 " int guestfs_sync (guestfs_h *g);\n"
12525 #: ../src/guestfs-actions.pod:4838 ../fish/guestfish-actions.pod:3762
12527 "This syncs the disk, so that any writes are flushed through to the "
12528 "underlying disk image."
12532 #: ../src/guestfs-actions.pod:4841 ../fish/guestfish-actions.pod:3765
12534 "You should always call this if you have modified a disk image, before "
12535 "closing the handle."
12539 #: ../src/guestfs-actions.pod:4846
12540 msgid "guestfs_tail"
12544 #: ../src/guestfs-actions.pod:4848
12547 " char **guestfs_tail (guestfs_h *g,\n"
12548 "\t\tconst char *path);\n"
12553 #: ../src/guestfs-actions.pod:4851 ../fish/guestfish-actions.pod:3772
12555 "This command returns up to the last 10 lines of a file as a list of strings."
12559 #: ../src/guestfs-actions.pod:4861
12560 msgid "guestfs_tail_n"
12564 #: ../src/guestfs-actions.pod:4863
12567 " char **guestfs_tail_n (guestfs_h *g,\n"
12568 "\t\tint nrlines,\n"
12569 "\t\tconst char *path);\n"
12574 #: ../src/guestfs-actions.pod:4867 ../fish/guestfish-actions.pod:3782
12576 "If the parameter C<nrlines> is a positive number, this returns the last "
12577 "C<nrlines> lines of the file C<path>."
12581 #: ../src/guestfs-actions.pod:4870 ../fish/guestfish-actions.pod:3785
12583 "If the parameter C<nrlines> is a negative number, this returns lines from "
12584 "the file C<path>, starting with the C<-nrlines>th line."
12588 #: ../src/guestfs-actions.pod:4882
12589 msgid "guestfs_tar_in"
12593 #: ../src/guestfs-actions.pod:4884
12596 " int guestfs_tar_in (guestfs_h *g,\n"
12597 "\t\tconst char *tarfile,\n"
12598 "\t\tconst char *directory);\n"
12603 #: ../src/guestfs-actions.pod:4888 ../fish/guestfish-actions.pod:3797
12605 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
12606 "tar file) into C<directory>."
12610 #: ../src/guestfs-actions.pod:4891
12612 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
12616 #: ../src/guestfs-actions.pod:4896
12617 msgid "guestfs_tar_out"
12621 #: ../src/guestfs-actions.pod:4898
12624 " int guestfs_tar_out (guestfs_h *g,\n"
12625 "\t\tconst char *directory,\n"
12626 "\t\tconst char *tarfile);\n"
12631 #: ../src/guestfs-actions.pod:4902 ../fish/guestfish-actions.pod:3809
12633 "This command packs the contents of C<directory> and downloads it to local "
12638 #: ../src/guestfs-actions.pod:4905
12640 "To download a compressed tarball, use C<guestfs_tgz_out> or "
12641 "C<guestfs_txz_out>."
12645 #: ../src/guestfs-actions.pod:4910
12646 msgid "guestfs_tgz_in"
12650 #: ../src/guestfs-actions.pod:4912
12653 " int guestfs_tgz_in (guestfs_h *g,\n"
12654 "\t\tconst char *tarball,\n"
12655 "\t\tconst char *directory);\n"
12660 #: ../src/guestfs-actions.pod:4916 ../fish/guestfish-actions.pod:3821
12662 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
12663 "tar file) into C<directory>."
12667 #: ../src/guestfs-actions.pod:4919
12668 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
12672 #: ../src/guestfs-actions.pod:4923
12673 msgid "guestfs_tgz_out"
12677 #: ../src/guestfs-actions.pod:4925
12680 " int guestfs_tgz_out (guestfs_h *g,\n"
12681 "\t\tconst char *directory,\n"
12682 "\t\tconst char *tarball);\n"
12687 #: ../src/guestfs-actions.pod:4929 ../fish/guestfish-actions.pod:3832
12689 "This command packs the contents of C<directory> and downloads it to local "
12694 #: ../src/guestfs-actions.pod:4932
12695 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
12699 #: ../src/guestfs-actions.pod:4936
12700 msgid "guestfs_touch"
12704 #: ../src/guestfs-actions.pod:4938
12707 " int guestfs_touch (guestfs_h *g,\n"
12708 "\t\tconst char *path);\n"
12713 #: ../src/guestfs-actions.pod:4941 ../fish/guestfish-actions.pod:3843
12715 "Touch acts like the L<touch(1)> command. It can be used to update the "
12716 "timestamps on a file, or, if the file does not exist, to create a new zero-"
12721 #: ../src/guestfs-actions.pod:4945 ../fish/guestfish-actions.pod:3847
12723 "This command only works on regular files, and will fail on other file types "
12724 "such as directories, symbolic links, block special etc."
12728 #: ../src/guestfs-actions.pod:4950
12729 msgid "guestfs_truncate"
12733 #: ../src/guestfs-actions.pod:4952
12736 " int guestfs_truncate (guestfs_h *g,\n"
12737 "\t\tconst char *path);\n"
12742 #: ../src/guestfs-actions.pod:4955 ../fish/guestfish-actions.pod:3854
12744 "This command truncates C<path> to a zero-length file. The file must exist "
12749 #: ../src/guestfs-actions.pod:4960
12750 msgid "guestfs_truncate_size"
12754 #: ../src/guestfs-actions.pod:4962
12757 " int guestfs_truncate_size (guestfs_h *g,\n"
12758 "\t\tconst char *path,\n"
12759 "\t\tint64_t size);\n"
12764 #: ../src/guestfs-actions.pod:4966 ../fish/guestfish-actions.pod:3861
12766 "This command truncates C<path> to size C<size> bytes. The file must exist "
12771 #: ../src/guestfs-actions.pod:4969
12773 "If the current file size is less than C<size> then the file is extended to "
12774 "the required size with zero bytes. This creates a sparse file (ie. disk "
12775 "blocks are not allocated for the file until you write to it). To create a "
12776 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
12780 #: ../src/guestfs-actions.pod:4977
12781 msgid "guestfs_tune2fs_l"
12785 #: ../src/guestfs-actions.pod:4979
12788 " char **guestfs_tune2fs_l (guestfs_h *g,\n"
12789 "\t\tconst char *device);\n"
12794 #: ../src/guestfs-actions.pod:4982 ../fish/guestfish-actions.pod:3874
12796 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
12801 #: ../src/guestfs-actions.pod:4985 ../fish/guestfish-actions.pod:3877
12803 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
12804 "for more details. The list of fields returned isn't clearly defined, and "
12805 "depends on both the version of C<tune2fs> that libguestfs was built against, "
12806 "and the filesystem itself."
12810 #: ../src/guestfs-actions.pod:4996
12811 msgid "guestfs_txz_in"
12815 #: ../src/guestfs-actions.pod:4998
12818 " int guestfs_txz_in (guestfs_h *g,\n"
12819 "\t\tconst char *tarball,\n"
12820 "\t\tconst char *directory);\n"
12825 #: ../src/guestfs-actions.pod:5002 ../fish/guestfish-actions.pod:3886
12827 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
12828 "tar file) into C<directory>."
12832 #: ../src/guestfs-actions.pod:5007
12833 msgid "guestfs_txz_out"
12837 #: ../src/guestfs-actions.pod:5009
12840 " int guestfs_txz_out (guestfs_h *g,\n"
12841 "\t\tconst char *directory,\n"
12842 "\t\tconst char *tarball);\n"
12847 #: ../src/guestfs-actions.pod:5013 ../fish/guestfish-actions.pod:3895
12849 "This command packs the contents of C<directory> and downloads it to local "
12850 "file C<tarball> (as an xz compressed tar archive)."
12854 #: ../src/guestfs-actions.pod:5018
12855 msgid "guestfs_umask"
12859 #: ../src/guestfs-actions.pod:5020
12862 " int guestfs_umask (guestfs_h *g,\n"
12868 #: ../src/guestfs-actions.pod:5023 ../fish/guestfish-actions.pod:3904
12870 "This function sets the mask used for creating new files and device nodes to "
12875 #: ../src/guestfs-actions.pod:5026 ../fish/guestfish-actions.pod:3907
12877 "Typical umask values would be C<022> which creates new files with "
12878 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
12879 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
12883 #: ../src/guestfs-actions.pod:5031 ../fish/guestfish-actions.pod:3912
12885 "The default umask is C<022>. This is important because it means that "
12886 "directories and device nodes will be created with C<0644> or C<0755> mode "
12887 "even if you specify C<0777>."
12891 #: ../src/guestfs-actions.pod:5035
12893 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
12894 "C<guestfs_mkdir>."
12898 #: ../src/guestfs-actions.pod:5038 ../fish/guestfish-actions.pod:3919
12899 msgid "This call returns the previous umask."
12903 #: ../src/guestfs-actions.pod:5042
12904 msgid "guestfs_umount"
12908 #: ../src/guestfs-actions.pod:5044
12911 " int guestfs_umount (guestfs_h *g,\n"
12912 "\t\tconst char *pathordevice);\n"
12917 #: ../src/guestfs-actions.pod:5047 ../fish/guestfish-actions.pod:3927
12919 "This unmounts the given filesystem. The filesystem may be specified either "
12920 "by its mountpoint (path) or the device which contains the filesystem."
12924 #: ../src/guestfs-actions.pod:5053
12925 msgid "guestfs_umount_all"
12929 #: ../src/guestfs-actions.pod:5055
12932 " int guestfs_umount_all (guestfs_h *g);\n"
12937 #: ../src/guestfs-actions.pod:5057 ../fish/guestfish-actions.pod:3937
12938 msgid "This unmounts all mounted filesystems."
12942 #: ../src/guestfs-actions.pod:5059 ../fish/guestfish-actions.pod:3939
12943 msgid "Some internal mounts are not unmounted by this call."
12947 #: ../src/guestfs-actions.pod:5063
12948 msgid "guestfs_upload"
12952 #: ../src/guestfs-actions.pod:5065
12955 " int guestfs_upload (guestfs_h *g,\n"
12956 "\t\tconst char *filename,\n"
12957 "\t\tconst char *remotefilename);\n"
12962 #: ../src/guestfs-actions.pod:5069 ../src/guestfs-actions.pod:5085
12963 #: ../fish/guestfish-actions.pod:3945 ../fish/guestfish-actions.pod:3958
12964 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
12968 #: ../src/guestfs-actions.pod:5074
12969 msgid "See also C<guestfs_download>."
12973 #: ../src/guestfs-actions.pod:5078
12974 msgid "guestfs_upload_offset"
12978 #: ../src/guestfs-actions.pod:5080
12981 " int guestfs_upload_offset (guestfs_h *g,\n"
12982 "\t\tconst char *filename,\n"
12983 "\t\tconst char *remotefilename,\n"
12984 "\t\tint64_t offset);\n"
12989 #: ../src/guestfs-actions.pod:5088 ../fish/guestfish-actions.pod:3961
12991 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
12992 "The intention is to overwrite parts of existing files or devices, although "
12993 "if a non-existant file is specified then it is created with a \"hole\" "
12994 "before C<offset>. The size of the data written is implicit in the size of "
12995 "the source C<filename>."
12999 #: ../src/guestfs-actions.pod:5095
13001 "Note that there is no limit on the amount of data that can be uploaded with "
13002 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
13003 "full amount unless an error occurs."
13007 #: ../src/guestfs-actions.pod:5100
13008 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
13012 #: ../src/guestfs-actions.pod:5104
13013 msgid "guestfs_utimens"
13017 #: ../src/guestfs-actions.pod:5106
13020 " int guestfs_utimens (guestfs_h *g,\n"
13021 "\t\tconst char *path,\n"
13022 "\t\tint64_t atsecs,\n"
13023 "\t\tint64_t atnsecs,\n"
13024 "\t\tint64_t mtsecs,\n"
13025 "\t\tint64_t mtnsecs);\n"
13030 #: ../src/guestfs-actions.pod:5113 ../fish/guestfish-actions.pod:3981
13031 msgid "This command sets the timestamps of a file with nanosecond precision."
13035 #: ../src/guestfs-actions.pod:5116 ../fish/guestfish-actions.pod:3984
13037 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
13042 #: ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3987
13044 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
13045 "nanoseconds from the epoch."
13049 #: ../src/guestfs-actions.pod:5122 ../fish/guestfish-actions.pod:3990
13051 "If the C<*nsecs> field contains the special value C<-1> then the "
13052 "corresponding timestamp is set to the current time. (The C<*secs> field is "
13053 "ignored in this case)."
13057 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3994
13059 "If the C<*nsecs> field contains the special value C<-2> then the "
13060 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
13065 #: ../src/guestfs-actions.pod:5132 ../src/guestfs-structs.pod:175
13066 msgid "guestfs_version"
13070 #: ../src/guestfs-actions.pod:5134
13073 " struct guestfs_version *guestfs_version (guestfs_h *g);\n"
13078 #: ../src/guestfs-actions.pod:5136 ../fish/guestfish-actions.pod:4002
13080 "Return the libguestfs version number that the program is linked against."
13084 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:4005
13086 "Note that because of dynamic linking this is not necessarily the version of "
13087 "libguestfs that you compiled against. You can compile the program, and then "
13088 "at runtime dynamically link against a completely different C<libguestfs.so> "
13093 #: ../src/guestfs-actions.pod:5144 ../fish/guestfish-actions.pod:4010
13095 "This call was added in version C<1.0.58>. In previous versions of "
13096 "libguestfs there was no way to get the version number. From C code you can "
13097 "use dynamic linker functions to find out if this symbol exists (if it "
13098 "doesn't, then it's an earlier version)."
13102 #: ../src/guestfs-actions.pod:5150 ../fish/guestfish-actions.pod:4016
13104 "The call returns a structure with four elements. The first three (C<major>, "
13105 "C<minor> and C<release>) are numbers and correspond to the usual version "
13106 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
13107 "but may be used for distro-specific information."
13111 #: ../src/guestfs-actions.pod:5156 ../fish/guestfish-actions.pod:4022
13113 "To construct the original version string: C<$major.$minor.$release$extra>"
13117 #: ../src/guestfs-actions.pod:5159 ../fish/guestfish-actions.pod:4025
13118 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
13122 #: ../src/guestfs-actions.pod:5161
13124 "I<Note:> Don't use this call to test for availability of features. In "
13125 "enterprise distributions we backport features from later versions into "
13126 "earlier versions, making this an unreliable way to test for features. Use "
13127 "C<guestfs_available> instead."
13131 #: ../src/guestfs-actions.pod:5167
13133 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
13134 "error. I<The caller must call C<guestfs_free_version> after use>."
13138 #: ../src/guestfs-actions.pod:5171
13139 msgid "guestfs_vfs_label"
13143 #: ../src/guestfs-actions.pod:5173
13146 " char *guestfs_vfs_label (guestfs_h *g,\n"
13147 "\t\tconst char *device);\n"
13152 #: ../src/guestfs-actions.pod:5176 ../fish/guestfish-actions.pod:4037
13153 msgid "This returns the filesystem label of the filesystem on C<device>."
13157 #: ../src/guestfs-actions.pod:5179 ../fish/guestfish-actions.pod:4040
13158 msgid "If the filesystem is unlabeled, this returns the empty string."
13162 #: ../src/guestfs-actions.pod:5181
13163 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
13167 #: ../src/guestfs-actions.pod:5186
13168 msgid "guestfs_vfs_type"
13172 #: ../src/guestfs-actions.pod:5188
13175 " char *guestfs_vfs_type (guestfs_h *g,\n"
13176 "\t\tconst char *device);\n"
13181 #: ../src/guestfs-actions.pod:5191 ../fish/guestfish-actions.pod:4048
13183 "This command gets the filesystem type corresponding to the filesystem on "
13188 #: ../src/guestfs-actions.pod:5194 ../fish/guestfish-actions.pod:4051
13190 "For most filesystems, the result is the name of the Linux VFS module which "
13191 "would be used to mount this filesystem if you mounted it without specifying "
13192 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
13196 #: ../src/guestfs-actions.pod:5202
13197 msgid "guestfs_vfs_uuid"
13201 #: ../src/guestfs-actions.pod:5204
13204 " char *guestfs_vfs_uuid (guestfs_h *g,\n"
13205 "\t\tconst char *device);\n"
13210 #: ../src/guestfs-actions.pod:5207 ../fish/guestfish-actions.pod:4060
13211 msgid "This returns the filesystem UUID of the filesystem on C<device>."
13215 #: ../src/guestfs-actions.pod:5210 ../fish/guestfish-actions.pod:4063
13216 msgid "If the filesystem does not have a UUID, this returns the empty string."
13220 #: ../src/guestfs-actions.pod:5212
13221 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
13225 #: ../src/guestfs-actions.pod:5217
13226 msgid "guestfs_vg_activate"
13230 #: ../src/guestfs-actions.pod:5219
13233 " int guestfs_vg_activate (guestfs_h *g,\n"
13234 "\t\tint activate,\n"
13235 "\t\tchar *const *volgroups);\n"
13240 #: ../src/guestfs-actions.pod:5223 ../fish/guestfish-actions.pod:4071
13242 "This command activates or (if C<activate> is false) deactivates all logical "
13243 "volumes in the listed volume groups C<volgroups>. If activated, then they "
13244 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
13245 "deactivated, then those devices disappear."
13249 #: ../src/guestfs-actions.pod:5229 ../fish/guestfish-actions.pod:4077
13250 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
13254 #: ../src/guestfs-actions.pod:5231 ../fish/guestfish-actions.pod:4079
13256 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
13257 "activated or deactivated."
13261 #: ../src/guestfs-actions.pod:5236
13262 msgid "guestfs_vg_activate_all"
13266 #: ../src/guestfs-actions.pod:5238
13269 " int guestfs_vg_activate_all (guestfs_h *g,\n"
13270 "\t\tint activate);\n"
13275 #: ../src/guestfs-actions.pod:5241 ../fish/guestfish-actions.pod:4086
13277 "This command activates or (if C<activate> is false) deactivates all logical "
13278 "volumes in all volume groups. If activated, then they are made known to the "
13279 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
13280 "those devices disappear."
13284 #: ../src/guestfs-actions.pod:5247 ../fish/guestfish-actions.pod:4092
13285 msgid "This command is the same as running C<vgchange -a y|n>"
13289 #: ../src/guestfs-actions.pod:5251
13290 msgid "guestfs_vgcreate"
13294 #: ../src/guestfs-actions.pod:5253
13297 " int guestfs_vgcreate (guestfs_h *g,\n"
13298 "\t\tconst char *volgroup,\n"
13299 "\t\tchar *const *physvols);\n"
13304 #: ../src/guestfs-actions.pod:5257 ../fish/guestfish-actions.pod:4098
13306 "This creates an LVM volume group called C<volgroup> from the non-empty list "
13307 "of physical volumes C<physvols>."
13311 #: ../src/guestfs-actions.pod:5262
13312 msgid "guestfs_vglvuuids"
13316 #: ../src/guestfs-actions.pod:5264
13319 " char **guestfs_vglvuuids (guestfs_h *g,\n"
13320 "\t\tconst char *vgname);\n"
13325 #: ../src/guestfs-actions.pod:5267 ../fish/guestfish-actions.pod:4105
13327 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
13328 "volumes created in this volume group."
13332 #: ../src/guestfs-actions.pod:5270
13334 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
13335 "associate logical volumes and volume groups."
13339 #: ../src/guestfs-actions.pod:5273
13340 msgid "See also C<guestfs_vgpvuuids>."
13344 #: ../src/guestfs-actions.pod:5279
13345 msgid "guestfs_vgpvuuids"
13349 #: ../src/guestfs-actions.pod:5281
13352 " char **guestfs_vgpvuuids (guestfs_h *g,\n"
13353 "\t\tconst char *vgname);\n"
13358 #: ../src/guestfs-actions.pod:5284 ../fish/guestfish-actions.pod:4117
13360 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
13361 "volumes that this volume group resides on."
13365 #: ../src/guestfs-actions.pod:5287
13367 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
13368 "associate physical volumes and volume groups."
13372 #: ../src/guestfs-actions.pod:5290
13373 msgid "See also C<guestfs_vglvuuids>."
13377 #: ../src/guestfs-actions.pod:5296
13378 msgid "guestfs_vgremove"
13382 #: ../src/guestfs-actions.pod:5298
13385 " int guestfs_vgremove (guestfs_h *g,\n"
13386 "\t\tconst char *vgname);\n"
13391 #: ../src/guestfs-actions.pod:5301 ../fish/guestfish-actions.pod:4129
13392 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
13396 #: ../src/guestfs-actions.pod:5303 ../fish/guestfish-actions.pod:4131
13398 "This also forcibly removes all logical volumes in the volume group (if any)."
13402 #: ../src/guestfs-actions.pod:5308
13403 msgid "guestfs_vgrename"
13407 #: ../src/guestfs-actions.pod:5310
13410 " int guestfs_vgrename (guestfs_h *g,\n"
13411 "\t\tconst char *volgroup,\n"
13412 "\t\tconst char *newvolgroup);\n"
13417 #: ../src/guestfs-actions.pod:5314 ../fish/guestfish-actions.pod:4138
13418 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
13422 #: ../src/guestfs-actions.pod:5318
13423 msgid "guestfs_vgs"
13427 #: ../src/guestfs-actions.pod:5320
13430 " char **guestfs_vgs (guestfs_h *g);\n"
13435 #: ../src/guestfs-actions.pod:5322 ../fish/guestfish-actions.pod:4144
13437 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
13442 #: ../src/guestfs-actions.pod:5325 ../fish/guestfish-actions.pod:4147
13444 "This returns a list of just the volume group names that were detected (eg. "
13449 #: ../src/guestfs-actions.pod:5328
13450 msgid "See also C<guestfs_vgs_full>."
13454 #: ../src/guestfs-actions.pod:5334
13455 msgid "guestfs_vgs_full"
13459 #: ../src/guestfs-actions.pod:5336
13462 " struct guestfs_lvm_vg_list *guestfs_vgs_full (guestfs_h *g);\n"
13467 #: ../src/guestfs-actions.pod:5338 ../fish/guestfish-actions.pod:4156
13469 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
13470 "> command. The \"full\" version includes all fields."
13474 #: ../src/guestfs-actions.pod:5341
13476 "This function returns a C<struct guestfs_lvm_vg_list *> (see E<lt>guestfs-"
13477 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
13478 "C<guestfs_free_lvm_vg_list> after use>."
13482 #: ../src/guestfs-actions.pod:5346
13483 msgid "guestfs_vgscan"
13487 #: ../src/guestfs-actions.pod:5348
13490 " int guestfs_vgscan (guestfs_h *g);\n"
13495 #: ../src/guestfs-actions.pod:5350 ../fish/guestfish-actions.pod:4163
13497 "This rescans all block devices and rebuilds the list of LVM physical "
13498 "volumes, volume groups and logical volumes."
13502 #: ../src/guestfs-actions.pod:5355
13503 msgid "guestfs_vguuid"
13507 #: ../src/guestfs-actions.pod:5357
13510 " char *guestfs_vguuid (guestfs_h *g,\n"
13511 "\t\tconst char *vgname);\n"
13516 #: ../src/guestfs-actions.pod:5360 ../fish/guestfish-actions.pod:4170
13517 msgid "This command returns the UUID of the LVM VG named C<vgname>."
13521 #: ../src/guestfs-actions.pod:5365
13522 msgid "guestfs_wait_ready"
13526 #: ../src/guestfs-actions.pod:5367
13529 " int guestfs_wait_ready (guestfs_h *g);\n"
13534 #: ../src/guestfs-actions.pod:5369
13535 msgid "This function is a no op."
13539 #: ../src/guestfs-actions.pod:5371
13541 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
13542 "calling C<guestfs_launch> to wait for the launch to complete. However this "
13543 "is no longer necessary because C<guestfs_launch> now does the waiting."
13547 #: ../src/guestfs-actions.pod:5376
13549 "If you see any calls to this function in code then you can just remove them, "
13550 "unless you want to retain compatibility with older versions of the API."
13554 #: ../src/guestfs-actions.pod:5382
13555 msgid "guestfs_wc_c"
13559 #: ../src/guestfs-actions.pod:5384
13562 " int guestfs_wc_c (guestfs_h *g,\n"
13563 "\t\tconst char *path);\n"
13568 #: ../src/guestfs-actions.pod:5387 ../fish/guestfish-actions.pod:4176
13570 "This command counts the characters in a file, using the C<wc -c> external "
13575 #: ../src/guestfs-actions.pod:5392
13576 msgid "guestfs_wc_l"
13580 #: ../src/guestfs-actions.pod:5394
13583 " int guestfs_wc_l (guestfs_h *g,\n"
13584 "\t\tconst char *path);\n"
13589 #: ../src/guestfs-actions.pod:5397 ../fish/guestfish-actions.pod:4183
13591 "This command counts the lines in a file, using the C<wc -l> external command."
13595 #: ../src/guestfs-actions.pod:5402
13596 msgid "guestfs_wc_w"
13600 #: ../src/guestfs-actions.pod:5404
13603 " int guestfs_wc_w (guestfs_h *g,\n"
13604 "\t\tconst char *path);\n"
13609 #: ../src/guestfs-actions.pod:5407 ../fish/guestfish-actions.pod:4190
13611 "This command counts the words in a file, using the C<wc -w> external command."
13615 #: ../src/guestfs-actions.pod:5412
13616 msgid "guestfs_write"
13620 #: ../src/guestfs-actions.pod:5414
13623 " int guestfs_write (guestfs_h *g,\n"
13624 "\t\tconst char *path,\n"
13625 "\t\tconst char *content,\n"
13626 "\t\tsize_t content_size);\n"
13631 #: ../src/guestfs-actions.pod:5419 ../fish/guestfish-actions.pod:4197
13633 "This call creates a file called C<path>. The content of the file is the "
13634 "string C<content> (which can contain any 8 bit data)."
13638 #: ../src/guestfs-actions.pod:5427
13639 msgid "guestfs_write_file"
13643 #: ../src/guestfs-actions.pod:5429
13646 " int guestfs_write_file (guestfs_h *g,\n"
13647 "\t\tconst char *path,\n"
13648 "\t\tconst char *content,\n"
13654 #: ../src/guestfs-actions.pod:5434 ../fish/guestfish-actions.pod:4207
13656 "This call creates a file called C<path>. The contents of the file is the "
13657 "string C<content> (which can contain any 8 bit data), with length C<size>."
13661 #: ../src/guestfs-actions.pod:5438 ../fish/guestfish-actions.pod:4211
13663 "As a special case, if C<size> is C<0> then the length is calculated using "
13664 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
13668 #: ../src/guestfs-actions.pod:5442 ../fish/guestfish-actions.pod:4215
13670 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
13671 "I<not> work, even if the length is specified."
13675 #: ../src/guestfs-actions.pod:5450 ../fish/guestfish-actions.pod:4221
13677 "This function is deprecated. In new code, use the C<write> call instead."
13681 #: ../src/guestfs-actions.pod:5457
13682 msgid "guestfs_zegrep"
13686 #: ../src/guestfs-actions.pod:5459
13689 " char **guestfs_zegrep (guestfs_h *g,\n"
13690 "\t\tconst char *regex,\n"
13691 "\t\tconst char *path);\n"
13696 #: ../src/guestfs-actions.pod:5463 ../fish/guestfish-actions.pod:4232
13698 "This calls the external C<zegrep> program and returns the matching lines."
13702 #: ../src/guestfs-actions.pod:5473
13703 msgid "guestfs_zegrepi"
13707 #: ../src/guestfs-actions.pod:5475
13710 " char **guestfs_zegrepi (guestfs_h *g,\n"
13711 "\t\tconst char *regex,\n"
13712 "\t\tconst char *path);\n"
13717 #: ../src/guestfs-actions.pod:5479 ../fish/guestfish-actions.pod:4242
13719 "This calls the external C<zegrep -i> program and returns the matching lines."
13723 #: ../src/guestfs-actions.pod:5489
13724 msgid "guestfs_zero"
13728 #: ../src/guestfs-actions.pod:5491
13731 " int guestfs_zero (guestfs_h *g,\n"
13732 "\t\tconst char *device);\n"
13737 #: ../src/guestfs-actions.pod:5494 ../fish/guestfish-actions.pod:4252
13738 msgid "This command writes zeroes over the first few blocks of C<device>."
13742 #: ../src/guestfs-actions.pod:5496 ../fish/guestfish-actions.pod:4254
13744 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
13745 "securely wipe the device). It should be sufficient to remove any partition "
13746 "tables, filesystem superblocks and so on."
13750 #: ../src/guestfs-actions.pod:5500
13751 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
13755 #: ../src/guestfs-actions.pod:5509
13756 msgid "guestfs_zero_device"
13760 #: ../src/guestfs-actions.pod:5511
13763 " int guestfs_zero_device (guestfs_h *g,\n"
13764 "\t\tconst char *device);\n"
13769 #: ../src/guestfs-actions.pod:5514
13771 "This command writes zeroes over the entire C<device>. Compare with "
13772 "C<guestfs_zero> which just zeroes the first few blocks of a device."
13776 #: ../src/guestfs-actions.pod:5528
13777 msgid "guestfs_zerofree"
13781 #: ../src/guestfs-actions.pod:5530
13784 " int guestfs_zerofree (guestfs_h *g,\n"
13785 "\t\tconst char *device);\n"
13790 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:4275
13792 "This runs the I<zerofree> program on C<device>. This program claims to zero "
13793 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
13794 "possible to compress the filesystem more effectively."
13798 #: ../src/guestfs-actions.pod:5538 ../fish/guestfish-actions.pod:4280
13799 msgid "You should B<not> run this program if the filesystem is mounted."
13803 #: ../src/guestfs-actions.pod:5541 ../fish/guestfish-actions.pod:4283
13805 "It is possible that using this program can damage the filesystem or data on "
13810 #: ../src/guestfs-actions.pod:5546
13811 msgid "guestfs_zfgrep"
13815 #: ../src/guestfs-actions.pod:5548
13818 " char **guestfs_zfgrep (guestfs_h *g,\n"
13819 "\t\tconst char *pattern,\n"
13820 "\t\tconst char *path);\n"
13825 #: ../src/guestfs-actions.pod:5552 ../fish/guestfish-actions.pod:4290
13827 "This calls the external C<zfgrep> program and returns the matching lines."
13831 #: ../src/guestfs-actions.pod:5562
13832 msgid "guestfs_zfgrepi"
13836 #: ../src/guestfs-actions.pod:5564
13839 " char **guestfs_zfgrepi (guestfs_h *g,\n"
13840 "\t\tconst char *pattern,\n"
13841 "\t\tconst char *path);\n"
13846 #: ../src/guestfs-actions.pod:5568 ../fish/guestfish-actions.pod:4300
13848 "This calls the external C<zfgrep -i> program and returns the matching lines."
13852 #: ../src/guestfs-actions.pod:5578
13853 msgid "guestfs_zfile"
13857 #: ../src/guestfs-actions.pod:5580
13860 " char *guestfs_zfile (guestfs_h *g,\n"
13861 "\t\tconst char *meth,\n"
13862 "\t\tconst char *path);\n"
13867 #: ../src/guestfs-actions.pod:5584 ../fish/guestfish-actions.pod:4310
13869 "This command runs C<file> after first decompressing C<path> using C<method>."
13873 #: ../src/guestfs-actions.pod:5587 ../fish/guestfish-actions.pod:4313
13874 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
13878 #: ../src/guestfs-actions.pod:5589
13880 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
13885 #: ../src/guestfs-actions.pod:5595 ../fish/guestfish-actions.pod:4318
13887 "This function is deprecated. In new code, use the C<file> call instead."
13891 #: ../src/guestfs-actions.pod:5602
13892 msgid "guestfs_zgrep"
13896 #: ../src/guestfs-actions.pod:5604
13899 " char **guestfs_zgrep (guestfs_h *g,\n"
13900 "\t\tconst char *regex,\n"
13901 "\t\tconst char *path);\n"
13906 #: ../src/guestfs-actions.pod:5608 ../fish/guestfish-actions.pod:4329
13908 "This calls the external C<zgrep> program and returns the matching lines."
13912 #: ../src/guestfs-actions.pod:5618
13913 msgid "guestfs_zgrepi"
13917 #: ../src/guestfs-actions.pod:5620
13920 " char **guestfs_zgrepi (guestfs_h *g,\n"
13921 "\t\tconst char *regex,\n"
13922 "\t\tconst char *path);\n"
13927 #: ../src/guestfs-actions.pod:5624 ../fish/guestfish-actions.pod:4339
13929 "This calls the external C<zgrep -i> program and returns the matching lines."
13933 #: ../src/guestfs-availability.pod:3
13938 #: ../src/guestfs-availability.pod:5
13940 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
13941 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
13942 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
13943 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
13944 "L</guestfs_aug_save> L</guestfs_aug_set>"
13948 #: ../src/guestfs-availability.pod:21
13953 #: ../src/guestfs-availability.pod:23
13955 "The following functions: L</guestfs_inotify_add_watch> L</"
13956 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
13957 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
13961 #: ../src/guestfs-availability.pod:31
13962 msgid "B<linuxfsuuid>"
13966 #: ../src/guestfs-availability.pod:33
13968 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
13969 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
13973 #: ../src/guestfs-availability.pod:40
13974 msgid "B<linuxmodules>"
13978 #: ../src/guestfs-availability.pod:42
13979 msgid "The following functions: L</guestfs_modprobe>"
13983 #: ../src/guestfs-availability.pod:45
13984 msgid "B<linuxxattrs>"
13988 #: ../src/guestfs-availability.pod:47
13990 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> L</"
13991 "guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</"
13992 "guestfs_removexattr> L</guestfs_setxattr>"
13996 #: ../src/guestfs-availability.pod:56
14001 #: ../src/guestfs-availability.pod:58
14003 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
14004 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
14005 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
14009 #: ../src/guestfs-availability.pod:67
14014 #: ../src/guestfs-availability.pod:69
14016 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
14017 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
14018 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
14019 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
14020 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
14021 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
14022 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
14026 #: ../src/guestfs-availability.pod:92
14031 #: ../src/guestfs-availability.pod:94
14033 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
14034 "guestfs_mknod_b> L</guestfs_mknod_c>"
14038 #: ../src/guestfs-availability.pod:100
14043 #: ../src/guestfs-availability.pod:102
14044 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
14048 #: ../src/guestfs-availability.pod:105
14049 msgid "B<ntfsprogs>"
14053 #: ../src/guestfs-availability.pod:107
14055 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
14059 #: ../src/guestfs-availability.pod:111
14060 msgid "B<realpath>"
14064 #: ../src/guestfs-availability.pod:113
14065 msgid "The following functions: L</guestfs_realpath>"
14069 #: ../src/guestfs-availability.pod:116
14074 #: ../src/guestfs-availability.pod:118
14076 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
14077 "guestfs_scrub_freespace>"
14081 #: ../src/guestfs-availability.pod:123
14086 #: ../src/guestfs-availability.pod:125
14087 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
14091 #: ../src/guestfs-availability.pod:129
14096 #: ../src/guestfs-availability.pod:131
14097 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
14101 #: ../src/guestfs-availability.pod:135
14102 msgid "B<zerofree>"
14106 #: ../src/guestfs-availability.pod:137
14107 msgid "The following functions: L</guestfs_zerofree>"
14111 #: ../src/guestfs-structs.pod:1
14112 msgid "guestfs_int_bool"
14116 #: ../src/guestfs-structs.pod:3
14119 " struct guestfs_int_bool {\n"
14127 #: ../src/guestfs-structs.pod:8
14130 " struct guestfs_int_bool_list {\n"
14131 " uint32_t len; /* Number of elements in list. */\n"
14132 " struct guestfs_int_bool *val; /* Elements. */\n"
14138 #: ../src/guestfs-structs.pod:13
14141 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
14142 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
14147 #: ../src/guestfs-structs.pod:16
14148 msgid "guestfs_lvm_pv"
14152 #: ../src/guestfs-structs.pod:18
14155 " struct guestfs_lvm_pv {\n"
14156 " char *pv_name;\n"
14157 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
14158 " char pv_uuid[32];\n"
14160 " uint64_t pv_size;\n"
14161 " uint64_t dev_size;\n"
14162 " uint64_t pv_free;\n"
14163 " uint64_t pv_used;\n"
14164 " char *pv_attr;\n"
14165 " int64_t pv_pe_count;\n"
14166 " int64_t pv_pe_alloc_count;\n"
14167 " char *pv_tags;\n"
14168 " uint64_t pe_start;\n"
14169 " int64_t pv_mda_count;\n"
14170 " uint64_t pv_mda_free;\n"
14176 #: ../src/guestfs-structs.pod:36
14179 " struct guestfs_lvm_pv_list {\n"
14180 " uint32_t len; /* Number of elements in list. */\n"
14181 " struct guestfs_lvm_pv *val; /* Elements. */\n"
14187 #: ../src/guestfs-structs.pod:41
14190 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
14191 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
14196 #: ../src/guestfs-structs.pod:44
14197 msgid "guestfs_lvm_vg"
14201 #: ../src/guestfs-structs.pod:46
14204 " struct guestfs_lvm_vg {\n"
14205 " char *vg_name;\n"
14206 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
14207 " char vg_uuid[32];\n"
14209 " char *vg_attr;\n"
14210 " uint64_t vg_size;\n"
14211 " uint64_t vg_free;\n"
14212 " char *vg_sysid;\n"
14213 " uint64_t vg_extent_size;\n"
14214 " int64_t vg_extent_count;\n"
14215 " int64_t vg_free_count;\n"
14216 " int64_t max_lv;\n"
14217 " int64_t max_pv;\n"
14218 " int64_t pv_count;\n"
14219 " int64_t lv_count;\n"
14220 " int64_t snap_count;\n"
14221 " int64_t vg_seqno;\n"
14222 " char *vg_tags;\n"
14223 " int64_t vg_mda_count;\n"
14224 " uint64_t vg_mda_free;\n"
14230 #: ../src/guestfs-structs.pod:69
14233 " struct guestfs_lvm_vg_list {\n"
14234 " uint32_t len; /* Number of elements in list. */\n"
14235 " struct guestfs_lvm_vg *val; /* Elements. */\n"
14241 #: ../src/guestfs-structs.pod:74
14244 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
14245 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
14250 #: ../src/guestfs-structs.pod:77
14251 msgid "guestfs_lvm_lv"
14255 #: ../src/guestfs-structs.pod:79
14258 " struct guestfs_lvm_lv {\n"
14259 " char *lv_name;\n"
14260 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
14261 " char lv_uuid[32];\n"
14262 " char *lv_attr;\n"
14263 " int64_t lv_major;\n"
14264 " int64_t lv_minor;\n"
14265 " int64_t lv_kernel_major;\n"
14266 " int64_t lv_kernel_minor;\n"
14267 " uint64_t lv_size;\n"
14268 " int64_t seg_count;\n"
14270 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
14271 " float snap_percent;\n"
14272 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
14273 " float copy_percent;\n"
14274 " char *move_pv;\n"
14275 " char *lv_tags;\n"
14276 " char *mirror_log;\n"
14277 " char *modules;\n"
14283 #: ../src/guestfs-structs.pod:101
14286 " struct guestfs_lvm_lv_list {\n"
14287 " uint32_t len; /* Number of elements in list. */\n"
14288 " struct guestfs_lvm_lv *val; /* Elements. */\n"
14294 #: ../src/guestfs-structs.pod:106
14297 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
14298 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
14303 #: ../src/guestfs-structs.pod:111
14306 " struct guestfs_stat {\n"
14310 " int64_t nlink;\n"
14315 " int64_t blksize;\n"
14316 " int64_t blocks;\n"
14317 " int64_t atime;\n"
14318 " int64_t mtime;\n"
14319 " int64_t ctime;\n"
14325 #: ../src/guestfs-structs.pod:127
14328 " struct guestfs_stat_list {\n"
14329 " uint32_t len; /* Number of elements in list. */\n"
14330 " struct guestfs_stat *val; /* Elements. */\n"
14336 #: ../src/guestfs-structs.pod:132
14339 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
14340 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
14345 #: ../src/guestfs-structs.pod:137
14348 " struct guestfs_statvfs {\n"
14349 " int64_t bsize;\n"
14350 " int64_t frsize;\n"
14351 " int64_t blocks;\n"
14352 " int64_t bfree;\n"
14353 " int64_t bavail;\n"
14354 " int64_t files;\n"
14355 " int64_t ffree;\n"
14356 " int64_t favail;\n"
14359 " int64_t namemax;\n"
14365 #: ../src/guestfs-structs.pod:151
14368 " struct guestfs_statvfs_list {\n"
14369 " uint32_t len; /* Number of elements in list. */\n"
14370 " struct guestfs_statvfs *val; /* Elements. */\n"
14376 #: ../src/guestfs-structs.pod:156
14379 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
14380 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
14385 #: ../src/guestfs-structs.pod:159
14386 msgid "guestfs_dirent"
14390 #: ../src/guestfs-structs.pod:161
14393 " struct guestfs_dirent {\n"
14402 #: ../src/guestfs-structs.pod:167
14405 " struct guestfs_dirent_list {\n"
14406 " uint32_t len; /* Number of elements in list. */\n"
14407 " struct guestfs_dirent *val; /* Elements. */\n"
14413 #: ../src/guestfs-structs.pod:172
14416 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
14417 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
14422 #: ../src/guestfs-structs.pod:177
14425 " struct guestfs_version {\n"
14426 " int64_t major;\n"
14427 " int64_t minor;\n"
14428 " int64_t release;\n"
14435 #: ../src/guestfs-structs.pod:184
14438 " struct guestfs_version_list {\n"
14439 " uint32_t len; /* Number of elements in list. */\n"
14440 " struct guestfs_version *val; /* Elements. */\n"
14446 #: ../src/guestfs-structs.pod:189
14449 " void guestfs_free_version (struct guestfs_free_version *);\n"
14450 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
14455 #: ../src/guestfs-structs.pod:192
14456 msgid "guestfs_xattr"
14460 #: ../src/guestfs-structs.pod:194
14463 " struct guestfs_xattr {\n"
14464 " char *attrname;\n"
14465 " /* The next two fields describe a byte array. */\n"
14466 " uint32_t attrval_len;\n"
14467 " char *attrval;\n"
14473 #: ../src/guestfs-structs.pod:201
14476 " struct guestfs_xattr_list {\n"
14477 " uint32_t len; /* Number of elements in list. */\n"
14478 " struct guestfs_xattr *val; /* Elements. */\n"
14484 #: ../src/guestfs-structs.pod:206
14487 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
14488 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
14493 #: ../src/guestfs-structs.pod:209
14494 msgid "guestfs_inotify_event"
14498 #: ../src/guestfs-structs.pod:211
14501 " struct guestfs_inotify_event {\n"
14502 " int64_t in_wd;\n"
14503 " uint32_t in_mask;\n"
14504 " uint32_t in_cookie;\n"
14505 " char *in_name;\n"
14511 #: ../src/guestfs-structs.pod:218
14514 " struct guestfs_inotify_event_list {\n"
14515 " uint32_t len; /* Number of elements in list. */\n"
14516 " struct guestfs_inotify_event *val; /* Elements. */\n"
14522 #: ../src/guestfs-structs.pod:223
14525 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
14526 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
14531 #: ../src/guestfs-structs.pod:226
14532 msgid "guestfs_partition"
14536 #: ../src/guestfs-structs.pod:228
14539 " struct guestfs_partition {\n"
14540 " int32_t part_num;\n"
14541 " uint64_t part_start;\n"
14542 " uint64_t part_end;\n"
14543 " uint64_t part_size;\n"
14549 #: ../src/guestfs-structs.pod:235
14552 " struct guestfs_partition_list {\n"
14553 " uint32_t len; /* Number of elements in list. */\n"
14554 " struct guestfs_partition *val; /* Elements. */\n"
14560 #: ../src/guestfs-structs.pod:240
14563 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
14564 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
14569 #: ../fish/guestfish.pod:5
14570 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
14574 #: ../fish/guestfish.pod:9
14577 " guestfish [--options] [commands]\n"
14582 #: ../fish/guestfish.pod:11
14590 #: ../fish/guestfish.pod:13
14593 " guestfish -a disk.img\n"
14598 #: ../fish/guestfish.pod:15
14601 " guestfish -a disk.img -m dev[:mountpoint]\n"
14606 #: ../fish/guestfish.pod:17
14609 " guestfish -d libvirt-domain\n"
14614 #: ../fish/guestfish.pod:19
14617 " guestfish -a disk.img -i\n"
14622 #: ../fish/guestfish.pod:21
14625 " guestfish -d libvirt-domain -i\n"
14630 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:11 ../tools/virt-edit.pl:45
14631 #: ../tools/virt-rescue.pl:41 ../tools/virt-tar.pl:60
14632 #: ../tools/virt-win-reg.pl:52
14637 #: ../fish/guestfish.pod:25
14639 "Using guestfish in read/write mode on live virtual machines can be "
14640 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
14641 "option to use guestfish safely if the disk image or virtual machine might be "
14646 #: ../fish/guestfish.pod:30 ../fish/guestfish.pod:736
14647 #: ../fuse/guestmount.pod:35 ../tools/virt-cat.pl:51 ../tools/virt-edit.pl:59
14648 #: ../tools/virt-resize.pl:66 ../tools/virt-tar.pl:46
14653 #: ../fish/guestfish.pod:32
14654 msgid "As an interactive shell"
14658 #: ../fish/guestfish.pod:34
14666 #: ../fish/guestfish.pod:36
14669 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
14670 " editing virtual machine filesystems.\n"
14675 #: ../fish/guestfish.pod:39
14678 " Type: 'help' for a list of commands\n"
14679 " 'man' to read the manual\n"
14680 " 'quit' to quit the shell\n"
14685 #: ../fish/guestfish.pod:43
14693 #: ../fish/guestfish.pod:45
14694 msgid "From shell scripts"
14698 #: ../fish/guestfish.pod:47
14699 msgid "Create a new C</etc/motd> file in a guest:"
14703 #: ../fish/guestfish.pod:49
14706 " guestfish <<_EOF_\n"
14709 " mount /dev/vg_guest/lv_root /\n"
14710 " write /etc/motd \"Welcome, new users\"\n"
14716 #: ../fish/guestfish.pod:56
14717 msgid "List the LVM logical volumes in a guest:"
14721 #: ../fish/guestfish.pod:58
14724 " guestfish -a disk.img --ro <<_EOF_\n"
14732 #: ../fish/guestfish.pod:63
14733 msgid "On one command line"
14737 #: ../fish/guestfish.pod:65
14738 msgid "Update C</etc/resolv.conf> in a guest:"
14742 #: ../fish/guestfish.pod:67
14746 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
14747 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
14752 #: ../fish/guestfish.pod:71
14753 msgid "Edit C</boot/grub/grub.conf> interactively:"
14757 #: ../fish/guestfish.pod:73
14760 " guestfish --add disk.img \\\n"
14761 " --mount /dev/vg_guest/lv_root \\\n"
14762 " --mount /dev/sda1:/boot \\\n"
14763 " edit /boot/grub/grub.conf\n"
14768 #: ../fish/guestfish.pod:78
14769 msgid "Mount disks automatically"
14773 #: ../fish/guestfish.pod:80
14775 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
14779 #: ../fish/guestfish.pod:83
14782 " guestfish --ro -a disk.img -i cat /etc/group\n"
14787 #: ../fish/guestfish.pod:85
14790 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
14795 #: ../fish/guestfish.pod:87
14796 msgid "As a script interpreter"
14800 #: ../fish/guestfish.pod:89
14801 msgid "Create a 100MB disk containing an ext2-formatted partition:"
14805 #: ../fish/guestfish.pod:91
14808 " #!/usr/bin/guestfish -f\n"
14809 " sparse test1.img 100M\n"
14811 " part-disk /dev/sda mbr\n"
14812 " mkfs ext2 /dev/sda1\n"
14817 #: ../fish/guestfish.pod:97
14818 msgid "Start with a prepared disk"
14822 #: ../fish/guestfish.pod:99
14824 "An alternate way to create a 100MB disk called C<test1.img> containing a "
14825 "single ext2-formatted partition:"
14829 #: ../fish/guestfish.pod:102
14832 " guestfish -N fs\n"
14837 #: ../fish/guestfish.pod:104
14838 msgid "To list what is available do:"
14842 #: ../fish/guestfish.pod:106 ../fish/guestfish.pod:727
14845 " guestfish -N help | less\n"
14850 #: ../fish/guestfish.pod:108
14851 msgid "Remote control"
14855 #: ../fish/guestfish.pod:110
14858 " eval `guestfish --listen --ro`\n"
14859 " guestfish --remote add disk.img\n"
14860 " guestfish --remote run\n"
14861 " guestfish --remote lvs\n"
14866 #: ../fish/guestfish.pod:117
14868 "Guestfish is a shell and command-line tool for examining and modifying "
14869 "virtual machine filesystems. It uses libguestfs and exposes all of the "
14870 "functionality of the guestfs API, see L<guestfs(3)>."
14874 #: ../fish/guestfish.pod:121
14876 "Guestfish gives you structured access to the libguestfs API, from shell "
14877 "scripts or the command line or interactively. If you want to rescue a "
14878 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
14883 #: ../fish/guestfish.pod:126 ../test-tool/libguestfs-test-tool.pod:37
14884 #: ../fuse/guestmount.pod:70 ../inspector/virt-inspector.pl:75
14885 #: ../tools/virt-cat.pl:80 ../tools/virt-df.pl:71 ../tools/virt-edit.pl:73
14886 #: ../tools/virt-list-filesystems.pl:50 ../tools/virt-list-partitions.pl:51
14887 #: ../tools/virt-ls.pl:79 ../tools/virt-make-fs.pl:153
14888 #: ../tools/virt-rescue.pl:103 ../tools/virt-resize.pl:233
14889 #: ../tools/virt-tar.pl:99 ../tools/virt-win-reg.pl:172
14894 #: ../fish/guestfish.pod:130 ../fuse/guestmount.pod:94
14895 #: ../inspector/virt-inspector.pl:83 ../tools/virt-cat.pl:88
14896 #: ../tools/virt-df.pl:79 ../tools/virt-edit.pl:81
14897 #: ../tools/virt-list-filesystems.pl:58 ../tools/virt-list-partitions.pl:59
14898 #: ../tools/virt-ls.pl:87 ../tools/virt-make-fs.pl:161
14899 #: ../tools/virt-rescue.pl:111 ../tools/virt-resize.pl:241
14900 #: ../tools/virt-tar.pl:107 ../tools/virt-win-reg.pl:180
14905 #: ../fish/guestfish.pod:132
14906 msgid "Displays general help on options."
14910 #: ../fish/guestfish.pod:134
14911 msgid "B<-h> | B<--cmd-help>"
14915 #: ../fish/guestfish.pod:136
14916 msgid "Lists all available guestfish commands."
14920 #: ../fish/guestfish.pod:138
14921 msgid "B<-h cmd> | B<--cmd-help cmd>"
14925 #: ../fish/guestfish.pod:140
14926 msgid "Displays detailed help on a single command C<cmd>."
14930 #: ../fish/guestfish.pod:142 ../fuse/guestmount.pod:74
14931 msgid "B<-a image> | B<--add image>"
14935 #: ../fish/guestfish.pod:144
14936 msgid "Add a block device or virtual machine image to the shell."
14940 #: ../fish/guestfish.pod:146
14941 msgid "B<-c URI> | B<--connect URI>"
14945 #: ../fish/guestfish.pod:148
14947 "When used in conjunction with the I<-d> option, this specifies the libvirt "
14948 "URI to use. The default is to use the default libvirt connection."
14952 #: ../fish/guestfish.pod:152
14953 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
14957 #: ../fish/guestfish.pod:154
14959 "Add disks from the named libvirt domain. If the I<--ro> option is also "
14960 "used, then any libvirt domain can be used. However in write mode, only "
14961 "libvirt domains which are shut down can be named here."
14965 #: ../fish/guestfish.pod:158
14966 msgid "B<-D> | B<--no-dest-paths>"
14970 #: ../fish/guestfish.pod:160
14972 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
14973 "to hit the tab key to complete paths on the guest filesystem, but this "
14974 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
14975 "allow this feature to be disabled."
14979 #: ../fish/guestfish.pod:165
14980 msgid "B<--echo-keys>"
14984 #: ../fish/guestfish.pod:167
14986 "When prompting for keys and passphrases, guestfish normally turns echoing "
14987 "off so you cannot see what you are typing. If you are not worried about "
14988 "Tempest attacks and there is no one else in the room you can specify this "
14989 "flag to see what you are typing."
14993 #: ../fish/guestfish.pod:172
14994 msgid "B<-f file> | B<--file file>"
14998 #: ../fish/guestfish.pod:174
14999 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
15003 #: ../fish/guestfish.pod:177
15006 " #!/usr/bin/guestfish -f\n"
15011 #: ../fish/guestfish.pod:179
15012 msgid "B<-i> | B<--inspector>"
15016 #: ../fish/guestfish.pod:181
15018 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
15019 "system and mount filesystems as they would be mounted on the real virtual "
15024 #: ../fish/guestfish.pod:185
15025 msgid "Typical usage is either:"
15029 #: ../fish/guestfish.pod:187
15032 " guestfish -d myguest -i\n"
15037 #: ../fish/guestfish.pod:189
15038 msgid "(for an inactive libvirt domain called I<myguest>), or:"
15042 #: ../fish/guestfish.pod:191
15045 " guestfish --ro -d myguest -i\n"
15050 #: ../fish/guestfish.pod:193
15051 msgid "(for active domains, readonly), or specify the block device directly:"
15055 #: ../fish/guestfish.pod:195
15058 " guestfish -a /dev/Guests/MyGuest -i\n"
15063 #: ../fish/guestfish.pod:197
15065 "Note that the command line syntax changed slightly over older versions of "
15066 "guestfish. You can still use the old syntax:"
15070 #: ../fish/guestfish.pod:200
15073 " guestfish [--ro] -i disk.img\n"
15078 #: ../fish/guestfish.pod:202
15081 " guestfish [--ro] -i libvirt-domain\n"
15086 #: ../fish/guestfish.pod:204
15087 msgid "B<--keys-from-stdin>"
15091 #: ../fish/guestfish.pod:206
15093 "Read key or passphrase parameters from stdin. The default is to try to read "
15094 "passphrases from the user by opening C</dev/tty>."
15098 #: ../fish/guestfish.pod:209
15099 msgid "B<--listen>"
15103 #: ../fish/guestfish.pod:211
15105 "Fork into the background and listen for remote commands. See section L</"
15106 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
15110 #: ../fish/guestfish.pod:214
15111 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
15115 #: ../fish/guestfish.pod:216
15116 msgid "Mount the named partition or logical volume on the given mountpoint."
15120 #: ../fish/guestfish.pod:218
15121 msgid "If the mountpoint is omitted, it defaults to C</>."
15125 #: ../fish/guestfish.pod:220
15126 msgid "You have to mount something on C</> before most commands will work."
15130 #: ../fish/guestfish.pod:222
15132 "If any I<-m> or I<--mount> options are given, the guest is automatically "
15137 #: ../fish/guestfish.pod:225
15139 "If you don't know what filesystems a disk image contains, you can either run "
15140 "guestfish without this option, then list the partitions and LVs available "
15141 "(see L</list-partitions> and L</lvs> commands), or you can use the L<virt-"
15142 "list-filesystems(1)> program."
15146 #: ../fish/guestfish.pod:230 ../fuse/guestmount.pod:106
15147 msgid "B<-n> | B<--no-sync>"
15151 #: ../fish/guestfish.pod:232
15153 "Disable autosync. This is enabled by default. See the discussion of "
15154 "autosync in the L<guestfs(3)> manpage."
15158 #: ../fish/guestfish.pod:235
15159 msgid "B<-N type> | B<--new type> | B<-N help>"
15163 #: ../fish/guestfish.pod:237
15165 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
15166 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
15167 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
15172 #: ../fish/guestfish.pod:242
15173 msgid "B<--progress-bars>"
15177 #: ../fish/guestfish.pod:244
15178 msgid "Enable progress bars, even when guestfish is used non-interactively."
15182 #: ../fish/guestfish.pod:246
15184 "Progress bars are enabled by default when guestfish is used as an "
15185 "interactive shell."
15189 #: ../fish/guestfish.pod:249
15190 msgid "B<--no-progress-bars>"
15194 #: ../fish/guestfish.pod:251
15195 msgid "Disable progress bars."
15199 #: ../fish/guestfish.pod:253
15200 msgid "B<--remote[=pid]>"
15204 #: ../fish/guestfish.pod:255
15206 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
15207 "CONTROL GUESTFISH OVER A SOCKET> below."
15211 #: ../fish/guestfish.pod:258 ../fuse/guestmount.pod:148
15212 msgid "B<-r> | B<--ro>"
15216 #: ../fish/guestfish.pod:260
15218 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
15219 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
15223 #: ../fish/guestfish.pod:263 ../tools/virt-rescue.pl:162
15225 "The option must always be used if the disk image or virtual machine might be "
15226 "running, and is generally recommended in cases where you don't need write "
15227 "access to the disk."
15231 #: ../fish/guestfish.pod:267
15233 "Note that prepared disk images created with I<-N> are not affected by the "
15238 #: ../fish/guestfish.pod:270 ../fuse/guestmount.pod:158
15239 #: ../tools/virt-rescue.pl:170
15240 msgid "B<--selinux>"
15244 #: ../fish/guestfish.pod:272
15245 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
15249 #: ../fish/guestfish.pod:274 ../fuse/guestmount.pod:168
15250 msgid "B<-v> | B<--verbose>"
15254 #: ../fish/guestfish.pod:276
15256 "Enable very verbose messages. This is particularly useful if you find a bug."
15260 #: ../fish/guestfish.pod:279 ../fuse/guestmount.pod:172
15261 msgid "B<-V> | B<--version>"
15265 #: ../fish/guestfish.pod:281
15266 msgid "Display the guestfish / libguestfs version number and exit."
15270 #: ../fish/guestfish.pod:283
15275 #: ../fish/guestfish.pod:285
15276 msgid "Echo each command before executing it."
15280 #: ../fish/guestfish.pod:289
15281 msgid "COMMANDS ON COMMAND LINE"
15285 #: ../fish/guestfish.pod:291
15287 "Any additional (non-option) arguments are treated as commands to execute."
15291 #: ../fish/guestfish.pod:294
15293 "Commands to execute should be separated by a colon (C<:>), where the colon "
15294 "is a separate parameter. Thus:"
15298 #: ../fish/guestfish.pod:297
15301 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
15306 #: ../fish/guestfish.pod:299
15308 "If there are no additional arguments, then we enter a shell, either an "
15309 "interactive shell with a prompt (if the input is a terminal) or a non-"
15310 "interactive shell."
15314 #: ../fish/guestfish.pod:303
15316 "In either command line mode or non-interactive shell, the first command that "
15317 "gives an error causes the whole shell to exit. In interactive mode (with a "
15318 "prompt) if a command fails, you can continue to enter commands."
15322 #: ../fish/guestfish.pod:308
15323 msgid "USING launch (OR run)"
15327 #: ../fish/guestfish.pod:310
15329 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
15330 "then launch it, then mount any disks you need, and finally issue actions/"
15331 "commands. So the general order of the day is:"
15335 #: ../fish/guestfish.pod:318
15336 msgid "add or -a/--add"
15340 #: ../fish/guestfish.pod:322
15341 msgid "launch (aka run)"
15345 #: ../fish/guestfish.pod:326
15346 msgid "mount or -m/--mount"
15350 #: ../fish/guestfish.pod:330
15351 msgid "any other commands"
15355 #: ../fish/guestfish.pod:334
15357 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
15358 "guest before mounting or performing any other commands."
15362 #: ../fish/guestfish.pod:337
15364 "The only exception is that if the I<-m> or I<--mount> option was given, the "
15365 "guest is automatically run for you (simply because guestfish can't mount the "
15366 "disks you asked for without doing this)."
15370 #: ../fish/guestfish.pod:341
15375 #: ../fish/guestfish.pod:343
15377 "You can quote ordinary parameters using either single or double quotes. For "
15382 #: ../fish/guestfish.pod:346
15385 " add \"file with a space.img\"\n"
15390 #: ../fish/guestfish.pod:348
15393 " rm '/file name'\n"
15398 #: ../fish/guestfish.pod:350
15406 #: ../fish/guestfish.pod:352
15408 "A few commands require a list of strings to be passed. For these, use a "
15409 "whitespace-separated list, enclosed in quotes. Strings containing "
15410 "whitespace to be passed through must be enclosed in single quotes. A "
15411 "literal single quote must be escaped with a backslash."
15415 #: ../fish/guestfish.pod:357
15418 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
15419 " command \"/bin/echo 'foo bar'\"\n"
15420 " command \"/bin/echo \\'foo\\'\"\n"
15425 #: ../fish/guestfish.pod:361
15430 #: ../fish/guestfish.pod:363
15432 "This section applies to all commands which can take integers as parameters."
15436 #: ../fish/guestfish.pod:366
15437 msgid "SIZE SUFFIX"
15441 #: ../fish/guestfish.pod:368
15443 "When the command takes a parameter measured in bytes, you can use one of the "
15444 "following suffixes to specify kilobytes, megabytes and larger sizes:"
15448 #: ../fish/guestfish.pod:374
15449 msgid "B<k> or B<K> or B<KiB>"
15453 #: ../fish/guestfish.pod:376
15454 msgid "The size in kilobytes (multiplied by 1024)."
15458 #: ../fish/guestfish.pod:378
15463 #: ../fish/guestfish.pod:380
15464 msgid "The size in SI 1000 byte units."
15468 #: ../fish/guestfish.pod:382
15469 msgid "B<M> or B<MiB>"
15473 #: ../fish/guestfish.pod:384
15474 msgid "The size in megabytes (multiplied by 1048576)."
15478 #: ../fish/guestfish.pod:386
15483 #: ../fish/guestfish.pod:388
15484 msgid "The size in SI 1000000 byte units."
15488 #: ../fish/guestfish.pod:390
15489 msgid "B<G> or B<GiB>"
15493 #: ../fish/guestfish.pod:392
15494 msgid "The size in gigabytes (multiplied by 2**30)."
15498 #: ../fish/guestfish.pod:394
15503 #: ../fish/guestfish.pod:396
15504 msgid "The size in SI 10**9 byte units."
15508 #: ../fish/guestfish.pod:398
15509 msgid "B<T> or B<TiB>"
15513 #: ../fish/guestfish.pod:400
15514 msgid "The size in terabytes (multiplied by 2**40)."
15518 #: ../fish/guestfish.pod:402
15523 #: ../fish/guestfish.pod:404
15524 msgid "The size in SI 10**12 byte units."
15528 #: ../fish/guestfish.pod:406
15529 msgid "B<P> or B<PiB>"
15533 #: ../fish/guestfish.pod:408
15534 msgid "The size in petabytes (multiplied by 2**50)."
15538 #: ../fish/guestfish.pod:410
15543 #: ../fish/guestfish.pod:412
15544 msgid "The size in SI 10**15 byte units."
15548 #: ../fish/guestfish.pod:414
15549 msgid "B<E> or B<EiB>"
15553 #: ../fish/guestfish.pod:416
15554 msgid "The size in exabytes (multiplied by 2**60)."
15558 #: ../fish/guestfish.pod:418
15563 #: ../fish/guestfish.pod:420
15564 msgid "The size in SI 10**18 byte units."
15568 #: ../fish/guestfish.pod:422
15569 msgid "B<Z> or B<ZiB>"
15573 #: ../fish/guestfish.pod:424
15574 msgid "The size in zettabytes (multiplied by 2**70)."
15578 #: ../fish/guestfish.pod:426
15583 #: ../fish/guestfish.pod:428
15584 msgid "The size in SI 10**21 byte units."
15588 #: ../fish/guestfish.pod:430
15589 msgid "B<Y> or B<YiB>"
15593 #: ../fish/guestfish.pod:432
15594 msgid "The size in yottabytes (multiplied by 2**80)."
15598 #: ../fish/guestfish.pod:434
15603 #: ../fish/guestfish.pod:436
15604 msgid "The size in SI 10**24 byte units."
15608 #: ../fish/guestfish.pod:440
15609 msgid "For example:"
15613 #: ../fish/guestfish.pod:442
15616 " truncate-size /file 1G\n"
15621 #: ../fish/guestfish.pod:444
15622 msgid "would truncate the file to 1 gigabyte."
15626 #: ../fish/guestfish.pod:446
15628 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
15629 "the parameter to L</memsize> is specified in megabytes already). Adding a "
15630 "suffix will probably not do what you expect."
15634 #: ../fish/guestfish.pod:450
15635 msgid "OCTAL AND HEXADECIMAL NUMBERS"
15639 #: ../fish/guestfish.pod:452
15641 "For specifying the radix (base) use the C convention: C<0> to prefix an "
15642 "octal number or C<0x> to prefix a hexadecimal number. For example:"
15646 #: ../fish/guestfish.pod:455
15649 " 1234 decimal number 1234\n"
15650 " 02322 octal number, equivalent to decimal 1234\n"
15651 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
15656 #: ../fish/guestfish.pod:459
15658 "When using the C<chmod> command, you almost always want to specify an octal "
15659 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
15660 "L<chmod(1)> program):"
15664 #: ../fish/guestfish.pod:463
15667 " chmod 0777 /public # OK\n"
15668 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
15673 #: ../fish/guestfish.pod:466
15675 "Commands that return numbers usually print them in decimal, but some "
15676 "commands print numbers in other radices (eg. C<umask> prints the mode in "
15677 "octal, preceeded by C<0>)."
15681 #: ../fish/guestfish.pod:470
15682 msgid "WILDCARDS AND GLOBBING"
15686 #: ../fish/guestfish.pod:472
15688 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
15689 "(globbing) by default. So for example the following will not do what you "
15694 #: ../fish/guestfish.pod:476
15702 #: ../fish/guestfish.pod:478
15704 "Assuming you don't have a directory literally called C</home/*> then the "
15705 "above command will return an error."
15709 #: ../fish/guestfish.pod:481
15710 msgid "To perform wildcard expansion, use the C<glob> command."
15714 #: ../fish/guestfish.pod:483
15717 " glob rm-rf /home/*\n"
15722 #: ../fish/guestfish.pod:485
15724 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
15725 "many times), equivalent to:"
15729 #: ../fish/guestfish.pod:488
15732 " rm-rf /home/jim\n"
15733 " rm-rf /home/joe\n"
15734 " rm-rf /home/mary\n"
15739 #: ../fish/guestfish.pod:492
15740 msgid "C<glob> only works on simple guest paths and not on device names."
15744 #: ../fish/guestfish.pod:494
15746 "If you have several parameters, each containing a wildcard, then glob will "
15747 "perform a cartesian product."
15751 #: ../fish/guestfish.pod:497
15756 #: ../fish/guestfish.pod:499
15758 "Any line which starts with a I<#> character is treated as a comment and "
15759 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
15760 "a command. For example:"
15764 #: ../fish/guestfish.pod:503
15767 " # this is a comment\n"
15768 " # this is a comment\n"
15769 " foo # NOT a comment\n"
15774 #: ../fish/guestfish.pod:507
15775 msgid "Blank lines are also ignored."
15779 #: ../fish/guestfish.pod:509
15780 msgid "RUNNING COMMANDS LOCALLY"
15784 #: ../fish/guestfish.pod:511
15786 "Any line which starts with a I<!> character is treated as a command sent to "
15787 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
15791 #: ../fish/guestfish.pod:515
15795 " tgz-out /remote local/remote-data.tar.gz\n"
15800 #: ../fish/guestfish.pod:518
15802 "will create a directory C<local> on the host, and then export the contents "
15803 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
15804 "(See C<tgz-out>)."
15808 #: ../fish/guestfish.pod:522
15810 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
15811 "effect, due to the way that subprocesses work in Unix."
15815 #: ../fish/guestfish.pod:525
15820 #: ../fish/guestfish.pod:527
15822 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
15823 "command (a guestfish command) to the second command (any host command). For "
15828 #: ../fish/guestfish.pod:531
15831 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
15836 #: ../fish/guestfish.pod:533
15838 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
15839 "program). The above command would list all accounts in the guest filesystem "
15840 "which have UID 0, ie. root accounts including backdoors. Other examples:"
15844 #: ../fish/guestfish.pod:538
15847 " hexdump /bin/ls | head\n"
15848 " list-devices | tail -1\n"
15849 " tgz-out / - | tar ztf -\n"
15854 #: ../fish/guestfish.pod:542
15856 "The space before the pipe symbol is required, any space after the pipe "
15857 "symbol is optional. Everything after the pipe symbol is just passed "
15858 "straight to the host shell, so it can contain redirections, globs and "
15859 "anything else that makes sense on the host side."
15863 #: ../fish/guestfish.pod:547
15865 "To use a literal argument which begins with a pipe symbol, you have to quote "
15870 #: ../fish/guestfish.pod:550
15878 #: ../fish/guestfish.pod:552
15879 msgid "HOME DIRECTORIES"
15883 #: ../fish/guestfish.pod:554
15885 "If a parameter starts with the character C<~> then the tilde may be expanded "
15886 "as a home directory path (either C<~> for the current user's home directory, "
15887 "or C<~user> for another user)."
15891 #: ../fish/guestfish.pod:558
15893 "Note that home directory expansion happens for users known I<on the host>, "
15894 "not in the guest filesystem."
15898 #: ../fish/guestfish.pod:561
15900 "To use a literal argument which begins with a tilde, you have to quote it, "
15905 #: ../fish/guestfish.pod:564
15913 #: ../fish/guestfish.pod:568
15915 "Libguestfs has some support for Linux guests encrypted according to the "
15916 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
15917 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
15918 "LUKS is supported."
15922 #: ../fish/guestfish.pod:573
15923 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
15927 #: ../fish/guestfish.pod:575
15930 " ><fs> vfs-type /dev/sda2\n"
15936 #: ../fish/guestfish.pod:578
15938 "Then open those devices using L</luks-open>. This creates a device-mapper "
15939 "device called C</dev/mapper/luksdev>."
15943 #: ../fish/guestfish.pod:581
15946 " ><fs> luks-open /dev/sda2 luksdev\n"
15947 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
15952 #: ../fish/guestfish.pod:584
15954 "Finally you have to tell LVM to scan for volume groups on the newly created "
15959 #: ../fish/guestfish.pod:587
15963 " ><fs> vg-activate-all true\n"
15968 #: ../fish/guestfish.pod:590
15969 msgid "The logical volume(s) can now be mounted in the usual way."
15973 #: ../fish/guestfish.pod:592
15975 "Before closing a LUKS device you must unmount any logical volumes on it and "
15976 "deactivate the volume groups by calling C<vg-activate false VG> on each "
15977 "one. Then you can close the mapper device:"
15981 #: ../fish/guestfish.pod:596
15984 " ><fs> vg-activate false /dev/VG\n"
15985 " ><fs> luks-close /dev/mapper/luksdev\n"
15990 #: ../fish/guestfish.pod:599
15991 msgid "WINDOWS PATHS"
15995 #: ../fish/guestfish.pod:601
15997 "If a path is prefixed with C<win:> then you can use Windows-style paths "
15998 "(with some limitations). The following commands are equivalent:"
16002 #: ../fish/guestfish.pod:604
16005 " file /WINDOWS/system32/config/system.LOG\n"
16010 #: ../fish/guestfish.pod:606
16013 " file win:/windows/system32/config/system.log\n"
16018 #: ../fish/guestfish.pod:608
16021 " file win:\\windows\\system32\\config\\system.log\n"
16026 #: ../fish/guestfish.pod:610
16029 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
16034 #: ../fish/guestfish.pod:612
16036 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
16037 "handles case insensitivity like Windows would. This only works in argument "
16038 "positions that expect a path."
16042 #: ../fish/guestfish.pod:616
16043 msgid "UPLOADING AND DOWNLOADING FILES"
16047 #: ../fish/guestfish.pod:618
16049 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
16050 "others which upload from or download to a local file, you can use the "
16051 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
16055 #: ../fish/guestfish.pod:622
16063 #: ../fish/guestfish.pod:624
16065 "reads stdin and creates from that a file C</foo> in the disk image, and:"
16069 #: ../fish/guestfish.pod:627
16072 " tar-out /etc - | tar tf -\n"
16077 #: ../fish/guestfish.pod:629
16079 "writes the tarball to stdout and then pipes that into the external \"tar\" "
16080 "command (see L</PIPES>)."
16084 #: ../fish/guestfish.pod:632
16086 "When using C<-> to read from stdin, the input is read up to the end of "
16087 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
16088 "some arbitrary end marker:"
16092 #: ../fish/guestfish.pod:636
16095 " upload -<<END /foo\n"
16104 #: ../fish/guestfish.pod:642
16106 "Any string of characters can be used instead of C<END>. The end marker must "
16107 "appear on a line of its own, without any preceeding or following characters "
16108 "(not even spaces)."
16112 #: ../fish/guestfish.pod:646
16114 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
16115 "upload local files (so-called \"FileIn\" parameters in the generator)."
16119 #: ../fish/guestfish.pod:649
16120 msgid "EXIT ON ERROR BEHAVIOUR"
16124 #: ../fish/guestfish.pod:651
16126 "By default, guestfish will ignore any errors when in interactive mode (ie. "
16127 "taking commands from a human over a tty), and will exit on the first error "
16128 "in non-interactive mode (scripts, commands given on the command line)."
16132 #: ../fish/guestfish.pod:656
16134 "If you prefix a command with a I<-> character, then that command will not "
16135 "cause guestfish to exit, even if that (one) command returns an error."
16139 #: ../fish/guestfish.pod:660
16140 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
16144 #: ../fish/guestfish.pod:662
16146 "Guestfish can be remote-controlled over a socket. This is useful "
16147 "particularly in shell scripts where you want to make several different "
16148 "changes to a filesystem, but you don't want the overhead of starting up a "
16149 "guestfish process each time."
16153 #: ../fish/guestfish.pod:667
16154 msgid "Start a guestfish server process using:"
16158 #: ../fish/guestfish.pod:669
16161 " eval `guestfish --listen`\n"
16166 #: ../fish/guestfish.pod:671
16167 msgid "and then send it commands by doing:"
16171 #: ../fish/guestfish.pod:673
16174 " guestfish --remote cmd [...]\n"
16179 #: ../fish/guestfish.pod:675
16180 msgid "To cause the server to exit, send it the exit command:"
16184 #: ../fish/guestfish.pod:677
16187 " guestfish --remote exit\n"
16192 #: ../fish/guestfish.pod:679
16194 "Note that the server will normally exit if there is an error in a command. "
16195 "You can change this in the usual way. See section L</EXIT ON ERROR "
16200 #: ../fish/guestfish.pod:683
16201 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
16205 #: ../fish/guestfish.pod:685
16207 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
16208 "is how the I<--remote> option knows where to send the commands. You can "
16209 "have several guestfish listener processes running using:"
16213 #: ../fish/guestfish.pod:689
16216 " eval `guestfish --listen`\n"
16217 " pid1=$GUESTFISH_PID\n"
16218 " eval `guestfish --listen`\n"
16219 " pid2=$GUESTFISH_PID\n"
16221 " guestfish --remote=$pid1 cmd\n"
16222 " guestfish --remote=$pid2 cmd\n"
16227 #: ../fish/guestfish.pod:697
16228 msgid "REMOTE CONTROL DETAILS"
16232 #: ../fish/guestfish.pod:699
16234 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
16235 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
16236 "and C<$PID> is the process ID of the server."
16240 #: ../fish/guestfish.pod:703
16241 msgid "Guestfish client and server versions must match exactly."
16245 #: ../fish/guestfish.pod:705
16246 msgid "PREPARED DISK IMAGES"
16250 #: ../fish/guestfish.pod:707
16252 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
16253 "preformatted disk images that guestfish can make for you to save typing. "
16254 "This is particularly useful for testing purposes. This option is used "
16255 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
16256 "can be mixed with I<-a>)."
16260 #: ../fish/guestfish.pod:713
16262 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
16263 "the second and so on. Existing files in the current directory are "
16268 #: ../fish/guestfish.pod:717
16270 "The type briefly describes how the disk should be sized, partitioned, how "
16271 "filesystem(s) should be created, and how content should be added. "
16272 "Optionally the type can be followed by extra parameters, separated by C<:> "
16273 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
16274 "allocated disk, containing a single partition, with the partition formatted "
16275 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
16280 #: ../fish/guestfish.pod:725
16281 msgid "To list the available types and any extra parameters they take, run:"
16285 #: ../fish/guestfish.pod:729
16287 "Note that the prepared filesystem is not mounted. You would usually have to "
16288 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
16292 #: ../fish/guestfish.pod:733
16294 "If any I<-N> or I<--new> options are given, the guest is automatically "
16299 #: ../fish/guestfish.pod:738
16300 msgid "Create a 100MB disk with an ext4-formatted partition:"
16304 #: ../fish/guestfish.pod:740
16307 " guestfish -N fs:ext4\n"
16312 #: ../fish/guestfish.pod:742
16313 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
16317 #: ../fish/guestfish.pod:744
16320 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
16325 #: ../fish/guestfish.pod:746
16326 msgid "Create a blank 200MB disk:"
16330 #: ../fish/guestfish.pod:748
16333 " guestfish -N disk:200M\n"
16338 #: ../fish/guestfish.pod:750
16339 msgid "PROGRESS BARS"
16343 #: ../fish/guestfish.pod:752
16345 "Some (not all) long-running commands send progress notification messages as "
16346 "they are running. Guestfish turns these messages into progress bars."
16350 #: ../fish/guestfish.pod:756
16352 "When a command that supports progress bars takes longer than two seconds to "
16353 "run, and if progress bars are enabled, then you will see one appearing below "
16358 #: ../fish/guestfish.pod:760
16361 " ><fs> copy-size /large-file /another-file 2048M\n"
16362 " / 10% [#####-----------------------------------------] 00:30\n"
16367 #: ../fish/guestfish.pod:763
16369 "The spinner on the left hand side moves round once for every progress "
16370 "notification received from the backend. This is a (reasonably) golden "
16371 "assurance that the command is \"doing something\" even if the progress bar "
16372 "is not moving, because the command is able to send the progress "
16373 "notifications. When the bar reaches 100% and the command finishes, the "
16374 "spinner disappears."
16378 #: ../fish/guestfish.pod:770
16380 "Progress bars are enabled by default when guestfish is used interactively. "
16381 "You can enable them even for non-interactive modes using I<--progress-bars>, "
16382 "and you can disable them completely using I<--no-progress-bars>."
16386 #: ../fish/guestfish.pod:775
16387 msgid "GUESTFISH COMMANDS"
16391 #: ../fish/guestfish.pod:777
16393 "The commands in this section are guestfish convenience commands, in other "
16394 "words, they are not part of the L<guestfs(3)> API."
16398 #: ../fish/guestfish.pod:780
16403 #: ../fish/guestfish.pod:782
16412 #: ../fish/guestfish.pod:785
16414 "Without any parameter, this lists all commands. With a C<cmd> parameter, "
16415 "this displays detailed help for a command."
16419 #: ../fish/guestfish.pod:788
16420 msgid "quit | exit"
16424 #: ../fish/guestfish.pod:790
16425 msgid "This exits guestfish. You can also use C<^D> key."
16429 #: ../fish/guestfish.pod:792
16430 msgid "@FISH_COMMANDS@"
16434 #: ../fish/guestfish.pod:794
16439 #: ../fish/guestfish.pod:798 ../test-tool/libguestfs-test-tool.pod:83
16444 #: ../fish/guestfish.pod:800
16446 "guestfish returns 0 if the commands completed without error, or 1 if there "
16451 #: ../fish/guestfish.pod:807
16456 #: ../fish/guestfish.pod:809
16458 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
16463 #: ../fish/guestfish.pod:812
16464 msgid "GUESTFISH_PID"
16468 #: ../fish/guestfish.pod:814
16470 "Used with the I<--remote> option to specify the remote guestfish process to "
16471 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
16475 #: ../fish/guestfish.pod:818
16480 #: ../fish/guestfish.pod:820
16482 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
16483 "not specified, the external L<hexedit(1)> program is used."
16487 #: ../fish/guestfish.pod:824
16492 #: ../fish/guestfish.pod:826
16494 "If compiled with GNU readline support, various files in the home directory "
16495 "can be used. See L</FILES>."
16499 #: ../fish/guestfish.pod:835
16501 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
16502 "effect as using the B<-v> option."
16506 #: ../fish/guestfish.pod:847
16508 "Set the path that guestfish uses to search for kernel and initrd.img. See "
16509 "the discussion of paths in L<guestfs(3)>."
16513 #: ../fish/guestfish.pod:858
16514 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
16518 #: ../fish/guestfish.pod:860
16523 #: ../fish/guestfish.pod:862
16525 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
16530 #: ../fish/guestfish.pod:877 ../test-tool/libguestfs-test-tool.pod:88
16535 #: ../fish/guestfish.pod:881
16536 msgid "$HOME/.guestfish"
16540 #: ../fish/guestfish.pod:883
16542 "If compiled with GNU readline support, then the command history is saved in "
16547 #: ../fish/guestfish.pod:886
16548 msgid "$HOME/.inputrc"
16552 #: ../fish/guestfish.pod:888
16553 msgid "/etc/inputrc"
16557 #: ../fish/guestfish.pod:890
16559 "If compiled with GNU readline support, then these files can be used to "
16560 "configure readline. For further information, please see L<readline(3)/"
16561 "INITIALIZATION FILE>."
16565 #: ../fish/guestfish.pod:894
16566 msgid "To write rules which only apply to guestfish, use:"
16570 #: ../fish/guestfish.pod:896
16580 #: ../fish/guestfish.pod:900
16582 "Variables that you can set in inputrc that change the behaviour of guestfish "
16583 "in useful ways include:"
16587 #: ../fish/guestfish.pod:905
16588 msgid "completion-ignore-case (default: on)"
16592 #: ../fish/guestfish.pod:907
16594 "By default, guestfish will ignore case when tab-completing paths on the "
16599 #: ../fish/guestfish.pod:910
16602 " set completion-ignore-case off\n"
16607 #: ../fish/guestfish.pod:912
16608 msgid "to make guestfish case sensitive."
16612 #: ../fish/guestfish.pod:916
16617 #: ../fish/guestfish.pod:918
16618 msgid "test2.img (etc)"
16622 #: ../fish/guestfish.pod:920
16624 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
16625 "will be created in the file C<test1.img> in the current directory. The "
16626 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
16627 "the same name will be overwritten."
16631 #: ../fish/guestfish.pod:929
16633 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
16634 "L<virt-edit(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, "
16635 "L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, "
16636 "L<virt-tar(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
16640 #: ../fish/guestfish.pod:953 ../test-tool/libguestfs-test-tool.pod:124
16641 #: ../fuse/guestmount.pod:198 ../inspector/virt-inspector.pl:865
16642 #: ../tools/virt-cat.pl:181 ../tools/virt-df.pl:553 ../tools/virt-edit.pl:345
16643 #: ../tools/virt-list-filesystems.pl:211 ../tools/virt-list-partitions.pl:248
16644 #: ../tools/virt-ls.pl:229 ../tools/virt-make-fs.pl:560
16645 #: ../tools/virt-rescue.pl:249 ../tools/virt-resize.pl:1415
16646 #: ../tools/virt-tar.pl:276 ../tools/virt-win-reg.pl:495
16648 "This program is free software; you can redistribute it and/or modify it "
16649 "under the terms of the GNU General Public License as published by the Free "
16650 "Software Foundation; either version 2 of the License, or (at your option) "
16651 "any later version."
16655 #: ../fish/guestfish.pod:958 ../test-tool/libguestfs-test-tool.pod:129
16656 #: ../fuse/guestmount.pod:203 ../inspector/virt-inspector.pl:870
16657 #: ../tools/virt-cat.pl:186 ../tools/virt-df.pl:558 ../tools/virt-edit.pl:350
16658 #: ../tools/virt-list-filesystems.pl:216 ../tools/virt-list-partitions.pl:253
16659 #: ../tools/virt-ls.pl:234 ../tools/virt-make-fs.pl:565
16660 #: ../tools/virt-rescue.pl:254 ../tools/virt-resize.pl:1420
16661 #: ../tools/virt-tar.pl:281 ../tools/virt-win-reg.pl:500
16663 "This program is distributed in the hope that it will be useful, but WITHOUT "
16664 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
16665 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
16670 #: ../fish/guestfish.pod:963 ../test-tool/libguestfs-test-tool.pod:134
16671 #: ../fuse/guestmount.pod:208 ../inspector/virt-inspector.pl:875
16672 #: ../tools/virt-cat.pl:191 ../tools/virt-df.pl:563 ../tools/virt-edit.pl:355
16673 #: ../tools/virt-list-filesystems.pl:221 ../tools/virt-list-partitions.pl:258
16674 #: ../tools/virt-ls.pl:239 ../tools/virt-make-fs.pl:570
16675 #: ../tools/virt-rescue.pl:259 ../tools/virt-resize.pl:1425
16676 #: ../tools/virt-tar.pl:286 ../tools/virt-win-reg.pl:505
16678 "You should have received a copy of the GNU General Public License along with "
16679 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
16680 "Ave, Cambridge, MA 02139, USA."
16684 #: ../fish/guestfish-actions.pod:1
16689 #: ../fish/guestfish-actions.pod:3
16694 #: ../fish/guestfish-actions.pod:5
16697 " add-cdrom filename\n"
16702 #: ../fish/guestfish-actions.pod:17
16704 "This call checks for the existence of C<filename>. This stops you from "
16705 "specifying other types of drive which are supported by qemu such as C<nbd:> "
16706 "and C<http:> URLs. To specify those, use the general L</config> call "
16711 #: ../fish/guestfish-actions.pod:24
16713 "If you just want to add an ISO file (often you use this as an efficient way "
16714 "to transfer large files into the guest), then you should probably use L</add-"
16715 "drive-ro> instead."
16719 #: ../fish/guestfish-actions.pod:30
16724 #: ../fish/guestfish-actions.pod:32
16729 #: ../fish/guestfish-actions.pod:34
16732 " add-drive filename\n"
16737 #: ../fish/guestfish-actions.pod:53 ../fish/guestfish-actions.pod:81
16739 "C<if=...> is set at compile time by the configuration option C<./configure --"
16740 "with-drive-if=...>. In the rare case where you might need to change this at "
16741 "run time, use L</add-drive-with-if> or L</add-drive-ro-with-if>."
16745 #: ../fish/guestfish-actions.pod:58 ../fish/guestfish-actions.pod:86
16747 "Note that this call checks for the existence of C<filename>. This stops you "
16748 "from specifying other types of drive which are supported by qemu such as "
16749 "C<nbd:> and C<http:> URLs. To specify those, use the general L</config> "
16754 #: ../fish/guestfish-actions.pod:63
16755 msgid "add-drive-ro"
16759 #: ../fish/guestfish-actions.pod:65
16764 #: ../fish/guestfish-actions.pod:67
16767 " add-drive-ro filename\n"
16772 #: ../fish/guestfish-actions.pod:91
16773 msgid "add-drive-ro-with-if"
16777 #: ../fish/guestfish-actions.pod:93
16780 " add-drive-ro-with-if filename iface\n"
16785 #: ../fish/guestfish-actions.pod:95
16787 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
16788 "interface emulation to use at run time."
16792 #: ../fish/guestfish-actions.pod:98
16793 msgid "add-drive-with-if"
16797 #: ../fish/guestfish-actions.pod:100
16800 " add-drive-with-if filename iface\n"
16805 #: ../fish/guestfish-actions.pod:102
16807 "This is the same as L</add-drive> but it allows you to specify the QEMU "
16808 "interface emulation to use at run time."
16812 #: ../fish/guestfish-actions.pod:105
16817 #: ../fish/guestfish-actions.pod:107
16820 " aug-clear augpath\n"
16825 #: ../fish/guestfish-actions.pod:112
16830 #: ../fish/guestfish-actions.pod:114
16838 #: ../fish/guestfish-actions.pod:116
16840 "Close the current Augeas handle and free up any resources used by it. After "
16841 "calling this, you have to call L</aug-init> again before you can use any "
16842 "other Augeas functions."
16846 #: ../fish/guestfish-actions.pod:121
16847 msgid "aug-defnode"
16851 #: ../fish/guestfish-actions.pod:123
16854 " aug-defnode name expr val\n"
16859 #: ../fish/guestfish-actions.pod:128
16861 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
16862 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
16863 "containing that single node."
16867 #: ../fish/guestfish-actions.pod:136
16872 #: ../fish/guestfish-actions.pod:138
16875 " aug-defvar name expr\n"
16880 #: ../fish/guestfish-actions.pod:147
16885 #: ../fish/guestfish-actions.pod:149
16888 " aug-get augpath\n"
16893 #: ../fish/guestfish-actions.pod:154
16898 #: ../fish/guestfish-actions.pod:156
16901 " aug-init root flags\n"
16906 #: ../fish/guestfish-actions.pod:162
16907 msgid "You must call this before using any other L</aug-*> commands."
16911 #: ../fish/guestfish-actions.pod:197
16912 msgid "Do not load the tree in L</aug-init>."
16916 #: ../fish/guestfish-actions.pod:201
16917 msgid "To close the handle, you can call L</aug-close>."
16921 #: ../fish/guestfish-actions.pod:205
16926 #: ../fish/guestfish-actions.pod:207
16929 " aug-insert augpath label true|false\n"
16934 #: ../fish/guestfish-actions.pod:217
16939 #: ../fish/guestfish-actions.pod:219
16947 #: ../fish/guestfish-actions.pod:226
16952 #: ../fish/guestfish-actions.pod:228
16955 " aug-ls augpath\n"
16960 #: ../fish/guestfish-actions.pod:230
16962 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
16963 "resulting nodes into alphabetical order."
16967 #: ../fish/guestfish-actions.pod:233
16972 #: ../fish/guestfish-actions.pod:235
16975 " aug-match augpath\n"
16980 #: ../fish/guestfish-actions.pod:241
16985 #: ../fish/guestfish-actions.pod:243
16988 " aug-mv src dest\n"
16993 #: ../fish/guestfish-actions.pod:248
16998 #: ../fish/guestfish-actions.pod:250
17001 " aug-rm augpath\n"
17006 #: ../fish/guestfish-actions.pod:256
17011 #: ../fish/guestfish-actions.pod:258
17019 #: ../fish/guestfish-actions.pod:262
17021 "The flags which were passed to L</aug-init> affect exactly how files are "
17026 #: ../fish/guestfish-actions.pod:265
17031 #: ../fish/guestfish-actions.pod:267
17034 " aug-set augpath val\n"
17039 #: ../fish/guestfish-actions.pod:271
17041 "In the Augeas API, it is possible to clear a node by setting the value to "
17042 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
17043 "this call. Instead you must use the L</aug-clear> call."
17047 #: ../fish/guestfish-actions.pod:276
17052 #: ../fish/guestfish-actions.pod:278
17055 " available 'groups ...'\n"
17060 #: ../fish/guestfish-actions.pod:284
17062 "The libguestfs groups, and the functions that those groups correspond to, "
17063 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
17064 "runtime by calling L</available-all-groups>."
17068 #: ../fish/guestfish-actions.pod:308
17069 msgid "You must call L</launch> before calling this function."
17073 #: ../fish/guestfish-actions.pod:330
17075 "This call was added in version C<1.0.80>. In previous versions of "
17076 "libguestfs all you could do would be to speculatively execute a command to "
17077 "find out if the daemon implemented it. See also L</version>."
17081 #: ../fish/guestfish-actions.pod:337
17082 msgid "available-all-groups"
17086 #: ../fish/guestfish-actions.pod:339
17089 " available-all-groups\n"
17094 #: ../fish/guestfish-actions.pod:341
17096 "This command returns a list of all optional groups that this daemon knows "
17097 "about. Note this returns both supported and unsupported groups. To find "
17098 "out which ones the daemon can actually support you have to call L</"
17099 "available> on each member of the returned list."
17103 #: ../fish/guestfish-actions.pod:347
17104 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
17108 #: ../fish/guestfish-actions.pod:349
17113 #: ../fish/guestfish-actions.pod:351
17116 " base64-in (base64file|-) filename\n"
17121 #: ../fish/guestfish-actions.pod:356 ../fish/guestfish-actions.pod:365
17122 #: ../fish/guestfish-actions.pod:589 ../fish/guestfish-actions.pod:736
17123 #: ../fish/guestfish-actions.pod:783 ../fish/guestfish-actions.pod:802
17124 #: ../fish/guestfish-actions.pod:1179 ../fish/guestfish-actions.pod:3803
17125 #: ../fish/guestfish-actions.pod:3815 ../fish/guestfish-actions.pod:3826
17126 #: ../fish/guestfish-actions.pod:3837 ../fish/guestfish-actions.pod:3889
17127 #: ../fish/guestfish-actions.pod:3898 ../fish/guestfish-actions.pod:3952
17128 #: ../fish/guestfish-actions.pod:3975
17129 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
17133 #: ../fish/guestfish-actions.pod:358
17138 #: ../fish/guestfish-actions.pod:360
17141 " base64-out filename (base64file|-)\n"
17146 #: ../fish/guestfish-actions.pod:367
17147 msgid "blockdev-flushbufs"
17151 #: ../fish/guestfish-actions.pod:369
17154 " blockdev-flushbufs device\n"
17159 #: ../fish/guestfish-actions.pod:376
17160 msgid "blockdev-getbsz"
17164 #: ../fish/guestfish-actions.pod:378
17167 " blockdev-getbsz device\n"
17172 #: ../fish/guestfish-actions.pod:387
17173 msgid "blockdev-getro"
17177 #: ../fish/guestfish-actions.pod:389
17180 " blockdev-getro device\n"
17185 #: ../fish/guestfish-actions.pod:396
17186 msgid "blockdev-getsize64"
17190 #: ../fish/guestfish-actions.pod:398
17193 " blockdev-getsize64 device\n"
17198 #: ../fish/guestfish-actions.pod:402
17199 msgid "See also L</blockdev-getsz>."
17203 #: ../fish/guestfish-actions.pod:406
17204 msgid "blockdev-getss"
17208 #: ../fish/guestfish-actions.pod:408
17211 " blockdev-getss device\n"
17216 #: ../fish/guestfish-actions.pod:413
17218 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
17222 #: ../fish/guestfish-actions.pod:418
17223 msgid "blockdev-getsz"
17227 #: ../fish/guestfish-actions.pod:420
17230 " blockdev-getsz device\n"
17235 #: ../fish/guestfish-actions.pod:425
17237 "See also L</blockdev-getss> for the real sector size of the device, and L</"
17238 "blockdev-getsize64> for the more useful I<size in bytes>."
17242 #: ../fish/guestfish-actions.pod:431
17243 msgid "blockdev-rereadpt"
17247 #: ../fish/guestfish-actions.pod:433
17250 " blockdev-rereadpt device\n"
17255 #: ../fish/guestfish-actions.pod:439
17256 msgid "blockdev-setbsz"
17260 #: ../fish/guestfish-actions.pod:441
17263 " blockdev-setbsz device blocksize\n"
17268 #: ../fish/guestfish-actions.pod:450
17269 msgid "blockdev-setro"
17273 #: ../fish/guestfish-actions.pod:452
17276 " blockdev-setro device\n"
17281 #: ../fish/guestfish-actions.pod:458
17282 msgid "blockdev-setrw"
17286 #: ../fish/guestfish-actions.pod:460
17289 " blockdev-setrw device\n"
17294 #: ../fish/guestfish-actions.pod:466
17295 msgid "case-sensitive-path"
17299 #: ../fish/guestfish-actions.pod:468
17302 " case-sensitive-path path\n"
17307 #: ../fish/guestfish-actions.pod:492
17309 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
17310 "WINDOWS/system32\"> (the exact return value would depend on details of how "
17311 "the directories were originally created under Windows)."
17315 #: ../fish/guestfish-actions.pod:500
17316 msgid "See also L</realpath>."
17320 #: ../fish/guestfish-actions.pod:502
17325 #: ../fish/guestfish-actions.pod:504
17333 #: ../fish/guestfish-actions.pod:508
17335 "Note that this function cannot correctly handle binary files (specifically, "
17336 "files containing C<\\0> character which is treated as end of string). For "
17337 "those you need to use the L</read-file> or L</download> functions which have "
17338 "a more complex interface."
17342 #: ../fish/guestfish-actions.pod:516
17347 #: ../fish/guestfish-actions.pod:518
17350 " checksum csumtype path\n"
17355 #: ../fish/guestfish-actions.pod:561
17356 msgid "To get the checksum for a device, use L</checksum-device>."
17360 #: ../fish/guestfish-actions.pod:563
17361 msgid "To get the checksums for many files, use L</checksums-out>."
17365 #: ../fish/guestfish-actions.pod:565
17366 msgid "checksum-device"
17370 #: ../fish/guestfish-actions.pod:567
17373 " checksum-device csumtype device\n"
17378 #: ../fish/guestfish-actions.pod:569
17380 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
17381 "device named C<device>. For the types of checksums supported see the L</"
17382 "checksum> command."
17386 #: ../fish/guestfish-actions.pod:573
17387 msgid "checksums-out"
17391 #: ../fish/guestfish-actions.pod:575
17394 " checksums-out csumtype directory (sumsfile|-)\n"
17399 #: ../fish/guestfish-actions.pod:591
17404 #: ../fish/guestfish-actions.pod:593
17407 " chmod mode path\n"
17412 #: ../fish/guestfish-actions.pod:604
17417 #: ../fish/guestfish-actions.pod:606
17420 " chown owner group path\n"
17425 #: ../fish/guestfish-actions.pod:614
17430 #: ../fish/guestfish-actions.pod:616
17433 " command 'arguments ...'\n"
17438 #: ../fish/guestfish-actions.pod:623
17440 "The single parameter is an argv-style list of arguments. The first element "
17441 "is the name of the program to run. Subsequent elements are parameters. The "
17442 "list must be non-empty (ie. must contain a program name). Note that the "
17443 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
17447 #: ../fish/guestfish-actions.pod:651
17448 msgid "command-lines"
17452 #: ../fish/guestfish-actions.pod:653
17455 " command-lines 'arguments ...'\n"
17460 #: ../fish/guestfish-actions.pod:655
17462 "This is the same as L</command>, but splits the result into a list of lines."
17466 #: ../fish/guestfish-actions.pod:658
17467 msgid "See also: L</sh-lines>"
17471 #: ../fish/guestfish-actions.pod:663
17476 #: ../fish/guestfish-actions.pod:665
17479 " config qemuparam qemuvalue\n"
17484 #: ../fish/guestfish-actions.pod:676
17489 #: ../fish/guestfish-actions.pod:678
17492 " copy-size src dest size\n"
17497 #: ../fish/guestfish-actions.pod:686
17502 #: ../fish/guestfish-actions.pod:688
17510 #: ../fish/guestfish-actions.pod:693
17515 #: ../fish/guestfish-actions.pod:695
17523 #: ../fish/guestfish-actions.pod:700
17528 #: ../fish/guestfish-actions.pod:702
17536 #: ../fish/guestfish-actions.pod:709
17538 "If the destination is a device, it must be as large or larger than the "
17539 "source file or device, otherwise the copy will fail. This command cannot do "
17540 "partial copies (see L</copy-size>)."
17544 #: ../fish/guestfish-actions.pod:713
17549 #: ../fish/guestfish-actions.pod:715
17552 " debug subcmd 'extraargs ...'\n"
17557 #: ../fish/guestfish-actions.pod:717
17559 "The L</debug> command exposes some internals of C<guestfsd> (the guestfs "
17560 "daemon) that runs inside the qemu subprocess."
17564 #: ../fish/guestfish-actions.pod:725
17565 msgid "debug-upload"
17569 #: ../fish/guestfish-actions.pod:727
17572 " debug-upload (filename|-) tmpname mode\n"
17577 #: ../fish/guestfish-actions.pod:729
17579 "The L</debug-upload> command uploads a file to the libguestfs appliance."
17583 #: ../fish/guestfish-actions.pod:738
17588 #: ../fish/guestfish-actions.pod:740
17596 #: ../fish/guestfish-actions.pod:748
17601 #: ../fish/guestfish-actions.pod:750
17609 #: ../fish/guestfish-actions.pod:759
17614 #: ../fish/guestfish-actions.pod:761
17622 #: ../fish/guestfish-actions.pod:767
17624 "Another way to get the same information is to enable verbose messages with "
17625 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
17626 "before running the program."
17630 #: ../fish/guestfish-actions.pod:772
17635 #: ../fish/guestfish-actions.pod:774
17638 " download remotefilename (filename|-)\n"
17643 #: ../fish/guestfish-actions.pod:781
17644 msgid "See also L</upload>, L</cat>."
17648 #: ../fish/guestfish-actions.pod:785
17649 msgid "download-offset"
17653 #: ../fish/guestfish-actions.pod:787
17656 " download-offset remotefilename (filename|-) offset size\n"
17661 #: ../fish/guestfish-actions.pod:795
17663 "Note that there is no limit on the amount of data that can be downloaded "
17664 "with this call, unlike with L</pread>, and this call always reads the full "
17665 "amount unless an error occurs."
17669 #: ../fish/guestfish-actions.pod:800
17670 msgid "See also L</download>, L</pread>."
17674 #: ../fish/guestfish-actions.pod:804
17675 msgid "drop-caches"
17679 #: ../fish/guestfish-actions.pod:806
17682 " drop-caches whattodrop\n"
17687 #: ../fish/guestfish-actions.pod:818
17692 #: ../fish/guestfish-actions.pod:820
17700 #: ../fish/guestfish-actions.pod:832
17705 #: ../fish/guestfish-actions.pod:834
17708 " e2fsck-f device\n"
17713 #: ../fish/guestfish-actions.pod:840
17715 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
17716 "should use L</fsck>."
17720 #: ../fish/guestfish-actions.pod:843
17721 msgid "echo-daemon"
17725 #: ../fish/guestfish-actions.pod:845
17728 " echo-daemon 'words ...'\n"
17733 #: ../fish/guestfish-actions.pod:852
17734 msgid "See also L</ping-daemon>."
17738 #: ../fish/guestfish-actions.pod:854
17743 #: ../fish/guestfish-actions.pod:856
17746 " egrep regex path\n"
17751 #: ../fish/guestfish-actions.pod:864
17756 #: ../fish/guestfish-actions.pod:866
17759 " egrepi regex path\n"
17764 #: ../fish/guestfish-actions.pod:874
17769 #: ../fish/guestfish-actions.pod:876
17772 " equal file1 file2\n"
17777 #: ../fish/guestfish-actions.pod:883
17782 #: ../fish/guestfish-actions.pod:885
17790 #: ../fish/guestfish-actions.pod:890
17791 msgid "See also L</is-file>, L</is-dir>, L</stat>."
17795 #: ../fish/guestfish-actions.pod:892
17800 #: ../fish/guestfish-actions.pod:894
17803 " fallocate path len\n"
17808 #: ../fish/guestfish-actions.pod:911
17809 msgid "fallocate64"
17813 #: ../fish/guestfish-actions.pod:913
17816 " fallocate64 path len\n"
17821 #: ../fish/guestfish-actions.pod:919
17823 "Note that this call allocates disk blocks for the file. To create a sparse "
17824 "file use L</truncate-size> instead."
17828 #: ../fish/guestfish-actions.pod:922
17830 "The deprecated call L</fallocate> does the same, but owing to an oversight "
17831 "it only allowed 30 bit lengths to be specified, effectively limiting the "
17832 "maximum size of files created through that call to 1GB."
17836 #: ../fish/guestfish-actions.pod:931
17841 #: ../fish/guestfish-actions.pod:933
17844 " fgrep pattern path\n"
17849 #: ../fish/guestfish-actions.pod:941
17854 #: ../fish/guestfish-actions.pod:943
17857 " fgrepi pattern path\n"
17862 #: ../fish/guestfish-actions.pod:951
17867 #: ../fish/guestfish-actions.pod:953
17875 #: ../fish/guestfish-actions.pod:965
17877 "This command can also be used on C</dev/> devices (and partitions, LV "
17878 "names). You can for example use this to determine if a device contains a "
17879 "filesystem, although it's usually better to use L</vfs-type>."
17883 #: ../fish/guestfish-actions.pod:975
17884 msgid "file-architecture"
17888 #: ../fish/guestfish-actions.pod:977
17891 " file-architecture filename\n"
17896 #: ../fish/guestfish-actions.pod:1080
17901 #: ../fish/guestfish-actions.pod:1082
17909 #: ../fish/guestfish-actions.pod:1086
17911 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
17912 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
17916 #: ../fish/guestfish-actions.pod:1090
17921 #: ../fish/guestfish-actions.pod:1092
17924 " fill c len path\n"
17929 #: ../fish/guestfish-actions.pod:1098
17931 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
17932 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
17933 "L</fill-pattern>."
17937 #: ../fish/guestfish-actions.pod:1103
17938 msgid "fill-pattern"
17942 #: ../fish/guestfish-actions.pod:1105
17945 " fill-pattern pattern len path\n"
17950 #: ../fish/guestfish-actions.pod:1107
17952 "This function is like L</fill> except that it creates a new file of length "
17953 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
17954 "is truncated if necessary to ensure the length of the file is exactly C<len> "
17959 #: ../fish/guestfish-actions.pod:1112
17964 #: ../fish/guestfish-actions.pod:1114
17967 " find directory\n"
17972 #: ../fish/guestfish-actions.pod:1128
17973 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
17977 #: ../fish/guestfish-actions.pod:1141
17978 msgid "See also L</find0>."
17982 #: ../fish/guestfish-actions.pod:1146
17987 #: ../fish/guestfish-actions.pod:1148
17990 " find0 directory (files|-)\n"
17995 #: ../fish/guestfish-actions.pod:1154
17997 "This command works the same way as L</find> with the following exceptions:"
18001 #: ../fish/guestfish-actions.pod:1181
18002 msgid "findfs-label"
18006 #: ../fish/guestfish-actions.pod:1183
18009 " findfs-label label\n"
18014 #: ../fish/guestfish-actions.pod:1189
18015 msgid "To find the label of a filesystem, use L</vfs-label>."
18019 #: ../fish/guestfish-actions.pod:1191
18020 msgid "findfs-uuid"
18024 #: ../fish/guestfish-actions.pod:1193
18027 " findfs-uuid uuid\n"
18032 #: ../fish/guestfish-actions.pod:1199
18033 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
18037 #: ../fish/guestfish-actions.pod:1201
18042 #: ../fish/guestfish-actions.pod:1203
18045 " fsck fstype device\n"
18050 #: ../fish/guestfish-actions.pod:1233
18055 #: ../fish/guestfish-actions.pod:1235
18063 #: ../fish/guestfish-actions.pod:1242
18064 msgid "get-autosync"
18068 #: ../fish/guestfish-actions.pod:1244
18076 #: ../fish/guestfish-actions.pod:1248
18081 #: ../fish/guestfish-actions.pod:1250
18089 #: ../fish/guestfish-actions.pod:1254
18090 msgid "get-e2label"
18094 #: ../fish/guestfish-actions.pod:1256
18097 " get-e2label device\n"
18102 #: ../fish/guestfish-actions.pod:1268
18107 #: ../fish/guestfish-actions.pod:1270
18110 " get-e2uuid device\n"
18115 #: ../fish/guestfish-actions.pod:1282
18116 msgid "get-memsize"
18120 #: ../fish/guestfish-actions.pod:1284
18128 #: ../fish/guestfish-actions.pod:1289
18130 "If L</set-memsize> was not called on this handle, and if "
18131 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
18132 "value for memsize."
18136 #: ../fish/guestfish-actions.pod:1296
18137 msgid "get-network"
18141 #: ../fish/guestfish-actions.pod:1298
18149 #: ../fish/guestfish-actions.pod:1302
18154 #: ../fish/guestfish-actions.pod:1304
18162 #: ../fish/guestfish-actions.pod:1311
18167 #: ../fish/guestfish-actions.pod:1313
18172 #: ../fish/guestfish-actions.pod:1315
18180 #: ../fish/guestfish-actions.pod:1322
18185 #: ../fish/guestfish-actions.pod:1324
18193 #: ../fish/guestfish-actions.pod:1331
18194 msgid "get-recovery-proc"
18198 #: ../fish/guestfish-actions.pod:1333
18201 " get-recovery-proc\n"
18206 #: ../fish/guestfish-actions.pod:1337
18207 msgid "get-selinux"
18211 #: ../fish/guestfish-actions.pod:1339
18219 #: ../fish/guestfish-actions.pod:1341
18221 "This returns the current setting of the selinux flag which is passed to the "
18222 "appliance at boot time. See L</set-selinux>."
18226 #: ../fish/guestfish-actions.pod:1347
18231 #: ../fish/guestfish-actions.pod:1349
18239 #: ../fish/guestfish-actions.pod:1356
18244 #: ../fish/guestfish-actions.pod:1358
18252 #: ../fish/guestfish-actions.pod:1362
18257 #: ../fish/guestfish-actions.pod:1364
18265 #: ../fish/guestfish-actions.pod:1366
18267 "Return the current umask. By default the umask is C<022> unless it has been "
18268 "set by calling L</umask>."
18272 #: ../fish/guestfish-actions.pod:1369
18273 msgid "get-verbose"
18277 #: ../fish/guestfish-actions.pod:1371
18285 #: ../fish/guestfish-actions.pod:1375
18290 #: ../fish/guestfish-actions.pod:1377
18298 #: ../fish/guestfish-actions.pod:1381
18299 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
18303 #: ../fish/guestfish-actions.pod:1384
18308 #: ../fish/guestfish-actions.pod:1386
18311 " getxattrs path\n"
18316 #: ../fish/guestfish-actions.pod:1394
18317 msgid "See also: L</lgetxattrs>, L<attr(5)>."
18321 #: ../fish/guestfish-actions.pod:1396
18322 msgid "glob-expand"
18326 #: ../fish/guestfish-actions.pod:1398
18329 " glob-expand pattern\n"
18334 #: ../fish/guestfish-actions.pod:1411
18339 #: ../fish/guestfish-actions.pod:1413
18342 " grep regex path\n"
18347 #: ../fish/guestfish-actions.pod:1421
18352 #: ../fish/guestfish-actions.pod:1423
18355 " grepi regex path\n"
18360 #: ../fish/guestfish-actions.pod:1431
18361 msgid "grub-install"
18365 #: ../fish/guestfish-actions.pod:1433
18368 " grub-install root device\n"
18373 #: ../fish/guestfish-actions.pod:1449
18378 #: ../fish/guestfish-actions.pod:1451
18386 #: ../fish/guestfish-actions.pod:1459
18391 #: ../fish/guestfish-actions.pod:1461
18394 " head-n nrlines path\n"
18399 #: ../fish/guestfish-actions.pod:1474
18404 #: ../fish/guestfish-actions.pod:1476
18412 #: ../fish/guestfish-actions.pod:1484
18417 #: ../fish/guestfish-actions.pod:1486
18420 " initrd-cat initrdpath filename\n"
18425 #: ../fish/guestfish-actions.pod:1498
18426 msgid "See also L</initrd-list>."
18430 #: ../fish/guestfish-actions.pod:1503
18431 msgid "initrd-list"
18435 #: ../fish/guestfish-actions.pod:1505
18438 " initrd-list path\n"
18443 #: ../fish/guestfish-actions.pod:1517
18444 msgid "inotify-add-watch"
18448 #: ../fish/guestfish-actions.pod:1519
18451 " inotify-add-watch path mask\n"
18456 #: ../fish/guestfish-actions.pod:1531
18457 msgid "inotify-close"
18461 #: ../fish/guestfish-actions.pod:1533
18469 #: ../fish/guestfish-actions.pod:1539
18470 msgid "inotify-files"
18474 #: ../fish/guestfish-actions.pod:1541
18482 #: ../fish/guestfish-actions.pod:1543
18484 "This function is a helpful wrapper around L</inotify-read> which just "
18485 "returns a list of pathnames of objects that were touched. The returned "
18486 "pathnames are sorted and deduplicated."
18490 #: ../fish/guestfish-actions.pod:1547
18491 msgid "inotify-init"
18495 #: ../fish/guestfish-actions.pod:1549
18498 " inotify-init maxevents\n"
18503 #: ../fish/guestfish-actions.pod:1555
18505 "C<maxevents> is the maximum number of events which will be queued up between "
18506 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
18507 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
18508 "default was 16384 events. Beyond this limit, the kernel throws away events, "
18509 "but records the fact that it threw them away by setting a flag "
18510 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
18514 #: ../fish/guestfish-actions.pod:1565
18516 "Before any events are generated, you have to add some watches to the "
18517 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
18518 "L</inotify-watch-all>."
18522 #: ../fish/guestfish-actions.pod:1571
18524 "Queued up events should be read periodically by calling L</inotify-read> (or "
18525 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
18526 "If you don't read the events out often enough then you risk the internal "
18527 "queue overflowing."
18531 #: ../fish/guestfish-actions.pod:1578
18533 "The handle should be closed after use by calling L</inotify-close>. This "
18534 "also removes any watches automatically."
18538 #: ../fish/guestfish-actions.pod:1587
18539 msgid "inotify-read"
18543 #: ../fish/guestfish-actions.pod:1589
18551 #: ../fish/guestfish-actions.pod:1602
18552 msgid "inotify-rm-watch"
18556 #: ../fish/guestfish-actions.pod:1604
18559 " inotify-rm-watch wd\n"
18564 #: ../fish/guestfish-actions.pod:1606
18565 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
18569 #: ../fish/guestfish-actions.pod:1609
18570 msgid "inspect-get-arch"
18574 #: ../fish/guestfish-actions.pod:1611
18577 " inspect-get-arch root\n"
18582 #: ../fish/guestfish-actions.pod:1613 ../fish/guestfish-actions.pod:1629
18583 #: ../fish/guestfish-actions.pod:1675 ../fish/guestfish-actions.pod:1693
18584 #: ../fish/guestfish-actions.pod:1714 ../fish/guestfish-actions.pod:1729
18585 #: ../fish/guestfish-actions.pod:1752 ../fish/guestfish-actions.pod:1769
18587 "This function should only be called with a root device string as returned by "
18592 #: ../fish/guestfish-actions.pod:1616
18594 "This returns the architecture of the inspected operating system. The "
18595 "possible return values are listed under L</file-architecture>."
18599 #: ../fish/guestfish-actions.pod:1625
18600 msgid "inspect-get-distro"
18604 #: ../fish/guestfish-actions.pod:1627
18607 " inspect-get-distro root\n"
18612 #: ../fish/guestfish-actions.pod:1671
18613 msgid "inspect-get-filesystems"
18617 #: ../fish/guestfish-actions.pod:1673
18620 " inspect-get-filesystems root\n"
18625 #: ../fish/guestfish-actions.pod:1686
18627 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
18628 "get-mountpoints>."
18632 #: ../fish/guestfish-actions.pod:1689
18633 msgid "inspect-get-major-version"
18637 #: ../fish/guestfish-actions.pod:1691
18640 " inspect-get-major-version root\n"
18645 #: ../fish/guestfish-actions.pod:1710
18646 msgid "inspect-get-minor-version"
18650 #: ../fish/guestfish-actions.pod:1712
18653 " inspect-get-minor-version root\n"
18658 #: ../fish/guestfish-actions.pod:1722
18660 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
18661 "get-major-version>."
18665 #: ../fish/guestfish-actions.pod:1725
18666 msgid "inspect-get-mountpoints"
18670 #: ../fish/guestfish-actions.pod:1727
18673 " inspect-get-mountpoints root\n"
18678 #: ../fish/guestfish-actions.pod:1745
18680 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
18681 "get-filesystems>."
18685 #: ../fish/guestfish-actions.pod:1748
18686 msgid "inspect-get-product-name"
18690 #: ../fish/guestfish-actions.pod:1750
18693 " inspect-get-product-name root\n"
18698 #: ../fish/guestfish-actions.pod:1765
18699 msgid "inspect-get-type"
18703 #: ../fish/guestfish-actions.pod:1767
18706 " inspect-get-type root\n"
18711 #: ../fish/guestfish-actions.pod:1796
18716 #: ../fish/guestfish-actions.pod:1798
18724 #: ../fish/guestfish-actions.pod:1813
18726 "You can pass the root string(s) returned to other L</inspect-get-*> "
18727 "functions in order to query further information about each operating system, "
18728 "such as the name and version."
18732 #: ../fish/guestfish-actions.pod:1818
18734 "This function uses other libguestfs features such as L</mount-ro> and L</"
18735 "umount-all> in order to mount and unmount filesystems and look at the "
18736 "contents. This should be called with no disks currently mounted. The "
18737 "function may also use Augeas, so any existing Augeas handle will be closed."
18741 #: ../fish/guestfish-actions.pod:1830 ../fish/guestfish-actions.pod:1986
18742 #: ../fish/guestfish-actions.pod:2032
18743 msgid "See also L</list-filesystems>."
18747 #: ../fish/guestfish-actions.pod:1832
18748 msgid "is-blockdev"
18752 #: ../fish/guestfish-actions.pod:1834
18755 " is-blockdev path\n"
18760 #: ../fish/guestfish-actions.pod:1839 ../fish/guestfish-actions.pod:1857
18761 #: ../fish/guestfish-actions.pod:1876 ../fish/guestfish-actions.pod:1885
18762 #: ../fish/guestfish-actions.pod:1895 ../fish/guestfish-actions.pod:1929
18763 #: ../fish/guestfish-actions.pod:1938
18764 msgid "See also L</stat>."
18768 #: ../fish/guestfish-actions.pod:1841
18773 #: ../fish/guestfish-actions.pod:1843
18781 #: ../fish/guestfish-actions.pod:1850
18786 #: ../fish/guestfish-actions.pod:1852
18789 " is-chardev path\n"
18794 #: ../fish/guestfish-actions.pod:1859
18799 #: ../fish/guestfish-actions.pod:1861
18807 #: ../fish/guestfish-actions.pod:1868
18812 #: ../fish/guestfish-actions.pod:1870
18820 #: ../fish/guestfish-actions.pod:1878
18825 #: ../fish/guestfish-actions.pod:1880
18833 #: ../fish/guestfish-actions.pod:1887
18838 #: ../fish/guestfish-actions.pod:1889
18846 #: ../fish/guestfish-actions.pod:1897
18847 msgid "is-launching"
18851 #: ../fish/guestfish-actions.pod:1899
18859 #: ../fish/guestfish-actions.pod:1906
18864 #: ../fish/guestfish-actions.pod:1908
18872 #: ../fish/guestfish-actions.pod:1913
18877 #: ../fish/guestfish-actions.pod:1915
18885 #: ../fish/guestfish-actions.pod:1922
18890 #: ../fish/guestfish-actions.pod:1924
18893 " is-socket path\n"
18898 #: ../fish/guestfish-actions.pod:1931
18903 #: ../fish/guestfish-actions.pod:1933
18906 " is-symlink path\n"
18911 #: ../fish/guestfish-actions.pod:1940
18912 msgid "kill-subprocess"
18916 #: ../fish/guestfish-actions.pod:1942
18919 " kill-subprocess\n"
18924 #: ../fish/guestfish-actions.pod:1946
18929 #: ../fish/guestfish-actions.pod:1948
18934 #: ../fish/guestfish-actions.pod:1950
18942 #: ../fish/guestfish-actions.pod:1958
18947 #: ../fish/guestfish-actions.pod:1960
18950 " lchown owner group path\n"
18955 #: ../fish/guestfish-actions.pod:1962
18957 "Change the file owner to C<owner> and group to C<group>. This is like L</"
18958 "chown> but if C<path> is a symlink then the link itself is changed, not the "
18963 #: ../fish/guestfish-actions.pod:1970
18968 #: ../fish/guestfish-actions.pod:1972
18971 " lgetxattrs path\n"
18976 #: ../fish/guestfish-actions.pod:1974
18978 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
18979 "it returns the extended attributes of the link itself."
18983 #: ../fish/guestfish-actions.pod:1978
18984 msgid "list-devices"
18988 #: ../fish/guestfish-actions.pod:1980
18996 #: ../fish/guestfish-actions.pod:1988
18997 msgid "list-filesystems"
19001 #: ../fish/guestfish-actions.pod:1990
19004 " list-filesystems\n"
19009 #: ../fish/guestfish-actions.pod:2009
19011 "This command runs other libguestfs commands, which might include L</mount> "
19012 "and L</umount>, and therefore you should use this soon after launch and only "
19013 "when nothing is mounted."
19017 #: ../fish/guestfish-actions.pod:2013
19019 "Not all of the filesystems returned will be mountable. In particular, swap "
19020 "partitions are returned in the list. Also this command does not check that "
19021 "each filesystem found is valid and mountable, and some filesystems might be "
19022 "mountable but require special options. Filesystems may not all belong to a "
19023 "single logical operating system (use L</inspect-os> to look for OSes)."
19027 #: ../fish/guestfish-actions.pod:2021
19028 msgid "list-partitions"
19032 #: ../fish/guestfish-actions.pod:2023
19035 " list-partitions\n"
19040 #: ../fish/guestfish-actions.pod:2029
19042 "This does not return logical volumes. For that you will need to call L</"
19047 #: ../fish/guestfish-actions.pod:2034
19052 #: ../fish/guestfish-actions.pod:2036
19060 #: ../fish/guestfish-actions.pod:2044
19065 #: ../fish/guestfish-actions.pod:2046
19068 " ln target linkname\n"
19073 #: ../fish/guestfish-actions.pod:2050
19078 #: ../fish/guestfish-actions.pod:2052
19081 " ln-f target linkname\n"
19086 #: ../fish/guestfish-actions.pod:2057
19091 #: ../fish/guestfish-actions.pod:2059
19094 " ln-s target linkname\n"
19099 #: ../fish/guestfish-actions.pod:2063
19104 #: ../fish/guestfish-actions.pod:2065
19107 " ln-sf target linkname\n"
19112 #: ../fish/guestfish-actions.pod:2070
19113 msgid "lremovexattr"
19117 #: ../fish/guestfish-actions.pod:2072
19120 " lremovexattr xattr path\n"
19125 #: ../fish/guestfish-actions.pod:2074
19127 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
19128 "it removes an extended attribute of the link itself."
19132 #: ../fish/guestfish-actions.pod:2078
19137 #: ../fish/guestfish-actions.pod:2080
19145 #: ../fish/guestfish-actions.pod:2086
19147 "This command is mostly useful for interactive sessions. Programs should "
19148 "probably use L</readdir> instead."
19152 #: ../fish/guestfish-actions.pod:2089
19157 #: ../fish/guestfish-actions.pod:2091
19160 " lsetxattr xattr val vallen path\n"
19165 #: ../fish/guestfish-actions.pod:2093
19167 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
19168 "sets an extended attribute of the link itself."
19172 #: ../fish/guestfish-actions.pod:2097
19177 #: ../fish/guestfish-actions.pod:2099
19185 #: ../fish/guestfish-actions.pod:2103
19187 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
19188 "the link is stat-ed, not the file it refers to."
19192 #: ../fish/guestfish-actions.pod:2109
19197 #: ../fish/guestfish-actions.pod:2111
19200 " lstatlist path 'names ...'\n"
19205 #: ../fish/guestfish-actions.pod:2113
19207 "This call allows you to perform the L</lstat> operation on multiple files, "
19208 "where all files are in the directory C<path>. C<names> is the list of files "
19209 "from this directory."
19213 #: ../fish/guestfish-actions.pod:2122
19215 "This call is intended for programs that want to efficiently list a directory "
19216 "contents without making many round-trips. See also L</lxattrlist> for a "
19217 "similarly efficient call for getting extended attributes. Very long "
19218 "directory listings might cause the protocol message size to be exceeded, "
19219 "causing this call to fail. The caller must split up such requests into "
19220 "smaller groups of names."
19224 #: ../fish/guestfish-actions.pod:2130
19225 msgid "luks-add-key"
19229 #: ../fish/guestfish-actions.pod:2132
19232 " luks-add-key device keyslot\n"
19237 #: ../fish/guestfish-actions.pod:2139
19239 "Note that if C<keyslot> already contains a key, then this command will "
19240 "fail. You have to use L</luks-kill-slot> first to remove that key."
19244 #: ../fish/guestfish-actions.pod:2143 ../fish/guestfish-actions.pod:2165
19245 #: ../fish/guestfish-actions.pod:2178 ../fish/guestfish-actions.pod:2192
19246 #: ../fish/guestfish-actions.pod:2215 ../fish/guestfish-actions.pod:2225
19248 "This command has one or more key or passphrase parameters. Guestfish will "
19249 "prompt for these separately."
19253 #: ../fish/guestfish-actions.pod:2146
19258 #: ../fish/guestfish-actions.pod:2148
19261 " luks-close device\n"
19266 #: ../fish/guestfish-actions.pod:2150
19268 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
19269 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
19270 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
19275 #: ../fish/guestfish-actions.pod:2156
19276 msgid "luks-format"
19280 #: ../fish/guestfish-actions.pod:2158
19283 " luks-format device keyslot\n"
19288 #: ../fish/guestfish-actions.pod:2171
19289 msgid "luks-format-cipher"
19293 #: ../fish/guestfish-actions.pod:2173
19296 " luks-format-cipher device keyslot cipher\n"
19301 #: ../fish/guestfish-actions.pod:2175
19303 "This command is the same as L</luks-format> but it also allows you to set "
19304 "the C<cipher> used."
19308 #: ../fish/guestfish-actions.pod:2184
19309 msgid "luks-kill-slot"
19313 #: ../fish/guestfish-actions.pod:2186
19316 " luks-kill-slot device keyslot\n"
19321 #: ../fish/guestfish-actions.pod:2195
19326 #: ../fish/guestfish-actions.pod:2197
19329 " luks-open device mapname\n"
19334 #: ../fish/guestfish-actions.pod:2211
19336 "If this block device contains LVM volume groups, then calling L</vgscan> "
19337 "followed by L</vg-activate-all> will make them visible."
19341 #: ../fish/guestfish-actions.pod:2218
19342 msgid "luks-open-ro"
19346 #: ../fish/guestfish-actions.pod:2220
19349 " luks-open-ro device mapname\n"
19354 #: ../fish/guestfish-actions.pod:2222
19356 "This is the same as L</luks-open> except that a read-only mapping is created."
19360 #: ../fish/guestfish-actions.pod:2228
19365 #: ../fish/guestfish-actions.pod:2230
19368 " lvcreate logvol volgroup mbytes\n"
19373 #: ../fish/guestfish-actions.pod:2235
19374 msgid "lvm-clear-filter"
19378 #: ../fish/guestfish-actions.pod:2237
19381 " lvm-clear-filter\n"
19386 #: ../fish/guestfish-actions.pod:2239
19388 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
19393 #: ../fish/guestfish-actions.pod:2245
19394 msgid "lvm-remove-all"
19398 #: ../fish/guestfish-actions.pod:2247
19401 " lvm-remove-all\n"
19406 #: ../fish/guestfish-actions.pod:2255
19407 msgid "lvm-set-filter"
19411 #: ../fish/guestfish-actions.pod:2257
19414 " lvm-set-filter 'devices ...'\n"
19419 #: ../fish/guestfish-actions.pod:2282
19424 #: ../fish/guestfish-actions.pod:2284
19427 " lvremove device\n"
19432 #: ../fish/guestfish-actions.pod:2292
19437 #: ../fish/guestfish-actions.pod:2294
19440 " lvrename logvol newlogvol\n"
19445 #: ../fish/guestfish-actions.pod:2298
19450 #: ../fish/guestfish-actions.pod:2300
19453 " lvresize device mbytes\n"
19458 #: ../fish/guestfish-actions.pod:2306
19459 msgid "lvresize-free"
19463 #: ../fish/guestfish-actions.pod:2308
19466 " lvresize-free lv percent\n"
19471 #: ../fish/guestfish-actions.pod:2316
19476 #: ../fish/guestfish-actions.pod:2318
19484 #: ../fish/guestfish-actions.pod:2326
19485 msgid "See also L</lvs-full>, L</list-filesystems>."
19489 #: ../fish/guestfish-actions.pod:2328
19494 #: ../fish/guestfish-actions.pod:2330
19502 #: ../fish/guestfish-actions.pod:2335
19507 #: ../fish/guestfish-actions.pod:2337
19515 #: ../fish/guestfish-actions.pod:2341
19520 #: ../fish/guestfish-actions.pod:2343
19523 " lxattrlist path 'names ...'\n"
19528 #: ../fish/guestfish-actions.pod:2359
19530 "This call is intended for programs that want to efficiently list a directory "
19531 "contents without making many round-trips. See also L</lstatlist> for a "
19532 "similarly efficient call for getting standard stats. Very long directory "
19533 "listings might cause the protocol message size to be exceeded, causing this "
19534 "call to fail. The caller must split up such requests into smaller groups of "
19539 #: ../fish/guestfish-actions.pod:2367
19544 #: ../fish/guestfish-actions.pod:2369
19552 #: ../fish/guestfish-actions.pod:2373
19557 #: ../fish/guestfish-actions.pod:2375
19560 " mkdir-mode path mode\n"
19565 #: ../fish/guestfish-actions.pod:2384
19566 msgid "See also L</mkdir>, L</umask>"
19570 #: ../fish/guestfish-actions.pod:2386
19575 #: ../fish/guestfish-actions.pod:2388
19583 #: ../fish/guestfish-actions.pod:2393
19588 #: ../fish/guestfish-actions.pod:2395
19591 " mkdtemp template\n"
19596 #: ../fish/guestfish-actions.pod:2416
19601 #: ../fish/guestfish-actions.pod:2418
19604 " mke2fs-J fstype blocksize device journal\n"
19609 #: ../fish/guestfish-actions.pod:2426
19610 msgid "See also L</mke2journal>."
19614 #: ../fish/guestfish-actions.pod:2428
19619 #: ../fish/guestfish-actions.pod:2430
19622 " mke2fs-JL fstype blocksize device label\n"
19627 #: ../fish/guestfish-actions.pod:2435
19628 msgid "See also L</mke2journal-L>."
19632 #: ../fish/guestfish-actions.pod:2437
19637 #: ../fish/guestfish-actions.pod:2439
19640 " mke2fs-JU fstype blocksize device uuid\n"
19645 #: ../fish/guestfish-actions.pod:2444
19646 msgid "See also L</mke2journal-U>."
19650 #: ../fish/guestfish-actions.pod:2446
19651 msgid "mke2journal"
19655 #: ../fish/guestfish-actions.pod:2448
19658 " mke2journal blocksize device\n"
19663 #: ../fish/guestfish-actions.pod:2455
19664 msgid "mke2journal-L"
19668 #: ../fish/guestfish-actions.pod:2457
19671 " mke2journal-L blocksize label device\n"
19676 #: ../fish/guestfish-actions.pod:2461
19677 msgid "mke2journal-U"
19681 #: ../fish/guestfish-actions.pod:2463
19684 " mke2journal-U blocksize uuid device\n"
19689 #: ../fish/guestfish-actions.pod:2467
19694 #: ../fish/guestfish-actions.pod:2469
19697 " mkfifo mode path\n"
19702 #: ../fish/guestfish-actions.pod:2471
19704 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
19705 "is just a convenient wrapper around L</mknod>."
19709 #: ../fish/guestfish-actions.pod:2477
19714 #: ../fish/guestfish-actions.pod:2479
19717 " mkfs fstype device\n"
19722 #: ../fish/guestfish-actions.pod:2485
19727 #: ../fish/guestfish-actions.pod:2487
19730 " mkfs-b fstype blocksize device\n"
19735 #: ../fish/guestfish-actions.pod:2489
19737 "This call is similar to L</mkfs>, but it allows you to control the block "
19738 "size of the resulting filesystem. Supported block sizes depend on the "
19739 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
19743 #: ../fish/guestfish-actions.pod:2497
19744 msgid "mkmountpoint"
19748 #: ../fish/guestfish-actions.pod:2499
19751 " mkmountpoint exemptpath\n"
19756 #: ../fish/guestfish-actions.pod:2501
19758 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
19759 "to create extra mountpoints before mounting the first filesystem."
19763 #: ../fish/guestfish-actions.pod:2525
19768 #: ../fish/guestfish-actions.pod:2527
19771 " mknod mode devmajor devminor path\n"
19776 #: ../fish/guestfish-actions.pod:2537
19778 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
19779 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
19780 "regular file). These constants are available in the standard Linux header "
19781 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
19782 "wrappers around this command which bitwise OR in the appropriate constant "
19787 #: ../fish/guestfish-actions.pod:2547
19792 #: ../fish/guestfish-actions.pod:2549
19795 " mknod-b mode devmajor devminor path\n"
19800 #: ../fish/guestfish-actions.pod:2551
19802 "This call creates a block device node called C<path> with mode C<mode> and "
19803 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
19804 "wrapper around L</mknod>."
19808 #: ../fish/guestfish-actions.pod:2557
19813 #: ../fish/guestfish-actions.pod:2559
19816 " mknod-c mode devmajor devminor path\n"
19821 #: ../fish/guestfish-actions.pod:2561
19823 "This call creates a char device node called C<path> with mode C<mode> and "
19824 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
19825 "wrapper around L</mknod>."
19829 #: ../fish/guestfish-actions.pod:2567
19834 #: ../fish/guestfish-actions.pod:2569
19842 #: ../fish/guestfish-actions.pod:2573
19847 #: ../fish/guestfish-actions.pod:2575
19850 " mkswap-L label device\n"
19855 #: ../fish/guestfish-actions.pod:2583
19860 #: ../fish/guestfish-actions.pod:2585
19863 " mkswap-U uuid device\n"
19868 #: ../fish/guestfish-actions.pod:2589
19869 msgid "mkswap-file"
19873 #: ../fish/guestfish-actions.pod:2591
19876 " mkswap-file path\n"
19881 #: ../fish/guestfish-actions.pod:2595
19883 "This command just writes a swap file signature to an existing file. To "
19884 "create the file itself, use something like L</fallocate>."
19888 #: ../fish/guestfish-actions.pod:2598
19893 #: ../fish/guestfish-actions.pod:2600
19896 " modprobe modulename\n"
19901 #: ../fish/guestfish-actions.pod:2607
19906 #: ../fish/guestfish-actions.pod:2609
19909 " mount device mountpoint\n"
19914 #: ../fish/guestfish-actions.pod:2625
19916 "B<Important note:> When you use this call, the filesystem options C<sync> "
19917 "and C<noatime> are set implicitly. This was originally done because we "
19918 "thought it would improve reliability, but it turns out that I<-o sync> has a "
19919 "very large negative performance impact and negligible effect on "
19920 "reliability. Therefore we recommend that you avoid using L</mount> in any "
19921 "code that needs performance, and instead use L</mount-options> (use an empty "
19922 "string for the first parameter if you don't want any options)."
19926 #: ../fish/guestfish-actions.pod:2635
19931 #: ../fish/guestfish-actions.pod:2637
19934 " mount-loop file mountpoint\n"
19939 #: ../fish/guestfish-actions.pod:2643
19940 msgid "mount-options"
19944 #: ../fish/guestfish-actions.pod:2645
19947 " mount-options options device mountpoint\n"
19952 #: ../fish/guestfish-actions.pod:2647
19954 "This is the same as the L</mount> command, but it allows you to set the "
19955 "mount options as for the L<mount(8)> I<-o> flag."
19959 #: ../fish/guestfish-actions.pod:2655
19964 #: ../fish/guestfish-actions.pod:2657
19967 " mount-ro device mountpoint\n"
19972 #: ../fish/guestfish-actions.pod:2659
19974 "This is the same as the L</mount> command, but it mounts the filesystem with "
19975 "the read-only (I<-o ro>) flag."
19979 #: ../fish/guestfish-actions.pod:2662
19984 #: ../fish/guestfish-actions.pod:2664
19987 " mount-vfs options vfstype device mountpoint\n"
19992 #: ../fish/guestfish-actions.pod:2666
19994 "This is the same as the L</mount> command, but it allows you to set both the "
19995 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
19999 #: ../fish/guestfish-actions.pod:2670
20000 msgid "mountpoints"
20004 #: ../fish/guestfish-actions.pod:2672
20012 #: ../fish/guestfish-actions.pod:2674
20014 "This call is similar to L</mounts>. That call returns a list of devices. "
20015 "This one returns a hash table (map) of device name to directory where the "
20016 "device is mounted."
20020 #: ../fish/guestfish-actions.pod:2678
20025 #: ../fish/guestfish-actions.pod:2680
20033 #: ../fish/guestfish-actions.pod:2687
20034 msgid "See also: L</mountpoints>"
20038 #: ../fish/guestfish-actions.pod:2689
20043 #: ../fish/guestfish-actions.pod:2691
20051 #: ../fish/guestfish-actions.pod:2696
20052 msgid "ntfs-3g-probe"
20056 #: ../fish/guestfish-actions.pod:2698
20059 " ntfs-3g-probe true|false device\n"
20064 #: ../fish/guestfish-actions.pod:2712
20069 #: ../fish/guestfish-actions.pod:2714
20072 " ntfsresize device\n"
20077 #: ../fish/guestfish-actions.pod:2720
20078 msgid "ntfsresize-size"
20082 #: ../fish/guestfish-actions.pod:2722
20085 " ntfsresize-size device size\n"
20090 #: ../fish/guestfish-actions.pod:2724
20092 "This command is the same as L</ntfsresize> except that it allows you to "
20093 "specify the new size (in bytes) explicitly."
20097 #: ../fish/guestfish-actions.pod:2727
20102 #: ../fish/guestfish-actions.pod:2729
20105 " part-add device prlogex startsect endsect\n"
20110 #: ../fish/guestfish-actions.pod:2731
20112 "This command adds a partition to C<device>. If there is no partition table "
20113 "on the device, call L</part-init> first."
20117 #: ../fish/guestfish-actions.pod:2743
20119 "Creating a partition which covers the whole disk is not so easy. Use L</"
20120 "part-disk> to do that."
20124 #: ../fish/guestfish-actions.pod:2746
20129 #: ../fish/guestfish-actions.pod:2748
20132 " part-del device partnum\n"
20137 #: ../fish/guestfish-actions.pod:2756
20142 #: ../fish/guestfish-actions.pod:2758
20145 " part-disk device parttype\n"
20150 #: ../fish/guestfish-actions.pod:2760
20152 "This command is simply a combination of L</part-init> followed by L</part-"
20153 "add> to create a single primary partition covering the whole disk."
20157 #: ../fish/guestfish-actions.pod:2764
20159 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
20160 "possible values are described in L</part-init>."
20164 #: ../fish/guestfish-actions.pod:2770
20165 msgid "part-get-bootable"
20169 #: ../fish/guestfish-actions.pod:2772
20172 " part-get-bootable device partnum\n"
20177 #: ../fish/guestfish-actions.pod:2777
20178 msgid "See also L</part-set-bootable>."
20182 #: ../fish/guestfish-actions.pod:2779
20183 msgid "part-get-mbr-id"
20187 #: ../fish/guestfish-actions.pod:2781
20190 " part-get-mbr-id device partnum\n"
20195 #: ../fish/guestfish-actions.pod:2786 ../fish/guestfish-actions.pod:2924
20197 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
20198 "undefined results for other partition table types (see L</part-get-"
20203 #: ../fish/guestfish-actions.pod:2790
20204 msgid "part-get-parttype"
20208 #: ../fish/guestfish-actions.pod:2792
20211 " part-get-parttype device\n"
20216 #: ../fish/guestfish-actions.pod:2797
20218 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
20219 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
20220 "possible, although unusual. See L</part-init> for a full list."
20224 #: ../fish/guestfish-actions.pod:2802
20229 #: ../fish/guestfish-actions.pod:2804
20232 " part-init device parttype\n"
20237 #: ../fish/guestfish-actions.pod:2810
20239 "Initially there are no partitions. Following this, you should call L</part-"
20240 "add> for each partition required."
20244 #: ../fish/guestfish-actions.pod:2873
20249 #: ../fish/guestfish-actions.pod:2875
20252 " part-list device\n"
20257 #: ../fish/guestfish-actions.pod:2890
20259 "Start of the partition I<in bytes>. To get sectors you have to divide by "
20260 "the device's sector size, see L</blockdev-getss>."
20264 #: ../fish/guestfish-actions.pod:2903
20265 msgid "part-set-bootable"
20269 #: ../fish/guestfish-actions.pod:2905
20272 " part-set-bootable device partnum true|false\n"
20277 #: ../fish/guestfish-actions.pod:2914
20278 msgid "part-set-mbr-id"
20282 #: ../fish/guestfish-actions.pod:2916
20285 " part-set-mbr-id device partnum idbyte\n"
20290 #: ../fish/guestfish-actions.pod:2928
20291 msgid "part-set-name"
20295 #: ../fish/guestfish-actions.pod:2930
20298 " part-set-name device partnum name\n"
20303 #: ../fish/guestfish-actions.pod:2938
20304 msgid "part-to-dev"
20308 #: ../fish/guestfish-actions.pod:2940
20311 " part-to-dev partition\n"
20316 #: ../fish/guestfish-actions.pod:2946
20318 "The named partition must exist, for example as a string returned from L</"
20319 "list-partitions>."
20323 #: ../fish/guestfish-actions.pod:2949
20324 msgid "ping-daemon"
20328 #: ../fish/guestfish-actions.pod:2951
20336 #: ../fish/guestfish-actions.pod:2958
20341 #: ../fish/guestfish-actions.pod:2960
20344 " pread path count offset\n"
20349 #: ../fish/guestfish-actions.pod:2968
20350 msgid "See also L</pwrite>."
20354 #: ../fish/guestfish-actions.pod:2973
20359 #: ../fish/guestfish-actions.pod:2975
20362 " pvcreate device\n"
20367 #: ../fish/guestfish-actions.pod:2981
20372 #: ../fish/guestfish-actions.pod:2983
20375 " pvremove device\n"
20380 #: ../fish/guestfish-actions.pod:2992
20385 #: ../fish/guestfish-actions.pod:2994
20388 " pvresize device\n"
20393 #: ../fish/guestfish-actions.pod:2999
20394 msgid "pvresize-size"
20398 #: ../fish/guestfish-actions.pod:3001
20401 " pvresize-size device size\n"
20406 #: ../fish/guestfish-actions.pod:3003
20408 "This command is the same as L</pvresize> except that it allows you to "
20409 "specify the new size (in bytes) explicitly."
20413 #: ../fish/guestfish-actions.pod:3006
20418 #: ../fish/guestfish-actions.pod:3008
20426 #: ../fish/guestfish-actions.pod:3016
20427 msgid "See also L</pvs-full>."
20431 #: ../fish/guestfish-actions.pod:3018
20436 #: ../fish/guestfish-actions.pod:3020
20444 #: ../fish/guestfish-actions.pod:3025
20449 #: ../fish/guestfish-actions.pod:3027
20457 #: ../fish/guestfish-actions.pod:3031
20462 #: ../fish/guestfish-actions.pod:3033
20465 " pwrite path content offset\n"
20470 #: ../fish/guestfish-actions.pod:3044
20471 msgid "See also L</pread>."
20475 #: ../fish/guestfish-actions.pod:3049
20480 #: ../fish/guestfish-actions.pod:3051
20483 " read-file path\n"
20488 #: ../fish/guestfish-actions.pod:3056
20490 "Unlike L</cat>, this function can correctly handle files that contain "
20491 "embedded ASCII NUL characters. However unlike L</download>, this function "
20492 "is limited in the total size of file that can be handled."
20496 #: ../fish/guestfish-actions.pod:3064
20501 #: ../fish/guestfish-actions.pod:3066
20504 " read-lines path\n"
20509 #: ../fish/guestfish-actions.pod:3073
20511 "Note that this function cannot correctly handle binary files (specifically, "
20512 "files containing C<\\0> character which is treated as end of line). For "
20513 "those you need to use the L</read-file> function which has a more complex "
20518 #: ../fish/guestfish-actions.pod:3078
20523 #: ../fish/guestfish-actions.pod:3080
20531 #: ../fish/guestfish-actions.pod:3132
20533 "This function is primarily intended for use by programs. To get a simple "
20534 "list of names, use L</ls>. To get a printable directory for human "
20535 "consumption, use L</ll>."
20539 #: ../fish/guestfish-actions.pod:3136
20544 #: ../fish/guestfish-actions.pod:3138
20552 #: ../fish/guestfish-actions.pod:3142
20553 msgid "readlinklist"
20557 #: ../fish/guestfish-actions.pod:3144
20560 " readlinklist path 'names ...'\n"
20565 #: ../fish/guestfish-actions.pod:3168
20570 #: ../fish/guestfish-actions.pod:3170
20578 #: ../fish/guestfish-actions.pod:3175
20579 msgid "removexattr"
20583 #: ../fish/guestfish-actions.pod:3177
20586 " removexattr xattr path\n"
20591 #: ../fish/guestfish-actions.pod:3182
20592 msgid "See also: L</lremovexattr>, L<attr(5)>."
20596 #: ../fish/guestfish-actions.pod:3184
20601 #: ../fish/guestfish-actions.pod:3186
20604 " resize2fs device\n"
20609 #: ../fish/guestfish-actions.pod:3191
20611 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
20612 "before calling this command. For unknown reasons C<resize2fs> sometimes "
20613 "gives an error about this and sometimes not. In any case, it is always safe "
20614 "to call L</e2fsck-f> before calling this function."
20618 #: ../fish/guestfish-actions.pod:3197
20619 msgid "resize2fs-size"
20623 #: ../fish/guestfish-actions.pod:3199
20626 " resize2fs-size device size\n"
20631 #: ../fish/guestfish-actions.pod:3201
20633 "This command is the same as L</resize2fs> except that it allows you to "
20634 "specify the new size (in bytes) explicitly."
20638 #: ../fish/guestfish-actions.pod:3204
20643 #: ../fish/guestfish-actions.pod:3206
20651 #: ../fish/guestfish-actions.pod:3210
20656 #: ../fish/guestfish-actions.pod:3212
20664 #: ../fish/guestfish-actions.pod:3218
20669 #: ../fish/guestfish-actions.pod:3220
20677 #: ../fish/guestfish-actions.pod:3224
20678 msgid "rmmountpoint"
20682 #: ../fish/guestfish-actions.pod:3226
20685 " rmmountpoint exemptpath\n"
20690 #: ../fish/guestfish-actions.pod:3228
20692 "This calls removes a mountpoint that was previously created with L</"
20693 "mkmountpoint>. See L</mkmountpoint> for full details."
20697 #: ../fish/guestfish-actions.pod:3232
20698 msgid "scrub-device"
20702 #: ../fish/guestfish-actions.pod:3234
20705 " scrub-device device\n"
20710 #: ../fish/guestfish-actions.pod:3245
20715 #: ../fish/guestfish-actions.pod:3247
20718 " scrub-file file\n"
20723 #: ../fish/guestfish-actions.pod:3257
20724 msgid "scrub-freespace"
20728 #: ../fish/guestfish-actions.pod:3259
20731 " scrub-freespace dir\n"
20736 #: ../fish/guestfish-actions.pod:3261
20738 "This command creates the directory C<dir> and then fills it with files until "
20739 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
20740 "deletes them. The intention is to scrub any free space on the partition "
20741 "containing C<dir>."
20745 #: ../fish/guestfish-actions.pod:3270
20750 #: ../fish/guestfish-actions.pod:3272
20755 #: ../fish/guestfish-actions.pod:3274
20758 " set-append append\n"
20763 #: ../fish/guestfish-actions.pod:3285
20764 msgid "set-autosync"
20768 #: ../fish/guestfish-actions.pod:3287
20773 #: ../fish/guestfish-actions.pod:3289
20776 " set-autosync true|false\n"
20781 #: ../fish/guestfish-actions.pod:3291
20783 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
20784 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
20785 "closed (also if the program exits without closing handles)."
20789 #: ../fish/guestfish-actions.pod:3299
20794 #: ../fish/guestfish-actions.pod:3301
20799 #: ../fish/guestfish-actions.pod:3303
20802 " set-direct true|false\n"
20807 #: ../fish/guestfish-actions.pod:3309
20809 "One consequence of this is that log messages aren't caught by the library "
20810 "and handled by L</set-log-message-callback>, but go straight to stdout."
20814 #: ../fish/guestfish-actions.pod:3318
20815 msgid "set-e2label"
20819 #: ../fish/guestfish-actions.pod:3320
20822 " set-e2label device label\n"
20827 #: ../fish/guestfish-actions.pod:3326
20829 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
20830 "label on a filesystem."
20834 #: ../fish/guestfish-actions.pod:3329
20839 #: ../fish/guestfish-actions.pod:3331
20842 " set-e2uuid device uuid\n"
20847 #: ../fish/guestfish-actions.pod:3338
20849 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
20850 "UUID of a filesystem."
20854 #: ../fish/guestfish-actions.pod:3341
20855 msgid "set-memsize"
20859 #: ../fish/guestfish-actions.pod:3343
20864 #: ../fish/guestfish-actions.pod:3345
20867 " set-memsize memsize\n"
20872 #: ../fish/guestfish-actions.pod:3347
20874 "This sets the memory size in megabytes allocated to the qemu subprocess. "
20875 "This only has any effect if called before L</launch>."
20879 #: ../fish/guestfish-actions.pod:3358
20880 msgid "set-network"
20884 #: ../fish/guestfish-actions.pod:3360
20889 #: ../fish/guestfish-actions.pod:3362
20892 " set-network true|false\n"
20897 #: ../fish/guestfish-actions.pod:3370
20899 "You must call this before calling L</launch>, otherwise it has no effect."
20903 #: ../fish/guestfish-actions.pod:3373
20908 #: ../fish/guestfish-actions.pod:3375
20913 #: ../fish/guestfish-actions.pod:3377
20916 " set-path searchpath\n"
20921 #: ../fish/guestfish-actions.pod:3386
20926 #: ../fish/guestfish-actions.pod:3388
20931 #: ../fish/guestfish-actions.pod:3390
20939 #: ../fish/guestfish-actions.pod:3410
20940 msgid "set-recovery-proc"
20944 #: ../fish/guestfish-actions.pod:3412
20945 msgid "recovery-proc"
20949 #: ../fish/guestfish-actions.pod:3414
20952 " set-recovery-proc true|false\n"
20957 #: ../fish/guestfish-actions.pod:3416
20959 "If this is called with the parameter C<false> then L</launch> does not "
20960 "create a recovery process. The purpose of the recovery process is to stop "
20961 "runaway qemu processes in the case where the main program aborts abruptly."
20965 #: ../fish/guestfish-actions.pod:3421
20967 "This only has any effect if called before L</launch>, and the default is "
20972 #: ../fish/guestfish-actions.pod:3430
20973 msgid "set-selinux"
20977 #: ../fish/guestfish-actions.pod:3432
20982 #: ../fish/guestfish-actions.pod:3434
20985 " set-selinux true|false\n"
20990 #: ../fish/guestfish-actions.pod:3445
20995 #: ../fish/guestfish-actions.pod:3447
21000 #: ../fish/guestfish-actions.pod:3449
21003 " set-trace true|false\n"
21008 #: ../fish/guestfish-actions.pod:3465
21009 msgid "set-verbose"
21013 #: ../fish/guestfish-actions.pod:3467
21018 #: ../fish/guestfish-actions.pod:3469
21021 " set-verbose true|false\n"
21026 #: ../fish/guestfish-actions.pod:3476
21031 #: ../fish/guestfish-actions.pod:3478
21034 " setcon context\n"
21039 #: ../fish/guestfish-actions.pod:3485
21044 #: ../fish/guestfish-actions.pod:3487
21047 " setxattr xattr val vallen path\n"
21052 #: ../fish/guestfish-actions.pod:3493
21053 msgid "See also: L</lsetxattr>, L<attr(5)>."
21057 #: ../fish/guestfish-actions.pod:3495
21062 #: ../fish/guestfish-actions.pod:3497
21065 " sfdisk device cyls heads sectors 'lines ...'\n"
21070 #: ../fish/guestfish-actions.pod:3519
21071 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
21075 #: ../fish/guestfish-actions.pod:3525
21080 #: ../fish/guestfish-actions.pod:3527
21083 " sfdiskM device 'lines ...'\n"
21088 #: ../fish/guestfish-actions.pod:3529
21090 "This is a simplified interface to the L</sfdisk> command, where partition "
21091 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
21092 "you don't need to specify the cyls, heads and sectors parameters which were "
21093 "rarely if ever used anyway."
21097 #: ../fish/guestfish-actions.pod:3535
21098 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
21102 #: ../fish/guestfish-actions.pod:3541
21107 #: ../fish/guestfish-actions.pod:3543
21110 " sfdisk-N device partnum cyls heads sectors line\n"
21115 #: ../fish/guestfish-actions.pod:3548
21117 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
21118 "cyls/heads/sectors parameters."
21122 #: ../fish/guestfish-actions.pod:3551
21123 msgid "See also: L</part-add>"
21127 #: ../fish/guestfish-actions.pod:3556
21128 msgid "sfdisk-disk-geometry"
21132 #: ../fish/guestfish-actions.pod:3558
21135 " sfdisk-disk-geometry device\n"
21140 #: ../fish/guestfish-actions.pod:3560
21142 "This displays the disk geometry of C<device> read from the partition table. "
21143 "Especially in the case where the underlying block device has been resized, "
21144 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
21145 "kernel-geometry>)."
21149 #: ../fish/guestfish-actions.pod:3568
21150 msgid "sfdisk-kernel-geometry"
21154 #: ../fish/guestfish-actions.pod:3570
21157 " sfdisk-kernel-geometry device\n"
21162 #: ../fish/guestfish-actions.pod:3577
21167 #: ../fish/guestfish-actions.pod:3579
21170 " sfdisk-l device\n"
21175 #: ../fish/guestfish-actions.pod:3585
21176 msgid "See also: L</part-list>"
21180 #: ../fish/guestfish-actions.pod:3587
21185 #: ../fish/guestfish-actions.pod:3589
21193 #: ../fish/guestfish-actions.pod:3594
21194 msgid "This is like L</command>, but passes the command to:"
21198 #: ../fish/guestfish-actions.pod:3602
21199 msgid "All the provisos about L</command> apply to this call."
21203 #: ../fish/guestfish-actions.pod:3604
21208 #: ../fish/guestfish-actions.pod:3606
21211 " sh-lines command\n"
21216 #: ../fish/guestfish-actions.pod:3608
21217 msgid "This is the same as L</sh>, but splits the result into a list of lines."
21221 #: ../fish/guestfish-actions.pod:3611
21222 msgid "See also: L</command-lines>"
21226 #: ../fish/guestfish-actions.pod:3613
21231 #: ../fish/guestfish-actions.pod:3615
21239 #: ../fish/guestfish-actions.pod:3619
21244 #: ../fish/guestfish-actions.pod:3621
21252 #: ../fish/guestfish-actions.pod:3627
21257 #: ../fish/guestfish-actions.pod:3629
21265 #: ../fish/guestfish-actions.pod:3637
21270 #: ../fish/guestfish-actions.pod:3639
21278 #: ../fish/guestfish-actions.pod:3647
21283 #: ../fish/guestfish-actions.pod:3649
21286 " strings-e encoding path\n"
21291 #: ../fish/guestfish-actions.pod:3651
21293 "This is like the L</strings> command, but allows you to specify the encoding "
21294 "of strings that are looked for in the source file C<path>."
21298 #: ../fish/guestfish-actions.pod:3661
21300 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
21301 "ISO-8859-X (this is what L</strings> uses)."
21305 #: ../fish/guestfish-actions.pod:3693
21306 msgid "swapoff-device"
21310 #: ../fish/guestfish-actions.pod:3695
21313 " swapoff-device device\n"
21318 #: ../fish/guestfish-actions.pod:3697
21320 "This command disables the libguestfs appliance swap device or partition "
21321 "named C<device>. See L</swapon-device>."
21325 #: ../fish/guestfish-actions.pod:3701
21326 msgid "swapoff-file"
21330 #: ../fish/guestfish-actions.pod:3703
21333 " swapoff-file file\n"
21338 #: ../fish/guestfish-actions.pod:3707
21339 msgid "swapoff-label"
21343 #: ../fish/guestfish-actions.pod:3709
21346 " swapoff-label label\n"
21351 #: ../fish/guestfish-actions.pod:3714
21352 msgid "swapoff-uuid"
21356 #: ../fish/guestfish-actions.pod:3716
21359 " swapoff-uuid uuid\n"
21364 #: ../fish/guestfish-actions.pod:3721
21365 msgid "swapon-device"
21369 #: ../fish/guestfish-actions.pod:3723
21372 " swapon-device device\n"
21377 #: ../fish/guestfish-actions.pod:3725
21379 "This command enables the libguestfs appliance to use the swap device or "
21380 "partition named C<device>. The increased memory is made available for all "
21381 "commands, for example those run using L</command> or L</sh>."
21385 #: ../fish/guestfish-actions.pod:3737
21386 msgid "swapon-file"
21390 #: ../fish/guestfish-actions.pod:3739
21393 " swapon-file file\n"
21398 #: ../fish/guestfish-actions.pod:3741
21400 "This command enables swap to a file. See L</swapon-device> for other notes."
21404 #: ../fish/guestfish-actions.pod:3744
21405 msgid "swapon-label"
21409 #: ../fish/guestfish-actions.pod:3746
21412 " swapon-label label\n"
21417 #: ../fish/guestfish-actions.pod:3748
21419 "This command enables swap to a labeled swap partition. See L</swapon-"
21420 "device> for other notes."
21424 #: ../fish/guestfish-actions.pod:3751
21425 msgid "swapon-uuid"
21429 #: ../fish/guestfish-actions.pod:3753
21432 " swapon-uuid uuid\n"
21437 #: ../fish/guestfish-actions.pod:3755
21439 "This command enables swap to a swap partition with the given UUID. See L</"
21440 "swapon-device> for other notes."
21444 #: ../fish/guestfish-actions.pod:3758
21449 #: ../fish/guestfish-actions.pod:3760
21457 #: ../fish/guestfish-actions.pod:3768
21462 #: ../fish/guestfish-actions.pod:3770
21470 #: ../fish/guestfish-actions.pod:3778
21475 #: ../fish/guestfish-actions.pod:3780
21478 " tail-n nrlines path\n"
21483 #: ../fish/guestfish-actions.pod:3793
21488 #: ../fish/guestfish-actions.pod:3795
21491 " tar-in (tarfile|-) directory\n"
21496 #: ../fish/guestfish-actions.pod:3800
21497 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
21501 #: ../fish/guestfish-actions.pod:3805
21506 #: ../fish/guestfish-actions.pod:3807
21509 " tar-out directory (tarfile|-)\n"
21514 #: ../fish/guestfish-actions.pod:3812
21515 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
21519 #: ../fish/guestfish-actions.pod:3817
21524 #: ../fish/guestfish-actions.pod:3819
21527 " tgz-in (tarball|-) directory\n"
21532 #: ../fish/guestfish-actions.pod:3824
21533 msgid "To upload an uncompressed tarball, use L</tar-in>."
21537 #: ../fish/guestfish-actions.pod:3828
21542 #: ../fish/guestfish-actions.pod:3830
21545 " tgz-out directory (tarball|-)\n"
21550 #: ../fish/guestfish-actions.pod:3835
21551 msgid "To download an uncompressed tarball, use L</tar-out>."
21555 #: ../fish/guestfish-actions.pod:3839
21560 #: ../fish/guestfish-actions.pod:3841
21568 #: ../fish/guestfish-actions.pod:3850
21573 #: ../fish/guestfish-actions.pod:3852
21581 #: ../fish/guestfish-actions.pod:3857
21582 msgid "truncate-size"
21586 #: ../fish/guestfish-actions.pod:3859
21589 " truncate-size path size\n"
21594 #: ../fish/guestfish-actions.pod:3864
21596 "If the current file size is less than C<size> then the file is extended to "
21597 "the required size with zero bytes. This creates a sparse file (ie. disk "
21598 "blocks are not allocated for the file until you write to it). To create a "
21599 "non-sparse file of zeroes, use L</fallocate64> instead."
21603 #: ../fish/guestfish-actions.pod:3870
21608 #: ../fish/guestfish-actions.pod:3872
21611 " tune2fs-l device\n"
21616 #: ../fish/guestfish-actions.pod:3882
21621 #: ../fish/guestfish-actions.pod:3884
21624 " txz-in (tarball|-) directory\n"
21629 #: ../fish/guestfish-actions.pod:3891
21634 #: ../fish/guestfish-actions.pod:3893
21637 " txz-out directory (tarball|-)\n"
21642 #: ../fish/guestfish-actions.pod:3900
21647 #: ../fish/guestfish-actions.pod:3902
21655 #: ../fish/guestfish-actions.pod:3916
21656 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
21660 #: ../fish/guestfish-actions.pod:3921
21665 #: ../fish/guestfish-actions.pod:3923
21670 #: ../fish/guestfish-actions.pod:3925
21673 " umount pathordevice\n"
21678 #: ../fish/guestfish-actions.pod:3931
21683 #: ../fish/guestfish-actions.pod:3933
21684 msgid "unmount-all"
21688 #: ../fish/guestfish-actions.pod:3935
21696 #: ../fish/guestfish-actions.pod:3941
21701 #: ../fish/guestfish-actions.pod:3943
21704 " upload (filename|-) remotefilename\n"
21709 #: ../fish/guestfish-actions.pod:3950
21710 msgid "See also L</download>."
21714 #: ../fish/guestfish-actions.pod:3954
21715 msgid "upload-offset"
21719 #: ../fish/guestfish-actions.pod:3956
21722 " upload-offset (filename|-) remotefilename offset\n"
21727 #: ../fish/guestfish-actions.pod:3968
21729 "Note that there is no limit on the amount of data that can be uploaded with "
21730 "this call, unlike with L</pwrite>, and this call always writes the full "
21731 "amount unless an error occurs."
21735 #: ../fish/guestfish-actions.pod:3973
21736 msgid "See also L</upload>, L</pwrite>."
21740 #: ../fish/guestfish-actions.pod:3977
21745 #: ../fish/guestfish-actions.pod:3979
21748 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
21753 #: ../fish/guestfish-actions.pod:3998
21758 #: ../fish/guestfish-actions.pod:4000
21766 #: ../fish/guestfish-actions.pod:4027
21768 "I<Note:> Don't use this call to test for availability of features. In "
21769 "enterprise distributions we backport features from later versions into "
21770 "earlier versions, making this an unreliable way to test for features. Use "
21771 "L</available> instead."
21775 #: ../fish/guestfish-actions.pod:4033
21780 #: ../fish/guestfish-actions.pod:4035
21783 " vfs-label device\n"
21788 #: ../fish/guestfish-actions.pod:4042
21789 msgid "To find a filesystem from the label, use L</findfs-label>."
21793 #: ../fish/guestfish-actions.pod:4044
21798 #: ../fish/guestfish-actions.pod:4046
21801 " vfs-type device\n"
21806 #: ../fish/guestfish-actions.pod:4056
21811 #: ../fish/guestfish-actions.pod:4058
21814 " vfs-uuid device\n"
21819 #: ../fish/guestfish-actions.pod:4065
21820 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
21824 #: ../fish/guestfish-actions.pod:4067
21825 msgid "vg-activate"
21829 #: ../fish/guestfish-actions.pod:4069
21832 " vg-activate true|false 'volgroups ...'\n"
21837 #: ../fish/guestfish-actions.pod:4082
21838 msgid "vg-activate-all"
21842 #: ../fish/guestfish-actions.pod:4084
21845 " vg-activate-all true|false\n"
21850 #: ../fish/guestfish-actions.pod:4094
21855 #: ../fish/guestfish-actions.pod:4096
21858 " vgcreate volgroup 'physvols ...'\n"
21863 #: ../fish/guestfish-actions.pod:4101
21868 #: ../fish/guestfish-actions.pod:4103
21871 " vglvuuids vgname\n"
21876 #: ../fish/guestfish-actions.pod:4108
21878 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
21879 "logical volumes and volume groups."
21883 #: ../fish/guestfish-actions.pod:4111
21884 msgid "See also L</vgpvuuids>."
21888 #: ../fish/guestfish-actions.pod:4113
21893 #: ../fish/guestfish-actions.pod:4115
21896 " vgpvuuids vgname\n"
21901 #: ../fish/guestfish-actions.pod:4120
21903 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
21904 "physical volumes and volume groups."
21908 #: ../fish/guestfish-actions.pod:4123
21909 msgid "See also L</vglvuuids>."
21913 #: ../fish/guestfish-actions.pod:4125
21918 #: ../fish/guestfish-actions.pod:4127
21921 " vgremove vgname\n"
21926 #: ../fish/guestfish-actions.pod:4134
21931 #: ../fish/guestfish-actions.pod:4136
21934 " vgrename volgroup newvolgroup\n"
21939 #: ../fish/guestfish-actions.pod:4140
21944 #: ../fish/guestfish-actions.pod:4142
21952 #: ../fish/guestfish-actions.pod:4150
21953 msgid "See also L</vgs-full>."
21957 #: ../fish/guestfish-actions.pod:4152
21962 #: ../fish/guestfish-actions.pod:4154
21970 #: ../fish/guestfish-actions.pod:4159
21975 #: ../fish/guestfish-actions.pod:4161
21983 #: ../fish/guestfish-actions.pod:4166
21988 #: ../fish/guestfish-actions.pod:4168
21996 #: ../fish/guestfish-actions.pod:4172
22001 #: ../fish/guestfish-actions.pod:4174
22009 #: ../fish/guestfish-actions.pod:4179
22014 #: ../fish/guestfish-actions.pod:4181
22022 #: ../fish/guestfish-actions.pod:4186
22027 #: ../fish/guestfish-actions.pod:4188
22035 #: ../fish/guestfish-actions.pod:4193
22040 #: ../fish/guestfish-actions.pod:4195
22043 " write path content\n"
22048 #: ../fish/guestfish-actions.pod:4203
22053 #: ../fish/guestfish-actions.pod:4205
22056 " write-file path content size\n"
22061 #: ../fish/guestfish-actions.pod:4228
22066 #: ../fish/guestfish-actions.pod:4230
22069 " zegrep regex path\n"
22074 #: ../fish/guestfish-actions.pod:4238
22079 #: ../fish/guestfish-actions.pod:4240
22082 " zegrepi regex path\n"
22087 #: ../fish/guestfish-actions.pod:4248
22092 #: ../fish/guestfish-actions.pod:4250
22100 #: ../fish/guestfish-actions.pod:4258
22101 msgid "See also: L</zero-device>, L</scrub-device>."
22105 #: ../fish/guestfish-actions.pod:4260
22106 msgid "zero-device"
22110 #: ../fish/guestfish-actions.pod:4262
22113 " zero-device device\n"
22118 #: ../fish/guestfish-actions.pod:4264
22120 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
22121 "which just zeroes the first few blocks of a device."
22125 #: ../fish/guestfish-actions.pod:4271
22130 #: ../fish/guestfish-actions.pod:4273
22133 " zerofree device\n"
22138 #: ../fish/guestfish-actions.pod:4286
22143 #: ../fish/guestfish-actions.pod:4288
22146 " zfgrep pattern path\n"
22151 #: ../fish/guestfish-actions.pod:4296
22156 #: ../fish/guestfish-actions.pod:4298
22159 " zfgrepi pattern path\n"
22164 #: ../fish/guestfish-actions.pod:4306
22169 #: ../fish/guestfish-actions.pod:4308
22172 " zfile meth path\n"
22177 #: ../fish/guestfish-actions.pod:4315
22179 "Since 1.0.63, use L</file> instead which can now process compressed files."
22183 #: ../fish/guestfish-actions.pod:4325
22188 #: ../fish/guestfish-actions.pod:4327
22191 " zgrep regex path\n"
22196 #: ../fish/guestfish-actions.pod:4335
22201 #: ../fish/guestfish-actions.pod:4337
22204 " zgrepi regex path\n"
22209 #: ../fish/guestfish-commands.pod:1
22214 #: ../fish/guestfish-commands.pod:3
22219 #: ../fish/guestfish-commands.pod:5
22222 " alloc filename size\n"
22227 #: ../fish/guestfish-commands.pod:7
22229 "This creates an empty (zeroed) file of the given size, and then adds so it "
22230 "can be further examined."
22234 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
22235 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
22239 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
22240 msgid "Size can be specified using standard suffixes, eg. C<1M>."
22244 #: ../fish/guestfish-commands.pod:14
22246 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
22247 "image, see L</PREPARED DISK IMAGES>."
22251 #: ../fish/guestfish-commands.pod:17
22256 #: ../fish/guestfish-commands.pod:19
22259 " copy-in local [local ...] /remotedir\n"
22264 #: ../fish/guestfish-commands.pod:21
22266 "C<copy-in> copies local files or directories recursively into the disk "
22267 "image, placing them in the directory called C</remotedir> (which must "
22268 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
22269 "other commands as necessary."
22273 #: ../fish/guestfish-commands.pod:26
22275 "Multiple local files and directories can be specified, but the last "
22276 "parameter must always be a remote directory. Wildcards cannot be used."
22280 #: ../fish/guestfish-commands.pod:30
22285 #: ../fish/guestfish-commands.pod:32
22288 " copy-out remote [remote ...] localdir\n"
22293 #: ../fish/guestfish-commands.pod:34
22295 "C<copy-out> copies remote files or directories recursively out of the disk "
22296 "image, placing them on the host disk in a local directory called C<localdir> "
22297 "(which must exist). This guestfish meta-command turns into a sequence of L</"
22298 "download>, L</tar-out> and other commands as necessary."
22302 #: ../fish/guestfish-commands.pod:40
22304 "Multiple remote files and directories can be specified, but the last "
22305 "parameter must always be a local directory. To download to the current "
22306 "directory, use C<.> as in:"
22310 #: ../fish/guestfish-commands.pod:44
22313 " copy-out /home .\n"
22318 #: ../fish/guestfish-commands.pod:46
22320 "Wildcards cannot be used in the ordinary command, but you can use them with "
22321 "the help of L</glob> like this:"
22325 #: ../fish/guestfish-commands.pod:49
22328 " glob copy-out /home/* .\n"
22333 #: ../fish/guestfish-commands.pod:51
22338 #: ../fish/guestfish-commands.pod:53
22341 " echo [params ...]\n"
22346 #: ../fish/guestfish-commands.pod:55
22347 msgid "This echos the parameters to the terminal."
22351 #: ../fish/guestfish-commands.pod:57
22356 #: ../fish/guestfish-commands.pod:59
22361 #: ../fish/guestfish-commands.pod:61
22366 #: ../fish/guestfish-commands.pod:63
22374 #: ../fish/guestfish-commands.pod:65
22376 "This is used to edit a file. It downloads the file, edits it locally using "
22377 "your editor, then uploads the result."
22381 #: ../fish/guestfish-commands.pod:68
22383 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
22384 "or C<emacs> you will get those corresponding editors."
22388 #: ../fish/guestfish-commands.pod:72
22393 #: ../fish/guestfish-commands.pod:74
22396 " glob command args...\n"
22401 #: ../fish/guestfish-commands.pod:76
22403 "Expand wildcards in any paths in the args list, and run C<command> "
22404 "repeatedly on each matching path."
22408 #: ../fish/guestfish-commands.pod:79
22409 msgid "See L</WILDCARDS AND GLOBBING>."
22413 #: ../fish/guestfish-commands.pod:81
22418 #: ../fish/guestfish-commands.pod:83
22421 " hexedit <filename|device>\n"
22422 " hexedit <filename|device> <max>\n"
22423 " hexedit <filename|device> <start> <max>\n"
22428 #: ../fish/guestfish-commands.pod:87
22430 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
22435 #: ../fish/guestfish-commands.pod:90
22437 "This command works by downloading potentially the whole file or device, "
22438 "editing it locally, then uploading it. If the file or device is large, you "
22439 "have to specify which part you wish to edit by using C<max> and/or C<start> "
22440 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
22441 "usual modifiers allowed such as C<1M> (1 megabyte)."
22445 #: ../fish/guestfish-commands.pod:97
22446 msgid "For example to edit the first few sectors of a disk you might do:"
22450 #: ../fish/guestfish-commands.pod:100
22453 " hexedit /dev/sda 1M\n"
22458 #: ../fish/guestfish-commands.pod:102
22460 "which would allow you to edit anywhere within the first megabyte of the disk."
22464 #: ../fish/guestfish-commands.pod:105
22465 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
22469 #: ../fish/guestfish-commands.pod:107
22472 " hexedit /dev/sda1 0x400 0x400\n"
22477 #: ../fish/guestfish-commands.pod:109
22478 msgid "(assuming the superblock is in the standard location)."
22482 #: ../fish/guestfish-commands.pod:111
22484 "This command requires the external L<hexedit(1)> program. You can specify "
22485 "another program to use by setting the C<HEXEDITOR> environment variable."
22489 #: ../fish/guestfish-commands.pod:115
22490 msgid "See also L</hexdump>."
22494 #: ../fish/guestfish-commands.pod:117
22499 #: ../fish/guestfish-commands.pod:119
22507 #: ../fish/guestfish-commands.pod:121
22509 "Change the local directory, ie. the current directory of guestfish itself."
22513 #: ../fish/guestfish-commands.pod:124
22514 msgid "Note that C<!cd> won't do what you might expect."
22518 #: ../fish/guestfish-commands.pod:126
22523 #: ../fish/guestfish-commands.pod:128
22528 #: ../fish/guestfish-commands.pod:130
22536 #: ../fish/guestfish-commands.pod:132
22537 msgid "Opens the manual page for guestfish."
22541 #: ../fish/guestfish-commands.pod:134
22546 #: ../fish/guestfish-commands.pod:136
22551 #: ../fish/guestfish-commands.pod:138
22559 #: ../fish/guestfish-commands.pod:140
22567 #: ../fish/guestfish-commands.pod:142
22568 msgid "This is used to view a file."
22572 #: ../fish/guestfish-commands.pod:144
22574 "The default viewer is C<$PAGER>. However if you use the alternate command "
22575 "C<less> you will get the C<less> command specifically."
22579 #: ../fish/guestfish-commands.pod:147
22584 #: ../fish/guestfish-commands.pod:149
22592 #: ../fish/guestfish-commands.pod:151
22594 "Close and reopen the libguestfs handle. It is not necessary to use this "
22595 "normally, because the handle is closed properly when guestfish exits. "
22596 "However this is occasionally useful for testing."
22600 #: ../fish/guestfish-commands.pod:155
22605 #: ../fish/guestfish-commands.pod:157
22608 " sparse filename size\n"
22613 #: ../fish/guestfish-commands.pod:159
22615 "This creates an empty sparse file of the given size, and then adds so it can "
22616 "be further examined."
22620 #: ../fish/guestfish-commands.pod:162
22622 "In all respects it works the same as the L</alloc> command, except that the "
22623 "image file is allocated sparsely, which means that disk blocks are not "
22624 "assigned to the file until they are needed. Sparse disk files only use "
22625 "space when written to, but they are slower and there is a danger you could "
22626 "run out of real disk space during a write operation."
22630 #: ../fish/guestfish-commands.pod:172
22635 #: ../fish/guestfish-commands.pod:174
22643 #: ../fish/guestfish-commands.pod:176
22645 "This command returns a list of the optional groups known to the daemon, and "
22646 "indicates which ones are supported by this build of the libguestfs appliance."
22650 #: ../fish/guestfish-commands.pod:180
22651 msgid "See also L<guestfs(3)/AVAILABILITY>."
22655 #: ../fish/guestfish-commands.pod:182
22660 #: ../fish/guestfish-commands.pod:184
22663 " time command args...\n"
22668 #: ../fish/guestfish-commands.pod:186
22670 "Run the command as usual, but print the elapsed time afterwards. This can "
22671 "be useful for benchmarking operations."
22675 #: ../test-tool/libguestfs-test-tool.pod:5
22676 msgid "libguestfs-test-tool - End user tests for libguestfs"
22680 #: ../test-tool/libguestfs-test-tool.pod:9
22683 " libguestfs-test-tool [--options]\n"
22688 #: ../test-tool/libguestfs-test-tool.pod:13
22690 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
22691 "and developers, to allow them to check basic libguestfs functionality is "
22692 "working. This is needed because libguestfs occasionally breaks for reasons "
22693 "beyond our control: usually because of changes in the underlying qemu or "
22694 "kernel packages, or the host environment."
22698 #: ../test-tool/libguestfs-test-tool.pod:20
22699 msgid "If you suspect a problem in libguestfs, then just run:"
22703 #: ../test-tool/libguestfs-test-tool.pod:22
22706 " libguestfs-test-tool\n"
22711 #: ../test-tool/libguestfs-test-tool.pod:24
22712 msgid "It will print lots of diagnostic messages."
22716 #: ../test-tool/libguestfs-test-tool.pod:26
22717 msgid "If it runs to completion successfully, you will see this near the end:"
22721 #: ../test-tool/libguestfs-test-tool.pod:28
22724 " ===== TEST FINISHED OK =====\n"
22729 #: ../test-tool/libguestfs-test-tool.pod:30
22730 msgid "and the test tool will exit with code 0."
22734 #: ../test-tool/libguestfs-test-tool.pod:32
22736 "If it fails (and/or exits with non-zero error code), please paste the "
22737 "B<complete, unedited> output of the test tool into a bug report. More "
22738 "information about reporting bugs can be found on the L<http://libguestfs.org/"
22743 #: ../test-tool/libguestfs-test-tool.pod:41
22748 #: ../test-tool/libguestfs-test-tool.pod:43
22749 msgid "Display short usage information and exit."
22753 #: ../test-tool/libguestfs-test-tool.pod:45
22754 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
22758 #: ../test-tool/libguestfs-test-tool.pod:47
22760 "Pass an alternate name for the helper program. libguestfs-test-tool will "
22761 "normally look in the C<$libexec> directory that was configured when the tool "
22766 #: ../test-tool/libguestfs-test-tool.pod:51
22767 msgid "I<--qemu qemu_binary>"
22771 #: ../test-tool/libguestfs-test-tool.pod:53
22773 "If you have downloaded another qemu binary, point this option at the full "
22774 "path of the binary to try it."
22778 #: ../test-tool/libguestfs-test-tool.pod:56
22779 msgid "I<--qemudir qemu_source_dir>"
22783 #: ../test-tool/libguestfs-test-tool.pod:58
22785 "If you have compiled qemu from source, point this option at the source "
22786 "directory to try it."
22790 #: ../test-tool/libguestfs-test-tool.pod:61
22791 msgid "I<--timeout N>"
22795 #: ../test-tool/libguestfs-test-tool.pod:63
22797 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
22798 "does not usually need to be adjusted unless your machine is very slow."
22802 #: ../test-tool/libguestfs-test-tool.pod:69
22803 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
22807 #: ../test-tool/libguestfs-test-tool.pod:71
22809 "If you have compiled another version of qemu from source and would like to "
22810 "try that, then you can use the I<--qemudir> option to point to the qemu "
22811 "source directory."
22815 #: ../test-tool/libguestfs-test-tool.pod:75
22817 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
22818 "option to point to the binary."
22822 #: ../test-tool/libguestfs-test-tool.pod:78
22824 "When using an alternate qemu with libguestfs, usually you would need to "
22825 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
22826 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
22827 "use either of the I<--qemudir> or I<--qemu> options."
22831 #: ../test-tool/libguestfs-test-tool.pod:85
22833 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
22834 "I<1> if there was an error."
22838 #: ../test-tool/libguestfs-test-tool.pod:92
22839 msgid "/usr/libexec/libguestfs-test-tool-helper"
22843 #: ../test-tool/libguestfs-test-tool.pod:94
22845 "This helper program is run inside the appliance and provides additional "
22850 #: ../test-tool/libguestfs-test-tool.pod:97
22851 msgid "/usr/bin/mkisofs"
22855 #: ../test-tool/libguestfs-test-tool.pod:99
22857 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
22858 "which is used as part of the tests."
22862 #: ../test-tool/libguestfs-test-tool.pod:106
22864 "For the full list of environment variables which may affect libguestfs, "
22865 "please see the L<guestfs(3)> manual page."
22869 #: ../test-tool/libguestfs-test-tool.pod:111
22870 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
22874 #: ../test-tool/libguestfs-test-tool.pod:121 ../fuse/guestmount.pod:195
22875 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
22879 #: ../fuse/guestmount.pod:5
22881 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
22885 #: ../fuse/guestmount.pod:9
22888 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
22893 #: ../fuse/guestmount.pod:13
22895 "You must I<not> use C<guestmount> in read-write mode on live virtual "
22896 "machines. If you do this, you risk disk corruption in the VM."
22900 #: ../fuse/guestmount.pod:18
22902 "The guestmount program can be used to mount virtual machine filesystems and "
22903 "other disk images on the host. It uses libguestfs for access to the guest "
22904 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
22905 "a mountable device."
22909 #: ../fuse/guestmount.pod:23
22911 "Along with other options, you have to give at least one device (I<-a> "
22912 "option) and at least one mountpoint (I<-m> option). How this works is "
22913 "better explained in the L<guestfish(1)> manual page, or you can use L<virt-"
22914 "inspector(1)> and/or the wrapper script C<guestmount-wrapper> to help you."
22918 #: ../fuse/guestmount.pod:29
22920 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
22921 "by you, and the filesystem will not be visible to any other users unless you "
22922 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
22923 "the filesystem, use the C<fusermount -u> command."
22927 #: ../fuse/guestmount.pod:37
22929 "For a typical Windows guest which has its main filesystem on the first "
22934 #: ../fuse/guestmount.pod:40
22937 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
22942 #: ../fuse/guestmount.pod:42
22944 "For a typical Linux guest which has a /boot filesystem on the first "
22945 "partition, and the root filesystem on a logical volume:"
22949 #: ../fuse/guestmount.pod:45
22952 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
22957 #: ../fuse/guestmount.pod:47
22959 "To get L<virt-inspector(1)> to do the hard work of detecting guest "
22960 "mountpoints for you:"
22964 #: ../fuse/guestmount.pod:50
22967 " guestmount $(virt-inspector --ro-fish MyGuest) /mnt\n"
22972 #: ../fuse/guestmount.pod:52
22974 "(or use --fish if you don't want it to be a read only mount). The option is "
22975 "called I<--ro-fish> or I<--fish> because these parameters are compatible "
22976 "with L<guestfish(1)>."
22980 #: ../fuse/guestmount.pod:56
22982 "If you don't know what filesystems are contained in a guest or disk image, "
22983 "use L<virt-list-filesystems(1)> first:"
22987 #: ../fuse/guestmount.pod:59
22990 " virt-list-filesystems MyGuest\n"
22995 #: ../fuse/guestmount.pod:61
22997 "If you want to trace the libguestfs calls but without excessive debugging, "
23002 #: ../fuse/guestmount.pod:64
23005 " guestmount [-a ... -m ...] --trace /mnt\n"
23010 #: ../fuse/guestmount.pod:66
23011 msgid "If you want to debug the program, we recommend:"
23015 #: ../fuse/guestmount.pod:68
23018 " guestmount [-a ... -m ...] --trace --verbose /mnt\n"
23023 #: ../fuse/guestmount.pod:76
23024 msgid "Add a block device or virtual machine image."
23028 #: ../fuse/guestmount.pod:78
23029 msgid "B<--dir-cache-timeout N>"
23033 #: ../fuse/guestmount.pod:80
23035 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
23036 "seconds. The readdir cache [actually, there are several semi-independent "
23037 "caches] is populated after a readdir(2) call with the stat and extended "
23038 "attributes of the files in the directory, in anticipation that they will be "
23039 "requested soon after."
23043 #: ../fuse/guestmount.pod:86
23045 "There is also a different attribute cache implemented by FUSE (see the FUSE "
23046 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
23047 "requests, only cache existing ones."
23051 #: ../fuse/guestmount.pod:90
23052 msgid "B<--fuse-help>"
23056 #: ../fuse/guestmount.pod:92
23057 msgid "Display help on special FUSE options (see I<-o> below)."
23061 #: ../fuse/guestmount.pod:96
23062 msgid "Display brief help and exit."
23066 #: ../fuse/guestmount.pod:98
23067 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
23071 #: ../fuse/guestmount.pod:100
23073 "Mount the named partition or logical volume on the given mountpoint B<in the "
23074 "guest> (this has nothing to do with mountpoints in the host)."
23078 #: ../fuse/guestmount.pod:103
23080 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
23081 "something on C</>."
23085 #: ../fuse/guestmount.pod:108
23087 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
23088 "unmounted. If you specify this option, then we don't attempt to sync the "
23089 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
23093 #: ../fuse/guestmount.pod:113
23094 msgid "B<-o option> | B<--option option>"
23098 #: ../fuse/guestmount.pod:115
23099 msgid "Pass extra options to FUSE."
23103 #: ../fuse/guestmount.pod:117
23105 "To get a list of all the extra options supported by FUSE, use the command "
23106 "below. Note that only the FUSE I<-o> options can be passed, and only some "
23107 "of them are a good idea."
23111 #: ../fuse/guestmount.pod:121
23114 " guestmount --fuse-help\n"
23119 #: ../fuse/guestmount.pod:123
23120 msgid "Some potentially useful FUSE options:"
23124 #: ../fuse/guestmount.pod:127
23125 msgid "B<-o allow_other>"
23129 #: ../fuse/guestmount.pod:129
23130 msgid "Allow other users to see the filesystem."
23134 #: ../fuse/guestmount.pod:131
23135 msgid "B<-o attr_timeout=N>"
23139 #: ../fuse/guestmount.pod:133
23140 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
23144 #: ../fuse/guestmount.pod:135
23145 msgid "B<-o kernel_cache>"
23149 #: ../fuse/guestmount.pod:137
23151 "Allow the kernel to cache files (reduces the number of reads that have to go "
23152 "through the L<guestfs(3)> API). This is generally a good idea if you can "
23153 "afford the extra memory usage."
23157 #: ../fuse/guestmount.pod:141
23158 msgid "B<-o uid=N> B<-o gid=N>"
23162 #: ../fuse/guestmount.pod:143
23164 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
23165 "the chosen values."
23169 #: ../fuse/guestmount.pod:150
23171 "Add devices and mount everything read-only. Also disallow writes and make "
23172 "the disk appear read-only to FUSE."
23176 #: ../fuse/guestmount.pod:153
23178 "This is highly recommended if you are not going to edit the guest disk. If "
23179 "the guest is running and this option is I<not> supplied, then there is a "
23180 "strong risk of disk corruption in the guest. We try to prevent this from "
23181 "happening, but it is not always possible."
23185 #: ../fuse/guestmount.pod:160
23186 msgid "Enable SELinux support for the guest."
23190 #: ../fuse/guestmount.pod:162
23195 #: ../fuse/guestmount.pod:164
23196 msgid "Trace libguestfs calls (to stderr)."
23200 #: ../fuse/guestmount.pod:166
23201 msgid "This also stops the daemon from forking into the background."
23205 #: ../fuse/guestmount.pod:170
23206 msgid "Enable verbose messages from underlying libguestfs."
23210 #: ../fuse/guestmount.pod:174
23211 msgid "Display the program version and exit."
23215 #: ../fuse/guestmount.pod:180
23217 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
23218 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
23223 #: ../inspector/virt-inspector.pl:40
23225 "virt-inspector - Display OS version, kernel, drivers, mount points, "
23226 "applications, etc. in a virtual machine"
23230 #: ../inspector/virt-inspector.pl:44
23233 " virt-inspector [--connect URI] domname\n"
23238 #: ../inspector/virt-inspector.pl:46
23241 " virt-inspector guest.img [guest.img ...]\n"
23246 #: ../inspector/virt-inspector.pl:50
23248 "B<virt-inspector> examines a virtual machine and tries to determine the "
23249 "version of the OS, the kernel version, what drivers are installed, whether "
23250 "the virtual machine is fully virtualized (FV) or para-virtualized (PV), what "
23251 "applications are installed and more."
23255 #: ../inspector/virt-inspector.pl:55
23257 "Virt-inspector can produce output in several formats, including a readable "
23258 "text report, and XML for feeding into other programs."
23262 #: ../inspector/virt-inspector.pl:58
23264 "In the normal usage, use C<virt-inspector domname> where C<domname> is the "
23265 "libvirt domain (see: C<virsh list --all>)."
23269 #: ../inspector/virt-inspector.pl:61
23271 "You can also run virt-inspector directly on disk images from a single "
23272 "virtual machine. Use C<virt-inspector guest.img>. In rare cases a domain "
23273 "has several block devices, in which case you should list them one after "
23274 "another, with the first corresponding to the guest's C</dev/sda>, the second "
23275 "to the guest's C</dev/sdb> and so on."
23279 #: ../inspector/virt-inspector.pl:67
23281 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
23282 "inspect several virtual machines, you have to run virt-inspector several "
23283 "times (for example, from a shell script for-loop)."
23287 #: ../inspector/virt-inspector.pl:72
23289 "Because virt-inspector needs direct access to guest images, it won't "
23290 "normally work over remote libvirt connections."
23294 #: ../inspector/virt-inspector.pl:85 ../tools/virt-cat.pl:90
23295 #: ../tools/virt-df.pl:81 ../tools/virt-edit.pl:83
23296 #: ../tools/virt-list-filesystems.pl:60 ../tools/virt-list-partitions.pl:61
23297 #: ../tools/virt-ls.pl:89 ../tools/virt-make-fs.pl:163
23298 #: ../tools/virt-rescue.pl:113 ../tools/virt-tar.pl:109
23299 #: ../tools/virt-win-reg.pl:182
23300 msgid "Display brief help."
23304 #: ../inspector/virt-inspector.pl:91 ../tools/virt-cat.pl:96
23305 #: ../tools/virt-df.pl:87 ../tools/virt-edit.pl:89
23306 #: ../tools/virt-list-filesystems.pl:66 ../tools/virt-list-partitions.pl:67
23307 #: ../tools/virt-ls.pl:95 ../tools/virt-make-fs.pl:169
23308 #: ../tools/virt-rescue.pl:119 ../tools/virt-resize.pl:249
23309 #: ../tools/virt-tar.pl:115 ../tools/virt-win-reg.pl:188
23310 msgid "B<--version>"
23314 #: ../inspector/virt-inspector.pl:93 ../tools/virt-cat.pl:98
23315 #: ../tools/virt-df.pl:89 ../tools/virt-edit.pl:91
23316 #: ../tools/virt-list-filesystems.pl:68 ../tools/virt-list-partitions.pl:69
23317 #: ../tools/virt-ls.pl:97 ../tools/virt-make-fs.pl:171
23318 #: ../tools/virt-rescue.pl:121 ../tools/virt-resize.pl:251
23319 #: ../tools/virt-tar.pl:117 ../tools/virt-win-reg.pl:190
23320 msgid "Display version number and exit."
23324 #: ../inspector/virt-inspector.pl:99 ../tools/virt-cat.pl:104
23325 #: ../tools/virt-df.pl:95 ../tools/virt-edit.pl:113
23326 #: ../tools/virt-list-filesystems.pl:74 ../tools/virt-list-partitions.pl:75
23327 #: ../tools/virt-ls.pl:103 ../tools/virt-rescue.pl:135
23328 #: ../tools/virt-tar.pl:123 ../tools/virt-win-reg.pl:204
23329 msgid "B<--connect URI> | B<-c URI>"
23333 #: ../inspector/virt-inspector.pl:101 ../tools/virt-cat.pl:106
23334 #: ../tools/virt-df.pl:97 ../tools/virt-edit.pl:115
23335 #: ../tools/virt-list-filesystems.pl:76 ../tools/virt-list-partitions.pl:77
23336 #: ../tools/virt-ls.pl:105 ../tools/virt-rescue.pl:137
23337 #: ../tools/virt-tar.pl:125 ../tools/virt-win-reg.pl:206
23339 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
23340 "to the default libvirt hypervisor."
23344 #: ../inspector/virt-inspector.pl:104
23346 "Libvirt is only used if you specify a C<domname> on the command line. If "
23347 "you specify guest block devices directly, then libvirt is not used at all."
23351 #: ../inspector/virt-inspector.pl:114
23353 "The following options select the output format. Use only one of them. The "
23354 "default is a readable text report."
23358 #: ../inspector/virt-inspector.pl:119
23359 msgid "B<--text> (default)"
23363 #: ../inspector/virt-inspector.pl:121
23364 msgid "Plain text report."
23368 #: ../inspector/virt-inspector.pl:123
23373 #: ../inspector/virt-inspector.pl:125
23374 msgid "Produce no output at all."
23378 #: ../inspector/virt-inspector.pl:127
23383 #: ../inspector/virt-inspector.pl:129
23385 "If you select I<--xml> then you get XML output which can be fed to other "
23390 #: ../inspector/virt-inspector.pl:132
23395 #: ../inspector/virt-inspector.pl:134
23397 "If you select I<--yaml> then you get YAML output which can be fed to other "
23402 #: ../inspector/virt-inspector.pl:137
23407 #: ../inspector/virt-inspector.pl:139
23409 "If you select I<--perl> then you get Perl structures output which can be "
23410 "used directly in another Perl program."
23414 #: ../inspector/virt-inspector.pl:142
23419 #: ../inspector/virt-inspector.pl:144
23420 msgid "B<--ro-fish>"
23424 #: ../inspector/virt-inspector.pl:146
23426 "If you select I<--fish> then we print a L<guestfish(1)> command line which "
23427 "will automatically mount up the filesystems on the correct mount points. "
23428 "Try this for example:"
23432 #: ../inspector/virt-inspector.pl:150
23435 " guestfish $(virt-inspector --fish guest.img)\n"
23440 #: ../inspector/virt-inspector.pl:152
23442 "I<--ro-fish> is the same, but the I<--ro> option is passed to guestfish so "
23443 "that the filesystems are mounted read-only."
23447 #: ../inspector/virt-inspector.pl:155
23452 #: ../inspector/virt-inspector.pl:157
23454 "In \"query mode\" we answer common questions about the guest, such as "
23455 "whether it is fullvirt or needs a Xen hypervisor to run."
23459 #: ../inspector/virt-inspector.pl:160
23460 msgid "See section I<QUERY MODE> below."
23464 #: ../inspector/virt-inspector.pl:166
23465 msgid "B<--windows-registry>"
23469 #: ../inspector/virt-inspector.pl:168
23471 "This flag is ignored for compatibility with earlier releases of the software."
23475 #: ../inspector/virt-inspector.pl:171
23477 "In this version, if L<Win::Hivex(3)> is available, then we attempt to parse "
23478 "information out of the Registry for any Windows guest."
23482 #: ../inspector/virt-inspector.pl:218
23483 msgid "OUTPUT FORMAT"
23487 #: ../inspector/virt-inspector.pl:220
23490 " Operating system(s)\n"
23491 " -------------------\n"
23492 " Linux (distro + version)\n"
23493 " Windows (version)\n"
23496 " +--- Filesystems ---------- Installed apps --- Kernel & drivers\n"
23497 " ----------- -------------- ----------------\n"
23498 " mount point => device List of apps Extra information\n"
23499 " mount point => device and versions about kernel(s)\n"
23500 " ... and drivers\n"
23501 " swap => swap device\n"
23502 " (plus lots of extra information\n"
23503 " about each filesystem)\n"
23508 #: ../inspector/virt-inspector.pl:235
23509 msgid "The output of virt-inspector is a complex two-level data structure."
23513 #: ../inspector/virt-inspector.pl:237
23515 "At the top level is a list of the operating systems installed on the guest. "
23516 "(For the vast majority of guests, only a single OS is installed.) The data "
23517 "returned for the OS includes the name (Linux, Windows), the distribution and "
23522 #: ../inspector/virt-inspector.pl:242
23523 msgid "The diagram above shows what we return for each OS."
23527 #: ../inspector/virt-inspector.pl:244
23529 "With the I<--xml> option the output is mapped into an XML document. There "
23530 "is a RELAX-NG schema for this XML in the file I<virt-inspector.rng> which "
23531 "normally ships with virt-inspector, or can be found in the source."
23535 #: ../inspector/virt-inspector.pl:249
23537 "With the I<--fish> or I<--ro-fish> option the mount points are mapped to "
23538 "L<guestfish(1)> command line parameters, so that you can go in afterwards "
23539 "and inspect the guest with everything mounted in the right place. For "
23544 #: ../inspector/virt-inspector.pl:254
23547 " guestfish $(virt-inspector --ro-fish guest.img)\n"
23548 " ==> guestfish --ro -a guest.img -m /dev/VG/LV:/ -m /dev/sda1:/boot\n"
23553 #: ../inspector/virt-inspector.pl:589
23558 #: ../inspector/virt-inspector.pl:591
23560 "When you use C<virt-inspector --query>, the output is a series of lines of "
23565 #: ../inspector/virt-inspector.pl:594
23571 " xen_pv_drivers=no\n"
23576 #: ../inspector/virt-inspector.pl:599
23578 "(each answer is usually C<yes> or C<no>, or the line is completely missing "
23579 "if we could not determine the answer at all)."
23583 #: ../inspector/virt-inspector.pl:602
23585 "If the guest is multiboot, you can get apparently conflicting answers (eg. "
23586 "C<windows=yes> and C<linux=yes>, or a guest which is both fullvirt and has a "
23587 "Xen PV kernel). This is normal, and just means that the guest can do both "
23588 "things, although it might require operator intervention such as selecting a "
23589 "boot option when the guest is booting."
23593 #: ../inspector/virt-inspector.pl:609
23594 msgid "This section describes the full range of answers possible."
23598 #: ../inspector/virt-inspector.pl:630
23599 msgid "windows=(yes|no)"
23603 #: ../inspector/virt-inspector.pl:632
23604 msgid "Answer C<yes> if Microsoft Windows is installed in the guest."
23608 #: ../inspector/virt-inspector.pl:645
23609 msgid "linux=(yes|no)"
23613 #: ../inspector/virt-inspector.pl:647
23614 msgid "Answer C<yes> if a Linux kernel is installed in the guest."
23618 #: ../inspector/virt-inspector.pl:660
23619 msgid "rhel=(yes|no)"
23623 #: ../inspector/virt-inspector.pl:662
23624 msgid "Answer C<yes> if the guest contains Red Hat Enterprise Linux."
23628 #: ../inspector/virt-inspector.pl:676
23629 msgid "fedora=(yes|no)"
23633 #: ../inspector/virt-inspector.pl:678
23634 msgid "Answer C<yes> if the guest contains the Fedora Linux distribution."
23638 #: ../inspector/virt-inspector.pl:691
23639 msgid "debian=(yes|no)"
23643 #: ../inspector/virt-inspector.pl:693
23644 msgid "Answer C<yes> if the guest contains the Debian Linux distribution."
23648 #: ../inspector/virt-inspector.pl:706
23649 msgid "fullvirt=(yes|no)"
23653 #: ../inspector/virt-inspector.pl:708
23655 "Answer C<yes> if there is at least one operating system kernel installed in "
23656 "the guest which runs fully virtualized. Such a guest would require a "
23657 "hypervisor which supports full system virtualization."
23661 #: ../inspector/virt-inspector.pl:731
23662 msgid "xen_domU_kernel=(yes|no)"
23666 #: ../inspector/virt-inspector.pl:733
23668 "Answer C<yes> if there is at least one Linux kernel installed in the guest "
23669 "which is compiled as a Xen DomU (a Xen paravirtualized guest)."
23673 #: ../inspector/virt-inspector.pl:753
23674 msgid "xen_pv_drivers=(yes|no)"
23678 #: ../inspector/virt-inspector.pl:755
23680 "Answer C<yes> if the guest has Xen paravirtualized drivers installed "
23681 "(usually the kernel itself will be fully virtualized, but the PV drivers "
23682 "have been installed by the administrator for performance reasons)."
23686 #: ../inspector/virt-inspector.pl:777
23687 msgid "virtio_drivers=(yes|no)"
23691 #: ../inspector/virt-inspector.pl:779
23693 "Answer C<yes> if the guest has virtio paravirtualized drivers installed. "
23694 "Virtio drivers are commonly used to improve the performance of KVM."
23698 #: ../inspector/virt-inspector.pl:800
23699 msgid "userspace_arch=(x86_64|...)"
23703 #: ../inspector/virt-inspector.pl:802
23704 msgid "Print the architecture of userspace."
23708 #: ../inspector/virt-inspector.pl:804 ../inspector/virt-inspector.pl:825
23709 msgid "NB. For multi-boot VMs this can print several lines."
23713 #: ../inspector/virt-inspector.pl:821
23714 msgid "kernel_arch=(x86_64|...)"
23718 #: ../inspector/virt-inspector.pl:823
23719 msgid "Print the architecture of the kernel."
23723 #: ../inspector/virt-inspector.pl:848 ../tools/virt-df.pl:538
23725 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
23726 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
23730 #: ../inspector/virt-inspector.pl:857 ../tools/virt-cat.pl:175
23731 #: ../tools/virt-df.pl:547 ../tools/virt-edit.pl:339
23732 #: ../tools/virt-list-filesystems.pl:205 ../tools/virt-list-partitions.pl:242
23733 #: ../tools/virt-ls.pl:223 ../tools/virt-make-fs.pl:554
23734 #: ../tools/virt-rescue.pl:243 ../tools/virt-resize.pl:1409
23735 #: ../tools/virt-tar.pl:270 ../tools/virt-win-reg.pl:489
23736 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
23740 #: ../inspector/virt-inspector.pl:859
23741 msgid "Matthew Booth L<mbooth@redhat.com>"
23745 #: ../inspector/virt-inspector.pl:863 ../tools/virt-cat.pl:179
23746 #: ../tools/virt-list-filesystems.pl:209 ../tools/virt-ls.pl:227
23747 #: ../tools/virt-tar.pl:274
23748 msgid "Copyright (C) 2009 Red Hat Inc."
23752 #: ../tools/virt-cat.pl:34
23753 msgid "virt-cat - Display a file in a virtual machine"
23757 #: ../tools/virt-cat.pl:38
23760 " virt-cat [--options] domname file\n"
23765 #: ../tools/virt-cat.pl:40
23768 " virt-cat [--options] disk.img [disk.img ...] file\n"
23773 #: ../tools/virt-cat.pl:44
23775 "C<virt-cat> is a command line tool to display the contents of C<file> where "
23776 "C<file> exists in the named virtual machine (or disk image)."
23780 #: ../tools/virt-cat.pl:47
23782 "C<virt-cat> can be used to quickly view a single file. To edit a file, use "
23783 "C<virt-edit>. For more complex cases you should look at the L<guestfish(1)> "
23788 #: ../tools/virt-cat.pl:53
23790 "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
23794 #: ../tools/virt-cat.pl:56
23797 " virt-cat mydomain /etc/fstab\n"
23802 #: ../tools/virt-cat.pl:58
23803 msgid "List syslog messages from a VM:"
23807 #: ../tools/virt-cat.pl:60
23810 " virt-cat mydomain /var/log/messages | tail\n"
23815 #: ../tools/virt-cat.pl:62
23816 msgid "Find out what DHCP IP address a VM acquired:"
23820 #: ../tools/virt-cat.pl:64
23823 " virt-cat mydomain /var/log/messages | grep 'dhclient: bound to' | tail\n"
23828 #: ../tools/virt-cat.pl:66
23829 msgid "Find out what packages were recently installed:"
23833 #: ../tools/virt-cat.pl:68
23836 " virt-cat mydomain /var/log/yum.log | tail\n"
23841 #: ../tools/virt-cat.pl:70
23842 msgid "Find out who is logged on inside a virtual machine:"
23846 #: ../tools/virt-cat.pl:72
23849 " virt-cat mydomain /var/run/utmp > /tmp/utmp\n"
23855 #: ../tools/virt-cat.pl:75
23856 msgid "or who was logged on:"
23860 #: ../tools/virt-cat.pl:77
23863 " virt-cat mydomain /var/log/wtmp > /tmp/wtmp\n"
23864 " last -f /tmp/wtmp\n"
23869 #: ../tools/virt-cat.pl:109 ../tools/virt-df.pl:100 ../tools/virt-edit.pl:118
23870 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80
23871 #: ../tools/virt-ls.pl:108 ../tools/virt-rescue.pl:140
23872 #: ../tools/virt-tar.pl:128 ../tools/virt-win-reg.pl:209
23874 "If you specify guest block devices directly, then libvirt is not used at all."
23878 #: ../tools/virt-cat.pl:165
23880 "L<guestfs(3)>, L<guestfish(1)>, L<virt-edit(1)>, L<Sys::Guestfs(3)>, L<Sys::"
23881 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
23885 #: ../tools/virt-cat.pl:173 ../tools/virt-df.pl:545 ../tools/virt-edit.pl:337
23886 #: ../tools/virt-list-filesystems.pl:203 ../tools/virt-list-partitions.pl:240
23887 #: ../tools/virt-ls.pl:221 ../tools/virt-make-fs.pl:552
23888 #: ../tools/virt-rescue.pl:241 ../tools/virt-resize.pl:1407
23889 #: ../tools/virt-tar.pl:268 ../tools/virt-win-reg.pl:487
23894 #: ../tools/virt-df.pl:36
23895 msgid "virt-df - Display free space on virtual filesystems"
23899 #: ../tools/virt-df.pl:40
23902 " virt-df [--options]\n"
23907 #: ../tools/virt-df.pl:42
23910 " virt-df [--options] domname\n"
23915 #: ../tools/virt-df.pl:44
23918 " virt-df [--options] disk.img [disk.img ...]\n"
23923 #: ../tools/virt-df.pl:48
23925 "C<virt-df> is a command line tool to display free space on virtual machine "
23926 "filesystems. Unlike other tools, it doesn't just display the amount of "
23927 "space allocated to a virtual machine, but can look inside the virtual "
23928 "machine to see how much space is really being used."
23932 #: ../tools/virt-df.pl:53
23934 "It is like the L<df(1)> command, but for virtual machines, except that it "
23935 "also works for Windows virtual machines."
23939 #: ../tools/virt-df.pl:56
23941 "If used without any arguments, C<virt-df> checks with libvirt to get a list "
23942 "of all active and inactive guests, and performs a C<df>-type operation on "
23943 "each one in turn, printing out the results."
23947 #: ../tools/virt-df.pl:60
23949 "If used with any argument(s), C<virt-df> performs a C<df>-type operation on "
23950 "either the single named libvirt domain, or on the disk image(s) listed on "
23951 "the command line (which must all belong to a single VM). In this mode (with "
23952 "arguments), C<virt-df> will I<only work for a single guest>. If you want to "
23953 "run on multiple guests, then you have to invoke C<virt-df> multiple times."
23957 #: ../tools/virt-df.pl:67
23959 "Use the C<--csv> option to get a format which can be easily parsed by other "
23960 "programs. Other options are mostly similar to standard C<df> options. See "
23961 "below for the complete list."
23965 #: ../tools/virt-df.pl:107
23970 #: ../tools/virt-df.pl:109
23972 "Write out the results in CSV format (comma-separated values). This format "
23973 "can be imported easily into databases and spreadsheets, but read L</NOTE "
23974 "ABOUT CSV FORMAT> below."
23978 #: ../tools/virt-df.pl:117
23979 msgid "B<--human-readable> | B<-h>"
23983 #: ../tools/virt-df.pl:119
23984 msgid "Print sizes in human-readable format."
23988 #: ../tools/virt-df.pl:121
23989 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
23993 #: ../tools/virt-df.pl:127
23994 msgid "B<--inodes> | B<-i>"
23998 #: ../tools/virt-df.pl:129
23999 msgid "Print inodes instead of blocks."
24003 #: ../tools/virt-df.pl:135
24004 msgid "B<--one-per-guest>"
24008 #: ../tools/virt-df.pl:137
24010 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
24011 "disks from several guests to a single libguestfs appliance."
24015 #: ../tools/virt-df.pl:140
24016 msgid "You might use this option in the following circumstances:"
24020 #: ../tools/virt-df.pl:146
24022 "If you think an untrusted guest might actively try to exploit the libguestfs "
24023 "appliance kernel, then this prevents one guest from interfering with the "
24024 "stats printed for another guest."
24028 #: ../tools/virt-df.pl:152
24030 "If the kernel has a bug which stops it from accessing a filesystem in one "
24031 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
24032 "and report stats for further guests."
24036 #: ../tools/virt-df.pl:512
24037 msgid "NOTE ABOUT CSV FORMAT"
24041 #: ../tools/virt-df.pl:514
24043 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
24044 "should be easy to parse, but it is definitely not easy to parse."
24048 #: ../tools/virt-df.pl:517
24050 "Myth: Just split fields at commas. Reality: This does I<not> work "
24051 "reliably. This example has two columns:"
24055 #: ../tools/virt-df.pl:520
24058 " \"foo,bar\",baz\n"
24063 #: ../tools/virt-df.pl:522
24065 "Myth: Read the file one line at a time. Reality: This does I<not> work "
24066 "reliably. This example has one row:"
24070 #: ../tools/virt-df.pl:525
24079 #: ../tools/virt-df.pl:528
24081 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
24082 "packaged in major Linux distributions)."
24086 #: ../tools/virt-df.pl:531
24088 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
24089 "or Python's built-in csv library)."
24093 #: ../tools/virt-df.pl:534
24094 msgid "Most spreadsheets and databases can import CSV directly."
24098 #: ../tools/virt-df.pl:551 ../tools/virt-edit.pl:343
24099 #: ../tools/virt-list-partitions.pl:246 ../tools/virt-rescue.pl:247
24100 msgid "Copyright (C) 2009-2010 Red Hat Inc."
24104 #: ../tools/virt-edit.pl:35
24105 msgid "virt-edit - Edit a file in a virtual machine"
24109 #: ../tools/virt-edit.pl:39
24112 " virt-edit [--options] domname file\n"
24117 #: ../tools/virt-edit.pl:41
24120 " virt-edit [--options] disk.img [disk.img ...] file\n"
24125 #: ../tools/virt-edit.pl:43
24128 " virt-edit [domname|disk.img] file -e 'expr'\n"
24133 #: ../tools/virt-edit.pl:47
24135 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
24136 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
24137 "doing this, but doesn't catch all cases."
24141 #: ../tools/virt-edit.pl:53
24143 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
24144 "the named virtual machine (or disk image)."
24148 #: ../tools/virt-edit.pl:56
24150 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
24151 "you should look at the L<guestfish(1)> tool."
24155 #: ../tools/virt-edit.pl:61
24156 msgid "Edit the named files interactively:"
24160 #: ../tools/virt-edit.pl:63
24163 " virt-edit mydomain /boot/grub/grub.conf\n"
24168 #: ../tools/virt-edit.pl:65
24171 " virt-edit mydomain /etc/passwd\n"
24176 #: ../tools/virt-edit.pl:67
24178 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
24179 "below). To change the init default level to 5:"
24183 #: ../tools/virt-edit.pl:71
24186 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
24191 #: ../tools/virt-edit.pl:97
24192 msgid "B<--backup extension> | B<-b extension>"
24196 #: ../tools/virt-edit.pl:99
24198 "Create a backup of the original file I<in the guest disk image>. The backup "
24199 "has the original filename with C<extension> added."
24203 #: ../tools/virt-edit.pl:102
24205 "Usually the first character of C<extension> would be a dot C<.> so you would "
24210 #: ../tools/virt-edit.pl:105
24213 " virt-edit -b .orig [etc]\n"
24218 #: ../tools/virt-edit.pl:107
24219 msgid "By default, no backup file is made."
24223 #: ../tools/virt-edit.pl:125
24224 msgid "B<--expr EXPR> | B<-e EXPR>"
24228 #: ../tools/virt-edit.pl:127
24230 "Instead of launching the external editor, non-interactively apply the Perl "
24231 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
24236 #: ../tools/virt-edit.pl:131
24238 "Be careful to properly quote the expression to prevent it from being altered "
24243 #: ../tools/virt-edit.pl:250
24244 msgid "NON-INTERACTIVE EDITING"
24248 #: ../tools/virt-edit.pl:252
24250 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
24251 "administrator can interactively edit the file."
24255 #: ../tools/virt-edit.pl:255
24257 "There are two ways also to use C<virt-edit> from scripts in order to make "
24258 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
24259 "like this, it's less error-prone to write scripts directly using the "
24260 "libguestfs API and Augeas for configuration file editing.)"
24264 #: ../tools/virt-edit.pl:261
24266 "The first method is to temporarily set C<$EDITOR> to any script or program "
24267 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
24268 "update C<tmpfile> in place however it likes."
24272 #: ../tools/virt-edit.pl:265
24274 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
24275 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
24276 "instances of C<foo> with C<bar> in a file:"
24280 #: ../tools/virt-edit.pl:269
24283 " virt-edit domname filename -e 's/foo/bar/'\n"
24288 #: ../tools/virt-edit.pl:271
24290 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
24291 "For example to delete root's password you could do:"
24295 #: ../tools/virt-edit.pl:274
24298 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
24303 #: ../tools/virt-edit.pl:276
24305 "What really happens is that the snippet is evaluated as a Perl expression "
24306 "for each line of the file. The line, including the final C<\\n>, is passed "
24307 "in C<$_> and the expression should update C<$_> or leave it unchanged."
24311 #: ../tools/virt-edit.pl:281
24313 "To delete a line, set C<$_> to the empty string. For example, to delete the "
24314 "C<apache> user account from the password file you can do:"
24318 #: ../tools/virt-edit.pl:284
24321 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
24326 #: ../tools/virt-edit.pl:286
24328 "To insert a line, prepend or append it to C<$_>. However appending lines to "
24329 "the end of the file is rather difficult this way since there is no concept "
24330 "of \"last line of the file\" - your expression just doesn't get called "
24331 "again. You might want to use the first method (setting C<$EDITOR>) if you "
24336 #: ../tools/virt-edit.pl:292
24338 "The variable C<$lineno> contains the current line number. As is "
24339 "traditional, the first line in the file is number C<1>."
24343 #: ../tools/virt-edit.pl:295
24345 "The return value from the expression is ignored, but the expression may call "
24346 "C<die> in order to abort the whole program, leaving the original file "
24351 #: ../tools/virt-edit.pl:299
24353 "Remember when matching the end of a line that C<$_> may contain the final C<"
24354 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
24355 "newline then neither of these. Thus to match or substitute some text at the "
24356 "end of a line, use this regular expression:"
24360 #: ../tools/virt-edit.pl:304
24363 " /some text(\\r?\\n)?$/\n"
24368 #: ../tools/virt-edit.pl:306
24370 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
24371 "$_> itself (since that would remove all newlines from the file):"
24375 #: ../tools/virt-edit.pl:310
24378 " my $m = $_; chomp $m; $m =~ /some text$/\n"
24383 #: ../tools/virt-edit.pl:316
24388 #: ../tools/virt-edit.pl:318
24390 "If set, this string is used as the editor. It may contain arguments, eg. C<"
24395 #: ../tools/virt-edit.pl:321
24396 msgid "If not set, C<vi> is used."
24400 #: ../tools/virt-edit.pl:327
24402 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
24403 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, "
24408 #: ../tools/virt-list-filesystems.pl:32
24410 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
24414 #: ../tools/virt-list-filesystems.pl:36
24417 " virt-list-filesystems [--options] domname\n"
24422 #: ../tools/virt-list-filesystems.pl:38
24425 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
24430 #: ../tools/virt-list-filesystems.pl:42
24432 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
24433 "are contained in a virtual machine or disk image."
24437 #: ../tools/virt-list-filesystems.pl:46
24439 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
24440 "functionality. For more complex cases you should look at the L<guestfish(1)"
24445 #: ../tools/virt-list-filesystems.pl:86 ../tools/virt-list-partitions.pl:95
24446 #: ../tools/virt-ls.pl:115
24447 msgid "B<-l> | B<--long>"
24451 #: ../tools/virt-list-filesystems.pl:88
24453 "With this option, C<virt-list-filesystems> displays the type of each "
24454 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
24458 #: ../tools/virt-list-filesystems.pl:95
24459 msgid "B<-a> | B<--all>"
24463 #: ../tools/virt-list-filesystems.pl:97
24465 "Normally we only show mountable filesystems. If this option is given then "
24466 "swap devices are shown too."
24470 #: ../tools/virt-list-filesystems.pl:193
24472 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-list-"
24473 "partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)"
24474 ">, L<http://libguestfs.org/>."
24478 #: ../tools/virt-list-partitions.pl:32
24480 "virt-list-partitions - List partitions in a virtual machine or disk image"
24484 #: ../tools/virt-list-partitions.pl:36
24487 " virt-list-partitions [--options] domname\n"
24492 #: ../tools/virt-list-partitions.pl:38
24495 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
24500 #: ../tools/virt-list-partitions.pl:42
24502 "C<virt-list-partitions> is a command line tool to list the partitions that "
24503 "are contained in a virtual machine or disk image. It is mainly useful as a "
24504 "first step to using L<virt-resize(1)>."
24508 #: ../tools/virt-list-partitions.pl:47
24510 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
24511 "functionality. For more complex cases you should look at the L<guestfish(1)"
24516 #: ../tools/virt-list-partitions.pl:87
24517 msgid "B<-h> | B<--human-readable>"
24521 #: ../tools/virt-list-partitions.pl:89
24522 msgid "Show sizes in human-readable form (eg. \"1G\")."
24526 #: ../tools/virt-list-partitions.pl:97
24528 "With this option, C<virt-list-partitions> displays the type and size of each "
24529 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
24533 #: ../tools/virt-list-partitions.pl:104
24534 msgid "B<-t> | B<--total>"
24538 #: ../tools/virt-list-partitions.pl:106
24540 "Display the total size of each block device (as a separate row or rows)."
24544 #: ../tools/virt-list-partitions.pl:231
24546 "L<guestfs(3)>, L<guestfish(1)>, L<virt-list-filesystems(1)>, L<virt-resize(1)"
24547 ">, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://"
24548 "libguestfs.org/>."
24552 #: ../tools/virt-ls.pl:35
24553 msgid "virt-ls - List files in a virtual machine"
24557 #: ../tools/virt-ls.pl:39
24560 " virt-ls [--options] domname directory\n"
24565 #: ../tools/virt-ls.pl:41
24568 " virt-ls [--options] disk.img [disk.img ...] directory\n"
24573 #: ../tools/virt-ls.pl:45
24575 "C<virt-ls> is a command line tool to list the names of files in a directory "
24576 "inside a virtual machine or disk image."
24580 #: ../tools/virt-ls.pl:48
24582 "C<virt-ls> is just a simple wrapper around L<libguestfs(3)> functionality. "
24583 "For more complex cases you should look at the L<guestfish(1)> tool."
24587 #: ../tools/virt-ls.pl:52
24589 "C<virt-ls> can be used in one of three modes: simple, long and recursive. A "
24590 "simple listing is like the ordinary L<ls(1)> command:"
24594 #: ../tools/virt-ls.pl:55
24597 " $ virt-ls myguest /\n"
24605 #: ../tools/virt-ls.pl:60
24606 msgid "With the C<-l> (C<--long>) option, C<virt-ls> shows more detail:"
24610 #: ../tools/virt-ls.pl:62
24613 " $ virt-ls -l myguest /\n"
24615 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
24616 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
24622 #: ../tools/virt-ls.pl:68
24624 "With the C<-R> (C<--recursive>) option, C<virt-ls> lists the names of files "
24625 "and directories recursively:"
24629 #: ../tools/virt-ls.pl:71
24632 " $ virt-ls -R myguest /tmp\n"
24640 #: ../tools/virt-ls.pl:76
24642 "You I<cannot> combine these options. To do more complicated things, use "
24647 #: ../tools/virt-ls.pl:117
24648 msgid "B<-R> | B<--recursive>"
24652 #: ../tools/virt-ls.pl:119
24654 "Select the mode. With neither of these options, C<virt-ls> produces a "
24655 "simple, flat list of the files in the named directory."
24659 #: ../tools/virt-ls.pl:122
24661 "C<virt-ls -l> produces a \"long listing\", which shows more detail (just "
24662 "like the plain C<ls -l> command)."
24666 #: ../tools/virt-ls.pl:125
24668 "C<virt-ls -R> produces a recursive list of files starting at the named "
24669 "directory. See the documentation for the C<guestfs_find> command L<guestfs"
24670 "(3)> for precise details."
24674 #: ../tools/virt-ls.pl:129
24675 msgid "You cannot combine these options."
24679 #: ../tools/virt-ls.pl:212
24681 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<Sys::"
24682 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
24687 #: ../tools/virt-make-fs.pl:37
24688 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
24692 #: ../tools/virt-make-fs.pl:41
24695 " virt-make-fs [--options] input.tar output.img\n"
24700 #: ../tools/virt-make-fs.pl:43
24703 " virt-make-fs [--options] input.tar.gz output.img\n"
24708 #: ../tools/virt-make-fs.pl:45
24711 " virt-make-fs [--options] directory output.img\n"
24716 #: ../tools/virt-make-fs.pl:49
24718 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
24719 "archive or some files in a directory. It is similar to tools like L<mkisofs"
24720 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
24721 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
24722 "you want to attach these filesystems to existing virtual machines (eg. to "
24723 "import large amounts of read-only data to a VM)."
24727 #: ../tools/virt-make-fs.pl:57
24728 msgid "Basic usage is:"
24732 #: ../tools/virt-make-fs.pl:59
24735 " virt-make-fs input output\n"
24740 #: ../tools/virt-make-fs.pl:61
24742 "where C<input> is either a directory containing files that you want to add, "
24743 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
24744 "C<output> is a disk image. The input type is detected automatically. The "
24745 "output disk image defaults to a raw ext2 image unless you specify extra "
24746 "flags (see L</OPTIONS> below)."
24750 #: ../tools/virt-make-fs.pl:67
24751 msgid "EXTRA SPACE"
24755 #: ../tools/virt-make-fs.pl:69
24757 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
24758 "the files that it contains, but might have extra space. Depending on how "
24759 "you are going to use the output, you might think this extra space is wasted "
24760 "and want to minimize it, or you might want to leave space so that more files "
24761 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
24762 "but you can use the C<--size> flag to leave space in the filesystem if you "
24767 #: ../tools/virt-make-fs.pl:77
24769 "An alternative way to leave extra space but not make the output image any "
24770 "bigger is to use an alternative disk image format (instead of the default "
24771 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
24772 "image format (check your hypervisor supports this before using it). This "
24773 "allows you to choose a large C<--size> but the extra space won't actually be "
24774 "allocated in the image until you try to store something in it."
24778 #: ../tools/virt-make-fs.pl:85
24780 "Don't forget that you can also use local commands including L<resize2fs(8)> "
24781 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-"
24782 "resize to build another image from scratch."
24786 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
24787 #: ../tools/virt-make-fs.pl:142
24792 #: ../tools/virt-make-fs.pl:91
24795 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
24800 #: ../tools/virt-make-fs.pl:93
24801 msgid "FILESYSTEM TYPE"
24805 #: ../tools/virt-make-fs.pl:95
24807 "The default filesystem type is C<ext2>. Just about any filesystem type that "
24808 "libguestfs supports can be used (but I<not> read-only formats like "
24809 "ISO9660). Here are some of the more common choices:"
24813 #: ../tools/virt-make-fs.pl:101
24818 #: ../tools/virt-make-fs.pl:103
24820 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
24821 "you are not going to use the filesystem in a way that requires the journal, "
24822 "then this is just wasted overhead."
24826 #: ../tools/virt-make-fs.pl:107
24827 msgid "I<ntfs> or I<vfat>"
24831 #: ../tools/virt-make-fs.pl:109
24832 msgid "Useful if exporting data to a Windows guest."
24836 #: ../tools/virt-make-fs.pl:111
24838 "I<Note for vfat>: The tar archive or local directory must only contain files "
24839 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
24840 "program running within libguestfs is unable to change the ownership of non-"
24841 "root files, since vfat itself does not support this."
24845 #: ../tools/virt-make-fs.pl:116
24850 #: ../tools/virt-make-fs.pl:118
24852 "Lower overhead than C<ext2>, but certain limitations on filename length and "
24853 "total filesystem size."
24857 #: ../tools/virt-make-fs.pl:125
24860 " virt-make-fs --type=minix input minixfs.img\n"
24865 #: ../tools/virt-make-fs.pl:127
24866 msgid "TO PARTITION OR NOT TO PARTITION"
24870 #: ../tools/virt-make-fs.pl:129
24871 msgid "Optionally virt-make-fs can add a partition table to the output disk."
24875 #: ../tools/virt-make-fs.pl:131
24877 "Adding a partition can make the disk image more compatible with certain "
24878 "virtualized operating systems which don't expect to see a filesystem "
24879 "directly located on a block device (Linux doesn't care and will happily "
24880 "handle both types)."
24884 #: ../tools/virt-make-fs.pl:136
24886 "On the other hand, if you have a partition table then the output image is no "
24887 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
24888 "directly on a partitioned disk image. (However libguestfs tools such as "
24889 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
24893 #: ../tools/virt-make-fs.pl:144
24894 msgid "Add an MBR partition:"
24898 #: ../tools/virt-make-fs.pl:146
24901 " virt-make-fs --partition -- input disk.img\n"
24906 #: ../tools/virt-make-fs.pl:148
24908 "If the output disk image could be terabyte-sized or larger, it's better to "
24909 "use an EFI/GPT-compatible partition table:"
24913 #: ../tools/virt-make-fs.pl:151
24916 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
24921 #: ../tools/virt-make-fs.pl:177 ../tools/virt-win-reg.pl:196
24926 #: ../tools/virt-make-fs.pl:179
24927 msgid "Enable debugging information."
24931 #: ../tools/virt-make-fs.pl:185
24932 msgid "B<--size=E<lt>NE<gt>>"
24936 #: ../tools/virt-make-fs.pl:187
24937 msgid "B<--size=+E<lt>NE<gt>>"
24941 #: ../tools/virt-make-fs.pl:189
24942 msgid "B<-s E<lt>NE<gt>>"
24946 #: ../tools/virt-make-fs.pl:191
24947 msgid "B<-s +E<lt>NE<gt>>"
24951 #: ../tools/virt-make-fs.pl:193
24953 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
24957 #: ../tools/virt-make-fs.pl:196
24959 "If this option is I<not> given, then the output image will be just large "
24960 "enough to contain all the files, with not much wasted space."
24964 #: ../tools/virt-make-fs.pl:199
24966 "To choose a fixed size output disk, specify an absolute number followed by b/"
24967 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
24968 "Petabytes or Exabytes. This must be large enough to contain all the input "
24969 "files, else you will get an error."
24973 #: ../tools/virt-make-fs.pl:204
24975 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
24976 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
24977 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
24978 "the input files, and (approximately) an extra 200 MB free space."
24982 #: ../tools/virt-make-fs.pl:210
24984 "Note that virt-make-fs estimates free space, and therefore will not produce "
24985 "filesystems containing precisely the free space requested. (It is much more "
24986 "expensive and time-consuming to produce a filesystem which has precisely the "
24987 "desired free space)."
24991 #: ../tools/virt-make-fs.pl:219
24992 msgid "B<--format=E<lt>fmtE<gt>>"
24996 #: ../tools/virt-make-fs.pl:221
24997 msgid "B<-F E<lt>fmtE<gt>>"
25001 #: ../tools/virt-make-fs.pl:223
25002 msgid "Choose the output disk image format."
25006 #: ../tools/virt-make-fs.pl:225
25007 msgid "The default is C<raw> (raw disk image)."
25011 #: ../tools/virt-make-fs.pl:227
25013 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
25014 "that would really make sense here is C<qcow2>."
25018 #: ../tools/virt-make-fs.pl:234
25019 msgid "B<--type=E<lt>fsE<gt>>"
25023 #: ../tools/virt-make-fs.pl:236
25024 msgid "B<-t E<lt>fsE<gt>>"
25028 #: ../tools/virt-make-fs.pl:238
25029 msgid "Choose the output filesystem type."
25033 #: ../tools/virt-make-fs.pl:240
25034 msgid "The default is C<ext2>."
25038 #: ../tools/virt-make-fs.pl:242
25040 "Any filesystem which is supported read-write by libguestfs can be used here."
25044 #: ../tools/virt-make-fs.pl:249
25045 msgid "B<--partition>"
25049 #: ../tools/virt-make-fs.pl:251
25050 msgid "B<--partition=E<lt>parttypeE<gt>>"
25054 #: ../tools/virt-make-fs.pl:253
25056 "If specified, this flag adds an MBR partition table to the output disk image."
25060 #: ../tools/virt-make-fs.pl:256
25062 "You can change the partition table type, eg. C<--partition=gpt> for large "
25067 #: ../tools/virt-make-fs.pl:259
25069 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
25070 "might consider the next parameter to be the partition type. For example:"
25074 #: ../tools/virt-make-fs.pl:263
25077 " virt-make-fs --partition input.tar ...\n"
25082 #: ../tools/virt-make-fs.pl:265
25084 "would cause virt-make-fs to think you wanted to use a partition type of "
25085 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
25086 "dash) between options and the input file argument:"
25090 #: ../tools/virt-make-fs.pl:269
25093 " virt-make-fs --partition -- input.tar ...\n"
25098 #: ../tools/virt-make-fs.pl:529
25100 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
25101 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
25102 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
25106 #: ../tools/virt-make-fs.pl:543 ../tools/virt-win-reg.pl:478
25108 "When reporting bugs, please enable debugging and capture the I<complete> "
25113 #: ../tools/virt-make-fs.pl:546
25116 " export LIBGUESTFS_DEBUG=1\n"
25117 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
25122 #: ../tools/virt-make-fs.pl:549
25124 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
25129 #: ../tools/virt-make-fs.pl:558 ../tools/virt-resize.pl:1413
25130 #: ../tools/virt-win-reg.pl:493
25131 msgid "Copyright (C) 2010 Red Hat Inc."
25135 #: ../tools/virt-rescue.pl:33
25136 msgid "virt-rescue - Run a rescue shell on a virtual machine"
25140 #: ../tools/virt-rescue.pl:37
25143 " virt-rescue [--options] domname\n"
25148 #: ../tools/virt-rescue.pl:39
25151 " virt-rescue [--options] disk.img [disk.img ...]\n"
25156 #: ../tools/virt-rescue.pl:43
25158 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
25159 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
25160 "you from doing this, but doesn't catch all cases."
25164 #: ../tools/virt-rescue.pl:47
25166 "However if you use the I<--ro> (read only) option, then you can attach a "
25167 "shell to a live virtual machine. The results might be strange or "
25168 "inconsistent at times but you won't get disk corruption."
25172 #: ../tools/virt-rescue.pl:53
25174 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
25175 "need for a CD. virt-rescue gives you a rescue shell and some simple "
25176 "recovery tools which you can use to examine or rescue a virtual machine or "
25181 #: ../tools/virt-rescue.pl:58
25183 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
25184 "on disk image(s):"
25188 #: ../tools/virt-rescue.pl:61
25191 " virt-rescue GuestName\n"
25196 #: ../tools/virt-rescue.pl:63
25199 " virt-rescue --ro /path/to/disk.img\n"
25204 #: ../tools/virt-rescue.pl:65
25207 " virt-rescue /dev/sdc\n"
25212 #: ../tools/virt-rescue.pl:67
25213 msgid "For live VMs you I<must> use the --ro option."
25217 #: ../tools/virt-rescue.pl:69
25219 "When you run virt-rescue on a virtual machine or disk image, you are placed "
25220 "in an interactive bash shell where you can use many ordinary Linux "
25221 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
25222 "appliance. You must mount the virtual machine's filesystems by hand. There "
25223 "is an empty directory called C</sysroot> where you can mount filesystems."
25227 #: ../tools/virt-rescue.pl:76
25229 "In the example below, we list logical volumes, then choose one to mount "
25230 "under C</sysroot>:"
25234 #: ../tools/virt-rescue.pl:79
25238 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
25239 " lv_root vg_f11x64 -wi-a- 8.83G\n"
25240 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
25241 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
25242 " ><rescue> ls /sysroot\n"
25247 #: ../tools/virt-rescue.pl:86
25249 "If you don't know what filesystems are available on the virtual machine then "
25250 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
25254 #: ../tools/virt-rescue.pl:90 ../tools/virt-resize.pl:1350
25259 #: ../tools/virt-rescue.pl:92
25261 "Virt-rescue can be used on I<any> disk image file or device, not just a "
25262 "virtual machine. For example you can use it on a blank file if you want to "
25263 "partition that file (although we would recommend using L<guestfish(1)> "
25264 "instead as it is more suitable for this purpose). You can even use virt-"
25265 "rescue on things like SD cards."
25269 #: ../tools/virt-rescue.pl:98
25271 "This tool is just designed for quick interactive hacking on a virtual "
25272 "machine. For more structured access to a virtual machine disk image, you "
25273 "should use L<guestfs(3)>. To get a structured shell that you can use to "
25274 "make scripted changes to guests, use L<guestfish(1)>."
25278 #: ../tools/virt-rescue.pl:127
25279 msgid "B<--append kernelopts>"
25283 #: ../tools/virt-rescue.pl:129
25284 msgid "Pass additional options to the rescue kernel."
25288 #: ../tools/virt-rescue.pl:147
25289 msgid "B<--memsize MB> | B<-m MB>"
25293 #: ../tools/virt-rescue.pl:149
25295 "Change the amount of memory allocated to the rescue system. The default is "
25296 "set by libguestfs and is small but adequate for running system tools. The "
25297 "occasional program might need more memory. The parameter is specified in "
25302 #: ../tools/virt-rescue.pl:158
25303 msgid "B<--ro> | B<-r>"
25307 #: ../tools/virt-rescue.pl:160
25308 msgid "Open the image read-only."
25312 #: ../tools/virt-rescue.pl:172
25314 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
25315 "SELINUX> before using this option."
25319 #: ../tools/virt-rescue.pl:228
25321 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
25322 "ENVIRONMENT VARIABLES> for the complete list."
25326 #: ../tools/virt-rescue.pl:233
25328 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
25329 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
25333 #: ../tools/virt-resize.pl:42
25334 msgid "virt-resize - Resize a virtual machine disk"
25338 #: ../tools/virt-resize.pl:46
25341 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
25342 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
25343 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
25348 #: ../tools/virt-resize.pl:52
25350 "Virt-resize is a tool which can resize a virtual machine disk, making it "
25351 "larger or smaller overall, and resizing or deleting any partitions contained "
25356 #: ../tools/virt-resize.pl:56
25358 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
25359 "not> be used on live virtual machines - for consistent results, shut the "
25360 "virtual machine down before resizing it."
25364 #: ../tools/virt-resize.pl:60
25366 "If you are not familiar with the associated tools: L<virt-list-partitions(1)"
25367 ">, L<virt-list-filesystems(1)> and L<virt-df(1)>, we recommend you go and "
25368 "read those manual pages first."
25372 #: ../tools/virt-resize.pl:68
25374 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
25375 "fill the extra 5GB of space."
25379 #: ../tools/virt-resize.pl:71
25382 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
25383 " virt-list-partitions -lht olddisk\n"
25384 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
25385 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
25390 #: ../tools/virt-resize.pl:76
25392 "As above, but make the /boot partition 200MB bigger, while giving the "
25393 "remaining space to /dev/sda2:"
25397 #: ../tools/virt-resize.pl:79
25400 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
25405 #: ../tools/virt-resize.pl:81
25406 msgid "DETAILED USAGE"
25410 #: ../tools/virt-resize.pl:83
25411 msgid "EXPANDING A VIRTUAL MACHINE DISK"
25415 #: ../tools/virt-resize.pl:87
25416 msgid "1. Shut down the virtual machine"
25420 #: ../tools/virt-resize.pl:89
25421 msgid "2. Locate input disk image"
25425 #: ../tools/virt-resize.pl:91
25427 "Locate the input disk image (ie. the file or device on the host containing "
25428 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
25429 "dumpxml> like this to find the disk image name:"
25433 #: ../tools/virt-resize.pl:95
25436 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
25437 " Found 1 nodes:\n"
25439 " <source dev=\"/dev/vg/lv_guest\" />\n"
25444 #: ../tools/virt-resize.pl:100
25445 msgid "3. Look at current sizing"
25449 #: ../tools/virt-resize.pl:102
25451 "Use L<virt-list-partitions(1)> to display the current partitions and sizes:"
25455 #: ../tools/virt-resize.pl:105
25458 " # virt-list-partitions -lht /dev/vg/lv_guest\n"
25459 " /dev/sda1 ext3 101.9M\n"
25460 " /dev/sda2 pv 7.9G\n"
25461 " /dev/sda device 8.0G\n"
25466 #: ../tools/virt-resize.pl:110
25468 "(This example is a virtual machine with an 8 GB disk which we would like to "
25469 "expand up to 10 GB)."
25473 #: ../tools/virt-resize.pl:113
25474 msgid "4. Create output disk"
25478 #: ../tools/virt-resize.pl:115
25480 "Virt-resize cannot do in-place disk modifications. You have to have space "
25481 "to store the resized output disk."
25485 #: ../tools/virt-resize.pl:118
25487 "To store the resized disk image in a file, create a file of a suitable size:"
25491 #: ../tools/virt-resize.pl:121
25494 " # rm -f outdisk\n"
25495 " # truncate -s 10G outdisk\n"
25500 #: ../tools/virt-resize.pl:124
25501 msgid "Or use L<lvcreate(1)> to create a logical volume:"
25505 #: ../tools/virt-resize.pl:126
25508 " # lvcreate -L 10G -n lv_name vg_name\n"
25513 #: ../tools/virt-resize.pl:128
25514 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
25518 #: ../tools/virt-resize.pl:130
25521 " # virsh pool-list\n"
25522 " # virsh vol-create-as poolname newvol 10G\n"
25527 #: ../tools/virt-resize.pl:133
25532 #: ../tools/virt-resize.pl:135
25534 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
25535 "file) and the output disk. The output disk is the one created in the "
25540 #: ../tools/virt-resize.pl:139
25543 " # virt-resize indisk outdisk\n"
25548 #: ../tools/virt-resize.pl:141
25550 "This command just copies disk image C<indisk> to disk image C<outdisk> "
25551 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
25552 "larger, then an extra, empty partition is created at the end of the disk "
25553 "covering the extra space. If C<outdisk> is smaller, then it will give an "
25558 #: ../tools/virt-resize.pl:147
25560 "More realistically you'd want to expand existing partitions in the disk "
25561 "image by passing extra options (for the full list see the L</OPTIONS> "
25566 #: ../tools/virt-resize.pl:151
25568 "L</--expand> is the most useful option. It expands the named partition "
25569 "within the disk to fill any extra space:"
25573 #: ../tools/virt-resize.pl:154
25576 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
25581 #: ../tools/virt-resize.pl:156
25583 "(In this case, an extra partition is I<not> created at the end of the disk, "
25584 "because there will be no unused space)."
25588 #: ../tools/virt-resize.pl:159
25590 "L</--resize> is the other commonly used option. The following would "
25591 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
25592 "rest of the available space:"
25596 #: ../tools/virt-resize.pl:163
25599 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
25600 " indisk outdisk\n"
25605 #: ../tools/virt-resize.pl:166
25607 "If the expanded partition in the image contains a filesystem or LVM PV, then "
25608 "if virt-resize knows how, it will resize the contents, the equivalent of "
25609 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
25610 ">. However virt-resize does not know how to resize some filesystems, so you "
25611 "would have to online resize them after booting the guest. And virt-resize "
25612 "also does not resize anything inside an LVM PV, it just resizes the PV "
25613 "itself and leaves the user to resize any LVs inside that PV as desired."
25617 #: ../tools/virt-resize.pl:175
25618 msgid "Other options are covered below."
25622 #: ../tools/virt-resize.pl:177
25627 #: ../tools/virt-resize.pl:179
25628 msgid "Thoroughly test the new disk image I<before> discarding the old one."
25632 #: ../tools/virt-resize.pl:181
25633 msgid "If you are using libvirt, edit the XML to point at the new disk:"
25637 #: ../tools/virt-resize.pl:183
25640 " # virsh edit guestname\n"
25645 #: ../tools/virt-resize.pl:185
25647 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
25648 "html#elementsDisks>"
25652 #: ../tools/virt-resize.pl:188
25653 msgid "Then start up the domain with the new, resized disk:"
25657 #: ../tools/virt-resize.pl:190
25660 " # virsh start guestname\n"
25665 #: ../tools/virt-resize.pl:192
25667 "and check that it still works. See also the L</NOTES> section below for "
25668 "additional information."
25672 #: ../tools/virt-resize.pl:195
25673 msgid "7. Resize LVs etc inside the guest"
25677 #: ../tools/virt-resize.pl:197
25678 msgid "(This can also be done offline using L<guestfish(1)>)"
25682 #: ../tools/virt-resize.pl:199
25684 "Once the guest has booted you should see the new space available, at least "
25685 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
25686 "may need to resize LVs inside PVs, and also resize filesystem types that "
25687 "virt-resize does not know how to expand."
25691 #: ../tools/virt-resize.pl:206
25692 msgid "SHRINKING A VIRTUAL MACHINE DISK"
25696 #: ../tools/virt-resize.pl:208
25698 "Shrinking is somewhat more complex than expanding, and only an overview is "
25703 #: ../tools/virt-resize.pl:211
25705 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
25706 "filesystems). The user has to shrink content before passing the disk image "
25707 "to virt-resize, and virt-resize will check that the content has been shrunk "
25712 #: ../tools/virt-resize.pl:216
25713 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
25717 #: ../tools/virt-resize.pl:218
25719 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
25720 "steps 3 and 4 above to allocate a new disk image."
25724 #: ../tools/virt-resize.pl:221
25726 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
25730 #: ../tools/virt-resize.pl:224
25731 msgid "IGNORING OR DELETING PARTITIONS"
25735 #: ../tools/virt-resize.pl:226
25737 "virt-resize also gives a convenient way to ignore or delete partitions when "
25738 "copying from the input disk to the output disk. Ignoring a partition speeds "
25739 "up the copy where you don't care about the existing contents of a "
25740 "partition. Deleting a partition removes it completely, but note that it "
25741 "also renumbers any partitions after the one which is deleted, which can "
25742 "leave some guests unbootable."
25746 #: ../tools/virt-resize.pl:243
25747 msgid "Display help."
25751 #: ../tools/virt-resize.pl:257
25752 msgid "B<--resize part=size>"
25756 #: ../tools/virt-resize.pl:259
25758 "Resize the named partition (expanding or shrinking it) so that it has the "
25763 #: ../tools/virt-resize.pl:262
25765 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
25766 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
25767 "Exabytes; or as a percentage of the current size; or as a relative number or "
25768 "percentage. For example:"
25772 #: ../tools/virt-resize.pl:267
25775 " --resize /dev/sda2=10G\n"
25780 #: ../tools/virt-resize.pl:269
25783 " --resize /dev/sda4=90%\n"
25788 #: ../tools/virt-resize.pl:271
25791 " --resize /dev/sda2=+1G\n"
25796 #: ../tools/virt-resize.pl:273
25799 " --resize /dev/sda2=-200M\n"
25804 #: ../tools/virt-resize.pl:275
25807 " --resize /dev/sda1=+128K\n"
25812 #: ../tools/virt-resize.pl:277
25815 " --resize /dev/sda1=+10%\n"
25820 #: ../tools/virt-resize.pl:279
25823 " --resize /dev/sda1=-10%\n"
25828 #: ../tools/virt-resize.pl:281
25830 "You can increase the size of any partition. Virt-resize will expand the "
25831 "direct content of the partition if it knows how (see C<--expand> below)."
25835 #: ../tools/virt-resize.pl:285
25837 "You can only I<decrease> the size of partitions that contain filesystems or "
25838 "PVs which have already been shrunk. Virt-resize will check this has been "
25839 "done before proceeding, or else will print an error (see also C<--resize-"
25844 #: ../tools/virt-resize.pl:290 ../tools/virt-resize.pl:382
25845 #: ../tools/virt-resize.pl:399
25846 msgid "You can give this option multiple times."
25850 #: ../tools/virt-resize.pl:296
25851 msgid "B<--resize-force part=size>"
25855 #: ../tools/virt-resize.pl:298
25857 "This is the same as C<--resize> except that it will let you decrease the "
25858 "size of any partition. Generally this means you will lose any data which "
25859 "was at the end of the partition you shrink, but you may not care about that "
25860 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
25861 "as a swap partition)."
25865 #: ../tools/virt-resize.pl:304
25866 msgid "See also the C<--ignore> option."
25870 #: ../tools/virt-resize.pl:310
25871 msgid "B<--expand part>"
25875 #: ../tools/virt-resize.pl:312
25877 "Expand the named partition so it uses up all extra space (space left over "
25878 "after any other resize changes that you request have been done)."
25882 #: ../tools/virt-resize.pl:315
25884 "If virt-resize knows how, it will expand the direct content of the "
25885 "partition. For example, if the partition is an LVM PV, it will expand the "
25886 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
25887 "content it doesn't know about alone."
25891 #: ../tools/virt-resize.pl:320
25892 msgid "Currently virt-resize can resize:"
25896 #: ../tools/virt-resize.pl:326
25898 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
25903 #: ../tools/virt-resize.pl:331
25905 "NTFS filesystems contained directly in a partition, if libguestfs was "
25906 "compiled with support for NTFS."
25910 #: ../tools/virt-resize.pl:334
25912 "The filesystem must have been shut down consistently last time it was used. "
25913 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
25914 "consistency check, so at the first boot after resizing Windows will check "
25919 #: ../tools/virt-resize.pl:341
25921 "LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
25922 "inside the PV. The user will have to resize LVs as desired."
25926 #: ../tools/virt-resize.pl:347 ../tools/virt-resize.pl:369
25927 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
25931 #: ../tools/virt-resize.pl:353
25932 msgid "B<--shrink part>"
25936 #: ../tools/virt-resize.pl:355
25938 "Shrink the named partition until the overall disk image fits in the "
25939 "destination. The named partition B<must> contain a filesystem or PV which "
25940 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
25941 "online tools). Virt-resize will check this and give an error if it has not "
25946 #: ../tools/virt-resize.pl:361
25948 "The amount by which the overall disk must be shrunk (after carrying out all "
25949 "other operations requested by the user) is called the \"deficit\". For "
25950 "example, a straight copy (assume no other operations) from a 5GB disk image "
25951 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
25952 "would give an error unless the user specified a partition to shrink and that "
25953 "partition had more than a gigabyte of free space."
25957 #: ../tools/virt-resize.pl:375
25958 msgid "B<--ignore part>"
25962 #: ../tools/virt-resize.pl:377
25964 "Ignore the named partition. Effectively this means the partition is "
25965 "allocated on the destination disk, but the content is not copied across from "
25966 "the source disk. The content of the partition will be blank (all zero "
25971 #: ../tools/virt-resize.pl:388
25972 msgid "B<--delete part>"
25976 #: ../tools/virt-resize.pl:390
25978 "Delete the named partition. It would be more accurate to describe this as "
25979 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
25980 "the original disk image is left intact."
25984 #: ../tools/virt-resize.pl:394
25986 "Note that when you delete a partition, then anything contained in the "
25987 "partition is also deleted. Furthermore, this causes any partitions that "
25988 "come after to be I<renumbered>, which can easily make your guest unbootable."
25992 #: ../tools/virt-resize.pl:405
25993 msgid "B<--LV-expand logvol>"
25997 #: ../tools/virt-resize.pl:407
25999 "This takes the logical volume and, as a final step, expands it to fill all "
26000 "the space available in its volume group. A typical usage, assuming a Linux "
26001 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
26002 "lv_root> would be:"
26006 #: ../tools/virt-resize.pl:412
26009 " virt-resize indisk outdisk \\\n"
26010 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
26015 #: ../tools/virt-resize.pl:415
26017 "This would first expand the partition (and PV), and then expand the root "
26018 "device to fill the extra space in the PV."
26022 #: ../tools/virt-resize.pl:418
26024 "The contents of the LV are also resized if virt-resize knows how to do "
26025 "that. You can stop virt-resize from trying to expand the content by using "
26026 "the option C<--no-expand-content>."
26030 #: ../tools/virt-resize.pl:422
26031 msgid "Use L<virt-list-filesystems(1)> to list the filesystems in the guest."
26035 #: ../tools/virt-resize.pl:425
26037 "You can give this option multiple times, I<but> it doesn't make sense to do "
26038 "this unless the logical volumes you specify are all in different volume "
26043 #: ../tools/virt-resize.pl:433
26044 msgid "B<--no-copy-boot-loader>"
26048 #: ../tools/virt-resize.pl:435
26050 "By default, virt-resize copies over some sectors at the start of the disk "
26051 "(up to the beginning of the first partition). Commonly these sectors "
26052 "contain the Master Boot Record (MBR) and the boot loader, and are required "
26053 "in order for the guest to boot correctly."
26057 #: ../tools/virt-resize.pl:440
26059 "If you specify this flag, then this initial copy is not done. You may need "
26060 "to reinstall the boot loader in this case."
26064 #: ../tools/virt-resize.pl:448
26065 msgid "B<--no-extra-partition>"
26069 #: ../tools/virt-resize.pl:450
26071 "By default, virt-resize creates an extra partition if there is any extra, "
26072 "unused space after all resizing has happened. Use this option to prevent "
26073 "the extra partition from being created. If you do this then the extra space "
26074 "will be inaccessible until you run fdisk, parted, or some other partitioning "
26075 "tool in the guest."
26079 #: ../tools/virt-resize.pl:456
26081 "Note that if the surplus space is smaller than 10 MB, no extra partition "
26086 #: ../tools/virt-resize.pl:463
26087 msgid "B<--no-expand-content>"
26091 #: ../tools/virt-resize.pl:465
26093 "By default, virt-resize will try to expand the direct contents of "
26094 "partitions, if it knows how (see C<--expand> option above)."
26098 #: ../tools/virt-resize.pl:468
26100 "If you give the C<--no-expand-content> option then virt-resize will not "
26105 #: ../tools/virt-resize.pl:475
26106 msgid "B<-d> | B<--debug>"
26110 #: ../tools/virt-resize.pl:477 ../tools/virt-win-reg.pl:198
26111 msgid "Enable debugging messages."
26115 #: ../tools/virt-resize.pl:483
26116 msgid "B<-n> | B<--dryrun>"
26120 #: ../tools/virt-resize.pl:485
26121 msgid "Print a summary of what would be done, but don't do anything."
26125 #: ../tools/virt-resize.pl:491
26126 msgid "B<-q> | B<--quiet>"
26130 #: ../tools/virt-resize.pl:493
26131 msgid "Don't print the summary."
26135 #: ../tools/virt-resize.pl:1352
26136 msgid "\"Partition 1 does not end on cylinder boundary.\""
26140 #: ../tools/virt-resize.pl:1354
26142 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
26143 "means the partitions will not be aligned to the ancient CHS geometry. "
26144 "However CHS geometry is meaningless for disks manufactured since the early "
26145 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
26146 "cylinders is not required by any modern operating system."
26150 #: ../tools/virt-resize.pl:1361
26151 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
26155 #: ../tools/virt-resize.pl:1363
26157 "In Windows Vista and later versions, Microsoft switched to using a separate "
26158 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
26159 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
26160 "the boot partition. Doing so seems to break the guest completely. However "
26161 "expanding the second partition (ie. C: drive) should work."
26165 #: ../tools/virt-resize.pl:1370
26167 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
26168 "NTFS partitions have been expanded. This is just a safety check and (unless "
26169 "it find errors) is nothing to worry about."
26173 #: ../tools/virt-resize.pl:1374
26174 msgid "ALTERNATIVE TOOLS"
26178 #: ../tools/virt-resize.pl:1376
26180 "There are several proprietary tools for resizing partitions. We won't "
26181 "mention any here."
26185 #: ../tools/virt-resize.pl:1379
26187 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
26188 "operations on disk images. They can resize and move partitions, but I don't "
26189 "think they can do anything with the contents, and they certainly don't "
26194 #: ../tools/virt-resize.pl:1384
26196 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
26197 "but at a much lower level. You will probably end up hand-calculating sector "
26198 "offsets, which is something that virt-resize was designed to avoid. If you "
26199 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
26204 #: ../tools/virt-resize.pl:1392
26206 "L<virt-list-partitions(1)>, L<virt-list-filesystems(1)>, L<virt-df(1)>, "
26207 "L<guestfs(3)>, L<guestfish(1)>, L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, "
26208 "L<resize2fs(8)>, L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<Sys::Guestfs"
26209 "(3)>, L<http://libguestfs.org/>."
26213 #: ../tools/virt-tar.pl:34
26214 msgid "virt-tar - Extract or upload files to a virtual machine"
26218 #: ../tools/virt-tar.pl:38
26221 " virt-tar [--options] -x domname directory tarball\n"
26226 #: ../tools/virt-tar.pl:40
26229 " virt-tar [--options] -u domname tarball directory\n"
26234 #: ../tools/virt-tar.pl:42
26237 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
26242 #: ../tools/virt-tar.pl:44
26245 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
26250 #: ../tools/virt-tar.pl:48
26251 msgid "Download C</home> from the VM into a local tarball:"
26255 #: ../tools/virt-tar.pl:50
26258 " virt-tar -x domname /home home.tar\n"
26263 #: ../tools/virt-tar.pl:52
26266 " virt-tar -zx domname /home home.tar.gz\n"
26271 #: ../tools/virt-tar.pl:54
26272 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
26276 #: ../tools/virt-tar.pl:56
26279 " virt-tar -u domname uploadstuff.tar /tmp\n"
26284 #: ../tools/virt-tar.pl:58
26287 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
26292 #: ../tools/virt-tar.pl:62
26294 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
26295 "virtual machines. If you do this, you risk disk corruption in the VM. "
26296 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
26300 #: ../tools/virt-tar.pl:67
26302 "You can use C<-x> (extract) on live virtual machines, but you might get "
26303 "inconsistent results or errors if there is filesystem activity inside the "
26304 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
26305 "work, but the only way to guarantee consistent results is if the virtual "
26306 "machine is shut down."
26310 #: ../tools/virt-tar.pl:75
26312 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
26313 "parts of a guest filesystem. There are many possibilities: making backups, "
26314 "uploading data files, snooping on guest activity, fixing or customizing "
26319 #: ../tools/virt-tar.pl:80
26321 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
26322 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
26323 "should look at the L<guestfish(1)> tool."
26327 #: ../tools/virt-tar.pl:84
26329 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
26330 "its contents (recursively) from the virtual machine into a local tarball. "
26331 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
26332 "virtual machine. You cannot use these two options together."
26336 #: ../tools/virt-tar.pl:90
26338 "In addition, you may need to use the C<-z> (gZip) option to enable "
26339 "compression. When uploading, you have to specify C<-z> if the upload file "
26340 "is compressed because virt-tar won't detect this on its own."
26344 #: ../tools/virt-tar.pl:94
26346 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
26347 "example it cannot do PKZip files or bzip2 compression. If you want that "
26348 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
26349 "the L<libguestfs(3)> API)."
26353 #: ../tools/virt-tar.pl:135
26354 msgid "B<-x> | B<--extract> | B<--download>"
26358 #: ../tools/virt-tar.pl:137
26359 msgid "B<-u> | B<--upload>"
26363 #: ../tools/virt-tar.pl:139
26365 "Use C<-x> to extract (download) a directory from a virtual machine to a "
26370 #: ../tools/virt-tar.pl:142
26372 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
26373 "Please read the L</WARNING> section above before using this option."
26377 #: ../tools/virt-tar.pl:146
26378 msgid "You must specify exactly one of these options."
26382 #: ../tools/virt-tar.pl:152
26383 msgid "B<-z> | B<--gzip>"
26387 #: ../tools/virt-tar.pl:154
26388 msgid "Specify that the input or output tarball is gzip-compressed."
26392 #: ../tools/virt-tar.pl:259
26394 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<Sys::"
26395 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
26400 #: ../tools/virt-win-reg.pl:38
26402 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
26406 #: ../tools/virt-win-reg.pl:42
26409 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
26414 #: ../tools/virt-win-reg.pl:44
26417 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
26422 #: ../tools/virt-win-reg.pl:46
26425 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
26430 #: ../tools/virt-win-reg.pl:48
26433 " virt-win-reg --merge domname [input.reg ...]\n"
26438 #: ../tools/virt-win-reg.pl:50
26441 " virt-win-reg [--options] disk.img ... # instead of domname\n"
26446 #: ../tools/virt-win-reg.pl:54
26448 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
26449 "virtual machines. If you do this, you I<will> get irreversible disk "
26450 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
26451 "but doesn't catch all cases."
26455 #: ../tools/virt-win-reg.pl:59
26457 "Modifying the Windows Registry is an inherently risky operation. The format "
26458 "is deliberately obscure and undocumented, and Registry changes can leave the "
26459 "system unbootable. Therefore when using the C<--merge> option, make sure "
26460 "you have a reliable backup first."
26464 #: ../tools/virt-win-reg.pl:66
26466 "This program can export and merge Windows Registry entries from a Windows "
26471 #: ../tools/virt-win-reg.pl:69
26473 "The first parameter is the libvirt guest name or the raw disk image of a "
26478 #: ../tools/virt-win-reg.pl:72
26480 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
26481 "exported (recursively). For example:"
26485 #: ../tools/virt-win-reg.pl:75
26488 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
26493 #: ../tools/virt-win-reg.pl:77
26495 "You can also display single values from within registry keys, for example:"
26499 #: ../tools/virt-win-reg.pl:80
26502 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
26503 " $ virt-win-reg Windows7 $cvkey ProductName\n"
26504 " Windows 7 Enterprise\n"
26509 #: ../tools/virt-win-reg.pl:84
26511 "With C<--merge>, you can merge a textual regedit file into the Windows "
26516 #: ../tools/virt-win-reg.pl:87
26519 " $ virt-win-reg --merge Windows7 changes.reg\n"
26524 #: ../tools/virt-win-reg.pl:89
26525 msgid "SUPPORTED SYSTEMS"
26529 #: ../tools/virt-win-reg.pl:91
26531 "The program currently supports Windows NT-derived guests starting with "
26532 "Windows XP through to at least Windows 7."
26536 #: ../tools/virt-win-reg.pl:94
26538 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
26539 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
26540 "and C<HKEY_USERS\\.DEFAULT>."
26544 #: ../tools/virt-win-reg.pl:98
26546 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
26551 #: ../tools/virt-win-reg.pl:101
26553 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
26558 #: ../tools/virt-win-reg.pl:104
26563 #: ../tools/virt-win-reg.pl:106
26565 "This program is only meant for simple access to the registry. If you want "
26566 "to do complicated things with the registry, we suggest you download the "
26567 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
26568 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
26569 "L<hivexregedit(1)>."
26573 #: ../tools/virt-win-reg.pl:112
26578 #: ../tools/virt-win-reg.pl:114
26580 "C<virt-win-reg> expects that regedit files have already been reencoded in "
26581 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
26582 "style line endings. Since Windows regedit files are often in UTF-16LE with "
26583 "Windows-style line endings, you may need to reencode the whole file before "
26584 "or after processing."
26588 #: ../tools/virt-win-reg.pl:120
26590 "To reencode a file from Windows format to Linux (before processing it with "
26591 "the C<--merge> option), you would do something like this:"
26595 #: ../tools/virt-win-reg.pl:123
26598 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
26603 #: ../tools/virt-win-reg.pl:125
26605 "To go in the opposite direction, after exporting and before sending the file "
26606 "to a Windows user, do something like this:"
26610 #: ../tools/virt-win-reg.pl:128
26613 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
26618 #: ../tools/virt-win-reg.pl:130
26619 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
26623 #: ../tools/virt-win-reg.pl:132
26625 "If you are unsure about the current encoding, use the L<file(1)> command. "
26626 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
26627 "style (CRLF) line endings, like this:"
26631 #: ../tools/virt-win-reg.pl:136
26634 " $ file software.reg\n"
26635 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
26636 " with CRLF line terminators\n"
26641 #: ../tools/virt-win-reg.pl:140
26642 msgid "This file would need conversion before you could C<--merge> it."
26646 #: ../tools/virt-win-reg.pl:142
26647 msgid "SHELL QUOTING"
26651 #: ../tools/virt-win-reg.pl:144
26653 "Be careful when passing parameters containing C<\\> (backslash) in the "
26654 "shell. Usually you will have to use 'single quotes' or double backslashes "
26655 "(but not both) to protect them from the shell."
26659 #: ../tools/virt-win-reg.pl:148
26660 msgid "Paths and value names are case-insensitive."
26664 #: ../tools/virt-win-reg.pl:150
26665 msgid "CurrentControlSet etc."
26669 #: ../tools/virt-win-reg.pl:152
26671 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
26672 "Registry at the level of the hive file, and therefore you cannot modify "
26677 #: ../tools/virt-win-reg.pl:156
26679 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
26680 "circumstances it might refer to another control set. The way to find out is "
26681 "to look at the C<HKLM\\SYSTEM\\Select> key:"
26685 #: ../tools/virt-win-reg.pl:160
26688 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
26689 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
26690 " \"Current\"=dword:00000001\n"
26691 " \"Default\"=dword:00000001\n"
26692 " \"Failed\"=dword:00000000\n"
26693 " \"LastKnownGood\"=dword:00000002\n"
26698 #: ../tools/virt-win-reg.pl:167
26699 msgid "\"Default\" is the one which Windows will choose when it boots."
26703 #: ../tools/virt-win-reg.pl:169
26705 "Similarly, other C<Current...> keys in the path may need to be replaced."
26709 #: ../tools/virt-win-reg.pl:216
26714 #: ../tools/virt-win-reg.pl:218
26716 "In merge mode, this merges a textual regedit file into the Windows Registry "
26717 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
26718 "displays or exports Registry entries instead."
26722 #: ../tools/virt-win-reg.pl:222
26724 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
26725 "result in disk corruption. However exporting (without this flag) is always "
26730 #: ../tools/virt-win-reg.pl:230
26731 msgid "B<--encoding> UTF-16LE|ASCII"
26735 #: ../tools/virt-win-reg.pl:232
26737 "When merging (only), you may need to specify the encoding for strings to be "
26738 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
26739 "(3)/ENCODING STRINGS>."
26743 #: ../tools/virt-win-reg.pl:236
26745 "The default is to use UTF-16LE, which should work with recent versions of "
26750 #: ../tools/virt-win-reg.pl:463
26752 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
26753 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
26754 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26758 #: ../tools/virt-win-reg.pl:481
26761 " export LIBGUESTFS_DEBUG=1\n"
26762 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
26767 #: ../tools/virt-win-reg.pl:484
26769 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."