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-11-08 15:50+0000\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:31 ../tools/virt-edit.pl:30
23 #: ../tools/virt-win-reg.pl:33 ../tools/virt-df.pl:32 ../tools/virt-ls.pl:30
24 #: ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28
25 #: ../tools/virt-cat.pl:29 ../tools/virt-tar.pl:29 ../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:33 ../tools/virt-edit.pl:32
34 #: ../tools/virt-win-reg.pl:35 ../tools/virt-df.pl:34 ../tools/virt-ls.pl:32
35 #: ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30
36 #: ../tools/virt-cat.pl:31 ../tools/virt-tar.pl:31 ../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:37 ../tools/virt-edit.pl:36
50 #: ../tools/virt-win-reg.pl:39 ../tools/virt-df.pl:38 ../tools/virt-ls.pl:36
51 #: ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34
52 #: ../tools/virt-cat.pl:35 ../tools/virt-tar.pl:35 ../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:20
93 #: ../inspector/virt-inspector.pl:43 ../tools/virt-edit.pl:50
94 #: ../tools/virt-win-reg.pl:63 ../tools/virt-df.pl:46 ../tools/virt-ls.pl:42
95 #: ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40
96 #: ../tools/virt-cat.pl:41 ../tools/virt-tar.pl:72 ../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 "The call you should use in modern code for adding drives is L</"
300 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
301 "specifying that the format is raw, do:"
305 #: ../src/guestfs.pod:131
308 " guestfs_add_drive_opts (g, filename,\n"
309 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
315 #: ../src/guestfs.pod:135
316 msgid "You can add a disk read-only using:"
320 #: ../src/guestfs.pod:137
323 " guestfs_add_drive_opts (g, filename,\n"
324 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
325 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
331 #: ../src/guestfs.pod:142
333 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
334 "libguestfs won't modify the file."
338 #: ../src/guestfs.pod:145
340 "Be extremely cautious if the disk image is in use, eg. if it is being used "
341 "by a virtual machine. Adding it read-write will almost certainly cause disk "
342 "corruption, but adding it read-only is safe."
346 #: ../src/guestfs.pod:149
348 "You must add at least one disk image, and you may add multiple disk images. "
349 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
350 "first one you added), C</dev/sdb> (for the second one you added), etc."
354 #: ../src/guestfs.pod:154
356 "Once L</guestfs_launch> has been called you cannot add any more images. You "
357 "can call L</guestfs_list_devices> to get a list of the device names, in the "
358 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
362 #: ../src/guestfs.pod:159
367 #: ../src/guestfs.pod:161
369 "Before you can read or write files, create directories and so on in a disk "
370 "image that contains filesystems, you have to mount those filesystems using "
371 "L</guestfs_mount>. If you already know that a disk image contains (for "
372 "example) one partition with a filesystem on that partition, then you can "
377 #: ../src/guestfs.pod:167
380 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
385 #: ../src/guestfs.pod:169
387 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
388 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
389 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>)."
393 #: ../src/guestfs.pod:173
395 "If you are given a disk image and you don't know what it contains then you "
396 "have to find out. Libguestfs can do that too: use L</"
397 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
398 "LVs, and either try mounting each to see what is mountable, or else examine "
399 "them with L</guestfs_vfs_type> or L</guestfs_file>. Libguestfs also has a "
400 "set of APIs for inspection of disk images (see L</INSPECTION> below). But "
401 "you might find it easier to look at higher level programs built on top of "
402 "libguestfs, in particular L<virt-inspector(1)>."
406 #: ../src/guestfs.pod:183
408 "To mount a disk image read-only, use L</guestfs_mount_ro>. There are "
409 "several other variations of the C<guestfs_mount_*> call."
413 #: ../src/guestfs.pod:186
414 msgid "FILESYSTEM ACCESS AND MODIFICATION"
418 #: ../src/guestfs.pod:188
420 "The majority of the libguestfs API consists of fairly low-level calls for "
421 "accessing and modifying the files, directories, symlinks etc on mounted "
422 "filesystems. There are over a hundred such calls which you can find listed "
423 "in detail below in this man page, and we don't even pretend to cover them "
424 "all in this overview."
428 #: ../src/guestfs.pod:194
430 "Specify filenames as full paths, starting with C<\"/\"> and including the "
435 #: ../src/guestfs.pod:197
437 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
438 "the file called C<\"etc/passwd\"> then you could do:"
442 #: ../src/guestfs.pod:200
445 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
450 #: ../src/guestfs.pod:202
452 "This would return C<data> as a newly allocated buffer containing the full "
453 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
454 "or C<NULL> if there was an error."
458 #: ../src/guestfs.pod:206
460 "As another example, to create a top-level directory on that filesystem "
461 "called C<\"var\"> you would do:"
465 #: ../src/guestfs.pod:209
468 " guestfs_mkdir (g, \"/var\");\n"
473 #: ../src/guestfs.pod:211
474 msgid "To create a symlink you could do:"
478 #: ../src/guestfs.pod:213
481 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
482 " \"/etc/rc3.d/S30portmap\");\n"
487 #: ../src/guestfs.pod:216
489 "Libguestfs will reject attempts to use relative paths and there is no "
490 "concept of a current working directory."
494 #: ../src/guestfs.pod:219
496 "Libguestfs can return errors in many situations: for example if the "
497 "filesystem isn't writable, or if a file or directory that you requested "
498 "doesn't exist. If you are using the C API (documented here) you have to "
499 "check for those error conditions after each call. (Other language bindings "
500 "turn these errors into exceptions)."
504 #: ../src/guestfs.pod:225
506 "File writes are affected by the per-handle umask, set by calling L</"
507 "guestfs_umask> and defaulting to 022. See L</UMASK>."
511 #: ../src/guestfs.pod:228
516 #: ../src/guestfs.pod:230
518 "Libguestfs contains API calls to read, create and modify partition tables on "
523 #: ../src/guestfs.pod:233
525 "In the common case where you want to create a single partition covering the "
526 "whole disk, you should use the L</guestfs_part_disk> call:"
530 #: ../src/guestfs.pod:237
533 " const char *parttype = \"mbr\";\n"
534 " if (disk_is_larger_than_2TB)\n"
535 " parttype = \"gpt\";\n"
536 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
541 #: ../src/guestfs.pod:242
543 "Obviously this effectively wipes anything that was on that disk image before."
547 #: ../src/guestfs.pod:245
552 #: ../src/guestfs.pod:247
554 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
555 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
556 "you familiarize yourself with the concepts of physical volumes, volume "
557 "groups and logical volumes."
561 #: ../src/guestfs.pod:252
563 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
564 "tldp.org/HOWTO/LVM-HOWTO/>."
568 #: ../src/guestfs.pod:255
573 #: ../src/guestfs.pod:257
575 "Use L</guestfs_cat> to download small, text only files. This call is "
576 "limited to files which are less than 2 MB and which cannot contain any ASCII "
577 "NUL (C<\\0>) characters. However it has a very simple to use API."
581 #: ../src/guestfs.pod:262
583 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
584 "bit data, since it returns a (pointer, size) pair. However it is still "
585 "limited to \"small\" files, less than 2 MB."
589 #: ../src/guestfs.pod:266
591 "L</guestfs_download> can be used to download any file, with no limits on "
592 "content or size (even files larger than 4 GB)."
596 #: ../src/guestfs.pod:269
598 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
602 #: ../src/guestfs.pod:272
607 #: ../src/guestfs.pod:274
609 "It's often the case that you want to write a file or files to the disk image."
613 #: ../src/guestfs.pod:277
615 "To write a small file with fixed content, use L</guestfs_write>. To create "
616 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
617 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
618 "of other functions for creating test files, for example L</guestfs_fill> and "
619 "L</guestfs_fill_pattern>."
623 #: ../src/guestfs.pod:283
625 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
626 "file content or size (even files larger than 4 GB)."
630 #: ../src/guestfs.pod:286
632 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
636 #: ../src/guestfs.pod:288
638 "However the fastest way to upload I<large numbers of arbitrary files> is to "
639 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
640 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
641 "in a predictable way (eg. adding it last after all other drives) then you "
642 "can get the device name from L</guestfs_list_devices> and mount it directly "
643 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
644 "portable between kernel versions, and they don't support labels or UUIDs. "
645 "If you want to pre-build an image or you need to mount it using a label or "
646 "UUID, use an ISO image instead."
650 #: ../src/guestfs.pod:299
655 #: ../src/guestfs.pod:301
657 "There are various different commands for copying between files and devices "
658 "and in and out of the guest filesystem. These are summarised in the table "
663 #: ../src/guestfs.pod:307
664 msgid "B<file> to B<file>"
668 #: ../src/guestfs.pod:309
670 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
671 "directories recursively."
675 #: ../src/guestfs.pod:312
676 msgid "B<file or device> to B<file or device>"
680 #: ../src/guestfs.pod:314
682 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
683 "devices in the guest."
687 #: ../src/guestfs.pod:317
688 msgid "Example: duplicate the contents of an LV:"
692 #: ../src/guestfs.pod:319
695 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
700 #: ../src/guestfs.pod:321
702 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
703 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
704 "guestfs_copy_size>."
708 #: ../src/guestfs.pod:325
709 msgid "B<file on the host> to B<file or device>"
713 #: ../src/guestfs.pod:327
714 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
718 #: ../src/guestfs.pod:329
719 msgid "B<file or device> to B<file on the host>"
723 #: ../src/guestfs.pod:331
724 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
728 #: ../src/guestfs.pod:335
729 msgid "LISTING FILES"
733 #: ../src/guestfs.pod:337
735 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
736 "L<guestfish(1)>-equivalent command C<ll>)."
740 #: ../src/guestfs.pod:340
742 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
743 "programs, as a flat list of strings."
747 #: ../src/guestfs.pod:343
749 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
750 "directory, plus additional information about each one. It is more "
751 "equivalent to using the L<readdir(3)> call on a local filesystem."
755 #: ../src/guestfs.pod:347
757 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
761 #: ../src/guestfs.pod:350
762 msgid "RUNNING COMMANDS"
766 #: ../src/guestfs.pod:352
768 "Although libguestfs is primarily an API for manipulating files inside guest "
769 "images, we also provide some limited facilities for running commands inside "
774 #: ../src/guestfs.pod:356
775 msgid "There are many limitations to this:"
779 #: ../src/guestfs.pod:360 ../src/guestfs.pod:365 ../src/guestfs.pod:370
780 #: ../src/guestfs.pod:374 ../src/guestfs.pod:379 ../src/guestfs.pod:383
781 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:1224
782 #: ../src/guestfs.pod:1229 ../src/guestfs.pod:1233 ../src/guestfs.pod:1449
783 #: ../src/guestfs.pod:1454 ../src/guestfs.pod:1458 ../src/guestfs.pod:1560
784 #: ../src/guestfs.pod:1564 ../src/guestfs.pod:1568 ../src/guestfs.pod:1573
785 #: ../src/guestfs.pod:1581 ../src/guestfs.pod:1600 ../src/guestfs.pod:1608
786 #: ../src/guestfs.pod:1838 ../src/guestfs.pod:1844 ../src/guestfs.pod:1849
787 #: ../src/guestfs.pod:1855 ../src/guestfs.pod:1962 ../src/guestfs.pod:1966
788 #: ../src/guestfs.pod:1970 ../src/guestfs.pod:1974
789 #: ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22
790 #: ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:509
791 #: ../src/guestfs-actions.pod:516 ../src/guestfs-actions.pod:523
792 #: ../src/guestfs-actions.pod:1558 ../src/guestfs-actions.pod:1562
793 #: ../src/guestfs-actions.pod:1566 ../src/guestfs-actions.pod:1570
794 #: ../src/guestfs-actions.pod:1578 ../src/guestfs-actions.pod:1582
795 #: ../src/guestfs-actions.pod:1586 ../src/guestfs-actions.pod:1596
796 #: ../src/guestfs-actions.pod:1600 ../src/guestfs-actions.pod:1604
797 #: ../src/guestfs-actions.pod:1742 ../src/guestfs-actions.pod:1746
798 #: ../src/guestfs-actions.pod:1751 ../src/guestfs-actions.pod:1756
799 #: ../src/guestfs-actions.pod:1817 ../src/guestfs-actions.pod:1821
800 #: ../src/guestfs-actions.pod:1826 ../fish/guestfish.pod:376
801 #: ../fish/guestfish.pod:380 ../fish/guestfish.pod:384
802 #: ../fish/guestfish.pod:388 ../fish/guestfish-actions.pod:13
803 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:339
804 #: ../fish/guestfish-actions.pod:347 ../fish/guestfish-actions.pod:354
805 #: ../fish/guestfish-actions.pod:361 ../fish/guestfish-actions.pod:1056
806 #: ../fish/guestfish-actions.pod:1060 ../fish/guestfish-actions.pod:1064
807 #: ../fish/guestfish-actions.pod:1068 ../fish/guestfish-actions.pod:1076
808 #: ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084
809 #: ../fish/guestfish-actions.pod:1094 ../fish/guestfish-actions.pod:1098
810 #: ../fish/guestfish-actions.pod:1102 ../fish/guestfish-actions.pod:1192
811 #: ../fish/guestfish-actions.pod:1196 ../fish/guestfish-actions.pod:1201
812 #: ../fish/guestfish-actions.pod:1206 ../fish/guestfish-actions.pod:1248
813 #: ../fish/guestfish-actions.pod:1252 ../fish/guestfish-actions.pod:1257
814 #: ../inspector/virt-inspector.pl:584 ../inspector/virt-inspector.pl:588
815 #: ../tools/virt-df.pl:161 ../tools/virt-df.pl:167 ../tools/virt-resize.pl:348
816 #: ../tools/virt-resize.pl:353 ../tools/virt-resize.pl:363
821 #: ../src/guestfs.pod:362
823 "The kernel version that the command runs under will be different from what "
828 #: ../src/guestfs.pod:367
830 "If the command needs to communicate with daemons, then most likely they "
835 #: ../src/guestfs.pod:372
836 msgid "The command will be running in limited memory."
840 #: ../src/guestfs.pod:376
842 "The network may not be available unless you enable it (see L</"
843 "guestfs_set_network>)."
847 #: ../src/guestfs.pod:381
848 msgid "Only supports Linux guests (not Windows, BSD, etc)."
852 #: ../src/guestfs.pod:385
854 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
858 #: ../src/guestfs.pod:390
860 "For SELinux guests, you may need to enable SELinux and load policy first. "
861 "See L</SELINUX> in this manpage."
865 #: ../src/guestfs.pod:395
867 "I<Security:> It is not safe to run commands from untrusted, possibly "
868 "malicious guests. These commands may attempt to exploit your program by "
869 "sending unexpected output. They could also try to exploit the Linux kernel "
870 "or qemu provided by the libguestfs appliance. They could use the network "
871 "provided by the libguestfs appliance to bypass ordinary network partitions "
872 "and firewalls. They could use the elevated privileges or different SELinux "
873 "context of your program to their advantage."
877 #: ../src/guestfs.pod:404
879 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
880 "(a script which runs when the guest next boots normally), and to have this "
881 "script run the commands you want in the normal context of the running guest, "
882 "network security and so on."
886 #: ../src/guestfs.pod:411
888 "The two main API calls to run commands are L</guestfs_command> and L</"
889 "guestfs_sh> (there are also variations)."
893 #: ../src/guestfs.pod:414
895 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
896 "shell globs, redirections, etc will work."
900 #: ../src/guestfs.pod:417
901 msgid "CONFIGURATION FILES"
905 #: ../src/guestfs.pod:419
907 "To read and write configuration files in Linux guest filesystems, we "
908 "strongly recommend using Augeas. For example, Augeas understands how to "
909 "read and write, say, a Linux shadow password file or X.org configuration "
910 "file, and so avoids you having to write that code."
914 #: ../src/guestfs.pod:424
916 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
917 "document Augeas itself here because there is excellent documentation on the "
918 "L<http://augeas.net/> website."
922 #: ../src/guestfs.pod:428
924 "If you don't want to use Augeas (you fool!) then try calling L</"
925 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
930 #: ../src/guestfs.pod:432
935 #: ../src/guestfs.pod:434
937 "We support SELinux guests. To ensure that labeling happens correctly in "
938 "SELinux guests, you need to enable SELinux and load the guest's policy:"
942 #: ../src/guestfs.pod:440 ../src/guestfs.pod:953
947 #: ../src/guestfs.pod:442
948 msgid "Before launching, do:"
952 #: ../src/guestfs.pod:444
955 " guestfs_set_selinux (g, 1);\n"
960 #: ../src/guestfs.pod:446 ../src/guestfs.pod:957
965 #: ../src/guestfs.pod:448
967 "After mounting the guest's filesystem(s), load the policy. This is best "
968 "done by running the L<load_policy(8)> command in the guest itself:"
972 #: ../src/guestfs.pod:452
975 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
980 #: ../src/guestfs.pod:454
982 "(Older versions of C<load_policy> require you to specify the name of the "
987 #: ../src/guestfs.pod:457 ../src/guestfs.pod:963
992 #: ../src/guestfs.pod:459
994 "Optionally, set the security context for the API. The correct security "
995 "context to use can only be known by inspecting the guest. As an example:"
999 #: ../src/guestfs.pod:463
1002 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1007 #: ../src/guestfs.pod:467
1008 msgid "This will work for running commands and editing existing files."
1012 #: ../src/guestfs.pod:469
1014 "When new files are created, you may need to label them explicitly, for "
1015 "example by running the external command C<restorecon pathname>."
1019 #: ../src/guestfs.pod:473
1024 #: ../src/guestfs.pod:475
1026 "Certain calls are affected by the current file mode creation mask (the "
1027 "\"umask\"). In particular ones which create files or directories, such as "
1028 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1029 "either the default mode that the file is created with or modifies the mode "
1034 #: ../src/guestfs.pod:481
1036 "The default umask is C<022>, so files are created with modes such as C<0644> "
1037 "and directories with C<0755>."
1041 #: ../src/guestfs.pod:484
1043 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1044 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1045 "guestfs_chmod> after creating each file or directory."
1049 #: ../src/guestfs.pod:488
1050 msgid "For more information about umask, see L<umask(2)>."
1054 #: ../src/guestfs.pod:490 ../fish/guestfish.pod:669
1055 msgid "ENCRYPTED DISKS"
1059 #: ../src/guestfs.pod:492
1061 "Libguestfs allows you to access Linux guests which have been encrypted using "
1062 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1063 "standard. This includes nearly all whole disk encryption systems used by "
1064 "modern Linux guests."
1068 #: ../src/guestfs.pod:498
1070 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1071 "returns the string C<crypto_LUKS>)."
1075 #: ../src/guestfs.pod:501
1077 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1078 "will require the passphrase!"
1082 #: ../src/guestfs.pod:504
1084 "Opening a LUKS device creates a new device mapper device called C</dev/"
1085 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1086 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1087 "from and encrypted to the underlying block device respectively."
1091 #: ../src/guestfs.pod:510
1093 "LVM volume groups on the device can be made visible by calling L</"
1094 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1095 "(s) can now be mounted in the usual way."
1099 #: ../src/guestfs.pod:514
1101 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1102 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1103 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1104 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1105 "underlying encrypted block device)."
1109 #: ../src/guestfs.pod:521
1114 #: ../src/guestfs.pod:523
1116 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1117 "contains operating systems. (These APIs used to be in a separate Perl-only "
1118 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1119 "frequently used part of this library has been rewritten in C and moved into "
1124 #: ../src/guestfs.pod:529
1126 "Add all disks belonging to the unknown virtual machine and call L</"
1127 "guestfs_launch> in the usual way."
1131 #: ../src/guestfs.pod:532
1133 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1134 "and certain heuristics, and returns a list of operating systems that were "
1135 "found. An empty list means none were found. A single element is the root "
1136 "filesystem of the operating system. For dual- or multi-boot guests, "
1137 "multiple roots can be returned, each one corresponding to a separate "
1138 "operating system. (Multi-boot virtual machines are extremely rare in the "
1139 "world of virtualization, but since this scenario can happen, we have built "
1140 "libguestfs to deal with it.)"
1144 #: ../src/guestfs.pod:541
1146 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1147 "to get additional details about that operating system. For example, call L</"
1148 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1149 "Windows and Linux-based operating systems respectively."
1153 #: ../src/guestfs.pod:547
1155 "Un*x-like and Linux-based operating systems usually consist of several "
1156 "filesystems which are mounted at boot time (for example, a separate boot "
1157 "partition mounted on C</boot>). The inspection rules are able to detect how "
1158 "filesystems correspond to mount points. Call "
1159 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1160 "hash table like this example:"
1164 #: ../src/guestfs.pod:554
1167 " /boot => /dev/sda1\n"
1168 " / => /dev/vg_guest/lv_root\n"
1169 " /usr => /dev/vg_guest/lv_usr\n"
1174 #: ../src/guestfs.pod:558
1176 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1177 "filesystems as suggested."
1181 #: ../src/guestfs.pod:561
1183 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1184 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1188 #: ../src/guestfs.pod:565
1190 "Inspection currently only works for some common operating systems. "
1191 "Contributors are welcome to send patches for other operating systems that we "
1192 "currently cannot detect."
1196 #: ../src/guestfs.pod:569
1198 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1199 "for more details. The L</guestfs_inspect_os> function just ignores any "
1200 "encrypted devices."
1204 #: ../src/guestfs.pod:573
1206 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1207 "inspection and caches the results in the guest handle. Subsequent calls to "
1208 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1209 "read the disks. If you change the content of the guest disks, you can redo "
1210 "inspection by calling L</guestfs_inspect_os> again."
1214 #: ../src/guestfs.pod:580
1215 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1219 #: ../src/guestfs.pod:582
1221 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1222 "ntfs-3g.org/> driver."
1226 #: ../src/guestfs.pod:585
1228 "DOS and Windows still use drive letters, and the filesystems are always "
1229 "treated as case insensitive by Windows itself, and therefore you might find "
1230 "a Windows configuration file referring to a path like C<c:\\windows"
1231 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1232 "might be referred to as C</WINDOWS/System32>."
1236 #: ../src/guestfs.pod:591
1238 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1239 "libguestfs to read the appropriate Windows Registry and configuration files, "
1240 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1245 #: ../src/guestfs.pod:596
1247 "Replacing backslash characters with forward slash characters is also outside "
1248 "the scope of libguestfs, but something that you can easily do."
1252 #: ../src/guestfs.pod:599
1254 "Where we can help is in resolving the case insensitivity of paths. For "
1255 "this, call L</guestfs_case_sensitive_path>."
1259 #: ../src/guestfs.pod:602
1261 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1262 "files, through the library C<hivex> which is part of the libguestfs project "
1263 "although ships as a separate tarball. You have to locate and download the "
1264 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1265 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1266 "reg(1)> for more help on this issue."
1270 #: ../src/guestfs.pod:610
1271 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1275 #: ../src/guestfs.pod:612
1277 "Although we don't want to discourage you from using the C API, we will "
1278 "mention here that the same API is also available in other languages."
1282 #: ../src/guestfs.pod:615
1284 "The API is broadly identical in all supported languages. This means that "
1285 "the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, C<g."
1286 "mount(path)> in Python, and C<Guestfs.mount g path> in OCaml. In other "
1287 "words, a straightforward, predictable isomorphism between each language."
1291 #: ../src/guestfs.pod:621
1293 "Error messages are automatically transformed into exceptions if the language "
1298 #: ../src/guestfs.pod:624
1300 "We don't try to \"object orientify\" parts of the API in OO languages, "
1301 "although contributors are welcome to write higher level APIs above what we "
1302 "provide in their favourite languages if they wish."
1306 #: ../src/guestfs.pod:630
1311 #: ../src/guestfs.pod:632
1313 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1314 "identical to the C API. C++ classes and exceptions are not used."
1318 #: ../src/guestfs.pod:636
1323 #: ../src/guestfs.pod:638
1325 "The C# bindings are highly experimental. Please read the warnings at the "
1326 "top of C<csharp/Libguestfs.cs>."
1330 #: ../src/guestfs.pod:641
1335 #: ../src/guestfs.pod:643
1337 "This is the only language binding that is working but incomplete. Only "
1338 "calls which return simple integers have been bound in Haskell, and we are "
1339 "looking for help to complete this binding."
1343 #: ../src/guestfs.pod:647
1348 #: ../src/guestfs.pod:649
1350 "Full documentation is contained in the Javadoc which is distributed with "
1355 #: ../src/guestfs.pod:652
1360 #: ../src/guestfs.pod:654
1361 msgid "For documentation see the file C<guestfs.mli>."
1365 #: ../src/guestfs.pod:656
1370 #: ../src/guestfs.pod:658
1371 msgid "For documentation see L<Sys::Guestfs(3)>."
1375 #: ../src/guestfs.pod:660
1380 #: ../src/guestfs.pod:662
1382 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1383 "the php-libguestfs package for your distribution."
1387 #: ../src/guestfs.pod:665
1388 msgid "The PHP binding only works correctly on 64 bit machines."
1392 #: ../src/guestfs.pod:667
1397 #: ../src/guestfs.pod:669
1398 msgid "For documentation do:"
1402 #: ../src/guestfs.pod:671
1406 " >>> import guestfs\n"
1407 " >>> help (guestfs)\n"
1412 #: ../src/guestfs.pod:675
1417 #: ../src/guestfs.pod:677
1419 "Use the Guestfs module. There is no Ruby-specific documentation, but you "
1420 "can find examples written in Ruby in the libguestfs source."
1424 #: ../src/guestfs.pod:680
1425 msgid "B<shell scripts>"
1429 #: ../src/guestfs.pod:682
1430 msgid "For documentation see L<guestfish(1)>."
1434 #: ../src/guestfs.pod:686
1435 msgid "LIBGUESTFS GOTCHAS"
1439 #: ../src/guestfs.pod:688
1441 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1442 "system [...] that works in the way it is documented but is counterintuitive "
1443 "and almost invites mistakes.\""
1447 #: ../src/guestfs.pod:692
1449 "Since we developed libguestfs and the associated tools, there are several "
1450 "things we would have designed differently, but are now stuck with for "
1451 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1452 "release, you can expect these to change. Beware of them."
1456 #: ../src/guestfs.pod:700
1457 msgid "Autosync / forgetting to sync."
1461 #: ../src/guestfs.pod:702
1463 "When modifying a filesystem from C or another language, you B<must> unmount "
1464 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1465 "libguestfs handle. You can also call:"
1469 #: ../src/guestfs.pod:706
1472 " guestfs_set_autosync (g, 1);\n"
1477 #: ../src/guestfs.pod:708
1479 "to have the unmount/sync done automatically for you when the handle 'g' is "
1480 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1484 #: ../src/guestfs.pod:712
1486 "If you forget to do this, then it is entirely possible that your changes "
1487 "won't be written out, or will be partially written, or (very rarely) that "
1488 "you'll get disk corruption."
1492 #: ../src/guestfs.pod:716
1494 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1495 "guestfish scripts that forget to sync will work just fine, which can make "
1496 "this very puzzling if you are trying to debug a problem."
1500 #: ../src/guestfs.pod:720
1502 "Update: Autosync is enabled by default for all API users starting from "
1503 "libguestfs 1.5.24."
1507 #: ../src/guestfs.pod:723
1508 msgid "Mount option C<-o sync> should not be the default."
1512 #: ../src/guestfs.pod:725
1514 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1515 "However C<-o sync> does not add any reliability benefit, but does have a "
1516 "very large performance impact."
1520 #: ../src/guestfs.pod:729
1522 "The work around is to use L</guestfs_mount_options> and set the mount "
1523 "options that you actually want to use."
1527 #: ../src/guestfs.pod:732
1528 msgid "Read-only should be the default."
1532 #: ../src/guestfs.pod:734
1534 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1535 "specify I<--rw> if you want to make changes to the image."
1539 #: ../src/guestfs.pod:737
1540 msgid "This would reduce the potential to corrupt live VM images."
1544 #: ../src/guestfs.pod:739
1546 "Note that many filesystems change the disk when you just mount and unmount, "
1547 "even if you didn't perform any writes. You need to use L</"
1548 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1552 #: ../src/guestfs.pod:743
1553 msgid "guestfish command line is hard to use."
1557 #: ../src/guestfs.pod:745
1559 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1560 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1561 "exist, so it fails. In earlier versions of guestfish the error message was "
1562 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1563 "we should have used C<guestfish -c command> to run commands."
1567 #: ../src/guestfs.pod:752
1568 msgid "guestfish megabyte modifiers don't work right on all commands"
1572 #: ../src/guestfs.pod:754
1574 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1575 "other modifiers). What guestfish actually does is to multiply the number "
1576 "part by the modifier part and pass the result to the C API. However this "
1577 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1578 "expecting some other unit (eg. megabytes)."
1582 #: ../src/guestfs.pod:761
1583 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1587 #: ../src/guestfs.pod:763
1590 " lvcreate LV VG 100M\n"
1595 #: ../src/guestfs.pod:765
1597 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1598 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1599 "megabytes * megabytes) logical volume. The error message you get from this "
1600 "is also a little obscure."
1604 #: ../src/guestfs.pod:770
1606 "This could be fixed in the generator by specially marking parameters and "
1607 "return values which take bytes or other units."
1611 #: ../src/guestfs.pod:773
1612 msgid "Ambiguity between devices and paths"
1616 #: ../src/guestfs.pod:775
1618 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1619 "sdb2>) and a similar pathname. A file might just happen to be called "
1620 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1624 #: ../src/guestfs.pod:780
1626 "In the current API we usually resolve this ambiguity by having two separate "
1627 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1628 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1629 "detecting if the path supplied begins with C</dev/>."
1633 #: ../src/guestfs.pod:786
1635 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1636 "make paths/devices into structured names. One way to do this would be to "
1637 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1638 "aspect of grub. Another way would be to use a structured type, equivalent "
1639 "to this OCaml type:"
1643 #: ../src/guestfs.pod:792
1646 " type path = Path of string | Device of int | Partition of int * int\n"
1651 #: ../src/guestfs.pod:794
1652 msgid "which would allow you to pass arguments like:"
1656 #: ../src/guestfs.pod:796
1659 " Path \"/foo/bar\"\n"
1660 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1661 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1662 " Path \"/dev/sdb2\" (* not a device *)\n"
1667 #: ../src/guestfs.pod:801
1669 "As you can see there are still problems to resolve even with this "
1670 "representation. Also consider how it might work in guestfish."
1674 #: ../src/guestfs.pod:806
1675 msgid "PROTOCOL LIMITS"
1679 #: ../src/guestfs.pod:808
1681 "Internally libguestfs uses a message-based protocol to pass API calls and "
1682 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1683 "plenty more detail about this). The maximum message size used by the "
1684 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1685 "aware of this limit. The API calls which may be affected are individually "
1686 "documented, with a link back to this section of the documentation."
1690 #: ../src/guestfs.pod:816
1692 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1693 "a simple string. Because this string is at some point internally encoded as "
1694 "a message, the maximum size that it can return is slightly under 4 MB. If "
1695 "the requested file is larger than this then you will get an error."
1699 #: ../src/guestfs.pod:822
1701 "In order to transfer large files into and out of the guest filesystem, you "
1702 "need to use particular calls that support this. The sections L</UPLOADING> "
1703 "and L</DOWNLOADING> document how to do this."
1707 #: ../src/guestfs.pod:826
1709 "You might also consider mounting the disk image using our FUSE filesystem "
1710 "support (L<guestmount(1)>)."
1714 #: ../src/guestfs.pod:829
1715 msgid "KEYS AND PASSPHRASES"
1719 #: ../src/guestfs.pod:831
1721 "Certain libguestfs calls take a parameter that contains sensitive key "
1722 "material, passed in as a C string."
1726 #: ../src/guestfs.pod:834
1728 "In the future we would hope to change the libguestfs implementation so that "
1729 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1730 "swap. However this is I<not> done at the moment, because of the complexity "
1731 "of such an implementation."
1735 #: ../src/guestfs.pod:839
1737 "Therefore you should be aware that any key parameter you pass to libguestfs "
1738 "might end up being written out to the swap partition. If this is a concern, "
1739 "scrub the swap partition or don't use libguestfs on encrypted devices."
1743 #: ../src/guestfs.pod:844
1744 msgid "CONNECTION MANAGEMENT"
1748 #: ../src/guestfs.pod:846
1753 #: ../src/guestfs.pod:848
1755 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
1756 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
1757 "handle and release all resources used."
1761 #: ../src/guestfs.pod:852
1763 "For information on using multiple handles and threads, see the section L</"
1764 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
1768 #: ../src/guestfs.pod:855
1769 msgid "guestfs_create"
1773 #: ../src/guestfs.pod:857
1776 " guestfs_h *guestfs_create (void);\n"
1781 #: ../src/guestfs.pod:859
1782 msgid "Create a connection handle."
1786 #: ../src/guestfs.pod:861
1788 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
1789 "on the handle at least once."
1793 #: ../src/guestfs.pod:864
1795 "This function returns a non-NULL pointer to a handle on success or NULL on "
1800 #: ../src/guestfs.pod:867
1801 msgid "After configuring the handle, you have to call L</guestfs_launch>."
1805 #: ../src/guestfs.pod:869
1807 "You may also want to configure error handling for the handle. See L</ERROR "
1808 "HANDLING> section below."
1812 #: ../src/guestfs.pod:872
1813 msgid "guestfs_close"
1817 #: ../src/guestfs.pod:874
1820 " void guestfs_close (guestfs_h *g);\n"
1825 #: ../src/guestfs.pod:876
1826 msgid "This closes the connection handle and frees up all resources used."
1830 #: ../src/guestfs.pod:878
1831 msgid "ERROR HANDLING"
1835 #: ../src/guestfs.pod:880
1837 "API functions can return errors. For example, almost all functions that "
1838 "return C<int> will return C<-1> to indicate an error."
1842 #: ../src/guestfs.pod:883
1844 "Additional information is available for errors: an error message string and "
1845 "optionally an error number (errno) if the thing that failed was a system "
1850 #: ../src/guestfs.pod:887
1852 "You can get at the additional information about the last error on the handle "
1853 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
1854 "up an error handler with L</guestfs_set_error_handler>."
1858 #: ../src/guestfs.pod:892
1860 "When the handle is created, a default error handler is installed which "
1861 "prints the error message string to C<stderr>. For small short-running "
1862 "command line programs it is sufficient to do:"
1866 #: ../src/guestfs.pod:896
1869 " if (guestfs_launch (g) == -1)\n"
1870 " exit (EXIT_FAILURE);\n"
1875 #: ../src/guestfs.pod:899
1877 "since the default error handler will ensure that an error message has been "
1878 "printed to C<stderr> before the program exits."
1882 #: ../src/guestfs.pod:902
1884 "For other programs the caller will almost certainly want to install an "
1885 "alternate error handler or do error handling in-line like this:"
1889 #: ../src/guestfs.pod:905
1892 " g = guestfs_create ();\n"
1897 #: ../src/guestfs.pod:907
1900 " /* This disables the default behaviour of printing errors\n"
1902 " guestfs_set_error_handler (g, NULL, NULL);\n"
1907 #: ../src/guestfs.pod:911
1910 " if (guestfs_launch (g) == -1) {\n"
1911 " /* Examine the error message and print it etc. */\n"
1912 " char *msg = guestfs_last_error (g);\n"
1913 " int errnum = guestfs_last_errno (g);\n"
1914 " fprintf (stderr, \"%s\\n\", msg);\n"
1921 #: ../src/guestfs.pod:919
1923 "Out of memory errors are handled differently. The default action is to call "
1924 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
1925 "guestfs_set_out_of_memory_handler>."
1929 #: ../src/guestfs.pod:923
1931 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
1932 "because there is no handle if this happens there is no way to get additional "
1933 "error information. However L</guestfs_create> is supposed to be a "
1934 "lightweight operation which can only fail because of insufficient memory (it "
1935 "returns NULL in this case)."
1939 #: ../src/guestfs.pod:929
1940 msgid "guestfs_last_error"
1944 #: ../src/guestfs.pod:931
1947 " const char *guestfs_last_error (guestfs_h *g);\n"
1952 #: ../src/guestfs.pod:933
1954 "This returns the last error message that happened on C<g>. If there has not "
1955 "been an error since the handle was created, then this returns C<NULL>."
1959 #: ../src/guestfs.pod:937
1961 "The lifetime of the returned string is until the next error occurs, or L</"
1962 "guestfs_close> is called."
1966 #: ../src/guestfs.pod:940
1967 msgid "guestfs_last_errno"
1971 #: ../src/guestfs.pod:942
1974 " int guestfs_last_errno (guestfs_h *g);\n"
1979 #: ../src/guestfs.pod:944
1980 msgid "This returns the last error number (errno) that happened on C<g>."
1984 #: ../src/guestfs.pod:946
1985 msgid "If successful, an errno integer not equal to zero is returned."
1989 #: ../src/guestfs.pod:948
1991 "If no error, this returns 0. This call can return 0 in three situations:"
1995 #: ../src/guestfs.pod:955
1996 msgid "There has not been any error on the handle."
2000 #: ../src/guestfs.pod:959
2002 "There has been an error but the errno was meaningless. This corresponds to "
2003 "the case where the error did not come from a failed system call, but for "
2004 "some other reason."
2008 #: ../src/guestfs.pod:965
2010 "There was an error from a failed system call, but for some reason the errno "
2011 "was not captured and returned. This usually indicates a bug in libguestfs."
2015 #: ../src/guestfs.pod:971
2017 "Libguestfs tries to convert the errno from inside the applicance into a "
2018 "corresponding errno for the caller (not entirely trivial: the appliance "
2019 "might be running a completely different operating system from the library "
2020 "and error numbers are not standardized across Un*xen). If this could not be "
2021 "done, then the error is translated to C<EINVAL>. In practice this should "
2022 "only happen in very rare circumstances."
2026 #: ../src/guestfs.pod:979
2027 msgid "guestfs_set_error_handler"
2031 #: ../src/guestfs.pod:981
2034 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2036 " const char *msg);\n"
2037 " void guestfs_set_error_handler (guestfs_h *g,\n"
2038 " guestfs_error_handler_cb cb,\n"
2044 #: ../src/guestfs.pod:988
2046 "The callback C<cb> will be called if there is an error. The parameters "
2047 "passed to the callback are an opaque data pointer and the error message "
2052 #: ../src/guestfs.pod:992
2054 "C<errno> is not passed to the callback. To get that the callback must call "
2055 "L</guestfs_last_errno>."
2059 #: ../src/guestfs.pod:995
2061 "Note that the message string C<msg> is freed as soon as the callback "
2062 "function returns, so if you want to stash it somewhere you must make your "
2067 #: ../src/guestfs.pod:999
2068 msgid "The default handler prints messages on C<stderr>."
2072 #: ../src/guestfs.pod:1001
2073 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2077 #: ../src/guestfs.pod:1003
2078 msgid "guestfs_get_error_handler"
2082 #: ../src/guestfs.pod:1005
2085 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2086 " void **opaque_rtn);\n"
2091 #: ../src/guestfs.pod:1008
2092 msgid "Returns the current error handler callback."
2096 #: ../src/guestfs.pod:1010
2097 msgid "guestfs_set_out_of_memory_handler"
2101 #: ../src/guestfs.pod:1012
2104 " typedef void (*guestfs_abort_cb) (void);\n"
2105 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2106 " guestfs_abort_cb);\n"
2111 #: ../src/guestfs.pod:1016
2113 "The callback C<cb> will be called if there is an out of memory situation. "
2114 "I<Note this callback must not return>."
2118 #: ../src/guestfs.pod:1019
2119 msgid "The default is to call L<abort(3)>."
2123 #: ../src/guestfs.pod:1021
2125 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2129 #: ../src/guestfs.pod:1024
2130 msgid "guestfs_get_out_of_memory_handler"
2134 #: ../src/guestfs.pod:1026
2137 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2142 #: ../src/guestfs.pod:1028
2143 msgid "This returns the current out of memory handler."
2147 #: ../src/guestfs.pod:1030
2152 #: ../src/guestfs.pod:1032
2154 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
2159 #: ../src/guestfs.pod:1035
2161 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
2162 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2166 #: ../src/guestfs.pod:1038
2168 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2169 "to change the directories that libguestfs will search in. The value is a "
2170 "colon-separated list of paths. The current directory is I<not> searched "
2171 "unless the path contains an empty element or C<.>. For example "
2172 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2173 "then C</usr/lib/guestfs>."
2177 #: ../src/guestfs.pod:1045
2178 msgid "HIGH-LEVEL API ACTIONS"
2182 #: ../src/guestfs.pod:1047
2183 msgid "ABI GUARANTEE"
2187 #: ../src/guestfs.pod:1049
2189 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2190 "actions as outlined in this section. Although we will deprecate some "
2191 "actions, for example if they get replaced by newer calls, we will keep the "
2192 "old actions forever. This allows you the developer to program in confidence "
2193 "against the libguestfs API."
2197 #: ../src/guestfs.pod:1055 ../fish/guestfish.pod:907
2202 #: ../src/guestfs.pod:1057
2207 #: ../src/guestfs.pod:1059
2212 #: ../src/guestfs.pod:1061
2213 msgid "AVAILABILITY"
2217 #: ../src/guestfs.pod:1063
2218 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2222 #: ../src/guestfs.pod:1065
2224 "Using L</guestfs_available> you can test availability of the following "
2225 "groups of functions. This test queries the appliance to see if the "
2226 "appliance you are currently using supports the functionality."
2230 #: ../src/guestfs.pod:1070
2231 msgid "@AVAILABILITY@"
2235 #: ../src/guestfs.pod:1072
2236 msgid "GUESTFISH supported COMMAND"
2240 #: ../src/guestfs.pod:1074
2242 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2243 "prints out the available groups and whether they are supported by this build "
2244 "of libguestfs. Note however that you have to do C<run> first."
2248 #: ../src/guestfs.pod:1079
2249 msgid "SINGLE CALLS AT COMPILE TIME"
2253 #: ../src/guestfs.pod:1081
2255 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2256 "function, such as:"
2260 #: ../src/guestfs.pod:1084
2263 " #define LIBGUESTFS_HAVE_DD 1\n"
2268 #: ../src/guestfs.pod:1086
2269 msgid "if L</guestfs_dd> is available."
2273 #: ../src/guestfs.pod:1088
2275 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2276 "function is available at compile time, we recommended using build tools such "
2277 "as autoconf or cmake. For example in autotools you could use:"
2281 #: ../src/guestfs.pod:1093
2284 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2285 " AC_CHECK_FUNCS([guestfs_dd])\n"
2290 #: ../src/guestfs.pod:1096
2292 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2297 #: ../src/guestfs.pod:1099
2298 msgid "SINGLE CALLS AT RUN TIME"
2302 #: ../src/guestfs.pod:1101
2304 "Testing at compile time doesn't guarantee that a function really exists in "
2305 "the library. The reason is that you might be dynamically linked against a "
2306 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2307 "This situation unfortunately results in a segmentation fault, which is a "
2308 "shortcoming of the C dynamic linking system itself."
2312 #: ../src/guestfs.pod:1108
2314 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2315 "in this example program (note that you still need the compile time check as "
2320 #: ../src/guestfs.pod:1112
2323 " #include <stdio.h>\n"
2324 " #include <stdlib.h>\n"
2325 " #include <unistd.h>\n"
2326 " #include <dlfcn.h>\n"
2327 " #include <guestfs.h>\n"
2332 #: ../src/guestfs.pod:1118
2337 " #ifdef LIBGUESTFS_HAVE_DD\n"
2339 " int has_function;\n"
2344 #: ../src/guestfs.pod:1124
2347 " /* Test if the function guestfs_dd is really available. */\n"
2348 " dl = dlopen (NULL, RTLD_LAZY);\n"
2350 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2351 " exit (EXIT_FAILURE);\n"
2353 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2359 #: ../src/guestfs.pod:1133
2362 " if (!has_function)\n"
2363 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2365 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2366 " /* Now it's safe to call\n"
2367 " guestfs_dd (g, \"foo\", \"bar\");\n"
2371 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2378 #: ../src/guestfs.pod:1146
2380 "You may think the above is an awful lot of hassle, and it is. There are "
2381 "other ways outside of the C linking system to ensure that this kind of "
2382 "incompatibility never arises, such as using package versioning:"
2386 #: ../src/guestfs.pod:1151
2389 " Requires: libguestfs >= 1.0.80\n"
2394 #: ../src/guestfs.pod:1153
2395 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2399 #: ../src/guestfs.pod:1155
2401 "A recent feature of the API is the introduction of calls which take optional "
2402 "arguments. In C these are declared 3 ways. The main way is as a call which "
2403 "takes variable arguments (ie. C<...>), as in this example:"
2407 #: ../src/guestfs.pod:1160
2410 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2415 #: ../src/guestfs.pod:1162
2417 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2418 "call with no optional arguments specified:"
2422 #: ../src/guestfs.pod:1165
2425 " guestfs_add_drive_opts (g, filename, -1);\n"
2430 #: ../src/guestfs.pod:1167
2431 msgid "With a single optional argument:"
2435 #: ../src/guestfs.pod:1169
2438 " guestfs_add_drive_opts (g, filename,\n"
2439 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2445 #: ../src/guestfs.pod:1173
2450 #: ../src/guestfs.pod:1175
2453 " guestfs_add_drive_opts (g, filename,\n"
2454 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2455 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
2461 #: ../src/guestfs.pod:1180
2463 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
2468 #: ../src/guestfs.pod:1183
2469 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
2473 #: ../src/guestfs.pod:1185
2475 "The second variant has the same name with the suffix C<_va>, which works the "
2476 "same way but takes a C<va_list>. See the C manual for details. For the "
2477 "example function, this is declared:"
2481 #: ../src/guestfs.pod:1189
2484 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
2490 #: ../src/guestfs.pod:1192
2491 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
2495 #: ../src/guestfs.pod:1194
2497 "The third variant is useful where you need to construct these calls. You "
2498 "pass in a structure where you fill in the optional fields. The structure "
2499 "has a bitmask as the first element which you must set to indicate which "
2500 "fields you have filled in. For our example function the structure and call "
2505 #: ../src/guestfs.pod:1200
2508 " struct guestfs_add_drive_opts_argv {\n"
2509 " uint64_t bitmask;\n"
2511 " const char *format;\n"
2514 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
2515 " const struct guestfs_add_drive_opts_argv *optargs);\n"
2520 #: ../src/guestfs.pod:1209
2521 msgid "You could call it like this:"
2525 #: ../src/guestfs.pod:1211
2528 " struct guestfs_add_drive_opts_argv optargs = {\n"
2529 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
2530 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
2532 " .format = \"qcow2\"\n"
2538 #: ../src/guestfs.pod:1218
2541 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
2546 #: ../src/guestfs.pod:1220 ../src/guestfs-actions.pod:11
2547 #: ../src/guestfs-actions.pod:1813 ../fish/guestfish-actions.pod:9
2548 #: ../fish/guestfish-actions.pod:1244
2553 #: ../src/guestfs.pod:1226
2554 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
2558 #: ../src/guestfs.pod:1231
2559 msgid "You do not need to fill in all fields of the structure."
2563 #: ../src/guestfs.pod:1235
2565 "There must be a one-to-one correspondence between fields of the structure "
2566 "that are filled in, and bits set in the bitmask."
2570 #: ../src/guestfs.pod:1240
2571 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
2575 #: ../src/guestfs.pod:1242
2577 "In other languages, optional arguments are expressed in the way that is "
2578 "natural for that language. We refer you to the language-specific "
2579 "documentation for more details on that."
2583 #: ../src/guestfs.pod:1246
2584 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
2588 #: ../src/guestfs.pod:1248 ../src/guestfs.pod:1253
2593 #: ../src/guestfs.pod:1250
2595 "<!-- old anchor for the next section --> <a name="
2596 "\"state_machine_and_low_level_event_api\"/>"
2600 #: ../src/guestfs.pod:1255
2601 msgid "ARCHITECTURE"
2605 #: ../src/guestfs.pod:1257
2607 "Internally, libguestfs is implemented by running an appliance (a special "
2608 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
2609 "process of the main program."
2613 #: ../src/guestfs.pod:1261
2616 " ___________________\n"
2618 " | main program |\n"
2620 " | | child process / appliance\n"
2621 " | | __________________________\n"
2623 " +-------------------+ RPC | +-----------------+ |\n"
2624 " | libguestfs <--------------------> guestfsd | |\n"
2625 " | | | +-----------------+ |\n"
2626 " \\___________________/ | | Linux kernel | |\n"
2627 " | +--^--------------+ |\n"
2628 " \\_________|________________/\n"
2634 " \\______________/\n"
2639 #: ../src/guestfs.pod:1281
2641 "The library, linked to the main program, creates the child process and hence "
2642 "the appliance in the L</guestfs_launch> function."
2646 #: ../src/guestfs.pod:1284
2648 "Inside the appliance is a Linux kernel and a complete stack of userspace "
2649 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
2650 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
2651 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
2652 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
2653 "attached to the qemu process which translates device access by the "
2654 "appliance's Linux kernel into accesses to the image."
2658 #: ../src/guestfs.pod:1293
2660 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
2661 "Although the disk image you are attached to might also be used by some "
2662 "virtual machine, libguestfs doesn't know or care about this. (But you will "
2663 "care if both libguestfs's qemu process and your virtual machine are trying "
2664 "to update the disk image at the same time, since these usually results in "
2665 "massive disk corruption)."
2669 #: ../src/guestfs.pod:1300
2670 msgid "STATE MACHINE"
2674 #: ../src/guestfs.pod:1302
2675 msgid "libguestfs uses a state machine to model the child process:"
2679 #: ../src/guestfs.pod:1304
2691 " / | \\ \\ guestfs_launch\n"
2692 " / | _\\__V______\n"
2694 " / | | LAUNCHING |\n"
2695 " / | \\___________/\n"
2697 " / | guestfs_launch\n"
2699 " ______ / __|____V\n"
2700 " / \\ ------> / \\\n"
2701 " | BUSY | | READY |\n"
2702 " \\______/ <------ \\________/\n"
2707 #: ../src/guestfs.pod:1326
2709 "The normal transitions are (1) CONFIG (when the handle is created, but there "
2710 "is no child process), (2) LAUNCHING (when the child process is booting up), "
2711 "(3) alternating between READY and BUSY as commands are issued to, and "
2712 "carried out by, the child process."
2716 #: ../src/guestfs.pod:1331
2718 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
2719 "asynchronously at any time (eg. due to some internal error), and that causes "
2720 "the state to transition back to CONFIG."
2724 #: ../src/guestfs.pod:1335
2726 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
2727 "issued when in the CONFIG state."
2731 #: ../src/guestfs.pod:1338
2733 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
2734 "L</guestfs_launch> blocks until the child process is READY to accept "
2735 "commands (or until some failure or timeout). L</guestfs_launch> internally "
2736 "moves the state from CONFIG to LAUNCHING while it is running."
2740 #: ../src/guestfs.pod:1344
2742 "API actions such as L</guestfs_mount> can only be issued when in the READY "
2743 "state. These API calls block waiting for the command to be carried out (ie. "
2744 "the state to transition to BUSY and then back to READY). There are no non-"
2745 "blocking versions, and no way to issue more than one command per handle at "
2750 #: ../src/guestfs.pod:1350
2752 "Finally, the child process sends asynchronous messages back to the main "
2753 "program, such as kernel log messages. You can register a callback to "
2754 "receive these messages."
2758 #: ../src/guestfs.pod:1354
2759 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
2763 #: ../src/guestfs.pod:1356
2765 "The child process generates events in some situations. Current events "
2766 "include: receiving a log message, the child process exits."
2770 #: ../src/guestfs.pod:1359
2772 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
2777 #: ../src/guestfs.pod:1362
2779 "Only I<one callback of each type> can be registered for each handle. "
2780 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
2781 "that type. Cancel all callbacks of this type by calling this function with "
2782 "C<cb> set to C<NULL>."
2786 #: ../src/guestfs.pod:1367
2787 msgid "guestfs_set_log_message_callback"
2791 #: ../src/guestfs.pod:1369
2794 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
2795 " char *buf, int len);\n"
2796 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
2797 " guestfs_log_message_cb cb,\n"
2803 #: ../src/guestfs.pod:1375
2805 "The callback function C<cb> will be called whenever qemu or the guest writes "
2806 "anything to the console."
2810 #: ../src/guestfs.pod:1378
2811 msgid "Use this function to capture kernel messages and similar."
2815 #: ../src/guestfs.pod:1380
2817 "Normally there is no log message handler, and log messages are just "
2822 #: ../src/guestfs.pod:1383
2823 msgid "guestfs_set_subprocess_quit_callback"
2827 #: ../src/guestfs.pod:1385
2830 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
2831 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
2832 " guestfs_subprocess_quit_cb cb,\n"
2838 #: ../src/guestfs.pod:1390
2840 "The callback function C<cb> will be called when the child process quits, "
2841 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
2842 "corresponds to a transition from any state to the CONFIG state)."
2846 #: ../src/guestfs.pod:1395
2847 msgid "guestfs_set_launch_done_callback"
2851 #: ../src/guestfs.pod:1397
2854 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
2855 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
2856 " guestfs_launch_done_cb cb,\n"
2862 #: ../src/guestfs.pod:1402
2864 "The callback function C<cb> will be called when the child process becomes "
2865 "ready first time after it has been launched. (This corresponds to a "
2866 "transition from LAUNCHING to the READY state)."
2870 #: ../src/guestfs.pod:1406
2871 msgid "guestfs_set_close_callback"
2875 #: ../src/guestfs.pod:1408
2878 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
2879 " void guestfs_set_close_callback (guestfs_h *g,\n"
2880 " guestfs_close_cb cb,\n"
2886 #: ../src/guestfs.pod:1413
2888 "The callback function C<cb> will be called while the handle is being closed "
2889 "(synchronously from L</guestfs_close>)."
2893 #: ../src/guestfs.pod:1416
2895 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
2896 "handles that are open when the program exits. This means that this callback "
2897 "might be called indirectly from L<exit(3)>, which can cause unexpected "
2898 "problems in higher-level languages (eg. if your HLL interpreter has already "
2899 "been cleaned up by the time this is called, and if your callback then jumps "
2900 "into some HLL function)."
2904 #: ../src/guestfs.pod:1424
2905 msgid "guestfs_set_progress_callback"
2909 #: ../src/guestfs.pod:1426
2912 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
2913 " int proc_nr, int serial,\n"
2914 " uint64_t position, uint64_t total);\n"
2915 " void guestfs_set_progress_callback (guestfs_h *g,\n"
2916 " guestfs_progress_cb cb,\n"
2922 #: ../src/guestfs.pod:1433
2924 "Some long-running operations can generate progress messages. If this "
2925 "callback is registered, then it will be called each time a progress message "
2926 "is generated (usually two seconds after the operation started, and three "
2927 "times per second thereafter until it completes, although the frequency may "
2928 "change in future versions)."
2932 #: ../src/guestfs.pod:1439
2934 "The callback receives two numbers: C<position> and C<total>. The units of "
2935 "C<total> are not defined, although for some operations C<total> may relate "
2936 "in some way to the amount of data to be transferred (eg. in bytes or "
2937 "megabytes), and C<position> may be the portion which has been transferred."
2941 #: ../src/guestfs.pod:1445
2942 msgid "The only defined and stable parts of the API are:"
2946 #: ../src/guestfs.pod:1451
2948 "The callback can display to the user some type of progress bar or indicator "
2949 "which shows the ratio of C<position>:C<total>."
2953 #: ../src/guestfs.pod:1456
2954 msgid "0 E<lt>= C<position> E<lt>= C<total>"
2958 #: ../src/guestfs.pod:1460
2960 "If any progress notification is sent during a call, then a final progress "
2961 "notification is always sent when C<position> = C<total>."
2965 #: ../src/guestfs.pod:1463
2967 "This is to simplify caller code, so callers can easily set the progress "
2968 "indicator to \"100%\" at the end of the operation, without requiring special "
2969 "code to detect this case."
2973 #: ../src/guestfs.pod:1469
2975 "The callback also receives the procedure number and serial number of the "
2976 "call. These are only useful for debugging protocol issues, and the callback "
2977 "can normally ignore them. The callback may want to print these numbers in "
2978 "error messages or debugging messages."
2982 #: ../src/guestfs.pod:1474
2983 msgid "PRIVATE DATA AREA"
2987 #: ../src/guestfs.pod:1476
2989 "You can attach named pieces of private data to the libguestfs handle, and "
2990 "fetch them by name for the lifetime of the handle. This is called the "
2991 "private data area and is only available from the C API."
2995 #: ../src/guestfs.pod:1480
2996 msgid "To attach a named piece of data, use the following call:"
3000 #: ../src/guestfs.pod:1482
3003 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3008 #: ../src/guestfs.pod:1484
3010 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3011 "pointer (which can be C<NULL>). Any previous item with the same name is "
3016 #: ../src/guestfs.pod:1488
3018 "You can use any C<key> you want, but names beginning with an underscore "
3019 "character are reserved for internal libguestfs purposes (for implementing "
3020 "language bindings). It is recommended to prefix the name with some unique "
3021 "string to avoid collisions with other users."
3025 #: ../src/guestfs.pod:1493
3026 msgid "To retrieve the pointer, use:"
3030 #: ../src/guestfs.pod:1495
3033 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3038 #: ../src/guestfs.pod:1497
3040 "This function returns C<NULL> if either no data is found associated with "
3041 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3046 #: ../src/guestfs.pod:1501
3048 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3049 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3050 "all. In particular, libguestfs does I<not> try to free the data when the "
3051 "handle is closed. If the data must be freed, then the caller must either "
3052 "free it before calling L</guestfs_close> or must set up a close callback to "
3053 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3054 "can be registered for a handle)."
3058 #: ../src/guestfs.pod:1509
3060 "The private data area is implemented using a hash table, and should be "
3061 "reasonably efficient for moderate numbers of keys."
3065 #: ../src/guestfs.pod:1512
3066 msgid "BLOCK DEVICE NAMING"
3070 #: ../src/guestfs.pod:1514
3072 "In the kernel there is now quite a profusion of schemata for naming block "
3073 "devices (in this context, by I<block device> I mean a physical or virtual "
3074 "hard drive). The original Linux IDE driver used names starting with C</dev/"
3075 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
3076 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
3077 "for the old IDE driver (particularly for SATA devices) those devices also "
3078 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
3079 "paravirtualized drivers. This has created several different naming systems, "
3080 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
3084 #: ../src/guestfs.pod:1526
3086 "As discussed above, libguestfs uses a qemu appliance running an embedded "
3087 "Linux kernel to access block devices. We can run a variety of appliances "
3088 "based on a variety of Linux kernels."
3092 #: ../src/guestfs.pod:1530
3094 "This causes a problem for libguestfs because many API calls use device or "
3095 "partition names. Working scripts and the recipe (example) scripts that we "
3096 "make available over the internet could fail if the naming scheme changes."
3100 #: ../src/guestfs.pod:1535
3102 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
3103 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
3104 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
3105 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
3109 #: ../src/guestfs.pod:1541
3111 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
3112 "L</guestfs_list_partitions> and similar calls return the true names of the "
3113 "devices and partitions as known to the appliance."
3117 #: ../src/guestfs.pod:1546
3118 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
3122 #: ../src/guestfs.pod:1548
3124 "Usually this translation is transparent. However in some (very rare) cases "
3125 "you may need to know the exact algorithm. Such cases include where you use "
3126 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
3127 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
3131 #: ../src/guestfs.pod:1554
3133 "The algorithm is applied only to I<parameters> which are known to be either "
3134 "device or partition names. Return values from functions such as L</"
3135 "guestfs_list_devices> are never changed."
3139 #: ../src/guestfs.pod:1562
3140 msgid "Is the string a parameter which is a device or partition name?"
3144 #: ../src/guestfs.pod:1566
3145 msgid "Does the string begin with C</dev/sd>?"
3149 #: ../src/guestfs.pod:1570
3151 "Does the named device exist? If so, we use that device. However if I<not> "
3152 "then we continue with this algorithm."
3156 #: ../src/guestfs.pod:1575
3157 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
3161 #: ../src/guestfs.pod:1577
3162 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
3166 #: ../src/guestfs.pod:1579
3167 msgid "If that named device exists, use it. If not, continue."
3171 #: ../src/guestfs.pod:1583
3172 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
3176 #: ../src/guestfs.pod:1585
3177 msgid "If that named device exists, use it. If not, return an error."
3181 #: ../src/guestfs.pod:1589
3182 msgid "PORTABILITY CONCERNS"
3186 #: ../src/guestfs.pod:1591
3188 "Although the standard naming scheme and automatic translation is useful for "
3189 "simple programs and guestfish scripts, for larger programs it is best not to "
3190 "rely on this mechanism."
3194 #: ../src/guestfs.pod:1595
3196 "Where possible for maximum future portability programs using libguestfs "
3197 "should use these future-proof techniques:"
3201 #: ../src/guestfs.pod:1602
3203 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
3204 "device names, and then use those names directly."
3208 #: ../src/guestfs.pod:1605
3210 "Since those device names exist by definition, they will never be translated."
3214 #: ../src/guestfs.pod:1610
3216 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
3217 "filesystem labels."
3221 #: ../src/guestfs.pod:1615
3226 #: ../src/guestfs.pod:1617
3227 msgid "COMMUNICATION PROTOCOL"
3231 #: ../src/guestfs.pod:1619
3233 "Don't rely on using this protocol directly. This section documents how it "
3234 "currently works, but it may change at any time."
3238 #: ../src/guestfs.pod:1622
3240 "The protocol used to talk between the library and the daemon running inside "
3241 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3242 "1014, RFC 1832, RFC 4506)."
3246 #: ../src/guestfs.pod:1626
3248 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3249 "this file is automatically generated)."
3253 #: ../src/guestfs.pod:1629
3255 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3256 "and C<FileOut> parameters, which are handled with very simple request/reply "
3257 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3258 "parameters, which use the same request and reply messages, but they may also "
3259 "be followed by files sent using a chunked encoding."
3263 #: ../src/guestfs.pod:1636
3264 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3268 #: ../src/guestfs.pod:1638
3269 msgid "For ordinary functions, the request message is:"
3273 #: ../src/guestfs.pod:1640
3276 " total length (header + arguments,\n"
3277 " but not including the length word itself)\n"
3278 " struct guestfs_message_header (encoded as XDR)\n"
3279 " struct guestfs_<foo>_args (encoded as XDR)\n"
3284 #: ../src/guestfs.pod:1645
3286 "The total length field allows the daemon to allocate a fixed size buffer "
3287 "into which it slurps the rest of the message. As a result, the total length "
3288 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3289 "effective size of any request is limited to somewhere under this size."
3293 #: ../src/guestfs.pod:1651
3295 "Note also that many functions don't take any arguments, in which case the "
3296 "C<guestfs_I<foo>_args> is completely omitted."
3300 #: ../src/guestfs.pod:1654
3302 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3303 "receiver knows what type of args structure to expect, or none at all."
3307 #: ../src/guestfs.pod:1658
3308 msgid "The reply message for ordinary functions is:"
3312 #: ../src/guestfs.pod:1660
3315 " total length (header + ret,\n"
3316 " but not including the length word itself)\n"
3317 " struct guestfs_message_header (encoded as XDR)\n"
3318 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3323 #: ../src/guestfs.pod:1665
3325 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3326 "functions that return no formal return values."
3330 #: ../src/guestfs.pod:1668
3332 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3336 #: ../src/guestfs.pod:1671
3338 "In the case of an error, a flag is set in the header, and the reply message "
3339 "is slightly changed:"
3343 #: ../src/guestfs.pod:1674
3346 " total length (header + error,\n"
3347 " but not including the length word itself)\n"
3348 " struct guestfs_message_header (encoded as XDR)\n"
3349 " struct guestfs_message_error (encoded as XDR)\n"
3354 #: ../src/guestfs.pod:1679
3356 "The C<guestfs_message_error> structure contains the error message as a "
3361 #: ../src/guestfs.pod:1682
3362 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3366 #: ../src/guestfs.pod:1684
3368 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3369 "The normal request message is sent (see above). However this is followed by "
3370 "a sequence of file chunks."
3374 #: ../src/guestfs.pod:1688
3377 " total length (header + arguments,\n"
3378 " but not including the length word itself,\n"
3379 " and not including the chunks)\n"
3380 " struct guestfs_message_header (encoded as XDR)\n"
3381 " struct guestfs_<foo>_args (encoded as XDR)\n"
3382 " sequence of chunks for FileIn param #0\n"
3383 " sequence of chunks for FileIn param #1 etc.\n"
3388 #: ../src/guestfs.pod:1696
3389 msgid "The \"sequence of chunks\" is:"
3393 #: ../src/guestfs.pod:1698
3396 " length of chunk (not including length word itself)\n"
3397 " struct guestfs_chunk (encoded as XDR)\n"
3398 " length of chunk\n"
3399 " struct guestfs_chunk (encoded as XDR)\n"
3401 " length of chunk\n"
3402 " struct guestfs_chunk (with data.data_len == 0)\n"
3407 #: ../src/guestfs.pod:1706
3409 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3410 "is set in the final chunk to indicate either successful completion or early "
3415 #: ../src/guestfs.pod:1710
3417 "At time of writing there are no functions that have more than one FileIn "
3418 "parameter. However this is (theoretically) supported, by sending the "
3419 "sequence of chunks for each FileIn parameter one after another (from left to "
3424 #: ../src/guestfs.pod:1715
3426 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3427 "transfer. The library does this by sending a chunk with a special flag set "
3428 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3429 "RPC, does I<not> send any reply, and goes back to reading the next request."
3433 #: ../src/guestfs.pod:1721
3435 "The daemon may also cancel. It does this by writing a special word "
3436 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3437 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3438 "cancel chunk). The special word is chosen so that even if cancellation "
3439 "happens right at the end of the transfer (after the library has finished "
3440 "writing and has started listening for the reply), the \"spurious\" cancel "
3441 "flag will not be confused with the reply message."
3445 #: ../src/guestfs.pod:1730
3447 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3448 "limit), and also files where the size is not known in advance (eg. from "
3449 "pipes or sockets). However the chunks are rather small "
3450 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3451 "to keep much in memory."
3455 #: ../src/guestfs.pod:1736
3456 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3460 #: ../src/guestfs.pod:1738
3462 "The protocol for FileOut parameters is exactly the same as for FileIn "
3463 "parameters, but with the roles of daemon and library reversed."
3467 #: ../src/guestfs.pod:1741
3470 " total length (header + ret,\n"
3471 " but not including the length word itself,\n"
3472 " and not including the chunks)\n"
3473 " struct guestfs_message_header (encoded as XDR)\n"
3474 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3475 " sequence of chunks for FileOut param #0\n"
3476 " sequence of chunks for FileOut param #1 etc.\n"
3481 #: ../src/guestfs.pod:1749
3482 msgid "INITIAL MESSAGE"
3486 #: ../src/guestfs.pod:1751
3488 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3489 "which indicates that the guest and daemon is alive. This is what L</"
3490 "guestfs_launch> waits for."
3494 #: ../src/guestfs.pod:1755
3495 msgid "PROGRESS NOTIFICATION MESSAGES"
3499 #: ../src/guestfs.pod:1757
3501 "The daemon may send progress notification messages at any time. These are "
3502 "distinguished by the normal length word being replaced by "
3503 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3507 #: ../src/guestfs.pod:1761
3509 "The library turns them into progress callbacks (see "
3510 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3511 "discards them if not."
3515 #: ../src/guestfs.pod:1765
3517 "The daemon self-limits the frequency of progress messages it sends (see "
3518 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3523 #: ../src/guestfs.pod:1769
3524 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
3528 #: ../src/guestfs.pod:1771
3530 "All high-level libguestfs actions are synchronous. If you want to use "
3531 "libguestfs asynchronously then you must create a thread."
3535 #: ../src/guestfs.pod:1774
3537 "Only use the handle from a single thread. Either use the handle exclusively "
3538 "from one thread, or provide your own mutex so that two threads cannot issue "
3539 "calls on the same handle at the same time."
3543 #: ../src/guestfs.pod:1778
3545 "See the graphical program guestfs-browser for one possible architecture for "
3546 "multithreaded programs using libvirt and libguestfs."
3550 #: ../src/guestfs.pod:1781
3551 msgid "QEMU WRAPPERS"
3555 #: ../src/guestfs.pod:1783
3557 "If you want to compile your own qemu, run qemu from a non-standard location, "
3558 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
3563 #: ../src/guestfs.pod:1787
3565 "There is one important rule to remember: you I<must C<exec qemu>> as the "
3566 "last command in the shell script (so that qemu replaces the shell and "
3567 "becomes the direct child of the libguestfs-using program). If you don't do "
3568 "this, then the qemu process won't be cleaned up correctly."
3572 #: ../src/guestfs.pod:1792
3574 "Here is an example of a wrapper, where I have built my own copy of qemu from "
3579 #: ../src/guestfs.pod:1795
3583 " qemudir=/home/rjones/d/qemu\n"
3584 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
3589 #: ../src/guestfs.pod:1799
3591 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
3592 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
3597 #: ../src/guestfs.pod:1803
3600 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
3605 #: ../src/guestfs.pod:1805
3607 "Note that libguestfs also calls qemu with the -help and -version options in "
3608 "order to determine features."
3612 #: ../src/guestfs.pod:1808
3613 msgid "LIBGUESTFS VERSION NUMBERS"
3617 #: ../src/guestfs.pod:1810
3619 "Since April 2010, libguestfs has started to make separate development and "
3620 "stable releases, along with corresponding branches in our git repository. "
3621 "These separate releases can be identified by version number:"
3625 #: ../src/guestfs.pod:1815
3628 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3629 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3635 " | `-------- sub-version\n"
3637 " `------ always '1' because we don't change the ABI\n"
3642 #: ../src/guestfs.pod:1826
3643 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3647 #: ../src/guestfs.pod:1828
3649 "As time passes we cherry pick fixes from the development branch and backport "
3650 "those into the stable branch, the effect being that the stable branch should "
3651 "get more stable and less buggy over time. So the stable releases are ideal "
3652 "for people who don't need new features but would just like the software to "
3657 #: ../src/guestfs.pod:1834
3658 msgid "Our criteria for backporting changes are:"
3662 #: ../src/guestfs.pod:1840
3664 "Documentation changes which don't affect any code are backported unless the "
3665 "documentation refers to a future feature which is not in stable."
3669 #: ../src/guestfs.pod:1846
3671 "Bug fixes which are not controversial, fix obvious problems, and have been "
3672 "well tested are backported."
3676 #: ../src/guestfs.pod:1851
3678 "Simple rearrangements of code which shouldn't affect how it works get "
3679 "backported. This is so that the code in the two branches doesn't get too "
3680 "far out of step, allowing us to backport future fixes more easily."
3684 #: ../src/guestfs.pod:1857
3686 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3687 "exceptional case: the new feature is required in order to implement an "
3688 "important bug fix."
3692 #: ../src/guestfs.pod:1863
3694 "A new stable branch starts when we think the new features in development are "
3695 "substantial and compelling enough over the current stable branch to warrant "
3696 "it. When that happens we create new stable and development versions 1.N.0 "
3697 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
3698 "stable at this point, but by backporting fixes from development, that branch "
3699 "will stabilize over time."
3703 #: ../src/guestfs.pod:1871 ../fish/guestfish.pod:914
3704 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
3705 #: ../tools/virt-rescue.pl:255
3706 msgid "ENVIRONMENT VARIABLES"
3710 #: ../src/guestfs.pod:1875 ../fish/guestfish.pod:940
3711 msgid "LIBGUESTFS_APPEND"
3715 #: ../src/guestfs.pod:1877 ../fish/guestfish.pod:942
3716 msgid "Pass additional options to the guest kernel."
3720 #: ../src/guestfs.pod:1879 ../fish/guestfish.pod:944
3721 msgid "LIBGUESTFS_DEBUG"
3725 #: ../src/guestfs.pod:1881
3727 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
3728 "effect as calling C<guestfs_set_verbose (g, 1)>."
3732 #: ../src/guestfs.pod:1884 ../fish/guestfish.pod:949
3733 msgid "LIBGUESTFS_MEMSIZE"
3737 #: ../src/guestfs.pod:1886 ../fish/guestfish.pod:951
3739 "Set the memory allocated to the qemu process, in megabytes. For example:"
3743 #: ../src/guestfs.pod:1889 ../fish/guestfish.pod:954
3746 " LIBGUESTFS_MEMSIZE=700\n"
3751 #: ../src/guestfs.pod:1891 ../fish/guestfish.pod:956
3752 msgid "LIBGUESTFS_PATH"
3756 #: ../src/guestfs.pod:1893
3758 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
3759 "the discussion of paths in section PATH above."
3763 #: ../src/guestfs.pod:1896 ../fish/guestfish.pod:961
3764 msgid "LIBGUESTFS_QEMU"
3768 #: ../src/guestfs.pod:1898 ../fish/guestfish.pod:963
3770 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
3771 "which was found at compile time by the configure script is used."
3775 #: ../src/guestfs.pod:1902
3776 msgid "See also L</QEMU WRAPPERS> above."
3780 #: ../src/guestfs.pod:1904 ../fish/guestfish.pod:967
3781 msgid "LIBGUESTFS_TRACE"
3785 #: ../src/guestfs.pod:1906
3787 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
3788 "effect as calling C<guestfs_set_trace (g, 1)>."
3792 #: ../src/guestfs.pod:1909 ../fish/guestfish.pod:976
3797 #: ../src/guestfs.pod:1911 ../fish/guestfish.pod:978
3798 msgid "Location of temporary directory, defaults to C</tmp>."
3802 #: ../src/guestfs.pod:1913 ../fish/guestfish.pod:980
3804 "If libguestfs was compiled to use the supermin appliance then the real "
3805 "appliance is cached in this directory, shared between all handles belonging "
3806 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
3807 "use in case C</tmp> is not large enough."
3811 #: ../src/guestfs.pod:1921 ../fish/guestfish.pod:1038
3812 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233
3813 #: ../inspector/virt-inspector.pl:570 ../tools/virt-edit.pl:350
3814 #: ../tools/virt-win-reg.pl:484 ../tools/virt-df.pl:640
3815 #: ../tools/virt-ls.pl:232 ../tools/virt-resize.pl:1486
3816 #: ../tools/virt-list-filesystems.pl:186 ../tools/virt-cat.pl:185
3817 #: ../tools/virt-tar.pl:281 ../tools/virt-rescue.pl:267
3818 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:254
3823 #: ../src/guestfs.pod:1923
3825 "L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, L<virt-edit"
3826 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
3827 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
3828 "tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
3829 "L<http://libguestfs.org/>."
3833 #: ../src/guestfs.pod:1941
3835 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
3836 "(8)>, L<disktype(1)>."
3840 #: ../src/guestfs.pod:1948 ../tools/virt-win-reg.pl:499
3841 #: ../tools/virt-make-fs.pl:548
3846 #: ../src/guestfs.pod:1950
3847 msgid "To get a list of bugs against libguestfs use this link:"
3851 #: ../src/guestfs.pod:1952
3853 "L<https://bugzilla.redhat.com/buglist.cgi?"
3854 "component=libguestfs&product=Virtualization+Tools>"
3858 #: ../src/guestfs.pod:1954
3859 msgid "To report a new bug against libguestfs use this link:"
3863 #: ../src/guestfs.pod:1956
3865 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
3866 "component=libguestfs&product=Virtualization+Tools>"
3870 #: ../src/guestfs.pod:1958
3871 msgid "When reporting a bug, please check:"
3875 #: ../src/guestfs.pod:1964
3876 msgid "That the bug hasn't been reported already."
3880 #: ../src/guestfs.pod:1968
3881 msgid "That you are testing a recent version."
3885 #: ../src/guestfs.pod:1972
3886 msgid "Describe the bug accurately, and give a way to reproduce it."
3890 #: ../src/guestfs.pod:1976
3892 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
3897 #: ../src/guestfs.pod:1981 ../fish/guestfish.pod:1055
3898 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
3899 #: ../inspector/virt-inspector.pl:580
3904 #: ../src/guestfs.pod:1983 ../fish/guestfish.pod:1057
3905 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
3906 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
3910 #: ../src/guestfs.pod:1985 ../fish/guestfish.pod:1059
3911 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248
3912 #: ../inspector/virt-inspector.pl:594 ../tools/virt-edit.pl:366
3913 #: ../tools/virt-win-reg.pl:514 ../tools/virt-df.pl:653
3914 #: ../tools/virt-ls.pl:247 ../tools/virt-resize.pl:1512
3915 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-cat.pl:199
3916 #: ../tools/virt-tar.pl:296 ../tools/virt-rescue.pl:281
3917 #: ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:269
3922 #: ../src/guestfs.pod:1987 ../fish/guestfish.pod:1061
3923 #: ../fuse/guestmount.pod:250
3924 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
3928 #: ../src/guestfs.pod:1990
3930 "This library is free software; you can redistribute it and/or modify it "
3931 "under the terms of the GNU Lesser General Public License as published by the "
3932 "Free Software Foundation; either version 2 of the License, or (at your "
3933 "option) any later version."
3937 #: ../src/guestfs.pod:1995
3939 "This library is distributed in the hope that it will be useful, but WITHOUT "
3940 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
3941 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
3946 #: ../src/guestfs.pod:2000
3948 "You should have received a copy of the GNU Lesser General Public License "
3949 "along with this library; if not, write to the Free Software Foundation, "
3950 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
3954 #: ../src/guestfs-actions.pod:1
3955 msgid "guestfs_add_cdrom"
3959 #: ../src/guestfs-actions.pod:3
3963 " guestfs_add_cdrom (guestfs_h *g,\n"
3964 " const char *filename);\n"
3969 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
3970 msgid "This function adds a virtual CD-ROM disk image to the guest."
3974 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
3975 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
3979 #: ../src/guestfs-actions.pod:17
3981 "This call checks for the existence of C<filename>. This stops you from "
3982 "specifying other types of drive which are supported by qemu such as C<nbd:> "
3983 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
3988 #: ../src/guestfs-actions.pod:24
3990 "If you just want to add an ISO file (often you use this as an efficient way "
3991 "to transfer large files into the guest), then you should probably use "
3992 "C<guestfs_add_drive_ro> instead."
3996 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:58
3997 #: ../src/guestfs-actions.pod:119 ../src/guestfs-actions.pod:156
3998 #: ../src/guestfs-actions.pod:170 ../src/guestfs-actions.pod:191
3999 #: ../src/guestfs-actions.pod:211 ../src/guestfs-actions.pod:225
4000 #: ../src/guestfs-actions.pod:340 ../src/guestfs-actions.pod:360
4001 #: ../src/guestfs-actions.pod:374 ../src/guestfs-actions.pod:419
4002 #: ../src/guestfs-actions.pod:447 ../src/guestfs-actions.pod:465
4003 #: ../src/guestfs-actions.pod:532 ../src/guestfs-actions.pod:565
4004 #: ../src/guestfs-actions.pod:579 ../src/guestfs-actions.pod:594
4005 #: ../src/guestfs-actions.pod:693 ../src/guestfs-actions.pod:711
4006 #: ../src/guestfs-actions.pod:725 ../src/guestfs-actions.pod:739
4007 #: ../src/guestfs-actions.pod:900 ../src/guestfs-actions.pod:920
4008 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1022
4009 #: ../src/guestfs-actions.pod:1040 ../src/guestfs-actions.pod:1059
4010 #: ../src/guestfs-actions.pod:1073 ../src/guestfs-actions.pod:1093
4011 #: ../src/guestfs-actions.pod:1132 ../src/guestfs-actions.pod:1202
4012 #: ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1258
4013 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1401
4014 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1653
4015 #: ../src/guestfs-actions.pod:1675 ../src/guestfs-actions.pod:1762
4016 #: ../src/guestfs-actions.pod:2185 ../src/guestfs-actions.pod:2329
4017 #: ../src/guestfs-actions.pod:2390 ../src/guestfs-actions.pod:2426
4018 #: ../src/guestfs-actions.pod:2962 ../src/guestfs-actions.pod:2977
4019 #: ../src/guestfs-actions.pod:2997 ../src/guestfs-actions.pod:3123
4020 #: ../src/guestfs-actions.pod:3137 ../src/guestfs-actions.pod:3150
4021 #: ../src/guestfs-actions.pod:3164 ../src/guestfs-actions.pod:3179
4022 #: ../src/guestfs-actions.pod:3215 ../src/guestfs-actions.pod:3288
4023 #: ../src/guestfs-actions.pod:3308 ../src/guestfs-actions.pod:3325
4024 #: ../src/guestfs-actions.pod:3348 ../src/guestfs-actions.pod:3371
4025 #: ../src/guestfs-actions.pod:3403 ../src/guestfs-actions.pod:3422
4026 #: ../src/guestfs-actions.pod:3441 ../src/guestfs-actions.pod:3476
4027 #: ../src/guestfs-actions.pod:3488 ../src/guestfs-actions.pod:3524
4028 #: ../src/guestfs-actions.pod:3540 ../src/guestfs-actions.pod:3553
4029 #: ../src/guestfs-actions.pod:3568 ../src/guestfs-actions.pod:3585
4030 #: ../src/guestfs-actions.pod:3680 ../src/guestfs-actions.pod:3700
4031 #: ../src/guestfs-actions.pod:3713 ../src/guestfs-actions.pod:3764
4032 #: ../src/guestfs-actions.pod:3782 ../src/guestfs-actions.pod:3800
4033 #: ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3830
4034 #: ../src/guestfs-actions.pod:3844 ../src/guestfs-actions.pod:3861
4035 #: ../src/guestfs-actions.pod:3876 ../src/guestfs-actions.pod:3896
4036 #: ../src/guestfs-actions.pod:3945 ../src/guestfs-actions.pod:3976
4037 #: ../src/guestfs-actions.pod:3995 ../src/guestfs-actions.pod:4014
4038 #: ../src/guestfs-actions.pod:4026 ../src/guestfs-actions.pod:4043
4039 #: ../src/guestfs-actions.pod:4056 ../src/guestfs-actions.pod:4071
4040 #: ../src/guestfs-actions.pod:4086 ../src/guestfs-actions.pod:4121
4041 #: ../src/guestfs-actions.pod:4136 ../src/guestfs-actions.pod:4156
4042 #: ../src/guestfs-actions.pod:4170 ../src/guestfs-actions.pod:4187
4043 #: ../src/guestfs-actions.pod:4236 ../src/guestfs-actions.pod:4273
4044 #: ../src/guestfs-actions.pod:4287 ../src/guestfs-actions.pod:4315
4045 #: ../src/guestfs-actions.pod:4332 ../src/guestfs-actions.pod:4350
4046 #: ../src/guestfs-actions.pod:4484 ../src/guestfs-actions.pod:4542
4047 #: ../src/guestfs-actions.pod:4564 ../src/guestfs-actions.pod:4582
4048 #: ../src/guestfs-actions.pod:4614 ../src/guestfs-actions.pod:4680
4049 #: ../src/guestfs-actions.pod:4697 ../src/guestfs-actions.pod:4710
4050 #: ../src/guestfs-actions.pod:4724 ../src/guestfs-actions.pod:5015
4051 #: ../src/guestfs-actions.pod:5034 ../src/guestfs-actions.pod:5048
4052 #: ../src/guestfs-actions.pod:5060 ../src/guestfs-actions.pod:5074
4053 #: ../src/guestfs-actions.pod:5086 ../src/guestfs-actions.pod:5100
4054 #: ../src/guestfs-actions.pod:5116 ../src/guestfs-actions.pod:5137
4055 #: ../src/guestfs-actions.pod:5156 ../src/guestfs-actions.pod:5175
4056 #: ../src/guestfs-actions.pod:5193 ../src/guestfs-actions.pod:5216
4057 #: ../src/guestfs-actions.pod:5234 ../src/guestfs-actions.pod:5253
4058 #: ../src/guestfs-actions.pod:5274 ../src/guestfs-actions.pod:5293
4059 #: ../src/guestfs-actions.pod:5310 ../src/guestfs-actions.pod:5338
4060 #: ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5381
4061 #: ../src/guestfs-actions.pod:5405 ../src/guestfs-actions.pod:5420
4062 #: ../src/guestfs-actions.pod:5435 ../src/guestfs-actions.pod:5454
4063 #: ../src/guestfs-actions.pod:5491 ../src/guestfs-actions.pod:5514
4064 #: ../src/guestfs-actions.pod:5540 ../src/guestfs-actions.pod:5648
4065 #: ../src/guestfs-actions.pod:5769 ../src/guestfs-actions.pod:5781
4066 #: ../src/guestfs-actions.pod:5794 ../src/guestfs-actions.pod:5807
4067 #: ../src/guestfs-actions.pod:5829 ../src/guestfs-actions.pod:5842
4068 #: ../src/guestfs-actions.pod:5855 ../src/guestfs-actions.pod:5868
4069 #: ../src/guestfs-actions.pod:5883 ../src/guestfs-actions.pod:5942
4070 #: ../src/guestfs-actions.pod:5959 ../src/guestfs-actions.pod:5975
4071 #: ../src/guestfs-actions.pod:5991 ../src/guestfs-actions.pod:6008
4072 #: ../src/guestfs-actions.pod:6021 ../src/guestfs-actions.pod:6041
4073 #: ../src/guestfs-actions.pod:6077 ../src/guestfs-actions.pod:6091
4074 #: ../src/guestfs-actions.pod:6132 ../src/guestfs-actions.pod:6145
4075 #: ../src/guestfs-actions.pod:6163 ../src/guestfs-actions.pod:6192
4076 #: ../src/guestfs-actions.pod:6223 ../src/guestfs-actions.pod:6342
4077 #: ../src/guestfs-actions.pod:6360 ../src/guestfs-actions.pod:6374
4078 #: ../src/guestfs-actions.pod:6429 ../src/guestfs-actions.pod:6442
4079 #: ../src/guestfs-actions.pod:6488 ../src/guestfs-actions.pod:6521
4080 #: ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:6601
4081 #: ../src/guestfs-actions.pod:6667 ../src/guestfs-actions.pod:6686
4082 #: ../src/guestfs-actions.pod:6715
4083 msgid "This function returns 0 on success or -1 on error."
4087 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:172
4088 #: ../src/guestfs-actions.pod:193 ../fish/guestfish-actions.pod:28
4089 #: ../fish/guestfish-actions.pod:117 ../fish/guestfish-actions.pod:131
4091 "This function is deprecated. In new code, use the C<add_drive_opts> call "
4096 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:175
4097 #: ../src/guestfs-actions.pod:196 ../src/guestfs-actions.pod:1406
4098 #: ../src/guestfs-actions.pod:1892 ../src/guestfs-actions.pod:1913
4099 #: ../src/guestfs-actions.pod:6609 ../src/guestfs-actions.pod:6778
4100 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:120
4101 #: ../fish/guestfish-actions.pod:134 ../fish/guestfish-actions.pod:940
4102 #: ../fish/guestfish-actions.pod:1297 ../fish/guestfish-actions.pod:1311
4103 #: ../fish/guestfish-actions.pod:4366 ../fish/guestfish-actions.pod:4463
4105 "Deprecated functions will not be removed from the API, but the fact that "
4106 "they are deprecated indicates that there are problems with correct use of "
4111 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:60
4112 #: ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:1864
4113 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:2065
4114 #: ../src/guestfs-actions.pod:2964 ../src/guestfs-actions.pod:2979
4115 #: ../src/guestfs-actions.pod:4123 ../src/guestfs-actions.pod:5195
4116 #: ../src/guestfs-actions.pod:5312 ../src/guestfs-actions.pod:5422
4117 #: ../src/guestfs-actions.pod:5885 ../src/guestfs-actions.pod:6010
4118 #: ../src/guestfs-actions.pod:6523
4119 msgid "(Added in 0.3)"
4123 #: ../src/guestfs-actions.pod:41
4124 msgid "guestfs_add_drive"
4128 #: ../src/guestfs-actions.pod:43
4132 " guestfs_add_drive (guestfs_h *g,\n"
4133 " const char *filename);\n"
4138 #: ../src/guestfs-actions.pod:47
4140 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
4141 "optional parameters, so the disk is added writable, with the format being "
4142 "detected automatically."
4146 #: ../src/guestfs-actions.pod:51
4148 "Automatic detection of the format opens you up to a potential security hole "
4149 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4150 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4151 "you should think about replacing calls to this function with calls to "
4152 "C<guestfs_add_drive_opts>, and specifying the format."
4156 #: ../src/guestfs-actions.pod:62
4157 msgid "guestfs_add_drive_opts"
4161 #: ../src/guestfs-actions.pod:64
4165 " guestfs_add_drive_opts (guestfs_h *g,\n"
4166 " const char *filename,\n"
4172 #: ../src/guestfs-actions.pod:69
4174 "You may supply a list of optional arguments to this call. Use zero or more "
4175 "of the following pairs of parameters, and terminate the list with C<-1> on "
4176 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
4180 #: ../src/guestfs-actions.pod:74
4183 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
4184 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
4185 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
4190 #: ../src/guestfs-actions.pod:78 ../fish/guestfish-actions.pod:56
4192 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4193 "The first time you call this function, the disk appears as C</dev/sda>, the "
4194 "second time as C</dev/sdb>, and so on."
4198 #: ../src/guestfs-actions.pod:83 ../fish/guestfish-actions.pod:61
4200 "You don't necessarily need to be root when using libguestfs. However you "
4201 "obviously do need sufficient permissions to access the filename for whatever "
4202 "operations you want to perform (ie. read access if you just want to read the "
4203 "image or write access if you want to modify the image)."
4207 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:67
4208 msgid "This call checks that C<filename> exists."
4212 #: ../src/guestfs-actions.pod:91 ../fish/guestfish-actions.pod:69
4213 msgid "The optional arguments are:"
4217 #: ../src/guestfs-actions.pod:95 ../fish/guestfish-actions.pod:73
4222 #: ../src/guestfs-actions.pod:97 ../fish/guestfish-actions.pod:75
4224 "If true then the image is treated as read-only. Writes are still allowed, "
4225 "but they are stored in a temporary snapshot overlay which is discarded at "
4226 "the end. The disk that you add is not modified."
4230 #: ../src/guestfs-actions.pod:101 ../fish/guestfish-actions.pod:79
4235 #: ../src/guestfs-actions.pod:103
4237 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4238 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4239 "Possible formats include C<raw> and C<qcow2>."
4243 #: ../src/guestfs-actions.pod:107 ../fish/guestfish-actions.pod:85
4245 "Automatic detection of the format opens you up to a potential security hole "
4246 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4247 "RHBZ#642934. Specifying the format closes this security hole."
4251 #: ../src/guestfs-actions.pod:112 ../fish/guestfish-actions.pod:90
4256 #: ../src/guestfs-actions.pod:114
4258 "This rarely-used option lets you emulate the behaviour of the deprecated "
4259 "C<guestfs_add_drive_with_if> call (q.v.)"
4263 #: ../src/guestfs-actions.pod:121
4264 msgid "(Added in 1.5.23)"
4268 #: ../src/guestfs-actions.pod:123
4269 msgid "guestfs_add_drive_opts_va"
4273 #: ../src/guestfs-actions.pod:125
4277 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
4278 " const char *filename,\n"
4284 #: ../src/guestfs-actions.pod:130
4285 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4289 #: ../src/guestfs-actions.pod:132 ../src/guestfs-actions.pod:143
4290 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4294 #: ../src/guestfs-actions.pod:134
4295 msgid "guestfs_add_drive_opts_argv"
4299 #: ../src/guestfs-actions.pod:136
4303 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4304 " const char *filename,\n"
4305 " const struct guestfs_add_drive_opts_argv *optargs);\n"
4310 #: ../src/guestfs-actions.pod:141
4311 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4315 #: ../src/guestfs-actions.pod:145
4316 msgid "guestfs_add_drive_ro"
4320 #: ../src/guestfs-actions.pod:147
4324 " guestfs_add_drive_ro (guestfs_h *g,\n"
4325 " const char *filename);\n"
4330 #: ../src/guestfs-actions.pod:151
4332 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4333 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4334 "disk is added read-only, with the format being detected automatically."
4338 #: ../src/guestfs-actions.pod:158
4339 msgid "(Added in 1.0.38)"
4343 #: ../src/guestfs-actions.pod:160
4344 msgid "guestfs_add_drive_ro_with_if"
4348 #: ../src/guestfs-actions.pod:162
4352 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4353 " const char *filename,\n"
4354 " const char *iface);\n"
4359 #: ../src/guestfs-actions.pod:167
4361 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4362 "QEMU interface emulation to use at run time."
4366 #: ../src/guestfs-actions.pod:179 ../src/guestfs-actions.pod:200
4367 #: ../src/guestfs-actions.pod:2275
4368 msgid "(Added in 1.0.84)"
4372 #: ../src/guestfs-actions.pod:181
4373 msgid "guestfs_add_drive_with_if"
4377 #: ../src/guestfs-actions.pod:183
4381 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4382 " const char *filename,\n"
4383 " const char *iface);\n"
4388 #: ../src/guestfs-actions.pod:188
4390 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4391 "QEMU interface emulation to use at run time."
4395 #: ../src/guestfs-actions.pod:202
4396 msgid "guestfs_aug_clear"
4400 #: ../src/guestfs-actions.pod:204
4404 " guestfs_aug_clear (guestfs_h *g,\n"
4405 " const char *augpath);\n"
4410 #: ../src/guestfs-actions.pod:208 ../fish/guestfish-actions.pod:142
4412 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4413 "L<augtool(1)> C<clear> command."
4417 #: ../src/guestfs-actions.pod:213 ../src/guestfs-actions.pod:2054
4418 msgid "(Added in 1.3.4)"
4422 #: ../src/guestfs-actions.pod:215
4423 msgid "guestfs_aug_close"
4427 #: ../src/guestfs-actions.pod:217
4431 " guestfs_aug_close (guestfs_h *g);\n"
4436 #: ../src/guestfs-actions.pod:220
4438 "Close the current Augeas handle and free up any resources used by it. After "
4439 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4440 "any other Augeas functions."
4444 #: ../src/guestfs-actions.pod:227 ../src/guestfs-actions.pod:252
4445 #: ../src/guestfs-actions.pod:270 ../src/guestfs-actions.pod:284
4446 #: ../src/guestfs-actions.pod:342 ../src/guestfs-actions.pod:362
4447 #: ../src/guestfs-actions.pod:376 ../src/guestfs-actions.pod:407
4448 #: ../src/guestfs-actions.pod:421 ../src/guestfs-actions.pod:435
4449 #: ../src/guestfs-actions.pod:449 ../src/guestfs-actions.pod:467
4450 #: ../src/guestfs-actions.pod:4872
4451 msgid "(Added in 0.7)"
4455 #: ../src/guestfs-actions.pod:229
4456 msgid "guestfs_aug_defnode"
4460 #: ../src/guestfs-actions.pod:231
4463 " struct guestfs_int_bool *\n"
4464 " guestfs_aug_defnode (guestfs_h *g,\n"
4465 " const char *name,\n"
4466 " const char *expr,\n"
4467 " const char *val);\n"
4472 #: ../src/guestfs-actions.pod:237 ../fish/guestfish-actions.pod:158
4474 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4478 #: ../src/guestfs-actions.pod:240
4480 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4481 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4482 "containing that single node."
4486 #: ../src/guestfs-actions.pod:244 ../fish/guestfish-actions.pod:165
4488 "On success this returns a pair containing the number of nodes in the "
4489 "nodeset, and a boolean flag if a node was created."
4493 #: ../src/guestfs-actions.pod:248
4495 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4496 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4500 #: ../src/guestfs-actions.pod:254
4501 msgid "guestfs_aug_defvar"
4505 #: ../src/guestfs-actions.pod:256
4509 " guestfs_aug_defvar (guestfs_h *g,\n"
4510 " const char *name,\n"
4511 " const char *expr);\n"
4516 #: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:173
4518 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4519 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4523 #: ../src/guestfs-actions.pod:265 ../fish/guestfish-actions.pod:177
4525 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4526 "evaluates to something which is not a nodeset."
4530 #: ../src/guestfs-actions.pod:268 ../src/guestfs-actions.pod:433
4531 #: ../src/guestfs-actions.pod:611 ../src/guestfs-actions.pod:642
4532 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:679
4533 #: ../src/guestfs-actions.pod:1278 ../src/guestfs-actions.pod:1632
4534 #: ../src/guestfs-actions.pod:1835 ../src/guestfs-actions.pod:1934
4535 #: ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:2029
4536 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2316
4537 #: ../src/guestfs-actions.pod:2575 ../src/guestfs-actions.pod:2596
4538 #: ../src/guestfs-actions.pod:4259 ../src/guestfs-actions.pod:4387
4539 #: ../src/guestfs-actions.pod:4795 ../src/guestfs-actions.pod:4821
4540 #: ../src/guestfs-actions.pod:6118 ../src/guestfs-actions.pod:6534
4541 #: ../src/guestfs-actions.pod:6547 ../src/guestfs-actions.pod:6560
4542 msgid "On error this function returns -1."
4546 #: ../src/guestfs-actions.pod:272
4547 msgid "guestfs_aug_get"
4551 #: ../src/guestfs-actions.pod:274
4555 " guestfs_aug_get (guestfs_h *g,\n"
4556 " const char *augpath);\n"
4561 #: ../src/guestfs-actions.pod:278 ../fish/guestfish-actions.pod:184
4563 "Look up the value associated with C<path>. If C<path> matches exactly one "
4564 "node, the C<value> is returned."
4568 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:781
4569 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:859
4570 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:978
4571 #: ../src/guestfs-actions.pod:1112 ../src/guestfs-actions.pod:1147
4572 #: ../src/guestfs-actions.pod:1164 ../src/guestfs-actions.pod:1183
4573 #: ../src/guestfs-actions.pod:1312 ../src/guestfs-actions.pod:1503
4574 #: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1778
4575 #: ../src/guestfs-actions.pod:1795 ../src/guestfs-actions.pod:1886
4576 #: ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:2077
4577 #: ../src/guestfs-actions.pod:2240 ../src/guestfs-actions.pod:2448
4578 #: ../src/guestfs-actions.pod:2521 ../src/guestfs-actions.pod:2652
4579 #: ../src/guestfs-actions.pod:2708 ../src/guestfs-actions.pod:2731
4580 #: ../src/guestfs-actions.pod:3109 ../src/guestfs-actions.pod:3460
4581 #: ../src/guestfs-actions.pod:3631 ../src/guestfs-actions.pod:3742
4582 #: ../src/guestfs-actions.pod:4405 ../src/guestfs-actions.pod:4599
4583 #: ../src/guestfs-actions.pod:4770 ../src/guestfs-actions.pod:4949
4584 #: ../src/guestfs-actions.pod:4998 ../src/guestfs-actions.pod:5561
4585 #: ../src/guestfs-actions.pod:5577 ../src/guestfs-actions.pod:5594
4586 #: ../src/guestfs-actions.pod:5618 ../src/guestfs-actions.pod:6282
4587 #: ../src/guestfs-actions.pod:6301 ../src/guestfs-actions.pod:6319
4588 #: ../src/guestfs-actions.pod:6500 ../src/guestfs-actions.pod:6772
4590 "This function returns a string, or NULL on error. I<The caller must free "
4591 "the returned string after use>."
4595 #: ../src/guestfs-actions.pod:286
4596 msgid "guestfs_aug_init"
4600 #: ../src/guestfs-actions.pod:288
4604 " guestfs_aug_init (guestfs_h *g,\n"
4605 " const char *root,\n"
4611 #: ../src/guestfs-actions.pod:293 ../fish/guestfish-actions.pod:191
4613 "Create a new Augeas handle for editing configuration files. If there was "
4614 "any previous Augeas handle associated with this guestfs session, then it is "
4619 #: ../src/guestfs-actions.pod:297
4620 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4624 #: ../src/guestfs-actions.pod:300 ../fish/guestfish-actions.pod:198
4626 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4630 #: ../src/guestfs-actions.pod:303 ../fish/guestfish-actions.pod:201
4632 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4633 "logical I<or> of the following integers:"
4637 #: ../src/guestfs-actions.pod:309 ../fish/guestfish-actions.pod:207
4638 msgid "C<AUG_SAVE_BACKUP> = 1"
4642 #: ../src/guestfs-actions.pod:311 ../fish/guestfish-actions.pod:209
4643 msgid "Keep the original file with a C<.augsave> extension."
4647 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:211
4648 msgid "C<AUG_SAVE_NEWFILE> = 2"
4652 #: ../src/guestfs-actions.pod:315 ../fish/guestfish-actions.pod:213
4654 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4655 "original. Overrides C<AUG_SAVE_BACKUP>."
4659 #: ../src/guestfs-actions.pod:318 ../fish/guestfish-actions.pod:216
4660 msgid "C<AUG_TYPE_CHECK> = 4"
4664 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:218
4665 msgid "Typecheck lenses (can be expensive)."
4669 #: ../src/guestfs-actions.pod:322 ../fish/guestfish-actions.pod:220
4670 msgid "C<AUG_NO_STDINC> = 8"
4674 #: ../src/guestfs-actions.pod:324 ../fish/guestfish-actions.pod:222
4675 msgid "Do not use standard load path for modules."
4679 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:224
4680 msgid "C<AUG_SAVE_NOOP> = 16"
4684 #: ../src/guestfs-actions.pod:328 ../fish/guestfish-actions.pod:226
4685 msgid "Make save a no-op, just record what would have been changed."
4689 #: ../src/guestfs-actions.pod:330 ../fish/guestfish-actions.pod:228
4690 msgid "C<AUG_NO_LOAD> = 32"
4694 #: ../src/guestfs-actions.pod:332
4695 msgid "Do not load the tree in C<guestfs_aug_init>."
4699 #: ../src/guestfs-actions.pod:336
4700 msgid "To close the handle, you can call C<guestfs_aug_close>."
4704 #: ../src/guestfs-actions.pod:338 ../fish/guestfish-actions.pod:236
4705 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4709 #: ../src/guestfs-actions.pod:344
4710 msgid "guestfs_aug_insert"
4714 #: ../src/guestfs-actions.pod:346
4718 " guestfs_aug_insert (guestfs_h *g,\n"
4719 " const char *augpath,\n"
4720 " const char *label,\n"
4726 #: ../src/guestfs-actions.pod:352 ../fish/guestfish-actions.pod:242
4728 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4729 "or after C<path> (depending on the boolean flag C<before>)."
4733 #: ../src/guestfs-actions.pod:356 ../fish/guestfish-actions.pod:246
4735 "C<path> must match exactly one existing node in the tree, and C<label> must "
4736 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4740 #: ../src/guestfs-actions.pod:364
4741 msgid "guestfs_aug_load"
4745 #: ../src/guestfs-actions.pod:366
4749 " guestfs_aug_load (guestfs_h *g);\n"
4754 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:254
4755 msgid "Load files into the tree."
4759 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:256
4760 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4764 #: ../src/guestfs-actions.pod:378
4765 msgid "guestfs_aug_ls"
4769 #: ../src/guestfs-actions.pod:380
4773 " guestfs_aug_ls (guestfs_h *g,\n"
4774 " const char *augpath);\n"
4779 #: ../src/guestfs-actions.pod:384
4781 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
4782 "sorting the resulting nodes into alphabetical order."
4786 #: ../src/guestfs-actions.pod:387 ../src/guestfs-actions.pod:403
4787 #: ../src/guestfs-actions.pod:549 ../src/guestfs-actions.pod:997
4788 #: ../src/guestfs-actions.pod:1327 ../src/guestfs-actions.pod:1346
4789 #: ../src/guestfs-actions.pod:1449 ../src/guestfs-actions.pod:1468
4790 #: ../src/guestfs-actions.pod:1717 ../src/guestfs-actions.pod:2120
4791 #: ../src/guestfs-actions.pod:2136 ../src/guestfs-actions.pod:2155
4792 #: ../src/guestfs-actions.pod:2198 ../src/guestfs-actions.pod:2222
4793 #: ../src/guestfs-actions.pod:2293 ../src/guestfs-actions.pod:2342
4794 #: ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:2671
4795 #: ../src/guestfs-actions.pod:2773 ../src/guestfs-actions.pod:3029
4796 #: ../src/guestfs-actions.pod:3091 ../src/guestfs-actions.pod:3196
4797 #: ../src/guestfs-actions.pod:3602 ../src/guestfs-actions.pod:4220
4798 #: ../src/guestfs-actions.pod:4741 ../src/guestfs-actions.pod:4868
4799 #: ../src/guestfs-actions.pod:4983 ../src/guestfs-actions.pod:5634
4800 #: ../src/guestfs-actions.pod:5695 ../src/guestfs-actions.pod:5750
4801 #: ../src/guestfs-actions.pod:5896 ../src/guestfs-actions.pod:5920
4802 #: ../src/guestfs-actions.pod:6392 ../src/guestfs-actions.pod:6412
4803 #: ../src/guestfs-actions.pod:6459 ../src/guestfs-actions.pod:6625
4804 #: ../src/guestfs-actions.pod:6644 ../src/guestfs-actions.pod:6729
4805 #: ../src/guestfs-actions.pod:6748 ../src/guestfs-actions.pod:6794
4806 #: ../src/guestfs-actions.pod:6813
4808 "This function returns a NULL-terminated array of strings (like L<environ(3)"
4809 ">), or NULL if there was an error. I<The caller must free the strings and "
4810 "the array after use>."
4814 #: ../src/guestfs-actions.pod:391 ../src/guestfs-actions.pod:922
4815 #: ../src/guestfs-actions.pod:940 ../src/guestfs-actions.pod:1384
4816 #: ../src/guestfs-actions.pod:2851 ../src/guestfs-actions.pod:2882
4817 #: ../src/guestfs-actions.pod:3443 ../src/guestfs-actions.pod:3493
4818 #: ../src/guestfs-actions.pod:3682 ../src/guestfs-actions.pod:3715
4819 #: ../src/guestfs-actions.pod:3878 ../src/guestfs-actions.pod:4224
4820 #: ../src/guestfs-actions.pod:4682 ../src/guestfs-actions.pod:5062
4821 #: ../src/guestfs-actions.pod:5076 ../src/guestfs-actions.pod:5088
4822 #: ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:6134
4823 #: ../src/guestfs-actions.pod:6147 ../src/guestfs-actions.pod:6376
4824 #: ../src/guestfs-actions.pod:6580 ../src/guestfs-actions.pod:6613
4825 msgid "(Added in 0.8)"
4829 #: ../src/guestfs-actions.pod:393
4830 msgid "guestfs_aug_match"
4834 #: ../src/guestfs-actions.pod:395
4838 " guestfs_aug_match (guestfs_h *g,\n"
4839 " const char *augpath);\n"
4844 #: ../src/guestfs-actions.pod:399 ../fish/guestfish-actions.pod:270
4846 "Returns a list of paths which match the path expression C<path>. The "
4847 "returned paths are sufficiently qualified so that they match exactly one "
4848 "node in the current tree."
4852 #: ../src/guestfs-actions.pod:409
4853 msgid "guestfs_aug_mv"
4857 #: ../src/guestfs-actions.pod:411
4861 " guestfs_aug_mv (guestfs_h *g,\n"
4862 " const char *src,\n"
4863 " const char *dest);\n"
4868 #: ../src/guestfs-actions.pod:416 ../fish/guestfish-actions.pod:278
4870 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4871 "C<dest> is overwritten if it exists."
4875 #: ../src/guestfs-actions.pod:423
4876 msgid "guestfs_aug_rm"
4880 #: ../src/guestfs-actions.pod:425
4884 " guestfs_aug_rm (guestfs_h *g,\n"
4885 " const char *augpath);\n"
4890 #: ../src/guestfs-actions.pod:429 ../fish/guestfish-actions.pod:285
4891 msgid "Remove C<path> and all of its children."
4895 #: ../src/guestfs-actions.pod:431 ../fish/guestfish-actions.pod:287
4896 msgid "On success this returns the number of entries which were removed."
4900 #: ../src/guestfs-actions.pod:437
4901 msgid "guestfs_aug_save"
4905 #: ../src/guestfs-actions.pod:439
4909 " guestfs_aug_save (guestfs_h *g);\n"
4914 #: ../src/guestfs-actions.pod:442 ../fish/guestfish-actions.pod:293
4915 msgid "This writes all pending changes to disk."
4919 #: ../src/guestfs-actions.pod:444
4921 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
4926 #: ../src/guestfs-actions.pod:451
4927 msgid "guestfs_aug_set"
4931 #: ../src/guestfs-actions.pod:453
4935 " guestfs_aug_set (guestfs_h *g,\n"
4936 " const char *augpath,\n"
4937 " const char *val);\n"
4942 #: ../src/guestfs-actions.pod:458 ../fish/guestfish-actions.pod:302
4943 msgid "Set the value associated with C<path> to C<val>."
4947 #: ../src/guestfs-actions.pod:460
4949 "In the Augeas API, it is possible to clear a node by setting the value to "
4950 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
4951 "this call. Instead you must use the C<guestfs_aug_clear> call."
4955 #: ../src/guestfs-actions.pod:469
4956 msgid "guestfs_available"
4960 #: ../src/guestfs-actions.pod:471
4964 " guestfs_available (guestfs_h *g,\n"
4965 " char *const *groups);\n"
4970 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:313
4972 "This command is used to check the availability of some groups of "
4973 "functionality in the appliance, which not all builds of the libguestfs "
4974 "appliance will be able to provide."
4978 #: ../src/guestfs-actions.pod:479
4980 "The libguestfs groups, and the functions that those groups correspond to, "
4981 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
4982 "runtime by calling C<guestfs_available_all_groups>."
4986 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:322
4988 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
4989 "\"]> would check for the availability of the Linux inotify functions and "
4990 "Augeas (configuration file editing) functions."
4994 #: ../src/guestfs-actions.pod:489 ../fish/guestfish-actions.pod:327
4995 msgid "The command returns no error if I<all> requested groups are available."
4999 #: ../src/guestfs-actions.pod:491 ../fish/guestfish-actions.pod:329
5001 "It fails with an error if one or more of the requested groups is unavailable "
5006 #: ../src/guestfs-actions.pod:494 ../fish/guestfish-actions.pod:332
5008 "If an unknown group name is included in the list of groups then an error is "
5013 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:335
5018 #: ../src/guestfs-actions.pod:503
5019 msgid "You must call C<guestfs_launch> before calling this function."
5023 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:343
5025 "The reason is because we don't know what groups are supported by the "
5026 "appliance/daemon until it is running and can be queried."
5030 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:349
5032 "If a group of functions is available, this does not necessarily mean that "
5033 "they will work. You still have to check for errors when calling individual "
5034 "API functions even if they are available."
5038 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:356
5040 "It is usually the job of distro packagers to build complete functionality "
5041 "into the libguestfs appliance. Upstream libguestfs, if built from source "
5042 "with all requirements satisfied, will support everything."
5046 #: ../src/guestfs-actions.pod:525
5048 "This call was added in version C<1.0.80>. In previous versions of "
5049 "libguestfs all you could do would be to speculatively execute a command to "
5050 "find out if the daemon implemented it. See also C<guestfs_version>."
5054 #: ../src/guestfs-actions.pod:534 ../src/guestfs-actions.pod:1095
5055 msgid "(Added in 1.0.80)"
5059 #: ../src/guestfs-actions.pod:536
5060 msgid "guestfs_available_all_groups"
5064 #: ../src/guestfs-actions.pod:538
5068 " guestfs_available_all_groups (guestfs_h *g);\n"
5073 #: ../src/guestfs-actions.pod:541
5075 "This command returns a list of all optional groups that this daemon knows "
5076 "about. Note this returns both supported and unsupported groups. To find "
5077 "out which ones the daemon can actually support you have to call "
5078 "C<guestfs_available> on each member of the returned list."
5082 #: ../src/guestfs-actions.pod:547
5083 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
5087 #: ../src/guestfs-actions.pod:553
5088 msgid "(Added in 1.3.15)"
5092 #: ../src/guestfs-actions.pod:555
5093 msgid "guestfs_base64_in"
5097 #: ../src/guestfs-actions.pod:557
5101 " guestfs_base64_in (guestfs_h *g,\n"
5102 " const char *base64file,\n"
5103 " const char *filename);\n"
5108 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:386
5110 "This command uploads base64-encoded data from C<base64file> to C<filename>."
5114 #: ../src/guestfs-actions.pod:567 ../src/guestfs-actions.pod:581
5115 #: ../src/guestfs-actions.pod:1134
5116 msgid "(Added in 1.3.5)"
5120 #: ../src/guestfs-actions.pod:569
5121 msgid "guestfs_base64_out"
5125 #: ../src/guestfs-actions.pod:571
5129 " guestfs_base64_out (guestfs_h *g,\n"
5130 " const char *filename,\n"
5131 " const char *base64file);\n"
5136 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:395
5138 "This command downloads the contents of C<filename>, writing it out to local "
5139 "file C<base64file> encoded as base64."
5143 #: ../src/guestfs-actions.pod:583
5144 msgid "guestfs_blockdev_flushbufs"
5148 #: ../src/guestfs-actions.pod:585
5152 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
5153 " const char *device);\n"
5158 #: ../src/guestfs-actions.pod:589 ../fish/guestfish-actions.pod:404
5160 "This tells the kernel to flush internal buffers associated with C<device>."
5164 #: ../src/guestfs-actions.pod:592 ../src/guestfs-actions.pod:609
5165 #: ../src/guestfs-actions.pod:624 ../src/guestfs-actions.pod:640
5166 #: ../src/guestfs-actions.pod:658 ../src/guestfs-actions.pod:677
5167 #: ../src/guestfs-actions.pod:691 ../src/guestfs-actions.pod:709
5168 #: ../src/guestfs-actions.pod:723 ../src/guestfs-actions.pod:737
5169 #: ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:418
5170 #: ../fish/guestfish-actions.pod:427 ../fish/guestfish-actions.pod:437
5171 #: ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:462
5172 #: ../fish/guestfish-actions.pod:470 ../fish/guestfish-actions.pod:481
5173 #: ../fish/guestfish-actions.pod:489 ../fish/guestfish-actions.pod:497
5174 msgid "This uses the L<blockdev(8)> command."
5178 #: ../src/guestfs-actions.pod:596 ../src/guestfs-actions.pod:613
5179 #: ../src/guestfs-actions.pod:628 ../src/guestfs-actions.pod:644
5180 #: ../src/guestfs-actions.pod:662 ../src/guestfs-actions.pod:681
5181 #: ../src/guestfs-actions.pod:695 ../src/guestfs-actions.pod:713
5182 #: ../src/guestfs-actions.pod:727 ../src/guestfs-actions.pod:741
5183 msgid "(Added in 0.9.3)"
5187 #: ../src/guestfs-actions.pod:598
5188 msgid "guestfs_blockdev_getbsz"
5192 #: ../src/guestfs-actions.pod:600
5196 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
5197 " const char *device);\n"
5202 #: ../src/guestfs-actions.pod:604 ../fish/guestfish-actions.pod:413
5203 msgid "This returns the block size of a device."
5207 #: ../src/guestfs-actions.pod:606 ../src/guestfs-actions.pod:706
5208 #: ../fish/guestfish-actions.pod:415 ../fish/guestfish-actions.pod:478
5210 "(Note this is different from both I<size in blocks> and I<filesystem block "
5215 #: ../src/guestfs-actions.pod:615
5216 msgid "guestfs_blockdev_getro"
5220 #: ../src/guestfs-actions.pod:617
5224 " guestfs_blockdev_getro (guestfs_h *g,\n"
5225 " const char *device);\n"
5230 #: ../src/guestfs-actions.pod:621 ../fish/guestfish-actions.pod:424
5232 "Returns a boolean indicating if the block device is read-only (true if read-"
5233 "only, false if not)."
5237 #: ../src/guestfs-actions.pod:626 ../src/guestfs-actions.pod:1367
5238 #: ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1862
5239 #: ../src/guestfs-actions.pod:1873 ../src/guestfs-actions.pod:1945
5240 #: ../src/guestfs-actions.pod:2000 ../src/guestfs-actions.pod:2015
5241 #: ../src/guestfs-actions.pod:2040 ../src/guestfs-actions.pod:2063
5242 #: ../src/guestfs-actions.pod:2790 ../src/guestfs-actions.pod:2804
5243 #: ../src/guestfs-actions.pod:2819 ../src/guestfs-actions.pod:2833
5244 #: ../src/guestfs-actions.pod:2849 ../src/guestfs-actions.pod:2864
5245 #: ../src/guestfs-actions.pod:2880 ../src/guestfs-actions.pod:2894
5246 #: ../src/guestfs-actions.pod:2907 ../src/guestfs-actions.pod:2921
5247 #: ../src/guestfs-actions.pod:2936 ../src/guestfs-actions.pod:2951
5248 #: ../src/guestfs-actions.pod:4369
5249 msgid "This function returns a C truth value on success or -1 on error."
5253 #: ../src/guestfs-actions.pod:630
5254 msgid "guestfs_blockdev_getsize64"
5258 #: ../src/guestfs-actions.pod:632
5262 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
5263 " const char *device);\n"
5268 #: ../src/guestfs-actions.pod:636 ../fish/guestfish-actions.pod:433
5269 msgid "This returns the size of the device in bytes."
5273 #: ../src/guestfs-actions.pod:638
5274 msgid "See also C<guestfs_blockdev_getsz>."
5278 #: ../src/guestfs-actions.pod:646
5279 msgid "guestfs_blockdev_getss"
5283 #: ../src/guestfs-actions.pod:648
5287 " guestfs_blockdev_getss (guestfs_h *g,\n"
5288 " const char *device);\n"
5293 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:443
5295 "This returns the size of sectors on a block device. Usually 512, but can be "
5296 "larger for modern devices."
5300 #: ../src/guestfs-actions.pod:655
5302 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
5307 #: ../src/guestfs-actions.pod:664
5308 msgid "guestfs_blockdev_getsz"
5312 #: ../src/guestfs-actions.pod:666
5316 " guestfs_blockdev_getsz (guestfs_h *g,\n"
5317 " const char *device);\n"
5322 #: ../src/guestfs-actions.pod:670 ../fish/guestfish-actions.pod:455
5324 "This returns the size of the device in units of 512-byte sectors (even if "
5325 "the sectorsize isn't 512 bytes ... weird)."
5329 #: ../src/guestfs-actions.pod:673
5331 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
5332 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
5336 #: ../src/guestfs-actions.pod:683
5337 msgid "guestfs_blockdev_rereadpt"
5341 #: ../src/guestfs-actions.pod:685
5345 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5346 " const char *device);\n"
5351 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:468
5352 msgid "Reread the partition table on C<device>."
5356 #: ../src/guestfs-actions.pod:697
5357 msgid "guestfs_blockdev_setbsz"
5361 #: ../src/guestfs-actions.pod:699
5365 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5366 " const char *device,\n"
5367 " int blocksize);\n"
5372 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:476
5373 msgid "This sets the block size of a device."
5377 #: ../src/guestfs-actions.pod:715
5378 msgid "guestfs_blockdev_setro"
5382 #: ../src/guestfs-actions.pod:717
5386 " guestfs_blockdev_setro (guestfs_h *g,\n"
5387 " const char *device);\n"
5392 #: ../src/guestfs-actions.pod:721 ../fish/guestfish-actions.pod:487
5393 msgid "Sets the block device named C<device> to read-only."
5397 #: ../src/guestfs-actions.pod:729
5398 msgid "guestfs_blockdev_setrw"
5402 #: ../src/guestfs-actions.pod:731
5406 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5407 " const char *device);\n"
5412 #: ../src/guestfs-actions.pod:735 ../fish/guestfish-actions.pod:495
5413 msgid "Sets the block device named C<device> to read-write."
5417 #: ../src/guestfs-actions.pod:743
5418 msgid "guestfs_case_sensitive_path"
5422 #: ../src/guestfs-actions.pod:745
5426 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5427 " const char *path);\n"
5432 #: ../src/guestfs-actions.pod:749 ../fish/guestfish-actions.pod:503
5434 "This can be used to resolve case insensitive paths on a filesystem which is "
5435 "case sensitive. The use case is to resolve paths which you have read from "
5436 "Windows configuration files or the Windows Registry, to the true path."
5440 #: ../src/guestfs-actions.pod:754 ../fish/guestfish-actions.pod:508
5442 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5443 "(and probably others), which is that although the underlying filesystem is "
5444 "case-insensitive, the driver exports the filesystem to Linux as case-"
5449 #: ../src/guestfs-actions.pod:759 ../fish/guestfish-actions.pod:513
5451 "One consequence of this is that special directories such as C<c:\\windows> "
5452 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5453 "precise details of how they were created. In Windows itself this would not "
5458 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:519
5460 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
5465 #: ../src/guestfs-actions.pod:768 ../fish/guestfish-actions.pod:522
5467 "This function resolves the true case of each element in the path and returns "
5468 "the case-sensitive path."
5472 #: ../src/guestfs-actions.pod:771
5474 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
5475 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5476 "how the directories were originally created under Windows)."
5480 #: ../src/guestfs-actions.pod:776 ../fish/guestfish-actions.pod:530
5481 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5485 #: ../src/guestfs-actions.pod:779
5486 msgid "See also C<guestfs_realpath>."
5490 #: ../src/guestfs-actions.pod:784 ../src/guestfs-actions.pod:6304
5491 msgid "(Added in 1.0.75)"
5495 #: ../src/guestfs-actions.pod:786
5500 #: ../src/guestfs-actions.pod:788
5504 " guestfs_cat (guestfs_h *g,\n"
5505 " const char *path);\n"
5510 #: ../src/guestfs-actions.pod:792 ../src/guestfs-actions.pod:4858
5511 #: ../fish/guestfish-actions.pod:539 ../fish/guestfish-actions.pod:3210
5512 msgid "Return the contents of the file named C<path>."
5516 #: ../src/guestfs-actions.pod:794
5518 "Note that this function cannot correctly handle binary files (specifically, "
5519 "files containing C<\\0> character which is treated as end of string). For "
5520 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5521 "functions which have a more complex interface."
5525 #: ../src/guestfs-actions.pod:802 ../src/guestfs-actions.pod:981
5526 #: ../src/guestfs-actions.pod:1001 ../src/guestfs-actions.pod:1331
5527 #: ../src/guestfs-actions.pod:1350 ../src/guestfs-actions.pod:1453
5528 #: ../src/guestfs-actions.pod:1472 ../src/guestfs-actions.pod:1721
5529 #: ../src/guestfs-actions.pod:2140 ../src/guestfs-actions.pod:2159
5530 #: ../src/guestfs-actions.pod:2202 ../src/guestfs-actions.pod:2226
5531 #: ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2272
5532 #: ../src/guestfs-actions.pod:4639 ../src/guestfs-actions.pod:4665
5533 #: ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4823
5534 #: ../src/guestfs-actions.pod:4847 ../src/guestfs-actions.pod:5699
5535 #: ../src/guestfs-actions.pod:5754 ../src/guestfs-actions.pod:5900
5536 #: ../src/guestfs-actions.pod:5924 ../src/guestfs-actions.pod:6577
5537 #: ../src/guestfs-actions.pod:6603 ../src/guestfs-actions.pod:6629
5538 #: ../src/guestfs-actions.pod:6648 ../src/guestfs-actions.pod:6733
5539 #: ../src/guestfs-actions.pod:6752 ../src/guestfs-actions.pod:6798
5540 #: ../src/guestfs-actions.pod:6817 ../fish/guestfish-actions.pod:546
5541 #: ../fish/guestfish-actions.pod:681 ../fish/guestfish-actions.pod:693
5542 #: ../fish/guestfish-actions.pod:894 ../fish/guestfish-actions.pod:904
5543 #: ../fish/guestfish-actions.pod:971 ../fish/guestfish-actions.pod:981
5544 #: ../fish/guestfish-actions.pod:1176 ../fish/guestfish-actions.pod:1451
5545 #: ../fish/guestfish-actions.pod:1461 ../fish/guestfish-actions.pod:1489
5546 #: ../fish/guestfish-actions.pod:1504 ../fish/guestfish-actions.pod:1514
5547 #: ../fish/guestfish-actions.pod:1533 ../fish/guestfish-actions.pod:3080
5548 #: ../fish/guestfish-actions.pod:3095 ../fish/guestfish-actions.pod:3171
5549 #: ../fish/guestfish-actions.pod:3188 ../fish/guestfish-actions.pod:3203
5550 #: ../fish/guestfish-actions.pod:3786 ../fish/guestfish-actions.pod:3832
5551 #: ../fish/guestfish-actions.pod:3917 ../fish/guestfish-actions.pod:3932
5552 #: ../fish/guestfish-actions.pod:4342 ../fish/guestfish-actions.pod:4360
5553 #: ../fish/guestfish-actions.pod:4377 ../fish/guestfish-actions.pod:4387
5554 #: ../fish/guestfish-actions.pod:4435 ../fish/guestfish-actions.pod:4445
5555 #: ../fish/guestfish-actions.pod:4474 ../fish/guestfish-actions.pod:4484
5557 "Because of the message protocol, there is a transfer limit of somewhere "
5558 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5562 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:3033
5563 #: ../src/guestfs-actions.pod:3095 ../src/guestfs-actions.pod:3112
5564 #: ../src/guestfs-actions.pod:3200 ../src/guestfs-actions.pod:3606
5565 #: ../src/guestfs-actions.pod:3621 ../src/guestfs-actions.pod:4745
5566 #: ../src/guestfs-actions.pod:4760 ../src/guestfs-actions.pod:6463
5567 #: ../src/guestfs-actions.pod:6478
5568 msgid "(Added in 0.4)"
5572 #: ../src/guestfs-actions.pod:807
5573 msgid "guestfs_checksum"
5577 #: ../src/guestfs-actions.pod:809
5581 " guestfs_checksum (guestfs_h *g,\n"
5582 " const char *csumtype,\n"
5583 " const char *path);\n"
5588 #: ../src/guestfs-actions.pod:814 ../fish/guestfish-actions.pod:553
5590 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5594 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:556
5596 "The type of checksum to compute is given by the C<csumtype> parameter which "
5597 "must have one of the following values:"
5601 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:561
5606 #: ../src/guestfs-actions.pod:824 ../fish/guestfish-actions.pod:563
5608 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5613 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:566
5618 #: ../src/guestfs-actions.pod:829 ../fish/guestfish-actions.pod:568
5619 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5623 #: ../src/guestfs-actions.pod:831 ../fish/guestfish-actions.pod:570
5628 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:572
5629 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5633 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:574
5638 #: ../src/guestfs-actions.pod:837 ../fish/guestfish-actions.pod:576
5639 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5643 #: ../src/guestfs-actions.pod:839 ../fish/guestfish-actions.pod:578
5648 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:580
5649 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5653 #: ../src/guestfs-actions.pod:843 ../fish/guestfish-actions.pod:582
5658 #: ../src/guestfs-actions.pod:845 ../fish/guestfish-actions.pod:584
5659 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5663 #: ../src/guestfs-actions.pod:847 ../fish/guestfish-actions.pod:586
5668 #: ../src/guestfs-actions.pod:849 ../fish/guestfish-actions.pod:588
5669 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5673 #: ../src/guestfs-actions.pod:853 ../fish/guestfish-actions.pod:592
5674 msgid "The checksum is returned as a printable string."
5678 #: ../src/guestfs-actions.pod:855
5679 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
5683 #: ../src/guestfs-actions.pod:857
5684 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
5688 #: ../src/guestfs-actions.pod:862 ../src/guestfs-actions.pod:1209
5689 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:2806
5690 #: ../src/guestfs-actions.pod:2835 ../src/guestfs-actions.pod:2896
5691 #: ../src/guestfs-actions.pod:2923 ../src/guestfs-actions.pod:6165
5692 msgid "(Added in 1.0.2)"
5696 #: ../src/guestfs-actions.pod:864
5697 msgid "guestfs_checksum_device"
5701 #: ../src/guestfs-actions.pod:866
5705 " guestfs_checksum_device (guestfs_h *g,\n"
5706 " const char *csumtype,\n"
5707 " const char *device);\n"
5712 #: ../src/guestfs-actions.pod:871
5714 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5715 "device named C<device>. For the types of checksums supported see the "
5716 "C<guestfs_checksum> command."
5720 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:4275
5721 #: ../src/guestfs-actions.pod:4334 ../src/guestfs-actions.pod:4371
5722 #: ../src/guestfs-actions.pod:4389 ../src/guestfs-actions.pod:4566
5723 #: ../src/guestfs-actions.pod:6079 ../src/guestfs-actions.pod:6093
5724 #: ../src/guestfs-actions.pod:6490
5725 msgid "(Added in 1.3.2)"
5729 #: ../src/guestfs-actions.pod:880
5730 msgid "guestfs_checksums_out"
5734 #: ../src/guestfs-actions.pod:882
5738 " guestfs_checksums_out (guestfs_h *g,\n"
5739 " const char *csumtype,\n"
5740 " const char *directory,\n"
5741 " const char *sumsfile);\n"
5746 #: ../src/guestfs-actions.pod:888 ../fish/guestfish-actions.pod:610
5748 "This command computes the checksums of all regular files in C<directory> and "
5749 "then emits a list of those checksums to the local output file C<sumsfile>."
5753 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:614
5755 "This can be used for verifying the integrity of a virtual machine. However "
5756 "to be properly secure you should pay attention to the output of the checksum "
5757 "command (it uses the ones from GNU coreutils). In particular when the "
5758 "filename is not printable, coreutils uses a special backslash syntax. For "
5759 "more information, see the GNU coreutils info file."
5763 #: ../src/guestfs-actions.pod:902
5764 msgid "(Added in 1.3.7)"
5768 #: ../src/guestfs-actions.pod:904
5769 msgid "guestfs_chmod"
5773 #: ../src/guestfs-actions.pod:906
5777 " guestfs_chmod (guestfs_h *g,\n"
5779 " const char *path);\n"
5784 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:628
5786 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5791 #: ../src/guestfs-actions.pod:914 ../fish/guestfish-actions.pod:631
5793 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5794 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5799 #: ../src/guestfs-actions.pod:918 ../src/guestfs-actions.pod:3859
5800 #: ../src/guestfs-actions.pod:3974 ../src/guestfs-actions.pod:3993
5801 #: ../src/guestfs-actions.pod:4012 ../fish/guestfish-actions.pod:635
5802 #: ../fish/guestfish-actions.pod:2570 ../fish/guestfish-actions.pod:2655
5803 #: ../fish/guestfish-actions.pod:2665 ../fish/guestfish-actions.pod:2675
5804 msgid "The mode actually set is affected by the umask."
5808 #: ../src/guestfs-actions.pod:924
5809 msgid "guestfs_chown"
5813 #: ../src/guestfs-actions.pod:926
5817 " guestfs_chown (guestfs_h *g,\n"
5820 " const char *path);\n"
5825 #: ../src/guestfs-actions.pod:932 ../fish/guestfish-actions.pod:641
5826 msgid "Change the file owner to C<owner> and group to C<group>."
5830 #: ../src/guestfs-actions.pod:934 ../src/guestfs-actions.pod:2993
5831 #: ../fish/guestfish-actions.pod:643 ../fish/guestfish-actions.pod:2048
5833 "Only numeric uid and gid are supported. If you want to use names, you will "
5834 "need to locate and parse the password file yourself (Augeas support makes "
5835 "this relatively easy)."
5839 #: ../src/guestfs-actions.pod:942
5840 msgid "guestfs_command"
5844 #: ../src/guestfs-actions.pod:944
5848 " guestfs_command (guestfs_h *g,\n"
5849 " char *const *arguments);\n"
5854 #: ../src/guestfs-actions.pod:948 ../fish/guestfish-actions.pod:651
5856 "This call runs a command from the guest filesystem. The filesystem must be "
5857 "mounted, and must contain a compatible operating system (ie. something "
5858 "Linux, with the same or compatible processor architecture)."
5862 #: ../src/guestfs-actions.pod:953
5864 "The single parameter is an argv-style list of arguments. The first element "
5865 "is the name of the program to run. Subsequent elements are parameters. The "
5866 "list must be non-empty (ie. must contain a program name). Note that the "
5867 "command runs directly, and is I<not> invoked via the shell (see "
5872 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:663
5873 msgid "The return value is anything printed to I<stdout> by the command."
5877 #: ../src/guestfs-actions.pod:963 ../fish/guestfish-actions.pod:666
5879 "If the command returns a non-zero exit status, then this function returns an "
5880 "error message. The error message string is the content of I<stderr> from "
5885 #: ../src/guestfs-actions.pod:967 ../fish/guestfish-actions.pod:670
5887 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
5888 "bin>. If you require a program from another location, you should provide "
5889 "the full path in the first parameter."
5893 #: ../src/guestfs-actions.pod:972 ../fish/guestfish-actions.pod:675
5895 "Shared libraries and data files required by the program must be available on "
5896 "filesystems which are mounted in the correct places. It is the caller's "
5897 "responsibility to ensure all filesystems that are needed are mounted at the "
5902 #: ../src/guestfs-actions.pod:984 ../src/guestfs-actions.pod:1004
5903 #: ../src/guestfs-actions.pod:1506
5904 msgid "(Added in 0.9.1)"
5908 #: ../src/guestfs-actions.pod:986
5909 msgid "guestfs_command_lines"
5913 #: ../src/guestfs-actions.pod:988
5917 " guestfs_command_lines (guestfs_h *g,\n"
5918 " char *const *arguments);\n"
5923 #: ../src/guestfs-actions.pod:992
5925 "This is the same as C<guestfs_command>, but splits the result into a list of "
5930 #: ../src/guestfs-actions.pod:995
5931 msgid "See also: C<guestfs_sh_lines>"
5935 #: ../src/guestfs-actions.pod:1006
5936 msgid "guestfs_config"
5940 #: ../src/guestfs-actions.pod:1008
5944 " guestfs_config (guestfs_h *g,\n"
5945 " const char *qemuparam,\n"
5946 " const char *qemuvalue);\n"
5951 #: ../src/guestfs-actions.pod:1013 ../fish/guestfish-actions.pod:700
5953 "This can be used to add arbitrary qemu command line parameters of the form "
5954 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
5955 "setting some parameters which would interfere with parameters that we use."
5959 #: ../src/guestfs-actions.pod:1018 ../fish/guestfish-actions.pod:705
5960 msgid "The first character of C<param> string must be a C<-> (dash)."
5964 #: ../src/guestfs-actions.pod:1020 ../fish/guestfish-actions.pod:707
5965 msgid "C<value> can be NULL."
5969 #: ../src/guestfs-actions.pod:1026
5970 msgid "guestfs_copy_size"
5974 #: ../src/guestfs-actions.pod:1028
5978 " guestfs_copy_size (guestfs_h *g,\n"
5979 " const char *src,\n"
5980 " const char *dest,\n"
5986 #: ../src/guestfs-actions.pod:1034 ../fish/guestfish-actions.pod:713
5988 "This command copies exactly C<size> bytes from one source device or file "
5989 "C<src> to another destination device or file C<dest>."
5993 #: ../src/guestfs-actions.pod:1037 ../fish/guestfish-actions.pod:716
5995 "Note this will fail if the source is too short or if the destination is not "
6000 #: ../src/guestfs-actions.pod:1042 ../src/guestfs-actions.pod:1204
6001 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:1655
6002 #: ../src/guestfs-actions.pod:1677 ../src/guestfs-actions.pod:6669
6003 #: ../src/guestfs-actions.pod:6688
6005 "This long-running command can generate progress notification messages so "
6006 "that the caller can display a progress bar or indicator. To receive these "
6007 "messages, the caller must register a progress callback. See L<guestfs(3)/"
6008 "guestfs_set_progress_callback>."
6012 #: ../src/guestfs-actions.pod:1047 ../src/guestfs-actions.pod:3634
6013 #: ../src/guestfs-actions.pod:4773 ../src/guestfs-actions.pod:6396
6014 #: ../src/guestfs-actions.pod:6416 ../src/guestfs-actions.pod:6503
6015 msgid "(Added in 1.0.87)"
6019 #: ../src/guestfs-actions.pod:1049
6024 #: ../src/guestfs-actions.pod:1051
6028 " guestfs_cp (guestfs_h *g,\n"
6029 " const char *src,\n"
6030 " const char *dest);\n"
6035 #: ../src/guestfs-actions.pod:1056 ../fish/guestfish-actions.pod:723
6037 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6038 "destination filename or destination directory."
6042 #: ../src/guestfs-actions.pod:1061 ../src/guestfs-actions.pod:1075
6043 #: ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:1260
6044 #: ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:4238
6045 #: ../src/guestfs-actions.pod:4616
6046 msgid "(Added in 1.0.18)"
6050 #: ../src/guestfs-actions.pod:1063
6051 msgid "guestfs_cp_a"
6055 #: ../src/guestfs-actions.pod:1065
6059 " guestfs_cp_a (guestfs_h *g,\n"
6060 " const char *src,\n"
6061 " const char *dest);\n"
6066 #: ../src/guestfs-actions.pod:1070 ../fish/guestfish-actions.pod:730
6068 "This copies a file or directory from C<src> to C<dest> recursively using the "
6073 #: ../src/guestfs-actions.pod:1077
6078 #: ../src/guestfs-actions.pod:1079
6082 " guestfs_dd (guestfs_h *g,\n"
6083 " const char *src,\n"
6084 " const char *dest);\n"
6089 #: ../src/guestfs-actions.pod:1084 ../fish/guestfish-actions.pod:737
6091 "This command copies from one source device or file C<src> to another "
6092 "destination device or file C<dest>. Normally you would use this to copy to "
6093 "or from a device or partition, for example to duplicate a filesystem."
6097 #: ../src/guestfs-actions.pod:1089
6099 "If the destination is a device, it must be as large or larger than the "
6100 "source file or device, otherwise the copy will fail. This command cannot do "
6101 "partial copies (see C<guestfs_copy_size>)."
6105 #: ../src/guestfs-actions.pod:1097
6106 msgid "guestfs_debug"
6110 #: ../src/guestfs-actions.pod:1099
6114 " guestfs_debug (guestfs_h *g,\n"
6115 " const char *subcmd,\n"
6116 " char *const *extraargs);\n"
6121 #: ../src/guestfs-actions.pod:1104
6123 "The C<guestfs_debug> command exposes some internals of C<guestfsd> (the "
6124 "guestfs daemon) that runs inside the qemu subprocess."
6128 #: ../src/guestfs-actions.pod:1108 ../fish/guestfish-actions.pod:754
6130 "There is no comprehensive help for this command. You have to look at the "
6131 "file C<daemon/debug.c> in the libguestfs source to find out what you can do."
6135 #: ../src/guestfs-actions.pod:1115
6136 msgid "(Added in 1.0.11)"
6140 #: ../src/guestfs-actions.pod:1117
6141 msgid "guestfs_debug_upload"
6145 #: ../src/guestfs-actions.pod:1119
6149 " guestfs_debug_upload (guestfs_h *g,\n"
6150 " const char *filename,\n"
6151 " const char *tmpname,\n"
6157 #: ../src/guestfs-actions.pod:1125
6159 "The C<guestfs_debug_upload> command uploads a file to the libguestfs "
6164 #: ../src/guestfs-actions.pod:1128 ../fish/guestfish-actions.pod:765
6166 "There is no comprehensive help for this command. You have to look at the "
6167 "file C<daemon/debug.c> in the libguestfs source to find out what it is for."
6171 #: ../src/guestfs-actions.pod:1136
6176 #: ../src/guestfs-actions.pod:1138
6180 " guestfs_df (guestfs_h *g);\n"
6185 #: ../src/guestfs-actions.pod:1141 ../fish/guestfish-actions.pod:775
6186 msgid "This command runs the C<df> command to report disk space used."
6190 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1160
6191 #: ../fish/guestfish-actions.pod:777 ../fish/guestfish-actions.pod:788
6193 "This command is mostly useful for interactive sessions. It is I<not> "
6194 "intended that you try to parse the output string. Use C<statvfs> from "
6199 #: ../src/guestfs-actions.pod:1150 ../src/guestfs-actions.pod:1167
6200 #: ../src/guestfs-actions.pod:1280 ../src/guestfs-actions.pod:2205
6201 #: ../src/guestfs-actions.pod:2229 ../src/guestfs-actions.pod:2297
6202 #: ../src/guestfs-actions.pod:3745 ../src/guestfs-actions.pod:4138
6203 #: ../src/guestfs-actions.pod:5903 ../src/guestfs-actions.pod:5927
6204 #: ../src/guestfs-actions.pod:6536 ../src/guestfs-actions.pod:6549
6205 #: ../src/guestfs-actions.pod:6562
6206 msgid "(Added in 1.0.54)"
6210 #: ../src/guestfs-actions.pod:1152
6211 msgid "guestfs_df_h"
6215 #: ../src/guestfs-actions.pod:1154
6219 " guestfs_df_h (guestfs_h *g);\n"
6224 #: ../src/guestfs-actions.pod:1157 ../fish/guestfish-actions.pod:785
6226 "This command runs the C<df -h> command to report disk space used in human-"
6231 #: ../src/guestfs-actions.pod:1169
6232 msgid "guestfs_dmesg"
6236 #: ../src/guestfs-actions.pod:1171
6240 " guestfs_dmesg (guestfs_h *g);\n"
6245 #: ../src/guestfs-actions.pod:1174 ../fish/guestfish-actions.pod:796
6247 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
6248 "This is sometimes useful for extended debugging of problems."
6252 #: ../src/guestfs-actions.pod:1178
6254 "Another way to get the same information is to enable verbose messages with "
6255 "C<guestfs_set_verbose> or by setting the environment variable "
6256 "C<LIBGUESTFS_DEBUG=1> before running the program."
6260 #: ../src/guestfs-actions.pod:1188
6261 msgid "guestfs_download"
6265 #: ../src/guestfs-actions.pod:1190
6269 " guestfs_download (guestfs_h *g,\n"
6270 " const char *remotefilename,\n"
6271 " const char *filename);\n"
6276 #: ../src/guestfs-actions.pod:1195 ../src/guestfs-actions.pod:1220
6277 #: ../fish/guestfish-actions.pod:809 ../fish/guestfish-actions.pod:822
6279 "Download file C<remotefilename> and save it as C<filename> on the local "
6284 #: ../src/guestfs-actions.pod:1198 ../src/guestfs-actions.pod:6159
6285 #: ../fish/guestfish-actions.pod:812 ../fish/guestfish-actions.pod:4090
6286 msgid "C<filename> can also be a named pipe."
6290 #: ../src/guestfs-actions.pod:1200
6291 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
6295 #: ../src/guestfs-actions.pod:1211
6296 msgid "guestfs_download_offset"
6300 #: ../src/guestfs-actions.pod:1213
6304 " guestfs_download_offset (guestfs_h *g,\n"
6305 " const char *remotefilename,\n"
6306 " const char *filename,\n"
6307 " int64_t offset,\n"
6313 #: ../src/guestfs-actions.pod:1223 ../fish/guestfish-actions.pod:825
6315 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6316 "region must be within the file or device)."
6320 #: ../src/guestfs-actions.pod:1226
6322 "Note that there is no limit on the amount of data that can be downloaded "
6323 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
6324 "full amount unless an error occurs."
6328 #: ../src/guestfs-actions.pod:1231
6329 msgid "See also C<guestfs_download>, C<guestfs_pread>."
6333 #: ../src/guestfs-actions.pod:1240 ../src/guestfs-actions.pod:6194
6334 msgid "(Added in 1.5.17)"
6338 #: ../src/guestfs-actions.pod:1242
6339 msgid "guestfs_drop_caches"
6343 #: ../src/guestfs-actions.pod:1244
6347 " guestfs_drop_caches (guestfs_h *g,\n"
6348 " int whattodrop);\n"
6353 #: ../src/guestfs-actions.pod:1248 ../fish/guestfish-actions.pod:841
6355 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6356 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6357 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6361 #: ../src/guestfs-actions.pod:1253 ../fish/guestfish-actions.pod:846
6362 msgid "Setting C<whattodrop> to 3 should drop everything."
6366 #: ../src/guestfs-actions.pod:1255 ../fish/guestfish-actions.pod:848
6368 "This automatically calls L<sync(2)> before the operation, so that the "
6369 "maximum guest memory is freed."
6373 #: ../src/guestfs-actions.pod:1262
6378 #: ../src/guestfs-actions.pod:1264
6382 " guestfs_du (guestfs_h *g,\n"
6383 " const char *path);\n"
6388 #: ../src/guestfs-actions.pod:1268 ../fish/guestfish-actions.pod:855
6390 "This command runs the C<du -s> command to estimate file space usage for "
6395 #: ../src/guestfs-actions.pod:1271 ../fish/guestfish-actions.pod:858
6397 "C<path> can be a file or a directory. If C<path> is a directory then the "
6398 "estimate includes the contents of the directory and all subdirectories "
6403 #: ../src/guestfs-actions.pod:1275 ../fish/guestfish-actions.pod:862
6405 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6409 #: ../src/guestfs-actions.pod:1282
6410 msgid "guestfs_e2fsck_f"
6414 #: ../src/guestfs-actions.pod:1284
6418 " guestfs_e2fsck_f (guestfs_h *g,\n"
6419 " const char *device);\n"
6424 #: ../src/guestfs-actions.pod:1288 ../fish/guestfish-actions.pod:869
6426 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6427 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
6432 #: ../src/guestfs-actions.pod:1292
6434 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
6435 "Normally you should use C<guestfs_fsck>."
6439 #: ../src/guestfs-actions.pod:1297
6440 msgid "(Added in 1.0.29)"
6444 #: ../src/guestfs-actions.pod:1299
6445 msgid "guestfs_echo_daemon"
6449 #: ../src/guestfs-actions.pod:1301
6453 " guestfs_echo_daemon (guestfs_h *g,\n"
6454 " char *const *words);\n"
6459 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:880
6461 "This command concatenates the list of C<words> passed with single spaces "
6462 "between them and returns the resulting string."
6466 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:883
6467 msgid "You can use this command to test the connection through to the daemon."
6471 #: ../src/guestfs-actions.pod:1310
6472 msgid "See also C<guestfs_ping_daemon>."
6476 #: ../src/guestfs-actions.pod:1315 ../src/guestfs-actions.pod:2042
6477 #: ../src/guestfs-actions.pod:5407
6478 msgid "(Added in 1.0.69)"
6482 #: ../src/guestfs-actions.pod:1317
6483 msgid "guestfs_egrep"
6487 #: ../src/guestfs-actions.pod:1319
6491 " guestfs_egrep (guestfs_h *g,\n"
6492 " const char *regex,\n"
6493 " const char *path);\n"
6498 #: ../src/guestfs-actions.pod:1324 ../fish/guestfish-actions.pod:891
6500 "This calls the external C<egrep> program and returns the matching lines."
6504 #: ../src/guestfs-actions.pod:1334 ../src/guestfs-actions.pod:1353
6505 #: ../src/guestfs-actions.pod:1410 ../src/guestfs-actions.pod:1456
6506 #: ../src/guestfs-actions.pod:1475 ../src/guestfs-actions.pod:2143
6507 #: ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:2318
6508 #: ../src/guestfs-actions.pod:2331 ../src/guestfs-actions.pod:2346
6509 #: ../src/guestfs-actions.pod:2392 ../src/guestfs-actions.pod:2415
6510 #: ../src/guestfs-actions.pod:2428 ../src/guestfs-actions.pod:3125
6511 #: ../src/guestfs-actions.pod:3139 ../src/guestfs-actions.pod:3152
6512 #: ../src/guestfs-actions.pod:3166 ../src/guestfs-actions.pod:4073
6513 #: ../src/guestfs-actions.pod:4952 ../src/guestfs-actions.pod:5001
6514 #: ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5783
6515 #: ../src/guestfs-actions.pod:5796 ../src/guestfs-actions.pod:5809
6516 #: ../src/guestfs-actions.pod:5831 ../src/guestfs-actions.pod:5844
6517 #: ../src/guestfs-actions.pod:5857 ../src/guestfs-actions.pod:5870
6518 #: ../src/guestfs-actions.pod:6632 ../src/guestfs-actions.pod:6651
6519 #: ../src/guestfs-actions.pod:6736 ../src/guestfs-actions.pod:6755
6520 #: ../src/guestfs-actions.pod:6801 ../src/guestfs-actions.pod:6820
6521 msgid "(Added in 1.0.66)"
6525 #: ../src/guestfs-actions.pod:1336
6526 msgid "guestfs_egrepi"
6530 #: ../src/guestfs-actions.pod:1338
6534 " guestfs_egrepi (guestfs_h *g,\n"
6535 " const char *regex,\n"
6536 " const char *path);\n"
6541 #: ../src/guestfs-actions.pod:1343 ../fish/guestfish-actions.pod:901
6543 "This calls the external C<egrep -i> program and returns the matching lines."
6547 #: ../src/guestfs-actions.pod:1355
6548 msgid "guestfs_equal"
6552 #: ../src/guestfs-actions.pod:1357
6556 " guestfs_equal (guestfs_h *g,\n"
6557 " const char *file1,\n"
6558 " const char *file2);\n"
6563 #: ../src/guestfs-actions.pod:1362 ../fish/guestfish-actions.pod:911
6565 "This compares the two files C<file1> and C<file2> and returns true if their "
6566 "content is exactly equal, or false otherwise."
6570 #: ../src/guestfs-actions.pod:1365 ../fish/guestfish-actions.pod:914
6571 msgid "The external L<cmp(1)> program is used for the comparison."
6575 #: ../src/guestfs-actions.pod:1371
6576 msgid "guestfs_exists"
6580 #: ../src/guestfs-actions.pod:1373
6584 " guestfs_exists (guestfs_h *g,\n"
6585 " const char *path);\n"
6590 #: ../src/guestfs-actions.pod:1377 ../fish/guestfish-actions.pod:920
6592 "This returns C<true> if and only if there is a file, directory (or anything) "
6593 "with the given C<path> name."
6597 #: ../src/guestfs-actions.pod:1380
6598 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6602 #: ../src/guestfs-actions.pod:1386
6603 msgid "guestfs_fallocate"
6607 #: ../src/guestfs-actions.pod:1388
6611 " guestfs_fallocate (guestfs_h *g,\n"
6612 " const char *path,\n"
6618 #: ../src/guestfs-actions.pod:1393 ../src/guestfs-actions.pod:1419
6619 #: ../fish/guestfish-actions.pod:929 ../fish/guestfish-actions.pod:948
6621 "This command preallocates a file (containing zero bytes) named C<path> of "
6622 "size C<len> bytes. If the file exists already, it is overwritten."
6626 #: ../src/guestfs-actions.pod:1397 ../fish/guestfish-actions.pod:933
6628 "Do not confuse this with the guestfish-specific C<alloc> command which "
6629 "allocates a file in the host and attaches it as a device."
6633 #: ../src/guestfs-actions.pod:1403 ../fish/guestfish-actions.pod:937
6635 "This function is deprecated. In new code, use the C<fallocate64> call "
6640 #: ../src/guestfs-actions.pod:1412
6641 msgid "guestfs_fallocate64"
6645 #: ../src/guestfs-actions.pod:1414
6649 " guestfs_fallocate64 (guestfs_h *g,\n"
6650 " const char *path,\n"
6656 #: ../src/guestfs-actions.pod:1423
6658 "Note that this call allocates disk blocks for the file. To create a sparse "
6659 "file use C<guestfs_truncate_size> instead."
6663 #: ../src/guestfs-actions.pod:1426
6665 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6666 "oversight it only allowed 30 bit lengths to be specified, effectively "
6667 "limiting the maximum size of files created through that call to 1GB."
6671 #: ../src/guestfs-actions.pod:1431 ../fish/guestfish-actions.pod:960
6673 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6674 "commands which create a file in the host and attach it as a device."
6678 #: ../src/guestfs-actions.pod:1437
6679 msgid "(Added in 1.3.17)"
6683 #: ../src/guestfs-actions.pod:1439
6684 msgid "guestfs_fgrep"
6688 #: ../src/guestfs-actions.pod:1441
6692 " guestfs_fgrep (guestfs_h *g,\n"
6693 " const char *pattern,\n"
6694 " const char *path);\n"
6699 #: ../src/guestfs-actions.pod:1446 ../fish/guestfish-actions.pod:968
6701 "This calls the external C<fgrep> program and returns the matching lines."
6705 #: ../src/guestfs-actions.pod:1458
6706 msgid "guestfs_fgrepi"
6710 #: ../src/guestfs-actions.pod:1460
6714 " guestfs_fgrepi (guestfs_h *g,\n"
6715 " const char *pattern,\n"
6716 " const char *path);\n"
6721 #: ../src/guestfs-actions.pod:1465 ../fish/guestfish-actions.pod:978
6723 "This calls the external C<fgrep -i> program and returns the matching lines."
6727 #: ../src/guestfs-actions.pod:1477
6728 msgid "guestfs_file"
6732 #: ../src/guestfs-actions.pod:1479
6736 " guestfs_file (guestfs_h *g,\n"
6737 " const char *path);\n"
6742 #: ../src/guestfs-actions.pod:1483 ../fish/guestfish-actions.pod:988
6744 "This call uses the standard L<file(1)> command to determine the type or "
6745 "contents of the file."
6749 #: ../src/guestfs-actions.pod:1486 ../fish/guestfish-actions.pod:991
6751 "This call will also transparently look inside various types of compressed "
6756 #: ../src/guestfs-actions.pod:1489 ../fish/guestfish-actions.pod:994
6758 "The exact command which runs is C<file -zb path>. Note in particular that "
6759 "the filename is not prepended to the output (the C<-b> option)."
6763 #: ../src/guestfs-actions.pod:1493
6765 "This command can also be used on C</dev/> devices (and partitions, LV "
6766 "names). You can for example use this to determine if a device contains a "
6767 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
6771 #: ../src/guestfs-actions.pod:1498 ../fish/guestfish-actions.pod:1003
6773 "If the C<path> does not begin with C</dev/> then this command only works for "
6774 "the content of regular files. For other file types (directory, symbolic "
6775 "link etc) it will just return the string C<directory> etc."
6779 #: ../src/guestfs-actions.pod:1508
6780 msgid "guestfs_file_architecture"
6784 #: ../src/guestfs-actions.pod:1510
6788 " guestfs_file_architecture (guestfs_h *g,\n"
6789 " const char *filename);\n"
6794 #: ../src/guestfs-actions.pod:1514 ../fish/guestfish-actions.pod:1012
6796 "This detects the architecture of the binary C<filename>, and returns it if "
6801 #: ../src/guestfs-actions.pod:1517 ../fish/guestfish-actions.pod:1015
6802 msgid "Currently defined architectures are:"
6806 #: ../src/guestfs-actions.pod:1521 ../fish/guestfish-actions.pod:1019
6811 #: ../src/guestfs-actions.pod:1523 ../fish/guestfish-actions.pod:1021
6813 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6814 "irrespective of the precise processor requirements of the binary."
6818 #: ../src/guestfs-actions.pod:1526 ../fish/guestfish-actions.pod:1024
6823 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1026
6824 msgid "64 bit x86-64."
6828 #: ../src/guestfs-actions.pod:1530 ../fish/guestfish-actions.pod:1028
6833 #: ../src/guestfs-actions.pod:1532 ../fish/guestfish-actions.pod:1030
6834 msgid "32 bit SPARC."
6838 #: ../src/guestfs-actions.pod:1534 ../fish/guestfish-actions.pod:1032
6843 #: ../src/guestfs-actions.pod:1536 ../fish/guestfish-actions.pod:1034
6844 msgid "64 bit SPARC V9 and above."
6848 #: ../src/guestfs-actions.pod:1538 ../fish/guestfish-actions.pod:1036
6853 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1038
6854 msgid "Intel Itanium."
6858 #: ../src/guestfs-actions.pod:1542 ../fish/guestfish-actions.pod:1040
6863 #: ../src/guestfs-actions.pod:1544 ../fish/guestfish-actions.pod:1042
6864 msgid "32 bit Power PC."
6868 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1044
6873 #: ../src/guestfs-actions.pod:1548 ../fish/guestfish-actions.pod:1046
6874 msgid "64 bit Power PC."
6878 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1050
6879 msgid "Libguestfs may return other architecture strings in future."
6883 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1052
6884 msgid "The function works on at least the following types of files:"
6888 #: ../src/guestfs-actions.pod:1560 ../fish/guestfish-actions.pod:1058
6889 msgid "many types of Un*x and Linux binary"
6893 #: ../src/guestfs-actions.pod:1564 ../fish/guestfish-actions.pod:1062
6894 msgid "many types of Un*x and Linux shared library"
6898 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1066
6899 msgid "Windows Win32 and Win64 binaries"
6903 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1070
6904 msgid "Windows Win32 and Win64 DLLs"
6908 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1072
6909 msgid "Win32 binaries and DLLs return C<i386>."
6913 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1074
6914 msgid "Win64 binaries and DLLs return C<x86_64>."
6918 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1078
6919 msgid "Linux kernel modules"
6923 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1082
6924 msgid "Linux new-style initrd images"
6928 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1086
6929 msgid "some non-x86 Linux vmlinuz kernels"
6933 #: ../src/guestfs-actions.pod:1592 ../fish/guestfish-actions.pod:1090
6934 msgid "What it can't do currently:"
6938 #: ../src/guestfs-actions.pod:1598 ../fish/guestfish-actions.pod:1096
6939 msgid "static libraries (libfoo.a)"
6943 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1100
6944 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6948 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1104
6949 msgid "x86 Linux vmlinuz kernels"
6953 #: ../src/guestfs-actions.pod:1608 ../fish/guestfish-actions.pod:1106
6955 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6956 "compressed code, and are horribly hard to unpack. If you want to find the "
6957 "architecture of a kernel, use the architecture of the associated initrd or "
6958 "kernel module(s) instead."
6962 #: ../src/guestfs-actions.pod:1618 ../src/guestfs-actions.pod:1781
6963 #: ../src/guestfs-actions.pod:1798 ../src/guestfs-actions.pod:2451
6964 #: ../src/guestfs-actions.pod:2524 ../src/guestfs-actions.pod:2550
6965 #: ../src/guestfs-actions.pod:2577 ../src/guestfs-actions.pod:2598
6966 #: ../src/guestfs-actions.pod:2631 ../src/guestfs-actions.pod:2655
6967 #: ../src/guestfs-actions.pod:2711 ../src/guestfs-actions.pod:2777
6968 #: ../src/guestfs-actions.pod:2909
6969 msgid "(Added in 1.5.3)"
6973 #: ../src/guestfs-actions.pod:1620
6974 msgid "guestfs_filesize"
6978 #: ../src/guestfs-actions.pod:1622
6982 " guestfs_filesize (guestfs_h *g,\n"
6983 " const char *file);\n"
6988 #: ../src/guestfs-actions.pod:1626 ../fish/guestfish-actions.pod:1117
6989 msgid "This command returns the size of C<file> in bytes."
6993 #: ../src/guestfs-actions.pod:1628
6995 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
6996 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
6997 "devices, use C<guestfs_blockdev_getsize64>."
7001 #: ../src/guestfs-actions.pod:1634
7002 msgid "(Added in 1.0.82)"
7006 #: ../src/guestfs-actions.pod:1636
7007 msgid "guestfs_fill"
7011 #: ../src/guestfs-actions.pod:1638
7015 " guestfs_fill (guestfs_h *g,\n"
7018 " const char *path);\n"
7023 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1127
7025 "This command creates a new file called C<path>. The initial content of the "
7026 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
7031 #: ../src/guestfs-actions.pod:1648
7033 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7034 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7035 "bytes use C<guestfs_fill_pattern>."
7039 #: ../src/guestfs-actions.pod:1660
7040 msgid "(Added in 1.0.79)"
7044 #: ../src/guestfs-actions.pod:1662
7045 msgid "guestfs_fill_pattern"
7049 #: ../src/guestfs-actions.pod:1664
7053 " guestfs_fill_pattern (guestfs_h *g,\n"
7054 " const char *pattern,\n"
7056 " const char *path);\n"
7061 #: ../src/guestfs-actions.pod:1670
7063 "This function is like C<guestfs_fill> except that it creates a new file of "
7064 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7065 "pattern is truncated if necessary to ensure the length of the file is "
7066 "exactly C<len> bytes."
7070 #: ../src/guestfs-actions.pod:1682
7071 msgid "(Added in 1.3.12)"
7075 #: ../src/guestfs-actions.pod:1684
7076 msgid "guestfs_find"
7080 #: ../src/guestfs-actions.pod:1686
7084 " guestfs_find (guestfs_h *g,\n"
7085 " const char *directory);\n"
7090 #: ../src/guestfs-actions.pod:1690 ../fish/guestfish-actions.pod:1149
7092 "This command lists out all files and directories, recursively, starting at "
7093 "C<directory>. It is essentially equivalent to running the shell command "
7094 "C<find directory -print> but some post-processing happens on the output, "
7099 #: ../src/guestfs-actions.pod:1695 ../fish/guestfish-actions.pod:1154
7101 "This returns a list of strings I<without any prefix>. Thus if the directory "
7106 #: ../src/guestfs-actions.pod:1698 ../fish/guestfish-actions.pod:1157
7116 #: ../src/guestfs-actions.pod:1702
7118 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7122 #: ../src/guestfs-actions.pod:1705 ../fish/guestfish-actions.pod:1164
7133 #: ../src/guestfs-actions.pod:1710 ../fish/guestfish-actions.pod:1169
7134 msgid "If C<directory> is not a directory, then this command returns an error."
7138 #: ../src/guestfs-actions.pod:1713 ../fish/guestfish-actions.pod:1172
7139 msgid "The returned list is sorted."
7143 #: ../src/guestfs-actions.pod:1715
7144 msgid "See also C<guestfs_find0>."
7148 #: ../src/guestfs-actions.pod:1724 ../src/guestfs-actions.pod:3570
7149 #: ../src/guestfs-actions.pod:5036
7150 msgid "(Added in 1.0.27)"
7154 #: ../src/guestfs-actions.pod:1726
7155 msgid "guestfs_find0"
7159 #: ../src/guestfs-actions.pod:1728
7163 " guestfs_find0 (guestfs_h *g,\n"
7164 " const char *directory,\n"
7165 " const char *files);\n"
7170 #: ../src/guestfs-actions.pod:1733 ../fish/guestfish-actions.pod:1183
7172 "This command lists out all files and directories, recursively, starting at "
7173 "C<directory>, placing the resulting list in the external file called "
7178 #: ../src/guestfs-actions.pod:1737
7180 "This command works the same way as C<guestfs_find> with the following "
7185 #: ../src/guestfs-actions.pod:1744 ../fish/guestfish-actions.pod:1194
7186 msgid "The resulting list is written to an external file."
7190 #: ../src/guestfs-actions.pod:1748 ../fish/guestfish-actions.pod:1198
7192 "Items (filenames) in the result are separated by C<\\0> characters. See "
7193 "L<find(1)> option I<-print0>."
7197 #: ../src/guestfs-actions.pod:1753 ../fish/guestfish-actions.pod:1203
7198 msgid "This command is not limited in the number of names that it can return."
7202 #: ../src/guestfs-actions.pod:1758 ../fish/guestfish-actions.pod:1208
7203 msgid "The result list is not sorted."
7207 #: ../src/guestfs-actions.pod:1764
7208 msgid "(Added in 1.0.74)"
7212 #: ../src/guestfs-actions.pod:1766
7213 msgid "guestfs_findfs_label"
7217 #: ../src/guestfs-actions.pod:1768
7221 " guestfs_findfs_label (guestfs_h *g,\n"
7222 " const char *label);\n"
7227 #: ../src/guestfs-actions.pod:1772 ../fish/guestfish-actions.pod:1218
7229 "This command searches the filesystems and returns the one which has the "
7230 "given label. An error is returned if no such filesystem can be found."
7234 #: ../src/guestfs-actions.pod:1776
7235 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
7239 #: ../src/guestfs-actions.pod:1783
7240 msgid "guestfs_findfs_uuid"
7244 #: ../src/guestfs-actions.pod:1785
7248 " guestfs_findfs_uuid (guestfs_h *g,\n"
7249 " const char *uuid);\n"
7254 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1228
7256 "This command searches the filesystems and returns the one which has the "
7257 "given UUID. An error is returned if no such filesystem can be found."
7261 #: ../src/guestfs-actions.pod:1793
7262 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
7266 #: ../src/guestfs-actions.pod:1800
7267 msgid "guestfs_fsck"
7271 #: ../src/guestfs-actions.pod:1802
7275 " guestfs_fsck (guestfs_h *g,\n"
7276 " const char *fstype,\n"
7277 " const char *device);\n"
7282 #: ../src/guestfs-actions.pod:1807 ../fish/guestfish-actions.pod:1238
7284 "This runs the filesystem checker (fsck) on C<device> which should have "
7285 "filesystem type C<fstype>."
7289 #: ../src/guestfs-actions.pod:1810 ../fish/guestfish-actions.pod:1241
7291 "The returned integer is the status. See L<fsck(8)> for the list of status "
7292 "codes from C<fsck>."
7296 #: ../src/guestfs-actions.pod:1819 ../fish/guestfish-actions.pod:1250
7297 msgid "Multiple status codes can be summed together."
7301 #: ../src/guestfs-actions.pod:1823 ../fish/guestfish-actions.pod:1254
7303 "A non-zero return code can mean \"success\", for example if errors have been "
7304 "corrected on the filesystem."
7308 #: ../src/guestfs-actions.pod:1828 ../fish/guestfish-actions.pod:1259
7309 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
7313 #: ../src/guestfs-actions.pod:1833 ../fish/guestfish-actions.pod:1264
7315 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
7319 #: ../src/guestfs-actions.pod:1837 ../src/guestfs-actions.pod:6674
7320 msgid "(Added in 1.0.16)"
7324 #: ../src/guestfs-actions.pod:1839
7325 msgid "guestfs_get_append"
7329 #: ../src/guestfs-actions.pod:1841
7333 " guestfs_get_append (guestfs_h *g);\n"
7338 #: ../src/guestfs-actions.pod:1844 ../fish/guestfish-actions.pod:1270
7340 "Return the additional kernel options which are added to the guest kernel "
7345 #: ../src/guestfs-actions.pod:1847 ../fish/guestfish-actions.pod:1273
7346 msgid "If C<NULL> then no options are added."
7350 #: ../src/guestfs-actions.pod:1849
7352 "This function returns a string which may be NULL. There is no way to return "
7353 "an error from this function. The string is owned by the guest handle and "
7354 "must I<not> be freed."
7358 #: ../src/guestfs-actions.pod:1853 ../src/guestfs-actions.pod:4712
7359 #: ../src/guestfs-actions.pod:5177 ../src/guestfs-actions.pod:5545
7360 #: ../src/guestfs-actions.pod:5564 ../src/guestfs-actions.pod:5580
7361 #: ../src/guestfs-actions.pod:5597 ../src/guestfs-actions.pod:6344
7362 #: ../src/guestfs-actions.pod:6362 ../src/guestfs-actions.pod:6717
7363 msgid "(Added in 1.0.26)"
7367 #: ../src/guestfs-actions.pod:1855
7368 msgid "guestfs_get_autosync"
7372 #: ../src/guestfs-actions.pod:1857
7376 " guestfs_get_autosync (guestfs_h *g);\n"
7381 #: ../src/guestfs-actions.pod:1860 ../fish/guestfish-actions.pod:1279
7382 msgid "Get the autosync flag."
7386 #: ../src/guestfs-actions.pod:1866
7387 msgid "guestfs_get_direct"
7391 #: ../src/guestfs-actions.pod:1868
7395 " guestfs_get_direct (guestfs_h *g);\n"
7400 #: ../src/guestfs-actions.pod:1871 ../fish/guestfish-actions.pod:1285
7401 msgid "Return the direct appliance mode flag."
7405 #: ../src/guestfs-actions.pod:1875 ../src/guestfs-actions.pod:5218
7406 msgid "(Added in 1.0.72)"
7410 #: ../src/guestfs-actions.pod:1877
7411 msgid "guestfs_get_e2label"
7415 #: ../src/guestfs-actions.pod:1879
7419 " guestfs_get_e2label (guestfs_h *g,\n"
7420 " const char *device);\n"
7425 #: ../src/guestfs-actions.pod:1883 ../fish/guestfish-actions.pod:1291
7427 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7431 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1294
7433 "This function is deprecated. In new code, use the C<vfs_label> call instead."
7437 #: ../src/guestfs-actions.pod:1896 ../src/guestfs-actions.pod:1917
7438 #: ../src/guestfs-actions.pod:5236 ../src/guestfs-actions.pod:5255
7439 msgid "(Added in 1.0.15)"
7443 #: ../src/guestfs-actions.pod:1898
7444 msgid "guestfs_get_e2uuid"
7448 #: ../src/guestfs-actions.pod:1900
7452 " guestfs_get_e2uuid (guestfs_h *g,\n"
7453 " const char *device);\n"
7458 #: ../src/guestfs-actions.pod:1904 ../fish/guestfish-actions.pod:1305
7460 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7464 #: ../src/guestfs-actions.pod:1910 ../fish/guestfish-actions.pod:1308
7466 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
7470 #: ../src/guestfs-actions.pod:1919
7471 msgid "guestfs_get_memsize"
7475 #: ../src/guestfs-actions.pod:1921
7479 " guestfs_get_memsize (guestfs_h *g);\n"
7484 #: ../src/guestfs-actions.pod:1924 ../fish/guestfish-actions.pod:1319
7486 "This gets the memory size in megabytes allocated to the qemu subprocess."
7490 #: ../src/guestfs-actions.pod:1927
7492 "If C<guestfs_set_memsize> was not called on this handle, and if "
7493 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7494 "value for memsize."
7498 #: ../src/guestfs-actions.pod:1931 ../src/guestfs-actions.pod:2012
7499 #: ../src/guestfs-actions.pod:5271 ../src/guestfs-actions.pod:5378
7500 #: ../fish/guestfish-actions.pod:1326 ../fish/guestfish-actions.pod:1377
7501 #: ../fish/guestfish-actions.pod:3497 ../fish/guestfish-actions.pod:3584
7503 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7507 #: ../src/guestfs-actions.pod:1936 ../src/guestfs-actions.pod:3863
7508 #: ../src/guestfs-actions.pod:3978 ../src/guestfs-actions.pod:3997
7509 #: ../src/guestfs-actions.pod:4016 ../src/guestfs-actions.pod:4028
7510 #: ../src/guestfs-actions.pod:4045 ../src/guestfs-actions.pod:4058
7511 #: ../src/guestfs-actions.pod:4939 ../src/guestfs-actions.pod:5276
7512 #: ../src/guestfs-actions.pod:5519 ../src/guestfs-actions.pod:6120
7513 msgid "(Added in 1.0.55)"
7517 #: ../src/guestfs-actions.pod:1938
7518 msgid "guestfs_get_network"
7522 #: ../src/guestfs-actions.pod:1940
7526 " guestfs_get_network (guestfs_h *g);\n"
7531 #: ../src/guestfs-actions.pod:1943 ../fish/guestfish-actions.pod:1333
7532 msgid "This returns the enable network flag."
7536 #: ../src/guestfs-actions.pod:1947 ../src/guestfs-actions.pod:5295
7537 msgid "(Added in 1.5.4)"
7541 #: ../src/guestfs-actions.pod:1949
7542 msgid "guestfs_get_path"
7546 #: ../src/guestfs-actions.pod:1951
7550 " guestfs_get_path (guestfs_h *g);\n"
7555 #: ../src/guestfs-actions.pod:1954 ../fish/guestfish-actions.pod:1339
7556 msgid "Return the current search path."
7560 #: ../src/guestfs-actions.pod:1956 ../fish/guestfish-actions.pod:1341
7562 "This is always non-NULL. If it wasn't set already, then this will return "
7567 #: ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:1988
7569 "This function returns a string, or NULL on error. The string is owned by "
7570 "the guest handle and must I<not> be freed."
7574 #: ../src/guestfs-actions.pod:1964
7575 msgid "guestfs_get_pid"
7579 #: ../src/guestfs-actions.pod:1966
7583 " guestfs_get_pid (guestfs_h *g);\n"
7588 #: ../src/guestfs-actions.pod:1969 ../fish/guestfish-actions.pod:1350
7590 "Return the process ID of the qemu subprocess. If there is no qemu "
7591 "subprocess, then this will return an error."
7595 #: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1353
7596 msgid "This is an internal call used for debugging and testing."
7600 #: ../src/guestfs-actions.pod:1976
7601 msgid "(Added in 1.0.56)"
7605 #: ../src/guestfs-actions.pod:1978
7606 msgid "guestfs_get_qemu"
7610 #: ../src/guestfs-actions.pod:1980
7614 " guestfs_get_qemu (guestfs_h *g);\n"
7619 #: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1359
7620 msgid "Return the current qemu binary."
7624 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1361
7626 "This is always non-NULL. If it wasn't set already, then this will return "
7627 "the default qemu binary name."
7631 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:5340
7632 msgid "(Added in 1.0.6)"
7636 #: ../src/guestfs-actions.pod:1993
7637 msgid "guestfs_get_recovery_proc"
7641 #: ../src/guestfs-actions.pod:1995
7645 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7650 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1368
7651 msgid "Return the recovery process enabled flag."
7655 #: ../src/guestfs-actions.pod:2002 ../src/guestfs-actions.pod:2999
7656 #: ../src/guestfs-actions.pod:3268 ../src/guestfs-actions.pod:3670
7657 #: ../src/guestfs-actions.pod:3702 ../src/guestfs-actions.pod:4642
7658 #: ../src/guestfs-actions.pod:4987 ../src/guestfs-actions.pod:5364
7659 #: ../src/guestfs-actions.pod:6023 ../src/guestfs-actions.pod:6043
7660 #: ../src/guestfs-actions.pod:6225
7661 msgid "(Added in 1.0.77)"
7665 #: ../src/guestfs-actions.pod:2004
7666 msgid "guestfs_get_selinux"
7670 #: ../src/guestfs-actions.pod:2006
7674 " guestfs_get_selinux (guestfs_h *g);\n"
7679 #: ../src/guestfs-actions.pod:2009
7681 "This returns the current setting of the selinux flag which is passed to the "
7682 "appliance at boot time. See C<guestfs_set_selinux>."
7686 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2080
7687 #: ../src/guestfs-actions.pod:5383 ../src/guestfs-actions.pod:5437
7688 msgid "(Added in 1.0.67)"
7692 #: ../src/guestfs-actions.pod:2019
7693 msgid "guestfs_get_state"
7697 #: ../src/guestfs-actions.pod:2021
7701 " guestfs_get_state (guestfs_h *g);\n"
7706 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1384
7708 "This returns the current state as an opaque integer. This is only useful "
7709 "for printing debug and internal error messages."
7713 #: ../src/guestfs-actions.pod:2027 ../src/guestfs-actions.pod:2802
7714 #: ../src/guestfs-actions.pod:2831 ../src/guestfs-actions.pod:2892
7715 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:1387
7716 #: ../fish/guestfish-actions.pod:1930 ../fish/guestfish-actions.pod:1948
7717 #: ../fish/guestfish-actions.pod:1986 ../fish/guestfish-actions.pod:2002
7718 msgid "For more information on states, see L<guestfs(3)>."
7722 #: ../src/guestfs-actions.pod:2033
7723 msgid "guestfs_get_trace"
7727 #: ../src/guestfs-actions.pod:2035
7731 " guestfs_get_trace (guestfs_h *g);\n"
7736 #: ../src/guestfs-actions.pod:2038 ../fish/guestfish-actions.pod:1393
7737 msgid "Return the command trace flag."
7741 #: ../src/guestfs-actions.pod:2044
7742 msgid "guestfs_get_umask"
7746 #: ../src/guestfs-actions.pod:2046
7750 " guestfs_get_umask (guestfs_h *g);\n"
7755 #: ../src/guestfs-actions.pod:2049
7757 "Return the current umask. By default the umask is C<022> unless it has been "
7758 "set by calling C<guestfs_umask>."
7762 #: ../src/guestfs-actions.pod:2056
7763 msgid "guestfs_get_verbose"
7767 #: ../src/guestfs-actions.pod:2058
7771 " guestfs_get_verbose (guestfs_h *g);\n"
7776 #: ../src/guestfs-actions.pod:2061 ../fish/guestfish-actions.pod:1406
7777 msgid "This returns the verbose messages flag."
7781 #: ../src/guestfs-actions.pod:2067
7782 msgid "guestfs_getcon"
7786 #: ../src/guestfs-actions.pod:2069
7790 " guestfs_getcon (guestfs_h *g);\n"
7795 #: ../src/guestfs-actions.pod:2072 ../fish/guestfish-actions.pod:1412
7796 msgid "This gets the SELinux security context of the daemon."
7800 #: ../src/guestfs-actions.pod:2074
7802 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
7806 #: ../src/guestfs-actions.pod:2082
7807 msgid "guestfs_getxattrs"
7811 #: ../src/guestfs-actions.pod:2084
7814 " struct guestfs_xattr_list *\n"
7815 " guestfs_getxattrs (guestfs_h *g,\n"
7816 " const char *path);\n"
7821 #: ../src/guestfs-actions.pod:2088 ../fish/guestfish-actions.pod:1421
7823 "This call lists the extended attributes of the file or directory C<path>."
7827 #: ../src/guestfs-actions.pod:2091 ../fish/guestfish-actions.pod:1424
7829 "At the system call level, this is a combination of the L<listxattr(2)> and "
7830 "L<getxattr(2)> calls."
7834 #: ../src/guestfs-actions.pod:2094
7835 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
7839 #: ../src/guestfs-actions.pod:2096 ../src/guestfs-actions.pod:3011
7840 #: ../src/guestfs-actions.pod:3665
7842 "This function returns a C<struct guestfs_xattr_list *> (see E<lt>guestfs-"
7843 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
7844 "C<guestfs_free_xattr_list> after use>."
7848 #: ../src/guestfs-actions.pod:2101 ../src/guestfs-actions.pod:3016
7849 #: ../src/guestfs-actions.pod:3181 ../src/guestfs-actions.pod:3217
7850 #: ../src/guestfs-actions.pod:5017 ../src/guestfs-actions.pod:5456
7851 #: ../src/guestfs-actions.pod:6782
7852 msgid "(Added in 1.0.59)"
7856 #: ../src/guestfs-actions.pod:2103
7857 msgid "guestfs_glob_expand"
7861 #: ../src/guestfs-actions.pod:2105
7865 " guestfs_glob_expand (guestfs_h *g,\n"
7866 " const char *pattern);\n"
7871 #: ../src/guestfs-actions.pod:2109 ../fish/guestfish-actions.pod:1433
7873 "This command searches for all the pathnames matching C<pattern> according to "
7874 "the wildcard expansion rules used by the shell."
7878 #: ../src/guestfs-actions.pod:2113 ../fish/guestfish-actions.pod:1437
7880 "If no paths match, then this returns an empty list (note: not an error)."
7884 #: ../src/guestfs-actions.pod:2116 ../fish/guestfish-actions.pod:1440
7886 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
7887 "GLOB_BRACE>. See that manual page for more details."
7891 #: ../src/guestfs-actions.pod:2124 ../src/guestfs-actions.pod:5621
7892 #: ../src/guestfs-actions.pod:5638
7893 msgid "(Added in 1.0.50)"
7897 #: ../src/guestfs-actions.pod:2126
7898 msgid "guestfs_grep"
7902 #: ../src/guestfs-actions.pod:2128
7906 " guestfs_grep (guestfs_h *g,\n"
7907 " const char *regex,\n"
7908 " const char *path);\n"
7913 #: ../src/guestfs-actions.pod:2133 ../fish/guestfish-actions.pod:1448
7914 msgid "This calls the external C<grep> program and returns the matching lines."
7918 #: ../src/guestfs-actions.pod:2145
7919 msgid "guestfs_grepi"
7923 #: ../src/guestfs-actions.pod:2147
7927 " guestfs_grepi (guestfs_h *g,\n"
7928 " const char *regex,\n"
7929 " const char *path);\n"
7934 #: ../src/guestfs-actions.pod:2152 ../fish/guestfish-actions.pod:1458
7936 "This calls the external C<grep -i> program and returns the matching lines."
7940 #: ../src/guestfs-actions.pod:2164
7941 msgid "guestfs_grub_install"
7945 #: ../src/guestfs-actions.pod:2166
7949 " guestfs_grub_install (guestfs_h *g,\n"
7950 " const char *root,\n"
7951 " const char *device);\n"
7956 #: ../src/guestfs-actions.pod:2171 ../fish/guestfish-actions.pod:1468
7958 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
7959 "the root directory being C<root>."
7963 #: ../src/guestfs-actions.pod:2174 ../fish/guestfish-actions.pod:1471
7965 "Note: If grub-install reports the error \"No suitable drive was found in the "
7966 "generated device map.\" it may be that you need to create a C</boot/grub/"
7967 "device.map> file first that contains the mapping between grub device names "
7968 "and Linux device names. It is usually sufficient to create a file "
7973 #: ../src/guestfs-actions.pod:2181 ../fish/guestfish-actions.pod:1478
7981 #: ../src/guestfs-actions.pod:2183 ../fish/guestfish-actions.pod:1480
7982 msgid "replacing C</dev/vda> with the name of the installation device."
7986 #: ../src/guestfs-actions.pod:2187
7987 msgid "(Added in 1.0.17)"
7991 #: ../src/guestfs-actions.pod:2189
7992 msgid "guestfs_head"
7996 #: ../src/guestfs-actions.pod:2191
8000 " guestfs_head (guestfs_h *g,\n"
8001 " const char *path);\n"
8006 #: ../src/guestfs-actions.pod:2195 ../fish/guestfish-actions.pod:1486
8008 "This command returns up to the first 10 lines of a file as a list of strings."
8012 #: ../src/guestfs-actions.pod:2207
8013 msgid "guestfs_head_n"
8017 #: ../src/guestfs-actions.pod:2209
8021 " guestfs_head_n (guestfs_h *g,\n"
8023 " const char *path);\n"
8028 #: ../src/guestfs-actions.pod:2214 ../fish/guestfish-actions.pod:1496
8030 "If the parameter C<nrlines> is a positive number, this returns the first "
8031 "C<nrlines> lines of the file C<path>."
8035 #: ../src/guestfs-actions.pod:2217 ../fish/guestfish-actions.pod:1499
8037 "If the parameter C<nrlines> is a negative number, this returns lines from "
8038 "the file C<path>, excluding the last C<nrlines> lines."
8042 #: ../src/guestfs-actions.pod:2220 ../src/guestfs-actions.pod:5918
8043 #: ../fish/guestfish-actions.pod:1502 ../fish/guestfish-actions.pod:3930
8044 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8048 #: ../src/guestfs-actions.pod:2231
8049 msgid "guestfs_hexdump"
8053 #: ../src/guestfs-actions.pod:2233
8057 " guestfs_hexdump (guestfs_h *g,\n"
8058 " const char *path);\n"
8063 #: ../src/guestfs-actions.pod:2237 ../fish/guestfish-actions.pod:1511
8065 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
8066 "readable, canonical hex dump of the file."
8070 #: ../src/guestfs-actions.pod:2246 ../src/guestfs-actions.pod:5702
8071 #: ../src/guestfs-actions.pod:5757
8072 msgid "(Added in 1.0.22)"
8076 #: ../src/guestfs-actions.pod:2248
8077 msgid "guestfs_initrd_cat"
8081 #: ../src/guestfs-actions.pod:2250
8085 " guestfs_initrd_cat (guestfs_h *g,\n"
8086 " const char *initrdpath,\n"
8087 " const char *filename,\n"
8088 " size_t *size_r);\n"
8093 #: ../src/guestfs-actions.pod:2256 ../fish/guestfish-actions.pod:1521
8095 "This command unpacks the file C<filename> from the initrd file called "
8096 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8101 #: ../src/guestfs-actions.pod:2260 ../fish/guestfish-actions.pod:1525
8103 "For example, in guestfish you could use the following command to examine the "
8104 "boot script (usually called C</init>) contained in a Linux initrd or "
8109 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1529
8112 " initrd-cat /boot/initrd-<version>.img init\n"
8117 #: ../src/guestfs-actions.pod:2266
8118 msgid "See also C<guestfs_initrd_list>."
8122 #: ../src/guestfs-actions.pod:2268 ../src/guestfs-actions.pod:4635
8123 #: ../src/guestfs-actions.pod:4661 ../src/guestfs-actions.pod:4843
8125 "This function returns a buffer, or NULL on error. The size of the returned "
8126 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8131 #: ../src/guestfs-actions.pod:2277
8132 msgid "guestfs_initrd_list"
8136 #: ../src/guestfs-actions.pod:2279
8140 " guestfs_initrd_list (guestfs_h *g,\n"
8141 " const char *path);\n"
8146 #: ../src/guestfs-actions.pod:2283 ../fish/guestfish-actions.pod:1540
8147 msgid "This command lists out files contained in an initrd."
8151 #: ../src/guestfs-actions.pod:2285 ../fish/guestfish-actions.pod:1542
8153 "The files are listed without any initial C</> character. The files are "
8154 "listed in the order they appear (not necessarily alphabetical). Directory "
8155 "names are listed as separate items."
8159 #: ../src/guestfs-actions.pod:2289 ../fish/guestfish-actions.pod:1546
8161 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8162 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8167 #: ../src/guestfs-actions.pod:2299
8168 msgid "guestfs_inotify_add_watch"
8172 #: ../src/guestfs-actions.pod:2301
8176 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8177 " const char *path,\n"
8183 #: ../src/guestfs-actions.pod:2306 ../fish/guestfish-actions.pod:1554
8184 msgid "Watch C<path> for the events listed in C<mask>."
8188 #: ../src/guestfs-actions.pod:2308 ../fish/guestfish-actions.pod:1556
8190 "Note that if C<path> is a directory then events within that directory are "
8191 "watched, but this does I<not> happen recursively (in subdirectories)."
8195 #: ../src/guestfs-actions.pod:2312 ../fish/guestfish-actions.pod:1560
8197 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8198 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
8202 #: ../src/guestfs-actions.pod:2320
8203 msgid "guestfs_inotify_close"
8207 #: ../src/guestfs-actions.pod:2322
8211 " guestfs_inotify_close (guestfs_h *g);\n"
8216 #: ../src/guestfs-actions.pod:2325 ../fish/guestfish-actions.pod:1568
8218 "This closes the inotify handle which was previously opened by inotify_init. "
8219 "It removes all watches, throws away any pending events, and deallocates all "
8224 #: ../src/guestfs-actions.pod:2333
8225 msgid "guestfs_inotify_files"
8229 #: ../src/guestfs-actions.pod:2335
8233 " guestfs_inotify_files (guestfs_h *g);\n"
8238 #: ../src/guestfs-actions.pod:2338
8240 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
8241 "returns a list of pathnames of objects that were touched. The returned "
8242 "pathnames are sorted and deduplicated."
8246 #: ../src/guestfs-actions.pod:2348
8247 msgid "guestfs_inotify_init"
8251 #: ../src/guestfs-actions.pod:2350
8255 " guestfs_inotify_init (guestfs_h *g,\n"
8256 " int maxevents);\n"
8261 #: ../src/guestfs-actions.pod:2354 ../fish/guestfish-actions.pod:1584
8263 "This command creates a new inotify handle. The inotify subsystem can be "
8264 "used to notify events which happen to objects in the guest filesystem."
8268 #: ../src/guestfs-actions.pod:2358
8270 "C<maxevents> is the maximum number of events which will be queued up between "
8271 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
8272 "passed as C<0>, then the kernel (or previously set) default is used. For "
8273 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
8274 "throws away events, but records the fact that it threw them away by setting "
8275 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
8276 "C<guestfs_inotify_read>)."
8280 #: ../src/guestfs-actions.pod:2368
8282 "Before any events are generated, you have to add some watches to the "
8283 "internal watch list. See: C<guestfs_inotify_add_watch>, "
8284 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
8288 #: ../src/guestfs-actions.pod:2374
8290 "Queued up events should be read periodically by calling "
8291 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
8292 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
8293 "often enough then you risk the internal queue overflowing."
8297 #: ../src/guestfs-actions.pod:2381
8299 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
8300 "This also removes any watches automatically."
8304 #: ../src/guestfs-actions.pod:2385 ../fish/guestfish-actions.pod:1615
8306 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
8307 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
8308 "that there is one global inotify handle per libguestfs instance."
8312 #: ../src/guestfs-actions.pod:2394
8313 msgid "guestfs_inotify_read"
8317 #: ../src/guestfs-actions.pod:2396
8320 " struct guestfs_inotify_event_list *\n"
8321 " guestfs_inotify_read (guestfs_h *g);\n"
8326 #: ../src/guestfs-actions.pod:2399 ../fish/guestfish-actions.pod:1624
8328 "Return the complete queue of events that have happened since the previous "
8333 #: ../src/guestfs-actions.pod:2402 ../fish/guestfish-actions.pod:1627
8334 msgid "If no events have happened, this returns an empty list."
8338 #: ../src/guestfs-actions.pod:2404 ../fish/guestfish-actions.pod:1629
8340 "I<Note>: In order to make sure that all events have been read, you must call "
8341 "this function repeatedly until it returns an empty list. The reason is that "
8342 "the call will read events up to the maximum appliance-to-host message size "
8343 "and leave remaining events in the queue."
8347 #: ../src/guestfs-actions.pod:2410
8349 "This function returns a C<struct guestfs_inotify_event_list *> (see "
8350 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
8351 "must call C<guestfs_free_inotify_event_list> after use>."
8355 #: ../src/guestfs-actions.pod:2417
8356 msgid "guestfs_inotify_rm_watch"
8360 #: ../src/guestfs-actions.pod:2419
8364 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
8370 #: ../src/guestfs-actions.pod:2423
8372 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
8376 #: ../src/guestfs-actions.pod:2430
8377 msgid "guestfs_inspect_get_arch"
8381 #: ../src/guestfs-actions.pod:2432
8385 " guestfs_inspect_get_arch (guestfs_h *g,\n"
8386 " const char *root);\n"
8391 #: ../src/guestfs-actions.pod:2436 ../src/guestfs-actions.pod:2459
8392 #: ../src/guestfs-actions.pod:2532 ../src/guestfs-actions.pod:2558
8393 #: ../src/guestfs-actions.pod:2585 ../src/guestfs-actions.pod:2606
8394 #: ../src/guestfs-actions.pod:2639 ../src/guestfs-actions.pod:2681
8395 #: ../src/guestfs-actions.pod:2719
8397 "This function should only be called with a root device string as returned by "
8398 "C<guestfs_inspect_os>."
8402 #: ../src/guestfs-actions.pod:2439
8404 "This returns the architecture of the inspected operating system. The "
8405 "possible return values are listed under C<guestfs_file_architecture>."
8409 #: ../src/guestfs-actions.pod:2443 ../fish/guestfish-actions.pod:1653
8411 "If the architecture could not be determined, then the string C<unknown> is "
8416 #: ../src/guestfs-actions.pod:2446 ../src/guestfs-actions.pod:2519
8417 #: ../src/guestfs-actions.pod:2573 ../src/guestfs-actions.pod:2650
8418 #: ../src/guestfs-actions.pod:2669 ../src/guestfs-actions.pod:2706
8419 #: ../src/guestfs-actions.pod:2729 ../src/guestfs-actions.pod:2769
8420 #: ../fish/guestfish-actions.pod:1656 ../fish/guestfish-actions.pod:1722
8421 #: ../fish/guestfish-actions.pod:1761 ../fish/guestfish-actions.pod:1816
8422 #: ../fish/guestfish-actions.pod:1829 ../fish/guestfish-actions.pod:1860
8423 #: ../fish/guestfish-actions.pod:1876 ../fish/guestfish-actions.pod:1910
8424 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
8428 #: ../src/guestfs-actions.pod:2453
8429 msgid "guestfs_inspect_get_distro"
8433 #: ../src/guestfs-actions.pod:2455
8437 " guestfs_inspect_get_distro (guestfs_h *g,\n"
8438 " const char *root);\n"
8443 #: ../src/guestfs-actions.pod:2462 ../fish/guestfish-actions.pod:1665
8445 "This returns the distro (distribution) of the inspected operating system."
8449 #: ../src/guestfs-actions.pod:2465 ../fish/guestfish-actions.pod:1668
8450 msgid "Currently defined distros are:"
8454 #: ../src/guestfs-actions.pod:2469 ../fish/guestfish-actions.pod:1672
8455 msgid "\"archlinux\""
8459 #: ../src/guestfs-actions.pod:2471 ../fish/guestfish-actions.pod:1674
8464 #: ../src/guestfs-actions.pod:2473 ../fish/guestfish-actions.pod:1676
8469 #: ../src/guestfs-actions.pod:2475 ../fish/guestfish-actions.pod:1678
8470 msgid "Debian or a Debian-derived distro such as Ubuntu."
8474 #: ../src/guestfs-actions.pod:2477 ../fish/guestfish-actions.pod:1680
8479 #: ../src/guestfs-actions.pod:2479 ../fish/guestfish-actions.pod:1682
8484 #: ../src/guestfs-actions.pod:2481 ../fish/guestfish-actions.pod:1684
8489 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1686
8494 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1688
8499 #: ../src/guestfs-actions.pod:2487 ../fish/guestfish-actions.pod:1690
8504 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1692
8509 #: ../src/guestfs-actions.pod:2491 ../fish/guestfish-actions.pod:1694
8514 #: ../src/guestfs-actions.pod:2493 ../fish/guestfish-actions.pod:1696
8515 msgid "\"redhat-based\""
8519 #: ../src/guestfs-actions.pod:2495 ../fish/guestfish-actions.pod:1698
8520 msgid "Some Red Hat-derived distro."
8524 #: ../src/guestfs-actions.pod:2497 ../fish/guestfish-actions.pod:1700
8529 #: ../src/guestfs-actions.pod:2499 ../fish/guestfish-actions.pod:1702
8530 msgid "Red Hat Enterprise Linux and some derivatives."
8534 #: ../src/guestfs-actions.pod:2501 ../src/guestfs-actions.pod:2693
8535 #: ../fish/guestfish-actions.pod:1704 ../fish/guestfish-actions.pod:1847
8540 #: ../src/guestfs-actions.pod:2503 ../fish/guestfish-actions.pod:1706
8542 "Windows does not have distributions. This string is returned if the OS type "
8547 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1709
8552 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1711
8557 #: ../src/guestfs-actions.pod:2510 ../src/guestfs-actions.pod:2697
8558 #: ../fish/guestfish-actions.pod:1713 ../fish/guestfish-actions.pod:1851
8563 #: ../src/guestfs-actions.pod:2512 ../fish/guestfish-actions.pod:1715
8564 msgid "The distro could not be determined."
8568 #: ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2703
8569 #: ../fish/guestfish-actions.pod:1719 ../fish/guestfish-actions.pod:1857
8571 "Future versions of libguestfs may return other strings here. The caller "
8572 "should be prepared to handle any string."
8576 #: ../src/guestfs-actions.pod:2526
8577 msgid "guestfs_inspect_get_filesystems"
8581 #: ../src/guestfs-actions.pod:2528
8585 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
8586 " const char *root);\n"
8591 #: ../src/guestfs-actions.pod:2535 ../fish/guestfish-actions.pod:1731
8593 "This returns a list of all the filesystems that we think are associated with "
8594 "this operating system. This includes the root filesystem, other ordinary "
8595 "filesystems, and non-mounted devices like swap partitions."
8599 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1736
8601 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8602 "to be shared between operating systems."
8606 #: ../src/guestfs-actions.pod:2543
8608 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8609 "C<guestfs_inspect_get_mountpoints>."
8613 #: ../src/guestfs-actions.pod:2552
8614 msgid "guestfs_inspect_get_major_version"
8618 #: ../src/guestfs-actions.pod:2554
8622 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
8623 " const char *root);\n"
8628 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1749
8630 "This returns the major version number of the inspected operating system."
8634 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1752
8636 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8637 "popular public names used by the operating system. Notably the operating "
8638 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8639 "1). You can find out the real versions corresponding to releases of Windows "
8640 "by consulting Wikipedia or MSDN."
8644 #: ../src/guestfs-actions.pod:2571 ../src/guestfs-actions.pod:2591
8645 #: ../fish/guestfish-actions.pod:1759 ../fish/guestfish-actions.pod:1773
8646 msgid "If the version could not be determined, then C<0> is returned."
8650 #: ../src/guestfs-actions.pod:2579
8651 msgid "guestfs_inspect_get_minor_version"
8655 #: ../src/guestfs-actions.pod:2581
8659 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
8660 " const char *root);\n"
8665 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1770
8667 "This returns the minor version number of the inspected operating system."
8671 #: ../src/guestfs-actions.pod:2593
8673 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8674 "C<guestfs_inspect_get_major_version>."
8678 #: ../src/guestfs-actions.pod:2600
8679 msgid "guestfs_inspect_get_mountpoints"
8683 #: ../src/guestfs-actions.pod:2602
8687 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
8688 " const char *root);\n"
8693 #: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:1785
8695 "This returns a hash of where we think the filesystems associated with this "
8696 "operating system should be mounted. Callers should note that this is at "
8697 "best an educated guess made by reading configuration files such as C</etc/"
8702 #: ../src/guestfs-actions.pod:2614 ../fish/guestfish-actions.pod:1790
8704 "Each element in the returned hashtable has a key which is the path of the "
8705 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8706 "mounted there (eg. C</dev/sda1>)."
8710 #: ../src/guestfs-actions.pod:2619 ../fish/guestfish-actions.pod:1795
8712 "Non-mounted devices such as swap devices are I<not> returned in this list."
8716 #: ../src/guestfs-actions.pod:2622
8718 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8719 "C<guestfs_inspect_get_filesystems>."
8723 #: ../src/guestfs-actions.pod:2625 ../src/guestfs-actions.pod:3069
8724 #: ../src/guestfs-actions.pod:4200 ../src/guestfs-actions.pod:6059
8726 "This function returns a NULL-terminated array of strings, or NULL if there "
8727 "was an error. The array of strings will always have length C<2n+1>, where "
8728 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
8729 "caller must free the strings and the array after use>."
8733 #: ../src/guestfs-actions.pod:2633
8734 msgid "guestfs_inspect_get_product_name"
8738 #: ../src/guestfs-actions.pod:2635
8742 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
8743 " const char *root);\n"
8748 #: ../src/guestfs-actions.pod:2642 ../fish/guestfish-actions.pod:1808
8750 "This returns the product name of the inspected operating system. The "
8751 "product name is generally some freeform string which can be displayed to the "
8752 "user, but should not be parsed by programs."
8756 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1813
8758 "If the product name could not be determined, then the string C<unknown> is "
8763 #: ../src/guestfs-actions.pod:2657
8764 msgid "guestfs_inspect_get_roots"
8768 #: ../src/guestfs-actions.pod:2659
8772 " guestfs_inspect_get_roots (guestfs_h *g);\n"
8777 #: ../src/guestfs-actions.pod:2662
8779 "This function is a convenient way to get the list of root devices, as "
8780 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
8781 "the whole inspection process."
8785 #: ../src/guestfs-actions.pod:2666
8787 "This returns an empty list if either no root devices were found or the "
8788 "caller has not called C<guestfs_inspect_os>."
8792 #: ../src/guestfs-actions.pod:2675
8793 msgid "guestfs_inspect_get_type"
8797 #: ../src/guestfs-actions.pod:2677
8801 " guestfs_inspect_get_type (guestfs_h *g,\n"
8802 " const char *root);\n"
8807 #: ../src/guestfs-actions.pod:2684 ../fish/guestfish-actions.pod:1838
8809 "This returns the type of the inspected operating system. Currently defined "
8814 #: ../src/guestfs-actions.pod:2689 ../fish/guestfish-actions.pod:1843
8819 #: ../src/guestfs-actions.pod:2691 ../fish/guestfish-actions.pod:1845
8820 msgid "Any Linux-based operating system."
8824 #: ../src/guestfs-actions.pod:2695 ../fish/guestfish-actions.pod:1849
8825 msgid "Any Microsoft Windows operating system."
8829 #: ../src/guestfs-actions.pod:2699 ../fish/guestfish-actions.pod:1853
8830 msgid "The operating system type could not be determined."
8834 #: ../src/guestfs-actions.pod:2713
8835 msgid "guestfs_inspect_get_windows_systemroot"
8839 #: ../src/guestfs-actions.pod:2715
8843 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
8844 " const char *root);\n"
8849 #: ../src/guestfs-actions.pod:2722 ../fish/guestfish-actions.pod:1869
8851 "This returns the Windows systemroot of the inspected guest. The systemroot "
8852 "is a directory path such as C</WINDOWS>."
8856 #: ../src/guestfs-actions.pod:2725 ../fish/guestfish-actions.pod:1872
8858 "This call assumes that the guest is Windows and that the systemroot could be "
8859 "determined by inspection. If this is not the case then an error is returned."
8863 #: ../src/guestfs-actions.pod:2734
8864 msgid "(Added in 1.5.25)"
8868 #: ../src/guestfs-actions.pod:2736
8869 msgid "guestfs_inspect_os"
8873 #: ../src/guestfs-actions.pod:2738
8877 " guestfs_inspect_os (guestfs_h *g);\n"
8882 #: ../src/guestfs-actions.pod:2741 ../fish/guestfish-actions.pod:1882
8884 "This function uses other libguestfs functions and certain heuristics to "
8885 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
8886 "for operating systems."
8890 #: ../src/guestfs-actions.pod:2745 ../fish/guestfish-actions.pod:1886
8891 msgid "The list returned is empty if no operating systems were found."
8895 #: ../src/guestfs-actions.pod:2747 ../fish/guestfish-actions.pod:1888
8897 "If one operating system was found, then this returns a list with a single "
8898 "element, which is the name of the root filesystem of this operating system. "
8899 "It is also possible for this function to return a list containing more than "
8900 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
8901 "element being the root filesystem of one of the operating systems."
8905 #: ../src/guestfs-actions.pod:2754
8907 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
8908 "functions in order to query further information about each operating system, "
8909 "such as the name and version."
8913 #: ../src/guestfs-actions.pod:2759
8915 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
8916 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
8917 "the contents. This should be called with no disks currently mounted. The "
8918 "function may also use Augeas, so any existing Augeas handle will be closed."
8922 #: ../src/guestfs-actions.pod:2765 ../fish/guestfish-actions.pod:1906
8924 "This function cannot decrypt encrypted disks. The caller must do that first "
8925 "(supplying the necessary keys) if the disk is encrypted."
8929 #: ../src/guestfs-actions.pod:2771 ../src/guestfs-actions.pod:3027
8930 #: ../src/guestfs-actions.pod:3089
8931 msgid "See also C<guestfs_list_filesystems>."
8935 #: ../src/guestfs-actions.pod:2779
8936 msgid "guestfs_is_blockdev"
8940 #: ../src/guestfs-actions.pod:2781
8944 " guestfs_is_blockdev (guestfs_h *g,\n"
8945 " const char *path);\n"
8950 #: ../src/guestfs-actions.pod:2785 ../fish/guestfish-actions.pod:1918
8952 "This returns C<true> if and only if there is a block device with the given "
8957 #: ../src/guestfs-actions.pod:2788 ../src/guestfs-actions.pod:2817
8958 #: ../src/guestfs-actions.pod:2847 ../src/guestfs-actions.pod:2862
8959 #: ../src/guestfs-actions.pod:2878 ../src/guestfs-actions.pod:2934
8960 #: ../src/guestfs-actions.pod:2949
8961 msgid "See also C<guestfs_stat>."
8965 #: ../src/guestfs-actions.pod:2792 ../src/guestfs-actions.pod:2821
8966 #: ../src/guestfs-actions.pod:2866 ../src/guestfs-actions.pod:2938
8967 #: ../src/guestfs-actions.pod:2953
8968 msgid "(Added in 1.5.10)"
8972 #: ../src/guestfs-actions.pod:2794
8973 msgid "guestfs_is_busy"
8977 #: ../src/guestfs-actions.pod:2796
8981 " guestfs_is_busy (guestfs_h *g);\n"
8986 #: ../src/guestfs-actions.pod:2799 ../fish/guestfish-actions.pod:1927
8988 "This returns true iff this handle is busy processing a command (in the "
8993 #: ../src/guestfs-actions.pod:2808
8994 msgid "guestfs_is_chardev"
8998 #: ../src/guestfs-actions.pod:2810
9002 " guestfs_is_chardev (guestfs_h *g,\n"
9003 " const char *path);\n"
9008 #: ../src/guestfs-actions.pod:2814 ../fish/guestfish-actions.pod:1936
9010 "This returns C<true> if and only if there is a character device with the "
9011 "given C<path> name."
9015 #: ../src/guestfs-actions.pod:2823
9016 msgid "guestfs_is_config"
9020 #: ../src/guestfs-actions.pod:2825
9024 " guestfs_is_config (guestfs_h *g);\n"
9029 #: ../src/guestfs-actions.pod:2828 ../fish/guestfish-actions.pod:1945
9031 "This returns true iff this handle is being configured (in the C<CONFIG> "
9036 #: ../src/guestfs-actions.pod:2837
9037 msgid "guestfs_is_dir"
9041 #: ../src/guestfs-actions.pod:2839
9045 " guestfs_is_dir (guestfs_h *g,\n"
9046 " const char *path);\n"
9051 #: ../src/guestfs-actions.pod:2843 ../fish/guestfish-actions.pod:1954
9053 "This returns C<true> if and only if there is a directory with the given "
9054 "C<path> name. Note that it returns false for other objects like files."
9058 #: ../src/guestfs-actions.pod:2853
9059 msgid "guestfs_is_fifo"
9063 #: ../src/guestfs-actions.pod:2855
9067 " guestfs_is_fifo (guestfs_h *g,\n"
9068 " const char *path);\n"
9073 #: ../src/guestfs-actions.pod:2859 ../fish/guestfish-actions.pod:1964
9075 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9076 "given C<path> name."
9080 #: ../src/guestfs-actions.pod:2868
9081 msgid "guestfs_is_file"
9085 #: ../src/guestfs-actions.pod:2870
9089 " guestfs_is_file (guestfs_h *g,\n"
9090 " const char *path);\n"
9095 #: ../src/guestfs-actions.pod:2874 ../fish/guestfish-actions.pod:1973
9097 "This returns C<true> if and only if there is a regular file with the given "
9098 "C<path> name. Note that it returns false for other objects like directories."
9102 #: ../src/guestfs-actions.pod:2884
9103 msgid "guestfs_is_launching"
9107 #: ../src/guestfs-actions.pod:2886
9111 " guestfs_is_launching (guestfs_h *g);\n"
9116 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1983
9118 "This returns true iff this handle is launching the subprocess (in the "
9119 "C<LAUNCHING> state)."
9123 #: ../src/guestfs-actions.pod:2898
9124 msgid "guestfs_is_lv"
9128 #: ../src/guestfs-actions.pod:2900
9132 " guestfs_is_lv (guestfs_h *g,\n"
9133 " const char *device);\n"
9138 #: ../src/guestfs-actions.pod:2904 ../fish/guestfish-actions.pod:1992
9140 "This command tests whether C<device> is a logical volume, and returns true "
9141 "iff this is the case."
9145 #: ../src/guestfs-actions.pod:2911
9146 msgid "guestfs_is_ready"
9150 #: ../src/guestfs-actions.pod:2913
9154 " guestfs_is_ready (guestfs_h *g);\n"
9159 #: ../src/guestfs-actions.pod:2916 ../fish/guestfish-actions.pod:1999
9161 "This returns true iff this handle is ready to accept commands (in the "
9166 #: ../src/guestfs-actions.pod:2925
9167 msgid "guestfs_is_socket"
9171 #: ../src/guestfs-actions.pod:2927
9175 " guestfs_is_socket (guestfs_h *g,\n"
9176 " const char *path);\n"
9181 #: ../src/guestfs-actions.pod:2931 ../fish/guestfish-actions.pod:2008
9183 "This returns C<true> if and only if there is a Unix domain socket with the "
9184 "given C<path> name."
9188 #: ../src/guestfs-actions.pod:2940
9189 msgid "guestfs_is_symlink"
9193 #: ../src/guestfs-actions.pod:2942
9197 " guestfs_is_symlink (guestfs_h *g,\n"
9198 " const char *path);\n"
9203 #: ../src/guestfs-actions.pod:2946 ../fish/guestfish-actions.pod:2017
9205 "This returns C<true> if and only if there is a symbolic link with the given "
9210 #: ../src/guestfs-actions.pod:2955
9211 msgid "guestfs_kill_subprocess"
9215 #: ../src/guestfs-actions.pod:2957
9219 " guestfs_kill_subprocess (guestfs_h *g);\n"
9224 #: ../src/guestfs-actions.pod:2960 ../fish/guestfish-actions.pod:2026
9225 msgid "This kills the qemu subprocess. You should never need to call this."
9229 #: ../src/guestfs-actions.pod:2966
9230 msgid "guestfs_launch"
9234 #: ../src/guestfs-actions.pod:2968
9238 " guestfs_launch (guestfs_h *g);\n"
9243 #: ../src/guestfs-actions.pod:2971 ../fish/guestfish-actions.pod:2034
9245 "Internally libguestfs is implemented by running a virtual machine using "
9250 #: ../src/guestfs-actions.pod:2974 ../fish/guestfish-actions.pod:2037
9252 "You should call this after configuring the handle (eg. adding drives) but "
9253 "before performing any actions."
9257 #: ../src/guestfs-actions.pod:2981
9258 msgid "guestfs_lchown"
9262 #: ../src/guestfs-actions.pod:2983
9266 " guestfs_lchown (guestfs_h *g,\n"
9269 " const char *path);\n"
9274 #: ../src/guestfs-actions.pod:2989
9276 "Change the file owner to C<owner> and group to C<group>. This is like "
9277 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
9278 "changed, not the target."
9282 #: ../src/guestfs-actions.pod:3001
9283 msgid "guestfs_lgetxattrs"
9287 #: ../src/guestfs-actions.pod:3003
9290 " struct guestfs_xattr_list *\n"
9291 " guestfs_lgetxattrs (guestfs_h *g,\n"
9292 " const char *path);\n"
9297 #: ../src/guestfs-actions.pod:3007
9299 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
9300 "then it returns the extended attributes of the link itself."
9304 #: ../src/guestfs-actions.pod:3018
9305 msgid "guestfs_list_devices"
9309 #: ../src/guestfs-actions.pod:3020
9313 " guestfs_list_devices (guestfs_h *g);\n"
9318 #: ../src/guestfs-actions.pod:3023 ../fish/guestfish-actions.pod:2064
9319 msgid "List all the block devices."
9323 #: ../src/guestfs-actions.pod:3025 ../fish/guestfish-actions.pod:2066
9324 msgid "The full block device names are returned, eg. C</dev/sda>."
9328 #: ../src/guestfs-actions.pod:3035
9329 msgid "guestfs_list_filesystems"
9333 #: ../src/guestfs-actions.pod:3037
9337 " guestfs_list_filesystems (guestfs_h *g);\n"
9342 #: ../src/guestfs-actions.pod:3040 ../fish/guestfish-actions.pod:2074
9344 "This inspection command looks for filesystems on partitions, block devices "
9345 "and logical volumes, returning a list of devices containing filesystems and "
9350 #: ../src/guestfs-actions.pod:3044 ../fish/guestfish-actions.pod:2078
9352 "The return value is a hash, where the keys are the devices containing "
9353 "filesystems, and the values are the filesystem types. For example:"
9357 #: ../src/guestfs-actions.pod:3048 ../fish/guestfish-actions.pod:2082
9360 " \"/dev/sda1\" => \"ntfs\"\n"
9361 " \"/dev/sda2\" => \"ext2\"\n"
9362 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9363 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9368 #: ../src/guestfs-actions.pod:3053 ../fish/guestfish-actions.pod:2087
9370 "The value can have the special value \"unknown\", meaning the content of the "
9371 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9375 #: ../src/guestfs-actions.pod:3057
9377 "This command runs other libguestfs commands, which might include "
9378 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
9379 "soon after launch and only when nothing is mounted."
9383 #: ../src/guestfs-actions.pod:3061
9385 "Not all of the filesystems returned will be mountable. In particular, swap "
9386 "partitions are returned in the list. Also this command does not check that "
9387 "each filesystem found is valid and mountable, and some filesystems might be "
9388 "mountable but require special options. Filesystems may not all belong to a "
9389 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
9393 #: ../src/guestfs-actions.pod:3075 ../src/guestfs-actions.pod:4602
9394 msgid "(Added in 1.5.15)"
9398 #: ../src/guestfs-actions.pod:3077
9399 msgid "guestfs_list_partitions"
9403 #: ../src/guestfs-actions.pod:3079
9407 " guestfs_list_partitions (guestfs_h *g);\n"
9412 #: ../src/guestfs-actions.pod:3082 ../fish/guestfish-actions.pod:2107
9413 msgid "List all the partitions detected on all block devices."
9417 #: ../src/guestfs-actions.pod:3084 ../fish/guestfish-actions.pod:2109
9418 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9422 #: ../src/guestfs-actions.pod:3086
9424 "This does not return logical volumes. For that you will need to call "
9429 #: ../src/guestfs-actions.pod:3097
9434 #: ../src/guestfs-actions.pod:3099
9438 " guestfs_ll (guestfs_h *g,\n"
9439 " const char *directory);\n"
9444 #: ../src/guestfs-actions.pod:3103 ../fish/guestfish-actions.pod:2120
9446 "List the files in C<directory> (relative to the root directory, there is no "
9447 "cwd) in the format of 'ls -la'."
9451 #: ../src/guestfs-actions.pod:3106 ../fish/guestfish-actions.pod:2123
9453 "This command is mostly useful for interactive sessions. It is I<not> "
9454 "intended that you try to parse the output string."
9458 #: ../src/guestfs-actions.pod:3114
9463 #: ../src/guestfs-actions.pod:3116
9467 " guestfs_ln (guestfs_h *g,\n"
9468 " const char *target,\n"
9469 " const char *linkname);\n"
9474 #: ../src/guestfs-actions.pod:3121 ../fish/guestfish-actions.pod:2130
9475 msgid "This command creates a hard link using the C<ln> command."
9479 #: ../src/guestfs-actions.pod:3127
9480 msgid "guestfs_ln_f"
9484 #: ../src/guestfs-actions.pod:3129
9488 " guestfs_ln_f (guestfs_h *g,\n"
9489 " const char *target,\n"
9490 " const char *linkname);\n"
9495 #: ../src/guestfs-actions.pod:3134 ../fish/guestfish-actions.pod:2136
9497 "This command creates a hard link using the C<ln -f> command. The C<-f> "
9498 "option removes the link (C<linkname>) if it exists already."
9502 #: ../src/guestfs-actions.pod:3141
9503 msgid "guestfs_ln_s"
9507 #: ../src/guestfs-actions.pod:3143
9511 " guestfs_ln_s (guestfs_h *g,\n"
9512 " const char *target,\n"
9513 " const char *linkname);\n"
9518 #: ../src/guestfs-actions.pod:3148 ../fish/guestfish-actions.pod:2143
9519 msgid "This command creates a symbolic link using the C<ln -s> command."
9523 #: ../src/guestfs-actions.pod:3154
9524 msgid "guestfs_ln_sf"
9528 #: ../src/guestfs-actions.pod:3156
9532 " guestfs_ln_sf (guestfs_h *g,\n"
9533 " const char *target,\n"
9534 " const char *linkname);\n"
9539 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2149
9541 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
9542 "option removes the link (C<linkname>) if it exists already."
9546 #: ../src/guestfs-actions.pod:3168
9547 msgid "guestfs_lremovexattr"
9551 #: ../src/guestfs-actions.pod:3170
9555 " guestfs_lremovexattr (guestfs_h *g,\n"
9556 " const char *xattr,\n"
9557 " const char *path);\n"
9562 #: ../src/guestfs-actions.pod:3175
9564 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
9565 "link, then it removes an extended attribute of the link itself."
9569 #: ../src/guestfs-actions.pod:3183
9574 #: ../src/guestfs-actions.pod:3185
9578 " guestfs_ls (guestfs_h *g,\n"
9579 " const char *directory);\n"
9584 #: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2164
9586 "List the files in C<directory> (relative to the root directory, there is no "
9587 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
9591 #: ../src/guestfs-actions.pod:3193
9593 "This command is mostly useful for interactive sessions. Programs should "
9594 "probably use C<guestfs_readdir> instead."
9598 #: ../src/guestfs-actions.pod:3202
9599 msgid "guestfs_lsetxattr"
9603 #: ../src/guestfs-actions.pod:3204
9607 " guestfs_lsetxattr (guestfs_h *g,\n"
9608 " const char *xattr,\n"
9609 " const char *val,\n"
9611 " const char *path);\n"
9616 #: ../src/guestfs-actions.pod:3211
9618 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
9619 "then it sets an extended attribute of the link itself."
9623 #: ../src/guestfs-actions.pod:3219
9624 msgid "guestfs_lstat"
9628 #: ../src/guestfs-actions.pod:3221
9631 " struct guestfs_stat *\n"
9632 " guestfs_lstat (guestfs_h *g,\n"
9633 " const char *path);\n"
9638 #: ../src/guestfs-actions.pod:3225 ../src/guestfs-actions.pod:5658
9639 #: ../fish/guestfish-actions.pod:2183 ../fish/guestfish-actions.pod:3765
9640 msgid "Returns file information for the given C<path>."
9644 #: ../src/guestfs-actions.pod:3227
9646 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
9647 "link, then the link is stat-ed, not the file it refers to."
9651 #: ../src/guestfs-actions.pod:3231 ../fish/guestfish-actions.pod:2189
9652 msgid "This is the same as the C<lstat(2)> system call."
9656 #: ../src/guestfs-actions.pod:3233 ../src/guestfs-actions.pod:5662
9658 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
9659 "error. I<The caller must call C<guestfs_free_stat> after use>."
9663 #: ../src/guestfs-actions.pod:3237 ../src/guestfs-actions.pod:5666
9664 #: ../src/guestfs-actions.pod:5684 ../src/guestfs-actions.pod:6065
9665 msgid "(Added in 0.9.2)"
9669 #: ../src/guestfs-actions.pod:3239
9670 msgid "guestfs_lstatlist"
9674 #: ../src/guestfs-actions.pod:3241
9677 " struct guestfs_stat_list *\n"
9678 " guestfs_lstatlist (guestfs_h *g,\n"
9679 " const char *path,\n"
9680 " char *const *names);\n"
9685 #: ../src/guestfs-actions.pod:3246
9687 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
9688 "files, where all files are in the directory C<path>. C<names> is the list "
9689 "of files from this directory."
9693 #: ../src/guestfs-actions.pod:3250 ../fish/guestfish-actions.pod:2199
9695 "On return you get a list of stat structs, with a one-to-one correspondence "
9696 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9697 "then the C<ino> field of that structure is set to C<-1>."
9701 #: ../src/guestfs-actions.pod:3255
9703 "This call is intended for programs that want to efficiently list a directory "
9704 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
9705 "for a similarly efficient call for getting extended attributes. Very long "
9706 "directory listings might cause the protocol message size to be exceeded, "
9707 "causing this call to fail. The caller must split up such requests into "
9708 "smaller groups of names."
9712 #: ../src/guestfs-actions.pod:3263
9714 "This function returns a C<struct guestfs_stat_list *> (see E<lt>guestfs-"
9715 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
9716 "C<guestfs_free_stat_list> after use>."
9720 #: ../src/guestfs-actions.pod:3270
9721 msgid "guestfs_luks_add_key"
9725 #: ../src/guestfs-actions.pod:3272
9729 " guestfs_luks_add_key (guestfs_h *g,\n"
9730 " const char *device,\n"
9731 " const char *key,\n"
9732 " const char *newkey,\n"
9738 #: ../src/guestfs-actions.pod:3279 ../fish/guestfish-actions.pod:2216
9740 "This command adds a new key on LUKS device C<device>. C<key> is any "
9741 "existing key, and is used to access the device. C<newkey> is the new key to "
9742 "add. C<keyslot> is the key slot that will be replaced."
9746 #: ../src/guestfs-actions.pod:3284
9748 "Note that if C<keyslot> already contains a key, then this command will "
9749 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
9753 #: ../src/guestfs-actions.pod:3290 ../src/guestfs-actions.pod:3330
9754 #: ../src/guestfs-actions.pod:3353 ../src/guestfs-actions.pod:3373
9755 #: ../src/guestfs-actions.pod:3405 ../src/guestfs-actions.pod:3424
9757 "This function takes a key or passphrase parameter which could contain "
9758 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
9763 #: ../src/guestfs-actions.pod:3294 ../src/guestfs-actions.pod:3334
9764 #: ../src/guestfs-actions.pod:3357 ../src/guestfs-actions.pod:3377
9765 msgid "(Added in 1.5.2)"
9769 #: ../src/guestfs-actions.pod:3296
9770 msgid "guestfs_luks_close"
9774 #: ../src/guestfs-actions.pod:3298
9778 " guestfs_luks_close (guestfs_h *g,\n"
9779 " const char *device);\n"
9784 #: ../src/guestfs-actions.pod:3302
9786 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
9787 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
9788 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
9789 "underlying block device."
9793 #: ../src/guestfs-actions.pod:3310 ../src/guestfs-actions.pod:3409
9794 #: ../src/guestfs-actions.pod:3428 ../src/guestfs-actions.pod:3478
9795 #: ../src/guestfs-actions.pod:3526
9796 msgid "(Added in 1.5.1)"
9800 #: ../src/guestfs-actions.pod:3312
9801 msgid "guestfs_luks_format"
9805 #: ../src/guestfs-actions.pod:3314
9809 " guestfs_luks_format (guestfs_h *g,\n"
9810 " const char *device,\n"
9811 " const char *key,\n"
9817 #: ../src/guestfs-actions.pod:3320 ../fish/guestfish-actions.pod:2242
9819 "This command erases existing data on C<device> and formats the device as a "
9820 "LUKS encrypted device. C<key> is the initial key, which is added to key "
9821 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
9825 #: ../src/guestfs-actions.pod:3327 ../src/guestfs-actions.pod:3350
9826 #: ../src/guestfs-actions.pod:3490 ../src/guestfs-actions.pod:4352
9827 #: ../src/guestfs-actions.pod:5118 ../src/guestfs-actions.pod:5493
9828 #: ../src/guestfs-actions.pod:5516 ../src/guestfs-actions.pod:5542
9829 #: ../src/guestfs-actions.pod:6693 ../fish/guestfish-actions.pod:2250
9830 #: ../fish/guestfish-actions.pod:2263 ../fish/guestfish-actions.pod:2347
9831 #: ../fish/guestfish-actions.pod:2877 ../fish/guestfish-actions.pod:3384
9832 #: ../fish/guestfish-actions.pod:3664 ../fish/guestfish-actions.pod:3680
9833 #: ../fish/guestfish-actions.pod:3695 ../fish/guestfish-actions.pod:4410
9835 "B<This command is dangerous. Without careful use you can easily destroy all "
9840 #: ../src/guestfs-actions.pod:3336
9841 msgid "guestfs_luks_format_cipher"
9845 #: ../src/guestfs-actions.pod:3338
9849 " guestfs_luks_format_cipher (guestfs_h *g,\n"
9850 " const char *device,\n"
9851 " const char *key,\n"
9853 " const char *cipher);\n"
9858 #: ../src/guestfs-actions.pod:3345
9860 "This command is the same as C<guestfs_luks_format> but it also allows you to "
9861 "set the C<cipher> used."
9865 #: ../src/guestfs-actions.pod:3359
9866 msgid "guestfs_luks_kill_slot"
9870 #: ../src/guestfs-actions.pod:3361
9874 " guestfs_luks_kill_slot (guestfs_h *g,\n"
9875 " const char *device,\n"
9876 " const char *key,\n"
9882 #: ../src/guestfs-actions.pod:3367 ../fish/guestfish-actions.pod:2270
9884 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
9885 "device C<device>. C<key> must be one of the I<other> keys."
9889 #: ../src/guestfs-actions.pod:3379
9890 msgid "guestfs_luks_open"
9894 #: ../src/guestfs-actions.pod:3381
9898 " guestfs_luks_open (guestfs_h *g,\n"
9899 " const char *device,\n"
9900 " const char *key,\n"
9901 " const char *mapname);\n"
9906 #: ../src/guestfs-actions.pod:3387 ../fish/guestfish-actions.pod:2281
9908 "This command opens a block device which has been encrypted according to the "
9909 "Linux Unified Key Setup (LUKS) standard."
9913 #: ../src/guestfs-actions.pod:3390 ../fish/guestfish-actions.pod:2284
9914 msgid "C<device> is the encrypted block device or partition."
9918 #: ../src/guestfs-actions.pod:3392 ../fish/guestfish-actions.pod:2286
9920 "The caller must supply one of the keys associated with the LUKS block "
9921 "device, in the C<key> parameter."
9925 #: ../src/guestfs-actions.pod:3395 ../fish/guestfish-actions.pod:2289
9927 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
9928 "writes to this block device are decrypted from and encrypted to the "
9929 "underlying C<device> respectively."
9933 #: ../src/guestfs-actions.pod:3399
9935 "If this block device contains LVM volume groups, then calling "
9936 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
9941 #: ../src/guestfs-actions.pod:3411
9942 msgid "guestfs_luks_open_ro"
9946 #: ../src/guestfs-actions.pod:3413
9950 " guestfs_luks_open_ro (guestfs_h *g,\n"
9951 " const char *device,\n"
9952 " const char *key,\n"
9953 " const char *mapname);\n"
9958 #: ../src/guestfs-actions.pod:3419
9960 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
9965 #: ../src/guestfs-actions.pod:3430
9966 msgid "guestfs_lvcreate"
9970 #: ../src/guestfs-actions.pod:3432
9974 " guestfs_lvcreate (guestfs_h *g,\n"
9975 " const char *logvol,\n"
9976 " const char *volgroup,\n"
9982 #: ../src/guestfs-actions.pod:3438 ../fish/guestfish-actions.pod:2314
9984 "This creates an LVM logical volume called C<logvol> on the volume group "
9985 "C<volgroup>, with C<size> megabytes."
9989 #: ../src/guestfs-actions.pod:3445
9990 msgid "guestfs_lvm_canonical_lv_name"
9994 #: ../src/guestfs-actions.pod:3447
9998 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
9999 " const char *lvname);\n"
10004 #: ../src/guestfs-actions.pod:3451 ../fish/guestfish-actions.pod:2321
10006 "This converts alternative naming schemes for LVs that you might find to the "
10007 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
10012 #: ../src/guestfs-actions.pod:3455 ../fish/guestfish-actions.pod:2325
10014 "This command returns an error if the C<lvname> parameter does not refer to a "
10019 #: ../src/guestfs-actions.pod:3458
10020 msgid "See also C<guestfs_is_lv>."
10024 #: ../src/guestfs-actions.pod:3463
10025 msgid "(Added in 1.5.24)"
10029 #: ../src/guestfs-actions.pod:3465
10030 msgid "guestfs_lvm_clear_filter"
10034 #: ../src/guestfs-actions.pod:3467
10038 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
10043 #: ../src/guestfs-actions.pod:3470
10045 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
10046 "see every block device."
10050 #: ../src/guestfs-actions.pod:3473 ../src/guestfs-actions.pod:3515
10051 #: ../fish/guestfish-actions.pod:2337 ../fish/guestfish-actions.pod:2368
10053 "This command also clears the LVM cache and performs a volume group scan."
10057 #: ../src/guestfs-actions.pod:3480
10058 msgid "guestfs_lvm_remove_all"
10062 #: ../src/guestfs-actions.pod:3482
10066 " guestfs_lvm_remove_all (guestfs_h *g);\n"
10071 #: ../src/guestfs-actions.pod:3485 ../fish/guestfish-actions.pod:2344
10073 "This command removes all LVM logical volumes, volume groups and physical "
10078 #: ../src/guestfs-actions.pod:3495
10079 msgid "guestfs_lvm_set_filter"
10083 #: ../src/guestfs-actions.pod:3497
10087 " guestfs_lvm_set_filter (guestfs_h *g,\n"
10088 " char *const *devices);\n"
10093 #: ../src/guestfs-actions.pod:3501 ../fish/guestfish-actions.pod:2354
10095 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10096 "block devices in the list C<devices>, and will ignore all other attached "
10101 #: ../src/guestfs-actions.pod:3505 ../fish/guestfish-actions.pod:2358
10103 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10104 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10105 "there are two types of duplication possible: either cloned PVs/VGs which "
10106 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10107 "same name. In normal operation you cannot create this situation, but you "
10108 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10109 "inside the LVM metadata."
10113 #: ../src/guestfs-actions.pod:3518 ../fish/guestfish-actions.pod:2371
10114 msgid "You can filter whole block devices or individual partitions."
10118 #: ../src/guestfs-actions.pod:3520 ../fish/guestfish-actions.pod:2373
10120 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10121 "filesystem), even if you are not filtering out that VG."
10125 #: ../src/guestfs-actions.pod:3528
10126 msgid "guestfs_lvremove"
10130 #: ../src/guestfs-actions.pod:3530
10134 " guestfs_lvremove (guestfs_h *g,\n"
10135 " const char *device);\n"
10140 #: ../src/guestfs-actions.pod:3534 ../fish/guestfish-actions.pod:2381
10142 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10143 "LV, such as C</dev/VG/LV>."
10147 #: ../src/guestfs-actions.pod:3537 ../fish/guestfish-actions.pod:2384
10149 "You can also remove all LVs in a volume group by specifying the VG name, C</"
10154 #: ../src/guestfs-actions.pod:3542 ../src/guestfs-actions.pod:4699
10155 #: ../src/guestfs-actions.pod:6431
10156 msgid "(Added in 1.0.13)"
10160 #: ../src/guestfs-actions.pod:3544
10161 msgid "guestfs_lvrename"
10165 #: ../src/guestfs-actions.pod:3546
10169 " guestfs_lvrename (guestfs_h *g,\n"
10170 " const char *logvol,\n"
10171 " const char *newlogvol);\n"
10176 #: ../src/guestfs-actions.pod:3551 ../fish/guestfish-actions.pod:2391
10177 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10181 #: ../src/guestfs-actions.pod:3555 ../src/guestfs-actions.pod:6444
10182 msgid "(Added in 1.0.83)"
10186 #: ../src/guestfs-actions.pod:3557
10187 msgid "guestfs_lvresize"
10191 #: ../src/guestfs-actions.pod:3559
10195 " guestfs_lvresize (guestfs_h *g,\n"
10196 " const char *device,\n"
10202 #: ../src/guestfs-actions.pod:3564 ../fish/guestfish-actions.pod:2397
10204 "This resizes (expands or shrinks) an existing LVM logical volume to "
10205 "C<mbytes>. When reducing, data in the reduced part is lost."
10209 #: ../src/guestfs-actions.pod:3572
10210 msgid "guestfs_lvresize_free"
10214 #: ../src/guestfs-actions.pod:3574
10218 " guestfs_lvresize_free (guestfs_h *g,\n"
10219 " const char *lv,\n"
10225 #: ../src/guestfs-actions.pod:3579 ../fish/guestfish-actions.pod:2405
10227 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10228 "remaining free space in the volume group. Commonly you would call this with "
10229 "pc = 100 which expands the logical volume as much as possible, using all "
10230 "remaining free space in the volume group."
10234 #: ../src/guestfs-actions.pod:3587
10235 msgid "(Added in 1.3.3)"
10239 #: ../src/guestfs-actions.pod:3589
10240 msgid "guestfs_lvs"
10244 #: ../src/guestfs-actions.pod:3591
10248 " guestfs_lvs (guestfs_h *g);\n"
10253 #: ../src/guestfs-actions.pod:3594 ../fish/guestfish-actions.pod:2415
10255 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10260 #: ../src/guestfs-actions.pod:3597 ../fish/guestfish-actions.pod:2418
10262 "This returns a list of the logical volume device names (eg. C</dev/"
10263 "VolGroup00/LogVol00>)."
10267 #: ../src/guestfs-actions.pod:3600
10268 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
10272 #: ../src/guestfs-actions.pod:3608
10273 msgid "guestfs_lvs_full"
10277 #: ../src/guestfs-actions.pod:3610
10280 " struct guestfs_lvm_lv_list *\n"
10281 " guestfs_lvs_full (guestfs_h *g);\n"
10286 #: ../src/guestfs-actions.pod:3613 ../fish/guestfish-actions.pod:2427
10288 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10289 "(8)> command. The \"full\" version includes all fields."
10293 #: ../src/guestfs-actions.pod:3616
10295 "This function returns a C<struct guestfs_lvm_lv_list *> (see E<lt>guestfs-"
10296 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
10297 "C<guestfs_free_lvm_lv_list> after use>."
10301 #: ../src/guestfs-actions.pod:3623
10302 msgid "guestfs_lvuuid"
10306 #: ../src/guestfs-actions.pod:3625
10310 " guestfs_lvuuid (guestfs_h *g,\n"
10311 " const char *device);\n"
10316 #: ../src/guestfs-actions.pod:3629 ../fish/guestfish-actions.pod:2434
10317 msgid "This command returns the UUID of the LVM LV C<device>."
10321 #: ../src/guestfs-actions.pod:3636
10322 msgid "guestfs_lxattrlist"
10326 #: ../src/guestfs-actions.pod:3638
10329 " struct guestfs_xattr_list *\n"
10330 " guestfs_lxattrlist (guestfs_h *g,\n"
10331 " const char *path,\n"
10332 " char *const *names);\n"
10337 #: ../src/guestfs-actions.pod:3643 ../fish/guestfish-actions.pod:2440
10339 "This call allows you to get the extended attributes of multiple files, where "
10340 "all files are in the directory C<path>. C<names> is the list of files from "
10345 #: ../src/guestfs-actions.pod:3647 ../fish/guestfish-actions.pod:2444
10347 "On return you get a flat list of xattr structs which must be interpreted "
10348 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10349 "C<attrval> in this struct is zero-length to indicate there was an error "
10350 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10351 "number (the number of following attributes for this file, which could be C<"
10352 "\"0\">). Then after the first xattr struct are the zero or more attributes "
10353 "for the first named file. This repeats for the second and subsequent files."
10357 #: ../src/guestfs-actions.pod:3657
10359 "This call is intended for programs that want to efficiently list a directory "
10360 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
10361 "a similarly efficient call for getting standard stats. Very long directory "
10362 "listings might cause the protocol message size to be exceeded, causing this "
10363 "call to fail. The caller must split up such requests into smaller groups of "
10368 #: ../src/guestfs-actions.pod:3672
10369 msgid "guestfs_mkdir"
10373 #: ../src/guestfs-actions.pod:3674
10377 " guestfs_mkdir (guestfs_h *g,\n"
10378 " const char *path);\n"
10383 #: ../src/guestfs-actions.pod:3678 ../fish/guestfish-actions.pod:2466
10384 msgid "Create a directory named C<path>."
10388 #: ../src/guestfs-actions.pod:3684
10389 msgid "guestfs_mkdir_mode"
10393 #: ../src/guestfs-actions.pod:3686
10397 " guestfs_mkdir_mode (guestfs_h *g,\n"
10398 " const char *path,\n"
10404 #: ../src/guestfs-actions.pod:3691 ../fish/guestfish-actions.pod:2472
10406 "This command creates a directory, setting the initial permissions of the "
10407 "directory to C<mode>."
10411 #: ../src/guestfs-actions.pod:3694 ../fish/guestfish-actions.pod:2475
10413 "For common Linux filesystems, the actual mode which is set will be C<mode & "
10414 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
10419 #: ../src/guestfs-actions.pod:3698
10420 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
10424 #: ../src/guestfs-actions.pod:3704
10425 msgid "guestfs_mkdir_p"
10429 #: ../src/guestfs-actions.pod:3706
10433 " guestfs_mkdir_p (guestfs_h *g,\n"
10434 " const char *path);\n"
10439 #: ../src/guestfs-actions.pod:3710 ../fish/guestfish-actions.pod:2485
10441 "Create a directory named C<path>, creating any parent directories as "
10442 "necessary. This is like the C<mkdir -p> shell command."
10446 #: ../src/guestfs-actions.pod:3717
10447 msgid "guestfs_mkdtemp"
10451 #: ../src/guestfs-actions.pod:3719
10455 " guestfs_mkdtemp (guestfs_h *g,\n"
10456 " const char *template);\n"
10461 #: ../src/guestfs-actions.pod:3723 ../fish/guestfish-actions.pod:2492
10463 "This command creates a temporary directory. The C<template> parameter "
10464 "should be a full pathname for the temporary directory name with the final "
10465 "six characters being \"XXXXXX\"."
10469 #: ../src/guestfs-actions.pod:3728 ../fish/guestfish-actions.pod:2497
10471 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10472 "being suitable for Windows filesystems."
10476 #: ../src/guestfs-actions.pod:3731 ../fish/guestfish-actions.pod:2500
10477 msgid "The name of the temporary directory that was created is returned."
10481 #: ../src/guestfs-actions.pod:3734 ../fish/guestfish-actions.pod:2503
10482 msgid "The temporary directory is created with mode 0700 and is owned by root."
10486 #: ../src/guestfs-actions.pod:3737 ../fish/guestfish-actions.pod:2506
10488 "The caller is responsible for deleting the temporary directory and its "
10489 "contents after use."
10493 #: ../src/guestfs-actions.pod:3740 ../fish/guestfish-actions.pod:2509
10494 msgid "See also: L<mkdtemp(3)>"
10498 #: ../src/guestfs-actions.pod:3747
10499 msgid "guestfs_mke2fs_J"
10503 #: ../src/guestfs-actions.pod:3749
10507 " guestfs_mke2fs_J (guestfs_h *g,\n"
10508 " const char *fstype,\n"
10509 " int blocksize,\n"
10510 " const char *device,\n"
10511 " const char *journal);\n"
10516 #: ../src/guestfs-actions.pod:3756 ../fish/guestfish-actions.pod:2515
10518 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10519 "C<journal>. It is equivalent to the command:"
10523 #: ../src/guestfs-actions.pod:3760 ../fish/guestfish-actions.pod:2519
10526 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10531 #: ../src/guestfs-actions.pod:3762
10532 msgid "See also C<guestfs_mke2journal>."
10536 #: ../src/guestfs-actions.pod:3766 ../src/guestfs-actions.pod:3784
10537 #: ../src/guestfs-actions.pod:3802 ../src/guestfs-actions.pod:3818
10538 #: ../src/guestfs-actions.pod:3832 ../src/guestfs-actions.pod:3846
10539 #: ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:4088
10540 msgid "(Added in 1.0.68)"
10544 #: ../src/guestfs-actions.pod:3768
10545 msgid "guestfs_mke2fs_JL"
10549 #: ../src/guestfs-actions.pod:3770
10553 " guestfs_mke2fs_JL (guestfs_h *g,\n"
10554 " const char *fstype,\n"
10555 " int blocksize,\n"
10556 " const char *device,\n"
10557 " const char *label);\n"
10562 #: ../src/guestfs-actions.pod:3777 ../fish/guestfish-actions.pod:2527
10564 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10565 "the journal labeled C<label>."
10569 #: ../src/guestfs-actions.pod:3780
10570 msgid "See also C<guestfs_mke2journal_L>."
10574 #: ../src/guestfs-actions.pod:3786
10575 msgid "guestfs_mke2fs_JU"
10579 #: ../src/guestfs-actions.pod:3788
10583 " guestfs_mke2fs_JU (guestfs_h *g,\n"
10584 " const char *fstype,\n"
10585 " int blocksize,\n"
10586 " const char *device,\n"
10587 " const char *uuid);\n"
10592 #: ../src/guestfs-actions.pod:3795 ../fish/guestfish-actions.pod:2536
10594 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10595 "the journal with UUID C<uuid>."
10599 #: ../src/guestfs-actions.pod:3798
10600 msgid "See also C<guestfs_mke2journal_U>."
10604 #: ../src/guestfs-actions.pod:3804
10605 msgid "guestfs_mke2journal"
10609 #: ../src/guestfs-actions.pod:3806
10613 " guestfs_mke2journal (guestfs_h *g,\n"
10614 " int blocksize,\n"
10615 " const char *device);\n"
10620 #: ../src/guestfs-actions.pod:3811 ../fish/guestfish-actions.pod:2545
10622 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10627 #: ../src/guestfs-actions.pod:3814 ../fish/guestfish-actions.pod:2548
10630 " mke2fs -O journal_dev -b blocksize device\n"
10635 #: ../src/guestfs-actions.pod:3820
10636 msgid "guestfs_mke2journal_L"
10640 #: ../src/guestfs-actions.pod:3822
10644 " guestfs_mke2journal_L (guestfs_h *g,\n"
10645 " int blocksize,\n"
10646 " const char *label,\n"
10647 " const char *device);\n"
10652 #: ../src/guestfs-actions.pod:3828 ../fish/guestfish-actions.pod:2554
10653 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10657 #: ../src/guestfs-actions.pod:3834
10658 msgid "guestfs_mke2journal_U"
10662 #: ../src/guestfs-actions.pod:3836
10666 " guestfs_mke2journal_U (guestfs_h *g,\n"
10667 " int blocksize,\n"
10668 " const char *uuid,\n"
10669 " const char *device);\n"
10674 #: ../src/guestfs-actions.pod:3842 ../fish/guestfish-actions.pod:2560
10675 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10679 #: ../src/guestfs-actions.pod:3848
10680 msgid "guestfs_mkfifo"
10684 #: ../src/guestfs-actions.pod:3850
10688 " guestfs_mkfifo (guestfs_h *g,\n"
10690 " const char *path);\n"
10695 #: ../src/guestfs-actions.pod:3855
10697 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10698 "is just a convenient wrapper around C<guestfs_mknod>."
10702 #: ../src/guestfs-actions.pod:3865
10703 msgid "guestfs_mkfs"
10707 #: ../src/guestfs-actions.pod:3867
10711 " guestfs_mkfs (guestfs_h *g,\n"
10712 " const char *fstype,\n"
10713 " const char *device);\n"
10718 #: ../src/guestfs-actions.pod:3872 ../fish/guestfish-actions.pod:2576
10720 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10721 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10725 #: ../src/guestfs-actions.pod:3880
10726 msgid "guestfs_mkfs_b"
10730 #: ../src/guestfs-actions.pod:3882
10734 " guestfs_mkfs_b (guestfs_h *g,\n"
10735 " const char *fstype,\n"
10736 " int blocksize,\n"
10737 " const char *device);\n"
10742 #: ../src/guestfs-actions.pod:3888
10744 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
10745 "block size of the resulting filesystem. Supported block sizes depend on the "
10746 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10750 #: ../src/guestfs-actions.pod:3893 ../fish/guestfish-actions.pod:2589
10752 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10757 #: ../src/guestfs-actions.pod:3900
10758 msgid "guestfs_mkmountpoint"
10762 #: ../src/guestfs-actions.pod:3902
10766 " guestfs_mkmountpoint (guestfs_h *g,\n"
10767 " const char *exemptpath);\n"
10772 #: ../src/guestfs-actions.pod:3906
10774 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
10775 "that can be used to create extra mountpoints before mounting the first "
10780 #: ../src/guestfs-actions.pod:3910 ../fish/guestfish-actions.pod:2600
10782 "These calls are I<only> necessary in some very limited circumstances, mainly "
10783 "the case where you want to mount a mix of unrelated and/or read-only "
10784 "filesystems together."
10788 #: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:2604
10790 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10791 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10792 "inside that. You can unpack this as follows in guestfish:"
10796 #: ../src/guestfs-actions.pod:3919 ../fish/guestfish-actions.pod:2609
10799 " add-ro Fedora-11-i686-Live.iso\n"
10801 " mkmountpoint /cd\n"
10802 " mkmountpoint /sqsh\n"
10803 " mkmountpoint /ext3fs\n"
10804 " mount /dev/sda /cd\n"
10805 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10806 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10811 #: ../src/guestfs-actions.pod:3928 ../fish/guestfish-actions.pod:2618
10812 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
10816 #: ../src/guestfs-actions.pod:3930
10818 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
10819 "may get unexpected errors if you try to mix these calls. It is safest to "
10820 "manually unmount filesystems and remove mountpoints after use."
10824 #: ../src/guestfs-actions.pod:3934
10826 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
10827 "first, so for this to work for manual mountpoints, you must ensure that the "
10828 "innermost mountpoints have the longest pathnames, as in the example code "
10833 #: ../src/guestfs-actions.pod:3939 ../fish/guestfish-actions.pod:2629
10835 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
10839 #: ../src/guestfs-actions.pod:3941
10841 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
10842 "means that C<guestfs_umount_all> is called when the handle is closed which "
10843 "can also trigger these issues."
10847 #: ../src/guestfs-actions.pod:3947 ../src/guestfs-actions.pod:4206
10848 #: ../src/guestfs-actions.pod:5102
10849 msgid "(Added in 1.0.62)"
10853 #: ../src/guestfs-actions.pod:3949
10854 msgid "guestfs_mknod"
10858 #: ../src/guestfs-actions.pod:3951
10862 " guestfs_mknod (guestfs_h *g,\n"
10866 " const char *path);\n"
10871 #: ../src/guestfs-actions.pod:3958 ../fish/guestfish-actions.pod:2639
10873 "This call creates block or character special devices, or named pipes (FIFOs)."
10877 #: ../src/guestfs-actions.pod:3961 ../fish/guestfish-actions.pod:2642
10879 "The C<mode> parameter should be the mode, using the standard constants. "
10880 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
10881 "used when creating block and character special devices."
10885 #: ../src/guestfs-actions.pod:3966
10887 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
10888 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
10889 "regular file). These constants are available in the standard Linux header "
10890 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
10891 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
10892 "the appropriate constant for you."
10896 #: ../src/guestfs-actions.pod:3980
10897 msgid "guestfs_mknod_b"
10901 #: ../src/guestfs-actions.pod:3982
10905 " guestfs_mknod_b (guestfs_h *g,\n"
10909 " const char *path);\n"
10914 #: ../src/guestfs-actions.pod:3989
10916 "This call creates a block device node called C<path> with mode C<mode> and "
10917 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10918 "wrapper around C<guestfs_mknod>."
10922 #: ../src/guestfs-actions.pod:3999
10923 msgid "guestfs_mknod_c"
10927 #: ../src/guestfs-actions.pod:4001
10931 " guestfs_mknod_c (guestfs_h *g,\n"
10935 " const char *path);\n"
10940 #: ../src/guestfs-actions.pod:4008
10942 "This call creates a char device node called C<path> with mode C<mode> and "
10943 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10944 "wrapper around C<guestfs_mknod>."
10948 #: ../src/guestfs-actions.pod:4018
10949 msgid "guestfs_mkswap"
10953 #: ../src/guestfs-actions.pod:4020
10957 " guestfs_mkswap (guestfs_h *g,\n"
10958 " const char *device);\n"
10963 #: ../src/guestfs-actions.pod:4024 ../fish/guestfish-actions.pod:2681
10964 msgid "Create a swap partition on C<device>."
10968 #: ../src/guestfs-actions.pod:4030
10969 msgid "guestfs_mkswap_L"
10973 #: ../src/guestfs-actions.pod:4032
10977 " guestfs_mkswap_L (guestfs_h *g,\n"
10978 " const char *label,\n"
10979 " const char *device);\n"
10984 #: ../src/guestfs-actions.pod:4037 ../fish/guestfish-actions.pod:2687
10985 msgid "Create a swap partition on C<device> with label C<label>."
10989 #: ../src/guestfs-actions.pod:4039 ../fish/guestfish-actions.pod:2689
10991 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
10992 "sda>), just to a partition. This appears to be a limitation of the kernel "
10997 #: ../src/guestfs-actions.pod:4047
10998 msgid "guestfs_mkswap_U"
11002 #: ../src/guestfs-actions.pod:4049
11006 " guestfs_mkswap_U (guestfs_h *g,\n"
11007 " const char *uuid,\n"
11008 " const char *device);\n"
11013 #: ../src/guestfs-actions.pod:4054 ../fish/guestfish-actions.pod:2697
11014 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11018 #: ../src/guestfs-actions.pod:4060
11019 msgid "guestfs_mkswap_file"
11023 #: ../src/guestfs-actions.pod:4062
11027 " guestfs_mkswap_file (guestfs_h *g,\n"
11028 " const char *path);\n"
11033 #: ../src/guestfs-actions.pod:4066 ../fish/guestfish-actions.pod:2703
11034 msgid "Create a swap file."
11038 #: ../src/guestfs-actions.pod:4068
11040 "This command just writes a swap file signature to an existing file. To "
11041 "create the file itself, use something like C<guestfs_fallocate>."
11045 #: ../src/guestfs-actions.pod:4075
11046 msgid "guestfs_modprobe"
11050 #: ../src/guestfs-actions.pod:4077
11054 " guestfs_modprobe (guestfs_h *g,\n"
11055 " const char *modulename);\n"
11060 #: ../src/guestfs-actions.pod:4081 ../fish/guestfish-actions.pod:2712
11061 msgid "This loads a kernel module in the appliance."
11065 #: ../src/guestfs-actions.pod:4083 ../fish/guestfish-actions.pod:2714
11067 "The kernel module must have been whitelisted when libguestfs was built (see "
11068 "C<appliance/kmod.whitelist.in> in the source)."
11072 #: ../src/guestfs-actions.pod:4090
11073 msgid "guestfs_mount"
11077 #: ../src/guestfs-actions.pod:4092
11081 " guestfs_mount (guestfs_h *g,\n"
11082 " const char *device,\n"
11083 " const char *mountpoint);\n"
11088 #: ../src/guestfs-actions.pod:4097 ../fish/guestfish-actions.pod:2721
11090 "Mount a guest disk at a position in the filesystem. Block devices are named "
11091 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11092 "those block devices contain partitions, they will have the usual names (eg. "
11093 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11097 #: ../src/guestfs-actions.pod:4103 ../fish/guestfish-actions.pod:2727
11099 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11100 "mounted on C</> before others can be mounted. Other filesystems can only be "
11101 "mounted on directories which already exist."
11105 #: ../src/guestfs-actions.pod:4108 ../fish/guestfish-actions.pod:2732
11107 "The mounted filesystem is writable, if we have sufficient permissions on the "
11108 "underlying device."
11112 #: ../src/guestfs-actions.pod:4111
11114 "B<Important note:> When you use this call, the filesystem options C<sync> "
11115 "and C<noatime> are set implicitly. This was originally done because we "
11116 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11117 "very large negative performance impact and negligible effect on "
11118 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
11119 "in any code that needs performance, and instead use C<guestfs_mount_options> "
11120 "(use an empty string for the first parameter if you don't want any options)."
11124 #: ../src/guestfs-actions.pod:4125
11125 msgid "guestfs_mount_loop"
11129 #: ../src/guestfs-actions.pod:4127
11133 " guestfs_mount_loop (guestfs_h *g,\n"
11134 " const char *file,\n"
11135 " const char *mountpoint);\n"
11140 #: ../src/guestfs-actions.pod:4132 ../fish/guestfish-actions.pod:2749
11142 "This command lets you mount C<file> (a filesystem image in a file) on a "
11143 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11148 #: ../src/guestfs-actions.pod:4140
11149 msgid "guestfs_mount_options"
11153 #: ../src/guestfs-actions.pod:4142
11157 " guestfs_mount_options (guestfs_h *g,\n"
11158 " const char *options,\n"
11159 " const char *device,\n"
11160 " const char *mountpoint);\n"
11165 #: ../src/guestfs-actions.pod:4148
11167 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11168 "the mount options as for the L<mount(8)> I<-o> flag."
11172 #: ../src/guestfs-actions.pod:4152 ../fish/guestfish-actions.pod:2761
11174 "If the C<options> parameter is an empty string, then no options are passed "
11175 "(all options default to whatever the filesystem uses)."
11179 #: ../src/guestfs-actions.pod:4158 ../src/guestfs-actions.pod:4172
11180 #: ../src/guestfs-actions.pod:4189
11181 msgid "(Added in 1.0.10)"
11185 #: ../src/guestfs-actions.pod:4160
11186 msgid "guestfs_mount_ro"
11190 #: ../src/guestfs-actions.pod:4162
11194 " guestfs_mount_ro (guestfs_h *g,\n"
11195 " const char *device,\n"
11196 " const char *mountpoint);\n"
11201 #: ../src/guestfs-actions.pod:4167
11203 "This is the same as the C<guestfs_mount> command, but it mounts the "
11204 "filesystem with the read-only (I<-o ro>) flag."
11208 #: ../src/guestfs-actions.pod:4174
11209 msgid "guestfs_mount_vfs"
11213 #: ../src/guestfs-actions.pod:4176
11217 " guestfs_mount_vfs (guestfs_h *g,\n"
11218 " const char *options,\n"
11219 " const char *vfstype,\n"
11220 " const char *device,\n"
11221 " const char *mountpoint);\n"
11226 #: ../src/guestfs-actions.pod:4183
11228 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11229 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
11234 #: ../src/guestfs-actions.pod:4191
11235 msgid "guestfs_mountpoints"
11239 #: ../src/guestfs-actions.pod:4193
11243 " guestfs_mountpoints (guestfs_h *g);\n"
11248 #: ../src/guestfs-actions.pod:4196
11250 "This call is similar to C<guestfs_mounts>. That call returns a list of "
11251 "devices. This one returns a hash table (map) of device name to directory "
11252 "where the device is mounted."
11256 #: ../src/guestfs-actions.pod:4208
11257 msgid "guestfs_mounts"
11261 #: ../src/guestfs-actions.pod:4210
11265 " guestfs_mounts (guestfs_h *g);\n"
11270 #: ../src/guestfs-actions.pod:4213 ../fish/guestfish-actions.pod:2792
11272 "This returns the list of currently mounted filesystems. It returns the list "
11273 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11277 #: ../src/guestfs-actions.pod:4216 ../fish/guestfish-actions.pod:2795
11278 msgid "Some internal mounts are not shown."
11282 #: ../src/guestfs-actions.pod:4218
11283 msgid "See also: C<guestfs_mountpoints>"
11287 #: ../src/guestfs-actions.pod:4226
11292 #: ../src/guestfs-actions.pod:4228
11296 " guestfs_mv (guestfs_h *g,\n"
11297 " const char *src,\n"
11298 " const char *dest);\n"
11303 #: ../src/guestfs-actions.pod:4233 ../fish/guestfish-actions.pod:2803
11305 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11306 "destination filename or destination directory."
11310 #: ../src/guestfs-actions.pod:4240
11311 msgid "guestfs_ntfs_3g_probe"
11315 #: ../src/guestfs-actions.pod:4242
11319 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
11321 " const char *device);\n"
11326 #: ../src/guestfs-actions.pod:4247 ../fish/guestfish-actions.pod:2810
11328 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11329 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
11330 "write, and some cannot be mounted at all)."
11334 #: ../src/guestfs-actions.pod:4251 ../fish/guestfish-actions.pod:2814
11336 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11337 "can be mounted read-write. Set it to false if you want to test if the "
11338 "volume can be mounted read-only."
11342 #: ../src/guestfs-actions.pod:4255 ../fish/guestfish-actions.pod:2818
11344 "The return value is an integer which C<0> if the operation would succeed, or "
11345 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11349 #: ../src/guestfs-actions.pod:4261
11350 msgid "(Added in 1.0.43)"
11354 #: ../src/guestfs-actions.pod:4263
11355 msgid "guestfs_ntfsresize"
11359 #: ../src/guestfs-actions.pod:4265
11363 " guestfs_ntfsresize (guestfs_h *g,\n"
11364 " const char *device);\n"
11369 #: ../src/guestfs-actions.pod:4269 ../fish/guestfish-actions.pod:2826
11371 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
11372 "size of the underlying device. See also L<ntfsresize(8)>."
11376 #: ../src/guestfs-actions.pod:4277
11377 msgid "guestfs_ntfsresize_size"
11381 #: ../src/guestfs-actions.pod:4279
11385 " guestfs_ntfsresize_size (guestfs_h *g,\n"
11386 " const char *device,\n"
11387 " int64_t size);\n"
11392 #: ../src/guestfs-actions.pod:4284
11394 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
11395 "to specify the new size (in bytes) explicitly."
11399 #: ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:4726
11400 #: ../src/guestfs-actions.pod:4800 ../src/guestfs-actions.pod:5050
11401 msgid "(Added in 1.3.14)"
11405 #: ../src/guestfs-actions.pod:4291
11406 msgid "guestfs_part_add"
11410 #: ../src/guestfs-actions.pod:4293
11414 " guestfs_part_add (guestfs_h *g,\n"
11415 " const char *device,\n"
11416 " const char *prlogex,\n"
11417 " int64_t startsect,\n"
11418 " int64_t endsect);\n"
11423 #: ../src/guestfs-actions.pod:4300
11425 "This command adds a partition to C<device>. If there is no partition table "
11426 "on the device, call C<guestfs_part_init> first."
11430 #: ../src/guestfs-actions.pod:4303 ../fish/guestfish-actions.pod:2844
11432 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11433 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11434 "C<logical>) and C<e> (or C<extended>) partition types."
11438 #: ../src/guestfs-actions.pod:4308 ../fish/guestfish-actions.pod:2849
11440 "C<startsect> and C<endsect> are the start and end of the partition in "
11441 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11442 "from the end of the disk (C<-1> is the last sector)."
11446 #: ../src/guestfs-actions.pod:4312
11448 "Creating a partition which covers the whole disk is not so easy. Use "
11449 "C<guestfs_part_disk> to do that."
11453 #: ../src/guestfs-actions.pod:4317 ../src/guestfs-actions.pod:4355
11454 #: ../src/guestfs-actions.pod:4408 ../src/guestfs-actions.pod:4486
11455 #: ../src/guestfs-actions.pod:4525 ../src/guestfs-actions.pod:4544
11456 #: ../src/guestfs-actions.pod:4584
11457 msgid "(Added in 1.0.78)"
11461 #: ../src/guestfs-actions.pod:4319
11462 msgid "guestfs_part_del"
11466 #: ../src/guestfs-actions.pod:4321
11470 " guestfs_part_del (guestfs_h *g,\n"
11471 " const char *device,\n"
11477 #: ../src/guestfs-actions.pod:4326 ../fish/guestfish-actions.pod:2860
11478 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11482 #: ../src/guestfs-actions.pod:4328 ../fish/guestfish-actions.pod:2862
11484 "Note that in the case of MBR partitioning, deleting an extended partition "
11485 "also deletes any logical partitions it contains."
11489 #: ../src/guestfs-actions.pod:4336
11490 msgid "guestfs_part_disk"
11494 #: ../src/guestfs-actions.pod:4338
11498 " guestfs_part_disk (guestfs_h *g,\n"
11499 " const char *device,\n"
11500 " const char *parttype);\n"
11505 #: ../src/guestfs-actions.pod:4343
11507 "This command is simply a combination of C<guestfs_part_init> followed by "
11508 "C<guestfs_part_add> to create a single primary partition covering the whole "
11513 #: ../src/guestfs-actions.pod:4347
11515 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11516 "possible values are described in C<guestfs_part_init>."
11520 #: ../src/guestfs-actions.pod:4357
11521 msgid "guestfs_part_get_bootable"
11525 #: ../src/guestfs-actions.pod:4359
11529 " guestfs_part_get_bootable (guestfs_h *g,\n"
11530 " const char *device,\n"
11536 #: ../src/guestfs-actions.pod:4364 ../fish/guestfish-actions.pod:2884
11538 "This command returns true if the partition C<partnum> on C<device> has the "
11539 "bootable flag set."
11543 #: ../src/guestfs-actions.pod:4367
11544 msgid "See also C<guestfs_part_set_bootable>."
11548 #: ../src/guestfs-actions.pod:4373
11549 msgid "guestfs_part_get_mbr_id"
11553 #: ../src/guestfs-actions.pod:4375
11557 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
11558 " const char *device,\n"
11564 #: ../src/guestfs-actions.pod:4380 ../fish/guestfish-actions.pod:2893
11566 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11567 "partition C<partnum>."
11571 #: ../src/guestfs-actions.pod:4383 ../src/guestfs-actions.pod:4560
11573 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11574 "undefined results for other partition table types (see "
11575 "C<guestfs_part_get_parttype>)."
11579 #: ../src/guestfs-actions.pod:4391
11580 msgid "guestfs_part_get_parttype"
11584 #: ../src/guestfs-actions.pod:4393
11588 " guestfs_part_get_parttype (guestfs_h *g,\n"
11589 " const char *device);\n"
11594 #: ../src/guestfs-actions.pod:4397 ../fish/guestfish-actions.pod:2904
11596 "This command examines the partition table on C<device> and returns the "
11597 "partition table type (format) being used."
11601 #: ../src/guestfs-actions.pod:4400
11603 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11604 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11605 "possible, although unusual. See C<guestfs_part_init> for a full list."
11609 #: ../src/guestfs-actions.pod:4410
11610 msgid "guestfs_part_init"
11614 #: ../src/guestfs-actions.pod:4412
11618 " guestfs_part_init (guestfs_h *g,\n"
11619 " const char *device,\n"
11620 " const char *parttype);\n"
11625 #: ../src/guestfs-actions.pod:4417 ../fish/guestfish-actions.pod:2916
11627 "This creates an empty partition table on C<device> of one of the partition "
11628 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11629 "(for large disks)."
11633 #: ../src/guestfs-actions.pod:4421
11635 "Initially there are no partitions. Following this, you should call "
11636 "C<guestfs_part_add> for each partition required."
11640 #: ../src/guestfs-actions.pod:4424 ../fish/guestfish-actions.pod:2923
11641 msgid "Possible values for C<parttype> are:"
11645 #: ../src/guestfs-actions.pod:4428 ../fish/guestfish-actions.pod:2927
11646 msgid "B<efi> | B<gpt>"
11650 #: ../src/guestfs-actions.pod:4430 ../fish/guestfish-actions.pod:2929
11651 msgid "Intel EFI / GPT partition table."
11655 #: ../src/guestfs-actions.pod:4432 ../fish/guestfish-actions.pod:2931
11657 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11658 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11659 "the C<mbr> format."
11663 #: ../src/guestfs-actions.pod:4436 ../fish/guestfish-actions.pod:2935
11664 msgid "B<mbr> | B<msdos>"
11668 #: ../src/guestfs-actions.pod:4438 ../fish/guestfish-actions.pod:2937
11670 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11671 "Windows. This partition type will B<only> work for device sizes up to 2 "
11672 "TB. For large disks we recommend using C<gpt>."
11676 #: ../src/guestfs-actions.pod:4445 ../fish/guestfish-actions.pod:2944
11678 "Other partition table types that may work but are not supported include:"
11682 #: ../src/guestfs-actions.pod:4450 ../fish/guestfish-actions.pod:2949
11687 #: ../src/guestfs-actions.pod:4452 ../fish/guestfish-actions.pod:2951
11688 msgid "AIX disk labels."
11692 #: ../src/guestfs-actions.pod:4454 ../fish/guestfish-actions.pod:2953
11693 msgid "B<amiga> | B<rdb>"
11697 #: ../src/guestfs-actions.pod:4456 ../fish/guestfish-actions.pod:2955
11698 msgid "Amiga \"Rigid Disk Block\" format."
11702 #: ../src/guestfs-actions.pod:4458 ../fish/guestfish-actions.pod:2957
11707 #: ../src/guestfs-actions.pod:4460 ../fish/guestfish-actions.pod:2959
11708 msgid "BSD disk labels."
11712 #: ../src/guestfs-actions.pod:4462 ../fish/guestfish-actions.pod:2961
11717 #: ../src/guestfs-actions.pod:4464 ../fish/guestfish-actions.pod:2963
11718 msgid "DASD, used on IBM mainframes."
11722 #: ../src/guestfs-actions.pod:4466 ../fish/guestfish-actions.pod:2965
11727 #: ../src/guestfs-actions.pod:4468 ../fish/guestfish-actions.pod:2967
11728 msgid "MIPS/SGI volumes."
11732 #: ../src/guestfs-actions.pod:4470 ../fish/guestfish-actions.pod:2969
11737 #: ../src/guestfs-actions.pod:4472 ../fish/guestfish-actions.pod:2971
11738 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11742 #: ../src/guestfs-actions.pod:4474 ../fish/guestfish-actions.pod:2973
11747 #: ../src/guestfs-actions.pod:4476 ../fish/guestfish-actions.pod:2975
11748 msgid "NEC PC-98 format, common in Japan apparently."
11752 #: ../src/guestfs-actions.pod:4478 ../fish/guestfish-actions.pod:2977
11757 #: ../src/guestfs-actions.pod:4480 ../fish/guestfish-actions.pod:2979
11758 msgid "Sun disk labels."
11762 #: ../src/guestfs-actions.pod:4488
11763 msgid "guestfs_part_list"
11767 #: ../src/guestfs-actions.pod:4490
11770 " struct guestfs_partition_list *\n"
11771 " guestfs_part_list (guestfs_h *g,\n"
11772 " const char *device);\n"
11777 #: ../src/guestfs-actions.pod:4494 ../fish/guestfish-actions.pod:2987
11779 "This command parses the partition table on C<device> and returns the list of "
11780 "partitions found."
11784 #: ../src/guestfs-actions.pod:4497 ../fish/guestfish-actions.pod:2990
11785 msgid "The fields in the returned structure are:"
11789 #: ../src/guestfs-actions.pod:4501 ../fish/guestfish-actions.pod:2994
11790 msgid "B<part_num>"
11794 #: ../src/guestfs-actions.pod:4503 ../fish/guestfish-actions.pod:2996
11795 msgid "Partition number, counting from 1."
11799 #: ../src/guestfs-actions.pod:4505 ../fish/guestfish-actions.pod:2998
11800 msgid "B<part_start>"
11804 #: ../src/guestfs-actions.pod:4507
11806 "Start of the partition I<in bytes>. To get sectors you have to divide by "
11807 "the device's sector size, see C<guestfs_blockdev_getss>."
11811 #: ../src/guestfs-actions.pod:4510 ../fish/guestfish-actions.pod:3003
11812 msgid "B<part_end>"
11816 #: ../src/guestfs-actions.pod:4512 ../fish/guestfish-actions.pod:3005
11817 msgid "End of the partition in bytes."
11821 #: ../src/guestfs-actions.pod:4514 ../fish/guestfish-actions.pod:3007
11822 msgid "B<part_size>"
11826 #: ../src/guestfs-actions.pod:4516 ../fish/guestfish-actions.pod:3009
11827 msgid "Size of the partition in bytes."
11831 #: ../src/guestfs-actions.pod:4520
11833 "This function returns a C<struct guestfs_partition_list *> (see E<lt>guestfs-"
11834 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
11835 "C<guestfs_free_partition_list> after use>."
11839 #: ../src/guestfs-actions.pod:4527
11840 msgid "guestfs_part_set_bootable"
11844 #: ../src/guestfs-actions.pod:4529
11848 " guestfs_part_set_bootable (guestfs_h *g,\n"
11849 " const char *device,\n"
11851 " int bootable);\n"
11856 #: ../src/guestfs-actions.pod:4535 ../fish/guestfish-actions.pod:3017
11858 "This sets the bootable flag on partition numbered C<partnum> on device "
11859 "C<device>. Note that partitions are numbered from 1."
11863 #: ../src/guestfs-actions.pod:4538 ../fish/guestfish-actions.pod:3020
11865 "The bootable flag is used by some operating systems (notably Windows) to "
11866 "determine which partition to boot from. It is by no means universally "
11871 #: ../src/guestfs-actions.pod:4546
11872 msgid "guestfs_part_set_mbr_id"
11876 #: ../src/guestfs-actions.pod:4548
11880 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
11881 " const char *device,\n"
11888 #: ../src/guestfs-actions.pod:4554 ../fish/guestfish-actions.pod:3028
11890 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
11891 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
11892 "documentation are in fact hexadecimal numbers, but usually documented "
11893 "without any leading \"0x\" which might be confusing."
11897 #: ../src/guestfs-actions.pod:4568
11898 msgid "guestfs_part_set_name"
11902 #: ../src/guestfs-actions.pod:4570
11906 " guestfs_part_set_name (guestfs_h *g,\n"
11907 " const char *device,\n"
11909 " const char *name);\n"
11914 #: ../src/guestfs-actions.pod:4576 ../fish/guestfish-actions.pod:3042
11916 "This sets the partition name on partition numbered C<partnum> on device "
11917 "C<device>. Note that partitions are numbered from 1."
11921 #: ../src/guestfs-actions.pod:4579 ../fish/guestfish-actions.pod:3045
11923 "The partition name can only be set on certain types of partition table. "
11924 "This works on C<gpt> but not on C<mbr> partitions."
11928 #: ../src/guestfs-actions.pod:4586
11929 msgid "guestfs_part_to_dev"
11933 #: ../src/guestfs-actions.pod:4588
11937 " guestfs_part_to_dev (guestfs_h *g,\n"
11938 " const char *partition);\n"
11943 #: ../src/guestfs-actions.pod:4592 ../fish/guestfish-actions.pod:3052
11945 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
11946 "partition number, returning the device name (eg. \"/dev/sdb\")."
11950 #: ../src/guestfs-actions.pod:4596
11952 "The named partition must exist, for example as a string returned from "
11953 "C<guestfs_list_partitions>."
11957 #: ../src/guestfs-actions.pod:4604
11958 msgid "guestfs_ping_daemon"
11962 #: ../src/guestfs-actions.pod:4606
11966 " guestfs_ping_daemon (guestfs_h *g);\n"
11971 #: ../src/guestfs-actions.pod:4609 ../fish/guestfish-actions.pod:3063
11973 "This is a test probe into the guestfs daemon running inside the qemu "
11974 "subprocess. Calling this function checks that the daemon responds to the "
11975 "ping message, without affecting the daemon or attached block device(s) in "
11980 #: ../src/guestfs-actions.pod:4618
11981 msgid "guestfs_pread"
11985 #: ../src/guestfs-actions.pod:4620
11989 " guestfs_pread (guestfs_h *g,\n"
11990 " const char *path,\n"
11992 " int64_t offset,\n"
11993 " size_t *size_r);\n"
11998 #: ../src/guestfs-actions.pod:4627 ../fish/guestfish-actions.pod:3072
12000 "This command lets you read part of a file. It reads C<count> bytes of the "
12001 "file, starting at C<offset>, from file C<path>."
12005 #: ../src/guestfs-actions.pod:4630 ../src/guestfs-actions.pod:4656
12006 #: ../fish/guestfish-actions.pod:3075 ../fish/guestfish-actions.pod:3090
12008 "This may read fewer bytes than requested. For further details see the "
12009 "L<pread(2)> system call."
12013 #: ../src/guestfs-actions.pod:4633
12014 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
12018 #: ../src/guestfs-actions.pod:4644
12019 msgid "guestfs_pread_device"
12023 #: ../src/guestfs-actions.pod:4646
12027 " guestfs_pread_device (guestfs_h *g,\n"
12028 " const char *device,\n"
12030 " int64_t offset,\n"
12031 " size_t *size_r);\n"
12036 #: ../src/guestfs-actions.pod:4653 ../fish/guestfish-actions.pod:3087
12038 "This command lets you read part of a file. It reads C<count> bytes of "
12039 "C<device>, starting at C<offset>."
12043 #: ../src/guestfs-actions.pod:4659
12044 msgid "See also C<guestfs_pread>."
12048 #: ../src/guestfs-actions.pod:4668
12049 msgid "(Added in 1.5.21)"
12053 #: ../src/guestfs-actions.pod:4670
12054 msgid "guestfs_pvcreate"
12058 #: ../src/guestfs-actions.pod:4672
12062 " guestfs_pvcreate (guestfs_h *g,\n"
12063 " const char *device);\n"
12068 #: ../src/guestfs-actions.pod:4676 ../fish/guestfish-actions.pod:3102
12070 "This creates an LVM physical volume on the named C<device>, where C<device> "
12071 "should usually be a partition name such as C</dev/sda1>."
12075 #: ../src/guestfs-actions.pod:4684
12076 msgid "guestfs_pvremove"
12080 #: ../src/guestfs-actions.pod:4686
12084 " guestfs_pvremove (guestfs_h *g,\n"
12085 " const char *device);\n"
12090 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3110
12092 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12097 #: ../src/guestfs-actions.pod:4693 ../fish/guestfish-actions.pod:3113
12099 "The implementation uses the C<pvremove> command which refuses to wipe "
12100 "physical volumes that contain any volume groups, so you have to remove those "
12105 #: ../src/guestfs-actions.pod:4701
12106 msgid "guestfs_pvresize"
12110 #: ../src/guestfs-actions.pod:4703
12114 " guestfs_pvresize (guestfs_h *g,\n"
12115 " const char *device);\n"
12120 #: ../src/guestfs-actions.pod:4707 ../fish/guestfish-actions.pod:3121
12122 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12123 "the new size of the underlying device."
12127 #: ../src/guestfs-actions.pod:4714
12128 msgid "guestfs_pvresize_size"
12132 #: ../src/guestfs-actions.pod:4716
12136 " guestfs_pvresize_size (guestfs_h *g,\n"
12137 " const char *device,\n"
12138 " int64_t size);\n"
12143 #: ../src/guestfs-actions.pod:4721
12145 "This command is the same as C<guestfs_pvresize> except that it allows you to "
12146 "specify the new size (in bytes) explicitly."
12150 #: ../src/guestfs-actions.pod:4728
12151 msgid "guestfs_pvs"
12155 #: ../src/guestfs-actions.pod:4730
12159 " guestfs_pvs (guestfs_h *g);\n"
12164 #: ../src/guestfs-actions.pod:4733 ../fish/guestfish-actions.pod:3135
12166 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12171 #: ../src/guestfs-actions.pod:4736 ../fish/guestfish-actions.pod:3138
12173 "This returns a list of just the device names that contain PVs (eg. C</dev/"
12178 #: ../src/guestfs-actions.pod:4739
12179 msgid "See also C<guestfs_pvs_full>."
12183 #: ../src/guestfs-actions.pod:4747
12184 msgid "guestfs_pvs_full"
12188 #: ../src/guestfs-actions.pod:4749
12191 " struct guestfs_lvm_pv_list *\n"
12192 " guestfs_pvs_full (guestfs_h *g);\n"
12197 #: ../src/guestfs-actions.pod:4752 ../fish/guestfish-actions.pod:3147
12199 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12200 "(8)> command. The \"full\" version includes all fields."
12204 #: ../src/guestfs-actions.pod:4755
12206 "This function returns a C<struct guestfs_lvm_pv_list *> (see E<lt>guestfs-"
12207 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
12208 "C<guestfs_free_lvm_pv_list> after use>."
12212 #: ../src/guestfs-actions.pod:4762
12213 msgid "guestfs_pvuuid"
12217 #: ../src/guestfs-actions.pod:4764
12221 " guestfs_pvuuid (guestfs_h *g,\n"
12222 " const char *device);\n"
12227 #: ../src/guestfs-actions.pod:4768 ../fish/guestfish-actions.pod:3154
12228 msgid "This command returns the UUID of the LVM PV C<device>."
12232 #: ../src/guestfs-actions.pod:4775
12233 msgid "guestfs_pwrite"
12237 #: ../src/guestfs-actions.pod:4777
12241 " guestfs_pwrite (guestfs_h *g,\n"
12242 " const char *path,\n"
12243 " const char *content,\n"
12244 " size_t content_size,\n"
12245 " int64_t offset);\n"
12250 #: ../src/guestfs-actions.pod:4784 ../fish/guestfish-actions.pod:3160
12252 "This command writes to part of a file. It writes the data buffer C<content> "
12253 "to the file C<path> starting at offset C<offset>."
12257 #: ../src/guestfs-actions.pod:4787 ../fish/guestfish-actions.pod:3163
12259 "This command implements the L<pwrite(2)> system call, and like that system "
12260 "call it may not write the full data requested. The return value is the "
12261 "number of bytes that were actually written to the file. This could even be "
12262 "0, although short writes are unlikely for regular files in ordinary "
12267 #: ../src/guestfs-actions.pod:4793
12268 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
12272 #: ../src/guestfs-actions.pod:4802
12273 msgid "guestfs_pwrite_device"
12277 #: ../src/guestfs-actions.pod:4804
12281 " guestfs_pwrite_device (guestfs_h *g,\n"
12282 " const char *device,\n"
12283 " const char *content,\n"
12284 " size_t content_size,\n"
12285 " int64_t offset);\n"
12290 #: ../src/guestfs-actions.pod:4811 ../fish/guestfish-actions.pod:3178
12292 "This command writes to part of a device. It writes the data buffer "
12293 "C<content> to C<device> starting at offset C<offset>."
12297 #: ../src/guestfs-actions.pod:4814 ../fish/guestfish-actions.pod:3181
12299 "This command implements the L<pwrite(2)> system call, and like that system "
12300 "call it may not write the full data requested (although short writes to disk "
12301 "devices and partitions are probably impossible with standard Linux kernels)."
12305 #: ../src/guestfs-actions.pod:4819
12306 msgid "See also C<guestfs_pwrite>."
12310 #: ../src/guestfs-actions.pod:4826
12311 msgid "(Added in 1.5.20)"
12315 #: ../src/guestfs-actions.pod:4828
12316 msgid "guestfs_read_file"
12320 #: ../src/guestfs-actions.pod:4830
12324 " guestfs_read_file (guestfs_h *g,\n"
12325 " const char *path,\n"
12326 " size_t *size_r);\n"
12331 #: ../src/guestfs-actions.pod:4835 ../fish/guestfish-actions.pod:3195
12332 msgid "This calls returns the contents of the file C<path> as a buffer."
12336 #: ../src/guestfs-actions.pod:4838
12338 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
12339 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
12340 "function is limited in the total size of file that can be handled."
12344 #: ../src/guestfs-actions.pod:4850
12345 msgid "(Added in 1.0.63)"
12349 #: ../src/guestfs-actions.pod:4852
12350 msgid "guestfs_read_lines"
12354 #: ../src/guestfs-actions.pod:4854
12358 " guestfs_read_lines (guestfs_h *g,\n"
12359 " const char *path);\n"
12364 #: ../src/guestfs-actions.pod:4860 ../fish/guestfish-actions.pod:3212
12366 "The file contents are returned as a list of lines. Trailing C<LF> and "
12367 "C<CRLF> character sequences are I<not> returned."
12371 #: ../src/guestfs-actions.pod:4863
12373 "Note that this function cannot correctly handle binary files (specifically, "
12374 "files containing C<\\0> character which is treated as end of line). For "
12375 "those you need to use the C<guestfs_read_file> function which has a more "
12376 "complex interface."
12380 #: ../src/guestfs-actions.pod:4874
12381 msgid "guestfs_readdir"
12385 #: ../src/guestfs-actions.pod:4876
12388 " struct guestfs_dirent_list *\n"
12389 " guestfs_readdir (guestfs_h *g,\n"
12390 " const char *dir);\n"
12395 #: ../src/guestfs-actions.pod:4880 ../fish/guestfish-actions.pod:3224
12396 msgid "This returns the list of directory entries in directory C<dir>."
12400 #: ../src/guestfs-actions.pod:4882 ../fish/guestfish-actions.pod:3226
12402 "All entries in the directory are returned, including C<.> and C<..>. The "
12403 "entries are I<not> sorted, but returned in the same order as the underlying "
12408 #: ../src/guestfs-actions.pod:4886 ../fish/guestfish-actions.pod:3230
12410 "Also this call returns basic file type information about each file. The "
12411 "C<ftyp> field will contain one of the following characters:"
12415 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3235
12420 #: ../src/guestfs-actions.pod:4893 ../fish/guestfish-actions.pod:3237
12421 msgid "Block special"
12425 #: ../src/guestfs-actions.pod:4895 ../fish/guestfish-actions.pod:3239
12430 #: ../src/guestfs-actions.pod:4897 ../fish/guestfish-actions.pod:3241
12431 msgid "Char special"
12435 #: ../src/guestfs-actions.pod:4899 ../fish/guestfish-actions.pod:3243
12440 #: ../src/guestfs-actions.pod:4901 ../fish/guestfish-actions.pod:3245
12445 #: ../src/guestfs-actions.pod:4903 ../fish/guestfish-actions.pod:3247
12450 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3249
12451 msgid "FIFO (named pipe)"
12455 #: ../src/guestfs-actions.pod:4907 ../fish/guestfish-actions.pod:3251
12460 #: ../src/guestfs-actions.pod:4909 ../fish/guestfish-actions.pod:3253
12461 msgid "Symbolic link"
12465 #: ../src/guestfs-actions.pod:4911 ../fish/guestfish-actions.pod:3255
12470 #: ../src/guestfs-actions.pod:4913 ../fish/guestfish-actions.pod:3257
12471 msgid "Regular file"
12475 #: ../src/guestfs-actions.pod:4915 ../fish/guestfish-actions.pod:3259
12480 #: ../src/guestfs-actions.pod:4917 ../fish/guestfish-actions.pod:3261
12485 #: ../src/guestfs-actions.pod:4919 ../fish/guestfish-actions.pod:3263
12490 #: ../src/guestfs-actions.pod:4921 ../fish/guestfish-actions.pod:3265
12491 msgid "Unknown file type"
12495 #: ../src/guestfs-actions.pod:4923 ../fish/guestfish-actions.pod:3267
12500 #: ../src/guestfs-actions.pod:4925 ../fish/guestfish-actions.pod:3269
12502 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12506 #: ../src/guestfs-actions.pod:4930
12508 "This function is primarily intended for use by programs. To get a simple "
12509 "list of names, use C<guestfs_ls>. To get a printable directory for human "
12510 "consumption, use C<guestfs_ll>."
12514 #: ../src/guestfs-actions.pod:4934
12516 "This function returns a C<struct guestfs_dirent_list *> (see E<lt>guestfs-"
12517 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
12518 "C<guestfs_free_dirent_list> after use>."
12522 #: ../src/guestfs-actions.pod:4941
12523 msgid "guestfs_readlink"
12527 #: ../src/guestfs-actions.pod:4943
12531 " guestfs_readlink (guestfs_h *g,\n"
12532 " const char *path);\n"
12537 #: ../src/guestfs-actions.pod:4947 ../fish/guestfish-actions.pod:3282
12538 msgid "This command reads the target of a symbolic link."
12542 #: ../src/guestfs-actions.pod:4954
12543 msgid "guestfs_readlinklist"
12547 #: ../src/guestfs-actions.pod:4956
12551 " guestfs_readlinklist (guestfs_h *g,\n"
12552 " const char *path,\n"
12553 " char *const *names);\n"
12558 #: ../src/guestfs-actions.pod:4961 ../fish/guestfish-actions.pod:3288
12560 "This call allows you to do a C<readlink> operation on multiple files, where "
12561 "all files are in the directory C<path>. C<names> is the list of files from "
12566 #: ../src/guestfs-actions.pod:4965 ../fish/guestfish-actions.pod:3292
12568 "On return you get a list of strings, with a one-to-one correspondence to the "
12569 "C<names> list. Each string is the value of the symbolic link."
12573 #: ../src/guestfs-actions.pod:4969 ../fish/guestfish-actions.pod:3296
12575 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12576 "result string is the empty string C<\"\">. However the whole operation is "
12577 "completed even if there were C<readlink(2)> errors, and so you can call this "
12578 "function with names where you don't know if they are symbolic links already "
12579 "(albeit slightly less efficient)."
12583 #: ../src/guestfs-actions.pod:4976 ../fish/guestfish-actions.pod:3303
12585 "This call is intended for programs that want to efficiently list a directory "
12586 "contents without making many round-trips. Very long directory listings "
12587 "might cause the protocol message size to be exceeded, causing this call to "
12588 "fail. The caller must split up such requests into smaller groups of names."
12592 #: ../src/guestfs-actions.pod:4989
12593 msgid "guestfs_realpath"
12597 #: ../src/guestfs-actions.pod:4991
12601 " guestfs_realpath (guestfs_h *g,\n"
12602 " const char *path);\n"
12607 #: ../src/guestfs-actions.pod:4995 ../fish/guestfish-actions.pod:3314
12609 "Return the canonicalized absolute pathname of C<path>. The returned path "
12610 "has no C<.>, C<..> or symbolic link path elements."
12614 #: ../src/guestfs-actions.pod:5003
12615 msgid "guestfs_removexattr"
12619 #: ../src/guestfs-actions.pod:5005
12623 " guestfs_removexattr (guestfs_h *g,\n"
12624 " const char *xattr,\n"
12625 " const char *path);\n"
12630 #: ../src/guestfs-actions.pod:5010 ../fish/guestfish-actions.pod:3321
12632 "This call removes the extended attribute named C<xattr> of the file C<path>."
12636 #: ../src/guestfs-actions.pod:5013
12637 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
12641 #: ../src/guestfs-actions.pod:5019
12642 msgid "guestfs_resize2fs"
12646 #: ../src/guestfs-actions.pod:5021
12650 " guestfs_resize2fs (guestfs_h *g,\n"
12651 " const char *device);\n"
12656 #: ../src/guestfs-actions.pod:5025 ../fish/guestfish-actions.pod:3330
12658 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12659 "underlying device."
12663 #: ../src/guestfs-actions.pod:5028
12665 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
12666 "C<device> before calling this command. For unknown reasons C<resize2fs> "
12667 "sometimes gives an error about this and sometimes not. In any case, it is "
12668 "always safe to call C<guestfs_e2fsck_f> before calling this function."
12672 #: ../src/guestfs-actions.pod:5038
12673 msgid "guestfs_resize2fs_size"
12677 #: ../src/guestfs-actions.pod:5040
12681 " guestfs_resize2fs_size (guestfs_h *g,\n"
12682 " const char *device,\n"
12683 " int64_t size);\n"
12688 #: ../src/guestfs-actions.pod:5045
12690 "This command is the same as C<guestfs_resize2fs> except that it allows you "
12691 "to specify the new size (in bytes) explicitly."
12695 #: ../src/guestfs-actions.pod:5052
12700 #: ../src/guestfs-actions.pod:5054
12704 " guestfs_rm (guestfs_h *g,\n"
12705 " const char *path);\n"
12710 #: ../src/guestfs-actions.pod:5058 ../fish/guestfish-actions.pod:3350
12711 msgid "Remove the single file C<path>."
12715 #: ../src/guestfs-actions.pod:5064
12716 msgid "guestfs_rm_rf"
12720 #: ../src/guestfs-actions.pod:5066
12724 " guestfs_rm_rf (guestfs_h *g,\n"
12725 " const char *path);\n"
12730 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3356
12732 "Remove the file or directory C<path>, recursively removing the contents if "
12733 "its a directory. This is like the C<rm -rf> shell command."
12737 #: ../src/guestfs-actions.pod:5078
12738 msgid "guestfs_rmdir"
12742 #: ../src/guestfs-actions.pod:5080
12746 " guestfs_rmdir (guestfs_h *g,\n"
12747 " const char *path);\n"
12752 #: ../src/guestfs-actions.pod:5084 ../fish/guestfish-actions.pod:3364
12753 msgid "Remove the single directory C<path>."
12757 #: ../src/guestfs-actions.pod:5090
12758 msgid "guestfs_rmmountpoint"
12762 #: ../src/guestfs-actions.pod:5092
12766 " guestfs_rmmountpoint (guestfs_h *g,\n"
12767 " const char *exemptpath);\n"
12772 #: ../src/guestfs-actions.pod:5096
12774 "This calls removes a mountpoint that was previously created with "
12775 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
12779 #: ../src/guestfs-actions.pod:5104
12780 msgid "guestfs_scrub_device"
12784 #: ../src/guestfs-actions.pod:5106
12788 " guestfs_scrub_device (guestfs_h *g,\n"
12789 " const char *device);\n"
12794 #: ../src/guestfs-actions.pod:5110 ../fish/guestfish-actions.pod:3378
12796 "This command writes patterns over C<device> to make data retrieval more "
12801 #: ../src/guestfs-actions.pod:5113 ../src/guestfs-actions.pod:5134
12802 #: ../src/guestfs-actions.pod:5153 ../fish/guestfish-actions.pod:3381
12803 #: ../fish/guestfish-actions.pod:3396 ../fish/guestfish-actions.pod:3409
12805 "It is an interface to the L<scrub(1)> program. See that manual page for "
12810 #: ../src/guestfs-actions.pod:5121 ../src/guestfs-actions.pod:5139
12811 #: ../src/guestfs-actions.pod:5158
12812 msgid "(Added in 1.0.52)"
12816 #: ../src/guestfs-actions.pod:5123
12817 msgid "guestfs_scrub_file"
12821 #: ../src/guestfs-actions.pod:5125
12825 " guestfs_scrub_file (guestfs_h *g,\n"
12826 " const char *file);\n"
12831 #: ../src/guestfs-actions.pod:5129 ../fish/guestfish-actions.pod:3391
12833 "This command writes patterns over a file to make data retrieval more "
12838 #: ../src/guestfs-actions.pod:5132 ../fish/guestfish-actions.pod:3394
12839 msgid "The file is I<removed> after scrubbing."
12843 #: ../src/guestfs-actions.pod:5141
12844 msgid "guestfs_scrub_freespace"
12848 #: ../src/guestfs-actions.pod:5143
12852 " guestfs_scrub_freespace (guestfs_h *g,\n"
12853 " const char *dir);\n"
12858 #: ../src/guestfs-actions.pod:5147
12860 "This command creates the directory C<dir> and then fills it with files until "
12861 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
12862 "and deletes them. The intention is to scrub any free space on the partition "
12863 "containing C<dir>."
12867 #: ../src/guestfs-actions.pod:5160
12868 msgid "guestfs_set_append"
12872 #: ../src/guestfs-actions.pod:5162
12876 " guestfs_set_append (guestfs_h *g,\n"
12877 " const char *append);\n"
12882 #: ../src/guestfs-actions.pod:5166 ../fish/guestfish-actions.pod:3418
12884 "This function is used to add additional options to the guest kernel command "
12889 #: ../src/guestfs-actions.pod:5169 ../fish/guestfish-actions.pod:3421
12891 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
12892 "environment variable."
12896 #: ../src/guestfs-actions.pod:5172 ../fish/guestfish-actions.pod:3424
12898 "Setting C<append> to C<NULL> means I<no> additional options are passed "
12899 "(libguestfs always adds a few of its own)."
12903 #: ../src/guestfs-actions.pod:5179
12904 msgid "guestfs_set_autosync"
12908 #: ../src/guestfs-actions.pod:5181
12912 " guestfs_set_autosync (guestfs_h *g,\n"
12913 " int autosync);\n"
12918 #: ../src/guestfs-actions.pod:5185
12920 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
12921 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
12922 "the handle is closed (also if the program exits without closing handles)."
12926 #: ../src/guestfs-actions.pod:5190 ../fish/guestfish-actions.pod:3438
12928 "This is enabled by default (since libguestfs 1.5.24, previously it was "
12929 "disabled by default)."
12933 #: ../src/guestfs-actions.pod:5197
12934 msgid "guestfs_set_direct"
12938 #: ../src/guestfs-actions.pod:5199
12942 " guestfs_set_direct (guestfs_h *g,\n"
12948 #: ../src/guestfs-actions.pod:5203 ../fish/guestfish-actions.pod:3447
12950 "If the direct appliance mode flag is enabled, then stdin and stdout are "
12951 "passed directly through to the appliance once it is launched."
12955 #: ../src/guestfs-actions.pod:5207
12957 "One consequence of this is that log messages aren't caught by the library "
12958 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
12963 #: ../src/guestfs-actions.pod:5211 ../fish/guestfish-actions.pod:3455
12964 msgid "You probably don't want to use this unless you know what you are doing."
12968 #: ../src/guestfs-actions.pod:5214 ../fish/guestfish-actions.pod:3458
12969 msgid "The default is disabled."
12973 #: ../src/guestfs-actions.pod:5220
12974 msgid "guestfs_set_e2label"
12978 #: ../src/guestfs-actions.pod:5222
12982 " guestfs_set_e2label (guestfs_h *g,\n"
12983 " const char *device,\n"
12984 " const char *label);\n"
12989 #: ../src/guestfs-actions.pod:5227 ../fish/guestfish-actions.pod:3464
12991 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
12992 "C<label>. Filesystem labels are limited to 16 characters."
12996 #: ../src/guestfs-actions.pod:5231
12998 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
12999 "the existing label on a filesystem."
13003 #: ../src/guestfs-actions.pod:5238
13004 msgid "guestfs_set_e2uuid"
13008 #: ../src/guestfs-actions.pod:5240
13012 " guestfs_set_e2uuid (guestfs_h *g,\n"
13013 " const char *device,\n"
13014 " const char *uuid);\n"
13019 #: ../src/guestfs-actions.pod:5245 ../fish/guestfish-actions.pod:3475
13021 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13022 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13023 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13027 #: ../src/guestfs-actions.pod:5250
13029 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
13030 "the existing UUID of a filesystem."
13034 #: ../src/guestfs-actions.pod:5257
13035 msgid "guestfs_set_memsize"
13039 #: ../src/guestfs-actions.pod:5259
13043 " guestfs_set_memsize (guestfs_h *g,\n"
13049 #: ../src/guestfs-actions.pod:5263
13051 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13052 "This only has any effect if called before C<guestfs_launch>."
13056 #: ../src/guestfs-actions.pod:5267 ../fish/guestfish-actions.pod:3493
13058 "You can also change this by setting the environment variable "
13059 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13063 #: ../src/guestfs-actions.pod:5278
13064 msgid "guestfs_set_network"
13068 #: ../src/guestfs-actions.pod:5280
13072 " guestfs_set_network (guestfs_h *g,\n"
13078 #: ../src/guestfs-actions.pod:5284 ../fish/guestfish-actions.pod:3506
13080 "If C<network> is true, then the network is enabled in the libguestfs "
13081 "appliance. The default is false."
13085 #: ../src/guestfs-actions.pod:5287 ../fish/guestfish-actions.pod:3509
13087 "This affects whether commands are able to access the network (see L<guestfs"
13088 "(3)/RUNNING COMMANDS>)."
13092 #: ../src/guestfs-actions.pod:5290
13094 "You must call this before calling C<guestfs_launch>, otherwise it has no "
13099 #: ../src/guestfs-actions.pod:5297
13100 msgid "guestfs_set_path"
13104 #: ../src/guestfs-actions.pod:5299
13108 " guestfs_set_path (guestfs_h *g,\n"
13109 " const char *searchpath);\n"
13114 #: ../src/guestfs-actions.pod:5303 ../fish/guestfish-actions.pod:3521
13115 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13119 #: ../src/guestfs-actions.pod:5305 ../fish/guestfish-actions.pod:3523
13121 "The default is C<$libdir/guestfs> unless overridden by setting "
13122 "C<LIBGUESTFS_PATH> environment variable."
13126 #: ../src/guestfs-actions.pod:5308 ../fish/guestfish-actions.pod:3526
13127 msgid "Setting C<path> to C<NULL> restores the default path."
13131 #: ../src/guestfs-actions.pod:5314
13132 msgid "guestfs_set_qemu"
13136 #: ../src/guestfs-actions.pod:5316
13140 " guestfs_set_qemu (guestfs_h *g,\n"
13141 " const char *qemu);\n"
13146 #: ../src/guestfs-actions.pod:5320 ../fish/guestfish-actions.pod:3534
13147 msgid "Set the qemu binary that we will use."
13151 #: ../src/guestfs-actions.pod:5322 ../fish/guestfish-actions.pod:3536
13153 "The default is chosen when the library was compiled by the configure script."
13157 #: ../src/guestfs-actions.pod:5325 ../fish/guestfish-actions.pod:3539
13159 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13164 #: ../src/guestfs-actions.pod:5328 ../fish/guestfish-actions.pod:3542
13165 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13169 #: ../src/guestfs-actions.pod:5330 ../fish/guestfish-actions.pod:3544
13171 "Note that you should call this function as early as possible after creating "
13172 "the handle. This is because some pre-launch operations depend on testing "
13173 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13174 "don't retest features, and so you might see inconsistent results. Using the "
13175 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13176 "the qemu binary at the same time as the handle is created."
13180 #: ../src/guestfs-actions.pod:5342
13181 msgid "guestfs_set_recovery_proc"
13185 #: ../src/guestfs-actions.pod:5344
13189 " guestfs_set_recovery_proc (guestfs_h *g,\n"
13190 " int recoveryproc);\n"
13195 #: ../src/guestfs-actions.pod:5348
13197 "If this is called with the parameter C<false> then C<guestfs_launch> does "
13198 "not create a recovery process. The purpose of the recovery process is to "
13199 "stop runaway qemu processes in the case where the main program aborts "
13204 #: ../src/guestfs-actions.pod:5353
13206 "This only has any effect if called before C<guestfs_launch>, and the default "
13211 #: ../src/guestfs-actions.pod:5356 ../fish/guestfish-actions.pod:3566
13213 "About the only time when you would want to disable this is if the main "
13214 "process will fork itself into the background (\"daemonize\" itself). In "
13215 "this case the recovery process thinks that the main program has disappeared "
13216 "and so kills qemu, which is not very helpful."
13220 #: ../src/guestfs-actions.pod:5366
13221 msgid "guestfs_set_selinux"
13225 #: ../src/guestfs-actions.pod:5368
13229 " guestfs_set_selinux (guestfs_h *g,\n"
13235 #: ../src/guestfs-actions.pod:5372 ../fish/guestfish-actions.pod:3578
13237 "This sets the selinux flag that is passed to the appliance at boot time. "
13238 "The default is C<selinux=0> (disabled)."
13242 #: ../src/guestfs-actions.pod:5375 ../fish/guestfish-actions.pod:3581
13244 "Note that if SELinux is enabled, it is always in Permissive mode "
13245 "(C<enforcing=0>)."
13249 #: ../src/guestfs-actions.pod:5385
13250 msgid "guestfs_set_trace"
13254 #: ../src/guestfs-actions.pod:5387
13258 " guestfs_set_trace (guestfs_h *g,\n"
13264 #: ../src/guestfs-actions.pod:5391 ../fish/guestfish-actions.pod:3593
13266 "If the command trace flag is set to 1, then commands are printed on stderr "
13267 "before they are executed in a format which is very similar to the one used "
13268 "by guestfish. In other words, you can run a program with this enabled, and "
13269 "you will get out a script which you can feed to guestfish to perform the "
13270 "same set of actions."
13274 #: ../src/guestfs-actions.pod:5398 ../fish/guestfish-actions.pod:3600
13276 "If you want to trace C API calls into libguestfs (and other libraries) then "
13277 "possibly a better way is to use the external ltrace(1) command."
13281 #: ../src/guestfs-actions.pod:5402 ../fish/guestfish-actions.pod:3604
13283 "Command traces are disabled unless the environment variable "
13284 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13288 #: ../src/guestfs-actions.pod:5409
13289 msgid "guestfs_set_verbose"
13293 #: ../src/guestfs-actions.pod:5411
13297 " guestfs_set_verbose (guestfs_h *g,\n"
13303 #: ../src/guestfs-actions.pod:5415 ../fish/guestfish-actions.pod:3613
13304 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
13308 #: ../src/guestfs-actions.pod:5417 ../fish/guestfish-actions.pod:3615
13310 "Verbose messages are disabled unless the environment variable "
13311 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13315 #: ../src/guestfs-actions.pod:5424
13316 msgid "guestfs_setcon"
13320 #: ../src/guestfs-actions.pod:5426
13324 " guestfs_setcon (guestfs_h *g,\n"
13325 " const char *context);\n"
13330 #: ../src/guestfs-actions.pod:5430 ../fish/guestfish-actions.pod:3622
13332 "This sets the SELinux security context of the daemon to the string "
13337 #: ../src/guestfs-actions.pod:5433 ../fish/guestfish-actions.pod:3625
13338 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13342 #: ../src/guestfs-actions.pod:5439
13343 msgid "guestfs_setxattr"
13347 #: ../src/guestfs-actions.pod:5441
13351 " guestfs_setxattr (guestfs_h *g,\n"
13352 " const char *xattr,\n"
13353 " const char *val,\n"
13355 " const char *path);\n"
13360 #: ../src/guestfs-actions.pod:5448 ../fish/guestfish-actions.pod:3631
13362 "This call sets the extended attribute named C<xattr> of the file C<path> to "
13363 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
13367 #: ../src/guestfs-actions.pod:5452
13368 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
13372 #: ../src/guestfs-actions.pod:5458
13373 msgid "guestfs_sfdisk"
13377 #: ../src/guestfs-actions.pod:5460
13381 " guestfs_sfdisk (guestfs_h *g,\n"
13382 " const char *device,\n"
13386 " char *const *lines);\n"
13391 #: ../src/guestfs-actions.pod:5468 ../fish/guestfish-actions.pod:3641
13393 "This is a direct interface to the L<sfdisk(8)> program for creating "
13394 "partitions on block devices."
13398 #: ../src/guestfs-actions.pod:5471 ../fish/guestfish-actions.pod:3644
13399 msgid "C<device> should be a block device, for example C</dev/sda>."
13403 #: ../src/guestfs-actions.pod:5473 ../fish/guestfish-actions.pod:3646
13405 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
13406 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
13407 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
13408 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
13409 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
13410 "the kernel) cannot work out the right geometry and you will need to tell it."
13414 #: ../src/guestfs-actions.pod:5481 ../fish/guestfish-actions.pod:3654
13416 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
13417 "refer to the L<sfdisk(8)> manpage."
13421 #: ../src/guestfs-actions.pod:5484 ../fish/guestfish-actions.pod:3657
13423 "To create a single partition occupying the whole disk, you would pass "
13424 "C<lines> as a single element list, when the single element being the string "
13429 #: ../src/guestfs-actions.pod:5488
13431 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
13435 #: ../src/guestfs-actions.pod:5498
13436 msgid "guestfs_sfdiskM"
13440 #: ../src/guestfs-actions.pod:5500
13444 " guestfs_sfdiskM (guestfs_h *g,\n"
13445 " const char *device,\n"
13446 " char *const *lines);\n"
13451 #: ../src/guestfs-actions.pod:5505
13453 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
13454 "partition sizes are specified in megabytes only (rounded to the nearest "
13455 "cylinder) and you don't need to specify the cyls, heads and sectors "
13456 "parameters which were rarely if ever used anyway."
13460 #: ../src/guestfs-actions.pod:5511
13462 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
13463 "C<guestfs_part_disk>"
13467 #: ../src/guestfs-actions.pod:5521
13468 msgid "guestfs_sfdisk_N"
13472 #: ../src/guestfs-actions.pod:5523
13476 " guestfs_sfdisk_N (guestfs_h *g,\n"
13477 " const char *device,\n"
13482 " const char *line);\n"
13487 #: ../src/guestfs-actions.pod:5532 ../fish/guestfish-actions.pod:3687
13489 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13490 "(note: C<n> counts from 1)."
13494 #: ../src/guestfs-actions.pod:5535
13496 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
13497 "for the cyls/heads/sectors parameters."
13501 #: ../src/guestfs-actions.pod:5538
13502 msgid "See also: C<guestfs_part_add>"
13506 #: ../src/guestfs-actions.pod:5547
13507 msgid "guestfs_sfdisk_disk_geometry"
13511 #: ../src/guestfs-actions.pod:5549
13515 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
13516 " const char *device);\n"
13521 #: ../src/guestfs-actions.pod:5553
13523 "This displays the disk geometry of C<device> read from the partition table. "
13524 "Especially in the case where the underlying block device has been resized, "
13525 "this can be different from the kernel's idea of the geometry (see "
13526 "C<guestfs_sfdisk_kernel_geometry>)."
13530 #: ../src/guestfs-actions.pod:5558 ../src/guestfs-actions.pod:5574
13531 #: ../fish/guestfish-actions.pod:3707 ../fish/guestfish-actions.pod:3716
13532 msgid "The result is in human-readable format, and not designed to be parsed."
13536 #: ../src/guestfs-actions.pod:5566
13537 msgid "guestfs_sfdisk_kernel_geometry"
13541 #: ../src/guestfs-actions.pod:5568
13545 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
13546 " const char *device);\n"
13551 #: ../src/guestfs-actions.pod:5572 ../fish/guestfish-actions.pod:3714
13552 msgid "This displays the kernel's idea of the geometry of C<device>."
13556 #: ../src/guestfs-actions.pod:5582
13557 msgid "guestfs_sfdisk_l"
13561 #: ../src/guestfs-actions.pod:5584
13565 " guestfs_sfdisk_l (guestfs_h *g,\n"
13566 " const char *device);\n"
13571 #: ../src/guestfs-actions.pod:5588 ../fish/guestfish-actions.pod:3723
13573 "This displays the partition table on C<device>, in the human-readable output "
13574 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13578 #: ../src/guestfs-actions.pod:5592
13579 msgid "See also: C<guestfs_part_list>"
13583 #: ../src/guestfs-actions.pod:5599
13588 #: ../src/guestfs-actions.pod:5601
13592 " guestfs_sh (guestfs_h *g,\n"
13593 " const char *command);\n"
13598 #: ../src/guestfs-actions.pod:5605 ../fish/guestfish-actions.pod:3733
13600 "This call runs a command from the guest filesystem via the guest's C</bin/"
13605 #: ../src/guestfs-actions.pod:5608
13606 msgid "This is like C<guestfs_command>, but passes the command to:"
13610 #: ../src/guestfs-actions.pod:5610 ../fish/guestfish-actions.pod:3738
13613 " /bin/sh -c \"command\"\n"
13618 #: ../src/guestfs-actions.pod:5612 ../fish/guestfish-actions.pod:3740
13620 "Depending on the guest's shell, this usually results in wildcards being "
13621 "expanded, shell expressions being interpolated and so on."
13625 #: ../src/guestfs-actions.pod:5616
13626 msgid "All the provisos about C<guestfs_command> apply to this call."
13630 #: ../src/guestfs-actions.pod:5623
13631 msgid "guestfs_sh_lines"
13635 #: ../src/guestfs-actions.pod:5625
13639 " guestfs_sh_lines (guestfs_h *g,\n"
13640 " const char *command);\n"
13645 #: ../src/guestfs-actions.pod:5629
13647 "This is the same as C<guestfs_sh>, but splits the result into a list of "
13652 #: ../src/guestfs-actions.pod:5632
13653 msgid "See also: C<guestfs_command_lines>"
13657 #: ../src/guestfs-actions.pod:5640
13658 msgid "guestfs_sleep"
13662 #: ../src/guestfs-actions.pod:5642
13666 " guestfs_sleep (guestfs_h *g,\n"
13672 #: ../src/guestfs-actions.pod:5646 ../fish/guestfish-actions.pod:3759
13673 msgid "Sleep for C<secs> seconds."
13677 #: ../src/guestfs-actions.pod:5650
13678 msgid "(Added in 1.0.41)"
13682 #: ../src/guestfs-actions.pod:5652 ../src/guestfs-structs.pod:109
13683 msgid "guestfs_stat"
13687 #: ../src/guestfs-actions.pod:5654
13690 " struct guestfs_stat *\n"
13691 " guestfs_stat (guestfs_h *g,\n"
13692 " const char *path);\n"
13697 #: ../src/guestfs-actions.pod:5660 ../fish/guestfish-actions.pod:3767
13698 msgid "This is the same as the C<stat(2)> system call."
13702 #: ../src/guestfs-actions.pod:5668 ../src/guestfs-structs.pod:135
13703 msgid "guestfs_statvfs"
13707 #: ../src/guestfs-actions.pod:5670
13710 " struct guestfs_statvfs *\n"
13711 " guestfs_statvfs (guestfs_h *g,\n"
13712 " const char *path);\n"
13717 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3773
13719 "Returns file system statistics for any mounted file system. C<path> should "
13720 "be a file or directory in the mounted file system (typically it is the mount "
13721 "point itself, but it doesn't need to be)."
13725 #: ../src/guestfs-actions.pod:5678 ../fish/guestfish-actions.pod:3777
13726 msgid "This is the same as the C<statvfs(2)> system call."
13730 #: ../src/guestfs-actions.pod:5680
13732 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
13733 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
13737 #: ../src/guestfs-actions.pod:5686
13738 msgid "guestfs_strings"
13742 #: ../src/guestfs-actions.pod:5688
13746 " guestfs_strings (guestfs_h *g,\n"
13747 " const char *path);\n"
13752 #: ../src/guestfs-actions.pod:5692 ../fish/guestfish-actions.pod:3783
13754 "This runs the L<strings(1)> command on a file and returns the list of "
13755 "printable strings found."
13759 #: ../src/guestfs-actions.pod:5704
13760 msgid "guestfs_strings_e"
13764 #: ../src/guestfs-actions.pod:5706
13768 " guestfs_strings_e (guestfs_h *g,\n"
13769 " const char *encoding,\n"
13770 " const char *path);\n"
13775 #: ../src/guestfs-actions.pod:5711
13777 "This is like the C<guestfs_strings> command, but allows you to specify the "
13778 "encoding of strings that are looked for in the source file C<path>."
13782 #: ../src/guestfs-actions.pod:5715 ../fish/guestfish-actions.pod:3797
13783 msgid "Allowed encodings are:"
13787 #: ../src/guestfs-actions.pod:5719 ../fish/guestfish-actions.pod:3801
13792 #: ../src/guestfs-actions.pod:5721
13794 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13795 "ISO-8859-X (this is what C<guestfs_strings> uses)."
13799 #: ../src/guestfs-actions.pod:5724 ../fish/guestfish-actions.pod:3806
13804 #: ../src/guestfs-actions.pod:5726 ../fish/guestfish-actions.pod:3808
13805 msgid "Single 8-bit-byte characters."
13809 #: ../src/guestfs-actions.pod:5728 ../fish/guestfish-actions.pod:3810
13814 #: ../src/guestfs-actions.pod:5730 ../fish/guestfish-actions.pod:3812
13815 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13819 #: ../src/guestfs-actions.pod:5733 ../fish/guestfish-actions.pod:3815
13820 msgid "l (lower case letter L)"
13824 #: ../src/guestfs-actions.pod:5735 ../fish/guestfish-actions.pod:3817
13826 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
13827 "examining binaries in Windows guests."
13831 #: ../src/guestfs-actions.pod:5738 ../fish/guestfish-actions.pod:3820
13836 #: ../src/guestfs-actions.pod:5740 ../fish/guestfish-actions.pod:3822
13837 msgid "32-bit big endian such as UCS-4BE."
13841 #: ../src/guestfs-actions.pod:5742 ../fish/guestfish-actions.pod:3824
13846 #: ../src/guestfs-actions.pod:5744 ../fish/guestfish-actions.pod:3826
13847 msgid "32-bit little endian such as UCS-4LE."
13851 #: ../src/guestfs-actions.pod:5748 ../fish/guestfish-actions.pod:3830
13852 msgid "The returned strings are transcoded to UTF-8."
13856 #: ../src/guestfs-actions.pod:5759
13857 msgid "guestfs_swapoff_device"
13861 #: ../src/guestfs-actions.pod:5761
13865 " guestfs_swapoff_device (guestfs_h *g,\n"
13866 " const char *device);\n"
13871 #: ../src/guestfs-actions.pod:5765
13873 "This command disables the libguestfs appliance swap device or partition "
13874 "named C<device>. See C<guestfs_swapon_device>."
13878 #: ../src/guestfs-actions.pod:5773
13879 msgid "guestfs_swapoff_file"
13883 #: ../src/guestfs-actions.pod:5775
13887 " guestfs_swapoff_file (guestfs_h *g,\n"
13888 " const char *file);\n"
13893 #: ../src/guestfs-actions.pod:5779 ../fish/guestfish-actions.pod:3847
13894 msgid "This command disables the libguestfs appliance swap on file."
13898 #: ../src/guestfs-actions.pod:5785
13899 msgid "guestfs_swapoff_label"
13903 #: ../src/guestfs-actions.pod:5787
13907 " guestfs_swapoff_label (guestfs_h *g,\n"
13908 " const char *label);\n"
13913 #: ../src/guestfs-actions.pod:5791 ../fish/guestfish-actions.pod:3853
13915 "This command disables the libguestfs appliance swap on labeled swap "
13920 #: ../src/guestfs-actions.pod:5798
13921 msgid "guestfs_swapoff_uuid"
13925 #: ../src/guestfs-actions.pod:5800
13929 " guestfs_swapoff_uuid (guestfs_h *g,\n"
13930 " const char *uuid);\n"
13935 #: ../src/guestfs-actions.pod:5804 ../fish/guestfish-actions.pod:3860
13937 "This command disables the libguestfs appliance swap partition with the given "
13942 #: ../src/guestfs-actions.pod:5811
13943 msgid "guestfs_swapon_device"
13947 #: ../src/guestfs-actions.pod:5813
13951 " guestfs_swapon_device (guestfs_h *g,\n"
13952 " const char *device);\n"
13957 #: ../src/guestfs-actions.pod:5817
13959 "This command enables the libguestfs appliance to use the swap device or "
13960 "partition named C<device>. The increased memory is made available for all "
13961 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
13965 #: ../src/guestfs-actions.pod:5822 ../fish/guestfish-actions.pod:3872
13967 "Note that you should not swap to existing guest swap partitions unless you "
13968 "know what you are doing. They may contain hibernation information, or other "
13969 "information that the guest doesn't want you to trash. You also risk leaking "
13970 "information about the host to the guest this way. Instead, attach a new "
13971 "host device to the guest and swap on that."
13975 #: ../src/guestfs-actions.pod:5833
13976 msgid "guestfs_swapon_file"
13980 #: ../src/guestfs-actions.pod:5835
13984 " guestfs_swapon_file (guestfs_h *g,\n"
13985 " const char *file);\n"
13990 #: ../src/guestfs-actions.pod:5839
13992 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
13997 #: ../src/guestfs-actions.pod:5846
13998 msgid "guestfs_swapon_label"
14002 #: ../src/guestfs-actions.pod:5848
14006 " guestfs_swapon_label (guestfs_h *g,\n"
14007 " const char *label);\n"
14012 #: ../src/guestfs-actions.pod:5852
14014 "This command enables swap to a labeled swap partition. See "
14015 "C<guestfs_swapon_device> for other notes."
14019 #: ../src/guestfs-actions.pod:5859
14020 msgid "guestfs_swapon_uuid"
14024 #: ../src/guestfs-actions.pod:5861
14028 " guestfs_swapon_uuid (guestfs_h *g,\n"
14029 " const char *uuid);\n"
14034 #: ../src/guestfs-actions.pod:5865
14036 "This command enables swap to a swap partition with the given UUID. See "
14037 "C<guestfs_swapon_device> for other notes."
14041 #: ../src/guestfs-actions.pod:5872
14042 msgid "guestfs_sync"
14046 #: ../src/guestfs-actions.pod:5874
14050 " guestfs_sync (guestfs_h *g);\n"
14055 #: ../src/guestfs-actions.pod:5877 ../fish/guestfish-actions.pod:3904
14057 "This syncs the disk, so that any writes are flushed through to the "
14058 "underlying disk image."
14062 #: ../src/guestfs-actions.pod:5880 ../fish/guestfish-actions.pod:3907
14064 "You should always call this if you have modified a disk image, before "
14065 "closing the handle."
14069 #: ../src/guestfs-actions.pod:5887
14070 msgid "guestfs_tail"
14074 #: ../src/guestfs-actions.pod:5889
14078 " guestfs_tail (guestfs_h *g,\n"
14079 " const char *path);\n"
14084 #: ../src/guestfs-actions.pod:5893 ../fish/guestfish-actions.pod:3914
14086 "This command returns up to the last 10 lines of a file as a list of strings."
14090 #: ../src/guestfs-actions.pod:5905
14091 msgid "guestfs_tail_n"
14095 #: ../src/guestfs-actions.pod:5907
14099 " guestfs_tail_n (guestfs_h *g,\n"
14101 " const char *path);\n"
14106 #: ../src/guestfs-actions.pod:5912 ../fish/guestfish-actions.pod:3924
14108 "If the parameter C<nrlines> is a positive number, this returns the last "
14109 "C<nrlines> lines of the file C<path>."
14113 #: ../src/guestfs-actions.pod:5915 ../fish/guestfish-actions.pod:3927
14115 "If the parameter C<nrlines> is a negative number, this returns lines from "
14116 "the file C<path>, starting with the C<-nrlines>th line."
14120 #: ../src/guestfs-actions.pod:5929
14121 msgid "guestfs_tar_in"
14125 #: ../src/guestfs-actions.pod:5931
14129 " guestfs_tar_in (guestfs_h *g,\n"
14130 " const char *tarfile,\n"
14131 " const char *directory);\n"
14136 #: ../src/guestfs-actions.pod:5936 ../fish/guestfish-actions.pod:3939
14138 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14139 "tar file) into C<directory>."
14143 #: ../src/guestfs-actions.pod:5939
14145 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
14149 #: ../src/guestfs-actions.pod:5944 ../src/guestfs-actions.pod:5961
14150 #: ../src/guestfs-actions.pod:5977 ../src/guestfs-actions.pod:5993
14151 msgid "(Added in 1.0.3)"
14155 #: ../src/guestfs-actions.pod:5946
14156 msgid "guestfs_tar_out"
14160 #: ../src/guestfs-actions.pod:5948
14164 " guestfs_tar_out (guestfs_h *g,\n"
14165 " const char *directory,\n"
14166 " const char *tarfile);\n"
14171 #: ../src/guestfs-actions.pod:5953 ../fish/guestfish-actions.pod:3951
14173 "This command packs the contents of C<directory> and downloads it to local "
14178 #: ../src/guestfs-actions.pod:5956
14180 "To download a compressed tarball, use C<guestfs_tgz_out> or "
14181 "C<guestfs_txz_out>."
14185 #: ../src/guestfs-actions.pod:5963
14186 msgid "guestfs_tgz_in"
14190 #: ../src/guestfs-actions.pod:5965
14194 " guestfs_tgz_in (guestfs_h *g,\n"
14195 " const char *tarball,\n"
14196 " const char *directory);\n"
14201 #: ../src/guestfs-actions.pod:5970 ../fish/guestfish-actions.pod:3963
14203 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14204 "tar file) into C<directory>."
14208 #: ../src/guestfs-actions.pod:5973
14209 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
14213 #: ../src/guestfs-actions.pod:5979
14214 msgid "guestfs_tgz_out"
14218 #: ../src/guestfs-actions.pod:5981
14222 " guestfs_tgz_out (guestfs_h *g,\n"
14223 " const char *directory,\n"
14224 " const char *tarball);\n"
14229 #: ../src/guestfs-actions.pod:5986 ../fish/guestfish-actions.pod:3974
14231 "This command packs the contents of C<directory> and downloads it to local "
14236 #: ../src/guestfs-actions.pod:5989
14237 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
14241 #: ../src/guestfs-actions.pod:5995
14242 msgid "guestfs_touch"
14246 #: ../src/guestfs-actions.pod:5997
14250 " guestfs_touch (guestfs_h *g,\n"
14251 " const char *path);\n"
14256 #: ../src/guestfs-actions.pod:6001 ../fish/guestfish-actions.pod:3985
14258 "Touch acts like the L<touch(1)> command. It can be used to update the "
14259 "timestamps on a file, or, if the file does not exist, to create a new zero-"
14264 #: ../src/guestfs-actions.pod:6005 ../fish/guestfish-actions.pod:3989
14266 "This command only works on regular files, and will fail on other file types "
14267 "such as directories, symbolic links, block special etc."
14271 #: ../src/guestfs-actions.pod:6012
14272 msgid "guestfs_truncate"
14276 #: ../src/guestfs-actions.pod:6014
14280 " guestfs_truncate (guestfs_h *g,\n"
14281 " const char *path);\n"
14286 #: ../src/guestfs-actions.pod:6018 ../fish/guestfish-actions.pod:3996
14288 "This command truncates C<path> to a zero-length file. The file must exist "
14293 #: ../src/guestfs-actions.pod:6025
14294 msgid "guestfs_truncate_size"
14298 #: ../src/guestfs-actions.pod:6027
14302 " guestfs_truncate_size (guestfs_h *g,\n"
14303 " const char *path,\n"
14304 " int64_t size);\n"
14309 #: ../src/guestfs-actions.pod:6032 ../fish/guestfish-actions.pod:4003
14311 "This command truncates C<path> to size C<size> bytes. The file must exist "
14316 #: ../src/guestfs-actions.pod:6035
14318 "If the current file size is less than C<size> then the file is extended to "
14319 "the required size with zero bytes. This creates a sparse file (ie. disk "
14320 "blocks are not allocated for the file until you write to it). To create a "
14321 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
14325 #: ../src/guestfs-actions.pod:6045
14326 msgid "guestfs_tune2fs_l"
14330 #: ../src/guestfs-actions.pod:6047
14334 " guestfs_tune2fs_l (guestfs_h *g,\n"
14335 " const char *device);\n"
14340 #: ../src/guestfs-actions.pod:6051 ../fish/guestfish-actions.pod:4016
14342 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14347 #: ../src/guestfs-actions.pod:6054 ../fish/guestfish-actions.pod:4019
14349 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
14350 "for more details. The list of fields returned isn't clearly defined, and "
14351 "depends on both the version of C<tune2fs> that libguestfs was built against, "
14352 "and the filesystem itself."
14356 #: ../src/guestfs-actions.pod:6067
14357 msgid "guestfs_txz_in"
14361 #: ../src/guestfs-actions.pod:6069
14365 " guestfs_txz_in (guestfs_h *g,\n"
14366 " const char *tarball,\n"
14367 " const char *directory);\n"
14372 #: ../src/guestfs-actions.pod:6074 ../fish/guestfish-actions.pod:4028
14374 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
14375 "tar file) into C<directory>."
14379 #: ../src/guestfs-actions.pod:6081
14380 msgid "guestfs_txz_out"
14384 #: ../src/guestfs-actions.pod:6083
14388 " guestfs_txz_out (guestfs_h *g,\n"
14389 " const char *directory,\n"
14390 " const char *tarball);\n"
14395 #: ../src/guestfs-actions.pod:6088 ../fish/guestfish-actions.pod:4037
14397 "This command packs the contents of C<directory> and downloads it to local "
14398 "file C<tarball> (as an xz compressed tar archive)."
14402 #: ../src/guestfs-actions.pod:6095
14403 msgid "guestfs_umask"
14407 #: ../src/guestfs-actions.pod:6097
14411 " guestfs_umask (guestfs_h *g,\n"
14417 #: ../src/guestfs-actions.pod:6101 ../fish/guestfish-actions.pod:4046
14419 "This function sets the mask used for creating new files and device nodes to "
14424 #: ../src/guestfs-actions.pod:6104 ../fish/guestfish-actions.pod:4049
14426 "Typical umask values would be C<022> which creates new files with "
14427 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
14428 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
14432 #: ../src/guestfs-actions.pod:6109 ../fish/guestfish-actions.pod:4054
14434 "The default umask is C<022>. This is important because it means that "
14435 "directories and device nodes will be created with C<0644> or C<0755> mode "
14436 "even if you specify C<0777>."
14440 #: ../src/guestfs-actions.pod:6113
14442 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
14443 "C<guestfs_mkdir>."
14447 #: ../src/guestfs-actions.pod:6116 ../fish/guestfish-actions.pod:4061
14448 msgid "This call returns the previous umask."
14452 #: ../src/guestfs-actions.pod:6122
14453 msgid "guestfs_umount"
14457 #: ../src/guestfs-actions.pod:6124
14461 " guestfs_umount (guestfs_h *g,\n"
14462 " const char *pathordevice);\n"
14467 #: ../src/guestfs-actions.pod:6128 ../fish/guestfish-actions.pod:4069
14469 "This unmounts the given filesystem. The filesystem may be specified either "
14470 "by its mountpoint (path) or the device which contains the filesystem."
14474 #: ../src/guestfs-actions.pod:6136
14475 msgid "guestfs_umount_all"
14479 #: ../src/guestfs-actions.pod:6138
14483 " guestfs_umount_all (guestfs_h *g);\n"
14488 #: ../src/guestfs-actions.pod:6141 ../fish/guestfish-actions.pod:4079
14489 msgid "This unmounts all mounted filesystems."
14493 #: ../src/guestfs-actions.pod:6143 ../fish/guestfish-actions.pod:4081
14494 msgid "Some internal mounts are not unmounted by this call."
14498 #: ../src/guestfs-actions.pod:6149
14499 msgid "guestfs_upload"
14503 #: ../src/guestfs-actions.pod:6151
14507 " guestfs_upload (guestfs_h *g,\n"
14508 " const char *filename,\n"
14509 " const char *remotefilename);\n"
14514 #: ../src/guestfs-actions.pod:6156 ../src/guestfs-actions.pod:6175
14515 #: ../fish/guestfish-actions.pod:4087 ../fish/guestfish-actions.pod:4100
14516 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14520 #: ../src/guestfs-actions.pod:6161
14521 msgid "See also C<guestfs_download>."
14525 #: ../src/guestfs-actions.pod:6167
14526 msgid "guestfs_upload_offset"
14530 #: ../src/guestfs-actions.pod:6169
14534 " guestfs_upload_offset (guestfs_h *g,\n"
14535 " const char *filename,\n"
14536 " const char *remotefilename,\n"
14537 " int64_t offset);\n"
14542 #: ../src/guestfs-actions.pod:6178 ../fish/guestfish-actions.pod:4103
14544 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14545 "The intention is to overwrite parts of existing files or devices, although "
14546 "if a non-existant file is specified then it is created with a \"hole\" "
14547 "before C<offset>. The size of the data written is implicit in the size of "
14548 "the source C<filename>."
14552 #: ../src/guestfs-actions.pod:6185
14554 "Note that there is no limit on the amount of data that can be uploaded with "
14555 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
14556 "full amount unless an error occurs."
14560 #: ../src/guestfs-actions.pod:6190
14561 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
14565 #: ../src/guestfs-actions.pod:6196
14566 msgid "guestfs_utimens"
14570 #: ../src/guestfs-actions.pod:6198
14574 " guestfs_utimens (guestfs_h *g,\n"
14575 " const char *path,\n"
14576 " int64_t atsecs,\n"
14577 " int64_t atnsecs,\n"
14578 " int64_t mtsecs,\n"
14579 " int64_t mtnsecs);\n"
14584 #: ../src/guestfs-actions.pod:6206 ../fish/guestfish-actions.pod:4123
14585 msgid "This command sets the timestamps of a file with nanosecond precision."
14589 #: ../src/guestfs-actions.pod:6209 ../fish/guestfish-actions.pod:4126
14591 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14596 #: ../src/guestfs-actions.pod:6212 ../fish/guestfish-actions.pod:4129
14598 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14599 "nanoseconds from the epoch."
14603 #: ../src/guestfs-actions.pod:6215 ../fish/guestfish-actions.pod:4132
14605 "If the C<*nsecs> field contains the special value C<-1> then the "
14606 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14607 "ignored in this case)."
14611 #: ../src/guestfs-actions.pod:6219 ../fish/guestfish-actions.pod:4136
14613 "If the C<*nsecs> field contains the special value C<-2> then the "
14614 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14619 #: ../src/guestfs-actions.pod:6227 ../src/guestfs-structs.pod:175
14620 msgid "guestfs_version"
14624 #: ../src/guestfs-actions.pod:6229
14627 " struct guestfs_version *\n"
14628 " guestfs_version (guestfs_h *g);\n"
14633 #: ../src/guestfs-actions.pod:6232 ../fish/guestfish-actions.pod:4144
14635 "Return the libguestfs version number that the program is linked against."
14639 #: ../src/guestfs-actions.pod:6235 ../fish/guestfish-actions.pod:4147
14641 "Note that because of dynamic linking this is not necessarily the version of "
14642 "libguestfs that you compiled against. You can compile the program, and then "
14643 "at runtime dynamically link against a completely different C<libguestfs.so> "
14648 #: ../src/guestfs-actions.pod:6240 ../fish/guestfish-actions.pod:4152
14650 "This call was added in version C<1.0.58>. In previous versions of "
14651 "libguestfs there was no way to get the version number. From C code you can "
14652 "use dynamic linker functions to find out if this symbol exists (if it "
14653 "doesn't, then it's an earlier version)."
14657 #: ../src/guestfs-actions.pod:6246 ../fish/guestfish-actions.pod:4158
14659 "The call returns a structure with four elements. The first three (C<major>, "
14660 "C<minor> and C<release>) are numbers and correspond to the usual version "
14661 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14662 "but may be used for distro-specific information."
14666 #: ../src/guestfs-actions.pod:6252 ../fish/guestfish-actions.pod:4164
14668 "To construct the original version string: C<$major.$minor.$release$extra>"
14672 #: ../src/guestfs-actions.pod:6255 ../fish/guestfish-actions.pod:4167
14673 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14677 #: ../src/guestfs-actions.pod:6257
14679 "I<Note:> Don't use this call to test for availability of features. In "
14680 "enterprise distributions we backport features from later versions into "
14681 "earlier versions, making this an unreliable way to test for features. Use "
14682 "C<guestfs_available> instead."
14686 #: ../src/guestfs-actions.pod:6263
14688 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
14689 "error. I<The caller must call C<guestfs_free_version> after use>."
14693 #: ../src/guestfs-actions.pod:6267
14694 msgid "(Added in 1.0.58)"
14698 #: ../src/guestfs-actions.pod:6269
14699 msgid "guestfs_vfs_label"
14703 #: ../src/guestfs-actions.pod:6271
14707 " guestfs_vfs_label (guestfs_h *g,\n"
14708 " const char *device);\n"
14713 #: ../src/guestfs-actions.pod:6275 ../fish/guestfish-actions.pod:4179
14714 msgid "This returns the filesystem label of the filesystem on C<device>."
14718 #: ../src/guestfs-actions.pod:6278 ../fish/guestfish-actions.pod:4182
14719 msgid "If the filesystem is unlabeled, this returns the empty string."
14723 #: ../src/guestfs-actions.pod:6280
14724 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
14728 #: ../src/guestfs-actions.pod:6285 ../src/guestfs-actions.pod:6322
14729 msgid "(Added in 1.3.18)"
14733 #: ../src/guestfs-actions.pod:6287
14734 msgid "guestfs_vfs_type"
14738 #: ../src/guestfs-actions.pod:6289
14742 " guestfs_vfs_type (guestfs_h *g,\n"
14743 " const char *device);\n"
14748 #: ../src/guestfs-actions.pod:6293 ../fish/guestfish-actions.pod:4190
14750 "This command gets the filesystem type corresponding to the filesystem on "
14755 #: ../src/guestfs-actions.pod:6296 ../fish/guestfish-actions.pod:4193
14757 "For most filesystems, the result is the name of the Linux VFS module which "
14758 "would be used to mount this filesystem if you mounted it without specifying "
14759 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14763 #: ../src/guestfs-actions.pod:6306
14764 msgid "guestfs_vfs_uuid"
14768 #: ../src/guestfs-actions.pod:6308
14772 " guestfs_vfs_uuid (guestfs_h *g,\n"
14773 " const char *device);\n"
14778 #: ../src/guestfs-actions.pod:6312 ../fish/guestfish-actions.pod:4202
14779 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14783 #: ../src/guestfs-actions.pod:6315 ../fish/guestfish-actions.pod:4205
14784 msgid "If the filesystem does not have a UUID, this returns the empty string."
14788 #: ../src/guestfs-actions.pod:6317
14789 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
14793 #: ../src/guestfs-actions.pod:6324
14794 msgid "guestfs_vg_activate"
14798 #: ../src/guestfs-actions.pod:6326
14802 " guestfs_vg_activate (guestfs_h *g,\n"
14804 " char *const *volgroups);\n"
14809 #: ../src/guestfs-actions.pod:6331 ../fish/guestfish-actions.pod:4213
14811 "This command activates or (if C<activate> is false) deactivates all logical "
14812 "volumes in the listed volume groups C<volgroups>. If activated, then they "
14813 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
14814 "deactivated, then those devices disappear."
14818 #: ../src/guestfs-actions.pod:6337 ../fish/guestfish-actions.pod:4219
14819 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14823 #: ../src/guestfs-actions.pod:6339 ../fish/guestfish-actions.pod:4221
14825 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14826 "activated or deactivated."
14830 #: ../src/guestfs-actions.pod:6346
14831 msgid "guestfs_vg_activate_all"
14835 #: ../src/guestfs-actions.pod:6348
14839 " guestfs_vg_activate_all (guestfs_h *g,\n"
14840 " int activate);\n"
14845 #: ../src/guestfs-actions.pod:6352 ../fish/guestfish-actions.pod:4228
14847 "This command activates or (if C<activate> is false) deactivates all logical "
14848 "volumes in all volume groups. If activated, then they are made known to the "
14849 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
14850 "those devices disappear."
14854 #: ../src/guestfs-actions.pod:6358 ../fish/guestfish-actions.pod:4234
14855 msgid "This command is the same as running C<vgchange -a y|n>"
14859 #: ../src/guestfs-actions.pod:6364
14860 msgid "guestfs_vgcreate"
14864 #: ../src/guestfs-actions.pod:6366
14868 " guestfs_vgcreate (guestfs_h *g,\n"
14869 " const char *volgroup,\n"
14870 " char *const *physvols);\n"
14875 #: ../src/guestfs-actions.pod:6371 ../fish/guestfish-actions.pod:4240
14877 "This creates an LVM volume group called C<volgroup> from the non-empty list "
14878 "of physical volumes C<physvols>."
14882 #: ../src/guestfs-actions.pod:6378
14883 msgid "guestfs_vglvuuids"
14887 #: ../src/guestfs-actions.pod:6380
14891 " guestfs_vglvuuids (guestfs_h *g,\n"
14892 " const char *vgname);\n"
14897 #: ../src/guestfs-actions.pod:6384 ../fish/guestfish-actions.pod:4247
14899 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
14900 "volumes created in this volume group."
14904 #: ../src/guestfs-actions.pod:6387
14906 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
14907 "associate logical volumes and volume groups."
14911 #: ../src/guestfs-actions.pod:6390
14912 msgid "See also C<guestfs_vgpvuuids>."
14916 #: ../src/guestfs-actions.pod:6398
14917 msgid "guestfs_vgpvuuids"
14921 #: ../src/guestfs-actions.pod:6400
14925 " guestfs_vgpvuuids (guestfs_h *g,\n"
14926 " const char *vgname);\n"
14931 #: ../src/guestfs-actions.pod:6404 ../fish/guestfish-actions.pod:4259
14933 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
14934 "volumes that this volume group resides on."
14938 #: ../src/guestfs-actions.pod:6407
14940 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
14941 "associate physical volumes and volume groups."
14945 #: ../src/guestfs-actions.pod:6410
14946 msgid "See also C<guestfs_vglvuuids>."
14950 #: ../src/guestfs-actions.pod:6418
14951 msgid "guestfs_vgremove"
14955 #: ../src/guestfs-actions.pod:6420
14959 " guestfs_vgremove (guestfs_h *g,\n"
14960 " const char *vgname);\n"
14965 #: ../src/guestfs-actions.pod:6424 ../fish/guestfish-actions.pod:4271
14966 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
14970 #: ../src/guestfs-actions.pod:6426 ../fish/guestfish-actions.pod:4273
14972 "This also forcibly removes all logical volumes in the volume group (if any)."
14976 #: ../src/guestfs-actions.pod:6433
14977 msgid "guestfs_vgrename"
14981 #: ../src/guestfs-actions.pod:6435
14985 " guestfs_vgrename (guestfs_h *g,\n"
14986 " const char *volgroup,\n"
14987 " const char *newvolgroup);\n"
14992 #: ../src/guestfs-actions.pod:6440 ../fish/guestfish-actions.pod:4280
14993 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
14997 #: ../src/guestfs-actions.pod:6446
14998 msgid "guestfs_vgs"
15002 #: ../src/guestfs-actions.pod:6448
15006 " guestfs_vgs (guestfs_h *g);\n"
15011 #: ../src/guestfs-actions.pod:6451 ../fish/guestfish-actions.pod:4286
15013 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15018 #: ../src/guestfs-actions.pod:6454 ../fish/guestfish-actions.pod:4289
15020 "This returns a list of just the volume group names that were detected (eg. "
15025 #: ../src/guestfs-actions.pod:6457
15026 msgid "See also C<guestfs_vgs_full>."
15030 #: ../src/guestfs-actions.pod:6465
15031 msgid "guestfs_vgs_full"
15035 #: ../src/guestfs-actions.pod:6467
15038 " struct guestfs_lvm_vg_list *\n"
15039 " guestfs_vgs_full (guestfs_h *g);\n"
15044 #: ../src/guestfs-actions.pod:6470 ../fish/guestfish-actions.pod:4298
15046 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15047 "> command. The \"full\" version includes all fields."
15051 #: ../src/guestfs-actions.pod:6473
15053 "This function returns a C<struct guestfs_lvm_vg_list *> (see E<lt>guestfs-"
15054 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
15055 "C<guestfs_free_lvm_vg_list> after use>."
15059 #: ../src/guestfs-actions.pod:6480
15060 msgid "guestfs_vgscan"
15064 #: ../src/guestfs-actions.pod:6482
15068 " guestfs_vgscan (guestfs_h *g);\n"
15073 #: ../src/guestfs-actions.pod:6485 ../fish/guestfish-actions.pod:4305
15075 "This rescans all block devices and rebuilds the list of LVM physical "
15076 "volumes, volume groups and logical volumes."
15080 #: ../src/guestfs-actions.pod:6492
15081 msgid "guestfs_vguuid"
15085 #: ../src/guestfs-actions.pod:6494
15089 " guestfs_vguuid (guestfs_h *g,\n"
15090 " const char *vgname);\n"
15095 #: ../src/guestfs-actions.pod:6498 ../fish/guestfish-actions.pod:4312
15096 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15100 #: ../src/guestfs-actions.pod:6505
15101 msgid "guestfs_wait_ready"
15105 #: ../src/guestfs-actions.pod:6507
15109 " guestfs_wait_ready (guestfs_h *g);\n"
15114 #: ../src/guestfs-actions.pod:6510
15115 msgid "This function is a no op."
15119 #: ../src/guestfs-actions.pod:6512
15121 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
15122 "calling C<guestfs_launch> to wait for the launch to complete. However this "
15123 "is no longer necessary because C<guestfs_launch> now does the waiting."
15127 #: ../src/guestfs-actions.pod:6517
15129 "If you see any calls to this function in code then you can just remove them, "
15130 "unless you want to retain compatibility with older versions of the API."
15134 #: ../src/guestfs-actions.pod:6525
15135 msgid "guestfs_wc_c"
15139 #: ../src/guestfs-actions.pod:6527
15143 " guestfs_wc_c (guestfs_h *g,\n"
15144 " const char *path);\n"
15149 #: ../src/guestfs-actions.pod:6531 ../fish/guestfish-actions.pod:4318
15151 "This command counts the characters in a file, using the C<wc -c> external "
15156 #: ../src/guestfs-actions.pod:6538
15157 msgid "guestfs_wc_l"
15161 #: ../src/guestfs-actions.pod:6540
15165 " guestfs_wc_l (guestfs_h *g,\n"
15166 " const char *path);\n"
15171 #: ../src/guestfs-actions.pod:6544 ../fish/guestfish-actions.pod:4325
15173 "This command counts the lines in a file, using the C<wc -l> external command."
15177 #: ../src/guestfs-actions.pod:6551
15178 msgid "guestfs_wc_w"
15182 #: ../src/guestfs-actions.pod:6553
15186 " guestfs_wc_w (guestfs_h *g,\n"
15187 " const char *path);\n"
15192 #: ../src/guestfs-actions.pod:6557 ../fish/guestfish-actions.pod:4332
15194 "This command counts the words in a file, using the C<wc -w> external command."
15198 #: ../src/guestfs-actions.pod:6564
15199 msgid "guestfs_write"
15203 #: ../src/guestfs-actions.pod:6566
15207 " guestfs_write (guestfs_h *g,\n"
15208 " const char *path,\n"
15209 " const char *content,\n"
15210 " size_t content_size);\n"
15215 #: ../src/guestfs-actions.pod:6572 ../fish/guestfish-actions.pod:4339
15217 "This call creates a file called C<path>. The content of the file is the "
15218 "string C<content> (which can contain any 8 bit data)."
15222 #: ../src/guestfs-actions.pod:6582
15223 msgid "guestfs_write_file"
15227 #: ../src/guestfs-actions.pod:6584
15231 " guestfs_write_file (guestfs_h *g,\n"
15232 " const char *path,\n"
15233 " const char *content,\n"
15239 #: ../src/guestfs-actions.pod:6590 ../fish/guestfish-actions.pod:4349
15241 "This call creates a file called C<path>. The contents of the file is the "
15242 "string C<content> (which can contain any 8 bit data), with length C<size>."
15246 #: ../src/guestfs-actions.pod:6594 ../fish/guestfish-actions.pod:4353
15248 "As a special case, if C<size> is C<0> then the length is calculated using "
15249 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15253 #: ../src/guestfs-actions.pod:6598 ../fish/guestfish-actions.pod:4357
15255 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15256 "I<not> work, even if the length is specified."
15260 #: ../src/guestfs-actions.pod:6606 ../fish/guestfish-actions.pod:4363
15262 "This function is deprecated. In new code, use the C<write> call instead."
15266 #: ../src/guestfs-actions.pod:6615
15267 msgid "guestfs_zegrep"
15271 #: ../src/guestfs-actions.pod:6617
15275 " guestfs_zegrep (guestfs_h *g,\n"
15276 " const char *regex,\n"
15277 " const char *path);\n"
15282 #: ../src/guestfs-actions.pod:6622 ../fish/guestfish-actions.pod:4374
15284 "This calls the external C<zegrep> program and returns the matching lines."
15288 #: ../src/guestfs-actions.pod:6634
15289 msgid "guestfs_zegrepi"
15293 #: ../src/guestfs-actions.pod:6636
15297 " guestfs_zegrepi (guestfs_h *g,\n"
15298 " const char *regex,\n"
15299 " const char *path);\n"
15304 #: ../src/guestfs-actions.pod:6641 ../fish/guestfish-actions.pod:4384
15306 "This calls the external C<zegrep -i> program and returns the matching lines."
15310 #: ../src/guestfs-actions.pod:6653
15311 msgid "guestfs_zero"
15315 #: ../src/guestfs-actions.pod:6655
15319 " guestfs_zero (guestfs_h *g,\n"
15320 " const char *device);\n"
15325 #: ../src/guestfs-actions.pod:6659 ../fish/guestfish-actions.pod:4394
15326 msgid "This command writes zeroes over the first few blocks of C<device>."
15330 #: ../src/guestfs-actions.pod:6661 ../fish/guestfish-actions.pod:4396
15332 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15333 "securely wipe the device). It should be sufficient to remove any partition "
15334 "tables, filesystem superblocks and so on."
15338 #: ../src/guestfs-actions.pod:6665
15339 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
15343 #: ../src/guestfs-actions.pod:6676
15344 msgid "guestfs_zero_device"
15348 #: ../src/guestfs-actions.pod:6678
15352 " guestfs_zero_device (guestfs_h *g,\n"
15353 " const char *device);\n"
15358 #: ../src/guestfs-actions.pod:6682
15360 "This command writes zeroes over the entire C<device>. Compare with "
15361 "C<guestfs_zero> which just zeroes the first few blocks of a device."
15365 #: ../src/guestfs-actions.pod:6696
15366 msgid "(Added in 1.3.1)"
15370 #: ../src/guestfs-actions.pod:6698
15371 msgid "guestfs_zerofree"
15375 #: ../src/guestfs-actions.pod:6700
15379 " guestfs_zerofree (guestfs_h *g,\n"
15380 " const char *device);\n"
15385 #: ../src/guestfs-actions.pod:6704 ../fish/guestfish-actions.pod:4417
15387 "This runs the I<zerofree> program on C<device>. This program claims to zero "
15388 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
15389 "possible to compress the filesystem more effectively."
15393 #: ../src/guestfs-actions.pod:6709 ../fish/guestfish-actions.pod:4422
15394 msgid "You should B<not> run this program if the filesystem is mounted."
15398 #: ../src/guestfs-actions.pod:6712 ../fish/guestfish-actions.pod:4425
15400 "It is possible that using this program can damage the filesystem or data on "
15405 #: ../src/guestfs-actions.pod:6719
15406 msgid "guestfs_zfgrep"
15410 #: ../src/guestfs-actions.pod:6721
15414 " guestfs_zfgrep (guestfs_h *g,\n"
15415 " const char *pattern,\n"
15416 " const char *path);\n"
15421 #: ../src/guestfs-actions.pod:6726 ../fish/guestfish-actions.pod:4432
15423 "This calls the external C<zfgrep> program and returns the matching lines."
15427 #: ../src/guestfs-actions.pod:6738
15428 msgid "guestfs_zfgrepi"
15432 #: ../src/guestfs-actions.pod:6740
15436 " guestfs_zfgrepi (guestfs_h *g,\n"
15437 " const char *pattern,\n"
15438 " const char *path);\n"
15443 #: ../src/guestfs-actions.pod:6745 ../fish/guestfish-actions.pod:4442
15445 "This calls the external C<zfgrep -i> program and returns the matching lines."
15449 #: ../src/guestfs-actions.pod:6757
15450 msgid "guestfs_zfile"
15454 #: ../src/guestfs-actions.pod:6759
15458 " guestfs_zfile (guestfs_h *g,\n"
15459 " const char *meth,\n"
15460 " const char *path);\n"
15465 #: ../src/guestfs-actions.pod:6764 ../fish/guestfish-actions.pod:4452
15467 "This command runs C<file> after first decompressing C<path> using C<method>."
15471 #: ../src/guestfs-actions.pod:6767 ../fish/guestfish-actions.pod:4455
15472 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
15476 #: ../src/guestfs-actions.pod:6769
15478 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
15483 #: ../src/guestfs-actions.pod:6775 ../fish/guestfish-actions.pod:4460
15485 "This function is deprecated. In new code, use the C<file> call instead."
15489 #: ../src/guestfs-actions.pod:6784
15490 msgid "guestfs_zgrep"
15494 #: ../src/guestfs-actions.pod:6786
15498 " guestfs_zgrep (guestfs_h *g,\n"
15499 " const char *regex,\n"
15500 " const char *path);\n"
15505 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4471
15507 "This calls the external C<zgrep> program and returns the matching lines."
15511 #: ../src/guestfs-actions.pod:6803
15512 msgid "guestfs_zgrepi"
15516 #: ../src/guestfs-actions.pod:6805
15520 " guestfs_zgrepi (guestfs_h *g,\n"
15521 " const char *regex,\n"
15522 " const char *path);\n"
15527 #: ../src/guestfs-actions.pod:6810 ../fish/guestfish-actions.pod:4481
15529 "This calls the external C<zgrep -i> program and returns the matching lines."
15533 #: ../src/guestfs-availability.pod:3
15538 #: ../src/guestfs-availability.pod:5
15540 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
15541 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
15542 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
15543 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
15544 "L</guestfs_aug_save> L</guestfs_aug_set>"
15548 #: ../src/guestfs-availability.pod:21
15553 #: ../src/guestfs-availability.pod:23
15555 "The following functions: L</guestfs_inotify_add_watch> L</"
15556 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
15557 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
15561 #: ../src/guestfs-availability.pod:31
15562 msgid "B<linuxfsuuid>"
15566 #: ../src/guestfs-availability.pod:33
15568 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
15569 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
15573 #: ../src/guestfs-availability.pod:40
15574 msgid "B<linuxmodules>"
15578 #: ../src/guestfs-availability.pod:42
15579 msgid "The following functions: L</guestfs_modprobe>"
15583 #: ../src/guestfs-availability.pod:45
15584 msgid "B<linuxxattrs>"
15588 #: ../src/guestfs-availability.pod:47
15590 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> L</"
15591 "guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</"
15592 "guestfs_removexattr> L</guestfs_setxattr>"
15596 #: ../src/guestfs-availability.pod:56
15601 #: ../src/guestfs-availability.pod:58
15603 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
15604 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
15605 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
15609 #: ../src/guestfs-availability.pod:67
15614 #: ../src/guestfs-availability.pod:69
15616 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
15617 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
15618 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
15619 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
15620 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
15621 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
15622 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
15626 #: ../src/guestfs-availability.pod:92
15631 #: ../src/guestfs-availability.pod:94
15633 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
15634 "guestfs_mknod_b> L</guestfs_mknod_c>"
15638 #: ../src/guestfs-availability.pod:100
15643 #: ../src/guestfs-availability.pod:102
15644 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
15648 #: ../src/guestfs-availability.pod:105
15649 msgid "B<ntfsprogs>"
15653 #: ../src/guestfs-availability.pod:107
15655 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
15659 #: ../src/guestfs-availability.pod:111
15660 msgid "B<realpath>"
15664 #: ../src/guestfs-availability.pod:113
15665 msgid "The following functions: L</guestfs_realpath>"
15669 #: ../src/guestfs-availability.pod:116
15674 #: ../src/guestfs-availability.pod:118
15676 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
15677 "guestfs_scrub_freespace>"
15681 #: ../src/guestfs-availability.pod:123
15686 #: ../src/guestfs-availability.pod:125
15687 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
15691 #: ../src/guestfs-availability.pod:129
15696 #: ../src/guestfs-availability.pod:131
15697 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
15701 #: ../src/guestfs-availability.pod:135
15702 msgid "B<zerofree>"
15706 #: ../src/guestfs-availability.pod:137
15707 msgid "The following functions: L</guestfs_zerofree>"
15711 #: ../src/guestfs-structs.pod:1
15712 msgid "guestfs_int_bool"
15716 #: ../src/guestfs-structs.pod:3
15719 " struct guestfs_int_bool {\n"
15727 #: ../src/guestfs-structs.pod:8
15730 " struct guestfs_int_bool_list {\n"
15731 " uint32_t len; /* Number of elements in list. */\n"
15732 " struct guestfs_int_bool *val; /* Elements. */\n"
15738 #: ../src/guestfs-structs.pod:13
15741 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
15742 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
15747 #: ../src/guestfs-structs.pod:16
15748 msgid "guestfs_lvm_pv"
15752 #: ../src/guestfs-structs.pod:18
15755 " struct guestfs_lvm_pv {\n"
15756 " char *pv_name;\n"
15757 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
15758 " char pv_uuid[32];\n"
15760 " uint64_t pv_size;\n"
15761 " uint64_t dev_size;\n"
15762 " uint64_t pv_free;\n"
15763 " uint64_t pv_used;\n"
15764 " char *pv_attr;\n"
15765 " int64_t pv_pe_count;\n"
15766 " int64_t pv_pe_alloc_count;\n"
15767 " char *pv_tags;\n"
15768 " uint64_t pe_start;\n"
15769 " int64_t pv_mda_count;\n"
15770 " uint64_t pv_mda_free;\n"
15776 #: ../src/guestfs-structs.pod:36
15779 " struct guestfs_lvm_pv_list {\n"
15780 " uint32_t len; /* Number of elements in list. */\n"
15781 " struct guestfs_lvm_pv *val; /* Elements. */\n"
15787 #: ../src/guestfs-structs.pod:41
15790 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
15791 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
15796 #: ../src/guestfs-structs.pod:44
15797 msgid "guestfs_lvm_vg"
15801 #: ../src/guestfs-structs.pod:46
15804 " struct guestfs_lvm_vg {\n"
15805 " char *vg_name;\n"
15806 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
15807 " char vg_uuid[32];\n"
15809 " char *vg_attr;\n"
15810 " uint64_t vg_size;\n"
15811 " uint64_t vg_free;\n"
15812 " char *vg_sysid;\n"
15813 " uint64_t vg_extent_size;\n"
15814 " int64_t vg_extent_count;\n"
15815 " int64_t vg_free_count;\n"
15816 " int64_t max_lv;\n"
15817 " int64_t max_pv;\n"
15818 " int64_t pv_count;\n"
15819 " int64_t lv_count;\n"
15820 " int64_t snap_count;\n"
15821 " int64_t vg_seqno;\n"
15822 " char *vg_tags;\n"
15823 " int64_t vg_mda_count;\n"
15824 " uint64_t vg_mda_free;\n"
15830 #: ../src/guestfs-structs.pod:69
15833 " struct guestfs_lvm_vg_list {\n"
15834 " uint32_t len; /* Number of elements in list. */\n"
15835 " struct guestfs_lvm_vg *val; /* Elements. */\n"
15841 #: ../src/guestfs-structs.pod:74
15844 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
15845 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
15850 #: ../src/guestfs-structs.pod:77
15851 msgid "guestfs_lvm_lv"
15855 #: ../src/guestfs-structs.pod:79
15858 " struct guestfs_lvm_lv {\n"
15859 " char *lv_name;\n"
15860 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
15861 " char lv_uuid[32];\n"
15862 " char *lv_attr;\n"
15863 " int64_t lv_major;\n"
15864 " int64_t lv_minor;\n"
15865 " int64_t lv_kernel_major;\n"
15866 " int64_t lv_kernel_minor;\n"
15867 " uint64_t lv_size;\n"
15868 " int64_t seg_count;\n"
15870 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
15871 " float snap_percent;\n"
15872 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
15873 " float copy_percent;\n"
15874 " char *move_pv;\n"
15875 " char *lv_tags;\n"
15876 " char *mirror_log;\n"
15877 " char *modules;\n"
15883 #: ../src/guestfs-structs.pod:101
15886 " struct guestfs_lvm_lv_list {\n"
15887 " uint32_t len; /* Number of elements in list. */\n"
15888 " struct guestfs_lvm_lv *val; /* Elements. */\n"
15894 #: ../src/guestfs-structs.pod:106
15897 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
15898 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
15903 #: ../src/guestfs-structs.pod:111
15906 " struct guestfs_stat {\n"
15910 " int64_t nlink;\n"
15915 " int64_t blksize;\n"
15916 " int64_t blocks;\n"
15917 " int64_t atime;\n"
15918 " int64_t mtime;\n"
15919 " int64_t ctime;\n"
15925 #: ../src/guestfs-structs.pod:127
15928 " struct guestfs_stat_list {\n"
15929 " uint32_t len; /* Number of elements in list. */\n"
15930 " struct guestfs_stat *val; /* Elements. */\n"
15936 #: ../src/guestfs-structs.pod:132
15939 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
15940 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
15945 #: ../src/guestfs-structs.pod:137
15948 " struct guestfs_statvfs {\n"
15949 " int64_t bsize;\n"
15950 " int64_t frsize;\n"
15951 " int64_t blocks;\n"
15952 " int64_t bfree;\n"
15953 " int64_t bavail;\n"
15954 " int64_t files;\n"
15955 " int64_t ffree;\n"
15956 " int64_t favail;\n"
15959 " int64_t namemax;\n"
15965 #: ../src/guestfs-structs.pod:151
15968 " struct guestfs_statvfs_list {\n"
15969 " uint32_t len; /* Number of elements in list. */\n"
15970 " struct guestfs_statvfs *val; /* Elements. */\n"
15976 #: ../src/guestfs-structs.pod:156
15979 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
15980 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
15985 #: ../src/guestfs-structs.pod:159
15986 msgid "guestfs_dirent"
15990 #: ../src/guestfs-structs.pod:161
15993 " struct guestfs_dirent {\n"
16002 #: ../src/guestfs-structs.pod:167
16005 " struct guestfs_dirent_list {\n"
16006 " uint32_t len; /* Number of elements in list. */\n"
16007 " struct guestfs_dirent *val; /* Elements. */\n"
16013 #: ../src/guestfs-structs.pod:172
16016 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
16017 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
16022 #: ../src/guestfs-structs.pod:177
16025 " struct guestfs_version {\n"
16026 " int64_t major;\n"
16027 " int64_t minor;\n"
16028 " int64_t release;\n"
16035 #: ../src/guestfs-structs.pod:184
16038 " struct guestfs_version_list {\n"
16039 " uint32_t len; /* Number of elements in list. */\n"
16040 " struct guestfs_version *val; /* Elements. */\n"
16046 #: ../src/guestfs-structs.pod:189
16049 " void guestfs_free_version (struct guestfs_free_version *);\n"
16050 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
16055 #: ../src/guestfs-structs.pod:192
16056 msgid "guestfs_xattr"
16060 #: ../src/guestfs-structs.pod:194
16063 " struct guestfs_xattr {\n"
16064 " char *attrname;\n"
16065 " /* The next two fields describe a byte array. */\n"
16066 " uint32_t attrval_len;\n"
16067 " char *attrval;\n"
16073 #: ../src/guestfs-structs.pod:201
16076 " struct guestfs_xattr_list {\n"
16077 " uint32_t len; /* Number of elements in list. */\n"
16078 " struct guestfs_xattr *val; /* Elements. */\n"
16084 #: ../src/guestfs-structs.pod:206
16087 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
16088 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
16093 #: ../src/guestfs-structs.pod:209
16094 msgid "guestfs_inotify_event"
16098 #: ../src/guestfs-structs.pod:211
16101 " struct guestfs_inotify_event {\n"
16102 " int64_t in_wd;\n"
16103 " uint32_t in_mask;\n"
16104 " uint32_t in_cookie;\n"
16105 " char *in_name;\n"
16111 #: ../src/guestfs-structs.pod:218
16114 " struct guestfs_inotify_event_list {\n"
16115 " uint32_t len; /* Number of elements in list. */\n"
16116 " struct guestfs_inotify_event *val; /* Elements. */\n"
16122 #: ../src/guestfs-structs.pod:223
16125 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
16126 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
16131 #: ../src/guestfs-structs.pod:226
16132 msgid "guestfs_partition"
16136 #: ../src/guestfs-structs.pod:228
16139 " struct guestfs_partition {\n"
16140 " int32_t part_num;\n"
16141 " uint64_t part_start;\n"
16142 " uint64_t part_end;\n"
16143 " uint64_t part_size;\n"
16149 #: ../src/guestfs-structs.pod:235
16152 " struct guestfs_partition_list {\n"
16153 " uint32_t len; /* Number of elements in list. */\n"
16154 " struct guestfs_partition *val; /* Elements. */\n"
16160 #: ../src/guestfs-structs.pod:240
16163 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
16164 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
16169 #: ../fish/guestfish.pod:5
16170 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
16174 #: ../fish/guestfish.pod:9
16177 " guestfish [--options] [commands]\n"
16182 #: ../fish/guestfish.pod:11
16190 #: ../fish/guestfish.pod:13
16193 " guestfish [--ro|--rw] -a disk.img\n"
16198 #: ../fish/guestfish.pod:15
16201 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
16206 #: ../fish/guestfish.pod:17
16209 " guestfish -d libvirt-domain\n"
16214 #: ../fish/guestfish.pod:19
16217 " guestfish [--ro|--rw] -a disk.img -i\n"
16222 #: ../fish/guestfish.pod:21
16225 " guestfish -d libvirt-domain -i\n"
16230 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
16231 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
16232 #: ../tools/virt-rescue.pl:41
16237 #: ../fish/guestfish.pod:25
16239 "Using guestfish in read/write mode on live virtual machines can be "
16240 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16241 "option to use guestfish safely if the disk image or virtual machine might be "
16246 #: ../fish/guestfish.pod:32
16248 "Guestfish is a shell and command-line tool for examining and modifying "
16249 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16250 "functionality of the guestfs API, see L<guestfs(3)>."
16254 #: ../fish/guestfish.pod:36
16256 "Guestfish gives you structured access to the libguestfs API, from shell "
16257 "scripts or the command line or interactively. If you want to rescue a "
16258 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16263 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:846
16264 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58
16265 #: ../tools/virt-resize.pl:66 ../tools/virt-cat.pl:50 ../tools/virt-tar.pl:45
16270 #: ../fish/guestfish.pod:43
16271 msgid "As an interactive shell"
16275 #: ../fish/guestfish.pod:45
16283 #: ../fish/guestfish.pod:47
16286 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
16287 " editing virtual machine filesystems.\n"
16292 #: ../fish/guestfish.pod:50
16295 " Type: 'help' for a list of commands\n"
16296 " 'man' to read the manual\n"
16297 " 'quit' to quit the shell\n"
16302 #: ../fish/guestfish.pod:54
16305 " ><fs> add-ro disk.img\n"
16307 " ><fs> list-filesystems\n"
16308 " /dev/sda1: ext4\n"
16309 " /dev/vg_guest/lv_root: ext4\n"
16310 " /dev/vg_guest/lv_swap: swap\n"
16311 " ><fs> mount /dev/vg_guest/lv_root /\n"
16312 " ><fs> cat /etc/fstab\n"
16314 " # Created by anaconda\n"
16321 #: ../fish/guestfish.pod:67
16322 msgid "From shell scripts"
16326 #: ../fish/guestfish.pod:69
16327 msgid "Create a new C</etc/motd> file in a guest or disk image:"
16331 #: ../fish/guestfish.pod:71
16334 " guestfish <<_EOF_\n"
16337 " mount /dev/vg_guest/lv_root /\n"
16338 " write /etc/motd \"Welcome, new users\"\n"
16344 #: ../fish/guestfish.pod:78
16345 msgid "List the LVM logical volumes in a disk image:"
16349 #: ../fish/guestfish.pod:80
16352 " guestfish -a disk.img --ro <<_EOF_\n"
16360 #: ../fish/guestfish.pod:85
16361 msgid "List all the filesystems in a disk image:"
16365 #: ../fish/guestfish.pod:87
16368 " guestfish -a disk.img --ro <<_EOF_\n"
16370 " list-filesystems\n"
16376 #: ../fish/guestfish.pod:92
16377 msgid "On one command line"
16381 #: ../fish/guestfish.pod:94
16382 msgid "Update C</etc/resolv.conf> in a guest:"
16386 #: ../fish/guestfish.pod:96
16390 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
16391 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
16396 #: ../fish/guestfish.pod:100
16397 msgid "Edit C</boot/grub/grub.conf> interactively:"
16401 #: ../fish/guestfish.pod:102
16404 " guestfish --rw --add disk.img \\\n"
16405 " --mount /dev/vg_guest/lv_root \\\n"
16406 " --mount /dev/sda1:/boot \\\n"
16407 " edit /boot/grub/grub.conf\n"
16412 #: ../fish/guestfish.pod:107
16413 msgid "Mount disks automatically"
16417 #: ../fish/guestfish.pod:109
16419 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
16423 #: ../fish/guestfish.pod:112
16426 " guestfish --ro -a disk.img -i cat /etc/group\n"
16431 #: ../fish/guestfish.pod:114
16434 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
16439 #: ../fish/guestfish.pod:116
16440 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
16444 #: ../fish/guestfish.pod:118
16447 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
16452 #: ../fish/guestfish.pod:120
16453 msgid "As a script interpreter"
16457 #: ../fish/guestfish.pod:122
16458 msgid "Create a 100MB disk containing an ext2-formatted partition:"
16462 #: ../fish/guestfish.pod:124
16465 " #!/usr/bin/guestfish -f\n"
16466 " sparse test1.img 100M\n"
16468 " part-disk /dev/sda mbr\n"
16469 " mkfs ext2 /dev/sda1\n"
16474 #: ../fish/guestfish.pod:130
16475 msgid "Start with a prepared disk"
16479 #: ../fish/guestfish.pod:132
16481 "An alternate way to create a 100MB disk called C<test1.img> containing a "
16482 "single ext2-formatted partition:"
16486 #: ../fish/guestfish.pod:135
16489 " guestfish -N fs\n"
16494 #: ../fish/guestfish.pod:137
16495 msgid "To list what is available do:"
16499 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:837
16502 " guestfish -N help | less\n"
16507 #: ../fish/guestfish.pod:141
16508 msgid "Remote control"
16512 #: ../fish/guestfish.pod:143
16515 " eval \"`guestfish --listen`\"\n"
16516 " guestfish --remote add-ro disk.img\n"
16517 " guestfish --remote run\n"
16518 " guestfish --remote lvs\n"
16523 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
16524 #: ../fuse/guestmount.pod:73 ../inspector/virt-inspector.pl:68
16525 #: ../tools/virt-edit.pl:72 ../tools/virt-win-reg.pl:171
16526 #: ../tools/virt-df.pl:71 ../tools/virt-ls.pl:78 ../tools/virt-resize.pl:257
16527 #: ../tools/virt-list-filesystems.pl:50 ../tools/virt-cat.pl:79
16528 #: ../tools/virt-tar.pl:98 ../tools/virt-rescue.pl:103
16529 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:51
16534 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
16535 #: ../inspector/virt-inspector.pl:76 ../tools/virt-edit.pl:80
16536 #: ../tools/virt-win-reg.pl:179 ../tools/virt-df.pl:79 ../tools/virt-ls.pl:86
16537 #: ../tools/virt-resize.pl:265 ../tools/virt-list-filesystems.pl:58
16538 #: ../tools/virt-cat.pl:87 ../tools/virt-tar.pl:106
16539 #: ../tools/virt-rescue.pl:111 ../tools/virt-make-fs.pl:161
16540 #: ../tools/virt-list-partitions.pl:59
16545 #: ../fish/guestfish.pod:154
16546 msgid "Displays general help on options."
16550 #: ../fish/guestfish.pod:156
16551 msgid "B<-h> | B<--cmd-help>"
16555 #: ../fish/guestfish.pod:158
16556 msgid "Lists all available guestfish commands."
16560 #: ../fish/guestfish.pod:160
16561 msgid "B<-h cmd> | B<--cmd-help cmd>"
16565 #: ../fish/guestfish.pod:162
16566 msgid "Displays detailed help on a single command C<cmd>."
16570 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
16571 msgid "B<-a image> | B<--add image>"
16575 #: ../fish/guestfish.pod:166
16576 msgid "Add a block device or virtual machine image to the shell."
16580 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
16582 "The format of the disk image is auto-detected. To override this and force a "
16583 "particular format use the I<--format=..> option."
16587 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
16588 msgid "B<-c URI> | B<--connect URI>"
16592 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
16594 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16595 "URI to use. The default is to use the default libvirt connection."
16599 #: ../fish/guestfish.pod:177
16604 #: ../fish/guestfish.pod:179
16606 "If using the I<--listen> option and a csh-like shell, use this option. See "
16607 "section L</REMOTE CONTROL AND CSH> below."
16611 #: ../fish/guestfish.pod:182 ../fuse/guestmount.pod:90
16612 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
16616 #: ../fish/guestfish.pod:184 ../fuse/guestmount.pod:92
16618 "Add disks from the named libvirt domain. If the I<--ro> option is also "
16619 "used, then any libvirt domain can be used. However in write mode, only "
16620 "libvirt domains which are shut down can be named here."
16624 #: ../fish/guestfish.pod:188
16625 msgid "B<-D> | B<--no-dest-paths>"
16629 #: ../fish/guestfish.pod:190
16631 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
16632 "to hit the tab key to complete paths on the guest filesystem, but this "
16633 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
16634 "allow this feature to be disabled."
16638 #: ../fish/guestfish.pod:195 ../fuse/guestmount.pod:108
16639 msgid "B<--echo-keys>"
16643 #: ../fish/guestfish.pod:197 ../fuse/guestmount.pod:110
16645 "When prompting for keys and passphrases, guestfish normally turns echoing "
16646 "off so you cannot see what you are typing. If you are not worried about "
16647 "Tempest attacks and there is no one else in the room you can specify this "
16648 "flag to see what you are typing."
16652 #: ../fish/guestfish.pod:202
16653 msgid "B<-f file> | B<--file file>"
16657 #: ../fish/guestfish.pod:204
16658 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
16662 #: ../fish/guestfish.pod:207
16665 " #!/usr/bin/guestfish -f\n"
16670 #: ../fish/guestfish.pod:209 ../fuse/guestmount.pod:115
16671 msgid "B<--format=raw|qcow2|..> | B<--format>"
16675 #: ../fish/guestfish.pod:211 ../fuse/guestmount.pod:117
16677 "The default for the I<-a> option is to auto-detect the format of the disk "
16678 "image. Using this forces the disk format for I<-a> options which follow on "
16679 "the command line. Using I<--format> with no argument switches back to auto-"
16680 "detection for subsequent I<-a> options."
16684 #: ../fish/guestfish.pod:216 ../fish/guestfish.pod:543
16685 #: ../inspector/virt-inspector.pl:549
16686 msgid "For example:"
16690 #: ../fish/guestfish.pod:218
16693 " guestfish --format=raw -a disk.img\n"
16698 #: ../fish/guestfish.pod:220
16699 msgid "forces raw format (no auto-detection) for C<disk.img>."
16703 #: ../fish/guestfish.pod:222
16706 " guestfish --format=raw -a disk.img --format -a another.img\n"
16711 #: ../fish/guestfish.pod:224
16713 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
16714 "detection for C<another.img>."
16718 #: ../fish/guestfish.pod:227
16720 "If you have untrusted raw-format guest disk images, you should use this "
16721 "option to specify the disk format. This avoids a possible security problem "
16722 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
16726 #: ../fish/guestfish.pod:232 ../fuse/guestmount.pod:135
16727 msgid "B<-i> | B<--inspector>"
16731 #: ../fish/guestfish.pod:234 ../fuse/guestmount.pod:137
16733 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
16734 "system and mount filesystems as they would be mounted on the real virtual "
16739 #: ../fish/guestfish.pod:238
16740 msgid "Typical usage is either:"
16744 #: ../fish/guestfish.pod:240
16747 " guestfish -d myguest -i\n"
16752 #: ../fish/guestfish.pod:242
16753 msgid "(for an inactive libvirt domain called I<myguest>), or:"
16757 #: ../fish/guestfish.pod:244
16760 " guestfish --ro -d myguest -i\n"
16765 #: ../fish/guestfish.pod:246
16766 msgid "(for active domains, readonly), or specify the block device directly:"
16770 #: ../fish/guestfish.pod:248
16773 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
16778 #: ../fish/guestfish.pod:250
16780 "Note that the command line syntax changed slightly over older versions of "
16781 "guestfish. You can still use the old syntax:"
16785 #: ../fish/guestfish.pod:253
16788 " guestfish [--ro] -i disk.img\n"
16793 #: ../fish/guestfish.pod:255
16796 " guestfish [--ro] -i libvirt-domain\n"
16801 #: ../fish/guestfish.pod:257 ../fuse/guestmount.pod:141
16802 msgid "B<--keys-from-stdin>"
16806 #: ../fish/guestfish.pod:259 ../fuse/guestmount.pod:143
16808 "Read key or passphrase parameters from stdin. The default is to try to read "
16809 "passphrases from the user by opening C</dev/tty>."
16813 #: ../fish/guestfish.pod:262
16814 msgid "B<--listen>"
16818 #: ../fish/guestfish.pod:264
16820 "Fork into the background and listen for remote commands. See section L</"
16821 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
16825 #: ../fish/guestfish.pod:267
16826 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
16830 #: ../fish/guestfish.pod:269
16831 msgid "Mount the named partition or logical volume on the given mountpoint."
16835 #: ../fish/guestfish.pod:271
16836 msgid "If the mountpoint is omitted, it defaults to C</>."
16840 #: ../fish/guestfish.pod:273
16841 msgid "You have to mount something on C</> before most commands will work."
16845 #: ../fish/guestfish.pod:275
16847 "If any I<-m> or I<--mount> options are given, the guest is automatically "
16852 #: ../fish/guestfish.pod:278
16854 "If you don't know what filesystems a disk image contains, you can either run "
16855 "guestfish without this option, then list the partitions and LVs available "
16856 "(see L</list-partitions> and L</lvs> commands), or you can use the L<virt-"
16857 "list-filesystems(1)> program."
16861 #: ../fish/guestfish.pod:283 ../fuse/guestmount.pod:154
16862 msgid "B<-n> | B<--no-sync>"
16866 #: ../fish/guestfish.pod:285
16868 "Disable autosync. This is enabled by default. See the discussion of "
16869 "autosync in the L<guestfs(3)> manpage."
16873 #: ../fish/guestfish.pod:288
16874 msgid "B<-N type> | B<--new type> | B<-N help>"
16878 #: ../fish/guestfish.pod:290
16880 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
16881 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
16882 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
16887 #: ../fish/guestfish.pod:295
16888 msgid "B<--progress-bars>"
16892 #: ../fish/guestfish.pod:297
16893 msgid "Enable progress bars, even when guestfish is used non-interactively."
16897 #: ../fish/guestfish.pod:299
16899 "Progress bars are enabled by default when guestfish is used as an "
16900 "interactive shell."
16904 #: ../fish/guestfish.pod:302
16905 msgid "B<--no-progress-bars>"
16909 #: ../fish/guestfish.pod:304
16910 msgid "Disable progress bars."
16914 #: ../fish/guestfish.pod:306
16915 msgid "B<--remote[=pid]>"
16919 #: ../fish/guestfish.pod:308
16921 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
16922 "CONTROL GUESTFISH OVER A SOCKET> below."
16926 #: ../fish/guestfish.pod:311 ../fuse/guestmount.pod:196
16927 msgid "B<-r> | B<--ro>"
16931 #: ../fish/guestfish.pod:313
16933 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
16934 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
16938 #: ../fish/guestfish.pod:316 ../tools/virt-rescue.pl:187
16940 "The option must always be used if the disk image or virtual machine might be "
16941 "running, and is generally recommended in cases where you don't need write "
16942 "access to the disk."
16946 #: ../fish/guestfish.pod:320
16948 "Note that prepared disk images created with I<-N> are not affected by the "
16953 #: ../fish/guestfish.pod:323
16954 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
16958 #: ../fish/guestfish.pod:325 ../fuse/guestmount.pod:208
16959 #: ../tools/virt-rescue.pl:195
16960 msgid "B<--selinux>"
16964 #: ../fish/guestfish.pod:327
16965 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
16969 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:212
16970 msgid "B<-v> | B<--verbose>"
16974 #: ../fish/guestfish.pod:331
16976 "Enable very verbose messages. This is particularly useful if you find a bug."
16980 #: ../fish/guestfish.pod:334 ../fuse/guestmount.pod:216
16981 msgid "B<-V> | B<--version>"
16985 #: ../fish/guestfish.pod:336
16986 msgid "Display the guestfish / libguestfs version number and exit."
16990 #: ../fish/guestfish.pod:338 ../fuse/guestmount.pod:220
16991 msgid "B<-w> | B<--rw>"
16995 #: ../fish/guestfish.pod:340
16997 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
17002 #: ../fish/guestfish.pod:343
17007 #: ../fish/guestfish.pod:345
17008 msgid "Echo each command before executing it."
17012 #: ../fish/guestfish.pod:349
17013 msgid "COMMANDS ON COMMAND LINE"
17017 #: ../fish/guestfish.pod:351
17019 "Any additional (non-option) arguments are treated as commands to execute."
17023 #: ../fish/guestfish.pod:354
17025 "Commands to execute should be separated by a colon (C<:>), where the colon "
17026 "is a separate parameter. Thus:"
17030 #: ../fish/guestfish.pod:357
17033 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
17038 #: ../fish/guestfish.pod:359
17040 "If there are no additional arguments, then we enter a shell, either an "
17041 "interactive shell with a prompt (if the input is a terminal) or a non-"
17042 "interactive shell."
17046 #: ../fish/guestfish.pod:363
17048 "In either command line mode or non-interactive shell, the first command that "
17049 "gives an error causes the whole shell to exit. In interactive mode (with a "
17050 "prompt) if a command fails, you can continue to enter commands."
17054 #: ../fish/guestfish.pod:368
17055 msgid "USING launch (OR run)"
17059 #: ../fish/guestfish.pod:370
17061 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
17062 "then launch it, then mount any disks you need, and finally issue actions/"
17063 "commands. So the general order of the day is:"
17067 #: ../fish/guestfish.pod:378
17068 msgid "add or -a/--add"
17072 #: ../fish/guestfish.pod:382
17073 msgid "launch (aka run)"
17077 #: ../fish/guestfish.pod:386
17078 msgid "mount or -m/--mount"
17082 #: ../fish/guestfish.pod:390
17083 msgid "any other commands"
17087 #: ../fish/guestfish.pod:394
17089 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
17090 "guest before mounting or performing any other commands."
17094 #: ../fish/guestfish.pod:397
17096 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
17097 "I<--new> options were given then C<run> is done automatically, simply "
17098 "because guestfish can't perform the action you asked for without doing this."
17102 #: ../fish/guestfish.pod:402
17103 msgid "OPENING DISKS FOR READ AND WRITE"
17107 #: ../fish/guestfish.pod:404
17109 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
17110 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
17111 "open disk images read-only or for writing."
17115 #: ../fish/guestfish.pod:408
17117 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
17118 "disk images supplied on the command line for write. To open a disk image "
17119 "read-only you have to do I<-a image --ro>."
17123 #: ../fish/guestfish.pod:412
17125 "This matters: If you accidentally open a live VM disk image writable then "
17126 "you will cause irreversible disk corruption."
17130 #: ../fish/guestfish.pod:415
17132 "By libguestfs 1.8 we intend to change the default the other way. Disk "
17133 "images will be opened read-only. You will have to either specify "
17134 "I<guestfish --rw> or change a configuration file in order to get write "
17135 "access for disk images specified by those other command line options."
17139 #: ../fish/guestfish.pod:420
17141 "This version of guestfish has a I<--rw> option which does nothing (it is "
17142 "already the default). However it is highly recommended that you use this "
17143 "option to indicate that guestfish needs write access, and to prepare your "
17144 "scripts for the day when this option will be required for write access."
17148 #: ../fish/guestfish.pod:426
17150 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
17151 "other libguestfs program apart from guestfish and guestmount."
17155 #: ../fish/guestfish.pod:429
17160 #: ../fish/guestfish.pod:431
17162 "You can quote ordinary parameters using either single or double quotes. For "
17167 #: ../fish/guestfish.pod:434
17170 " add \"file with a space.img\"\n"
17175 #: ../fish/guestfish.pod:436
17178 " rm '/file name'\n"
17183 #: ../fish/guestfish.pod:438
17191 #: ../fish/guestfish.pod:440
17193 "A few commands require a list of strings to be passed. For these, use a "
17194 "whitespace-separated list, enclosed in quotes. Strings containing "
17195 "whitespace to be passed through must be enclosed in single quotes. A "
17196 "literal single quote must be escaped with a backslash."
17200 #: ../fish/guestfish.pod:445
17203 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17204 " command \"/bin/echo 'foo bar'\"\n"
17205 " command \"/bin/echo \\'foo\\'\"\n"
17210 #: ../fish/guestfish.pod:449
17211 msgid "OPTIONAL ARGUMENTS"
17215 #: ../fish/guestfish.pod:451
17217 "Some commands take optional arguments. These arguments appear in this "
17218 "documentation as C<[argname:..]>. You can use them as in these examples:"
17222 #: ../fish/guestfish.pod:455
17225 " add-drive-opts filename\n"
17230 #: ../fish/guestfish.pod:457
17233 " add-drive-opts filename readonly:true\n"
17238 #: ../fish/guestfish.pod:459
17241 " add-drive-opts filename format:qcow2 readonly:false\n"
17246 #: ../fish/guestfish.pod:461
17248 "Each optional argument can appear at most once. All optional arguments must "
17249 "appear after the required ones."
17253 #: ../fish/guestfish.pod:464
17258 #: ../fish/guestfish.pod:466
17260 "This section applies to all commands which can take integers as parameters."
17264 #: ../fish/guestfish.pod:469
17265 msgid "SIZE SUFFIX"
17269 #: ../fish/guestfish.pod:471
17271 "When the command takes a parameter measured in bytes, you can use one of the "
17272 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17276 #: ../fish/guestfish.pod:477
17277 msgid "B<k> or B<K> or B<KiB>"
17281 #: ../fish/guestfish.pod:479
17282 msgid "The size in kilobytes (multiplied by 1024)."
17286 #: ../fish/guestfish.pod:481
17291 #: ../fish/guestfish.pod:483
17292 msgid "The size in SI 1000 byte units."
17296 #: ../fish/guestfish.pod:485
17297 msgid "B<M> or B<MiB>"
17301 #: ../fish/guestfish.pod:487
17302 msgid "The size in megabytes (multiplied by 1048576)."
17306 #: ../fish/guestfish.pod:489
17311 #: ../fish/guestfish.pod:491
17312 msgid "The size in SI 1000000 byte units."
17316 #: ../fish/guestfish.pod:493
17317 msgid "B<G> or B<GiB>"
17321 #: ../fish/guestfish.pod:495
17322 msgid "The size in gigabytes (multiplied by 2**30)."
17326 #: ../fish/guestfish.pod:497
17331 #: ../fish/guestfish.pod:499
17332 msgid "The size in SI 10**9 byte units."
17336 #: ../fish/guestfish.pod:501
17337 msgid "B<T> or B<TiB>"
17341 #: ../fish/guestfish.pod:503
17342 msgid "The size in terabytes (multiplied by 2**40)."
17346 #: ../fish/guestfish.pod:505
17351 #: ../fish/guestfish.pod:507
17352 msgid "The size in SI 10**12 byte units."
17356 #: ../fish/guestfish.pod:509
17357 msgid "B<P> or B<PiB>"
17361 #: ../fish/guestfish.pod:511
17362 msgid "The size in petabytes (multiplied by 2**50)."
17366 #: ../fish/guestfish.pod:513
17371 #: ../fish/guestfish.pod:515
17372 msgid "The size in SI 10**15 byte units."
17376 #: ../fish/guestfish.pod:517
17377 msgid "B<E> or B<EiB>"
17381 #: ../fish/guestfish.pod:519
17382 msgid "The size in exabytes (multiplied by 2**60)."
17386 #: ../fish/guestfish.pod:521
17391 #: ../fish/guestfish.pod:523
17392 msgid "The size in SI 10**18 byte units."
17396 #: ../fish/guestfish.pod:525
17397 msgid "B<Z> or B<ZiB>"
17401 #: ../fish/guestfish.pod:527
17402 msgid "The size in zettabytes (multiplied by 2**70)."
17406 #: ../fish/guestfish.pod:529
17411 #: ../fish/guestfish.pod:531
17412 msgid "The size in SI 10**21 byte units."
17416 #: ../fish/guestfish.pod:533
17417 msgid "B<Y> or B<YiB>"
17421 #: ../fish/guestfish.pod:535
17422 msgid "The size in yottabytes (multiplied by 2**80)."
17426 #: ../fish/guestfish.pod:537
17431 #: ../fish/guestfish.pod:539
17432 msgid "The size in SI 10**24 byte units."
17436 #: ../fish/guestfish.pod:545
17439 " truncate-size /file 1G\n"
17444 #: ../fish/guestfish.pod:547
17445 msgid "would truncate the file to 1 gigabyte."
17449 #: ../fish/guestfish.pod:549
17451 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
17452 "the parameter to L</memsize> is specified in megabytes already). Adding a "
17453 "suffix will probably not do what you expect."
17457 #: ../fish/guestfish.pod:553
17458 msgid "OCTAL AND HEXADECIMAL NUMBERS"
17462 #: ../fish/guestfish.pod:555
17464 "For specifying the radix (base) use the C convention: C<0> to prefix an "
17465 "octal number or C<0x> to prefix a hexadecimal number. For example:"
17469 #: ../fish/guestfish.pod:558
17472 " 1234 decimal number 1234\n"
17473 " 02322 octal number, equivalent to decimal 1234\n"
17474 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
17479 #: ../fish/guestfish.pod:562
17481 "When using the C<chmod> command, you almost always want to specify an octal "
17482 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
17483 "L<chmod(1)> program):"
17487 #: ../fish/guestfish.pod:566
17490 " chmod 0777 /public # OK\n"
17491 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
17496 #: ../fish/guestfish.pod:569
17498 "Commands that return numbers usually print them in decimal, but some "
17499 "commands print numbers in other radices (eg. C<umask> prints the mode in "
17500 "octal, preceeded by C<0>)."
17504 #: ../fish/guestfish.pod:573
17505 msgid "WILDCARDS AND GLOBBING"
17509 #: ../fish/guestfish.pod:575
17511 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
17512 "(globbing) by default. So for example the following will not do what you "
17517 #: ../fish/guestfish.pod:579
17525 #: ../fish/guestfish.pod:581
17527 "Assuming you don't have a directory called literally C</home/*> then the "
17528 "above command will return an error."
17532 #: ../fish/guestfish.pod:584
17533 msgid "To perform wildcard expansion, use the C<glob> command."
17537 #: ../fish/guestfish.pod:586
17540 " glob rm-rf /home/*\n"
17545 #: ../fish/guestfish.pod:588
17547 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
17548 "many times), equivalent to:"
17552 #: ../fish/guestfish.pod:591
17555 " rm-rf /home/jim\n"
17556 " rm-rf /home/joe\n"
17557 " rm-rf /home/mary\n"
17562 #: ../fish/guestfish.pod:595
17563 msgid "C<glob> only works on simple guest paths and not on device names."
17567 #: ../fish/guestfish.pod:597
17569 "If you have several parameters, each containing a wildcard, then glob will "
17570 "perform a Cartesian product."
17574 #: ../fish/guestfish.pod:600
17579 #: ../fish/guestfish.pod:602
17581 "Any line which starts with a I<#> character is treated as a comment and "
17582 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
17583 "a command. For example:"
17587 #: ../fish/guestfish.pod:606
17590 " # this is a comment\n"
17591 " # this is a comment\n"
17592 " foo # NOT a comment\n"
17597 #: ../fish/guestfish.pod:610
17598 msgid "Blank lines are also ignored."
17602 #: ../fish/guestfish.pod:612
17603 msgid "RUNNING COMMANDS LOCALLY"
17607 #: ../fish/guestfish.pod:614
17609 "Any line which starts with a I<!> character is treated as a command sent to "
17610 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
17614 #: ../fish/guestfish.pod:618
17618 " tgz-out /remote local/remote-data.tar.gz\n"
17623 #: ../fish/guestfish.pod:621
17625 "will create a directory C<local> on the host, and then export the contents "
17626 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17627 "(See C<tgz-out>)."
17631 #: ../fish/guestfish.pod:625
17633 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17634 "effect, due to the way that subprocesses work in Unix."
17638 #: ../fish/guestfish.pod:628
17643 #: ../fish/guestfish.pod:630
17645 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17646 "command (a guestfish command) to the second command (any host command). For "
17651 #: ../fish/guestfish.pod:634
17654 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17659 #: ../fish/guestfish.pod:636
17661 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17662 "program). The above command would list all accounts in the guest filesystem "
17663 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17667 #: ../fish/guestfish.pod:641
17670 " hexdump /bin/ls | head\n"
17671 " list-devices | tail -1\n"
17672 " tgz-out / - | tar ztf -\n"
17677 #: ../fish/guestfish.pod:645
17679 "The space before the pipe symbol is required, any space after the pipe "
17680 "symbol is optional. Everything after the pipe symbol is just passed "
17681 "straight to the host shell, so it can contain redirections, globs and "
17682 "anything else that makes sense on the host side."
17686 #: ../fish/guestfish.pod:650
17688 "To use a literal argument which begins with a pipe symbol, you have to quote "
17693 #: ../fish/guestfish.pod:653
17701 #: ../fish/guestfish.pod:655
17702 msgid "HOME DIRECTORIES"
17706 #: ../fish/guestfish.pod:657
17708 "If a parameter starts with the character C<~> then the tilde may be expanded "
17709 "as a home directory path (either C<~> for the current user's home directory, "
17710 "or C<~user> for another user)."
17714 #: ../fish/guestfish.pod:661
17716 "Note that home directory expansion happens for users known I<on the host>, "
17717 "not in the guest filesystem."
17721 #: ../fish/guestfish.pod:664
17723 "To use a literal argument which begins with a tilde, you have to quote it, "
17728 #: ../fish/guestfish.pod:667
17736 #: ../fish/guestfish.pod:671
17738 "Libguestfs has some support for Linux guests encrypted according to the "
17739 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17740 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
17741 "LUKS is supported."
17745 #: ../fish/guestfish.pod:676
17746 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17750 #: ../fish/guestfish.pod:678
17753 " ><fs> vfs-type /dev/sda2\n"
17759 #: ../fish/guestfish.pod:681
17761 "Then open those devices using L</luks-open>. This creates a device-mapper "
17762 "device called C</dev/mapper/luksdev>."
17766 #: ../fish/guestfish.pod:684
17769 " ><fs> luks-open /dev/sda2 luksdev\n"
17770 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17775 #: ../fish/guestfish.pod:687
17777 "Finally you have to tell LVM to scan for volume groups on the newly created "
17782 #: ../fish/guestfish.pod:690
17786 " vg-activate-all true\n"
17791 #: ../fish/guestfish.pod:693
17792 msgid "The logical volume(s) can now be mounted in the usual way."
17796 #: ../fish/guestfish.pod:695
17798 "Before closing a LUKS device you must unmount any logical volumes on it and "
17799 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17800 "one. Then you can close the mapper device:"
17804 #: ../fish/guestfish.pod:699
17807 " vg-activate false /dev/VG\n"
17808 " luks-close /dev/mapper/luksdev\n"
17813 #: ../fish/guestfish.pod:702
17814 msgid "WINDOWS PATHS"
17818 #: ../fish/guestfish.pod:704
17820 "If a path is prefixed with C<win:> then you can use Windows-style paths "
17821 "(with some limitations). The following commands are equivalent:"
17825 #: ../fish/guestfish.pod:707
17828 " file /WINDOWS/system32/config/system.LOG\n"
17833 #: ../fish/guestfish.pod:709
17836 " file win:/windows/system32/config/system.log\n"
17841 #: ../fish/guestfish.pod:711
17844 " file win:\\windows\\system32\\config\\system.log\n"
17849 #: ../fish/guestfish.pod:713
17852 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
17857 #: ../fish/guestfish.pod:715
17859 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
17860 "handles case insensitivity like Windows would. This only works in argument "
17861 "positions that expect a path."
17865 #: ../fish/guestfish.pod:719
17866 msgid "UPLOADING AND DOWNLOADING FILES"
17870 #: ../fish/guestfish.pod:721
17872 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
17873 "others which upload from or download to a local file, you can use the "
17874 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
17878 #: ../fish/guestfish.pod:725
17886 #: ../fish/guestfish.pod:727
17888 "reads stdin and creates from that a file C</foo> in the disk image, and:"
17892 #: ../fish/guestfish.pod:730
17895 " tar-out /etc - | tar tf -\n"
17900 #: ../fish/guestfish.pod:732
17902 "writes the tarball to stdout and then pipes that into the external \"tar\" "
17903 "command (see L</PIPES>)."
17907 #: ../fish/guestfish.pod:735
17909 "When using C<-> to read from stdin, the input is read up to the end of "
17910 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
17911 "some arbitrary end marker:"
17915 #: ../fish/guestfish.pod:739
17918 " upload -<<END /foo\n"
17927 #: ../fish/guestfish.pod:745
17929 "Any string of characters can be used instead of C<END>. The end marker must "
17930 "appear on a line of its own, without any preceeding or following characters "
17931 "(not even spaces)."
17935 #: ../fish/guestfish.pod:749
17937 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
17938 "upload local files (so-called \"FileIn\" parameters in the generator)."
17942 #: ../fish/guestfish.pod:752
17943 msgid "EXIT ON ERROR BEHAVIOUR"
17947 #: ../fish/guestfish.pod:754
17949 "By default, guestfish will ignore any errors when in interactive mode (ie. "
17950 "taking commands from a human over a tty), and will exit on the first error "
17951 "in non-interactive mode (scripts, commands given on the command line)."
17955 #: ../fish/guestfish.pod:759
17957 "If you prefix a command with a I<-> character, then that command will not "
17958 "cause guestfish to exit, even if that (one) command returns an error."
17962 #: ../fish/guestfish.pod:763
17963 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
17967 #: ../fish/guestfish.pod:765
17969 "Guestfish can be remote-controlled over a socket. This is useful "
17970 "particularly in shell scripts where you want to make several different "
17971 "changes to a filesystem, but you don't want the overhead of starting up a "
17972 "guestfish process each time."
17976 #: ../fish/guestfish.pod:770
17977 msgid "Start a guestfish server process using:"
17981 #: ../fish/guestfish.pod:772
17984 " eval \"`guestfish --listen`\"\n"
17989 #: ../fish/guestfish.pod:774
17990 msgid "and then send it commands by doing:"
17994 #: ../fish/guestfish.pod:776
17997 " guestfish --remote cmd [...]\n"
18002 #: ../fish/guestfish.pod:778
18003 msgid "To cause the server to exit, send it the exit command:"
18007 #: ../fish/guestfish.pod:780
18010 " guestfish --remote exit\n"
18015 #: ../fish/guestfish.pod:782
18017 "Note that the server will normally exit if there is an error in a command. "
18018 "You can change this in the usual way. See section L</EXIT ON ERROR "
18023 #: ../fish/guestfish.pod:786
18024 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18028 #: ../fish/guestfish.pod:788
18030 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18031 "is how the I<--remote> option knows where to send the commands. You can "
18032 "have several guestfish listener processes running using:"
18036 #: ../fish/guestfish.pod:792
18039 " eval \"`guestfish --listen`\"\n"
18040 " pid1=$GUESTFISH_PID\n"
18041 " eval \"`guestfish --listen`\"\n"
18042 " pid2=$GUESTFISH_PID\n"
18044 " guestfish --remote=$pid1 cmd\n"
18045 " guestfish --remote=$pid2 cmd\n"
18050 #: ../fish/guestfish.pod:800
18051 msgid "REMOTE CONTROL AND CSH"
18055 #: ../fish/guestfish.pod:802
18057 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18062 #: ../fish/guestfish.pod:805
18065 " eval \"`guestfish --listen --csh`\"\n"
18070 #: ../fish/guestfish.pod:807
18071 msgid "REMOTE CONTROL DETAILS"
18075 #: ../fish/guestfish.pod:809
18077 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
18078 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
18079 "and C<$PID> is the process ID of the server."
18083 #: ../fish/guestfish.pod:813
18084 msgid "Guestfish client and server versions must match exactly."
18088 #: ../fish/guestfish.pod:815
18089 msgid "PREPARED DISK IMAGES"
18093 #: ../fish/guestfish.pod:817
18095 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18096 "preformatted disk images that guestfish can make for you to save typing. "
18097 "This is particularly useful for testing purposes. This option is used "
18098 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18099 "can be mixed with I<-a>)."
18103 #: ../fish/guestfish.pod:823
18105 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18106 "the second and so on. Existing files in the current directory are "
18111 #: ../fish/guestfish.pod:827
18113 "The type briefly describes how the disk should be sized, partitioned, how "
18114 "filesystem(s) should be created, and how content should be added. "
18115 "Optionally the type can be followed by extra parameters, separated by C<:> "
18116 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
18117 "allocated disk, containing a single partition, with the partition formatted "
18118 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
18123 #: ../fish/guestfish.pod:835
18124 msgid "To list the available types and any extra parameters they take, run:"
18128 #: ../fish/guestfish.pod:839
18130 "Note that the prepared filesystem is not mounted. You would usually have to "
18131 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18135 #: ../fish/guestfish.pod:843
18137 "If any I<-N> or I<--new> options are given, the guest is automatically "
18142 #: ../fish/guestfish.pod:848
18143 msgid "Create a 100MB disk with an ext4-formatted partition:"
18147 #: ../fish/guestfish.pod:850
18150 " guestfish -N fs:ext4\n"
18155 #: ../fish/guestfish.pod:852
18156 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18160 #: ../fish/guestfish.pod:854
18163 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18168 #: ../fish/guestfish.pod:856
18169 msgid "Create a blank 200MB disk:"
18173 #: ../fish/guestfish.pod:858
18176 " guestfish -N disk:200M\n"
18181 #: ../fish/guestfish.pod:860
18182 msgid "PROGRESS BARS"
18186 #: ../fish/guestfish.pod:862
18188 "Some (not all) long-running commands send progress notification messages as "
18189 "they are running. Guestfish turns these messages into progress bars."
18193 #: ../fish/guestfish.pod:866
18195 "When a command that supports progress bars takes longer than two seconds to "
18196 "run, and if progress bars are enabled, then you will see one appearing below "
18201 #: ../fish/guestfish.pod:870
18204 " ><fs> copy-size /large-file /another-file 2048M\n"
18205 " / 10% [#####-----------------------------------------] 00:30\n"
18210 #: ../fish/guestfish.pod:873
18212 "The spinner on the left hand side moves round once for every progress "
18213 "notification received from the backend. This is a (reasonably) golden "
18214 "assurance that the command is \"doing something\" even if the progress bar "
18215 "is not moving, because the command is able to send the progress "
18216 "notifications. When the bar reaches 100% and the command finishes, the "
18217 "spinner disappears."
18221 #: ../fish/guestfish.pod:880
18223 "Progress bars are enabled by default when guestfish is used interactively. "
18224 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18225 "and you can disable them completely using I<--no-progress-bars>."
18229 #: ../fish/guestfish.pod:885
18230 msgid "GUESTFISH COMMANDS"
18234 #: ../fish/guestfish.pod:887
18236 "The commands in this section are guestfish convenience commands, in other "
18237 "words, they are not part of the L<guestfs(3)> API."
18241 #: ../fish/guestfish.pod:890
18246 #: ../fish/guestfish.pod:892
18255 #: ../fish/guestfish.pod:895
18256 msgid "Without any parameter, this provides general help."
18260 #: ../fish/guestfish.pod:897
18261 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18265 #: ../fish/guestfish.pod:899
18266 msgid "quit | exit"
18270 #: ../fish/guestfish.pod:901
18271 msgid "This exits guestfish. You can also use C<^D> key."
18275 #: ../fish/guestfish.pod:903
18276 msgid "@FISH_COMMANDS@"
18280 #: ../fish/guestfish.pod:905
18285 #: ../fish/guestfish.pod:909 ../test-tool/libguestfs-test-tool.pod:83
18290 #: ../fish/guestfish.pod:911
18292 "guestfish returns 0 if the commands completed without error, or 1 if there "
18297 #: ../fish/guestfish.pod:918
18302 #: ../fish/guestfish.pod:920
18304 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
18309 #: ../fish/guestfish.pod:923
18310 msgid "GUESTFISH_PID"
18314 #: ../fish/guestfish.pod:925
18316 "Used with the I<--remote> option to specify the remote guestfish process to "
18317 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
18321 #: ../fish/guestfish.pod:929
18326 #: ../fish/guestfish.pod:931
18328 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
18329 "not specified, the external L<hexedit(1)> program is used."
18333 #: ../fish/guestfish.pod:935
18338 #: ../fish/guestfish.pod:937
18340 "If compiled with GNU readline support, various files in the home directory "
18341 "can be used. See L</FILES>."
18345 #: ../fish/guestfish.pod:946
18347 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
18348 "effect as using the B<-v> option."
18352 #: ../fish/guestfish.pod:958
18354 "Set the path that guestfish uses to search for kernel and initrd.img. See "
18355 "the discussion of paths in L<guestfs(3)>."
18359 #: ../fish/guestfish.pod:969
18360 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
18364 #: ../fish/guestfish.pod:971
18369 #: ../fish/guestfish.pod:973
18371 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
18376 #: ../fish/guestfish.pod:988 ../test-tool/libguestfs-test-tool.pod:88
18381 #: ../fish/guestfish.pod:992
18382 msgid "$HOME/.guestfish"
18386 #: ../fish/guestfish.pod:994
18388 "If compiled with GNU readline support, then the command history is saved in "
18393 #: ../fish/guestfish.pod:997
18394 msgid "$HOME/.inputrc"
18398 #: ../fish/guestfish.pod:999
18399 msgid "/etc/inputrc"
18403 #: ../fish/guestfish.pod:1001
18405 "If compiled with GNU readline support, then these files can be used to "
18406 "configure readline. For further information, please see L<readline(3)/"
18407 "INITIALIZATION FILE>."
18411 #: ../fish/guestfish.pod:1005
18412 msgid "To write rules which only apply to guestfish, use:"
18416 #: ../fish/guestfish.pod:1007
18426 #: ../fish/guestfish.pod:1011
18428 "Variables that you can set in inputrc that change the behaviour of guestfish "
18429 "in useful ways include:"
18433 #: ../fish/guestfish.pod:1016
18434 msgid "completion-ignore-case (default: on)"
18438 #: ../fish/guestfish.pod:1018
18440 "By default, guestfish will ignore case when tab-completing paths on the "
18445 #: ../fish/guestfish.pod:1021
18448 " set completion-ignore-case off\n"
18453 #: ../fish/guestfish.pod:1023
18454 msgid "to make guestfish case sensitive."
18458 #: ../fish/guestfish.pod:1027
18463 #: ../fish/guestfish.pod:1029
18464 msgid "test2.img (etc)"
18468 #: ../fish/guestfish.pod:1031
18470 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
18471 "will be created in the file C<test1.img> in the current directory. The "
18472 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
18473 "the same name will be overwritten."
18477 #: ../fish/guestfish.pod:1040
18479 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
18480 "L<virt-edit(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, "
18481 "L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, "
18482 "L<virt-tar(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
18486 #: ../fish/guestfish.pod:1064 ../test-tool/libguestfs-test-tool.pod:124
18487 #: ../fuse/guestmount.pod:253 ../inspector/virt-inspector.pl:598
18488 #: ../tools/virt-edit.pl:370 ../tools/virt-win-reg.pl:518
18489 #: ../tools/virt-df.pl:657 ../tools/virt-ls.pl:251
18490 #: ../tools/virt-resize.pl:1516 ../tools/virt-list-filesystems.pl:206
18491 #: ../tools/virt-cat.pl:203 ../tools/virt-tar.pl:300
18492 #: ../tools/virt-rescue.pl:285 ../tools/virt-make-fs.pl:567
18493 #: ../tools/virt-list-partitions.pl:273
18495 "This program is free software; you can redistribute it and/or modify it "
18496 "under the terms of the GNU General Public License as published by the Free "
18497 "Software Foundation; either version 2 of the License, or (at your option) "
18498 "any later version."
18502 #: ../fish/guestfish.pod:1069 ../test-tool/libguestfs-test-tool.pod:129
18503 #: ../fuse/guestmount.pod:258 ../inspector/virt-inspector.pl:603
18504 #: ../tools/virt-edit.pl:375 ../tools/virt-win-reg.pl:523
18505 #: ../tools/virt-df.pl:662 ../tools/virt-ls.pl:256
18506 #: ../tools/virt-resize.pl:1521 ../tools/virt-list-filesystems.pl:211
18507 #: ../tools/virt-cat.pl:208 ../tools/virt-tar.pl:305
18508 #: ../tools/virt-rescue.pl:290 ../tools/virt-make-fs.pl:572
18509 #: ../tools/virt-list-partitions.pl:278
18511 "This program is distributed in the hope that it will be useful, but WITHOUT "
18512 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
18513 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
18518 #: ../fish/guestfish.pod:1074 ../test-tool/libguestfs-test-tool.pod:134
18519 #: ../fuse/guestmount.pod:263 ../inspector/virt-inspector.pl:608
18520 #: ../tools/virt-edit.pl:380 ../tools/virt-win-reg.pl:528
18521 #: ../tools/virt-df.pl:667 ../tools/virt-ls.pl:261
18522 #: ../tools/virt-resize.pl:1526 ../tools/virt-list-filesystems.pl:216
18523 #: ../tools/virt-cat.pl:213 ../tools/virt-tar.pl:310
18524 #: ../tools/virt-rescue.pl:295 ../tools/virt-make-fs.pl:577
18525 #: ../tools/virt-list-partitions.pl:283
18527 "You should have received a copy of the GNU General Public License along with "
18528 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
18529 "Ave, Cambridge, MA 02139, USA."
18533 #: ../fish/guestfish-actions.pod:1
18538 #: ../fish/guestfish-actions.pod:3
18541 " add-cdrom filename\n"
18546 #: ../fish/guestfish-actions.pod:15
18548 "This call checks for the existence of C<filename>. This stops you from "
18549 "specifying other types of drive which are supported by qemu such as C<nbd:> "
18550 "and C<http:> URLs. To specify those, use the general L</config> call "
18555 #: ../fish/guestfish-actions.pod:22
18557 "If you just want to add an ISO file (often you use this as an efficient way "
18558 "to transfer large files into the guest), then you should probably use L</add-"
18559 "drive-ro> instead."
18563 #: ../fish/guestfish-actions.pod:35
18568 #: ../fish/guestfish-actions.pod:37
18571 " add-drive filename\n"
18576 #: ../fish/guestfish-actions.pod:39
18578 "This function is the equivalent of calling L</add-drive-opts> with no "
18579 "optional parameters, so the disk is added writable, with the format being "
18580 "detected automatically."
18584 #: ../fish/guestfish-actions.pod:43
18586 "Automatic detection of the format opens you up to a potential security hole "
18587 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
18588 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
18589 "you should think about replacing calls to this function with calls to L</add-"
18590 "drive-opts>, and specifying the format."
18594 #: ../fish/guestfish-actions.pod:50
18595 msgid "add-drive-opts"
18599 #: ../fish/guestfish-actions.pod:52
18604 #: ../fish/guestfish-actions.pod:54
18607 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
18612 #: ../fish/guestfish-actions.pod:81
18614 "This forces the image format. If you omit this (or use L</add-drive> or L</"
18615 "add-drive-ro>) then the format is automatically detected. Possible formats "
18616 "include C<raw> and C<qcow2>."
18620 #: ../fish/guestfish-actions.pod:92
18622 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
18623 "add-drive-with-if> call (q.v.)"
18627 #: ../fish/guestfish-actions.pod:97
18629 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
18633 #: ../fish/guestfish-actions.pod:99
18634 msgid "add-drive-ro"
18638 #: ../fish/guestfish-actions.pod:101
18643 #: ../fish/guestfish-actions.pod:103
18646 " add-drive-ro filename\n"
18651 #: ../fish/guestfish-actions.pod:105
18653 "This function is the equivalent of calling L</add-drive-opts> with the "
18654 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
18655 "is added read-only, with the format being detected automatically."
18659 #: ../fish/guestfish-actions.pod:110
18660 msgid "add-drive-ro-with-if"
18664 #: ../fish/guestfish-actions.pod:112
18667 " add-drive-ro-with-if filename iface\n"
18672 #: ../fish/guestfish-actions.pod:114
18674 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
18675 "interface emulation to use at run time."
18679 #: ../fish/guestfish-actions.pod:124
18680 msgid "add-drive-with-if"
18684 #: ../fish/guestfish-actions.pod:126
18687 " add-drive-with-if filename iface\n"
18692 #: ../fish/guestfish-actions.pod:128
18694 "This is the same as L</add-drive> but it allows you to specify the QEMU "
18695 "interface emulation to use at run time."
18699 #: ../fish/guestfish-actions.pod:138
18704 #: ../fish/guestfish-actions.pod:140
18707 " aug-clear augpath\n"
18712 #: ../fish/guestfish-actions.pod:145
18717 #: ../fish/guestfish-actions.pod:147
18725 #: ../fish/guestfish-actions.pod:149
18727 "Close the current Augeas handle and free up any resources used by it. After "
18728 "calling this, you have to call L</aug-init> again before you can use any "
18729 "other Augeas functions."
18733 #: ../fish/guestfish-actions.pod:154
18734 msgid "aug-defnode"
18738 #: ../fish/guestfish-actions.pod:156
18741 " aug-defnode name expr val\n"
18746 #: ../fish/guestfish-actions.pod:161
18748 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
18749 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
18750 "containing that single node."
18754 #: ../fish/guestfish-actions.pod:169
18759 #: ../fish/guestfish-actions.pod:171
18762 " aug-defvar name expr\n"
18767 #: ../fish/guestfish-actions.pod:180
18772 #: ../fish/guestfish-actions.pod:182
18775 " aug-get augpath\n"
18780 #: ../fish/guestfish-actions.pod:187
18785 #: ../fish/guestfish-actions.pod:189
18788 " aug-init root flags\n"
18793 #: ../fish/guestfish-actions.pod:195
18794 msgid "You must call this before using any other L</aug-*> commands."
18798 #: ../fish/guestfish-actions.pod:230
18799 msgid "Do not load the tree in L</aug-init>."
18803 #: ../fish/guestfish-actions.pod:234
18804 msgid "To close the handle, you can call L</aug-close>."
18808 #: ../fish/guestfish-actions.pod:238
18813 #: ../fish/guestfish-actions.pod:240
18816 " aug-insert augpath label true|false\n"
18821 #: ../fish/guestfish-actions.pod:250
18826 #: ../fish/guestfish-actions.pod:252
18834 #: ../fish/guestfish-actions.pod:259
18839 #: ../fish/guestfish-actions.pod:261
18842 " aug-ls augpath\n"
18847 #: ../fish/guestfish-actions.pod:263
18849 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
18850 "resulting nodes into alphabetical order."
18854 #: ../fish/guestfish-actions.pod:266
18859 #: ../fish/guestfish-actions.pod:268
18862 " aug-match augpath\n"
18867 #: ../fish/guestfish-actions.pod:274
18872 #: ../fish/guestfish-actions.pod:276
18875 " aug-mv src dest\n"
18880 #: ../fish/guestfish-actions.pod:281
18885 #: ../fish/guestfish-actions.pod:283
18888 " aug-rm augpath\n"
18893 #: ../fish/guestfish-actions.pod:289
18898 #: ../fish/guestfish-actions.pod:291
18906 #: ../fish/guestfish-actions.pod:295
18908 "The flags which were passed to L</aug-init> affect exactly how files are "
18913 #: ../fish/guestfish-actions.pod:298
18918 #: ../fish/guestfish-actions.pod:300
18921 " aug-set augpath val\n"
18926 #: ../fish/guestfish-actions.pod:304
18928 "In the Augeas API, it is possible to clear a node by setting the value to "
18929 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
18930 "this call. Instead you must use the L</aug-clear> call."
18934 #: ../fish/guestfish-actions.pod:309
18939 #: ../fish/guestfish-actions.pod:311
18942 " available 'groups ...'\n"
18947 #: ../fish/guestfish-actions.pod:317
18949 "The libguestfs groups, and the functions that those groups correspond to, "
18950 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
18951 "runtime by calling L</available-all-groups>."
18955 #: ../fish/guestfish-actions.pod:341
18956 msgid "You must call L</launch> before calling this function."
18960 #: ../fish/guestfish-actions.pod:363
18962 "This call was added in version C<1.0.80>. In previous versions of "
18963 "libguestfs all you could do would be to speculatively execute a command to "
18964 "find out if the daemon implemented it. See also L</version>."
18968 #: ../fish/guestfish-actions.pod:370
18969 msgid "available-all-groups"
18973 #: ../fish/guestfish-actions.pod:372
18976 " available-all-groups\n"
18981 #: ../fish/guestfish-actions.pod:374
18983 "This command returns a list of all optional groups that this daemon knows "
18984 "about. Note this returns both supported and unsupported groups. To find "
18985 "out which ones the daemon can actually support you have to call L</"
18986 "available> on each member of the returned list."
18990 #: ../fish/guestfish-actions.pod:380
18991 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
18995 #: ../fish/guestfish-actions.pod:382
19000 #: ../fish/guestfish-actions.pod:384
19003 " base64-in (base64file|-) filename\n"
19008 #: ../fish/guestfish-actions.pod:389 ../fish/guestfish-actions.pod:398
19009 #: ../fish/guestfish-actions.pod:622 ../fish/guestfish-actions.pod:769
19010 #: ../fish/guestfish-actions.pod:816 ../fish/guestfish-actions.pod:835
19011 #: ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:3945
19012 #: ../fish/guestfish-actions.pod:3957 ../fish/guestfish-actions.pod:3968
19013 #: ../fish/guestfish-actions.pod:3979 ../fish/guestfish-actions.pod:4031
19014 #: ../fish/guestfish-actions.pod:4040 ../fish/guestfish-actions.pod:4094
19015 #: ../fish/guestfish-actions.pod:4117
19016 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
19020 #: ../fish/guestfish-actions.pod:391
19025 #: ../fish/guestfish-actions.pod:393
19028 " base64-out filename (base64file|-)\n"
19033 #: ../fish/guestfish-actions.pod:400
19034 msgid "blockdev-flushbufs"
19038 #: ../fish/guestfish-actions.pod:402
19041 " blockdev-flushbufs device\n"
19046 #: ../fish/guestfish-actions.pod:409
19047 msgid "blockdev-getbsz"
19051 #: ../fish/guestfish-actions.pod:411
19054 " blockdev-getbsz device\n"
19059 #: ../fish/guestfish-actions.pod:420
19060 msgid "blockdev-getro"
19064 #: ../fish/guestfish-actions.pod:422
19067 " blockdev-getro device\n"
19072 #: ../fish/guestfish-actions.pod:429
19073 msgid "blockdev-getsize64"
19077 #: ../fish/guestfish-actions.pod:431
19080 " blockdev-getsize64 device\n"
19085 #: ../fish/guestfish-actions.pod:435
19086 msgid "See also L</blockdev-getsz>."
19090 #: ../fish/guestfish-actions.pod:439
19091 msgid "blockdev-getss"
19095 #: ../fish/guestfish-actions.pod:441
19098 " blockdev-getss device\n"
19103 #: ../fish/guestfish-actions.pod:446
19105 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
19109 #: ../fish/guestfish-actions.pod:451
19110 msgid "blockdev-getsz"
19114 #: ../fish/guestfish-actions.pod:453
19117 " blockdev-getsz device\n"
19122 #: ../fish/guestfish-actions.pod:458
19124 "See also L</blockdev-getss> for the real sector size of the device, and L</"
19125 "blockdev-getsize64> for the more useful I<size in bytes>."
19129 #: ../fish/guestfish-actions.pod:464
19130 msgid "blockdev-rereadpt"
19134 #: ../fish/guestfish-actions.pod:466
19137 " blockdev-rereadpt device\n"
19142 #: ../fish/guestfish-actions.pod:472
19143 msgid "blockdev-setbsz"
19147 #: ../fish/guestfish-actions.pod:474
19150 " blockdev-setbsz device blocksize\n"
19155 #: ../fish/guestfish-actions.pod:483
19156 msgid "blockdev-setro"
19160 #: ../fish/guestfish-actions.pod:485
19163 " blockdev-setro device\n"
19168 #: ../fish/guestfish-actions.pod:491
19169 msgid "blockdev-setrw"
19173 #: ../fish/guestfish-actions.pod:493
19176 " blockdev-setrw device\n"
19181 #: ../fish/guestfish-actions.pod:499
19182 msgid "case-sensitive-path"
19186 #: ../fish/guestfish-actions.pod:501
19189 " case-sensitive-path path\n"
19194 #: ../fish/guestfish-actions.pod:525
19196 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
19197 "WINDOWS/system32\"> (the exact return value would depend on details of how "
19198 "the directories were originally created under Windows)."
19202 #: ../fish/guestfish-actions.pod:533
19203 msgid "See also L</realpath>."
19207 #: ../fish/guestfish-actions.pod:535
19212 #: ../fish/guestfish-actions.pod:537
19220 #: ../fish/guestfish-actions.pod:541
19222 "Note that this function cannot correctly handle binary files (specifically, "
19223 "files containing C<\\0> character which is treated as end of string). For "
19224 "those you need to use the L</read-file> or L</download> functions which have "
19225 "a more complex interface."
19229 #: ../fish/guestfish-actions.pod:549
19234 #: ../fish/guestfish-actions.pod:551
19237 " checksum csumtype path\n"
19242 #: ../fish/guestfish-actions.pod:594
19243 msgid "To get the checksum for a device, use L</checksum-device>."
19247 #: ../fish/guestfish-actions.pod:596
19248 msgid "To get the checksums for many files, use L</checksums-out>."
19252 #: ../fish/guestfish-actions.pod:598
19253 msgid "checksum-device"
19257 #: ../fish/guestfish-actions.pod:600
19260 " checksum-device csumtype device\n"
19265 #: ../fish/guestfish-actions.pod:602
19267 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
19268 "device named C<device>. For the types of checksums supported see the L</"
19269 "checksum> command."
19273 #: ../fish/guestfish-actions.pod:606
19274 msgid "checksums-out"
19278 #: ../fish/guestfish-actions.pod:608
19281 " checksums-out csumtype directory (sumsfile|-)\n"
19286 #: ../fish/guestfish-actions.pod:624
19291 #: ../fish/guestfish-actions.pod:626
19294 " chmod mode path\n"
19299 #: ../fish/guestfish-actions.pod:637
19304 #: ../fish/guestfish-actions.pod:639
19307 " chown owner group path\n"
19312 #: ../fish/guestfish-actions.pod:647
19317 #: ../fish/guestfish-actions.pod:649
19320 " command 'arguments ...'\n"
19325 #: ../fish/guestfish-actions.pod:656
19327 "The single parameter is an argv-style list of arguments. The first element "
19328 "is the name of the program to run. Subsequent elements are parameters. The "
19329 "list must be non-empty (ie. must contain a program name). Note that the "
19330 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
19334 #: ../fish/guestfish-actions.pod:684
19335 msgid "command-lines"
19339 #: ../fish/guestfish-actions.pod:686
19342 " command-lines 'arguments ...'\n"
19347 #: ../fish/guestfish-actions.pod:688
19349 "This is the same as L</command>, but splits the result into a list of lines."
19353 #: ../fish/guestfish-actions.pod:691
19354 msgid "See also: L</sh-lines>"
19358 #: ../fish/guestfish-actions.pod:696
19363 #: ../fish/guestfish-actions.pod:698
19366 " config qemuparam qemuvalue\n"
19371 #: ../fish/guestfish-actions.pod:709
19376 #: ../fish/guestfish-actions.pod:711
19379 " copy-size src dest size\n"
19384 #: ../fish/guestfish-actions.pod:719
19389 #: ../fish/guestfish-actions.pod:721
19397 #: ../fish/guestfish-actions.pod:726
19402 #: ../fish/guestfish-actions.pod:728
19410 #: ../fish/guestfish-actions.pod:733
19415 #: ../fish/guestfish-actions.pod:735
19423 #: ../fish/guestfish-actions.pod:742
19425 "If the destination is a device, it must be as large or larger than the "
19426 "source file or device, otherwise the copy will fail. This command cannot do "
19427 "partial copies (see L</copy-size>)."
19431 #: ../fish/guestfish-actions.pod:746
19436 #: ../fish/guestfish-actions.pod:748
19439 " debug subcmd 'extraargs ...'\n"
19444 #: ../fish/guestfish-actions.pod:750
19446 "The L</debug> command exposes some internals of C<guestfsd> (the guestfs "
19447 "daemon) that runs inside the qemu subprocess."
19451 #: ../fish/guestfish-actions.pod:758
19452 msgid "debug-upload"
19456 #: ../fish/guestfish-actions.pod:760
19459 " debug-upload (filename|-) tmpname mode\n"
19464 #: ../fish/guestfish-actions.pod:762
19466 "The L</debug-upload> command uploads a file to the libguestfs appliance."
19470 #: ../fish/guestfish-actions.pod:771
19475 #: ../fish/guestfish-actions.pod:773
19483 #: ../fish/guestfish-actions.pod:781
19488 #: ../fish/guestfish-actions.pod:783
19496 #: ../fish/guestfish-actions.pod:792
19501 #: ../fish/guestfish-actions.pod:794
19509 #: ../fish/guestfish-actions.pod:800
19511 "Another way to get the same information is to enable verbose messages with "
19512 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
19513 "before running the program."
19517 #: ../fish/guestfish-actions.pod:805
19522 #: ../fish/guestfish-actions.pod:807
19525 " download remotefilename (filename|-)\n"
19530 #: ../fish/guestfish-actions.pod:814
19531 msgid "See also L</upload>, L</cat>."
19535 #: ../fish/guestfish-actions.pod:818
19536 msgid "download-offset"
19540 #: ../fish/guestfish-actions.pod:820
19543 " download-offset remotefilename (filename|-) offset size\n"
19548 #: ../fish/guestfish-actions.pod:828
19550 "Note that there is no limit on the amount of data that can be downloaded "
19551 "with this call, unlike with L</pread>, and this call always reads the full "
19552 "amount unless an error occurs."
19556 #: ../fish/guestfish-actions.pod:833
19557 msgid "See also L</download>, L</pread>."
19561 #: ../fish/guestfish-actions.pod:837
19562 msgid "drop-caches"
19566 #: ../fish/guestfish-actions.pod:839
19569 " drop-caches whattodrop\n"
19574 #: ../fish/guestfish-actions.pod:851
19579 #: ../fish/guestfish-actions.pod:853
19587 #: ../fish/guestfish-actions.pod:865
19592 #: ../fish/guestfish-actions.pod:867
19595 " e2fsck-f device\n"
19600 #: ../fish/guestfish-actions.pod:873
19602 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
19603 "should use L</fsck>."
19607 #: ../fish/guestfish-actions.pod:876
19608 msgid "echo-daemon"
19612 #: ../fish/guestfish-actions.pod:878
19615 " echo-daemon 'words ...'\n"
19620 #: ../fish/guestfish-actions.pod:885
19621 msgid "See also L</ping-daemon>."
19625 #: ../fish/guestfish-actions.pod:887
19630 #: ../fish/guestfish-actions.pod:889
19633 " egrep regex path\n"
19638 #: ../fish/guestfish-actions.pod:897
19643 #: ../fish/guestfish-actions.pod:899
19646 " egrepi regex path\n"
19651 #: ../fish/guestfish-actions.pod:907
19656 #: ../fish/guestfish-actions.pod:909
19659 " equal file1 file2\n"
19664 #: ../fish/guestfish-actions.pod:916
19669 #: ../fish/guestfish-actions.pod:918
19677 #: ../fish/guestfish-actions.pod:923
19678 msgid "See also L</is-file>, L</is-dir>, L</stat>."
19682 #: ../fish/guestfish-actions.pod:925
19687 #: ../fish/guestfish-actions.pod:927
19690 " fallocate path len\n"
19695 #: ../fish/guestfish-actions.pod:944
19696 msgid "fallocate64"
19700 #: ../fish/guestfish-actions.pod:946
19703 " fallocate64 path len\n"
19708 #: ../fish/guestfish-actions.pod:952
19710 "Note that this call allocates disk blocks for the file. To create a sparse "
19711 "file use L</truncate-size> instead."
19715 #: ../fish/guestfish-actions.pod:955
19717 "The deprecated call L</fallocate> does the same, but owing to an oversight "
19718 "it only allowed 30 bit lengths to be specified, effectively limiting the "
19719 "maximum size of files created through that call to 1GB."
19723 #: ../fish/guestfish-actions.pod:964
19728 #: ../fish/guestfish-actions.pod:966
19731 " fgrep pattern path\n"
19736 #: ../fish/guestfish-actions.pod:974
19741 #: ../fish/guestfish-actions.pod:976
19744 " fgrepi pattern path\n"
19749 #: ../fish/guestfish-actions.pod:984
19754 #: ../fish/guestfish-actions.pod:986
19762 #: ../fish/guestfish-actions.pod:998
19764 "This command can also be used on C</dev/> devices (and partitions, LV "
19765 "names). You can for example use this to determine if a device contains a "
19766 "filesystem, although it's usually better to use L</vfs-type>."
19770 #: ../fish/guestfish-actions.pod:1008
19771 msgid "file-architecture"
19775 #: ../fish/guestfish-actions.pod:1010
19778 " file-architecture filename\n"
19783 #: ../fish/guestfish-actions.pod:1113
19788 #: ../fish/guestfish-actions.pod:1115
19796 #: ../fish/guestfish-actions.pod:1119
19798 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
19799 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
19803 #: ../fish/guestfish-actions.pod:1123
19808 #: ../fish/guestfish-actions.pod:1125
19811 " fill c len path\n"
19816 #: ../fish/guestfish-actions.pod:1131
19818 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
19819 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
19820 "L</fill-pattern>."
19824 #: ../fish/guestfish-actions.pod:1136
19825 msgid "fill-pattern"
19829 #: ../fish/guestfish-actions.pod:1138
19832 " fill-pattern pattern len path\n"
19837 #: ../fish/guestfish-actions.pod:1140
19839 "This function is like L</fill> except that it creates a new file of length "
19840 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
19841 "is truncated if necessary to ensure the length of the file is exactly C<len> "
19846 #: ../fish/guestfish-actions.pod:1145
19851 #: ../fish/guestfish-actions.pod:1147
19854 " find directory\n"
19859 #: ../fish/guestfish-actions.pod:1161
19860 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
19864 #: ../fish/guestfish-actions.pod:1174
19865 msgid "See also L</find0>."
19869 #: ../fish/guestfish-actions.pod:1179
19874 #: ../fish/guestfish-actions.pod:1181
19877 " find0 directory (files|-)\n"
19882 #: ../fish/guestfish-actions.pod:1187
19884 "This command works the same way as L</find> with the following exceptions:"
19888 #: ../fish/guestfish-actions.pod:1214
19889 msgid "findfs-label"
19893 #: ../fish/guestfish-actions.pod:1216
19896 " findfs-label label\n"
19901 #: ../fish/guestfish-actions.pod:1222
19902 msgid "To find the label of a filesystem, use L</vfs-label>."
19906 #: ../fish/guestfish-actions.pod:1224
19907 msgid "findfs-uuid"
19911 #: ../fish/guestfish-actions.pod:1226
19914 " findfs-uuid uuid\n"
19919 #: ../fish/guestfish-actions.pod:1232
19920 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
19924 #: ../fish/guestfish-actions.pod:1234
19929 #: ../fish/guestfish-actions.pod:1236
19932 " fsck fstype device\n"
19937 #: ../fish/guestfish-actions.pod:1266
19942 #: ../fish/guestfish-actions.pod:1268
19950 #: ../fish/guestfish-actions.pod:1275
19951 msgid "get-autosync"
19955 #: ../fish/guestfish-actions.pod:1277
19963 #: ../fish/guestfish-actions.pod:1281
19968 #: ../fish/guestfish-actions.pod:1283
19976 #: ../fish/guestfish-actions.pod:1287
19977 msgid "get-e2label"
19981 #: ../fish/guestfish-actions.pod:1289
19984 " get-e2label device\n"
19989 #: ../fish/guestfish-actions.pod:1301
19994 #: ../fish/guestfish-actions.pod:1303
19997 " get-e2uuid device\n"
20002 #: ../fish/guestfish-actions.pod:1315
20003 msgid "get-memsize"
20007 #: ../fish/guestfish-actions.pod:1317
20015 #: ../fish/guestfish-actions.pod:1322
20017 "If L</set-memsize> was not called on this handle, and if "
20018 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
20019 "value for memsize."
20023 #: ../fish/guestfish-actions.pod:1329
20024 msgid "get-network"
20028 #: ../fish/guestfish-actions.pod:1331
20036 #: ../fish/guestfish-actions.pod:1335
20041 #: ../fish/guestfish-actions.pod:1337
20049 #: ../fish/guestfish-actions.pod:1344
20054 #: ../fish/guestfish-actions.pod:1346
20059 #: ../fish/guestfish-actions.pod:1348
20067 #: ../fish/guestfish-actions.pod:1355
20072 #: ../fish/guestfish-actions.pod:1357
20080 #: ../fish/guestfish-actions.pod:1364
20081 msgid "get-recovery-proc"
20085 #: ../fish/guestfish-actions.pod:1366
20088 " get-recovery-proc\n"
20093 #: ../fish/guestfish-actions.pod:1370
20094 msgid "get-selinux"
20098 #: ../fish/guestfish-actions.pod:1372
20106 #: ../fish/guestfish-actions.pod:1374
20108 "This returns the current setting of the selinux flag which is passed to the "
20109 "appliance at boot time. See L</set-selinux>."
20113 #: ../fish/guestfish-actions.pod:1380
20118 #: ../fish/guestfish-actions.pod:1382
20126 #: ../fish/guestfish-actions.pod:1389
20131 #: ../fish/guestfish-actions.pod:1391
20139 #: ../fish/guestfish-actions.pod:1395
20144 #: ../fish/guestfish-actions.pod:1397
20152 #: ../fish/guestfish-actions.pod:1399
20154 "Return the current umask. By default the umask is C<022> unless it has been "
20155 "set by calling L</umask>."
20159 #: ../fish/guestfish-actions.pod:1402
20160 msgid "get-verbose"
20164 #: ../fish/guestfish-actions.pod:1404
20172 #: ../fish/guestfish-actions.pod:1408
20177 #: ../fish/guestfish-actions.pod:1410
20185 #: ../fish/guestfish-actions.pod:1414
20186 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
20190 #: ../fish/guestfish-actions.pod:1417
20195 #: ../fish/guestfish-actions.pod:1419
20198 " getxattrs path\n"
20203 #: ../fish/guestfish-actions.pod:1427
20204 msgid "See also: L</lgetxattrs>, L<attr(5)>."
20208 #: ../fish/guestfish-actions.pod:1429
20209 msgid "glob-expand"
20213 #: ../fish/guestfish-actions.pod:1431
20216 " glob-expand pattern\n"
20221 #: ../fish/guestfish-actions.pod:1444
20226 #: ../fish/guestfish-actions.pod:1446
20229 " grep regex path\n"
20234 #: ../fish/guestfish-actions.pod:1454
20239 #: ../fish/guestfish-actions.pod:1456
20242 " grepi regex path\n"
20247 #: ../fish/guestfish-actions.pod:1464
20248 msgid "grub-install"
20252 #: ../fish/guestfish-actions.pod:1466
20255 " grub-install root device\n"
20260 #: ../fish/guestfish-actions.pod:1482
20265 #: ../fish/guestfish-actions.pod:1484
20273 #: ../fish/guestfish-actions.pod:1492
20278 #: ../fish/guestfish-actions.pod:1494
20281 " head-n nrlines path\n"
20286 #: ../fish/guestfish-actions.pod:1507
20291 #: ../fish/guestfish-actions.pod:1509
20299 #: ../fish/guestfish-actions.pod:1517
20304 #: ../fish/guestfish-actions.pod:1519
20307 " initrd-cat initrdpath filename\n"
20312 #: ../fish/guestfish-actions.pod:1531
20313 msgid "See also L</initrd-list>."
20317 #: ../fish/guestfish-actions.pod:1536
20318 msgid "initrd-list"
20322 #: ../fish/guestfish-actions.pod:1538
20325 " initrd-list path\n"
20330 #: ../fish/guestfish-actions.pod:1550
20331 msgid "inotify-add-watch"
20335 #: ../fish/guestfish-actions.pod:1552
20338 " inotify-add-watch path mask\n"
20343 #: ../fish/guestfish-actions.pod:1564
20344 msgid "inotify-close"
20348 #: ../fish/guestfish-actions.pod:1566
20356 #: ../fish/guestfish-actions.pod:1572
20357 msgid "inotify-files"
20361 #: ../fish/guestfish-actions.pod:1574
20369 #: ../fish/guestfish-actions.pod:1576
20371 "This function is a helpful wrapper around L</inotify-read> which just "
20372 "returns a list of pathnames of objects that were touched. The returned "
20373 "pathnames are sorted and deduplicated."
20377 #: ../fish/guestfish-actions.pod:1580
20378 msgid "inotify-init"
20382 #: ../fish/guestfish-actions.pod:1582
20385 " inotify-init maxevents\n"
20390 #: ../fish/guestfish-actions.pod:1588
20392 "C<maxevents> is the maximum number of events which will be queued up between "
20393 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
20394 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
20395 "default was 16384 events. Beyond this limit, the kernel throws away events, "
20396 "but records the fact that it threw them away by setting a flag "
20397 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
20401 #: ../fish/guestfish-actions.pod:1598
20403 "Before any events are generated, you have to add some watches to the "
20404 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
20405 "L</inotify-watch-all>."
20409 #: ../fish/guestfish-actions.pod:1604
20411 "Queued up events should be read periodically by calling L</inotify-read> (or "
20412 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
20413 "If you don't read the events out often enough then you risk the internal "
20414 "queue overflowing."
20418 #: ../fish/guestfish-actions.pod:1611
20420 "The handle should be closed after use by calling L</inotify-close>. This "
20421 "also removes any watches automatically."
20425 #: ../fish/guestfish-actions.pod:1620
20426 msgid "inotify-read"
20430 #: ../fish/guestfish-actions.pod:1622
20438 #: ../fish/guestfish-actions.pod:1635
20439 msgid "inotify-rm-watch"
20443 #: ../fish/guestfish-actions.pod:1637
20446 " inotify-rm-watch wd\n"
20451 #: ../fish/guestfish-actions.pod:1639
20452 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
20456 #: ../fish/guestfish-actions.pod:1642
20457 msgid "inspect-get-arch"
20461 #: ../fish/guestfish-actions.pod:1644
20464 " inspect-get-arch root\n"
20469 #: ../fish/guestfish-actions.pod:1646 ../fish/guestfish-actions.pod:1662
20470 #: ../fish/guestfish-actions.pod:1728 ../fish/guestfish-actions.pod:1746
20471 #: ../fish/guestfish-actions.pod:1767 ../fish/guestfish-actions.pod:1782
20472 #: ../fish/guestfish-actions.pod:1805 ../fish/guestfish-actions.pod:1835
20473 #: ../fish/guestfish-actions.pod:1866
20475 "This function should only be called with a root device string as returned by "
20480 #: ../fish/guestfish-actions.pod:1649
20482 "This returns the architecture of the inspected operating system. The "
20483 "possible return values are listed under L</file-architecture>."
20487 #: ../fish/guestfish-actions.pod:1658
20488 msgid "inspect-get-distro"
20492 #: ../fish/guestfish-actions.pod:1660
20495 " inspect-get-distro root\n"
20500 #: ../fish/guestfish-actions.pod:1724
20501 msgid "inspect-get-filesystems"
20505 #: ../fish/guestfish-actions.pod:1726
20508 " inspect-get-filesystems root\n"
20513 #: ../fish/guestfish-actions.pod:1739
20515 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
20516 "get-mountpoints>."
20520 #: ../fish/guestfish-actions.pod:1742
20521 msgid "inspect-get-major-version"
20525 #: ../fish/guestfish-actions.pod:1744
20528 " inspect-get-major-version root\n"
20533 #: ../fish/guestfish-actions.pod:1763
20534 msgid "inspect-get-minor-version"
20538 #: ../fish/guestfish-actions.pod:1765
20541 " inspect-get-minor-version root\n"
20546 #: ../fish/guestfish-actions.pod:1775
20548 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
20549 "get-major-version>."
20553 #: ../fish/guestfish-actions.pod:1778
20554 msgid "inspect-get-mountpoints"
20558 #: ../fish/guestfish-actions.pod:1780
20561 " inspect-get-mountpoints root\n"
20566 #: ../fish/guestfish-actions.pod:1798
20568 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
20569 "get-filesystems>."
20573 #: ../fish/guestfish-actions.pod:1801
20574 msgid "inspect-get-product-name"
20578 #: ../fish/guestfish-actions.pod:1803
20581 " inspect-get-product-name root\n"
20586 #: ../fish/guestfish-actions.pod:1818
20587 msgid "inspect-get-roots"
20591 #: ../fish/guestfish-actions.pod:1820
20594 " inspect-get-roots\n"
20599 #: ../fish/guestfish-actions.pod:1822
20601 "This function is a convenient way to get the list of root devices, as "
20602 "returned from a previous call to L</inspect-os>, but without redoing the "
20603 "whole inspection process."
20607 #: ../fish/guestfish-actions.pod:1826
20609 "This returns an empty list if either no root devices were found or the "
20610 "caller has not called L</inspect-os>."
20614 #: ../fish/guestfish-actions.pod:1831
20615 msgid "inspect-get-type"
20619 #: ../fish/guestfish-actions.pod:1833
20622 " inspect-get-type root\n"
20627 #: ../fish/guestfish-actions.pod:1862
20628 msgid "inspect-get-windows-systemroot"
20632 #: ../fish/guestfish-actions.pod:1864
20635 " inspect-get-windows-systemroot root\n"
20640 #: ../fish/guestfish-actions.pod:1878
20645 #: ../fish/guestfish-actions.pod:1880
20653 #: ../fish/guestfish-actions.pod:1895
20655 "You can pass the root string(s) returned to other L</inspect-get-*> "
20656 "functions in order to query further information about each operating system, "
20657 "such as the name and version."
20661 #: ../fish/guestfish-actions.pod:1900
20663 "This function uses other libguestfs features such as L</mount-ro> and L</"
20664 "umount-all> in order to mount and unmount filesystems and look at the "
20665 "contents. This should be called with no disks currently mounted. The "
20666 "function may also use Augeas, so any existing Augeas handle will be closed."
20670 #: ../fish/guestfish-actions.pod:1912 ../fish/guestfish-actions.pod:2068
20671 #: ../fish/guestfish-actions.pod:2114
20672 msgid "See also L</list-filesystems>."
20676 #: ../fish/guestfish-actions.pod:1914
20677 msgid "is-blockdev"
20681 #: ../fish/guestfish-actions.pod:1916
20684 " is-blockdev path\n"
20689 #: ../fish/guestfish-actions.pod:1921 ../fish/guestfish-actions.pod:1939
20690 #: ../fish/guestfish-actions.pod:1958 ../fish/guestfish-actions.pod:1967
20691 #: ../fish/guestfish-actions.pod:1977 ../fish/guestfish-actions.pod:2011
20692 #: ../fish/guestfish-actions.pod:2020
20693 msgid "See also L</stat>."
20697 #: ../fish/guestfish-actions.pod:1923
20702 #: ../fish/guestfish-actions.pod:1925
20710 #: ../fish/guestfish-actions.pod:1932
20715 #: ../fish/guestfish-actions.pod:1934
20718 " is-chardev path\n"
20723 #: ../fish/guestfish-actions.pod:1941
20728 #: ../fish/guestfish-actions.pod:1943
20736 #: ../fish/guestfish-actions.pod:1950
20741 #: ../fish/guestfish-actions.pod:1952
20749 #: ../fish/guestfish-actions.pod:1960
20754 #: ../fish/guestfish-actions.pod:1962
20762 #: ../fish/guestfish-actions.pod:1969
20767 #: ../fish/guestfish-actions.pod:1971
20775 #: ../fish/guestfish-actions.pod:1979
20776 msgid "is-launching"
20780 #: ../fish/guestfish-actions.pod:1981
20788 #: ../fish/guestfish-actions.pod:1988
20793 #: ../fish/guestfish-actions.pod:1990
20801 #: ../fish/guestfish-actions.pod:1995
20806 #: ../fish/guestfish-actions.pod:1997
20814 #: ../fish/guestfish-actions.pod:2004
20819 #: ../fish/guestfish-actions.pod:2006
20822 " is-socket path\n"
20827 #: ../fish/guestfish-actions.pod:2013
20832 #: ../fish/guestfish-actions.pod:2015
20835 " is-symlink path\n"
20840 #: ../fish/guestfish-actions.pod:2022
20841 msgid "kill-subprocess"
20845 #: ../fish/guestfish-actions.pod:2024
20848 " kill-subprocess\n"
20853 #: ../fish/guestfish-actions.pod:2028
20858 #: ../fish/guestfish-actions.pod:2030
20863 #: ../fish/guestfish-actions.pod:2032
20871 #: ../fish/guestfish-actions.pod:2040
20876 #: ../fish/guestfish-actions.pod:2042
20879 " lchown owner group path\n"
20884 #: ../fish/guestfish-actions.pod:2044
20886 "Change the file owner to C<owner> and group to C<group>. This is like L</"
20887 "chown> but if C<path> is a symlink then the link itself is changed, not the "
20892 #: ../fish/guestfish-actions.pod:2052
20897 #: ../fish/guestfish-actions.pod:2054
20900 " lgetxattrs path\n"
20905 #: ../fish/guestfish-actions.pod:2056
20907 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
20908 "it returns the extended attributes of the link itself."
20912 #: ../fish/guestfish-actions.pod:2060
20913 msgid "list-devices"
20917 #: ../fish/guestfish-actions.pod:2062
20925 #: ../fish/guestfish-actions.pod:2070
20926 msgid "list-filesystems"
20930 #: ../fish/guestfish-actions.pod:2072
20933 " list-filesystems\n"
20938 #: ../fish/guestfish-actions.pod:2091
20940 "This command runs other libguestfs commands, which might include L</mount> "
20941 "and L</umount>, and therefore you should use this soon after launch and only "
20942 "when nothing is mounted."
20946 #: ../fish/guestfish-actions.pod:2095
20948 "Not all of the filesystems returned will be mountable. In particular, swap "
20949 "partitions are returned in the list. Also this command does not check that "
20950 "each filesystem found is valid and mountable, and some filesystems might be "
20951 "mountable but require special options. Filesystems may not all belong to a "
20952 "single logical operating system (use L</inspect-os> to look for OSes)."
20956 #: ../fish/guestfish-actions.pod:2103
20957 msgid "list-partitions"
20961 #: ../fish/guestfish-actions.pod:2105
20964 " list-partitions\n"
20969 #: ../fish/guestfish-actions.pod:2111
20971 "This does not return logical volumes. For that you will need to call L</"
20976 #: ../fish/guestfish-actions.pod:2116
20981 #: ../fish/guestfish-actions.pod:2118
20989 #: ../fish/guestfish-actions.pod:2126
20994 #: ../fish/guestfish-actions.pod:2128
20997 " ln target linkname\n"
21002 #: ../fish/guestfish-actions.pod:2132
21007 #: ../fish/guestfish-actions.pod:2134
21010 " ln-f target linkname\n"
21015 #: ../fish/guestfish-actions.pod:2139
21020 #: ../fish/guestfish-actions.pod:2141
21023 " ln-s target linkname\n"
21028 #: ../fish/guestfish-actions.pod:2145
21033 #: ../fish/guestfish-actions.pod:2147
21036 " ln-sf target linkname\n"
21041 #: ../fish/guestfish-actions.pod:2152
21042 msgid "lremovexattr"
21046 #: ../fish/guestfish-actions.pod:2154
21049 " lremovexattr xattr path\n"
21054 #: ../fish/guestfish-actions.pod:2156
21056 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
21057 "it removes an extended attribute of the link itself."
21061 #: ../fish/guestfish-actions.pod:2160
21066 #: ../fish/guestfish-actions.pod:2162
21074 #: ../fish/guestfish-actions.pod:2168
21076 "This command is mostly useful for interactive sessions. Programs should "
21077 "probably use L</readdir> instead."
21081 #: ../fish/guestfish-actions.pod:2171
21086 #: ../fish/guestfish-actions.pod:2173
21089 " lsetxattr xattr val vallen path\n"
21094 #: ../fish/guestfish-actions.pod:2175
21096 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
21097 "sets an extended attribute of the link itself."
21101 #: ../fish/guestfish-actions.pod:2179
21106 #: ../fish/guestfish-actions.pod:2181
21114 #: ../fish/guestfish-actions.pod:2185
21116 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
21117 "the link is stat-ed, not the file it refers to."
21121 #: ../fish/guestfish-actions.pod:2191
21126 #: ../fish/guestfish-actions.pod:2193
21129 " lstatlist path 'names ...'\n"
21134 #: ../fish/guestfish-actions.pod:2195
21136 "This call allows you to perform the L</lstat> operation on multiple files, "
21137 "where all files are in the directory C<path>. C<names> is the list of files "
21138 "from this directory."
21142 #: ../fish/guestfish-actions.pod:2204
21144 "This call is intended for programs that want to efficiently list a directory "
21145 "contents without making many round-trips. See also L</lxattrlist> for a "
21146 "similarly efficient call for getting extended attributes. Very long "
21147 "directory listings might cause the protocol message size to be exceeded, "
21148 "causing this call to fail. The caller must split up such requests into "
21149 "smaller groups of names."
21153 #: ../fish/guestfish-actions.pod:2212
21154 msgid "luks-add-key"
21158 #: ../fish/guestfish-actions.pod:2214
21161 " luks-add-key device keyslot\n"
21166 #: ../fish/guestfish-actions.pod:2221
21168 "Note that if C<keyslot> already contains a key, then this command will "
21169 "fail. You have to use L</luks-kill-slot> first to remove that key."
21173 #: ../fish/guestfish-actions.pod:2225 ../fish/guestfish-actions.pod:2247
21174 #: ../fish/guestfish-actions.pod:2260 ../fish/guestfish-actions.pod:2274
21175 #: ../fish/guestfish-actions.pod:2297 ../fish/guestfish-actions.pod:2307
21177 "This command has one or more key or passphrase parameters. Guestfish will "
21178 "prompt for these separately."
21182 #: ../fish/guestfish-actions.pod:2228
21187 #: ../fish/guestfish-actions.pod:2230
21190 " luks-close device\n"
21195 #: ../fish/guestfish-actions.pod:2232
21197 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
21198 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
21199 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
21204 #: ../fish/guestfish-actions.pod:2238
21205 msgid "luks-format"
21209 #: ../fish/guestfish-actions.pod:2240
21212 " luks-format device keyslot\n"
21217 #: ../fish/guestfish-actions.pod:2253
21218 msgid "luks-format-cipher"
21222 #: ../fish/guestfish-actions.pod:2255
21225 " luks-format-cipher device keyslot cipher\n"
21230 #: ../fish/guestfish-actions.pod:2257
21232 "This command is the same as L</luks-format> but it also allows you to set "
21233 "the C<cipher> used."
21237 #: ../fish/guestfish-actions.pod:2266
21238 msgid "luks-kill-slot"
21242 #: ../fish/guestfish-actions.pod:2268
21245 " luks-kill-slot device keyslot\n"
21250 #: ../fish/guestfish-actions.pod:2277
21255 #: ../fish/guestfish-actions.pod:2279
21258 " luks-open device mapname\n"
21263 #: ../fish/guestfish-actions.pod:2293
21265 "If this block device contains LVM volume groups, then calling L</vgscan> "
21266 "followed by L</vg-activate-all> will make them visible."
21270 #: ../fish/guestfish-actions.pod:2300
21271 msgid "luks-open-ro"
21275 #: ../fish/guestfish-actions.pod:2302
21278 " luks-open-ro device mapname\n"
21283 #: ../fish/guestfish-actions.pod:2304
21285 "This is the same as L</luks-open> except that a read-only mapping is created."
21289 #: ../fish/guestfish-actions.pod:2310
21294 #: ../fish/guestfish-actions.pod:2312
21297 " lvcreate logvol volgroup mbytes\n"
21302 #: ../fish/guestfish-actions.pod:2317
21303 msgid "lvm-canonical-lv-name"
21307 #: ../fish/guestfish-actions.pod:2319
21310 " lvm-canonical-lv-name lvname\n"
21315 #: ../fish/guestfish-actions.pod:2328
21316 msgid "See also L</is-lv>."
21320 #: ../fish/guestfish-actions.pod:2330
21321 msgid "lvm-clear-filter"
21325 #: ../fish/guestfish-actions.pod:2332
21328 " lvm-clear-filter\n"
21333 #: ../fish/guestfish-actions.pod:2334
21335 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
21340 #: ../fish/guestfish-actions.pod:2340
21341 msgid "lvm-remove-all"
21345 #: ../fish/guestfish-actions.pod:2342
21348 " lvm-remove-all\n"
21353 #: ../fish/guestfish-actions.pod:2350
21354 msgid "lvm-set-filter"
21358 #: ../fish/guestfish-actions.pod:2352
21361 " lvm-set-filter 'devices ...'\n"
21366 #: ../fish/guestfish-actions.pod:2377
21371 #: ../fish/guestfish-actions.pod:2379
21374 " lvremove device\n"
21379 #: ../fish/guestfish-actions.pod:2387
21384 #: ../fish/guestfish-actions.pod:2389
21387 " lvrename logvol newlogvol\n"
21392 #: ../fish/guestfish-actions.pod:2393
21397 #: ../fish/guestfish-actions.pod:2395
21400 " lvresize device mbytes\n"
21405 #: ../fish/guestfish-actions.pod:2401
21406 msgid "lvresize-free"
21410 #: ../fish/guestfish-actions.pod:2403
21413 " lvresize-free lv percent\n"
21418 #: ../fish/guestfish-actions.pod:2411
21423 #: ../fish/guestfish-actions.pod:2413
21431 #: ../fish/guestfish-actions.pod:2421
21432 msgid "See also L</lvs-full>, L</list-filesystems>."
21436 #: ../fish/guestfish-actions.pod:2423
21441 #: ../fish/guestfish-actions.pod:2425
21449 #: ../fish/guestfish-actions.pod:2430
21454 #: ../fish/guestfish-actions.pod:2432
21462 #: ../fish/guestfish-actions.pod:2436
21467 #: ../fish/guestfish-actions.pod:2438
21470 " lxattrlist path 'names ...'\n"
21475 #: ../fish/guestfish-actions.pod:2454
21477 "This call is intended for programs that want to efficiently list a directory "
21478 "contents without making many round-trips. See also L</lstatlist> for a "
21479 "similarly efficient call for getting standard stats. Very long directory "
21480 "listings might cause the protocol message size to be exceeded, causing this "
21481 "call to fail. The caller must split up such requests into smaller groups of "
21486 #: ../fish/guestfish-actions.pod:2462
21491 #: ../fish/guestfish-actions.pod:2464
21499 #: ../fish/guestfish-actions.pod:2468
21504 #: ../fish/guestfish-actions.pod:2470
21507 " mkdir-mode path mode\n"
21512 #: ../fish/guestfish-actions.pod:2479
21513 msgid "See also L</mkdir>, L</umask>"
21517 #: ../fish/guestfish-actions.pod:2481
21522 #: ../fish/guestfish-actions.pod:2483
21530 #: ../fish/guestfish-actions.pod:2488
21535 #: ../fish/guestfish-actions.pod:2490
21538 " mkdtemp template\n"
21543 #: ../fish/guestfish-actions.pod:2511
21548 #: ../fish/guestfish-actions.pod:2513
21551 " mke2fs-J fstype blocksize device journal\n"
21556 #: ../fish/guestfish-actions.pod:2521
21557 msgid "See also L</mke2journal>."
21561 #: ../fish/guestfish-actions.pod:2523
21566 #: ../fish/guestfish-actions.pod:2525
21569 " mke2fs-JL fstype blocksize device label\n"
21574 #: ../fish/guestfish-actions.pod:2530
21575 msgid "See also L</mke2journal-L>."
21579 #: ../fish/guestfish-actions.pod:2532
21584 #: ../fish/guestfish-actions.pod:2534
21587 " mke2fs-JU fstype blocksize device uuid\n"
21592 #: ../fish/guestfish-actions.pod:2539
21593 msgid "See also L</mke2journal-U>."
21597 #: ../fish/guestfish-actions.pod:2541
21598 msgid "mke2journal"
21602 #: ../fish/guestfish-actions.pod:2543
21605 " mke2journal blocksize device\n"
21610 #: ../fish/guestfish-actions.pod:2550
21611 msgid "mke2journal-L"
21615 #: ../fish/guestfish-actions.pod:2552
21618 " mke2journal-L blocksize label device\n"
21623 #: ../fish/guestfish-actions.pod:2556
21624 msgid "mke2journal-U"
21628 #: ../fish/guestfish-actions.pod:2558
21631 " mke2journal-U blocksize uuid device\n"
21636 #: ../fish/guestfish-actions.pod:2562
21641 #: ../fish/guestfish-actions.pod:2564
21644 " mkfifo mode path\n"
21649 #: ../fish/guestfish-actions.pod:2566
21651 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
21652 "is just a convenient wrapper around L</mknod>."
21656 #: ../fish/guestfish-actions.pod:2572
21661 #: ../fish/guestfish-actions.pod:2574
21664 " mkfs fstype device\n"
21669 #: ../fish/guestfish-actions.pod:2580
21674 #: ../fish/guestfish-actions.pod:2582
21677 " mkfs-b fstype blocksize device\n"
21682 #: ../fish/guestfish-actions.pod:2584
21684 "This call is similar to L</mkfs>, but it allows you to control the block "
21685 "size of the resulting filesystem. Supported block sizes depend on the "
21686 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
21690 #: ../fish/guestfish-actions.pod:2592
21691 msgid "mkmountpoint"
21695 #: ../fish/guestfish-actions.pod:2594
21698 " mkmountpoint exemptpath\n"
21703 #: ../fish/guestfish-actions.pod:2596
21705 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
21706 "to create extra mountpoints before mounting the first filesystem."
21710 #: ../fish/guestfish-actions.pod:2620
21712 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
21713 "unexpected errors if you try to mix these calls. It is safest to manually "
21714 "unmount filesystems and remove mountpoints after use."
21718 #: ../fish/guestfish-actions.pod:2624
21720 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
21721 "for this to work for manual mountpoints, you must ensure that the innermost "
21722 "mountpoints have the longest pathnames, as in the example code above."
21726 #: ../fish/guestfish-actions.pod:2631
21728 "Autosync [see L</set-autosync>, this is set by default on handles] means "
21729 "that L</umount-all> is called when the handle is closed which can also "
21730 "trigger these issues."
21734 #: ../fish/guestfish-actions.pod:2635
21739 #: ../fish/guestfish-actions.pod:2637
21742 " mknod mode devmajor devminor path\n"
21747 #: ../fish/guestfish-actions.pod:2647
21749 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
21750 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
21751 "regular file). These constants are available in the standard Linux header "
21752 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
21753 "wrappers around this command which bitwise OR in the appropriate constant "
21758 #: ../fish/guestfish-actions.pod:2657
21763 #: ../fish/guestfish-actions.pod:2659
21766 " mknod-b mode devmajor devminor path\n"
21771 #: ../fish/guestfish-actions.pod:2661
21773 "This call creates a block device node called C<path> with mode C<mode> and "
21774 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
21775 "wrapper around L</mknod>."
21779 #: ../fish/guestfish-actions.pod:2667
21784 #: ../fish/guestfish-actions.pod:2669
21787 " mknod-c mode devmajor devminor path\n"
21792 #: ../fish/guestfish-actions.pod:2671
21794 "This call creates a char device node called C<path> with mode C<mode> and "
21795 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
21796 "wrapper around L</mknod>."
21800 #: ../fish/guestfish-actions.pod:2677
21805 #: ../fish/guestfish-actions.pod:2679
21813 #: ../fish/guestfish-actions.pod:2683
21818 #: ../fish/guestfish-actions.pod:2685
21821 " mkswap-L label device\n"
21826 #: ../fish/guestfish-actions.pod:2693
21831 #: ../fish/guestfish-actions.pod:2695
21834 " mkswap-U uuid device\n"
21839 #: ../fish/guestfish-actions.pod:2699
21840 msgid "mkswap-file"
21844 #: ../fish/guestfish-actions.pod:2701
21847 " mkswap-file path\n"
21852 #: ../fish/guestfish-actions.pod:2705
21854 "This command just writes a swap file signature to an existing file. To "
21855 "create the file itself, use something like L</fallocate>."
21859 #: ../fish/guestfish-actions.pod:2708
21864 #: ../fish/guestfish-actions.pod:2710
21867 " modprobe modulename\n"
21872 #: ../fish/guestfish-actions.pod:2717
21877 #: ../fish/guestfish-actions.pod:2719
21880 " mount device mountpoint\n"
21885 #: ../fish/guestfish-actions.pod:2735
21887 "B<Important note:> When you use this call, the filesystem options C<sync> "
21888 "and C<noatime> are set implicitly. This was originally done because we "
21889 "thought it would improve reliability, but it turns out that I<-o sync> has a "
21890 "very large negative performance impact and negligible effect on "
21891 "reliability. Therefore we recommend that you avoid using L</mount> in any "
21892 "code that needs performance, and instead use L</mount-options> (use an empty "
21893 "string for the first parameter if you don't want any options)."
21897 #: ../fish/guestfish-actions.pod:2745
21902 #: ../fish/guestfish-actions.pod:2747
21905 " mount-loop file mountpoint\n"
21910 #: ../fish/guestfish-actions.pod:2753
21911 msgid "mount-options"
21915 #: ../fish/guestfish-actions.pod:2755
21918 " mount-options options device mountpoint\n"
21923 #: ../fish/guestfish-actions.pod:2757
21925 "This is the same as the L</mount> command, but it allows you to set the "
21926 "mount options as for the L<mount(8)> I<-o> flag."
21930 #: ../fish/guestfish-actions.pod:2765
21935 #: ../fish/guestfish-actions.pod:2767
21938 " mount-ro device mountpoint\n"
21943 #: ../fish/guestfish-actions.pod:2769
21945 "This is the same as the L</mount> command, but it mounts the filesystem with "
21946 "the read-only (I<-o ro>) flag."
21950 #: ../fish/guestfish-actions.pod:2772
21955 #: ../fish/guestfish-actions.pod:2774
21958 " mount-vfs options vfstype device mountpoint\n"
21963 #: ../fish/guestfish-actions.pod:2776
21965 "This is the same as the L</mount> command, but it allows you to set both the "
21966 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
21970 #: ../fish/guestfish-actions.pod:2780
21971 msgid "mountpoints"
21975 #: ../fish/guestfish-actions.pod:2782
21983 #: ../fish/guestfish-actions.pod:2784
21985 "This call is similar to L</mounts>. That call returns a list of devices. "
21986 "This one returns a hash table (map) of device name to directory where the "
21987 "device is mounted."
21991 #: ../fish/guestfish-actions.pod:2788
21996 #: ../fish/guestfish-actions.pod:2790
22004 #: ../fish/guestfish-actions.pod:2797
22005 msgid "See also: L</mountpoints>"
22009 #: ../fish/guestfish-actions.pod:2799
22014 #: ../fish/guestfish-actions.pod:2801
22022 #: ../fish/guestfish-actions.pod:2806
22023 msgid "ntfs-3g-probe"
22027 #: ../fish/guestfish-actions.pod:2808
22030 " ntfs-3g-probe true|false device\n"
22035 #: ../fish/guestfish-actions.pod:2822
22040 #: ../fish/guestfish-actions.pod:2824
22043 " ntfsresize device\n"
22048 #: ../fish/guestfish-actions.pod:2830
22049 msgid "ntfsresize-size"
22053 #: ../fish/guestfish-actions.pod:2832
22056 " ntfsresize-size device size\n"
22061 #: ../fish/guestfish-actions.pod:2834
22063 "This command is the same as L</ntfsresize> except that it allows you to "
22064 "specify the new size (in bytes) explicitly."
22068 #: ../fish/guestfish-actions.pod:2837
22073 #: ../fish/guestfish-actions.pod:2839
22076 " part-add device prlogex startsect endsect\n"
22081 #: ../fish/guestfish-actions.pod:2841
22083 "This command adds a partition to C<device>. If there is no partition table "
22084 "on the device, call L</part-init> first."
22088 #: ../fish/guestfish-actions.pod:2853
22090 "Creating a partition which covers the whole disk is not so easy. Use L</"
22091 "part-disk> to do that."
22095 #: ../fish/guestfish-actions.pod:2856
22100 #: ../fish/guestfish-actions.pod:2858
22103 " part-del device partnum\n"
22108 #: ../fish/guestfish-actions.pod:2866
22113 #: ../fish/guestfish-actions.pod:2868
22116 " part-disk device parttype\n"
22121 #: ../fish/guestfish-actions.pod:2870
22123 "This command is simply a combination of L</part-init> followed by L</part-"
22124 "add> to create a single primary partition covering the whole disk."
22128 #: ../fish/guestfish-actions.pod:2874
22130 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
22131 "possible values are described in L</part-init>."
22135 #: ../fish/guestfish-actions.pod:2880
22136 msgid "part-get-bootable"
22140 #: ../fish/guestfish-actions.pod:2882
22143 " part-get-bootable device partnum\n"
22148 #: ../fish/guestfish-actions.pod:2887
22149 msgid "See also L</part-set-bootable>."
22153 #: ../fish/guestfish-actions.pod:2889
22154 msgid "part-get-mbr-id"
22158 #: ../fish/guestfish-actions.pod:2891
22161 " part-get-mbr-id device partnum\n"
22166 #: ../fish/guestfish-actions.pod:2896 ../fish/guestfish-actions.pod:3034
22168 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
22169 "undefined results for other partition table types (see L</part-get-"
22174 #: ../fish/guestfish-actions.pod:2900
22175 msgid "part-get-parttype"
22179 #: ../fish/guestfish-actions.pod:2902
22182 " part-get-parttype device\n"
22187 #: ../fish/guestfish-actions.pod:2907
22189 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
22190 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
22191 "possible, although unusual. See L</part-init> for a full list."
22195 #: ../fish/guestfish-actions.pod:2912
22200 #: ../fish/guestfish-actions.pod:2914
22203 " part-init device parttype\n"
22208 #: ../fish/guestfish-actions.pod:2920
22210 "Initially there are no partitions. Following this, you should call L</part-"
22211 "add> for each partition required."
22215 #: ../fish/guestfish-actions.pod:2983
22220 #: ../fish/guestfish-actions.pod:2985
22223 " part-list device\n"
22228 #: ../fish/guestfish-actions.pod:3000
22230 "Start of the partition I<in bytes>. To get sectors you have to divide by "
22231 "the device's sector size, see L</blockdev-getss>."
22235 #: ../fish/guestfish-actions.pod:3013
22236 msgid "part-set-bootable"
22240 #: ../fish/guestfish-actions.pod:3015
22243 " part-set-bootable device partnum true|false\n"
22248 #: ../fish/guestfish-actions.pod:3024
22249 msgid "part-set-mbr-id"
22253 #: ../fish/guestfish-actions.pod:3026
22256 " part-set-mbr-id device partnum idbyte\n"
22261 #: ../fish/guestfish-actions.pod:3038
22262 msgid "part-set-name"
22266 #: ../fish/guestfish-actions.pod:3040
22269 " part-set-name device partnum name\n"
22274 #: ../fish/guestfish-actions.pod:3048
22275 msgid "part-to-dev"
22279 #: ../fish/guestfish-actions.pod:3050
22282 " part-to-dev partition\n"
22287 #: ../fish/guestfish-actions.pod:3056
22289 "The named partition must exist, for example as a string returned from L</"
22290 "list-partitions>."
22294 #: ../fish/guestfish-actions.pod:3059
22295 msgid "ping-daemon"
22299 #: ../fish/guestfish-actions.pod:3061
22307 #: ../fish/guestfish-actions.pod:3068
22312 #: ../fish/guestfish-actions.pod:3070
22315 " pread path count offset\n"
22320 #: ../fish/guestfish-actions.pod:3078
22321 msgid "See also L</pwrite>, L</pread-device>."
22325 #: ../fish/guestfish-actions.pod:3083
22326 msgid "pread-device"
22330 #: ../fish/guestfish-actions.pod:3085
22333 " pread-device device count offset\n"
22338 #: ../fish/guestfish-actions.pod:3093
22339 msgid "See also L</pread>."
22343 #: ../fish/guestfish-actions.pod:3098
22348 #: ../fish/guestfish-actions.pod:3100
22351 " pvcreate device\n"
22356 #: ../fish/guestfish-actions.pod:3106
22361 #: ../fish/guestfish-actions.pod:3108
22364 " pvremove device\n"
22369 #: ../fish/guestfish-actions.pod:3117
22374 #: ../fish/guestfish-actions.pod:3119
22377 " pvresize device\n"
22382 #: ../fish/guestfish-actions.pod:3124
22383 msgid "pvresize-size"
22387 #: ../fish/guestfish-actions.pod:3126
22390 " pvresize-size device size\n"
22395 #: ../fish/guestfish-actions.pod:3128
22397 "This command is the same as L</pvresize> except that it allows you to "
22398 "specify the new size (in bytes) explicitly."
22402 #: ../fish/guestfish-actions.pod:3131
22407 #: ../fish/guestfish-actions.pod:3133
22415 #: ../fish/guestfish-actions.pod:3141
22416 msgid "See also L</pvs-full>."
22420 #: ../fish/guestfish-actions.pod:3143
22425 #: ../fish/guestfish-actions.pod:3145
22433 #: ../fish/guestfish-actions.pod:3150
22438 #: ../fish/guestfish-actions.pod:3152
22446 #: ../fish/guestfish-actions.pod:3156
22451 #: ../fish/guestfish-actions.pod:3158
22454 " pwrite path content offset\n"
22459 #: ../fish/guestfish-actions.pod:3169
22460 msgid "See also L</pread>, L</pwrite-device>."
22464 #: ../fish/guestfish-actions.pod:3174
22465 msgid "pwrite-device"
22469 #: ../fish/guestfish-actions.pod:3176
22472 " pwrite-device device content offset\n"
22477 #: ../fish/guestfish-actions.pod:3186
22478 msgid "See also L</pwrite>."
22482 #: ../fish/guestfish-actions.pod:3191
22487 #: ../fish/guestfish-actions.pod:3193
22490 " read-file path\n"
22495 #: ../fish/guestfish-actions.pod:3198
22497 "Unlike L</cat>, this function can correctly handle files that contain "
22498 "embedded ASCII NUL characters. However unlike L</download>, this function "
22499 "is limited in the total size of file that can be handled."
22503 #: ../fish/guestfish-actions.pod:3206
22508 #: ../fish/guestfish-actions.pod:3208
22511 " read-lines path\n"
22516 #: ../fish/guestfish-actions.pod:3215
22518 "Note that this function cannot correctly handle binary files (specifically, "
22519 "files containing C<\\0> character which is treated as end of line). For "
22520 "those you need to use the L</read-file> function which has a more complex "
22525 #: ../fish/guestfish-actions.pod:3220
22530 #: ../fish/guestfish-actions.pod:3222
22538 #: ../fish/guestfish-actions.pod:3274
22540 "This function is primarily intended for use by programs. To get a simple "
22541 "list of names, use L</ls>. To get a printable directory for human "
22542 "consumption, use L</ll>."
22546 #: ../fish/guestfish-actions.pod:3278
22551 #: ../fish/guestfish-actions.pod:3280
22559 #: ../fish/guestfish-actions.pod:3284
22560 msgid "readlinklist"
22564 #: ../fish/guestfish-actions.pod:3286
22567 " readlinklist path 'names ...'\n"
22572 #: ../fish/guestfish-actions.pod:3310
22577 #: ../fish/guestfish-actions.pod:3312
22585 #: ../fish/guestfish-actions.pod:3317
22586 msgid "removexattr"
22590 #: ../fish/guestfish-actions.pod:3319
22593 " removexattr xattr path\n"
22598 #: ../fish/guestfish-actions.pod:3324
22599 msgid "See also: L</lremovexattr>, L<attr(5)>."
22603 #: ../fish/guestfish-actions.pod:3326
22608 #: ../fish/guestfish-actions.pod:3328
22611 " resize2fs device\n"
22616 #: ../fish/guestfish-actions.pod:3333
22618 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
22619 "before calling this command. For unknown reasons C<resize2fs> sometimes "
22620 "gives an error about this and sometimes not. In any case, it is always safe "
22621 "to call L</e2fsck-f> before calling this function."
22625 #: ../fish/guestfish-actions.pod:3339
22626 msgid "resize2fs-size"
22630 #: ../fish/guestfish-actions.pod:3341
22633 " resize2fs-size device size\n"
22638 #: ../fish/guestfish-actions.pod:3343
22640 "This command is the same as L</resize2fs> except that it allows you to "
22641 "specify the new size (in bytes) explicitly."
22645 #: ../fish/guestfish-actions.pod:3346
22650 #: ../fish/guestfish-actions.pod:3348
22658 #: ../fish/guestfish-actions.pod:3352
22663 #: ../fish/guestfish-actions.pod:3354
22671 #: ../fish/guestfish-actions.pod:3360
22676 #: ../fish/guestfish-actions.pod:3362
22684 #: ../fish/guestfish-actions.pod:3366
22685 msgid "rmmountpoint"
22689 #: ../fish/guestfish-actions.pod:3368
22692 " rmmountpoint exemptpath\n"
22697 #: ../fish/guestfish-actions.pod:3370
22699 "This calls removes a mountpoint that was previously created with L</"
22700 "mkmountpoint>. See L</mkmountpoint> for full details."
22704 #: ../fish/guestfish-actions.pod:3374
22705 msgid "scrub-device"
22709 #: ../fish/guestfish-actions.pod:3376
22712 " scrub-device device\n"
22717 #: ../fish/guestfish-actions.pod:3387
22722 #: ../fish/guestfish-actions.pod:3389
22725 " scrub-file file\n"
22730 #: ../fish/guestfish-actions.pod:3399
22731 msgid "scrub-freespace"
22735 #: ../fish/guestfish-actions.pod:3401
22738 " scrub-freespace dir\n"
22743 #: ../fish/guestfish-actions.pod:3403
22745 "This command creates the directory C<dir> and then fills it with files until "
22746 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
22747 "deletes them. The intention is to scrub any free space on the partition "
22748 "containing C<dir>."
22752 #: ../fish/guestfish-actions.pod:3412
22757 #: ../fish/guestfish-actions.pod:3414
22762 #: ../fish/guestfish-actions.pod:3416
22765 " set-append append\n"
22770 #: ../fish/guestfish-actions.pod:3427
22771 msgid "set-autosync"
22775 #: ../fish/guestfish-actions.pod:3429
22780 #: ../fish/guestfish-actions.pod:3431
22783 " set-autosync true|false\n"
22788 #: ../fish/guestfish-actions.pod:3433
22790 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
22791 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
22792 "closed (also if the program exits without closing handles)."
22796 #: ../fish/guestfish-actions.pod:3441
22801 #: ../fish/guestfish-actions.pod:3443
22806 #: ../fish/guestfish-actions.pod:3445
22809 " set-direct true|false\n"
22814 #: ../fish/guestfish-actions.pod:3451
22816 "One consequence of this is that log messages aren't caught by the library "
22817 "and handled by L</set-log-message-callback>, but go straight to stdout."
22821 #: ../fish/guestfish-actions.pod:3460
22822 msgid "set-e2label"
22826 #: ../fish/guestfish-actions.pod:3462
22829 " set-e2label device label\n"
22834 #: ../fish/guestfish-actions.pod:3468
22836 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
22837 "label on a filesystem."
22841 #: ../fish/guestfish-actions.pod:3471
22846 #: ../fish/guestfish-actions.pod:3473
22849 " set-e2uuid device uuid\n"
22854 #: ../fish/guestfish-actions.pod:3480
22856 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
22857 "UUID of a filesystem."
22861 #: ../fish/guestfish-actions.pod:3483
22862 msgid "set-memsize"
22866 #: ../fish/guestfish-actions.pod:3485
22871 #: ../fish/guestfish-actions.pod:3487
22874 " set-memsize memsize\n"
22879 #: ../fish/guestfish-actions.pod:3489
22881 "This sets the memory size in megabytes allocated to the qemu subprocess. "
22882 "This only has any effect if called before L</launch>."
22886 #: ../fish/guestfish-actions.pod:3500
22887 msgid "set-network"
22891 #: ../fish/guestfish-actions.pod:3502
22896 #: ../fish/guestfish-actions.pod:3504
22899 " set-network true|false\n"
22904 #: ../fish/guestfish-actions.pod:3512
22906 "You must call this before calling L</launch>, otherwise it has no effect."
22910 #: ../fish/guestfish-actions.pod:3515
22915 #: ../fish/guestfish-actions.pod:3517
22920 #: ../fish/guestfish-actions.pod:3519
22923 " set-path searchpath\n"
22928 #: ../fish/guestfish-actions.pod:3528
22933 #: ../fish/guestfish-actions.pod:3530
22938 #: ../fish/guestfish-actions.pod:3532
22946 #: ../fish/guestfish-actions.pod:3552
22947 msgid "set-recovery-proc"
22951 #: ../fish/guestfish-actions.pod:3554
22952 msgid "recovery-proc"
22956 #: ../fish/guestfish-actions.pod:3556
22959 " set-recovery-proc true|false\n"
22964 #: ../fish/guestfish-actions.pod:3558
22966 "If this is called with the parameter C<false> then L</launch> does not "
22967 "create a recovery process. The purpose of the recovery process is to stop "
22968 "runaway qemu processes in the case where the main program aborts abruptly."
22972 #: ../fish/guestfish-actions.pod:3563
22974 "This only has any effect if called before L</launch>, and the default is "
22979 #: ../fish/guestfish-actions.pod:3572
22980 msgid "set-selinux"
22984 #: ../fish/guestfish-actions.pod:3574
22989 #: ../fish/guestfish-actions.pod:3576
22992 " set-selinux true|false\n"
22997 #: ../fish/guestfish-actions.pod:3587
23002 #: ../fish/guestfish-actions.pod:3589
23007 #: ../fish/guestfish-actions.pod:3591
23010 " set-trace true|false\n"
23015 #: ../fish/guestfish-actions.pod:3607
23016 msgid "set-verbose"
23020 #: ../fish/guestfish-actions.pod:3609
23025 #: ../fish/guestfish-actions.pod:3611
23028 " set-verbose true|false\n"
23033 #: ../fish/guestfish-actions.pod:3618
23038 #: ../fish/guestfish-actions.pod:3620
23041 " setcon context\n"
23046 #: ../fish/guestfish-actions.pod:3627
23051 #: ../fish/guestfish-actions.pod:3629
23054 " setxattr xattr val vallen path\n"
23059 #: ../fish/guestfish-actions.pod:3635
23060 msgid "See also: L</lsetxattr>, L<attr(5)>."
23064 #: ../fish/guestfish-actions.pod:3637
23069 #: ../fish/guestfish-actions.pod:3639
23072 " sfdisk device cyls heads sectors 'lines ...'\n"
23077 #: ../fish/guestfish-actions.pod:3661
23078 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
23082 #: ../fish/guestfish-actions.pod:3667
23087 #: ../fish/guestfish-actions.pod:3669
23090 " sfdiskM device 'lines ...'\n"
23095 #: ../fish/guestfish-actions.pod:3671
23097 "This is a simplified interface to the L</sfdisk> command, where partition "
23098 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
23099 "you don't need to specify the cyls, heads and sectors parameters which were "
23100 "rarely if ever used anyway."
23104 #: ../fish/guestfish-actions.pod:3677
23105 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
23109 #: ../fish/guestfish-actions.pod:3683
23114 #: ../fish/guestfish-actions.pod:3685
23117 " sfdisk-N device partnum cyls heads sectors line\n"
23122 #: ../fish/guestfish-actions.pod:3690
23124 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
23125 "cyls/heads/sectors parameters."
23129 #: ../fish/guestfish-actions.pod:3693
23130 msgid "See also: L</part-add>"
23134 #: ../fish/guestfish-actions.pod:3698
23135 msgid "sfdisk-disk-geometry"
23139 #: ../fish/guestfish-actions.pod:3700
23142 " sfdisk-disk-geometry device\n"
23147 #: ../fish/guestfish-actions.pod:3702
23149 "This displays the disk geometry of C<device> read from the partition table. "
23150 "Especially in the case where the underlying block device has been resized, "
23151 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
23152 "kernel-geometry>)."
23156 #: ../fish/guestfish-actions.pod:3710
23157 msgid "sfdisk-kernel-geometry"
23161 #: ../fish/guestfish-actions.pod:3712
23164 " sfdisk-kernel-geometry device\n"
23169 #: ../fish/guestfish-actions.pod:3719
23174 #: ../fish/guestfish-actions.pod:3721
23177 " sfdisk-l device\n"
23182 #: ../fish/guestfish-actions.pod:3727
23183 msgid "See also: L</part-list>"
23187 #: ../fish/guestfish-actions.pod:3729
23192 #: ../fish/guestfish-actions.pod:3731
23200 #: ../fish/guestfish-actions.pod:3736
23201 msgid "This is like L</command>, but passes the command to:"
23205 #: ../fish/guestfish-actions.pod:3744
23206 msgid "All the provisos about L</command> apply to this call."
23210 #: ../fish/guestfish-actions.pod:3746
23215 #: ../fish/guestfish-actions.pod:3748
23218 " sh-lines command\n"
23223 #: ../fish/guestfish-actions.pod:3750
23224 msgid "This is the same as L</sh>, but splits the result into a list of lines."
23228 #: ../fish/guestfish-actions.pod:3753
23229 msgid "See also: L</command-lines>"
23233 #: ../fish/guestfish-actions.pod:3755
23238 #: ../fish/guestfish-actions.pod:3757
23246 #: ../fish/guestfish-actions.pod:3761
23251 #: ../fish/guestfish-actions.pod:3763
23259 #: ../fish/guestfish-actions.pod:3769
23264 #: ../fish/guestfish-actions.pod:3771
23272 #: ../fish/guestfish-actions.pod:3779
23277 #: ../fish/guestfish-actions.pod:3781
23285 #: ../fish/guestfish-actions.pod:3789
23290 #: ../fish/guestfish-actions.pod:3791
23293 " strings-e encoding path\n"
23298 #: ../fish/guestfish-actions.pod:3793
23300 "This is like the L</strings> command, but allows you to specify the encoding "
23301 "of strings that are looked for in the source file C<path>."
23305 #: ../fish/guestfish-actions.pod:3803
23307 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
23308 "ISO-8859-X (this is what L</strings> uses)."
23312 #: ../fish/guestfish-actions.pod:3835
23313 msgid "swapoff-device"
23317 #: ../fish/guestfish-actions.pod:3837
23320 " swapoff-device device\n"
23325 #: ../fish/guestfish-actions.pod:3839
23327 "This command disables the libguestfs appliance swap device or partition "
23328 "named C<device>. See L</swapon-device>."
23332 #: ../fish/guestfish-actions.pod:3843
23333 msgid "swapoff-file"
23337 #: ../fish/guestfish-actions.pod:3845
23340 " swapoff-file file\n"
23345 #: ../fish/guestfish-actions.pod:3849
23346 msgid "swapoff-label"
23350 #: ../fish/guestfish-actions.pod:3851
23353 " swapoff-label label\n"
23358 #: ../fish/guestfish-actions.pod:3856
23359 msgid "swapoff-uuid"
23363 #: ../fish/guestfish-actions.pod:3858
23366 " swapoff-uuid uuid\n"
23371 #: ../fish/guestfish-actions.pod:3863
23372 msgid "swapon-device"
23376 #: ../fish/guestfish-actions.pod:3865
23379 " swapon-device device\n"
23384 #: ../fish/guestfish-actions.pod:3867
23386 "This command enables the libguestfs appliance to use the swap device or "
23387 "partition named C<device>. The increased memory is made available for all "
23388 "commands, for example those run using L</command> or L</sh>."
23392 #: ../fish/guestfish-actions.pod:3879
23393 msgid "swapon-file"
23397 #: ../fish/guestfish-actions.pod:3881
23400 " swapon-file file\n"
23405 #: ../fish/guestfish-actions.pod:3883
23407 "This command enables swap to a file. See L</swapon-device> for other notes."
23411 #: ../fish/guestfish-actions.pod:3886
23412 msgid "swapon-label"
23416 #: ../fish/guestfish-actions.pod:3888
23419 " swapon-label label\n"
23424 #: ../fish/guestfish-actions.pod:3890
23426 "This command enables swap to a labeled swap partition. See L</swapon-"
23427 "device> for other notes."
23431 #: ../fish/guestfish-actions.pod:3893
23432 msgid "swapon-uuid"
23436 #: ../fish/guestfish-actions.pod:3895
23439 " swapon-uuid uuid\n"
23444 #: ../fish/guestfish-actions.pod:3897
23446 "This command enables swap to a swap partition with the given UUID. See L</"
23447 "swapon-device> for other notes."
23451 #: ../fish/guestfish-actions.pod:3900
23456 #: ../fish/guestfish-actions.pod:3902
23464 #: ../fish/guestfish-actions.pod:3910
23469 #: ../fish/guestfish-actions.pod:3912
23477 #: ../fish/guestfish-actions.pod:3920
23482 #: ../fish/guestfish-actions.pod:3922
23485 " tail-n nrlines path\n"
23490 #: ../fish/guestfish-actions.pod:3935
23495 #: ../fish/guestfish-actions.pod:3937
23498 " tar-in (tarfile|-) directory\n"
23503 #: ../fish/guestfish-actions.pod:3942
23504 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
23508 #: ../fish/guestfish-actions.pod:3947
23513 #: ../fish/guestfish-actions.pod:3949
23516 " tar-out directory (tarfile|-)\n"
23521 #: ../fish/guestfish-actions.pod:3954
23522 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
23526 #: ../fish/guestfish-actions.pod:3959
23531 #: ../fish/guestfish-actions.pod:3961
23534 " tgz-in (tarball|-) directory\n"
23539 #: ../fish/guestfish-actions.pod:3966
23540 msgid "To upload an uncompressed tarball, use L</tar-in>."
23544 #: ../fish/guestfish-actions.pod:3970
23549 #: ../fish/guestfish-actions.pod:3972
23552 " tgz-out directory (tarball|-)\n"
23557 #: ../fish/guestfish-actions.pod:3977
23558 msgid "To download an uncompressed tarball, use L</tar-out>."
23562 #: ../fish/guestfish-actions.pod:3981
23567 #: ../fish/guestfish-actions.pod:3983
23575 #: ../fish/guestfish-actions.pod:3992
23580 #: ../fish/guestfish-actions.pod:3994
23588 #: ../fish/guestfish-actions.pod:3999
23589 msgid "truncate-size"
23593 #: ../fish/guestfish-actions.pod:4001
23596 " truncate-size path size\n"
23601 #: ../fish/guestfish-actions.pod:4006
23603 "If the current file size is less than C<size> then the file is extended to "
23604 "the required size with zero bytes. This creates a sparse file (ie. disk "
23605 "blocks are not allocated for the file until you write to it). To create a "
23606 "non-sparse file of zeroes, use L</fallocate64> instead."
23610 #: ../fish/guestfish-actions.pod:4012
23615 #: ../fish/guestfish-actions.pod:4014
23618 " tune2fs-l device\n"
23623 #: ../fish/guestfish-actions.pod:4024
23628 #: ../fish/guestfish-actions.pod:4026
23631 " txz-in (tarball|-) directory\n"
23636 #: ../fish/guestfish-actions.pod:4033
23641 #: ../fish/guestfish-actions.pod:4035
23644 " txz-out directory (tarball|-)\n"
23649 #: ../fish/guestfish-actions.pod:4042
23654 #: ../fish/guestfish-actions.pod:4044
23662 #: ../fish/guestfish-actions.pod:4058
23663 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
23667 #: ../fish/guestfish-actions.pod:4063
23672 #: ../fish/guestfish-actions.pod:4065
23677 #: ../fish/guestfish-actions.pod:4067
23680 " umount pathordevice\n"
23685 #: ../fish/guestfish-actions.pod:4073
23690 #: ../fish/guestfish-actions.pod:4075
23691 msgid "unmount-all"
23695 #: ../fish/guestfish-actions.pod:4077
23703 #: ../fish/guestfish-actions.pod:4083
23708 #: ../fish/guestfish-actions.pod:4085
23711 " upload (filename|-) remotefilename\n"
23716 #: ../fish/guestfish-actions.pod:4092
23717 msgid "See also L</download>."
23721 #: ../fish/guestfish-actions.pod:4096
23722 msgid "upload-offset"
23726 #: ../fish/guestfish-actions.pod:4098
23729 " upload-offset (filename|-) remotefilename offset\n"
23734 #: ../fish/guestfish-actions.pod:4110
23736 "Note that there is no limit on the amount of data that can be uploaded with "
23737 "this call, unlike with L</pwrite>, and this call always writes the full "
23738 "amount unless an error occurs."
23742 #: ../fish/guestfish-actions.pod:4115
23743 msgid "See also L</upload>, L</pwrite>."
23747 #: ../fish/guestfish-actions.pod:4119
23752 #: ../fish/guestfish-actions.pod:4121
23755 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
23760 #: ../fish/guestfish-actions.pod:4140
23765 #: ../fish/guestfish-actions.pod:4142
23773 #: ../fish/guestfish-actions.pod:4169
23775 "I<Note:> Don't use this call to test for availability of features. In "
23776 "enterprise distributions we backport features from later versions into "
23777 "earlier versions, making this an unreliable way to test for features. Use "
23778 "L</available> instead."
23782 #: ../fish/guestfish-actions.pod:4175
23787 #: ../fish/guestfish-actions.pod:4177
23790 " vfs-label device\n"
23795 #: ../fish/guestfish-actions.pod:4184
23796 msgid "To find a filesystem from the label, use L</findfs-label>."
23800 #: ../fish/guestfish-actions.pod:4186
23805 #: ../fish/guestfish-actions.pod:4188
23808 " vfs-type device\n"
23813 #: ../fish/guestfish-actions.pod:4198
23818 #: ../fish/guestfish-actions.pod:4200
23821 " vfs-uuid device\n"
23826 #: ../fish/guestfish-actions.pod:4207
23827 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
23831 #: ../fish/guestfish-actions.pod:4209
23832 msgid "vg-activate"
23836 #: ../fish/guestfish-actions.pod:4211
23839 " vg-activate true|false 'volgroups ...'\n"
23844 #: ../fish/guestfish-actions.pod:4224
23845 msgid "vg-activate-all"
23849 #: ../fish/guestfish-actions.pod:4226
23852 " vg-activate-all true|false\n"
23857 #: ../fish/guestfish-actions.pod:4236
23862 #: ../fish/guestfish-actions.pod:4238
23865 " vgcreate volgroup 'physvols ...'\n"
23870 #: ../fish/guestfish-actions.pod:4243
23875 #: ../fish/guestfish-actions.pod:4245
23878 " vglvuuids vgname\n"
23883 #: ../fish/guestfish-actions.pod:4250
23885 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
23886 "logical volumes and volume groups."
23890 #: ../fish/guestfish-actions.pod:4253
23891 msgid "See also L</vgpvuuids>."
23895 #: ../fish/guestfish-actions.pod:4255
23900 #: ../fish/guestfish-actions.pod:4257
23903 " vgpvuuids vgname\n"
23908 #: ../fish/guestfish-actions.pod:4262
23910 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
23911 "physical volumes and volume groups."
23915 #: ../fish/guestfish-actions.pod:4265
23916 msgid "See also L</vglvuuids>."
23920 #: ../fish/guestfish-actions.pod:4267
23925 #: ../fish/guestfish-actions.pod:4269
23928 " vgremove vgname\n"
23933 #: ../fish/guestfish-actions.pod:4276
23938 #: ../fish/guestfish-actions.pod:4278
23941 " vgrename volgroup newvolgroup\n"
23946 #: ../fish/guestfish-actions.pod:4282
23951 #: ../fish/guestfish-actions.pod:4284
23959 #: ../fish/guestfish-actions.pod:4292
23960 msgid "See also L</vgs-full>."
23964 #: ../fish/guestfish-actions.pod:4294
23969 #: ../fish/guestfish-actions.pod:4296
23977 #: ../fish/guestfish-actions.pod:4301
23982 #: ../fish/guestfish-actions.pod:4303
23990 #: ../fish/guestfish-actions.pod:4308
23995 #: ../fish/guestfish-actions.pod:4310
24003 #: ../fish/guestfish-actions.pod:4314
24008 #: ../fish/guestfish-actions.pod:4316
24016 #: ../fish/guestfish-actions.pod:4321
24021 #: ../fish/guestfish-actions.pod:4323
24029 #: ../fish/guestfish-actions.pod:4328
24034 #: ../fish/guestfish-actions.pod:4330
24042 #: ../fish/guestfish-actions.pod:4335
24047 #: ../fish/guestfish-actions.pod:4337
24050 " write path content\n"
24055 #: ../fish/guestfish-actions.pod:4345
24060 #: ../fish/guestfish-actions.pod:4347
24063 " write-file path content size\n"
24068 #: ../fish/guestfish-actions.pod:4370
24073 #: ../fish/guestfish-actions.pod:4372
24076 " zegrep regex path\n"
24081 #: ../fish/guestfish-actions.pod:4380
24086 #: ../fish/guestfish-actions.pod:4382
24089 " zegrepi regex path\n"
24094 #: ../fish/guestfish-actions.pod:4390
24099 #: ../fish/guestfish-actions.pod:4392
24107 #: ../fish/guestfish-actions.pod:4400
24108 msgid "See also: L</zero-device>, L</scrub-device>."
24112 #: ../fish/guestfish-actions.pod:4402
24113 msgid "zero-device"
24117 #: ../fish/guestfish-actions.pod:4404
24120 " zero-device device\n"
24125 #: ../fish/guestfish-actions.pod:4406
24127 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
24128 "which just zeroes the first few blocks of a device."
24132 #: ../fish/guestfish-actions.pod:4413
24137 #: ../fish/guestfish-actions.pod:4415
24140 " zerofree device\n"
24145 #: ../fish/guestfish-actions.pod:4428
24150 #: ../fish/guestfish-actions.pod:4430
24153 " zfgrep pattern path\n"
24158 #: ../fish/guestfish-actions.pod:4438
24163 #: ../fish/guestfish-actions.pod:4440
24166 " zfgrepi pattern path\n"
24171 #: ../fish/guestfish-actions.pod:4448
24176 #: ../fish/guestfish-actions.pod:4450
24179 " zfile meth path\n"
24184 #: ../fish/guestfish-actions.pod:4457
24186 "Since 1.0.63, use L</file> instead which can now process compressed files."
24190 #: ../fish/guestfish-actions.pod:4467
24195 #: ../fish/guestfish-actions.pod:4469
24198 " zgrep regex path\n"
24203 #: ../fish/guestfish-actions.pod:4477
24208 #: ../fish/guestfish-actions.pod:4479
24211 " zgrepi regex path\n"
24216 #: ../fish/guestfish-commands.pod:1
24221 #: ../fish/guestfish-commands.pod:3
24226 #: ../fish/guestfish-commands.pod:5
24229 " alloc filename size\n"
24234 #: ../fish/guestfish-commands.pod:7
24236 "This creates an empty (zeroed) file of the given size, and then adds so it "
24237 "can be further examined."
24241 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
24242 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
24246 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
24247 msgid "Size can be specified using standard suffixes, eg. C<1M>."
24251 #: ../fish/guestfish-commands.pod:14
24253 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
24254 "image, see L</PREPARED DISK IMAGES>."
24258 #: ../fish/guestfish-commands.pod:17
24263 #: ../fish/guestfish-commands.pod:19
24266 " copy-in local [local ...] /remotedir\n"
24271 #: ../fish/guestfish-commands.pod:21
24273 "C<copy-in> copies local files or directories recursively into the disk "
24274 "image, placing them in the directory called C</remotedir> (which must "
24275 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
24276 "other commands as necessary."
24280 #: ../fish/guestfish-commands.pod:26
24282 "Multiple local files and directories can be specified, but the last "
24283 "parameter must always be a remote directory. Wildcards cannot be used."
24287 #: ../fish/guestfish-commands.pod:30
24292 #: ../fish/guestfish-commands.pod:32
24295 " copy-out remote [remote ...] localdir\n"
24300 #: ../fish/guestfish-commands.pod:34
24302 "C<copy-out> copies remote files or directories recursively out of the disk "
24303 "image, placing them on the host disk in a local directory called C<localdir> "
24304 "(which must exist). This guestfish meta-command turns into a sequence of L</"
24305 "download>, L</tar-out> and other commands as necessary."
24309 #: ../fish/guestfish-commands.pod:40
24311 "Multiple remote files and directories can be specified, but the last "
24312 "parameter must always be a local directory. To download to the current "
24313 "directory, use C<.> as in:"
24317 #: ../fish/guestfish-commands.pod:44
24320 " copy-out /home .\n"
24325 #: ../fish/guestfish-commands.pod:46
24327 "Wildcards cannot be used in the ordinary command, but you can use them with "
24328 "the help of L</glob> like this:"
24332 #: ../fish/guestfish-commands.pod:49
24335 " glob copy-out /home/* .\n"
24340 #: ../fish/guestfish-commands.pod:51
24345 #: ../fish/guestfish-commands.pod:53
24348 " echo [params ...]\n"
24353 #: ../fish/guestfish-commands.pod:55
24354 msgid "This echos the parameters to the terminal."
24358 #: ../fish/guestfish-commands.pod:57
24363 #: ../fish/guestfish-commands.pod:59
24368 #: ../fish/guestfish-commands.pod:61
24373 #: ../fish/guestfish-commands.pod:63
24381 #: ../fish/guestfish-commands.pod:65
24383 "This is used to edit a file. It downloads the file, edits it locally using "
24384 "your editor, then uploads the result."
24388 #: ../fish/guestfish-commands.pod:68
24390 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
24391 "or C<emacs> you will get those corresponding editors."
24395 #: ../fish/guestfish-commands.pod:72
24400 #: ../fish/guestfish-commands.pod:74
24403 " glob command args...\n"
24408 #: ../fish/guestfish-commands.pod:76
24410 "Expand wildcards in any paths in the args list, and run C<command> "
24411 "repeatedly on each matching path."
24415 #: ../fish/guestfish-commands.pod:79
24416 msgid "See L</WILDCARDS AND GLOBBING>."
24420 #: ../fish/guestfish-commands.pod:81
24425 #: ../fish/guestfish-commands.pod:83
24428 " hexedit <filename|device>\n"
24429 " hexedit <filename|device> <max>\n"
24430 " hexedit <filename|device> <start> <max>\n"
24435 #: ../fish/guestfish-commands.pod:87
24437 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
24442 #: ../fish/guestfish-commands.pod:90
24444 "This command works by downloading potentially the whole file or device, "
24445 "editing it locally, then uploading it. If the file or device is large, you "
24446 "have to specify which part you wish to edit by using C<max> and/or C<start> "
24447 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
24448 "usual modifiers allowed such as C<1M> (1 megabyte)."
24452 #: ../fish/guestfish-commands.pod:97
24453 msgid "For example to edit the first few sectors of a disk you might do:"
24457 #: ../fish/guestfish-commands.pod:100
24460 " hexedit /dev/sda 1M\n"
24465 #: ../fish/guestfish-commands.pod:102
24467 "which would allow you to edit anywhere within the first megabyte of the disk."
24471 #: ../fish/guestfish-commands.pod:105
24472 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
24476 #: ../fish/guestfish-commands.pod:107
24479 " hexedit /dev/sda1 0x400 0x400\n"
24484 #: ../fish/guestfish-commands.pod:109
24485 msgid "(assuming the superblock is in the standard location)."
24489 #: ../fish/guestfish-commands.pod:111
24491 "This command requires the external L<hexedit(1)> program. You can specify "
24492 "another program to use by setting the C<HEXEDITOR> environment variable."
24496 #: ../fish/guestfish-commands.pod:115
24497 msgid "See also L</hexdump>."
24501 #: ../fish/guestfish-commands.pod:117
24506 #: ../fish/guestfish-commands.pod:119
24514 #: ../fish/guestfish-commands.pod:121
24516 "Change the local directory, ie. the current directory of guestfish itself."
24520 #: ../fish/guestfish-commands.pod:124
24521 msgid "Note that C<!cd> won't do what you might expect."
24525 #: ../fish/guestfish-commands.pod:126
24530 #: ../fish/guestfish-commands.pod:128
24535 #: ../fish/guestfish-commands.pod:130
24543 #: ../fish/guestfish-commands.pod:132
24544 msgid "Opens the manual page for guestfish."
24548 #: ../fish/guestfish-commands.pod:134
24553 #: ../fish/guestfish-commands.pod:136
24558 #: ../fish/guestfish-commands.pod:138
24566 #: ../fish/guestfish-commands.pod:140
24574 #: ../fish/guestfish-commands.pod:142
24575 msgid "This is used to view a file."
24579 #: ../fish/guestfish-commands.pod:144
24581 "The default viewer is C<$PAGER>. However if you use the alternate command "
24582 "C<less> you will get the C<less> command specifically."
24586 #: ../fish/guestfish-commands.pod:147
24591 #: ../fish/guestfish-commands.pod:149
24599 #: ../fish/guestfish-commands.pod:151
24601 "Close and reopen the libguestfs handle. It is not necessary to use this "
24602 "normally, because the handle is closed properly when guestfish exits. "
24603 "However this is occasionally useful for testing."
24607 #: ../fish/guestfish-commands.pod:155
24612 #: ../fish/guestfish-commands.pod:157
24615 " sparse filename size\n"
24620 #: ../fish/guestfish-commands.pod:159
24622 "This creates an empty sparse file of the given size, and then adds so it can "
24623 "be further examined."
24627 #: ../fish/guestfish-commands.pod:162
24629 "In all respects it works the same as the L</alloc> command, except that the "
24630 "image file is allocated sparsely, which means that disk blocks are not "
24631 "assigned to the file until they are needed. Sparse disk files only use "
24632 "space when written to, but they are slower and there is a danger you could "
24633 "run out of real disk space during a write operation."
24637 #: ../fish/guestfish-commands.pod:172
24642 #: ../fish/guestfish-commands.pod:174
24650 #: ../fish/guestfish-commands.pod:176
24652 "This command returns a list of the optional groups known to the daemon, and "
24653 "indicates which ones are supported by this build of the libguestfs appliance."
24657 #: ../fish/guestfish-commands.pod:180
24658 msgid "See also L<guestfs(3)/AVAILABILITY>."
24662 #: ../fish/guestfish-commands.pod:182
24667 #: ../fish/guestfish-commands.pod:184
24670 " time command args...\n"
24675 #: ../fish/guestfish-commands.pod:186
24677 "Run the command as usual, but print the elapsed time afterwards. This can "
24678 "be useful for benchmarking operations."
24682 #: ../test-tool/libguestfs-test-tool.pod:5
24683 msgid "libguestfs-test-tool - End user tests for libguestfs"
24687 #: ../test-tool/libguestfs-test-tool.pod:9
24690 " libguestfs-test-tool [--options]\n"
24695 #: ../test-tool/libguestfs-test-tool.pod:13
24697 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
24698 "and developers, to allow them to check basic libguestfs functionality is "
24699 "working. This is needed because libguestfs occasionally breaks for reasons "
24700 "beyond our control: usually because of changes in the underlying qemu or "
24701 "kernel packages, or the host environment."
24705 #: ../test-tool/libguestfs-test-tool.pod:20
24706 msgid "If you suspect a problem in libguestfs, then just run:"
24710 #: ../test-tool/libguestfs-test-tool.pod:22
24713 " libguestfs-test-tool\n"
24718 #: ../test-tool/libguestfs-test-tool.pod:24
24719 msgid "It will print lots of diagnostic messages."
24723 #: ../test-tool/libguestfs-test-tool.pod:26
24724 msgid "If it runs to completion successfully, you will see this near the end:"
24728 #: ../test-tool/libguestfs-test-tool.pod:28
24731 " ===== TEST FINISHED OK =====\n"
24736 #: ../test-tool/libguestfs-test-tool.pod:30
24737 msgid "and the test tool will exit with code 0."
24741 #: ../test-tool/libguestfs-test-tool.pod:32
24743 "If it fails (and/or exits with non-zero error code), please paste the "
24744 "B<complete, unedited> output of the test tool into a bug report. More "
24745 "information about reporting bugs can be found on the L<http://libguestfs.org/"
24750 #: ../test-tool/libguestfs-test-tool.pod:41
24755 #: ../test-tool/libguestfs-test-tool.pod:43
24756 msgid "Display short usage information and exit."
24760 #: ../test-tool/libguestfs-test-tool.pod:45
24761 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
24765 #: ../test-tool/libguestfs-test-tool.pod:47
24767 "Pass an alternate name for the helper program. libguestfs-test-tool will "
24768 "normally look in the C<$libexec> directory that was configured when the tool "
24773 #: ../test-tool/libguestfs-test-tool.pod:51
24774 msgid "I<--qemu qemu_binary>"
24778 #: ../test-tool/libguestfs-test-tool.pod:53
24780 "If you have downloaded another qemu binary, point this option at the full "
24781 "path of the binary to try it."
24785 #: ../test-tool/libguestfs-test-tool.pod:56
24786 msgid "I<--qemudir qemu_source_dir>"
24790 #: ../test-tool/libguestfs-test-tool.pod:58
24792 "If you have compiled qemu from source, point this option at the source "
24793 "directory to try it."
24797 #: ../test-tool/libguestfs-test-tool.pod:61
24798 msgid "I<--timeout N>"
24802 #: ../test-tool/libguestfs-test-tool.pod:63
24804 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
24805 "does not usually need to be adjusted unless your machine is very slow."
24809 #: ../test-tool/libguestfs-test-tool.pod:69
24810 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
24814 #: ../test-tool/libguestfs-test-tool.pod:71
24816 "If you have compiled another version of qemu from source and would like to "
24817 "try that, then you can use the I<--qemudir> option to point to the qemu "
24818 "source directory."
24822 #: ../test-tool/libguestfs-test-tool.pod:75
24824 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
24825 "option to point to the binary."
24829 #: ../test-tool/libguestfs-test-tool.pod:78
24831 "When using an alternate qemu with libguestfs, usually you would need to "
24832 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
24833 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
24834 "use either of the I<--qemudir> or I<--qemu> options."
24838 #: ../test-tool/libguestfs-test-tool.pod:85
24840 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
24841 "I<1> if there was an error."
24845 #: ../test-tool/libguestfs-test-tool.pod:92
24846 msgid "/usr/libexec/libguestfs-test-tool-helper"
24850 #: ../test-tool/libguestfs-test-tool.pod:94
24852 "This helper program is run inside the appliance and provides additional "
24857 #: ../test-tool/libguestfs-test-tool.pod:97
24858 msgid "/usr/bin/mkisofs"
24862 #: ../test-tool/libguestfs-test-tool.pod:99
24864 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
24865 "which is used as part of the tests."
24869 #: ../test-tool/libguestfs-test-tool.pod:106
24871 "For the full list of environment variables which may affect libguestfs, "
24872 "please see the L<guestfs(3)> manual page."
24876 #: ../test-tool/libguestfs-test-tool.pod:111
24877 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
24881 #: ../test-tool/libguestfs-test-tool.pod:121
24882 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
24886 #: ../fuse/guestmount.pod:5
24888 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
24892 #: ../fuse/guestmount.pod:9
24895 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
24900 #: ../fuse/guestmount.pod:11
24903 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
24908 #: ../fuse/guestmount.pod:13
24911 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
24916 #: ../fuse/guestmount.pod:17
24918 "You must I<not> use C<guestmount> in read-write mode on live virtual "
24919 "machines. If you do this, you risk disk corruption in the VM."
24923 #: ../fuse/guestmount.pod:22
24925 "The guestmount program can be used to mount virtual machine filesystems and "
24926 "other disk images on the host. It uses libguestfs for access to the guest "
24927 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
24928 "a mountable device."
24932 #: ../fuse/guestmount.pod:27
24934 "Along with other options, you have to give at least one device (I<-a> "
24935 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
24936 "option) or use the I<-i> inspection option. How this works is better "
24937 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
24942 #: ../fuse/guestmount.pod:33
24944 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
24945 "by you, and the filesystem will not be visible to any other users unless you "
24946 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
24947 "the filesystem, use the C<fusermount -u> command."
24951 #: ../fuse/guestmount.pod:41
24953 "For a typical Windows guest which has its main filesystem on the first "
24958 #: ../fuse/guestmount.pod:44
24961 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
24966 #: ../fuse/guestmount.pod:46
24968 "For a typical Linux guest which has a /boot filesystem on the first "
24969 "partition, and the root filesystem on a logical volume:"
24973 #: ../fuse/guestmount.pod:49
24976 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
24981 #: ../fuse/guestmount.pod:51
24982 msgid "To get libguestfs to detect guest mountpoints for you:"
24986 #: ../fuse/guestmount.pod:53
24989 " guestmount -a guest.img -i --ro /mnt\n"
24994 #: ../fuse/guestmount.pod:55
24995 msgid "For a libvirt guest called \"Guest\" you could do:"
24999 #: ../fuse/guestmount.pod:57
25002 " guestmount -d Guest -i --ro /mnt\n"
25007 #: ../fuse/guestmount.pod:59
25009 "If you don't know what filesystems are contained in a guest or disk image, "
25010 "use L<virt-list-filesystems(1)> first:"
25014 #: ../fuse/guestmount.pod:62
25017 " virt-list-filesystems MyGuest\n"
25022 #: ../fuse/guestmount.pod:64
25024 "If you want to trace the libguestfs calls but without excessive debugging "
25025 "information, we recommend:"
25029 #: ../fuse/guestmount.pod:67
25032 " guestmount [...] --trace /mnt\n"
25037 #: ../fuse/guestmount.pod:69
25038 msgid "If you want to debug the program, we recommend:"
25042 #: ../fuse/guestmount.pod:71
25045 " guestmount [...] --trace --verbose /mnt\n"
25050 #: ../fuse/guestmount.pod:79
25051 msgid "Add a block device or virtual machine image."
25055 #: ../fuse/guestmount.pod:96
25056 msgid "B<--dir-cache-timeout N>"
25060 #: ../fuse/guestmount.pod:98
25062 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
25063 "seconds. The readdir cache [actually, there are several semi-independent "
25064 "caches] is populated after a readdir(2) call with the stat and extended "
25065 "attributes of the files in the directory, in anticipation that they will be "
25066 "requested soon after."
25070 #: ../fuse/guestmount.pod:104
25072 "There is also a different attribute cache implemented by FUSE (see the FUSE "
25073 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
25074 "requests, only cache existing ones."
25078 #: ../fuse/guestmount.pod:122
25080 "If you have untrusted raw-format guest disk images, you should use this "
25081 "option to specify the disk format. This avoids a possible security problem "
25082 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
25083 "guestfs_add_drive_opts>."
25087 #: ../fuse/guestmount.pod:127
25088 msgid "B<--fuse-help>"
25092 #: ../fuse/guestmount.pod:129
25093 msgid "Display help on special FUSE options (see I<-o> below)."
25097 #: ../fuse/guestmount.pod:133
25098 msgid "Display brief help and exit."
25102 #: ../fuse/guestmount.pod:146
25103 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
25107 #: ../fuse/guestmount.pod:148
25109 "Mount the named partition or logical volume on the given mountpoint B<in the "
25110 "guest> (this has nothing to do with mountpoints in the host)."
25114 #: ../fuse/guestmount.pod:151
25116 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
25117 "something on C</>."
25121 #: ../fuse/guestmount.pod:156
25123 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
25124 "unmounted. If you specify this option, then we don't attempt to sync the "
25125 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
25129 #: ../fuse/guestmount.pod:161
25130 msgid "B<-o option> | B<--option option>"
25134 #: ../fuse/guestmount.pod:163
25135 msgid "Pass extra options to FUSE."
25139 #: ../fuse/guestmount.pod:165
25141 "To get a list of all the extra options supported by FUSE, use the command "
25142 "below. Note that only the FUSE I<-o> options can be passed, and only some "
25143 "of them are a good idea."
25147 #: ../fuse/guestmount.pod:169
25150 " guestmount --fuse-help\n"
25155 #: ../fuse/guestmount.pod:171
25156 msgid "Some potentially useful FUSE options:"
25160 #: ../fuse/guestmount.pod:175
25161 msgid "B<-o allow_other>"
25165 #: ../fuse/guestmount.pod:177
25166 msgid "Allow other users to see the filesystem."
25170 #: ../fuse/guestmount.pod:179
25171 msgid "B<-o attr_timeout=N>"
25175 #: ../fuse/guestmount.pod:181
25176 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
25180 #: ../fuse/guestmount.pod:183
25181 msgid "B<-o kernel_cache>"
25185 #: ../fuse/guestmount.pod:185
25187 "Allow the kernel to cache files (reduces the number of reads that have to go "
25188 "through the L<guestfs(3)> API). This is generally a good idea if you can "
25189 "afford the extra memory usage."
25193 #: ../fuse/guestmount.pod:189
25194 msgid "B<-o uid=N> B<-o gid=N>"
25198 #: ../fuse/guestmount.pod:191
25200 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
25201 "the chosen values."
25205 #: ../fuse/guestmount.pod:198
25207 "Add devices and mount everything read-only. Also disallow writes and make "
25208 "the disk appear read-only to FUSE."
25212 #: ../fuse/guestmount.pod:201
25214 "This is highly recommended if you are not going to edit the guest disk. If "
25215 "the guest is running and this option is I<not> supplied, then there is a "
25216 "strong risk of disk corruption in the guest. We try to prevent this from "
25217 "happening, but it is not always possible."
25221 #: ../fuse/guestmount.pod:206
25222 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
25226 #: ../fuse/guestmount.pod:210
25227 msgid "Enable SELinux support for the guest."
25231 #: ../fuse/guestmount.pod:214
25232 msgid "Enable verbose messages from underlying libguestfs."
25236 #: ../fuse/guestmount.pod:218
25237 msgid "Display the program version and exit."
25241 #: ../fuse/guestmount.pod:222
25243 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
25244 "FOR READ AND WRITE>."
25248 #: ../fuse/guestmount.pod:225
25249 msgid "B<-x> | B<--trace>"
25253 #: ../fuse/guestmount.pod:227
25254 msgid "Trace libguestfs calls."
25258 #: ../fuse/guestmount.pod:229
25259 msgid "This also stops the daemon from forking into the background."
25263 #: ../fuse/guestmount.pod:235
25265 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
25266 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
25271 #: ../inspector/virt-inspector.pl:35
25273 "virt-inspector - Display operating system version and other information "
25274 "about a virtual machine"
25278 #: ../inspector/virt-inspector.pl:39
25281 " virt-inspector [--connect URI] domname\n"
25286 #: ../inspector/virt-inspector.pl:41
25289 " virt-inspector guest.img [guest.img ...]\n"
25294 #: ../inspector/virt-inspector.pl:45
25296 "B<virt-inspector> examines a virtual machine or disk image and tries to "
25297 "determine the version of the operating system and other information about "
25298 "the virtual machine."
25302 #: ../inspector/virt-inspector.pl:49
25303 msgid "Virt-inspector produces XML output for feeding into other programs."
25307 #: ../inspector/virt-inspector.pl:51
25309 "In the normal usage, use C<virt-inspector domname> where C<domname> is the "
25310 "libvirt domain (see: C<virsh list --all>)."
25314 #: ../inspector/virt-inspector.pl:54
25316 "You can also run virt-inspector directly on disk images from a single "
25317 "virtual machine. Use C<virt-inspector guest.img>. In rare cases a domain "
25318 "has several block devices, in which case you should list them one after "
25319 "another, with the first corresponding to the guest's C</dev/sda>, the second "
25320 "to the guest's C</dev/sdb> and so on."
25324 #: ../inspector/virt-inspector.pl:60
25326 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
25327 "inspect several virtual machines, you have to run virt-inspector several "
25328 "times (for example, from a shell script for-loop)."
25332 #: ../inspector/virt-inspector.pl:65
25334 "Because virt-inspector needs direct access to guest images, it won't "
25335 "normally work over remote libvirt connections."
25339 #: ../inspector/virt-inspector.pl:78 ../tools/virt-edit.pl:82
25340 #: ../tools/virt-win-reg.pl:181 ../tools/virt-df.pl:81 ../tools/virt-ls.pl:88
25341 #: ../tools/virt-list-filesystems.pl:60 ../tools/virt-cat.pl:89
25342 #: ../tools/virt-tar.pl:108 ../tools/virt-rescue.pl:113
25343 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:61
25344 msgid "Display brief help."
25348 #: ../inspector/virt-inspector.pl:84 ../tools/virt-edit.pl:88
25349 #: ../tools/virt-win-reg.pl:187 ../tools/virt-df.pl:87 ../tools/virt-ls.pl:94
25350 #: ../tools/virt-resize.pl:273 ../tools/virt-list-filesystems.pl:66
25351 #: ../tools/virt-cat.pl:95 ../tools/virt-tar.pl:114
25352 #: ../tools/virt-rescue.pl:119 ../tools/virt-make-fs.pl:169
25353 #: ../tools/virt-list-partitions.pl:67
25354 msgid "B<--version>"
25358 #: ../inspector/virt-inspector.pl:86 ../tools/virt-edit.pl:90
25359 #: ../tools/virt-win-reg.pl:189 ../tools/virt-df.pl:89 ../tools/virt-ls.pl:96
25360 #: ../tools/virt-resize.pl:275 ../tools/virt-list-filesystems.pl:68
25361 #: ../tools/virt-cat.pl:97 ../tools/virt-tar.pl:116
25362 #: ../tools/virt-rescue.pl:121 ../tools/virt-make-fs.pl:171
25363 #: ../tools/virt-list-partitions.pl:69
25364 msgid "Display version number and exit."
25368 #: ../inspector/virt-inspector.pl:92 ../tools/virt-edit.pl:112
25369 #: ../tools/virt-win-reg.pl:203 ../tools/virt-df.pl:95 ../tools/virt-ls.pl:102
25370 #: ../tools/virt-list-filesystems.pl:74 ../tools/virt-cat.pl:103
25371 #: ../tools/virt-tar.pl:122 ../tools/virt-rescue.pl:135
25372 #: ../tools/virt-list-partitions.pl:75
25373 msgid "B<--connect URI> | B<-c URI>"
25377 #: ../inspector/virt-inspector.pl:94 ../tools/virt-edit.pl:114
25378 #: ../tools/virt-win-reg.pl:205 ../tools/virt-df.pl:97 ../tools/virt-ls.pl:104
25379 #: ../tools/virt-list-filesystems.pl:76 ../tools/virt-cat.pl:105
25380 #: ../tools/virt-tar.pl:124 ../tools/virt-rescue.pl:137
25381 #: ../tools/virt-list-partitions.pl:77
25383 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
25384 "to the default libvirt hypervisor."
25388 #: ../inspector/virt-inspector.pl:97
25390 "Libvirt is only used if you specify a C<domname> on the command line. If "
25391 "you specify guest block devices directly, then libvirt is not used at all."
25395 #: ../inspector/virt-inspector.pl:105 ../tools/virt-edit.pl:124
25396 #: ../tools/virt-win-reg.pl:215 ../tools/virt-df.pl:117
25397 #: ../tools/virt-ls.pl:114 ../tools/virt-resize.pl:523
25398 #: ../tools/virt-list-filesystems.pl:86 ../tools/virt-cat.pl:115
25399 #: ../tools/virt-tar.pl:134 ../tools/virt-rescue.pl:147
25400 #: ../tools/virt-list-partitions.pl:87
25401 msgid "B<--format> raw"
25405 #: ../inspector/virt-inspector.pl:107 ../tools/virt-edit.pl:126
25406 #: ../tools/virt-win-reg.pl:217 ../tools/virt-df.pl:119
25407 #: ../tools/virt-ls.pl:116 ../tools/virt-list-filesystems.pl:88
25408 #: ../tools/virt-cat.pl:117 ../tools/virt-tar.pl:136
25409 #: ../tools/virt-rescue.pl:149 ../tools/virt-list-partitions.pl:89
25411 "Specify the format of disk images given on the command line. If this is "
25412 "omitted then the format is autodetected from the content of the disk image."
25416 #: ../inspector/virt-inspector.pl:111 ../tools/virt-edit.pl:130
25417 #: ../tools/virt-win-reg.pl:221 ../tools/virt-df.pl:123
25418 #: ../tools/virt-ls.pl:120 ../tools/virt-list-filesystems.pl:92
25419 #: ../tools/virt-cat.pl:121 ../tools/virt-tar.pl:140
25420 #: ../tools/virt-rescue.pl:153 ../tools/virt-list-partitions.pl:93
25422 "If disk images are requested from libvirt, then this program asks libvirt "
25423 "for this information. In this case, the value of the format parameter is "
25428 #: ../inspector/virt-inspector.pl:115 ../tools/virt-edit.pl:134
25429 #: ../tools/virt-win-reg.pl:225 ../tools/virt-df.pl:127
25430 #: ../tools/virt-ls.pl:124 ../tools/virt-resize.pl:528
25431 #: ../tools/virt-resize.pl:543 ../tools/virt-list-filesystems.pl:96
25432 #: ../tools/virt-cat.pl:125 ../tools/virt-tar.pl:144
25433 #: ../tools/virt-rescue.pl:157 ../tools/virt-list-partitions.pl:97
25435 "If working with untrusted raw-format guest disk images, you should ensure "
25436 "the format is always specified."
25440 #: ../inspector/virt-inspector.pl:149
25445 #: ../inspector/virt-inspector.pl:151
25447 "The virt-inspector XML is described precisely in a RELAX NG schema which is "
25448 "supplied with libguestfs. This section is just an overview."
25452 #: ../inspector/virt-inspector.pl:154
25454 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
25455 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
25456 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
25457 "which is vanishingly rare in real world VMs."
25461 #: ../inspector/virt-inspector.pl:159
25462 msgid "E<lt>operatingsystemE<gt>"
25466 #: ../inspector/virt-inspector.pl:161
25468 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
25469 "describe the operating system, its architecture, the descriptive \"product "
25470 "name\" string, the type of OS and so on, as in this example:"
25474 #: ../inspector/virt-inspector.pl:165
25477 " <operatingsystems>\n"
25478 " <operatingsystem>\n"
25479 " <root>/dev/sda2</root>\n"
25480 " <name>windows</name>\n"
25481 " <arch>i386</arch>\n"
25482 " <distro>windows</distro>\n"
25483 " <product_name>Windows 7 Enterprise</product_name>\n"
25484 " <major_version>6</major_version>\n"
25485 " <minor_version>1</minor_version>\n"
25486 " <windows_systemroot>/Windows</windows_systemroot>\n"
25491 #: ../inspector/virt-inspector.pl:176
25493 "These fields are derived from the libguestfs inspection API, and you can "
25494 "find more details in L<guestfs(3)/INSPECTION>."
25498 #: ../inspector/virt-inspector.pl:179
25500 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
25501 "of view of libguestfs (block devices may have completely different names "
25502 "inside the VM itself)."
25506 #: ../inspector/virt-inspector.pl:240
25507 msgid "E<lt>mountpointsE<gt>"
25511 #: ../inspector/virt-inspector.pl:242
25513 "Un*x-like guests typically have multiple filesystems which are mounted at "
25514 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
25515 "element which looks like this:"
25519 #: ../inspector/virt-inspector.pl:246
25522 " <operatingsystems>\n"
25523 " <operatingsystem>\n"
25526 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
25527 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
25528 " </mountpoints>\n"
25533 #: ../inspector/virt-inspector.pl:254
25535 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
25536 "and may have completely different names inside the guest. Only mountable "
25537 "filesystems appear in this list, not things like swap devices."
25541 #: ../inspector/virt-inspector.pl:276
25542 msgid "E<lt>filesystemsE<gt>"
25546 #: ../inspector/virt-inspector.pl:278
25548 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
25549 "filesystems belonging to the guest, including swap and empty partitions. "
25550 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
25551 "this OS or shared by this OS and other OSes)."
25555 #: ../inspector/virt-inspector.pl:283
25556 msgid "You might see something like this:"
25560 #: ../inspector/virt-inspector.pl:285
25563 " <operatingsystems>\n"
25564 " <operatingsystem>\n"
25567 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
25568 " <type>ext4</type>\n"
25569 " <label>Fedora-13-x86_64</label>\n"
25570 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
25576 #: ../inspector/virt-inspector.pl:295
25578 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
25579 "the label, and the UUID."
25583 #: ../inspector/virt-inspector.pl:337
25584 msgid "E<lt>applicationsE<gt>"
25588 #: ../inspector/virt-inspector.pl:339
25590 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
25591 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
25592 "machine. At the moment we are only able to list RPMs and Debian packages "
25593 "installed, but in future we will support other Linux distros and Windows."
25597 #: ../inspector/virt-inspector.pl:345
25599 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
25600 "Typical values would be C<rpm> and C<deb>."
25604 #: ../inspector/virt-inspector.pl:348
25606 "E<lt>package_managementE<gt>, if present, describes the package manager. "
25607 "Typical values include C<yum>, C<up2date> and C<apt>"
25611 #: ../inspector/virt-inspector.pl:351
25612 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
25616 #: ../inspector/virt-inspector.pl:354
25619 " <operatingsystems>\n"
25620 " <operatingsystem>\n"
25622 " <applications>\n"
25624 " <name>coreutils</name>\n"
25625 " <version>8.5</version>\n"
25626 " <release>1</release>\n"
25627 " </application>\n"
25632 #: ../inspector/virt-inspector.pl:364
25634 "(The version and release fields may not be available for some package types)."
25638 #: ../inspector/virt-inspector.pl:544
25639 msgid "USING XPATH"
25643 #: ../inspector/virt-inspector.pl:546
25645 "You can use the XPath query language, and/or the xpath tool, in order to "
25646 "select parts of the XML."
25650 #: ../inspector/virt-inspector.pl:551
25653 " $ virt-inspector Guest | xpath //filesystems\n"
25654 " Found 1 nodes:\n"
25657 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
25658 " <type>ext4</type>\n"
25664 #: ../inspector/virt-inspector.pl:559
25667 " $ virt-inspector Guest | \\\n"
25668 " xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
25669 " Query didn't return a nodeset. Value: ext4\n"
25674 #: ../inspector/virt-inspector.pl:563 ../tools/virt-edit.pl:343
25675 #: ../tools/virt-win-reg.pl:141 ../tools/virt-win-reg.pl:477
25676 #: ../tools/virt-df.pl:633 ../tools/virt-ls.pl:225
25677 #: ../tools/virt-resize.pl:1479 ../tools/virt-list-filesystems.pl:179
25678 #: ../tools/virt-cat.pl:178 ../tools/virt-tar.pl:274
25679 #: ../tools/virt-rescue.pl:260 ../tools/virt-make-fs.pl:527
25680 #: ../tools/virt-list-partitions.pl:247
25681 msgid "SHELL QUOTING"
25685 #: ../inspector/virt-inspector.pl:565 ../tools/virt-edit.pl:345
25686 #: ../tools/virt-win-reg.pl:479 ../tools/virt-df.pl:635
25687 #: ../tools/virt-ls.pl:227 ../tools/virt-resize.pl:1481
25688 #: ../tools/virt-list-filesystems.pl:181 ../tools/virt-cat.pl:180
25689 #: ../tools/virt-tar.pl:276 ../tools/virt-rescue.pl:262
25690 #: ../tools/virt-make-fs.pl:529 ../tools/virt-list-partitions.pl:249
25692 "Libvirt guest names can contain arbitrary characters, some of which have "
25693 "meaning to the shell such as C<#> and space. You may need to quote or "
25694 "escape these characters on the command line. See the shell manual page L<sh"
25695 "(1)> for details."
25699 #: ../inspector/virt-inspector.pl:572
25701 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
25702 "L<Sys::Virt(3)>, L<http://www.w3.org/TR/xpath/>, L<http://libguestfs.org/>."
25706 #: ../inspector/virt-inspector.pl:586 ../tools/virt-edit.pl:364
25707 #: ../tools/virt-win-reg.pl:512 ../tools/virt-df.pl:651
25708 #: ../tools/virt-ls.pl:245 ../tools/virt-resize.pl:1510
25709 #: ../tools/virt-list-filesystems.pl:200 ../tools/virt-cat.pl:197
25710 #: ../tools/virt-tar.pl:294 ../tools/virt-rescue.pl:279
25711 #: ../tools/virt-make-fs.pl:561 ../tools/virt-list-partitions.pl:267
25712 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
25716 #: ../inspector/virt-inspector.pl:590
25717 msgid "Matthew Booth L<mbooth@redhat.com>"
25721 #: ../inspector/virt-inspector.pl:596 ../tools/virt-win-reg.pl:516
25722 #: ../tools/virt-resize.pl:1514 ../tools/virt-make-fs.pl:565
25723 msgid "Copyright (C) 2010 Red Hat Inc."
25727 #: ../tools/virt-edit.pl:34
25728 msgid "virt-edit - Edit a file in a virtual machine"
25732 #: ../tools/virt-edit.pl:38
25735 " virt-edit [--options] domname file\n"
25740 #: ../tools/virt-edit.pl:40
25743 " virt-edit [--options] disk.img [disk.img ...] file\n"
25748 #: ../tools/virt-edit.pl:42
25751 " virt-edit [domname|disk.img] file -e 'expr'\n"
25756 #: ../tools/virt-edit.pl:46
25758 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
25759 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
25760 "doing this, but doesn't catch all cases."
25764 #: ../tools/virt-edit.pl:52
25766 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
25767 "the named virtual machine (or disk image)."
25771 #: ../tools/virt-edit.pl:55
25773 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
25774 "you should look at the L<guestfish(1)> tool."
25778 #: ../tools/virt-edit.pl:60
25779 msgid "Edit the named files interactively:"
25783 #: ../tools/virt-edit.pl:62
25786 " virt-edit mydomain /boot/grub/grub.conf\n"
25791 #: ../tools/virt-edit.pl:64
25794 " virt-edit mydomain /etc/passwd\n"
25799 #: ../tools/virt-edit.pl:66
25801 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
25802 "below). To change the init default level to 5:"
25806 #: ../tools/virt-edit.pl:70
25809 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
25814 #: ../tools/virt-edit.pl:96
25815 msgid "B<--backup extension> | B<-b extension>"
25819 #: ../tools/virt-edit.pl:98
25821 "Create a backup of the original file I<in the guest disk image>. The backup "
25822 "has the original filename with C<extension> added."
25826 #: ../tools/virt-edit.pl:101
25828 "Usually the first character of C<extension> would be a dot C<.> so you would "
25833 #: ../tools/virt-edit.pl:104
25836 " virt-edit -b .orig [etc]\n"
25841 #: ../tools/virt-edit.pl:106
25842 msgid "By default, no backup file is made."
25846 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:208
25847 #: ../tools/virt-df.pl:100 ../tools/virt-ls.pl:107
25848 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-cat.pl:108
25849 #: ../tools/virt-tar.pl:127 ../tools/virt-rescue.pl:140
25850 #: ../tools/virt-list-partitions.pl:80
25852 "If you specify guest block devices directly, then libvirt is not used at all."
25856 #: ../tools/virt-edit.pl:141
25857 msgid "B<--expr EXPR> | B<-e EXPR>"
25861 #: ../tools/virt-edit.pl:143
25863 "Instead of launching the external editor, non-interactively apply the Perl "
25864 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
25869 #: ../tools/virt-edit.pl:147
25871 "Be careful to properly quote the expression to prevent it from being altered "
25876 #: ../tools/virt-edit.pl:268
25877 msgid "NON-INTERACTIVE EDITING"
25881 #: ../tools/virt-edit.pl:270
25883 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
25884 "administrator can interactively edit the file."
25888 #: ../tools/virt-edit.pl:273
25890 "There are two ways also to use C<virt-edit> from scripts in order to make "
25891 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
25892 "like this, it's less error-prone to write scripts directly using the "
25893 "libguestfs API and Augeas for configuration file editing.)"
25897 #: ../tools/virt-edit.pl:279
25899 "The first method is to temporarily set C<$EDITOR> to any script or program "
25900 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
25901 "update C<tmpfile> in place however it likes."
25905 #: ../tools/virt-edit.pl:283
25907 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
25908 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
25909 "instances of C<foo> with C<bar> in a file:"
25913 #: ../tools/virt-edit.pl:287
25916 " virt-edit domname filename -e 's/foo/bar/'\n"
25921 #: ../tools/virt-edit.pl:289
25923 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
25924 "For example to delete root's password you could do:"
25928 #: ../tools/virt-edit.pl:292
25931 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
25936 #: ../tools/virt-edit.pl:294
25938 "What really happens is that the snippet is evaluated as a Perl expression "
25939 "for each line of the file. The line, including the final C<\\n>, is passed "
25940 "in C<$_> and the expression should update C<$_> or leave it unchanged."
25944 #: ../tools/virt-edit.pl:299
25946 "To delete a line, set C<$_> to the empty string. For example, to delete the "
25947 "C<apache> user account from the password file you can do:"
25951 #: ../tools/virt-edit.pl:302
25954 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
25959 #: ../tools/virt-edit.pl:304
25961 "To insert a line, prepend or append it to C<$_>. However appending lines to "
25962 "the end of the file is rather difficult this way since there is no concept "
25963 "of \"last line of the file\" - your expression just doesn't get called "
25964 "again. You might want to use the first method (setting C<$EDITOR>) if you "
25969 #: ../tools/virt-edit.pl:310
25971 "The variable C<$lineno> contains the current line number. As is "
25972 "traditional, the first line in the file is number C<1>."
25976 #: ../tools/virt-edit.pl:313
25978 "The return value from the expression is ignored, but the expression may call "
25979 "C<die> in order to abort the whole program, leaving the original file "
25984 #: ../tools/virt-edit.pl:317
25986 "Remember when matching the end of a line that C<$_> may contain the final C<"
25987 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
25988 "newline then neither of these. Thus to match or substitute some text at the "
25989 "end of a line, use this regular expression:"
25993 #: ../tools/virt-edit.pl:322
25996 " /some text(\\r?\\n)?$/\n"
26001 #: ../tools/virt-edit.pl:324
26003 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
26004 "$_> itself (since that would remove all newlines from the file):"
26008 #: ../tools/virt-edit.pl:328
26011 " my $m = $_; chomp $m; $m =~ /some text$/\n"
26016 #: ../tools/virt-edit.pl:334
26021 #: ../tools/virt-edit.pl:336
26023 "If set, this string is used as the editor. It may contain arguments, eg. C<"
26028 #: ../tools/virt-edit.pl:339
26029 msgid "If not set, C<vi> is used."
26033 #: ../tools/virt-edit.pl:352
26035 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
26036 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, "
26041 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:510
26042 #: ../tools/virt-df.pl:649 ../tools/virt-ls.pl:243
26043 #: ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:198
26044 #: ../tools/virt-cat.pl:195 ../tools/virt-tar.pl:292
26045 #: ../tools/virt-rescue.pl:277 ../tools/virt-make-fs.pl:559
26046 #: ../tools/virt-list-partitions.pl:265
26051 #: ../tools/virt-edit.pl:368 ../tools/virt-df.pl:655
26052 #: ../tools/virt-rescue.pl:283 ../tools/virt-list-partitions.pl:271
26053 msgid "Copyright (C) 2009-2010 Red Hat Inc."
26057 #: ../tools/virt-win-reg.pl:37
26059 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
26063 #: ../tools/virt-win-reg.pl:41
26066 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
26071 #: ../tools/virt-win-reg.pl:43
26074 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
26079 #: ../tools/virt-win-reg.pl:45
26082 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
26087 #: ../tools/virt-win-reg.pl:47
26090 " virt-win-reg --merge domname [input.reg ...]\n"
26095 #: ../tools/virt-win-reg.pl:49
26098 " virt-win-reg [--options] disk.img ... # instead of domname\n"
26103 #: ../tools/virt-win-reg.pl:53
26105 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
26106 "virtual machines. If you do this, you I<will> get irreversible disk "
26107 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
26108 "but doesn't catch all cases."
26112 #: ../tools/virt-win-reg.pl:58
26114 "Modifying the Windows Registry is an inherently risky operation. The format "
26115 "is deliberately obscure and undocumented, and Registry changes can leave the "
26116 "system unbootable. Therefore when using the C<--merge> option, make sure "
26117 "you have a reliable backup first."
26121 #: ../tools/virt-win-reg.pl:65
26123 "This program can export and merge Windows Registry entries from a Windows "
26128 #: ../tools/virt-win-reg.pl:68
26130 "The first parameter is the libvirt guest name or the raw disk image of a "
26135 #: ../tools/virt-win-reg.pl:71
26137 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
26138 "exported (recursively). For example:"
26142 #: ../tools/virt-win-reg.pl:74
26145 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
26150 #: ../tools/virt-win-reg.pl:76
26152 "You can also display single values from within registry keys, for example:"
26156 #: ../tools/virt-win-reg.pl:79
26159 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
26160 " $ virt-win-reg Windows7 $cvkey ProductName\n"
26161 " Windows 7 Enterprise\n"
26166 #: ../tools/virt-win-reg.pl:83
26168 "With C<--merge>, you can merge a textual regedit file into the Windows "
26173 #: ../tools/virt-win-reg.pl:86
26176 " $ virt-win-reg --merge Windows7 changes.reg\n"
26181 #: ../tools/virt-win-reg.pl:88
26182 msgid "SUPPORTED SYSTEMS"
26186 #: ../tools/virt-win-reg.pl:90
26188 "The program currently supports Windows NT-derived guests starting with "
26189 "Windows XP through to at least Windows 7."
26193 #: ../tools/virt-win-reg.pl:93
26195 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
26196 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
26197 "and C<HKEY_USERS\\.DEFAULT>."
26201 #: ../tools/virt-win-reg.pl:97
26203 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
26208 #: ../tools/virt-win-reg.pl:100
26210 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
26215 #: ../tools/virt-win-reg.pl:103
26220 #: ../tools/virt-win-reg.pl:105
26222 "This program is only meant for simple access to the registry. If you want "
26223 "to do complicated things with the registry, we suggest you download the "
26224 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
26225 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
26226 "L<hivexregedit(1)>."
26230 #: ../tools/virt-win-reg.pl:111
26235 #: ../tools/virt-win-reg.pl:113
26237 "C<virt-win-reg> expects that regedit files have already been reencoded in "
26238 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
26239 "style line endings. Since Windows regedit files are often in UTF-16LE with "
26240 "Windows-style line endings, you may need to reencode the whole file before "
26241 "or after processing."
26245 #: ../tools/virt-win-reg.pl:119
26247 "To reencode a file from Windows format to Linux (before processing it with "
26248 "the C<--merge> option), you would do something like this:"
26252 #: ../tools/virt-win-reg.pl:122
26255 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
26260 #: ../tools/virt-win-reg.pl:124
26262 "To go in the opposite direction, after exporting and before sending the file "
26263 "to a Windows user, do something like this:"
26267 #: ../tools/virt-win-reg.pl:127
26270 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
26275 #: ../tools/virt-win-reg.pl:129
26276 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
26280 #: ../tools/virt-win-reg.pl:131
26282 "If you are unsure about the current encoding, use the L<file(1)> command. "
26283 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
26284 "style (CRLF) line endings, like this:"
26288 #: ../tools/virt-win-reg.pl:135
26291 " $ file software.reg\n"
26292 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
26293 " with CRLF line terminators\n"
26298 #: ../tools/virt-win-reg.pl:139
26299 msgid "This file would need conversion before you could C<--merge> it."
26303 #: ../tools/virt-win-reg.pl:143
26305 "Be careful when passing parameters containing C<\\> (backslash) in the "
26306 "shell. Usually you will have to use 'single quotes' or double backslashes "
26307 "(but not both) to protect them from the shell."
26311 #: ../tools/virt-win-reg.pl:147
26312 msgid "Paths and value names are case-insensitive."
26316 #: ../tools/virt-win-reg.pl:149
26317 msgid "CurrentControlSet etc."
26321 #: ../tools/virt-win-reg.pl:151
26323 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
26324 "Registry at the level of the hive file, and therefore you cannot modify "
26329 #: ../tools/virt-win-reg.pl:155
26331 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
26332 "circumstances it might refer to another control set. The way to find out is "
26333 "to look at the C<HKLM\\SYSTEM\\Select> key:"
26337 #: ../tools/virt-win-reg.pl:159
26340 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
26341 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
26342 " \"Current\"=dword:00000001\n"
26343 " \"Default\"=dword:00000001\n"
26344 " \"Failed\"=dword:00000000\n"
26345 " \"LastKnownGood\"=dword:00000002\n"
26350 #: ../tools/virt-win-reg.pl:166
26351 msgid "\"Current\" is the one which Windows will choose when it boots."
26355 #: ../tools/virt-win-reg.pl:168
26357 "Similarly, other C<Current...> keys in the path may need to be replaced."
26361 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
26366 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:501
26367 msgid "Enable debugging messages."
26371 #: ../tools/virt-win-reg.pl:232
26376 #: ../tools/virt-win-reg.pl:234
26378 "In merge mode, this merges a textual regedit file into the Windows Registry "
26379 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
26380 "displays or exports Registry entries instead."
26384 #: ../tools/virt-win-reg.pl:238
26386 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
26387 "result in disk corruption. However exporting (without this flag) is always "
26392 #: ../tools/virt-win-reg.pl:246
26393 msgid "B<--encoding> UTF-16LE|ASCII"
26397 #: ../tools/virt-win-reg.pl:248
26399 "When merging (only), you may need to specify the encoding for strings to be "
26400 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
26401 "(3)/ENCODING STRINGS>."
26405 #: ../tools/virt-win-reg.pl:252
26407 "The default is to use UTF-16LE, which should work with recent versions of "
26412 #: ../tools/virt-win-reg.pl:486
26414 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
26415 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
26416 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26420 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
26422 "When reporting bugs, please enable debugging and capture the I<complete> "
26427 #: ../tools/virt-win-reg.pl:504
26430 " export LIBGUESTFS_DEBUG=1\n"
26431 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
26436 #: ../tools/virt-win-reg.pl:507
26438 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
26443 #: ../tools/virt-df.pl:36
26444 msgid "virt-df - Display free space on virtual filesystems"
26448 #: ../tools/virt-df.pl:40
26451 " virt-df [--options]\n"
26456 #: ../tools/virt-df.pl:42
26459 " virt-df [--options] domname\n"
26464 #: ../tools/virt-df.pl:44
26467 " virt-df [--options] disk.img [disk.img ...]\n"
26472 #: ../tools/virt-df.pl:48
26474 "C<virt-df> is a command line tool to display free space on virtual machine "
26475 "filesystems. Unlike other tools, it doesn't just display the amount of "
26476 "space allocated to a virtual machine, but can look inside the virtual "
26477 "machine to see how much space is really being used."
26481 #: ../tools/virt-df.pl:53
26483 "It is like the L<df(1)> command, but for virtual machines, except that it "
26484 "also works for Windows virtual machines."
26488 #: ../tools/virt-df.pl:56
26490 "If used without any arguments, C<virt-df> checks with libvirt to get a list "
26491 "of all active and inactive guests, and performs a C<df>-type operation on "
26492 "each one in turn, printing out the results."
26496 #: ../tools/virt-df.pl:60
26498 "If used with any argument(s), C<virt-df> performs a C<df>-type operation on "
26499 "either the single named libvirt domain, or on the disk image(s) listed on "
26500 "the command line (which must all belong to a single VM). In this mode (with "
26501 "arguments), C<virt-df> will I<only work for a single guest>. If you want to "
26502 "run on multiple guests, then you have to invoke C<virt-df> multiple times."
26506 #: ../tools/virt-df.pl:67
26508 "Use the C<--csv> option to get a format which can be easily parsed by other "
26509 "programs. Other options are mostly similar to standard C<df> options. See "
26510 "below for the complete list."
26514 #: ../tools/virt-df.pl:107
26519 #: ../tools/virt-df.pl:109
26521 "Write out the results in CSV format (comma-separated values). This format "
26522 "can be imported easily into databases and spreadsheets, but read L</NOTE "
26523 "ABOUT CSV FORMAT> below."
26527 #: ../tools/virt-df.pl:134
26528 msgid "B<--human-readable> | B<-h>"
26532 #: ../tools/virt-df.pl:136
26533 msgid "Print sizes in human-readable format."
26537 #: ../tools/virt-df.pl:138
26538 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
26542 #: ../tools/virt-df.pl:144
26543 msgid "B<--inodes> | B<-i>"
26547 #: ../tools/virt-df.pl:146
26548 msgid "Print inodes instead of blocks."
26552 #: ../tools/virt-df.pl:152
26553 msgid "B<--one-per-guest>"
26557 #: ../tools/virt-df.pl:154
26559 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
26560 "disks from several guests to a single libguestfs appliance."
26564 #: ../tools/virt-df.pl:157
26565 msgid "You might use this option in the following circumstances:"
26569 #: ../tools/virt-df.pl:163
26571 "If you think an untrusted guest might actively try to exploit the libguestfs "
26572 "appliance kernel, then this prevents one guest from interfering with the "
26573 "stats printed for another guest."
26577 #: ../tools/virt-df.pl:169
26579 "If the kernel has a bug which stops it from accessing a filesystem in one "
26580 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
26581 "and report stats for further guests."
26585 #: ../tools/virt-df.pl:180
26590 #: ../tools/virt-df.pl:182
26592 "Print UUIDs instead of names. This is useful for following a guest even "
26593 "when the guest is migrated or renamed, or when two guests happen to have the "
26598 #: ../tools/virt-df.pl:186
26600 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
26601 "images, we still print the disk image name even when this option is "
26606 #: ../tools/virt-df.pl:609
26607 msgid "NOTE ABOUT CSV FORMAT"
26611 #: ../tools/virt-df.pl:611
26613 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
26614 "should be easy to parse, but it is definitely not easy to parse."
26618 #: ../tools/virt-df.pl:614
26620 "Myth: Just split fields at commas. Reality: This does I<not> work "
26621 "reliably. This example has two columns:"
26625 #: ../tools/virt-df.pl:617
26628 " \"foo,bar\",baz\n"
26633 #: ../tools/virt-df.pl:619
26635 "Myth: Read the file one line at a time. Reality: This does I<not> work "
26636 "reliably. This example has one row:"
26640 #: ../tools/virt-df.pl:622
26649 #: ../tools/virt-df.pl:625
26651 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
26652 "packaged in major Linux distributions)."
26656 #: ../tools/virt-df.pl:628
26658 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
26659 "or Python's built-in csv library)."
26663 #: ../tools/virt-df.pl:631
26664 msgid "Most spreadsheets and databases can import CSV directly."
26668 #: ../tools/virt-df.pl:642
26670 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
26671 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26675 #: ../tools/virt-ls.pl:34
26676 msgid "virt-ls - List files in a virtual machine"
26680 #: ../tools/virt-ls.pl:38
26683 " virt-ls [--options] domname directory\n"
26688 #: ../tools/virt-ls.pl:40
26691 " virt-ls [--options] disk.img [disk.img ...] directory\n"
26696 #: ../tools/virt-ls.pl:44
26698 "C<virt-ls> is a command line tool to list the names of files in a directory "
26699 "inside a virtual machine or disk image."
26703 #: ../tools/virt-ls.pl:47
26705 "C<virt-ls> is just a simple wrapper around L<libguestfs(3)> functionality. "
26706 "For more complex cases you should look at the L<guestfish(1)> tool."
26710 #: ../tools/virt-ls.pl:51
26712 "C<virt-ls> can be used in one of three modes: simple, long and recursive. A "
26713 "simple listing is like the ordinary L<ls(1)> command:"
26717 #: ../tools/virt-ls.pl:54
26720 " $ virt-ls myguest /\n"
26728 #: ../tools/virt-ls.pl:59
26729 msgid "With the C<-l> (C<--long>) option, C<virt-ls> shows more detail:"
26733 #: ../tools/virt-ls.pl:61
26736 " $ virt-ls -l myguest /\n"
26738 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
26739 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
26745 #: ../tools/virt-ls.pl:67
26747 "With the C<-R> (C<--recursive>) option, C<virt-ls> lists the names of files "
26748 "and directories recursively:"
26752 #: ../tools/virt-ls.pl:70
26755 " $ virt-ls -R myguest /tmp\n"
26763 #: ../tools/virt-ls.pl:75
26765 "You I<cannot> combine these options. To do more complicated things, use "
26770 #: ../tools/virt-ls.pl:131 ../tools/virt-list-filesystems.pl:103
26771 #: ../tools/virt-list-partitions.pl:112
26772 msgid "B<-l> | B<--long>"
26776 #: ../tools/virt-ls.pl:133
26777 msgid "B<-R> | B<--recursive>"
26781 #: ../tools/virt-ls.pl:135
26783 "Select the mode. With neither of these options, C<virt-ls> produces a "
26784 "simple, flat list of the files in the named directory."
26788 #: ../tools/virt-ls.pl:138
26790 "C<virt-ls -l> produces a \"long listing\", which shows more detail (just "
26791 "like the plain C<ls -l> command)."
26795 #: ../tools/virt-ls.pl:141
26797 "C<virt-ls -R> produces a recursive list of files starting at the named "
26798 "directory. See the documentation for L<guestfs(3)/guestfs_find> for precise "
26803 #: ../tools/virt-ls.pl:145
26804 msgid "You cannot combine these options."
26808 #: ../tools/virt-ls.pl:234
26810 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<Sys::"
26811 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
26816 #: ../tools/virt-ls.pl:249 ../tools/virt-list-filesystems.pl:204
26817 #: ../tools/virt-cat.pl:201 ../tools/virt-tar.pl:298
26818 msgid "Copyright (C) 2009 Red Hat Inc."
26822 #: ../tools/virt-resize.pl:42
26823 msgid "virt-resize - Resize a virtual machine disk"
26827 #: ../tools/virt-resize.pl:46
26830 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
26831 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
26832 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
26837 #: ../tools/virt-resize.pl:52
26839 "Virt-resize is a tool which can resize a virtual machine disk, making it "
26840 "larger or smaller overall, and resizing or deleting any partitions contained "
26845 #: ../tools/virt-resize.pl:56
26847 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
26848 "not> be used on live virtual machines - for consistent results, shut the "
26849 "virtual machine down before resizing it."
26853 #: ../tools/virt-resize.pl:60
26855 "If you are not familiar with the associated tools: L<virt-list-partitions(1)"
26856 ">, L<virt-list-filesystems(1)> and L<virt-df(1)>, we recommend you go and "
26857 "read those manual pages first."
26861 #: ../tools/virt-resize.pl:68
26863 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
26864 "fill the extra 5GB of space."
26868 #: ../tools/virt-resize.pl:71
26871 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
26872 " virt-list-partitions -lht olddisk\n"
26873 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
26874 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
26879 #: ../tools/virt-resize.pl:76
26881 "As above, but make the /boot partition 200MB bigger, while giving the "
26882 "remaining space to /dev/sda2:"
26886 #: ../tools/virt-resize.pl:79
26889 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
26894 #: ../tools/virt-resize.pl:81
26895 msgid "As above, but the output format will be uncompressed qcow2:"
26899 #: ../tools/virt-resize.pl:83
26902 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
26903 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
26908 #: ../tools/virt-resize.pl:86
26909 msgid "DETAILED USAGE"
26913 #: ../tools/virt-resize.pl:88
26914 msgid "EXPANDING A VIRTUAL MACHINE DISK"
26918 #: ../tools/virt-resize.pl:92
26919 msgid "1. Shut down the virtual machine"
26923 #: ../tools/virt-resize.pl:94
26924 msgid "2. Locate input disk image"
26928 #: ../tools/virt-resize.pl:96
26930 "Locate the input disk image (ie. the file or device on the host containing "
26931 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
26932 "dumpxml> like this to find the disk image name:"
26936 #: ../tools/virt-resize.pl:100
26939 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
26940 " Found 1 nodes:\n"
26942 " <source dev=\"/dev/vg/lv_guest\" />\n"
26947 #: ../tools/virt-resize.pl:105
26948 msgid "3. Look at current sizing"
26952 #: ../tools/virt-resize.pl:107
26954 "Use L<virt-list-partitions(1)> to display the current partitions and sizes:"
26958 #: ../tools/virt-resize.pl:110
26961 " # virt-list-partitions -lht /dev/vg/lv_guest\n"
26962 " /dev/sda1 ext3 101.9M\n"
26963 " /dev/sda2 pv 7.9G\n"
26964 " /dev/sda device 8.0G\n"
26969 #: ../tools/virt-resize.pl:115
26971 "(This example is a virtual machine with an 8 GB disk which we would like to "
26972 "expand up to 10 GB)."
26976 #: ../tools/virt-resize.pl:118
26977 msgid "4. Create output disk"
26981 #: ../tools/virt-resize.pl:120
26983 "Virt-resize cannot do in-place disk modifications. You have to have space "
26984 "to store the resized output disk."
26988 #: ../tools/virt-resize.pl:123
26990 "To store the resized disk image in a file, create a file of a suitable size:"
26994 #: ../tools/virt-resize.pl:126
26997 " # rm -f outdisk\n"
26998 " # truncate -s 10G outdisk\n"
27003 #: ../tools/virt-resize.pl:129
27004 msgid "Or use L<lvcreate(1)> to create a logical volume:"
27008 #: ../tools/virt-resize.pl:131
27011 " # lvcreate -L 10G -n lv_name vg_name\n"
27016 #: ../tools/virt-resize.pl:133
27017 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
27021 #: ../tools/virt-resize.pl:135
27024 " # virsh pool-list\n"
27025 " # virsh vol-create-as poolname newvol 10G\n"
27030 #: ../tools/virt-resize.pl:138
27035 #: ../tools/virt-resize.pl:140
27037 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
27038 "file) and the output disk. The output disk is the one created in the "
27043 #: ../tools/virt-resize.pl:144
27046 " # virt-resize indisk outdisk\n"
27051 #: ../tools/virt-resize.pl:146
27053 "This command just copies disk image C<indisk> to disk image C<outdisk> "
27054 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
27055 "larger, then an extra, empty partition is created at the end of the disk "
27056 "covering the extra space. If C<outdisk> is smaller, then it will give an "
27061 #: ../tools/virt-resize.pl:152
27063 "More realistically you'd want to expand existing partitions in the disk "
27064 "image by passing extra options (for the full list see the L</OPTIONS> "
27069 #: ../tools/virt-resize.pl:156
27071 "L</--expand> is the most useful option. It expands the named partition "
27072 "within the disk to fill any extra space:"
27076 #: ../tools/virt-resize.pl:159
27079 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
27084 #: ../tools/virt-resize.pl:161
27086 "(In this case, an extra partition is I<not> created at the end of the disk, "
27087 "because there will be no unused space)."
27091 #: ../tools/virt-resize.pl:164
27093 "L</--resize> is the other commonly used option. The following would "
27094 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
27095 "rest of the available space:"
27099 #: ../tools/virt-resize.pl:168
27102 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
27103 " indisk outdisk\n"
27108 #: ../tools/virt-resize.pl:171
27110 "If the expanded partition in the image contains a filesystem or LVM PV, then "
27111 "if virt-resize knows how, it will resize the contents, the equivalent of "
27112 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
27113 ">. However virt-resize does not know how to resize some filesystems, so you "
27114 "would have to online resize them after booting the guest. And virt-resize "
27115 "also does not resize anything inside an LVM PV, it just resizes the PV "
27116 "itself and leaves the user to resize any LVs inside that PV as desired."
27120 #: ../tools/virt-resize.pl:180
27121 msgid "Other options are covered below."
27125 #: ../tools/virt-resize.pl:182
27130 #: ../tools/virt-resize.pl:184
27131 msgid "Thoroughly test the new disk image I<before> discarding the old one."
27135 #: ../tools/virt-resize.pl:186
27136 msgid "If you are using libvirt, edit the XML to point at the new disk:"
27140 #: ../tools/virt-resize.pl:188
27143 " # virsh edit guestname\n"
27148 #: ../tools/virt-resize.pl:190
27150 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
27151 "html#elementsDisks>"
27155 #: ../tools/virt-resize.pl:193
27156 msgid "Then start up the domain with the new, resized disk:"
27160 #: ../tools/virt-resize.pl:195
27163 " # virsh start guestname\n"
27168 #: ../tools/virt-resize.pl:197
27170 "and check that it still works. See also the L</NOTES> section below for "
27171 "additional information."
27175 #: ../tools/virt-resize.pl:200
27176 msgid "7. Resize LVs etc inside the guest"
27180 #: ../tools/virt-resize.pl:202
27181 msgid "(This can also be done offline using L<guestfish(1)>)"
27185 #: ../tools/virt-resize.pl:204
27187 "Once the guest has booted you should see the new space available, at least "
27188 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
27189 "may need to resize LVs inside PVs, and also resize filesystem types that "
27190 "virt-resize does not know how to expand."
27194 #: ../tools/virt-resize.pl:211
27195 msgid "SHRINKING A VIRTUAL MACHINE DISK"
27199 #: ../tools/virt-resize.pl:213
27201 "Shrinking is somewhat more complex than expanding, and only an overview is "
27206 #: ../tools/virt-resize.pl:216
27208 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
27209 "filesystems). The user has to shrink content before passing the disk image "
27210 "to virt-resize, and virt-resize will check that the content has been shrunk "
27215 #: ../tools/virt-resize.pl:221
27216 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
27220 #: ../tools/virt-resize.pl:223
27222 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
27223 "steps 3 and 4 above to allocate a new disk image."
27227 #: ../tools/virt-resize.pl:226
27229 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
27233 #: ../tools/virt-resize.pl:229
27234 msgid "IGNORING OR DELETING PARTITIONS"
27238 #: ../tools/virt-resize.pl:231
27240 "virt-resize also gives a convenient way to ignore or delete partitions when "
27241 "copying from the input disk to the output disk. Ignoring a partition speeds "
27242 "up the copy where you don't care about the existing contents of a "
27243 "partition. Deleting a partition removes it completely, but note that it "
27244 "also renumbers any partitions after the one which is deleted, which can "
27245 "leave some guests unbootable."
27249 #: ../tools/virt-resize.pl:238
27250 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
27254 #: ../tools/virt-resize.pl:240
27256 "If the input disk is in qcow2 format, then you may prefer that the output is "
27257 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
27258 "the fly. The output format is simply determined by the format of the empty "
27259 "output container that you provide. Thus to create qcow2 output, use:"
27263 #: ../tools/virt-resize.pl:246
27266 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
27271 #: ../tools/virt-resize.pl:248
27272 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
27276 #: ../tools/virt-resize.pl:250
27277 msgid "Similarly, to get non-sparse raw output use:"
27281 #: ../tools/virt-resize.pl:252
27284 " fallocate -l size outdisk\n"
27289 #: ../tools/virt-resize.pl:254
27291 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
27292 "dev/zero of=outdisk bs=1M count=..>)"
27296 #: ../tools/virt-resize.pl:267
27297 msgid "Display help."
27301 #: ../tools/virt-resize.pl:281
27302 msgid "B<--resize part=size>"
27306 #: ../tools/virt-resize.pl:283
27308 "Resize the named partition (expanding or shrinking it) so that it has the "
27313 #: ../tools/virt-resize.pl:286
27315 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
27316 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
27317 "Exabytes; or as a percentage of the current size; or as a relative number or "
27318 "percentage. For example:"
27322 #: ../tools/virt-resize.pl:291
27325 " --resize /dev/sda2=10G\n"
27330 #: ../tools/virt-resize.pl:293
27333 " --resize /dev/sda4=90%\n"
27338 #: ../tools/virt-resize.pl:295
27341 " --resize /dev/sda2=+1G\n"
27346 #: ../tools/virt-resize.pl:297
27349 " --resize /dev/sda2=-200M\n"
27354 #: ../tools/virt-resize.pl:299
27357 " --resize /dev/sda1=+128K\n"
27362 #: ../tools/virt-resize.pl:301
27365 " --resize /dev/sda1=+10%\n"
27370 #: ../tools/virt-resize.pl:303
27373 " --resize /dev/sda1=-10%\n"
27378 #: ../tools/virt-resize.pl:305
27380 "You can increase the size of any partition. Virt-resize will expand the "
27381 "direct content of the partition if it knows how (see C<--expand> below)."
27385 #: ../tools/virt-resize.pl:309
27387 "You can only I<decrease> the size of partitions that contain filesystems or "
27388 "PVs which have already been shrunk. Virt-resize will check this has been "
27389 "done before proceeding, or else will print an error (see also C<--resize-"
27394 #: ../tools/virt-resize.pl:314 ../tools/virt-resize.pl:406
27395 #: ../tools/virt-resize.pl:423
27396 msgid "You can give this option multiple times."
27400 #: ../tools/virt-resize.pl:320
27401 msgid "B<--resize-force part=size>"
27405 #: ../tools/virt-resize.pl:322
27407 "This is the same as C<--resize> except that it will let you decrease the "
27408 "size of any partition. Generally this means you will lose any data which "
27409 "was at the end of the partition you shrink, but you may not care about that "
27410 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
27411 "as a swap partition)."
27415 #: ../tools/virt-resize.pl:328
27416 msgid "See also the C<--ignore> option."
27420 #: ../tools/virt-resize.pl:334
27421 msgid "B<--expand part>"
27425 #: ../tools/virt-resize.pl:336
27427 "Expand the named partition so it uses up all extra space (space left over "
27428 "after any other resize changes that you request have been done)."
27432 #: ../tools/virt-resize.pl:339
27434 "If virt-resize knows how, it will expand the direct content of the "
27435 "partition. For example, if the partition is an LVM PV, it will expand the "
27436 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
27437 "content it doesn't know about alone."
27441 #: ../tools/virt-resize.pl:344
27442 msgid "Currently virt-resize can resize:"
27446 #: ../tools/virt-resize.pl:350
27448 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
27453 #: ../tools/virt-resize.pl:355
27455 "NTFS filesystems contained directly in a partition, if libguestfs was "
27456 "compiled with support for NTFS."
27460 #: ../tools/virt-resize.pl:358
27462 "The filesystem must have been shut down consistently last time it was used. "
27463 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
27464 "consistency check, so at the first boot after resizing Windows will check "
27469 #: ../tools/virt-resize.pl:365
27471 "LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
27472 "inside the PV. The user will have to resize LVs as desired."
27476 #: ../tools/virt-resize.pl:371 ../tools/virt-resize.pl:393
27477 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
27481 #: ../tools/virt-resize.pl:377
27482 msgid "B<--shrink part>"
27486 #: ../tools/virt-resize.pl:379
27488 "Shrink the named partition until the overall disk image fits in the "
27489 "destination. The named partition B<must> contain a filesystem or PV which "
27490 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
27491 "online tools). Virt-resize will check this and give an error if it has not "
27496 #: ../tools/virt-resize.pl:385
27498 "The amount by which the overall disk must be shrunk (after carrying out all "
27499 "other operations requested by the user) is called the \"deficit\". For "
27500 "example, a straight copy (assume no other operations) from a 5GB disk image "
27501 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
27502 "would give an error unless the user specified a partition to shrink and that "
27503 "partition had more than a gigabyte of free space."
27507 #: ../tools/virt-resize.pl:399
27508 msgid "B<--ignore part>"
27512 #: ../tools/virt-resize.pl:401
27514 "Ignore the named partition. Effectively this means the partition is "
27515 "allocated on the destination disk, but the content is not copied across from "
27516 "the source disk. The content of the partition will be blank (all zero "
27521 #: ../tools/virt-resize.pl:412
27522 msgid "B<--delete part>"
27526 #: ../tools/virt-resize.pl:414
27528 "Delete the named partition. It would be more accurate to describe this as "
27529 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
27530 "the original disk image is left intact."
27534 #: ../tools/virt-resize.pl:418
27536 "Note that when you delete a partition, then anything contained in the "
27537 "partition is also deleted. Furthermore, this causes any partitions that "
27538 "come after to be I<renumbered>, which can easily make your guest unbootable."
27542 #: ../tools/virt-resize.pl:429
27543 msgid "B<--LV-expand logvol>"
27547 #: ../tools/virt-resize.pl:431
27549 "This takes the logical volume and, as a final step, expands it to fill all "
27550 "the space available in its volume group. A typical usage, assuming a Linux "
27551 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
27552 "lv_root> would be:"
27556 #: ../tools/virt-resize.pl:436
27559 " virt-resize indisk outdisk \\\n"
27560 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
27565 #: ../tools/virt-resize.pl:439
27567 "This would first expand the partition (and PV), and then expand the root "
27568 "device to fill the extra space in the PV."
27572 #: ../tools/virt-resize.pl:442
27574 "The contents of the LV are also resized if virt-resize knows how to do "
27575 "that. You can stop virt-resize from trying to expand the content by using "
27576 "the option C<--no-expand-content>."
27580 #: ../tools/virt-resize.pl:446
27581 msgid "Use L<virt-list-filesystems(1)> to list the filesystems in the guest."
27585 #: ../tools/virt-resize.pl:449
27587 "You can give this option multiple times, I<but> it doesn't make sense to do "
27588 "this unless the logical volumes you specify are all in different volume "
27593 #: ../tools/virt-resize.pl:457
27594 msgid "B<--no-copy-boot-loader>"
27598 #: ../tools/virt-resize.pl:459
27600 "By default, virt-resize copies over some sectors at the start of the disk "
27601 "(up to the beginning of the first partition). Commonly these sectors "
27602 "contain the Master Boot Record (MBR) and the boot loader, and are required "
27603 "in order for the guest to boot correctly."
27607 #: ../tools/virt-resize.pl:464
27609 "If you specify this flag, then this initial copy is not done. You may need "
27610 "to reinstall the boot loader in this case."
27614 #: ../tools/virt-resize.pl:472
27615 msgid "B<--no-extra-partition>"
27619 #: ../tools/virt-resize.pl:474
27621 "By default, virt-resize creates an extra partition if there is any extra, "
27622 "unused space after all resizing has happened. Use this option to prevent "
27623 "the extra partition from being created. If you do this then the extra space "
27624 "will be inaccessible until you run fdisk, parted, or some other partitioning "
27625 "tool in the guest."
27629 #: ../tools/virt-resize.pl:480
27631 "Note that if the surplus space is smaller than 10 MB, no extra partition "
27636 #: ../tools/virt-resize.pl:487
27637 msgid "B<--no-expand-content>"
27641 #: ../tools/virt-resize.pl:489
27643 "By default, virt-resize will try to expand the direct contents of "
27644 "partitions, if it knows how (see C<--expand> option above)."
27648 #: ../tools/virt-resize.pl:492
27650 "If you give the C<--no-expand-content> option then virt-resize will not "
27655 #: ../tools/virt-resize.pl:499
27656 msgid "B<-d> | B<--debug>"
27660 #: ../tools/virt-resize.pl:507
27661 msgid "B<-n> | B<--dryrun>"
27665 #: ../tools/virt-resize.pl:509
27666 msgid "Print a summary of what would be done, but don't do anything."
27670 #: ../tools/virt-resize.pl:515
27671 msgid "B<-q> | B<--quiet>"
27675 #: ../tools/virt-resize.pl:517
27676 msgid "Don't print the summary."
27680 #: ../tools/virt-resize.pl:525
27682 "Specify the format of the input disk image. If this flag is not given then "
27683 "it is auto-detected from the image itself."
27687 #: ../tools/virt-resize.pl:531
27689 "Note that this option I<does not> affect the output format. See L</QCOW2 "
27690 "AND NON-SPARSE RAW FORMATS>."
27694 #: ../tools/virt-resize.pl:538
27695 msgid "B<--output-format> raw"
27699 #: ../tools/virt-resize.pl:540
27701 "Specify the format of the output disk image. If this flag is not given then "
27702 "it is auto-detected from the image itself."
27706 #: ../tools/virt-resize.pl:546
27708 "Note that you still need to create the output disk with the right format. "
27709 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
27713 #: ../tools/virt-resize.pl:1422 ../tools/virt-rescue.pl:90
27718 #: ../tools/virt-resize.pl:1424
27719 msgid "\"Partition 1 does not end on cylinder boundary.\""
27723 #: ../tools/virt-resize.pl:1426
27725 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
27726 "means the partitions will not be aligned to the ancient CHS geometry. "
27727 "However CHS geometry is meaningless for disks manufactured since the early "
27728 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
27729 "cylinders is not required by any modern operating system."
27733 #: ../tools/virt-resize.pl:1433
27734 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
27738 #: ../tools/virt-resize.pl:1435
27740 "In Windows Vista and later versions, Microsoft switched to using a separate "
27741 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
27742 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
27743 "the boot partition. Doing so seems to break the guest completely. However "
27744 "expanding the second partition (ie. C: drive) should work."
27748 #: ../tools/virt-resize.pl:1442
27750 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
27751 "NTFS partitions have been expanded. This is just a safety check and (unless "
27752 "it find errors) is nothing to worry about."
27756 #: ../tools/virt-resize.pl:1446
27757 msgid "GUEST BOOT STUCK AT \"GRUB\""
27761 #: ../tools/virt-resize.pl:1448
27763 "If a Linux guest does not boot after resizing, and the boot is stuck after "
27764 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
27765 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
27766 "although we think is to do with partition alignment."
27770 #: ../tools/virt-resize.pl:1453
27773 " guestfish -i -a newdisk\n"
27774 " ><fs> cat /boot/grub/device.map\n"
27775 " # check the contents of this file are sensible or\n"
27776 " # edit the file if necessary\n"
27777 " ><fs> grub-install / /dev/vda\n"
27783 #: ../tools/virt-resize.pl:1460
27785 "For more flexible guest reconfiguration, including if you need to specify "
27786 "other parameters to grub-install, use L<virt-rescue(1)>."
27790 #: ../tools/virt-resize.pl:1463
27791 msgid "ALTERNATIVE TOOLS"
27795 #: ../tools/virt-resize.pl:1465
27797 "There are several proprietary tools for resizing partitions. We won't "
27798 "mention any here."
27802 #: ../tools/virt-resize.pl:1468
27804 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
27805 "operations on disk images. They can resize and move partitions, but I don't "
27806 "think they can do anything with the contents, and they certainly don't "
27811 #: ../tools/virt-resize.pl:1473
27813 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
27814 "but at a much lower level. You will probably end up hand-calculating sector "
27815 "offsets, which is something that virt-resize was designed to avoid. If you "
27816 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
27821 #: ../tools/virt-resize.pl:1488
27823 "L<virt-list-partitions(1)>, L<virt-list-filesystems(1)>, L<virt-df(1)>, "
27824 "L<guestfs(3)>, L<guestfish(1)>, L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, "
27825 "L<resize2fs(8)>, L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)"
27826 ">, L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
27827 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
27831 #: ../tools/virt-list-filesystems.pl:32
27833 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
27837 #: ../tools/virt-list-filesystems.pl:36
27840 " virt-list-filesystems [--options] domname\n"
27845 #: ../tools/virt-list-filesystems.pl:38
27848 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
27853 #: ../tools/virt-list-filesystems.pl:42
27855 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
27856 "are contained in a virtual machine or disk image."
27860 #: ../tools/virt-list-filesystems.pl:46
27862 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
27863 "functionality. For more complex cases you should look at the L<guestfish(1)"
27868 #: ../tools/virt-list-filesystems.pl:105
27870 "With this option, C<virt-list-filesystems> displays the type of each "
27871 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
27875 #: ../tools/virt-list-filesystems.pl:112
27876 msgid "B<-a> | B<--all>"
27880 #: ../tools/virt-list-filesystems.pl:114
27882 "Normally we only show mountable filesystems. If this option is given then "
27883 "swap devices are shown too."
27887 #: ../tools/virt-list-filesystems.pl:188
27889 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-list-"
27890 "partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)"
27891 ">, L<http://libguestfs.org/>."
27895 #: ../tools/virt-cat.pl:33
27896 msgid "virt-cat - Display a file in a virtual machine"
27900 #: ../tools/virt-cat.pl:37
27903 " virt-cat [--options] domname file\n"
27908 #: ../tools/virt-cat.pl:39
27911 " virt-cat [--options] disk.img [disk.img ...] file\n"
27916 #: ../tools/virt-cat.pl:43
27918 "C<virt-cat> is a command line tool to display the contents of C<file> where "
27919 "C<file> exists in the named virtual machine (or disk image)."
27923 #: ../tools/virt-cat.pl:46
27925 "C<virt-cat> can be used to quickly view a single file. To edit a file, use "
27926 "C<virt-edit>. For more complex cases you should look at the L<guestfish(1)> "
27931 #: ../tools/virt-cat.pl:52
27933 "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
27937 #: ../tools/virt-cat.pl:55
27940 " virt-cat mydomain /etc/fstab\n"
27945 #: ../tools/virt-cat.pl:57
27946 msgid "List syslog messages from a VM:"
27950 #: ../tools/virt-cat.pl:59
27953 " virt-cat mydomain /var/log/messages | tail\n"
27958 #: ../tools/virt-cat.pl:61
27959 msgid "Find out what DHCP IP address a VM acquired:"
27963 #: ../tools/virt-cat.pl:63
27966 " virt-cat mydomain /var/log/messages | grep 'dhclient: bound to' | tail\n"
27971 #: ../tools/virt-cat.pl:65
27972 msgid "Find out what packages were recently installed:"
27976 #: ../tools/virt-cat.pl:67
27979 " virt-cat mydomain /var/log/yum.log | tail\n"
27984 #: ../tools/virt-cat.pl:69
27985 msgid "Find out who is logged on inside a virtual machine:"
27989 #: ../tools/virt-cat.pl:71
27992 " virt-cat mydomain /var/run/utmp > /tmp/utmp\n"
27998 #: ../tools/virt-cat.pl:74
27999 msgid "or who was logged on:"
28003 #: ../tools/virt-cat.pl:76
28006 " virt-cat mydomain /var/log/wtmp > /tmp/wtmp\n"
28007 " last -f /tmp/wtmp\n"
28012 #: ../tools/virt-cat.pl:187
28014 "L<guestfs(3)>, L<guestfish(1)>, L<virt-edit(1)>, L<Sys::Guestfs(3)>, L<Sys::"
28015 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
28019 #: ../tools/virt-tar.pl:33
28020 msgid "virt-tar - Extract or upload files to a virtual machine"
28024 #: ../tools/virt-tar.pl:37
28027 " virt-tar [--options] -x domname directory tarball\n"
28032 #: ../tools/virt-tar.pl:39
28035 " virt-tar [--options] -u domname tarball directory\n"
28040 #: ../tools/virt-tar.pl:41
28043 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
28048 #: ../tools/virt-tar.pl:43
28051 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
28056 #: ../tools/virt-tar.pl:47
28057 msgid "Download C</home> from the VM into a local tarball:"
28061 #: ../tools/virt-tar.pl:49
28064 " virt-tar -x domname /home home.tar\n"
28069 #: ../tools/virt-tar.pl:51
28072 " virt-tar -zx domname /home home.tar.gz\n"
28077 #: ../tools/virt-tar.pl:53
28078 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
28082 #: ../tools/virt-tar.pl:55
28085 " virt-tar -u domname uploadstuff.tar /tmp\n"
28090 #: ../tools/virt-tar.pl:57
28093 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
28098 #: ../tools/virt-tar.pl:61
28100 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
28101 "virtual machines. If you do this, you risk disk corruption in the VM. "
28102 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
28106 #: ../tools/virt-tar.pl:66
28108 "You can use C<-x> (extract) on live virtual machines, but you might get "
28109 "inconsistent results or errors if there is filesystem activity inside the "
28110 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
28111 "work, but the only way to guarantee consistent results is if the virtual "
28112 "machine is shut down."
28116 #: ../tools/virt-tar.pl:74
28118 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
28119 "parts of a guest filesystem. There are many possibilities: making backups, "
28120 "uploading data files, snooping on guest activity, fixing or customizing "
28125 #: ../tools/virt-tar.pl:79
28127 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
28128 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
28129 "should look at the L<guestfish(1)> tool."
28133 #: ../tools/virt-tar.pl:83
28135 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
28136 "its contents (recursively) from the virtual machine into a local tarball. "
28137 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
28138 "virtual machine. You cannot use these two options together."
28142 #: ../tools/virt-tar.pl:89
28144 "In addition, you may need to use the C<-z> (gZip) option to enable "
28145 "compression. When uploading, you have to specify C<-z> if the upload file "
28146 "is compressed because virt-tar won't detect this on its own."
28150 #: ../tools/virt-tar.pl:93
28152 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
28153 "example it cannot do PKZip files or bzip2 compression. If you want that "
28154 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
28155 "the L<libguestfs(3)> API)."
28159 #: ../tools/virt-tar.pl:151
28160 msgid "B<-x> | B<--extract> | B<--download>"
28164 #: ../tools/virt-tar.pl:153
28165 msgid "B<-u> | B<--upload>"
28169 #: ../tools/virt-tar.pl:155
28171 "Use C<-x> to extract (download) a directory from a virtual machine to a "
28176 #: ../tools/virt-tar.pl:158
28178 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
28179 "Please read the L</WARNING> section above before using this option."
28183 #: ../tools/virt-tar.pl:162
28184 msgid "You must specify exactly one of these options."
28188 #: ../tools/virt-tar.pl:168
28189 msgid "B<-z> | B<--gzip>"
28193 #: ../tools/virt-tar.pl:170
28194 msgid "Specify that the input or output tarball is gzip-compressed."
28198 #: ../tools/virt-tar.pl:283
28200 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<Sys::"
28201 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
28206 #: ../tools/virt-rescue.pl:33
28207 msgid "virt-rescue - Run a rescue shell on a virtual machine"
28211 #: ../tools/virt-rescue.pl:37
28214 " virt-rescue [--options] domname\n"
28219 #: ../tools/virt-rescue.pl:39
28222 " virt-rescue [--options] disk.img [disk.img ...]\n"
28227 #: ../tools/virt-rescue.pl:43
28229 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
28230 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
28231 "you from doing this, but doesn't catch all cases."
28235 #: ../tools/virt-rescue.pl:47
28237 "However if you use the I<--ro> (read only) option, then you can attach a "
28238 "shell to a live virtual machine. The results might be strange or "
28239 "inconsistent at times but you won't get disk corruption."
28243 #: ../tools/virt-rescue.pl:53
28245 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
28246 "need for a CD. virt-rescue gives you a rescue shell and some simple "
28247 "recovery tools which you can use to examine or rescue a virtual machine or "
28252 #: ../tools/virt-rescue.pl:58
28254 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
28255 "on disk image(s):"
28259 #: ../tools/virt-rescue.pl:61
28262 " virt-rescue GuestName\n"
28267 #: ../tools/virt-rescue.pl:63
28270 " virt-rescue --ro /path/to/disk.img\n"
28275 #: ../tools/virt-rescue.pl:65
28278 " virt-rescue /dev/sdc\n"
28283 #: ../tools/virt-rescue.pl:67
28284 msgid "For live VMs you I<must> use the --ro option."
28288 #: ../tools/virt-rescue.pl:69
28290 "When you run virt-rescue on a virtual machine or disk image, you are placed "
28291 "in an interactive bash shell where you can use many ordinary Linux "
28292 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
28293 "appliance. You must mount the virtual machine's filesystems by hand. There "
28294 "is an empty directory called C</sysroot> where you can mount filesystems."
28298 #: ../tools/virt-rescue.pl:76
28300 "In the example below, we list logical volumes, then choose one to mount "
28301 "under C</sysroot>:"
28305 #: ../tools/virt-rescue.pl:79
28309 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
28310 " lv_root vg_f11x64 -wi-a- 8.83G\n"
28311 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
28312 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
28313 " ><rescue> ls /sysroot\n"
28318 #: ../tools/virt-rescue.pl:86
28320 "If you don't know what filesystems are available on the virtual machine then "
28321 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
28325 #: ../tools/virt-rescue.pl:92
28327 "Virt-rescue can be used on I<any> disk image file or device, not just a "
28328 "virtual machine. For example you can use it on a blank file if you want to "
28329 "partition that file (although we would recommend using L<guestfish(1)> "
28330 "instead as it is more suitable for this purpose). You can even use virt-"
28331 "rescue on things like SD cards."
28335 #: ../tools/virt-rescue.pl:98
28337 "This tool is just designed for quick interactive hacking on a virtual "
28338 "machine. For more structured access to a virtual machine disk image, you "
28339 "should use L<guestfs(3)>. To get a structured shell that you can use to "
28340 "make scripted changes to guests, use L<guestfish(1)>."
28344 #: ../tools/virt-rescue.pl:127
28345 msgid "B<--append kernelopts>"
28349 #: ../tools/virt-rescue.pl:129
28350 msgid "Pass additional options to the rescue kernel."
28354 #: ../tools/virt-rescue.pl:164
28355 msgid "B<--memsize MB> | B<-m MB>"
28359 #: ../tools/virt-rescue.pl:166
28361 "Change the amount of memory allocated to the rescue system. The default is "
28362 "set by libguestfs and is small but adequate for running system tools. The "
28363 "occasional program might need more memory. The parameter is specified in "
28368 #: ../tools/virt-rescue.pl:175
28369 msgid "B<--network MB>"
28373 #: ../tools/virt-rescue.pl:177
28374 msgid "Enable QEMU user networking in the guest."
28378 #: ../tools/virt-rescue.pl:183
28379 msgid "B<--ro> | B<-r>"
28383 #: ../tools/virt-rescue.pl:185
28384 msgid "Open the image read-only."
28388 #: ../tools/virt-rescue.pl:197
28390 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
28391 "SELINUX> before using this option."
28395 #: ../tools/virt-rescue.pl:257
28397 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
28398 "ENVIRONMENT VARIABLES> for the complete list."
28402 #: ../tools/virt-rescue.pl:269
28404 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
28405 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
28409 #: ../tools/virt-make-fs.pl:37
28410 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
28414 #: ../tools/virt-make-fs.pl:41
28417 " virt-make-fs [--options] input.tar output.img\n"
28422 #: ../tools/virt-make-fs.pl:43
28425 " virt-make-fs [--options] input.tar.gz output.img\n"
28430 #: ../tools/virt-make-fs.pl:45
28433 " virt-make-fs [--options] directory output.img\n"
28438 #: ../tools/virt-make-fs.pl:49
28440 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
28441 "archive or some files in a directory. It is similar to tools like L<mkisofs"
28442 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
28443 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
28444 "you want to attach these filesystems to existing virtual machines (eg. to "
28445 "import large amounts of read-only data to a VM)."
28449 #: ../tools/virt-make-fs.pl:57
28450 msgid "Basic usage is:"
28454 #: ../tools/virt-make-fs.pl:59
28457 " virt-make-fs input output\n"
28462 #: ../tools/virt-make-fs.pl:61
28464 "where C<input> is either a directory containing files that you want to add, "
28465 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
28466 "C<output> is a disk image. The input type is detected automatically. The "
28467 "output disk image defaults to a raw ext2 image unless you specify extra "
28468 "flags (see L</OPTIONS> below)."
28472 #: ../tools/virt-make-fs.pl:67
28473 msgid "EXTRA SPACE"
28477 #: ../tools/virt-make-fs.pl:69
28479 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
28480 "the files that it contains, but might have extra space. Depending on how "
28481 "you are going to use the output, you might think this extra space is wasted "
28482 "and want to minimize it, or you might want to leave space so that more files "
28483 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
28484 "but you can use the C<--size> flag to leave space in the filesystem if you "
28489 #: ../tools/virt-make-fs.pl:77
28491 "An alternative way to leave extra space but not make the output image any "
28492 "bigger is to use an alternative disk image format (instead of the default "
28493 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
28494 "image format (check your hypervisor supports this before using it). This "
28495 "allows you to choose a large C<--size> but the extra space won't actually be "
28496 "allocated in the image until you try to store something in it."
28500 #: ../tools/virt-make-fs.pl:85
28502 "Don't forget that you can also use local commands including L<resize2fs(8)> "
28503 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-"
28504 "resize to build another image from scratch."
28508 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
28509 #: ../tools/virt-make-fs.pl:142
28514 #: ../tools/virt-make-fs.pl:91
28517 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
28522 #: ../tools/virt-make-fs.pl:93
28523 msgid "FILESYSTEM TYPE"
28527 #: ../tools/virt-make-fs.pl:95
28529 "The default filesystem type is C<ext2>. Just about any filesystem type that "
28530 "libguestfs supports can be used (but I<not> read-only formats like "
28531 "ISO9660). Here are some of the more common choices:"
28535 #: ../tools/virt-make-fs.pl:101
28540 #: ../tools/virt-make-fs.pl:103
28542 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
28543 "you are not going to use the filesystem in a way that requires the journal, "
28544 "then this is just wasted overhead."
28548 #: ../tools/virt-make-fs.pl:107
28549 msgid "I<ntfs> or I<vfat>"
28553 #: ../tools/virt-make-fs.pl:109
28554 msgid "Useful if exporting data to a Windows guest."
28558 #: ../tools/virt-make-fs.pl:111
28560 "I<Note for vfat>: The tar archive or local directory must only contain files "
28561 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
28562 "program running within libguestfs is unable to change the ownership of non-"
28563 "root files, since vfat itself does not support this."
28567 #: ../tools/virt-make-fs.pl:116
28572 #: ../tools/virt-make-fs.pl:118
28574 "Lower overhead than C<ext2>, but certain limitations on filename length and "
28575 "total filesystem size."
28579 #: ../tools/virt-make-fs.pl:125
28582 " virt-make-fs --type=minix input minixfs.img\n"
28587 #: ../tools/virt-make-fs.pl:127
28588 msgid "TO PARTITION OR NOT TO PARTITION"
28592 #: ../tools/virt-make-fs.pl:129
28593 msgid "Optionally virt-make-fs can add a partition table to the output disk."
28597 #: ../tools/virt-make-fs.pl:131
28599 "Adding a partition can make the disk image more compatible with certain "
28600 "virtualized operating systems which don't expect to see a filesystem "
28601 "directly located on a block device (Linux doesn't care and will happily "
28602 "handle both types)."
28606 #: ../tools/virt-make-fs.pl:136
28608 "On the other hand, if you have a partition table then the output image is no "
28609 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
28610 "directly on a partitioned disk image. (However libguestfs tools such as "
28611 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
28615 #: ../tools/virt-make-fs.pl:144
28616 msgid "Add an MBR partition:"
28620 #: ../tools/virt-make-fs.pl:146
28623 " virt-make-fs --partition -- input disk.img\n"
28628 #: ../tools/virt-make-fs.pl:148
28630 "If the output disk image could be terabyte-sized or larger, it's better to "
28631 "use an EFI/GPT-compatible partition table:"
28635 #: ../tools/virt-make-fs.pl:151
28638 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
28643 #: ../tools/virt-make-fs.pl:179
28644 msgid "Enable debugging information."
28648 #: ../tools/virt-make-fs.pl:185
28649 msgid "B<--size=E<lt>NE<gt>>"
28653 #: ../tools/virt-make-fs.pl:187
28654 msgid "B<--size=+E<lt>NE<gt>>"
28658 #: ../tools/virt-make-fs.pl:189
28659 msgid "B<-s E<lt>NE<gt>>"
28663 #: ../tools/virt-make-fs.pl:191
28664 msgid "B<-s +E<lt>NE<gt>>"
28668 #: ../tools/virt-make-fs.pl:193
28670 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
28674 #: ../tools/virt-make-fs.pl:196
28676 "If this option is I<not> given, then the output image will be just large "
28677 "enough to contain all the files, with not much wasted space."
28681 #: ../tools/virt-make-fs.pl:199
28683 "To choose a fixed size output disk, specify an absolute number followed by b/"
28684 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28685 "Petabytes or Exabytes. This must be large enough to contain all the input "
28686 "files, else you will get an error."
28690 #: ../tools/virt-make-fs.pl:204
28692 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
28693 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28694 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
28695 "the input files, and (approximately) an extra 200 MB free space."
28699 #: ../tools/virt-make-fs.pl:210
28701 "Note that virt-make-fs estimates free space, and therefore will not produce "
28702 "filesystems containing precisely the free space requested. (It is much more "
28703 "expensive and time-consuming to produce a filesystem which has precisely the "
28704 "desired free space)."
28708 #: ../tools/virt-make-fs.pl:219
28709 msgid "B<--format=E<lt>fmtE<gt>>"
28713 #: ../tools/virt-make-fs.pl:221
28714 msgid "B<-F E<lt>fmtE<gt>>"
28718 #: ../tools/virt-make-fs.pl:223
28719 msgid "Choose the output disk image format."
28723 #: ../tools/virt-make-fs.pl:225
28724 msgid "The default is C<raw> (raw disk image)."
28728 #: ../tools/virt-make-fs.pl:227
28730 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
28731 "that would really make sense here is C<qcow2>."
28735 #: ../tools/virt-make-fs.pl:234
28736 msgid "B<--type=E<lt>fsE<gt>>"
28740 #: ../tools/virt-make-fs.pl:236
28741 msgid "B<-t E<lt>fsE<gt>>"
28745 #: ../tools/virt-make-fs.pl:238
28746 msgid "Choose the output filesystem type."
28750 #: ../tools/virt-make-fs.pl:240
28751 msgid "The default is C<ext2>."
28755 #: ../tools/virt-make-fs.pl:242
28757 "Any filesystem which is supported read-write by libguestfs can be used here."
28761 #: ../tools/virt-make-fs.pl:249
28762 msgid "B<--partition>"
28766 #: ../tools/virt-make-fs.pl:251
28767 msgid "B<--partition=E<lt>parttypeE<gt>>"
28771 #: ../tools/virt-make-fs.pl:253
28773 "If specified, this flag adds an MBR partition table to the output disk image."
28777 #: ../tools/virt-make-fs.pl:256
28779 "You can change the partition table type, eg. C<--partition=gpt> for large "
28784 #: ../tools/virt-make-fs.pl:259
28786 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
28787 "might consider the next parameter to be the partition type. For example:"
28791 #: ../tools/virt-make-fs.pl:263
28794 " virt-make-fs --partition input.tar ...\n"
28799 #: ../tools/virt-make-fs.pl:265
28801 "would cause virt-make-fs to think you wanted to use a partition type of "
28802 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
28803 "dash) between options and the input file argument:"
28807 #: ../tools/virt-make-fs.pl:269
28810 " virt-make-fs --partition -- input.tar ...\n"
28815 #: ../tools/virt-make-fs.pl:536
28817 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
28818 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
28819 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28823 #: ../tools/virt-make-fs.pl:553
28826 " export LIBGUESTFS_DEBUG=1\n"
28827 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
28832 #: ../tools/virt-make-fs.pl:556
28834 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
28839 #: ../tools/virt-list-partitions.pl:32
28841 "virt-list-partitions - List partitions in a virtual machine or disk image"
28845 #: ../tools/virt-list-partitions.pl:36
28848 " virt-list-partitions [--options] domname\n"
28853 #: ../tools/virt-list-partitions.pl:38
28856 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
28861 #: ../tools/virt-list-partitions.pl:42
28863 "C<virt-list-partitions> is a command line tool to list the partitions that "
28864 "are contained in a virtual machine or disk image. It is mainly useful as a "
28865 "first step to using L<virt-resize(1)>."
28869 #: ../tools/virt-list-partitions.pl:47
28871 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
28872 "functionality. For more complex cases you should look at the L<guestfish(1)"
28877 #: ../tools/virt-list-partitions.pl:104
28878 msgid "B<-h> | B<--human-readable>"
28882 #: ../tools/virt-list-partitions.pl:106
28883 msgid "Show sizes in human-readable form (eg. \"1G\")."
28887 #: ../tools/virt-list-partitions.pl:114
28889 "With this option, C<virt-list-partitions> displays the type and size of each "
28890 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
28894 #: ../tools/virt-list-partitions.pl:121
28895 msgid "B<-t> | B<--total>"
28899 #: ../tools/virt-list-partitions.pl:123
28901 "Display the total size of each block device (as a separate row or rows)."
28905 #: ../tools/virt-list-partitions.pl:256
28907 "L<guestfs(3)>, L<guestfish(1)>, L<virt-list-filesystems(1)>, L<virt-resize(1)"
28908 ">, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://"
28909 "libguestfs.org/>."