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-10-01 21:02+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-edit.pl:31
23 #: ../tools/virt-win-reg.pl:34 ../tools/virt-df.pl:32 ../tools/virt-ls.pl:31
24 #: ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28
25 #: ../tools/virt-cat.pl:30 ../tools/virt-tar.pl:30 ../tools/virt-rescue.pl:29
26 #: ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28
31 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
32 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
33 #: ../inspector/virt-inspector.pl:38 ../tools/virt-edit.pl:33
34 #: ../tools/virt-win-reg.pl:36 ../tools/virt-df.pl:34 ../tools/virt-ls.pl:33
35 #: ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30
36 #: ../tools/virt-cat.pl:32 ../tools/virt-tar.pl:32 ../tools/virt-rescue.pl:31
37 #: ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
42 #: ../src/guestfs.pod:5
43 msgid "guestfs - Library for accessing and modifying virtual machine images"
47 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
48 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
49 #: ../inspector/virt-inspector.pl:42 ../tools/virt-edit.pl:37
50 #: ../tools/virt-win-reg.pl:40 ../tools/virt-df.pl:38 ../tools/virt-ls.pl:37
51 #: ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34
52 #: ../tools/virt-cat.pl:36 ../tools/virt-tar.pl:36 ../tools/virt-rescue.pl:35
53 #: ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
58 #: ../src/guestfs.pod:9
61 " #include <guestfs.h>\n"
66 #: ../src/guestfs.pod:11
69 " guestfs_h *g = guestfs_create ();\n"
70 " guestfs_add_drive (g, \"guest.img\");\n"
71 " guestfs_launch (g);\n"
72 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
73 " guestfs_touch (g, \"/hello\");\n"
74 " guestfs_umount (g, \"/\");\n"
75 " guestfs_sync (g);\n"
76 " guestfs_close (g);\n"
81 #: ../src/guestfs.pod:20
84 " cc prog.c -o prog -lguestfs\n"
86 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
91 #: ../src/guestfs.pod:24 ../fish/guestfish.pod:30
92 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:16
93 #: ../inspector/virt-inspector.pl:48 ../tools/virt-edit.pl:51
94 #: ../tools/virt-win-reg.pl:64 ../tools/virt-df.pl:46 ../tools/virt-ls.pl:43
95 #: ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40
96 #: ../tools/virt-cat.pl:42 ../tools/virt-tar.pl:73 ../tools/virt-rescue.pl:51
97 #: ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
102 #: ../src/guestfs.pod:26
104 "Libguestfs is a library for accessing and modifying guest disk images. "
105 "Amongst the things this is good for: making batch configuration changes to "
106 "guests, getting disk used/free statistics (see also: virt-df), migrating "
107 "between virtualization systems (see also: virt-p2v), performing partial "
108 "backups, performing partial guest clones, cloning guests and changing "
109 "registry/UUID/hostname info, and much else besides."
113 #: ../src/guestfs.pod:34
115 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
116 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
117 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
122 #: ../src/guestfs.pod:39
124 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
125 "what filesystem is in each LV, etc.). It can also run commands in the "
126 "context of the guest. Also you can access filesystems over FUSE."
130 #: ../src/guestfs.pod:44
132 "Libguestfs is a library that can be linked with C and C++ management "
133 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
134 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
139 #: ../src/guestfs.pod:49
141 "You don't need to be root to use libguestfs, although obviously you do need "
142 "enough permissions to access the disk images."
146 #: ../src/guestfs.pod:52
148 "Libguestfs is a large API because it can do many things. For a gentle "
149 "introduction, please read the L</API OVERVIEW> section next."
153 #: ../src/guestfs.pod:55
158 #: ../src/guestfs.pod:57
160 "This section provides a gentler overview of the libguestfs API. We also try "
161 "to group API calls together, where that may not be obvious from reading "
162 "about the individual calls in the main section of this manual."
166 #: ../src/guestfs.pod:62
171 #: ../src/guestfs.pod:64
173 "Before you can use libguestfs calls, you have to create a handle. Then you "
174 "must add at least one disk image to the handle, followed by launching the "
175 "handle, then performing whatever operations you want, and finally closing "
176 "the handle. By convention we use the single letter C<g> for the name of the "
177 "handle variable, although of course you can use any name you want."
181 #: ../src/guestfs.pod:71
182 msgid "The general structure of all libguestfs-using programs looks like this:"
186 #: ../src/guestfs.pod:74
189 " guestfs_h *g = guestfs_create ();\n"
194 #: ../src/guestfs.pod:76
197 " /* Call guestfs_add_drive additional times if there are\n"
198 " * multiple disk images.\n"
200 " guestfs_add_drive (g, \"guest.img\");\n"
205 #: ../src/guestfs.pod:81
208 " /* Most manipulation calls won't work until you've launched\n"
209 " * the handle 'g'. You have to do this _after_ adding drives\n"
210 " * and _before_ other commands.\n"
212 " guestfs_launch (g);\n"
217 #: ../src/guestfs.pod:87
220 " /* Now you can examine what partitions, LVs etc are available.\n"
222 " char **partitions = guestfs_list_partitions (g);\n"
223 " char **logvols = guestfs_lvs (g);\n"
228 #: ../src/guestfs.pod:92
231 " /* To access a filesystem in the image, you must mount it.\n"
233 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
238 #: ../src/guestfs.pod:96
241 " /* Now you can perform filesystem actions on the guest\n"
244 " guestfs_touch (g, \"/hello\");\n"
249 #: ../src/guestfs.pod:101
252 " /* You only need to call guestfs_sync if you have made\n"
253 " * changes to the guest image. (But if you've made changes\n"
254 " * then you *must* sync). See also: guestfs_umount and\n"
255 " * guestfs_umount_all calls.\n"
257 " guestfs_sync (g);\n"
262 #: ../src/guestfs.pod:108
265 " /* Close the handle 'g'. */\n"
266 " guestfs_close (g);\n"
271 #: ../src/guestfs.pod:111
273 "The code above doesn't include any error checking. In real code you should "
274 "check return values carefully for errors. In general all functions that "
275 "return integers return C<-1> on error, and all functions that return "
276 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
277 "how to handle errors, and consult the documentation for each function call "
278 "below to see precisely how they return error indications."
282 #: ../src/guestfs.pod:119
287 #: ../src/guestfs.pod:121
289 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
290 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
291 "actual block device, or simply an empty file of zeroes that you have created "
292 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
297 #: ../src/guestfs.pod:127
299 "You can add a disk read-only using L</guestfs_add_drive_ro>, in which case "
300 "libguestfs won't modify the file."
304 #: ../src/guestfs.pod:130
306 "Be extremely cautious if the disk image is in use, eg. if it is being used "
307 "by a virtual machine. Adding it read-write will almost certainly cause disk "
308 "corruption, but adding it read-only is safe."
312 #: ../src/guestfs.pod:134
314 "You must add at least one disk image, and you may add multiple disk images. "
315 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
316 "first one you added), C</dev/sdb> (for the second one you added), etc."
320 #: ../src/guestfs.pod:139
322 "Once L</guestfs_launch> has been called you cannot add any more images. You "
323 "can call L</guestfs_list_devices> to get a list of the device names, in the "
324 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
328 #: ../src/guestfs.pod:144
333 #: ../src/guestfs.pod:146
335 "Before you can read or write files, create directories and so on in a disk "
336 "image that contains filesystems, you have to mount those filesystems using "
337 "L</guestfs_mount>. If you already know that a disk image contains (for "
338 "example) one partition with a filesystem on that partition, then you can "
343 #: ../src/guestfs.pod:152
346 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
351 #: ../src/guestfs.pod:154
353 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
354 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
355 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>)."
359 #: ../src/guestfs.pod:158
361 "If you are given a disk image and you don't know what it contains then you "
362 "have to find out. Libguestfs can do that too: use L</"
363 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
364 "LVs, and either try mounting each to see what is mountable, or else examine "
365 "them with L</guestfs_vfs_type> or L</guestfs_file>. Libguestfs also has a "
366 "set of APIs for inspection of disk images (see L</INSPECTION> below). But "
367 "you might find it easier to look at higher level programs built on top of "
368 "libguestfs, in particular L<virt-inspector(1)>."
372 #: ../src/guestfs.pod:168
374 "To mount a disk image read-only, use L</guestfs_mount_ro>. There are "
375 "several other variations of the C<guestfs_mount_*> call."
379 #: ../src/guestfs.pod:171
380 msgid "FILESYSTEM ACCESS AND MODIFICATION"
384 #: ../src/guestfs.pod:173
386 "The majority of the libguestfs API consists of fairly low-level calls for "
387 "accessing and modifying the files, directories, symlinks etc on mounted "
388 "filesystems. There are over a hundred such calls which you can find listed "
389 "in detail below in this man page, and we don't even pretend to cover them "
390 "all in this overview."
394 #: ../src/guestfs.pod:179
396 "Specify filenames as full paths, starting with C<\"/\"> and including the "
401 #: ../src/guestfs.pod:182
403 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
404 "the file called C<\"etc/passwd\"> then you could do:"
408 #: ../src/guestfs.pod:185
411 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
416 #: ../src/guestfs.pod:187
418 "This would return C<data> as a newly allocated buffer containing the full "
419 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
420 "or C<NULL> if there was an error."
424 #: ../src/guestfs.pod:191
426 "As another example, to create a top-level directory on that filesystem "
427 "called C<\"var\"> you would do:"
431 #: ../src/guestfs.pod:194
434 " guestfs_mkdir (g, \"/var\");\n"
439 #: ../src/guestfs.pod:196
440 msgid "To create a symlink you could do:"
444 #: ../src/guestfs.pod:198
447 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
448 " \"/etc/rc3.d/S30portmap\");\n"
453 #: ../src/guestfs.pod:201
455 "Libguestfs will reject attempts to use relative paths and there is no "
456 "concept of a current working directory."
460 #: ../src/guestfs.pod:204
462 "Libguestfs can return errors in many situations: for example if the "
463 "filesystem isn't writable, or if a file or directory that you requested "
464 "doesn't exist. If you are using the C API (documented here) you have to "
465 "check for those error conditions after each call. (Other language bindings "
466 "turn these errors into exceptions)."
470 #: ../src/guestfs.pod:210
472 "File writes are affected by the per-handle umask, set by calling L</"
473 "guestfs_umask> and defaulting to 022. See L</UMASK>."
477 #: ../src/guestfs.pod:213
482 #: ../src/guestfs.pod:215
484 "Libguestfs contains API calls to read, create and modify partition tables on "
489 #: ../src/guestfs.pod:218
491 "In the common case where you want to create a single partition covering the "
492 "whole disk, you should use the L</guestfs_part_disk> call:"
496 #: ../src/guestfs.pod:222
499 " const char *parttype = \"mbr\";\n"
500 " if (disk_is_larger_than_2TB)\n"
501 " parttype = \"gpt\";\n"
502 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
507 #: ../src/guestfs.pod:227
509 "Obviously this effectively wipes anything that was on that disk image before."
513 #: ../src/guestfs.pod:230
518 #: ../src/guestfs.pod:232
520 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
521 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
522 "you familiarize yourself with the concepts of physical volumes, volume "
523 "groups and logical volumes."
527 #: ../src/guestfs.pod:237
529 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
530 "tldp.org/HOWTO/LVM-HOWTO/>."
534 #: ../src/guestfs.pod:240
539 #: ../src/guestfs.pod:242
541 "Use L</guestfs_cat> to download small, text only files. This call is "
542 "limited to files which are less than 2 MB and which cannot contain any ASCII "
543 "NUL (C<\\0>) characters. However it has a very simple to use API."
547 #: ../src/guestfs.pod:247
549 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
550 "bit data, since it returns a (pointer, size) pair. However it is still "
551 "limited to \"small\" files, less than 2 MB."
555 #: ../src/guestfs.pod:251
557 "L</guestfs_download> can be used to download any file, with no limits on "
558 "content or size (even files larger than 4 GB)."
562 #: ../src/guestfs.pod:254
564 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
568 #: ../src/guestfs.pod:257
573 #: ../src/guestfs.pod:259
575 "It's often the case that you want to write a file or files to the disk image."
579 #: ../src/guestfs.pod:262
581 "To write a small file with fixed content, use L</guestfs_write>. To create "
582 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
583 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
584 "of other functions for creating test files, for example L</guestfs_fill> and "
585 "L</guestfs_fill_pattern>."
589 #: ../src/guestfs.pod:268
591 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
592 "file content or size (even files larger than 4 GB)."
596 #: ../src/guestfs.pod:271
598 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
602 #: ../src/guestfs.pod:273
604 "However the fastest way to upload I<large numbers of arbitrary files> is to "
605 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
606 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
607 "in a predictable way (eg. adding it last after all other drives) then you "
608 "can get the device name from L</guestfs_list_devices> and mount it directly "
609 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
610 "portable between kernel versions, and they don't support labels or UUIDs. "
611 "If you want to pre-build an image or you need to mount it using a label or "
612 "UUID, use an ISO image instead."
616 #: ../src/guestfs.pod:284
621 #: ../src/guestfs.pod:286
623 "There are various different commands for copying between files and devices "
624 "and in and out of the guest filesystem. These are summarised in the table "
629 #: ../src/guestfs.pod:292
630 msgid "B<file> to B<file>"
634 #: ../src/guestfs.pod:294
636 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
637 "directories recursively."
641 #: ../src/guestfs.pod:297
642 msgid "B<file or device> to B<file or device>"
646 #: ../src/guestfs.pod:299
648 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
649 "devices in the guest."
653 #: ../src/guestfs.pod:302
654 msgid "Example: duplicate the contents of an LV:"
658 #: ../src/guestfs.pod:304
661 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
666 #: ../src/guestfs.pod:306
668 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
669 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
670 "guestfs_copy_size>."
674 #: ../src/guestfs.pod:310
675 msgid "B<file on the host> to B<file or device>"
679 #: ../src/guestfs.pod:312
680 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
684 #: ../src/guestfs.pod:314
685 msgid "B<file or device> to B<file on the host>"
689 #: ../src/guestfs.pod:316
690 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
694 #: ../src/guestfs.pod:320
695 msgid "LISTING FILES"
699 #: ../src/guestfs.pod:322
701 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
702 "L<guestfish(1)>-equivalent command C<ll>)."
706 #: ../src/guestfs.pod:325
708 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
709 "programs, as a flat list of strings."
713 #: ../src/guestfs.pod:328
715 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
716 "directory, plus additional information about each one. It is more "
717 "equivalent to using the L<readdir(3)> call on a local filesystem."
721 #: ../src/guestfs.pod:332
723 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
727 #: ../src/guestfs.pod:335
728 msgid "RUNNING COMMANDS"
732 #: ../src/guestfs.pod:337
734 "Although libguestfs is primarily an API for manipulating files inside guest "
735 "images, we also provide some limited facilities for running commands inside "
740 #: ../src/guestfs.pod:341
741 msgid "There are many limitations to this:"
745 #: ../src/guestfs.pod:345 ../src/guestfs.pod:350 ../src/guestfs.pod:355
746 #: ../src/guestfs.pod:359 ../src/guestfs.pod:364 ../src/guestfs.pod:368
747 #: ../src/guestfs.pod:373 ../src/guestfs.pod:1254 ../src/guestfs.pod:1259
748 #: ../src/guestfs.pod:1263 ../src/guestfs.pod:1365 ../src/guestfs.pod:1369
749 #: ../src/guestfs.pod:1373 ../src/guestfs.pod:1378 ../src/guestfs.pod:1386
750 #: ../src/guestfs.pod:1405 ../src/guestfs.pod:1413 ../src/guestfs.pod:1643
751 #: ../src/guestfs.pod:1649 ../src/guestfs.pod:1654 ../src/guestfs.pod:1660
752 #: ../src/guestfs.pod:1767 ../src/guestfs.pod:1771 ../src/guestfs.pod:1775
753 #: ../src/guestfs.pod:1779 ../src/guestfs-actions.pod:14
754 #: ../src/guestfs-actions.pod:21 ../src/guestfs-actions.pod:372
755 #: ../src/guestfs-actions.pod:380 ../src/guestfs-actions.pod:387
756 #: ../src/guestfs-actions.pod:394 ../src/guestfs-actions.pod:1285
757 #: ../src/guestfs-actions.pod:1289 ../src/guestfs-actions.pod:1293
758 #: ../src/guestfs-actions.pod:1297 ../src/guestfs-actions.pod:1305
759 #: ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:1313
760 #: ../src/guestfs-actions.pod:1323 ../src/guestfs-actions.pod:1327
761 #: ../src/guestfs-actions.pod:1331 ../src/guestfs-actions.pod:1454
762 #: ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1463
763 #: ../src/guestfs-actions.pod:1468 ../src/guestfs-actions.pod:1520
764 #: ../src/guestfs-actions.pod:1524 ../src/guestfs-actions.pod:1529
765 #: ../fish/guestfish.pod:338 ../fish/guestfish.pod:342
766 #: ../fish/guestfish.pod:346 ../fish/guestfish.pod:350
767 #: ../fish/guestfish-actions.pod:15 ../fish/guestfish-actions.pod:22
768 #: ../fish/guestfish-actions.pod:306 ../fish/guestfish-actions.pod:314
769 #: ../fish/guestfish-actions.pod:321 ../fish/guestfish-actions.pod:328
770 #: ../fish/guestfish-actions.pod:1023 ../fish/guestfish-actions.pod:1027
771 #: ../fish/guestfish-actions.pod:1031 ../fish/guestfish-actions.pod:1035
772 #: ../fish/guestfish-actions.pod:1043 ../fish/guestfish-actions.pod:1047
773 #: ../fish/guestfish-actions.pod:1051 ../fish/guestfish-actions.pod:1061
774 #: ../fish/guestfish-actions.pod:1065 ../fish/guestfish-actions.pod:1069
775 #: ../fish/guestfish-actions.pod:1159 ../fish/guestfish-actions.pod:1163
776 #: ../fish/guestfish-actions.pod:1168 ../fish/guestfish-actions.pod:1173
777 #: ../fish/guestfish-actions.pod:1215 ../fish/guestfish-actions.pod:1219
778 #: ../fish/guestfish-actions.pod:1224 ../tools/virt-df.pl:144
779 #: ../tools/virt-df.pl:150 ../tools/virt-resize.pl:324
780 #: ../tools/virt-resize.pl:329 ../tools/virt-resize.pl:339
785 #: ../src/guestfs.pod:347
787 "The kernel version that the command runs under will be different from what "
792 #: ../src/guestfs.pod:352
794 "If the command needs to communicate with daemons, then most likely they "
799 #: ../src/guestfs.pod:357
800 msgid "The command will be running in limited memory."
804 #: ../src/guestfs.pod:361
806 "The network may not be available unless you enable it (see L</"
807 "guestfs_set_network>)."
811 #: ../src/guestfs.pod:366
812 msgid "Only supports Linux guests (not Windows, BSD, etc)."
816 #: ../src/guestfs.pod:370
818 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
822 #: ../src/guestfs.pod:375
824 "For SELinux guests, you may need to enable SELinux and load policy first. "
825 "See L</SELINUX> in this manpage."
829 #: ../src/guestfs.pod:380
831 "The two main API calls to run commands are L</guestfs_command> and L</"
832 "guestfs_sh> (there are also variations)."
836 #: ../src/guestfs.pod:383
838 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
839 "shell globs, redirections, etc will work."
843 #: ../src/guestfs.pod:386
844 msgid "CONFIGURATION FILES"
848 #: ../src/guestfs.pod:388
850 "To read and write configuration files in Linux guest filesystems, we "
851 "strongly recommend using Augeas. For example, Augeas understands how to "
852 "read and write, say, a Linux shadow password file or X.org configuration "
853 "file, and so avoids you having to write that code."
857 #: ../src/guestfs.pod:393
859 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
860 "document Augeas itself here because there is excellent documentation on the "
861 "L<http://augeas.net/> website."
865 #: ../src/guestfs.pod:397
867 "If you don't want to use Augeas (you fool!) then try calling L</"
868 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
873 #: ../src/guestfs.pod:401
878 #: ../src/guestfs.pod:403
880 "We support SELinux guests. To ensure that labeling happens correctly in "
881 "SELinux guests, you need to enable SELinux and load the guest's policy:"
885 #: ../src/guestfs.pod:409
890 #: ../src/guestfs.pod:411
891 msgid "Before launching, do:"
895 #: ../src/guestfs.pod:413
898 " guestfs_set_selinux (g, 1);\n"
903 #: ../src/guestfs.pod:415
908 #: ../src/guestfs.pod:417
910 "After mounting the guest's filesystem(s), load the policy. This is best "
911 "done by running the L<load_policy(8)> command in the guest itself:"
915 #: ../src/guestfs.pod:421
918 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
923 #: ../src/guestfs.pod:423
925 "(Older versions of C<load_policy> require you to specify the name of the "
930 #: ../src/guestfs.pod:426
935 #: ../src/guestfs.pod:428
937 "Optionally, set the security context for the API. The correct security "
938 "context to use can only be known by inspecting the guest. As an example:"
942 #: ../src/guestfs.pod:432
945 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
950 #: ../src/guestfs.pod:436
951 msgid "This will work for running commands and editing existing files."
955 #: ../src/guestfs.pod:438
957 "When new files are created, you may need to label them explicitly, for "
958 "example by running the external command C<restorecon pathname>."
962 #: ../src/guestfs.pod:442
967 #: ../src/guestfs.pod:444
969 "Certain calls are affected by the current file mode creation mask (the "
970 "\"umask\"). In particular ones which create files or directories, such as "
971 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
972 "either the default mode that the file is created with or modifies the mode "
977 #: ../src/guestfs.pod:450
979 "The default umask is C<022>, so files are created with modes such as C<0644> "
980 "and directories with C<0755>."
984 #: ../src/guestfs.pod:453
986 "There are two ways to avoid being affected by umask. Either set umask to 0 "
987 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
988 "guestfs_chmod> after creating each file or directory."
992 #: ../src/guestfs.pod:457
993 msgid "For more information about umask, see L<umask(2)>."
997 #: ../src/guestfs.pod:459 ../fish/guestfish.pod:589
998 msgid "ENCRYPTED DISKS"
1002 #: ../src/guestfs.pod:461
1004 "Libguestfs allows you to access Linux guests which have been encrypted using "
1005 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1006 "standard. This includes nearly all whole disk encryption systems used by "
1007 "modern Linux guests."
1011 #: ../src/guestfs.pod:467
1013 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1014 "returns the string C<crypto_LUKS>)."
1018 #: ../src/guestfs.pod:470
1020 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1021 "will require the passphrase!"
1025 #: ../src/guestfs.pod:473
1027 "Opening a LUKS device creates a new device mapper device called C</dev/"
1028 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1029 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1030 "from and encrypted to the underlying block device respectively."
1034 #: ../src/guestfs.pod:479
1036 "LVM volume groups on the device can be made visible by calling L</"
1037 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1038 "(s) can now be mounted in the usual way."
1042 #: ../src/guestfs.pod:483
1044 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1045 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1046 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1047 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1048 "underlying encrypted block device)."
1052 #: ../src/guestfs.pod:490
1057 #: ../src/guestfs.pod:492
1059 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1060 "contains operating systems. (These APIs used to be in a separate Perl-only "
1061 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1062 "frequently used part of this library has been rewritten in C and moved into "
1067 #: ../src/guestfs.pod:498
1069 "Add all disks belonging to the unknown virtual machine and call L</"
1070 "guestfs_launch> in the usual way."
1074 #: ../src/guestfs.pod:501
1076 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1077 "and certain heuristics, and returns a list of operating systems that were "
1078 "found. An empty list means none were found. A single element is the root "
1079 "filesystem of the operating system. For dual- or multi-boot guests, "
1080 "multiple roots can be returned, each one corresponding to a separate "
1081 "operating system. (Multi-boot virtual machines are extremely rare in the "
1082 "world of virtualization, but since this scenario can happen, we have built "
1083 "libguestfs to deal with it.)"
1087 #: ../src/guestfs.pod:510
1089 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1090 "to get additional details about that operating system. For example, call L</"
1091 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1092 "Windows and Linux-based operating systems respectively."
1096 #: ../src/guestfs.pod:516
1098 "Un*x-like and Linux-based operating systems usually consist of several "
1099 "filesystems which are mounted at boot time (for example, a separate boot "
1100 "partition mounted on C</boot>). The inspection rules are able to detect how "
1101 "filesystems correspond to mount points. Call "
1102 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1103 "hash table like this example:"
1107 #: ../src/guestfs.pod:523
1110 " /boot => /dev/sda1\n"
1111 " / => /dev/vg_guest/lv_root\n"
1112 " /usr => /dev/vg_guest/lv_usr\n"
1117 #: ../src/guestfs.pod:527
1119 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1120 "filesystems as suggested."
1124 #: ../src/guestfs.pod:530
1126 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1127 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1131 #: ../src/guestfs.pod:534
1133 "Inspection currently only works for some common operating systems. "
1134 "Contributors are welcome to send patches for other operating systems that we "
1135 "currently cannot detect."
1139 #: ../src/guestfs.pod:538
1141 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1142 "for more details. The L</guestfs_inspect_os> function just ignores any "
1143 "encrypted devices."
1147 #: ../src/guestfs.pod:542
1149 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1150 "inspection and caches the results in the guest handle. Subsequent calls to "
1151 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1152 "read the disks. If you change the content of the guest disks, you can redo "
1153 "inspection by calling L</guestfs_inspect_os> again."
1157 #: ../src/guestfs.pod:549
1158 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1162 #: ../src/guestfs.pod:551
1164 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1165 "ntfs-3g.org/> driver."
1169 #: ../src/guestfs.pod:554
1171 "DOS and Windows still use drive letters, and the filesystems are always "
1172 "treated as case insensitive by Windows itself, and therefore you might find "
1173 "a Windows configuration file referring to a path like C<c:\\windows"
1174 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1175 "might be referred to as C</WINDOWS/System32>."
1179 #: ../src/guestfs.pod:560
1181 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1182 "libguestfs to read the appropriate Windows Registry and configuration files, "
1183 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1188 #: ../src/guestfs.pod:565
1190 "Replacing backslash characters with forward slash characters is also outside "
1191 "the scope of libguestfs, but something that you can easily do."
1195 #: ../src/guestfs.pod:568
1197 "Where we can help is in resolving the case insensitivity of paths. For "
1198 "this, call L</guestfs_case_sensitive_path>."
1202 #: ../src/guestfs.pod:571
1204 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1205 "files, through the library C<hivex> which is part of the libguestfs project "
1206 "although ships as a separate tarball. You have to locate and download the "
1207 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1208 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1209 "reg(1)> for more help on this issue."
1213 #: ../src/guestfs.pod:579
1214 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1218 #: ../src/guestfs.pod:581
1220 "Although we don't want to discourage you from using the C API, we will "
1221 "mention here that the same API is also available in other languages."
1225 #: ../src/guestfs.pod:584
1227 "The API is broadly identical in all supported languages. This means that "
1228 "the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, C<g."
1229 "mount(path)> in Python, and C<Guestfs.mount g path> in OCaml. In other "
1230 "words, a straightforward, predictable isomorphism between each language."
1234 #: ../src/guestfs.pod:590
1236 "Error messages are automatically transformed into exceptions if the language "
1241 #: ../src/guestfs.pod:593
1243 "We don't try to \"object orientify\" parts of the API in OO languages, "
1244 "although contributors are welcome to write higher level APIs above what we "
1245 "provide in their favourite languages if they wish."
1249 #: ../src/guestfs.pod:599
1254 #: ../src/guestfs.pod:601
1256 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1257 "identical to the C API. C++ classes and exceptions are not used."
1261 #: ../src/guestfs.pod:605
1266 #: ../src/guestfs.pod:607
1268 "The C# bindings are highly experimental. Please read the warnings at the "
1269 "top of C<csharp/Libguestfs.cs>."
1273 #: ../src/guestfs.pod:610
1278 #: ../src/guestfs.pod:612
1280 "This is the only language binding that is working but incomplete. Only "
1281 "calls which return simple integers have been bound in Haskell, and we are "
1282 "looking for help to complete this binding."
1286 #: ../src/guestfs.pod:616
1291 #: ../src/guestfs.pod:618
1293 "Full documentation is contained in the Javadoc which is distributed with "
1298 #: ../src/guestfs.pod:621
1303 #: ../src/guestfs.pod:623
1304 msgid "For documentation see the file C<guestfs.mli>."
1308 #: ../src/guestfs.pod:625
1313 #: ../src/guestfs.pod:627
1314 msgid "For documentation see L<Sys::Guestfs(3)>."
1318 #: ../src/guestfs.pod:629
1323 #: ../src/guestfs.pod:631
1325 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1326 "the php-libguestfs package for your distribution."
1330 #: ../src/guestfs.pod:634
1331 msgid "The PHP binding only works correctly on 64 bit machines."
1335 #: ../src/guestfs.pod:636
1340 #: ../src/guestfs.pod:638
1341 msgid "For documentation do:"
1345 #: ../src/guestfs.pod:640
1349 " >>> import guestfs\n"
1350 " >>> help (guestfs)\n"
1355 #: ../src/guestfs.pod:644
1360 #: ../src/guestfs.pod:646
1362 "Use the Guestfs module. There is no Ruby-specific documentation, but you "
1363 "can find examples written in Ruby in the libguestfs source."
1367 #: ../src/guestfs.pod:649
1368 msgid "B<shell scripts>"
1372 #: ../src/guestfs.pod:651
1373 msgid "For documentation see L<guestfish(1)>."
1377 #: ../src/guestfs.pod:655
1378 msgid "LIBGUESTFS GOTCHAS"
1382 #: ../src/guestfs.pod:657
1384 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1385 "system [...] that works in the way it is documented but is counterintuitive "
1386 "and almost invites mistakes.\""
1390 #: ../src/guestfs.pod:661
1392 "Since we developed libguestfs and the associated tools, there are several "
1393 "things we would have designed differently, but are now stuck with for "
1394 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1395 "release, you can expect these to change. Beware of them."
1399 #: ../src/guestfs.pod:669
1400 msgid "Autosync / forgetting to sync."
1404 #: ../src/guestfs.pod:671
1406 "When modifying a filesystem from C or another language, you B<must> unmount "
1407 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1408 "libguestfs handle. You can also call:"
1412 #: ../src/guestfs.pod:675
1415 " guestfs_set_autosync (g, 1);\n"
1420 #: ../src/guestfs.pod:677
1422 "to have the unmount/sync done automatically for you when the handle 'g' is "
1423 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1427 #: ../src/guestfs.pod:681
1429 "If you forget to do this, then it is entirely possible that your changes "
1430 "won't be written out, or will be partially written, or (very rarely) that "
1431 "you'll get disk corruption."
1435 #: ../src/guestfs.pod:685
1437 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1438 "guestfish scripts that forget to sync will work just fine, which can make "
1439 "this very puzzling if you are trying to debug a problem."
1443 #: ../src/guestfs.pod:689
1444 msgid "Mount option C<-o sync> should not be the default."
1448 #: ../src/guestfs.pod:691
1450 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1451 "However C<-o sync> does not add any reliability benefit, but does have a "
1452 "very large performance impact."
1456 #: ../src/guestfs.pod:695
1458 "The work around is to use L</guestfs_mount_options> and set the mount "
1459 "options that you actually want to use."
1463 #: ../src/guestfs.pod:698
1464 msgid "Read-only should be the default."
1468 #: ../src/guestfs.pod:700
1470 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1471 "specify I<--rw> if you want to make changes to the image."
1475 #: ../src/guestfs.pod:703
1476 msgid "This would reduce the potential to corrupt live VM images."
1480 #: ../src/guestfs.pod:705
1482 "Note that many filesystems change the disk when you just mount and unmount, "
1483 "even if you didn't perform any writes. You need to use L</"
1484 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1488 #: ../src/guestfs.pod:709
1489 msgid "guestfish command line is hard to use."
1493 #: ../src/guestfs.pod:711
1495 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1496 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1497 "exist, so it fails. In earlier versions of guestfish the error message was "
1498 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1499 "we should have used C<guestfish -c command> to run commands."
1503 #: ../src/guestfs.pod:718
1504 msgid "guestfish megabyte modifiers don't work right on all commands"
1508 #: ../src/guestfs.pod:720
1510 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1511 "other modifiers). What guestfish actually does is to multiply the number "
1512 "part by the modifier part and pass the result to the C API. However this "
1513 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1514 "expecting some other unit (eg. megabytes)."
1518 #: ../src/guestfs.pod:727
1519 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1523 #: ../src/guestfs.pod:729
1526 " lvcreate LV VG 100M\n"
1531 #: ../src/guestfs.pod:731
1533 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1534 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1535 "megabytes * megabytes) logical volume. The error message you get from this "
1536 "is also a little obscure."
1540 #: ../src/guestfs.pod:736
1542 "This could be fixed in the generator by specially marking parameters and "
1543 "return values which take bytes or other units."
1547 #: ../src/guestfs.pod:739
1548 msgid "Library should return errno with error messages."
1552 #: ../src/guestfs.pod:741
1554 "It would be a nice-to-have to be able to get the original value of 'errno' "
1555 "from inside the appliance along error paths (where set). Currently "
1556 "L<guestmount(1)> goes through hoops to try to reverse the error message "
1557 "string into an errno, see the function error() in fuse/guestmount.c."
1561 #: ../src/guestfs.pod:747
1563 "In libguestfs 1.5.4, the protocol was changed so that the Linux errno is "
1564 "sent back from the daemon."
1568 #: ../src/guestfs.pod:750
1569 msgid "Ambiguity between devices and paths"
1573 #: ../src/guestfs.pod:752
1575 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1576 "sdb2>) and a similar pathname. A file might just happen to be called "
1577 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1581 #: ../src/guestfs.pod:757
1583 "In the current API we usually resolve this ambiguity by having two separate "
1584 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1585 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1586 "detecting if the path supplied begins with C</dev/>."
1590 #: ../src/guestfs.pod:763
1592 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1593 "make paths/devices into structured names. One way to do this would be to "
1594 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1595 "aspect of grub. Another way would be to use a structured type, equivalent "
1596 "to this OCaml type:"
1600 #: ../src/guestfs.pod:769
1603 " type path = Path of string | Device of int | Partition of int * int\n"
1608 #: ../src/guestfs.pod:771
1609 msgid "which would allow you to pass arguments like:"
1613 #: ../src/guestfs.pod:773
1616 " Path \"/foo/bar\"\n"
1617 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1618 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1619 " Path \"/dev/sdb2\" (* not a device *)\n"
1624 #: ../src/guestfs.pod:778
1626 "As you can see there are still problems to resolve even with this "
1627 "representation. Also consider how it might work in guestfish."
1631 #: ../src/guestfs.pod:783
1632 msgid "PROTOCOL LIMITS"
1636 #: ../src/guestfs.pod:785
1638 "Internally libguestfs uses a message-based protocol to pass API calls and "
1639 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1640 "plenty more detail about this). The maximum message size used by the "
1641 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1642 "aware of this limit. The API calls which may be affected are individually "
1643 "documented, with a link back to this section of the documentation."
1647 #: ../src/guestfs.pod:793
1649 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1650 "a simple string. Because this string is at some point internally encoded as "
1651 "a message, the maximum size that it can return is slightly under 4 MB. If "
1652 "the requested file is larger than this then you will get an error."
1656 #: ../src/guestfs.pod:799
1658 "In order to transfer large files into and out of the guest filesystem, you "
1659 "need to use particular calls that support this. The sections L</UPLOADING> "
1660 "and L</DOWNLOADING> document how to do this."
1664 #: ../src/guestfs.pod:803
1666 "You might also consider mounting the disk image using our FUSE filesystem "
1667 "support (L<guestmount(1)>)."
1671 #: ../src/guestfs.pod:806
1672 msgid "KEYS AND PASSPHRASES"
1676 #: ../src/guestfs.pod:808
1678 "Certain libguestfs calls take a parameter that contains sensitive key "
1679 "material, passed in as a C string."
1683 #: ../src/guestfs.pod:811
1685 "In the future we would hope to change the libguestfs implementation so that "
1686 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1687 "swap. However this is I<not> done at the moment, because of the complexity "
1688 "of such an implementation."
1692 #: ../src/guestfs.pod:816
1694 "Therefore you should be aware that any key parameter you pass to libguestfs "
1695 "might end up being written out to the swap partition. If this is a concern, "
1696 "scrub the swap partition or don't use libguestfs on encrypted devices."
1700 #: ../src/guestfs.pod:821
1701 msgid "CONNECTION MANAGEMENT"
1705 #: ../src/guestfs.pod:823
1710 #: ../src/guestfs.pod:825
1712 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
1713 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
1714 "handle and release all resources used."
1718 #: ../src/guestfs.pod:829
1720 "For information on using multiple handles and threads, see the section L</"
1721 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
1725 #: ../src/guestfs.pod:832
1726 msgid "guestfs_create"
1730 #: ../src/guestfs.pod:834
1733 " guestfs_h *guestfs_create (void);\n"
1738 #: ../src/guestfs.pod:836
1739 msgid "Create a connection handle."
1743 #: ../src/guestfs.pod:838
1744 msgid "You have to call L</guestfs_add_drive> on the handle at least once."
1748 #: ../src/guestfs.pod:840
1750 "This function returns a non-NULL pointer to a handle on success or NULL on "
1755 #: ../src/guestfs.pod:843
1756 msgid "After configuring the handle, you have to call L</guestfs_launch>."
1760 #: ../src/guestfs.pod:845
1762 "You may also want to configure error handling for the handle. See L</ERROR "
1763 "HANDLING> section below."
1767 #: ../src/guestfs.pod:848
1768 msgid "guestfs_close"
1772 #: ../src/guestfs.pod:850
1775 " void guestfs_close (guestfs_h *g);\n"
1780 #: ../src/guestfs.pod:852
1781 msgid "This closes the connection handle and frees up all resources used."
1785 #: ../src/guestfs.pod:854
1786 msgid "ERROR HANDLING"
1790 #: ../src/guestfs.pod:856
1792 "The convention in all functions that return C<int> is that they return C<-1> "
1793 "to indicate an error. You can get additional information on errors by "
1794 "calling L</guestfs_last_error> and/or by setting up an error handler with L</"
1795 "guestfs_set_error_handler>."
1799 #: ../src/guestfs.pod:861
1800 msgid "The default error handler prints the information string to C<stderr>."
1804 #: ../src/guestfs.pod:863
1806 "Out of memory errors are handled differently. The default action is to call "
1807 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
1808 "guestfs_set_out_of_memory_handler>."
1812 #: ../src/guestfs.pod:867
1813 msgid "guestfs_last_error"
1817 #: ../src/guestfs.pod:869
1820 " const char *guestfs_last_error (guestfs_h *g);\n"
1825 #: ../src/guestfs.pod:871
1827 "This returns the last error message that happened on C<g>. If there has not "
1828 "been an error since the handle was created, then this returns C<NULL>."
1832 #: ../src/guestfs.pod:875
1834 "The lifetime of the returned string is until the next error occurs, or L</"
1835 "guestfs_close> is called."
1839 #: ../src/guestfs.pod:878
1841 "The error string is not localized (ie. is always in English), because this "
1842 "makes searching for error messages in search engines give the largest number "
1847 #: ../src/guestfs.pod:882
1848 msgid "guestfs_set_error_handler"
1852 #: ../src/guestfs.pod:884
1855 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
1857 " const char *msg);\n"
1858 " void guestfs_set_error_handler (guestfs_h *g,\n"
1859 " guestfs_error_handler_cb cb,\n"
1865 #: ../src/guestfs.pod:891
1867 "The callback C<cb> will be called if there is an error. The parameters "
1868 "passed to the callback are an opaque data pointer and the error message "
1873 #: ../src/guestfs.pod:895
1875 "Note that the message string C<msg> is freed as soon as the callback "
1876 "function returns, so if you want to stash it somewhere you must make your "
1881 #: ../src/guestfs.pod:899
1882 msgid "The default handler prints messages on C<stderr>."
1886 #: ../src/guestfs.pod:901
1887 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
1891 #: ../src/guestfs.pod:903
1892 msgid "guestfs_get_error_handler"
1896 #: ../src/guestfs.pod:905
1899 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
1900 " void **opaque_rtn);\n"
1905 #: ../src/guestfs.pod:908
1906 msgid "Returns the current error handler callback."
1910 #: ../src/guestfs.pod:910
1911 msgid "guestfs_set_out_of_memory_handler"
1915 #: ../src/guestfs.pod:912
1918 " typedef void (*guestfs_abort_cb) (void);\n"
1919 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
1920 " guestfs_abort_cb);\n"
1925 #: ../src/guestfs.pod:916
1927 "The callback C<cb> will be called if there is an out of memory situation. "
1928 "I<Note this callback must not return>."
1932 #: ../src/guestfs.pod:919
1933 msgid "The default is to call L<abort(3)>."
1937 #: ../src/guestfs.pod:921
1939 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
1943 #: ../src/guestfs.pod:924
1944 msgid "guestfs_get_out_of_memory_handler"
1948 #: ../src/guestfs.pod:926
1951 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
1956 #: ../src/guestfs.pod:928
1957 msgid "This returns the current out of memory handler."
1961 #: ../src/guestfs.pod:930
1966 #: ../src/guestfs.pod:932
1968 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
1973 #: ../src/guestfs.pod:935
1975 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1976 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1980 #: ../src/guestfs.pod:938
1982 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1983 "to change the directories that libguestfs will search in. The value is a "
1984 "colon-separated list of paths. The current directory is I<not> searched "
1985 "unless the path contains an empty element or C<.>. For example "
1986 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1987 "then C</usr/lib/guestfs>."
1991 #: ../src/guestfs.pod:945
1992 msgid "HIGH-LEVEL API ACTIONS"
1996 #: ../src/guestfs.pod:947
1997 msgid "ABI GUARANTEE"
2001 #: ../src/guestfs.pod:949
2003 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2004 "actions as outlined in this section. Although we will deprecate some "
2005 "actions, for example if they get replaced by newer calls, we will keep the "
2006 "old actions forever. This allows you the developer to program in confidence "
2007 "against the libguestfs API."
2011 #: ../src/guestfs.pod:955 ../fish/guestfish.pod:819
2016 #: ../src/guestfs.pod:957
2021 #: ../src/guestfs.pod:959
2026 #: ../src/guestfs.pod:961
2027 msgid "AVAILABILITY"
2031 #: ../src/guestfs.pod:963
2032 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2036 #: ../src/guestfs.pod:965
2038 "Using L</guestfs_available> you can test availability of the following "
2039 "groups of functions. This test queries the appliance to see if the "
2040 "appliance you are currently using supports the functionality."
2044 #: ../src/guestfs.pod:970
2045 msgid "@AVAILABILITY@"
2049 #: ../src/guestfs.pod:972
2050 msgid "GUESTFISH supported COMMAND"
2054 #: ../src/guestfs.pod:974
2056 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2057 "prints out the available groups and whether they are supported by this build "
2058 "of libguestfs. Note however that you have to do C<run> first."
2062 #: ../src/guestfs.pod:979
2063 msgid "SINGLE CALLS AT COMPILE TIME"
2067 #: ../src/guestfs.pod:981
2069 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2070 "function, such as:"
2074 #: ../src/guestfs.pod:984
2077 " #define LIBGUESTFS_HAVE_DD 1\n"
2082 #: ../src/guestfs.pod:986
2083 msgid "if L</guestfs_dd> is available."
2087 #: ../src/guestfs.pod:988
2089 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2090 "function is available at compile time, we recommended using build tools such "
2091 "as autoconf or cmake. For example in autotools you could use:"
2095 #: ../src/guestfs.pod:993
2098 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2099 " AC_CHECK_FUNCS([guestfs_dd])\n"
2104 #: ../src/guestfs.pod:996
2106 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2111 #: ../src/guestfs.pod:999
2112 msgid "SINGLE CALLS AT RUN TIME"
2116 #: ../src/guestfs.pod:1001
2118 "Testing at compile time doesn't guarantee that a function really exists in "
2119 "the library. The reason is that you might be dynamically linked against a "
2120 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2121 "This situation unfortunately results in a segmentation fault, which is a "
2122 "shortcoming of the C dynamic linking system itself."
2126 #: ../src/guestfs.pod:1008
2128 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2129 "in this example program (note that you still need the compile time check as "
2134 #: ../src/guestfs.pod:1012
2137 " #include <stdio.h>\n"
2138 " #include <stdlib.h>\n"
2139 " #include <unistd.h>\n"
2140 " #include <dlfcn.h>\n"
2141 " #include <guestfs.h>\n"
2146 #: ../src/guestfs.pod:1018
2151 " #ifdef LIBGUESTFS_HAVE_DD\n"
2153 " int has_function;\n"
2158 #: ../src/guestfs.pod:1024
2161 " /* Test if the function guestfs_dd is really available. */\n"
2162 " dl = dlopen (NULL, RTLD_LAZY);\n"
2164 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2165 " exit (EXIT_FAILURE);\n"
2167 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2173 #: ../src/guestfs.pod:1033
2176 " if (!has_function)\n"
2177 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2179 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2180 " /* Now it's safe to call\n"
2181 " guestfs_dd (g, \"foo\", \"bar\");\n"
2185 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2192 #: ../src/guestfs.pod:1046
2194 "You may think the above is an awful lot of hassle, and it is. There are "
2195 "other ways outside of the C linking system to ensure that this kind of "
2196 "incompatibility never arises, such as using package versioning:"
2200 #: ../src/guestfs.pod:1051
2203 " Requires: libguestfs >= 1.0.80\n"
2208 #: ../src/guestfs.pod:1053 ../src/guestfs.pod:1058
2213 #: ../src/guestfs.pod:1055
2215 "<!-- old anchor for the next section --> <a name="
2216 "\"state_machine_and_low_level_event_api\"/>"
2220 #: ../src/guestfs.pod:1060
2221 msgid "ARCHITECTURE"
2225 #: ../src/guestfs.pod:1062
2227 "Internally, libguestfs is implemented by running an appliance (a special "
2228 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
2229 "process of the main program."
2233 #: ../src/guestfs.pod:1066
2236 " ___________________\n"
2238 " | main program |\n"
2240 " | | child process / appliance\n"
2241 " | | __________________________\n"
2243 " +-------------------+ RPC | +-----------------+ |\n"
2244 " | libguestfs <--------------------> guestfsd | |\n"
2245 " | | | +-----------------+ |\n"
2246 " \\___________________/ | | Linux kernel | |\n"
2247 " | +--^--------------+ |\n"
2248 " \\_________|________________/\n"
2254 " \\______________/\n"
2259 #: ../src/guestfs.pod:1086
2261 "The library, linked to the main program, creates the child process and hence "
2262 "the appliance in the L</guestfs_launch> function."
2266 #: ../src/guestfs.pod:1089
2268 "Inside the appliance is a Linux kernel and a complete stack of userspace "
2269 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
2270 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
2271 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
2272 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
2273 "attached to the qemu process which translates device access by the "
2274 "appliance's Linux kernel into accesses to the image."
2278 #: ../src/guestfs.pod:1098
2280 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
2281 "Although the disk image you are attached to might also be used by some "
2282 "virtual machine, libguestfs doesn't know or care about this. (But you will "
2283 "care if both libguestfs's qemu process and your virtual machine are trying "
2284 "to update the disk image at the same time, since these usually results in "
2285 "massive disk corruption)."
2289 #: ../src/guestfs.pod:1105
2290 msgid "STATE MACHINE"
2294 #: ../src/guestfs.pod:1107
2295 msgid "libguestfs uses a state machine to model the child process:"
2299 #: ../src/guestfs.pod:1109
2311 " / | \\ \\ guestfs_launch\n"
2312 " / | _\\__V______\n"
2314 " / | | LAUNCHING |\n"
2315 " / | \\___________/\n"
2317 " / | guestfs_launch\n"
2319 " ______ / __|____V\n"
2320 " / \\ ------> / \\\n"
2321 " | BUSY | | READY |\n"
2322 " \\______/ <------ \\________/\n"
2327 #: ../src/guestfs.pod:1131
2329 "The normal transitions are (1) CONFIG (when the handle is created, but there "
2330 "is no child process), (2) LAUNCHING (when the child process is booting up), "
2331 "(3) alternating between READY and BUSY as commands are issued to, and "
2332 "carried out by, the child process."
2336 #: ../src/guestfs.pod:1136
2338 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
2339 "asynchronously at any time (eg. due to some internal error), and that causes "
2340 "the state to transition back to CONFIG."
2344 #: ../src/guestfs.pod:1140
2346 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
2347 "issued when in the CONFIG state."
2351 #: ../src/guestfs.pod:1143
2353 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
2354 "L</guestfs_launch> blocks until the child process is READY to accept "
2355 "commands (or until some failure or timeout). L</guestfs_launch> internally "
2356 "moves the state from CONFIG to LAUNCHING while it is running."
2360 #: ../src/guestfs.pod:1149
2362 "API actions such as L</guestfs_mount> can only be issued when in the READY "
2363 "state. These API calls block waiting for the command to be carried out (ie. "
2364 "the state to transition to BUSY and then back to READY). There are no non-"
2365 "blocking versions, and no way to issue more than one command per handle at "
2370 #: ../src/guestfs.pod:1155
2372 "Finally, the child process sends asynchronous messages back to the main "
2373 "program, such as kernel log messages. You can register a callback to "
2374 "receive these messages."
2378 #: ../src/guestfs.pod:1159
2379 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
2383 #: ../src/guestfs.pod:1161
2385 "The child process generates events in some situations. Current events "
2386 "include: receiving a log message, the child process exits."
2390 #: ../src/guestfs.pod:1164
2392 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
2397 #: ../src/guestfs.pod:1167
2399 "Only I<one callback of each type> can be registered for each handle. "
2400 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
2401 "that type. Cancel all callbacks of this type by calling this function with "
2402 "C<cb> set to C<NULL>."
2406 #: ../src/guestfs.pod:1172
2407 msgid "guestfs_set_log_message_callback"
2411 #: ../src/guestfs.pod:1174
2414 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
2415 " char *buf, int len);\n"
2416 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
2417 " guestfs_log_message_cb cb,\n"
2423 #: ../src/guestfs.pod:1180
2425 "The callback function C<cb> will be called whenever qemu or the guest writes "
2426 "anything to the console."
2430 #: ../src/guestfs.pod:1183
2431 msgid "Use this function to capture kernel messages and similar."
2435 #: ../src/guestfs.pod:1185
2437 "Normally there is no log message handler, and log messages are just "
2442 #: ../src/guestfs.pod:1188
2443 msgid "guestfs_set_subprocess_quit_callback"
2447 #: ../src/guestfs.pod:1190
2450 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
2451 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
2452 " guestfs_subprocess_quit_cb cb,\n"
2458 #: ../src/guestfs.pod:1195
2460 "The callback function C<cb> will be called when the child process quits, "
2461 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
2462 "corresponds to a transition from any state to the CONFIG state)."
2466 #: ../src/guestfs.pod:1200
2467 msgid "guestfs_set_launch_done_callback"
2471 #: ../src/guestfs.pod:1202
2474 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
2475 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
2476 " guestfs_launch_done_cb cb,\n"
2482 #: ../src/guestfs.pod:1207
2484 "The callback function C<cb> will be called when the child process becomes "
2485 "ready first time after it has been launched. (This corresponds to a "
2486 "transition from LAUNCHING to the READY state)."
2490 #: ../src/guestfs.pod:1211
2491 msgid "guestfs_set_close_callback"
2495 #: ../src/guestfs.pod:1213
2498 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
2499 " void guestfs_set_close_callback (guestfs_h *g,\n"
2500 " guestfs_close_cb cb,\n"
2506 #: ../src/guestfs.pod:1218
2508 "The callback function C<cb> will be called while the handle is being closed "
2509 "(synchronously from L</guestfs_close>)."
2513 #: ../src/guestfs.pod:1221
2515 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
2516 "handles that are open when the program exits. This means that this callback "
2517 "might be called indirectly from L<exit(3)>, which can cause unexpected "
2518 "problems in higher-level languages (eg. if your HLL interpreter has already "
2519 "been cleaned up by the time this is called, and if your callback then jumps "
2520 "into some HLL function)."
2524 #: ../src/guestfs.pod:1229
2525 msgid "guestfs_set_progress_callback"
2529 #: ../src/guestfs.pod:1231
2532 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
2533 " int proc_nr, int serial,\n"
2534 " uint64_t position, uint64_t total);\n"
2535 " void guestfs_set_progress_callback (guestfs_h *g,\n"
2536 " guestfs_progress_cb cb,\n"
2542 #: ../src/guestfs.pod:1238
2544 "Some long-running operations can generate progress messages. If this "
2545 "callback is registered, then it will be called each time a progress message "
2546 "is generated (usually two seconds after the operation started, and three "
2547 "times per second thereafter until it completes, although the frequency may "
2548 "change in future versions)."
2552 #: ../src/guestfs.pod:1244
2554 "The callback receives two numbers: C<position> and C<total>. The units of "
2555 "C<total> are not defined, although for some operations C<total> may relate "
2556 "in some way to the amount of data to be transferred (eg. in bytes or "
2557 "megabytes), and C<position> may be the portion which has been transferred."
2561 #: ../src/guestfs.pod:1250
2562 msgid "The only defined and stable parts of the API are:"
2566 #: ../src/guestfs.pod:1256
2568 "The callback can display to the user some type of progress bar or indicator "
2569 "which shows the ratio of C<position>:C<total>."
2573 #: ../src/guestfs.pod:1261
2574 msgid "0 E<lt>= C<position> E<lt>= C<total>"
2578 #: ../src/guestfs.pod:1265
2580 "If any progress notification is sent during a call, then a final progress "
2581 "notification is always sent when C<position> = C<total>."
2585 #: ../src/guestfs.pod:1268
2587 "This is to simplify caller code, so callers can easily set the progress "
2588 "indicator to \"100%\" at the end of the operation, without requiring special "
2589 "code to detect this case."
2593 #: ../src/guestfs.pod:1274
2595 "The callback also receives the procedure number and serial number of the "
2596 "call. These are only useful for debugging protocol issues, and the callback "
2597 "can normally ignore them. The callback may want to print these numbers in "
2598 "error messages or debugging messages."
2602 #: ../src/guestfs.pod:1279
2603 msgid "PRIVATE DATA AREA"
2607 #: ../src/guestfs.pod:1281
2609 "You can attach named pieces of private data to the libguestfs handle, and "
2610 "fetch them by name for the lifetime of the handle. This is called the "
2611 "private data area and is only available from the C API."
2615 #: ../src/guestfs.pod:1285
2616 msgid "To attach a named piece of data, use the following call:"
2620 #: ../src/guestfs.pod:1287
2623 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
2628 #: ../src/guestfs.pod:1289
2630 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
2631 "pointer (which can be C<NULL>). Any previous item with the same name is "
2636 #: ../src/guestfs.pod:1293
2638 "You can use any C<key> you want, but names beginning with an underscore "
2639 "character are reserved for internal libguestfs purposes (for implementing "
2640 "language bindings). It is recommended to prefix the name with some unique "
2641 "string to avoid collisions with other users."
2645 #: ../src/guestfs.pod:1298
2646 msgid "To retrieve the pointer, use:"
2650 #: ../src/guestfs.pod:1300
2653 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
2658 #: ../src/guestfs.pod:1302
2660 "This function returns C<NULL> if either no data is found associated with "
2661 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
2666 #: ../src/guestfs.pod:1306
2668 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
2669 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
2670 "all. In particular, libguestfs does I<not> try to free the data when the "
2671 "handle is closed. If the data must be freed, then the caller must either "
2672 "free it before calling L</guestfs_close> or must set up a close callback to "
2673 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
2674 "can be registered for a handle)."
2678 #: ../src/guestfs.pod:1314
2680 "The private data area is implemented using a hash table, and should be "
2681 "reasonably efficient for moderate numbers of keys."
2685 #: ../src/guestfs.pod:1317
2686 msgid "BLOCK DEVICE NAMING"
2690 #: ../src/guestfs.pod:1319
2692 "In the kernel there is now quite a profusion of schemata for naming block "
2693 "devices (in this context, by I<block device> I mean a physical or virtual "
2694 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2695 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2696 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2697 "for the old IDE driver (particularly for SATA devices) those devices also "
2698 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2699 "paravirtualized drivers. This has created several different naming systems, "
2700 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2704 #: ../src/guestfs.pod:1331
2706 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2707 "Linux kernel to access block devices. We can run a variety of appliances "
2708 "based on a variety of Linux kernels."
2712 #: ../src/guestfs.pod:1335
2714 "This causes a problem for libguestfs because many API calls use device or "
2715 "partition names. Working scripts and the recipe (example) scripts that we "
2716 "make available over the internet could fail if the naming scheme changes."
2720 #: ../src/guestfs.pod:1340
2722 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2723 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2724 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2725 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2729 #: ../src/guestfs.pod:1346
2731 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2732 "L</guestfs_list_partitions> and similar calls return the true names of the "
2733 "devices and partitions as known to the appliance."
2737 #: ../src/guestfs.pod:1351
2738 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2742 #: ../src/guestfs.pod:1353
2744 "Usually this translation is transparent. However in some (very rare) cases "
2745 "you may need to know the exact algorithm. Such cases include where you use "
2746 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2747 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2751 #: ../src/guestfs.pod:1359
2753 "The algorithm is applied only to I<parameters> which are known to be either "
2754 "device or partition names. Return values from functions such as L</"
2755 "guestfs_list_devices> are never changed."
2759 #: ../src/guestfs.pod:1367
2760 msgid "Is the string a parameter which is a device or partition name?"
2764 #: ../src/guestfs.pod:1371
2765 msgid "Does the string begin with C</dev/sd>?"
2769 #: ../src/guestfs.pod:1375
2771 "Does the named device exist? If so, we use that device. However if I<not> "
2772 "then we continue with this algorithm."
2776 #: ../src/guestfs.pod:1380
2777 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2781 #: ../src/guestfs.pod:1382
2782 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2786 #: ../src/guestfs.pod:1384
2787 msgid "If that named device exists, use it. If not, continue."
2791 #: ../src/guestfs.pod:1388
2792 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2796 #: ../src/guestfs.pod:1390
2797 msgid "If that named device exists, use it. If not, return an error."
2801 #: ../src/guestfs.pod:1394
2802 msgid "PORTABILITY CONCERNS"
2806 #: ../src/guestfs.pod:1396
2808 "Although the standard naming scheme and automatic translation is useful for "
2809 "simple programs and guestfish scripts, for larger programs it is best not to "
2810 "rely on this mechanism."
2814 #: ../src/guestfs.pod:1400
2816 "Where possible for maximum future portability programs using libguestfs "
2817 "should use these future-proof techniques:"
2821 #: ../src/guestfs.pod:1407
2823 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2824 "device names, and then use those names directly."
2828 #: ../src/guestfs.pod:1410
2830 "Since those device names exist by definition, they will never be translated."
2834 #: ../src/guestfs.pod:1415
2836 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2837 "filesystem labels."
2841 #: ../src/guestfs.pod:1420
2846 #: ../src/guestfs.pod:1422
2847 msgid "COMMUNICATION PROTOCOL"
2851 #: ../src/guestfs.pod:1424
2853 "Don't rely on using this protocol directly. This section documents how it "
2854 "currently works, but it may change at any time."
2858 #: ../src/guestfs.pod:1427
2860 "The protocol used to talk between the library and the daemon running inside "
2861 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
2862 "1014, RFC 1832, RFC 4506)."
2866 #: ../src/guestfs.pod:1431
2868 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
2869 "this file is automatically generated)."
2873 #: ../src/guestfs.pod:1434
2875 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
2876 "and C<FileOut> parameters, which are handled with very simple request/reply "
2877 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
2878 "parameters, which use the same request and reply messages, but they may also "
2879 "be followed by files sent using a chunked encoding."
2883 #: ../src/guestfs.pod:1441
2884 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
2888 #: ../src/guestfs.pod:1443
2889 msgid "For ordinary functions, the request message is:"
2893 #: ../src/guestfs.pod:1445
2896 " total length (header + arguments,\n"
2897 " but not including the length word itself)\n"
2898 " struct guestfs_message_header (encoded as XDR)\n"
2899 " struct guestfs_<foo>_args (encoded as XDR)\n"
2904 #: ../src/guestfs.pod:1450
2906 "The total length field allows the daemon to allocate a fixed size buffer "
2907 "into which it slurps the rest of the message. As a result, the total length "
2908 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
2909 "effective size of any request is limited to somewhere under this size."
2913 #: ../src/guestfs.pod:1456
2915 "Note also that many functions don't take any arguments, in which case the "
2916 "C<guestfs_I<foo>_args> is completely omitted."
2920 #: ../src/guestfs.pod:1459
2922 "The header contains the procedure number (C<guestfs_proc>) which is how the "
2923 "receiver knows what type of args structure to expect, or none at all."
2927 #: ../src/guestfs.pod:1463
2928 msgid "The reply message for ordinary functions is:"
2932 #: ../src/guestfs.pod:1465
2935 " total length (header + ret,\n"
2936 " but not including the length word itself)\n"
2937 " struct guestfs_message_header (encoded as XDR)\n"
2938 " struct guestfs_<foo>_ret (encoded as XDR)\n"
2943 #: ../src/guestfs.pod:1470
2945 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
2946 "functions that return no formal return values."
2950 #: ../src/guestfs.pod:1473
2952 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
2956 #: ../src/guestfs.pod:1476
2958 "In the case of an error, a flag is set in the header, and the reply message "
2959 "is slightly changed:"
2963 #: ../src/guestfs.pod:1479
2966 " total length (header + error,\n"
2967 " but not including the length word itself)\n"
2968 " struct guestfs_message_header (encoded as XDR)\n"
2969 " struct guestfs_message_error (encoded as XDR)\n"
2974 #: ../src/guestfs.pod:1484
2976 "The C<guestfs_message_error> structure contains the error message as a "
2981 #: ../src/guestfs.pod:1487
2982 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
2986 #: ../src/guestfs.pod:1489
2988 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
2989 "The normal request message is sent (see above). However this is followed by "
2990 "a sequence of file chunks."
2994 #: ../src/guestfs.pod:1493
2997 " total length (header + arguments,\n"
2998 " but not including the length word itself,\n"
2999 " and not including the chunks)\n"
3000 " struct guestfs_message_header (encoded as XDR)\n"
3001 " struct guestfs_<foo>_args (encoded as XDR)\n"
3002 " sequence of chunks for FileIn param #0\n"
3003 " sequence of chunks for FileIn param #1 etc.\n"
3008 #: ../src/guestfs.pod:1501
3009 msgid "The \"sequence of chunks\" is:"
3013 #: ../src/guestfs.pod:1503
3016 " length of chunk (not including length word itself)\n"
3017 " struct guestfs_chunk (encoded as XDR)\n"
3018 " length of chunk\n"
3019 " struct guestfs_chunk (encoded as XDR)\n"
3021 " length of chunk\n"
3022 " struct guestfs_chunk (with data.data_len == 0)\n"
3027 #: ../src/guestfs.pod:1511
3029 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3030 "is set in the final chunk to indicate either successful completion or early "
3035 #: ../src/guestfs.pod:1515
3037 "At time of writing there are no functions that have more than one FileIn "
3038 "parameter. However this is (theoretically) supported, by sending the "
3039 "sequence of chunks for each FileIn parameter one after another (from left to "
3044 #: ../src/guestfs.pod:1520
3046 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3047 "transfer. The library does this by sending a chunk with a special flag set "
3048 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3049 "RPC, does I<not> send any reply, and goes back to reading the next request."
3053 #: ../src/guestfs.pod:1526
3055 "The daemon may also cancel. It does this by writing a special word "
3056 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3057 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3058 "cancel chunk). The special word is chosen so that even if cancellation "
3059 "happens right at the end of the transfer (after the library has finished "
3060 "writing and has started listening for the reply), the \"spurious\" cancel "
3061 "flag will not be confused with the reply message."
3065 #: ../src/guestfs.pod:1535
3067 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3068 "limit), and also files where the size is not known in advance (eg. from "
3069 "pipes or sockets). However the chunks are rather small "
3070 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3071 "to keep much in memory."
3075 #: ../src/guestfs.pod:1541
3076 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3080 #: ../src/guestfs.pod:1543
3082 "The protocol for FileOut parameters is exactly the same as for FileIn "
3083 "parameters, but with the roles of daemon and library reversed."
3087 #: ../src/guestfs.pod:1546
3090 " total length (header + ret,\n"
3091 " but not including the length word itself,\n"
3092 " and not including the chunks)\n"
3093 " struct guestfs_message_header (encoded as XDR)\n"
3094 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3095 " sequence of chunks for FileOut param #0\n"
3096 " sequence of chunks for FileOut param #1 etc.\n"
3101 #: ../src/guestfs.pod:1554
3102 msgid "INITIAL MESSAGE"
3106 #: ../src/guestfs.pod:1556
3108 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3109 "which indicates that the guest and daemon is alive. This is what L</"
3110 "guestfs_launch> waits for."
3114 #: ../src/guestfs.pod:1560
3115 msgid "PROGRESS NOTIFICATION MESSAGES"
3119 #: ../src/guestfs.pod:1562
3121 "The daemon may send progress notification messages at any time. These are "
3122 "distinguished by the normal length word being replaced by "
3123 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3127 #: ../src/guestfs.pod:1566
3129 "The library turns them into progress callbacks (see "
3130 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3131 "discards them if not."
3135 #: ../src/guestfs.pod:1570
3137 "The daemon self-limits the frequency of progress messages it sends (see "
3138 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3143 #: ../src/guestfs.pod:1574
3144 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
3148 #: ../src/guestfs.pod:1576
3150 "All high-level libguestfs actions are synchronous. If you want to use "
3151 "libguestfs asynchronously then you must create a thread."
3155 #: ../src/guestfs.pod:1579
3157 "Only use the handle from a single thread. Either use the handle exclusively "
3158 "from one thread, or provide your own mutex so that two threads cannot issue "
3159 "calls on the same handle at the same time."
3163 #: ../src/guestfs.pod:1583
3165 "See the graphical program guestfs-browser for one possible architecture for "
3166 "multithreaded programs using libvirt and libguestfs."
3170 #: ../src/guestfs.pod:1586
3171 msgid "QEMU WRAPPERS"
3175 #: ../src/guestfs.pod:1588
3177 "If you want to compile your own qemu, run qemu from a non-standard location, "
3178 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
3183 #: ../src/guestfs.pod:1592
3185 "There is one important rule to remember: you I<must C<exec qemu>> as the "
3186 "last command in the shell script (so that qemu replaces the shell and "
3187 "becomes the direct child of the libguestfs-using program). If you don't do "
3188 "this, then the qemu process won't be cleaned up correctly."
3192 #: ../src/guestfs.pod:1597
3194 "Here is an example of a wrapper, where I have built my own copy of qemu from "
3199 #: ../src/guestfs.pod:1600
3203 " qemudir=/home/rjones/d/qemu\n"
3204 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
3209 #: ../src/guestfs.pod:1604
3211 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
3212 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
3217 #: ../src/guestfs.pod:1608
3220 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
3225 #: ../src/guestfs.pod:1610
3227 "Note that libguestfs also calls qemu with the -help and -version options in "
3228 "order to determine features."
3232 #: ../src/guestfs.pod:1613
3233 msgid "LIBGUESTFS VERSION NUMBERS"
3237 #: ../src/guestfs.pod:1615
3239 "Since April 2010, libguestfs has started to make separate development and "
3240 "stable releases, along with corresponding branches in our git repository. "
3241 "These separate releases can be identified by version number:"
3245 #: ../src/guestfs.pod:1620
3248 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3249 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3255 " | `-------- sub-version\n"
3257 " `------ always '1' because we don't change the ABI\n"
3262 #: ../src/guestfs.pod:1631
3263 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3267 #: ../src/guestfs.pod:1633
3269 "As time passes we cherry pick fixes from the development branch and backport "
3270 "those into the stable branch, the effect being that the stable branch should "
3271 "get more stable and less buggy over time. So the stable releases are ideal "
3272 "for people who don't need new features but would just like the software to "
3277 #: ../src/guestfs.pod:1639
3278 msgid "Our criteria for backporting changes are:"
3282 #: ../src/guestfs.pod:1645
3284 "Documentation changes which don't affect any code are backported unless the "
3285 "documentation refers to a future feature which is not in stable."
3289 #: ../src/guestfs.pod:1651
3291 "Bug fixes which are not controversial, fix obvious problems, and have been "
3292 "well tested are backported."
3296 #: ../src/guestfs.pod:1656
3298 "Simple rearrangements of code which shouldn't affect how it works get "
3299 "backported. This is so that the code in the two branches doesn't get too "
3300 "far out of step, allowing us to backport future fixes more easily."
3304 #: ../src/guestfs.pod:1662
3306 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3307 "exceptional case: the new feature is required in order to implement an "
3308 "important bug fix."
3312 #: ../src/guestfs.pod:1668
3314 "A new stable branch starts when we think the new features in development are "
3315 "substantial and compelling enough over the current stable branch to warrant "
3316 "it. When that happens we create new stable and development versions 1.N.0 "
3317 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
3318 "stable at this point, but by backporting fixes from development, that branch "
3319 "will stabilize over time."
3323 #: ../src/guestfs.pod:1676 ../fish/guestfish.pod:826
3324 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:312
3325 #: ../tools/virt-rescue.pl:226
3326 msgid "ENVIRONMENT VARIABLES"
3330 #: ../src/guestfs.pod:1680 ../fish/guestfish.pod:852
3331 msgid "LIBGUESTFS_APPEND"
3335 #: ../src/guestfs.pod:1682 ../fish/guestfish.pod:854
3336 msgid "Pass additional options to the guest kernel."
3340 #: ../src/guestfs.pod:1684 ../fish/guestfish.pod:856
3341 msgid "LIBGUESTFS_DEBUG"
3345 #: ../src/guestfs.pod:1686
3347 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
3348 "effect as calling C<guestfs_set_verbose (g, 1)>."
3352 #: ../src/guestfs.pod:1689 ../fish/guestfish.pod:861
3353 msgid "LIBGUESTFS_MEMSIZE"
3357 #: ../src/guestfs.pod:1691 ../fish/guestfish.pod:863
3359 "Set the memory allocated to the qemu process, in megabytes. For example:"
3363 #: ../src/guestfs.pod:1694 ../fish/guestfish.pod:866
3366 " LIBGUESTFS_MEMSIZE=700\n"
3371 #: ../src/guestfs.pod:1696 ../fish/guestfish.pod:868
3372 msgid "LIBGUESTFS_PATH"
3376 #: ../src/guestfs.pod:1698
3378 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
3379 "the discussion of paths in section PATH above."
3383 #: ../src/guestfs.pod:1701 ../fish/guestfish.pod:873
3384 msgid "LIBGUESTFS_QEMU"
3388 #: ../src/guestfs.pod:1703 ../fish/guestfish.pod:875
3390 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
3391 "which was found at compile time by the configure script is used."
3395 #: ../src/guestfs.pod:1707
3396 msgid "See also L</QEMU WRAPPERS> above."
3400 #: ../src/guestfs.pod:1709 ../fish/guestfish.pod:879
3401 msgid "LIBGUESTFS_TRACE"
3405 #: ../src/guestfs.pod:1711
3407 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
3408 "effect as calling C<guestfs_set_trace (g, 1)>."
3412 #: ../src/guestfs.pod:1714 ../fish/guestfish.pod:888
3417 #: ../src/guestfs.pod:1716 ../fish/guestfish.pod:890
3418 msgid "Location of temporary directory, defaults to C</tmp>."
3422 #: ../src/guestfs.pod:1718 ../fish/guestfish.pod:892
3424 "If libguestfs was compiled to use the supermin appliance then the real "
3425 "appliance is cached in this directory, shared between all handles belonging "
3426 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
3427 "use in case C</tmp> is not large enough."
3431 #: ../src/guestfs.pod:1726 ../fish/guestfish.pod:950
3432 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:178
3433 #: ../inspector/virt-inspector.pl:846 ../tools/virt-edit.pl:325
3434 #: ../tools/virt-win-reg.pl:461 ../tools/virt-df.pl:536
3435 #: ../tools/virt-ls.pl:210 ../tools/virt-resize.pl:1399
3436 #: ../tools/virt-list-filesystems.pl:191 ../tools/virt-cat.pl:163
3437 #: ../tools/virt-tar.pl:257 ../tools/virt-rescue.pl:231
3438 #: ../tools/virt-make-fs.pl:527 ../tools/virt-list-partitions.pl:229
3443 #: ../src/guestfs.pod:1728
3445 "L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, L<virt-edit"
3446 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
3447 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
3448 "tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
3449 "L<http://libguestfs.org/>."
3453 #: ../src/guestfs.pod:1746
3455 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
3456 "(8)>, L<disktype(1)>."
3460 #: ../src/guestfs.pod:1753 ../tools/virt-win-reg.pl:476
3461 #: ../tools/virt-make-fs.pl:541
3466 #: ../src/guestfs.pod:1755
3467 msgid "To get a list of bugs against libguestfs use this link:"
3471 #: ../src/guestfs.pod:1757
3473 "L<https://bugzilla.redhat.com/buglist.cgi?"
3474 "component=libguestfs&product=Virtualization+Tools>"
3478 #: ../src/guestfs.pod:1759
3479 msgid "To report a new bug against libguestfs use this link:"
3483 #: ../src/guestfs.pod:1761
3485 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
3486 "component=libguestfs&product=Virtualization+Tools>"
3490 #: ../src/guestfs.pod:1763
3491 msgid "When reporting a bug, please check:"
3495 #: ../src/guestfs.pod:1769
3496 msgid "That the bug hasn't been reported already."
3500 #: ../src/guestfs.pod:1773
3501 msgid "That you are testing a recent version."
3505 #: ../src/guestfs.pod:1777
3506 msgid "Describe the bug accurately, and give a way to reproduce it."
3510 #: ../src/guestfs.pod:1781
3512 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
3517 #: ../src/guestfs.pod:1786 ../fish/guestfish.pod:967
3518 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:189
3519 #: ../inspector/virt-inspector.pl:855
3524 #: ../src/guestfs.pod:1788 ../fish/guestfish.pod:969
3525 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:191
3526 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
3530 #: ../src/guestfs.pod:1790 ../fish/guestfish.pod:971
3531 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:193
3532 #: ../inspector/virt-inspector.pl:861 ../tools/virt-edit.pl:341
3533 #: ../tools/virt-win-reg.pl:491 ../tools/virt-df.pl:549
3534 #: ../tools/virt-ls.pl:225 ../tools/virt-resize.pl:1420
3535 #: ../tools/virt-list-filesystems.pl:207 ../tools/virt-cat.pl:177
3536 #: ../tools/virt-tar.pl:272 ../tools/virt-rescue.pl:245
3537 #: ../tools/virt-make-fs.pl:556 ../tools/virt-list-partitions.pl:244
3542 #: ../src/guestfs.pod:1792 ../fish/guestfish.pod:973
3543 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
3547 #: ../src/guestfs.pod:1795
3549 "This library is free software; you can redistribute it and/or modify it "
3550 "under the terms of the GNU Lesser General Public License as published by the "
3551 "Free Software Foundation; either version 2 of the License, or (at your "
3552 "option) any later version."
3556 #: ../src/guestfs.pod:1800
3558 "This library is distributed in the hope that it will be useful, but WITHOUT "
3559 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
3560 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
3565 #: ../src/guestfs.pod:1805
3567 "You should have received a copy of the GNU Lesser General Public License "
3568 "along with this library; if not, write to the Free Software Foundation, "
3569 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
3573 #: ../src/guestfs-actions.pod:1
3574 msgid "guestfs_add_cdrom"
3578 #: ../src/guestfs-actions.pod:3
3581 " int guestfs_add_cdrom (guestfs_h *g,\n"
3582 "\t\tconst char *filename);\n"
3587 #: ../src/guestfs-actions.pod:6 ../fish/guestfish-actions.pod:7
3588 msgid "This function adds a virtual CD-ROM disk image to the guest."
3592 #: ../src/guestfs-actions.pod:8 ../fish/guestfish-actions.pod:9
3593 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
3597 #: ../src/guestfs-actions.pod:10 ../src/guestfs-actions.pod:1516
3598 #: ../fish/guestfish-actions.pod:11 ../fish/guestfish-actions.pod:1211
3603 #: ../src/guestfs-actions.pod:16
3605 "This call checks for the existence of C<filename>. This stops you from "
3606 "specifying other types of drive which are supported by qemu such as C<nbd:> "
3607 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
3612 #: ../src/guestfs-actions.pod:23
3614 "If you just want to add an ISO file (often you use this as an efficient way "
3615 "to transfer large files into the guest), then you should probably use "
3616 "C<guestfs_add_drive_ro> instead."
3620 #: ../src/guestfs-actions.pod:29 ../src/guestfs-actions.pod:63
3621 #: ../src/guestfs-actions.pod:92 ../src/guestfs-actions.pod:103
3622 #: ../src/guestfs-actions.pod:114 ../src/guestfs-actions.pod:124
3623 #: ../src/guestfs-actions.pod:135 ../src/guestfs-actions.pod:238
3624 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:266
3625 #: ../src/guestfs-actions.pod:302 ../src/guestfs-actions.pod:324
3626 #: ../src/guestfs-actions.pod:339 ../src/guestfs-actions.pod:403
3627 #: ../src/guestfs-actions.pod:430 ../src/guestfs-actions.pod:441
3628 #: ../src/guestfs-actions.pod:453 ../src/guestfs-actions.pod:534
3629 #: ../src/guestfs-actions.pod:549 ../src/guestfs-actions.pod:560
3630 #: ../src/guestfs-actions.pod:571 ../src/guestfs-actions.pod:717
3631 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:749
3632 #: ../src/guestfs-actions.pod:824 ../src/guestfs-actions.pod:839
3633 #: ../src/guestfs-actions.pod:855 ../src/guestfs-actions.pod:866
3634 #: ../src/guestfs-actions.pod:883 ../src/guestfs-actions.pod:916
3635 #: ../src/guestfs-actions.pod:974 ../src/guestfs-actions.pod:1002
3636 #: ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:1055
3637 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1174
3638 #: ../src/guestfs-actions.pod:1374 ../src/guestfs-actions.pod:1393
3639 #: ../src/guestfs-actions.pod:1474 ../src/guestfs-actions.pod:1822
3640 #: ../src/guestfs-actions.pod:1945 ../src/guestfs-actions.pod:2000
3641 #: ../src/guestfs-actions.pod:2030 ../src/guestfs-actions.pod:2439
3642 #: ../src/guestfs-actions.pod:2451 ../src/guestfs-actions.pod:2468
3643 #: ../src/guestfs-actions.pod:2576 ../src/guestfs-actions.pod:2587
3644 #: ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2608
3645 #: ../src/guestfs-actions.pod:2620 ../src/guestfs-actions.pod:2650
3646 #: ../src/guestfs-actions.pod:2714 ../src/guestfs-actions.pod:2731
3647 #: ../src/guestfs-actions.pod:2745 ../src/guestfs-actions.pod:2765
3648 #: ../src/guestfs-actions.pod:2785 ../src/guestfs-actions.pod:2814
3649 #: ../src/guestfs-actions.pod:2830 ../src/guestfs-actions.pod:2846
3650 #: ../src/guestfs-actions.pod:2858 ../src/guestfs-actions.pod:2867
3651 #: ../src/guestfs-actions.pod:2900 ../src/guestfs-actions.pod:2913
3652 #: ../src/guestfs-actions.pod:2923 ../src/guestfs-actions.pod:2935
3653 #: ../src/guestfs-actions.pod:2949 ../src/guestfs-actions.pod:3029
3654 #: ../src/guestfs-actions.pod:3046 ../src/guestfs-actions.pod:3056
3655 #: ../src/guestfs-actions.pod:3101 ../src/guestfs-actions.pod:3116
3656 #: ../src/guestfs-actions.pod:3131 ../src/guestfs-actions.pod:3144
3657 #: ../src/guestfs-actions.pod:3155 ../src/guestfs-actions.pod:3166
3658 #: ../src/guestfs-actions.pod:3180 ../src/guestfs-actions.pod:3192
3659 #: ../src/guestfs-actions.pod:3209 ../src/guestfs-actions.pod:3240
3660 #: ../src/guestfs-actions.pod:3268 ../src/guestfs-actions.pod:3284
3661 #: ../src/guestfs-actions.pod:3300 ../src/guestfs-actions.pod:3309
3662 #: ../src/guestfs-actions.pod:3323 ../src/guestfs-actions.pod:3333
3663 #: ../src/guestfs-actions.pod:3345 ../src/guestfs-actions.pod:3357
3664 #: ../src/guestfs-actions.pod:3389 ../src/guestfs-actions.pod:3401
3665 #: ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3429
3666 #: ../src/guestfs-actions.pod:3443 ../src/guestfs-actions.pod:3483
3667 #: ../src/guestfs-actions.pod:3514 ../src/guestfs-actions.pod:3525
3668 #: ../src/guestfs-actions.pod:3550 ../src/guestfs-actions.pod:3564
3669 #: ../src/guestfs-actions.pod:3579 ../src/guestfs-actions.pod:3701
3670 #: ../src/guestfs-actions.pod:3753 ../src/guestfs-actions.pod:3772
3671 #: ../src/guestfs-actions.pod:3787 ../src/guestfs-actions.pod:3813
3672 #: ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:3884
3673 #: ../src/guestfs-actions.pod:3894 ../src/guestfs-actions.pod:3905
3674 #: ../src/guestfs-actions.pod:4160 ../src/guestfs-actions.pod:4176
3675 #: ../src/guestfs-actions.pod:4187 ../src/guestfs-actions.pod:4196
3676 #: ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4216
3677 #: ../src/guestfs-actions.pod:4227 ../src/guestfs-actions.pod:4240
3678 #: ../src/guestfs-actions.pod:4258 ../src/guestfs-actions.pod:4274
3679 #: ../src/guestfs-actions.pod:4290 ../src/guestfs-actions.pod:4305
3680 #: ../src/guestfs-actions.pod:4325 ../src/guestfs-actions.pod:4340
3681 #: ../src/guestfs-actions.pod:4356 ../src/guestfs-actions.pod:4374
3682 #: ../src/guestfs-actions.pod:4390 ../src/guestfs-actions.pod:4404
3683 #: ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:4450
3684 #: ../src/guestfs-actions.pod:4466 ../src/guestfs-actions.pod:4487
3685 #: ../src/guestfs-actions.pod:4499 ../src/guestfs-actions.pod:4511
3686 #: ../src/guestfs-actions.pod:4527 ../src/guestfs-actions.pod:4561
3687 #: ../src/guestfs-actions.pod:4581 ../src/guestfs-actions.pod:4604
3688 #: ../src/guestfs-actions.pod:4694 ../src/guestfs-actions.pod:4800
3689 #: ../src/guestfs-actions.pod:4809 ../src/guestfs-actions.pod:4819
3690 #: ../src/guestfs-actions.pod:4829 ../src/guestfs-actions.pod:4848
3691 #: ../src/guestfs-actions.pod:4858 ../src/guestfs-actions.pod:4868
3692 #: ../src/guestfs-actions.pod:4878 ../src/guestfs-actions.pod:4890
3693 #: ../src/guestfs-actions.pod:4940 ../src/guestfs-actions.pod:4954
3694 #: ../src/guestfs-actions.pod:4967 ../src/guestfs-actions.pod:4980
3695 #: ../src/guestfs-actions.pod:4994 ../src/guestfs-actions.pod:5004
3696 #: ../src/guestfs-actions.pod:5021 ../src/guestfs-actions.pod:5051
3697 #: ../src/guestfs-actions.pod:5062 ../src/guestfs-actions.pod:5097
3698 #: ../src/guestfs-actions.pod:5107 ../src/guestfs-actions.pod:5122
3699 #: ../src/guestfs-actions.pod:5148 ../src/guestfs-actions.pod:5176
3700 #: ../src/guestfs-actions.pod:5280 ../src/guestfs-actions.pod:5295
3701 #: ../src/guestfs-actions.pod:5306 ../src/guestfs-actions.pod:5352
3702 #: ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5399
3703 #: ../src/guestfs-actions.pod:5426 ../src/guestfs-actions.pod:5468
3704 #: ../src/guestfs-actions.pod:5491 ../src/guestfs-actions.pod:5548
3705 #: ../src/guestfs-actions.pod:5564 ../src/guestfs-actions.pod:5590
3706 msgid "This function returns 0 on success or -1 on error."
3710 #: ../src/guestfs-actions.pod:31
3711 msgid "guestfs_add_drive"
3715 #: ../src/guestfs-actions.pod:33
3718 " int guestfs_add_drive (guestfs_h *g,\n"
3719 "\t\tconst char *filename);\n"
3724 #: ../src/guestfs-actions.pod:36 ../fish/guestfish-actions.pod:36
3726 "This function adds a virtual machine disk image C<filename> to the guest. "
3727 "The first time you call this function, the disk appears as IDE disk 0 (C</"
3728 "dev/sda>) in the guest, the second time as C</dev/sdb>, and so on."
3732 #: ../src/guestfs-actions.pod:41 ../fish/guestfish-actions.pod:41
3734 "You don't necessarily need to be root when using libguestfs. However you "
3735 "obviously do need sufficient permissions to access the filename for whatever "
3736 "operations you want to perform (ie. read access if you just want to read the "
3737 "image or write access if you want to modify the image)."
3741 #: ../src/guestfs-actions.pod:47 ../fish/guestfish-actions.pod:47
3743 "This is equivalent to the qemu parameter C<-drive file=filename,cache=off,"
3748 #: ../src/guestfs-actions.pod:50 ../fish/guestfish-actions.pod:50
3750 "C<cache=off> is omitted in cases where it is not supported by the underlying "
3755 #: ../src/guestfs-actions.pod:53 ../src/guestfs-actions.pod:82
3757 "C<if=...> is set at compile time by the configuration option C<./configure --"
3758 "with-drive-if=...>. In the rare case where you might need to change this at "
3759 "run time, use C<guestfs_add_drive_with_if> or "
3760 "C<guestfs_add_drive_ro_with_if>."
3764 #: ../src/guestfs-actions.pod:58 ../src/guestfs-actions.pod:87
3766 "Note that this call checks for the existence of C<filename>. This stops you "
3767 "from specifying other types of drive which are supported by qemu such as "
3768 "C<nbd:> and C<http:> URLs. To specify those, use the general "
3769 "C<guestfs_config> call instead."
3773 #: ../src/guestfs-actions.pod:65
3774 msgid "guestfs_add_drive_ro"
3778 #: ../src/guestfs-actions.pod:67
3781 " int guestfs_add_drive_ro (guestfs_h *g,\n"
3782 "\t\tconst char *filename);\n"
3787 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:69
3788 msgid "This adds a drive in snapshot mode, making it effectively read-only."
3792 #: ../src/guestfs-actions.pod:73 ../fish/guestfish-actions.pod:72
3794 "Note that writes to the device are allowed, and will be seen for the "
3795 "duration of the guestfs handle, but they are written to a temporary file "
3796 "which is discarded as soon as the guestfs handle is closed. We don't "
3797 "currently have any method to enable changes to be committed, although qemu "
3802 #: ../src/guestfs-actions.pod:79 ../fish/guestfish-actions.pod:78
3804 "This is equivalent to the qemu parameter C<-drive file=filename,snapshot=on,"
3809 #: ../src/guestfs-actions.pod:94
3810 msgid "guestfs_add_drive_ro_with_if"
3814 #: ../src/guestfs-actions.pod:96
3817 " int guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
3818 "\t\tconst char *filename,\n"
3819 "\t\tconst char *iface);\n"
3824 #: ../src/guestfs-actions.pod:100
3826 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
3827 "QEMU interface emulation to use at run time."
3831 #: ../src/guestfs-actions.pod:105
3832 msgid "guestfs_add_drive_with_if"
3836 #: ../src/guestfs-actions.pod:107
3839 " int guestfs_add_drive_with_if (guestfs_h *g,\n"
3840 "\t\tconst char *filename,\n"
3841 "\t\tconst char *iface);\n"
3846 #: ../src/guestfs-actions.pod:111
3848 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
3849 "QEMU interface emulation to use at run time."
3853 #: ../src/guestfs-actions.pod:116
3854 msgid "guestfs_aug_clear"
3858 #: ../src/guestfs-actions.pod:118
3861 " int guestfs_aug_clear (guestfs_h *g,\n"
3862 "\t\tconst char *augpath);\n"
3867 #: ../src/guestfs-actions.pod:121 ../fish/guestfish-actions.pod:109
3869 "Set the value associated with C<path> to C<NULL>. This is the same as the "
3870 "L<augtool(1)> C<clear> command."
3874 #: ../src/guestfs-actions.pod:126
3875 msgid "guestfs_aug_close"
3879 #: ../src/guestfs-actions.pod:128
3882 " int guestfs_aug_close (guestfs_h *g);\n"
3887 #: ../src/guestfs-actions.pod:130
3889 "Close the current Augeas handle and free up any resources used by it. After "
3890 "calling this, you have to call C<guestfs_aug_init> again before you can use "
3891 "any other Augeas functions."
3895 #: ../src/guestfs-actions.pod:137
3896 msgid "guestfs_aug_defnode"
3900 #: ../src/guestfs-actions.pod:139
3903 " struct guestfs_int_bool *guestfs_aug_defnode (guestfs_h *g,\n"
3904 "\t\tconst char *name,\n"
3905 "\t\tconst char *expr,\n"
3906 "\t\tconst char *val);\n"
3911 #: ../src/guestfs-actions.pod:144 ../fish/guestfish-actions.pod:125
3913 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
3917 #: ../src/guestfs-actions.pod:147
3919 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
3920 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
3921 "containing that single node."
3925 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:132
3927 "On success this returns a pair containing the number of nodes in the "
3928 "nodeset, and a boolean flag if a node was created."
3932 #: ../src/guestfs-actions.pod:155
3934 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
3935 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
3939 #: ../src/guestfs-actions.pod:159
3940 msgid "guestfs_aug_defvar"
3944 #: ../src/guestfs-actions.pod:161
3947 " int guestfs_aug_defvar (guestfs_h *g,\n"
3948 "\t\tconst char *name,\n"
3949 "\t\tconst char *expr);\n"
3954 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:140
3956 "Defines an Augeas variable C<name> whose value is the result of evaluating "
3957 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
3961 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:144
3963 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
3964 "evaluates to something which is not a nodeset."
3968 #: ../src/guestfs-actions.pod:172 ../src/guestfs-actions.pod:313
3969 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:492
3970 #: ../src/guestfs-actions.pod:507 ../src/guestfs-actions.pod:523
3971 #: ../src/guestfs-actions.pod:1041 ../src/guestfs-actions.pod:1356
3972 #: ../src/guestfs-actions.pod:1538 ../src/guestfs-actions.pod:1619
3973 #: ../src/guestfs-actions.pod:1650 ../src/guestfs-actions.pod:1693
3974 #: ../src/guestfs-actions.pod:1710 ../src/guestfs-actions.pod:1935
3975 #: ../src/guestfs-actions.pod:2147 ../src/guestfs-actions.pod:2165
3976 #: ../src/guestfs-actions.pod:3503 ../src/guestfs-actions.pod:3610
3977 #: ../src/guestfs-actions.pod:3964 ../src/guestfs-actions.pod:3987
3978 #: ../src/guestfs-actions.pod:5086 ../src/guestfs-actions.pod:5436
3979 #: ../src/guestfs-actions.pod:5446 ../src/guestfs-actions.pod:5456
3980 msgid "On error this function returns -1."
3984 #: ../src/guestfs-actions.pod:174
3985 msgid "guestfs_aug_get"
3989 #: ../src/guestfs-actions.pod:176
3992 " char *guestfs_aug_get (guestfs_h *g,\n"
3993 "\t\tconst char *augpath);\n"
3998 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:151
4000 "Look up the value associated with C<path>. If C<path> matches exactly one "
4001 "node, the C<value> is returned."
4005 #: ../src/guestfs-actions.pod:182 ../src/guestfs-actions.pod:610
4006 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:682
4007 #: ../src/guestfs-actions.pod:695 ../src/guestfs-actions.pod:786
4008 #: ../src/guestfs-actions.pod:899 ../src/guestfs-actions.pod:928
4009 #: ../src/guestfs-actions.pod:942 ../src/guestfs-actions.pod:958
4010 #: ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1233
4011 #: ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:1487
4012 #: ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1577
4013 #: ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1729
4014 #: ../src/guestfs-actions.pod:1868 ../src/guestfs-actions.pod:2049
4015 #: ../src/guestfs-actions.pod:2099 ../src/guestfs-actions.pod:2215
4016 #: ../src/guestfs-actions.pod:2250 ../src/guestfs-actions.pod:2565
4017 #: ../src/guestfs-actions.pod:2986 ../src/guestfs-actions.pod:3082
4018 #: ../src/guestfs-actions.pod:3625 ../src/guestfs-actions.pod:3801
4019 #: ../src/guestfs-actions.pod:3942 ../src/guestfs-actions.pod:4103
4020 #: ../src/guestfs-actions.pod:4146 ../src/guestfs-actions.pod:4622
4021 #: ../src/guestfs-actions.pod:4635 ../src/guestfs-actions.pod:4649
4022 #: ../src/guestfs-actions.pod:4670 ../src/guestfs-actions.pod:5229
4023 #: ../src/guestfs-actions.pod:5245 ../src/guestfs-actions.pod:5260
4024 #: ../src/guestfs-actions.pod:5408 ../src/guestfs-actions.pod:5638
4026 "This function returns a string, or NULL on error. I<The caller must free "
4027 "the returned string after use>."
4031 #: ../src/guestfs-actions.pod:185
4032 msgid "guestfs_aug_init"
4036 #: ../src/guestfs-actions.pod:187
4039 " int guestfs_aug_init (guestfs_h *g,\n"
4040 "\t\tconst char *root,\n"
4046 #: ../src/guestfs-actions.pod:191 ../fish/guestfish-actions.pod:158
4048 "Create a new Augeas handle for editing configuration files. If there was "
4049 "any previous Augeas handle associated with this guestfs session, then it is "
4054 #: ../src/guestfs-actions.pod:195
4055 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4059 #: ../src/guestfs-actions.pod:198 ../fish/guestfish-actions.pod:165
4061 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4065 #: ../src/guestfs-actions.pod:201 ../fish/guestfish-actions.pod:168
4067 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4068 "logical I<or> of the following integers:"
4072 #: ../src/guestfs-actions.pod:207 ../fish/guestfish-actions.pod:174
4073 msgid "C<AUG_SAVE_BACKUP> = 1"
4077 #: ../src/guestfs-actions.pod:209 ../fish/guestfish-actions.pod:176
4078 msgid "Keep the original file with a C<.augsave> extension."
4082 #: ../src/guestfs-actions.pod:211 ../fish/guestfish-actions.pod:178
4083 msgid "C<AUG_SAVE_NEWFILE> = 2"
4087 #: ../src/guestfs-actions.pod:213 ../fish/guestfish-actions.pod:180
4089 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4090 "original. Overrides C<AUG_SAVE_BACKUP>."
4094 #: ../src/guestfs-actions.pod:216 ../fish/guestfish-actions.pod:183
4095 msgid "C<AUG_TYPE_CHECK> = 4"
4099 #: ../src/guestfs-actions.pod:218 ../fish/guestfish-actions.pod:185
4100 msgid "Typecheck lenses (can be expensive)."
4104 #: ../src/guestfs-actions.pod:220 ../fish/guestfish-actions.pod:187
4105 msgid "C<AUG_NO_STDINC> = 8"
4109 #: ../src/guestfs-actions.pod:222 ../fish/guestfish-actions.pod:189
4110 msgid "Do not use standard load path for modules."
4114 #: ../src/guestfs-actions.pod:224 ../fish/guestfish-actions.pod:191
4115 msgid "C<AUG_SAVE_NOOP> = 16"
4119 #: ../src/guestfs-actions.pod:226 ../fish/guestfish-actions.pod:193
4120 msgid "Make save a no-op, just record what would have been changed."
4124 #: ../src/guestfs-actions.pod:228 ../fish/guestfish-actions.pod:195
4125 msgid "C<AUG_NO_LOAD> = 32"
4129 #: ../src/guestfs-actions.pod:230
4130 msgid "Do not load the tree in C<guestfs_aug_init>."
4134 #: ../src/guestfs-actions.pod:234
4135 msgid "To close the handle, you can call C<guestfs_aug_close>."
4139 #: ../src/guestfs-actions.pod:236 ../fish/guestfish-actions.pod:203
4140 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4144 #: ../src/guestfs-actions.pod:240
4145 msgid "guestfs_aug_insert"
4149 #: ../src/guestfs-actions.pod:242
4152 " int guestfs_aug_insert (guestfs_h *g,\n"
4153 "\t\tconst char *augpath,\n"
4154 "\t\tconst char *label,\n"
4155 "\t\tint before);\n"
4160 #: ../src/guestfs-actions.pod:247 ../fish/guestfish-actions.pod:209
4162 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4163 "or after C<path> (depending on the boolean flag C<before>)."
4167 #: ../src/guestfs-actions.pod:251 ../fish/guestfish-actions.pod:213
4169 "C<path> must match exactly one existing node in the tree, and C<label> must "
4170 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4174 #: ../src/guestfs-actions.pod:257
4175 msgid "guestfs_aug_load"
4179 #: ../src/guestfs-actions.pod:259
4182 " int guestfs_aug_load (guestfs_h *g);\n"
4187 #: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:221
4188 msgid "Load files into the tree."
4192 #: ../src/guestfs-actions.pod:263 ../fish/guestfish-actions.pod:223
4193 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4197 #: ../src/guestfs-actions.pod:268
4198 msgid "guestfs_aug_ls"
4202 #: ../src/guestfs-actions.pod:270
4205 " char **guestfs_aug_ls (guestfs_h *g,\n"
4206 "\t\tconst char *augpath);\n"
4211 #: ../src/guestfs-actions.pod:273
4213 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
4214 "sorting the resulting nodes into alphabetical order."
4218 #: ../src/guestfs-actions.pod:276 ../src/guestfs-actions.pod:289
4219 #: ../src/guestfs-actions.pod:417 ../src/guestfs-actions.pod:802
4220 #: ../src/guestfs-actions.pod:1081 ../src/guestfs-actions.pod:1097
4221 #: ../src/guestfs-actions.pod:1185 ../src/guestfs-actions.pod:1201
4222 #: ../src/guestfs-actions.pod:1432 ../src/guestfs-actions.pod:1766
4223 #: ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1795
4224 #: ../src/guestfs-actions.pod:1832 ../src/guestfs-actions.pod:1853
4225 #: ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1955
4226 #: ../src/guestfs-actions.pod:2121 ../src/guestfs-actions.pod:2289
4227 #: ../src/guestfs-actions.pod:2494 ../src/guestfs-actions.pod:2550
4228 #: ../src/guestfs-actions.pod:2634 ../src/guestfs-actions.pod:2963
4229 #: ../src/guestfs-actions.pod:3470 ../src/guestfs-actions.pod:3919
4230 #: ../src/guestfs-actions.pod:4028 ../src/guestfs-actions.pod:4134
4231 #: ../src/guestfs-actions.pod:4683 ../src/guestfs-actions.pod:4732
4232 #: ../src/guestfs-actions.pod:4784 ../src/guestfs-actions.pod:4900
4233 #: ../src/guestfs-actions.pod:4921 ../src/guestfs-actions.pod:5321
4234 #: ../src/guestfs-actions.pod:5338 ../src/guestfs-actions.pod:5376
4235 #: ../src/guestfs-actions.pod:5512 ../src/guestfs-actions.pod:5528
4236 #: ../src/guestfs-actions.pod:5601 ../src/guestfs-actions.pod:5617
4237 #: ../src/guestfs-actions.pod:5657 ../src/guestfs-actions.pod:5673
4239 "This function returns a NULL-terminated array of strings (like L<environ(3)"
4240 ">), or NULL if there was an error. I<The caller must free the strings and "
4241 "the array after use>."
4245 #: ../src/guestfs-actions.pod:280
4246 msgid "guestfs_aug_match"
4250 #: ../src/guestfs-actions.pod:282
4253 " char **guestfs_aug_match (guestfs_h *g,\n"
4254 "\t\tconst char *augpath);\n"
4259 #: ../src/guestfs-actions.pod:285 ../fish/guestfish-actions.pod:237
4261 "Returns a list of paths which match the path expression C<path>. The "
4262 "returned paths are sufficiently qualified so that they match exactly one "
4263 "node in the current tree."
4267 #: ../src/guestfs-actions.pod:293
4268 msgid "guestfs_aug_mv"
4272 #: ../src/guestfs-actions.pod:295
4275 " int guestfs_aug_mv (guestfs_h *g,\n"
4276 "\t\tconst char *src,\n"
4277 "\t\tconst char *dest);\n"
4282 #: ../src/guestfs-actions.pod:299 ../fish/guestfish-actions.pod:245
4284 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4285 "C<dest> is overwritten if it exists."
4289 #: ../src/guestfs-actions.pod:304
4290 msgid "guestfs_aug_rm"
4294 #: ../src/guestfs-actions.pod:306
4297 " int guestfs_aug_rm (guestfs_h *g,\n"
4298 "\t\tconst char *augpath);\n"
4303 #: ../src/guestfs-actions.pod:309 ../fish/guestfish-actions.pod:252
4304 msgid "Remove C<path> and all of its children."
4308 #: ../src/guestfs-actions.pod:311 ../fish/guestfish-actions.pod:254
4309 msgid "On success this returns the number of entries which were removed."
4313 #: ../src/guestfs-actions.pod:315
4314 msgid "guestfs_aug_save"
4318 #: ../src/guestfs-actions.pod:317
4321 " int guestfs_aug_save (guestfs_h *g);\n"
4326 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:260
4327 msgid "This writes all pending changes to disk."
4331 #: ../src/guestfs-actions.pod:321
4333 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
4338 #: ../src/guestfs-actions.pod:326
4339 msgid "guestfs_aug_set"
4343 #: ../src/guestfs-actions.pod:328
4346 " int guestfs_aug_set (guestfs_h *g,\n"
4347 "\t\tconst char *augpath,\n"
4348 "\t\tconst char *val);\n"
4353 #: ../src/guestfs-actions.pod:332 ../fish/guestfish-actions.pod:269
4354 msgid "Set the value associated with C<path> to C<val>."
4358 #: ../src/guestfs-actions.pod:334
4360 "In the Augeas API, it is possible to clear a node by setting the value to "
4361 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
4362 "this call. Instead you must use the C<guestfs_aug_clear> call."
4366 #: ../src/guestfs-actions.pod:341
4367 msgid "guestfs_available"
4371 #: ../src/guestfs-actions.pod:343
4374 " int guestfs_available (guestfs_h *g,\n"
4375 "\t\tchar *const *groups);\n"
4380 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:280
4382 "This command is used to check the availability of some groups of "
4383 "functionality in the appliance, which not all builds of the libguestfs "
4384 "appliance will be able to provide."
4388 #: ../src/guestfs-actions.pod:350
4390 "The libguestfs groups, and the functions that those groups correspond to, "
4391 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
4392 "runtime by calling C<guestfs_available_all_groups>."
4396 #: ../src/guestfs-actions.pod:355 ../fish/guestfish-actions.pod:289
4398 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
4399 "\"]> would check for the availability of the Linux inotify functions and "
4400 "Augeas (configuration file editing) functions."
4404 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:294
4405 msgid "The command returns no error if I<all> requested groups are available."
4409 #: ../src/guestfs-actions.pod:362 ../fish/guestfish-actions.pod:296
4411 "It fails with an error if one or more of the requested groups is unavailable "
4416 #: ../src/guestfs-actions.pod:365 ../fish/guestfish-actions.pod:299
4418 "If an unknown group name is included in the list of groups then an error is "
4423 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:302
4428 #: ../src/guestfs-actions.pod:374
4429 msgid "You must call C<guestfs_launch> before calling this function."
4433 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:310
4435 "The reason is because we don't know what groups are supported by the "
4436 "appliance/daemon until it is running and can be queried."
4440 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:316
4442 "If a group of functions is available, this does not necessarily mean that "
4443 "they will work. You still have to check for errors when calling individual "
4444 "API functions even if they are available."
4448 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:323
4450 "It is usually the job of distro packagers to build complete functionality "
4451 "into the libguestfs appliance. Upstream libguestfs, if built from source "
4452 "with all requirements satisfied, will support everything."
4456 #: ../src/guestfs-actions.pod:396
4458 "This call was added in version C<1.0.80>. In previous versions of "
4459 "libguestfs all you could do would be to speculatively execute a command to "
4460 "find out if the daemon implemented it. See also C<guestfs_version>."
4464 #: ../src/guestfs-actions.pod:405
4465 msgid "guestfs_available_all_groups"
4469 #: ../src/guestfs-actions.pod:407
4472 " char **guestfs_available_all_groups (guestfs_h *g);\n"
4477 #: ../src/guestfs-actions.pod:409
4479 "This command returns a list of all optional groups that this daemon knows "
4480 "about. Note this returns both supported and unsupported groups. To find "
4481 "out which ones the daemon can actually support you have to call "
4482 "C<guestfs_available> on each member of the returned list."
4486 #: ../src/guestfs-actions.pod:415
4487 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
4491 #: ../src/guestfs-actions.pod:421
4492 msgid "guestfs_base64_in"
4496 #: ../src/guestfs-actions.pod:423
4499 " int guestfs_base64_in (guestfs_h *g,\n"
4500 "\t\tconst char *base64file,\n"
4501 "\t\tconst char *filename);\n"
4506 #: ../src/guestfs-actions.pod:427 ../fish/guestfish-actions.pod:353
4508 "This command uploads base64-encoded data from C<base64file> to C<filename>."
4512 #: ../src/guestfs-actions.pod:432
4513 msgid "guestfs_base64_out"
4517 #: ../src/guestfs-actions.pod:434
4520 " int guestfs_base64_out (guestfs_h *g,\n"
4521 "\t\tconst char *filename,\n"
4522 "\t\tconst char *base64file);\n"
4527 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:362
4529 "This command downloads the contents of C<filename>, writing it out to local "
4530 "file C<base64file> encoded as base64."
4534 #: ../src/guestfs-actions.pod:443
4535 msgid "guestfs_blockdev_flushbufs"
4539 #: ../src/guestfs-actions.pod:445
4542 " int guestfs_blockdev_flushbufs (guestfs_h *g,\n"
4543 "\t\tconst char *device);\n"
4548 #: ../src/guestfs-actions.pod:448 ../fish/guestfish-actions.pod:371
4550 "This tells the kernel to flush internal buffers associated with C<device>."
4554 #: ../src/guestfs-actions.pod:451 ../src/guestfs-actions.pod:465
4555 #: ../src/guestfs-actions.pod:477 ../src/guestfs-actions.pod:490
4556 #: ../src/guestfs-actions.pod:505 ../src/guestfs-actions.pod:521
4557 #: ../src/guestfs-actions.pod:532 ../src/guestfs-actions.pod:547
4558 #: ../src/guestfs-actions.pod:558 ../src/guestfs-actions.pod:569
4559 #: ../fish/guestfish-actions.pod:374 ../fish/guestfish-actions.pod:385
4560 #: ../fish/guestfish-actions.pod:394 ../fish/guestfish-actions.pod:404
4561 #: ../fish/guestfish-actions.pod:416 ../fish/guestfish-actions.pod:429
4562 #: ../fish/guestfish-actions.pod:437 ../fish/guestfish-actions.pod:448
4563 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:464
4564 msgid "This uses the L<blockdev(8)> command."
4568 #: ../src/guestfs-actions.pod:455
4569 msgid "guestfs_blockdev_getbsz"
4573 #: ../src/guestfs-actions.pod:457
4576 " int guestfs_blockdev_getbsz (guestfs_h *g,\n"
4577 "\t\tconst char *device);\n"
4582 #: ../src/guestfs-actions.pod:460 ../fish/guestfish-actions.pod:380
4583 msgid "This returns the block size of a device."
4587 #: ../src/guestfs-actions.pod:462 ../src/guestfs-actions.pod:544
4588 #: ../fish/guestfish-actions.pod:382 ../fish/guestfish-actions.pod:445
4590 "(Note this is different from both I<size in blocks> and I<filesystem block "
4595 #: ../src/guestfs-actions.pod:469
4596 msgid "guestfs_blockdev_getro"
4600 #: ../src/guestfs-actions.pod:471
4603 " int guestfs_blockdev_getro (guestfs_h *g,\n"
4604 "\t\tconst char *device);\n"
4609 #: ../src/guestfs-actions.pod:474 ../fish/guestfish-actions.pod:391
4611 "Returns a boolean indicating if the block device is read-only (true if read-"
4612 "only, false if not)."
4616 #: ../src/guestfs-actions.pod:479 ../src/guestfs-actions.pod:1115
4617 #: ../src/guestfs-actions.pod:1127 ../src/guestfs-actions.pod:1559
4618 #: ../src/guestfs-actions.pod:1567 ../src/guestfs-actions.pod:1627
4619 #: ../src/guestfs-actions.pod:1670 ../src/guestfs-actions.pod:1682
4620 #: ../src/guestfs-actions.pod:1701 ../src/guestfs-actions.pod:1718
4621 #: ../src/guestfs-actions.pod:2303 ../src/guestfs-actions.pod:2314
4622 #: ../src/guestfs-actions.pod:2326 ../src/guestfs-actions.pod:2337
4623 #: ../src/guestfs-actions.pod:2350 ../src/guestfs-actions.pod:2362
4624 #: ../src/guestfs-actions.pod:2375 ../src/guestfs-actions.pod:2386
4625 #: ../src/guestfs-actions.pod:2396 ../src/guestfs-actions.pod:2407
4626 #: ../src/guestfs-actions.pod:2419 ../src/guestfs-actions.pod:2431
4627 #: ../src/guestfs-actions.pod:3595
4628 msgid "This function returns a C truth value on success or -1 on error."
4632 #: ../src/guestfs-actions.pod:481
4633 msgid "guestfs_blockdev_getsize64"
4637 #: ../src/guestfs-actions.pod:483
4640 " int64_t guestfs_blockdev_getsize64 (guestfs_h *g,\n"
4641 "\t\tconst char *device);\n"
4646 #: ../src/guestfs-actions.pod:486 ../fish/guestfish-actions.pod:400
4647 msgid "This returns the size of the device in bytes."
4651 #: ../src/guestfs-actions.pod:488
4652 msgid "See also C<guestfs_blockdev_getsz>."
4656 #: ../src/guestfs-actions.pod:494
4657 msgid "guestfs_blockdev_getss"
4661 #: ../src/guestfs-actions.pod:496
4664 " int guestfs_blockdev_getss (guestfs_h *g,\n"
4665 "\t\tconst char *device);\n"
4670 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:410
4672 "This returns the size of sectors on a block device. Usually 512, but can be "
4673 "larger for modern devices."
4677 #: ../src/guestfs-actions.pod:502
4679 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
4684 #: ../src/guestfs-actions.pod:509
4685 msgid "guestfs_blockdev_getsz"
4689 #: ../src/guestfs-actions.pod:511
4692 " int64_t guestfs_blockdev_getsz (guestfs_h *g,\n"
4693 "\t\tconst char *device);\n"
4698 #: ../src/guestfs-actions.pod:514 ../fish/guestfish-actions.pod:422
4700 "This returns the size of the device in units of 512-byte sectors (even if "
4701 "the sectorsize isn't 512 bytes ... weird)."
4705 #: ../src/guestfs-actions.pod:517
4707 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
4708 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
4712 #: ../src/guestfs-actions.pod:525
4713 msgid "guestfs_blockdev_rereadpt"
4717 #: ../src/guestfs-actions.pod:527
4720 " int guestfs_blockdev_rereadpt (guestfs_h *g,\n"
4721 "\t\tconst char *device);\n"
4726 #: ../src/guestfs-actions.pod:530 ../fish/guestfish-actions.pod:435
4727 msgid "Reread the partition table on C<device>."
4731 #: ../src/guestfs-actions.pod:536
4732 msgid "guestfs_blockdev_setbsz"
4736 #: ../src/guestfs-actions.pod:538
4739 " int guestfs_blockdev_setbsz (guestfs_h *g,\n"
4740 "\t\tconst char *device,\n"
4741 "\t\tint blocksize);\n"
4746 #: ../src/guestfs-actions.pod:542 ../fish/guestfish-actions.pod:443
4747 msgid "This sets the block size of a device."
4751 #: ../src/guestfs-actions.pod:551
4752 msgid "guestfs_blockdev_setro"
4756 #: ../src/guestfs-actions.pod:553
4759 " int guestfs_blockdev_setro (guestfs_h *g,\n"
4760 "\t\tconst char *device);\n"
4765 #: ../src/guestfs-actions.pod:556 ../fish/guestfish-actions.pod:454
4766 msgid "Sets the block device named C<device> to read-only."
4770 #: ../src/guestfs-actions.pod:562
4771 msgid "guestfs_blockdev_setrw"
4775 #: ../src/guestfs-actions.pod:564
4778 " int guestfs_blockdev_setrw (guestfs_h *g,\n"
4779 "\t\tconst char *device);\n"
4784 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:462
4785 msgid "Sets the block device named C<device> to read-write."
4789 #: ../src/guestfs-actions.pod:573
4790 msgid "guestfs_case_sensitive_path"
4794 #: ../src/guestfs-actions.pod:575
4797 " char *guestfs_case_sensitive_path (guestfs_h *g,\n"
4798 "\t\tconst char *path);\n"
4803 #: ../src/guestfs-actions.pod:578 ../fish/guestfish-actions.pod:470
4805 "This can be used to resolve case insensitive paths on a filesystem which is "
4806 "case sensitive. The use case is to resolve paths which you have read from "
4807 "Windows configuration files or the Windows Registry, to the true path."
4811 #: ../src/guestfs-actions.pod:583 ../fish/guestfish-actions.pod:475
4813 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
4814 "(and probably others), which is that although the underlying filesystem is "
4815 "case-insensitive, the driver exports the filesystem to Linux as case-"
4820 #: ../src/guestfs-actions.pod:588 ../fish/guestfish-actions.pod:480
4822 "One consequence of this is that special directories such as C<c:\\windows> "
4823 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
4824 "precise details of how they were created. In Windows itself this would not "
4829 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:486
4831 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
4836 #: ../src/guestfs-actions.pod:597 ../fish/guestfish-actions.pod:489
4838 "This function resolves the true case of each element in the path and returns "
4839 "the case-sensitive path."
4843 #: ../src/guestfs-actions.pod:600
4845 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
4846 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
4847 "how the directories were originally created under Windows)."
4851 #: ../src/guestfs-actions.pod:605 ../fish/guestfish-actions.pod:497
4852 msgid "I<Note>: This function does not handle drive names, backslashes etc."
4856 #: ../src/guestfs-actions.pod:608
4857 msgid "See also C<guestfs_realpath>."
4861 #: ../src/guestfs-actions.pod:613
4866 #: ../src/guestfs-actions.pod:615
4869 " char *guestfs_cat (guestfs_h *g,\n"
4870 "\t\tconst char *path);\n"
4875 #: ../src/guestfs-actions.pod:618 ../src/guestfs-actions.pod:4018
4876 #: ../fish/guestfish-actions.pod:506 ../fish/guestfish-actions.pod:3100
4877 msgid "Return the contents of the file named C<path>."
4881 #: ../src/guestfs-actions.pod:620
4883 "Note that this function cannot correctly handle binary files (specifically, "
4884 "files containing C<\\0> character which is treated as end of string). For "
4885 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
4886 "functions which have a more complex interface."
4890 #: ../src/guestfs-actions.pod:628 ../src/guestfs-actions.pod:789
4891 #: ../src/guestfs-actions.pod:806 ../src/guestfs-actions.pod:1085
4892 #: ../src/guestfs-actions.pod:1101 ../src/guestfs-actions.pod:1189
4893 #: ../src/guestfs-actions.pod:1205 ../src/guestfs-actions.pod:1436
4894 #: ../src/guestfs-actions.pod:1783 ../src/guestfs-actions.pod:1799
4895 #: ../src/guestfs-actions.pod:1836 ../src/guestfs-actions.pod:1857
4896 #: ../src/guestfs-actions.pod:1871 ../src/guestfs-actions.pod:1897
4897 #: ../src/guestfs-actions.pod:3835 ../src/guestfs-actions.pod:3858
4898 #: ../src/guestfs-actions.pod:3966 ../src/guestfs-actions.pod:3989
4899 #: ../src/guestfs-actions.pod:4010 ../src/guestfs-actions.pod:4736
4900 #: ../src/guestfs-actions.pod:4788 ../src/guestfs-actions.pod:4904
4901 #: ../src/guestfs-actions.pod:4925 ../src/guestfs-actions.pod:5470
4902 #: ../src/guestfs-actions.pod:5493 ../src/guestfs-actions.pod:5516
4903 #: ../src/guestfs-actions.pod:5532 ../src/guestfs-actions.pod:5605
4904 #: ../src/guestfs-actions.pod:5621 ../src/guestfs-actions.pod:5661
4905 #: ../src/guestfs-actions.pod:5677 ../fish/guestfish-actions.pod:513
4906 #: ../fish/guestfish-actions.pod:648 ../fish/guestfish-actions.pod:660
4907 #: ../fish/guestfish-actions.pod:861 ../fish/guestfish-actions.pod:871
4908 #: ../fish/guestfish-actions.pod:938 ../fish/guestfish-actions.pod:948
4909 #: ../fish/guestfish-actions.pod:1143 ../fish/guestfish-actions.pod:1418
4910 #: ../fish/guestfish-actions.pod:1428 ../fish/guestfish-actions.pod:1456
4911 #: ../fish/guestfish-actions.pod:1471 ../fish/guestfish-actions.pod:1481
4912 #: ../fish/guestfish-actions.pod:1500 ../fish/guestfish-actions.pod:2970
4913 #: ../fish/guestfish-actions.pod:2985 ../fish/guestfish-actions.pod:3061
4914 #: ../fish/guestfish-actions.pod:3078 ../fish/guestfish-actions.pod:3093
4915 #: ../fish/guestfish-actions.pod:3676 ../fish/guestfish-actions.pod:3722
4916 #: ../fish/guestfish-actions.pod:3807 ../fish/guestfish-actions.pod:3822
4917 #: ../fish/guestfish-actions.pod:4232 ../fish/guestfish-actions.pod:4250
4918 #: ../fish/guestfish-actions.pod:4267 ../fish/guestfish-actions.pod:4277
4919 #: ../fish/guestfish-actions.pod:4325 ../fish/guestfish-actions.pod:4335
4920 #: ../fish/guestfish-actions.pod:4364 ../fish/guestfish-actions.pod:4374
4922 "Because of the message protocol, there is a transfer limit of somewhere "
4923 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
4927 #: ../src/guestfs-actions.pod:631
4928 msgid "guestfs_checksum"
4932 #: ../src/guestfs-actions.pod:633
4935 " char *guestfs_checksum (guestfs_h *g,\n"
4936 "\t\tconst char *csumtype,\n"
4937 "\t\tconst char *path);\n"
4942 #: ../src/guestfs-actions.pod:637 ../fish/guestfish-actions.pod:520
4944 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
4948 #: ../src/guestfs-actions.pod:640 ../fish/guestfish-actions.pod:523
4950 "The type of checksum to compute is given by the C<csumtype> parameter which "
4951 "must have one of the following values:"
4955 #: ../src/guestfs-actions.pod:645 ../fish/guestfish-actions.pod:528
4960 #: ../src/guestfs-actions.pod:647 ../fish/guestfish-actions.pod:530
4962 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
4967 #: ../src/guestfs-actions.pod:650 ../fish/guestfish-actions.pod:533
4972 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:535
4973 msgid "Compute the MD5 hash (using the C<md5sum> program)."
4977 #: ../src/guestfs-actions.pod:654 ../fish/guestfish-actions.pod:537
4982 #: ../src/guestfs-actions.pod:656 ../fish/guestfish-actions.pod:539
4983 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
4987 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:541
4992 #: ../src/guestfs-actions.pod:660 ../fish/guestfish-actions.pod:543
4993 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
4997 #: ../src/guestfs-actions.pod:662 ../fish/guestfish-actions.pod:545
5002 #: ../src/guestfs-actions.pod:664 ../fish/guestfish-actions.pod:547
5003 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5007 #: ../src/guestfs-actions.pod:666 ../fish/guestfish-actions.pod:549
5012 #: ../src/guestfs-actions.pod:668 ../fish/guestfish-actions.pod:551
5013 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5017 #: ../src/guestfs-actions.pod:670 ../fish/guestfish-actions.pod:553
5022 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:555
5023 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5027 #: ../src/guestfs-actions.pod:676 ../fish/guestfish-actions.pod:559
5028 msgid "The checksum is returned as a printable string."
5032 #: ../src/guestfs-actions.pod:678
5033 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
5037 #: ../src/guestfs-actions.pod:680
5038 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
5042 #: ../src/guestfs-actions.pod:685
5043 msgid "guestfs_checksum_device"
5047 #: ../src/guestfs-actions.pod:687
5050 " char *guestfs_checksum_device (guestfs_h *g,\n"
5051 "\t\tconst char *csumtype,\n"
5052 "\t\tconst char *device);\n"
5057 #: ../src/guestfs-actions.pod:691
5059 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5060 "device named C<device>. For the types of checksums supported see the "
5061 "C<guestfs_checksum> command."
5065 #: ../src/guestfs-actions.pod:698
5066 msgid "guestfs_checksums_out"
5070 #: ../src/guestfs-actions.pod:700
5073 " int guestfs_checksums_out (guestfs_h *g,\n"
5074 "\t\tconst char *csumtype,\n"
5075 "\t\tconst char *directory,\n"
5076 "\t\tconst char *sumsfile);\n"
5081 #: ../src/guestfs-actions.pod:705 ../fish/guestfish-actions.pod:577
5083 "This command computes the checksums of all regular files in C<directory> and "
5084 "then emits a list of those checksums to the local output file C<sumsfile>."
5088 #: ../src/guestfs-actions.pod:709 ../fish/guestfish-actions.pod:581
5090 "This can be used for verifying the integrity of a virtual machine. However "
5091 "to be properly secure you should pay attention to the output of the checksum "
5092 "command (it uses the ones from GNU coreutils). In particular when the "
5093 "filename is not printable, coreutils uses a special backslash syntax. For "
5094 "more information, see the GNU coreutils info file."
5098 #: ../src/guestfs-actions.pod:719
5099 msgid "guestfs_chmod"
5103 #: ../src/guestfs-actions.pod:721
5106 " int guestfs_chmod (guestfs_h *g,\n"
5108 "\t\tconst char *path);\n"
5113 #: ../src/guestfs-actions.pod:725 ../fish/guestfish-actions.pod:595
5115 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5120 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:598
5122 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5123 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5128 #: ../src/guestfs-actions.pod:732 ../src/guestfs-actions.pod:3178
5129 #: ../src/guestfs-actions.pod:3266 ../src/guestfs-actions.pod:3282
5130 #: ../src/guestfs-actions.pod:3298 ../fish/guestfish-actions.pod:602
5131 #: ../fish/guestfish-actions.pod:2475 ../fish/guestfish-actions.pod:2545
5132 #: ../fish/guestfish-actions.pod:2555 ../fish/guestfish-actions.pod:2565
5133 msgid "The mode actually set is affected by the umask."
5137 #: ../src/guestfs-actions.pod:736
5138 msgid "guestfs_chown"
5142 #: ../src/guestfs-actions.pod:738
5145 " int guestfs_chown (guestfs_h *g,\n"
5148 "\t\tconst char *path);\n"
5153 #: ../src/guestfs-actions.pod:743 ../fish/guestfish-actions.pod:608
5154 msgid "Change the file owner to C<owner> and group to C<group>."
5158 #: ../src/guestfs-actions.pod:745 ../src/guestfs-actions.pod:2464
5159 #: ../fish/guestfish-actions.pod:610 ../fish/guestfish-actions.pod:1966
5161 "Only numeric uid and gid are supported. If you want to use names, you will "
5162 "need to locate and parse the password file yourself (Augeas support makes "
5163 "this relatively easy)."
5167 #: ../src/guestfs-actions.pod:751
5168 msgid "guestfs_command"
5172 #: ../src/guestfs-actions.pod:753
5175 " char *guestfs_command (guestfs_h *g,\n"
5176 "\t\tchar *const *arguments);\n"
5181 #: ../src/guestfs-actions.pod:756 ../fish/guestfish-actions.pod:618
5183 "This call runs a command from the guest filesystem. The filesystem must be "
5184 "mounted, and must contain a compatible operating system (ie. something "
5185 "Linux, with the same or compatible processor architecture)."
5189 #: ../src/guestfs-actions.pod:761
5191 "The single parameter is an argv-style list of arguments. The first element "
5192 "is the name of the program to run. Subsequent elements are parameters. The "
5193 "list must be non-empty (ie. must contain a program name). Note that the "
5194 "command runs directly, and is I<not> invoked via the shell (see "
5199 #: ../src/guestfs-actions.pod:768 ../fish/guestfish-actions.pod:630
5200 msgid "The return value is anything printed to I<stdout> by the command."
5204 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:633
5206 "If the command returns a non-zero exit status, then this function returns an "
5207 "error message. The error message string is the content of I<stderr> from "
5212 #: ../src/guestfs-actions.pod:775 ../fish/guestfish-actions.pod:637
5214 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
5215 "bin>. If you require a program from another location, you should provide "
5216 "the full path in the first parameter."
5220 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:642
5222 "Shared libraries and data files required by the program must be available on "
5223 "filesystems which are mounted in the correct places. It is the caller's "
5224 "responsibility to ensure all filesystems that are needed are mounted at the "
5229 #: ../src/guestfs-actions.pod:792
5230 msgid "guestfs_command_lines"
5234 #: ../src/guestfs-actions.pod:794
5237 " char **guestfs_command_lines (guestfs_h *g,\n"
5238 "\t\tchar *const *arguments);\n"
5243 #: ../src/guestfs-actions.pod:797
5245 "This is the same as C<guestfs_command>, but splits the result into a list of "
5250 #: ../src/guestfs-actions.pod:800
5251 msgid "See also: C<guestfs_sh_lines>"
5255 #: ../src/guestfs-actions.pod:809
5256 msgid "guestfs_config"
5260 #: ../src/guestfs-actions.pod:811
5263 " int guestfs_config (guestfs_h *g,\n"
5264 "\t\tconst char *qemuparam,\n"
5265 "\t\tconst char *qemuvalue);\n"
5270 #: ../src/guestfs-actions.pod:815 ../fish/guestfish-actions.pod:667
5272 "This can be used to add arbitrary qemu command line parameters of the form "
5273 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
5274 "setting some parameters which would interfere with parameters that we use."
5278 #: ../src/guestfs-actions.pod:820 ../fish/guestfish-actions.pod:672
5279 msgid "The first character of C<param> string must be a C<-> (dash)."
5283 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:674
5284 msgid "C<value> can be NULL."
5288 #: ../src/guestfs-actions.pod:826
5289 msgid "guestfs_copy_size"
5293 #: ../src/guestfs-actions.pod:828
5296 " int guestfs_copy_size (guestfs_h *g,\n"
5297 "\t\tconst char *src,\n"
5298 "\t\tconst char *dest,\n"
5299 "\t\tint64_t size);\n"
5304 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:680
5306 "This command copies exactly C<size> bytes from one source device or file "
5307 "C<src> to another destination device or file C<dest>."
5311 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:683
5313 "Note this will fail if the source is too short or if the destination is not "
5318 #: ../src/guestfs-actions.pod:841 ../src/guestfs-actions.pod:976
5319 #: ../src/guestfs-actions.pod:1004 ../src/guestfs-actions.pod:1376
5320 #: ../src/guestfs-actions.pod:1395 ../src/guestfs-actions.pod:5550
5321 #: ../src/guestfs-actions.pod:5566
5323 "This long-running command can generate progress notification messages so "
5324 "that the caller can display a progress bar or indicator. To receive these "
5325 "messages, the caller must register a progress callback. See L<guestfs(3)/"
5326 "guestfs_set_progress_callback>."
5330 #: ../src/guestfs-actions.pod:846
5335 #: ../src/guestfs-actions.pod:848
5338 " int guestfs_cp (guestfs_h *g,\n"
5339 "\t\tconst char *src,\n"
5340 "\t\tconst char *dest);\n"
5345 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:690
5347 "This copies a file from C<src> to C<dest> where C<dest> is either a "
5348 "destination filename or destination directory."
5352 #: ../src/guestfs-actions.pod:857
5353 msgid "guestfs_cp_a"
5357 #: ../src/guestfs-actions.pod:859
5360 " int guestfs_cp_a (guestfs_h *g,\n"
5361 "\t\tconst char *src,\n"
5362 "\t\tconst char *dest);\n"
5367 #: ../src/guestfs-actions.pod:863 ../fish/guestfish-actions.pod:697
5369 "This copies a file or directory from C<src> to C<dest> recursively using the "
5374 #: ../src/guestfs-actions.pod:868
5379 #: ../src/guestfs-actions.pod:870
5382 " int guestfs_dd (guestfs_h *g,\n"
5383 "\t\tconst char *src,\n"
5384 "\t\tconst char *dest);\n"
5389 #: ../src/guestfs-actions.pod:874 ../fish/guestfish-actions.pod:704
5391 "This command copies from one source device or file C<src> to another "
5392 "destination device or file C<dest>. Normally you would use this to copy to "
5393 "or from a device or partition, for example to duplicate a filesystem."
5397 #: ../src/guestfs-actions.pod:879
5399 "If the destination is a device, it must be as large or larger than the "
5400 "source file or device, otherwise the copy will fail. This command cannot do "
5401 "partial copies (see C<guestfs_copy_size>)."
5405 #: ../src/guestfs-actions.pod:885
5406 msgid "guestfs_debug"
5410 #: ../src/guestfs-actions.pod:887
5413 " char *guestfs_debug (guestfs_h *g,\n"
5414 "\t\tconst char *subcmd,\n"
5415 "\t\tchar *const *extraargs);\n"
5420 #: ../src/guestfs-actions.pod:891
5422 "The C<guestfs_debug> command exposes some internals of C<guestfsd> (the "
5423 "guestfs daemon) that runs inside the qemu subprocess."
5427 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:721
5429 "There is no comprehensive help for this command. You have to look at the "
5430 "file C<daemon/debug.c> in the libguestfs source to find out what you can do."
5434 #: ../src/guestfs-actions.pod:902
5435 msgid "guestfs_debug_upload"
5439 #: ../src/guestfs-actions.pod:904
5442 " int guestfs_debug_upload (guestfs_h *g,\n"
5443 "\t\tconst char *filename,\n"
5444 "\t\tconst char *tmpname,\n"
5450 #: ../src/guestfs-actions.pod:909
5452 "The C<guestfs_debug_upload> command uploads a file to the libguestfs "
5457 #: ../src/guestfs-actions.pod:912 ../fish/guestfish-actions.pod:732
5459 "There is no comprehensive help for this command. You have to look at the "
5460 "file C<daemon/debug.c> in the libguestfs source to find out what it is for."
5464 #: ../src/guestfs-actions.pod:918
5469 #: ../src/guestfs-actions.pod:920
5472 " char *guestfs_df (guestfs_h *g);\n"
5477 #: ../src/guestfs-actions.pod:922 ../fish/guestfish-actions.pod:742
5478 msgid "This command runs the C<df> command to report disk space used."
5482 #: ../src/guestfs-actions.pod:924 ../src/guestfs-actions.pod:938
5483 #: ../fish/guestfish-actions.pod:744 ../fish/guestfish-actions.pod:755
5485 "This command is mostly useful for interactive sessions. It is I<not> "
5486 "intended that you try to parse the output string. Use C<statvfs> from "
5491 #: ../src/guestfs-actions.pod:931
5492 msgid "guestfs_df_h"
5496 #: ../src/guestfs-actions.pod:933
5499 " char *guestfs_df_h (guestfs_h *g);\n"
5504 #: ../src/guestfs-actions.pod:935 ../fish/guestfish-actions.pod:752
5506 "This command runs the C<df -h> command to report disk space used in human-"
5511 #: ../src/guestfs-actions.pod:945
5512 msgid "guestfs_dmesg"
5516 #: ../src/guestfs-actions.pod:947
5519 " char *guestfs_dmesg (guestfs_h *g);\n"
5524 #: ../src/guestfs-actions.pod:949 ../fish/guestfish-actions.pod:763
5526 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
5527 "This is sometimes useful for extended debugging of problems."
5531 #: ../src/guestfs-actions.pod:953
5533 "Another way to get the same information is to enable verbose messages with "
5534 "C<guestfs_set_verbose> or by setting the environment variable "
5535 "C<LIBGUESTFS_DEBUG=1> before running the program."
5539 #: ../src/guestfs-actions.pod:961
5540 msgid "guestfs_download"
5544 #: ../src/guestfs-actions.pod:963
5547 " int guestfs_download (guestfs_h *g,\n"
5548 "\t\tconst char *remotefilename,\n"
5549 "\t\tconst char *filename);\n"
5554 #: ../src/guestfs-actions.pod:967 ../src/guestfs-actions.pod:989
5555 #: ../fish/guestfish-actions.pod:776 ../fish/guestfish-actions.pod:789
5557 "Download file C<remotefilename> and save it as C<filename> on the local "
5562 #: ../src/guestfs-actions.pod:970 ../src/guestfs-actions.pod:5118
5563 #: ../fish/guestfish-actions.pod:779 ../fish/guestfish-actions.pod:3980
5564 msgid "C<filename> can also be a named pipe."
5568 #: ../src/guestfs-actions.pod:972
5569 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
5573 #: ../src/guestfs-actions.pod:981
5574 msgid "guestfs_download_offset"
5578 #: ../src/guestfs-actions.pod:983
5581 " int guestfs_download_offset (guestfs_h *g,\n"
5582 "\t\tconst char *remotefilename,\n"
5583 "\t\tconst char *filename,\n"
5584 "\t\tint64_t offset,\n"
5585 "\t\tint64_t size);\n"
5590 #: ../src/guestfs-actions.pod:992 ../fish/guestfish-actions.pod:792
5592 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
5593 "region must be within the file or device)."
5597 #: ../src/guestfs-actions.pod:995
5599 "Note that there is no limit on the amount of data that can be downloaded "
5600 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
5601 "full amount unless an error occurs."
5605 #: ../src/guestfs-actions.pod:1000
5606 msgid "See also C<guestfs_download>, C<guestfs_pread>."
5610 #: ../src/guestfs-actions.pod:1009
5611 msgid "guestfs_drop_caches"
5615 #: ../src/guestfs-actions.pod:1011
5618 " int guestfs_drop_caches (guestfs_h *g,\n"
5619 "\t\tint whattodrop);\n"
5624 #: ../src/guestfs-actions.pod:1014 ../fish/guestfish-actions.pod:808
5626 "This instructs the guest kernel to drop its page cache, and/or dentries and "
5627 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
5628 "to drop, see L<http://linux-mm.org/Drop_Caches>"
5632 #: ../src/guestfs-actions.pod:1019 ../fish/guestfish-actions.pod:813
5633 msgid "Setting C<whattodrop> to 3 should drop everything."
5637 #: ../src/guestfs-actions.pod:1021 ../fish/guestfish-actions.pod:815
5639 "This automatically calls L<sync(2)> before the operation, so that the "
5640 "maximum guest memory is freed."
5644 #: ../src/guestfs-actions.pod:1026
5649 #: ../src/guestfs-actions.pod:1028
5652 " int64_t guestfs_du (guestfs_h *g,\n"
5653 "\t\tconst char *path);\n"
5658 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:822
5660 "This command runs the C<du -s> command to estimate file space usage for "
5665 #: ../src/guestfs-actions.pod:1034 ../fish/guestfish-actions.pod:825
5667 "C<path> can be a file or a directory. If C<path> is a directory then the "
5668 "estimate includes the contents of the directory and all subdirectories "
5673 #: ../src/guestfs-actions.pod:1038 ../fish/guestfish-actions.pod:829
5675 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
5679 #: ../src/guestfs-actions.pod:1043
5680 msgid "guestfs_e2fsck_f"
5684 #: ../src/guestfs-actions.pod:1045
5687 " int guestfs_e2fsck_f (guestfs_h *g,\n"
5688 "\t\tconst char *device);\n"
5693 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:836
5695 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
5696 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
5701 #: ../src/guestfs-actions.pod:1052
5703 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
5704 "Normally you should use C<guestfs_fsck>."
5708 #: ../src/guestfs-actions.pod:1057
5709 msgid "guestfs_echo_daemon"
5713 #: ../src/guestfs-actions.pod:1059
5716 " char *guestfs_echo_daemon (guestfs_h *g,\n"
5717 "\t\tchar *const *words);\n"
5722 #: ../src/guestfs-actions.pod:1062 ../fish/guestfish-actions.pod:847
5724 "This command concatenates the list of C<words> passed with single spaces "
5725 "between them and returns the resulting string."
5729 #: ../src/guestfs-actions.pod:1065 ../fish/guestfish-actions.pod:850
5730 msgid "You can use this command to test the connection through to the daemon."
5734 #: ../src/guestfs-actions.pod:1067
5735 msgid "See also C<guestfs_ping_daemon>."
5739 #: ../src/guestfs-actions.pod:1072
5740 msgid "guestfs_egrep"
5744 #: ../src/guestfs-actions.pod:1074
5747 " char **guestfs_egrep (guestfs_h *g,\n"
5748 "\t\tconst char *regex,\n"
5749 "\t\tconst char *path);\n"
5754 #: ../src/guestfs-actions.pod:1078 ../fish/guestfish-actions.pod:858
5756 "This calls the external C<egrep> program and returns the matching lines."
5760 #: ../src/guestfs-actions.pod:1088
5761 msgid "guestfs_egrepi"
5765 #: ../src/guestfs-actions.pod:1090
5768 " char **guestfs_egrepi (guestfs_h *g,\n"
5769 "\t\tconst char *regex,\n"
5770 "\t\tconst char *path);\n"
5775 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:868
5777 "This calls the external C<egrep -i> program and returns the matching lines."
5781 #: ../src/guestfs-actions.pod:1104
5782 msgid "guestfs_equal"
5786 #: ../src/guestfs-actions.pod:1106
5789 " int guestfs_equal (guestfs_h *g,\n"
5790 "\t\tconst char *file1,\n"
5791 "\t\tconst char *file2);\n"
5796 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:878
5798 "This compares the two files C<file1> and C<file2> and returns true if their "
5799 "content is exactly equal, or false otherwise."
5803 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:881
5804 msgid "The external L<cmp(1)> program is used for the comparison."
5808 #: ../src/guestfs-actions.pod:1117
5809 msgid "guestfs_exists"
5813 #: ../src/guestfs-actions.pod:1119
5816 " int guestfs_exists (guestfs_h *g,\n"
5817 "\t\tconst char *path);\n"
5822 #: ../src/guestfs-actions.pod:1122 ../fish/guestfish-actions.pod:887
5824 "This returns C<true> if and only if there is a file, directory (or anything) "
5825 "with the given C<path> name."
5829 #: ../src/guestfs-actions.pod:1125
5830 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
5834 #: ../src/guestfs-actions.pod:1129
5835 msgid "guestfs_fallocate"
5839 #: ../src/guestfs-actions.pod:1131
5842 " int guestfs_fallocate (guestfs_h *g,\n"
5843 "\t\tconst char *path,\n"
5849 #: ../src/guestfs-actions.pod:1135 ../src/guestfs-actions.pod:1158
5850 #: ../fish/guestfish-actions.pod:896 ../fish/guestfish-actions.pod:915
5852 "This command preallocates a file (containing zero bytes) named C<path> of "
5853 "size C<len> bytes. If the file exists already, it is overwritten."
5857 #: ../src/guestfs-actions.pod:1139 ../fish/guestfish-actions.pod:900
5859 "Do not confuse this with the guestfish-specific C<alloc> command which "
5860 "allocates a file in the host and attaches it as a device."
5864 #: ../src/guestfs-actions.pod:1145 ../fish/guestfish-actions.pod:904
5866 "This function is deprecated. In new code, use the C<fallocate64> call "
5871 #: ../src/guestfs-actions.pod:1148 ../src/guestfs-actions.pod:1583
5872 #: ../src/guestfs-actions.pod:1601 ../src/guestfs-actions.pod:5499
5873 #: ../src/guestfs-actions.pod:5644 ../fish/guestfish-actions.pod:907
5874 #: ../fish/guestfish-actions.pod:1264 ../fish/guestfish-actions.pod:1278
5875 #: ../fish/guestfish-actions.pod:4256 ../fish/guestfish-actions.pod:4353
5877 "Deprecated functions will not be removed from the API, but the fact that "
5878 "they are deprecated indicates that there are problems with correct use of "
5883 #: ../src/guestfs-actions.pod:1152
5884 msgid "guestfs_fallocate64"
5888 #: ../src/guestfs-actions.pod:1154
5891 " int guestfs_fallocate64 (guestfs_h *g,\n"
5892 "\t\tconst char *path,\n"
5893 "\t\tint64_t len);\n"
5898 #: ../src/guestfs-actions.pod:1162
5900 "Note that this call allocates disk blocks for the file. To create a sparse "
5901 "file use C<guestfs_truncate_size> instead."
5905 #: ../src/guestfs-actions.pod:1165
5907 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
5908 "oversight it only allowed 30 bit lengths to be specified, effectively "
5909 "limiting the maximum size of files created through that call to 1GB."
5913 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:927
5915 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
5916 "commands which create a file in the host and attach it as a device."
5920 #: ../src/guestfs-actions.pod:1176
5921 msgid "guestfs_fgrep"
5925 #: ../src/guestfs-actions.pod:1178
5928 " char **guestfs_fgrep (guestfs_h *g,\n"
5929 "\t\tconst char *pattern,\n"
5930 "\t\tconst char *path);\n"
5935 #: ../src/guestfs-actions.pod:1182 ../fish/guestfish-actions.pod:935
5937 "This calls the external C<fgrep> program and returns the matching lines."
5941 #: ../src/guestfs-actions.pod:1192
5942 msgid "guestfs_fgrepi"
5946 #: ../src/guestfs-actions.pod:1194
5949 " char **guestfs_fgrepi (guestfs_h *g,\n"
5950 "\t\tconst char *pattern,\n"
5951 "\t\tconst char *path);\n"
5956 #: ../src/guestfs-actions.pod:1198 ../fish/guestfish-actions.pod:945
5958 "This calls the external C<fgrep -i> program and returns the matching lines."
5962 #: ../src/guestfs-actions.pod:1208
5963 msgid "guestfs_file"
5967 #: ../src/guestfs-actions.pod:1210
5970 " char *guestfs_file (guestfs_h *g,\n"
5971 "\t\tconst char *path);\n"
5976 #: ../src/guestfs-actions.pod:1213 ../fish/guestfish-actions.pod:955
5978 "This call uses the standard L<file(1)> command to determine the type or "
5979 "contents of the file."
5983 #: ../src/guestfs-actions.pod:1216 ../fish/guestfish-actions.pod:958
5985 "This call will also transparently look inside various types of compressed "
5990 #: ../src/guestfs-actions.pod:1219 ../fish/guestfish-actions.pod:961
5992 "The exact command which runs is C<file -zb path>. Note in particular that "
5993 "the filename is not prepended to the output (the C<-b> option)."
5997 #: ../src/guestfs-actions.pod:1223
5999 "This command can also be used on C</dev/> devices (and partitions, LV "
6000 "names). You can for example use this to determine if a device contains a "
6001 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
6005 #: ../src/guestfs-actions.pod:1228 ../fish/guestfish-actions.pod:970
6007 "If the C<path> does not begin with C</dev/> then this command only works for "
6008 "the content of regular files. For other file types (directory, symbolic "
6009 "link etc) it will just return the string C<directory> etc."
6013 #: ../src/guestfs-actions.pod:1236
6014 msgid "guestfs_file_architecture"
6018 #: ../src/guestfs-actions.pod:1238
6021 " char *guestfs_file_architecture (guestfs_h *g,\n"
6022 "\t\tconst char *filename);\n"
6027 #: ../src/guestfs-actions.pod:1241 ../fish/guestfish-actions.pod:979
6029 "This detects the architecture of the binary C<filename>, and returns it if "
6034 #: ../src/guestfs-actions.pod:1244 ../fish/guestfish-actions.pod:982
6035 msgid "Currently defined architectures are:"
6039 #: ../src/guestfs-actions.pod:1248 ../fish/guestfish-actions.pod:986
6044 #: ../src/guestfs-actions.pod:1250 ../fish/guestfish-actions.pod:988
6046 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6047 "irrespective of the precise processor requirements of the binary."
6051 #: ../src/guestfs-actions.pod:1253 ../fish/guestfish-actions.pod:991
6056 #: ../src/guestfs-actions.pod:1255 ../fish/guestfish-actions.pod:993
6057 msgid "64 bit x86-64."
6061 #: ../src/guestfs-actions.pod:1257 ../fish/guestfish-actions.pod:995
6066 #: ../src/guestfs-actions.pod:1259 ../fish/guestfish-actions.pod:997
6067 msgid "32 bit SPARC."
6071 #: ../src/guestfs-actions.pod:1261 ../fish/guestfish-actions.pod:999
6076 #: ../src/guestfs-actions.pod:1263 ../fish/guestfish-actions.pod:1001
6077 msgid "64 bit SPARC V9 and above."
6081 #: ../src/guestfs-actions.pod:1265 ../fish/guestfish-actions.pod:1003
6086 #: ../src/guestfs-actions.pod:1267 ../fish/guestfish-actions.pod:1005
6087 msgid "Intel Itanium."
6091 #: ../src/guestfs-actions.pod:1269 ../fish/guestfish-actions.pod:1007
6096 #: ../src/guestfs-actions.pod:1271 ../fish/guestfish-actions.pod:1009
6097 msgid "32 bit Power PC."
6101 #: ../src/guestfs-actions.pod:1273 ../fish/guestfish-actions.pod:1011
6106 #: ../src/guestfs-actions.pod:1275 ../fish/guestfish-actions.pod:1013
6107 msgid "64 bit Power PC."
6111 #: ../src/guestfs-actions.pod:1279 ../fish/guestfish-actions.pod:1017
6112 msgid "Libguestfs may return other architecture strings in future."
6116 #: ../src/guestfs-actions.pod:1281 ../fish/guestfish-actions.pod:1019
6117 msgid "The function works on at least the following types of files:"
6121 #: ../src/guestfs-actions.pod:1287 ../fish/guestfish-actions.pod:1025
6122 msgid "many types of Un*x and Linux binary"
6126 #: ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:1029
6127 msgid "many types of Un*x and Linux shared library"
6131 #: ../src/guestfs-actions.pod:1295 ../fish/guestfish-actions.pod:1033
6132 msgid "Windows Win32 and Win64 binaries"
6136 #: ../src/guestfs-actions.pod:1299 ../fish/guestfish-actions.pod:1037
6137 msgid "Windows Win32 and Win64 DLLs"
6141 #: ../src/guestfs-actions.pod:1301 ../fish/guestfish-actions.pod:1039
6142 msgid "Win32 binaries and DLLs return C<i386>."
6146 #: ../src/guestfs-actions.pod:1303 ../fish/guestfish-actions.pod:1041
6147 msgid "Win64 binaries and DLLs return C<x86_64>."
6151 #: ../src/guestfs-actions.pod:1307 ../fish/guestfish-actions.pod:1045
6152 msgid "Linux kernel modules"
6156 #: ../src/guestfs-actions.pod:1311 ../fish/guestfish-actions.pod:1049
6157 msgid "Linux new-style initrd images"
6161 #: ../src/guestfs-actions.pod:1315 ../fish/guestfish-actions.pod:1053
6162 msgid "some non-x86 Linux vmlinuz kernels"
6166 #: ../src/guestfs-actions.pod:1319 ../fish/guestfish-actions.pod:1057
6167 msgid "What it can't do currently:"
6171 #: ../src/guestfs-actions.pod:1325 ../fish/guestfish-actions.pod:1063
6172 msgid "static libraries (libfoo.a)"
6176 #: ../src/guestfs-actions.pod:1329 ../fish/guestfish-actions.pod:1067
6177 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6181 #: ../src/guestfs-actions.pod:1333 ../fish/guestfish-actions.pod:1071
6182 msgid "x86 Linux vmlinuz kernels"
6186 #: ../src/guestfs-actions.pod:1335 ../fish/guestfish-actions.pod:1073
6188 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6189 "compressed code, and are horribly hard to unpack. If you want to find the "
6190 "architecture of a kernel, use the architecture of the associated initrd or "
6191 "kernel module(s) instead."
6195 #: ../src/guestfs-actions.pod:1345
6196 msgid "guestfs_filesize"
6200 #: ../src/guestfs-actions.pod:1347
6203 " int64_t guestfs_filesize (guestfs_h *g,\n"
6204 "\t\tconst char *file);\n"
6209 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:1084
6210 msgid "This command returns the size of C<file> in bytes."
6214 #: ../src/guestfs-actions.pod:1352
6216 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
6217 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
6218 "devices, use C<guestfs_blockdev_getsize64>."
6222 #: ../src/guestfs-actions.pod:1358
6223 msgid "guestfs_fill"
6227 #: ../src/guestfs-actions.pod:1360
6230 " int guestfs_fill (guestfs_h *g,\n"
6233 "\t\tconst char *path);\n"
6238 #: ../src/guestfs-actions.pod:1365 ../fish/guestfish-actions.pod:1094
6240 "This command creates a new file called C<path>. The initial content of the "
6241 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
6246 #: ../src/guestfs-actions.pod:1369
6248 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6249 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
6250 "bytes use C<guestfs_fill_pattern>."
6254 #: ../src/guestfs-actions.pod:1381
6255 msgid "guestfs_fill_pattern"
6259 #: ../src/guestfs-actions.pod:1383
6262 " int guestfs_fill_pattern (guestfs_h *g,\n"
6263 "\t\tconst char *pattern,\n"
6265 "\t\tconst char *path);\n"
6270 #: ../src/guestfs-actions.pod:1388
6272 "This function is like C<guestfs_fill> except that it creates a new file of "
6273 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
6274 "pattern is truncated if necessary to ensure the length of the file is "
6275 "exactly C<len> bytes."
6279 #: ../src/guestfs-actions.pod:1400
6280 msgid "guestfs_find"
6284 #: ../src/guestfs-actions.pod:1402
6287 " char **guestfs_find (guestfs_h *g,\n"
6288 "\t\tconst char *directory);\n"
6293 #: ../src/guestfs-actions.pod:1405 ../fish/guestfish-actions.pod:1116
6295 "This command lists out all files and directories, recursively, starting at "
6296 "C<directory>. It is essentially equivalent to running the shell command "
6297 "C<find directory -print> but some post-processing happens on the output, "
6302 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:1121
6304 "This returns a list of strings I<without any prefix>. Thus if the directory "
6309 #: ../src/guestfs-actions.pod:1413 ../fish/guestfish-actions.pod:1124
6319 #: ../src/guestfs-actions.pod:1417
6321 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
6325 #: ../src/guestfs-actions.pod:1420 ../fish/guestfish-actions.pod:1131
6336 #: ../src/guestfs-actions.pod:1425 ../fish/guestfish-actions.pod:1136
6337 msgid "If C<directory> is not a directory, then this command returns an error."
6341 #: ../src/guestfs-actions.pod:1428 ../fish/guestfish-actions.pod:1139
6342 msgid "The returned list is sorted."
6346 #: ../src/guestfs-actions.pod:1430
6347 msgid "See also C<guestfs_find0>."
6351 #: ../src/guestfs-actions.pod:1439
6352 msgid "guestfs_find0"
6356 #: ../src/guestfs-actions.pod:1441
6359 " int guestfs_find0 (guestfs_h *g,\n"
6360 "\t\tconst char *directory,\n"
6361 "\t\tconst char *files);\n"
6366 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:1150
6368 "This command lists out all files and directories, recursively, starting at "
6369 "C<directory>, placing the resulting list in the external file called "
6374 #: ../src/guestfs-actions.pod:1449
6376 "This command works the same way as C<guestfs_find> with the following "
6381 #: ../src/guestfs-actions.pod:1456 ../fish/guestfish-actions.pod:1161
6382 msgid "The resulting list is written to an external file."
6386 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:1165
6388 "Items (filenames) in the result are separated by C<\\0> characters. See "
6389 "L<find(1)> option I<-print0>."
6393 #: ../src/guestfs-actions.pod:1465 ../fish/guestfish-actions.pod:1170
6394 msgid "This command is not limited in the number of names that it can return."
6398 #: ../src/guestfs-actions.pod:1470 ../fish/guestfish-actions.pod:1175
6399 msgid "The result list is not sorted."
6403 #: ../src/guestfs-actions.pod:1476
6404 msgid "guestfs_findfs_label"
6408 #: ../src/guestfs-actions.pod:1478
6411 " char *guestfs_findfs_label (guestfs_h *g,\n"
6412 "\t\tconst char *label);\n"
6417 #: ../src/guestfs-actions.pod:1481 ../fish/guestfish-actions.pod:1185
6419 "This command searches the filesystems and returns the one which has the "
6420 "given label. An error is returned if no such filesystem can be found."
6424 #: ../src/guestfs-actions.pod:1485
6425 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
6429 #: ../src/guestfs-actions.pod:1490
6430 msgid "guestfs_findfs_uuid"
6434 #: ../src/guestfs-actions.pod:1492
6437 " char *guestfs_findfs_uuid (guestfs_h *g,\n"
6438 "\t\tconst char *uuid);\n"
6443 #: ../src/guestfs-actions.pod:1495 ../fish/guestfish-actions.pod:1195
6445 "This command searches the filesystems and returns the one which has the "
6446 "given UUID. An error is returned if no such filesystem can be found."
6450 #: ../src/guestfs-actions.pod:1499
6451 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
6455 #: ../src/guestfs-actions.pod:1504
6456 msgid "guestfs_fsck"
6460 #: ../src/guestfs-actions.pod:1506
6463 " int guestfs_fsck (guestfs_h *g,\n"
6464 "\t\tconst char *fstype,\n"
6465 "\t\tconst char *device);\n"
6470 #: ../src/guestfs-actions.pod:1510 ../fish/guestfish-actions.pod:1205
6472 "This runs the filesystem checker (fsck) on C<device> which should have "
6473 "filesystem type C<fstype>."
6477 #: ../src/guestfs-actions.pod:1513 ../fish/guestfish-actions.pod:1208
6479 "The returned integer is the status. See L<fsck(8)> for the list of status "
6480 "codes from C<fsck>."
6484 #: ../src/guestfs-actions.pod:1522 ../fish/guestfish-actions.pod:1217
6485 msgid "Multiple status codes can be summed together."
6489 #: ../src/guestfs-actions.pod:1526 ../fish/guestfish-actions.pod:1221
6491 "A non-zero return code can mean \"success\", for example if errors have been "
6492 "corrected on the filesystem."
6496 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1226
6497 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
6501 #: ../src/guestfs-actions.pod:1536 ../fish/guestfish-actions.pod:1231
6503 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
6507 #: ../src/guestfs-actions.pod:1540
6508 msgid "guestfs_get_append"
6512 #: ../src/guestfs-actions.pod:1542
6515 " const char *guestfs_get_append (guestfs_h *g);\n"
6520 #: ../src/guestfs-actions.pod:1544 ../fish/guestfish-actions.pod:1237
6522 "Return the additional kernel options which are added to the guest kernel "
6527 #: ../src/guestfs-actions.pod:1547 ../fish/guestfish-actions.pod:1240
6528 msgid "If C<NULL> then no options are added."
6532 #: ../src/guestfs-actions.pod:1549
6534 "This function returns a string which may be NULL. There is no way to return "
6535 "an error from this function. The string is owned by the guest handle and "
6536 "must I<not> be freed."
6540 #: ../src/guestfs-actions.pod:1553
6541 msgid "guestfs_get_autosync"
6545 #: ../src/guestfs-actions.pod:1555
6548 " int guestfs_get_autosync (guestfs_h *g);\n"
6553 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1246
6554 msgid "Get the autosync flag."
6558 #: ../src/guestfs-actions.pod:1561
6559 msgid "guestfs_get_direct"
6563 #: ../src/guestfs-actions.pod:1563
6566 " int guestfs_get_direct (guestfs_h *g);\n"
6571 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1252
6572 msgid "Return the direct appliance mode flag."
6576 #: ../src/guestfs-actions.pod:1569
6577 msgid "guestfs_get_e2label"
6581 #: ../src/guestfs-actions.pod:1571
6584 " char *guestfs_get_e2label (guestfs_h *g,\n"
6585 "\t\tconst char *device);\n"
6590 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1258
6592 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
6596 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1261
6598 "This function is deprecated. In new code, use the C<vfs_label> call instead."
6602 #: ../src/guestfs-actions.pod:1587
6603 msgid "guestfs_get_e2uuid"
6607 #: ../src/guestfs-actions.pod:1589
6610 " char *guestfs_get_e2uuid (guestfs_h *g,\n"
6611 "\t\tconst char *device);\n"
6616 #: ../src/guestfs-actions.pod:1592 ../fish/guestfish-actions.pod:1272
6618 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
6622 #: ../src/guestfs-actions.pod:1598 ../fish/guestfish-actions.pod:1275
6624 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
6628 #: ../src/guestfs-actions.pod:1605
6629 msgid "guestfs_get_memsize"
6633 #: ../src/guestfs-actions.pod:1607
6636 " int guestfs_get_memsize (guestfs_h *g);\n"
6641 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1286
6643 "This gets the memory size in megabytes allocated to the qemu subprocess."
6647 #: ../src/guestfs-actions.pod:1612
6649 "If C<guestfs_set_memsize> was not called on this handle, and if "
6650 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
6651 "value for memsize."
6655 #: ../src/guestfs-actions.pod:1616 ../src/guestfs-actions.pod:1679
6656 #: ../src/guestfs-actions.pod:4371 ../src/guestfs-actions.pod:4463
6657 #: ../fish/guestfish-actions.pod:1293 ../fish/guestfish-actions.pod:1344
6658 #: ../fish/guestfish-actions.pod:3387 ../fish/guestfish-actions.pod:3474
6660 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
6664 #: ../src/guestfs-actions.pod:1621
6665 msgid "guestfs_get_network"
6669 #: ../src/guestfs-actions.pod:1623
6672 " int guestfs_get_network (guestfs_h *g);\n"
6677 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1300
6678 msgid "This returns the enable network flag."
6682 #: ../src/guestfs-actions.pod:1629
6683 msgid "guestfs_get_path"
6687 #: ../src/guestfs-actions.pod:1631
6690 " const char *guestfs_get_path (guestfs_h *g);\n"
6695 #: ../src/guestfs-actions.pod:1633 ../fish/guestfish-actions.pod:1306
6696 msgid "Return the current search path."
6700 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1308
6702 "This is always non-NULL. If it wasn't set already, then this will return "
6707 #: ../src/guestfs-actions.pod:1638 ../src/guestfs-actions.pod:1661
6709 "This function returns a string, or NULL on error. The string is owned by "
6710 "the guest handle and must I<not> be freed."
6714 #: ../src/guestfs-actions.pod:1641
6715 msgid "guestfs_get_pid"
6719 #: ../src/guestfs-actions.pod:1643
6722 " int guestfs_get_pid (guestfs_h *g);\n"
6727 #: ../src/guestfs-actions.pod:1645 ../fish/guestfish-actions.pod:1317
6729 "Return the process ID of the qemu subprocess. If there is no qemu "
6730 "subprocess, then this will return an error."
6734 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1320
6735 msgid "This is an internal call used for debugging and testing."
6739 #: ../src/guestfs-actions.pod:1652
6740 msgid "guestfs_get_qemu"
6744 #: ../src/guestfs-actions.pod:1654
6747 " const char *guestfs_get_qemu (guestfs_h *g);\n"
6752 #: ../src/guestfs-actions.pod:1656 ../fish/guestfish-actions.pod:1326
6753 msgid "Return the current qemu binary."
6757 #: ../src/guestfs-actions.pod:1658 ../fish/guestfish-actions.pod:1328
6759 "This is always non-NULL. If it wasn't set already, then this will return "
6760 "the default qemu binary name."
6764 #: ../src/guestfs-actions.pod:1664
6765 msgid "guestfs_get_recovery_proc"
6769 #: ../src/guestfs-actions.pod:1666
6772 " int guestfs_get_recovery_proc (guestfs_h *g);\n"
6777 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1335
6778 msgid "Return the recovery process enabled flag."
6782 #: ../src/guestfs-actions.pod:1672
6783 msgid "guestfs_get_selinux"
6787 #: ../src/guestfs-actions.pod:1674
6790 " int guestfs_get_selinux (guestfs_h *g);\n"
6795 #: ../src/guestfs-actions.pod:1676
6797 "This returns the current setting of the selinux flag which is passed to the "
6798 "appliance at boot time. See C<guestfs_set_selinux>."
6802 #: ../src/guestfs-actions.pod:1684
6803 msgid "guestfs_get_state"
6807 #: ../src/guestfs-actions.pod:1686
6810 " int guestfs_get_state (guestfs_h *g);\n"
6815 #: ../src/guestfs-actions.pod:1688 ../fish/guestfish-actions.pod:1351
6817 "This returns the current state as an opaque integer. This is only useful "
6818 "for printing debug and internal error messages."
6822 #: ../src/guestfs-actions.pod:1691 ../src/guestfs-actions.pod:2312
6823 #: ../src/guestfs-actions.pod:2335 ../src/guestfs-actions.pod:2384
6824 #: ../src/guestfs-actions.pod:2405 ../fish/guestfish-actions.pod:1354
6825 #: ../fish/guestfish-actions.pod:1848 ../fish/guestfish-actions.pod:1866
6826 #: ../fish/guestfish-actions.pod:1904 ../fish/guestfish-actions.pod:1920
6827 msgid "For more information on states, see L<guestfs(3)>."
6831 #: ../src/guestfs-actions.pod:1695
6832 msgid "guestfs_get_trace"
6836 #: ../src/guestfs-actions.pod:1697
6839 " int guestfs_get_trace (guestfs_h *g);\n"
6844 #: ../src/guestfs-actions.pod:1699 ../fish/guestfish-actions.pod:1360
6845 msgid "Return the command trace flag."
6849 #: ../src/guestfs-actions.pod:1703
6850 msgid "guestfs_get_umask"
6854 #: ../src/guestfs-actions.pod:1705
6857 " int guestfs_get_umask (guestfs_h *g);\n"
6862 #: ../src/guestfs-actions.pod:1707
6864 "Return the current umask. By default the umask is C<022> unless it has been "
6865 "set by calling C<guestfs_umask>."
6869 #: ../src/guestfs-actions.pod:1712
6870 msgid "guestfs_get_verbose"
6874 #: ../src/guestfs-actions.pod:1714
6877 " int guestfs_get_verbose (guestfs_h *g);\n"
6882 #: ../src/guestfs-actions.pod:1716 ../fish/guestfish-actions.pod:1373
6883 msgid "This returns the verbose messages flag."
6887 #: ../src/guestfs-actions.pod:1720
6888 msgid "guestfs_getcon"
6892 #: ../src/guestfs-actions.pod:1722
6895 " char *guestfs_getcon (guestfs_h *g);\n"
6900 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1379
6901 msgid "This gets the SELinux security context of the daemon."
6905 #: ../src/guestfs-actions.pod:1726
6907 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
6911 #: ../src/guestfs-actions.pod:1732
6912 msgid "guestfs_getxattrs"
6916 #: ../src/guestfs-actions.pod:1734
6919 " struct guestfs_xattr_list *guestfs_getxattrs (guestfs_h *g,\n"
6920 "\t\tconst char *path);\n"
6925 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1388
6927 "This call lists the extended attributes of the file or directory C<path>."
6931 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1391
6933 "At the system call level, this is a combination of the L<listxattr(2)> and "
6934 "L<getxattr(2)> calls."
6938 #: ../src/guestfs-actions.pod:1743
6939 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
6943 #: ../src/guestfs-actions.pod:1745 ../src/guestfs-actions.pod:2479
6944 #: ../src/guestfs-actions.pod:3017
6946 "This function returns a C<struct guestfs_xattr_list *> (see E<lt>guestfs-"
6947 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
6948 "C<guestfs_free_xattr_list> after use>."
6952 #: ../src/guestfs-actions.pod:1750
6953 msgid "guestfs_glob_expand"
6957 #: ../src/guestfs-actions.pod:1752
6960 " char **guestfs_glob_expand (guestfs_h *g,\n"
6961 "\t\tconst char *pattern);\n"
6966 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1400
6968 "This command searches for all the pathnames matching C<pattern> according to "
6969 "the wildcard expansion rules used by the shell."
6973 #: ../src/guestfs-actions.pod:1759 ../fish/guestfish-actions.pod:1404
6975 "If no paths match, then this returns an empty list (note: not an error)."
6979 #: ../src/guestfs-actions.pod:1762 ../fish/guestfish-actions.pod:1407
6981 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
6982 "GLOB_BRACE>. See that manual page for more details."
6986 #: ../src/guestfs-actions.pod:1770
6987 msgid "guestfs_grep"
6991 #: ../src/guestfs-actions.pod:1772
6994 " char **guestfs_grep (guestfs_h *g,\n"
6995 "\t\tconst char *regex,\n"
6996 "\t\tconst char *path);\n"
7001 #: ../src/guestfs-actions.pod:1776 ../fish/guestfish-actions.pod:1415
7002 msgid "This calls the external C<grep> program and returns the matching lines."
7006 #: ../src/guestfs-actions.pod:1786
7007 msgid "guestfs_grepi"
7011 #: ../src/guestfs-actions.pod:1788
7014 " char **guestfs_grepi (guestfs_h *g,\n"
7015 "\t\tconst char *regex,\n"
7016 "\t\tconst char *path);\n"
7021 #: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1425
7023 "This calls the external C<grep -i> program and returns the matching lines."
7027 #: ../src/guestfs-actions.pod:1802
7028 msgid "guestfs_grub_install"
7032 #: ../src/guestfs-actions.pod:1804
7035 " int guestfs_grub_install (guestfs_h *g,\n"
7036 "\t\tconst char *root,\n"
7037 "\t\tconst char *device);\n"
7042 #: ../src/guestfs-actions.pod:1808 ../fish/guestfish-actions.pod:1435
7044 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
7045 "the root directory being C<root>."
7049 #: ../src/guestfs-actions.pod:1811 ../fish/guestfish-actions.pod:1438
7051 "Note: If grub-install reports the error \"No suitable drive was found in the "
7052 "generated device map.\" it may be that you need to create a C</boot/grub/"
7053 "device.map> file first that contains the mapping between grub device names "
7054 "and Linux device names. It is usually sufficient to create a file "
7059 #: ../src/guestfs-actions.pod:1818 ../fish/guestfish-actions.pod:1445
7067 #: ../src/guestfs-actions.pod:1820 ../fish/guestfish-actions.pod:1447
7068 msgid "replacing C</dev/vda> with the name of the installation device."
7072 #: ../src/guestfs-actions.pod:1824
7073 msgid "guestfs_head"
7077 #: ../src/guestfs-actions.pod:1826
7080 " char **guestfs_head (guestfs_h *g,\n"
7081 "\t\tconst char *path);\n"
7086 #: ../src/guestfs-actions.pod:1829 ../fish/guestfish-actions.pod:1453
7088 "This command returns up to the first 10 lines of a file as a list of strings."
7092 #: ../src/guestfs-actions.pod:1839
7093 msgid "guestfs_head_n"
7097 #: ../src/guestfs-actions.pod:1841
7100 " char **guestfs_head_n (guestfs_h *g,\n"
7101 "\t\tint nrlines,\n"
7102 "\t\tconst char *path);\n"
7107 #: ../src/guestfs-actions.pod:1845 ../fish/guestfish-actions.pod:1463
7109 "If the parameter C<nrlines> is a positive number, this returns the first "
7110 "C<nrlines> lines of the file C<path>."
7114 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1466
7116 "If the parameter C<nrlines> is a negative number, this returns lines from "
7117 "the file C<path>, excluding the last C<nrlines> lines."
7121 #: ../src/guestfs-actions.pod:1851 ../src/guestfs-actions.pod:4919
7122 #: ../fish/guestfish-actions.pod:1469 ../fish/guestfish-actions.pod:3820
7123 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7127 #: ../src/guestfs-actions.pod:1860
7128 msgid "guestfs_hexdump"
7132 #: ../src/guestfs-actions.pod:1862
7135 " char *guestfs_hexdump (guestfs_h *g,\n"
7136 "\t\tconst char *path);\n"
7141 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1478
7143 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
7144 "readable, canonical hex dump of the file."
7148 #: ../src/guestfs-actions.pod:1874
7149 msgid "guestfs_initrd_cat"
7153 #: ../src/guestfs-actions.pod:1876
7156 " char *guestfs_initrd_cat (guestfs_h *g,\n"
7157 "\t\tconst char *initrdpath,\n"
7158 "\t\tconst char *filename,\n"
7159 "\t\tsize_t *size_r);\n"
7164 #: ../src/guestfs-actions.pod:1881 ../fish/guestfish-actions.pod:1488
7166 "This command unpacks the file C<filename> from the initrd file called "
7167 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7172 #: ../src/guestfs-actions.pod:1885 ../fish/guestfish-actions.pod:1492
7174 "For example, in guestfish you could use the following command to examine the "
7175 "boot script (usually called C</init>) contained in a Linux initrd or "
7180 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1496
7183 " initrd-cat /boot/initrd-<version>.img init\n"
7188 #: ../src/guestfs-actions.pod:1891
7189 msgid "See also C<guestfs_initrd_list>."
7193 #: ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:3831
7194 #: ../src/guestfs-actions.pod:3854 ../src/guestfs-actions.pod:4006
7196 "This function returns a buffer, or NULL on error. The size of the returned "
7197 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
7202 #: ../src/guestfs-actions.pod:1900
7203 msgid "guestfs_initrd_list"
7207 #: ../src/guestfs-actions.pod:1902
7210 " char **guestfs_initrd_list (guestfs_h *g,\n"
7211 "\t\tconst char *path);\n"
7216 #: ../src/guestfs-actions.pod:1905 ../fish/guestfish-actions.pod:1507
7217 msgid "This command lists out files contained in an initrd."
7221 #: ../src/guestfs-actions.pod:1907 ../fish/guestfish-actions.pod:1509
7223 "The files are listed without any initial C</> character. The files are "
7224 "listed in the order they appear (not necessarily alphabetical). Directory "
7225 "names are listed as separate items."
7229 #: ../src/guestfs-actions.pod:1911 ../fish/guestfish-actions.pod:1513
7231 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
7232 "initrd. We I<only> support the newer initramfs format (compressed cpio "
7237 #: ../src/guestfs-actions.pod:1919
7238 msgid "guestfs_inotify_add_watch"
7242 #: ../src/guestfs-actions.pod:1921
7245 " int64_t guestfs_inotify_add_watch (guestfs_h *g,\n"
7246 "\t\tconst char *path,\n"
7252 #: ../src/guestfs-actions.pod:1925 ../fish/guestfish-actions.pod:1521
7253 msgid "Watch C<path> for the events listed in C<mask>."
7257 #: ../src/guestfs-actions.pod:1927 ../fish/guestfish-actions.pod:1523
7259 "Note that if C<path> is a directory then events within that directory are "
7260 "watched, but this does I<not> happen recursively (in subdirectories)."
7264 #: ../src/guestfs-actions.pod:1931 ../fish/guestfish-actions.pod:1527
7266 "Note for non-C or non-Linux callers: the inotify events are defined by the "
7267 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
7271 #: ../src/guestfs-actions.pod:1937
7272 msgid "guestfs_inotify_close"
7276 #: ../src/guestfs-actions.pod:1939
7279 " int guestfs_inotify_close (guestfs_h *g);\n"
7284 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1535
7286 "This closes the inotify handle which was previously opened by inotify_init. "
7287 "It removes all watches, throws away any pending events, and deallocates all "
7292 #: ../src/guestfs-actions.pod:1947
7293 msgid "guestfs_inotify_files"
7297 #: ../src/guestfs-actions.pod:1949
7300 " char **guestfs_inotify_files (guestfs_h *g);\n"
7305 #: ../src/guestfs-actions.pod:1951
7307 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
7308 "returns a list of pathnames of objects that were touched. The returned "
7309 "pathnames are sorted and deduplicated."
7313 #: ../src/guestfs-actions.pod:1959
7314 msgid "guestfs_inotify_init"
7318 #: ../src/guestfs-actions.pod:1961
7321 " int guestfs_inotify_init (guestfs_h *g,\n"
7322 "\t\tint maxevents);\n"
7327 #: ../src/guestfs-actions.pod:1964 ../fish/guestfish-actions.pod:1551
7329 "This command creates a new inotify handle. The inotify subsystem can be "
7330 "used to notify events which happen to objects in the guest filesystem."
7334 #: ../src/guestfs-actions.pod:1968
7336 "C<maxevents> is the maximum number of events which will be queued up between "
7337 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
7338 "passed as C<0>, then the kernel (or previously set) default is used. For "
7339 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
7340 "throws away events, but records the fact that it threw them away by setting "
7341 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
7342 "C<guestfs_inotify_read>)."
7346 #: ../src/guestfs-actions.pod:1978
7348 "Before any events are generated, you have to add some watches to the "
7349 "internal watch list. See: C<guestfs_inotify_add_watch>, "
7350 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
7354 #: ../src/guestfs-actions.pod:1984
7356 "Queued up events should be read periodically by calling "
7357 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
7358 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
7359 "often enough then you risk the internal queue overflowing."
7363 #: ../src/guestfs-actions.pod:1991
7365 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
7366 "This also removes any watches automatically."
7370 #: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1582
7372 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
7373 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
7374 "that there is one global inotify handle per libguestfs instance."
7378 #: ../src/guestfs-actions.pod:2002
7379 msgid "guestfs_inotify_read"
7383 #: ../src/guestfs-actions.pod:2004
7386 " struct guestfs_inotify_event_list *guestfs_inotify_read (guestfs_h *g);\n"
7391 #: ../src/guestfs-actions.pod:2006 ../fish/guestfish-actions.pod:1591
7393 "Return the complete queue of events that have happened since the previous "
7398 #: ../src/guestfs-actions.pod:2009 ../fish/guestfish-actions.pod:1594
7399 msgid "If no events have happened, this returns an empty list."
7403 #: ../src/guestfs-actions.pod:2011 ../fish/guestfish-actions.pod:1596
7405 "I<Note>: In order to make sure that all events have been read, you must call "
7406 "this function repeatedly until it returns an empty list. The reason is that "
7407 "the call will read events up to the maximum appliance-to-host message size "
7408 "and leave remaining events in the queue."
7412 #: ../src/guestfs-actions.pod:2017
7414 "This function returns a C<struct guestfs_inotify_event_list *> (see "
7415 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
7416 "must call C<guestfs_free_inotify_event_list> after use>."
7420 #: ../src/guestfs-actions.pod:2022
7421 msgid "guestfs_inotify_rm_watch"
7425 #: ../src/guestfs-actions.pod:2024
7428 " int guestfs_inotify_rm_watch (guestfs_h *g,\n"
7434 #: ../src/guestfs-actions.pod:2027
7436 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
7440 #: ../src/guestfs-actions.pod:2032
7441 msgid "guestfs_inspect_get_arch"
7445 #: ../src/guestfs-actions.pod:2034
7448 " char *guestfs_inspect_get_arch (guestfs_h *g,\n"
7449 "\t\tconst char *root);\n"
7454 #: ../src/guestfs-actions.pod:2037 ../src/guestfs-actions.pod:2057
7455 #: ../src/guestfs-actions.pod:2107 ../src/guestfs-actions.pod:2130
7456 #: ../src/guestfs-actions.pod:2154 ../src/guestfs-actions.pod:2172
7457 #: ../src/guestfs-actions.pod:2202 ../src/guestfs-actions.pod:2223
7459 "This function should only be called with a root device string as returned by "
7460 "C<guestfs_inspect_os>."
7464 #: ../src/guestfs-actions.pod:2040
7466 "This returns the architecture of the inspected operating system. The "
7467 "possible return values are listed under C<guestfs_file_architecture>."
7471 #: ../src/guestfs-actions.pod:2044 ../fish/guestfish-actions.pod:1620
7473 "If the architecture could not be determined, then the string C<unknown> is "
7478 #: ../src/guestfs-actions.pod:2047 ../src/guestfs-actions.pod:2097
7479 #: ../src/guestfs-actions.pod:2145 ../src/guestfs-actions.pod:2213
7480 #: ../src/guestfs-actions.pod:2248 ../src/guestfs-actions.pod:2285
7481 #: ../fish/guestfish-actions.pod:1623 ../fish/guestfish-actions.pod:1669
7482 #: ../fish/guestfish-actions.pod:1708 ../fish/guestfish-actions.pod:1763
7483 #: ../fish/guestfish-actions.pod:1794 ../fish/guestfish-actions.pod:1828
7484 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
7488 #: ../src/guestfs-actions.pod:2052
7489 msgid "guestfs_inspect_get_distro"
7493 #: ../src/guestfs-actions.pod:2054
7496 " char *guestfs_inspect_get_distro (guestfs_h *g,\n"
7497 "\t\tconst char *root);\n"
7502 #: ../src/guestfs-actions.pod:2060 ../fish/guestfish-actions.pod:1632
7504 "This returns the distro (distribution) of the inspected operating system."
7508 #: ../src/guestfs-actions.pod:2063 ../fish/guestfish-actions.pod:1635
7509 msgid "Currently defined distros are:"
7513 #: ../src/guestfs-actions.pod:2067 ../fish/guestfish-actions.pod:1639
7518 #: ../src/guestfs-actions.pod:2069 ../fish/guestfish-actions.pod:1641
7519 msgid "Debian or a Debian-derived distro such as Ubuntu."
7523 #: ../src/guestfs-actions.pod:2071 ../fish/guestfish-actions.pod:1643
7528 #: ../src/guestfs-actions.pod:2073 ../fish/guestfish-actions.pod:1645
7533 #: ../src/guestfs-actions.pod:2075 ../fish/guestfish-actions.pod:1647
7534 msgid "\"redhat-based\""
7538 #: ../src/guestfs-actions.pod:2077 ../fish/guestfish-actions.pod:1649
7539 msgid "Some Red Hat-derived distro."
7543 #: ../src/guestfs-actions.pod:2079 ../fish/guestfish-actions.pod:1651
7548 #: ../src/guestfs-actions.pod:2081 ../fish/guestfish-actions.pod:1653
7549 msgid "Red Hat Enterprise Linux and some derivatives."
7553 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2235
7554 #: ../fish/guestfish-actions.pod:1655 ../fish/guestfish-actions.pod:1781
7559 #: ../src/guestfs-actions.pod:2085 ../fish/guestfish-actions.pod:1657
7561 "Windows does not have distributions. This string is returned if the OS type "
7566 #: ../src/guestfs-actions.pod:2088 ../src/guestfs-actions.pod:2239
7567 #: ../fish/guestfish-actions.pod:1660 ../fish/guestfish-actions.pod:1785
7572 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1662
7573 msgid "The distro could not be determined."
7577 #: ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:2245
7578 #: ../fish/guestfish-actions.pod:1666 ../fish/guestfish-actions.pod:1791
7580 "Future versions of libguestfs may return other strings here. The caller "
7581 "should be prepared to handle any string."
7585 #: ../src/guestfs-actions.pod:2102
7586 msgid "guestfs_inspect_get_filesystems"
7590 #: ../src/guestfs-actions.pod:2104
7593 " char **guestfs_inspect_get_filesystems (guestfs_h *g,\n"
7594 "\t\tconst char *root);\n"
7599 #: ../src/guestfs-actions.pod:2110 ../fish/guestfish-actions.pod:1678
7601 "This returns a list of all the filesystems that we think are associated with "
7602 "this operating system. This includes the root filesystem, other ordinary "
7603 "filesystems, and non-mounted devices like swap partitions."
7607 #: ../src/guestfs-actions.pod:2115 ../fish/guestfish-actions.pod:1683
7609 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
7610 "to be shared between operating systems."
7614 #: ../src/guestfs-actions.pod:2118
7616 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7617 "C<guestfs_inspect_get_mountpoints>."
7621 #: ../src/guestfs-actions.pod:2125
7622 msgid "guestfs_inspect_get_major_version"
7626 #: ../src/guestfs-actions.pod:2127
7629 " int guestfs_inspect_get_major_version (guestfs_h *g,\n"
7630 "\t\tconst char *root);\n"
7635 #: ../src/guestfs-actions.pod:2133 ../fish/guestfish-actions.pod:1696
7637 "This returns the major version number of the inspected operating system."
7641 #: ../src/guestfs-actions.pod:2136 ../fish/guestfish-actions.pod:1699
7643 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
7644 "popular public names used by the operating system. Notably the operating "
7645 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
7646 "1). You can find out the real versions corresponding to releases of Windows "
7647 "by consulting Wikipedia or MSDN."
7651 #: ../src/guestfs-actions.pod:2143 ../src/guestfs-actions.pod:2160
7652 #: ../fish/guestfish-actions.pod:1706 ../fish/guestfish-actions.pod:1720
7653 msgid "If the version could not be determined, then C<0> is returned."
7657 #: ../src/guestfs-actions.pod:2149
7658 msgid "guestfs_inspect_get_minor_version"
7662 #: ../src/guestfs-actions.pod:2151
7665 " int guestfs_inspect_get_minor_version (guestfs_h *g,\n"
7666 "\t\tconst char *root);\n"
7671 #: ../src/guestfs-actions.pod:2157 ../fish/guestfish-actions.pod:1717
7673 "This returns the minor version number of the inspected operating system."
7677 #: ../src/guestfs-actions.pod:2162
7679 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7680 "C<guestfs_inspect_get_major_version>."
7684 #: ../src/guestfs-actions.pod:2167
7685 msgid "guestfs_inspect_get_mountpoints"
7689 #: ../src/guestfs-actions.pod:2169
7692 " char **guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
7693 "\t\tconst char *root);\n"
7698 #: ../src/guestfs-actions.pod:2175 ../fish/guestfish-actions.pod:1732
7700 "This returns a hash of where we think the filesystems associated with this "
7701 "operating system should be mounted. Callers should note that this is at "
7702 "best an educated guess made by reading configuration files such as C</etc/"
7707 #: ../src/guestfs-actions.pod:2180 ../fish/guestfish-actions.pod:1737
7709 "Each element in the returned hashtable has a key which is the path of the "
7710 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
7711 "mounted there (eg. C</dev/sda1>)."
7715 #: ../src/guestfs-actions.pod:2185 ../fish/guestfish-actions.pod:1742
7717 "Non-mounted devices such as swap devices are I<not> returned in this list."
7721 #: ../src/guestfs-actions.pod:2188
7723 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7724 "C<guestfs_inspect_get_filesystems>."
7728 #: ../src/guestfs-actions.pod:2191 ../src/guestfs-actions.pod:2531
7729 #: ../src/guestfs-actions.pod:3453 ../src/guestfs-actions.pod:5036
7731 "This function returns a NULL-terminated array of strings, or NULL if there "
7732 "was an error. The array of strings will always have length C<2n+1>, where "
7733 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
7734 "caller must free the strings and the array after use>."
7738 #: ../src/guestfs-actions.pod:2197
7739 msgid "guestfs_inspect_get_product_name"
7743 #: ../src/guestfs-actions.pod:2199
7746 " char *guestfs_inspect_get_product_name (guestfs_h *g,\n"
7747 "\t\tconst char *root);\n"
7752 #: ../src/guestfs-actions.pod:2205 ../fish/guestfish-actions.pod:1755
7754 "This returns the product name of the inspected operating system. The "
7755 "product name is generally some freeform string which can be displayed to the "
7756 "user, but should not be parsed by programs."
7760 #: ../src/guestfs-actions.pod:2210 ../fish/guestfish-actions.pod:1760
7762 "If the product name could not be determined, then the string C<unknown> is "
7767 #: ../src/guestfs-actions.pod:2218
7768 msgid "guestfs_inspect_get_type"
7772 #: ../src/guestfs-actions.pod:2220
7775 " char *guestfs_inspect_get_type (guestfs_h *g,\n"
7776 "\t\tconst char *root);\n"
7781 #: ../src/guestfs-actions.pod:2226 ../fish/guestfish-actions.pod:1772
7783 "This returns the type of the inspected operating system. Currently defined "
7788 #: ../src/guestfs-actions.pod:2231 ../fish/guestfish-actions.pod:1777
7793 #: ../src/guestfs-actions.pod:2233 ../fish/guestfish-actions.pod:1779
7794 msgid "Any Linux-based operating system."
7798 #: ../src/guestfs-actions.pod:2237 ../fish/guestfish-actions.pod:1783
7799 msgid "Any Microsoft Windows operating system."
7803 #: ../src/guestfs-actions.pod:2241 ../fish/guestfish-actions.pod:1787
7804 msgid "The operating system type could not be determined."
7808 #: ../src/guestfs-actions.pod:2253
7809 msgid "guestfs_inspect_os"
7813 #: ../src/guestfs-actions.pod:2255
7816 " char **guestfs_inspect_os (guestfs_h *g);\n"
7821 #: ../src/guestfs-actions.pod:2257 ../fish/guestfish-actions.pod:1800
7823 "This function uses other libguestfs functions and certain heuristics to "
7824 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
7825 "for operating systems."
7829 #: ../src/guestfs-actions.pod:2261 ../fish/guestfish-actions.pod:1804
7830 msgid "The list returned is empty if no operating systems were found."
7834 #: ../src/guestfs-actions.pod:2263 ../fish/guestfish-actions.pod:1806
7836 "If one operating system was found, then this returns a list with a single "
7837 "element, which is the name of the root filesystem of this operating system. "
7838 "It is also possible for this function to return a list containing more than "
7839 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
7840 "element being the root filesystem of one of the operating systems."
7844 #: ../src/guestfs-actions.pod:2270
7846 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
7847 "functions in order to query further information about each operating system, "
7848 "such as the name and version."
7852 #: ../src/guestfs-actions.pod:2275
7854 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
7855 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
7856 "the contents. This should be called with no disks currently mounted. The "
7857 "function may also use Augeas, so any existing Augeas handle will be closed."
7861 #: ../src/guestfs-actions.pod:2281 ../fish/guestfish-actions.pod:1824
7863 "This function cannot decrypt encrypted disks. The caller must do that first "
7864 "(supplying the necessary keys) if the disk is encrypted."
7868 #: ../src/guestfs-actions.pod:2287 ../src/guestfs-actions.pod:2492
7869 #: ../src/guestfs-actions.pod:2548
7870 msgid "See also C<guestfs_list_filesystems>."
7874 #: ../src/guestfs-actions.pod:2293
7875 msgid "guestfs_is_blockdev"
7879 #: ../src/guestfs-actions.pod:2295
7882 " int guestfs_is_blockdev (guestfs_h *g,\n"
7883 "\t\tconst char *path);\n"
7888 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1836
7890 "This returns C<true> if and only if there is a block device with the given "
7895 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:2324
7896 #: ../src/guestfs-actions.pod:2348 ../src/guestfs-actions.pod:2360
7897 #: ../src/guestfs-actions.pod:2373 ../src/guestfs-actions.pod:2417
7898 #: ../src/guestfs-actions.pod:2429
7899 msgid "See also C<guestfs_stat>."
7903 #: ../src/guestfs-actions.pod:2305
7904 msgid "guestfs_is_busy"
7908 #: ../src/guestfs-actions.pod:2307
7911 " int guestfs_is_busy (guestfs_h *g);\n"
7916 #: ../src/guestfs-actions.pod:2309 ../fish/guestfish-actions.pod:1845
7918 "This returns true iff this handle is busy processing a command (in the "
7923 #: ../src/guestfs-actions.pod:2316
7924 msgid "guestfs_is_chardev"
7928 #: ../src/guestfs-actions.pod:2318
7931 " int guestfs_is_chardev (guestfs_h *g,\n"
7932 "\t\tconst char *path);\n"
7937 #: ../src/guestfs-actions.pod:2321 ../fish/guestfish-actions.pod:1854
7939 "This returns C<true> if and only if there is a character device with the "
7940 "given C<path> name."
7944 #: ../src/guestfs-actions.pod:2328
7945 msgid "guestfs_is_config"
7949 #: ../src/guestfs-actions.pod:2330
7952 " int guestfs_is_config (guestfs_h *g);\n"
7957 #: ../src/guestfs-actions.pod:2332 ../fish/guestfish-actions.pod:1863
7959 "This returns true iff this handle is being configured (in the C<CONFIG> "
7964 #: ../src/guestfs-actions.pod:2339
7965 msgid "guestfs_is_dir"
7969 #: ../src/guestfs-actions.pod:2341
7972 " int guestfs_is_dir (guestfs_h *g,\n"
7973 "\t\tconst char *path);\n"
7978 #: ../src/guestfs-actions.pod:2344 ../fish/guestfish-actions.pod:1872
7980 "This returns C<true> if and only if there is a directory with the given "
7981 "C<path> name. Note that it returns false for other objects like files."
7985 #: ../src/guestfs-actions.pod:2352
7986 msgid "guestfs_is_fifo"
7990 #: ../src/guestfs-actions.pod:2354
7993 " int guestfs_is_fifo (guestfs_h *g,\n"
7994 "\t\tconst char *path);\n"
7999 #: ../src/guestfs-actions.pod:2357 ../fish/guestfish-actions.pod:1882
8001 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
8002 "given C<path> name."
8006 #: ../src/guestfs-actions.pod:2364
8007 msgid "guestfs_is_file"
8011 #: ../src/guestfs-actions.pod:2366
8014 " int guestfs_is_file (guestfs_h *g,\n"
8015 "\t\tconst char *path);\n"
8020 #: ../src/guestfs-actions.pod:2369 ../fish/guestfish-actions.pod:1891
8022 "This returns C<true> if and only if there is a regular file with the given "
8023 "C<path> name. Note that it returns false for other objects like directories."
8027 #: ../src/guestfs-actions.pod:2377
8028 msgid "guestfs_is_launching"
8032 #: ../src/guestfs-actions.pod:2379
8035 " int guestfs_is_launching (guestfs_h *g);\n"
8040 #: ../src/guestfs-actions.pod:2381 ../fish/guestfish-actions.pod:1901
8042 "This returns true iff this handle is launching the subprocess (in the "
8043 "C<LAUNCHING> state)."
8047 #: ../src/guestfs-actions.pod:2388
8048 msgid "guestfs_is_lv"
8052 #: ../src/guestfs-actions.pod:2390
8055 " int guestfs_is_lv (guestfs_h *g,\n"
8056 "\t\tconst char *device);\n"
8061 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1910
8063 "This command tests whether C<device> is a logical volume, and returns true "
8064 "iff this is the case."
8068 #: ../src/guestfs-actions.pod:2398
8069 msgid "guestfs_is_ready"
8073 #: ../src/guestfs-actions.pod:2400
8076 " int guestfs_is_ready (guestfs_h *g);\n"
8081 #: ../src/guestfs-actions.pod:2402 ../fish/guestfish-actions.pod:1917
8083 "This returns true iff this handle is ready to accept commands (in the "
8088 #: ../src/guestfs-actions.pod:2409
8089 msgid "guestfs_is_socket"
8093 #: ../src/guestfs-actions.pod:2411
8096 " int guestfs_is_socket (guestfs_h *g,\n"
8097 "\t\tconst char *path);\n"
8102 #: ../src/guestfs-actions.pod:2414 ../fish/guestfish-actions.pod:1926
8104 "This returns C<true> if and only if there is a Unix domain socket with the "
8105 "given C<path> name."
8109 #: ../src/guestfs-actions.pod:2421
8110 msgid "guestfs_is_symlink"
8114 #: ../src/guestfs-actions.pod:2423
8117 " int guestfs_is_symlink (guestfs_h *g,\n"
8118 "\t\tconst char *path);\n"
8123 #: ../src/guestfs-actions.pod:2426 ../fish/guestfish-actions.pod:1935
8125 "This returns C<true> if and only if there is a symbolic link with the given "
8130 #: ../src/guestfs-actions.pod:2433
8131 msgid "guestfs_kill_subprocess"
8135 #: ../src/guestfs-actions.pod:2435
8138 " int guestfs_kill_subprocess (guestfs_h *g);\n"
8143 #: ../src/guestfs-actions.pod:2437 ../fish/guestfish-actions.pod:1944
8144 msgid "This kills the qemu subprocess. You should never need to call this."
8148 #: ../src/guestfs-actions.pod:2441
8149 msgid "guestfs_launch"
8153 #: ../src/guestfs-actions.pod:2443
8156 " int guestfs_launch (guestfs_h *g);\n"
8161 #: ../src/guestfs-actions.pod:2445 ../fish/guestfish-actions.pod:1952
8163 "Internally libguestfs is implemented by running a virtual machine using "
8168 #: ../src/guestfs-actions.pod:2448 ../fish/guestfish-actions.pod:1955
8170 "You should call this after configuring the handle (eg. adding drives) but "
8171 "before performing any actions."
8175 #: ../src/guestfs-actions.pod:2453
8176 msgid "guestfs_lchown"
8180 #: ../src/guestfs-actions.pod:2455
8183 " int guestfs_lchown (guestfs_h *g,\n"
8186 "\t\tconst char *path);\n"
8191 #: ../src/guestfs-actions.pod:2460
8193 "Change the file owner to C<owner> and group to C<group>. This is like "
8194 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
8195 "changed, not the target."
8199 #: ../src/guestfs-actions.pod:2470
8200 msgid "guestfs_lgetxattrs"
8204 #: ../src/guestfs-actions.pod:2472
8207 " struct guestfs_xattr_list *guestfs_lgetxattrs (guestfs_h *g,\n"
8208 "\t\tconst char *path);\n"
8213 #: ../src/guestfs-actions.pod:2475
8215 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
8216 "then it returns the extended attributes of the link itself."
8220 #: ../src/guestfs-actions.pod:2484
8221 msgid "guestfs_list_devices"
8225 #: ../src/guestfs-actions.pod:2486
8228 " char **guestfs_list_devices (guestfs_h *g);\n"
8233 #: ../src/guestfs-actions.pod:2488 ../fish/guestfish-actions.pod:1982
8234 msgid "List all the block devices."
8238 #: ../src/guestfs-actions.pod:2490 ../fish/guestfish-actions.pod:1984
8239 msgid "The full block device names are returned, eg. C</dev/sda>."
8243 #: ../src/guestfs-actions.pod:2498
8244 msgid "guestfs_list_filesystems"
8248 #: ../src/guestfs-actions.pod:2500
8251 " char **guestfs_list_filesystems (guestfs_h *g);\n"
8256 #: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1992
8258 "This inspection command looks for filesystems on partitions, block devices "
8259 "and logical volumes, returning a list of devices containing filesystems and "
8264 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1996
8266 "The return value is a hash, where the keys are the devices containing "
8267 "filesystems, and the values are the filesystem types. For example:"
8271 #: ../src/guestfs-actions.pod:2510 ../fish/guestfish-actions.pod:2000
8274 " \"/dev/sda1\" => \"ntfs\"\n"
8275 " \"/dev/sda2\" => \"ext2\"\n"
8276 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
8277 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
8282 #: ../src/guestfs-actions.pod:2515 ../fish/guestfish-actions.pod:2005
8284 "The value can have the special value \"unknown\", meaning the content of the "
8285 "device is undetermined or empty. \"swap\" means a Linux swap partition."
8289 #: ../src/guestfs-actions.pod:2519
8291 "This command runs other libguestfs commands, which might include "
8292 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
8293 "soon after launch and only when nothing is mounted."
8297 #: ../src/guestfs-actions.pod:2523
8299 "Not all of the filesystems returned will be mountable. In particular, swap "
8300 "partitions are returned in the list. Also this command does not check that "
8301 "each filesystem found is valid and mountable, and some filesystems might be "
8302 "mountable but require special options. Filesystems may not all belong to a "
8303 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
8307 #: ../src/guestfs-actions.pod:2537
8308 msgid "guestfs_list_partitions"
8312 #: ../src/guestfs-actions.pod:2539
8315 " char **guestfs_list_partitions (guestfs_h *g);\n"
8320 #: ../src/guestfs-actions.pod:2541 ../fish/guestfish-actions.pod:2025
8321 msgid "List all the partitions detected on all block devices."
8325 #: ../src/guestfs-actions.pod:2543 ../fish/guestfish-actions.pod:2027
8326 msgid "The full partition device names are returned, eg. C</dev/sda1>"
8330 #: ../src/guestfs-actions.pod:2545
8332 "This does not return logical volumes. For that you will need to call "
8337 #: ../src/guestfs-actions.pod:2554
8342 #: ../src/guestfs-actions.pod:2556
8345 " char *guestfs_ll (guestfs_h *g,\n"
8346 "\t\tconst char *directory);\n"
8351 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:2038
8353 "List the files in C<directory> (relative to the root directory, there is no "
8354 "cwd) in the format of 'ls -la'."
8358 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:2041
8360 "This command is mostly useful for interactive sessions. It is I<not> "
8361 "intended that you try to parse the output string."
8365 #: ../src/guestfs-actions.pod:2568
8370 #: ../src/guestfs-actions.pod:2570
8373 " int guestfs_ln (guestfs_h *g,\n"
8374 "\t\tconst char *target,\n"
8375 "\t\tconst char *linkname);\n"
8380 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:2048
8381 msgid "This command creates a hard link using the C<ln> command."
8385 #: ../src/guestfs-actions.pod:2578
8386 msgid "guestfs_ln_f"
8390 #: ../src/guestfs-actions.pod:2580
8393 " int guestfs_ln_f (guestfs_h *g,\n"
8394 "\t\tconst char *target,\n"
8395 "\t\tconst char *linkname);\n"
8400 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:2054
8402 "This command creates a hard link using the C<ln -f> command. The C<-f> "
8403 "option removes the link (C<linkname>) if it exists already."
8407 #: ../src/guestfs-actions.pod:2589
8408 msgid "guestfs_ln_s"
8412 #: ../src/guestfs-actions.pod:2591
8415 " int guestfs_ln_s (guestfs_h *g,\n"
8416 "\t\tconst char *target,\n"
8417 "\t\tconst char *linkname);\n"
8422 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:2061
8423 msgid "This command creates a symbolic link using the C<ln -s> command."
8427 #: ../src/guestfs-actions.pod:2599
8428 msgid "guestfs_ln_sf"
8432 #: ../src/guestfs-actions.pod:2601
8435 " int guestfs_ln_sf (guestfs_h *g,\n"
8436 "\t\tconst char *target,\n"
8437 "\t\tconst char *linkname);\n"
8442 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:2067
8444 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
8445 "option removes the link (C<linkname>) if it exists already."
8449 #: ../src/guestfs-actions.pod:2610
8450 msgid "guestfs_lremovexattr"
8454 #: ../src/guestfs-actions.pod:2612
8457 " int guestfs_lremovexattr (guestfs_h *g,\n"
8458 "\t\tconst char *xattr,\n"
8459 "\t\tconst char *path);\n"
8464 #: ../src/guestfs-actions.pod:2616
8466 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
8467 "link, then it removes an extended attribute of the link itself."
8471 #: ../src/guestfs-actions.pod:2622
8476 #: ../src/guestfs-actions.pod:2624
8479 " char **guestfs_ls (guestfs_h *g,\n"
8480 "\t\tconst char *directory);\n"
8485 #: ../src/guestfs-actions.pod:2627 ../fish/guestfish-actions.pod:2082
8487 "List the files in C<directory> (relative to the root directory, there is no "
8488 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
8492 #: ../src/guestfs-actions.pod:2631
8494 "This command is mostly useful for interactive sessions. Programs should "
8495 "probably use C<guestfs_readdir> instead."
8499 #: ../src/guestfs-actions.pod:2638
8500 msgid "guestfs_lsetxattr"
8504 #: ../src/guestfs-actions.pod:2640
8507 " int guestfs_lsetxattr (guestfs_h *g,\n"
8508 "\t\tconst char *xattr,\n"
8509 "\t\tconst char *val,\n"
8511 "\t\tconst char *path);\n"
8516 #: ../src/guestfs-actions.pod:2646
8518 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
8519 "then it sets an extended attribute of the link itself."
8523 #: ../src/guestfs-actions.pod:2652
8524 msgid "guestfs_lstat"
8528 #: ../src/guestfs-actions.pod:2654
8531 " struct guestfs_stat *guestfs_lstat (guestfs_h *g,\n"
8532 "\t\tconst char *path);\n"
8537 #: ../src/guestfs-actions.pod:2657 ../src/guestfs-actions.pod:4701
8538 #: ../fish/guestfish-actions.pod:2101 ../fish/guestfish-actions.pod:3655
8539 msgid "Returns file information for the given C<path>."
8543 #: ../src/guestfs-actions.pod:2659
8545 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
8546 "link, then the link is stat-ed, not the file it refers to."
8550 #: ../src/guestfs-actions.pod:2663 ../fish/guestfish-actions.pod:2107
8551 msgid "This is the same as the C<lstat(2)> system call."
8555 #: ../src/guestfs-actions.pod:2665 ../src/guestfs-actions.pod:4705
8557 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
8558 "error. I<The caller must call C<guestfs_free_stat> after use>."
8562 #: ../src/guestfs-actions.pod:2669
8563 msgid "guestfs_lstatlist"
8567 #: ../src/guestfs-actions.pod:2671
8570 " struct guestfs_stat_list *guestfs_lstatlist (guestfs_h *g,\n"
8571 "\t\tconst char *path,\n"
8572 "\t\tchar *const *names);\n"
8577 #: ../src/guestfs-actions.pod:2675
8579 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
8580 "files, where all files are in the directory C<path>. C<names> is the list "
8581 "of files from this directory."
8585 #: ../src/guestfs-actions.pod:2679 ../fish/guestfish-actions.pod:2117
8587 "On return you get a list of stat structs, with a one-to-one correspondence "
8588 "to the C<names> list. If any name did not exist or could not be lstat'd, "
8589 "then the C<ino> field of that structure is set to C<-1>."
8593 #: ../src/guestfs-actions.pod:2684
8595 "This call is intended for programs that want to efficiently list a directory "
8596 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
8597 "for a similarly efficient call for getting extended attributes. Very long "
8598 "directory listings might cause the protocol message size to be exceeded, "
8599 "causing this call to fail. The caller must split up such requests into "
8600 "smaller groups of names."
8604 #: ../src/guestfs-actions.pod:2692
8606 "This function returns a C<struct guestfs_stat_list *> (see E<lt>guestfs-"
8607 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
8608 "C<guestfs_free_stat_list> after use>."
8612 #: ../src/guestfs-actions.pod:2697
8613 msgid "guestfs_luks_add_key"
8617 #: ../src/guestfs-actions.pod:2699
8620 " int guestfs_luks_add_key (guestfs_h *g,\n"
8621 "\t\tconst char *device,\n"
8622 "\t\tconst char *key,\n"
8623 "\t\tconst char *newkey,\n"
8624 "\t\tint keyslot);\n"
8629 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:2134
8631 "This command adds a new key on LUKS device C<device>. C<key> is any "
8632 "existing key, and is used to access the device. C<newkey> is the new key to "
8633 "add. C<keyslot> is the key slot that will be replaced."
8637 #: ../src/guestfs-actions.pod:2710
8639 "Note that if C<keyslot> already contains a key, then this command will "
8640 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
8644 #: ../src/guestfs-actions.pod:2716 ../src/guestfs-actions.pod:2750
8645 #: ../src/guestfs-actions.pod:2770 ../src/guestfs-actions.pod:2787
8646 #: ../src/guestfs-actions.pod:2816 ../src/guestfs-actions.pod:2832
8648 "This function takes a key or passphrase parameter which could contain "
8649 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
8654 #: ../src/guestfs-actions.pod:2720
8655 msgid "guestfs_luks_close"
8659 #: ../src/guestfs-actions.pod:2722
8662 " int guestfs_luks_close (guestfs_h *g,\n"
8663 "\t\tconst char *device);\n"
8668 #: ../src/guestfs-actions.pod:2725
8670 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
8671 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
8672 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
8673 "underlying block device."
8677 #: ../src/guestfs-actions.pod:2733
8678 msgid "guestfs_luks_format"
8682 #: ../src/guestfs-actions.pod:2735
8685 " int guestfs_luks_format (guestfs_h *g,\n"
8686 "\t\tconst char *device,\n"
8687 "\t\tconst char *key,\n"
8688 "\t\tint keyslot);\n"
8693 #: ../src/guestfs-actions.pod:2740 ../fish/guestfish-actions.pod:2160
8695 "This command erases existing data on C<device> and formats the device as a "
8696 "LUKS encrypted device. C<key> is the initial key, which is added to key "
8697 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
8701 #: ../src/guestfs-actions.pod:2747 ../src/guestfs-actions.pod:2767
8702 #: ../src/guestfs-actions.pod:2869 ../src/guestfs-actions.pod:3581
8703 #: ../src/guestfs-actions.pod:4242 ../src/guestfs-actions.pod:4563
8704 #: ../src/guestfs-actions.pod:4583 ../src/guestfs-actions.pod:4606
8705 #: ../src/guestfs-actions.pod:5571 ../fish/guestfish-actions.pod:2168
8706 #: ../fish/guestfish-actions.pod:2181 ../fish/guestfish-actions.pod:2252
8707 #: ../fish/guestfish-actions.pod:2767 ../fish/guestfish-actions.pod:3274
8708 #: ../fish/guestfish-actions.pod:3554 ../fish/guestfish-actions.pod:3570
8709 #: ../fish/guestfish-actions.pod:3585 ../fish/guestfish-actions.pod:4300
8711 "B<This command is dangerous. Without careful use you can easily destroy all "
8716 #: ../src/guestfs-actions.pod:2754
8717 msgid "guestfs_luks_format_cipher"
8721 #: ../src/guestfs-actions.pod:2756
8724 " int guestfs_luks_format_cipher (guestfs_h *g,\n"
8725 "\t\tconst char *device,\n"
8726 "\t\tconst char *key,\n"
8727 "\t\tint keyslot,\n"
8728 "\t\tconst char *cipher);\n"
8733 #: ../src/guestfs-actions.pod:2762
8735 "This command is the same as C<guestfs_luks_format> but it also allows you to "
8736 "set the C<cipher> used."
8740 #: ../src/guestfs-actions.pod:2774
8741 msgid "guestfs_luks_kill_slot"
8745 #: ../src/guestfs-actions.pod:2776
8748 " int guestfs_luks_kill_slot (guestfs_h *g,\n"
8749 "\t\tconst char *device,\n"
8750 "\t\tconst char *key,\n"
8751 "\t\tint keyslot);\n"
8756 #: ../src/guestfs-actions.pod:2781 ../fish/guestfish-actions.pod:2188
8758 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
8759 "device C<device>. C<key> must be one of the I<other> keys."
8763 #: ../src/guestfs-actions.pod:2791
8764 msgid "guestfs_luks_open"
8768 #: ../src/guestfs-actions.pod:2793
8771 " int guestfs_luks_open (guestfs_h *g,\n"
8772 "\t\tconst char *device,\n"
8773 "\t\tconst char *key,\n"
8774 "\t\tconst char *mapname);\n"
8779 #: ../src/guestfs-actions.pod:2798 ../fish/guestfish-actions.pod:2199
8781 "This command opens a block device which has been encrypted according to the "
8782 "Linux Unified Key Setup (LUKS) standard."
8786 #: ../src/guestfs-actions.pod:2801 ../fish/guestfish-actions.pod:2202
8787 msgid "C<device> is the encrypted block device or partition."
8791 #: ../src/guestfs-actions.pod:2803 ../fish/guestfish-actions.pod:2204
8793 "The caller must supply one of the keys associated with the LUKS block "
8794 "device, in the C<key> parameter."
8798 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:2207
8800 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
8801 "writes to this block device are decrypted from and encrypted to the "
8802 "underlying C<device> respectively."
8806 #: ../src/guestfs-actions.pod:2810
8808 "If this block device contains LVM volume groups, then calling "
8809 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
8814 #: ../src/guestfs-actions.pod:2820
8815 msgid "guestfs_luks_open_ro"
8819 #: ../src/guestfs-actions.pod:2822
8822 " int guestfs_luks_open_ro (guestfs_h *g,\n"
8823 "\t\tconst char *device,\n"
8824 "\t\tconst char *key,\n"
8825 "\t\tconst char *mapname);\n"
8830 #: ../src/guestfs-actions.pod:2827
8832 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
8837 #: ../src/guestfs-actions.pod:2836
8838 msgid "guestfs_lvcreate"
8842 #: ../src/guestfs-actions.pod:2838
8845 " int guestfs_lvcreate (guestfs_h *g,\n"
8846 "\t\tconst char *logvol,\n"
8847 "\t\tconst char *volgroup,\n"
8848 "\t\tint mbytes);\n"
8853 #: ../src/guestfs-actions.pod:2843 ../fish/guestfish-actions.pod:2232
8855 "This creates an LVM logical volume called C<logvol> on the volume group "
8856 "C<volgroup>, with C<size> megabytes."
8860 #: ../src/guestfs-actions.pod:2848
8861 msgid "guestfs_lvm_clear_filter"
8865 #: ../src/guestfs-actions.pod:2850
8868 " int guestfs_lvm_clear_filter (guestfs_h *g);\n"
8873 #: ../src/guestfs-actions.pod:2852
8875 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
8876 "see every block device."
8880 #: ../src/guestfs-actions.pod:2855 ../src/guestfs-actions.pod:2891
8881 #: ../fish/guestfish-actions.pod:2242 ../fish/guestfish-actions.pod:2273
8883 "This command also clears the LVM cache and performs a volume group scan."
8887 #: ../src/guestfs-actions.pod:2860
8888 msgid "guestfs_lvm_remove_all"
8892 #: ../src/guestfs-actions.pod:2862
8895 " int guestfs_lvm_remove_all (guestfs_h *g);\n"
8900 #: ../src/guestfs-actions.pod:2864 ../fish/guestfish-actions.pod:2249
8902 "This command removes all LVM logical volumes, volume groups and physical "
8907 #: ../src/guestfs-actions.pod:2872
8908 msgid "guestfs_lvm_set_filter"
8912 #: ../src/guestfs-actions.pod:2874
8915 " int guestfs_lvm_set_filter (guestfs_h *g,\n"
8916 "\t\tchar *const *devices);\n"
8921 #: ../src/guestfs-actions.pod:2877 ../fish/guestfish-actions.pod:2259
8923 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
8924 "block devices in the list C<devices>, and will ignore all other attached "
8929 #: ../src/guestfs-actions.pod:2881 ../fish/guestfish-actions.pod:2263
8931 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
8932 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
8933 "there are two types of duplication possible: either cloned PVs/VGs which "
8934 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
8935 "same name. In normal operation you cannot create this situation, but you "
8936 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
8937 "inside the LVM metadata."
8941 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:2276
8942 msgid "You can filter whole block devices or individual partitions."
8946 #: ../src/guestfs-actions.pod:2896 ../fish/guestfish-actions.pod:2278
8948 "You cannot use this if any VG is currently in use (eg. contains a mounted "
8949 "filesystem), even if you are not filtering out that VG."
8953 #: ../src/guestfs-actions.pod:2902
8954 msgid "guestfs_lvremove"
8958 #: ../src/guestfs-actions.pod:2904
8961 " int guestfs_lvremove (guestfs_h *g,\n"
8962 "\t\tconst char *device);\n"
8967 #: ../src/guestfs-actions.pod:2907 ../fish/guestfish-actions.pod:2286
8969 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
8970 "LV, such as C</dev/VG/LV>."
8974 #: ../src/guestfs-actions.pod:2910 ../fish/guestfish-actions.pod:2289
8976 "You can also remove all LVs in a volume group by specifying the VG name, C</"
8981 #: ../src/guestfs-actions.pod:2915
8982 msgid "guestfs_lvrename"
8986 #: ../src/guestfs-actions.pod:2917
8989 " int guestfs_lvrename (guestfs_h *g,\n"
8990 "\t\tconst char *logvol,\n"
8991 "\t\tconst char *newlogvol);\n"
8996 #: ../src/guestfs-actions.pod:2921 ../fish/guestfish-actions.pod:2296
8997 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
9001 #: ../src/guestfs-actions.pod:2925
9002 msgid "guestfs_lvresize"
9006 #: ../src/guestfs-actions.pod:2927
9009 " int guestfs_lvresize (guestfs_h *g,\n"
9010 "\t\tconst char *device,\n"
9011 "\t\tint mbytes);\n"
9016 #: ../src/guestfs-actions.pod:2931 ../fish/guestfish-actions.pod:2302
9018 "This resizes (expands or shrinks) an existing LVM logical volume to "
9019 "C<mbytes>. When reducing, data in the reduced part is lost."
9023 #: ../src/guestfs-actions.pod:2937
9024 msgid "guestfs_lvresize_free"
9028 #: ../src/guestfs-actions.pod:2939
9031 " int guestfs_lvresize_free (guestfs_h *g,\n"
9032 "\t\tconst char *lv,\n"
9033 "\t\tint percent);\n"
9038 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2310
9040 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
9041 "remaining free space in the volume group. Commonly you would call this with "
9042 "pc = 100 which expands the logical volume as much as possible, using all "
9043 "remaining free space in the volume group."
9047 #: ../src/guestfs-actions.pod:2951
9052 #: ../src/guestfs-actions.pod:2953
9055 " char **guestfs_lvs (guestfs_h *g);\n"
9060 #: ../src/guestfs-actions.pod:2955 ../fish/guestfish-actions.pod:2320
9062 "List all the logical volumes detected. This is the equivalent of the L<lvs"
9067 #: ../src/guestfs-actions.pod:2958 ../fish/guestfish-actions.pod:2323
9069 "This returns a list of the logical volume device names (eg. C</dev/"
9070 "VolGroup00/LogVol00>)."
9074 #: ../src/guestfs-actions.pod:2961
9075 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
9079 #: ../src/guestfs-actions.pod:2967
9080 msgid "guestfs_lvs_full"
9084 #: ../src/guestfs-actions.pod:2969
9087 " struct guestfs_lvm_lv_list *guestfs_lvs_full (guestfs_h *g);\n"
9092 #: ../src/guestfs-actions.pod:2971 ../fish/guestfish-actions.pod:2332
9094 "List all the logical volumes detected. This is the equivalent of the L<lvs"
9095 "(8)> command. The \"full\" version includes all fields."
9099 #: ../src/guestfs-actions.pod:2974
9101 "This function returns a C<struct guestfs_lvm_lv_list *> (see E<lt>guestfs-"
9102 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
9103 "C<guestfs_free_lvm_lv_list> after use>."
9107 #: ../src/guestfs-actions.pod:2979
9108 msgid "guestfs_lvuuid"
9112 #: ../src/guestfs-actions.pod:2981
9115 " char *guestfs_lvuuid (guestfs_h *g,\n"
9116 "\t\tconst char *device);\n"
9121 #: ../src/guestfs-actions.pod:2984 ../fish/guestfish-actions.pod:2339
9122 msgid "This command returns the UUID of the LVM LV C<device>."
9126 #: ../src/guestfs-actions.pod:2989
9127 msgid "guestfs_lxattrlist"
9131 #: ../src/guestfs-actions.pod:2991
9134 " struct guestfs_xattr_list *guestfs_lxattrlist (guestfs_h *g,\n"
9135 "\t\tconst char *path,\n"
9136 "\t\tchar *const *names);\n"
9141 #: ../src/guestfs-actions.pod:2995 ../fish/guestfish-actions.pod:2345
9143 "This call allows you to get the extended attributes of multiple files, where "
9144 "all files are in the directory C<path>. C<names> is the list of files from "
9149 #: ../src/guestfs-actions.pod:2999 ../fish/guestfish-actions.pod:2349
9151 "On return you get a flat list of xattr structs which must be interpreted "
9152 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
9153 "C<attrval> in this struct is zero-length to indicate there was an error "
9154 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
9155 "number (the number of following attributes for this file, which could be C<"
9156 "\"0\">). Then after the first xattr struct are the zero or more attributes "
9157 "for the first named file. This repeats for the second and subsequent files."
9161 #: ../src/guestfs-actions.pod:3009
9163 "This call is intended for programs that want to efficiently list a directory "
9164 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
9165 "a similarly efficient call for getting standard stats. Very long directory "
9166 "listings might cause the protocol message size to be exceeded, causing this "
9167 "call to fail. The caller must split up such requests into smaller groups of "
9172 #: ../src/guestfs-actions.pod:3022
9173 msgid "guestfs_mkdir"
9177 #: ../src/guestfs-actions.pod:3024
9180 " int guestfs_mkdir (guestfs_h *g,\n"
9181 "\t\tconst char *path);\n"
9186 #: ../src/guestfs-actions.pod:3027 ../fish/guestfish-actions.pod:2371
9187 msgid "Create a directory named C<path>."
9191 #: ../src/guestfs-actions.pod:3031
9192 msgid "guestfs_mkdir_mode"
9196 #: ../src/guestfs-actions.pod:3033
9199 " int guestfs_mkdir_mode (guestfs_h *g,\n"
9200 "\t\tconst char *path,\n"
9206 #: ../src/guestfs-actions.pod:3037 ../fish/guestfish-actions.pod:2377
9208 "This command creates a directory, setting the initial permissions of the "
9209 "directory to C<mode>."
9213 #: ../src/guestfs-actions.pod:3040 ../fish/guestfish-actions.pod:2380
9215 "For common Linux filesystems, the actual mode which is set will be C<mode & "
9216 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
9221 #: ../src/guestfs-actions.pod:3044
9222 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
9226 #: ../src/guestfs-actions.pod:3048
9227 msgid "guestfs_mkdir_p"
9231 #: ../src/guestfs-actions.pod:3050
9234 " int guestfs_mkdir_p (guestfs_h *g,\n"
9235 "\t\tconst char *path);\n"
9240 #: ../src/guestfs-actions.pod:3053 ../fish/guestfish-actions.pod:2390
9242 "Create a directory named C<path>, creating any parent directories as "
9243 "necessary. This is like the C<mkdir -p> shell command."
9247 #: ../src/guestfs-actions.pod:3058
9248 msgid "guestfs_mkdtemp"
9252 #: ../src/guestfs-actions.pod:3060
9255 " char *guestfs_mkdtemp (guestfs_h *g,\n"
9256 "\t\tconst char *template);\n"
9261 #: ../src/guestfs-actions.pod:3063 ../fish/guestfish-actions.pod:2397
9263 "This command creates a temporary directory. The C<template> parameter "
9264 "should be a full pathname for the temporary directory name with the final "
9265 "six characters being \"XXXXXX\"."
9269 #: ../src/guestfs-actions.pod:3068 ../fish/guestfish-actions.pod:2402
9271 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
9272 "being suitable for Windows filesystems."
9276 #: ../src/guestfs-actions.pod:3071 ../fish/guestfish-actions.pod:2405
9277 msgid "The name of the temporary directory that was created is returned."
9281 #: ../src/guestfs-actions.pod:3074 ../fish/guestfish-actions.pod:2408
9282 msgid "The temporary directory is created with mode 0700 and is owned by root."
9286 #: ../src/guestfs-actions.pod:3077 ../fish/guestfish-actions.pod:2411
9288 "The caller is responsible for deleting the temporary directory and its "
9289 "contents after use."
9293 #: ../src/guestfs-actions.pod:3080 ../fish/guestfish-actions.pod:2414
9294 msgid "See also: L<mkdtemp(3)>"
9298 #: ../src/guestfs-actions.pod:3085
9299 msgid "guestfs_mke2fs_J"
9303 #: ../src/guestfs-actions.pod:3087
9306 " int guestfs_mke2fs_J (guestfs_h *g,\n"
9307 "\t\tconst char *fstype,\n"
9308 "\t\tint blocksize,\n"
9309 "\t\tconst char *device,\n"
9310 "\t\tconst char *journal);\n"
9315 #: ../src/guestfs-actions.pod:3093 ../fish/guestfish-actions.pod:2420
9317 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
9318 "C<journal>. It is equivalent to the command:"
9322 #: ../src/guestfs-actions.pod:3097 ../fish/guestfish-actions.pod:2424
9325 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
9330 #: ../src/guestfs-actions.pod:3099
9331 msgid "See also C<guestfs_mke2journal>."
9335 #: ../src/guestfs-actions.pod:3103
9336 msgid "guestfs_mke2fs_JL"
9340 #: ../src/guestfs-actions.pod:3105
9343 " int guestfs_mke2fs_JL (guestfs_h *g,\n"
9344 "\t\tconst char *fstype,\n"
9345 "\t\tint blocksize,\n"
9346 "\t\tconst char *device,\n"
9347 "\t\tconst char *label);\n"
9352 #: ../src/guestfs-actions.pod:3111 ../fish/guestfish-actions.pod:2432
9354 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
9355 "the journal labeled C<label>."
9359 #: ../src/guestfs-actions.pod:3114
9360 msgid "See also C<guestfs_mke2journal_L>."
9364 #: ../src/guestfs-actions.pod:3118
9365 msgid "guestfs_mke2fs_JU"
9369 #: ../src/guestfs-actions.pod:3120
9372 " int guestfs_mke2fs_JU (guestfs_h *g,\n"
9373 "\t\tconst char *fstype,\n"
9374 "\t\tint blocksize,\n"
9375 "\t\tconst char *device,\n"
9376 "\t\tconst char *uuid);\n"
9381 #: ../src/guestfs-actions.pod:3126 ../fish/guestfish-actions.pod:2441
9383 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
9384 "the journal with UUID C<uuid>."
9388 #: ../src/guestfs-actions.pod:3129
9389 msgid "See also C<guestfs_mke2journal_U>."
9393 #: ../src/guestfs-actions.pod:3133
9394 msgid "guestfs_mke2journal"
9398 #: ../src/guestfs-actions.pod:3135
9401 " int guestfs_mke2journal (guestfs_h *g,\n"
9402 "\t\tint blocksize,\n"
9403 "\t\tconst char *device);\n"
9408 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2450
9410 "This creates an ext2 external journal on C<device>. It is equivalent to the "
9415 #: ../src/guestfs-actions.pod:3142 ../fish/guestfish-actions.pod:2453
9418 " mke2fs -O journal_dev -b blocksize device\n"
9423 #: ../src/guestfs-actions.pod:3146
9424 msgid "guestfs_mke2journal_L"
9428 #: ../src/guestfs-actions.pod:3148
9431 " int guestfs_mke2journal_L (guestfs_h *g,\n"
9432 "\t\tint blocksize,\n"
9433 "\t\tconst char *label,\n"
9434 "\t\tconst char *device);\n"
9439 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2459
9440 msgid "This creates an ext2 external journal on C<device> with label C<label>."
9444 #: ../src/guestfs-actions.pod:3157
9445 msgid "guestfs_mke2journal_U"
9449 #: ../src/guestfs-actions.pod:3159
9452 " int guestfs_mke2journal_U (guestfs_h *g,\n"
9453 "\t\tint blocksize,\n"
9454 "\t\tconst char *uuid,\n"
9455 "\t\tconst char *device);\n"
9460 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2465
9461 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
9465 #: ../src/guestfs-actions.pod:3168
9466 msgid "guestfs_mkfifo"
9470 #: ../src/guestfs-actions.pod:3170
9473 " int guestfs_mkfifo (guestfs_h *g,\n"
9475 "\t\tconst char *path);\n"
9480 #: ../src/guestfs-actions.pod:3174
9482 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
9483 "is just a convenient wrapper around C<guestfs_mknod>."
9487 #: ../src/guestfs-actions.pod:3182
9488 msgid "guestfs_mkfs"
9492 #: ../src/guestfs-actions.pod:3184
9495 " int guestfs_mkfs (guestfs_h *g,\n"
9496 "\t\tconst char *fstype,\n"
9497 "\t\tconst char *device);\n"
9502 #: ../src/guestfs-actions.pod:3188 ../fish/guestfish-actions.pod:2481
9504 "This creates a filesystem on C<device> (usually a partition or LVM logical "
9505 "volume). The filesystem type is C<fstype>, for example C<ext3>."
9509 #: ../src/guestfs-actions.pod:3194
9510 msgid "guestfs_mkfs_b"
9514 #: ../src/guestfs-actions.pod:3196
9517 " int guestfs_mkfs_b (guestfs_h *g,\n"
9518 "\t\tconst char *fstype,\n"
9519 "\t\tint blocksize,\n"
9520 "\t\tconst char *device);\n"
9525 #: ../src/guestfs-actions.pod:3201
9527 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
9528 "block size of the resulting filesystem. Supported block sizes depend on the "
9529 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
9533 #: ../src/guestfs-actions.pod:3206 ../fish/guestfish-actions.pod:2494
9535 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
9540 #: ../src/guestfs-actions.pod:3211
9541 msgid "guestfs_mkmountpoint"
9545 #: ../src/guestfs-actions.pod:3213
9548 " int guestfs_mkmountpoint (guestfs_h *g,\n"
9549 "\t\tconst char *exemptpath);\n"
9554 #: ../src/guestfs-actions.pod:3216
9556 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
9557 "that can be used to create extra mountpoints before mounting the first "
9562 #: ../src/guestfs-actions.pod:3220 ../fish/guestfish-actions.pod:2505
9564 "These calls are I<only> necessary in some very limited circumstances, mainly "
9565 "the case where you want to mount a mix of unrelated and/or read-only "
9566 "filesystems together."
9570 #: ../src/guestfs-actions.pod:3224 ../fish/guestfish-actions.pod:2509
9572 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
9573 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
9574 "inside that. You can unpack this as follows in guestfish:"
9578 #: ../src/guestfs-actions.pod:3229 ../fish/guestfish-actions.pod:2514
9581 " add-ro Fedora-11-i686-Live.iso\n"
9583 " mkmountpoint /cd\n"
9584 " mkmountpoint /squash\n"
9585 " mkmountpoint /ext3\n"
9586 " mount /dev/sda /cd\n"
9587 " mount-loop /cd/LiveOS/squashfs.img /squash\n"
9588 " mount-loop /squash/LiveOS/ext3fs.img /ext3\n"
9593 #: ../src/guestfs-actions.pod:3238 ../fish/guestfish-actions.pod:2523
9594 msgid "The inner filesystem is now unpacked under the /ext3 mountpoint."
9598 #: ../src/guestfs-actions.pod:3242
9599 msgid "guestfs_mknod"
9603 #: ../src/guestfs-actions.pod:3244
9606 " int guestfs_mknod (guestfs_h *g,\n"
9608 "\t\tint devmajor,\n"
9609 "\t\tint devminor,\n"
9610 "\t\tconst char *path);\n"
9615 #: ../src/guestfs-actions.pod:3250 ../fish/guestfish-actions.pod:2529
9617 "This call creates block or character special devices, or named pipes (FIFOs)."
9621 #: ../src/guestfs-actions.pod:3253 ../fish/guestfish-actions.pod:2532
9623 "The C<mode> parameter should be the mode, using the standard constants. "
9624 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
9625 "used when creating block and character special devices."
9629 #: ../src/guestfs-actions.pod:3258
9631 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
9632 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
9633 "regular file). These constants are available in the standard Linux header "
9634 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
9635 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
9636 "the appropriate constant for you."
9640 #: ../src/guestfs-actions.pod:3270
9641 msgid "guestfs_mknod_b"
9645 #: ../src/guestfs-actions.pod:3272
9648 " int guestfs_mknod_b (guestfs_h *g,\n"
9650 "\t\tint devmajor,\n"
9651 "\t\tint devminor,\n"
9652 "\t\tconst char *path);\n"
9657 #: ../src/guestfs-actions.pod:3278
9659 "This call creates a block device node called C<path> with mode C<mode> and "
9660 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
9661 "wrapper around C<guestfs_mknod>."
9665 #: ../src/guestfs-actions.pod:3286
9666 msgid "guestfs_mknod_c"
9670 #: ../src/guestfs-actions.pod:3288
9673 " int guestfs_mknod_c (guestfs_h *g,\n"
9675 "\t\tint devmajor,\n"
9676 "\t\tint devminor,\n"
9677 "\t\tconst char *path);\n"
9682 #: ../src/guestfs-actions.pod:3294
9684 "This call creates a char device node called C<path> with mode C<mode> and "
9685 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
9686 "wrapper around C<guestfs_mknod>."
9690 #: ../src/guestfs-actions.pod:3302
9691 msgid "guestfs_mkswap"
9695 #: ../src/guestfs-actions.pod:3304
9698 " int guestfs_mkswap (guestfs_h *g,\n"
9699 "\t\tconst char *device);\n"
9704 #: ../src/guestfs-actions.pod:3307 ../fish/guestfish-actions.pod:2571
9705 msgid "Create a swap partition on C<device>."
9709 #: ../src/guestfs-actions.pod:3311
9710 msgid "guestfs_mkswap_L"
9714 #: ../src/guestfs-actions.pod:3313
9717 " int guestfs_mkswap_L (guestfs_h *g,\n"
9718 "\t\tconst char *label,\n"
9719 "\t\tconst char *device);\n"
9724 #: ../src/guestfs-actions.pod:3317 ../fish/guestfish-actions.pod:2577
9725 msgid "Create a swap partition on C<device> with label C<label>."
9729 #: ../src/guestfs-actions.pod:3319 ../fish/guestfish-actions.pod:2579
9731 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
9732 "sda>), just to a partition. This appears to be a limitation of the kernel "
9737 #: ../src/guestfs-actions.pod:3325
9738 msgid "guestfs_mkswap_U"
9742 #: ../src/guestfs-actions.pod:3327
9745 " int guestfs_mkswap_U (guestfs_h *g,\n"
9746 "\t\tconst char *uuid,\n"
9747 "\t\tconst char *device);\n"
9752 #: ../src/guestfs-actions.pod:3331 ../fish/guestfish-actions.pod:2587
9753 msgid "Create a swap partition on C<device> with UUID C<uuid>."
9757 #: ../src/guestfs-actions.pod:3335
9758 msgid "guestfs_mkswap_file"
9762 #: ../src/guestfs-actions.pod:3337
9765 " int guestfs_mkswap_file (guestfs_h *g,\n"
9766 "\t\tconst char *path);\n"
9771 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2593
9772 msgid "Create a swap file."
9776 #: ../src/guestfs-actions.pod:3342
9778 "This command just writes a swap file signature to an existing file. To "
9779 "create the file itself, use something like C<guestfs_fallocate>."
9783 #: ../src/guestfs-actions.pod:3347
9784 msgid "guestfs_modprobe"
9788 #: ../src/guestfs-actions.pod:3349
9791 " int guestfs_modprobe (guestfs_h *g,\n"
9792 "\t\tconst char *modulename);\n"
9797 #: ../src/guestfs-actions.pod:3352 ../fish/guestfish-actions.pod:2602
9798 msgid "This loads a kernel module in the appliance."
9802 #: ../src/guestfs-actions.pod:3354 ../fish/guestfish-actions.pod:2604
9804 "The kernel module must have been whitelisted when libguestfs was built (see "
9805 "C<appliance/kmod.whitelist.in> in the source)."
9809 #: ../src/guestfs-actions.pod:3359
9810 msgid "guestfs_mount"
9814 #: ../src/guestfs-actions.pod:3361
9817 " int guestfs_mount (guestfs_h *g,\n"
9818 "\t\tconst char *device,\n"
9819 "\t\tconst char *mountpoint);\n"
9824 #: ../src/guestfs-actions.pod:3365 ../fish/guestfish-actions.pod:2611
9826 "Mount a guest disk at a position in the filesystem. Block devices are named "
9827 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
9828 "those block devices contain partitions, they will have the usual names (eg. "
9829 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
9833 #: ../src/guestfs-actions.pod:3371 ../fish/guestfish-actions.pod:2617
9835 "The rules are the same as for L<mount(2)>: A filesystem must first be "
9836 "mounted on C</> before others can be mounted. Other filesystems can only be "
9837 "mounted on directories which already exist."
9841 #: ../src/guestfs-actions.pod:3376 ../fish/guestfish-actions.pod:2622
9843 "The mounted filesystem is writable, if we have sufficient permissions on the "
9844 "underlying device."
9848 #: ../src/guestfs-actions.pod:3379
9850 "B<Important note:> When you use this call, the filesystem options C<sync> "
9851 "and C<noatime> are set implicitly. This was originally done because we "
9852 "thought it would improve reliability, but it turns out that I<-o sync> has a "
9853 "very large negative performance impact and negligible effect on "
9854 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
9855 "in any code that needs performance, and instead use C<guestfs_mount_options> "
9856 "(use an empty string for the first parameter if you don't want any options)."
9860 #: ../src/guestfs-actions.pod:3391
9861 msgid "guestfs_mount_loop"
9865 #: ../src/guestfs-actions.pod:3393
9868 " int guestfs_mount_loop (guestfs_h *g,\n"
9869 "\t\tconst char *file,\n"
9870 "\t\tconst char *mountpoint);\n"
9875 #: ../src/guestfs-actions.pod:3397 ../fish/guestfish-actions.pod:2639
9877 "This command lets you mount C<file> (a filesystem image in a file) on a "
9878 "mount point. It is entirely equivalent to the command C<mount -o loop file "
9883 #: ../src/guestfs-actions.pod:3403
9884 msgid "guestfs_mount_options"
9888 #: ../src/guestfs-actions.pod:3405
9891 " int guestfs_mount_options (guestfs_h *g,\n"
9892 "\t\tconst char *options,\n"
9893 "\t\tconst char *device,\n"
9894 "\t\tconst char *mountpoint);\n"
9899 #: ../src/guestfs-actions.pod:3410
9901 "This is the same as the C<guestfs_mount> command, but it allows you to set "
9902 "the mount options as for the L<mount(8)> I<-o> flag."
9906 #: ../src/guestfs-actions.pod:3414 ../fish/guestfish-actions.pod:2651
9908 "If the C<options> parameter is an empty string, then no options are passed "
9909 "(all options default to whatever the filesystem uses)."
9913 #: ../src/guestfs-actions.pod:3420
9914 msgid "guestfs_mount_ro"
9918 #: ../src/guestfs-actions.pod:3422
9921 " int guestfs_mount_ro (guestfs_h *g,\n"
9922 "\t\tconst char *device,\n"
9923 "\t\tconst char *mountpoint);\n"
9928 #: ../src/guestfs-actions.pod:3426
9930 "This is the same as the C<guestfs_mount> command, but it mounts the "
9931 "filesystem with the read-only (I<-o ro>) flag."
9935 #: ../src/guestfs-actions.pod:3431
9936 msgid "guestfs_mount_vfs"
9940 #: ../src/guestfs-actions.pod:3433
9943 " int guestfs_mount_vfs (guestfs_h *g,\n"
9944 "\t\tconst char *options,\n"
9945 "\t\tconst char *vfstype,\n"
9946 "\t\tconst char *device,\n"
9947 "\t\tconst char *mountpoint);\n"
9952 #: ../src/guestfs-actions.pod:3439
9954 "This is the same as the C<guestfs_mount> command, but it allows you to set "
9955 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
9960 #: ../src/guestfs-actions.pod:3445
9961 msgid "guestfs_mountpoints"
9965 #: ../src/guestfs-actions.pod:3447
9968 " char **guestfs_mountpoints (guestfs_h *g);\n"
9973 #: ../src/guestfs-actions.pod:3449
9975 "This call is similar to C<guestfs_mounts>. That call returns a list of "
9976 "devices. This one returns a hash table (map) of device name to directory "
9977 "where the device is mounted."
9981 #: ../src/guestfs-actions.pod:3459
9982 msgid "guestfs_mounts"
9986 #: ../src/guestfs-actions.pod:3461
9989 " char **guestfs_mounts (guestfs_h *g);\n"
9994 #: ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:2682
9996 "This returns the list of currently mounted filesystems. It returns the list "
9997 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
10001 #: ../src/guestfs-actions.pod:3466 ../fish/guestfish-actions.pod:2685
10002 msgid "Some internal mounts are not shown."
10006 #: ../src/guestfs-actions.pod:3468
10007 msgid "See also: C<guestfs_mountpoints>"
10011 #: ../src/guestfs-actions.pod:3474
10016 #: ../src/guestfs-actions.pod:3476
10019 " int guestfs_mv (guestfs_h *g,\n"
10020 "\t\tconst char *src,\n"
10021 "\t\tconst char *dest);\n"
10026 #: ../src/guestfs-actions.pod:3480 ../fish/guestfish-actions.pod:2693
10028 "This moves a file from C<src> to C<dest> where C<dest> is either a "
10029 "destination filename or destination directory."
10033 #: ../src/guestfs-actions.pod:3485
10034 msgid "guestfs_ntfs_3g_probe"
10038 #: ../src/guestfs-actions.pod:3487
10041 " int guestfs_ntfs_3g_probe (guestfs_h *g,\n"
10043 "\t\tconst char *device);\n"
10048 #: ../src/guestfs-actions.pod:3491 ../fish/guestfish-actions.pod:2700
10050 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
10051 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
10052 "write, and some cannot be mounted at all)."
10056 #: ../src/guestfs-actions.pod:3495 ../fish/guestfish-actions.pod:2704
10058 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
10059 "can be mounted read-write. Set it to false if you want to test if the "
10060 "volume can be mounted read-only."
10064 #: ../src/guestfs-actions.pod:3499 ../fish/guestfish-actions.pod:2708
10066 "The return value is an integer which C<0> if the operation would succeed, or "
10067 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
10071 #: ../src/guestfs-actions.pod:3505
10072 msgid "guestfs_ntfsresize"
10076 #: ../src/guestfs-actions.pod:3507
10079 " int guestfs_ntfsresize (guestfs_h *g,\n"
10080 "\t\tconst char *device);\n"
10085 #: ../src/guestfs-actions.pod:3510 ../fish/guestfish-actions.pod:2716
10087 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
10088 "size of the underlying device. See also L<ntfsresize(8)>."
10092 #: ../src/guestfs-actions.pod:3516
10093 msgid "guestfs_ntfsresize_size"
10097 #: ../src/guestfs-actions.pod:3518
10100 " int guestfs_ntfsresize_size (guestfs_h *g,\n"
10101 "\t\tconst char *device,\n"
10102 "\t\tint64_t size);\n"
10107 #: ../src/guestfs-actions.pod:3522
10109 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
10110 "to specify the new size (in bytes) explicitly."
10114 #: ../src/guestfs-actions.pod:3527
10115 msgid "guestfs_part_add"
10119 #: ../src/guestfs-actions.pod:3529
10122 " int guestfs_part_add (guestfs_h *g,\n"
10123 "\t\tconst char *device,\n"
10124 "\t\tconst char *prlogex,\n"
10125 "\t\tint64_t startsect,\n"
10126 "\t\tint64_t endsect);\n"
10131 #: ../src/guestfs-actions.pod:3535
10133 "This command adds a partition to C<device>. If there is no partition table "
10134 "on the device, call C<guestfs_part_init> first."
10138 #: ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:2734
10140 "The C<prlogex> parameter is the type of partition. Normally you should pass "
10141 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
10142 "C<logical>) and C<e> (or C<extended>) partition types."
10146 #: ../src/guestfs-actions.pod:3543 ../fish/guestfish-actions.pod:2739
10148 "C<startsect> and C<endsect> are the start and end of the partition in "
10149 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
10150 "from the end of the disk (C<-1> is the last sector)."
10154 #: ../src/guestfs-actions.pod:3547
10156 "Creating a partition which covers the whole disk is not so easy. Use "
10157 "C<guestfs_part_disk> to do that."
10161 #: ../src/guestfs-actions.pod:3552
10162 msgid "guestfs_part_del"
10166 #: ../src/guestfs-actions.pod:3554
10169 " int guestfs_part_del (guestfs_h *g,\n"
10170 "\t\tconst char *device,\n"
10171 "\t\tint partnum);\n"
10176 #: ../src/guestfs-actions.pod:3558 ../fish/guestfish-actions.pod:2750
10177 msgid "This command deletes the partition numbered C<partnum> on C<device>."
10181 #: ../src/guestfs-actions.pod:3560 ../fish/guestfish-actions.pod:2752
10183 "Note that in the case of MBR partitioning, deleting an extended partition "
10184 "also deletes any logical partitions it contains."
10188 #: ../src/guestfs-actions.pod:3566
10189 msgid "guestfs_part_disk"
10193 #: ../src/guestfs-actions.pod:3568
10196 " int guestfs_part_disk (guestfs_h *g,\n"
10197 "\t\tconst char *device,\n"
10198 "\t\tconst char *parttype);\n"
10203 #: ../src/guestfs-actions.pod:3572
10205 "This command is simply a combination of C<guestfs_part_init> followed by "
10206 "C<guestfs_part_add> to create a single primary partition covering the whole "
10211 #: ../src/guestfs-actions.pod:3576
10213 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
10214 "possible values are described in C<guestfs_part_init>."
10218 #: ../src/guestfs-actions.pod:3584
10219 msgid "guestfs_part_get_bootable"
10223 #: ../src/guestfs-actions.pod:3586
10226 " int guestfs_part_get_bootable (guestfs_h *g,\n"
10227 "\t\tconst char *device,\n"
10228 "\t\tint partnum);\n"
10233 #: ../src/guestfs-actions.pod:3590 ../fish/guestfish-actions.pod:2774
10235 "This command returns true if the partition C<partnum> on C<device> has the "
10236 "bootable flag set."
10240 #: ../src/guestfs-actions.pod:3593
10241 msgid "See also C<guestfs_part_set_bootable>."
10245 #: ../src/guestfs-actions.pod:3597
10246 msgid "guestfs_part_get_mbr_id"
10250 #: ../src/guestfs-actions.pod:3599
10253 " int guestfs_part_get_mbr_id (guestfs_h *g,\n"
10254 "\t\tconst char *device,\n"
10255 "\t\tint partnum);\n"
10260 #: ../src/guestfs-actions.pod:3603 ../fish/guestfish-actions.pod:2783
10262 "Returns the MBR type byte (also known as the ID byte) from the numbered "
10263 "partition C<partnum>."
10267 #: ../src/guestfs-actions.pod:3606 ../src/guestfs-actions.pod:3768
10269 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
10270 "undefined results for other partition table types (see "
10271 "C<guestfs_part_get_parttype>)."
10275 #: ../src/guestfs-actions.pod:3612
10276 msgid "guestfs_part_get_parttype"
10280 #: ../src/guestfs-actions.pod:3614
10283 " char *guestfs_part_get_parttype (guestfs_h *g,\n"
10284 "\t\tconst char *device);\n"
10289 #: ../src/guestfs-actions.pod:3617 ../fish/guestfish-actions.pod:2794
10291 "This command examines the partition table on C<device> and returns the "
10292 "partition table type (format) being used."
10296 #: ../src/guestfs-actions.pod:3620
10298 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
10299 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
10300 "possible, although unusual. See C<guestfs_part_init> for a full list."
10304 #: ../src/guestfs-actions.pod:3628
10305 msgid "guestfs_part_init"
10309 #: ../src/guestfs-actions.pod:3630
10312 " int guestfs_part_init (guestfs_h *g,\n"
10313 "\t\tconst char *device,\n"
10314 "\t\tconst char *parttype);\n"
10319 #: ../src/guestfs-actions.pod:3634 ../fish/guestfish-actions.pod:2806
10321 "This creates an empty partition table on C<device> of one of the partition "
10322 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
10323 "(for large disks)."
10327 #: ../src/guestfs-actions.pod:3638
10329 "Initially there are no partitions. Following this, you should call "
10330 "C<guestfs_part_add> for each partition required."
10334 #: ../src/guestfs-actions.pod:3641 ../fish/guestfish-actions.pod:2813
10335 msgid "Possible values for C<parttype> are:"
10339 #: ../src/guestfs-actions.pod:3645 ../fish/guestfish-actions.pod:2817
10340 msgid "B<efi> | B<gpt>"
10344 #: ../src/guestfs-actions.pod:3647 ../fish/guestfish-actions.pod:2819
10345 msgid "Intel EFI / GPT partition table."
10349 #: ../src/guestfs-actions.pod:3649 ../fish/guestfish-actions.pod:2821
10351 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
10352 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
10353 "the C<mbr> format."
10357 #: ../src/guestfs-actions.pod:3653 ../fish/guestfish-actions.pod:2825
10358 msgid "B<mbr> | B<msdos>"
10362 #: ../src/guestfs-actions.pod:3655 ../fish/guestfish-actions.pod:2827
10364 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
10365 "Windows. This partition type will B<only> work for device sizes up to 2 "
10366 "TB. For large disks we recommend using C<gpt>."
10370 #: ../src/guestfs-actions.pod:3662 ../fish/guestfish-actions.pod:2834
10372 "Other partition table types that may work but are not supported include:"
10376 #: ../src/guestfs-actions.pod:3667 ../fish/guestfish-actions.pod:2839
10381 #: ../src/guestfs-actions.pod:3669 ../fish/guestfish-actions.pod:2841
10382 msgid "AIX disk labels."
10386 #: ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:2843
10387 msgid "B<amiga> | B<rdb>"
10391 #: ../src/guestfs-actions.pod:3673 ../fish/guestfish-actions.pod:2845
10392 msgid "Amiga \"Rigid Disk Block\" format."
10396 #: ../src/guestfs-actions.pod:3675 ../fish/guestfish-actions.pod:2847
10401 #: ../src/guestfs-actions.pod:3677 ../fish/guestfish-actions.pod:2849
10402 msgid "BSD disk labels."
10406 #: ../src/guestfs-actions.pod:3679 ../fish/guestfish-actions.pod:2851
10411 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2853
10412 msgid "DASD, used on IBM mainframes."
10416 #: ../src/guestfs-actions.pod:3683 ../fish/guestfish-actions.pod:2855
10421 #: ../src/guestfs-actions.pod:3685 ../fish/guestfish-actions.pod:2857
10422 msgid "MIPS/SGI volumes."
10426 #: ../src/guestfs-actions.pod:3687 ../fish/guestfish-actions.pod:2859
10431 #: ../src/guestfs-actions.pod:3689 ../fish/guestfish-actions.pod:2861
10432 msgid "Old Mac partition format. Modern Macs use C<gpt>."
10436 #: ../src/guestfs-actions.pod:3691 ../fish/guestfish-actions.pod:2863
10441 #: ../src/guestfs-actions.pod:3693 ../fish/guestfish-actions.pod:2865
10442 msgid "NEC PC-98 format, common in Japan apparently."
10446 #: ../src/guestfs-actions.pod:3695 ../fish/guestfish-actions.pod:2867
10451 #: ../src/guestfs-actions.pod:3697 ../fish/guestfish-actions.pod:2869
10452 msgid "Sun disk labels."
10456 #: ../src/guestfs-actions.pod:3703
10457 msgid "guestfs_part_list"
10461 #: ../src/guestfs-actions.pod:3705
10464 " struct guestfs_partition_list *guestfs_part_list (guestfs_h *g,\n"
10465 "\t\tconst char *device);\n"
10470 #: ../src/guestfs-actions.pod:3708 ../fish/guestfish-actions.pod:2877
10472 "This command parses the partition table on C<device> and returns the list of "
10473 "partitions found."
10477 #: ../src/guestfs-actions.pod:3711 ../fish/guestfish-actions.pod:2880
10478 msgid "The fields in the returned structure are:"
10482 #: ../src/guestfs-actions.pod:3715 ../fish/guestfish-actions.pod:2884
10483 msgid "B<part_num>"
10487 #: ../src/guestfs-actions.pod:3717 ../fish/guestfish-actions.pod:2886
10488 msgid "Partition number, counting from 1."
10492 #: ../src/guestfs-actions.pod:3719 ../fish/guestfish-actions.pod:2888
10493 msgid "B<part_start>"
10497 #: ../src/guestfs-actions.pod:3721
10499 "Start of the partition I<in bytes>. To get sectors you have to divide by "
10500 "the device's sector size, see C<guestfs_blockdev_getss>."
10504 #: ../src/guestfs-actions.pod:3724 ../fish/guestfish-actions.pod:2893
10505 msgid "B<part_end>"
10509 #: ../src/guestfs-actions.pod:3726 ../fish/guestfish-actions.pod:2895
10510 msgid "End of the partition in bytes."
10514 #: ../src/guestfs-actions.pod:3728 ../fish/guestfish-actions.pod:2897
10515 msgid "B<part_size>"
10519 #: ../src/guestfs-actions.pod:3730 ../fish/guestfish-actions.pod:2899
10520 msgid "Size of the partition in bytes."
10524 #: ../src/guestfs-actions.pod:3734
10526 "This function returns a C<struct guestfs_partition_list *> (see E<lt>guestfs-"
10527 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
10528 "C<guestfs_free_partition_list> after use>."
10532 #: ../src/guestfs-actions.pod:3739
10533 msgid "guestfs_part_set_bootable"
10537 #: ../src/guestfs-actions.pod:3741
10540 " int guestfs_part_set_bootable (guestfs_h *g,\n"
10541 "\t\tconst char *device,\n"
10542 "\t\tint partnum,\n"
10543 "\t\tint bootable);\n"
10548 #: ../src/guestfs-actions.pod:3746 ../fish/guestfish-actions.pod:2907
10550 "This sets the bootable flag on partition numbered C<partnum> on device "
10551 "C<device>. Note that partitions are numbered from 1."
10555 #: ../src/guestfs-actions.pod:3749 ../fish/guestfish-actions.pod:2910
10557 "The bootable flag is used by some operating systems (notably Windows) to "
10558 "determine which partition to boot from. It is by no means universally "
10563 #: ../src/guestfs-actions.pod:3755
10564 msgid "guestfs_part_set_mbr_id"
10568 #: ../src/guestfs-actions.pod:3757
10571 " int guestfs_part_set_mbr_id (guestfs_h *g,\n"
10572 "\t\tconst char *device,\n"
10573 "\t\tint partnum,\n"
10574 "\t\tint idbyte);\n"
10579 #: ../src/guestfs-actions.pod:3762 ../fish/guestfish-actions.pod:2918
10581 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
10582 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
10583 "documentation are in fact hexadecimal numbers, but usually documented "
10584 "without any leading \"0x\" which might be confusing."
10588 #: ../src/guestfs-actions.pod:3774
10589 msgid "guestfs_part_set_name"
10593 #: ../src/guestfs-actions.pod:3776
10596 " int guestfs_part_set_name (guestfs_h *g,\n"
10597 "\t\tconst char *device,\n"
10598 "\t\tint partnum,\n"
10599 "\t\tconst char *name);\n"
10604 #: ../src/guestfs-actions.pod:3781 ../fish/guestfish-actions.pod:2932
10606 "This sets the partition name on partition numbered C<partnum> on device "
10607 "C<device>. Note that partitions are numbered from 1."
10611 #: ../src/guestfs-actions.pod:3784 ../fish/guestfish-actions.pod:2935
10613 "The partition name can only be set on certain types of partition table. "
10614 "This works on C<gpt> but not on C<mbr> partitions."
10618 #: ../src/guestfs-actions.pod:3789
10619 msgid "guestfs_part_to_dev"
10623 #: ../src/guestfs-actions.pod:3791
10626 " char *guestfs_part_to_dev (guestfs_h *g,\n"
10627 "\t\tconst char *partition);\n"
10632 #: ../src/guestfs-actions.pod:3794 ../fish/guestfish-actions.pod:2942
10634 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
10635 "partition number, returning the device name (eg. \"/dev/sdb\")."
10639 #: ../src/guestfs-actions.pod:3798
10641 "The named partition must exist, for example as a string returned from "
10642 "C<guestfs_list_partitions>."
10646 #: ../src/guestfs-actions.pod:3804
10647 msgid "guestfs_ping_daemon"
10651 #: ../src/guestfs-actions.pod:3806
10654 " int guestfs_ping_daemon (guestfs_h *g);\n"
10659 #: ../src/guestfs-actions.pod:3808 ../fish/guestfish-actions.pod:2953
10661 "This is a test probe into the guestfs daemon running inside the qemu "
10662 "subprocess. Calling this function checks that the daemon responds to the "
10663 "ping message, without affecting the daemon or attached block device(s) in "
10668 #: ../src/guestfs-actions.pod:3815
10669 msgid "guestfs_pread"
10673 #: ../src/guestfs-actions.pod:3817
10676 " char *guestfs_pread (guestfs_h *g,\n"
10677 "\t\tconst char *path,\n"
10679 "\t\tint64_t offset,\n"
10680 "\t\tsize_t *size_r);\n"
10685 #: ../src/guestfs-actions.pod:3823 ../fish/guestfish-actions.pod:2962
10687 "This command lets you read part of a file. It reads C<count> bytes of the "
10688 "file, starting at C<offset>, from file C<path>."
10692 #: ../src/guestfs-actions.pod:3826 ../src/guestfs-actions.pod:3849
10693 #: ../fish/guestfish-actions.pod:2965 ../fish/guestfish-actions.pod:2980
10695 "This may read fewer bytes than requested. For further details see the "
10696 "L<pread(2)> system call."
10700 #: ../src/guestfs-actions.pod:3829
10701 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
10705 #: ../src/guestfs-actions.pod:3838
10706 msgid "guestfs_pread_device"
10710 #: ../src/guestfs-actions.pod:3840
10713 " char *guestfs_pread_device (guestfs_h *g,\n"
10714 "\t\tconst char *device,\n"
10716 "\t\tint64_t offset,\n"
10717 "\t\tsize_t *size_r);\n"
10722 #: ../src/guestfs-actions.pod:3846 ../fish/guestfish-actions.pod:2977
10724 "This command lets you read part of a file. It reads C<count> bytes of "
10725 "C<device>, starting at C<offset>."
10729 #: ../src/guestfs-actions.pod:3852
10730 msgid "See also C<guestfs_pread>."
10734 #: ../src/guestfs-actions.pod:3861
10735 msgid "guestfs_pvcreate"
10739 #: ../src/guestfs-actions.pod:3863
10742 " int guestfs_pvcreate (guestfs_h *g,\n"
10743 "\t\tconst char *device);\n"
10748 #: ../src/guestfs-actions.pod:3866 ../fish/guestfish-actions.pod:2992
10750 "This creates an LVM physical volume on the named C<device>, where C<device> "
10751 "should usually be a partition name such as C</dev/sda1>."
10755 #: ../src/guestfs-actions.pod:3872
10756 msgid "guestfs_pvremove"
10760 #: ../src/guestfs-actions.pod:3874
10763 " int guestfs_pvremove (guestfs_h *g,\n"
10764 "\t\tconst char *device);\n"
10769 #: ../src/guestfs-actions.pod:3877 ../fish/guestfish-actions.pod:3000
10771 "This wipes a physical volume C<device> so that LVM will no longer recognise "
10776 #: ../src/guestfs-actions.pod:3880 ../fish/guestfish-actions.pod:3003
10778 "The implementation uses the C<pvremove> command which refuses to wipe "
10779 "physical volumes that contain any volume groups, so you have to remove those "
10784 #: ../src/guestfs-actions.pod:3886
10785 msgid "guestfs_pvresize"
10789 #: ../src/guestfs-actions.pod:3888
10792 " int guestfs_pvresize (guestfs_h *g,\n"
10793 "\t\tconst char *device);\n"
10798 #: ../src/guestfs-actions.pod:3891 ../fish/guestfish-actions.pod:3011
10800 "This resizes (expands or shrinks) an existing LVM physical volume to match "
10801 "the new size of the underlying device."
10805 #: ../src/guestfs-actions.pod:3896
10806 msgid "guestfs_pvresize_size"
10810 #: ../src/guestfs-actions.pod:3898
10813 " int guestfs_pvresize_size (guestfs_h *g,\n"
10814 "\t\tconst char *device,\n"
10815 "\t\tint64_t size);\n"
10820 #: ../src/guestfs-actions.pod:3902
10822 "This command is the same as C<guestfs_pvresize> except that it allows you to "
10823 "specify the new size (in bytes) explicitly."
10827 #: ../src/guestfs-actions.pod:3907
10828 msgid "guestfs_pvs"
10832 #: ../src/guestfs-actions.pod:3909
10835 " char **guestfs_pvs (guestfs_h *g);\n"
10840 #: ../src/guestfs-actions.pod:3911 ../fish/guestfish-actions.pod:3025
10842 "List all the physical volumes detected. This is the equivalent of the L<pvs"
10847 #: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:3028
10849 "This returns a list of just the device names that contain PVs (eg. C</dev/"
10854 #: ../src/guestfs-actions.pod:3917
10855 msgid "See also C<guestfs_pvs_full>."
10859 #: ../src/guestfs-actions.pod:3923
10860 msgid "guestfs_pvs_full"
10864 #: ../src/guestfs-actions.pod:3925
10867 " struct guestfs_lvm_pv_list *guestfs_pvs_full (guestfs_h *g);\n"
10872 #: ../src/guestfs-actions.pod:3927 ../fish/guestfish-actions.pod:3037
10874 "List all the physical volumes detected. This is the equivalent of the L<pvs"
10875 "(8)> command. The \"full\" version includes all fields."
10879 #: ../src/guestfs-actions.pod:3930
10881 "This function returns a C<struct guestfs_lvm_pv_list *> (see E<lt>guestfs-"
10882 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
10883 "C<guestfs_free_lvm_pv_list> after use>."
10887 #: ../src/guestfs-actions.pod:3935
10888 msgid "guestfs_pvuuid"
10892 #: ../src/guestfs-actions.pod:3937
10895 " char *guestfs_pvuuid (guestfs_h *g,\n"
10896 "\t\tconst char *device);\n"
10901 #: ../src/guestfs-actions.pod:3940 ../fish/guestfish-actions.pod:3044
10902 msgid "This command returns the UUID of the LVM PV C<device>."
10906 #: ../src/guestfs-actions.pod:3945
10907 msgid "guestfs_pwrite"
10911 #: ../src/guestfs-actions.pod:3947
10914 " int guestfs_pwrite (guestfs_h *g,\n"
10915 "\t\tconst char *path,\n"
10916 "\t\tconst char *content,\n"
10917 "\t\tsize_t content_size,\n"
10918 "\t\tint64_t offset);\n"
10923 #: ../src/guestfs-actions.pod:3953 ../fish/guestfish-actions.pod:3050
10925 "This command writes to part of a file. It writes the data buffer C<content> "
10926 "to the file C<path> starting at offset C<offset>."
10930 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:3053
10932 "This command implements the L<pwrite(2)> system call, and like that system "
10933 "call it may not write the full data requested. The return value is the "
10934 "number of bytes that were actually written to the file. This could even be "
10935 "0, although short writes are unlikely for regular files in ordinary "
10940 #: ../src/guestfs-actions.pod:3962
10941 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
10945 #: ../src/guestfs-actions.pod:3969
10946 msgid "guestfs_pwrite_device"
10950 #: ../src/guestfs-actions.pod:3971
10953 " int guestfs_pwrite_device (guestfs_h *g,\n"
10954 "\t\tconst char *device,\n"
10955 "\t\tconst char *content,\n"
10956 "\t\tsize_t content_size,\n"
10957 "\t\tint64_t offset);\n"
10962 #: ../src/guestfs-actions.pod:3977 ../fish/guestfish-actions.pod:3068
10964 "This command writes to part of a device. It writes the data buffer "
10965 "C<content> to C<device> starting at offset C<offset>."
10969 #: ../src/guestfs-actions.pod:3980 ../fish/guestfish-actions.pod:3071
10971 "This command implements the L<pwrite(2)> system call, and like that system "
10972 "call it may not write the full data requested (although short writes to disk "
10973 "devices and partitions are probably impossible with standard Linux kernels)."
10977 #: ../src/guestfs-actions.pod:3985
10978 msgid "See also C<guestfs_pwrite>."
10982 #: ../src/guestfs-actions.pod:3992
10983 msgid "guestfs_read_file"
10987 #: ../src/guestfs-actions.pod:3994
10990 " char *guestfs_read_file (guestfs_h *g,\n"
10991 "\t\tconst char *path,\n"
10992 "\t\tsize_t *size_r);\n"
10997 #: ../src/guestfs-actions.pod:3998 ../fish/guestfish-actions.pod:3085
10998 msgid "This calls returns the contents of the file C<path> as a buffer."
11002 #: ../src/guestfs-actions.pod:4001
11004 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
11005 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
11006 "function is limited in the total size of file that can be handled."
11010 #: ../src/guestfs-actions.pod:4013
11011 msgid "guestfs_read_lines"
11015 #: ../src/guestfs-actions.pod:4015
11018 " char **guestfs_read_lines (guestfs_h *g,\n"
11019 "\t\tconst char *path);\n"
11024 #: ../src/guestfs-actions.pod:4020 ../fish/guestfish-actions.pod:3102
11026 "The file contents are returned as a list of lines. Trailing C<LF> and "
11027 "C<CRLF> character sequences are I<not> returned."
11031 #: ../src/guestfs-actions.pod:4023
11033 "Note that this function cannot correctly handle binary files (specifically, "
11034 "files containing C<\\0> character which is treated as end of line). For "
11035 "those you need to use the C<guestfs_read_file> function which has a more "
11036 "complex interface."
11040 #: ../src/guestfs-actions.pod:4032
11041 msgid "guestfs_readdir"
11045 #: ../src/guestfs-actions.pod:4034
11048 " struct guestfs_dirent_list *guestfs_readdir (guestfs_h *g,\n"
11049 "\t\tconst char *dir);\n"
11054 #: ../src/guestfs-actions.pod:4037 ../fish/guestfish-actions.pod:3114
11055 msgid "This returns the list of directory entries in directory C<dir>."
11059 #: ../src/guestfs-actions.pod:4039 ../fish/guestfish-actions.pod:3116
11061 "All entries in the directory are returned, including C<.> and C<..>. The "
11062 "entries are I<not> sorted, but returned in the same order as the underlying "
11067 #: ../src/guestfs-actions.pod:4043 ../fish/guestfish-actions.pod:3120
11069 "Also this call returns basic file type information about each file. The "
11070 "C<ftyp> field will contain one of the following characters:"
11074 #: ../src/guestfs-actions.pod:4048 ../fish/guestfish-actions.pod:3125
11079 #: ../src/guestfs-actions.pod:4050 ../fish/guestfish-actions.pod:3127
11080 msgid "Block special"
11084 #: ../src/guestfs-actions.pod:4052 ../fish/guestfish-actions.pod:3129
11089 #: ../src/guestfs-actions.pod:4054 ../fish/guestfish-actions.pod:3131
11090 msgid "Char special"
11094 #: ../src/guestfs-actions.pod:4056 ../fish/guestfish-actions.pod:3133
11099 #: ../src/guestfs-actions.pod:4058 ../fish/guestfish-actions.pod:3135
11104 #: ../src/guestfs-actions.pod:4060 ../fish/guestfish-actions.pod:3137
11109 #: ../src/guestfs-actions.pod:4062 ../fish/guestfish-actions.pod:3139
11110 msgid "FIFO (named pipe)"
11114 #: ../src/guestfs-actions.pod:4064 ../fish/guestfish-actions.pod:3141
11119 #: ../src/guestfs-actions.pod:4066 ../fish/guestfish-actions.pod:3143
11120 msgid "Symbolic link"
11124 #: ../src/guestfs-actions.pod:4068 ../fish/guestfish-actions.pod:3145
11129 #: ../src/guestfs-actions.pod:4070 ../fish/guestfish-actions.pod:3147
11130 msgid "Regular file"
11134 #: ../src/guestfs-actions.pod:4072 ../fish/guestfish-actions.pod:3149
11139 #: ../src/guestfs-actions.pod:4074 ../fish/guestfish-actions.pod:3151
11144 #: ../src/guestfs-actions.pod:4076 ../fish/guestfish-actions.pod:3153
11149 #: ../src/guestfs-actions.pod:4078 ../fish/guestfish-actions.pod:3155
11150 msgid "Unknown file type"
11154 #: ../src/guestfs-actions.pod:4080 ../fish/guestfish-actions.pod:3157
11159 #: ../src/guestfs-actions.pod:4082 ../fish/guestfish-actions.pod:3159
11161 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
11165 #: ../src/guestfs-actions.pod:4087
11167 "This function is primarily intended for use by programs. To get a simple "
11168 "list of names, use C<guestfs_ls>. To get a printable directory for human "
11169 "consumption, use C<guestfs_ll>."
11173 #: ../src/guestfs-actions.pod:4091
11175 "This function returns a C<struct guestfs_dirent_list *> (see E<lt>guestfs-"
11176 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
11177 "C<guestfs_free_dirent_list> after use>."
11181 #: ../src/guestfs-actions.pod:4096
11182 msgid "guestfs_readlink"
11186 #: ../src/guestfs-actions.pod:4098
11189 " char *guestfs_readlink (guestfs_h *g,\n"
11190 "\t\tconst char *path);\n"
11195 #: ../src/guestfs-actions.pod:4101 ../fish/guestfish-actions.pod:3172
11196 msgid "This command reads the target of a symbolic link."
11200 #: ../src/guestfs-actions.pod:4106
11201 msgid "guestfs_readlinklist"
11205 #: ../src/guestfs-actions.pod:4108
11208 " char **guestfs_readlinklist (guestfs_h *g,\n"
11209 "\t\tconst char *path,\n"
11210 "\t\tchar *const *names);\n"
11215 #: ../src/guestfs-actions.pod:4112 ../fish/guestfish-actions.pod:3178
11217 "This call allows you to do a C<readlink> operation on multiple files, where "
11218 "all files are in the directory C<path>. C<names> is the list of files from "
11223 #: ../src/guestfs-actions.pod:4116 ../fish/guestfish-actions.pod:3182
11225 "On return you get a list of strings, with a one-to-one correspondence to the "
11226 "C<names> list. Each string is the value of the symbolic link."
11230 #: ../src/guestfs-actions.pod:4120 ../fish/guestfish-actions.pod:3186
11232 "If the C<readlink(2)> operation fails on any name, then the corresponding "
11233 "result string is the empty string C<\"\">. However the whole operation is "
11234 "completed even if there were C<readlink(2)> errors, and so you can call this "
11235 "function with names where you don't know if they are symbolic links already "
11236 "(albeit slightly less efficient)."
11240 #: ../src/guestfs-actions.pod:4127 ../fish/guestfish-actions.pod:3193
11242 "This call is intended for programs that want to efficiently list a directory "
11243 "contents without making many round-trips. Very long directory listings "
11244 "might cause the protocol message size to be exceeded, causing this call to "
11245 "fail. The caller must split up such requests into smaller groups of names."
11249 #: ../src/guestfs-actions.pod:4138
11250 msgid "guestfs_realpath"
11254 #: ../src/guestfs-actions.pod:4140
11257 " char *guestfs_realpath (guestfs_h *g,\n"
11258 "\t\tconst char *path);\n"
11263 #: ../src/guestfs-actions.pod:4143 ../fish/guestfish-actions.pod:3204
11265 "Return the canonicalized absolute pathname of C<path>. The returned path "
11266 "has no C<.>, C<..> or symbolic link path elements."
11270 #: ../src/guestfs-actions.pod:4149
11271 msgid "guestfs_removexattr"
11275 #: ../src/guestfs-actions.pod:4151
11278 " int guestfs_removexattr (guestfs_h *g,\n"
11279 "\t\tconst char *xattr,\n"
11280 "\t\tconst char *path);\n"
11285 #: ../src/guestfs-actions.pod:4155 ../fish/guestfish-actions.pod:3211
11287 "This call removes the extended attribute named C<xattr> of the file C<path>."
11291 #: ../src/guestfs-actions.pod:4158
11292 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
11296 #: ../src/guestfs-actions.pod:4162
11297 msgid "guestfs_resize2fs"
11301 #: ../src/guestfs-actions.pod:4164
11304 " int guestfs_resize2fs (guestfs_h *g,\n"
11305 "\t\tconst char *device);\n"
11310 #: ../src/guestfs-actions.pod:4167 ../fish/guestfish-actions.pod:3220
11312 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
11313 "underlying device."
11317 #: ../src/guestfs-actions.pod:4170
11319 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
11320 "C<device> before calling this command. For unknown reasons C<resize2fs> "
11321 "sometimes gives an error about this and sometimes not. In any case, it is "
11322 "always safe to call C<guestfs_e2fsck_f> before calling this function."
11326 #: ../src/guestfs-actions.pod:4178
11327 msgid "guestfs_resize2fs_size"
11331 #: ../src/guestfs-actions.pod:4180
11334 " int guestfs_resize2fs_size (guestfs_h *g,\n"
11335 "\t\tconst char *device,\n"
11336 "\t\tint64_t size);\n"
11341 #: ../src/guestfs-actions.pod:4184
11343 "This command is the same as C<guestfs_resize2fs> except that it allows you "
11344 "to specify the new size (in bytes) explicitly."
11348 #: ../src/guestfs-actions.pod:4189
11353 #: ../src/guestfs-actions.pod:4191
11356 " int guestfs_rm (guestfs_h *g,\n"
11357 "\t\tconst char *path);\n"
11362 #: ../src/guestfs-actions.pod:4194 ../fish/guestfish-actions.pod:3240
11363 msgid "Remove the single file C<path>."
11367 #: ../src/guestfs-actions.pod:4198
11368 msgid "guestfs_rm_rf"
11372 #: ../src/guestfs-actions.pod:4200
11375 " int guestfs_rm_rf (guestfs_h *g,\n"
11376 "\t\tconst char *path);\n"
11381 #: ../src/guestfs-actions.pod:4203 ../fish/guestfish-actions.pod:3246
11383 "Remove the file or directory C<path>, recursively removing the contents if "
11384 "its a directory. This is like the C<rm -rf> shell command."
11388 #: ../src/guestfs-actions.pod:4209
11389 msgid "guestfs_rmdir"
11393 #: ../src/guestfs-actions.pod:4211
11396 " int guestfs_rmdir (guestfs_h *g,\n"
11397 "\t\tconst char *path);\n"
11402 #: ../src/guestfs-actions.pod:4214 ../fish/guestfish-actions.pod:3254
11403 msgid "Remove the single directory C<path>."
11407 #: ../src/guestfs-actions.pod:4218
11408 msgid "guestfs_rmmountpoint"
11412 #: ../src/guestfs-actions.pod:4220
11415 " int guestfs_rmmountpoint (guestfs_h *g,\n"
11416 "\t\tconst char *exemptpath);\n"
11421 #: ../src/guestfs-actions.pod:4223
11423 "This calls removes a mountpoint that was previously created with "
11424 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
11428 #: ../src/guestfs-actions.pod:4229
11429 msgid "guestfs_scrub_device"
11433 #: ../src/guestfs-actions.pod:4231
11436 " int guestfs_scrub_device (guestfs_h *g,\n"
11437 "\t\tconst char *device);\n"
11442 #: ../src/guestfs-actions.pod:4234 ../fish/guestfish-actions.pod:3268
11444 "This command writes patterns over C<device> to make data retrieval more "
11449 #: ../src/guestfs-actions.pod:4237 ../src/guestfs-actions.pod:4255
11450 #: ../src/guestfs-actions.pod:4271 ../fish/guestfish-actions.pod:3271
11451 #: ../fish/guestfish-actions.pod:3286 ../fish/guestfish-actions.pod:3299
11453 "It is an interface to the L<scrub(1)> program. See that manual page for "
11458 #: ../src/guestfs-actions.pod:4245
11459 msgid "guestfs_scrub_file"
11463 #: ../src/guestfs-actions.pod:4247
11466 " int guestfs_scrub_file (guestfs_h *g,\n"
11467 "\t\tconst char *file);\n"
11472 #: ../src/guestfs-actions.pod:4250 ../fish/guestfish-actions.pod:3281
11474 "This command writes patterns over a file to make data retrieval more "
11479 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:3284
11480 msgid "The file is I<removed> after scrubbing."
11484 #: ../src/guestfs-actions.pod:4260
11485 msgid "guestfs_scrub_freespace"
11489 #: ../src/guestfs-actions.pod:4262
11492 " int guestfs_scrub_freespace (guestfs_h *g,\n"
11493 "\t\tconst char *dir);\n"
11498 #: ../src/guestfs-actions.pod:4265
11500 "This command creates the directory C<dir> and then fills it with files until "
11501 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
11502 "and deletes them. The intention is to scrub any free space on the partition "
11503 "containing C<dir>."
11507 #: ../src/guestfs-actions.pod:4276
11508 msgid "guestfs_set_append"
11512 #: ../src/guestfs-actions.pod:4278
11515 " int guestfs_set_append (guestfs_h *g,\n"
11516 "\t\tconst char *append);\n"
11521 #: ../src/guestfs-actions.pod:4281 ../fish/guestfish-actions.pod:3308
11523 "This function is used to add additional options to the guest kernel command "
11528 #: ../src/guestfs-actions.pod:4284 ../fish/guestfish-actions.pod:3311
11530 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
11531 "environment variable."
11535 #: ../src/guestfs-actions.pod:4287 ../fish/guestfish-actions.pod:3314
11537 "Setting C<append> to C<NULL> means I<no> additional options are passed "
11538 "(libguestfs always adds a few of its own)."
11542 #: ../src/guestfs-actions.pod:4292
11543 msgid "guestfs_set_autosync"
11547 #: ../src/guestfs-actions.pod:4294
11550 " int guestfs_set_autosync (guestfs_h *g,\n"
11551 "\t\tint autosync);\n"
11556 #: ../src/guestfs-actions.pod:4297
11558 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
11559 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
11560 "the handle is closed (also if the program exits without closing handles)."
11564 #: ../src/guestfs-actions.pod:4302 ../fish/guestfish-actions.pod:3328
11566 "This is disabled by default (except in guestfish where it is enabled by "
11571 #: ../src/guestfs-actions.pod:4307
11572 msgid "guestfs_set_direct"
11576 #: ../src/guestfs-actions.pod:4309
11579 " int guestfs_set_direct (guestfs_h *g,\n"
11580 "\t\tint direct);\n"
11585 #: ../src/guestfs-actions.pod:4312 ../fish/guestfish-actions.pod:3337
11587 "If the direct appliance mode flag is enabled, then stdin and stdout are "
11588 "passed directly through to the appliance once it is launched."
11592 #: ../src/guestfs-actions.pod:4316
11594 "One consequence of this is that log messages aren't caught by the library "
11595 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
11600 #: ../src/guestfs-actions.pod:4320 ../fish/guestfish-actions.pod:3345
11601 msgid "You probably don't want to use this unless you know what you are doing."
11605 #: ../src/guestfs-actions.pod:4323 ../fish/guestfish-actions.pod:3348
11606 msgid "The default is disabled."
11610 #: ../src/guestfs-actions.pod:4327
11611 msgid "guestfs_set_e2label"
11615 #: ../src/guestfs-actions.pod:4329
11618 " int guestfs_set_e2label (guestfs_h *g,\n"
11619 "\t\tconst char *device,\n"
11620 "\t\tconst char *label);\n"
11625 #: ../src/guestfs-actions.pod:4333 ../fish/guestfish-actions.pod:3354
11627 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
11628 "C<label>. Filesystem labels are limited to 16 characters."
11632 #: ../src/guestfs-actions.pod:4337
11634 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
11635 "the existing label on a filesystem."
11639 #: ../src/guestfs-actions.pod:4342
11640 msgid "guestfs_set_e2uuid"
11644 #: ../src/guestfs-actions.pod:4344
11647 " int guestfs_set_e2uuid (guestfs_h *g,\n"
11648 "\t\tconst char *device,\n"
11649 "\t\tconst char *uuid);\n"
11654 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:3365
11656 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
11657 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
11658 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
11662 #: ../src/guestfs-actions.pod:4353
11664 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
11665 "the existing UUID of a filesystem."
11669 #: ../src/guestfs-actions.pod:4358
11670 msgid "guestfs_set_memsize"
11674 #: ../src/guestfs-actions.pod:4360
11677 " int guestfs_set_memsize (guestfs_h *g,\n"
11678 "\t\tint memsize);\n"
11683 #: ../src/guestfs-actions.pod:4363
11685 "This sets the memory size in megabytes allocated to the qemu subprocess. "
11686 "This only has any effect if called before C<guestfs_launch>."
11690 #: ../src/guestfs-actions.pod:4367 ../fish/guestfish-actions.pod:3383
11692 "You can also change this by setting the environment variable "
11693 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
11697 #: ../src/guestfs-actions.pod:4376
11698 msgid "guestfs_set_network"
11702 #: ../src/guestfs-actions.pod:4378
11705 " int guestfs_set_network (guestfs_h *g,\n"
11706 "\t\tint network);\n"
11711 #: ../src/guestfs-actions.pod:4381 ../fish/guestfish-actions.pod:3396
11713 "If C<network> is true, then the network is enabled in the libguestfs "
11714 "appliance. The default is false."
11718 #: ../src/guestfs-actions.pod:4384 ../fish/guestfish-actions.pod:3399
11720 "This affects whether commands are able to access the network (see L<guestfs"
11721 "(3)/RUNNING COMMANDS>)."
11725 #: ../src/guestfs-actions.pod:4387
11727 "You must call this before calling C<guestfs_launch>, otherwise it has no "
11732 #: ../src/guestfs-actions.pod:4392
11733 msgid "guestfs_set_path"
11737 #: ../src/guestfs-actions.pod:4394
11740 " int guestfs_set_path (guestfs_h *g,\n"
11741 "\t\tconst char *searchpath);\n"
11746 #: ../src/guestfs-actions.pod:4397 ../fish/guestfish-actions.pod:3411
11747 msgid "Set the path that libguestfs searches for kernel and initrd.img."
11751 #: ../src/guestfs-actions.pod:4399 ../fish/guestfish-actions.pod:3413
11753 "The default is C<$libdir/guestfs> unless overridden by setting "
11754 "C<LIBGUESTFS_PATH> environment variable."
11758 #: ../src/guestfs-actions.pod:4402 ../fish/guestfish-actions.pod:3416
11759 msgid "Setting C<path> to C<NULL> restores the default path."
11763 #: ../src/guestfs-actions.pod:4406
11764 msgid "guestfs_set_qemu"
11768 #: ../src/guestfs-actions.pod:4408
11771 " int guestfs_set_qemu (guestfs_h *g,\n"
11772 "\t\tconst char *qemu);\n"
11777 #: ../src/guestfs-actions.pod:4411 ../fish/guestfish-actions.pod:3424
11778 msgid "Set the qemu binary that we will use."
11782 #: ../src/guestfs-actions.pod:4413 ../fish/guestfish-actions.pod:3426
11784 "The default is chosen when the library was compiled by the configure script."
11788 #: ../src/guestfs-actions.pod:4416 ../fish/guestfish-actions.pod:3429
11790 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
11795 #: ../src/guestfs-actions.pod:4419 ../fish/guestfish-actions.pod:3432
11796 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
11800 #: ../src/guestfs-actions.pod:4421 ../fish/guestfish-actions.pod:3434
11802 "Note that you should call this function as early as possible after creating "
11803 "the handle. This is because some pre-launch operations depend on testing "
11804 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
11805 "don't retest features, and so you might see inconsistent results. Using the "
11806 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
11807 "the qemu binary at the same time as the handle is created."
11811 #: ../src/guestfs-actions.pod:4431
11812 msgid "guestfs_set_recovery_proc"
11816 #: ../src/guestfs-actions.pod:4433
11819 " int guestfs_set_recovery_proc (guestfs_h *g,\n"
11820 "\t\tint recoveryproc);\n"
11825 #: ../src/guestfs-actions.pod:4436
11827 "If this is called with the parameter C<false> then C<guestfs_launch> does "
11828 "not create a recovery process. The purpose of the recovery process is to "
11829 "stop runaway qemu processes in the case where the main program aborts "
11834 #: ../src/guestfs-actions.pod:4441
11836 "This only has any effect if called before C<guestfs_launch>, and the default "
11841 #: ../src/guestfs-actions.pod:4444 ../fish/guestfish-actions.pod:3456
11843 "About the only time when you would want to disable this is if the main "
11844 "process will fork itself into the background (\"daemonize\" itself). In "
11845 "this case the recovery process thinks that the main program has disappeared "
11846 "and so kills qemu, which is not very helpful."
11850 #: ../src/guestfs-actions.pod:4452
11851 msgid "guestfs_set_selinux"
11855 #: ../src/guestfs-actions.pod:4454
11858 " int guestfs_set_selinux (guestfs_h *g,\n"
11859 "\t\tint selinux);\n"
11864 #: ../src/guestfs-actions.pod:4457 ../fish/guestfish-actions.pod:3468
11866 "This sets the selinux flag that is passed to the appliance at boot time. "
11867 "The default is C<selinux=0> (disabled)."
11871 #: ../src/guestfs-actions.pod:4460 ../fish/guestfish-actions.pod:3471
11873 "Note that if SELinux is enabled, it is always in Permissive mode "
11874 "(C<enforcing=0>)."
11878 #: ../src/guestfs-actions.pod:4468
11879 msgid "guestfs_set_trace"
11883 #: ../src/guestfs-actions.pod:4470
11886 " int guestfs_set_trace (guestfs_h *g,\n"
11887 "\t\tint trace);\n"
11892 #: ../src/guestfs-actions.pod:4473 ../fish/guestfish-actions.pod:3483
11894 "If the command trace flag is set to 1, then commands are printed on stderr "
11895 "before they are executed in a format which is very similar to the one used "
11896 "by guestfish. In other words, you can run a program with this enabled, and "
11897 "you will get out a script which you can feed to guestfish to perform the "
11898 "same set of actions."
11902 #: ../src/guestfs-actions.pod:4480 ../fish/guestfish-actions.pod:3490
11904 "If you want to trace C API calls into libguestfs (and other libraries) then "
11905 "possibly a better way is to use the external ltrace(1) command."
11909 #: ../src/guestfs-actions.pod:4484 ../fish/guestfish-actions.pod:3494
11911 "Command traces are disabled unless the environment variable "
11912 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
11916 #: ../src/guestfs-actions.pod:4489
11917 msgid "guestfs_set_verbose"
11921 #: ../src/guestfs-actions.pod:4491
11924 " int guestfs_set_verbose (guestfs_h *g,\n"
11925 "\t\tint verbose);\n"
11930 #: ../src/guestfs-actions.pod:4494 ../fish/guestfish-actions.pod:3503
11931 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
11935 #: ../src/guestfs-actions.pod:4496 ../fish/guestfish-actions.pod:3505
11937 "Verbose messages are disabled unless the environment variable "
11938 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
11942 #: ../src/guestfs-actions.pod:4501
11943 msgid "guestfs_setcon"
11947 #: ../src/guestfs-actions.pod:4503
11950 " int guestfs_setcon (guestfs_h *g,\n"
11951 "\t\tconst char *context);\n"
11956 #: ../src/guestfs-actions.pod:4506 ../fish/guestfish-actions.pod:3512
11958 "This sets the SELinux security context of the daemon to the string "
11963 #: ../src/guestfs-actions.pod:4509 ../fish/guestfish-actions.pod:3515
11964 msgid "See the documentation about SELINUX in L<guestfs(3)>."
11968 #: ../src/guestfs-actions.pod:4513
11969 msgid "guestfs_setxattr"
11973 #: ../src/guestfs-actions.pod:4515
11976 " int guestfs_setxattr (guestfs_h *g,\n"
11977 "\t\tconst char *xattr,\n"
11978 "\t\tconst char *val,\n"
11979 "\t\tint vallen,\n"
11980 "\t\tconst char *path);\n"
11985 #: ../src/guestfs-actions.pod:4521 ../fish/guestfish-actions.pod:3521
11987 "This call sets the extended attribute named C<xattr> of the file C<path> to "
11988 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
11992 #: ../src/guestfs-actions.pod:4525
11993 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
11997 #: ../src/guestfs-actions.pod:4529
11998 msgid "guestfs_sfdisk"
12002 #: ../src/guestfs-actions.pod:4531
12005 " int guestfs_sfdisk (guestfs_h *g,\n"
12006 "\t\tconst char *device,\n"
12009 "\t\tint sectors,\n"
12010 "\t\tchar *const *lines);\n"
12015 #: ../src/guestfs-actions.pod:4538 ../fish/guestfish-actions.pod:3531
12017 "This is a direct interface to the L<sfdisk(8)> program for creating "
12018 "partitions on block devices."
12022 #: ../src/guestfs-actions.pod:4541 ../fish/guestfish-actions.pod:3534
12023 msgid "C<device> should be a block device, for example C</dev/sda>."
12027 #: ../src/guestfs-actions.pod:4543 ../fish/guestfish-actions.pod:3536
12029 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
12030 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
12031 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
12032 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
12033 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
12034 "the kernel) cannot work out the right geometry and you will need to tell it."
12038 #: ../src/guestfs-actions.pod:4551 ../fish/guestfish-actions.pod:3544
12040 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
12041 "refer to the L<sfdisk(8)> manpage."
12045 #: ../src/guestfs-actions.pod:4554 ../fish/guestfish-actions.pod:3547
12047 "To create a single partition occupying the whole disk, you would pass "
12048 "C<lines> as a single element list, when the single element being the string "
12053 #: ../src/guestfs-actions.pod:4558
12055 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
12059 #: ../src/guestfs-actions.pod:4566
12060 msgid "guestfs_sfdiskM"
12064 #: ../src/guestfs-actions.pod:4568
12067 " int guestfs_sfdiskM (guestfs_h *g,\n"
12068 "\t\tconst char *device,\n"
12069 "\t\tchar *const *lines);\n"
12074 #: ../src/guestfs-actions.pod:4572
12076 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
12077 "partition sizes are specified in megabytes only (rounded to the nearest "
12078 "cylinder) and you don't need to specify the cyls, heads and sectors "
12079 "parameters which were rarely if ever used anyway."
12083 #: ../src/guestfs-actions.pod:4578
12085 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
12086 "C<guestfs_part_disk>"
12090 #: ../src/guestfs-actions.pod:4586
12091 msgid "guestfs_sfdisk_N"
12095 #: ../src/guestfs-actions.pod:4588
12098 " int guestfs_sfdisk_N (guestfs_h *g,\n"
12099 "\t\tconst char *device,\n"
12100 "\t\tint partnum,\n"
12103 "\t\tint sectors,\n"
12104 "\t\tconst char *line);\n"
12109 #: ../src/guestfs-actions.pod:4596 ../fish/guestfish-actions.pod:3577
12111 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
12112 "(note: C<n> counts from 1)."
12116 #: ../src/guestfs-actions.pod:4599
12118 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
12119 "for the cyls/heads/sectors parameters."
12123 #: ../src/guestfs-actions.pod:4602
12124 msgid "See also: C<guestfs_part_add>"
12128 #: ../src/guestfs-actions.pod:4609
12129 msgid "guestfs_sfdisk_disk_geometry"
12133 #: ../src/guestfs-actions.pod:4611
12136 " char *guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
12137 "\t\tconst char *device);\n"
12142 #: ../src/guestfs-actions.pod:4614
12144 "This displays the disk geometry of C<device> read from the partition table. "
12145 "Especially in the case where the underlying block device has been resized, "
12146 "this can be different from the kernel's idea of the geometry (see "
12147 "C<guestfs_sfdisk_kernel_geometry>)."
12151 #: ../src/guestfs-actions.pod:4619 ../src/guestfs-actions.pod:4632
12152 #: ../fish/guestfish-actions.pod:3597 ../fish/guestfish-actions.pod:3606
12153 msgid "The result is in human-readable format, and not designed to be parsed."
12157 #: ../src/guestfs-actions.pod:4625
12158 msgid "guestfs_sfdisk_kernel_geometry"
12162 #: ../src/guestfs-actions.pod:4627
12165 " char *guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
12166 "\t\tconst char *device);\n"
12171 #: ../src/guestfs-actions.pod:4630 ../fish/guestfish-actions.pod:3604
12172 msgid "This displays the kernel's idea of the geometry of C<device>."
12176 #: ../src/guestfs-actions.pod:4638
12177 msgid "guestfs_sfdisk_l"
12181 #: ../src/guestfs-actions.pod:4640
12184 " char *guestfs_sfdisk_l (guestfs_h *g,\n"
12185 "\t\tconst char *device);\n"
12190 #: ../src/guestfs-actions.pod:4643 ../fish/guestfish-actions.pod:3613
12192 "This displays the partition table on C<device>, in the human-readable output "
12193 "of the L<sfdisk(8)> command. It is not intended to be parsed."
12197 #: ../src/guestfs-actions.pod:4647
12198 msgid "See also: C<guestfs_part_list>"
12202 #: ../src/guestfs-actions.pod:4652
12207 #: ../src/guestfs-actions.pod:4654
12210 " char *guestfs_sh (guestfs_h *g,\n"
12211 "\t\tconst char *command);\n"
12216 #: ../src/guestfs-actions.pod:4657 ../fish/guestfish-actions.pod:3623
12218 "This call runs a command from the guest filesystem via the guest's C</bin/"
12223 #: ../src/guestfs-actions.pod:4660
12224 msgid "This is like C<guestfs_command>, but passes the command to:"
12228 #: ../src/guestfs-actions.pod:4662 ../fish/guestfish-actions.pod:3628
12231 " /bin/sh -c \"command\"\n"
12236 #: ../src/guestfs-actions.pod:4664 ../fish/guestfish-actions.pod:3630
12238 "Depending on the guest's shell, this usually results in wildcards being "
12239 "expanded, shell expressions being interpolated and so on."
12243 #: ../src/guestfs-actions.pod:4668
12244 msgid "All the provisos about C<guestfs_command> apply to this call."
12248 #: ../src/guestfs-actions.pod:4673
12249 msgid "guestfs_sh_lines"
12253 #: ../src/guestfs-actions.pod:4675
12256 " char **guestfs_sh_lines (guestfs_h *g,\n"
12257 "\t\tconst char *command);\n"
12262 #: ../src/guestfs-actions.pod:4678
12264 "This is the same as C<guestfs_sh>, but splits the result into a list of "
12269 #: ../src/guestfs-actions.pod:4681
12270 msgid "See also: C<guestfs_command_lines>"
12274 #: ../src/guestfs-actions.pod:4687
12275 msgid "guestfs_sleep"
12279 #: ../src/guestfs-actions.pod:4689
12282 " int guestfs_sleep (guestfs_h *g,\n"
12288 #: ../src/guestfs-actions.pod:4692 ../fish/guestfish-actions.pod:3649
12289 msgid "Sleep for C<secs> seconds."
12293 #: ../src/guestfs-actions.pod:4696 ../src/guestfs-structs.pod:109
12294 msgid "guestfs_stat"
12298 #: ../src/guestfs-actions.pod:4698
12301 " struct guestfs_stat *guestfs_stat (guestfs_h *g,\n"
12302 "\t\tconst char *path);\n"
12307 #: ../src/guestfs-actions.pod:4703 ../fish/guestfish-actions.pod:3657
12308 msgid "This is the same as the C<stat(2)> system call."
12312 #: ../src/guestfs-actions.pod:4709 ../src/guestfs-structs.pod:135
12313 msgid "guestfs_statvfs"
12317 #: ../src/guestfs-actions.pod:4711
12320 " struct guestfs_statvfs *guestfs_statvfs (guestfs_h *g,\n"
12321 "\t\tconst char *path);\n"
12326 #: ../src/guestfs-actions.pod:4714 ../fish/guestfish-actions.pod:3663
12328 "Returns file system statistics for any mounted file system. C<path> should "
12329 "be a file or directory in the mounted file system (typically it is the mount "
12330 "point itself, but it doesn't need to be)."
12334 #: ../src/guestfs-actions.pod:4718 ../fish/guestfish-actions.pod:3667
12335 msgid "This is the same as the C<statvfs(2)> system call."
12339 #: ../src/guestfs-actions.pod:4720
12341 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
12342 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
12346 #: ../src/guestfs-actions.pod:4724
12347 msgid "guestfs_strings"
12351 #: ../src/guestfs-actions.pod:4726
12354 " char **guestfs_strings (guestfs_h *g,\n"
12355 "\t\tconst char *path);\n"
12360 #: ../src/guestfs-actions.pod:4729 ../fish/guestfish-actions.pod:3673
12362 "This runs the L<strings(1)> command on a file and returns the list of "
12363 "printable strings found."
12367 #: ../src/guestfs-actions.pod:4739
12368 msgid "guestfs_strings_e"
12372 #: ../src/guestfs-actions.pod:4741
12375 " char **guestfs_strings_e (guestfs_h *g,\n"
12376 "\t\tconst char *encoding,\n"
12377 "\t\tconst char *path);\n"
12382 #: ../src/guestfs-actions.pod:4745
12384 "This is like the C<guestfs_strings> command, but allows you to specify the "
12385 "encoding of strings that are looked for in the source file C<path>."
12389 #: ../src/guestfs-actions.pod:4749 ../fish/guestfish-actions.pod:3687
12390 msgid "Allowed encodings are:"
12394 #: ../src/guestfs-actions.pod:4753 ../fish/guestfish-actions.pod:3691
12399 #: ../src/guestfs-actions.pod:4755
12401 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
12402 "ISO-8859-X (this is what C<guestfs_strings> uses)."
12406 #: ../src/guestfs-actions.pod:4758 ../fish/guestfish-actions.pod:3696
12411 #: ../src/guestfs-actions.pod:4760 ../fish/guestfish-actions.pod:3698
12412 msgid "Single 8-bit-byte characters."
12416 #: ../src/guestfs-actions.pod:4762 ../fish/guestfish-actions.pod:3700
12421 #: ../src/guestfs-actions.pod:4764 ../fish/guestfish-actions.pod:3702
12422 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
12426 #: ../src/guestfs-actions.pod:4767 ../fish/guestfish-actions.pod:3705
12427 msgid "l (lower case letter L)"
12431 #: ../src/guestfs-actions.pod:4769 ../fish/guestfish-actions.pod:3707
12433 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
12434 "examining binaries in Windows guests."
12438 #: ../src/guestfs-actions.pod:4772 ../fish/guestfish-actions.pod:3710
12443 #: ../src/guestfs-actions.pod:4774 ../fish/guestfish-actions.pod:3712
12444 msgid "32-bit big endian such as UCS-4BE."
12448 #: ../src/guestfs-actions.pod:4776 ../fish/guestfish-actions.pod:3714
12453 #: ../src/guestfs-actions.pod:4778 ../fish/guestfish-actions.pod:3716
12454 msgid "32-bit little endian such as UCS-4LE."
12458 #: ../src/guestfs-actions.pod:4782 ../fish/guestfish-actions.pod:3720
12459 msgid "The returned strings are transcoded to UTF-8."
12463 #: ../src/guestfs-actions.pod:4791
12464 msgid "guestfs_swapoff_device"
12468 #: ../src/guestfs-actions.pod:4793
12471 " int guestfs_swapoff_device (guestfs_h *g,\n"
12472 "\t\tconst char *device);\n"
12477 #: ../src/guestfs-actions.pod:4796
12479 "This command disables the libguestfs appliance swap device or partition "
12480 "named C<device>. See C<guestfs_swapon_device>."
12484 #: ../src/guestfs-actions.pod:4802
12485 msgid "guestfs_swapoff_file"
12489 #: ../src/guestfs-actions.pod:4804
12492 " int guestfs_swapoff_file (guestfs_h *g,\n"
12493 "\t\tconst char *file);\n"
12498 #: ../src/guestfs-actions.pod:4807 ../fish/guestfish-actions.pod:3737
12499 msgid "This command disables the libguestfs appliance swap on file."
12503 #: ../src/guestfs-actions.pod:4811
12504 msgid "guestfs_swapoff_label"
12508 #: ../src/guestfs-actions.pod:4813
12511 " int guestfs_swapoff_label (guestfs_h *g,\n"
12512 "\t\tconst char *label);\n"
12517 #: ../src/guestfs-actions.pod:4816 ../fish/guestfish-actions.pod:3743
12519 "This command disables the libguestfs appliance swap on labeled swap "
12524 #: ../src/guestfs-actions.pod:4821
12525 msgid "guestfs_swapoff_uuid"
12529 #: ../src/guestfs-actions.pod:4823
12532 " int guestfs_swapoff_uuid (guestfs_h *g,\n"
12533 "\t\tconst char *uuid);\n"
12538 #: ../src/guestfs-actions.pod:4826 ../fish/guestfish-actions.pod:3750
12540 "This command disables the libguestfs appliance swap partition with the given "
12545 #: ../src/guestfs-actions.pod:4831
12546 msgid "guestfs_swapon_device"
12550 #: ../src/guestfs-actions.pod:4833
12553 " int guestfs_swapon_device (guestfs_h *g,\n"
12554 "\t\tconst char *device);\n"
12559 #: ../src/guestfs-actions.pod:4836
12561 "This command enables the libguestfs appliance to use the swap device or "
12562 "partition named C<device>. The increased memory is made available for all "
12563 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
12567 #: ../src/guestfs-actions.pod:4841 ../fish/guestfish-actions.pod:3762
12569 "Note that you should not swap to existing guest swap partitions unless you "
12570 "know what you are doing. They may contain hibernation information, or other "
12571 "information that the guest doesn't want you to trash. You also risk leaking "
12572 "information about the host to the guest this way. Instead, attach a new "
12573 "host device to the guest and swap on that."
12577 #: ../src/guestfs-actions.pod:4850
12578 msgid "guestfs_swapon_file"
12582 #: ../src/guestfs-actions.pod:4852
12585 " int guestfs_swapon_file (guestfs_h *g,\n"
12586 "\t\tconst char *file);\n"
12591 #: ../src/guestfs-actions.pod:4855
12593 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
12598 #: ../src/guestfs-actions.pod:4860
12599 msgid "guestfs_swapon_label"
12603 #: ../src/guestfs-actions.pod:4862
12606 " int guestfs_swapon_label (guestfs_h *g,\n"
12607 "\t\tconst char *label);\n"
12612 #: ../src/guestfs-actions.pod:4865
12614 "This command enables swap to a labeled swap partition. See "
12615 "C<guestfs_swapon_device> for other notes."
12619 #: ../src/guestfs-actions.pod:4870
12620 msgid "guestfs_swapon_uuid"
12624 #: ../src/guestfs-actions.pod:4872
12627 " int guestfs_swapon_uuid (guestfs_h *g,\n"
12628 "\t\tconst char *uuid);\n"
12633 #: ../src/guestfs-actions.pod:4875
12635 "This command enables swap to a swap partition with the given UUID. See "
12636 "C<guestfs_swapon_device> for other notes."
12640 #: ../src/guestfs-actions.pod:4880
12641 msgid "guestfs_sync"
12645 #: ../src/guestfs-actions.pod:4882
12648 " int guestfs_sync (guestfs_h *g);\n"
12653 #: ../src/guestfs-actions.pod:4884 ../fish/guestfish-actions.pod:3794
12655 "This syncs the disk, so that any writes are flushed through to the "
12656 "underlying disk image."
12660 #: ../src/guestfs-actions.pod:4887 ../fish/guestfish-actions.pod:3797
12662 "You should always call this if you have modified a disk image, before "
12663 "closing the handle."
12667 #: ../src/guestfs-actions.pod:4892
12668 msgid "guestfs_tail"
12672 #: ../src/guestfs-actions.pod:4894
12675 " char **guestfs_tail (guestfs_h *g,\n"
12676 "\t\tconst char *path);\n"
12681 #: ../src/guestfs-actions.pod:4897 ../fish/guestfish-actions.pod:3804
12683 "This command returns up to the last 10 lines of a file as a list of strings."
12687 #: ../src/guestfs-actions.pod:4907
12688 msgid "guestfs_tail_n"
12692 #: ../src/guestfs-actions.pod:4909
12695 " char **guestfs_tail_n (guestfs_h *g,\n"
12696 "\t\tint nrlines,\n"
12697 "\t\tconst char *path);\n"
12702 #: ../src/guestfs-actions.pod:4913 ../fish/guestfish-actions.pod:3814
12704 "If the parameter C<nrlines> is a positive number, this returns the last "
12705 "C<nrlines> lines of the file C<path>."
12709 #: ../src/guestfs-actions.pod:4916 ../fish/guestfish-actions.pod:3817
12711 "If the parameter C<nrlines> is a negative number, this returns lines from "
12712 "the file C<path>, starting with the C<-nrlines>th line."
12716 #: ../src/guestfs-actions.pod:4928
12717 msgid "guestfs_tar_in"
12721 #: ../src/guestfs-actions.pod:4930
12724 " int guestfs_tar_in (guestfs_h *g,\n"
12725 "\t\tconst char *tarfile,\n"
12726 "\t\tconst char *directory);\n"
12731 #: ../src/guestfs-actions.pod:4934 ../fish/guestfish-actions.pod:3829
12733 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
12734 "tar file) into C<directory>."
12738 #: ../src/guestfs-actions.pod:4937
12740 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
12744 #: ../src/guestfs-actions.pod:4942
12745 msgid "guestfs_tar_out"
12749 #: ../src/guestfs-actions.pod:4944
12752 " int guestfs_tar_out (guestfs_h *g,\n"
12753 "\t\tconst char *directory,\n"
12754 "\t\tconst char *tarfile);\n"
12759 #: ../src/guestfs-actions.pod:4948 ../fish/guestfish-actions.pod:3841
12761 "This command packs the contents of C<directory> and downloads it to local "
12766 #: ../src/guestfs-actions.pod:4951
12768 "To download a compressed tarball, use C<guestfs_tgz_out> or "
12769 "C<guestfs_txz_out>."
12773 #: ../src/guestfs-actions.pod:4956
12774 msgid "guestfs_tgz_in"
12778 #: ../src/guestfs-actions.pod:4958
12781 " int guestfs_tgz_in (guestfs_h *g,\n"
12782 "\t\tconst char *tarball,\n"
12783 "\t\tconst char *directory);\n"
12788 #: ../src/guestfs-actions.pod:4962 ../fish/guestfish-actions.pod:3853
12790 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
12791 "tar file) into C<directory>."
12795 #: ../src/guestfs-actions.pod:4965
12796 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
12800 #: ../src/guestfs-actions.pod:4969
12801 msgid "guestfs_tgz_out"
12805 #: ../src/guestfs-actions.pod:4971
12808 " int guestfs_tgz_out (guestfs_h *g,\n"
12809 "\t\tconst char *directory,\n"
12810 "\t\tconst char *tarball);\n"
12815 #: ../src/guestfs-actions.pod:4975 ../fish/guestfish-actions.pod:3864
12817 "This command packs the contents of C<directory> and downloads it to local "
12822 #: ../src/guestfs-actions.pod:4978
12823 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
12827 #: ../src/guestfs-actions.pod:4982
12828 msgid "guestfs_touch"
12832 #: ../src/guestfs-actions.pod:4984
12835 " int guestfs_touch (guestfs_h *g,\n"
12836 "\t\tconst char *path);\n"
12841 #: ../src/guestfs-actions.pod:4987 ../fish/guestfish-actions.pod:3875
12843 "Touch acts like the L<touch(1)> command. It can be used to update the "
12844 "timestamps on a file, or, if the file does not exist, to create a new zero-"
12849 #: ../src/guestfs-actions.pod:4991 ../fish/guestfish-actions.pod:3879
12851 "This command only works on regular files, and will fail on other file types "
12852 "such as directories, symbolic links, block special etc."
12856 #: ../src/guestfs-actions.pod:4996
12857 msgid "guestfs_truncate"
12861 #: ../src/guestfs-actions.pod:4998
12864 " int guestfs_truncate (guestfs_h *g,\n"
12865 "\t\tconst char *path);\n"
12870 #: ../src/guestfs-actions.pod:5001 ../fish/guestfish-actions.pod:3886
12872 "This command truncates C<path> to a zero-length file. The file must exist "
12877 #: ../src/guestfs-actions.pod:5006
12878 msgid "guestfs_truncate_size"
12882 #: ../src/guestfs-actions.pod:5008
12885 " int guestfs_truncate_size (guestfs_h *g,\n"
12886 "\t\tconst char *path,\n"
12887 "\t\tint64_t size);\n"
12892 #: ../src/guestfs-actions.pod:5012 ../fish/guestfish-actions.pod:3893
12894 "This command truncates C<path> to size C<size> bytes. The file must exist "
12899 #: ../src/guestfs-actions.pod:5015
12901 "If the current file size is less than C<size> then the file is extended to "
12902 "the required size with zero bytes. This creates a sparse file (ie. disk "
12903 "blocks are not allocated for the file until you write to it). To create a "
12904 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
12908 #: ../src/guestfs-actions.pod:5023
12909 msgid "guestfs_tune2fs_l"
12913 #: ../src/guestfs-actions.pod:5025
12916 " char **guestfs_tune2fs_l (guestfs_h *g,\n"
12917 "\t\tconst char *device);\n"
12922 #: ../src/guestfs-actions.pod:5028 ../fish/guestfish-actions.pod:3906
12924 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
12929 #: ../src/guestfs-actions.pod:5031 ../fish/guestfish-actions.pod:3909
12931 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
12932 "for more details. The list of fields returned isn't clearly defined, and "
12933 "depends on both the version of C<tune2fs> that libguestfs was built against, "
12934 "and the filesystem itself."
12938 #: ../src/guestfs-actions.pod:5042
12939 msgid "guestfs_txz_in"
12943 #: ../src/guestfs-actions.pod:5044
12946 " int guestfs_txz_in (guestfs_h *g,\n"
12947 "\t\tconst char *tarball,\n"
12948 "\t\tconst char *directory);\n"
12953 #: ../src/guestfs-actions.pod:5048 ../fish/guestfish-actions.pod:3918
12955 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
12956 "tar file) into C<directory>."
12960 #: ../src/guestfs-actions.pod:5053
12961 msgid "guestfs_txz_out"
12965 #: ../src/guestfs-actions.pod:5055
12968 " int guestfs_txz_out (guestfs_h *g,\n"
12969 "\t\tconst char *directory,\n"
12970 "\t\tconst char *tarball);\n"
12975 #: ../src/guestfs-actions.pod:5059 ../fish/guestfish-actions.pod:3927
12977 "This command packs the contents of C<directory> and downloads it to local "
12978 "file C<tarball> (as an xz compressed tar archive)."
12982 #: ../src/guestfs-actions.pod:5064
12983 msgid "guestfs_umask"
12987 #: ../src/guestfs-actions.pod:5066
12990 " int guestfs_umask (guestfs_h *g,\n"
12996 #: ../src/guestfs-actions.pod:5069 ../fish/guestfish-actions.pod:3936
12998 "This function sets the mask used for creating new files and device nodes to "
13003 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3939
13005 "Typical umask values would be C<022> which creates new files with "
13006 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
13007 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
13011 #: ../src/guestfs-actions.pod:5077 ../fish/guestfish-actions.pod:3944
13013 "The default umask is C<022>. This is important because it means that "
13014 "directories and device nodes will be created with C<0644> or C<0755> mode "
13015 "even if you specify C<0777>."
13019 #: ../src/guestfs-actions.pod:5081
13021 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
13022 "C<guestfs_mkdir>."
13026 #: ../src/guestfs-actions.pod:5084 ../fish/guestfish-actions.pod:3951
13027 msgid "This call returns the previous umask."
13031 #: ../src/guestfs-actions.pod:5088
13032 msgid "guestfs_umount"
13036 #: ../src/guestfs-actions.pod:5090
13039 " int guestfs_umount (guestfs_h *g,\n"
13040 "\t\tconst char *pathordevice);\n"
13045 #: ../src/guestfs-actions.pod:5093 ../fish/guestfish-actions.pod:3959
13047 "This unmounts the given filesystem. The filesystem may be specified either "
13048 "by its mountpoint (path) or the device which contains the filesystem."
13052 #: ../src/guestfs-actions.pod:5099
13053 msgid "guestfs_umount_all"
13057 #: ../src/guestfs-actions.pod:5101
13060 " int guestfs_umount_all (guestfs_h *g);\n"
13065 #: ../src/guestfs-actions.pod:5103 ../fish/guestfish-actions.pod:3969
13066 msgid "This unmounts all mounted filesystems."
13070 #: ../src/guestfs-actions.pod:5105 ../fish/guestfish-actions.pod:3971
13071 msgid "Some internal mounts are not unmounted by this call."
13075 #: ../src/guestfs-actions.pod:5109
13076 msgid "guestfs_upload"
13080 #: ../src/guestfs-actions.pod:5111
13083 " int guestfs_upload (guestfs_h *g,\n"
13084 "\t\tconst char *filename,\n"
13085 "\t\tconst char *remotefilename);\n"
13090 #: ../src/guestfs-actions.pod:5115 ../src/guestfs-actions.pod:5131
13091 #: ../fish/guestfish-actions.pod:3977 ../fish/guestfish-actions.pod:3990
13092 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
13096 #: ../src/guestfs-actions.pod:5120
13097 msgid "See also C<guestfs_download>."
13101 #: ../src/guestfs-actions.pod:5124
13102 msgid "guestfs_upload_offset"
13106 #: ../src/guestfs-actions.pod:5126
13109 " int guestfs_upload_offset (guestfs_h *g,\n"
13110 "\t\tconst char *filename,\n"
13111 "\t\tconst char *remotefilename,\n"
13112 "\t\tint64_t offset);\n"
13117 #: ../src/guestfs-actions.pod:5134 ../fish/guestfish-actions.pod:3993
13119 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
13120 "The intention is to overwrite parts of existing files or devices, although "
13121 "if a non-existant file is specified then it is created with a \"hole\" "
13122 "before C<offset>. The size of the data written is implicit in the size of "
13123 "the source C<filename>."
13127 #: ../src/guestfs-actions.pod:5141
13129 "Note that there is no limit on the amount of data that can be uploaded with "
13130 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
13131 "full amount unless an error occurs."
13135 #: ../src/guestfs-actions.pod:5146
13136 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
13140 #: ../src/guestfs-actions.pod:5150
13141 msgid "guestfs_utimens"
13145 #: ../src/guestfs-actions.pod:5152
13148 " int guestfs_utimens (guestfs_h *g,\n"
13149 "\t\tconst char *path,\n"
13150 "\t\tint64_t atsecs,\n"
13151 "\t\tint64_t atnsecs,\n"
13152 "\t\tint64_t mtsecs,\n"
13153 "\t\tint64_t mtnsecs);\n"
13158 #: ../src/guestfs-actions.pod:5159 ../fish/guestfish-actions.pod:4013
13159 msgid "This command sets the timestamps of a file with nanosecond precision."
13163 #: ../src/guestfs-actions.pod:5162 ../fish/guestfish-actions.pod:4016
13165 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
13170 #: ../src/guestfs-actions.pod:5165 ../fish/guestfish-actions.pod:4019
13172 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
13173 "nanoseconds from the epoch."
13177 #: ../src/guestfs-actions.pod:5168 ../fish/guestfish-actions.pod:4022
13179 "If the C<*nsecs> field contains the special value C<-1> then the "
13180 "corresponding timestamp is set to the current time. (The C<*secs> field is "
13181 "ignored in this case)."
13185 #: ../src/guestfs-actions.pod:5172 ../fish/guestfish-actions.pod:4026
13187 "If the C<*nsecs> field contains the special value C<-2> then the "
13188 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
13193 #: ../src/guestfs-actions.pod:5178 ../src/guestfs-structs.pod:175
13194 msgid "guestfs_version"
13198 #: ../src/guestfs-actions.pod:5180
13201 " struct guestfs_version *guestfs_version (guestfs_h *g);\n"
13206 #: ../src/guestfs-actions.pod:5182 ../fish/guestfish-actions.pod:4034
13208 "Return the libguestfs version number that the program is linked against."
13212 #: ../src/guestfs-actions.pod:5185 ../fish/guestfish-actions.pod:4037
13214 "Note that because of dynamic linking this is not necessarily the version of "
13215 "libguestfs that you compiled against. You can compile the program, and then "
13216 "at runtime dynamically link against a completely different C<libguestfs.so> "
13221 #: ../src/guestfs-actions.pod:5190 ../fish/guestfish-actions.pod:4042
13223 "This call was added in version C<1.0.58>. In previous versions of "
13224 "libguestfs there was no way to get the version number. From C code you can "
13225 "use dynamic linker functions to find out if this symbol exists (if it "
13226 "doesn't, then it's an earlier version)."
13230 #: ../src/guestfs-actions.pod:5196 ../fish/guestfish-actions.pod:4048
13232 "The call returns a structure with four elements. The first three (C<major>, "
13233 "C<minor> and C<release>) are numbers and correspond to the usual version "
13234 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
13235 "but may be used for distro-specific information."
13239 #: ../src/guestfs-actions.pod:5202 ../fish/guestfish-actions.pod:4054
13241 "To construct the original version string: C<$major.$minor.$release$extra>"
13245 #: ../src/guestfs-actions.pod:5205 ../fish/guestfish-actions.pod:4057
13246 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
13250 #: ../src/guestfs-actions.pod:5207
13252 "I<Note:> Don't use this call to test for availability of features. In "
13253 "enterprise distributions we backport features from later versions into "
13254 "earlier versions, making this an unreliable way to test for features. Use "
13255 "C<guestfs_available> instead."
13259 #: ../src/guestfs-actions.pod:5213
13261 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
13262 "error. I<The caller must call C<guestfs_free_version> after use>."
13266 #: ../src/guestfs-actions.pod:5217
13267 msgid "guestfs_vfs_label"
13271 #: ../src/guestfs-actions.pod:5219
13274 " char *guestfs_vfs_label (guestfs_h *g,\n"
13275 "\t\tconst char *device);\n"
13280 #: ../src/guestfs-actions.pod:5222 ../fish/guestfish-actions.pod:4069
13281 msgid "This returns the filesystem label of the filesystem on C<device>."
13285 #: ../src/guestfs-actions.pod:5225 ../fish/guestfish-actions.pod:4072
13286 msgid "If the filesystem is unlabeled, this returns the empty string."
13290 #: ../src/guestfs-actions.pod:5227
13291 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
13295 #: ../src/guestfs-actions.pod:5232
13296 msgid "guestfs_vfs_type"
13300 #: ../src/guestfs-actions.pod:5234
13303 " char *guestfs_vfs_type (guestfs_h *g,\n"
13304 "\t\tconst char *device);\n"
13309 #: ../src/guestfs-actions.pod:5237 ../fish/guestfish-actions.pod:4080
13311 "This command gets the filesystem type corresponding to the filesystem on "
13316 #: ../src/guestfs-actions.pod:5240 ../fish/guestfish-actions.pod:4083
13318 "For most filesystems, the result is the name of the Linux VFS module which "
13319 "would be used to mount this filesystem if you mounted it without specifying "
13320 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
13324 #: ../src/guestfs-actions.pod:5248
13325 msgid "guestfs_vfs_uuid"
13329 #: ../src/guestfs-actions.pod:5250
13332 " char *guestfs_vfs_uuid (guestfs_h *g,\n"
13333 "\t\tconst char *device);\n"
13338 #: ../src/guestfs-actions.pod:5253 ../fish/guestfish-actions.pod:4092
13339 msgid "This returns the filesystem UUID of the filesystem on C<device>."
13343 #: ../src/guestfs-actions.pod:5256 ../fish/guestfish-actions.pod:4095
13344 msgid "If the filesystem does not have a UUID, this returns the empty string."
13348 #: ../src/guestfs-actions.pod:5258
13349 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
13353 #: ../src/guestfs-actions.pod:5263
13354 msgid "guestfs_vg_activate"
13358 #: ../src/guestfs-actions.pod:5265
13361 " int guestfs_vg_activate (guestfs_h *g,\n"
13362 "\t\tint activate,\n"
13363 "\t\tchar *const *volgroups);\n"
13368 #: ../src/guestfs-actions.pod:5269 ../fish/guestfish-actions.pod:4103
13370 "This command activates or (if C<activate> is false) deactivates all logical "
13371 "volumes in the listed volume groups C<volgroups>. If activated, then they "
13372 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
13373 "deactivated, then those devices disappear."
13377 #: ../src/guestfs-actions.pod:5275 ../fish/guestfish-actions.pod:4109
13378 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
13382 #: ../src/guestfs-actions.pod:5277 ../fish/guestfish-actions.pod:4111
13384 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
13385 "activated or deactivated."
13389 #: ../src/guestfs-actions.pod:5282
13390 msgid "guestfs_vg_activate_all"
13394 #: ../src/guestfs-actions.pod:5284
13397 " int guestfs_vg_activate_all (guestfs_h *g,\n"
13398 "\t\tint activate);\n"
13403 #: ../src/guestfs-actions.pod:5287 ../fish/guestfish-actions.pod:4118
13405 "This command activates or (if C<activate> is false) deactivates all logical "
13406 "volumes in all volume groups. If activated, then they are made known to the "
13407 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
13408 "those devices disappear."
13412 #: ../src/guestfs-actions.pod:5293 ../fish/guestfish-actions.pod:4124
13413 msgid "This command is the same as running C<vgchange -a y|n>"
13417 #: ../src/guestfs-actions.pod:5297
13418 msgid "guestfs_vgcreate"
13422 #: ../src/guestfs-actions.pod:5299
13425 " int guestfs_vgcreate (guestfs_h *g,\n"
13426 "\t\tconst char *volgroup,\n"
13427 "\t\tchar *const *physvols);\n"
13432 #: ../src/guestfs-actions.pod:5303 ../fish/guestfish-actions.pod:4130
13434 "This creates an LVM volume group called C<volgroup> from the non-empty list "
13435 "of physical volumes C<physvols>."
13439 #: ../src/guestfs-actions.pod:5308
13440 msgid "guestfs_vglvuuids"
13444 #: ../src/guestfs-actions.pod:5310
13447 " char **guestfs_vglvuuids (guestfs_h *g,\n"
13448 "\t\tconst char *vgname);\n"
13453 #: ../src/guestfs-actions.pod:5313 ../fish/guestfish-actions.pod:4137
13455 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
13456 "volumes created in this volume group."
13460 #: ../src/guestfs-actions.pod:5316
13462 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
13463 "associate logical volumes and volume groups."
13467 #: ../src/guestfs-actions.pod:5319
13468 msgid "See also C<guestfs_vgpvuuids>."
13472 #: ../src/guestfs-actions.pod:5325
13473 msgid "guestfs_vgpvuuids"
13477 #: ../src/guestfs-actions.pod:5327
13480 " char **guestfs_vgpvuuids (guestfs_h *g,\n"
13481 "\t\tconst char *vgname);\n"
13486 #: ../src/guestfs-actions.pod:5330 ../fish/guestfish-actions.pod:4149
13488 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
13489 "volumes that this volume group resides on."
13493 #: ../src/guestfs-actions.pod:5333
13495 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
13496 "associate physical volumes and volume groups."
13500 #: ../src/guestfs-actions.pod:5336
13501 msgid "See also C<guestfs_vglvuuids>."
13505 #: ../src/guestfs-actions.pod:5342
13506 msgid "guestfs_vgremove"
13510 #: ../src/guestfs-actions.pod:5344
13513 " int guestfs_vgremove (guestfs_h *g,\n"
13514 "\t\tconst char *vgname);\n"
13519 #: ../src/guestfs-actions.pod:5347 ../fish/guestfish-actions.pod:4161
13520 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
13524 #: ../src/guestfs-actions.pod:5349 ../fish/guestfish-actions.pod:4163
13526 "This also forcibly removes all logical volumes in the volume group (if any)."
13530 #: ../src/guestfs-actions.pod:5354
13531 msgid "guestfs_vgrename"
13535 #: ../src/guestfs-actions.pod:5356
13538 " int guestfs_vgrename (guestfs_h *g,\n"
13539 "\t\tconst char *volgroup,\n"
13540 "\t\tconst char *newvolgroup);\n"
13545 #: ../src/guestfs-actions.pod:5360 ../fish/guestfish-actions.pod:4170
13546 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
13550 #: ../src/guestfs-actions.pod:5364
13551 msgid "guestfs_vgs"
13555 #: ../src/guestfs-actions.pod:5366
13558 " char **guestfs_vgs (guestfs_h *g);\n"
13563 #: ../src/guestfs-actions.pod:5368 ../fish/guestfish-actions.pod:4176
13565 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
13570 #: ../src/guestfs-actions.pod:5371 ../fish/guestfish-actions.pod:4179
13572 "This returns a list of just the volume group names that were detected (eg. "
13577 #: ../src/guestfs-actions.pod:5374
13578 msgid "See also C<guestfs_vgs_full>."
13582 #: ../src/guestfs-actions.pod:5380
13583 msgid "guestfs_vgs_full"
13587 #: ../src/guestfs-actions.pod:5382
13590 " struct guestfs_lvm_vg_list *guestfs_vgs_full (guestfs_h *g);\n"
13595 #: ../src/guestfs-actions.pod:5384 ../fish/guestfish-actions.pod:4188
13597 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
13598 "> command. The \"full\" version includes all fields."
13602 #: ../src/guestfs-actions.pod:5387
13604 "This function returns a C<struct guestfs_lvm_vg_list *> (see E<lt>guestfs-"
13605 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
13606 "C<guestfs_free_lvm_vg_list> after use>."
13610 #: ../src/guestfs-actions.pod:5392
13611 msgid "guestfs_vgscan"
13615 #: ../src/guestfs-actions.pod:5394
13618 " int guestfs_vgscan (guestfs_h *g);\n"
13623 #: ../src/guestfs-actions.pod:5396 ../fish/guestfish-actions.pod:4195
13625 "This rescans all block devices and rebuilds the list of LVM physical "
13626 "volumes, volume groups and logical volumes."
13630 #: ../src/guestfs-actions.pod:5401
13631 msgid "guestfs_vguuid"
13635 #: ../src/guestfs-actions.pod:5403
13638 " char *guestfs_vguuid (guestfs_h *g,\n"
13639 "\t\tconst char *vgname);\n"
13644 #: ../src/guestfs-actions.pod:5406 ../fish/guestfish-actions.pod:4202
13645 msgid "This command returns the UUID of the LVM VG named C<vgname>."
13649 #: ../src/guestfs-actions.pod:5411
13650 msgid "guestfs_wait_ready"
13654 #: ../src/guestfs-actions.pod:5413
13657 " int guestfs_wait_ready (guestfs_h *g);\n"
13662 #: ../src/guestfs-actions.pod:5415
13663 msgid "This function is a no op."
13667 #: ../src/guestfs-actions.pod:5417
13669 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
13670 "calling C<guestfs_launch> to wait for the launch to complete. However this "
13671 "is no longer necessary because C<guestfs_launch> now does the waiting."
13675 #: ../src/guestfs-actions.pod:5422
13677 "If you see any calls to this function in code then you can just remove them, "
13678 "unless you want to retain compatibility with older versions of the API."
13682 #: ../src/guestfs-actions.pod:5428
13683 msgid "guestfs_wc_c"
13687 #: ../src/guestfs-actions.pod:5430
13690 " int guestfs_wc_c (guestfs_h *g,\n"
13691 "\t\tconst char *path);\n"
13696 #: ../src/guestfs-actions.pod:5433 ../fish/guestfish-actions.pod:4208
13698 "This command counts the characters in a file, using the C<wc -c> external "
13703 #: ../src/guestfs-actions.pod:5438
13704 msgid "guestfs_wc_l"
13708 #: ../src/guestfs-actions.pod:5440
13711 " int guestfs_wc_l (guestfs_h *g,\n"
13712 "\t\tconst char *path);\n"
13717 #: ../src/guestfs-actions.pod:5443 ../fish/guestfish-actions.pod:4215
13719 "This command counts the lines in a file, using the C<wc -l> external command."
13723 #: ../src/guestfs-actions.pod:5448
13724 msgid "guestfs_wc_w"
13728 #: ../src/guestfs-actions.pod:5450
13731 " int guestfs_wc_w (guestfs_h *g,\n"
13732 "\t\tconst char *path);\n"
13737 #: ../src/guestfs-actions.pod:5453 ../fish/guestfish-actions.pod:4222
13739 "This command counts the words in a file, using the C<wc -w> external command."
13743 #: ../src/guestfs-actions.pod:5458
13744 msgid "guestfs_write"
13748 #: ../src/guestfs-actions.pod:5460
13751 " int guestfs_write (guestfs_h *g,\n"
13752 "\t\tconst char *path,\n"
13753 "\t\tconst char *content,\n"
13754 "\t\tsize_t content_size);\n"
13759 #: ../src/guestfs-actions.pod:5465 ../fish/guestfish-actions.pod:4229
13761 "This call creates a file called C<path>. The content of the file is the "
13762 "string C<content> (which can contain any 8 bit data)."
13766 #: ../src/guestfs-actions.pod:5473
13767 msgid "guestfs_write_file"
13771 #: ../src/guestfs-actions.pod:5475
13774 " int guestfs_write_file (guestfs_h *g,\n"
13775 "\t\tconst char *path,\n"
13776 "\t\tconst char *content,\n"
13782 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:4239
13784 "This call creates a file called C<path>. The contents of the file is the "
13785 "string C<content> (which can contain any 8 bit data), with length C<size>."
13789 #: ../src/guestfs-actions.pod:5484 ../fish/guestfish-actions.pod:4243
13791 "As a special case, if C<size> is C<0> then the length is calculated using "
13792 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
13796 #: ../src/guestfs-actions.pod:5488 ../fish/guestfish-actions.pod:4247
13798 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
13799 "I<not> work, even if the length is specified."
13803 #: ../src/guestfs-actions.pod:5496 ../fish/guestfish-actions.pod:4253
13805 "This function is deprecated. In new code, use the C<write> call instead."
13809 #: ../src/guestfs-actions.pod:5503
13810 msgid "guestfs_zegrep"
13814 #: ../src/guestfs-actions.pod:5505
13817 " char **guestfs_zegrep (guestfs_h *g,\n"
13818 "\t\tconst char *regex,\n"
13819 "\t\tconst char *path);\n"
13824 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:4264
13826 "This calls the external C<zegrep> program and returns the matching lines."
13830 #: ../src/guestfs-actions.pod:5519
13831 msgid "guestfs_zegrepi"
13835 #: ../src/guestfs-actions.pod:5521
13838 " char **guestfs_zegrepi (guestfs_h *g,\n"
13839 "\t\tconst char *regex,\n"
13840 "\t\tconst char *path);\n"
13845 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:4274
13847 "This calls the external C<zegrep -i> program and returns the matching lines."
13851 #: ../src/guestfs-actions.pod:5535
13852 msgid "guestfs_zero"
13856 #: ../src/guestfs-actions.pod:5537
13859 " int guestfs_zero (guestfs_h *g,\n"
13860 "\t\tconst char *device);\n"
13865 #: ../src/guestfs-actions.pod:5540 ../fish/guestfish-actions.pod:4284
13866 msgid "This command writes zeroes over the first few blocks of C<device>."
13870 #: ../src/guestfs-actions.pod:5542 ../fish/guestfish-actions.pod:4286
13872 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
13873 "securely wipe the device). It should be sufficient to remove any partition "
13874 "tables, filesystem superblocks and so on."
13878 #: ../src/guestfs-actions.pod:5546
13879 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
13883 #: ../src/guestfs-actions.pod:5555
13884 msgid "guestfs_zero_device"
13888 #: ../src/guestfs-actions.pod:5557
13891 " int guestfs_zero_device (guestfs_h *g,\n"
13892 "\t\tconst char *device);\n"
13897 #: ../src/guestfs-actions.pod:5560
13899 "This command writes zeroes over the entire C<device>. Compare with "
13900 "C<guestfs_zero> which just zeroes the first few blocks of a device."
13904 #: ../src/guestfs-actions.pod:5574
13905 msgid "guestfs_zerofree"
13909 #: ../src/guestfs-actions.pod:5576
13912 " int guestfs_zerofree (guestfs_h *g,\n"
13913 "\t\tconst char *device);\n"
13918 #: ../src/guestfs-actions.pod:5579 ../fish/guestfish-actions.pod:4307
13920 "This runs the I<zerofree> program on C<device>. This program claims to zero "
13921 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
13922 "possible to compress the filesystem more effectively."
13926 #: ../src/guestfs-actions.pod:5584 ../fish/guestfish-actions.pod:4312
13927 msgid "You should B<not> run this program if the filesystem is mounted."
13931 #: ../src/guestfs-actions.pod:5587 ../fish/guestfish-actions.pod:4315
13933 "It is possible that using this program can damage the filesystem or data on "
13938 #: ../src/guestfs-actions.pod:5592
13939 msgid "guestfs_zfgrep"
13943 #: ../src/guestfs-actions.pod:5594
13946 " char **guestfs_zfgrep (guestfs_h *g,\n"
13947 "\t\tconst char *pattern,\n"
13948 "\t\tconst char *path);\n"
13953 #: ../src/guestfs-actions.pod:5598 ../fish/guestfish-actions.pod:4322
13955 "This calls the external C<zfgrep> program and returns the matching lines."
13959 #: ../src/guestfs-actions.pod:5608
13960 msgid "guestfs_zfgrepi"
13964 #: ../src/guestfs-actions.pod:5610
13967 " char **guestfs_zfgrepi (guestfs_h *g,\n"
13968 "\t\tconst char *pattern,\n"
13969 "\t\tconst char *path);\n"
13974 #: ../src/guestfs-actions.pod:5614 ../fish/guestfish-actions.pod:4332
13976 "This calls the external C<zfgrep -i> program and returns the matching lines."
13980 #: ../src/guestfs-actions.pod:5624
13981 msgid "guestfs_zfile"
13985 #: ../src/guestfs-actions.pod:5626
13988 " char *guestfs_zfile (guestfs_h *g,\n"
13989 "\t\tconst char *meth,\n"
13990 "\t\tconst char *path);\n"
13995 #: ../src/guestfs-actions.pod:5630 ../fish/guestfish-actions.pod:4342
13997 "This command runs C<file> after first decompressing C<path> using C<method>."
14001 #: ../src/guestfs-actions.pod:5633 ../fish/guestfish-actions.pod:4345
14002 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
14006 #: ../src/guestfs-actions.pod:5635
14008 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
14013 #: ../src/guestfs-actions.pod:5641 ../fish/guestfish-actions.pod:4350
14015 "This function is deprecated. In new code, use the C<file> call instead."
14019 #: ../src/guestfs-actions.pod:5648
14020 msgid "guestfs_zgrep"
14024 #: ../src/guestfs-actions.pod:5650
14027 " char **guestfs_zgrep (guestfs_h *g,\n"
14028 "\t\tconst char *regex,\n"
14029 "\t\tconst char *path);\n"
14034 #: ../src/guestfs-actions.pod:5654 ../fish/guestfish-actions.pod:4361
14036 "This calls the external C<zgrep> program and returns the matching lines."
14040 #: ../src/guestfs-actions.pod:5664
14041 msgid "guestfs_zgrepi"
14045 #: ../src/guestfs-actions.pod:5666
14048 " char **guestfs_zgrepi (guestfs_h *g,\n"
14049 "\t\tconst char *regex,\n"
14050 "\t\tconst char *path);\n"
14055 #: ../src/guestfs-actions.pod:5670 ../fish/guestfish-actions.pod:4371
14057 "This calls the external C<zgrep -i> program and returns the matching lines."
14061 #: ../src/guestfs-availability.pod:3
14066 #: ../src/guestfs-availability.pod:5
14068 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
14069 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
14070 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
14071 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
14072 "L</guestfs_aug_save> L</guestfs_aug_set>"
14076 #: ../src/guestfs-availability.pod:21
14081 #: ../src/guestfs-availability.pod:23
14083 "The following functions: L</guestfs_inotify_add_watch> L</"
14084 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
14085 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
14089 #: ../src/guestfs-availability.pod:31
14090 msgid "B<linuxfsuuid>"
14094 #: ../src/guestfs-availability.pod:33
14096 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
14097 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
14101 #: ../src/guestfs-availability.pod:40
14102 msgid "B<linuxmodules>"
14106 #: ../src/guestfs-availability.pod:42
14107 msgid "The following functions: L</guestfs_modprobe>"
14111 #: ../src/guestfs-availability.pod:45
14112 msgid "B<linuxxattrs>"
14116 #: ../src/guestfs-availability.pod:47
14118 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> L</"
14119 "guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</"
14120 "guestfs_removexattr> L</guestfs_setxattr>"
14124 #: ../src/guestfs-availability.pod:56
14129 #: ../src/guestfs-availability.pod:58
14131 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
14132 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
14133 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
14137 #: ../src/guestfs-availability.pod:67
14142 #: ../src/guestfs-availability.pod:69
14144 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
14145 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
14146 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
14147 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
14148 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
14149 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
14150 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
14154 #: ../src/guestfs-availability.pod:92
14159 #: ../src/guestfs-availability.pod:94
14161 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
14162 "guestfs_mknod_b> L</guestfs_mknod_c>"
14166 #: ../src/guestfs-availability.pod:100
14171 #: ../src/guestfs-availability.pod:102
14172 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
14176 #: ../src/guestfs-availability.pod:105
14177 msgid "B<ntfsprogs>"
14181 #: ../src/guestfs-availability.pod:107
14183 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
14187 #: ../src/guestfs-availability.pod:111
14188 msgid "B<realpath>"
14192 #: ../src/guestfs-availability.pod:113
14193 msgid "The following functions: L</guestfs_realpath>"
14197 #: ../src/guestfs-availability.pod:116
14202 #: ../src/guestfs-availability.pod:118
14204 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
14205 "guestfs_scrub_freespace>"
14209 #: ../src/guestfs-availability.pod:123
14214 #: ../src/guestfs-availability.pod:125
14215 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
14219 #: ../src/guestfs-availability.pod:129
14224 #: ../src/guestfs-availability.pod:131
14225 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
14229 #: ../src/guestfs-availability.pod:135
14230 msgid "B<zerofree>"
14234 #: ../src/guestfs-availability.pod:137
14235 msgid "The following functions: L</guestfs_zerofree>"
14239 #: ../src/guestfs-structs.pod:1
14240 msgid "guestfs_int_bool"
14244 #: ../src/guestfs-structs.pod:3
14247 " struct guestfs_int_bool {\n"
14255 #: ../src/guestfs-structs.pod:8
14258 " struct guestfs_int_bool_list {\n"
14259 " uint32_t len; /* Number of elements in list. */\n"
14260 " struct guestfs_int_bool *val; /* Elements. */\n"
14266 #: ../src/guestfs-structs.pod:13
14269 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
14270 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
14275 #: ../src/guestfs-structs.pod:16
14276 msgid "guestfs_lvm_pv"
14280 #: ../src/guestfs-structs.pod:18
14283 " struct guestfs_lvm_pv {\n"
14284 " char *pv_name;\n"
14285 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
14286 " char pv_uuid[32];\n"
14288 " uint64_t pv_size;\n"
14289 " uint64_t dev_size;\n"
14290 " uint64_t pv_free;\n"
14291 " uint64_t pv_used;\n"
14292 " char *pv_attr;\n"
14293 " int64_t pv_pe_count;\n"
14294 " int64_t pv_pe_alloc_count;\n"
14295 " char *pv_tags;\n"
14296 " uint64_t pe_start;\n"
14297 " int64_t pv_mda_count;\n"
14298 " uint64_t pv_mda_free;\n"
14304 #: ../src/guestfs-structs.pod:36
14307 " struct guestfs_lvm_pv_list {\n"
14308 " uint32_t len; /* Number of elements in list. */\n"
14309 " struct guestfs_lvm_pv *val; /* Elements. */\n"
14315 #: ../src/guestfs-structs.pod:41
14318 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
14319 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
14324 #: ../src/guestfs-structs.pod:44
14325 msgid "guestfs_lvm_vg"
14329 #: ../src/guestfs-structs.pod:46
14332 " struct guestfs_lvm_vg {\n"
14333 " char *vg_name;\n"
14334 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
14335 " char vg_uuid[32];\n"
14337 " char *vg_attr;\n"
14338 " uint64_t vg_size;\n"
14339 " uint64_t vg_free;\n"
14340 " char *vg_sysid;\n"
14341 " uint64_t vg_extent_size;\n"
14342 " int64_t vg_extent_count;\n"
14343 " int64_t vg_free_count;\n"
14344 " int64_t max_lv;\n"
14345 " int64_t max_pv;\n"
14346 " int64_t pv_count;\n"
14347 " int64_t lv_count;\n"
14348 " int64_t snap_count;\n"
14349 " int64_t vg_seqno;\n"
14350 " char *vg_tags;\n"
14351 " int64_t vg_mda_count;\n"
14352 " uint64_t vg_mda_free;\n"
14358 #: ../src/guestfs-structs.pod:69
14361 " struct guestfs_lvm_vg_list {\n"
14362 " uint32_t len; /* Number of elements in list. */\n"
14363 " struct guestfs_lvm_vg *val; /* Elements. */\n"
14369 #: ../src/guestfs-structs.pod:74
14372 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
14373 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
14378 #: ../src/guestfs-structs.pod:77
14379 msgid "guestfs_lvm_lv"
14383 #: ../src/guestfs-structs.pod:79
14386 " struct guestfs_lvm_lv {\n"
14387 " char *lv_name;\n"
14388 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
14389 " char lv_uuid[32];\n"
14390 " char *lv_attr;\n"
14391 " int64_t lv_major;\n"
14392 " int64_t lv_minor;\n"
14393 " int64_t lv_kernel_major;\n"
14394 " int64_t lv_kernel_minor;\n"
14395 " uint64_t lv_size;\n"
14396 " int64_t seg_count;\n"
14398 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
14399 " float snap_percent;\n"
14400 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
14401 " float copy_percent;\n"
14402 " char *move_pv;\n"
14403 " char *lv_tags;\n"
14404 " char *mirror_log;\n"
14405 " char *modules;\n"
14411 #: ../src/guestfs-structs.pod:101
14414 " struct guestfs_lvm_lv_list {\n"
14415 " uint32_t len; /* Number of elements in list. */\n"
14416 " struct guestfs_lvm_lv *val; /* Elements. */\n"
14422 #: ../src/guestfs-structs.pod:106
14425 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
14426 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
14431 #: ../src/guestfs-structs.pod:111
14434 " struct guestfs_stat {\n"
14438 " int64_t nlink;\n"
14443 " int64_t blksize;\n"
14444 " int64_t blocks;\n"
14445 " int64_t atime;\n"
14446 " int64_t mtime;\n"
14447 " int64_t ctime;\n"
14453 #: ../src/guestfs-structs.pod:127
14456 " struct guestfs_stat_list {\n"
14457 " uint32_t len; /* Number of elements in list. */\n"
14458 " struct guestfs_stat *val; /* Elements. */\n"
14464 #: ../src/guestfs-structs.pod:132
14467 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
14468 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
14473 #: ../src/guestfs-structs.pod:137
14476 " struct guestfs_statvfs {\n"
14477 " int64_t bsize;\n"
14478 " int64_t frsize;\n"
14479 " int64_t blocks;\n"
14480 " int64_t bfree;\n"
14481 " int64_t bavail;\n"
14482 " int64_t files;\n"
14483 " int64_t ffree;\n"
14484 " int64_t favail;\n"
14487 " int64_t namemax;\n"
14493 #: ../src/guestfs-structs.pod:151
14496 " struct guestfs_statvfs_list {\n"
14497 " uint32_t len; /* Number of elements in list. */\n"
14498 " struct guestfs_statvfs *val; /* Elements. */\n"
14504 #: ../src/guestfs-structs.pod:156
14507 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
14508 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
14513 #: ../src/guestfs-structs.pod:159
14514 msgid "guestfs_dirent"
14518 #: ../src/guestfs-structs.pod:161
14521 " struct guestfs_dirent {\n"
14530 #: ../src/guestfs-structs.pod:167
14533 " struct guestfs_dirent_list {\n"
14534 " uint32_t len; /* Number of elements in list. */\n"
14535 " struct guestfs_dirent *val; /* Elements. */\n"
14541 #: ../src/guestfs-structs.pod:172
14544 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
14545 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
14550 #: ../src/guestfs-structs.pod:177
14553 " struct guestfs_version {\n"
14554 " int64_t major;\n"
14555 " int64_t minor;\n"
14556 " int64_t release;\n"
14563 #: ../src/guestfs-structs.pod:184
14566 " struct guestfs_version_list {\n"
14567 " uint32_t len; /* Number of elements in list. */\n"
14568 " struct guestfs_version *val; /* Elements. */\n"
14574 #: ../src/guestfs-structs.pod:189
14577 " void guestfs_free_version (struct guestfs_free_version *);\n"
14578 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
14583 #: ../src/guestfs-structs.pod:192
14584 msgid "guestfs_xattr"
14588 #: ../src/guestfs-structs.pod:194
14591 " struct guestfs_xattr {\n"
14592 " char *attrname;\n"
14593 " /* The next two fields describe a byte array. */\n"
14594 " uint32_t attrval_len;\n"
14595 " char *attrval;\n"
14601 #: ../src/guestfs-structs.pod:201
14604 " struct guestfs_xattr_list {\n"
14605 " uint32_t len; /* Number of elements in list. */\n"
14606 " struct guestfs_xattr *val; /* Elements. */\n"
14612 #: ../src/guestfs-structs.pod:206
14615 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
14616 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
14621 #: ../src/guestfs-structs.pod:209
14622 msgid "guestfs_inotify_event"
14626 #: ../src/guestfs-structs.pod:211
14629 " struct guestfs_inotify_event {\n"
14630 " int64_t in_wd;\n"
14631 " uint32_t in_mask;\n"
14632 " uint32_t in_cookie;\n"
14633 " char *in_name;\n"
14639 #: ../src/guestfs-structs.pod:218
14642 " struct guestfs_inotify_event_list {\n"
14643 " uint32_t len; /* Number of elements in list. */\n"
14644 " struct guestfs_inotify_event *val; /* Elements. */\n"
14650 #: ../src/guestfs-structs.pod:223
14653 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
14654 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
14659 #: ../src/guestfs-structs.pod:226
14660 msgid "guestfs_partition"
14664 #: ../src/guestfs-structs.pod:228
14667 " struct guestfs_partition {\n"
14668 " int32_t part_num;\n"
14669 " uint64_t part_start;\n"
14670 " uint64_t part_end;\n"
14671 " uint64_t part_size;\n"
14677 #: ../src/guestfs-structs.pod:235
14680 " struct guestfs_partition_list {\n"
14681 " uint32_t len; /* Number of elements in list. */\n"
14682 " struct guestfs_partition *val; /* Elements. */\n"
14688 #: ../src/guestfs-structs.pod:240
14691 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
14692 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
14697 #: ../fish/guestfish.pod:5
14698 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
14702 #: ../fish/guestfish.pod:9
14705 " guestfish [--options] [commands]\n"
14710 #: ../fish/guestfish.pod:11
14718 #: ../fish/guestfish.pod:13
14721 " guestfish -a disk.img\n"
14726 #: ../fish/guestfish.pod:15
14729 " guestfish -a disk.img -m dev[:mountpoint]\n"
14734 #: ../fish/guestfish.pod:17
14737 " guestfish -d libvirt-domain\n"
14742 #: ../fish/guestfish.pod:19
14745 " guestfish -a disk.img -i\n"
14750 #: ../fish/guestfish.pod:21
14753 " guestfish -d libvirt-domain -i\n"
14758 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:11 ../tools/virt-edit.pl:45
14759 #: ../tools/virt-win-reg.pl:52 ../tools/virt-tar.pl:60
14760 #: ../tools/virt-rescue.pl:41
14765 #: ../fish/guestfish.pod:25
14767 "Using guestfish in read/write mode on live virtual machines can be "
14768 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
14769 "option to use guestfish safely if the disk image or virtual machine might be "
14774 #: ../fish/guestfish.pod:32
14776 "Guestfish is a shell and command-line tool for examining and modifying "
14777 "virtual machine filesystems. It uses libguestfs and exposes all of the "
14778 "functionality of the guestfs API, see L<guestfs(3)>."
14782 #: ../fish/guestfish.pod:36
14784 "Guestfish gives you structured access to the libguestfs API, from shell "
14785 "scripts or the command line or interactively. If you want to rescue a "
14786 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
14791 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:759
14792 #: ../fuse/guestmount.pod:35 ../tools/virt-edit.pl:59
14793 #: ../tools/virt-resize.pl:66 ../tools/virt-cat.pl:51 ../tools/virt-tar.pl:46
14798 #: ../fish/guestfish.pod:43
14799 msgid "As an interactive shell"
14803 #: ../fish/guestfish.pod:45
14811 #: ../fish/guestfish.pod:47
14814 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
14815 " editing virtual machine filesystems.\n"
14820 #: ../fish/guestfish.pod:50
14823 " Type: 'help' for a list of commands\n"
14824 " 'man' to read the manual\n"
14825 " 'quit' to quit the shell\n"
14830 #: ../fish/guestfish.pod:54
14833 " ><fs> add-ro disk.img\n"
14835 " ><fs> list-filesystems\n"
14836 " /dev/sda1: ext4\n"
14837 " /dev/vg_guest/lv_root: ext4\n"
14838 " /dev/vg_guest/lv_swap: swap\n"
14839 " ><fs> mount /dev/vg_guest/lv_root /\n"
14840 " ><fs> cat /etc/fstab\n"
14842 " # Created by anaconda\n"
14849 #: ../fish/guestfish.pod:67
14850 msgid "From shell scripts"
14854 #: ../fish/guestfish.pod:69
14855 msgid "Create a new C</etc/motd> file in a guest or disk image:"
14859 #: ../fish/guestfish.pod:71
14862 " guestfish <<_EOF_\n"
14865 " mount /dev/vg_guest/lv_root /\n"
14866 " write /etc/motd \"Welcome, new users\"\n"
14872 #: ../fish/guestfish.pod:78
14873 msgid "List the LVM logical volumes in a disk image:"
14877 #: ../fish/guestfish.pod:80
14880 " guestfish -a disk.img --ro <<_EOF_\n"
14888 #: ../fish/guestfish.pod:85
14889 msgid "List all the filesystems in a disk image:"
14893 #: ../fish/guestfish.pod:87
14896 " guestfish -a disk.img --ro <<_EOF_\n"
14898 " list-filesystems\n"
14904 #: ../fish/guestfish.pod:92
14905 msgid "On one command line"
14909 #: ../fish/guestfish.pod:94
14910 msgid "Update C</etc/resolv.conf> in a guest:"
14914 #: ../fish/guestfish.pod:96
14918 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
14919 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
14924 #: ../fish/guestfish.pod:100
14925 msgid "Edit C</boot/grub/grub.conf> interactively:"
14929 #: ../fish/guestfish.pod:102
14932 " guestfish --add disk.img \\\n"
14933 " --mount /dev/vg_guest/lv_root \\\n"
14934 " --mount /dev/sda1:/boot \\\n"
14935 " edit /boot/grub/grub.conf\n"
14940 #: ../fish/guestfish.pod:107
14941 msgid "Mount disks automatically"
14945 #: ../fish/guestfish.pod:109
14947 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
14951 #: ../fish/guestfish.pod:112
14954 " guestfish --ro -a disk.img -i cat /etc/group\n"
14959 #: ../fish/guestfish.pod:114
14962 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
14967 #: ../fish/guestfish.pod:116
14968 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
14972 #: ../fish/guestfish.pod:118
14975 " guestfish -a disk.img -i edit /boot/grub/grub.conf\n"
14980 #: ../fish/guestfish.pod:120
14981 msgid "As a script interpreter"
14985 #: ../fish/guestfish.pod:122
14986 msgid "Create a 100MB disk containing an ext2-formatted partition:"
14990 #: ../fish/guestfish.pod:124
14993 " #!/usr/bin/guestfish -f\n"
14994 " sparse test1.img 100M\n"
14996 " part-disk /dev/sda mbr\n"
14997 " mkfs ext2 /dev/sda1\n"
15002 #: ../fish/guestfish.pod:130
15003 msgid "Start with a prepared disk"
15007 #: ../fish/guestfish.pod:132
15009 "An alternate way to create a 100MB disk called C<test1.img> containing a "
15010 "single ext2-formatted partition:"
15014 #: ../fish/guestfish.pod:135
15017 " guestfish -N fs\n"
15022 #: ../fish/guestfish.pod:137
15023 msgid "To list what is available do:"
15027 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:750
15030 " guestfish -N help | less\n"
15035 #: ../fish/guestfish.pod:141
15036 msgid "Remote control"
15040 #: ../fish/guestfish.pod:143
15043 " eval `guestfish --listen`\n"
15044 " guestfish --remote add-ro disk.img\n"
15045 " guestfish --remote run\n"
15046 " guestfish --remote lvs\n"
15051 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
15052 #: ../fuse/guestmount.pod:70 ../inspector/virt-inspector.pl:75
15053 #: ../tools/virt-edit.pl:73 ../tools/virt-win-reg.pl:172
15054 #: ../tools/virt-df.pl:71 ../tools/virt-ls.pl:79 ../tools/virt-resize.pl:233
15055 #: ../tools/virt-list-filesystems.pl:50 ../tools/virt-cat.pl:80
15056 #: ../tools/virt-tar.pl:99 ../tools/virt-rescue.pl:103
15057 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:51
15062 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:94
15063 #: ../inspector/virt-inspector.pl:83 ../tools/virt-edit.pl:81
15064 #: ../tools/virt-win-reg.pl:180 ../tools/virt-df.pl:79 ../tools/virt-ls.pl:87
15065 #: ../tools/virt-resize.pl:241 ../tools/virt-list-filesystems.pl:58
15066 #: ../tools/virt-cat.pl:88 ../tools/virt-tar.pl:107
15067 #: ../tools/virt-rescue.pl:111 ../tools/virt-make-fs.pl:161
15068 #: ../tools/virt-list-partitions.pl:59
15073 #: ../fish/guestfish.pod:154
15074 msgid "Displays general help on options."
15078 #: ../fish/guestfish.pod:156
15079 msgid "B<-h> | B<--cmd-help>"
15083 #: ../fish/guestfish.pod:158
15084 msgid "Lists all available guestfish commands."
15088 #: ../fish/guestfish.pod:160
15089 msgid "B<-h cmd> | B<--cmd-help cmd>"
15093 #: ../fish/guestfish.pod:162
15094 msgid "Displays detailed help on a single command C<cmd>."
15098 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:74
15099 msgid "B<-a image> | B<--add image>"
15103 #: ../fish/guestfish.pod:166
15104 msgid "Add a block device or virtual machine image to the shell."
15108 #: ../fish/guestfish.pod:168
15109 msgid "B<-c URI> | B<--connect URI>"
15113 #: ../fish/guestfish.pod:170
15115 "When used in conjunction with the I<-d> option, this specifies the libvirt "
15116 "URI to use. The default is to use the default libvirt connection."
15120 #: ../fish/guestfish.pod:174
15121 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
15125 #: ../fish/guestfish.pod:176
15127 "Add disks from the named libvirt domain. If the I<--ro> option is also "
15128 "used, then any libvirt domain can be used. However in write mode, only "
15129 "libvirt domains which are shut down can be named here."
15133 #: ../fish/guestfish.pod:180
15134 msgid "B<-D> | B<--no-dest-paths>"
15138 #: ../fish/guestfish.pod:182
15140 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
15141 "to hit the tab key to complete paths on the guest filesystem, but this "
15142 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
15143 "allow this feature to be disabled."
15147 #: ../fish/guestfish.pod:187
15148 msgid "B<--echo-keys>"
15152 #: ../fish/guestfish.pod:189
15154 "When prompting for keys and passphrases, guestfish normally turns echoing "
15155 "off so you cannot see what you are typing. If you are not worried about "
15156 "Tempest attacks and there is no one else in the room you can specify this "
15157 "flag to see what you are typing."
15161 #: ../fish/guestfish.pod:194
15162 msgid "B<-f file> | B<--file file>"
15166 #: ../fish/guestfish.pod:196
15167 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
15171 #: ../fish/guestfish.pod:199
15174 " #!/usr/bin/guestfish -f\n"
15179 #: ../fish/guestfish.pod:201
15180 msgid "B<-i> | B<--inspector>"
15184 #: ../fish/guestfish.pod:203
15186 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
15187 "system and mount filesystems as they would be mounted on the real virtual "
15192 #: ../fish/guestfish.pod:207
15193 msgid "Typical usage is either:"
15197 #: ../fish/guestfish.pod:209
15200 " guestfish -d myguest -i\n"
15205 #: ../fish/guestfish.pod:211
15206 msgid "(for an inactive libvirt domain called I<myguest>), or:"
15210 #: ../fish/guestfish.pod:213
15213 " guestfish --ro -d myguest -i\n"
15218 #: ../fish/guestfish.pod:215
15219 msgid "(for active domains, readonly), or specify the block device directly:"
15223 #: ../fish/guestfish.pod:217
15226 " guestfish -a /dev/Guests/MyGuest -i\n"
15231 #: ../fish/guestfish.pod:219
15233 "Note that the command line syntax changed slightly over older versions of "
15234 "guestfish. You can still use the old syntax:"
15238 #: ../fish/guestfish.pod:222
15241 " guestfish [--ro] -i disk.img\n"
15246 #: ../fish/guestfish.pod:224
15249 " guestfish [--ro] -i libvirt-domain\n"
15254 #: ../fish/guestfish.pod:226
15255 msgid "B<--keys-from-stdin>"
15259 #: ../fish/guestfish.pod:228
15261 "Read key or passphrase parameters from stdin. The default is to try to read "
15262 "passphrases from the user by opening C</dev/tty>."
15266 #: ../fish/guestfish.pod:231
15267 msgid "B<--listen>"
15271 #: ../fish/guestfish.pod:233
15273 "Fork into the background and listen for remote commands. See section L</"
15274 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
15278 #: ../fish/guestfish.pod:236
15279 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
15283 #: ../fish/guestfish.pod:238
15284 msgid "Mount the named partition or logical volume on the given mountpoint."
15288 #: ../fish/guestfish.pod:240
15289 msgid "If the mountpoint is omitted, it defaults to C</>."
15293 #: ../fish/guestfish.pod:242
15294 msgid "You have to mount something on C</> before most commands will work."
15298 #: ../fish/guestfish.pod:244
15300 "If any I<-m> or I<--mount> options are given, the guest is automatically "
15305 #: ../fish/guestfish.pod:247
15307 "If you don't know what filesystems a disk image contains, you can either run "
15308 "guestfish without this option, then list the partitions and LVs available "
15309 "(see L</list-partitions> and L</lvs> commands), or you can use the L<virt-"
15310 "list-filesystems(1)> program."
15314 #: ../fish/guestfish.pod:252 ../fuse/guestmount.pod:106
15315 msgid "B<-n> | B<--no-sync>"
15319 #: ../fish/guestfish.pod:254
15321 "Disable autosync. This is enabled by default. See the discussion of "
15322 "autosync in the L<guestfs(3)> manpage."
15326 #: ../fish/guestfish.pod:257
15327 msgid "B<-N type> | B<--new type> | B<-N help>"
15331 #: ../fish/guestfish.pod:259
15333 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
15334 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
15335 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
15340 #: ../fish/guestfish.pod:264
15341 msgid "B<--progress-bars>"
15345 #: ../fish/guestfish.pod:266
15346 msgid "Enable progress bars, even when guestfish is used non-interactively."
15350 #: ../fish/guestfish.pod:268
15352 "Progress bars are enabled by default when guestfish is used as an "
15353 "interactive shell."
15357 #: ../fish/guestfish.pod:271
15358 msgid "B<--no-progress-bars>"
15362 #: ../fish/guestfish.pod:273
15363 msgid "Disable progress bars."
15367 #: ../fish/guestfish.pod:275
15368 msgid "B<--remote[=pid]>"
15372 #: ../fish/guestfish.pod:277
15374 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
15375 "CONTROL GUESTFISH OVER A SOCKET> below."
15379 #: ../fish/guestfish.pod:280 ../fuse/guestmount.pod:148
15380 msgid "B<-r> | B<--ro>"
15384 #: ../fish/guestfish.pod:282
15386 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
15387 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
15391 #: ../fish/guestfish.pod:285 ../tools/virt-rescue.pl:162
15393 "The option must always be used if the disk image or virtual machine might be "
15394 "running, and is generally recommended in cases where you don't need write "
15395 "access to the disk."
15399 #: ../fish/guestfish.pod:289
15401 "Note that prepared disk images created with I<-N> are not affected by the "
15406 #: ../fish/guestfish.pod:292 ../fuse/guestmount.pod:158
15407 #: ../tools/virt-rescue.pl:170
15408 msgid "B<--selinux>"
15412 #: ../fish/guestfish.pod:294
15413 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
15417 #: ../fish/guestfish.pod:296 ../fuse/guestmount.pod:168
15418 msgid "B<-v> | B<--verbose>"
15422 #: ../fish/guestfish.pod:298
15424 "Enable very verbose messages. This is particularly useful if you find a bug."
15428 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:172
15429 msgid "B<-V> | B<--version>"
15433 #: ../fish/guestfish.pod:303
15434 msgid "Display the guestfish / libguestfs version number and exit."
15438 #: ../fish/guestfish.pod:305
15443 #: ../fish/guestfish.pod:307
15444 msgid "Echo each command before executing it."
15448 #: ../fish/guestfish.pod:311
15449 msgid "COMMANDS ON COMMAND LINE"
15453 #: ../fish/guestfish.pod:313
15455 "Any additional (non-option) arguments are treated as commands to execute."
15459 #: ../fish/guestfish.pod:316
15461 "Commands to execute should be separated by a colon (C<:>), where the colon "
15462 "is a separate parameter. Thus:"
15466 #: ../fish/guestfish.pod:319
15469 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
15474 #: ../fish/guestfish.pod:321
15476 "If there are no additional arguments, then we enter a shell, either an "
15477 "interactive shell with a prompt (if the input is a terminal) or a non-"
15478 "interactive shell."
15482 #: ../fish/guestfish.pod:325
15484 "In either command line mode or non-interactive shell, the first command that "
15485 "gives an error causes the whole shell to exit. In interactive mode (with a "
15486 "prompt) if a command fails, you can continue to enter commands."
15490 #: ../fish/guestfish.pod:330
15491 msgid "USING launch (OR run)"
15495 #: ../fish/guestfish.pod:332
15497 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
15498 "then launch it, then mount any disks you need, and finally issue actions/"
15499 "commands. So the general order of the day is:"
15503 #: ../fish/guestfish.pod:340
15504 msgid "add or -a/--add"
15508 #: ../fish/guestfish.pod:344
15509 msgid "launch (aka run)"
15513 #: ../fish/guestfish.pod:348
15514 msgid "mount or -m/--mount"
15518 #: ../fish/guestfish.pod:352
15519 msgid "any other commands"
15523 #: ../fish/guestfish.pod:356
15525 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
15526 "guest before mounting or performing any other commands."
15530 #: ../fish/guestfish.pod:359
15532 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
15533 "I<--new> options were given then C<run> is done automatically, simply "
15534 "because guestfish can't perform the action you asked for without doing this."
15538 #: ../fish/guestfish.pod:364
15543 #: ../fish/guestfish.pod:366
15545 "You can quote ordinary parameters using either single or double quotes. For "
15550 #: ../fish/guestfish.pod:369
15553 " add \"file with a space.img\"\n"
15558 #: ../fish/guestfish.pod:371
15561 " rm '/file name'\n"
15566 #: ../fish/guestfish.pod:373
15574 #: ../fish/guestfish.pod:375
15576 "A few commands require a list of strings to be passed. For these, use a "
15577 "whitespace-separated list, enclosed in quotes. Strings containing "
15578 "whitespace to be passed through must be enclosed in single quotes. A "
15579 "literal single quote must be escaped with a backslash."
15583 #: ../fish/guestfish.pod:380
15586 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
15587 " command \"/bin/echo 'foo bar'\"\n"
15588 " command \"/bin/echo \\'foo\\'\"\n"
15593 #: ../fish/guestfish.pod:384
15598 #: ../fish/guestfish.pod:386
15600 "This section applies to all commands which can take integers as parameters."
15604 #: ../fish/guestfish.pod:389
15605 msgid "SIZE SUFFIX"
15609 #: ../fish/guestfish.pod:391
15611 "When the command takes a parameter measured in bytes, you can use one of the "
15612 "following suffixes to specify kilobytes, megabytes and larger sizes:"
15616 #: ../fish/guestfish.pod:397
15617 msgid "B<k> or B<K> or B<KiB>"
15621 #: ../fish/guestfish.pod:399
15622 msgid "The size in kilobytes (multiplied by 1024)."
15626 #: ../fish/guestfish.pod:401
15631 #: ../fish/guestfish.pod:403
15632 msgid "The size in SI 1000 byte units."
15636 #: ../fish/guestfish.pod:405
15637 msgid "B<M> or B<MiB>"
15641 #: ../fish/guestfish.pod:407
15642 msgid "The size in megabytes (multiplied by 1048576)."
15646 #: ../fish/guestfish.pod:409
15651 #: ../fish/guestfish.pod:411
15652 msgid "The size in SI 1000000 byte units."
15656 #: ../fish/guestfish.pod:413
15657 msgid "B<G> or B<GiB>"
15661 #: ../fish/guestfish.pod:415
15662 msgid "The size in gigabytes (multiplied by 2**30)."
15666 #: ../fish/guestfish.pod:417
15671 #: ../fish/guestfish.pod:419
15672 msgid "The size in SI 10**9 byte units."
15676 #: ../fish/guestfish.pod:421
15677 msgid "B<T> or B<TiB>"
15681 #: ../fish/guestfish.pod:423
15682 msgid "The size in terabytes (multiplied by 2**40)."
15686 #: ../fish/guestfish.pod:425
15691 #: ../fish/guestfish.pod:427
15692 msgid "The size in SI 10**12 byte units."
15696 #: ../fish/guestfish.pod:429
15697 msgid "B<P> or B<PiB>"
15701 #: ../fish/guestfish.pod:431
15702 msgid "The size in petabytes (multiplied by 2**50)."
15706 #: ../fish/guestfish.pod:433
15711 #: ../fish/guestfish.pod:435
15712 msgid "The size in SI 10**15 byte units."
15716 #: ../fish/guestfish.pod:437
15717 msgid "B<E> or B<EiB>"
15721 #: ../fish/guestfish.pod:439
15722 msgid "The size in exabytes (multiplied by 2**60)."
15726 #: ../fish/guestfish.pod:441
15731 #: ../fish/guestfish.pod:443
15732 msgid "The size in SI 10**18 byte units."
15736 #: ../fish/guestfish.pod:445
15737 msgid "B<Z> or B<ZiB>"
15741 #: ../fish/guestfish.pod:447
15742 msgid "The size in zettabytes (multiplied by 2**70)."
15746 #: ../fish/guestfish.pod:449
15751 #: ../fish/guestfish.pod:451
15752 msgid "The size in SI 10**21 byte units."
15756 #: ../fish/guestfish.pod:453
15757 msgid "B<Y> or B<YiB>"
15761 #: ../fish/guestfish.pod:455
15762 msgid "The size in yottabytes (multiplied by 2**80)."
15766 #: ../fish/guestfish.pod:457
15771 #: ../fish/guestfish.pod:459
15772 msgid "The size in SI 10**24 byte units."
15776 #: ../fish/guestfish.pod:463
15777 msgid "For example:"
15781 #: ../fish/guestfish.pod:465
15784 " truncate-size /file 1G\n"
15789 #: ../fish/guestfish.pod:467
15790 msgid "would truncate the file to 1 gigabyte."
15794 #: ../fish/guestfish.pod:469
15796 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
15797 "the parameter to L</memsize> is specified in megabytes already). Adding a "
15798 "suffix will probably not do what you expect."
15802 #: ../fish/guestfish.pod:473
15803 msgid "OCTAL AND HEXADECIMAL NUMBERS"
15807 #: ../fish/guestfish.pod:475
15809 "For specifying the radix (base) use the C convention: C<0> to prefix an "
15810 "octal number or C<0x> to prefix a hexadecimal number. For example:"
15814 #: ../fish/guestfish.pod:478
15817 " 1234 decimal number 1234\n"
15818 " 02322 octal number, equivalent to decimal 1234\n"
15819 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
15824 #: ../fish/guestfish.pod:482
15826 "When using the C<chmod> command, you almost always want to specify an octal "
15827 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
15828 "L<chmod(1)> program):"
15832 #: ../fish/guestfish.pod:486
15835 " chmod 0777 /public # OK\n"
15836 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
15841 #: ../fish/guestfish.pod:489
15843 "Commands that return numbers usually print them in decimal, but some "
15844 "commands print numbers in other radices (eg. C<umask> prints the mode in "
15845 "octal, preceeded by C<0>)."
15849 #: ../fish/guestfish.pod:493
15850 msgid "WILDCARDS AND GLOBBING"
15854 #: ../fish/guestfish.pod:495
15856 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
15857 "(globbing) by default. So for example the following will not do what you "
15862 #: ../fish/guestfish.pod:499
15870 #: ../fish/guestfish.pod:501
15872 "Assuming you don't have a directory called literally C</home/*> then the "
15873 "above command will return an error."
15877 #: ../fish/guestfish.pod:504
15878 msgid "To perform wildcard expansion, use the C<glob> command."
15882 #: ../fish/guestfish.pod:506
15885 " glob rm-rf /home/*\n"
15890 #: ../fish/guestfish.pod:508
15892 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
15893 "many times), equivalent to:"
15897 #: ../fish/guestfish.pod:511
15900 " rm-rf /home/jim\n"
15901 " rm-rf /home/joe\n"
15902 " rm-rf /home/mary\n"
15907 #: ../fish/guestfish.pod:515
15908 msgid "C<glob> only works on simple guest paths and not on device names."
15912 #: ../fish/guestfish.pod:517
15914 "If you have several parameters, each containing a wildcard, then glob will "
15915 "perform a Cartesian product."
15919 #: ../fish/guestfish.pod:520
15924 #: ../fish/guestfish.pod:522
15926 "Any line which starts with a I<#> character is treated as a comment and "
15927 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
15928 "a command. For example:"
15932 #: ../fish/guestfish.pod:526
15935 " # this is a comment\n"
15936 " # this is a comment\n"
15937 " foo # NOT a comment\n"
15942 #: ../fish/guestfish.pod:530
15943 msgid "Blank lines are also ignored."
15947 #: ../fish/guestfish.pod:532
15948 msgid "RUNNING COMMANDS LOCALLY"
15952 #: ../fish/guestfish.pod:534
15954 "Any line which starts with a I<!> character is treated as a command sent to "
15955 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
15959 #: ../fish/guestfish.pod:538
15963 " tgz-out /remote local/remote-data.tar.gz\n"
15968 #: ../fish/guestfish.pod:541
15970 "will create a directory C<local> on the host, and then export the contents "
15971 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
15972 "(See C<tgz-out>)."
15976 #: ../fish/guestfish.pod:545
15978 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
15979 "effect, due to the way that subprocesses work in Unix."
15983 #: ../fish/guestfish.pod:548
15988 #: ../fish/guestfish.pod:550
15990 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
15991 "command (a guestfish command) to the second command (any host command). For "
15996 #: ../fish/guestfish.pod:554
15999 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
16004 #: ../fish/guestfish.pod:556
16006 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
16007 "program). The above command would list all accounts in the guest filesystem "
16008 "which have UID 0, ie. root accounts including backdoors. Other examples:"
16012 #: ../fish/guestfish.pod:561
16015 " hexdump /bin/ls | head\n"
16016 " list-devices | tail -1\n"
16017 " tgz-out / - | tar ztf -\n"
16022 #: ../fish/guestfish.pod:565
16024 "The space before the pipe symbol is required, any space after the pipe "
16025 "symbol is optional. Everything after the pipe symbol is just passed "
16026 "straight to the host shell, so it can contain redirections, globs and "
16027 "anything else that makes sense on the host side."
16031 #: ../fish/guestfish.pod:570
16033 "To use a literal argument which begins with a pipe symbol, you have to quote "
16038 #: ../fish/guestfish.pod:573
16046 #: ../fish/guestfish.pod:575
16047 msgid "HOME DIRECTORIES"
16051 #: ../fish/guestfish.pod:577
16053 "If a parameter starts with the character C<~> then the tilde may be expanded "
16054 "as a home directory path (either C<~> for the current user's home directory, "
16055 "or C<~user> for another user)."
16059 #: ../fish/guestfish.pod:581
16061 "Note that home directory expansion happens for users known I<on the host>, "
16062 "not in the guest filesystem."
16066 #: ../fish/guestfish.pod:584
16068 "To use a literal argument which begins with a tilde, you have to quote it, "
16073 #: ../fish/guestfish.pod:587
16081 #: ../fish/guestfish.pod:591
16083 "Libguestfs has some support for Linux guests encrypted according to the "
16084 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
16085 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
16086 "LUKS is supported."
16090 #: ../fish/guestfish.pod:596
16091 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
16095 #: ../fish/guestfish.pod:598
16098 " ><fs> vfs-type /dev/sda2\n"
16104 #: ../fish/guestfish.pod:601
16106 "Then open those devices using L</luks-open>. This creates a device-mapper "
16107 "device called C</dev/mapper/luksdev>."
16111 #: ../fish/guestfish.pod:604
16114 " ><fs> luks-open /dev/sda2 luksdev\n"
16115 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
16120 #: ../fish/guestfish.pod:607
16122 "Finally you have to tell LVM to scan for volume groups on the newly created "
16127 #: ../fish/guestfish.pod:610
16131 " vg-activate-all true\n"
16136 #: ../fish/guestfish.pod:613
16137 msgid "The logical volume(s) can now be mounted in the usual way."
16141 #: ../fish/guestfish.pod:615
16143 "Before closing a LUKS device you must unmount any logical volumes on it and "
16144 "deactivate the volume groups by calling C<vg-activate false VG> on each "
16145 "one. Then you can close the mapper device:"
16149 #: ../fish/guestfish.pod:619
16152 " vg-activate false /dev/VG\n"
16153 " luks-close /dev/mapper/luksdev\n"
16158 #: ../fish/guestfish.pod:622
16159 msgid "WINDOWS PATHS"
16163 #: ../fish/guestfish.pod:624
16165 "If a path is prefixed with C<win:> then you can use Windows-style paths "
16166 "(with some limitations). The following commands are equivalent:"
16170 #: ../fish/guestfish.pod:627
16173 " file /WINDOWS/system32/config/system.LOG\n"
16178 #: ../fish/guestfish.pod:629
16181 " file win:/windows/system32/config/system.log\n"
16186 #: ../fish/guestfish.pod:631
16189 " file win:\\windows\\system32\\config\\system.log\n"
16194 #: ../fish/guestfish.pod:633
16197 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
16202 #: ../fish/guestfish.pod:635
16204 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
16205 "handles case insensitivity like Windows would. This only works in argument "
16206 "positions that expect a path."
16210 #: ../fish/guestfish.pod:639
16211 msgid "UPLOADING AND DOWNLOADING FILES"
16215 #: ../fish/guestfish.pod:641
16217 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
16218 "others which upload from or download to a local file, you can use the "
16219 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
16223 #: ../fish/guestfish.pod:645
16231 #: ../fish/guestfish.pod:647
16233 "reads stdin and creates from that a file C</foo> in the disk image, and:"
16237 #: ../fish/guestfish.pod:650
16240 " tar-out /etc - | tar tf -\n"
16245 #: ../fish/guestfish.pod:652
16247 "writes the tarball to stdout and then pipes that into the external \"tar\" "
16248 "command (see L</PIPES>)."
16252 #: ../fish/guestfish.pod:655
16254 "When using C<-> to read from stdin, the input is read up to the end of "
16255 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
16256 "some arbitrary end marker:"
16260 #: ../fish/guestfish.pod:659
16263 " upload -<<END /foo\n"
16272 #: ../fish/guestfish.pod:665
16274 "Any string of characters can be used instead of C<END>. The end marker must "
16275 "appear on a line of its own, without any preceeding or following characters "
16276 "(not even spaces)."
16280 #: ../fish/guestfish.pod:669
16282 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
16283 "upload local files (so-called \"FileIn\" parameters in the generator)."
16287 #: ../fish/guestfish.pod:672
16288 msgid "EXIT ON ERROR BEHAVIOUR"
16292 #: ../fish/guestfish.pod:674
16294 "By default, guestfish will ignore any errors when in interactive mode (ie. "
16295 "taking commands from a human over a tty), and will exit on the first error "
16296 "in non-interactive mode (scripts, commands given on the command line)."
16300 #: ../fish/guestfish.pod:679
16302 "If you prefix a command with a I<-> character, then that command will not "
16303 "cause guestfish to exit, even if that (one) command returns an error."
16307 #: ../fish/guestfish.pod:683
16308 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
16312 #: ../fish/guestfish.pod:685
16314 "Guestfish can be remote-controlled over a socket. This is useful "
16315 "particularly in shell scripts where you want to make several different "
16316 "changes to a filesystem, but you don't want the overhead of starting up a "
16317 "guestfish process each time."
16321 #: ../fish/guestfish.pod:690
16322 msgid "Start a guestfish server process using:"
16326 #: ../fish/guestfish.pod:692
16329 " eval `guestfish --listen`\n"
16334 #: ../fish/guestfish.pod:694
16335 msgid "and then send it commands by doing:"
16339 #: ../fish/guestfish.pod:696
16342 " guestfish --remote cmd [...]\n"
16347 #: ../fish/guestfish.pod:698
16348 msgid "To cause the server to exit, send it the exit command:"
16352 #: ../fish/guestfish.pod:700
16355 " guestfish --remote exit\n"
16360 #: ../fish/guestfish.pod:702
16362 "Note that the server will normally exit if there is an error in a command. "
16363 "You can change this in the usual way. See section L</EXIT ON ERROR "
16368 #: ../fish/guestfish.pod:706
16369 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
16373 #: ../fish/guestfish.pod:708
16375 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
16376 "is how the I<--remote> option knows where to send the commands. You can "
16377 "have several guestfish listener processes running using:"
16381 #: ../fish/guestfish.pod:712
16384 " eval `guestfish --listen`\n"
16385 " pid1=$GUESTFISH_PID\n"
16386 " eval `guestfish --listen`\n"
16387 " pid2=$GUESTFISH_PID\n"
16389 " guestfish --remote=$pid1 cmd\n"
16390 " guestfish --remote=$pid2 cmd\n"
16395 #: ../fish/guestfish.pod:720
16396 msgid "REMOTE CONTROL DETAILS"
16400 #: ../fish/guestfish.pod:722
16402 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
16403 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
16404 "and C<$PID> is the process ID of the server."
16408 #: ../fish/guestfish.pod:726
16409 msgid "Guestfish client and server versions must match exactly."
16413 #: ../fish/guestfish.pod:728
16414 msgid "PREPARED DISK IMAGES"
16418 #: ../fish/guestfish.pod:730
16420 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
16421 "preformatted disk images that guestfish can make for you to save typing. "
16422 "This is particularly useful for testing purposes. This option is used "
16423 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
16424 "can be mixed with I<-a>)."
16428 #: ../fish/guestfish.pod:736
16430 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
16431 "the second and so on. Existing files in the current directory are "
16436 #: ../fish/guestfish.pod:740
16438 "The type briefly describes how the disk should be sized, partitioned, how "
16439 "filesystem(s) should be created, and how content should be added. "
16440 "Optionally the type can be followed by extra parameters, separated by C<:> "
16441 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
16442 "allocated disk, containing a single partition, with the partition formatted "
16443 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
16448 #: ../fish/guestfish.pod:748
16449 msgid "To list the available types and any extra parameters they take, run:"
16453 #: ../fish/guestfish.pod:752
16455 "Note that the prepared filesystem is not mounted. You would usually have to "
16456 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
16460 #: ../fish/guestfish.pod:756
16462 "If any I<-N> or I<--new> options are given, the guest is automatically "
16467 #: ../fish/guestfish.pod:761
16468 msgid "Create a 100MB disk with an ext4-formatted partition:"
16472 #: ../fish/guestfish.pod:763
16475 " guestfish -N fs:ext4\n"
16480 #: ../fish/guestfish.pod:765
16481 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
16485 #: ../fish/guestfish.pod:767
16488 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
16493 #: ../fish/guestfish.pod:769
16494 msgid "Create a blank 200MB disk:"
16498 #: ../fish/guestfish.pod:771
16501 " guestfish -N disk:200M\n"
16506 #: ../fish/guestfish.pod:773
16507 msgid "PROGRESS BARS"
16511 #: ../fish/guestfish.pod:775
16513 "Some (not all) long-running commands send progress notification messages as "
16514 "they are running. Guestfish turns these messages into progress bars."
16518 #: ../fish/guestfish.pod:779
16520 "When a command that supports progress bars takes longer than two seconds to "
16521 "run, and if progress bars are enabled, then you will see one appearing below "
16526 #: ../fish/guestfish.pod:783
16529 " ><fs> copy-size /large-file /another-file 2048M\n"
16530 " / 10% [#####-----------------------------------------] 00:30\n"
16535 #: ../fish/guestfish.pod:786
16537 "The spinner on the left hand side moves round once for every progress "
16538 "notification received from the backend. This is a (reasonably) golden "
16539 "assurance that the command is \"doing something\" even if the progress bar "
16540 "is not moving, because the command is able to send the progress "
16541 "notifications. When the bar reaches 100% and the command finishes, the "
16542 "spinner disappears."
16546 #: ../fish/guestfish.pod:793
16548 "Progress bars are enabled by default when guestfish is used interactively. "
16549 "You can enable them even for non-interactive modes using I<--progress-bars>, "
16550 "and you can disable them completely using I<--no-progress-bars>."
16554 #: ../fish/guestfish.pod:798
16555 msgid "GUESTFISH COMMANDS"
16559 #: ../fish/guestfish.pod:800
16561 "The commands in this section are guestfish convenience commands, in other "
16562 "words, they are not part of the L<guestfs(3)> API."
16566 #: ../fish/guestfish.pod:803
16571 #: ../fish/guestfish.pod:805
16580 #: ../fish/guestfish.pod:808
16582 "Without any parameter, this lists all commands. With a C<cmd> parameter, "
16583 "this displays detailed help for a command."
16587 #: ../fish/guestfish.pod:811
16588 msgid "quit | exit"
16592 #: ../fish/guestfish.pod:813
16593 msgid "This exits guestfish. You can also use C<^D> key."
16597 #: ../fish/guestfish.pod:815
16598 msgid "@FISH_COMMANDS@"
16602 #: ../fish/guestfish.pod:817
16607 #: ../fish/guestfish.pod:821 ../test-tool/libguestfs-test-tool.pod:83
16612 #: ../fish/guestfish.pod:823
16614 "guestfish returns 0 if the commands completed without error, or 1 if there "
16619 #: ../fish/guestfish.pod:830
16624 #: ../fish/guestfish.pod:832
16626 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
16631 #: ../fish/guestfish.pod:835
16632 msgid "GUESTFISH_PID"
16636 #: ../fish/guestfish.pod:837
16638 "Used with the I<--remote> option to specify the remote guestfish process to "
16639 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
16643 #: ../fish/guestfish.pod:841
16648 #: ../fish/guestfish.pod:843
16650 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
16651 "not specified, the external L<hexedit(1)> program is used."
16655 #: ../fish/guestfish.pod:847
16660 #: ../fish/guestfish.pod:849
16662 "If compiled with GNU readline support, various files in the home directory "
16663 "can be used. See L</FILES>."
16667 #: ../fish/guestfish.pod:858
16669 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
16670 "effect as using the B<-v> option."
16674 #: ../fish/guestfish.pod:870
16676 "Set the path that guestfish uses to search for kernel and initrd.img. See "
16677 "the discussion of paths in L<guestfs(3)>."
16681 #: ../fish/guestfish.pod:881
16682 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
16686 #: ../fish/guestfish.pod:883
16691 #: ../fish/guestfish.pod:885
16693 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
16698 #: ../fish/guestfish.pod:900 ../test-tool/libguestfs-test-tool.pod:88
16703 #: ../fish/guestfish.pod:904
16704 msgid "$HOME/.guestfish"
16708 #: ../fish/guestfish.pod:906
16710 "If compiled with GNU readline support, then the command history is saved in "
16715 #: ../fish/guestfish.pod:909
16716 msgid "$HOME/.inputrc"
16720 #: ../fish/guestfish.pod:911
16721 msgid "/etc/inputrc"
16725 #: ../fish/guestfish.pod:913
16727 "If compiled with GNU readline support, then these files can be used to "
16728 "configure readline. For further information, please see L<readline(3)/"
16729 "INITIALIZATION FILE>."
16733 #: ../fish/guestfish.pod:917
16734 msgid "To write rules which only apply to guestfish, use:"
16738 #: ../fish/guestfish.pod:919
16748 #: ../fish/guestfish.pod:923
16750 "Variables that you can set in inputrc that change the behaviour of guestfish "
16751 "in useful ways include:"
16755 #: ../fish/guestfish.pod:928
16756 msgid "completion-ignore-case (default: on)"
16760 #: ../fish/guestfish.pod:930
16762 "By default, guestfish will ignore case when tab-completing paths on the "
16767 #: ../fish/guestfish.pod:933
16770 " set completion-ignore-case off\n"
16775 #: ../fish/guestfish.pod:935
16776 msgid "to make guestfish case sensitive."
16780 #: ../fish/guestfish.pod:939
16785 #: ../fish/guestfish.pod:941
16786 msgid "test2.img (etc)"
16790 #: ../fish/guestfish.pod:943
16792 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
16793 "will be created in the file C<test1.img> in the current directory. The "
16794 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
16795 "the same name will be overwritten."
16799 #: ../fish/guestfish.pod:952
16801 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
16802 "L<virt-edit(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, "
16803 "L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, "
16804 "L<virt-tar(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
16808 #: ../fish/guestfish.pod:976 ../test-tool/libguestfs-test-tool.pod:124
16809 #: ../fuse/guestmount.pod:198 ../inspector/virt-inspector.pl:865
16810 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:495
16811 #: ../tools/virt-df.pl:553 ../tools/virt-ls.pl:229
16812 #: ../tools/virt-resize.pl:1424 ../tools/virt-list-filesystems.pl:211
16813 #: ../tools/virt-cat.pl:181 ../tools/virt-tar.pl:276
16814 #: ../tools/virt-rescue.pl:249 ../tools/virt-make-fs.pl:560
16815 #: ../tools/virt-list-partitions.pl:248
16817 "This program is free software; you can redistribute it and/or modify it "
16818 "under the terms of the GNU General Public License as published by the Free "
16819 "Software Foundation; either version 2 of the License, or (at your option) "
16820 "any later version."
16824 #: ../fish/guestfish.pod:981 ../test-tool/libguestfs-test-tool.pod:129
16825 #: ../fuse/guestmount.pod:203 ../inspector/virt-inspector.pl:870
16826 #: ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:500
16827 #: ../tools/virt-df.pl:558 ../tools/virt-ls.pl:234
16828 #: ../tools/virt-resize.pl:1429 ../tools/virt-list-filesystems.pl:216
16829 #: ../tools/virt-cat.pl:186 ../tools/virt-tar.pl:281
16830 #: ../tools/virt-rescue.pl:254 ../tools/virt-make-fs.pl:565
16831 #: ../tools/virt-list-partitions.pl:253
16833 "This program is distributed in the hope that it will be useful, but WITHOUT "
16834 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
16835 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
16840 #: ../fish/guestfish.pod:986 ../test-tool/libguestfs-test-tool.pod:134
16841 #: ../fuse/guestmount.pod:208 ../inspector/virt-inspector.pl:875
16842 #: ../tools/virt-edit.pl:355 ../tools/virt-win-reg.pl:505
16843 #: ../tools/virt-df.pl:563 ../tools/virt-ls.pl:239
16844 #: ../tools/virt-resize.pl:1434 ../tools/virt-list-filesystems.pl:221
16845 #: ../tools/virt-cat.pl:191 ../tools/virt-tar.pl:286
16846 #: ../tools/virt-rescue.pl:259 ../tools/virt-make-fs.pl:570
16847 #: ../tools/virt-list-partitions.pl:258
16849 "You should have received a copy of the GNU General Public License along with "
16850 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
16851 "Ave, Cambridge, MA 02139, USA."
16855 #: ../fish/guestfish-actions.pod:1
16860 #: ../fish/guestfish-actions.pod:3
16865 #: ../fish/guestfish-actions.pod:5
16868 " add-cdrom filename\n"
16873 #: ../fish/guestfish-actions.pod:17
16875 "This call checks for the existence of C<filename>. This stops you from "
16876 "specifying other types of drive which are supported by qemu such as C<nbd:> "
16877 "and C<http:> URLs. To specify those, use the general L</config> call "
16882 #: ../fish/guestfish-actions.pod:24
16884 "If you just want to add an ISO file (often you use this as an efficient way "
16885 "to transfer large files into the guest), then you should probably use L</add-"
16886 "drive-ro> instead."
16890 #: ../fish/guestfish-actions.pod:30
16895 #: ../fish/guestfish-actions.pod:32
16900 #: ../fish/guestfish-actions.pod:34
16903 " add-drive filename\n"
16908 #: ../fish/guestfish-actions.pod:53 ../fish/guestfish-actions.pod:81
16910 "C<if=...> is set at compile time by the configuration option C<./configure --"
16911 "with-drive-if=...>. In the rare case where you might need to change this at "
16912 "run time, use L</add-drive-with-if> or L</add-drive-ro-with-if>."
16916 #: ../fish/guestfish-actions.pod:58 ../fish/guestfish-actions.pod:86
16918 "Note that this call checks for the existence of C<filename>. This stops you "
16919 "from specifying other types of drive which are supported by qemu such as "
16920 "C<nbd:> and C<http:> URLs. To specify those, use the general L</config> "
16925 #: ../fish/guestfish-actions.pod:63
16926 msgid "add-drive-ro"
16930 #: ../fish/guestfish-actions.pod:65
16935 #: ../fish/guestfish-actions.pod:67
16938 " add-drive-ro filename\n"
16943 #: ../fish/guestfish-actions.pod:91
16944 msgid "add-drive-ro-with-if"
16948 #: ../fish/guestfish-actions.pod:93
16951 " add-drive-ro-with-if filename iface\n"
16956 #: ../fish/guestfish-actions.pod:95
16958 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
16959 "interface emulation to use at run time."
16963 #: ../fish/guestfish-actions.pod:98
16964 msgid "add-drive-with-if"
16968 #: ../fish/guestfish-actions.pod:100
16971 " add-drive-with-if filename iface\n"
16976 #: ../fish/guestfish-actions.pod:102
16978 "This is the same as L</add-drive> but it allows you to specify the QEMU "
16979 "interface emulation to use at run time."
16983 #: ../fish/guestfish-actions.pod:105
16988 #: ../fish/guestfish-actions.pod:107
16991 " aug-clear augpath\n"
16996 #: ../fish/guestfish-actions.pod:112
17001 #: ../fish/guestfish-actions.pod:114
17009 #: ../fish/guestfish-actions.pod:116
17011 "Close the current Augeas handle and free up any resources used by it. After "
17012 "calling this, you have to call L</aug-init> again before you can use any "
17013 "other Augeas functions."
17017 #: ../fish/guestfish-actions.pod:121
17018 msgid "aug-defnode"
17022 #: ../fish/guestfish-actions.pod:123
17025 " aug-defnode name expr val\n"
17030 #: ../fish/guestfish-actions.pod:128
17032 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
17033 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
17034 "containing that single node."
17038 #: ../fish/guestfish-actions.pod:136
17043 #: ../fish/guestfish-actions.pod:138
17046 " aug-defvar name expr\n"
17051 #: ../fish/guestfish-actions.pod:147
17056 #: ../fish/guestfish-actions.pod:149
17059 " aug-get augpath\n"
17064 #: ../fish/guestfish-actions.pod:154
17069 #: ../fish/guestfish-actions.pod:156
17072 " aug-init root flags\n"
17077 #: ../fish/guestfish-actions.pod:162
17078 msgid "You must call this before using any other L</aug-*> commands."
17082 #: ../fish/guestfish-actions.pod:197
17083 msgid "Do not load the tree in L</aug-init>."
17087 #: ../fish/guestfish-actions.pod:201
17088 msgid "To close the handle, you can call L</aug-close>."
17092 #: ../fish/guestfish-actions.pod:205
17097 #: ../fish/guestfish-actions.pod:207
17100 " aug-insert augpath label true|false\n"
17105 #: ../fish/guestfish-actions.pod:217
17110 #: ../fish/guestfish-actions.pod:219
17118 #: ../fish/guestfish-actions.pod:226
17123 #: ../fish/guestfish-actions.pod:228
17126 " aug-ls augpath\n"
17131 #: ../fish/guestfish-actions.pod:230
17133 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
17134 "resulting nodes into alphabetical order."
17138 #: ../fish/guestfish-actions.pod:233
17143 #: ../fish/guestfish-actions.pod:235
17146 " aug-match augpath\n"
17151 #: ../fish/guestfish-actions.pod:241
17156 #: ../fish/guestfish-actions.pod:243
17159 " aug-mv src dest\n"
17164 #: ../fish/guestfish-actions.pod:248
17169 #: ../fish/guestfish-actions.pod:250
17172 " aug-rm augpath\n"
17177 #: ../fish/guestfish-actions.pod:256
17182 #: ../fish/guestfish-actions.pod:258
17190 #: ../fish/guestfish-actions.pod:262
17192 "The flags which were passed to L</aug-init> affect exactly how files are "
17197 #: ../fish/guestfish-actions.pod:265
17202 #: ../fish/guestfish-actions.pod:267
17205 " aug-set augpath val\n"
17210 #: ../fish/guestfish-actions.pod:271
17212 "In the Augeas API, it is possible to clear a node by setting the value to "
17213 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
17214 "this call. Instead you must use the L</aug-clear> call."
17218 #: ../fish/guestfish-actions.pod:276
17223 #: ../fish/guestfish-actions.pod:278
17226 " available 'groups ...'\n"
17231 #: ../fish/guestfish-actions.pod:284
17233 "The libguestfs groups, and the functions that those groups correspond to, "
17234 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
17235 "runtime by calling L</available-all-groups>."
17239 #: ../fish/guestfish-actions.pod:308
17240 msgid "You must call L</launch> before calling this function."
17244 #: ../fish/guestfish-actions.pod:330
17246 "This call was added in version C<1.0.80>. In previous versions of "
17247 "libguestfs all you could do would be to speculatively execute a command to "
17248 "find out if the daemon implemented it. See also L</version>."
17252 #: ../fish/guestfish-actions.pod:337
17253 msgid "available-all-groups"
17257 #: ../fish/guestfish-actions.pod:339
17260 " available-all-groups\n"
17265 #: ../fish/guestfish-actions.pod:341
17267 "This command returns a list of all optional groups that this daemon knows "
17268 "about. Note this returns both supported and unsupported groups. To find "
17269 "out which ones the daemon can actually support you have to call L</"
17270 "available> on each member of the returned list."
17274 #: ../fish/guestfish-actions.pod:347
17275 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
17279 #: ../fish/guestfish-actions.pod:349
17284 #: ../fish/guestfish-actions.pod:351
17287 " base64-in (base64file|-) filename\n"
17292 #: ../fish/guestfish-actions.pod:356 ../fish/guestfish-actions.pod:365
17293 #: ../fish/guestfish-actions.pod:589 ../fish/guestfish-actions.pod:736
17294 #: ../fish/guestfish-actions.pod:783 ../fish/guestfish-actions.pod:802
17295 #: ../fish/guestfish-actions.pod:1179 ../fish/guestfish-actions.pod:3835
17296 #: ../fish/guestfish-actions.pod:3847 ../fish/guestfish-actions.pod:3858
17297 #: ../fish/guestfish-actions.pod:3869 ../fish/guestfish-actions.pod:3921
17298 #: ../fish/guestfish-actions.pod:3930 ../fish/guestfish-actions.pod:3984
17299 #: ../fish/guestfish-actions.pod:4007
17300 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
17304 #: ../fish/guestfish-actions.pod:358
17309 #: ../fish/guestfish-actions.pod:360
17312 " base64-out filename (base64file|-)\n"
17317 #: ../fish/guestfish-actions.pod:367
17318 msgid "blockdev-flushbufs"
17322 #: ../fish/guestfish-actions.pod:369
17325 " blockdev-flushbufs device\n"
17330 #: ../fish/guestfish-actions.pod:376
17331 msgid "blockdev-getbsz"
17335 #: ../fish/guestfish-actions.pod:378
17338 " blockdev-getbsz device\n"
17343 #: ../fish/guestfish-actions.pod:387
17344 msgid "blockdev-getro"
17348 #: ../fish/guestfish-actions.pod:389
17351 " blockdev-getro device\n"
17356 #: ../fish/guestfish-actions.pod:396
17357 msgid "blockdev-getsize64"
17361 #: ../fish/guestfish-actions.pod:398
17364 " blockdev-getsize64 device\n"
17369 #: ../fish/guestfish-actions.pod:402
17370 msgid "See also L</blockdev-getsz>."
17374 #: ../fish/guestfish-actions.pod:406
17375 msgid "blockdev-getss"
17379 #: ../fish/guestfish-actions.pod:408
17382 " blockdev-getss device\n"
17387 #: ../fish/guestfish-actions.pod:413
17389 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
17393 #: ../fish/guestfish-actions.pod:418
17394 msgid "blockdev-getsz"
17398 #: ../fish/guestfish-actions.pod:420
17401 " blockdev-getsz device\n"
17406 #: ../fish/guestfish-actions.pod:425
17408 "See also L</blockdev-getss> for the real sector size of the device, and L</"
17409 "blockdev-getsize64> for the more useful I<size in bytes>."
17413 #: ../fish/guestfish-actions.pod:431
17414 msgid "blockdev-rereadpt"
17418 #: ../fish/guestfish-actions.pod:433
17421 " blockdev-rereadpt device\n"
17426 #: ../fish/guestfish-actions.pod:439
17427 msgid "blockdev-setbsz"
17431 #: ../fish/guestfish-actions.pod:441
17434 " blockdev-setbsz device blocksize\n"
17439 #: ../fish/guestfish-actions.pod:450
17440 msgid "blockdev-setro"
17444 #: ../fish/guestfish-actions.pod:452
17447 " blockdev-setro device\n"
17452 #: ../fish/guestfish-actions.pod:458
17453 msgid "blockdev-setrw"
17457 #: ../fish/guestfish-actions.pod:460
17460 " blockdev-setrw device\n"
17465 #: ../fish/guestfish-actions.pod:466
17466 msgid "case-sensitive-path"
17470 #: ../fish/guestfish-actions.pod:468
17473 " case-sensitive-path path\n"
17478 #: ../fish/guestfish-actions.pod:492
17480 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
17481 "WINDOWS/system32\"> (the exact return value would depend on details of how "
17482 "the directories were originally created under Windows)."
17486 #: ../fish/guestfish-actions.pod:500
17487 msgid "See also L</realpath>."
17491 #: ../fish/guestfish-actions.pod:502
17496 #: ../fish/guestfish-actions.pod:504
17504 #: ../fish/guestfish-actions.pod:508
17506 "Note that this function cannot correctly handle binary files (specifically, "
17507 "files containing C<\\0> character which is treated as end of string). For "
17508 "those you need to use the L</read-file> or L</download> functions which have "
17509 "a more complex interface."
17513 #: ../fish/guestfish-actions.pod:516
17518 #: ../fish/guestfish-actions.pod:518
17521 " checksum csumtype path\n"
17526 #: ../fish/guestfish-actions.pod:561
17527 msgid "To get the checksum for a device, use L</checksum-device>."
17531 #: ../fish/guestfish-actions.pod:563
17532 msgid "To get the checksums for many files, use L</checksums-out>."
17536 #: ../fish/guestfish-actions.pod:565
17537 msgid "checksum-device"
17541 #: ../fish/guestfish-actions.pod:567
17544 " checksum-device csumtype device\n"
17549 #: ../fish/guestfish-actions.pod:569
17551 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
17552 "device named C<device>. For the types of checksums supported see the L</"
17553 "checksum> command."
17557 #: ../fish/guestfish-actions.pod:573
17558 msgid "checksums-out"
17562 #: ../fish/guestfish-actions.pod:575
17565 " checksums-out csumtype directory (sumsfile|-)\n"
17570 #: ../fish/guestfish-actions.pod:591
17575 #: ../fish/guestfish-actions.pod:593
17578 " chmod mode path\n"
17583 #: ../fish/guestfish-actions.pod:604
17588 #: ../fish/guestfish-actions.pod:606
17591 " chown owner group path\n"
17596 #: ../fish/guestfish-actions.pod:614
17601 #: ../fish/guestfish-actions.pod:616
17604 " command 'arguments ...'\n"
17609 #: ../fish/guestfish-actions.pod:623
17611 "The single parameter is an argv-style list of arguments. The first element "
17612 "is the name of the program to run. Subsequent elements are parameters. The "
17613 "list must be non-empty (ie. must contain a program name). Note that the "
17614 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
17618 #: ../fish/guestfish-actions.pod:651
17619 msgid "command-lines"
17623 #: ../fish/guestfish-actions.pod:653
17626 " command-lines 'arguments ...'\n"
17631 #: ../fish/guestfish-actions.pod:655
17633 "This is the same as L</command>, but splits the result into a list of lines."
17637 #: ../fish/guestfish-actions.pod:658
17638 msgid "See also: L</sh-lines>"
17642 #: ../fish/guestfish-actions.pod:663
17647 #: ../fish/guestfish-actions.pod:665
17650 " config qemuparam qemuvalue\n"
17655 #: ../fish/guestfish-actions.pod:676
17660 #: ../fish/guestfish-actions.pod:678
17663 " copy-size src dest size\n"
17668 #: ../fish/guestfish-actions.pod:686
17673 #: ../fish/guestfish-actions.pod:688
17681 #: ../fish/guestfish-actions.pod:693
17686 #: ../fish/guestfish-actions.pod:695
17694 #: ../fish/guestfish-actions.pod:700
17699 #: ../fish/guestfish-actions.pod:702
17707 #: ../fish/guestfish-actions.pod:709
17709 "If the destination is a device, it must be as large or larger than the "
17710 "source file or device, otherwise the copy will fail. This command cannot do "
17711 "partial copies (see L</copy-size>)."
17715 #: ../fish/guestfish-actions.pod:713
17720 #: ../fish/guestfish-actions.pod:715
17723 " debug subcmd 'extraargs ...'\n"
17728 #: ../fish/guestfish-actions.pod:717
17730 "The L</debug> command exposes some internals of C<guestfsd> (the guestfs "
17731 "daemon) that runs inside the qemu subprocess."
17735 #: ../fish/guestfish-actions.pod:725
17736 msgid "debug-upload"
17740 #: ../fish/guestfish-actions.pod:727
17743 " debug-upload (filename|-) tmpname mode\n"
17748 #: ../fish/guestfish-actions.pod:729
17750 "The L</debug-upload> command uploads a file to the libguestfs appliance."
17754 #: ../fish/guestfish-actions.pod:738
17759 #: ../fish/guestfish-actions.pod:740
17767 #: ../fish/guestfish-actions.pod:748
17772 #: ../fish/guestfish-actions.pod:750
17780 #: ../fish/guestfish-actions.pod:759
17785 #: ../fish/guestfish-actions.pod:761
17793 #: ../fish/guestfish-actions.pod:767
17795 "Another way to get the same information is to enable verbose messages with "
17796 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
17797 "before running the program."
17801 #: ../fish/guestfish-actions.pod:772
17806 #: ../fish/guestfish-actions.pod:774
17809 " download remotefilename (filename|-)\n"
17814 #: ../fish/guestfish-actions.pod:781
17815 msgid "See also L</upload>, L</cat>."
17819 #: ../fish/guestfish-actions.pod:785
17820 msgid "download-offset"
17824 #: ../fish/guestfish-actions.pod:787
17827 " download-offset remotefilename (filename|-) offset size\n"
17832 #: ../fish/guestfish-actions.pod:795
17834 "Note that there is no limit on the amount of data that can be downloaded "
17835 "with this call, unlike with L</pread>, and this call always reads the full "
17836 "amount unless an error occurs."
17840 #: ../fish/guestfish-actions.pod:800
17841 msgid "See also L</download>, L</pread>."
17845 #: ../fish/guestfish-actions.pod:804
17846 msgid "drop-caches"
17850 #: ../fish/guestfish-actions.pod:806
17853 " drop-caches whattodrop\n"
17858 #: ../fish/guestfish-actions.pod:818
17863 #: ../fish/guestfish-actions.pod:820
17871 #: ../fish/guestfish-actions.pod:832
17876 #: ../fish/guestfish-actions.pod:834
17879 " e2fsck-f device\n"
17884 #: ../fish/guestfish-actions.pod:840
17886 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
17887 "should use L</fsck>."
17891 #: ../fish/guestfish-actions.pod:843
17892 msgid "echo-daemon"
17896 #: ../fish/guestfish-actions.pod:845
17899 " echo-daemon 'words ...'\n"
17904 #: ../fish/guestfish-actions.pod:852
17905 msgid "See also L</ping-daemon>."
17909 #: ../fish/guestfish-actions.pod:854
17914 #: ../fish/guestfish-actions.pod:856
17917 " egrep regex path\n"
17922 #: ../fish/guestfish-actions.pod:864
17927 #: ../fish/guestfish-actions.pod:866
17930 " egrepi regex path\n"
17935 #: ../fish/guestfish-actions.pod:874
17940 #: ../fish/guestfish-actions.pod:876
17943 " equal file1 file2\n"
17948 #: ../fish/guestfish-actions.pod:883
17953 #: ../fish/guestfish-actions.pod:885
17961 #: ../fish/guestfish-actions.pod:890
17962 msgid "See also L</is-file>, L</is-dir>, L</stat>."
17966 #: ../fish/guestfish-actions.pod:892
17971 #: ../fish/guestfish-actions.pod:894
17974 " fallocate path len\n"
17979 #: ../fish/guestfish-actions.pod:911
17980 msgid "fallocate64"
17984 #: ../fish/guestfish-actions.pod:913
17987 " fallocate64 path len\n"
17992 #: ../fish/guestfish-actions.pod:919
17994 "Note that this call allocates disk blocks for the file. To create a sparse "
17995 "file use L</truncate-size> instead."
17999 #: ../fish/guestfish-actions.pod:922
18001 "The deprecated call L</fallocate> does the same, but owing to an oversight "
18002 "it only allowed 30 bit lengths to be specified, effectively limiting the "
18003 "maximum size of files created through that call to 1GB."
18007 #: ../fish/guestfish-actions.pod:931
18012 #: ../fish/guestfish-actions.pod:933
18015 " fgrep pattern path\n"
18020 #: ../fish/guestfish-actions.pod:941
18025 #: ../fish/guestfish-actions.pod:943
18028 " fgrepi pattern path\n"
18033 #: ../fish/guestfish-actions.pod:951
18038 #: ../fish/guestfish-actions.pod:953
18046 #: ../fish/guestfish-actions.pod:965
18048 "This command can also be used on C</dev/> devices (and partitions, LV "
18049 "names). You can for example use this to determine if a device contains a "
18050 "filesystem, although it's usually better to use L</vfs-type>."
18054 #: ../fish/guestfish-actions.pod:975
18055 msgid "file-architecture"
18059 #: ../fish/guestfish-actions.pod:977
18062 " file-architecture filename\n"
18067 #: ../fish/guestfish-actions.pod:1080
18072 #: ../fish/guestfish-actions.pod:1082
18080 #: ../fish/guestfish-actions.pod:1086
18082 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
18083 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
18087 #: ../fish/guestfish-actions.pod:1090
18092 #: ../fish/guestfish-actions.pod:1092
18095 " fill c len path\n"
18100 #: ../fish/guestfish-actions.pod:1098
18102 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
18103 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
18104 "L</fill-pattern>."
18108 #: ../fish/guestfish-actions.pod:1103
18109 msgid "fill-pattern"
18113 #: ../fish/guestfish-actions.pod:1105
18116 " fill-pattern pattern len path\n"
18121 #: ../fish/guestfish-actions.pod:1107
18123 "This function is like L</fill> except that it creates a new file of length "
18124 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
18125 "is truncated if necessary to ensure the length of the file is exactly C<len> "
18130 #: ../fish/guestfish-actions.pod:1112
18135 #: ../fish/guestfish-actions.pod:1114
18138 " find directory\n"
18143 #: ../fish/guestfish-actions.pod:1128
18144 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
18148 #: ../fish/guestfish-actions.pod:1141
18149 msgid "See also L</find0>."
18153 #: ../fish/guestfish-actions.pod:1146
18158 #: ../fish/guestfish-actions.pod:1148
18161 " find0 directory (files|-)\n"
18166 #: ../fish/guestfish-actions.pod:1154
18168 "This command works the same way as L</find> with the following exceptions:"
18172 #: ../fish/guestfish-actions.pod:1181
18173 msgid "findfs-label"
18177 #: ../fish/guestfish-actions.pod:1183
18180 " findfs-label label\n"
18185 #: ../fish/guestfish-actions.pod:1189
18186 msgid "To find the label of a filesystem, use L</vfs-label>."
18190 #: ../fish/guestfish-actions.pod:1191
18191 msgid "findfs-uuid"
18195 #: ../fish/guestfish-actions.pod:1193
18198 " findfs-uuid uuid\n"
18203 #: ../fish/guestfish-actions.pod:1199
18204 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
18208 #: ../fish/guestfish-actions.pod:1201
18213 #: ../fish/guestfish-actions.pod:1203
18216 " fsck fstype device\n"
18221 #: ../fish/guestfish-actions.pod:1233
18226 #: ../fish/guestfish-actions.pod:1235
18234 #: ../fish/guestfish-actions.pod:1242
18235 msgid "get-autosync"
18239 #: ../fish/guestfish-actions.pod:1244
18247 #: ../fish/guestfish-actions.pod:1248
18252 #: ../fish/guestfish-actions.pod:1250
18260 #: ../fish/guestfish-actions.pod:1254
18261 msgid "get-e2label"
18265 #: ../fish/guestfish-actions.pod:1256
18268 " get-e2label device\n"
18273 #: ../fish/guestfish-actions.pod:1268
18278 #: ../fish/guestfish-actions.pod:1270
18281 " get-e2uuid device\n"
18286 #: ../fish/guestfish-actions.pod:1282
18287 msgid "get-memsize"
18291 #: ../fish/guestfish-actions.pod:1284
18299 #: ../fish/guestfish-actions.pod:1289
18301 "If L</set-memsize> was not called on this handle, and if "
18302 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
18303 "value for memsize."
18307 #: ../fish/guestfish-actions.pod:1296
18308 msgid "get-network"
18312 #: ../fish/guestfish-actions.pod:1298
18320 #: ../fish/guestfish-actions.pod:1302
18325 #: ../fish/guestfish-actions.pod:1304
18333 #: ../fish/guestfish-actions.pod:1311
18338 #: ../fish/guestfish-actions.pod:1313
18343 #: ../fish/guestfish-actions.pod:1315
18351 #: ../fish/guestfish-actions.pod:1322
18356 #: ../fish/guestfish-actions.pod:1324
18364 #: ../fish/guestfish-actions.pod:1331
18365 msgid "get-recovery-proc"
18369 #: ../fish/guestfish-actions.pod:1333
18372 " get-recovery-proc\n"
18377 #: ../fish/guestfish-actions.pod:1337
18378 msgid "get-selinux"
18382 #: ../fish/guestfish-actions.pod:1339
18390 #: ../fish/guestfish-actions.pod:1341
18392 "This returns the current setting of the selinux flag which is passed to the "
18393 "appliance at boot time. See L</set-selinux>."
18397 #: ../fish/guestfish-actions.pod:1347
18402 #: ../fish/guestfish-actions.pod:1349
18410 #: ../fish/guestfish-actions.pod:1356
18415 #: ../fish/guestfish-actions.pod:1358
18423 #: ../fish/guestfish-actions.pod:1362
18428 #: ../fish/guestfish-actions.pod:1364
18436 #: ../fish/guestfish-actions.pod:1366
18438 "Return the current umask. By default the umask is C<022> unless it has been "
18439 "set by calling L</umask>."
18443 #: ../fish/guestfish-actions.pod:1369
18444 msgid "get-verbose"
18448 #: ../fish/guestfish-actions.pod:1371
18456 #: ../fish/guestfish-actions.pod:1375
18461 #: ../fish/guestfish-actions.pod:1377
18469 #: ../fish/guestfish-actions.pod:1381
18470 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
18474 #: ../fish/guestfish-actions.pod:1384
18479 #: ../fish/guestfish-actions.pod:1386
18482 " getxattrs path\n"
18487 #: ../fish/guestfish-actions.pod:1394
18488 msgid "See also: L</lgetxattrs>, L<attr(5)>."
18492 #: ../fish/guestfish-actions.pod:1396
18493 msgid "glob-expand"
18497 #: ../fish/guestfish-actions.pod:1398
18500 " glob-expand pattern\n"
18505 #: ../fish/guestfish-actions.pod:1411
18510 #: ../fish/guestfish-actions.pod:1413
18513 " grep regex path\n"
18518 #: ../fish/guestfish-actions.pod:1421
18523 #: ../fish/guestfish-actions.pod:1423
18526 " grepi regex path\n"
18531 #: ../fish/guestfish-actions.pod:1431
18532 msgid "grub-install"
18536 #: ../fish/guestfish-actions.pod:1433
18539 " grub-install root device\n"
18544 #: ../fish/guestfish-actions.pod:1449
18549 #: ../fish/guestfish-actions.pod:1451
18557 #: ../fish/guestfish-actions.pod:1459
18562 #: ../fish/guestfish-actions.pod:1461
18565 " head-n nrlines path\n"
18570 #: ../fish/guestfish-actions.pod:1474
18575 #: ../fish/guestfish-actions.pod:1476
18583 #: ../fish/guestfish-actions.pod:1484
18588 #: ../fish/guestfish-actions.pod:1486
18591 " initrd-cat initrdpath filename\n"
18596 #: ../fish/guestfish-actions.pod:1498
18597 msgid "See also L</initrd-list>."
18601 #: ../fish/guestfish-actions.pod:1503
18602 msgid "initrd-list"
18606 #: ../fish/guestfish-actions.pod:1505
18609 " initrd-list path\n"
18614 #: ../fish/guestfish-actions.pod:1517
18615 msgid "inotify-add-watch"
18619 #: ../fish/guestfish-actions.pod:1519
18622 " inotify-add-watch path mask\n"
18627 #: ../fish/guestfish-actions.pod:1531
18628 msgid "inotify-close"
18632 #: ../fish/guestfish-actions.pod:1533
18640 #: ../fish/guestfish-actions.pod:1539
18641 msgid "inotify-files"
18645 #: ../fish/guestfish-actions.pod:1541
18653 #: ../fish/guestfish-actions.pod:1543
18655 "This function is a helpful wrapper around L</inotify-read> which just "
18656 "returns a list of pathnames of objects that were touched. The returned "
18657 "pathnames are sorted and deduplicated."
18661 #: ../fish/guestfish-actions.pod:1547
18662 msgid "inotify-init"
18666 #: ../fish/guestfish-actions.pod:1549
18669 " inotify-init maxevents\n"
18674 #: ../fish/guestfish-actions.pod:1555
18676 "C<maxevents> is the maximum number of events which will be queued up between "
18677 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
18678 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
18679 "default was 16384 events. Beyond this limit, the kernel throws away events, "
18680 "but records the fact that it threw them away by setting a flag "
18681 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
18685 #: ../fish/guestfish-actions.pod:1565
18687 "Before any events are generated, you have to add some watches to the "
18688 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
18689 "L</inotify-watch-all>."
18693 #: ../fish/guestfish-actions.pod:1571
18695 "Queued up events should be read periodically by calling L</inotify-read> (or "
18696 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
18697 "If you don't read the events out often enough then you risk the internal "
18698 "queue overflowing."
18702 #: ../fish/guestfish-actions.pod:1578
18704 "The handle should be closed after use by calling L</inotify-close>. This "
18705 "also removes any watches automatically."
18709 #: ../fish/guestfish-actions.pod:1587
18710 msgid "inotify-read"
18714 #: ../fish/guestfish-actions.pod:1589
18722 #: ../fish/guestfish-actions.pod:1602
18723 msgid "inotify-rm-watch"
18727 #: ../fish/guestfish-actions.pod:1604
18730 " inotify-rm-watch wd\n"
18735 #: ../fish/guestfish-actions.pod:1606
18736 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
18740 #: ../fish/guestfish-actions.pod:1609
18741 msgid "inspect-get-arch"
18745 #: ../fish/guestfish-actions.pod:1611
18748 " inspect-get-arch root\n"
18753 #: ../fish/guestfish-actions.pod:1613 ../fish/guestfish-actions.pod:1629
18754 #: ../fish/guestfish-actions.pod:1675 ../fish/guestfish-actions.pod:1693
18755 #: ../fish/guestfish-actions.pod:1714 ../fish/guestfish-actions.pod:1729
18756 #: ../fish/guestfish-actions.pod:1752 ../fish/guestfish-actions.pod:1769
18758 "This function should only be called with a root device string as returned by "
18763 #: ../fish/guestfish-actions.pod:1616
18765 "This returns the architecture of the inspected operating system. The "
18766 "possible return values are listed under L</file-architecture>."
18770 #: ../fish/guestfish-actions.pod:1625
18771 msgid "inspect-get-distro"
18775 #: ../fish/guestfish-actions.pod:1627
18778 " inspect-get-distro root\n"
18783 #: ../fish/guestfish-actions.pod:1671
18784 msgid "inspect-get-filesystems"
18788 #: ../fish/guestfish-actions.pod:1673
18791 " inspect-get-filesystems root\n"
18796 #: ../fish/guestfish-actions.pod:1686
18798 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
18799 "get-mountpoints>."
18803 #: ../fish/guestfish-actions.pod:1689
18804 msgid "inspect-get-major-version"
18808 #: ../fish/guestfish-actions.pod:1691
18811 " inspect-get-major-version root\n"
18816 #: ../fish/guestfish-actions.pod:1710
18817 msgid "inspect-get-minor-version"
18821 #: ../fish/guestfish-actions.pod:1712
18824 " inspect-get-minor-version root\n"
18829 #: ../fish/guestfish-actions.pod:1722
18831 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
18832 "get-major-version>."
18836 #: ../fish/guestfish-actions.pod:1725
18837 msgid "inspect-get-mountpoints"
18841 #: ../fish/guestfish-actions.pod:1727
18844 " inspect-get-mountpoints root\n"
18849 #: ../fish/guestfish-actions.pod:1745
18851 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
18852 "get-filesystems>."
18856 #: ../fish/guestfish-actions.pod:1748
18857 msgid "inspect-get-product-name"
18861 #: ../fish/guestfish-actions.pod:1750
18864 " inspect-get-product-name root\n"
18869 #: ../fish/guestfish-actions.pod:1765
18870 msgid "inspect-get-type"
18874 #: ../fish/guestfish-actions.pod:1767
18877 " inspect-get-type root\n"
18882 #: ../fish/guestfish-actions.pod:1796
18887 #: ../fish/guestfish-actions.pod:1798
18895 #: ../fish/guestfish-actions.pod:1813
18897 "You can pass the root string(s) returned to other L</inspect-get-*> "
18898 "functions in order to query further information about each operating system, "
18899 "such as the name and version."
18903 #: ../fish/guestfish-actions.pod:1818
18905 "This function uses other libguestfs features such as L</mount-ro> and L</"
18906 "umount-all> in order to mount and unmount filesystems and look at the "
18907 "contents. This should be called with no disks currently mounted. The "
18908 "function may also use Augeas, so any existing Augeas handle will be closed."
18912 #: ../fish/guestfish-actions.pod:1830 ../fish/guestfish-actions.pod:1986
18913 #: ../fish/guestfish-actions.pod:2032
18914 msgid "See also L</list-filesystems>."
18918 #: ../fish/guestfish-actions.pod:1832
18919 msgid "is-blockdev"
18923 #: ../fish/guestfish-actions.pod:1834
18926 " is-blockdev path\n"
18931 #: ../fish/guestfish-actions.pod:1839 ../fish/guestfish-actions.pod:1857
18932 #: ../fish/guestfish-actions.pod:1876 ../fish/guestfish-actions.pod:1885
18933 #: ../fish/guestfish-actions.pod:1895 ../fish/guestfish-actions.pod:1929
18934 #: ../fish/guestfish-actions.pod:1938
18935 msgid "See also L</stat>."
18939 #: ../fish/guestfish-actions.pod:1841
18944 #: ../fish/guestfish-actions.pod:1843
18952 #: ../fish/guestfish-actions.pod:1850
18957 #: ../fish/guestfish-actions.pod:1852
18960 " is-chardev path\n"
18965 #: ../fish/guestfish-actions.pod:1859
18970 #: ../fish/guestfish-actions.pod:1861
18978 #: ../fish/guestfish-actions.pod:1868
18983 #: ../fish/guestfish-actions.pod:1870
18991 #: ../fish/guestfish-actions.pod:1878
18996 #: ../fish/guestfish-actions.pod:1880
19004 #: ../fish/guestfish-actions.pod:1887
19009 #: ../fish/guestfish-actions.pod:1889
19017 #: ../fish/guestfish-actions.pod:1897
19018 msgid "is-launching"
19022 #: ../fish/guestfish-actions.pod:1899
19030 #: ../fish/guestfish-actions.pod:1906
19035 #: ../fish/guestfish-actions.pod:1908
19043 #: ../fish/guestfish-actions.pod:1913
19048 #: ../fish/guestfish-actions.pod:1915
19056 #: ../fish/guestfish-actions.pod:1922
19061 #: ../fish/guestfish-actions.pod:1924
19064 " is-socket path\n"
19069 #: ../fish/guestfish-actions.pod:1931
19074 #: ../fish/guestfish-actions.pod:1933
19077 " is-symlink path\n"
19082 #: ../fish/guestfish-actions.pod:1940
19083 msgid "kill-subprocess"
19087 #: ../fish/guestfish-actions.pod:1942
19090 " kill-subprocess\n"
19095 #: ../fish/guestfish-actions.pod:1946
19100 #: ../fish/guestfish-actions.pod:1948
19105 #: ../fish/guestfish-actions.pod:1950
19113 #: ../fish/guestfish-actions.pod:1958
19118 #: ../fish/guestfish-actions.pod:1960
19121 " lchown owner group path\n"
19126 #: ../fish/guestfish-actions.pod:1962
19128 "Change the file owner to C<owner> and group to C<group>. This is like L</"
19129 "chown> but if C<path> is a symlink then the link itself is changed, not the "
19134 #: ../fish/guestfish-actions.pod:1970
19139 #: ../fish/guestfish-actions.pod:1972
19142 " lgetxattrs path\n"
19147 #: ../fish/guestfish-actions.pod:1974
19149 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
19150 "it returns the extended attributes of the link itself."
19154 #: ../fish/guestfish-actions.pod:1978
19155 msgid "list-devices"
19159 #: ../fish/guestfish-actions.pod:1980
19167 #: ../fish/guestfish-actions.pod:1988
19168 msgid "list-filesystems"
19172 #: ../fish/guestfish-actions.pod:1990
19175 " list-filesystems\n"
19180 #: ../fish/guestfish-actions.pod:2009
19182 "This command runs other libguestfs commands, which might include L</mount> "
19183 "and L</umount>, and therefore you should use this soon after launch and only "
19184 "when nothing is mounted."
19188 #: ../fish/guestfish-actions.pod:2013
19190 "Not all of the filesystems returned will be mountable. In particular, swap "
19191 "partitions are returned in the list. Also this command does not check that "
19192 "each filesystem found is valid and mountable, and some filesystems might be "
19193 "mountable but require special options. Filesystems may not all belong to a "
19194 "single logical operating system (use L</inspect-os> to look for OSes)."
19198 #: ../fish/guestfish-actions.pod:2021
19199 msgid "list-partitions"
19203 #: ../fish/guestfish-actions.pod:2023
19206 " list-partitions\n"
19211 #: ../fish/guestfish-actions.pod:2029
19213 "This does not return logical volumes. For that you will need to call L</"
19218 #: ../fish/guestfish-actions.pod:2034
19223 #: ../fish/guestfish-actions.pod:2036
19231 #: ../fish/guestfish-actions.pod:2044
19236 #: ../fish/guestfish-actions.pod:2046
19239 " ln target linkname\n"
19244 #: ../fish/guestfish-actions.pod:2050
19249 #: ../fish/guestfish-actions.pod:2052
19252 " ln-f target linkname\n"
19257 #: ../fish/guestfish-actions.pod:2057
19262 #: ../fish/guestfish-actions.pod:2059
19265 " ln-s target linkname\n"
19270 #: ../fish/guestfish-actions.pod:2063
19275 #: ../fish/guestfish-actions.pod:2065
19278 " ln-sf target linkname\n"
19283 #: ../fish/guestfish-actions.pod:2070
19284 msgid "lremovexattr"
19288 #: ../fish/guestfish-actions.pod:2072
19291 " lremovexattr xattr path\n"
19296 #: ../fish/guestfish-actions.pod:2074
19298 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
19299 "it removes an extended attribute of the link itself."
19303 #: ../fish/guestfish-actions.pod:2078
19308 #: ../fish/guestfish-actions.pod:2080
19316 #: ../fish/guestfish-actions.pod:2086
19318 "This command is mostly useful for interactive sessions. Programs should "
19319 "probably use L</readdir> instead."
19323 #: ../fish/guestfish-actions.pod:2089
19328 #: ../fish/guestfish-actions.pod:2091
19331 " lsetxattr xattr val vallen path\n"
19336 #: ../fish/guestfish-actions.pod:2093
19338 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
19339 "sets an extended attribute of the link itself."
19343 #: ../fish/guestfish-actions.pod:2097
19348 #: ../fish/guestfish-actions.pod:2099
19356 #: ../fish/guestfish-actions.pod:2103
19358 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
19359 "the link is stat-ed, not the file it refers to."
19363 #: ../fish/guestfish-actions.pod:2109
19368 #: ../fish/guestfish-actions.pod:2111
19371 " lstatlist path 'names ...'\n"
19376 #: ../fish/guestfish-actions.pod:2113
19378 "This call allows you to perform the L</lstat> operation on multiple files, "
19379 "where all files are in the directory C<path>. C<names> is the list of files "
19380 "from this directory."
19384 #: ../fish/guestfish-actions.pod:2122
19386 "This call is intended for programs that want to efficiently list a directory "
19387 "contents without making many round-trips. See also L</lxattrlist> for a "
19388 "similarly efficient call for getting extended attributes. Very long "
19389 "directory listings might cause the protocol message size to be exceeded, "
19390 "causing this call to fail. The caller must split up such requests into "
19391 "smaller groups of names."
19395 #: ../fish/guestfish-actions.pod:2130
19396 msgid "luks-add-key"
19400 #: ../fish/guestfish-actions.pod:2132
19403 " luks-add-key device keyslot\n"
19408 #: ../fish/guestfish-actions.pod:2139
19410 "Note that if C<keyslot> already contains a key, then this command will "
19411 "fail. You have to use L</luks-kill-slot> first to remove that key."
19415 #: ../fish/guestfish-actions.pod:2143 ../fish/guestfish-actions.pod:2165
19416 #: ../fish/guestfish-actions.pod:2178 ../fish/guestfish-actions.pod:2192
19417 #: ../fish/guestfish-actions.pod:2215 ../fish/guestfish-actions.pod:2225
19419 "This command has one or more key or passphrase parameters. Guestfish will "
19420 "prompt for these separately."
19424 #: ../fish/guestfish-actions.pod:2146
19429 #: ../fish/guestfish-actions.pod:2148
19432 " luks-close device\n"
19437 #: ../fish/guestfish-actions.pod:2150
19439 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
19440 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
19441 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
19446 #: ../fish/guestfish-actions.pod:2156
19447 msgid "luks-format"
19451 #: ../fish/guestfish-actions.pod:2158
19454 " luks-format device keyslot\n"
19459 #: ../fish/guestfish-actions.pod:2171
19460 msgid "luks-format-cipher"
19464 #: ../fish/guestfish-actions.pod:2173
19467 " luks-format-cipher device keyslot cipher\n"
19472 #: ../fish/guestfish-actions.pod:2175
19474 "This command is the same as L</luks-format> but it also allows you to set "
19475 "the C<cipher> used."
19479 #: ../fish/guestfish-actions.pod:2184
19480 msgid "luks-kill-slot"
19484 #: ../fish/guestfish-actions.pod:2186
19487 " luks-kill-slot device keyslot\n"
19492 #: ../fish/guestfish-actions.pod:2195
19497 #: ../fish/guestfish-actions.pod:2197
19500 " luks-open device mapname\n"
19505 #: ../fish/guestfish-actions.pod:2211
19507 "If this block device contains LVM volume groups, then calling L</vgscan> "
19508 "followed by L</vg-activate-all> will make them visible."
19512 #: ../fish/guestfish-actions.pod:2218
19513 msgid "luks-open-ro"
19517 #: ../fish/guestfish-actions.pod:2220
19520 " luks-open-ro device mapname\n"
19525 #: ../fish/guestfish-actions.pod:2222
19527 "This is the same as L</luks-open> except that a read-only mapping is created."
19531 #: ../fish/guestfish-actions.pod:2228
19536 #: ../fish/guestfish-actions.pod:2230
19539 " lvcreate logvol volgroup mbytes\n"
19544 #: ../fish/guestfish-actions.pod:2235
19545 msgid "lvm-clear-filter"
19549 #: ../fish/guestfish-actions.pod:2237
19552 " lvm-clear-filter\n"
19557 #: ../fish/guestfish-actions.pod:2239
19559 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
19564 #: ../fish/guestfish-actions.pod:2245
19565 msgid "lvm-remove-all"
19569 #: ../fish/guestfish-actions.pod:2247
19572 " lvm-remove-all\n"
19577 #: ../fish/guestfish-actions.pod:2255
19578 msgid "lvm-set-filter"
19582 #: ../fish/guestfish-actions.pod:2257
19585 " lvm-set-filter 'devices ...'\n"
19590 #: ../fish/guestfish-actions.pod:2282
19595 #: ../fish/guestfish-actions.pod:2284
19598 " lvremove device\n"
19603 #: ../fish/guestfish-actions.pod:2292
19608 #: ../fish/guestfish-actions.pod:2294
19611 " lvrename logvol newlogvol\n"
19616 #: ../fish/guestfish-actions.pod:2298
19621 #: ../fish/guestfish-actions.pod:2300
19624 " lvresize device mbytes\n"
19629 #: ../fish/guestfish-actions.pod:2306
19630 msgid "lvresize-free"
19634 #: ../fish/guestfish-actions.pod:2308
19637 " lvresize-free lv percent\n"
19642 #: ../fish/guestfish-actions.pod:2316
19647 #: ../fish/guestfish-actions.pod:2318
19655 #: ../fish/guestfish-actions.pod:2326
19656 msgid "See also L</lvs-full>, L</list-filesystems>."
19660 #: ../fish/guestfish-actions.pod:2328
19665 #: ../fish/guestfish-actions.pod:2330
19673 #: ../fish/guestfish-actions.pod:2335
19678 #: ../fish/guestfish-actions.pod:2337
19686 #: ../fish/guestfish-actions.pod:2341
19691 #: ../fish/guestfish-actions.pod:2343
19694 " lxattrlist path 'names ...'\n"
19699 #: ../fish/guestfish-actions.pod:2359
19701 "This call is intended for programs that want to efficiently list a directory "
19702 "contents without making many round-trips. See also L</lstatlist> for a "
19703 "similarly efficient call for getting standard stats. Very long directory "
19704 "listings might cause the protocol message size to be exceeded, causing this "
19705 "call to fail. The caller must split up such requests into smaller groups of "
19710 #: ../fish/guestfish-actions.pod:2367
19715 #: ../fish/guestfish-actions.pod:2369
19723 #: ../fish/guestfish-actions.pod:2373
19728 #: ../fish/guestfish-actions.pod:2375
19731 " mkdir-mode path mode\n"
19736 #: ../fish/guestfish-actions.pod:2384
19737 msgid "See also L</mkdir>, L</umask>"
19741 #: ../fish/guestfish-actions.pod:2386
19746 #: ../fish/guestfish-actions.pod:2388
19754 #: ../fish/guestfish-actions.pod:2393
19759 #: ../fish/guestfish-actions.pod:2395
19762 " mkdtemp template\n"
19767 #: ../fish/guestfish-actions.pod:2416
19772 #: ../fish/guestfish-actions.pod:2418
19775 " mke2fs-J fstype blocksize device journal\n"
19780 #: ../fish/guestfish-actions.pod:2426
19781 msgid "See also L</mke2journal>."
19785 #: ../fish/guestfish-actions.pod:2428
19790 #: ../fish/guestfish-actions.pod:2430
19793 " mke2fs-JL fstype blocksize device label\n"
19798 #: ../fish/guestfish-actions.pod:2435
19799 msgid "See also L</mke2journal-L>."
19803 #: ../fish/guestfish-actions.pod:2437
19808 #: ../fish/guestfish-actions.pod:2439
19811 " mke2fs-JU fstype blocksize device uuid\n"
19816 #: ../fish/guestfish-actions.pod:2444
19817 msgid "See also L</mke2journal-U>."
19821 #: ../fish/guestfish-actions.pod:2446
19822 msgid "mke2journal"
19826 #: ../fish/guestfish-actions.pod:2448
19829 " mke2journal blocksize device\n"
19834 #: ../fish/guestfish-actions.pod:2455
19835 msgid "mke2journal-L"
19839 #: ../fish/guestfish-actions.pod:2457
19842 " mke2journal-L blocksize label device\n"
19847 #: ../fish/guestfish-actions.pod:2461
19848 msgid "mke2journal-U"
19852 #: ../fish/guestfish-actions.pod:2463
19855 " mke2journal-U blocksize uuid device\n"
19860 #: ../fish/guestfish-actions.pod:2467
19865 #: ../fish/guestfish-actions.pod:2469
19868 " mkfifo mode path\n"
19873 #: ../fish/guestfish-actions.pod:2471
19875 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
19876 "is just a convenient wrapper around L</mknod>."
19880 #: ../fish/guestfish-actions.pod:2477
19885 #: ../fish/guestfish-actions.pod:2479
19888 " mkfs fstype device\n"
19893 #: ../fish/guestfish-actions.pod:2485
19898 #: ../fish/guestfish-actions.pod:2487
19901 " mkfs-b fstype blocksize device\n"
19906 #: ../fish/guestfish-actions.pod:2489
19908 "This call is similar to L</mkfs>, but it allows you to control the block "
19909 "size of the resulting filesystem. Supported block sizes depend on the "
19910 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
19914 #: ../fish/guestfish-actions.pod:2497
19915 msgid "mkmountpoint"
19919 #: ../fish/guestfish-actions.pod:2499
19922 " mkmountpoint exemptpath\n"
19927 #: ../fish/guestfish-actions.pod:2501
19929 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
19930 "to create extra mountpoints before mounting the first filesystem."
19934 #: ../fish/guestfish-actions.pod:2525
19939 #: ../fish/guestfish-actions.pod:2527
19942 " mknod mode devmajor devminor path\n"
19947 #: ../fish/guestfish-actions.pod:2537
19949 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
19950 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
19951 "regular file). These constants are available in the standard Linux header "
19952 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
19953 "wrappers around this command which bitwise OR in the appropriate constant "
19958 #: ../fish/guestfish-actions.pod:2547
19963 #: ../fish/guestfish-actions.pod:2549
19966 " mknod-b mode devmajor devminor path\n"
19971 #: ../fish/guestfish-actions.pod:2551
19973 "This call creates a block device node called C<path> with mode C<mode> and "
19974 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
19975 "wrapper around L</mknod>."
19979 #: ../fish/guestfish-actions.pod:2557
19984 #: ../fish/guestfish-actions.pod:2559
19987 " mknod-c mode devmajor devminor path\n"
19992 #: ../fish/guestfish-actions.pod:2561
19994 "This call creates a char device node called C<path> with mode C<mode> and "
19995 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
19996 "wrapper around L</mknod>."
20000 #: ../fish/guestfish-actions.pod:2567
20005 #: ../fish/guestfish-actions.pod:2569
20013 #: ../fish/guestfish-actions.pod:2573
20018 #: ../fish/guestfish-actions.pod:2575
20021 " mkswap-L label device\n"
20026 #: ../fish/guestfish-actions.pod:2583
20031 #: ../fish/guestfish-actions.pod:2585
20034 " mkswap-U uuid device\n"
20039 #: ../fish/guestfish-actions.pod:2589
20040 msgid "mkswap-file"
20044 #: ../fish/guestfish-actions.pod:2591
20047 " mkswap-file path\n"
20052 #: ../fish/guestfish-actions.pod:2595
20054 "This command just writes a swap file signature to an existing file. To "
20055 "create the file itself, use something like L</fallocate>."
20059 #: ../fish/guestfish-actions.pod:2598
20064 #: ../fish/guestfish-actions.pod:2600
20067 " modprobe modulename\n"
20072 #: ../fish/guestfish-actions.pod:2607
20077 #: ../fish/guestfish-actions.pod:2609
20080 " mount device mountpoint\n"
20085 #: ../fish/guestfish-actions.pod:2625
20087 "B<Important note:> When you use this call, the filesystem options C<sync> "
20088 "and C<noatime> are set implicitly. This was originally done because we "
20089 "thought it would improve reliability, but it turns out that I<-o sync> has a "
20090 "very large negative performance impact and negligible effect on "
20091 "reliability. Therefore we recommend that you avoid using L</mount> in any "
20092 "code that needs performance, and instead use L</mount-options> (use an empty "
20093 "string for the first parameter if you don't want any options)."
20097 #: ../fish/guestfish-actions.pod:2635
20102 #: ../fish/guestfish-actions.pod:2637
20105 " mount-loop file mountpoint\n"
20110 #: ../fish/guestfish-actions.pod:2643
20111 msgid "mount-options"
20115 #: ../fish/guestfish-actions.pod:2645
20118 " mount-options options device mountpoint\n"
20123 #: ../fish/guestfish-actions.pod:2647
20125 "This is the same as the L</mount> command, but it allows you to set the "
20126 "mount options as for the L<mount(8)> I<-o> flag."
20130 #: ../fish/guestfish-actions.pod:2655
20135 #: ../fish/guestfish-actions.pod:2657
20138 " mount-ro device mountpoint\n"
20143 #: ../fish/guestfish-actions.pod:2659
20145 "This is the same as the L</mount> command, but it mounts the filesystem with "
20146 "the read-only (I<-o ro>) flag."
20150 #: ../fish/guestfish-actions.pod:2662
20155 #: ../fish/guestfish-actions.pod:2664
20158 " mount-vfs options vfstype device mountpoint\n"
20163 #: ../fish/guestfish-actions.pod:2666
20165 "This is the same as the L</mount> command, but it allows you to set both the "
20166 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
20170 #: ../fish/guestfish-actions.pod:2670
20171 msgid "mountpoints"
20175 #: ../fish/guestfish-actions.pod:2672
20183 #: ../fish/guestfish-actions.pod:2674
20185 "This call is similar to L</mounts>. That call returns a list of devices. "
20186 "This one returns a hash table (map) of device name to directory where the "
20187 "device is mounted."
20191 #: ../fish/guestfish-actions.pod:2678
20196 #: ../fish/guestfish-actions.pod:2680
20204 #: ../fish/guestfish-actions.pod:2687
20205 msgid "See also: L</mountpoints>"
20209 #: ../fish/guestfish-actions.pod:2689
20214 #: ../fish/guestfish-actions.pod:2691
20222 #: ../fish/guestfish-actions.pod:2696
20223 msgid "ntfs-3g-probe"
20227 #: ../fish/guestfish-actions.pod:2698
20230 " ntfs-3g-probe true|false device\n"
20235 #: ../fish/guestfish-actions.pod:2712
20240 #: ../fish/guestfish-actions.pod:2714
20243 " ntfsresize device\n"
20248 #: ../fish/guestfish-actions.pod:2720
20249 msgid "ntfsresize-size"
20253 #: ../fish/guestfish-actions.pod:2722
20256 " ntfsresize-size device size\n"
20261 #: ../fish/guestfish-actions.pod:2724
20263 "This command is the same as L</ntfsresize> except that it allows you to "
20264 "specify the new size (in bytes) explicitly."
20268 #: ../fish/guestfish-actions.pod:2727
20273 #: ../fish/guestfish-actions.pod:2729
20276 " part-add device prlogex startsect endsect\n"
20281 #: ../fish/guestfish-actions.pod:2731
20283 "This command adds a partition to C<device>. If there is no partition table "
20284 "on the device, call L</part-init> first."
20288 #: ../fish/guestfish-actions.pod:2743
20290 "Creating a partition which covers the whole disk is not so easy. Use L</"
20291 "part-disk> to do that."
20295 #: ../fish/guestfish-actions.pod:2746
20300 #: ../fish/guestfish-actions.pod:2748
20303 " part-del device partnum\n"
20308 #: ../fish/guestfish-actions.pod:2756
20313 #: ../fish/guestfish-actions.pod:2758
20316 " part-disk device parttype\n"
20321 #: ../fish/guestfish-actions.pod:2760
20323 "This command is simply a combination of L</part-init> followed by L</part-"
20324 "add> to create a single primary partition covering the whole disk."
20328 #: ../fish/guestfish-actions.pod:2764
20330 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
20331 "possible values are described in L</part-init>."
20335 #: ../fish/guestfish-actions.pod:2770
20336 msgid "part-get-bootable"
20340 #: ../fish/guestfish-actions.pod:2772
20343 " part-get-bootable device partnum\n"
20348 #: ../fish/guestfish-actions.pod:2777
20349 msgid "See also L</part-set-bootable>."
20353 #: ../fish/guestfish-actions.pod:2779
20354 msgid "part-get-mbr-id"
20358 #: ../fish/guestfish-actions.pod:2781
20361 " part-get-mbr-id device partnum\n"
20366 #: ../fish/guestfish-actions.pod:2786 ../fish/guestfish-actions.pod:2924
20368 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
20369 "undefined results for other partition table types (see L</part-get-"
20374 #: ../fish/guestfish-actions.pod:2790
20375 msgid "part-get-parttype"
20379 #: ../fish/guestfish-actions.pod:2792
20382 " part-get-parttype device\n"
20387 #: ../fish/guestfish-actions.pod:2797
20389 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
20390 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
20391 "possible, although unusual. See L</part-init> for a full list."
20395 #: ../fish/guestfish-actions.pod:2802
20400 #: ../fish/guestfish-actions.pod:2804
20403 " part-init device parttype\n"
20408 #: ../fish/guestfish-actions.pod:2810
20410 "Initially there are no partitions. Following this, you should call L</part-"
20411 "add> for each partition required."
20415 #: ../fish/guestfish-actions.pod:2873
20420 #: ../fish/guestfish-actions.pod:2875
20423 " part-list device\n"
20428 #: ../fish/guestfish-actions.pod:2890
20430 "Start of the partition I<in bytes>. To get sectors you have to divide by "
20431 "the device's sector size, see L</blockdev-getss>."
20435 #: ../fish/guestfish-actions.pod:2903
20436 msgid "part-set-bootable"
20440 #: ../fish/guestfish-actions.pod:2905
20443 " part-set-bootable device partnum true|false\n"
20448 #: ../fish/guestfish-actions.pod:2914
20449 msgid "part-set-mbr-id"
20453 #: ../fish/guestfish-actions.pod:2916
20456 " part-set-mbr-id device partnum idbyte\n"
20461 #: ../fish/guestfish-actions.pod:2928
20462 msgid "part-set-name"
20466 #: ../fish/guestfish-actions.pod:2930
20469 " part-set-name device partnum name\n"
20474 #: ../fish/guestfish-actions.pod:2938
20475 msgid "part-to-dev"
20479 #: ../fish/guestfish-actions.pod:2940
20482 " part-to-dev partition\n"
20487 #: ../fish/guestfish-actions.pod:2946
20489 "The named partition must exist, for example as a string returned from L</"
20490 "list-partitions>."
20494 #: ../fish/guestfish-actions.pod:2949
20495 msgid "ping-daemon"
20499 #: ../fish/guestfish-actions.pod:2951
20507 #: ../fish/guestfish-actions.pod:2958
20512 #: ../fish/guestfish-actions.pod:2960
20515 " pread path count offset\n"
20520 #: ../fish/guestfish-actions.pod:2968
20521 msgid "See also L</pwrite>, L</pread-device>."
20525 #: ../fish/guestfish-actions.pod:2973
20526 msgid "pread-device"
20530 #: ../fish/guestfish-actions.pod:2975
20533 " pread-device device count offset\n"
20538 #: ../fish/guestfish-actions.pod:2983
20539 msgid "See also L</pread>."
20543 #: ../fish/guestfish-actions.pod:2988
20548 #: ../fish/guestfish-actions.pod:2990
20551 " pvcreate device\n"
20556 #: ../fish/guestfish-actions.pod:2996
20561 #: ../fish/guestfish-actions.pod:2998
20564 " pvremove device\n"
20569 #: ../fish/guestfish-actions.pod:3007
20574 #: ../fish/guestfish-actions.pod:3009
20577 " pvresize device\n"
20582 #: ../fish/guestfish-actions.pod:3014
20583 msgid "pvresize-size"
20587 #: ../fish/guestfish-actions.pod:3016
20590 " pvresize-size device size\n"
20595 #: ../fish/guestfish-actions.pod:3018
20597 "This command is the same as L</pvresize> except that it allows you to "
20598 "specify the new size (in bytes) explicitly."
20602 #: ../fish/guestfish-actions.pod:3021
20607 #: ../fish/guestfish-actions.pod:3023
20615 #: ../fish/guestfish-actions.pod:3031
20616 msgid "See also L</pvs-full>."
20620 #: ../fish/guestfish-actions.pod:3033
20625 #: ../fish/guestfish-actions.pod:3035
20633 #: ../fish/guestfish-actions.pod:3040
20638 #: ../fish/guestfish-actions.pod:3042
20646 #: ../fish/guestfish-actions.pod:3046
20651 #: ../fish/guestfish-actions.pod:3048
20654 " pwrite path content offset\n"
20659 #: ../fish/guestfish-actions.pod:3059
20660 msgid "See also L</pread>, L</pwrite-device>."
20664 #: ../fish/guestfish-actions.pod:3064
20665 msgid "pwrite-device"
20669 #: ../fish/guestfish-actions.pod:3066
20672 " pwrite-device device content offset\n"
20677 #: ../fish/guestfish-actions.pod:3076
20678 msgid "See also L</pwrite>."
20682 #: ../fish/guestfish-actions.pod:3081
20687 #: ../fish/guestfish-actions.pod:3083
20690 " read-file path\n"
20695 #: ../fish/guestfish-actions.pod:3088
20697 "Unlike L</cat>, this function can correctly handle files that contain "
20698 "embedded ASCII NUL characters. However unlike L</download>, this function "
20699 "is limited in the total size of file that can be handled."
20703 #: ../fish/guestfish-actions.pod:3096
20708 #: ../fish/guestfish-actions.pod:3098
20711 " read-lines path\n"
20716 #: ../fish/guestfish-actions.pod:3105
20718 "Note that this function cannot correctly handle binary files (specifically, "
20719 "files containing C<\\0> character which is treated as end of line). For "
20720 "those you need to use the L</read-file> function which has a more complex "
20725 #: ../fish/guestfish-actions.pod:3110
20730 #: ../fish/guestfish-actions.pod:3112
20738 #: ../fish/guestfish-actions.pod:3164
20740 "This function is primarily intended for use by programs. To get a simple "
20741 "list of names, use L</ls>. To get a printable directory for human "
20742 "consumption, use L</ll>."
20746 #: ../fish/guestfish-actions.pod:3168
20751 #: ../fish/guestfish-actions.pod:3170
20759 #: ../fish/guestfish-actions.pod:3174
20760 msgid "readlinklist"
20764 #: ../fish/guestfish-actions.pod:3176
20767 " readlinklist path 'names ...'\n"
20772 #: ../fish/guestfish-actions.pod:3200
20777 #: ../fish/guestfish-actions.pod:3202
20785 #: ../fish/guestfish-actions.pod:3207
20786 msgid "removexattr"
20790 #: ../fish/guestfish-actions.pod:3209
20793 " removexattr xattr path\n"
20798 #: ../fish/guestfish-actions.pod:3214
20799 msgid "See also: L</lremovexattr>, L<attr(5)>."
20803 #: ../fish/guestfish-actions.pod:3216
20808 #: ../fish/guestfish-actions.pod:3218
20811 " resize2fs device\n"
20816 #: ../fish/guestfish-actions.pod:3223
20818 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
20819 "before calling this command. For unknown reasons C<resize2fs> sometimes "
20820 "gives an error about this and sometimes not. In any case, it is always safe "
20821 "to call L</e2fsck-f> before calling this function."
20825 #: ../fish/guestfish-actions.pod:3229
20826 msgid "resize2fs-size"
20830 #: ../fish/guestfish-actions.pod:3231
20833 " resize2fs-size device size\n"
20838 #: ../fish/guestfish-actions.pod:3233
20840 "This command is the same as L</resize2fs> except that it allows you to "
20841 "specify the new size (in bytes) explicitly."
20845 #: ../fish/guestfish-actions.pod:3236
20850 #: ../fish/guestfish-actions.pod:3238
20858 #: ../fish/guestfish-actions.pod:3242
20863 #: ../fish/guestfish-actions.pod:3244
20871 #: ../fish/guestfish-actions.pod:3250
20876 #: ../fish/guestfish-actions.pod:3252
20884 #: ../fish/guestfish-actions.pod:3256
20885 msgid "rmmountpoint"
20889 #: ../fish/guestfish-actions.pod:3258
20892 " rmmountpoint exemptpath\n"
20897 #: ../fish/guestfish-actions.pod:3260
20899 "This calls removes a mountpoint that was previously created with L</"
20900 "mkmountpoint>. See L</mkmountpoint> for full details."
20904 #: ../fish/guestfish-actions.pod:3264
20905 msgid "scrub-device"
20909 #: ../fish/guestfish-actions.pod:3266
20912 " scrub-device device\n"
20917 #: ../fish/guestfish-actions.pod:3277
20922 #: ../fish/guestfish-actions.pod:3279
20925 " scrub-file file\n"
20930 #: ../fish/guestfish-actions.pod:3289
20931 msgid "scrub-freespace"
20935 #: ../fish/guestfish-actions.pod:3291
20938 " scrub-freespace dir\n"
20943 #: ../fish/guestfish-actions.pod:3293
20945 "This command creates the directory C<dir> and then fills it with files until "
20946 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
20947 "deletes them. The intention is to scrub any free space on the partition "
20948 "containing C<dir>."
20952 #: ../fish/guestfish-actions.pod:3302
20957 #: ../fish/guestfish-actions.pod:3304
20962 #: ../fish/guestfish-actions.pod:3306
20965 " set-append append\n"
20970 #: ../fish/guestfish-actions.pod:3317
20971 msgid "set-autosync"
20975 #: ../fish/guestfish-actions.pod:3319
20980 #: ../fish/guestfish-actions.pod:3321
20983 " set-autosync true|false\n"
20988 #: ../fish/guestfish-actions.pod:3323
20990 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
20991 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
20992 "closed (also if the program exits without closing handles)."
20996 #: ../fish/guestfish-actions.pod:3331
21001 #: ../fish/guestfish-actions.pod:3333
21006 #: ../fish/guestfish-actions.pod:3335
21009 " set-direct true|false\n"
21014 #: ../fish/guestfish-actions.pod:3341
21016 "One consequence of this is that log messages aren't caught by the library "
21017 "and handled by L</set-log-message-callback>, but go straight to stdout."
21021 #: ../fish/guestfish-actions.pod:3350
21022 msgid "set-e2label"
21026 #: ../fish/guestfish-actions.pod:3352
21029 " set-e2label device label\n"
21034 #: ../fish/guestfish-actions.pod:3358
21036 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
21037 "label on a filesystem."
21041 #: ../fish/guestfish-actions.pod:3361
21046 #: ../fish/guestfish-actions.pod:3363
21049 " set-e2uuid device uuid\n"
21054 #: ../fish/guestfish-actions.pod:3370
21056 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
21057 "UUID of a filesystem."
21061 #: ../fish/guestfish-actions.pod:3373
21062 msgid "set-memsize"
21066 #: ../fish/guestfish-actions.pod:3375
21071 #: ../fish/guestfish-actions.pod:3377
21074 " set-memsize memsize\n"
21079 #: ../fish/guestfish-actions.pod:3379
21081 "This sets the memory size in megabytes allocated to the qemu subprocess. "
21082 "This only has any effect if called before L</launch>."
21086 #: ../fish/guestfish-actions.pod:3390
21087 msgid "set-network"
21091 #: ../fish/guestfish-actions.pod:3392
21096 #: ../fish/guestfish-actions.pod:3394
21099 " set-network true|false\n"
21104 #: ../fish/guestfish-actions.pod:3402
21106 "You must call this before calling L</launch>, otherwise it has no effect."
21110 #: ../fish/guestfish-actions.pod:3405
21115 #: ../fish/guestfish-actions.pod:3407
21120 #: ../fish/guestfish-actions.pod:3409
21123 " set-path searchpath\n"
21128 #: ../fish/guestfish-actions.pod:3418
21133 #: ../fish/guestfish-actions.pod:3420
21138 #: ../fish/guestfish-actions.pod:3422
21146 #: ../fish/guestfish-actions.pod:3442
21147 msgid "set-recovery-proc"
21151 #: ../fish/guestfish-actions.pod:3444
21152 msgid "recovery-proc"
21156 #: ../fish/guestfish-actions.pod:3446
21159 " set-recovery-proc true|false\n"
21164 #: ../fish/guestfish-actions.pod:3448
21166 "If this is called with the parameter C<false> then L</launch> does not "
21167 "create a recovery process. The purpose of the recovery process is to stop "
21168 "runaway qemu processes in the case where the main program aborts abruptly."
21172 #: ../fish/guestfish-actions.pod:3453
21174 "This only has any effect if called before L</launch>, and the default is "
21179 #: ../fish/guestfish-actions.pod:3462
21180 msgid "set-selinux"
21184 #: ../fish/guestfish-actions.pod:3464
21189 #: ../fish/guestfish-actions.pod:3466
21192 " set-selinux true|false\n"
21197 #: ../fish/guestfish-actions.pod:3477
21202 #: ../fish/guestfish-actions.pod:3479
21207 #: ../fish/guestfish-actions.pod:3481
21210 " set-trace true|false\n"
21215 #: ../fish/guestfish-actions.pod:3497
21216 msgid "set-verbose"
21220 #: ../fish/guestfish-actions.pod:3499
21225 #: ../fish/guestfish-actions.pod:3501
21228 " set-verbose true|false\n"
21233 #: ../fish/guestfish-actions.pod:3508
21238 #: ../fish/guestfish-actions.pod:3510
21241 " setcon context\n"
21246 #: ../fish/guestfish-actions.pod:3517
21251 #: ../fish/guestfish-actions.pod:3519
21254 " setxattr xattr val vallen path\n"
21259 #: ../fish/guestfish-actions.pod:3525
21260 msgid "See also: L</lsetxattr>, L<attr(5)>."
21264 #: ../fish/guestfish-actions.pod:3527
21269 #: ../fish/guestfish-actions.pod:3529
21272 " sfdisk device cyls heads sectors 'lines ...'\n"
21277 #: ../fish/guestfish-actions.pod:3551
21278 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
21282 #: ../fish/guestfish-actions.pod:3557
21287 #: ../fish/guestfish-actions.pod:3559
21290 " sfdiskM device 'lines ...'\n"
21295 #: ../fish/guestfish-actions.pod:3561
21297 "This is a simplified interface to the L</sfdisk> command, where partition "
21298 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
21299 "you don't need to specify the cyls, heads and sectors parameters which were "
21300 "rarely if ever used anyway."
21304 #: ../fish/guestfish-actions.pod:3567
21305 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
21309 #: ../fish/guestfish-actions.pod:3573
21314 #: ../fish/guestfish-actions.pod:3575
21317 " sfdisk-N device partnum cyls heads sectors line\n"
21322 #: ../fish/guestfish-actions.pod:3580
21324 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
21325 "cyls/heads/sectors parameters."
21329 #: ../fish/guestfish-actions.pod:3583
21330 msgid "See also: L</part-add>"
21334 #: ../fish/guestfish-actions.pod:3588
21335 msgid "sfdisk-disk-geometry"
21339 #: ../fish/guestfish-actions.pod:3590
21342 " sfdisk-disk-geometry device\n"
21347 #: ../fish/guestfish-actions.pod:3592
21349 "This displays the disk geometry of C<device> read from the partition table. "
21350 "Especially in the case where the underlying block device has been resized, "
21351 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
21352 "kernel-geometry>)."
21356 #: ../fish/guestfish-actions.pod:3600
21357 msgid "sfdisk-kernel-geometry"
21361 #: ../fish/guestfish-actions.pod:3602
21364 " sfdisk-kernel-geometry device\n"
21369 #: ../fish/guestfish-actions.pod:3609
21374 #: ../fish/guestfish-actions.pod:3611
21377 " sfdisk-l device\n"
21382 #: ../fish/guestfish-actions.pod:3617
21383 msgid "See also: L</part-list>"
21387 #: ../fish/guestfish-actions.pod:3619
21392 #: ../fish/guestfish-actions.pod:3621
21400 #: ../fish/guestfish-actions.pod:3626
21401 msgid "This is like L</command>, but passes the command to:"
21405 #: ../fish/guestfish-actions.pod:3634
21406 msgid "All the provisos about L</command> apply to this call."
21410 #: ../fish/guestfish-actions.pod:3636
21415 #: ../fish/guestfish-actions.pod:3638
21418 " sh-lines command\n"
21423 #: ../fish/guestfish-actions.pod:3640
21424 msgid "This is the same as L</sh>, but splits the result into a list of lines."
21428 #: ../fish/guestfish-actions.pod:3643
21429 msgid "See also: L</command-lines>"
21433 #: ../fish/guestfish-actions.pod:3645
21438 #: ../fish/guestfish-actions.pod:3647
21446 #: ../fish/guestfish-actions.pod:3651
21451 #: ../fish/guestfish-actions.pod:3653
21459 #: ../fish/guestfish-actions.pod:3659
21464 #: ../fish/guestfish-actions.pod:3661
21472 #: ../fish/guestfish-actions.pod:3669
21477 #: ../fish/guestfish-actions.pod:3671
21485 #: ../fish/guestfish-actions.pod:3679
21490 #: ../fish/guestfish-actions.pod:3681
21493 " strings-e encoding path\n"
21498 #: ../fish/guestfish-actions.pod:3683
21500 "This is like the L</strings> command, but allows you to specify the encoding "
21501 "of strings that are looked for in the source file C<path>."
21505 #: ../fish/guestfish-actions.pod:3693
21507 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
21508 "ISO-8859-X (this is what L</strings> uses)."
21512 #: ../fish/guestfish-actions.pod:3725
21513 msgid "swapoff-device"
21517 #: ../fish/guestfish-actions.pod:3727
21520 " swapoff-device device\n"
21525 #: ../fish/guestfish-actions.pod:3729
21527 "This command disables the libguestfs appliance swap device or partition "
21528 "named C<device>. See L</swapon-device>."
21532 #: ../fish/guestfish-actions.pod:3733
21533 msgid "swapoff-file"
21537 #: ../fish/guestfish-actions.pod:3735
21540 " swapoff-file file\n"
21545 #: ../fish/guestfish-actions.pod:3739
21546 msgid "swapoff-label"
21550 #: ../fish/guestfish-actions.pod:3741
21553 " swapoff-label label\n"
21558 #: ../fish/guestfish-actions.pod:3746
21559 msgid "swapoff-uuid"
21563 #: ../fish/guestfish-actions.pod:3748
21566 " swapoff-uuid uuid\n"
21571 #: ../fish/guestfish-actions.pod:3753
21572 msgid "swapon-device"
21576 #: ../fish/guestfish-actions.pod:3755
21579 " swapon-device device\n"
21584 #: ../fish/guestfish-actions.pod:3757
21586 "This command enables the libguestfs appliance to use the swap device or "
21587 "partition named C<device>. The increased memory is made available for all "
21588 "commands, for example those run using L</command> or L</sh>."
21592 #: ../fish/guestfish-actions.pod:3769
21593 msgid "swapon-file"
21597 #: ../fish/guestfish-actions.pod:3771
21600 " swapon-file file\n"
21605 #: ../fish/guestfish-actions.pod:3773
21607 "This command enables swap to a file. See L</swapon-device> for other notes."
21611 #: ../fish/guestfish-actions.pod:3776
21612 msgid "swapon-label"
21616 #: ../fish/guestfish-actions.pod:3778
21619 " swapon-label label\n"
21624 #: ../fish/guestfish-actions.pod:3780
21626 "This command enables swap to a labeled swap partition. See L</swapon-"
21627 "device> for other notes."
21631 #: ../fish/guestfish-actions.pod:3783
21632 msgid "swapon-uuid"
21636 #: ../fish/guestfish-actions.pod:3785
21639 " swapon-uuid uuid\n"
21644 #: ../fish/guestfish-actions.pod:3787
21646 "This command enables swap to a swap partition with the given UUID. See L</"
21647 "swapon-device> for other notes."
21651 #: ../fish/guestfish-actions.pod:3790
21656 #: ../fish/guestfish-actions.pod:3792
21664 #: ../fish/guestfish-actions.pod:3800
21669 #: ../fish/guestfish-actions.pod:3802
21677 #: ../fish/guestfish-actions.pod:3810
21682 #: ../fish/guestfish-actions.pod:3812
21685 " tail-n nrlines path\n"
21690 #: ../fish/guestfish-actions.pod:3825
21695 #: ../fish/guestfish-actions.pod:3827
21698 " tar-in (tarfile|-) directory\n"
21703 #: ../fish/guestfish-actions.pod:3832
21704 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
21708 #: ../fish/guestfish-actions.pod:3837
21713 #: ../fish/guestfish-actions.pod:3839
21716 " tar-out directory (tarfile|-)\n"
21721 #: ../fish/guestfish-actions.pod:3844
21722 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
21726 #: ../fish/guestfish-actions.pod:3849
21731 #: ../fish/guestfish-actions.pod:3851
21734 " tgz-in (tarball|-) directory\n"
21739 #: ../fish/guestfish-actions.pod:3856
21740 msgid "To upload an uncompressed tarball, use L</tar-in>."
21744 #: ../fish/guestfish-actions.pod:3860
21749 #: ../fish/guestfish-actions.pod:3862
21752 " tgz-out directory (tarball|-)\n"
21757 #: ../fish/guestfish-actions.pod:3867
21758 msgid "To download an uncompressed tarball, use L</tar-out>."
21762 #: ../fish/guestfish-actions.pod:3871
21767 #: ../fish/guestfish-actions.pod:3873
21775 #: ../fish/guestfish-actions.pod:3882
21780 #: ../fish/guestfish-actions.pod:3884
21788 #: ../fish/guestfish-actions.pod:3889
21789 msgid "truncate-size"
21793 #: ../fish/guestfish-actions.pod:3891
21796 " truncate-size path size\n"
21801 #: ../fish/guestfish-actions.pod:3896
21803 "If the current file size is less than C<size> then the file is extended to "
21804 "the required size with zero bytes. This creates a sparse file (ie. disk "
21805 "blocks are not allocated for the file until you write to it). To create a "
21806 "non-sparse file of zeroes, use L</fallocate64> instead."
21810 #: ../fish/guestfish-actions.pod:3902
21815 #: ../fish/guestfish-actions.pod:3904
21818 " tune2fs-l device\n"
21823 #: ../fish/guestfish-actions.pod:3914
21828 #: ../fish/guestfish-actions.pod:3916
21831 " txz-in (tarball|-) directory\n"
21836 #: ../fish/guestfish-actions.pod:3923
21841 #: ../fish/guestfish-actions.pod:3925
21844 " txz-out directory (tarball|-)\n"
21849 #: ../fish/guestfish-actions.pod:3932
21854 #: ../fish/guestfish-actions.pod:3934
21862 #: ../fish/guestfish-actions.pod:3948
21863 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
21867 #: ../fish/guestfish-actions.pod:3953
21872 #: ../fish/guestfish-actions.pod:3955
21877 #: ../fish/guestfish-actions.pod:3957
21880 " umount pathordevice\n"
21885 #: ../fish/guestfish-actions.pod:3963
21890 #: ../fish/guestfish-actions.pod:3965
21891 msgid "unmount-all"
21895 #: ../fish/guestfish-actions.pod:3967
21903 #: ../fish/guestfish-actions.pod:3973
21908 #: ../fish/guestfish-actions.pod:3975
21911 " upload (filename|-) remotefilename\n"
21916 #: ../fish/guestfish-actions.pod:3982
21917 msgid "See also L</download>."
21921 #: ../fish/guestfish-actions.pod:3986
21922 msgid "upload-offset"
21926 #: ../fish/guestfish-actions.pod:3988
21929 " upload-offset (filename|-) remotefilename offset\n"
21934 #: ../fish/guestfish-actions.pod:4000
21936 "Note that there is no limit on the amount of data that can be uploaded with "
21937 "this call, unlike with L</pwrite>, and this call always writes the full "
21938 "amount unless an error occurs."
21942 #: ../fish/guestfish-actions.pod:4005
21943 msgid "See also L</upload>, L</pwrite>."
21947 #: ../fish/guestfish-actions.pod:4009
21952 #: ../fish/guestfish-actions.pod:4011
21955 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
21960 #: ../fish/guestfish-actions.pod:4030
21965 #: ../fish/guestfish-actions.pod:4032
21973 #: ../fish/guestfish-actions.pod:4059
21975 "I<Note:> Don't use this call to test for availability of features. In "
21976 "enterprise distributions we backport features from later versions into "
21977 "earlier versions, making this an unreliable way to test for features. Use "
21978 "L</available> instead."
21982 #: ../fish/guestfish-actions.pod:4065
21987 #: ../fish/guestfish-actions.pod:4067
21990 " vfs-label device\n"
21995 #: ../fish/guestfish-actions.pod:4074
21996 msgid "To find a filesystem from the label, use L</findfs-label>."
22000 #: ../fish/guestfish-actions.pod:4076
22005 #: ../fish/guestfish-actions.pod:4078
22008 " vfs-type device\n"
22013 #: ../fish/guestfish-actions.pod:4088
22018 #: ../fish/guestfish-actions.pod:4090
22021 " vfs-uuid device\n"
22026 #: ../fish/guestfish-actions.pod:4097
22027 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
22031 #: ../fish/guestfish-actions.pod:4099
22032 msgid "vg-activate"
22036 #: ../fish/guestfish-actions.pod:4101
22039 " vg-activate true|false 'volgroups ...'\n"
22044 #: ../fish/guestfish-actions.pod:4114
22045 msgid "vg-activate-all"
22049 #: ../fish/guestfish-actions.pod:4116
22052 " vg-activate-all true|false\n"
22057 #: ../fish/guestfish-actions.pod:4126
22062 #: ../fish/guestfish-actions.pod:4128
22065 " vgcreate volgroup 'physvols ...'\n"
22070 #: ../fish/guestfish-actions.pod:4133
22075 #: ../fish/guestfish-actions.pod:4135
22078 " vglvuuids vgname\n"
22083 #: ../fish/guestfish-actions.pod:4140
22085 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
22086 "logical volumes and volume groups."
22090 #: ../fish/guestfish-actions.pod:4143
22091 msgid "See also L</vgpvuuids>."
22095 #: ../fish/guestfish-actions.pod:4145
22100 #: ../fish/guestfish-actions.pod:4147
22103 " vgpvuuids vgname\n"
22108 #: ../fish/guestfish-actions.pod:4152
22110 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
22111 "physical volumes and volume groups."
22115 #: ../fish/guestfish-actions.pod:4155
22116 msgid "See also L</vglvuuids>."
22120 #: ../fish/guestfish-actions.pod:4157
22125 #: ../fish/guestfish-actions.pod:4159
22128 " vgremove vgname\n"
22133 #: ../fish/guestfish-actions.pod:4166
22138 #: ../fish/guestfish-actions.pod:4168
22141 " vgrename volgroup newvolgroup\n"
22146 #: ../fish/guestfish-actions.pod:4172
22151 #: ../fish/guestfish-actions.pod:4174
22159 #: ../fish/guestfish-actions.pod:4182
22160 msgid "See also L</vgs-full>."
22164 #: ../fish/guestfish-actions.pod:4184
22169 #: ../fish/guestfish-actions.pod:4186
22177 #: ../fish/guestfish-actions.pod:4191
22182 #: ../fish/guestfish-actions.pod:4193
22190 #: ../fish/guestfish-actions.pod:4198
22195 #: ../fish/guestfish-actions.pod:4200
22203 #: ../fish/guestfish-actions.pod:4204
22208 #: ../fish/guestfish-actions.pod:4206
22216 #: ../fish/guestfish-actions.pod:4211
22221 #: ../fish/guestfish-actions.pod:4213
22229 #: ../fish/guestfish-actions.pod:4218
22234 #: ../fish/guestfish-actions.pod:4220
22242 #: ../fish/guestfish-actions.pod:4225
22247 #: ../fish/guestfish-actions.pod:4227
22250 " write path content\n"
22255 #: ../fish/guestfish-actions.pod:4235
22260 #: ../fish/guestfish-actions.pod:4237
22263 " write-file path content size\n"
22268 #: ../fish/guestfish-actions.pod:4260
22273 #: ../fish/guestfish-actions.pod:4262
22276 " zegrep regex path\n"
22281 #: ../fish/guestfish-actions.pod:4270
22286 #: ../fish/guestfish-actions.pod:4272
22289 " zegrepi regex path\n"
22294 #: ../fish/guestfish-actions.pod:4280
22299 #: ../fish/guestfish-actions.pod:4282
22307 #: ../fish/guestfish-actions.pod:4290
22308 msgid "See also: L</zero-device>, L</scrub-device>."
22312 #: ../fish/guestfish-actions.pod:4292
22313 msgid "zero-device"
22317 #: ../fish/guestfish-actions.pod:4294
22320 " zero-device device\n"
22325 #: ../fish/guestfish-actions.pod:4296
22327 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
22328 "which just zeroes the first few blocks of a device."
22332 #: ../fish/guestfish-actions.pod:4303
22337 #: ../fish/guestfish-actions.pod:4305
22340 " zerofree device\n"
22345 #: ../fish/guestfish-actions.pod:4318
22350 #: ../fish/guestfish-actions.pod:4320
22353 " zfgrep pattern path\n"
22358 #: ../fish/guestfish-actions.pod:4328
22363 #: ../fish/guestfish-actions.pod:4330
22366 " zfgrepi pattern path\n"
22371 #: ../fish/guestfish-actions.pod:4338
22376 #: ../fish/guestfish-actions.pod:4340
22379 " zfile meth path\n"
22384 #: ../fish/guestfish-actions.pod:4347
22386 "Since 1.0.63, use L</file> instead which can now process compressed files."
22390 #: ../fish/guestfish-actions.pod:4357
22395 #: ../fish/guestfish-actions.pod:4359
22398 " zgrep regex path\n"
22403 #: ../fish/guestfish-actions.pod:4367
22408 #: ../fish/guestfish-actions.pod:4369
22411 " zgrepi regex path\n"
22416 #: ../fish/guestfish-commands.pod:1
22421 #: ../fish/guestfish-commands.pod:3
22426 #: ../fish/guestfish-commands.pod:5
22429 " alloc filename size\n"
22434 #: ../fish/guestfish-commands.pod:7
22436 "This creates an empty (zeroed) file of the given size, and then adds so it "
22437 "can be further examined."
22441 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
22442 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
22446 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
22447 msgid "Size can be specified using standard suffixes, eg. C<1M>."
22451 #: ../fish/guestfish-commands.pod:14
22453 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
22454 "image, see L</PREPARED DISK IMAGES>."
22458 #: ../fish/guestfish-commands.pod:17
22463 #: ../fish/guestfish-commands.pod:19
22466 " copy-in local [local ...] /remotedir\n"
22471 #: ../fish/guestfish-commands.pod:21
22473 "C<copy-in> copies local files or directories recursively into the disk "
22474 "image, placing them in the directory called C</remotedir> (which must "
22475 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
22476 "other commands as necessary."
22480 #: ../fish/guestfish-commands.pod:26
22482 "Multiple local files and directories can be specified, but the last "
22483 "parameter must always be a remote directory. Wildcards cannot be used."
22487 #: ../fish/guestfish-commands.pod:30
22492 #: ../fish/guestfish-commands.pod:32
22495 " copy-out remote [remote ...] localdir\n"
22500 #: ../fish/guestfish-commands.pod:34
22502 "C<copy-out> copies remote files or directories recursively out of the disk "
22503 "image, placing them on the host disk in a local directory called C<localdir> "
22504 "(which must exist). This guestfish meta-command turns into a sequence of L</"
22505 "download>, L</tar-out> and other commands as necessary."
22509 #: ../fish/guestfish-commands.pod:40
22511 "Multiple remote files and directories can be specified, but the last "
22512 "parameter must always be a local directory. To download to the current "
22513 "directory, use C<.> as in:"
22517 #: ../fish/guestfish-commands.pod:44
22520 " copy-out /home .\n"
22525 #: ../fish/guestfish-commands.pod:46
22527 "Wildcards cannot be used in the ordinary command, but you can use them with "
22528 "the help of L</glob> like this:"
22532 #: ../fish/guestfish-commands.pod:49
22535 " glob copy-out /home/* .\n"
22540 #: ../fish/guestfish-commands.pod:51
22545 #: ../fish/guestfish-commands.pod:53
22548 " echo [params ...]\n"
22553 #: ../fish/guestfish-commands.pod:55
22554 msgid "This echos the parameters to the terminal."
22558 #: ../fish/guestfish-commands.pod:57
22563 #: ../fish/guestfish-commands.pod:59
22568 #: ../fish/guestfish-commands.pod:61
22573 #: ../fish/guestfish-commands.pod:63
22581 #: ../fish/guestfish-commands.pod:65
22583 "This is used to edit a file. It downloads the file, edits it locally using "
22584 "your editor, then uploads the result."
22588 #: ../fish/guestfish-commands.pod:68
22590 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
22591 "or C<emacs> you will get those corresponding editors."
22595 #: ../fish/guestfish-commands.pod:72
22600 #: ../fish/guestfish-commands.pod:74
22603 " glob command args...\n"
22608 #: ../fish/guestfish-commands.pod:76
22610 "Expand wildcards in any paths in the args list, and run C<command> "
22611 "repeatedly on each matching path."
22615 #: ../fish/guestfish-commands.pod:79
22616 msgid "See L</WILDCARDS AND GLOBBING>."
22620 #: ../fish/guestfish-commands.pod:81
22625 #: ../fish/guestfish-commands.pod:83
22628 " hexedit <filename|device>\n"
22629 " hexedit <filename|device> <max>\n"
22630 " hexedit <filename|device> <start> <max>\n"
22635 #: ../fish/guestfish-commands.pod:87
22637 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
22642 #: ../fish/guestfish-commands.pod:90
22644 "This command works by downloading potentially the whole file or device, "
22645 "editing it locally, then uploading it. If the file or device is large, you "
22646 "have to specify which part you wish to edit by using C<max> and/or C<start> "
22647 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
22648 "usual modifiers allowed such as C<1M> (1 megabyte)."
22652 #: ../fish/guestfish-commands.pod:97
22653 msgid "For example to edit the first few sectors of a disk you might do:"
22657 #: ../fish/guestfish-commands.pod:100
22660 " hexedit /dev/sda 1M\n"
22665 #: ../fish/guestfish-commands.pod:102
22667 "which would allow you to edit anywhere within the first megabyte of the disk."
22671 #: ../fish/guestfish-commands.pod:105
22672 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
22676 #: ../fish/guestfish-commands.pod:107
22679 " hexedit /dev/sda1 0x400 0x400\n"
22684 #: ../fish/guestfish-commands.pod:109
22685 msgid "(assuming the superblock is in the standard location)."
22689 #: ../fish/guestfish-commands.pod:111
22691 "This command requires the external L<hexedit(1)> program. You can specify "
22692 "another program to use by setting the C<HEXEDITOR> environment variable."
22696 #: ../fish/guestfish-commands.pod:115
22697 msgid "See also L</hexdump>."
22701 #: ../fish/guestfish-commands.pod:117
22706 #: ../fish/guestfish-commands.pod:119
22714 #: ../fish/guestfish-commands.pod:121
22716 "Change the local directory, ie. the current directory of guestfish itself."
22720 #: ../fish/guestfish-commands.pod:124
22721 msgid "Note that C<!cd> won't do what you might expect."
22725 #: ../fish/guestfish-commands.pod:126
22730 #: ../fish/guestfish-commands.pod:128
22735 #: ../fish/guestfish-commands.pod:130
22743 #: ../fish/guestfish-commands.pod:132
22744 msgid "Opens the manual page for guestfish."
22748 #: ../fish/guestfish-commands.pod:134
22753 #: ../fish/guestfish-commands.pod:136
22758 #: ../fish/guestfish-commands.pod:138
22766 #: ../fish/guestfish-commands.pod:140
22774 #: ../fish/guestfish-commands.pod:142
22775 msgid "This is used to view a file."
22779 #: ../fish/guestfish-commands.pod:144
22781 "The default viewer is C<$PAGER>. However if you use the alternate command "
22782 "C<less> you will get the C<less> command specifically."
22786 #: ../fish/guestfish-commands.pod:147
22791 #: ../fish/guestfish-commands.pod:149
22799 #: ../fish/guestfish-commands.pod:151
22801 "Close and reopen the libguestfs handle. It is not necessary to use this "
22802 "normally, because the handle is closed properly when guestfish exits. "
22803 "However this is occasionally useful for testing."
22807 #: ../fish/guestfish-commands.pod:155
22812 #: ../fish/guestfish-commands.pod:157
22815 " sparse filename size\n"
22820 #: ../fish/guestfish-commands.pod:159
22822 "This creates an empty sparse file of the given size, and then adds so it can "
22823 "be further examined."
22827 #: ../fish/guestfish-commands.pod:162
22829 "In all respects it works the same as the L</alloc> command, except that the "
22830 "image file is allocated sparsely, which means that disk blocks are not "
22831 "assigned to the file until they are needed. Sparse disk files only use "
22832 "space when written to, but they are slower and there is a danger you could "
22833 "run out of real disk space during a write operation."
22837 #: ../fish/guestfish-commands.pod:172
22842 #: ../fish/guestfish-commands.pod:174
22850 #: ../fish/guestfish-commands.pod:176
22852 "This command returns a list of the optional groups known to the daemon, and "
22853 "indicates which ones are supported by this build of the libguestfs appliance."
22857 #: ../fish/guestfish-commands.pod:180
22858 msgid "See also L<guestfs(3)/AVAILABILITY>."
22862 #: ../fish/guestfish-commands.pod:182
22867 #: ../fish/guestfish-commands.pod:184
22870 " time command args...\n"
22875 #: ../fish/guestfish-commands.pod:186
22877 "Run the command as usual, but print the elapsed time afterwards. This can "
22878 "be useful for benchmarking operations."
22882 #: ../test-tool/libguestfs-test-tool.pod:5
22883 msgid "libguestfs-test-tool - End user tests for libguestfs"
22887 #: ../test-tool/libguestfs-test-tool.pod:9
22890 " libguestfs-test-tool [--options]\n"
22895 #: ../test-tool/libguestfs-test-tool.pod:13
22897 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
22898 "and developers, to allow them to check basic libguestfs functionality is "
22899 "working. This is needed because libguestfs occasionally breaks for reasons "
22900 "beyond our control: usually because of changes in the underlying qemu or "
22901 "kernel packages, or the host environment."
22905 #: ../test-tool/libguestfs-test-tool.pod:20
22906 msgid "If you suspect a problem in libguestfs, then just run:"
22910 #: ../test-tool/libguestfs-test-tool.pod:22
22913 " libguestfs-test-tool\n"
22918 #: ../test-tool/libguestfs-test-tool.pod:24
22919 msgid "It will print lots of diagnostic messages."
22923 #: ../test-tool/libguestfs-test-tool.pod:26
22924 msgid "If it runs to completion successfully, you will see this near the end:"
22928 #: ../test-tool/libguestfs-test-tool.pod:28
22931 " ===== TEST FINISHED OK =====\n"
22936 #: ../test-tool/libguestfs-test-tool.pod:30
22937 msgid "and the test tool will exit with code 0."
22941 #: ../test-tool/libguestfs-test-tool.pod:32
22943 "If it fails (and/or exits with non-zero error code), please paste the "
22944 "B<complete, unedited> output of the test tool into a bug report. More "
22945 "information about reporting bugs can be found on the L<http://libguestfs.org/"
22950 #: ../test-tool/libguestfs-test-tool.pod:41
22955 #: ../test-tool/libguestfs-test-tool.pod:43
22956 msgid "Display short usage information and exit."
22960 #: ../test-tool/libguestfs-test-tool.pod:45
22961 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
22965 #: ../test-tool/libguestfs-test-tool.pod:47
22967 "Pass an alternate name for the helper program. libguestfs-test-tool will "
22968 "normally look in the C<$libexec> directory that was configured when the tool "
22973 #: ../test-tool/libguestfs-test-tool.pod:51
22974 msgid "I<--qemu qemu_binary>"
22978 #: ../test-tool/libguestfs-test-tool.pod:53
22980 "If you have downloaded another qemu binary, point this option at the full "
22981 "path of the binary to try it."
22985 #: ../test-tool/libguestfs-test-tool.pod:56
22986 msgid "I<--qemudir qemu_source_dir>"
22990 #: ../test-tool/libguestfs-test-tool.pod:58
22992 "If you have compiled qemu from source, point this option at the source "
22993 "directory to try it."
22997 #: ../test-tool/libguestfs-test-tool.pod:61
22998 msgid "I<--timeout N>"
23002 #: ../test-tool/libguestfs-test-tool.pod:63
23004 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
23005 "does not usually need to be adjusted unless your machine is very slow."
23009 #: ../test-tool/libguestfs-test-tool.pod:69
23010 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
23014 #: ../test-tool/libguestfs-test-tool.pod:71
23016 "If you have compiled another version of qemu from source and would like to "
23017 "try that, then you can use the I<--qemudir> option to point to the qemu "
23018 "source directory."
23022 #: ../test-tool/libguestfs-test-tool.pod:75
23024 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
23025 "option to point to the binary."
23029 #: ../test-tool/libguestfs-test-tool.pod:78
23031 "When using an alternate qemu with libguestfs, usually you would need to "
23032 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
23033 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
23034 "use either of the I<--qemudir> or I<--qemu> options."
23038 #: ../test-tool/libguestfs-test-tool.pod:85
23040 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
23041 "I<1> if there was an error."
23045 #: ../test-tool/libguestfs-test-tool.pod:92
23046 msgid "/usr/libexec/libguestfs-test-tool-helper"
23050 #: ../test-tool/libguestfs-test-tool.pod:94
23052 "This helper program is run inside the appliance and provides additional "
23057 #: ../test-tool/libguestfs-test-tool.pod:97
23058 msgid "/usr/bin/mkisofs"
23062 #: ../test-tool/libguestfs-test-tool.pod:99
23064 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
23065 "which is used as part of the tests."
23069 #: ../test-tool/libguestfs-test-tool.pod:106
23071 "For the full list of environment variables which may affect libguestfs, "
23072 "please see the L<guestfs(3)> manual page."
23076 #: ../test-tool/libguestfs-test-tool.pod:111
23077 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
23081 #: ../test-tool/libguestfs-test-tool.pod:121 ../fuse/guestmount.pod:195
23082 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
23086 #: ../fuse/guestmount.pod:5
23088 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
23092 #: ../fuse/guestmount.pod:9
23095 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
23100 #: ../fuse/guestmount.pod:13
23102 "You must I<not> use C<guestmount> in read-write mode on live virtual "
23103 "machines. If you do this, you risk disk corruption in the VM."
23107 #: ../fuse/guestmount.pod:18
23109 "The guestmount program can be used to mount virtual machine filesystems and "
23110 "other disk images on the host. It uses libguestfs for access to the guest "
23111 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
23112 "a mountable device."
23116 #: ../fuse/guestmount.pod:23
23118 "Along with other options, you have to give at least one device (I<-a> "
23119 "option) and at least one mountpoint (I<-m> option). How this works is "
23120 "better explained in the L<guestfish(1)> manual page, or you can use L<virt-"
23121 "inspector(1)> and/or the wrapper script C<guestmount-wrapper> to help you."
23125 #: ../fuse/guestmount.pod:29
23127 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
23128 "by you, and the filesystem will not be visible to any other users unless you "
23129 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
23130 "the filesystem, use the C<fusermount -u> command."
23134 #: ../fuse/guestmount.pod:37
23136 "For a typical Windows guest which has its main filesystem on the first "
23141 #: ../fuse/guestmount.pod:40
23144 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
23149 #: ../fuse/guestmount.pod:42
23151 "For a typical Linux guest which has a /boot filesystem on the first "
23152 "partition, and the root filesystem on a logical volume:"
23156 #: ../fuse/guestmount.pod:45
23159 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
23164 #: ../fuse/guestmount.pod:47
23166 "To get L<virt-inspector(1)> to do the hard work of detecting guest "
23167 "mountpoints for you:"
23171 #: ../fuse/guestmount.pod:50
23174 " guestmount $(virt-inspector --ro-fish MyGuest) /mnt\n"
23179 #: ../fuse/guestmount.pod:52
23181 "(or use --fish if you don't want it to be a read only mount). The option is "
23182 "called I<--ro-fish> or I<--fish> because these parameters are compatible "
23183 "with L<guestfish(1)>."
23187 #: ../fuse/guestmount.pod:56
23189 "If you don't know what filesystems are contained in a guest or disk image, "
23190 "use L<virt-list-filesystems(1)> first:"
23194 #: ../fuse/guestmount.pod:59
23197 " virt-list-filesystems MyGuest\n"
23202 #: ../fuse/guestmount.pod:61
23204 "If you want to trace the libguestfs calls but without excessive debugging, "
23209 #: ../fuse/guestmount.pod:64
23212 " guestmount [-a ... -m ...] --trace /mnt\n"
23217 #: ../fuse/guestmount.pod:66
23218 msgid "If you want to debug the program, we recommend:"
23222 #: ../fuse/guestmount.pod:68
23225 " guestmount [-a ... -m ...] --trace --verbose /mnt\n"
23230 #: ../fuse/guestmount.pod:76
23231 msgid "Add a block device or virtual machine image."
23235 #: ../fuse/guestmount.pod:78
23236 msgid "B<--dir-cache-timeout N>"
23240 #: ../fuse/guestmount.pod:80
23242 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
23243 "seconds. The readdir cache [actually, there are several semi-independent "
23244 "caches] is populated after a readdir(2) call with the stat and extended "
23245 "attributes of the files in the directory, in anticipation that they will be "
23246 "requested soon after."
23250 #: ../fuse/guestmount.pod:86
23252 "There is also a different attribute cache implemented by FUSE (see the FUSE "
23253 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
23254 "requests, only cache existing ones."
23258 #: ../fuse/guestmount.pod:90
23259 msgid "B<--fuse-help>"
23263 #: ../fuse/guestmount.pod:92
23264 msgid "Display help on special FUSE options (see I<-o> below)."
23268 #: ../fuse/guestmount.pod:96
23269 msgid "Display brief help and exit."
23273 #: ../fuse/guestmount.pod:98
23274 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
23278 #: ../fuse/guestmount.pod:100
23280 "Mount the named partition or logical volume on the given mountpoint B<in the "
23281 "guest> (this has nothing to do with mountpoints in the host)."
23285 #: ../fuse/guestmount.pod:103
23287 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
23288 "something on C</>."
23292 #: ../fuse/guestmount.pod:108
23294 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
23295 "unmounted. If you specify this option, then we don't attempt to sync the "
23296 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
23300 #: ../fuse/guestmount.pod:113
23301 msgid "B<-o option> | B<--option option>"
23305 #: ../fuse/guestmount.pod:115
23306 msgid "Pass extra options to FUSE."
23310 #: ../fuse/guestmount.pod:117
23312 "To get a list of all the extra options supported by FUSE, use the command "
23313 "below. Note that only the FUSE I<-o> options can be passed, and only some "
23314 "of them are a good idea."
23318 #: ../fuse/guestmount.pod:121
23321 " guestmount --fuse-help\n"
23326 #: ../fuse/guestmount.pod:123
23327 msgid "Some potentially useful FUSE options:"
23331 #: ../fuse/guestmount.pod:127
23332 msgid "B<-o allow_other>"
23336 #: ../fuse/guestmount.pod:129
23337 msgid "Allow other users to see the filesystem."
23341 #: ../fuse/guestmount.pod:131
23342 msgid "B<-o attr_timeout=N>"
23346 #: ../fuse/guestmount.pod:133
23347 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
23351 #: ../fuse/guestmount.pod:135
23352 msgid "B<-o kernel_cache>"
23356 #: ../fuse/guestmount.pod:137
23358 "Allow the kernel to cache files (reduces the number of reads that have to go "
23359 "through the L<guestfs(3)> API). This is generally a good idea if you can "
23360 "afford the extra memory usage."
23364 #: ../fuse/guestmount.pod:141
23365 msgid "B<-o uid=N> B<-o gid=N>"
23369 #: ../fuse/guestmount.pod:143
23371 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
23372 "the chosen values."
23376 #: ../fuse/guestmount.pod:150
23378 "Add devices and mount everything read-only. Also disallow writes and make "
23379 "the disk appear read-only to FUSE."
23383 #: ../fuse/guestmount.pod:153
23385 "This is highly recommended if you are not going to edit the guest disk. If "
23386 "the guest is running and this option is I<not> supplied, then there is a "
23387 "strong risk of disk corruption in the guest. We try to prevent this from "
23388 "happening, but it is not always possible."
23392 #: ../fuse/guestmount.pod:160
23393 msgid "Enable SELinux support for the guest."
23397 #: ../fuse/guestmount.pod:162
23402 #: ../fuse/guestmount.pod:164
23403 msgid "Trace libguestfs calls (to stderr)."
23407 #: ../fuse/guestmount.pod:166
23408 msgid "This also stops the daemon from forking into the background."
23412 #: ../fuse/guestmount.pod:170
23413 msgid "Enable verbose messages from underlying libguestfs."
23417 #: ../fuse/guestmount.pod:174
23418 msgid "Display the program version and exit."
23422 #: ../fuse/guestmount.pod:180
23424 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
23425 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
23430 #: ../inspector/virt-inspector.pl:40
23432 "virt-inspector - Display OS version, kernel, drivers, mount points, "
23433 "applications, etc. in a virtual machine"
23437 #: ../inspector/virt-inspector.pl:44
23440 " virt-inspector [--connect URI] domname\n"
23445 #: ../inspector/virt-inspector.pl:46
23448 " virt-inspector guest.img [guest.img ...]\n"
23453 #: ../inspector/virt-inspector.pl:50
23455 "B<virt-inspector> examines a virtual machine and tries to determine the "
23456 "version of the OS, the kernel version, what drivers are installed, whether "
23457 "the virtual machine is fully virtualized (FV) or para-virtualized (PV), what "
23458 "applications are installed and more."
23462 #: ../inspector/virt-inspector.pl:55
23464 "Virt-inspector can produce output in several formats, including a readable "
23465 "text report, and XML for feeding into other programs."
23469 #: ../inspector/virt-inspector.pl:58
23471 "In the normal usage, use C<virt-inspector domname> where C<domname> is the "
23472 "libvirt domain (see: C<virsh list --all>)."
23476 #: ../inspector/virt-inspector.pl:61
23478 "You can also run virt-inspector directly on disk images from a single "
23479 "virtual machine. Use C<virt-inspector guest.img>. In rare cases a domain "
23480 "has several block devices, in which case you should list them one after "
23481 "another, with the first corresponding to the guest's C</dev/sda>, the second "
23482 "to the guest's C</dev/sdb> and so on."
23486 #: ../inspector/virt-inspector.pl:67
23488 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
23489 "inspect several virtual machines, you have to run virt-inspector several "
23490 "times (for example, from a shell script for-loop)."
23494 #: ../inspector/virt-inspector.pl:72
23496 "Because virt-inspector needs direct access to guest images, it won't "
23497 "normally work over remote libvirt connections."
23501 #: ../inspector/virt-inspector.pl:85 ../tools/virt-edit.pl:83
23502 #: ../tools/virt-win-reg.pl:182 ../tools/virt-df.pl:81 ../tools/virt-ls.pl:89
23503 #: ../tools/virt-list-filesystems.pl:60 ../tools/virt-cat.pl:90
23504 #: ../tools/virt-tar.pl:109 ../tools/virt-rescue.pl:113
23505 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:61
23506 msgid "Display brief help."
23510 #: ../inspector/virt-inspector.pl:91 ../tools/virt-edit.pl:89
23511 #: ../tools/virt-win-reg.pl:188 ../tools/virt-df.pl:87 ../tools/virt-ls.pl:95
23512 #: ../tools/virt-resize.pl:249 ../tools/virt-list-filesystems.pl:66
23513 #: ../tools/virt-cat.pl:96 ../tools/virt-tar.pl:115
23514 #: ../tools/virt-rescue.pl:119 ../tools/virt-make-fs.pl:169
23515 #: ../tools/virt-list-partitions.pl:67
23516 msgid "B<--version>"
23520 #: ../inspector/virt-inspector.pl:93 ../tools/virt-edit.pl:91
23521 #: ../tools/virt-win-reg.pl:190 ../tools/virt-df.pl:89 ../tools/virt-ls.pl:97
23522 #: ../tools/virt-resize.pl:251 ../tools/virt-list-filesystems.pl:68
23523 #: ../tools/virt-cat.pl:98 ../tools/virt-tar.pl:117
23524 #: ../tools/virt-rescue.pl:121 ../tools/virt-make-fs.pl:171
23525 #: ../tools/virt-list-partitions.pl:69
23526 msgid "Display version number and exit."
23530 #: ../inspector/virt-inspector.pl:99 ../tools/virt-edit.pl:113
23531 #: ../tools/virt-win-reg.pl:204 ../tools/virt-df.pl:95 ../tools/virt-ls.pl:103
23532 #: ../tools/virt-list-filesystems.pl:74 ../tools/virt-cat.pl:104
23533 #: ../tools/virt-tar.pl:123 ../tools/virt-rescue.pl:135
23534 #: ../tools/virt-list-partitions.pl:75
23535 msgid "B<--connect URI> | B<-c URI>"
23539 #: ../inspector/virt-inspector.pl:101 ../tools/virt-edit.pl:115
23540 #: ../tools/virt-win-reg.pl:206 ../tools/virt-df.pl:97 ../tools/virt-ls.pl:105
23541 #: ../tools/virt-list-filesystems.pl:76 ../tools/virt-cat.pl:106
23542 #: ../tools/virt-tar.pl:125 ../tools/virt-rescue.pl:137
23543 #: ../tools/virt-list-partitions.pl:77
23545 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
23546 "to the default libvirt hypervisor."
23550 #: ../inspector/virt-inspector.pl:104
23552 "Libvirt is only used if you specify a C<domname> on the command line. If "
23553 "you specify guest block devices directly, then libvirt is not used at all."
23557 #: ../inspector/virt-inspector.pl:114
23559 "The following options select the output format. Use only one of them. The "
23560 "default is a readable text report."
23564 #: ../inspector/virt-inspector.pl:119
23565 msgid "B<--text> (default)"
23569 #: ../inspector/virt-inspector.pl:121
23570 msgid "Plain text report."
23574 #: ../inspector/virt-inspector.pl:123
23579 #: ../inspector/virt-inspector.pl:125
23580 msgid "Produce no output at all."
23584 #: ../inspector/virt-inspector.pl:127
23589 #: ../inspector/virt-inspector.pl:129
23591 "If you select I<--xml> then you get XML output which can be fed to other "
23596 #: ../inspector/virt-inspector.pl:132
23601 #: ../inspector/virt-inspector.pl:134
23603 "If you select I<--yaml> then you get YAML output which can be fed to other "
23608 #: ../inspector/virt-inspector.pl:137
23613 #: ../inspector/virt-inspector.pl:139
23615 "If you select I<--perl> then you get Perl structures output which can be "
23616 "used directly in another Perl program."
23620 #: ../inspector/virt-inspector.pl:142
23625 #: ../inspector/virt-inspector.pl:144
23626 msgid "B<--ro-fish>"
23630 #: ../inspector/virt-inspector.pl:146
23632 "If you select I<--fish> then we print a L<guestfish(1)> command line which "
23633 "will automatically mount up the filesystems on the correct mount points. "
23634 "Try this for example:"
23638 #: ../inspector/virt-inspector.pl:150
23641 " guestfish $(virt-inspector --fish guest.img)\n"
23646 #: ../inspector/virt-inspector.pl:152
23648 "I<--ro-fish> is the same, but the I<--ro> option is passed to guestfish so "
23649 "that the filesystems are mounted read-only."
23653 #: ../inspector/virt-inspector.pl:155
23658 #: ../inspector/virt-inspector.pl:157
23660 "In \"query mode\" we answer common questions about the guest, such as "
23661 "whether it is fullvirt or needs a Xen hypervisor to run."
23665 #: ../inspector/virt-inspector.pl:160
23666 msgid "See section I<QUERY MODE> below."
23670 #: ../inspector/virt-inspector.pl:166
23671 msgid "B<--windows-registry>"
23675 #: ../inspector/virt-inspector.pl:168
23677 "This flag is ignored for compatibility with earlier releases of the software."
23681 #: ../inspector/virt-inspector.pl:171
23683 "In this version, if L<Win::Hivex(3)> is available, then we attempt to parse "
23684 "information out of the Registry for any Windows guest."
23688 #: ../inspector/virt-inspector.pl:218
23689 msgid "OUTPUT FORMAT"
23693 #: ../inspector/virt-inspector.pl:220
23696 " Operating system(s)\n"
23697 " -------------------\n"
23698 " Linux (distro + version)\n"
23699 " Windows (version)\n"
23702 " +--- Filesystems ---------- Installed apps --- Kernel & drivers\n"
23703 " ----------- -------------- ----------------\n"
23704 " mount point => device List of apps Extra information\n"
23705 " mount point => device and versions about kernel(s)\n"
23706 " ... and drivers\n"
23707 " swap => swap device\n"
23708 " (plus lots of extra information\n"
23709 " about each filesystem)\n"
23714 #: ../inspector/virt-inspector.pl:235
23715 msgid "The output of virt-inspector is a complex two-level data structure."
23719 #: ../inspector/virt-inspector.pl:237
23721 "At the top level is a list of the operating systems installed on the guest. "
23722 "(For the vast majority of guests, only a single OS is installed.) The data "
23723 "returned for the OS includes the name (Linux, Windows), the distribution and "
23728 #: ../inspector/virt-inspector.pl:242
23729 msgid "The diagram above shows what we return for each OS."
23733 #: ../inspector/virt-inspector.pl:244
23735 "With the I<--xml> option the output is mapped into an XML document. There "
23736 "is a RELAX-NG schema for this XML in the file I<virt-inspector.rng> which "
23737 "normally ships with virt-inspector, or can be found in the source."
23741 #: ../inspector/virt-inspector.pl:249
23743 "With the I<--fish> or I<--ro-fish> option the mount points are mapped to "
23744 "L<guestfish(1)> command line parameters, so that you can go in afterwards "
23745 "and inspect the guest with everything mounted in the right place. For "
23750 #: ../inspector/virt-inspector.pl:254
23753 " guestfish $(virt-inspector --ro-fish guest.img)\n"
23754 " ==> guestfish --ro -a guest.img -m /dev/VG/LV:/ -m /dev/sda1:/boot\n"
23759 #: ../inspector/virt-inspector.pl:589
23764 #: ../inspector/virt-inspector.pl:591
23766 "When you use C<virt-inspector --query>, the output is a series of lines of "
23771 #: ../inspector/virt-inspector.pl:594
23777 " xen_pv_drivers=no\n"
23782 #: ../inspector/virt-inspector.pl:599
23784 "(each answer is usually C<yes> or C<no>, or the line is completely missing "
23785 "if we could not determine the answer at all)."
23789 #: ../inspector/virt-inspector.pl:602
23791 "If the guest is multiboot, you can get apparently conflicting answers (eg. "
23792 "C<windows=yes> and C<linux=yes>, or a guest which is both fullvirt and has a "
23793 "Xen PV kernel). This is normal, and just means that the guest can do both "
23794 "things, although it might require operator intervention such as selecting a "
23795 "boot option when the guest is booting."
23799 #: ../inspector/virt-inspector.pl:609
23800 msgid "This section describes the full range of answers possible."
23804 #: ../inspector/virt-inspector.pl:630
23805 msgid "windows=(yes|no)"
23809 #: ../inspector/virt-inspector.pl:632
23810 msgid "Answer C<yes> if Microsoft Windows is installed in the guest."
23814 #: ../inspector/virt-inspector.pl:645
23815 msgid "linux=(yes|no)"
23819 #: ../inspector/virt-inspector.pl:647
23820 msgid "Answer C<yes> if a Linux kernel is installed in the guest."
23824 #: ../inspector/virt-inspector.pl:660
23825 msgid "rhel=(yes|no)"
23829 #: ../inspector/virt-inspector.pl:662
23830 msgid "Answer C<yes> if the guest contains Red Hat Enterprise Linux."
23834 #: ../inspector/virt-inspector.pl:676
23835 msgid "fedora=(yes|no)"
23839 #: ../inspector/virt-inspector.pl:678
23840 msgid "Answer C<yes> if the guest contains the Fedora Linux distribution."
23844 #: ../inspector/virt-inspector.pl:691
23845 msgid "debian=(yes|no)"
23849 #: ../inspector/virt-inspector.pl:693
23850 msgid "Answer C<yes> if the guest contains the Debian Linux distribution."
23854 #: ../inspector/virt-inspector.pl:706
23855 msgid "fullvirt=(yes|no)"
23859 #: ../inspector/virt-inspector.pl:708
23861 "Answer C<yes> if there is at least one operating system kernel installed in "
23862 "the guest which runs fully virtualized. Such a guest would require a "
23863 "hypervisor which supports full system virtualization."
23867 #: ../inspector/virt-inspector.pl:731
23868 msgid "xen_domU_kernel=(yes|no)"
23872 #: ../inspector/virt-inspector.pl:733
23874 "Answer C<yes> if there is at least one Linux kernel installed in the guest "
23875 "which is compiled as a Xen DomU (a Xen paravirtualized guest)."
23879 #: ../inspector/virt-inspector.pl:753
23880 msgid "xen_pv_drivers=(yes|no)"
23884 #: ../inspector/virt-inspector.pl:755
23886 "Answer C<yes> if the guest has Xen paravirtualized drivers installed "
23887 "(usually the kernel itself will be fully virtualized, but the PV drivers "
23888 "have been installed by the administrator for performance reasons)."
23892 #: ../inspector/virt-inspector.pl:777
23893 msgid "virtio_drivers=(yes|no)"
23897 #: ../inspector/virt-inspector.pl:779
23899 "Answer C<yes> if the guest has virtio paravirtualized drivers installed. "
23900 "Virtio drivers are commonly used to improve the performance of KVM."
23904 #: ../inspector/virt-inspector.pl:800
23905 msgid "userspace_arch=(x86_64|...)"
23909 #: ../inspector/virt-inspector.pl:802
23910 msgid "Print the architecture of userspace."
23914 #: ../inspector/virt-inspector.pl:804 ../inspector/virt-inspector.pl:825
23915 msgid "NB. For multi-boot VMs this can print several lines."
23919 #: ../inspector/virt-inspector.pl:821
23920 msgid "kernel_arch=(x86_64|...)"
23924 #: ../inspector/virt-inspector.pl:823
23925 msgid "Print the architecture of the kernel."
23929 #: ../inspector/virt-inspector.pl:848 ../tools/virt-df.pl:538
23931 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
23932 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
23936 #: ../inspector/virt-inspector.pl:857 ../tools/virt-edit.pl:339
23937 #: ../tools/virt-win-reg.pl:489 ../tools/virt-df.pl:547
23938 #: ../tools/virt-ls.pl:223 ../tools/virt-resize.pl:1418
23939 #: ../tools/virt-list-filesystems.pl:205 ../tools/virt-cat.pl:175
23940 #: ../tools/virt-tar.pl:270 ../tools/virt-rescue.pl:243
23941 #: ../tools/virt-make-fs.pl:554 ../tools/virt-list-partitions.pl:242
23942 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
23946 #: ../inspector/virt-inspector.pl:859
23947 msgid "Matthew Booth L<mbooth@redhat.com>"
23951 #: ../inspector/virt-inspector.pl:863 ../tools/virt-ls.pl:227
23952 #: ../tools/virt-list-filesystems.pl:209 ../tools/virt-cat.pl:179
23953 #: ../tools/virt-tar.pl:274
23954 msgid "Copyright (C) 2009 Red Hat Inc."
23958 #: ../tools/virt-edit.pl:35
23959 msgid "virt-edit - Edit a file in a virtual machine"
23963 #: ../tools/virt-edit.pl:39
23966 " virt-edit [--options] domname file\n"
23971 #: ../tools/virt-edit.pl:41
23974 " virt-edit [--options] disk.img [disk.img ...] file\n"
23979 #: ../tools/virt-edit.pl:43
23982 " virt-edit [domname|disk.img] file -e 'expr'\n"
23987 #: ../tools/virt-edit.pl:47
23989 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
23990 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
23991 "doing this, but doesn't catch all cases."
23995 #: ../tools/virt-edit.pl:53
23997 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
23998 "the named virtual machine (or disk image)."
24002 #: ../tools/virt-edit.pl:56
24004 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
24005 "you should look at the L<guestfish(1)> tool."
24009 #: ../tools/virt-edit.pl:61
24010 msgid "Edit the named files interactively:"
24014 #: ../tools/virt-edit.pl:63
24017 " virt-edit mydomain /boot/grub/grub.conf\n"
24022 #: ../tools/virt-edit.pl:65
24025 " virt-edit mydomain /etc/passwd\n"
24030 #: ../tools/virt-edit.pl:67
24032 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
24033 "below). To change the init default level to 5:"
24037 #: ../tools/virt-edit.pl:71
24040 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
24045 #: ../tools/virt-edit.pl:97
24046 msgid "B<--backup extension> | B<-b extension>"
24050 #: ../tools/virt-edit.pl:99
24052 "Create a backup of the original file I<in the guest disk image>. The backup "
24053 "has the original filename with C<extension> added."
24057 #: ../tools/virt-edit.pl:102
24059 "Usually the first character of C<extension> would be a dot C<.> so you would "
24064 #: ../tools/virt-edit.pl:105
24067 " virt-edit -b .orig [etc]\n"
24072 #: ../tools/virt-edit.pl:107
24073 msgid "By default, no backup file is made."
24077 #: ../tools/virt-edit.pl:118 ../tools/virt-win-reg.pl:209
24078 #: ../tools/virt-df.pl:100 ../tools/virt-ls.pl:108
24079 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-cat.pl:109
24080 #: ../tools/virt-tar.pl:128 ../tools/virt-rescue.pl:140
24081 #: ../tools/virt-list-partitions.pl:80
24083 "If you specify guest block devices directly, then libvirt is not used at all."
24087 #: ../tools/virt-edit.pl:125
24088 msgid "B<--expr EXPR> | B<-e EXPR>"
24092 #: ../tools/virt-edit.pl:127
24094 "Instead of launching the external editor, non-interactively apply the Perl "
24095 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
24100 #: ../tools/virt-edit.pl:131
24102 "Be careful to properly quote the expression to prevent it from being altered "
24107 #: ../tools/virt-edit.pl:250
24108 msgid "NON-INTERACTIVE EDITING"
24112 #: ../tools/virt-edit.pl:252
24114 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
24115 "administrator can interactively edit the file."
24119 #: ../tools/virt-edit.pl:255
24121 "There are two ways also to use C<virt-edit> from scripts in order to make "
24122 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
24123 "like this, it's less error-prone to write scripts directly using the "
24124 "libguestfs API and Augeas for configuration file editing.)"
24128 #: ../tools/virt-edit.pl:261
24130 "The first method is to temporarily set C<$EDITOR> to any script or program "
24131 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
24132 "update C<tmpfile> in place however it likes."
24136 #: ../tools/virt-edit.pl:265
24138 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
24139 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
24140 "instances of C<foo> with C<bar> in a file:"
24144 #: ../tools/virt-edit.pl:269
24147 " virt-edit domname filename -e 's/foo/bar/'\n"
24152 #: ../tools/virt-edit.pl:271
24154 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
24155 "For example to delete root's password you could do:"
24159 #: ../tools/virt-edit.pl:274
24162 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
24167 #: ../tools/virt-edit.pl:276
24169 "What really happens is that the snippet is evaluated as a Perl expression "
24170 "for each line of the file. The line, including the final C<\\n>, is passed "
24171 "in C<$_> and the expression should update C<$_> or leave it unchanged."
24175 #: ../tools/virt-edit.pl:281
24177 "To delete a line, set C<$_> to the empty string. For example, to delete the "
24178 "C<apache> user account from the password file you can do:"
24182 #: ../tools/virt-edit.pl:284
24185 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
24190 #: ../tools/virt-edit.pl:286
24192 "To insert a line, prepend or append it to C<$_>. However appending lines to "
24193 "the end of the file is rather difficult this way since there is no concept "
24194 "of \"last line of the file\" - your expression just doesn't get called "
24195 "again. You might want to use the first method (setting C<$EDITOR>) if you "
24200 #: ../tools/virt-edit.pl:292
24202 "The variable C<$lineno> contains the current line number. As is "
24203 "traditional, the first line in the file is number C<1>."
24207 #: ../tools/virt-edit.pl:295
24209 "The return value from the expression is ignored, but the expression may call "
24210 "C<die> in order to abort the whole program, leaving the original file "
24215 #: ../tools/virt-edit.pl:299
24217 "Remember when matching the end of a line that C<$_> may contain the final C<"
24218 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
24219 "newline then neither of these. Thus to match or substitute some text at the "
24220 "end of a line, use this regular expression:"
24224 #: ../tools/virt-edit.pl:304
24227 " /some text(\\r?\\n)?$/\n"
24232 #: ../tools/virt-edit.pl:306
24234 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
24235 "$_> itself (since that would remove all newlines from the file):"
24239 #: ../tools/virt-edit.pl:310
24242 " my $m = $_; chomp $m; $m =~ /some text$/\n"
24247 #: ../tools/virt-edit.pl:316
24252 #: ../tools/virt-edit.pl:318
24254 "If set, this string is used as the editor. It may contain arguments, eg. C<"
24259 #: ../tools/virt-edit.pl:321
24260 msgid "If not set, C<vi> is used."
24264 #: ../tools/virt-edit.pl:327
24266 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
24267 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, "
24272 #: ../tools/virt-edit.pl:337 ../tools/virt-win-reg.pl:487
24273 #: ../tools/virt-df.pl:545 ../tools/virt-ls.pl:221
24274 #: ../tools/virt-resize.pl:1416 ../tools/virt-list-filesystems.pl:203
24275 #: ../tools/virt-cat.pl:173 ../tools/virt-tar.pl:268
24276 #: ../tools/virt-rescue.pl:241 ../tools/virt-make-fs.pl:552
24277 #: ../tools/virt-list-partitions.pl:240
24282 #: ../tools/virt-edit.pl:343 ../tools/virt-df.pl:551
24283 #: ../tools/virt-rescue.pl:247 ../tools/virt-list-partitions.pl:246
24284 msgid "Copyright (C) 2009-2010 Red Hat Inc."
24288 #: ../tools/virt-win-reg.pl:38
24290 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
24294 #: ../tools/virt-win-reg.pl:42
24297 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
24302 #: ../tools/virt-win-reg.pl:44
24305 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
24310 #: ../tools/virt-win-reg.pl:46
24313 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
24318 #: ../tools/virt-win-reg.pl:48
24321 " virt-win-reg --merge domname [input.reg ...]\n"
24326 #: ../tools/virt-win-reg.pl:50
24329 " virt-win-reg [--options] disk.img ... # instead of domname\n"
24334 #: ../tools/virt-win-reg.pl:54
24336 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
24337 "virtual machines. If you do this, you I<will> get irreversible disk "
24338 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
24339 "but doesn't catch all cases."
24343 #: ../tools/virt-win-reg.pl:59
24345 "Modifying the Windows Registry is an inherently risky operation. The format "
24346 "is deliberately obscure and undocumented, and Registry changes can leave the "
24347 "system unbootable. Therefore when using the C<--merge> option, make sure "
24348 "you have a reliable backup first."
24352 #: ../tools/virt-win-reg.pl:66
24354 "This program can export and merge Windows Registry entries from a Windows "
24359 #: ../tools/virt-win-reg.pl:69
24361 "The first parameter is the libvirt guest name or the raw disk image of a "
24366 #: ../tools/virt-win-reg.pl:72
24368 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
24369 "exported (recursively). For example:"
24373 #: ../tools/virt-win-reg.pl:75
24376 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
24381 #: ../tools/virt-win-reg.pl:77
24383 "You can also display single values from within registry keys, for example:"
24387 #: ../tools/virt-win-reg.pl:80
24390 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
24391 " $ virt-win-reg Windows7 $cvkey ProductName\n"
24392 " Windows 7 Enterprise\n"
24397 #: ../tools/virt-win-reg.pl:84
24399 "With C<--merge>, you can merge a textual regedit file into the Windows "
24404 #: ../tools/virt-win-reg.pl:87
24407 " $ virt-win-reg --merge Windows7 changes.reg\n"
24412 #: ../tools/virt-win-reg.pl:89
24413 msgid "SUPPORTED SYSTEMS"
24417 #: ../tools/virt-win-reg.pl:91
24419 "The program currently supports Windows NT-derived guests starting with "
24420 "Windows XP through to at least Windows 7."
24424 #: ../tools/virt-win-reg.pl:94
24426 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
24427 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
24428 "and C<HKEY_USERS\\.DEFAULT>."
24432 #: ../tools/virt-win-reg.pl:98
24434 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
24439 #: ../tools/virt-win-reg.pl:101
24441 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
24446 #: ../tools/virt-win-reg.pl:104
24451 #: ../tools/virt-win-reg.pl:106
24453 "This program is only meant for simple access to the registry. If you want "
24454 "to do complicated things with the registry, we suggest you download the "
24455 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
24456 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
24457 "L<hivexregedit(1)>."
24461 #: ../tools/virt-win-reg.pl:112
24466 #: ../tools/virt-win-reg.pl:114
24468 "C<virt-win-reg> expects that regedit files have already been reencoded in "
24469 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
24470 "style line endings. Since Windows regedit files are often in UTF-16LE with "
24471 "Windows-style line endings, you may need to reencode the whole file before "
24472 "or after processing."
24476 #: ../tools/virt-win-reg.pl:120
24478 "To reencode a file from Windows format to Linux (before processing it with "
24479 "the C<--merge> option), you would do something like this:"
24483 #: ../tools/virt-win-reg.pl:123
24486 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
24491 #: ../tools/virt-win-reg.pl:125
24493 "To go in the opposite direction, after exporting and before sending the file "
24494 "to a Windows user, do something like this:"
24498 #: ../tools/virt-win-reg.pl:128
24501 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
24506 #: ../tools/virt-win-reg.pl:130
24507 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
24511 #: ../tools/virt-win-reg.pl:132
24513 "If you are unsure about the current encoding, use the L<file(1)> command. "
24514 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
24515 "style (CRLF) line endings, like this:"
24519 #: ../tools/virt-win-reg.pl:136
24522 " $ file software.reg\n"
24523 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
24524 " with CRLF line terminators\n"
24529 #: ../tools/virt-win-reg.pl:140
24530 msgid "This file would need conversion before you could C<--merge> it."
24534 #: ../tools/virt-win-reg.pl:142
24535 msgid "SHELL QUOTING"
24539 #: ../tools/virt-win-reg.pl:144
24541 "Be careful when passing parameters containing C<\\> (backslash) in the "
24542 "shell. Usually you will have to use 'single quotes' or double backslashes "
24543 "(but not both) to protect them from the shell."
24547 #: ../tools/virt-win-reg.pl:148
24548 msgid "Paths and value names are case-insensitive."
24552 #: ../tools/virt-win-reg.pl:150
24553 msgid "CurrentControlSet etc."
24557 #: ../tools/virt-win-reg.pl:152
24559 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
24560 "Registry at the level of the hive file, and therefore you cannot modify "
24565 #: ../tools/virt-win-reg.pl:156
24567 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
24568 "circumstances it might refer to another control set. The way to find out is "
24569 "to look at the C<HKLM\\SYSTEM\\Select> key:"
24573 #: ../tools/virt-win-reg.pl:160
24576 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
24577 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
24578 " \"Current\"=dword:00000001\n"
24579 " \"Default\"=dword:00000001\n"
24580 " \"Failed\"=dword:00000000\n"
24581 " \"LastKnownGood\"=dword:00000002\n"
24586 #: ../tools/virt-win-reg.pl:167
24587 msgid "\"Default\" is the one which Windows will choose when it boots."
24591 #: ../tools/virt-win-reg.pl:169
24593 "Similarly, other C<Current...> keys in the path may need to be replaced."
24597 #: ../tools/virt-win-reg.pl:196 ../tools/virt-make-fs.pl:177
24602 #: ../tools/virt-win-reg.pl:198 ../tools/virt-resize.pl:477
24603 msgid "Enable debugging messages."
24607 #: ../tools/virt-win-reg.pl:216
24612 #: ../tools/virt-win-reg.pl:218
24614 "In merge mode, this merges a textual regedit file into the Windows Registry "
24615 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
24616 "displays or exports Registry entries instead."
24620 #: ../tools/virt-win-reg.pl:222
24622 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
24623 "result in disk corruption. However exporting (without this flag) is always "
24628 #: ../tools/virt-win-reg.pl:230
24629 msgid "B<--encoding> UTF-16LE|ASCII"
24633 #: ../tools/virt-win-reg.pl:232
24635 "When merging (only), you may need to specify the encoding for strings to be "
24636 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
24637 "(3)/ENCODING STRINGS>."
24641 #: ../tools/virt-win-reg.pl:236
24643 "The default is to use UTF-16LE, which should work with recent versions of "
24648 #: ../tools/virt-win-reg.pl:463
24650 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
24651 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
24652 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
24656 #: ../tools/virt-win-reg.pl:478 ../tools/virt-make-fs.pl:543
24658 "When reporting bugs, please enable debugging and capture the I<complete> "
24663 #: ../tools/virt-win-reg.pl:481
24666 " export LIBGUESTFS_DEBUG=1\n"
24667 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
24672 #: ../tools/virt-win-reg.pl:484
24674 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
24679 #: ../tools/virt-win-reg.pl:493 ../tools/virt-resize.pl:1422
24680 #: ../tools/virt-make-fs.pl:558
24681 msgid "Copyright (C) 2010 Red Hat Inc."
24685 #: ../tools/virt-df.pl:36
24686 msgid "virt-df - Display free space on virtual filesystems"
24690 #: ../tools/virt-df.pl:40
24693 " virt-df [--options]\n"
24698 #: ../tools/virt-df.pl:42
24701 " virt-df [--options] domname\n"
24706 #: ../tools/virt-df.pl:44
24709 " virt-df [--options] disk.img [disk.img ...]\n"
24714 #: ../tools/virt-df.pl:48
24716 "C<virt-df> is a command line tool to display free space on virtual machine "
24717 "filesystems. Unlike other tools, it doesn't just display the amount of "
24718 "space allocated to a virtual machine, but can look inside the virtual "
24719 "machine to see how much space is really being used."
24723 #: ../tools/virt-df.pl:53
24725 "It is like the L<df(1)> command, but for virtual machines, except that it "
24726 "also works for Windows virtual machines."
24730 #: ../tools/virt-df.pl:56
24732 "If used without any arguments, C<virt-df> checks with libvirt to get a list "
24733 "of all active and inactive guests, and performs a C<df>-type operation on "
24734 "each one in turn, printing out the results."
24738 #: ../tools/virt-df.pl:60
24740 "If used with any argument(s), C<virt-df> performs a C<df>-type operation on "
24741 "either the single named libvirt domain, or on the disk image(s) listed on "
24742 "the command line (which must all belong to a single VM). In this mode (with "
24743 "arguments), C<virt-df> will I<only work for a single guest>. If you want to "
24744 "run on multiple guests, then you have to invoke C<virt-df> multiple times."
24748 #: ../tools/virt-df.pl:67
24750 "Use the C<--csv> option to get a format which can be easily parsed by other "
24751 "programs. Other options are mostly similar to standard C<df> options. See "
24752 "below for the complete list."
24756 #: ../tools/virt-df.pl:107
24761 #: ../tools/virt-df.pl:109
24763 "Write out the results in CSV format (comma-separated values). This format "
24764 "can be imported easily into databases and spreadsheets, but read L</NOTE "
24765 "ABOUT CSV FORMAT> below."
24769 #: ../tools/virt-df.pl:117
24770 msgid "B<--human-readable> | B<-h>"
24774 #: ../tools/virt-df.pl:119
24775 msgid "Print sizes in human-readable format."
24779 #: ../tools/virt-df.pl:121
24780 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
24784 #: ../tools/virt-df.pl:127
24785 msgid "B<--inodes> | B<-i>"
24789 #: ../tools/virt-df.pl:129
24790 msgid "Print inodes instead of blocks."
24794 #: ../tools/virt-df.pl:135
24795 msgid "B<--one-per-guest>"
24799 #: ../tools/virt-df.pl:137
24801 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
24802 "disks from several guests to a single libguestfs appliance."
24806 #: ../tools/virt-df.pl:140
24807 msgid "You might use this option in the following circumstances:"
24811 #: ../tools/virt-df.pl:146
24813 "If you think an untrusted guest might actively try to exploit the libguestfs "
24814 "appliance kernel, then this prevents one guest from interfering with the "
24815 "stats printed for another guest."
24819 #: ../tools/virt-df.pl:152
24821 "If the kernel has a bug which stops it from accessing a filesystem in one "
24822 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
24823 "and report stats for further guests."
24827 #: ../tools/virt-df.pl:512
24828 msgid "NOTE ABOUT CSV FORMAT"
24832 #: ../tools/virt-df.pl:514
24834 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
24835 "should be easy to parse, but it is definitely not easy to parse."
24839 #: ../tools/virt-df.pl:517
24841 "Myth: Just split fields at commas. Reality: This does I<not> work "
24842 "reliably. This example has two columns:"
24846 #: ../tools/virt-df.pl:520
24849 " \"foo,bar\",baz\n"
24854 #: ../tools/virt-df.pl:522
24856 "Myth: Read the file one line at a time. Reality: This does I<not> work "
24857 "reliably. This example has one row:"
24861 #: ../tools/virt-df.pl:525
24870 #: ../tools/virt-df.pl:528
24872 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
24873 "packaged in major Linux distributions)."
24877 #: ../tools/virt-df.pl:531
24879 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
24880 "or Python's built-in csv library)."
24884 #: ../tools/virt-df.pl:534
24885 msgid "Most spreadsheets and databases can import CSV directly."
24889 #: ../tools/virt-ls.pl:35
24890 msgid "virt-ls - List files in a virtual machine"
24894 #: ../tools/virt-ls.pl:39
24897 " virt-ls [--options] domname directory\n"
24902 #: ../tools/virt-ls.pl:41
24905 " virt-ls [--options] disk.img [disk.img ...] directory\n"
24910 #: ../tools/virt-ls.pl:45
24912 "C<virt-ls> is a command line tool to list the names of files in a directory "
24913 "inside a virtual machine or disk image."
24917 #: ../tools/virt-ls.pl:48
24919 "C<virt-ls> is just a simple wrapper around L<libguestfs(3)> functionality. "
24920 "For more complex cases you should look at the L<guestfish(1)> tool."
24924 #: ../tools/virt-ls.pl:52
24926 "C<virt-ls> can be used in one of three modes: simple, long and recursive. A "
24927 "simple listing is like the ordinary L<ls(1)> command:"
24931 #: ../tools/virt-ls.pl:55
24934 " $ virt-ls myguest /\n"
24942 #: ../tools/virt-ls.pl:60
24943 msgid "With the C<-l> (C<--long>) option, C<virt-ls> shows more detail:"
24947 #: ../tools/virt-ls.pl:62
24950 " $ virt-ls -l myguest /\n"
24952 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
24953 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
24959 #: ../tools/virt-ls.pl:68
24961 "With the C<-R> (C<--recursive>) option, C<virt-ls> lists the names of files "
24962 "and directories recursively:"
24966 #: ../tools/virt-ls.pl:71
24969 " $ virt-ls -R myguest /tmp\n"
24977 #: ../tools/virt-ls.pl:76
24979 "You I<cannot> combine these options. To do more complicated things, use "
24984 #: ../tools/virt-ls.pl:115 ../tools/virt-list-filesystems.pl:86
24985 #: ../tools/virt-list-partitions.pl:95
24986 msgid "B<-l> | B<--long>"
24990 #: ../tools/virt-ls.pl:117
24991 msgid "B<-R> | B<--recursive>"
24995 #: ../tools/virt-ls.pl:119
24997 "Select the mode. With neither of these options, C<virt-ls> produces a "
24998 "simple, flat list of the files in the named directory."
25002 #: ../tools/virt-ls.pl:122
25004 "C<virt-ls -l> produces a \"long listing\", which shows more detail (just "
25005 "like the plain C<ls -l> command)."
25009 #: ../tools/virt-ls.pl:125
25011 "C<virt-ls -R> produces a recursive list of files starting at the named "
25012 "directory. See the documentation for the C<guestfs_find> command L<guestfs"
25013 "(3)> for precise details."
25017 #: ../tools/virt-ls.pl:129
25018 msgid "You cannot combine these options."
25022 #: ../tools/virt-ls.pl:212
25024 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<Sys::"
25025 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
25030 #: ../tools/virt-resize.pl:42
25031 msgid "virt-resize - Resize a virtual machine disk"
25035 #: ../tools/virt-resize.pl:46
25038 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
25039 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
25040 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
25045 #: ../tools/virt-resize.pl:52
25047 "Virt-resize is a tool which can resize a virtual machine disk, making it "
25048 "larger or smaller overall, and resizing or deleting any partitions contained "
25053 #: ../tools/virt-resize.pl:56
25055 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
25056 "not> be used on live virtual machines - for consistent results, shut the "
25057 "virtual machine down before resizing it."
25061 #: ../tools/virt-resize.pl:60
25063 "If you are not familiar with the associated tools: L<virt-list-partitions(1)"
25064 ">, L<virt-list-filesystems(1)> and L<virt-df(1)>, we recommend you go and "
25065 "read those manual pages first."
25069 #: ../tools/virt-resize.pl:68
25071 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
25072 "fill the extra 5GB of space."
25076 #: ../tools/virt-resize.pl:71
25079 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
25080 " virt-list-partitions -lht olddisk\n"
25081 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
25082 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
25087 #: ../tools/virt-resize.pl:76
25089 "As above, but make the /boot partition 200MB bigger, while giving the "
25090 "remaining space to /dev/sda2:"
25094 #: ../tools/virt-resize.pl:79
25097 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
25102 #: ../tools/virt-resize.pl:81
25103 msgid "DETAILED USAGE"
25107 #: ../tools/virt-resize.pl:83
25108 msgid "EXPANDING A VIRTUAL MACHINE DISK"
25112 #: ../tools/virt-resize.pl:87
25113 msgid "1. Shut down the virtual machine"
25117 #: ../tools/virt-resize.pl:89
25118 msgid "2. Locate input disk image"
25122 #: ../tools/virt-resize.pl:91
25124 "Locate the input disk image (ie. the file or device on the host containing "
25125 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
25126 "dumpxml> like this to find the disk image name:"
25130 #: ../tools/virt-resize.pl:95
25133 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
25134 " Found 1 nodes:\n"
25136 " <source dev=\"/dev/vg/lv_guest\" />\n"
25141 #: ../tools/virt-resize.pl:100
25142 msgid "3. Look at current sizing"
25146 #: ../tools/virt-resize.pl:102
25148 "Use L<virt-list-partitions(1)> to display the current partitions and sizes:"
25152 #: ../tools/virt-resize.pl:105
25155 " # virt-list-partitions -lht /dev/vg/lv_guest\n"
25156 " /dev/sda1 ext3 101.9M\n"
25157 " /dev/sda2 pv 7.9G\n"
25158 " /dev/sda device 8.0G\n"
25163 #: ../tools/virt-resize.pl:110
25165 "(This example is a virtual machine with an 8 GB disk which we would like to "
25166 "expand up to 10 GB)."
25170 #: ../tools/virt-resize.pl:113
25171 msgid "4. Create output disk"
25175 #: ../tools/virt-resize.pl:115
25177 "Virt-resize cannot do in-place disk modifications. You have to have space "
25178 "to store the resized output disk."
25182 #: ../tools/virt-resize.pl:118
25184 "To store the resized disk image in a file, create a file of a suitable size:"
25188 #: ../tools/virt-resize.pl:121
25191 " # rm -f outdisk\n"
25192 " # truncate -s 10G outdisk\n"
25197 #: ../tools/virt-resize.pl:124
25198 msgid "Or use L<lvcreate(1)> to create a logical volume:"
25202 #: ../tools/virt-resize.pl:126
25205 " # lvcreate -L 10G -n lv_name vg_name\n"
25210 #: ../tools/virt-resize.pl:128
25211 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
25215 #: ../tools/virt-resize.pl:130
25218 " # virsh pool-list\n"
25219 " # virsh vol-create-as poolname newvol 10G\n"
25224 #: ../tools/virt-resize.pl:133
25229 #: ../tools/virt-resize.pl:135
25231 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
25232 "file) and the output disk. The output disk is the one created in the "
25237 #: ../tools/virt-resize.pl:139
25240 " # virt-resize indisk outdisk\n"
25245 #: ../tools/virt-resize.pl:141
25247 "This command just copies disk image C<indisk> to disk image C<outdisk> "
25248 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
25249 "larger, then an extra, empty partition is created at the end of the disk "
25250 "covering the extra space. If C<outdisk> is smaller, then it will give an "
25255 #: ../tools/virt-resize.pl:147
25257 "More realistically you'd want to expand existing partitions in the disk "
25258 "image by passing extra options (for the full list see the L</OPTIONS> "
25263 #: ../tools/virt-resize.pl:151
25265 "L</--expand> is the most useful option. It expands the named partition "
25266 "within the disk to fill any extra space:"
25270 #: ../tools/virt-resize.pl:154
25273 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
25278 #: ../tools/virt-resize.pl:156
25280 "(In this case, an extra partition is I<not> created at the end of the disk, "
25281 "because there will be no unused space)."
25285 #: ../tools/virt-resize.pl:159
25287 "L</--resize> is the other commonly used option. The following would "
25288 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
25289 "rest of the available space:"
25293 #: ../tools/virt-resize.pl:163
25296 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
25297 " indisk outdisk\n"
25302 #: ../tools/virt-resize.pl:166
25304 "If the expanded partition in the image contains a filesystem or LVM PV, then "
25305 "if virt-resize knows how, it will resize the contents, the equivalent of "
25306 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
25307 ">. However virt-resize does not know how to resize some filesystems, so you "
25308 "would have to online resize them after booting the guest. And virt-resize "
25309 "also does not resize anything inside an LVM PV, it just resizes the PV "
25310 "itself and leaves the user to resize any LVs inside that PV as desired."
25314 #: ../tools/virt-resize.pl:175
25315 msgid "Other options are covered below."
25319 #: ../tools/virt-resize.pl:177
25324 #: ../tools/virt-resize.pl:179
25325 msgid "Thoroughly test the new disk image I<before> discarding the old one."
25329 #: ../tools/virt-resize.pl:181
25330 msgid "If you are using libvirt, edit the XML to point at the new disk:"
25334 #: ../tools/virt-resize.pl:183
25337 " # virsh edit guestname\n"
25342 #: ../tools/virt-resize.pl:185
25344 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
25345 "html#elementsDisks>"
25349 #: ../tools/virt-resize.pl:188
25350 msgid "Then start up the domain with the new, resized disk:"
25354 #: ../tools/virt-resize.pl:190
25357 " # virsh start guestname\n"
25362 #: ../tools/virt-resize.pl:192
25364 "and check that it still works. See also the L</NOTES> section below for "
25365 "additional information."
25369 #: ../tools/virt-resize.pl:195
25370 msgid "7. Resize LVs etc inside the guest"
25374 #: ../tools/virt-resize.pl:197
25375 msgid "(This can also be done offline using L<guestfish(1)>)"
25379 #: ../tools/virt-resize.pl:199
25381 "Once the guest has booted you should see the new space available, at least "
25382 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
25383 "may need to resize LVs inside PVs, and also resize filesystem types that "
25384 "virt-resize does not know how to expand."
25388 #: ../tools/virt-resize.pl:206
25389 msgid "SHRINKING A VIRTUAL MACHINE DISK"
25393 #: ../tools/virt-resize.pl:208
25395 "Shrinking is somewhat more complex than expanding, and only an overview is "
25400 #: ../tools/virt-resize.pl:211
25402 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
25403 "filesystems). The user has to shrink content before passing the disk image "
25404 "to virt-resize, and virt-resize will check that the content has been shrunk "
25409 #: ../tools/virt-resize.pl:216
25410 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
25414 #: ../tools/virt-resize.pl:218
25416 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
25417 "steps 3 and 4 above to allocate a new disk image."
25421 #: ../tools/virt-resize.pl:221
25423 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
25427 #: ../tools/virt-resize.pl:224
25428 msgid "IGNORING OR DELETING PARTITIONS"
25432 #: ../tools/virt-resize.pl:226
25434 "virt-resize also gives a convenient way to ignore or delete partitions when "
25435 "copying from the input disk to the output disk. Ignoring a partition speeds "
25436 "up the copy where you don't care about the existing contents of a "
25437 "partition. Deleting a partition removes it completely, but note that it "
25438 "also renumbers any partitions after the one which is deleted, which can "
25439 "leave some guests unbootable."
25443 #: ../tools/virt-resize.pl:243
25444 msgid "Display help."
25448 #: ../tools/virt-resize.pl:257
25449 msgid "B<--resize part=size>"
25453 #: ../tools/virt-resize.pl:259
25455 "Resize the named partition (expanding or shrinking it) so that it has the "
25460 #: ../tools/virt-resize.pl:262
25462 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
25463 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
25464 "Exabytes; or as a percentage of the current size; or as a relative number or "
25465 "percentage. For example:"
25469 #: ../tools/virt-resize.pl:267
25472 " --resize /dev/sda2=10G\n"
25477 #: ../tools/virt-resize.pl:269
25480 " --resize /dev/sda4=90%\n"
25485 #: ../tools/virt-resize.pl:271
25488 " --resize /dev/sda2=+1G\n"
25493 #: ../tools/virt-resize.pl:273
25496 " --resize /dev/sda2=-200M\n"
25501 #: ../tools/virt-resize.pl:275
25504 " --resize /dev/sda1=+128K\n"
25509 #: ../tools/virt-resize.pl:277
25512 " --resize /dev/sda1=+10%\n"
25517 #: ../tools/virt-resize.pl:279
25520 " --resize /dev/sda1=-10%\n"
25525 #: ../tools/virt-resize.pl:281
25527 "You can increase the size of any partition. Virt-resize will expand the "
25528 "direct content of the partition if it knows how (see C<--expand> below)."
25532 #: ../tools/virt-resize.pl:285
25534 "You can only I<decrease> the size of partitions that contain filesystems or "
25535 "PVs which have already been shrunk. Virt-resize will check this has been "
25536 "done before proceeding, or else will print an error (see also C<--resize-"
25541 #: ../tools/virt-resize.pl:290 ../tools/virt-resize.pl:382
25542 #: ../tools/virt-resize.pl:399
25543 msgid "You can give this option multiple times."
25547 #: ../tools/virt-resize.pl:296
25548 msgid "B<--resize-force part=size>"
25552 #: ../tools/virt-resize.pl:298
25554 "This is the same as C<--resize> except that it will let you decrease the "
25555 "size of any partition. Generally this means you will lose any data which "
25556 "was at the end of the partition you shrink, but you may not care about that "
25557 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
25558 "as a swap partition)."
25562 #: ../tools/virt-resize.pl:304
25563 msgid "See also the C<--ignore> option."
25567 #: ../tools/virt-resize.pl:310
25568 msgid "B<--expand part>"
25572 #: ../tools/virt-resize.pl:312
25574 "Expand the named partition so it uses up all extra space (space left over "
25575 "after any other resize changes that you request have been done)."
25579 #: ../tools/virt-resize.pl:315
25581 "If virt-resize knows how, it will expand the direct content of the "
25582 "partition. For example, if the partition is an LVM PV, it will expand the "
25583 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
25584 "content it doesn't know about alone."
25588 #: ../tools/virt-resize.pl:320
25589 msgid "Currently virt-resize can resize:"
25593 #: ../tools/virt-resize.pl:326
25595 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
25600 #: ../tools/virt-resize.pl:331
25602 "NTFS filesystems contained directly in a partition, if libguestfs was "
25603 "compiled with support for NTFS."
25607 #: ../tools/virt-resize.pl:334
25609 "The filesystem must have been shut down consistently last time it was used. "
25610 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
25611 "consistency check, so at the first boot after resizing Windows will check "
25616 #: ../tools/virt-resize.pl:341
25618 "LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
25619 "inside the PV. The user will have to resize LVs as desired."
25623 #: ../tools/virt-resize.pl:347 ../tools/virt-resize.pl:369
25624 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
25628 #: ../tools/virt-resize.pl:353
25629 msgid "B<--shrink part>"
25633 #: ../tools/virt-resize.pl:355
25635 "Shrink the named partition until the overall disk image fits in the "
25636 "destination. The named partition B<must> contain a filesystem or PV which "
25637 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
25638 "online tools). Virt-resize will check this and give an error if it has not "
25643 #: ../tools/virt-resize.pl:361
25645 "The amount by which the overall disk must be shrunk (after carrying out all "
25646 "other operations requested by the user) is called the \"deficit\". For "
25647 "example, a straight copy (assume no other operations) from a 5GB disk image "
25648 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
25649 "would give an error unless the user specified a partition to shrink and that "
25650 "partition had more than a gigabyte of free space."
25654 #: ../tools/virt-resize.pl:375
25655 msgid "B<--ignore part>"
25659 #: ../tools/virt-resize.pl:377
25661 "Ignore the named partition. Effectively this means the partition is "
25662 "allocated on the destination disk, but the content is not copied across from "
25663 "the source disk. The content of the partition will be blank (all zero "
25668 #: ../tools/virt-resize.pl:388
25669 msgid "B<--delete part>"
25673 #: ../tools/virt-resize.pl:390
25675 "Delete the named partition. It would be more accurate to describe this as "
25676 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
25677 "the original disk image is left intact."
25681 #: ../tools/virt-resize.pl:394
25683 "Note that when you delete a partition, then anything contained in the "
25684 "partition is also deleted. Furthermore, this causes any partitions that "
25685 "come after to be I<renumbered>, which can easily make your guest unbootable."
25689 #: ../tools/virt-resize.pl:405
25690 msgid "B<--LV-expand logvol>"
25694 #: ../tools/virt-resize.pl:407
25696 "This takes the logical volume and, as a final step, expands it to fill all "
25697 "the space available in its volume group. A typical usage, assuming a Linux "
25698 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
25699 "lv_root> would be:"
25703 #: ../tools/virt-resize.pl:412
25706 " virt-resize indisk outdisk \\\n"
25707 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
25712 #: ../tools/virt-resize.pl:415
25714 "This would first expand the partition (and PV), and then expand the root "
25715 "device to fill the extra space in the PV."
25719 #: ../tools/virt-resize.pl:418
25721 "The contents of the LV are also resized if virt-resize knows how to do "
25722 "that. You can stop virt-resize from trying to expand the content by using "
25723 "the option C<--no-expand-content>."
25727 #: ../tools/virt-resize.pl:422
25728 msgid "Use L<virt-list-filesystems(1)> to list the filesystems in the guest."
25732 #: ../tools/virt-resize.pl:425
25734 "You can give this option multiple times, I<but> it doesn't make sense to do "
25735 "this unless the logical volumes you specify are all in different volume "
25740 #: ../tools/virt-resize.pl:433
25741 msgid "B<--no-copy-boot-loader>"
25745 #: ../tools/virt-resize.pl:435
25747 "By default, virt-resize copies over some sectors at the start of the disk "
25748 "(up to the beginning of the first partition). Commonly these sectors "
25749 "contain the Master Boot Record (MBR) and the boot loader, and are required "
25750 "in order for the guest to boot correctly."
25754 #: ../tools/virt-resize.pl:440
25756 "If you specify this flag, then this initial copy is not done. You may need "
25757 "to reinstall the boot loader in this case."
25761 #: ../tools/virt-resize.pl:448
25762 msgid "B<--no-extra-partition>"
25766 #: ../tools/virt-resize.pl:450
25768 "By default, virt-resize creates an extra partition if there is any extra, "
25769 "unused space after all resizing has happened. Use this option to prevent "
25770 "the extra partition from being created. If you do this then the extra space "
25771 "will be inaccessible until you run fdisk, parted, or some other partitioning "
25772 "tool in the guest."
25776 #: ../tools/virt-resize.pl:456
25778 "Note that if the surplus space is smaller than 10 MB, no extra partition "
25783 #: ../tools/virt-resize.pl:463
25784 msgid "B<--no-expand-content>"
25788 #: ../tools/virt-resize.pl:465
25790 "By default, virt-resize will try to expand the direct contents of "
25791 "partitions, if it knows how (see C<--expand> option above)."
25795 #: ../tools/virt-resize.pl:468
25797 "If you give the C<--no-expand-content> option then virt-resize will not "
25802 #: ../tools/virt-resize.pl:475
25803 msgid "B<-d> | B<--debug>"
25807 #: ../tools/virt-resize.pl:483
25808 msgid "B<-n> | B<--dryrun>"
25812 #: ../tools/virt-resize.pl:485
25813 msgid "Print a summary of what would be done, but don't do anything."
25817 #: ../tools/virt-resize.pl:491
25818 msgid "B<-q> | B<--quiet>"
25822 #: ../tools/virt-resize.pl:493
25823 msgid "Don't print the summary."
25827 #: ../tools/virt-resize.pl:1359 ../tools/virt-rescue.pl:90
25832 #: ../tools/virt-resize.pl:1361
25833 msgid "\"Partition 1 does not end on cylinder boundary.\""
25837 #: ../tools/virt-resize.pl:1363
25839 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
25840 "means the partitions will not be aligned to the ancient CHS geometry. "
25841 "However CHS geometry is meaningless for disks manufactured since the early "
25842 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
25843 "cylinders is not required by any modern operating system."
25847 #: ../tools/virt-resize.pl:1370
25848 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
25852 #: ../tools/virt-resize.pl:1372
25854 "In Windows Vista and later versions, Microsoft switched to using a separate "
25855 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
25856 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
25857 "the boot partition. Doing so seems to break the guest completely. However "
25858 "expanding the second partition (ie. C: drive) should work."
25862 #: ../tools/virt-resize.pl:1379
25864 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
25865 "NTFS partitions have been expanded. This is just a safety check and (unless "
25866 "it find errors) is nothing to worry about."
25870 #: ../tools/virt-resize.pl:1383
25871 msgid "ALTERNATIVE TOOLS"
25875 #: ../tools/virt-resize.pl:1385
25877 "There are several proprietary tools for resizing partitions. We won't "
25878 "mention any here."
25882 #: ../tools/virt-resize.pl:1388
25884 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
25885 "operations on disk images. They can resize and move partitions, but I don't "
25886 "think they can do anything with the contents, and they certainly don't "
25891 #: ../tools/virt-resize.pl:1393
25893 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
25894 "but at a much lower level. You will probably end up hand-calculating sector "
25895 "offsets, which is something that virt-resize was designed to avoid. If you "
25896 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
25901 #: ../tools/virt-resize.pl:1401
25903 "L<virt-list-partitions(1)>, L<virt-list-filesystems(1)>, L<virt-df(1)>, "
25904 "L<guestfs(3)>, L<guestfish(1)>, L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, "
25905 "L<resize2fs(8)>, L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<Sys::Guestfs"
25906 "(3)>, L<http://libguestfs.org/>."
25910 #: ../tools/virt-list-filesystems.pl:32
25912 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
25916 #: ../tools/virt-list-filesystems.pl:36
25919 " virt-list-filesystems [--options] domname\n"
25924 #: ../tools/virt-list-filesystems.pl:38
25927 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
25932 #: ../tools/virt-list-filesystems.pl:42
25934 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
25935 "are contained in a virtual machine or disk image."
25939 #: ../tools/virt-list-filesystems.pl:46
25941 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
25942 "functionality. For more complex cases you should look at the L<guestfish(1)"
25947 #: ../tools/virt-list-filesystems.pl:88
25949 "With this option, C<virt-list-filesystems> displays the type of each "
25950 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
25954 #: ../tools/virt-list-filesystems.pl:95
25955 msgid "B<-a> | B<--all>"
25959 #: ../tools/virt-list-filesystems.pl:97
25961 "Normally we only show mountable filesystems. If this option is given then "
25962 "swap devices are shown too."
25966 #: ../tools/virt-list-filesystems.pl:193
25968 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-list-"
25969 "partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)"
25970 ">, L<http://libguestfs.org/>."
25974 #: ../tools/virt-cat.pl:34
25975 msgid "virt-cat - Display a file in a virtual machine"
25979 #: ../tools/virt-cat.pl:38
25982 " virt-cat [--options] domname file\n"
25987 #: ../tools/virt-cat.pl:40
25990 " virt-cat [--options] disk.img [disk.img ...] file\n"
25995 #: ../tools/virt-cat.pl:44
25997 "C<virt-cat> is a command line tool to display the contents of C<file> where "
25998 "C<file> exists in the named virtual machine (or disk image)."
26002 #: ../tools/virt-cat.pl:47
26004 "C<virt-cat> can be used to quickly view a single file. To edit a file, use "
26005 "C<virt-edit>. For more complex cases you should look at the L<guestfish(1)> "
26010 #: ../tools/virt-cat.pl:53
26012 "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
26016 #: ../tools/virt-cat.pl:56
26019 " virt-cat mydomain /etc/fstab\n"
26024 #: ../tools/virt-cat.pl:58
26025 msgid "List syslog messages from a VM:"
26029 #: ../tools/virt-cat.pl:60
26032 " virt-cat mydomain /var/log/messages | tail\n"
26037 #: ../tools/virt-cat.pl:62
26038 msgid "Find out what DHCP IP address a VM acquired:"
26042 #: ../tools/virt-cat.pl:64
26045 " virt-cat mydomain /var/log/messages | grep 'dhclient: bound to' | tail\n"
26050 #: ../tools/virt-cat.pl:66
26051 msgid "Find out what packages were recently installed:"
26055 #: ../tools/virt-cat.pl:68
26058 " virt-cat mydomain /var/log/yum.log | tail\n"
26063 #: ../tools/virt-cat.pl:70
26064 msgid "Find out who is logged on inside a virtual machine:"
26068 #: ../tools/virt-cat.pl:72
26071 " virt-cat mydomain /var/run/utmp > /tmp/utmp\n"
26077 #: ../tools/virt-cat.pl:75
26078 msgid "or who was logged on:"
26082 #: ../tools/virt-cat.pl:77
26085 " virt-cat mydomain /var/log/wtmp > /tmp/wtmp\n"
26086 " last -f /tmp/wtmp\n"
26091 #: ../tools/virt-cat.pl:165
26093 "L<guestfs(3)>, L<guestfish(1)>, L<virt-edit(1)>, L<Sys::Guestfs(3)>, L<Sys::"
26094 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26098 #: ../tools/virt-tar.pl:34
26099 msgid "virt-tar - Extract or upload files to a virtual machine"
26103 #: ../tools/virt-tar.pl:38
26106 " virt-tar [--options] -x domname directory tarball\n"
26111 #: ../tools/virt-tar.pl:40
26114 " virt-tar [--options] -u domname tarball directory\n"
26119 #: ../tools/virt-tar.pl:42
26122 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
26127 #: ../tools/virt-tar.pl:44
26130 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
26135 #: ../tools/virt-tar.pl:48
26136 msgid "Download C</home> from the VM into a local tarball:"
26140 #: ../tools/virt-tar.pl:50
26143 " virt-tar -x domname /home home.tar\n"
26148 #: ../tools/virt-tar.pl:52
26151 " virt-tar -zx domname /home home.tar.gz\n"
26156 #: ../tools/virt-tar.pl:54
26157 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
26161 #: ../tools/virt-tar.pl:56
26164 " virt-tar -u domname uploadstuff.tar /tmp\n"
26169 #: ../tools/virt-tar.pl:58
26172 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
26177 #: ../tools/virt-tar.pl:62
26179 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
26180 "virtual machines. If you do this, you risk disk corruption in the VM. "
26181 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
26185 #: ../tools/virt-tar.pl:67
26187 "You can use C<-x> (extract) on live virtual machines, but you might get "
26188 "inconsistent results or errors if there is filesystem activity inside the "
26189 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
26190 "work, but the only way to guarantee consistent results is if the virtual "
26191 "machine is shut down."
26195 #: ../tools/virt-tar.pl:75
26197 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
26198 "parts of a guest filesystem. There are many possibilities: making backups, "
26199 "uploading data files, snooping on guest activity, fixing or customizing "
26204 #: ../tools/virt-tar.pl:80
26206 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
26207 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
26208 "should look at the L<guestfish(1)> tool."
26212 #: ../tools/virt-tar.pl:84
26214 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
26215 "its contents (recursively) from the virtual machine into a local tarball. "
26216 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
26217 "virtual machine. You cannot use these two options together."
26221 #: ../tools/virt-tar.pl:90
26223 "In addition, you may need to use the C<-z> (gZip) option to enable "
26224 "compression. When uploading, you have to specify C<-z> if the upload file "
26225 "is compressed because virt-tar won't detect this on its own."
26229 #: ../tools/virt-tar.pl:94
26231 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
26232 "example it cannot do PKZip files or bzip2 compression. If you want that "
26233 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
26234 "the L<libguestfs(3)> API)."
26238 #: ../tools/virt-tar.pl:135
26239 msgid "B<-x> | B<--extract> | B<--download>"
26243 #: ../tools/virt-tar.pl:137
26244 msgid "B<-u> | B<--upload>"
26248 #: ../tools/virt-tar.pl:139
26250 "Use C<-x> to extract (download) a directory from a virtual machine to a "
26255 #: ../tools/virt-tar.pl:142
26257 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
26258 "Please read the L</WARNING> section above before using this option."
26262 #: ../tools/virt-tar.pl:146
26263 msgid "You must specify exactly one of these options."
26267 #: ../tools/virt-tar.pl:152
26268 msgid "B<-z> | B<--gzip>"
26272 #: ../tools/virt-tar.pl:154
26273 msgid "Specify that the input or output tarball is gzip-compressed."
26277 #: ../tools/virt-tar.pl:259
26279 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<Sys::"
26280 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
26285 #: ../tools/virt-rescue.pl:33
26286 msgid "virt-rescue - Run a rescue shell on a virtual machine"
26290 #: ../tools/virt-rescue.pl:37
26293 " virt-rescue [--options] domname\n"
26298 #: ../tools/virt-rescue.pl:39
26301 " virt-rescue [--options] disk.img [disk.img ...]\n"
26306 #: ../tools/virt-rescue.pl:43
26308 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
26309 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
26310 "you from doing this, but doesn't catch all cases."
26314 #: ../tools/virt-rescue.pl:47
26316 "However if you use the I<--ro> (read only) option, then you can attach a "
26317 "shell to a live virtual machine. The results might be strange or "
26318 "inconsistent at times but you won't get disk corruption."
26322 #: ../tools/virt-rescue.pl:53
26324 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
26325 "need for a CD. virt-rescue gives you a rescue shell and some simple "
26326 "recovery tools which you can use to examine or rescue a virtual machine or "
26331 #: ../tools/virt-rescue.pl:58
26333 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
26334 "on disk image(s):"
26338 #: ../tools/virt-rescue.pl:61
26341 " virt-rescue GuestName\n"
26346 #: ../tools/virt-rescue.pl:63
26349 " virt-rescue --ro /path/to/disk.img\n"
26354 #: ../tools/virt-rescue.pl:65
26357 " virt-rescue /dev/sdc\n"
26362 #: ../tools/virt-rescue.pl:67
26363 msgid "For live VMs you I<must> use the --ro option."
26367 #: ../tools/virt-rescue.pl:69
26369 "When you run virt-rescue on a virtual machine or disk image, you are placed "
26370 "in an interactive bash shell where you can use many ordinary Linux "
26371 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
26372 "appliance. You must mount the virtual machine's filesystems by hand. There "
26373 "is an empty directory called C</sysroot> where you can mount filesystems."
26377 #: ../tools/virt-rescue.pl:76
26379 "In the example below, we list logical volumes, then choose one to mount "
26380 "under C</sysroot>:"
26384 #: ../tools/virt-rescue.pl:79
26388 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
26389 " lv_root vg_f11x64 -wi-a- 8.83G\n"
26390 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
26391 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
26392 " ><rescue> ls /sysroot\n"
26397 #: ../tools/virt-rescue.pl:86
26399 "If you don't know what filesystems are available on the virtual machine then "
26400 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
26404 #: ../tools/virt-rescue.pl:92
26406 "Virt-rescue can be used on I<any> disk image file or device, not just a "
26407 "virtual machine. For example you can use it on a blank file if you want to "
26408 "partition that file (although we would recommend using L<guestfish(1)> "
26409 "instead as it is more suitable for this purpose). You can even use virt-"
26410 "rescue on things like SD cards."
26414 #: ../tools/virt-rescue.pl:98
26416 "This tool is just designed for quick interactive hacking on a virtual "
26417 "machine. For more structured access to a virtual machine disk image, you "
26418 "should use L<guestfs(3)>. To get a structured shell that you can use to "
26419 "make scripted changes to guests, use L<guestfish(1)>."
26423 #: ../tools/virt-rescue.pl:127
26424 msgid "B<--append kernelopts>"
26428 #: ../tools/virt-rescue.pl:129
26429 msgid "Pass additional options to the rescue kernel."
26433 #: ../tools/virt-rescue.pl:147
26434 msgid "B<--memsize MB> | B<-m MB>"
26438 #: ../tools/virt-rescue.pl:149
26440 "Change the amount of memory allocated to the rescue system. The default is "
26441 "set by libguestfs and is small but adequate for running system tools. The "
26442 "occasional program might need more memory. The parameter is specified in "
26447 #: ../tools/virt-rescue.pl:158
26448 msgid "B<--ro> | B<-r>"
26452 #: ../tools/virt-rescue.pl:160
26453 msgid "Open the image read-only."
26457 #: ../tools/virt-rescue.pl:172
26459 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
26460 "SELINUX> before using this option."
26464 #: ../tools/virt-rescue.pl:228
26466 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
26467 "ENVIRONMENT VARIABLES> for the complete list."
26471 #: ../tools/virt-rescue.pl:233
26473 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
26474 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26478 #: ../tools/virt-make-fs.pl:37
26479 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
26483 #: ../tools/virt-make-fs.pl:41
26486 " virt-make-fs [--options] input.tar output.img\n"
26491 #: ../tools/virt-make-fs.pl:43
26494 " virt-make-fs [--options] input.tar.gz output.img\n"
26499 #: ../tools/virt-make-fs.pl:45
26502 " virt-make-fs [--options] directory output.img\n"
26507 #: ../tools/virt-make-fs.pl:49
26509 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
26510 "archive or some files in a directory. It is similar to tools like L<mkisofs"
26511 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
26512 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
26513 "you want to attach these filesystems to existing virtual machines (eg. to "
26514 "import large amounts of read-only data to a VM)."
26518 #: ../tools/virt-make-fs.pl:57
26519 msgid "Basic usage is:"
26523 #: ../tools/virt-make-fs.pl:59
26526 " virt-make-fs input output\n"
26531 #: ../tools/virt-make-fs.pl:61
26533 "where C<input> is either a directory containing files that you want to add, "
26534 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
26535 "C<output> is a disk image. The input type is detected automatically. The "
26536 "output disk image defaults to a raw ext2 image unless you specify extra "
26537 "flags (see L</OPTIONS> below)."
26541 #: ../tools/virt-make-fs.pl:67
26542 msgid "EXTRA SPACE"
26546 #: ../tools/virt-make-fs.pl:69
26548 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
26549 "the files that it contains, but might have extra space. Depending on how "
26550 "you are going to use the output, you might think this extra space is wasted "
26551 "and want to minimize it, or you might want to leave space so that more files "
26552 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
26553 "but you can use the C<--size> flag to leave space in the filesystem if you "
26558 #: ../tools/virt-make-fs.pl:77
26560 "An alternative way to leave extra space but not make the output image any "
26561 "bigger is to use an alternative disk image format (instead of the default "
26562 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
26563 "image format (check your hypervisor supports this before using it). This "
26564 "allows you to choose a large C<--size> but the extra space won't actually be "
26565 "allocated in the image until you try to store something in it."
26569 #: ../tools/virt-make-fs.pl:85
26571 "Don't forget that you can also use local commands including L<resize2fs(8)> "
26572 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-"
26573 "resize to build another image from scratch."
26577 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
26578 #: ../tools/virt-make-fs.pl:142
26583 #: ../tools/virt-make-fs.pl:91
26586 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
26591 #: ../tools/virt-make-fs.pl:93
26592 msgid "FILESYSTEM TYPE"
26596 #: ../tools/virt-make-fs.pl:95
26598 "The default filesystem type is C<ext2>. Just about any filesystem type that "
26599 "libguestfs supports can be used (but I<not> read-only formats like "
26600 "ISO9660). Here are some of the more common choices:"
26604 #: ../tools/virt-make-fs.pl:101
26609 #: ../tools/virt-make-fs.pl:103
26611 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
26612 "you are not going to use the filesystem in a way that requires the journal, "
26613 "then this is just wasted overhead."
26617 #: ../tools/virt-make-fs.pl:107
26618 msgid "I<ntfs> or I<vfat>"
26622 #: ../tools/virt-make-fs.pl:109
26623 msgid "Useful if exporting data to a Windows guest."
26627 #: ../tools/virt-make-fs.pl:111
26629 "I<Note for vfat>: The tar archive or local directory must only contain files "
26630 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
26631 "program running within libguestfs is unable to change the ownership of non-"
26632 "root files, since vfat itself does not support this."
26636 #: ../tools/virt-make-fs.pl:116
26641 #: ../tools/virt-make-fs.pl:118
26643 "Lower overhead than C<ext2>, but certain limitations on filename length and "
26644 "total filesystem size."
26648 #: ../tools/virt-make-fs.pl:125
26651 " virt-make-fs --type=minix input minixfs.img\n"
26656 #: ../tools/virt-make-fs.pl:127
26657 msgid "TO PARTITION OR NOT TO PARTITION"
26661 #: ../tools/virt-make-fs.pl:129
26662 msgid "Optionally virt-make-fs can add a partition table to the output disk."
26666 #: ../tools/virt-make-fs.pl:131
26668 "Adding a partition can make the disk image more compatible with certain "
26669 "virtualized operating systems which don't expect to see a filesystem "
26670 "directly located on a block device (Linux doesn't care and will happily "
26671 "handle both types)."
26675 #: ../tools/virt-make-fs.pl:136
26677 "On the other hand, if you have a partition table then the output image is no "
26678 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
26679 "directly on a partitioned disk image. (However libguestfs tools such as "
26680 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
26684 #: ../tools/virt-make-fs.pl:144
26685 msgid "Add an MBR partition:"
26689 #: ../tools/virt-make-fs.pl:146
26692 " virt-make-fs --partition -- input disk.img\n"
26697 #: ../tools/virt-make-fs.pl:148
26699 "If the output disk image could be terabyte-sized or larger, it's better to "
26700 "use an EFI/GPT-compatible partition table:"
26704 #: ../tools/virt-make-fs.pl:151
26707 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
26712 #: ../tools/virt-make-fs.pl:179
26713 msgid "Enable debugging information."
26717 #: ../tools/virt-make-fs.pl:185
26718 msgid "B<--size=E<lt>NE<gt>>"
26722 #: ../tools/virt-make-fs.pl:187
26723 msgid "B<--size=+E<lt>NE<gt>>"
26727 #: ../tools/virt-make-fs.pl:189
26728 msgid "B<-s E<lt>NE<gt>>"
26732 #: ../tools/virt-make-fs.pl:191
26733 msgid "B<-s +E<lt>NE<gt>>"
26737 #: ../tools/virt-make-fs.pl:193
26739 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
26743 #: ../tools/virt-make-fs.pl:196
26745 "If this option is I<not> given, then the output image will be just large "
26746 "enough to contain all the files, with not much wasted space."
26750 #: ../tools/virt-make-fs.pl:199
26752 "To choose a fixed size output disk, specify an absolute number followed by b/"
26753 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
26754 "Petabytes or Exabytes. This must be large enough to contain all the input "
26755 "files, else you will get an error."
26759 #: ../tools/virt-make-fs.pl:204
26761 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
26762 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
26763 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
26764 "the input files, and (approximately) an extra 200 MB free space."
26768 #: ../tools/virt-make-fs.pl:210
26770 "Note that virt-make-fs estimates free space, and therefore will not produce "
26771 "filesystems containing precisely the free space requested. (It is much more "
26772 "expensive and time-consuming to produce a filesystem which has precisely the "
26773 "desired free space)."
26777 #: ../tools/virt-make-fs.pl:219
26778 msgid "B<--format=E<lt>fmtE<gt>>"
26782 #: ../tools/virt-make-fs.pl:221
26783 msgid "B<-F E<lt>fmtE<gt>>"
26787 #: ../tools/virt-make-fs.pl:223
26788 msgid "Choose the output disk image format."
26792 #: ../tools/virt-make-fs.pl:225
26793 msgid "The default is C<raw> (raw disk image)."
26797 #: ../tools/virt-make-fs.pl:227
26799 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
26800 "that would really make sense here is C<qcow2>."
26804 #: ../tools/virt-make-fs.pl:234
26805 msgid "B<--type=E<lt>fsE<gt>>"
26809 #: ../tools/virt-make-fs.pl:236
26810 msgid "B<-t E<lt>fsE<gt>>"
26814 #: ../tools/virt-make-fs.pl:238
26815 msgid "Choose the output filesystem type."
26819 #: ../tools/virt-make-fs.pl:240
26820 msgid "The default is C<ext2>."
26824 #: ../tools/virt-make-fs.pl:242
26826 "Any filesystem which is supported read-write by libguestfs can be used here."
26830 #: ../tools/virt-make-fs.pl:249
26831 msgid "B<--partition>"
26835 #: ../tools/virt-make-fs.pl:251
26836 msgid "B<--partition=E<lt>parttypeE<gt>>"
26840 #: ../tools/virt-make-fs.pl:253
26842 "If specified, this flag adds an MBR partition table to the output disk image."
26846 #: ../tools/virt-make-fs.pl:256
26848 "You can change the partition table type, eg. C<--partition=gpt> for large "
26853 #: ../tools/virt-make-fs.pl:259
26855 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
26856 "might consider the next parameter to be the partition type. For example:"
26860 #: ../tools/virt-make-fs.pl:263
26863 " virt-make-fs --partition input.tar ...\n"
26868 #: ../tools/virt-make-fs.pl:265
26870 "would cause virt-make-fs to think you wanted to use a partition type of "
26871 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
26872 "dash) between options and the input file argument:"
26876 #: ../tools/virt-make-fs.pl:269
26879 " virt-make-fs --partition -- input.tar ...\n"
26884 #: ../tools/virt-make-fs.pl:529
26886 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
26887 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
26888 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
26892 #: ../tools/virt-make-fs.pl:546
26895 " export LIBGUESTFS_DEBUG=1\n"
26896 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
26901 #: ../tools/virt-make-fs.pl:549
26903 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
26908 #: ../tools/virt-list-partitions.pl:32
26910 "virt-list-partitions - List partitions in a virtual machine or disk image"
26914 #: ../tools/virt-list-partitions.pl:36
26917 " virt-list-partitions [--options] domname\n"
26922 #: ../tools/virt-list-partitions.pl:38
26925 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
26930 #: ../tools/virt-list-partitions.pl:42
26932 "C<virt-list-partitions> is a command line tool to list the partitions that "
26933 "are contained in a virtual machine or disk image. It is mainly useful as a "
26934 "first step to using L<virt-resize(1)>."
26938 #: ../tools/virt-list-partitions.pl:47
26940 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
26941 "functionality. For more complex cases you should look at the L<guestfish(1)"
26946 #: ../tools/virt-list-partitions.pl:87
26947 msgid "B<-h> | B<--human-readable>"
26951 #: ../tools/virt-list-partitions.pl:89
26952 msgid "Show sizes in human-readable form (eg. \"1G\")."
26956 #: ../tools/virt-list-partitions.pl:97
26958 "With this option, C<virt-list-partitions> displays the type and size of each "
26959 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
26963 #: ../tools/virt-list-partitions.pl:104
26964 msgid "B<-t> | B<--total>"
26968 #: ../tools/virt-list-partitions.pl:106
26970 "Display the total size of each block device (as a separate row or rows)."
26974 #: ../tools/virt-list-partitions.pl:231
26976 "L<guestfs(3)>, L<guestfish(1)>, L<virt-list-filesystems(1)>, L<virt-resize(1)"
26977 ">, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://"
26978 "libguestfs.org/>."