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-12 22:55+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-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-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-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-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:569 ../src/guestfs-actions.pod:577
791 #: ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591
792 #: ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591
793 #: ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599
794 #: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611
795 #: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625
796 #: ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633
797 #: ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775
798 #: ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785
799 #: ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850
800 #: ../src/guestfs-actions.pod:1855 ../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:375
804 #: ../fish/guestfish-actions.pod:383 ../fish/guestfish-actions.pod:390
805 #: ../fish/guestfish-actions.pod:397 ../fish/guestfish-actions.pod:1067
806 #: ../fish/guestfish-actions.pod:1071 ../fish/guestfish-actions.pod:1075
807 #: ../fish/guestfish-actions.pod:1079 ../fish/guestfish-actions.pod:1087
808 #: ../fish/guestfish-actions.pod:1091 ../fish/guestfish-actions.pod:1095
809 #: ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1109
810 #: ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1203
811 #: ../fish/guestfish-actions.pod:1207 ../fish/guestfish-actions.pod:1212
812 #: ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1259
813 #: ../fish/guestfish-actions.pod:1263 ../fish/guestfish-actions.pod:1268
814 #: ../inspector/virt-inspector.pl:550 ../inspector/virt-inspector.pl:554
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:1842 ../fish/guestfish-actions.pod:9
2548 #: ../fish/guestfish-actions.pod:1255
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:536 ../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-tar.pl:281
3817 #: ../tools/virt-rescue.pl:267 ../tools/virt-make-fs.pl:534
3818 #: ../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:546
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:560 ../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-tar.pl:296
3916 #: ../tools/virt-rescue.pl:281 ../tools/virt-make-fs.pl:563
3917 #: ../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:126
3997 #: ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224
3998 #: ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259
3999 #: ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293
4000 #: ../src/guestfs-actions.pod:408 ../src/guestfs-actions.pod:428
4001 #: ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:487
4002 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:533
4003 #: ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:633
4004 #: ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:662
4005 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779
4006 #: ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807
4007 #: ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:988
4008 #: ../src/guestfs-actions.pod:1006 ../src/guestfs-actions.pod:1090
4009 #: ../src/guestfs-actions.pod:1108 ../src/guestfs-actions.pod:1127
4010 #: ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1161
4011 #: ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1262
4012 #: ../src/guestfs-actions.pod:1287 ../src/guestfs-actions.pod:1324
4013 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1464
4014 #: ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1704
4015 #: ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:2213
4016 #: ../src/guestfs-actions.pod:2357 ../src/guestfs-actions.pod:2418
4017 #: ../src/guestfs-actions.pod:2453 ../src/guestfs-actions.pod:3045
4018 #: ../src/guestfs-actions.pod:3060 ../src/guestfs-actions.pod:3080
4019 #: ../src/guestfs-actions.pod:3205 ../src/guestfs-actions.pod:3219
4020 #: ../src/guestfs-actions.pod:3232 ../src/guestfs-actions.pod:3246
4021 #: ../src/guestfs-actions.pod:3261 ../src/guestfs-actions.pod:3297
4022 #: ../src/guestfs-actions.pod:3369 ../src/guestfs-actions.pod:3389
4023 #: ../src/guestfs-actions.pod:3406 ../src/guestfs-actions.pod:3429
4024 #: ../src/guestfs-actions.pod:3452 ../src/guestfs-actions.pod:3484
4025 #: ../src/guestfs-actions.pod:3503 ../src/guestfs-actions.pod:3522
4026 #: ../src/guestfs-actions.pod:3557 ../src/guestfs-actions.pod:3569
4027 #: ../src/guestfs-actions.pod:3605 ../src/guestfs-actions.pod:3621
4028 #: ../src/guestfs-actions.pod:3634 ../src/guestfs-actions.pod:3649
4029 #: ../src/guestfs-actions.pod:3666 ../src/guestfs-actions.pod:3759
4030 #: ../src/guestfs-actions.pod:3779 ../src/guestfs-actions.pod:3792
4031 #: ../src/guestfs-actions.pod:3843 ../src/guestfs-actions.pod:3861
4032 #: ../src/guestfs-actions.pod:3879 ../src/guestfs-actions.pod:3895
4033 #: ../src/guestfs-actions.pod:3909 ../src/guestfs-actions.pod:3923
4034 #: ../src/guestfs-actions.pod:3940 ../src/guestfs-actions.pod:3955
4035 #: ../src/guestfs-actions.pod:3975 ../src/guestfs-actions.pod:4024
4036 #: ../src/guestfs-actions.pod:4055 ../src/guestfs-actions.pod:4074
4037 #: ../src/guestfs-actions.pod:4093 ../src/guestfs-actions.pod:4105
4038 #: ../src/guestfs-actions.pod:4122 ../src/guestfs-actions.pod:4135
4039 #: ../src/guestfs-actions.pod:4150 ../src/guestfs-actions.pod:4165
4040 #: ../src/guestfs-actions.pod:4200 ../src/guestfs-actions.pod:4215
4041 #: ../src/guestfs-actions.pod:4235 ../src/guestfs-actions.pod:4249
4042 #: ../src/guestfs-actions.pod:4266 ../src/guestfs-actions.pod:4315
4043 #: ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:4366
4044 #: ../src/guestfs-actions.pod:4394 ../src/guestfs-actions.pod:4411
4045 #: ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:4563
4046 #: ../src/guestfs-actions.pod:4620 ../src/guestfs-actions.pod:4642
4047 #: ../src/guestfs-actions.pod:4660 ../src/guestfs-actions.pod:4692
4048 #: ../src/guestfs-actions.pod:4758 ../src/guestfs-actions.pod:4775
4049 #: ../src/guestfs-actions.pod:4788 ../src/guestfs-actions.pod:4802
4050 #: ../src/guestfs-actions.pod:5091 ../src/guestfs-actions.pod:5110
4051 #: ../src/guestfs-actions.pod:5124 ../src/guestfs-actions.pod:5136
4052 #: ../src/guestfs-actions.pod:5150 ../src/guestfs-actions.pod:5162
4053 #: ../src/guestfs-actions.pod:5176 ../src/guestfs-actions.pod:5192
4054 #: ../src/guestfs-actions.pod:5213 ../src/guestfs-actions.pod:5232
4055 #: ../src/guestfs-actions.pod:5251 ../src/guestfs-actions.pod:5269
4056 #: ../src/guestfs-actions.pod:5292 ../src/guestfs-actions.pod:5310
4057 #: ../src/guestfs-actions.pod:5329 ../src/guestfs-actions.pod:5350
4058 #: ../src/guestfs-actions.pod:5369 ../src/guestfs-actions.pod:5386
4059 #: ../src/guestfs-actions.pod:5414 ../src/guestfs-actions.pod:5438
4060 #: ../src/guestfs-actions.pod:5457 ../src/guestfs-actions.pod:5481
4061 #: ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:5511
4062 #: ../src/guestfs-actions.pod:5530 ../src/guestfs-actions.pod:5567
4063 #: ../src/guestfs-actions.pod:5590 ../src/guestfs-actions.pod:5616
4064 #: ../src/guestfs-actions.pod:5724 ../src/guestfs-actions.pod:5845
4065 #: ../src/guestfs-actions.pod:5857 ../src/guestfs-actions.pod:5870
4066 #: ../src/guestfs-actions.pod:5883 ../src/guestfs-actions.pod:5905
4067 #: ../src/guestfs-actions.pod:5918 ../src/guestfs-actions.pod:5931
4068 #: ../src/guestfs-actions.pod:5944 ../src/guestfs-actions.pod:5959
4069 #: ../src/guestfs-actions.pod:6018 ../src/guestfs-actions.pod:6035
4070 #: ../src/guestfs-actions.pod:6051 ../src/guestfs-actions.pod:6067
4071 #: ../src/guestfs-actions.pod:6084 ../src/guestfs-actions.pod:6097
4072 #: ../src/guestfs-actions.pod:6117 ../src/guestfs-actions.pod:6153
4073 #: ../src/guestfs-actions.pod:6167 ../src/guestfs-actions.pod:6208
4074 #: ../src/guestfs-actions.pod:6221 ../src/guestfs-actions.pod:6239
4075 #: ../src/guestfs-actions.pod:6268 ../src/guestfs-actions.pod:6299
4076 #: ../src/guestfs-actions.pod:6418 ../src/guestfs-actions.pod:6436
4077 #: ../src/guestfs-actions.pod:6450 ../src/guestfs-actions.pod:6505
4078 #: ../src/guestfs-actions.pod:6518 ../src/guestfs-actions.pod:6563
4079 #: ../src/guestfs-actions.pod:6596 ../src/guestfs-actions.pod:6650
4080 #: ../src/guestfs-actions.pod:6676 ../src/guestfs-actions.pod:6742
4081 #: ../src/guestfs-actions.pod:6761 ../src/guestfs-actions.pod:6790
4082 msgid "This function returns 0 on success or -1 on error."
4086 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240
4087 #: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:28
4088 #: ../fish/guestfish-actions.pod:153 ../fish/guestfish-actions.pod:167
4090 "This function is deprecated. In new code, use the C<add_drive_opts> call "
4095 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243
4096 #: ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435
4097 #: ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1942
4098 #: ../src/guestfs-actions.pod:6684 ../src/guestfs-actions.pod:6853
4099 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:156
4100 #: ../fish/guestfish-actions.pod:170 ../fish/guestfish-actions.pod:951
4101 #: ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1322
4102 #: ../fish/guestfish-actions.pod:4423 ../fish/guestfish-actions.pod:4520
4104 "Deprecated functions will not be removed from the API, but the fact that "
4105 "they are deprecated indicates that there are problems with correct use of "
4110 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128
4111 #: ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1893
4112 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2094
4113 #: ../src/guestfs-actions.pod:3047 ../src/guestfs-actions.pod:3062
4114 #: ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:5271
4115 #: ../src/guestfs-actions.pod:5388 ../src/guestfs-actions.pod:5498
4116 #: ../src/guestfs-actions.pod:5961 ../src/guestfs-actions.pod:6086
4117 #: ../src/guestfs-actions.pod:6598
4118 msgid "(Added in 0.3)"
4122 #: ../src/guestfs-actions.pod:41
4123 msgid "guestfs_add_domain"
4127 #: ../src/guestfs-actions.pod:43
4131 " guestfs_add_domain (guestfs_h *g,\n"
4132 " const char *dom,\n"
4138 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137
4140 "You may supply a list of optional arguments to this call. Use zero or more "
4141 "of the following pairs of parameters, and terminate the list with C<-1> on "
4142 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
4146 #: ../src/guestfs-actions.pod:53
4149 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
4150 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
4151 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
4156 #: ../src/guestfs-actions.pod:57
4158 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
4159 "It works by connecting to libvirt, requesting the domain and domain XML from "
4160 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
4165 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
4167 "The number of disks added is returned. This operation is atomic: if an "
4168 "error is returned, then no disks are added."
4172 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
4174 "This function does some minimal checks to make sure the libvirt domain is "
4175 "not running (unless C<readonly> is true). In a future version we will try "
4176 "to acquire the libvirt lock on each disk."
4180 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
4182 "Disks must be accessible locally. This often means that adding disks from a "
4183 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
4184 "unless those disks are accessible via the same device path locally too."
4188 #: ../src/guestfs-actions.pod:74
4190 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
4191 "libvirt.org/uri.html>). If this is not set then we connect to the default "
4192 "libvirt URI (or one set through an environment variable, see the libvirt "
4193 "documentation for full details). If you are using the C API directly then "
4194 "it is more flexible to create the libvirt connection object yourself, get "
4195 "the domain object, and call C<guestfs_add_libvirt_dom>."
4199 #: ../src/guestfs-actions.pod:82
4201 "The other optional parameters are passed directly through to "
4202 "C<guestfs_add_drive_opts>."
4206 #: ../src/guestfs-actions.pod:85 ../src/guestfs-actions.pod:336
4207 #: ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:679
4208 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728
4209 #: ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:1307
4210 #: ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1864
4211 #: ../src/guestfs-actions.pod:1963 ../src/guestfs-actions.pod:2003
4212 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2081
4213 #: ../src/guestfs-actions.pod:2344 ../src/guestfs-actions.pod:2602
4214 #: ../src/guestfs-actions.pod:2623 ../src/guestfs-actions.pod:4338
4215 #: ../src/guestfs-actions.pod:4466 ../src/guestfs-actions.pod:4872
4216 #: ../src/guestfs-actions.pod:4898 ../src/guestfs-actions.pod:6194
4217 #: ../src/guestfs-actions.pod:6609 ../src/guestfs-actions.pod:6622
4218 #: ../src/guestfs-actions.pod:6635
4219 msgid "On error this function returns -1."
4223 #: ../src/guestfs-actions.pod:87
4224 msgid "guestfs_add_domain_va"
4228 #: ../src/guestfs-actions.pod:89
4232 " guestfs_add_domain_va (guestfs_h *g,\n"
4233 " const char *dom,\n"
4239 #: ../src/guestfs-actions.pod:94
4240 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
4244 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107
4245 #: ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211
4246 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4250 #: ../src/guestfs-actions.pod:98
4251 msgid "guestfs_add_domain_argv"
4255 #: ../src/guestfs-actions.pod:100
4259 " guestfs_add_domain_argv (guestfs_h *g,\n"
4260 " const char *dom,\n"
4261 " const struct guestfs_add_domain_argv *optargs);\n"
4266 #: ../src/guestfs-actions.pod:105
4267 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
4271 #: ../src/guestfs-actions.pod:109
4272 msgid "guestfs_add_drive"
4276 #: ../src/guestfs-actions.pod:111
4280 " guestfs_add_drive (guestfs_h *g,\n"
4281 " const char *filename);\n"
4286 #: ../src/guestfs-actions.pod:115
4288 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
4289 "optional parameters, so the disk is added writable, with the format being "
4290 "detected automatically."
4294 #: ../src/guestfs-actions.pod:119
4296 "Automatic detection of the format opens you up to a potential security hole "
4297 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4298 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4299 "you should think about replacing calls to this function with calls to "
4300 "C<guestfs_add_drive_opts>, and specifying the format."
4304 #: ../src/guestfs-actions.pod:130
4305 msgid "guestfs_add_drive_opts"
4309 #: ../src/guestfs-actions.pod:132
4313 " guestfs_add_drive_opts (guestfs_h *g,\n"
4314 " const char *filename,\n"
4320 #: ../src/guestfs-actions.pod:142
4323 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
4324 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
4325 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
4330 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:92
4332 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4333 "The first time you call this function, the disk appears as C</dev/sda>, the "
4334 "second time as C</dev/sdb>, and so on."
4338 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:97
4340 "You don't necessarily need to be root when using libguestfs. However you "
4341 "obviously do need sufficient permissions to access the filename for whatever "
4342 "operations you want to perform (ie. read access if you just want to read the "
4343 "image or write access if you want to modify the image)."
4347 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:103
4348 msgid "This call checks that C<filename> exists."
4352 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:105
4353 msgid "The optional arguments are:"
4357 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:109
4362 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:111
4364 "If true then the image is treated as read-only. Writes are still allowed, "
4365 "but they are stored in a temporary snapshot overlay which is discarded at "
4366 "the end. The disk that you add is not modified."
4370 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:115
4375 #: ../src/guestfs-actions.pod:171
4377 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4378 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4379 "Possible formats include C<raw> and C<qcow2>."
4383 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:121
4385 "Automatic detection of the format opens you up to a potential security hole "
4386 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4387 "RHBZ#642934. Specifying the format closes this security hole."
4391 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:126
4396 #: ../src/guestfs-actions.pod:182
4398 "This rarely-used option lets you emulate the behaviour of the deprecated "
4399 "C<guestfs_add_drive_with_if> call (q.v.)"
4403 #: ../src/guestfs-actions.pod:189
4404 msgid "(Added in 1.5.23)"
4408 #: ../src/guestfs-actions.pod:191
4409 msgid "guestfs_add_drive_opts_va"
4413 #: ../src/guestfs-actions.pod:193
4417 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
4418 " const char *filename,\n"
4424 #: ../src/guestfs-actions.pod:198
4425 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4429 #: ../src/guestfs-actions.pod:202
4430 msgid "guestfs_add_drive_opts_argv"
4434 #: ../src/guestfs-actions.pod:204
4438 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4439 " const char *filename,\n"
4440 " const struct guestfs_add_drive_opts_argv *optargs);\n"
4445 #: ../src/guestfs-actions.pod:209
4446 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4450 #: ../src/guestfs-actions.pod:213
4451 msgid "guestfs_add_drive_ro"
4455 #: ../src/guestfs-actions.pod:215
4459 " guestfs_add_drive_ro (guestfs_h *g,\n"
4460 " const char *filename);\n"
4465 #: ../src/guestfs-actions.pod:219
4467 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4468 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4469 "disk is added read-only, with the format being detected automatically."
4473 #: ../src/guestfs-actions.pod:226
4474 msgid "(Added in 1.0.38)"
4478 #: ../src/guestfs-actions.pod:228
4479 msgid "guestfs_add_drive_ro_with_if"
4483 #: ../src/guestfs-actions.pod:230
4487 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4488 " const char *filename,\n"
4489 " const char *iface);\n"
4494 #: ../src/guestfs-actions.pod:235
4496 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4497 "QEMU interface emulation to use at run time."
4501 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268
4502 #: ../src/guestfs-actions.pod:2303
4503 msgid "(Added in 1.0.84)"
4507 #: ../src/guestfs-actions.pod:249
4508 msgid "guestfs_add_drive_with_if"
4512 #: ../src/guestfs-actions.pod:251
4516 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4517 " const char *filename,\n"
4518 " const char *iface);\n"
4523 #: ../src/guestfs-actions.pod:256
4525 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4526 "QEMU interface emulation to use at run time."
4530 #: ../src/guestfs-actions.pod:270
4531 msgid "guestfs_aug_clear"
4535 #: ../src/guestfs-actions.pod:272
4539 " guestfs_aug_clear (guestfs_h *g,\n"
4540 " const char *augpath);\n"
4545 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:178
4547 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4548 "L<augtool(1)> C<clear> command."
4552 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2083
4553 msgid "(Added in 1.3.4)"
4557 #: ../src/guestfs-actions.pod:283
4558 msgid "guestfs_aug_close"
4562 #: ../src/guestfs-actions.pod:285
4566 " guestfs_aug_close (guestfs_h *g);\n"
4571 #: ../src/guestfs-actions.pod:288
4573 "Close the current Augeas handle and free up any resources used by it. After "
4574 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4575 "any other Augeas functions."
4579 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320
4580 #: ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352
4581 #: ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430
4582 #: ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:475
4583 #: ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503
4584 #: ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535
4585 #: ../src/guestfs-actions.pod:4949
4586 msgid "(Added in 0.7)"
4590 #: ../src/guestfs-actions.pod:297
4591 msgid "guestfs_aug_defnode"
4595 #: ../src/guestfs-actions.pod:299
4598 " struct guestfs_int_bool *\n"
4599 " guestfs_aug_defnode (guestfs_h *g,\n"
4600 " const char *name,\n"
4601 " const char *expr,\n"
4602 " const char *val);\n"
4607 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:194
4609 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4613 #: ../src/guestfs-actions.pod:308
4615 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4616 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4617 "containing that single node."
4621 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:201
4623 "On success this returns a pair containing the number of nodes in the "
4624 "nodeset, and a boolean flag if a node was created."
4628 #: ../src/guestfs-actions.pod:316
4630 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4631 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4635 #: ../src/guestfs-actions.pod:322
4636 msgid "guestfs_aug_defvar"
4640 #: ../src/guestfs-actions.pod:324
4644 " guestfs_aug_defvar (guestfs_h *g,\n"
4645 " const char *name,\n"
4646 " const char *expr);\n"
4651 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:209
4653 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4654 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4658 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:213
4660 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4661 "evaluates to something which is not a nodeset."
4665 #: ../src/guestfs-actions.pod:340
4666 msgid "guestfs_aug_get"
4670 #: ../src/guestfs-actions.pod:342
4674 " guestfs_aug_get (guestfs_h *g,\n"
4675 " const char *augpath);\n"
4680 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:220
4682 "Look up the value associated with C<path>. If C<path> matches exactly one "
4683 "node, the C<value> is returned."
4687 #: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:849
4688 #: ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:927
4689 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1046
4690 #: ../src/guestfs-actions.pod:1176 ../src/guestfs-actions.pod:1193
4691 #: ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1341
4692 #: ../src/guestfs-actions.pod:1532 ../src/guestfs-actions.pod:1644
4693 #: ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824
4694 #: ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1936
4695 #: ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2268
4696 #: ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2548
4697 #: ../src/guestfs-actions.pod:2684 ../src/guestfs-actions.pod:2713
4698 #: ../src/guestfs-actions.pod:2735 ../src/guestfs-actions.pod:2791
4699 #: ../src/guestfs-actions.pod:2814 ../src/guestfs-actions.pod:3191
4700 #: ../src/guestfs-actions.pod:3541 ../src/guestfs-actions.pod:3711
4701 #: ../src/guestfs-actions.pod:3821 ../src/guestfs-actions.pod:4484
4702 #: ../src/guestfs-actions.pod:4677 ../src/guestfs-actions.pod:4847
4703 #: ../src/guestfs-actions.pod:5025 ../src/guestfs-actions.pod:5074
4704 #: ../src/guestfs-actions.pod:5637 ../src/guestfs-actions.pod:5653
4705 #: ../src/guestfs-actions.pod:5670 ../src/guestfs-actions.pod:5694
4706 #: ../src/guestfs-actions.pod:6358 ../src/guestfs-actions.pod:6377
4707 #: ../src/guestfs-actions.pod:6395 ../src/guestfs-actions.pod:6575
4708 #: ../src/guestfs-actions.pod:6847
4710 "This function returns a string, or NULL on error. I<The caller must free "
4711 "the returned string after use>."
4715 #: ../src/guestfs-actions.pod:354
4716 msgid "guestfs_aug_init"
4720 #: ../src/guestfs-actions.pod:356
4724 " guestfs_aug_init (guestfs_h *g,\n"
4725 " const char *root,\n"
4731 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:227
4733 "Create a new Augeas handle for editing configuration files. If there was "
4734 "any previous Augeas handle associated with this guestfs session, then it is "
4739 #: ../src/guestfs-actions.pod:365
4740 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4744 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:234
4746 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4750 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:237
4752 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4753 "logical I<or> of the following integers:"
4757 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:243
4758 msgid "C<AUG_SAVE_BACKUP> = 1"
4762 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:245
4763 msgid "Keep the original file with a C<.augsave> extension."
4767 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:247
4768 msgid "C<AUG_SAVE_NEWFILE> = 2"
4772 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:249
4774 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4775 "original. Overrides C<AUG_SAVE_BACKUP>."
4779 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:252
4780 msgid "C<AUG_TYPE_CHECK> = 4"
4784 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:254
4785 msgid "Typecheck lenses (can be expensive)."
4789 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:256
4790 msgid "C<AUG_NO_STDINC> = 8"
4794 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:258
4795 msgid "Do not use standard load path for modules."
4799 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:260
4800 msgid "C<AUG_SAVE_NOOP> = 16"
4804 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:262
4805 msgid "Make save a no-op, just record what would have been changed."
4809 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:264
4810 msgid "C<AUG_NO_LOAD> = 32"
4814 #: ../src/guestfs-actions.pod:400
4815 msgid "Do not load the tree in C<guestfs_aug_init>."
4819 #: ../src/guestfs-actions.pod:404
4820 msgid "To close the handle, you can call C<guestfs_aug_close>."
4824 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:272
4825 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4829 #: ../src/guestfs-actions.pod:412
4830 msgid "guestfs_aug_insert"
4834 #: ../src/guestfs-actions.pod:414
4838 " guestfs_aug_insert (guestfs_h *g,\n"
4839 " const char *augpath,\n"
4840 " const char *label,\n"
4846 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:278
4848 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4849 "or after C<path> (depending on the boolean flag C<before>)."
4853 #: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:282
4855 "C<path> must match exactly one existing node in the tree, and C<label> must "
4856 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4860 #: ../src/guestfs-actions.pod:432
4861 msgid "guestfs_aug_load"
4865 #: ../src/guestfs-actions.pod:434
4869 " guestfs_aug_load (guestfs_h *g);\n"
4874 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:290
4875 msgid "Load files into the tree."
4879 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:292
4880 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4884 #: ../src/guestfs-actions.pod:446
4885 msgid "guestfs_aug_ls"
4889 #: ../src/guestfs-actions.pod:448
4893 " guestfs_aug_ls (guestfs_h *g,\n"
4894 " const char *augpath);\n"
4899 #: ../src/guestfs-actions.pod:452
4901 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
4902 "sorting the resulting nodes into alphabetical order."
4906 #: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:471
4907 #: ../src/guestfs-actions.pod:617 ../src/guestfs-actions.pod:1065
4908 #: ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1375
4909 #: ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1497
4910 #: ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:2148
4911 #: ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:2183
4912 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:2250
4913 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2370
4914 #: ../src/guestfs-actions.pod:2573 ../src/guestfs-actions.pod:2754
4915 #: ../src/guestfs-actions.pod:2856 ../src/guestfs-actions.pod:3111
4916 #: ../src/guestfs-actions.pod:3173 ../src/guestfs-actions.pod:3278
4917 #: ../src/guestfs-actions.pod:3683 ../src/guestfs-actions.pod:4299
4918 #: ../src/guestfs-actions.pod:4819 ../src/guestfs-actions.pod:4945
4919 #: ../src/guestfs-actions.pod:5059 ../src/guestfs-actions.pod:5710
4920 #: ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5826
4921 #: ../src/guestfs-actions.pod:5972 ../src/guestfs-actions.pod:5996
4922 #: ../src/guestfs-actions.pod:6468 ../src/guestfs-actions.pod:6488
4923 #: ../src/guestfs-actions.pod:6535 ../src/guestfs-actions.pod:6700
4924 #: ../src/guestfs-actions.pod:6719 ../src/guestfs-actions.pod:6804
4925 #: ../src/guestfs-actions.pod:6823 ../src/guestfs-actions.pod:6869
4926 #: ../src/guestfs-actions.pod:6888
4928 "This function returns a NULL-terminated array of strings (like L<environ(3)"
4929 ">), or NULL if there was an error. I<The caller must free the strings and "
4930 "the array after use>."
4934 #: ../src/guestfs-actions.pod:459 ../src/guestfs-actions.pod:990
4935 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1413
4936 #: ../src/guestfs-actions.pod:2934 ../src/guestfs-actions.pod:2965
4937 #: ../src/guestfs-actions.pod:3524 ../src/guestfs-actions.pod:3574
4938 #: ../src/guestfs-actions.pod:3761 ../src/guestfs-actions.pod:3794
4939 #: ../src/guestfs-actions.pod:3957 ../src/guestfs-actions.pod:4303
4940 #: ../src/guestfs-actions.pod:4760 ../src/guestfs-actions.pod:5138
4941 #: ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5164
4942 #: ../src/guestfs-actions.pod:5572 ../src/guestfs-actions.pod:6210
4943 #: ../src/guestfs-actions.pod:6223 ../src/guestfs-actions.pod:6452
4944 #: ../src/guestfs-actions.pod:6655 ../src/guestfs-actions.pod:6688
4945 msgid "(Added in 0.8)"
4949 #: ../src/guestfs-actions.pod:461
4950 msgid "guestfs_aug_match"
4954 #: ../src/guestfs-actions.pod:463
4958 " guestfs_aug_match (guestfs_h *g,\n"
4959 " const char *augpath);\n"
4964 #: ../src/guestfs-actions.pod:467 ../fish/guestfish-actions.pod:306
4966 "Returns a list of paths which match the path expression C<path>. The "
4967 "returned paths are sufficiently qualified so that they match exactly one "
4968 "node in the current tree."
4972 #: ../src/guestfs-actions.pod:477
4973 msgid "guestfs_aug_mv"
4977 #: ../src/guestfs-actions.pod:479
4981 " guestfs_aug_mv (guestfs_h *g,\n"
4982 " const char *src,\n"
4983 " const char *dest);\n"
4988 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:314
4990 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4991 "C<dest> is overwritten if it exists."
4995 #: ../src/guestfs-actions.pod:491
4996 msgid "guestfs_aug_rm"
5000 #: ../src/guestfs-actions.pod:493
5004 " guestfs_aug_rm (guestfs_h *g,\n"
5005 " const char *augpath);\n"
5010 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:321
5011 msgid "Remove C<path> and all of its children."
5015 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:323
5016 msgid "On success this returns the number of entries which were removed."
5020 #: ../src/guestfs-actions.pod:505
5021 msgid "guestfs_aug_save"
5025 #: ../src/guestfs-actions.pod:507
5029 " guestfs_aug_save (guestfs_h *g);\n"
5034 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:329
5035 msgid "This writes all pending changes to disk."
5039 #: ../src/guestfs-actions.pod:512
5041 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5046 #: ../src/guestfs-actions.pod:519
5047 msgid "guestfs_aug_set"
5051 #: ../src/guestfs-actions.pod:521
5055 " guestfs_aug_set (guestfs_h *g,\n"
5056 " const char *augpath,\n"
5057 " const char *val);\n"
5062 #: ../src/guestfs-actions.pod:526 ../fish/guestfish-actions.pod:338
5063 msgid "Set the value associated with C<path> to C<val>."
5067 #: ../src/guestfs-actions.pod:528
5069 "In the Augeas API, it is possible to clear a node by setting the value to "
5070 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5071 "this call. Instead you must use the C<guestfs_aug_clear> call."
5075 #: ../src/guestfs-actions.pod:537
5076 msgid "guestfs_available"
5080 #: ../src/guestfs-actions.pod:539
5084 " guestfs_available (guestfs_h *g,\n"
5085 " char *const *groups);\n"
5090 #: ../src/guestfs-actions.pod:543 ../fish/guestfish-actions.pod:349
5092 "This command is used to check the availability of some groups of "
5093 "functionality in the appliance, which not all builds of the libguestfs "
5094 "appliance will be able to provide."
5098 #: ../src/guestfs-actions.pod:547
5100 "The libguestfs groups, and the functions that those groups correspond to, "
5101 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5102 "runtime by calling C<guestfs_available_all_groups>."
5106 #: ../src/guestfs-actions.pod:552 ../fish/guestfish-actions.pod:358
5108 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
5109 "\"]> would check for the availability of the Linux inotify functions and "
5110 "Augeas (configuration file editing) functions."
5114 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:363
5115 msgid "The command returns no error if I<all> requested groups are available."
5119 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:365
5121 "It fails with an error if one or more of the requested groups is unavailable "
5126 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:368
5128 "If an unknown group name is included in the list of groups then an error is "
5133 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:371
5138 #: ../src/guestfs-actions.pod:571
5139 msgid "You must call C<guestfs_launch> before calling this function."
5143 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:379
5145 "The reason is because we don't know what groups are supported by the "
5146 "appliance/daemon until it is running and can be queried."
5150 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:385
5152 "If a group of functions is available, this does not necessarily mean that "
5153 "they will work. You still have to check for errors when calling individual "
5154 "API functions even if they are available."
5158 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:392
5160 "It is usually the job of distro packagers to build complete functionality "
5161 "into the libguestfs appliance. Upstream libguestfs, if built from source "
5162 "with all requirements satisfied, will support everything."
5166 #: ../src/guestfs-actions.pod:593
5168 "This call was added in version C<1.0.80>. In previous versions of "
5169 "libguestfs all you could do would be to speculatively execute a command to "
5170 "find out if the daemon implemented it. See also C<guestfs_version>."
5174 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:1163
5175 msgid "(Added in 1.0.80)"
5179 #: ../src/guestfs-actions.pod:604
5180 msgid "guestfs_available_all_groups"
5184 #: ../src/guestfs-actions.pod:606
5188 " guestfs_available_all_groups (guestfs_h *g);\n"
5193 #: ../src/guestfs-actions.pod:609
5195 "This command returns a list of all optional groups that this daemon knows "
5196 "about. Note this returns both supported and unsupported groups. To find "
5197 "out which ones the daemon can actually support you have to call "
5198 "C<guestfs_available> on each member of the returned list."
5202 #: ../src/guestfs-actions.pod:615
5203 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
5207 #: ../src/guestfs-actions.pod:621
5208 msgid "(Added in 1.3.15)"
5212 #: ../src/guestfs-actions.pod:623
5213 msgid "guestfs_base64_in"
5217 #: ../src/guestfs-actions.pod:625
5221 " guestfs_base64_in (guestfs_h *g,\n"
5222 " const char *base64file,\n"
5223 " const char *filename);\n"
5228 #: ../src/guestfs-actions.pod:630 ../fish/guestfish-actions.pod:422
5230 "This command uploads base64-encoded data from C<base64file> to C<filename>."
5234 #: ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649
5235 msgid "(Added in 1.3.5)"
5239 #: ../src/guestfs-actions.pod:637
5240 msgid "guestfs_base64_out"
5244 #: ../src/guestfs-actions.pod:639
5248 " guestfs_base64_out (guestfs_h *g,\n"
5249 " const char *filename,\n"
5250 " const char *base64file);\n"
5255 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:431
5257 "This command downloads the contents of C<filename>, writing it out to local "
5258 "file C<base64file> encoded as base64."
5262 #: ../src/guestfs-actions.pod:651
5263 msgid "guestfs_blockdev_flushbufs"
5267 #: ../src/guestfs-actions.pod:653
5271 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
5272 " const char *device);\n"
5277 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:440
5279 "This tells the kernel to flush internal buffers associated with C<device>."
5283 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:677
5284 #: ../src/guestfs-actions.pod:692 ../src/guestfs-actions.pod:708
5285 #: ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:745
5286 #: ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:777
5287 #: ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805
5288 #: ../fish/guestfish-actions.pod:443 ../fish/guestfish-actions.pod:454
5289 #: ../fish/guestfish-actions.pod:463 ../fish/guestfish-actions.pod:473
5290 #: ../fish/guestfish-actions.pod:485 ../fish/guestfish-actions.pod:498
5291 #: ../fish/guestfish-actions.pod:506 ../fish/guestfish-actions.pod:517
5292 #: ../fish/guestfish-actions.pod:525 ../fish/guestfish-actions.pod:533
5293 msgid "This uses the L<blockdev(8)> command."
5297 #: ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:681
5298 #: ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:712
5299 #: ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749
5300 #: ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781
5301 #: ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809
5302 msgid "(Added in 0.9.3)"
5306 #: ../src/guestfs-actions.pod:666
5307 msgid "guestfs_blockdev_getbsz"
5311 #: ../src/guestfs-actions.pod:668
5315 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
5316 " const char *device);\n"
5321 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:449
5322 msgid "This returns the block size of a device."
5326 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:774
5327 #: ../fish/guestfish-actions.pod:451 ../fish/guestfish-actions.pod:514
5329 "(Note this is different from both I<size in blocks> and I<filesystem block "
5334 #: ../src/guestfs-actions.pod:683
5335 msgid "guestfs_blockdev_getro"
5339 #: ../src/guestfs-actions.pod:685
5343 " guestfs_blockdev_getro (guestfs_h *g,\n"
5344 " const char *device);\n"
5349 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:460
5351 "Returns a boolean indicating if the block device is read-only (true if read-"
5352 "only, false if not)."
5356 #: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:1396
5357 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:1891
5358 #: ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:1974
5359 #: ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2044
5360 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2092
5361 #: ../src/guestfs-actions.pod:2873 ../src/guestfs-actions.pod:2887
5362 #: ../src/guestfs-actions.pod:2902 ../src/guestfs-actions.pod:2916
5363 #: ../src/guestfs-actions.pod:2932 ../src/guestfs-actions.pod:2947
5364 #: ../src/guestfs-actions.pod:2963 ../src/guestfs-actions.pod:2977
5365 #: ../src/guestfs-actions.pod:2990 ../src/guestfs-actions.pod:3004
5366 #: ../src/guestfs-actions.pod:3019 ../src/guestfs-actions.pod:3034
5367 #: ../src/guestfs-actions.pod:4448
5368 msgid "This function returns a C truth value on success or -1 on error."
5372 #: ../src/guestfs-actions.pod:698
5373 msgid "guestfs_blockdev_getsize64"
5377 #: ../src/guestfs-actions.pod:700
5381 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
5382 " const char *device);\n"
5387 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:469
5388 msgid "This returns the size of the device in bytes."
5392 #: ../src/guestfs-actions.pod:706
5393 msgid "See also C<guestfs_blockdev_getsz>."
5397 #: ../src/guestfs-actions.pod:714
5398 msgid "guestfs_blockdev_getss"
5402 #: ../src/guestfs-actions.pod:716
5406 " guestfs_blockdev_getss (guestfs_h *g,\n"
5407 " const char *device);\n"
5412 #: ../src/guestfs-actions.pod:720 ../fish/guestfish-actions.pod:479
5414 "This returns the size of sectors on a block device. Usually 512, but can be "
5415 "larger for modern devices."
5419 #: ../src/guestfs-actions.pod:723
5421 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
5426 #: ../src/guestfs-actions.pod:732
5427 msgid "guestfs_blockdev_getsz"
5431 #: ../src/guestfs-actions.pod:734
5435 " guestfs_blockdev_getsz (guestfs_h *g,\n"
5436 " const char *device);\n"
5441 #: ../src/guestfs-actions.pod:738 ../fish/guestfish-actions.pod:491
5443 "This returns the size of the device in units of 512-byte sectors (even if "
5444 "the sectorsize isn't 512 bytes ... weird)."
5448 #: ../src/guestfs-actions.pod:741
5450 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
5451 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
5455 #: ../src/guestfs-actions.pod:751
5456 msgid "guestfs_blockdev_rereadpt"
5460 #: ../src/guestfs-actions.pod:753
5464 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5465 " const char *device);\n"
5470 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:504
5471 msgid "Reread the partition table on C<device>."
5475 #: ../src/guestfs-actions.pod:765
5476 msgid "guestfs_blockdev_setbsz"
5480 #: ../src/guestfs-actions.pod:767
5484 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5485 " const char *device,\n"
5486 " int blocksize);\n"
5491 #: ../src/guestfs-actions.pod:772 ../fish/guestfish-actions.pod:512
5492 msgid "This sets the block size of a device."
5496 #: ../src/guestfs-actions.pod:783
5497 msgid "guestfs_blockdev_setro"
5501 #: ../src/guestfs-actions.pod:785
5505 " guestfs_blockdev_setro (guestfs_h *g,\n"
5506 " const char *device);\n"
5511 #: ../src/guestfs-actions.pod:789 ../fish/guestfish-actions.pod:523
5512 msgid "Sets the block device named C<device> to read-only."
5516 #: ../src/guestfs-actions.pod:797
5517 msgid "guestfs_blockdev_setrw"
5521 #: ../src/guestfs-actions.pod:799
5525 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5526 " const char *device);\n"
5531 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:531
5532 msgid "Sets the block device named C<device> to read-write."
5536 #: ../src/guestfs-actions.pod:811
5537 msgid "guestfs_case_sensitive_path"
5541 #: ../src/guestfs-actions.pod:813
5545 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5546 " const char *path);\n"
5551 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:539
5553 "This can be used to resolve case insensitive paths on a filesystem which is "
5554 "case sensitive. The use case is to resolve paths which you have read from "
5555 "Windows configuration files or the Windows Registry, to the true path."
5559 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:544
5561 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5562 "(and probably others), which is that although the underlying filesystem is "
5563 "case-insensitive, the driver exports the filesystem to Linux as case-"
5568 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:549
5570 "One consequence of this is that special directories such as C<c:\\windows> "
5571 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5572 "precise details of how they were created. In Windows itself this would not "
5577 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:555
5579 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
5584 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:558
5586 "This function resolves the true case of each element in the path and returns "
5587 "the case-sensitive path."
5591 #: ../src/guestfs-actions.pod:839
5593 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
5594 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5595 "how the directories were originally created under Windows)."
5599 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:566
5600 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5604 #: ../src/guestfs-actions.pod:847
5605 msgid "See also C<guestfs_realpath>."
5609 #: ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:6380
5610 msgid "(Added in 1.0.75)"
5614 #: ../src/guestfs-actions.pod:854
5619 #: ../src/guestfs-actions.pod:856
5623 " guestfs_cat (guestfs_h *g,\n"
5624 " const char *path);\n"
5629 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:4935
5630 #: ../fish/guestfish-actions.pod:575 ../fish/guestfish-actions.pod:3267
5631 msgid "Return the contents of the file named C<path>."
5635 #: ../src/guestfs-actions.pod:862
5637 "Note that this function cannot correctly handle binary files (specifically, "
5638 "files containing C<\\0> character which is treated as end of string). For "
5639 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5640 "functions which have a more complex interface."
5644 #: ../src/guestfs-actions.pod:870 ../src/guestfs-actions.pod:1049
5645 #: ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1360
5646 #: ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1482
5647 #: ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1750
5648 #: ../src/guestfs-actions.pod:2168 ../src/guestfs-actions.pod:2187
5649 #: ../src/guestfs-actions.pod:2230 ../src/guestfs-actions.pod:2254
5650 #: ../src/guestfs-actions.pod:2271 ../src/guestfs-actions.pod:2300
5651 #: ../src/guestfs-actions.pod:4717 ../src/guestfs-actions.pod:4743
5652 #: ../src/guestfs-actions.pod:4874 ../src/guestfs-actions.pod:4900
5653 #: ../src/guestfs-actions.pod:4924 ../src/guestfs-actions.pod:5775
5654 #: ../src/guestfs-actions.pod:5830 ../src/guestfs-actions.pod:5976
5655 #: ../src/guestfs-actions.pod:6000 ../src/guestfs-actions.pod:6652
5656 #: ../src/guestfs-actions.pod:6678 ../src/guestfs-actions.pod:6704
5657 #: ../src/guestfs-actions.pod:6723 ../src/guestfs-actions.pod:6808
5658 #: ../src/guestfs-actions.pod:6827 ../src/guestfs-actions.pod:6873
5659 #: ../src/guestfs-actions.pod:6892 ../fish/guestfish-actions.pod:582
5660 #: ../fish/guestfish-actions.pod:717 ../fish/guestfish-actions.pod:729
5661 #: ../fish/guestfish-actions.pod:905 ../fish/guestfish-actions.pod:915
5662 #: ../fish/guestfish-actions.pod:982 ../fish/guestfish-actions.pod:992
5663 #: ../fish/guestfish-actions.pod:1187 ../fish/guestfish-actions.pod:1462
5664 #: ../fish/guestfish-actions.pod:1472 ../fish/guestfish-actions.pod:1500
5665 #: ../fish/guestfish-actions.pod:1515 ../fish/guestfish-actions.pod:1525
5666 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:3137
5667 #: ../fish/guestfish-actions.pod:3152 ../fish/guestfish-actions.pod:3228
5668 #: ../fish/guestfish-actions.pod:3245 ../fish/guestfish-actions.pod:3260
5669 #: ../fish/guestfish-actions.pod:3843 ../fish/guestfish-actions.pod:3889
5670 #: ../fish/guestfish-actions.pod:3974 ../fish/guestfish-actions.pod:3989
5671 #: ../fish/guestfish-actions.pod:4399 ../fish/guestfish-actions.pod:4417
5672 #: ../fish/guestfish-actions.pod:4434 ../fish/guestfish-actions.pod:4444
5673 #: ../fish/guestfish-actions.pod:4492 ../fish/guestfish-actions.pod:4502
5674 #: ../fish/guestfish-actions.pod:4531 ../fish/guestfish-actions.pod:4541
5676 "Because of the message protocol, there is a transfer limit of somewhere "
5677 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5681 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:3115
5682 #: ../src/guestfs-actions.pod:3177 ../src/guestfs-actions.pod:3194
5683 #: ../src/guestfs-actions.pod:3282 ../src/guestfs-actions.pod:3687
5684 #: ../src/guestfs-actions.pod:3701 ../src/guestfs-actions.pod:4823
5685 #: ../src/guestfs-actions.pod:4837 ../src/guestfs-actions.pod:6539
5686 #: ../src/guestfs-actions.pod:6553
5687 msgid "(Added in 0.4)"
5691 #: ../src/guestfs-actions.pod:875
5692 msgid "guestfs_checksum"
5696 #: ../src/guestfs-actions.pod:877
5700 " guestfs_checksum (guestfs_h *g,\n"
5701 " const char *csumtype,\n"
5702 " const char *path);\n"
5707 #: ../src/guestfs-actions.pod:882 ../fish/guestfish-actions.pod:589
5709 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5713 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:592
5715 "The type of checksum to compute is given by the C<csumtype> parameter which "
5716 "must have one of the following values:"
5720 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:597
5725 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:599
5727 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5732 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:602
5737 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:604
5738 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5742 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:606
5747 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:608
5748 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5752 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:610
5757 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:612
5758 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5762 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:614
5767 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:616
5768 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5772 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:618
5777 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:620
5778 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5782 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:622
5787 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:624
5788 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5792 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:628
5793 msgid "The checksum is returned as a printable string."
5797 #: ../src/guestfs-actions.pod:923
5798 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
5802 #: ../src/guestfs-actions.pod:925
5803 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
5807 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:1238
5808 #: ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:2889
5809 #: ../src/guestfs-actions.pod:2918 ../src/guestfs-actions.pod:2979
5810 #: ../src/guestfs-actions.pod:3006 ../src/guestfs-actions.pod:6241
5811 msgid "(Added in 1.0.2)"
5815 #: ../src/guestfs-actions.pod:932
5816 msgid "guestfs_checksum_device"
5820 #: ../src/guestfs-actions.pod:934
5824 " guestfs_checksum_device (guestfs_h *g,\n"
5825 " const char *csumtype,\n"
5826 " const char *device);\n"
5831 #: ../src/guestfs-actions.pod:939
5833 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5834 "device named C<device>. For the types of checksums supported see the "
5835 "C<guestfs_checksum> command."
5839 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:4354
5840 #: ../src/guestfs-actions.pod:4413 ../src/guestfs-actions.pod:4450
5841 #: ../src/guestfs-actions.pod:4468 ../src/guestfs-actions.pod:4644
5842 #: ../src/guestfs-actions.pod:6155 ../src/guestfs-actions.pod:6169
5843 #: ../src/guestfs-actions.pod:6565
5844 msgid "(Added in 1.3.2)"
5848 #: ../src/guestfs-actions.pod:948
5849 msgid "guestfs_checksums_out"
5853 #: ../src/guestfs-actions.pod:950
5857 " guestfs_checksums_out (guestfs_h *g,\n"
5858 " const char *csumtype,\n"
5859 " const char *directory,\n"
5860 " const char *sumsfile);\n"
5865 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:646
5867 "This command computes the checksums of all regular files in C<directory> and "
5868 "then emits a list of those checksums to the local output file C<sumsfile>."
5872 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:650
5874 "This can be used for verifying the integrity of a virtual machine. However "
5875 "to be properly secure you should pay attention to the output of the checksum "
5876 "command (it uses the ones from GNU coreutils). In particular when the "
5877 "filename is not printable, coreutils uses a special backslash syntax. For "
5878 "more information, see the GNU coreutils info file."
5882 #: ../src/guestfs-actions.pod:970
5883 msgid "(Added in 1.3.7)"
5887 #: ../src/guestfs-actions.pod:972
5888 msgid "guestfs_chmod"
5892 #: ../src/guestfs-actions.pod:974
5896 " guestfs_chmod (guestfs_h *g,\n"
5898 " const char *path);\n"
5903 #: ../src/guestfs-actions.pod:979 ../fish/guestfish-actions.pod:664
5905 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5910 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:667
5912 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5913 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5918 #: ../src/guestfs-actions.pod:986 ../src/guestfs-actions.pod:3938
5919 #: ../src/guestfs-actions.pod:4053 ../src/guestfs-actions.pod:4072
5920 #: ../src/guestfs-actions.pod:4091 ../fish/guestfish-actions.pod:671
5921 #: ../fish/guestfish-actions.pod:2627 ../fish/guestfish-actions.pod:2712
5922 #: ../fish/guestfish-actions.pod:2722 ../fish/guestfish-actions.pod:2732
5923 msgid "The mode actually set is affected by the umask."
5927 #: ../src/guestfs-actions.pod:992
5928 msgid "guestfs_chown"
5932 #: ../src/guestfs-actions.pod:994
5936 " guestfs_chown (guestfs_h *g,\n"
5939 " const char *path);\n"
5944 #: ../src/guestfs-actions.pod:1000 ../fish/guestfish-actions.pod:677
5945 msgid "Change the file owner to C<owner> and group to C<group>."
5949 #: ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:3076
5950 #: ../fish/guestfish-actions.pod:679 ../fish/guestfish-actions.pod:2105
5952 "Only numeric uid and gid are supported. If you want to use names, you will "
5953 "need to locate and parse the password file yourself (Augeas support makes "
5954 "this relatively easy)."
5958 #: ../src/guestfs-actions.pod:1010
5959 msgid "guestfs_command"
5963 #: ../src/guestfs-actions.pod:1012
5967 " guestfs_command (guestfs_h *g,\n"
5968 " char *const *arguments);\n"
5973 #: ../src/guestfs-actions.pod:1016 ../fish/guestfish-actions.pod:687
5975 "This call runs a command from the guest filesystem. The filesystem must be "
5976 "mounted, and must contain a compatible operating system (ie. something "
5977 "Linux, with the same or compatible processor architecture)."
5981 #: ../src/guestfs-actions.pod:1021
5983 "The single parameter is an argv-style list of arguments. The first element "
5984 "is the name of the program to run. Subsequent elements are parameters. The "
5985 "list must be non-empty (ie. must contain a program name). Note that the "
5986 "command runs directly, and is I<not> invoked via the shell (see "
5991 #: ../src/guestfs-actions.pod:1028 ../fish/guestfish-actions.pod:699
5992 msgid "The return value is anything printed to I<stdout> by the command."
5996 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:702
5998 "If the command returns a non-zero exit status, then this function returns an "
5999 "error message. The error message string is the content of I<stderr> from "
6004 #: ../src/guestfs-actions.pod:1035 ../fish/guestfish-actions.pod:706
6006 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
6007 "bin>. If you require a program from another location, you should provide "
6008 "the full path in the first parameter."
6012 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:711
6014 "Shared libraries and data files required by the program must be available on "
6015 "filesystems which are mounted in the correct places. It is the caller's "
6016 "responsibility to ensure all filesystems that are needed are mounted at the "
6021 #: ../src/guestfs-actions.pod:1052 ../src/guestfs-actions.pod:1072
6022 #: ../src/guestfs-actions.pod:1535
6023 msgid "(Added in 0.9.1)"
6027 #: ../src/guestfs-actions.pod:1054
6028 msgid "guestfs_command_lines"
6032 #: ../src/guestfs-actions.pod:1056
6036 " guestfs_command_lines (guestfs_h *g,\n"
6037 " char *const *arguments);\n"
6042 #: ../src/guestfs-actions.pod:1060
6044 "This is the same as C<guestfs_command>, but splits the result into a list of "
6049 #: ../src/guestfs-actions.pod:1063
6050 msgid "See also: C<guestfs_sh_lines>"
6054 #: ../src/guestfs-actions.pod:1074
6055 msgid "guestfs_config"
6059 #: ../src/guestfs-actions.pod:1076
6063 " guestfs_config (guestfs_h *g,\n"
6064 " const char *qemuparam,\n"
6065 " const char *qemuvalue);\n"
6070 #: ../src/guestfs-actions.pod:1081 ../fish/guestfish-actions.pod:736
6072 "This can be used to add arbitrary qemu command line parameters of the form "
6073 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
6074 "setting some parameters which would interfere with parameters that we use."
6078 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:741
6079 msgid "The first character of C<param> string must be a C<-> (dash)."
6083 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:743
6084 msgid "C<value> can be NULL."
6088 #: ../src/guestfs-actions.pod:1094
6089 msgid "guestfs_copy_size"
6093 #: ../src/guestfs-actions.pod:1096
6097 " guestfs_copy_size (guestfs_h *g,\n"
6098 " const char *src,\n"
6099 " const char *dest,\n"
6105 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:749
6107 "This command copies exactly C<size> bytes from one source device or file "
6108 "C<src> to another destination device or file C<dest>."
6112 #: ../src/guestfs-actions.pod:1105 ../fish/guestfish-actions.pod:752
6114 "Note this will fail if the source is too short or if the destination is not "
6119 #: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1233
6120 #: ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1684
6121 #: ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:6744
6122 #: ../src/guestfs-actions.pod:6763
6124 "This long-running command can generate progress notification messages so "
6125 "that the caller can display a progress bar or indicator. To receive these "
6126 "messages, the caller must register a progress callback. See L<guestfs(3)/"
6127 "guestfs_set_progress_callback>."
6131 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:3714
6132 #: ../src/guestfs-actions.pod:4850 ../src/guestfs-actions.pod:6472
6133 #: ../src/guestfs-actions.pod:6492 ../src/guestfs-actions.pod:6578
6134 msgid "(Added in 1.0.87)"
6138 #: ../src/guestfs-actions.pod:1117
6143 #: ../src/guestfs-actions.pod:1119
6147 " guestfs_cp (guestfs_h *g,\n"
6148 " const char *src,\n"
6149 " const char *dest);\n"
6154 #: ../src/guestfs-actions.pod:1124 ../fish/guestfish-actions.pod:759
6156 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6157 "destination filename or destination directory."
6161 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143
6162 #: ../src/guestfs-actions.pod:1215 ../src/guestfs-actions.pod:1289
6163 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:4317
6164 #: ../src/guestfs-actions.pod:4694
6165 msgid "(Added in 1.0.18)"
6169 #: ../src/guestfs-actions.pod:1131
6170 msgid "guestfs_cp_a"
6174 #: ../src/guestfs-actions.pod:1133
6178 " guestfs_cp_a (guestfs_h *g,\n"
6179 " const char *src,\n"
6180 " const char *dest);\n"
6185 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:766
6187 "This copies a file or directory from C<src> to C<dest> recursively using the "
6192 #: ../src/guestfs-actions.pod:1145
6197 #: ../src/guestfs-actions.pod:1147
6201 " guestfs_dd (guestfs_h *g,\n"
6202 " const char *src,\n"
6203 " const char *dest);\n"
6208 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:773
6210 "This command copies from one source device or file C<src> to another "
6211 "destination device or file C<dest>. Normally you would use this to copy to "
6212 "or from a device or partition, for example to duplicate a filesystem."
6216 #: ../src/guestfs-actions.pod:1157
6218 "If the destination is a device, it must be as large or larger than the "
6219 "source file or device, otherwise the copy will fail. This command cannot do "
6220 "partial copies (see C<guestfs_copy_size>)."
6224 #: ../src/guestfs-actions.pod:1165
6229 #: ../src/guestfs-actions.pod:1167
6233 " guestfs_df (guestfs_h *g);\n"
6238 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:786
6239 msgid "This command runs the C<df> command to report disk space used."
6243 #: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:1189
6244 #: ../fish/guestfish-actions.pod:788 ../fish/guestfish-actions.pod:799
6246 "This command is mostly useful for interactive sessions. It is I<not> "
6247 "intended that you try to parse the output string. Use C<statvfs> from "
6252 #: ../src/guestfs-actions.pod:1179 ../src/guestfs-actions.pod:1196
6253 #: ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:2233
6254 #: ../src/guestfs-actions.pod:2257 ../src/guestfs-actions.pod:2325
6255 #: ../src/guestfs-actions.pod:3824 ../src/guestfs-actions.pod:4217
6256 #: ../src/guestfs-actions.pod:5979 ../src/guestfs-actions.pod:6003
6257 #: ../src/guestfs-actions.pod:6611 ../src/guestfs-actions.pod:6624
6258 #: ../src/guestfs-actions.pod:6637
6259 msgid "(Added in 1.0.54)"
6263 #: ../src/guestfs-actions.pod:1181
6264 msgid "guestfs_df_h"
6268 #: ../src/guestfs-actions.pod:1183
6272 " guestfs_df_h (guestfs_h *g);\n"
6277 #: ../src/guestfs-actions.pod:1186 ../fish/guestfish-actions.pod:796
6279 "This command runs the C<df -h> command to report disk space used in human-"
6284 #: ../src/guestfs-actions.pod:1198
6285 msgid "guestfs_dmesg"
6289 #: ../src/guestfs-actions.pod:1200
6293 " guestfs_dmesg (guestfs_h *g);\n"
6298 #: ../src/guestfs-actions.pod:1203 ../fish/guestfish-actions.pod:807
6300 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
6301 "This is sometimes useful for extended debugging of problems."
6305 #: ../src/guestfs-actions.pod:1207
6307 "Another way to get the same information is to enable verbose messages with "
6308 "C<guestfs_set_verbose> or by setting the environment variable "
6309 "C<LIBGUESTFS_DEBUG=1> before running the program."
6313 #: ../src/guestfs-actions.pod:1217
6314 msgid "guestfs_download"
6318 #: ../src/guestfs-actions.pod:1219
6322 " guestfs_download (guestfs_h *g,\n"
6323 " const char *remotefilename,\n"
6324 " const char *filename);\n"
6329 #: ../src/guestfs-actions.pod:1224 ../src/guestfs-actions.pod:1249
6330 #: ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:833
6332 "Download file C<remotefilename> and save it as C<filename> on the local "
6337 #: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:6235
6338 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:4147
6339 msgid "C<filename> can also be a named pipe."
6343 #: ../src/guestfs-actions.pod:1229
6344 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
6348 #: ../src/guestfs-actions.pod:1240
6349 msgid "guestfs_download_offset"
6353 #: ../src/guestfs-actions.pod:1242
6357 " guestfs_download_offset (guestfs_h *g,\n"
6358 " const char *remotefilename,\n"
6359 " const char *filename,\n"
6360 " int64_t offset,\n"
6366 #: ../src/guestfs-actions.pod:1252 ../fish/guestfish-actions.pod:836
6368 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6369 "region must be within the file or device)."
6373 #: ../src/guestfs-actions.pod:1255
6375 "Note that there is no limit on the amount of data that can be downloaded "
6376 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
6377 "full amount unless an error occurs."
6381 #: ../src/guestfs-actions.pod:1260
6382 msgid "See also C<guestfs_download>, C<guestfs_pread>."
6386 #: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:6270
6387 msgid "(Added in 1.5.17)"
6391 #: ../src/guestfs-actions.pod:1271
6392 msgid "guestfs_drop_caches"
6396 #: ../src/guestfs-actions.pod:1273
6400 " guestfs_drop_caches (guestfs_h *g,\n"
6401 " int whattodrop);\n"
6406 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:852
6408 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6409 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6410 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6414 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:857
6415 msgid "Setting C<whattodrop> to 3 should drop everything."
6419 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:859
6421 "This automatically calls L<sync(2)> before the operation, so that the "
6422 "maximum guest memory is freed."
6426 #: ../src/guestfs-actions.pod:1291
6431 #: ../src/guestfs-actions.pod:1293
6435 " guestfs_du (guestfs_h *g,\n"
6436 " const char *path);\n"
6441 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:866
6443 "This command runs the C<du -s> command to estimate file space usage for "
6448 #: ../src/guestfs-actions.pod:1300 ../fish/guestfish-actions.pod:869
6450 "C<path> can be a file or a directory. If C<path> is a directory then the "
6451 "estimate includes the contents of the directory and all subdirectories "
6456 #: ../src/guestfs-actions.pod:1304 ../fish/guestfish-actions.pod:873
6458 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6462 #: ../src/guestfs-actions.pod:1311
6463 msgid "guestfs_e2fsck_f"
6467 #: ../src/guestfs-actions.pod:1313
6471 " guestfs_e2fsck_f (guestfs_h *g,\n"
6472 " const char *device);\n"
6477 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:880
6479 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6480 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
6485 #: ../src/guestfs-actions.pod:1321
6487 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
6488 "Normally you should use C<guestfs_fsck>."
6492 #: ../src/guestfs-actions.pod:1326
6493 msgid "(Added in 1.0.29)"
6497 #: ../src/guestfs-actions.pod:1328
6498 msgid "guestfs_echo_daemon"
6502 #: ../src/guestfs-actions.pod:1330
6506 " guestfs_echo_daemon (guestfs_h *g,\n"
6507 " char *const *words);\n"
6512 #: ../src/guestfs-actions.pod:1334 ../fish/guestfish-actions.pod:891
6514 "This command concatenates the list of C<words> passed with single spaces "
6515 "between them and returns the resulting string."
6519 #: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:894
6520 msgid "You can use this command to test the connection through to the daemon."
6524 #: ../src/guestfs-actions.pod:1339
6525 msgid "See also C<guestfs_ping_daemon>."
6529 #: ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:2071
6530 #: ../src/guestfs-actions.pod:5483
6531 msgid "(Added in 1.0.69)"
6535 #: ../src/guestfs-actions.pod:1346
6536 msgid "guestfs_egrep"
6540 #: ../src/guestfs-actions.pod:1348
6544 " guestfs_egrep (guestfs_h *g,\n"
6545 " const char *regex,\n"
6546 " const char *path);\n"
6551 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:902
6553 "This calls the external C<egrep> program and returns the matching lines."
6557 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1382
6558 #: ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1485
6559 #: ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:2171
6560 #: ../src/guestfs-actions.pod:2190 ../src/guestfs-actions.pod:2346
6561 #: ../src/guestfs-actions.pod:2359 ../src/guestfs-actions.pod:2374
6562 #: ../src/guestfs-actions.pod:2420 ../src/guestfs-actions.pod:2442
6563 #: ../src/guestfs-actions.pod:2455 ../src/guestfs-actions.pod:3207
6564 #: ../src/guestfs-actions.pod:3221 ../src/guestfs-actions.pod:3234
6565 #: ../src/guestfs-actions.pod:3248 ../src/guestfs-actions.pod:4152
6566 #: ../src/guestfs-actions.pod:5028 ../src/guestfs-actions.pod:5077
6567 #: ../src/guestfs-actions.pod:5847 ../src/guestfs-actions.pod:5859
6568 #: ../src/guestfs-actions.pod:5872 ../src/guestfs-actions.pod:5885
6569 #: ../src/guestfs-actions.pod:5907 ../src/guestfs-actions.pod:5920
6570 #: ../src/guestfs-actions.pod:5933 ../src/guestfs-actions.pod:5946
6571 #: ../src/guestfs-actions.pod:6707 ../src/guestfs-actions.pod:6726
6572 #: ../src/guestfs-actions.pod:6811 ../src/guestfs-actions.pod:6830
6573 #: ../src/guestfs-actions.pod:6876 ../src/guestfs-actions.pod:6895
6574 msgid "(Added in 1.0.66)"
6578 #: ../src/guestfs-actions.pod:1365
6579 msgid "guestfs_egrepi"
6583 #: ../src/guestfs-actions.pod:1367
6587 " guestfs_egrepi (guestfs_h *g,\n"
6588 " const char *regex,\n"
6589 " const char *path);\n"
6594 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
6596 "This calls the external C<egrep -i> program and returns the matching lines."
6600 #: ../src/guestfs-actions.pod:1384
6601 msgid "guestfs_equal"
6605 #: ../src/guestfs-actions.pod:1386
6609 " guestfs_equal (guestfs_h *g,\n"
6610 " const char *file1,\n"
6611 " const char *file2);\n"
6616 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
6618 "This compares the two files C<file1> and C<file2> and returns true if their "
6619 "content is exactly equal, or false otherwise."
6623 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:925
6624 msgid "The external L<cmp(1)> program is used for the comparison."
6628 #: ../src/guestfs-actions.pod:1400
6629 msgid "guestfs_exists"
6633 #: ../src/guestfs-actions.pod:1402
6637 " guestfs_exists (guestfs_h *g,\n"
6638 " const char *path);\n"
6643 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:931
6645 "This returns C<true> if and only if there is a file, directory (or anything) "
6646 "with the given C<path> name."
6650 #: ../src/guestfs-actions.pod:1409
6651 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6655 #: ../src/guestfs-actions.pod:1415
6656 msgid "guestfs_fallocate"
6660 #: ../src/guestfs-actions.pod:1417
6664 " guestfs_fallocate (guestfs_h *g,\n"
6665 " const char *path,\n"
6671 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1448
6672 #: ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:959
6674 "This command preallocates a file (containing zero bytes) named C<path> of "
6675 "size C<len> bytes. If the file exists already, it is overwritten."
6679 #: ../src/guestfs-actions.pod:1426 ../fish/guestfish-actions.pod:944
6681 "Do not confuse this with the guestfish-specific C<alloc> command which "
6682 "allocates a file in the host and attaches it as a device."
6686 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:948
6688 "This function is deprecated. In new code, use the C<fallocate64> call "
6693 #: ../src/guestfs-actions.pod:1441
6694 msgid "guestfs_fallocate64"
6698 #: ../src/guestfs-actions.pod:1443
6702 " guestfs_fallocate64 (guestfs_h *g,\n"
6703 " const char *path,\n"
6709 #: ../src/guestfs-actions.pod:1452
6711 "Note that this call allocates disk blocks for the file. To create a sparse "
6712 "file use C<guestfs_truncate_size> instead."
6716 #: ../src/guestfs-actions.pod:1455
6718 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6719 "oversight it only allowed 30 bit lengths to be specified, effectively "
6720 "limiting the maximum size of files created through that call to 1GB."
6724 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:971
6726 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6727 "commands which create a file in the host and attach it as a device."
6731 #: ../src/guestfs-actions.pod:1466
6732 msgid "(Added in 1.3.17)"
6736 #: ../src/guestfs-actions.pod:1468
6737 msgid "guestfs_fgrep"
6741 #: ../src/guestfs-actions.pod:1470
6745 " guestfs_fgrep (guestfs_h *g,\n"
6746 " const char *pattern,\n"
6747 " const char *path);\n"
6752 #: ../src/guestfs-actions.pod:1475 ../fish/guestfish-actions.pod:979
6754 "This calls the external C<fgrep> program and returns the matching lines."
6758 #: ../src/guestfs-actions.pod:1487
6759 msgid "guestfs_fgrepi"
6763 #: ../src/guestfs-actions.pod:1489
6767 " guestfs_fgrepi (guestfs_h *g,\n"
6768 " const char *pattern,\n"
6769 " const char *path);\n"
6774 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
6776 "This calls the external C<fgrep -i> program and returns the matching lines."
6780 #: ../src/guestfs-actions.pod:1506
6781 msgid "guestfs_file"
6785 #: ../src/guestfs-actions.pod:1508
6789 " guestfs_file (guestfs_h *g,\n"
6790 " const char *path);\n"
6795 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:999
6797 "This call uses the standard L<file(1)> command to determine the type or "
6798 "contents of the file."
6802 #: ../src/guestfs-actions.pod:1515 ../fish/guestfish-actions.pod:1002
6804 "This call will also transparently look inside various types of compressed "
6809 #: ../src/guestfs-actions.pod:1518 ../fish/guestfish-actions.pod:1005
6811 "The exact command which runs is C<file -zb path>. Note in particular that "
6812 "the filename is not prepended to the output (the C<-b> option)."
6816 #: ../src/guestfs-actions.pod:1522
6818 "This command can also be used on C</dev/> devices (and partitions, LV "
6819 "names). You can for example use this to determine if a device contains a "
6820 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
6824 #: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1014
6826 "If the C<path> does not begin with C</dev/> then this command only works for "
6827 "the content of regular files. For other file types (directory, symbolic "
6828 "link etc) it will just return the string C<directory> etc."
6832 #: ../src/guestfs-actions.pod:1537
6833 msgid "guestfs_file_architecture"
6837 #: ../src/guestfs-actions.pod:1539
6841 " guestfs_file_architecture (guestfs_h *g,\n"
6842 " const char *filename);\n"
6847 #: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1023
6849 "This detects the architecture of the binary C<filename>, and returns it if "
6854 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1026
6855 msgid "Currently defined architectures are:"
6859 #: ../src/guestfs-actions.pod:1550 ../fish/guestfish-actions.pod:1030
6864 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1032
6866 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6867 "irrespective of the precise processor requirements of the binary."
6871 #: ../src/guestfs-actions.pod:1555 ../fish/guestfish-actions.pod:1035
6876 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1037
6877 msgid "64 bit x86-64."
6881 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1039
6886 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1041
6887 msgid "32 bit SPARC."
6891 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1043
6896 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1045
6897 msgid "64 bit SPARC V9 and above."
6901 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1047
6906 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1049
6907 msgid "Intel Itanium."
6911 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1051
6916 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1053
6917 msgid "32 bit Power PC."
6921 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1055
6926 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1057
6927 msgid "64 bit Power PC."
6931 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1061
6932 msgid "Libguestfs may return other architecture strings in future."
6936 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1063
6937 msgid "The function works on at least the following types of files:"
6941 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1069
6942 msgid "many types of Un*x and Linux binary"
6946 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1073
6947 msgid "many types of Un*x and Linux shared library"
6951 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1077
6952 msgid "Windows Win32 and Win64 binaries"
6956 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1081
6957 msgid "Windows Win32 and Win64 DLLs"
6961 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1083
6962 msgid "Win32 binaries and DLLs return C<i386>."
6966 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1085
6967 msgid "Win64 binaries and DLLs return C<x86_64>."
6971 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1089
6972 msgid "Linux kernel modules"
6976 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1093
6977 msgid "Linux new-style initrd images"
6981 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1097
6982 msgid "some non-x86 Linux vmlinuz kernels"
6986 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1101
6987 msgid "What it can't do currently:"
6991 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1107
6992 msgid "static libraries (libfoo.a)"
6996 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1111
6997 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7001 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1115
7002 msgid "x86 Linux vmlinuz kernels"
7006 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1117
7008 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7009 "compressed code, and are horribly hard to unpack. If you want to find the "
7010 "architecture of a kernel, use the architecture of the associated initrd or "
7011 "kernel module(s) instead."
7015 #: ../src/guestfs-actions.pod:1647 ../src/guestfs-actions.pod:1810
7016 #: ../src/guestfs-actions.pod:1827 ../src/guestfs-actions.pod:2478
7017 #: ../src/guestfs-actions.pod:2551 ../src/guestfs-actions.pod:2577
7018 #: ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2625
7019 #: ../src/guestfs-actions.pod:2658 ../src/guestfs-actions.pod:2738
7020 #: ../src/guestfs-actions.pod:2794 ../src/guestfs-actions.pod:2860
7021 #: ../src/guestfs-actions.pod:2992
7022 msgid "(Added in 1.5.3)"
7026 #: ../src/guestfs-actions.pod:1649
7027 msgid "guestfs_filesize"
7031 #: ../src/guestfs-actions.pod:1651
7035 " guestfs_filesize (guestfs_h *g,\n"
7036 " const char *file);\n"
7041 #: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1128
7042 msgid "This command returns the size of C<file> in bytes."
7046 #: ../src/guestfs-actions.pod:1657
7048 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
7049 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
7050 "devices, use C<guestfs_blockdev_getsize64>."
7054 #: ../src/guestfs-actions.pod:1663
7055 msgid "(Added in 1.0.82)"
7059 #: ../src/guestfs-actions.pod:1665
7060 msgid "guestfs_fill"
7064 #: ../src/guestfs-actions.pod:1667
7068 " guestfs_fill (guestfs_h *g,\n"
7071 " const char *path);\n"
7076 #: ../src/guestfs-actions.pod:1673 ../fish/guestfish-actions.pod:1138
7078 "This command creates a new file called C<path>. The initial content of the "
7079 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
7084 #: ../src/guestfs-actions.pod:1677
7086 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7087 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7088 "bytes use C<guestfs_fill_pattern>."
7092 #: ../src/guestfs-actions.pod:1689
7093 msgid "(Added in 1.0.79)"
7097 #: ../src/guestfs-actions.pod:1691
7098 msgid "guestfs_fill_pattern"
7102 #: ../src/guestfs-actions.pod:1693
7106 " guestfs_fill_pattern (guestfs_h *g,\n"
7107 " const char *pattern,\n"
7109 " const char *path);\n"
7114 #: ../src/guestfs-actions.pod:1699
7116 "This function is like C<guestfs_fill> except that it creates a new file of "
7117 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7118 "pattern is truncated if necessary to ensure the length of the file is "
7119 "exactly C<len> bytes."
7123 #: ../src/guestfs-actions.pod:1711
7124 msgid "(Added in 1.3.12)"
7128 #: ../src/guestfs-actions.pod:1713
7129 msgid "guestfs_find"
7133 #: ../src/guestfs-actions.pod:1715
7137 " guestfs_find (guestfs_h *g,\n"
7138 " const char *directory);\n"
7143 #: ../src/guestfs-actions.pod:1719 ../fish/guestfish-actions.pod:1160
7145 "This command lists out all files and directories, recursively, starting at "
7146 "C<directory>. It is essentially equivalent to running the shell command "
7147 "C<find directory -print> but some post-processing happens on the output, "
7152 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1165
7154 "This returns a list of strings I<without any prefix>. Thus if the directory "
7159 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1168
7169 #: ../src/guestfs-actions.pod:1731
7171 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7175 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1175
7186 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1180
7187 msgid "If C<directory> is not a directory, then this command returns an error."
7191 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1183
7192 msgid "The returned list is sorted."
7196 #: ../src/guestfs-actions.pod:1744
7197 msgid "See also C<guestfs_find0>."
7201 #: ../src/guestfs-actions.pod:1753 ../src/guestfs-actions.pod:3651
7202 #: ../src/guestfs-actions.pod:5112
7203 msgid "(Added in 1.0.27)"
7207 #: ../src/guestfs-actions.pod:1755
7208 msgid "guestfs_find0"
7212 #: ../src/guestfs-actions.pod:1757
7216 " guestfs_find0 (guestfs_h *g,\n"
7217 " const char *directory,\n"
7218 " const char *files);\n"
7223 #: ../src/guestfs-actions.pod:1762 ../fish/guestfish-actions.pod:1194
7225 "This command lists out all files and directories, recursively, starting at "
7226 "C<directory>, placing the resulting list in the external file called "
7231 #: ../src/guestfs-actions.pod:1766
7233 "This command works the same way as C<guestfs_find> with the following "
7238 #: ../src/guestfs-actions.pod:1773 ../fish/guestfish-actions.pod:1205
7239 msgid "The resulting list is written to an external file."
7243 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1209
7245 "Items (filenames) in the result are separated by C<\\0> characters. See "
7246 "L<find(1)> option I<-print0>."
7250 #: ../src/guestfs-actions.pod:1782 ../fish/guestfish-actions.pod:1214
7251 msgid "This command is not limited in the number of names that it can return."
7255 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1219
7256 msgid "The result list is not sorted."
7260 #: ../src/guestfs-actions.pod:1793
7261 msgid "(Added in 1.0.74)"
7265 #: ../src/guestfs-actions.pod:1795
7266 msgid "guestfs_findfs_label"
7270 #: ../src/guestfs-actions.pod:1797
7274 " guestfs_findfs_label (guestfs_h *g,\n"
7275 " const char *label);\n"
7280 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1229
7282 "This command searches the filesystems and returns the one which has the "
7283 "given label. An error is returned if no such filesystem can be found."
7287 #: ../src/guestfs-actions.pod:1805
7288 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
7292 #: ../src/guestfs-actions.pod:1812
7293 msgid "guestfs_findfs_uuid"
7297 #: ../src/guestfs-actions.pod:1814
7301 " guestfs_findfs_uuid (guestfs_h *g,\n"
7302 " const char *uuid);\n"
7307 #: ../src/guestfs-actions.pod:1818 ../fish/guestfish-actions.pod:1239
7309 "This command searches the filesystems and returns the one which has the "
7310 "given UUID. An error is returned if no such filesystem can be found."
7314 #: ../src/guestfs-actions.pod:1822
7315 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
7319 #: ../src/guestfs-actions.pod:1829
7320 msgid "guestfs_fsck"
7324 #: ../src/guestfs-actions.pod:1831
7328 " guestfs_fsck (guestfs_h *g,\n"
7329 " const char *fstype,\n"
7330 " const char *device);\n"
7335 #: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1249
7337 "This runs the filesystem checker (fsck) on C<device> which should have "
7338 "filesystem type C<fstype>."
7342 #: ../src/guestfs-actions.pod:1839 ../fish/guestfish-actions.pod:1252
7344 "The returned integer is the status. See L<fsck(8)> for the list of status "
7345 "codes from C<fsck>."
7349 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1261
7350 msgid "Multiple status codes can be summed together."
7354 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1265
7356 "A non-zero return code can mean \"success\", for example if errors have been "
7357 "corrected on the filesystem."
7361 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1270
7362 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
7366 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1275
7368 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
7372 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:6749
7373 msgid "(Added in 1.0.16)"
7377 #: ../src/guestfs-actions.pod:1868
7378 msgid "guestfs_get_append"
7382 #: ../src/guestfs-actions.pod:1870
7386 " guestfs_get_append (guestfs_h *g);\n"
7391 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1281
7393 "Return the additional kernel options which are added to the guest kernel "
7398 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1284
7399 msgid "If C<NULL> then no options are added."
7403 #: ../src/guestfs-actions.pod:1878
7405 "This function returns a string which may be NULL. There is no way to return "
7406 "an error from this function. The string is owned by the guest handle and "
7407 "must I<not> be freed."
7411 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:4790
7412 #: ../src/guestfs-actions.pod:5253 ../src/guestfs-actions.pod:5621
7413 #: ../src/guestfs-actions.pod:5640 ../src/guestfs-actions.pod:5656
7414 #: ../src/guestfs-actions.pod:5673 ../src/guestfs-actions.pod:6420
7415 #: ../src/guestfs-actions.pod:6438 ../src/guestfs-actions.pod:6792
7416 msgid "(Added in 1.0.26)"
7420 #: ../src/guestfs-actions.pod:1884
7421 msgid "guestfs_get_autosync"
7425 #: ../src/guestfs-actions.pod:1886
7429 " guestfs_get_autosync (guestfs_h *g);\n"
7434 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1290
7435 msgid "Get the autosync flag."
7439 #: ../src/guestfs-actions.pod:1895
7440 msgid "guestfs_get_direct"
7444 #: ../src/guestfs-actions.pod:1897
7448 " guestfs_get_direct (guestfs_h *g);\n"
7453 #: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1296
7454 msgid "Return the direct appliance mode flag."
7458 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:5294
7459 msgid "(Added in 1.0.72)"
7463 #: ../src/guestfs-actions.pod:1906
7464 msgid "guestfs_get_e2label"
7468 #: ../src/guestfs-actions.pod:1908
7472 " guestfs_get_e2label (guestfs_h *g,\n"
7473 " const char *device);\n"
7478 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1302
7480 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7484 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1305
7486 "This function is deprecated. In new code, use the C<vfs_label> call instead."
7490 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1946
7491 #: ../src/guestfs-actions.pod:5312 ../src/guestfs-actions.pod:5331
7492 msgid "(Added in 1.0.15)"
7496 #: ../src/guestfs-actions.pod:1927
7497 msgid "guestfs_get_e2uuid"
7501 #: ../src/guestfs-actions.pod:1929
7505 " guestfs_get_e2uuid (guestfs_h *g,\n"
7506 " const char *device);\n"
7511 #: ../src/guestfs-actions.pod:1933 ../fish/guestfish-actions.pod:1316
7513 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7517 #: ../src/guestfs-actions.pod:1939 ../fish/guestfish-actions.pod:1319
7519 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
7523 #: ../src/guestfs-actions.pod:1948
7524 msgid "guestfs_get_memsize"
7528 #: ../src/guestfs-actions.pod:1950
7532 " guestfs_get_memsize (guestfs_h *g);\n"
7537 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1330
7539 "This gets the memory size in megabytes allocated to the qemu subprocess."
7543 #: ../src/guestfs-actions.pod:1956
7545 "If C<guestfs_set_memsize> was not called on this handle, and if "
7546 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7547 "value for memsize."
7551 #: ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2041
7552 #: ../src/guestfs-actions.pod:5347 ../src/guestfs-actions.pod:5454
7553 #: ../fish/guestfish-actions.pod:1337 ../fish/guestfish-actions.pod:1388
7554 #: ../fish/guestfish-actions.pod:3554 ../fish/guestfish-actions.pod:3641
7556 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7560 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:3942
7561 #: ../src/guestfs-actions.pod:4057 ../src/guestfs-actions.pod:4076
7562 #: ../src/guestfs-actions.pod:4095 ../src/guestfs-actions.pod:4107
7563 #: ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4137
7564 #: ../src/guestfs-actions.pod:5015 ../src/guestfs-actions.pod:5352
7565 #: ../src/guestfs-actions.pod:5595 ../src/guestfs-actions.pod:6196
7566 msgid "(Added in 1.0.55)"
7570 #: ../src/guestfs-actions.pod:1967
7571 msgid "guestfs_get_network"
7575 #: ../src/guestfs-actions.pod:1969
7579 " guestfs_get_network (guestfs_h *g);\n"
7584 #: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1344
7585 msgid "This returns the enable network flag."
7589 #: ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:5371
7590 msgid "(Added in 1.5.4)"
7594 #: ../src/guestfs-actions.pod:1978
7595 msgid "guestfs_get_path"
7599 #: ../src/guestfs-actions.pod:1980
7603 " guestfs_get_path (guestfs_h *g);\n"
7608 #: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1350
7609 msgid "Return the current search path."
7613 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1352
7615 "This is always non-NULL. If it wasn't set already, then this will return "
7620 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2017
7622 "This function returns a string, or NULL on error. The string is owned by "
7623 "the guest handle and must I<not> be freed."
7627 #: ../src/guestfs-actions.pod:1993
7628 msgid "guestfs_get_pid"
7632 #: ../src/guestfs-actions.pod:1995
7636 " guestfs_get_pid (guestfs_h *g);\n"
7641 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1361
7643 "Return the process ID of the qemu subprocess. If there is no qemu "
7644 "subprocess, then this will return an error."
7648 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1364
7649 msgid "This is an internal call used for debugging and testing."
7653 #: ../src/guestfs-actions.pod:2005
7654 msgid "(Added in 1.0.56)"
7658 #: ../src/guestfs-actions.pod:2007
7659 msgid "guestfs_get_qemu"
7663 #: ../src/guestfs-actions.pod:2009
7667 " guestfs_get_qemu (guestfs_h *g);\n"
7672 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1370
7673 msgid "Return the current qemu binary."
7677 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1372
7679 "This is always non-NULL. If it wasn't set already, then this will return "
7680 "the default qemu binary name."
7684 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5416
7685 msgid "(Added in 1.0.6)"
7689 #: ../src/guestfs-actions.pod:2022
7690 msgid "guestfs_get_recovery_proc"
7694 #: ../src/guestfs-actions.pod:2024
7698 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7703 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1379
7704 msgid "Return the recovery process enabled flag."
7708 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:3082
7709 #: ../src/guestfs-actions.pod:3349 ../src/guestfs-actions.pod:3749
7710 #: ../src/guestfs-actions.pod:3781 ../src/guestfs-actions.pod:4720
7711 #: ../src/guestfs-actions.pod:5063 ../src/guestfs-actions.pod:5440
7712 #: ../src/guestfs-actions.pod:6099 ../src/guestfs-actions.pod:6119
7713 #: ../src/guestfs-actions.pod:6301
7714 msgid "(Added in 1.0.77)"
7718 #: ../src/guestfs-actions.pod:2033
7719 msgid "guestfs_get_selinux"
7723 #: ../src/guestfs-actions.pod:2035
7727 " guestfs_get_selinux (guestfs_h *g);\n"
7732 #: ../src/guestfs-actions.pod:2038
7734 "This returns the current setting of the selinux flag which is passed to the "
7735 "appliance at boot time. See C<guestfs_set_selinux>."
7739 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2109
7740 #: ../src/guestfs-actions.pod:5459 ../src/guestfs-actions.pod:5513
7741 msgid "(Added in 1.0.67)"
7745 #: ../src/guestfs-actions.pod:2048
7746 msgid "guestfs_get_state"
7750 #: ../src/guestfs-actions.pod:2050
7754 " guestfs_get_state (guestfs_h *g);\n"
7759 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1395
7761 "This returns the current state as an opaque integer. This is only useful "
7762 "for printing debug and internal error messages."
7766 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:2885
7767 #: ../src/guestfs-actions.pod:2914 ../src/guestfs-actions.pod:2975
7768 #: ../src/guestfs-actions.pod:3002 ../fish/guestfish-actions.pod:1398
7769 #: ../fish/guestfish-actions.pod:1987 ../fish/guestfish-actions.pod:2005
7770 #: ../fish/guestfish-actions.pod:2043 ../fish/guestfish-actions.pod:2059
7771 msgid "For more information on states, see L<guestfs(3)>."
7775 #: ../src/guestfs-actions.pod:2062
7776 msgid "guestfs_get_trace"
7780 #: ../src/guestfs-actions.pod:2064
7784 " guestfs_get_trace (guestfs_h *g);\n"
7789 #: ../src/guestfs-actions.pod:2067 ../fish/guestfish-actions.pod:1404
7790 msgid "Return the command trace flag."
7794 #: ../src/guestfs-actions.pod:2073
7795 msgid "guestfs_get_umask"
7799 #: ../src/guestfs-actions.pod:2075
7803 " guestfs_get_umask (guestfs_h *g);\n"
7808 #: ../src/guestfs-actions.pod:2078
7810 "Return the current umask. By default the umask is C<022> unless it has been "
7811 "set by calling C<guestfs_umask>."
7815 #: ../src/guestfs-actions.pod:2085
7816 msgid "guestfs_get_verbose"
7820 #: ../src/guestfs-actions.pod:2087
7824 " guestfs_get_verbose (guestfs_h *g);\n"
7829 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1417
7830 msgid "This returns the verbose messages flag."
7834 #: ../src/guestfs-actions.pod:2096
7835 msgid "guestfs_getcon"
7839 #: ../src/guestfs-actions.pod:2098
7843 " guestfs_getcon (guestfs_h *g);\n"
7848 #: ../src/guestfs-actions.pod:2101 ../fish/guestfish-actions.pod:1423
7849 msgid "This gets the SELinux security context of the daemon."
7853 #: ../src/guestfs-actions.pod:2103
7855 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
7859 #: ../src/guestfs-actions.pod:2111
7860 msgid "guestfs_getxattrs"
7864 #: ../src/guestfs-actions.pod:2113
7867 " struct guestfs_xattr_list *\n"
7868 " guestfs_getxattrs (guestfs_h *g,\n"
7869 " const char *path);\n"
7874 #: ../src/guestfs-actions.pod:2117 ../fish/guestfish-actions.pod:1432
7876 "This call lists the extended attributes of the file or directory C<path>."
7880 #: ../src/guestfs-actions.pod:2120 ../fish/guestfish-actions.pod:1435
7882 "At the system call level, this is a combination of the L<listxattr(2)> and "
7883 "L<getxattr(2)> calls."
7887 #: ../src/guestfs-actions.pod:2123
7888 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
7892 #: ../src/guestfs-actions.pod:2125 ../src/guestfs-actions.pod:3094
7893 #: ../src/guestfs-actions.pod:3745
7895 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
7896 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
7900 #: ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:3098
7901 #: ../src/guestfs-actions.pod:3263 ../src/guestfs-actions.pod:3299
7902 #: ../src/guestfs-actions.pod:5093 ../src/guestfs-actions.pod:5532
7903 #: ../src/guestfs-actions.pod:6857
7904 msgid "(Added in 1.0.59)"
7908 #: ../src/guestfs-actions.pod:2131
7909 msgid "guestfs_glob_expand"
7913 #: ../src/guestfs-actions.pod:2133
7917 " guestfs_glob_expand (guestfs_h *g,\n"
7918 " const char *pattern);\n"
7923 #: ../src/guestfs-actions.pod:2137 ../fish/guestfish-actions.pod:1444
7925 "This command searches for all the pathnames matching C<pattern> according to "
7926 "the wildcard expansion rules used by the shell."
7930 #: ../src/guestfs-actions.pod:2141 ../fish/guestfish-actions.pod:1448
7932 "If no paths match, then this returns an empty list (note: not an error)."
7936 #: ../src/guestfs-actions.pod:2144 ../fish/guestfish-actions.pod:1451
7938 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
7939 "GLOB_BRACE>. See that manual page for more details."
7943 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:5697
7944 #: ../src/guestfs-actions.pod:5714
7945 msgid "(Added in 1.0.50)"
7949 #: ../src/guestfs-actions.pod:2154
7950 msgid "guestfs_grep"
7954 #: ../src/guestfs-actions.pod:2156
7958 " guestfs_grep (guestfs_h *g,\n"
7959 " const char *regex,\n"
7960 " const char *path);\n"
7965 #: ../src/guestfs-actions.pod:2161 ../fish/guestfish-actions.pod:1459
7966 msgid "This calls the external C<grep> program and returns the matching lines."
7970 #: ../src/guestfs-actions.pod:2173
7971 msgid "guestfs_grepi"
7975 #: ../src/guestfs-actions.pod:2175
7979 " guestfs_grepi (guestfs_h *g,\n"
7980 " const char *regex,\n"
7981 " const char *path);\n"
7986 #: ../src/guestfs-actions.pod:2180 ../fish/guestfish-actions.pod:1469
7988 "This calls the external C<grep -i> program and returns the matching lines."
7992 #: ../src/guestfs-actions.pod:2192
7993 msgid "guestfs_grub_install"
7997 #: ../src/guestfs-actions.pod:2194
8001 " guestfs_grub_install (guestfs_h *g,\n"
8002 " const char *root,\n"
8003 " const char *device);\n"
8008 #: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1479
8010 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
8011 "the root directory being C<root>."
8015 #: ../src/guestfs-actions.pod:2202 ../fish/guestfish-actions.pod:1482
8017 "Note: If grub-install reports the error \"No suitable drive was found in the "
8018 "generated device map.\" it may be that you need to create a C</boot/grub/"
8019 "device.map> file first that contains the mapping between grub device names "
8020 "and Linux device names. It is usually sufficient to create a file "
8025 #: ../src/guestfs-actions.pod:2209 ../fish/guestfish-actions.pod:1489
8033 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1491
8034 msgid "replacing C</dev/vda> with the name of the installation device."
8038 #: ../src/guestfs-actions.pod:2215
8039 msgid "(Added in 1.0.17)"
8043 #: ../src/guestfs-actions.pod:2217
8044 msgid "guestfs_head"
8048 #: ../src/guestfs-actions.pod:2219
8052 " guestfs_head (guestfs_h *g,\n"
8053 " const char *path);\n"
8058 #: ../src/guestfs-actions.pod:2223 ../fish/guestfish-actions.pod:1497
8060 "This command returns up to the first 10 lines of a file as a list of strings."
8064 #: ../src/guestfs-actions.pod:2235
8065 msgid "guestfs_head_n"
8069 #: ../src/guestfs-actions.pod:2237
8073 " guestfs_head_n (guestfs_h *g,\n"
8075 " const char *path);\n"
8080 #: ../src/guestfs-actions.pod:2242 ../fish/guestfish-actions.pod:1507
8082 "If the parameter C<nrlines> is a positive number, this returns the first "
8083 "C<nrlines> lines of the file C<path>."
8087 #: ../src/guestfs-actions.pod:2245 ../fish/guestfish-actions.pod:1510
8089 "If the parameter C<nrlines> is a negative number, this returns lines from "
8090 "the file C<path>, excluding the last C<nrlines> lines."
8094 #: ../src/guestfs-actions.pod:2248 ../src/guestfs-actions.pod:5994
8095 #: ../fish/guestfish-actions.pod:1513 ../fish/guestfish-actions.pod:3987
8096 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8100 #: ../src/guestfs-actions.pod:2259
8101 msgid "guestfs_hexdump"
8105 #: ../src/guestfs-actions.pod:2261
8109 " guestfs_hexdump (guestfs_h *g,\n"
8110 " const char *path);\n"
8115 #: ../src/guestfs-actions.pod:2265 ../fish/guestfish-actions.pod:1522
8117 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
8118 "readable, canonical hex dump of the file."
8122 #: ../src/guestfs-actions.pod:2274 ../src/guestfs-actions.pod:5778
8123 #: ../src/guestfs-actions.pod:5833
8124 msgid "(Added in 1.0.22)"
8128 #: ../src/guestfs-actions.pod:2276
8129 msgid "guestfs_initrd_cat"
8133 #: ../src/guestfs-actions.pod:2278
8137 " guestfs_initrd_cat (guestfs_h *g,\n"
8138 " const char *initrdpath,\n"
8139 " const char *filename,\n"
8140 " size_t *size_r);\n"
8145 #: ../src/guestfs-actions.pod:2284 ../fish/guestfish-actions.pod:1532
8147 "This command unpacks the file C<filename> from the initrd file called "
8148 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8153 #: ../src/guestfs-actions.pod:2288 ../fish/guestfish-actions.pod:1536
8155 "For example, in guestfish you could use the following command to examine the "
8156 "boot script (usually called C</init>) contained in a Linux initrd or "
8161 #: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1540
8164 " initrd-cat /boot/initrd-<version>.img init\n"
8169 #: ../src/guestfs-actions.pod:2294
8170 msgid "See also C<guestfs_initrd_list>."
8174 #: ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:4713
8175 #: ../src/guestfs-actions.pod:4739 ../src/guestfs-actions.pod:4920
8177 "This function returns a buffer, or NULL on error. The size of the returned "
8178 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8183 #: ../src/guestfs-actions.pod:2305
8184 msgid "guestfs_initrd_list"
8188 #: ../src/guestfs-actions.pod:2307
8192 " guestfs_initrd_list (guestfs_h *g,\n"
8193 " const char *path);\n"
8198 #: ../src/guestfs-actions.pod:2311 ../fish/guestfish-actions.pod:1551
8199 msgid "This command lists out files contained in an initrd."
8203 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1553
8205 "The files are listed without any initial C</> character. The files are "
8206 "listed in the order they appear (not necessarily alphabetical). Directory "
8207 "names are listed as separate items."
8211 #: ../src/guestfs-actions.pod:2317 ../fish/guestfish-actions.pod:1557
8213 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8214 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8219 #: ../src/guestfs-actions.pod:2327
8220 msgid "guestfs_inotify_add_watch"
8224 #: ../src/guestfs-actions.pod:2329
8228 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8229 " const char *path,\n"
8235 #: ../src/guestfs-actions.pod:2334 ../fish/guestfish-actions.pod:1565
8236 msgid "Watch C<path> for the events listed in C<mask>."
8240 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1567
8242 "Note that if C<path> is a directory then events within that directory are "
8243 "watched, but this does I<not> happen recursively (in subdirectories)."
8247 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1571
8249 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8250 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
8254 #: ../src/guestfs-actions.pod:2348
8255 msgid "guestfs_inotify_close"
8259 #: ../src/guestfs-actions.pod:2350
8263 " guestfs_inotify_close (guestfs_h *g);\n"
8268 #: ../src/guestfs-actions.pod:2353 ../fish/guestfish-actions.pod:1579
8270 "This closes the inotify handle which was previously opened by inotify_init. "
8271 "It removes all watches, throws away any pending events, and deallocates all "
8276 #: ../src/guestfs-actions.pod:2361
8277 msgid "guestfs_inotify_files"
8281 #: ../src/guestfs-actions.pod:2363
8285 " guestfs_inotify_files (guestfs_h *g);\n"
8290 #: ../src/guestfs-actions.pod:2366
8292 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
8293 "returns a list of pathnames of objects that were touched. The returned "
8294 "pathnames are sorted and deduplicated."
8298 #: ../src/guestfs-actions.pod:2376
8299 msgid "guestfs_inotify_init"
8303 #: ../src/guestfs-actions.pod:2378
8307 " guestfs_inotify_init (guestfs_h *g,\n"
8308 " int maxevents);\n"
8313 #: ../src/guestfs-actions.pod:2382 ../fish/guestfish-actions.pod:1595
8315 "This command creates a new inotify handle. The inotify subsystem can be "
8316 "used to notify events which happen to objects in the guest filesystem."
8320 #: ../src/guestfs-actions.pod:2386
8322 "C<maxevents> is the maximum number of events which will be queued up between "
8323 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
8324 "passed as C<0>, then the kernel (or previously set) default is used. For "
8325 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
8326 "throws away events, but records the fact that it threw them away by setting "
8327 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
8328 "C<guestfs_inotify_read>)."
8332 #: ../src/guestfs-actions.pod:2396
8334 "Before any events are generated, you have to add some watches to the "
8335 "internal watch list. See: C<guestfs_inotify_add_watch>, "
8336 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
8340 #: ../src/guestfs-actions.pod:2402
8342 "Queued up events should be read periodically by calling "
8343 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
8344 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
8345 "often enough then you risk the internal queue overflowing."
8349 #: ../src/guestfs-actions.pod:2409
8351 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
8352 "This also removes any watches automatically."
8356 #: ../src/guestfs-actions.pod:2413 ../fish/guestfish-actions.pod:1626
8358 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
8359 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
8360 "that there is one global inotify handle per libguestfs instance."
8364 #: ../src/guestfs-actions.pod:2422
8365 msgid "guestfs_inotify_read"
8369 #: ../src/guestfs-actions.pod:2424
8372 " struct guestfs_inotify_event_list *\n"
8373 " guestfs_inotify_read (guestfs_h *g);\n"
8378 #: ../src/guestfs-actions.pod:2427 ../fish/guestfish-actions.pod:1635
8380 "Return the complete queue of events that have happened since the previous "
8385 #: ../src/guestfs-actions.pod:2430 ../fish/guestfish-actions.pod:1638
8386 msgid "If no events have happened, this returns an empty list."
8390 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1640
8392 "I<Note>: In order to make sure that all events have been read, you must call "
8393 "this function repeatedly until it returns an empty list. The reason is that "
8394 "the call will read events up to the maximum appliance-to-host message size "
8395 "and leave remaining events in the queue."
8399 #: ../src/guestfs-actions.pod:2438
8401 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
8402 "there was an error. I<The caller must call "
8403 "C<guestfs_free_inotify_event_list> after use>."
8407 #: ../src/guestfs-actions.pod:2444
8408 msgid "guestfs_inotify_rm_watch"
8412 #: ../src/guestfs-actions.pod:2446
8416 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
8422 #: ../src/guestfs-actions.pod:2450
8424 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
8428 #: ../src/guestfs-actions.pod:2457
8429 msgid "guestfs_inspect_get_arch"
8433 #: ../src/guestfs-actions.pod:2459
8437 " guestfs_inspect_get_arch (guestfs_h *g,\n"
8438 " const char *root);\n"
8443 #: ../src/guestfs-actions.pod:2463 ../src/guestfs-actions.pod:2486
8444 #: ../src/guestfs-actions.pod:2559 ../src/guestfs-actions.pod:2585
8445 #: ../src/guestfs-actions.pod:2612 ../src/guestfs-actions.pod:2633
8446 #: ../src/guestfs-actions.pod:2666 ../src/guestfs-actions.pod:2693
8447 #: ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2764
8448 #: ../src/guestfs-actions.pod:2802
8450 "This function should only be called with a root device string as returned by "
8451 "C<guestfs_inspect_os>."
8455 #: ../src/guestfs-actions.pod:2466
8457 "This returns the architecture of the inspected operating system. The "
8458 "possible return values are listed under C<guestfs_file_architecture>."
8462 #: ../src/guestfs-actions.pod:2470 ../fish/guestfish-actions.pod:1664
8464 "If the architecture could not be determined, then the string C<unknown> is "
8469 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2546
8470 #: ../src/guestfs-actions.pod:2600 ../src/guestfs-actions.pod:2682
8471 #: ../src/guestfs-actions.pod:2711 ../src/guestfs-actions.pod:2733
8472 #: ../src/guestfs-actions.pod:2752 ../src/guestfs-actions.pod:2789
8473 #: ../src/guestfs-actions.pod:2812 ../src/guestfs-actions.pod:2852
8474 #: ../fish/guestfish-actions.pod:1667 ../fish/guestfish-actions.pod:1733
8475 #: ../fish/guestfish-actions.pod:1772 ../fish/guestfish-actions.pod:1832
8476 #: ../fish/guestfish-actions.pod:1856 ../fish/guestfish-actions.pod:1873
8477 #: ../fish/guestfish-actions.pod:1886 ../fish/guestfish-actions.pod:1917
8478 #: ../fish/guestfish-actions.pod:1933 ../fish/guestfish-actions.pod:1967
8479 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
8483 #: ../src/guestfs-actions.pod:2480
8484 msgid "guestfs_inspect_get_distro"
8488 #: ../src/guestfs-actions.pod:2482
8492 " guestfs_inspect_get_distro (guestfs_h *g,\n"
8493 " const char *root);\n"
8498 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1676
8500 "This returns the distro (distribution) of the inspected operating system."
8504 #: ../src/guestfs-actions.pod:2492 ../fish/guestfish-actions.pod:1679
8505 msgid "Currently defined distros are:"
8509 #: ../src/guestfs-actions.pod:2496 ../fish/guestfish-actions.pod:1683
8510 msgid "\"archlinux\""
8514 #: ../src/guestfs-actions.pod:2498 ../fish/guestfish-actions.pod:1685
8519 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1687
8524 #: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1689
8525 msgid "Debian or a Debian-derived distro such as Ubuntu."
8529 #: ../src/guestfs-actions.pod:2504 ../fish/guestfish-actions.pod:1691
8534 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1693
8539 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1695
8544 #: ../src/guestfs-actions.pod:2510 ../fish/guestfish-actions.pod:1697
8549 #: ../src/guestfs-actions.pod:2512 ../fish/guestfish-actions.pod:1699
8554 #: ../src/guestfs-actions.pod:2514 ../fish/guestfish-actions.pod:1701
8559 #: ../src/guestfs-actions.pod:2516 ../fish/guestfish-actions.pod:1703
8564 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1705
8569 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1707
8570 msgid "\"redhat-based\""
8574 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1709
8575 msgid "Some Red Hat-derived distro."
8579 #: ../src/guestfs-actions.pod:2524 ../fish/guestfish-actions.pod:1711
8584 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1713
8585 msgid "Red Hat Enterprise Linux and some derivatives."
8589 #: ../src/guestfs-actions.pod:2528 ../src/guestfs-actions.pod:2776
8590 #: ../fish/guestfish-actions.pod:1715 ../fish/guestfish-actions.pod:1904
8595 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1717
8597 "Windows does not have distributions. This string is returned if the OS type "
8602 #: ../src/guestfs-actions.pod:2533 ../fish/guestfish-actions.pod:1720
8607 #: ../src/guestfs-actions.pod:2535 ../fish/guestfish-actions.pod:1722
8612 #: ../src/guestfs-actions.pod:2537 ../src/guestfs-actions.pod:2780
8613 #: ../fish/guestfish-actions.pod:1724 ../fish/guestfish-actions.pod:1908
8618 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1726
8619 msgid "The distro could not be determined."
8623 #: ../src/guestfs-actions.pod:2543 ../src/guestfs-actions.pod:2786
8624 #: ../fish/guestfish-actions.pod:1730 ../fish/guestfish-actions.pod:1914
8626 "Future versions of libguestfs may return other strings here. The caller "
8627 "should be prepared to handle any string."
8631 #: ../src/guestfs-actions.pod:2553
8632 msgid "guestfs_inspect_get_filesystems"
8636 #: ../src/guestfs-actions.pod:2555
8640 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
8641 " const char *root);\n"
8646 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1742
8648 "This returns a list of all the filesystems that we think are associated with "
8649 "this operating system. This includes the root filesystem, other ordinary "
8650 "filesystems, and non-mounted devices like swap partitions."
8654 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1747
8656 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8657 "to be shared between operating systems."
8661 #: ../src/guestfs-actions.pod:2570
8663 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8664 "C<guestfs_inspect_get_mountpoints>."
8668 #: ../src/guestfs-actions.pod:2579
8669 msgid "guestfs_inspect_get_major_version"
8673 #: ../src/guestfs-actions.pod:2581
8677 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
8678 " const char *root);\n"
8683 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1760
8685 "This returns the major version number of the inspected operating system."
8689 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1763
8691 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8692 "popular public names used by the operating system. Notably the operating "
8693 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8694 "1). You can find out the real versions corresponding to releases of Windows "
8695 "by consulting Wikipedia or MSDN."
8699 #: ../src/guestfs-actions.pod:2598 ../src/guestfs-actions.pod:2618
8700 #: ../fish/guestfish-actions.pod:1770 ../fish/guestfish-actions.pod:1784
8701 msgid "If the version could not be determined, then C<0> is returned."
8705 #: ../src/guestfs-actions.pod:2606
8706 msgid "guestfs_inspect_get_minor_version"
8710 #: ../src/guestfs-actions.pod:2608
8714 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
8715 " const char *root);\n"
8720 #: ../src/guestfs-actions.pod:2615 ../fish/guestfish-actions.pod:1781
8722 "This returns the minor version number of the inspected operating system."
8726 #: ../src/guestfs-actions.pod:2620
8728 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8729 "C<guestfs_inspect_get_major_version>."
8733 #: ../src/guestfs-actions.pod:2627
8734 msgid "guestfs_inspect_get_mountpoints"
8738 #: ../src/guestfs-actions.pod:2629
8742 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
8743 " const char *root);\n"
8748 #: ../src/guestfs-actions.pod:2636 ../fish/guestfish-actions.pod:1796
8750 "This returns a hash of where we think the filesystems associated with this "
8751 "operating system should be mounted. Callers should note that this is at "
8752 "best an educated guess made by reading configuration files such as C</etc/"
8757 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1801
8759 "Each element in the returned hashtable has a key which is the path of the "
8760 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8761 "mounted there (eg. C</dev/sda1>)."
8765 #: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1806
8767 "Non-mounted devices such as swap devices are I<not> returned in this list."
8771 #: ../src/guestfs-actions.pod:2649
8773 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8774 "C<guestfs_inspect_get_filesystems>."
8778 #: ../src/guestfs-actions.pod:2652 ../src/guestfs-actions.pod:3151
8779 #: ../src/guestfs-actions.pod:4279 ../src/guestfs-actions.pod:6135
8781 "This function returns a NULL-terminated array of strings, or NULL if there "
8782 "was an error. The array of strings will always have length C<2n+1>, where "
8783 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
8784 "caller must free the strings and the array after use>."
8788 #: ../src/guestfs-actions.pod:2660
8789 msgid "guestfs_inspect_get_package_format"
8793 #: ../src/guestfs-actions.pod:2662
8797 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
8798 " const char *root);\n"
8803 #: ../src/guestfs-actions.pod:2669
8805 "This function and C<guestfs_inspect_get_package_management> return the "
8806 "package format and package management tool used by the inspected operating "
8807 "system. For example for Fedora these functions would return C<rpm> (package "
8808 "format) and C<yum> (package management)."
8812 #: ../src/guestfs-actions.pod:2675 ../fish/guestfish-actions.pod:1825
8814 "This returns the string C<unknown> if we could not determine the package "
8815 "format I<or> if the operating system does not have a real packaging system "
8820 #: ../src/guestfs-actions.pod:2679 ../fish/guestfish-actions.pod:1829
8822 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
8823 "Future versions of libguestfs may return other strings."
8827 #: ../src/guestfs-actions.pod:2687
8828 msgid "guestfs_inspect_get_package_management"
8832 #: ../src/guestfs-actions.pod:2689
8836 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
8837 " const char *root);\n"
8842 #: ../src/guestfs-actions.pod:2696
8844 "C<guestfs_inspect_get_package_format> and this function return the package "
8845 "format and package management tool used by the inspected operating system. "
8846 "For example for Fedora these functions would return C<rpm> (package format) "
8847 "and C<yum> (package management)."
8851 #: ../src/guestfs-actions.pod:2702 ../fish/guestfish-actions.pod:1847
8853 "This returns the string C<unknown> if we could not determine the package "
8854 "management tool I<or> if the operating system does not have a real packaging "
8855 "system (eg. Windows)."
8859 #: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1851
8861 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
8862 "derivatives), C<portage>, C<pisi>, C<pacman>. Future versions of libguestfs "
8863 "may return other strings."
8867 #: ../src/guestfs-actions.pod:2716
8868 msgid "guestfs_inspect_get_product_name"
8872 #: ../src/guestfs-actions.pod:2718
8876 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
8877 " const char *root);\n"
8882 #: ../src/guestfs-actions.pod:2725 ../fish/guestfish-actions.pod:1865
8884 "This returns the product name of the inspected operating system. The "
8885 "product name is generally some freeform string which can be displayed to the "
8886 "user, but should not be parsed by programs."
8890 #: ../src/guestfs-actions.pod:2730 ../fish/guestfish-actions.pod:1870
8892 "If the product name could not be determined, then the string C<unknown> is "
8897 #: ../src/guestfs-actions.pod:2740
8898 msgid "guestfs_inspect_get_roots"
8902 #: ../src/guestfs-actions.pod:2742
8906 " guestfs_inspect_get_roots (guestfs_h *g);\n"
8911 #: ../src/guestfs-actions.pod:2745
8913 "This function is a convenient way to get the list of root devices, as "
8914 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
8915 "the whole inspection process."
8919 #: ../src/guestfs-actions.pod:2749
8921 "This returns an empty list if either no root devices were found or the "
8922 "caller has not called C<guestfs_inspect_os>."
8926 #: ../src/guestfs-actions.pod:2758
8927 msgid "guestfs_inspect_get_type"
8931 #: ../src/guestfs-actions.pod:2760
8935 " guestfs_inspect_get_type (guestfs_h *g,\n"
8936 " const char *root);\n"
8941 #: ../src/guestfs-actions.pod:2767 ../fish/guestfish-actions.pod:1895
8943 "This returns the type of the inspected operating system. Currently defined "
8948 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1900
8953 #: ../src/guestfs-actions.pod:2774 ../fish/guestfish-actions.pod:1902
8954 msgid "Any Linux-based operating system."
8958 #: ../src/guestfs-actions.pod:2778 ../fish/guestfish-actions.pod:1906
8959 msgid "Any Microsoft Windows operating system."
8963 #: ../src/guestfs-actions.pod:2782 ../fish/guestfish-actions.pod:1910
8964 msgid "The operating system type could not be determined."
8968 #: ../src/guestfs-actions.pod:2796
8969 msgid "guestfs_inspect_get_windows_systemroot"
8973 #: ../src/guestfs-actions.pod:2798
8977 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
8978 " const char *root);\n"
8983 #: ../src/guestfs-actions.pod:2805 ../fish/guestfish-actions.pod:1926
8985 "This returns the Windows systemroot of the inspected guest. The systemroot "
8986 "is a directory path such as C</WINDOWS>."
8990 #: ../src/guestfs-actions.pod:2808 ../fish/guestfish-actions.pod:1929
8992 "This call assumes that the guest is Windows and that the systemroot could be "
8993 "determined by inspection. If this is not the case then an error is returned."
8997 #: ../src/guestfs-actions.pod:2817
8998 msgid "(Added in 1.5.25)"
9002 #: ../src/guestfs-actions.pod:2819
9003 msgid "guestfs_inspect_os"
9007 #: ../src/guestfs-actions.pod:2821
9011 " guestfs_inspect_os (guestfs_h *g);\n"
9016 #: ../src/guestfs-actions.pod:2824 ../fish/guestfish-actions.pod:1939
9018 "This function uses other libguestfs functions and certain heuristics to "
9019 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
9020 "for operating systems."
9024 #: ../src/guestfs-actions.pod:2828 ../fish/guestfish-actions.pod:1943
9025 msgid "The list returned is empty if no operating systems were found."
9029 #: ../src/guestfs-actions.pod:2830 ../fish/guestfish-actions.pod:1945
9031 "If one operating system was found, then this returns a list with a single "
9032 "element, which is the name of the root filesystem of this operating system. "
9033 "It is also possible for this function to return a list containing more than "
9034 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
9035 "element being the root filesystem of one of the operating systems."
9039 #: ../src/guestfs-actions.pod:2837
9041 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
9042 "functions in order to query further information about each operating system, "
9043 "such as the name and version."
9047 #: ../src/guestfs-actions.pod:2842
9049 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
9050 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
9051 "the contents. This should be called with no disks currently mounted. The "
9052 "function may also use Augeas, so any existing Augeas handle will be closed."
9056 #: ../src/guestfs-actions.pod:2848 ../fish/guestfish-actions.pod:1963
9058 "This function cannot decrypt encrypted disks. The caller must do that first "
9059 "(supplying the necessary keys) if the disk is encrypted."
9063 #: ../src/guestfs-actions.pod:2854 ../src/guestfs-actions.pod:3109
9064 #: ../src/guestfs-actions.pod:3171
9065 msgid "See also C<guestfs_list_filesystems>."
9069 #: ../src/guestfs-actions.pod:2862
9070 msgid "guestfs_is_blockdev"
9074 #: ../src/guestfs-actions.pod:2864
9078 " guestfs_is_blockdev (guestfs_h *g,\n"
9079 " const char *path);\n"
9084 #: ../src/guestfs-actions.pod:2868 ../fish/guestfish-actions.pod:1975
9086 "This returns C<true> if and only if there is a block device with the given "
9091 #: ../src/guestfs-actions.pod:2871 ../src/guestfs-actions.pod:2900
9092 #: ../src/guestfs-actions.pod:2930 ../src/guestfs-actions.pod:2945
9093 #: ../src/guestfs-actions.pod:2961 ../src/guestfs-actions.pod:3017
9094 #: ../src/guestfs-actions.pod:3032
9095 msgid "See also C<guestfs_stat>."
9099 #: ../src/guestfs-actions.pod:2875 ../src/guestfs-actions.pod:2904
9100 #: ../src/guestfs-actions.pod:2949 ../src/guestfs-actions.pod:3021
9101 #: ../src/guestfs-actions.pod:3036
9102 msgid "(Added in 1.5.10)"
9106 #: ../src/guestfs-actions.pod:2877
9107 msgid "guestfs_is_busy"
9111 #: ../src/guestfs-actions.pod:2879
9115 " guestfs_is_busy (guestfs_h *g);\n"
9120 #: ../src/guestfs-actions.pod:2882 ../fish/guestfish-actions.pod:1984
9122 "This returns true iff this handle is busy processing a command (in the "
9127 #: ../src/guestfs-actions.pod:2891
9128 msgid "guestfs_is_chardev"
9132 #: ../src/guestfs-actions.pod:2893
9136 " guestfs_is_chardev (guestfs_h *g,\n"
9137 " const char *path);\n"
9142 #: ../src/guestfs-actions.pod:2897 ../fish/guestfish-actions.pod:1993
9144 "This returns C<true> if and only if there is a character device with the "
9145 "given C<path> name."
9149 #: ../src/guestfs-actions.pod:2906
9150 msgid "guestfs_is_config"
9154 #: ../src/guestfs-actions.pod:2908
9158 " guestfs_is_config (guestfs_h *g);\n"
9163 #: ../src/guestfs-actions.pod:2911 ../fish/guestfish-actions.pod:2002
9165 "This returns true iff this handle is being configured (in the C<CONFIG> "
9170 #: ../src/guestfs-actions.pod:2920
9171 msgid "guestfs_is_dir"
9175 #: ../src/guestfs-actions.pod:2922
9179 " guestfs_is_dir (guestfs_h *g,\n"
9180 " const char *path);\n"
9185 #: ../src/guestfs-actions.pod:2926 ../fish/guestfish-actions.pod:2011
9187 "This returns C<true> if and only if there is a directory with the given "
9188 "C<path> name. Note that it returns false for other objects like files."
9192 #: ../src/guestfs-actions.pod:2936
9193 msgid "guestfs_is_fifo"
9197 #: ../src/guestfs-actions.pod:2938
9201 " guestfs_is_fifo (guestfs_h *g,\n"
9202 " const char *path);\n"
9207 #: ../src/guestfs-actions.pod:2942 ../fish/guestfish-actions.pod:2021
9209 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9210 "given C<path> name."
9214 #: ../src/guestfs-actions.pod:2951
9215 msgid "guestfs_is_file"
9219 #: ../src/guestfs-actions.pod:2953
9223 " guestfs_is_file (guestfs_h *g,\n"
9224 " const char *path);\n"
9229 #: ../src/guestfs-actions.pod:2957 ../fish/guestfish-actions.pod:2030
9231 "This returns C<true> if and only if there is a regular file with the given "
9232 "C<path> name. Note that it returns false for other objects like directories."
9236 #: ../src/guestfs-actions.pod:2967
9237 msgid "guestfs_is_launching"
9241 #: ../src/guestfs-actions.pod:2969
9245 " guestfs_is_launching (guestfs_h *g);\n"
9250 #: ../src/guestfs-actions.pod:2972 ../fish/guestfish-actions.pod:2040
9252 "This returns true iff this handle is launching the subprocess (in the "
9253 "C<LAUNCHING> state)."
9257 #: ../src/guestfs-actions.pod:2981
9258 msgid "guestfs_is_lv"
9262 #: ../src/guestfs-actions.pod:2983
9266 " guestfs_is_lv (guestfs_h *g,\n"
9267 " const char *device);\n"
9272 #: ../src/guestfs-actions.pod:2987 ../fish/guestfish-actions.pod:2049
9274 "This command tests whether C<device> is a logical volume, and returns true "
9275 "iff this is the case."
9279 #: ../src/guestfs-actions.pod:2994
9280 msgid "guestfs_is_ready"
9284 #: ../src/guestfs-actions.pod:2996
9288 " guestfs_is_ready (guestfs_h *g);\n"
9293 #: ../src/guestfs-actions.pod:2999 ../fish/guestfish-actions.pod:2056
9295 "This returns true iff this handle is ready to accept commands (in the "
9300 #: ../src/guestfs-actions.pod:3008
9301 msgid "guestfs_is_socket"
9305 #: ../src/guestfs-actions.pod:3010
9309 " guestfs_is_socket (guestfs_h *g,\n"
9310 " const char *path);\n"
9315 #: ../src/guestfs-actions.pod:3014 ../fish/guestfish-actions.pod:2065
9317 "This returns C<true> if and only if there is a Unix domain socket with the "
9318 "given C<path> name."
9322 #: ../src/guestfs-actions.pod:3023
9323 msgid "guestfs_is_symlink"
9327 #: ../src/guestfs-actions.pod:3025
9331 " guestfs_is_symlink (guestfs_h *g,\n"
9332 " const char *path);\n"
9337 #: ../src/guestfs-actions.pod:3029 ../fish/guestfish-actions.pod:2074
9339 "This returns C<true> if and only if there is a symbolic link with the given "
9344 #: ../src/guestfs-actions.pod:3038
9345 msgid "guestfs_kill_subprocess"
9349 #: ../src/guestfs-actions.pod:3040
9353 " guestfs_kill_subprocess (guestfs_h *g);\n"
9358 #: ../src/guestfs-actions.pod:3043 ../fish/guestfish-actions.pod:2083
9359 msgid "This kills the qemu subprocess. You should never need to call this."
9363 #: ../src/guestfs-actions.pod:3049
9364 msgid "guestfs_launch"
9368 #: ../src/guestfs-actions.pod:3051
9372 " guestfs_launch (guestfs_h *g);\n"
9377 #: ../src/guestfs-actions.pod:3054 ../fish/guestfish-actions.pod:2091
9379 "Internally libguestfs is implemented by running a virtual machine using "
9384 #: ../src/guestfs-actions.pod:3057 ../fish/guestfish-actions.pod:2094
9386 "You should call this after configuring the handle (eg. adding drives) but "
9387 "before performing any actions."
9391 #: ../src/guestfs-actions.pod:3064
9392 msgid "guestfs_lchown"
9396 #: ../src/guestfs-actions.pod:3066
9400 " guestfs_lchown (guestfs_h *g,\n"
9403 " const char *path);\n"
9408 #: ../src/guestfs-actions.pod:3072
9410 "Change the file owner to C<owner> and group to C<group>. This is like "
9411 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
9412 "changed, not the target."
9416 #: ../src/guestfs-actions.pod:3084
9417 msgid "guestfs_lgetxattrs"
9421 #: ../src/guestfs-actions.pod:3086
9424 " struct guestfs_xattr_list *\n"
9425 " guestfs_lgetxattrs (guestfs_h *g,\n"
9426 " const char *path);\n"
9431 #: ../src/guestfs-actions.pod:3090
9433 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
9434 "then it returns the extended attributes of the link itself."
9438 #: ../src/guestfs-actions.pod:3100
9439 msgid "guestfs_list_devices"
9443 #: ../src/guestfs-actions.pod:3102
9447 " guestfs_list_devices (guestfs_h *g);\n"
9452 #: ../src/guestfs-actions.pod:3105 ../fish/guestfish-actions.pod:2121
9453 msgid "List all the block devices."
9457 #: ../src/guestfs-actions.pod:3107 ../fish/guestfish-actions.pod:2123
9458 msgid "The full block device names are returned, eg. C</dev/sda>."
9462 #: ../src/guestfs-actions.pod:3117
9463 msgid "guestfs_list_filesystems"
9467 #: ../src/guestfs-actions.pod:3119
9471 " guestfs_list_filesystems (guestfs_h *g);\n"
9476 #: ../src/guestfs-actions.pod:3122 ../fish/guestfish-actions.pod:2131
9478 "This inspection command looks for filesystems on partitions, block devices "
9479 "and logical volumes, returning a list of devices containing filesystems and "
9484 #: ../src/guestfs-actions.pod:3126 ../fish/guestfish-actions.pod:2135
9486 "The return value is a hash, where the keys are the devices containing "
9487 "filesystems, and the values are the filesystem types. For example:"
9491 #: ../src/guestfs-actions.pod:3130 ../fish/guestfish-actions.pod:2139
9494 " \"/dev/sda1\" => \"ntfs\"\n"
9495 " \"/dev/sda2\" => \"ext2\"\n"
9496 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9497 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9502 #: ../src/guestfs-actions.pod:3135 ../fish/guestfish-actions.pod:2144
9504 "The value can have the special value \"unknown\", meaning the content of the "
9505 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9509 #: ../src/guestfs-actions.pod:3139
9511 "This command runs other libguestfs commands, which might include "
9512 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
9513 "soon after launch and only when nothing is mounted."
9517 #: ../src/guestfs-actions.pod:3143
9519 "Not all of the filesystems returned will be mountable. In particular, swap "
9520 "partitions are returned in the list. Also this command does not check that "
9521 "each filesystem found is valid and mountable, and some filesystems might be "
9522 "mountable but require special options. Filesystems may not all belong to a "
9523 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
9527 #: ../src/guestfs-actions.pod:3157 ../src/guestfs-actions.pod:4680
9528 msgid "(Added in 1.5.15)"
9532 #: ../src/guestfs-actions.pod:3159
9533 msgid "guestfs_list_partitions"
9537 #: ../src/guestfs-actions.pod:3161
9541 " guestfs_list_partitions (guestfs_h *g);\n"
9546 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2164
9547 msgid "List all the partitions detected on all block devices."
9551 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2166
9552 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9556 #: ../src/guestfs-actions.pod:3168
9558 "This does not return logical volumes. For that you will need to call "
9563 #: ../src/guestfs-actions.pod:3179
9568 #: ../src/guestfs-actions.pod:3181
9572 " guestfs_ll (guestfs_h *g,\n"
9573 " const char *directory);\n"
9578 #: ../src/guestfs-actions.pod:3185 ../fish/guestfish-actions.pod:2177
9580 "List the files in C<directory> (relative to the root directory, there is no "
9581 "cwd) in the format of 'ls -la'."
9585 #: ../src/guestfs-actions.pod:3188 ../fish/guestfish-actions.pod:2180
9587 "This command is mostly useful for interactive sessions. It is I<not> "
9588 "intended that you try to parse the output string."
9592 #: ../src/guestfs-actions.pod:3196
9597 #: ../src/guestfs-actions.pod:3198
9601 " guestfs_ln (guestfs_h *g,\n"
9602 " const char *target,\n"
9603 " const char *linkname);\n"
9608 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2187
9609 msgid "This command creates a hard link using the C<ln> command."
9613 #: ../src/guestfs-actions.pod:3209
9614 msgid "guestfs_ln_f"
9618 #: ../src/guestfs-actions.pod:3211
9622 " guestfs_ln_f (guestfs_h *g,\n"
9623 " const char *target,\n"
9624 " const char *linkname);\n"
9629 #: ../src/guestfs-actions.pod:3216 ../fish/guestfish-actions.pod:2193
9631 "This command creates a hard link using the C<ln -f> command. The C<-f> "
9632 "option removes the link (C<linkname>) if it exists already."
9636 #: ../src/guestfs-actions.pod:3223
9637 msgid "guestfs_ln_s"
9641 #: ../src/guestfs-actions.pod:3225
9645 " guestfs_ln_s (guestfs_h *g,\n"
9646 " const char *target,\n"
9647 " const char *linkname);\n"
9652 #: ../src/guestfs-actions.pod:3230 ../fish/guestfish-actions.pod:2200
9653 msgid "This command creates a symbolic link using the C<ln -s> command."
9657 #: ../src/guestfs-actions.pod:3236
9658 msgid "guestfs_ln_sf"
9662 #: ../src/guestfs-actions.pod:3238
9666 " guestfs_ln_sf (guestfs_h *g,\n"
9667 " const char *target,\n"
9668 " const char *linkname);\n"
9673 #: ../src/guestfs-actions.pod:3243 ../fish/guestfish-actions.pod:2206
9675 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
9676 "option removes the link (C<linkname>) if it exists already."
9680 #: ../src/guestfs-actions.pod:3250
9681 msgid "guestfs_lremovexattr"
9685 #: ../src/guestfs-actions.pod:3252
9689 " guestfs_lremovexattr (guestfs_h *g,\n"
9690 " const char *xattr,\n"
9691 " const char *path);\n"
9696 #: ../src/guestfs-actions.pod:3257
9698 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
9699 "link, then it removes an extended attribute of the link itself."
9703 #: ../src/guestfs-actions.pod:3265
9708 #: ../src/guestfs-actions.pod:3267
9712 " guestfs_ls (guestfs_h *g,\n"
9713 " const char *directory);\n"
9718 #: ../src/guestfs-actions.pod:3271 ../fish/guestfish-actions.pod:2221
9720 "List the files in C<directory> (relative to the root directory, there is no "
9721 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
9725 #: ../src/guestfs-actions.pod:3275
9727 "This command is mostly useful for interactive sessions. Programs should "
9728 "probably use C<guestfs_readdir> instead."
9732 #: ../src/guestfs-actions.pod:3284
9733 msgid "guestfs_lsetxattr"
9737 #: ../src/guestfs-actions.pod:3286
9741 " guestfs_lsetxattr (guestfs_h *g,\n"
9742 " const char *xattr,\n"
9743 " const char *val,\n"
9745 " const char *path);\n"
9750 #: ../src/guestfs-actions.pod:3293
9752 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
9753 "then it sets an extended attribute of the link itself."
9757 #: ../src/guestfs-actions.pod:3301
9758 msgid "guestfs_lstat"
9762 #: ../src/guestfs-actions.pod:3303
9765 " struct guestfs_stat *\n"
9766 " guestfs_lstat (guestfs_h *g,\n"
9767 " const char *path);\n"
9772 #: ../src/guestfs-actions.pod:3307 ../src/guestfs-actions.pod:5734
9773 #: ../fish/guestfish-actions.pod:2240 ../fish/guestfish-actions.pod:3822
9774 msgid "Returns file information for the given C<path>."
9778 #: ../src/guestfs-actions.pod:3309
9780 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
9781 "link, then the link is stat-ed, not the file it refers to."
9785 #: ../src/guestfs-actions.pod:3313 ../fish/guestfish-actions.pod:2246
9786 msgid "This is the same as the C<lstat(2)> system call."
9790 #: ../src/guestfs-actions.pod:3315 ../src/guestfs-actions.pod:5738
9792 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
9793 "error. I<The caller must call C<guestfs_free_stat> after use>."
9797 #: ../src/guestfs-actions.pod:3319 ../src/guestfs-actions.pod:5742
9798 #: ../src/guestfs-actions.pod:5760 ../src/guestfs-actions.pod:6141
9799 msgid "(Added in 0.9.2)"
9803 #: ../src/guestfs-actions.pod:3321
9804 msgid "guestfs_lstatlist"
9808 #: ../src/guestfs-actions.pod:3323
9811 " struct guestfs_stat_list *\n"
9812 " guestfs_lstatlist (guestfs_h *g,\n"
9813 " const char *path,\n"
9814 " char *const *names);\n"
9819 #: ../src/guestfs-actions.pod:3328
9821 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
9822 "files, where all files are in the directory C<path>. C<names> is the list "
9823 "of files from this directory."
9827 #: ../src/guestfs-actions.pod:3332 ../fish/guestfish-actions.pod:2256
9829 "On return you get a list of stat structs, with a one-to-one correspondence "
9830 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9831 "then the C<ino> field of that structure is set to C<-1>."
9835 #: ../src/guestfs-actions.pod:3337
9837 "This call is intended for programs that want to efficiently list a directory "
9838 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
9839 "for a similarly efficient call for getting extended attributes. Very long "
9840 "directory listings might cause the protocol message size to be exceeded, "
9841 "causing this call to fail. The caller must split up such requests into "
9842 "smaller groups of names."
9846 #: ../src/guestfs-actions.pod:3345
9848 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
9849 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
9853 #: ../src/guestfs-actions.pod:3351
9854 msgid "guestfs_luks_add_key"
9858 #: ../src/guestfs-actions.pod:3353
9862 " guestfs_luks_add_key (guestfs_h *g,\n"
9863 " const char *device,\n"
9864 " const char *key,\n"
9865 " const char *newkey,\n"
9871 #: ../src/guestfs-actions.pod:3360 ../fish/guestfish-actions.pod:2273
9873 "This command adds a new key on LUKS device C<device>. C<key> is any "
9874 "existing key, and is used to access the device. C<newkey> is the new key to "
9875 "add. C<keyslot> is the key slot that will be replaced."
9879 #: ../src/guestfs-actions.pod:3365
9881 "Note that if C<keyslot> already contains a key, then this command will "
9882 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
9886 #: ../src/guestfs-actions.pod:3371 ../src/guestfs-actions.pod:3411
9887 #: ../src/guestfs-actions.pod:3434 ../src/guestfs-actions.pod:3454
9888 #: ../src/guestfs-actions.pod:3486 ../src/guestfs-actions.pod:3505
9890 "This function takes a key or passphrase parameter which could contain "
9891 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
9896 #: ../src/guestfs-actions.pod:3375 ../src/guestfs-actions.pod:3415
9897 #: ../src/guestfs-actions.pod:3438 ../src/guestfs-actions.pod:3458
9898 msgid "(Added in 1.5.2)"
9902 #: ../src/guestfs-actions.pod:3377
9903 msgid "guestfs_luks_close"
9907 #: ../src/guestfs-actions.pod:3379
9911 " guestfs_luks_close (guestfs_h *g,\n"
9912 " const char *device);\n"
9917 #: ../src/guestfs-actions.pod:3383
9919 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
9920 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
9921 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
9922 "underlying block device."
9926 #: ../src/guestfs-actions.pod:3391 ../src/guestfs-actions.pod:3490
9927 #: ../src/guestfs-actions.pod:3509 ../src/guestfs-actions.pod:3559
9928 #: ../src/guestfs-actions.pod:3607
9929 msgid "(Added in 1.5.1)"
9933 #: ../src/guestfs-actions.pod:3393
9934 msgid "guestfs_luks_format"
9938 #: ../src/guestfs-actions.pod:3395
9942 " guestfs_luks_format (guestfs_h *g,\n"
9943 " const char *device,\n"
9944 " const char *key,\n"
9950 #: ../src/guestfs-actions.pod:3401 ../fish/guestfish-actions.pod:2299
9952 "This command erases existing data on C<device> and formats the device as a "
9953 "LUKS encrypted device. C<key> is the initial key, which is added to key "
9954 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
9958 #: ../src/guestfs-actions.pod:3408 ../src/guestfs-actions.pod:3431
9959 #: ../src/guestfs-actions.pod:3571 ../src/guestfs-actions.pod:4431
9960 #: ../src/guestfs-actions.pod:5194 ../src/guestfs-actions.pod:5569
9961 #: ../src/guestfs-actions.pod:5592 ../src/guestfs-actions.pod:5618
9962 #: ../src/guestfs-actions.pod:6768 ../fish/guestfish-actions.pod:2307
9963 #: ../fish/guestfish-actions.pod:2320 ../fish/guestfish-actions.pod:2404
9964 #: ../fish/guestfish-actions.pod:2934 ../fish/guestfish-actions.pod:3441
9965 #: ../fish/guestfish-actions.pod:3721 ../fish/guestfish-actions.pod:3737
9966 #: ../fish/guestfish-actions.pod:3752 ../fish/guestfish-actions.pod:4467
9968 "B<This command is dangerous. Without careful use you can easily destroy all "
9973 #: ../src/guestfs-actions.pod:3417
9974 msgid "guestfs_luks_format_cipher"
9978 #: ../src/guestfs-actions.pod:3419
9982 " guestfs_luks_format_cipher (guestfs_h *g,\n"
9983 " const char *device,\n"
9984 " const char *key,\n"
9986 " const char *cipher);\n"
9991 #: ../src/guestfs-actions.pod:3426
9993 "This command is the same as C<guestfs_luks_format> but it also allows you to "
9994 "set the C<cipher> used."
9998 #: ../src/guestfs-actions.pod:3440
9999 msgid "guestfs_luks_kill_slot"
10003 #: ../src/guestfs-actions.pod:3442
10007 " guestfs_luks_kill_slot (guestfs_h *g,\n"
10008 " const char *device,\n"
10009 " const char *key,\n"
10015 #: ../src/guestfs-actions.pod:3448 ../fish/guestfish-actions.pod:2327
10017 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
10018 "device C<device>. C<key> must be one of the I<other> keys."
10022 #: ../src/guestfs-actions.pod:3460
10023 msgid "guestfs_luks_open"
10027 #: ../src/guestfs-actions.pod:3462
10031 " guestfs_luks_open (guestfs_h *g,\n"
10032 " const char *device,\n"
10033 " const char *key,\n"
10034 " const char *mapname);\n"
10039 #: ../src/guestfs-actions.pod:3468 ../fish/guestfish-actions.pod:2338
10041 "This command opens a block device which has been encrypted according to the "
10042 "Linux Unified Key Setup (LUKS) standard."
10046 #: ../src/guestfs-actions.pod:3471 ../fish/guestfish-actions.pod:2341
10047 msgid "C<device> is the encrypted block device or partition."
10051 #: ../src/guestfs-actions.pod:3473 ../fish/guestfish-actions.pod:2343
10053 "The caller must supply one of the keys associated with the LUKS block "
10054 "device, in the C<key> parameter."
10058 #: ../src/guestfs-actions.pod:3476 ../fish/guestfish-actions.pod:2346
10060 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
10061 "writes to this block device are decrypted from and encrypted to the "
10062 "underlying C<device> respectively."
10066 #: ../src/guestfs-actions.pod:3480
10068 "If this block device contains LVM volume groups, then calling "
10069 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
10074 #: ../src/guestfs-actions.pod:3492
10075 msgid "guestfs_luks_open_ro"
10079 #: ../src/guestfs-actions.pod:3494
10083 " guestfs_luks_open_ro (guestfs_h *g,\n"
10084 " const char *device,\n"
10085 " const char *key,\n"
10086 " const char *mapname);\n"
10091 #: ../src/guestfs-actions.pod:3500
10093 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
10098 #: ../src/guestfs-actions.pod:3511
10099 msgid "guestfs_lvcreate"
10103 #: ../src/guestfs-actions.pod:3513
10107 " guestfs_lvcreate (guestfs_h *g,\n"
10108 " const char *logvol,\n"
10109 " const char *volgroup,\n"
10115 #: ../src/guestfs-actions.pod:3519 ../fish/guestfish-actions.pod:2371
10117 "This creates an LVM logical volume called C<logvol> on the volume group "
10118 "C<volgroup>, with C<size> megabytes."
10122 #: ../src/guestfs-actions.pod:3526
10123 msgid "guestfs_lvm_canonical_lv_name"
10127 #: ../src/guestfs-actions.pod:3528
10131 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
10132 " const char *lvname);\n"
10137 #: ../src/guestfs-actions.pod:3532 ../fish/guestfish-actions.pod:2378
10139 "This converts alternative naming schemes for LVs that you might find to the "
10140 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
10145 #: ../src/guestfs-actions.pod:3536 ../fish/guestfish-actions.pod:2382
10147 "This command returns an error if the C<lvname> parameter does not refer to a "
10152 #: ../src/guestfs-actions.pod:3539
10153 msgid "See also C<guestfs_is_lv>."
10157 #: ../src/guestfs-actions.pod:3544
10158 msgid "(Added in 1.5.24)"
10162 #: ../src/guestfs-actions.pod:3546
10163 msgid "guestfs_lvm_clear_filter"
10167 #: ../src/guestfs-actions.pod:3548
10171 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
10176 #: ../src/guestfs-actions.pod:3551
10178 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
10179 "see every block device."
10183 #: ../src/guestfs-actions.pod:3554 ../src/guestfs-actions.pod:3596
10184 #: ../fish/guestfish-actions.pod:2394 ../fish/guestfish-actions.pod:2425
10186 "This command also clears the LVM cache and performs a volume group scan."
10190 #: ../src/guestfs-actions.pod:3561
10191 msgid "guestfs_lvm_remove_all"
10195 #: ../src/guestfs-actions.pod:3563
10199 " guestfs_lvm_remove_all (guestfs_h *g);\n"
10204 #: ../src/guestfs-actions.pod:3566 ../fish/guestfish-actions.pod:2401
10206 "This command removes all LVM logical volumes, volume groups and physical "
10211 #: ../src/guestfs-actions.pod:3576
10212 msgid "guestfs_lvm_set_filter"
10216 #: ../src/guestfs-actions.pod:3578
10220 " guestfs_lvm_set_filter (guestfs_h *g,\n"
10221 " char *const *devices);\n"
10226 #: ../src/guestfs-actions.pod:3582 ../fish/guestfish-actions.pod:2411
10228 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10229 "block devices in the list C<devices>, and will ignore all other attached "
10234 #: ../src/guestfs-actions.pod:3586 ../fish/guestfish-actions.pod:2415
10236 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10237 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10238 "there are two types of duplication possible: either cloned PVs/VGs which "
10239 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10240 "same name. In normal operation you cannot create this situation, but you "
10241 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10242 "inside the LVM metadata."
10246 #: ../src/guestfs-actions.pod:3599 ../fish/guestfish-actions.pod:2428
10247 msgid "You can filter whole block devices or individual partitions."
10251 #: ../src/guestfs-actions.pod:3601 ../fish/guestfish-actions.pod:2430
10253 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10254 "filesystem), even if you are not filtering out that VG."
10258 #: ../src/guestfs-actions.pod:3609
10259 msgid "guestfs_lvremove"
10263 #: ../src/guestfs-actions.pod:3611
10267 " guestfs_lvremove (guestfs_h *g,\n"
10268 " const char *device);\n"
10273 #: ../src/guestfs-actions.pod:3615 ../fish/guestfish-actions.pod:2438
10275 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10276 "LV, such as C</dev/VG/LV>."
10280 #: ../src/guestfs-actions.pod:3618 ../fish/guestfish-actions.pod:2441
10282 "You can also remove all LVs in a volume group by specifying the VG name, C</"
10287 #: ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:4777
10288 #: ../src/guestfs-actions.pod:6507
10289 msgid "(Added in 1.0.13)"
10293 #: ../src/guestfs-actions.pod:3625
10294 msgid "guestfs_lvrename"
10298 #: ../src/guestfs-actions.pod:3627
10302 " guestfs_lvrename (guestfs_h *g,\n"
10303 " const char *logvol,\n"
10304 " const char *newlogvol);\n"
10309 #: ../src/guestfs-actions.pod:3632 ../fish/guestfish-actions.pod:2448
10310 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10314 #: ../src/guestfs-actions.pod:3636 ../src/guestfs-actions.pod:6520
10315 msgid "(Added in 1.0.83)"
10319 #: ../src/guestfs-actions.pod:3638
10320 msgid "guestfs_lvresize"
10324 #: ../src/guestfs-actions.pod:3640
10328 " guestfs_lvresize (guestfs_h *g,\n"
10329 " const char *device,\n"
10335 #: ../src/guestfs-actions.pod:3645 ../fish/guestfish-actions.pod:2454
10337 "This resizes (expands or shrinks) an existing LVM logical volume to "
10338 "C<mbytes>. When reducing, data in the reduced part is lost."
10342 #: ../src/guestfs-actions.pod:3653
10343 msgid "guestfs_lvresize_free"
10347 #: ../src/guestfs-actions.pod:3655
10351 " guestfs_lvresize_free (guestfs_h *g,\n"
10352 " const char *lv,\n"
10358 #: ../src/guestfs-actions.pod:3660 ../fish/guestfish-actions.pod:2462
10360 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10361 "remaining free space in the volume group. Commonly you would call this with "
10362 "pc = 100 which expands the logical volume as much as possible, using all "
10363 "remaining free space in the volume group."
10367 #: ../src/guestfs-actions.pod:3668
10368 msgid "(Added in 1.3.3)"
10372 #: ../src/guestfs-actions.pod:3670
10373 msgid "guestfs_lvs"
10377 #: ../src/guestfs-actions.pod:3672
10381 " guestfs_lvs (guestfs_h *g);\n"
10386 #: ../src/guestfs-actions.pod:3675 ../fish/guestfish-actions.pod:2472
10388 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10393 #: ../src/guestfs-actions.pod:3678 ../fish/guestfish-actions.pod:2475
10395 "This returns a list of the logical volume device names (eg. C</dev/"
10396 "VolGroup00/LogVol00>)."
10400 #: ../src/guestfs-actions.pod:3681
10401 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
10405 #: ../src/guestfs-actions.pod:3689
10406 msgid "guestfs_lvs_full"
10410 #: ../src/guestfs-actions.pod:3691
10413 " struct guestfs_lvm_lv_list *\n"
10414 " guestfs_lvs_full (guestfs_h *g);\n"
10419 #: ../src/guestfs-actions.pod:3694 ../fish/guestfish-actions.pod:2484
10421 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10422 "(8)> command. The \"full\" version includes all fields."
10426 #: ../src/guestfs-actions.pod:3697
10428 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
10429 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
10433 #: ../src/guestfs-actions.pod:3703
10434 msgid "guestfs_lvuuid"
10438 #: ../src/guestfs-actions.pod:3705
10442 " guestfs_lvuuid (guestfs_h *g,\n"
10443 " const char *device);\n"
10448 #: ../src/guestfs-actions.pod:3709 ../fish/guestfish-actions.pod:2491
10449 msgid "This command returns the UUID of the LVM LV C<device>."
10453 #: ../src/guestfs-actions.pod:3716
10454 msgid "guestfs_lxattrlist"
10458 #: ../src/guestfs-actions.pod:3718
10461 " struct guestfs_xattr_list *\n"
10462 " guestfs_lxattrlist (guestfs_h *g,\n"
10463 " const char *path,\n"
10464 " char *const *names);\n"
10469 #: ../src/guestfs-actions.pod:3723 ../fish/guestfish-actions.pod:2497
10471 "This call allows you to get the extended attributes of multiple files, where "
10472 "all files are in the directory C<path>. C<names> is the list of files from "
10477 #: ../src/guestfs-actions.pod:3727 ../fish/guestfish-actions.pod:2501
10479 "On return you get a flat list of xattr structs which must be interpreted "
10480 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10481 "C<attrval> in this struct is zero-length to indicate there was an error "
10482 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10483 "number (the number of following attributes for this file, which could be C<"
10484 "\"0\">). Then after the first xattr struct are the zero or more attributes "
10485 "for the first named file. This repeats for the second and subsequent files."
10489 #: ../src/guestfs-actions.pod:3737
10491 "This call is intended for programs that want to efficiently list a directory "
10492 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
10493 "a similarly efficient call for getting standard stats. Very long directory "
10494 "listings might cause the protocol message size to be exceeded, causing this "
10495 "call to fail. The caller must split up such requests into smaller groups of "
10500 #: ../src/guestfs-actions.pod:3751
10501 msgid "guestfs_mkdir"
10505 #: ../src/guestfs-actions.pod:3753
10509 " guestfs_mkdir (guestfs_h *g,\n"
10510 " const char *path);\n"
10515 #: ../src/guestfs-actions.pod:3757 ../fish/guestfish-actions.pod:2523
10516 msgid "Create a directory named C<path>."
10520 #: ../src/guestfs-actions.pod:3763
10521 msgid "guestfs_mkdir_mode"
10525 #: ../src/guestfs-actions.pod:3765
10529 " guestfs_mkdir_mode (guestfs_h *g,\n"
10530 " const char *path,\n"
10536 #: ../src/guestfs-actions.pod:3770 ../fish/guestfish-actions.pod:2529
10538 "This command creates a directory, setting the initial permissions of the "
10539 "directory to C<mode>."
10543 #: ../src/guestfs-actions.pod:3773 ../fish/guestfish-actions.pod:2532
10545 "For common Linux filesystems, the actual mode which is set will be C<mode & "
10546 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
10551 #: ../src/guestfs-actions.pod:3777
10552 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
10556 #: ../src/guestfs-actions.pod:3783
10557 msgid "guestfs_mkdir_p"
10561 #: ../src/guestfs-actions.pod:3785
10565 " guestfs_mkdir_p (guestfs_h *g,\n"
10566 " const char *path);\n"
10571 #: ../src/guestfs-actions.pod:3789 ../fish/guestfish-actions.pod:2542
10573 "Create a directory named C<path>, creating any parent directories as "
10574 "necessary. This is like the C<mkdir -p> shell command."
10578 #: ../src/guestfs-actions.pod:3796
10579 msgid "guestfs_mkdtemp"
10583 #: ../src/guestfs-actions.pod:3798
10587 " guestfs_mkdtemp (guestfs_h *g,\n"
10588 " const char *template);\n"
10593 #: ../src/guestfs-actions.pod:3802 ../fish/guestfish-actions.pod:2549
10595 "This command creates a temporary directory. The C<template> parameter "
10596 "should be a full pathname for the temporary directory name with the final "
10597 "six characters being \"XXXXXX\"."
10601 #: ../src/guestfs-actions.pod:3807 ../fish/guestfish-actions.pod:2554
10603 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10604 "being suitable for Windows filesystems."
10608 #: ../src/guestfs-actions.pod:3810 ../fish/guestfish-actions.pod:2557
10609 msgid "The name of the temporary directory that was created is returned."
10613 #: ../src/guestfs-actions.pod:3813 ../fish/guestfish-actions.pod:2560
10614 msgid "The temporary directory is created with mode 0700 and is owned by root."
10618 #: ../src/guestfs-actions.pod:3816 ../fish/guestfish-actions.pod:2563
10620 "The caller is responsible for deleting the temporary directory and its "
10621 "contents after use."
10625 #: ../src/guestfs-actions.pod:3819 ../fish/guestfish-actions.pod:2566
10626 msgid "See also: L<mkdtemp(3)>"
10630 #: ../src/guestfs-actions.pod:3826
10631 msgid "guestfs_mke2fs_J"
10635 #: ../src/guestfs-actions.pod:3828
10639 " guestfs_mke2fs_J (guestfs_h *g,\n"
10640 " const char *fstype,\n"
10641 " int blocksize,\n"
10642 " const char *device,\n"
10643 " const char *journal);\n"
10648 #: ../src/guestfs-actions.pod:3835 ../fish/guestfish-actions.pod:2572
10650 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10651 "C<journal>. It is equivalent to the command:"
10655 #: ../src/guestfs-actions.pod:3839 ../fish/guestfish-actions.pod:2576
10658 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10663 #: ../src/guestfs-actions.pod:3841
10664 msgid "See also C<guestfs_mke2journal>."
10668 #: ../src/guestfs-actions.pod:3845 ../src/guestfs-actions.pod:3863
10669 #: ../src/guestfs-actions.pod:3881 ../src/guestfs-actions.pod:3897
10670 #: ../src/guestfs-actions.pod:3911 ../src/guestfs-actions.pod:3925
10671 #: ../src/guestfs-actions.pod:3977 ../src/guestfs-actions.pod:4167
10672 msgid "(Added in 1.0.68)"
10676 #: ../src/guestfs-actions.pod:3847
10677 msgid "guestfs_mke2fs_JL"
10681 #: ../src/guestfs-actions.pod:3849
10685 " guestfs_mke2fs_JL (guestfs_h *g,\n"
10686 " const char *fstype,\n"
10687 " int blocksize,\n"
10688 " const char *device,\n"
10689 " const char *label);\n"
10694 #: ../src/guestfs-actions.pod:3856 ../fish/guestfish-actions.pod:2584
10696 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10697 "the journal labeled C<label>."
10701 #: ../src/guestfs-actions.pod:3859
10702 msgid "See also C<guestfs_mke2journal_L>."
10706 #: ../src/guestfs-actions.pod:3865
10707 msgid "guestfs_mke2fs_JU"
10711 #: ../src/guestfs-actions.pod:3867
10715 " guestfs_mke2fs_JU (guestfs_h *g,\n"
10716 " const char *fstype,\n"
10717 " int blocksize,\n"
10718 " const char *device,\n"
10719 " const char *uuid);\n"
10724 #: ../src/guestfs-actions.pod:3874 ../fish/guestfish-actions.pod:2593
10726 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10727 "the journal with UUID C<uuid>."
10731 #: ../src/guestfs-actions.pod:3877
10732 msgid "See also C<guestfs_mke2journal_U>."
10736 #: ../src/guestfs-actions.pod:3883
10737 msgid "guestfs_mke2journal"
10741 #: ../src/guestfs-actions.pod:3885
10745 " guestfs_mke2journal (guestfs_h *g,\n"
10746 " int blocksize,\n"
10747 " const char *device);\n"
10752 #: ../src/guestfs-actions.pod:3890 ../fish/guestfish-actions.pod:2602
10754 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10759 #: ../src/guestfs-actions.pod:3893 ../fish/guestfish-actions.pod:2605
10762 " mke2fs -O journal_dev -b blocksize device\n"
10767 #: ../src/guestfs-actions.pod:3899
10768 msgid "guestfs_mke2journal_L"
10772 #: ../src/guestfs-actions.pod:3901
10776 " guestfs_mke2journal_L (guestfs_h *g,\n"
10777 " int blocksize,\n"
10778 " const char *label,\n"
10779 " const char *device);\n"
10784 #: ../src/guestfs-actions.pod:3907 ../fish/guestfish-actions.pod:2611
10785 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10789 #: ../src/guestfs-actions.pod:3913
10790 msgid "guestfs_mke2journal_U"
10794 #: ../src/guestfs-actions.pod:3915
10798 " guestfs_mke2journal_U (guestfs_h *g,\n"
10799 " int blocksize,\n"
10800 " const char *uuid,\n"
10801 " const char *device);\n"
10806 #: ../src/guestfs-actions.pod:3921 ../fish/guestfish-actions.pod:2617
10807 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10811 #: ../src/guestfs-actions.pod:3927
10812 msgid "guestfs_mkfifo"
10816 #: ../src/guestfs-actions.pod:3929
10820 " guestfs_mkfifo (guestfs_h *g,\n"
10822 " const char *path);\n"
10827 #: ../src/guestfs-actions.pod:3934
10829 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10830 "is just a convenient wrapper around C<guestfs_mknod>."
10834 #: ../src/guestfs-actions.pod:3944
10835 msgid "guestfs_mkfs"
10839 #: ../src/guestfs-actions.pod:3946
10843 " guestfs_mkfs (guestfs_h *g,\n"
10844 " const char *fstype,\n"
10845 " const char *device);\n"
10850 #: ../src/guestfs-actions.pod:3951 ../fish/guestfish-actions.pod:2633
10852 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10853 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10857 #: ../src/guestfs-actions.pod:3959
10858 msgid "guestfs_mkfs_b"
10862 #: ../src/guestfs-actions.pod:3961
10866 " guestfs_mkfs_b (guestfs_h *g,\n"
10867 " const char *fstype,\n"
10868 " int blocksize,\n"
10869 " const char *device);\n"
10874 #: ../src/guestfs-actions.pod:3967
10876 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
10877 "block size of the resulting filesystem. Supported block sizes depend on the "
10878 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10882 #: ../src/guestfs-actions.pod:3972 ../fish/guestfish-actions.pod:2646
10884 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10889 #: ../src/guestfs-actions.pod:3979
10890 msgid "guestfs_mkmountpoint"
10894 #: ../src/guestfs-actions.pod:3981
10898 " guestfs_mkmountpoint (guestfs_h *g,\n"
10899 " const char *exemptpath);\n"
10904 #: ../src/guestfs-actions.pod:3985
10906 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
10907 "that can be used to create extra mountpoints before mounting the first "
10912 #: ../src/guestfs-actions.pod:3989 ../fish/guestfish-actions.pod:2657
10914 "These calls are I<only> necessary in some very limited circumstances, mainly "
10915 "the case where you want to mount a mix of unrelated and/or read-only "
10916 "filesystems together."
10920 #: ../src/guestfs-actions.pod:3993 ../fish/guestfish-actions.pod:2661
10922 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10923 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10924 "inside that. You can unpack this as follows in guestfish:"
10928 #: ../src/guestfs-actions.pod:3998 ../fish/guestfish-actions.pod:2666
10931 " add-ro Fedora-11-i686-Live.iso\n"
10933 " mkmountpoint /cd\n"
10934 " mkmountpoint /sqsh\n"
10935 " mkmountpoint /ext3fs\n"
10936 " mount /dev/sda /cd\n"
10937 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10938 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10943 #: ../src/guestfs-actions.pod:4007 ../fish/guestfish-actions.pod:2675
10944 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
10948 #: ../src/guestfs-actions.pod:4009
10950 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
10951 "may get unexpected errors if you try to mix these calls. It is safest to "
10952 "manually unmount filesystems and remove mountpoints after use."
10956 #: ../src/guestfs-actions.pod:4013
10958 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
10959 "first, so for this to work for manual mountpoints, you must ensure that the "
10960 "innermost mountpoints have the longest pathnames, as in the example code "
10965 #: ../src/guestfs-actions.pod:4018 ../fish/guestfish-actions.pod:2686
10967 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
10971 #: ../src/guestfs-actions.pod:4020
10973 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
10974 "means that C<guestfs_umount_all> is called when the handle is closed which "
10975 "can also trigger these issues."
10979 #: ../src/guestfs-actions.pod:4026 ../src/guestfs-actions.pod:4285
10980 #: ../src/guestfs-actions.pod:5178
10981 msgid "(Added in 1.0.62)"
10985 #: ../src/guestfs-actions.pod:4028
10986 msgid "guestfs_mknod"
10990 #: ../src/guestfs-actions.pod:4030
10994 " guestfs_mknod (guestfs_h *g,\n"
10998 " const char *path);\n"
11003 #: ../src/guestfs-actions.pod:4037 ../fish/guestfish-actions.pod:2696
11005 "This call creates block or character special devices, or named pipes (FIFOs)."
11009 #: ../src/guestfs-actions.pod:4040 ../fish/guestfish-actions.pod:2699
11011 "The C<mode> parameter should be the mode, using the standard constants. "
11012 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
11013 "used when creating block and character special devices."
11017 #: ../src/guestfs-actions.pod:4045
11019 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
11020 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
11021 "regular file). These constants are available in the standard Linux header "
11022 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
11023 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
11024 "the appropriate constant for you."
11028 #: ../src/guestfs-actions.pod:4059
11029 msgid "guestfs_mknod_b"
11033 #: ../src/guestfs-actions.pod:4061
11037 " guestfs_mknod_b (guestfs_h *g,\n"
11041 " const char *path);\n"
11046 #: ../src/guestfs-actions.pod:4068
11048 "This call creates a block device node called C<path> with mode C<mode> and "
11049 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11050 "wrapper around C<guestfs_mknod>."
11054 #: ../src/guestfs-actions.pod:4078
11055 msgid "guestfs_mknod_c"
11059 #: ../src/guestfs-actions.pod:4080
11063 " guestfs_mknod_c (guestfs_h *g,\n"
11067 " const char *path);\n"
11072 #: ../src/guestfs-actions.pod:4087
11074 "This call creates a char device node called C<path> with mode C<mode> and "
11075 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11076 "wrapper around C<guestfs_mknod>."
11080 #: ../src/guestfs-actions.pod:4097
11081 msgid "guestfs_mkswap"
11085 #: ../src/guestfs-actions.pod:4099
11089 " guestfs_mkswap (guestfs_h *g,\n"
11090 " const char *device);\n"
11095 #: ../src/guestfs-actions.pod:4103 ../fish/guestfish-actions.pod:2738
11096 msgid "Create a swap partition on C<device>."
11100 #: ../src/guestfs-actions.pod:4109
11101 msgid "guestfs_mkswap_L"
11105 #: ../src/guestfs-actions.pod:4111
11109 " guestfs_mkswap_L (guestfs_h *g,\n"
11110 " const char *label,\n"
11111 " const char *device);\n"
11116 #: ../src/guestfs-actions.pod:4116 ../fish/guestfish-actions.pod:2744
11117 msgid "Create a swap partition on C<device> with label C<label>."
11121 #: ../src/guestfs-actions.pod:4118 ../fish/guestfish-actions.pod:2746
11123 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
11124 "sda>), just to a partition. This appears to be a limitation of the kernel "
11129 #: ../src/guestfs-actions.pod:4126
11130 msgid "guestfs_mkswap_U"
11134 #: ../src/guestfs-actions.pod:4128
11138 " guestfs_mkswap_U (guestfs_h *g,\n"
11139 " const char *uuid,\n"
11140 " const char *device);\n"
11145 #: ../src/guestfs-actions.pod:4133 ../fish/guestfish-actions.pod:2754
11146 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11150 #: ../src/guestfs-actions.pod:4139
11151 msgid "guestfs_mkswap_file"
11155 #: ../src/guestfs-actions.pod:4141
11159 " guestfs_mkswap_file (guestfs_h *g,\n"
11160 " const char *path);\n"
11165 #: ../src/guestfs-actions.pod:4145 ../fish/guestfish-actions.pod:2760
11166 msgid "Create a swap file."
11170 #: ../src/guestfs-actions.pod:4147
11172 "This command just writes a swap file signature to an existing file. To "
11173 "create the file itself, use something like C<guestfs_fallocate>."
11177 #: ../src/guestfs-actions.pod:4154
11178 msgid "guestfs_modprobe"
11182 #: ../src/guestfs-actions.pod:4156
11186 " guestfs_modprobe (guestfs_h *g,\n"
11187 " const char *modulename);\n"
11192 #: ../src/guestfs-actions.pod:4160 ../fish/guestfish-actions.pod:2769
11193 msgid "This loads a kernel module in the appliance."
11197 #: ../src/guestfs-actions.pod:4162 ../fish/guestfish-actions.pod:2771
11199 "The kernel module must have been whitelisted when libguestfs was built (see "
11200 "C<appliance/kmod.whitelist.in> in the source)."
11204 #: ../src/guestfs-actions.pod:4169
11205 msgid "guestfs_mount"
11209 #: ../src/guestfs-actions.pod:4171
11213 " guestfs_mount (guestfs_h *g,\n"
11214 " const char *device,\n"
11215 " const char *mountpoint);\n"
11220 #: ../src/guestfs-actions.pod:4176 ../fish/guestfish-actions.pod:2778
11222 "Mount a guest disk at a position in the filesystem. Block devices are named "
11223 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11224 "those block devices contain partitions, they will have the usual names (eg. "
11225 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11229 #: ../src/guestfs-actions.pod:4182 ../fish/guestfish-actions.pod:2784
11231 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11232 "mounted on C</> before others can be mounted. Other filesystems can only be "
11233 "mounted on directories which already exist."
11237 #: ../src/guestfs-actions.pod:4187 ../fish/guestfish-actions.pod:2789
11239 "The mounted filesystem is writable, if we have sufficient permissions on the "
11240 "underlying device."
11244 #: ../src/guestfs-actions.pod:4190
11246 "B<Important note:> When you use this call, the filesystem options C<sync> "
11247 "and C<noatime> are set implicitly. This was originally done because we "
11248 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11249 "very large negative performance impact and negligible effect on "
11250 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
11251 "in any code that needs performance, and instead use C<guestfs_mount_options> "
11252 "(use an empty string for the first parameter if you don't want any options)."
11256 #: ../src/guestfs-actions.pod:4204
11257 msgid "guestfs_mount_loop"
11261 #: ../src/guestfs-actions.pod:4206
11265 " guestfs_mount_loop (guestfs_h *g,\n"
11266 " const char *file,\n"
11267 " const char *mountpoint);\n"
11272 #: ../src/guestfs-actions.pod:4211 ../fish/guestfish-actions.pod:2806
11274 "This command lets you mount C<file> (a filesystem image in a file) on a "
11275 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11280 #: ../src/guestfs-actions.pod:4219
11281 msgid "guestfs_mount_options"
11285 #: ../src/guestfs-actions.pod:4221
11289 " guestfs_mount_options (guestfs_h *g,\n"
11290 " const char *options,\n"
11291 " const char *device,\n"
11292 " const char *mountpoint);\n"
11297 #: ../src/guestfs-actions.pod:4227
11299 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11300 "the mount options as for the L<mount(8)> I<-o> flag."
11304 #: ../src/guestfs-actions.pod:4231 ../fish/guestfish-actions.pod:2818
11306 "If the C<options> parameter is an empty string, then no options are passed "
11307 "(all options default to whatever the filesystem uses)."
11311 #: ../src/guestfs-actions.pod:4237 ../src/guestfs-actions.pod:4251
11312 #: ../src/guestfs-actions.pod:4268
11313 msgid "(Added in 1.0.10)"
11317 #: ../src/guestfs-actions.pod:4239
11318 msgid "guestfs_mount_ro"
11322 #: ../src/guestfs-actions.pod:4241
11326 " guestfs_mount_ro (guestfs_h *g,\n"
11327 " const char *device,\n"
11328 " const char *mountpoint);\n"
11333 #: ../src/guestfs-actions.pod:4246
11335 "This is the same as the C<guestfs_mount> command, but it mounts the "
11336 "filesystem with the read-only (I<-o ro>) flag."
11340 #: ../src/guestfs-actions.pod:4253
11341 msgid "guestfs_mount_vfs"
11345 #: ../src/guestfs-actions.pod:4255
11349 " guestfs_mount_vfs (guestfs_h *g,\n"
11350 " const char *options,\n"
11351 " const char *vfstype,\n"
11352 " const char *device,\n"
11353 " const char *mountpoint);\n"
11358 #: ../src/guestfs-actions.pod:4262
11360 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11361 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
11366 #: ../src/guestfs-actions.pod:4270
11367 msgid "guestfs_mountpoints"
11371 #: ../src/guestfs-actions.pod:4272
11375 " guestfs_mountpoints (guestfs_h *g);\n"
11380 #: ../src/guestfs-actions.pod:4275
11382 "This call is similar to C<guestfs_mounts>. That call returns a list of "
11383 "devices. This one returns a hash table (map) of device name to directory "
11384 "where the device is mounted."
11388 #: ../src/guestfs-actions.pod:4287
11389 msgid "guestfs_mounts"
11393 #: ../src/guestfs-actions.pod:4289
11397 " guestfs_mounts (guestfs_h *g);\n"
11402 #: ../src/guestfs-actions.pod:4292 ../fish/guestfish-actions.pod:2849
11404 "This returns the list of currently mounted filesystems. It returns the list "
11405 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11409 #: ../src/guestfs-actions.pod:4295 ../fish/guestfish-actions.pod:2852
11410 msgid "Some internal mounts are not shown."
11414 #: ../src/guestfs-actions.pod:4297
11415 msgid "See also: C<guestfs_mountpoints>"
11419 #: ../src/guestfs-actions.pod:4305
11424 #: ../src/guestfs-actions.pod:4307
11428 " guestfs_mv (guestfs_h *g,\n"
11429 " const char *src,\n"
11430 " const char *dest);\n"
11435 #: ../src/guestfs-actions.pod:4312 ../fish/guestfish-actions.pod:2860
11437 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11438 "destination filename or destination directory."
11442 #: ../src/guestfs-actions.pod:4319
11443 msgid "guestfs_ntfs_3g_probe"
11447 #: ../src/guestfs-actions.pod:4321
11451 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
11453 " const char *device);\n"
11458 #: ../src/guestfs-actions.pod:4326 ../fish/guestfish-actions.pod:2867
11460 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11461 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
11462 "write, and some cannot be mounted at all)."
11466 #: ../src/guestfs-actions.pod:4330 ../fish/guestfish-actions.pod:2871
11468 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11469 "can be mounted read-write. Set it to false if you want to test if the "
11470 "volume can be mounted read-only."
11474 #: ../src/guestfs-actions.pod:4334 ../fish/guestfish-actions.pod:2875
11476 "The return value is an integer which C<0> if the operation would succeed, or "
11477 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11481 #: ../src/guestfs-actions.pod:4340
11482 msgid "(Added in 1.0.43)"
11486 #: ../src/guestfs-actions.pod:4342
11487 msgid "guestfs_ntfsresize"
11491 #: ../src/guestfs-actions.pod:4344
11495 " guestfs_ntfsresize (guestfs_h *g,\n"
11496 " const char *device);\n"
11501 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2883
11503 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
11504 "size of the underlying device. See also L<ntfsresize(8)>."
11508 #: ../src/guestfs-actions.pod:4356
11509 msgid "guestfs_ntfsresize_size"
11513 #: ../src/guestfs-actions.pod:4358
11517 " guestfs_ntfsresize_size (guestfs_h *g,\n"
11518 " const char *device,\n"
11519 " int64_t size);\n"
11524 #: ../src/guestfs-actions.pod:4363
11526 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
11527 "to specify the new size (in bytes) explicitly."
11531 #: ../src/guestfs-actions.pod:4368 ../src/guestfs-actions.pod:4804
11532 #: ../src/guestfs-actions.pod:4877 ../src/guestfs-actions.pod:5126
11533 msgid "(Added in 1.3.14)"
11537 #: ../src/guestfs-actions.pod:4370
11538 msgid "guestfs_part_add"
11542 #: ../src/guestfs-actions.pod:4372
11546 " guestfs_part_add (guestfs_h *g,\n"
11547 " const char *device,\n"
11548 " const char *prlogex,\n"
11549 " int64_t startsect,\n"
11550 " int64_t endsect);\n"
11555 #: ../src/guestfs-actions.pod:4379
11557 "This command adds a partition to C<device>. If there is no partition table "
11558 "on the device, call C<guestfs_part_init> first."
11562 #: ../src/guestfs-actions.pod:4382 ../fish/guestfish-actions.pod:2901
11564 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11565 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11566 "C<logical>) and C<e> (or C<extended>) partition types."
11570 #: ../src/guestfs-actions.pod:4387 ../fish/guestfish-actions.pod:2906
11572 "C<startsect> and C<endsect> are the start and end of the partition in "
11573 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11574 "from the end of the disk (C<-1> is the last sector)."
11578 #: ../src/guestfs-actions.pod:4391
11580 "Creating a partition which covers the whole disk is not so easy. Use "
11581 "C<guestfs_part_disk> to do that."
11585 #: ../src/guestfs-actions.pod:4396 ../src/guestfs-actions.pod:4434
11586 #: ../src/guestfs-actions.pod:4487 ../src/guestfs-actions.pod:4565
11587 #: ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:4622
11588 #: ../src/guestfs-actions.pod:4662
11589 msgid "(Added in 1.0.78)"
11593 #: ../src/guestfs-actions.pod:4398
11594 msgid "guestfs_part_del"
11598 #: ../src/guestfs-actions.pod:4400
11602 " guestfs_part_del (guestfs_h *g,\n"
11603 " const char *device,\n"
11609 #: ../src/guestfs-actions.pod:4405 ../fish/guestfish-actions.pod:2917
11610 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11614 #: ../src/guestfs-actions.pod:4407 ../fish/guestfish-actions.pod:2919
11616 "Note that in the case of MBR partitioning, deleting an extended partition "
11617 "also deletes any logical partitions it contains."
11621 #: ../src/guestfs-actions.pod:4415
11622 msgid "guestfs_part_disk"
11626 #: ../src/guestfs-actions.pod:4417
11630 " guestfs_part_disk (guestfs_h *g,\n"
11631 " const char *device,\n"
11632 " const char *parttype);\n"
11637 #: ../src/guestfs-actions.pod:4422
11639 "This command is simply a combination of C<guestfs_part_init> followed by "
11640 "C<guestfs_part_add> to create a single primary partition covering the whole "
11645 #: ../src/guestfs-actions.pod:4426
11647 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11648 "possible values are described in C<guestfs_part_init>."
11652 #: ../src/guestfs-actions.pod:4436
11653 msgid "guestfs_part_get_bootable"
11657 #: ../src/guestfs-actions.pod:4438
11661 " guestfs_part_get_bootable (guestfs_h *g,\n"
11662 " const char *device,\n"
11668 #: ../src/guestfs-actions.pod:4443 ../fish/guestfish-actions.pod:2941
11670 "This command returns true if the partition C<partnum> on C<device> has the "
11671 "bootable flag set."
11675 #: ../src/guestfs-actions.pod:4446
11676 msgid "See also C<guestfs_part_set_bootable>."
11680 #: ../src/guestfs-actions.pod:4452
11681 msgid "guestfs_part_get_mbr_id"
11685 #: ../src/guestfs-actions.pod:4454
11689 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
11690 " const char *device,\n"
11696 #: ../src/guestfs-actions.pod:4459 ../fish/guestfish-actions.pod:2950
11698 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11699 "partition C<partnum>."
11703 #: ../src/guestfs-actions.pod:4462 ../src/guestfs-actions.pod:4638
11705 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11706 "undefined results for other partition table types (see "
11707 "C<guestfs_part_get_parttype>)."
11711 #: ../src/guestfs-actions.pod:4470
11712 msgid "guestfs_part_get_parttype"
11716 #: ../src/guestfs-actions.pod:4472
11720 " guestfs_part_get_parttype (guestfs_h *g,\n"
11721 " const char *device);\n"
11726 #: ../src/guestfs-actions.pod:4476 ../fish/guestfish-actions.pod:2961
11728 "This command examines the partition table on C<device> and returns the "
11729 "partition table type (format) being used."
11733 #: ../src/guestfs-actions.pod:4479
11735 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11736 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11737 "possible, although unusual. See C<guestfs_part_init> for a full list."
11741 #: ../src/guestfs-actions.pod:4489
11742 msgid "guestfs_part_init"
11746 #: ../src/guestfs-actions.pod:4491
11750 " guestfs_part_init (guestfs_h *g,\n"
11751 " const char *device,\n"
11752 " const char *parttype);\n"
11757 #: ../src/guestfs-actions.pod:4496 ../fish/guestfish-actions.pod:2973
11759 "This creates an empty partition table on C<device> of one of the partition "
11760 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11761 "(for large disks)."
11765 #: ../src/guestfs-actions.pod:4500
11767 "Initially there are no partitions. Following this, you should call "
11768 "C<guestfs_part_add> for each partition required."
11772 #: ../src/guestfs-actions.pod:4503 ../fish/guestfish-actions.pod:2980
11773 msgid "Possible values for C<parttype> are:"
11777 #: ../src/guestfs-actions.pod:4507 ../fish/guestfish-actions.pod:2984
11778 msgid "B<efi> | B<gpt>"
11782 #: ../src/guestfs-actions.pod:4509 ../fish/guestfish-actions.pod:2986
11783 msgid "Intel EFI / GPT partition table."
11787 #: ../src/guestfs-actions.pod:4511 ../fish/guestfish-actions.pod:2988
11789 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11790 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11791 "the C<mbr> format."
11795 #: ../src/guestfs-actions.pod:4515 ../fish/guestfish-actions.pod:2992
11796 msgid "B<mbr> | B<msdos>"
11800 #: ../src/guestfs-actions.pod:4517 ../fish/guestfish-actions.pod:2994
11802 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11803 "Windows. This partition type will B<only> work for device sizes up to 2 "
11804 "TB. For large disks we recommend using C<gpt>."
11808 #: ../src/guestfs-actions.pod:4524 ../fish/guestfish-actions.pod:3001
11810 "Other partition table types that may work but are not supported include:"
11814 #: ../src/guestfs-actions.pod:4529 ../fish/guestfish-actions.pod:3006
11819 #: ../src/guestfs-actions.pod:4531 ../fish/guestfish-actions.pod:3008
11820 msgid "AIX disk labels."
11824 #: ../src/guestfs-actions.pod:4533 ../fish/guestfish-actions.pod:3010
11825 msgid "B<amiga> | B<rdb>"
11829 #: ../src/guestfs-actions.pod:4535 ../fish/guestfish-actions.pod:3012
11830 msgid "Amiga \"Rigid Disk Block\" format."
11834 #: ../src/guestfs-actions.pod:4537 ../fish/guestfish-actions.pod:3014
11839 #: ../src/guestfs-actions.pod:4539 ../fish/guestfish-actions.pod:3016
11840 msgid "BSD disk labels."
11844 #: ../src/guestfs-actions.pod:4541 ../fish/guestfish-actions.pod:3018
11849 #: ../src/guestfs-actions.pod:4543 ../fish/guestfish-actions.pod:3020
11850 msgid "DASD, used on IBM mainframes."
11854 #: ../src/guestfs-actions.pod:4545 ../fish/guestfish-actions.pod:3022
11859 #: ../src/guestfs-actions.pod:4547 ../fish/guestfish-actions.pod:3024
11860 msgid "MIPS/SGI volumes."
11864 #: ../src/guestfs-actions.pod:4549 ../fish/guestfish-actions.pod:3026
11869 #: ../src/guestfs-actions.pod:4551 ../fish/guestfish-actions.pod:3028
11870 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11874 #: ../src/guestfs-actions.pod:4553 ../fish/guestfish-actions.pod:3030
11879 #: ../src/guestfs-actions.pod:4555 ../fish/guestfish-actions.pod:3032
11880 msgid "NEC PC-98 format, common in Japan apparently."
11884 #: ../src/guestfs-actions.pod:4557 ../fish/guestfish-actions.pod:3034
11889 #: ../src/guestfs-actions.pod:4559 ../fish/guestfish-actions.pod:3036
11890 msgid "Sun disk labels."
11894 #: ../src/guestfs-actions.pod:4567
11895 msgid "guestfs_part_list"
11899 #: ../src/guestfs-actions.pod:4569
11902 " struct guestfs_partition_list *\n"
11903 " guestfs_part_list (guestfs_h *g,\n"
11904 " const char *device);\n"
11909 #: ../src/guestfs-actions.pod:4573 ../fish/guestfish-actions.pod:3044
11911 "This command parses the partition table on C<device> and returns the list of "
11912 "partitions found."
11916 #: ../src/guestfs-actions.pod:4576 ../fish/guestfish-actions.pod:3047
11917 msgid "The fields in the returned structure are:"
11921 #: ../src/guestfs-actions.pod:4580 ../fish/guestfish-actions.pod:3051
11922 msgid "B<part_num>"
11926 #: ../src/guestfs-actions.pod:4582 ../fish/guestfish-actions.pod:3053
11927 msgid "Partition number, counting from 1."
11931 #: ../src/guestfs-actions.pod:4584 ../fish/guestfish-actions.pod:3055
11932 msgid "B<part_start>"
11936 #: ../src/guestfs-actions.pod:4586
11938 "Start of the partition I<in bytes>. To get sectors you have to divide by "
11939 "the device's sector size, see C<guestfs_blockdev_getss>."
11943 #: ../src/guestfs-actions.pod:4589 ../fish/guestfish-actions.pod:3060
11944 msgid "B<part_end>"
11948 #: ../src/guestfs-actions.pod:4591 ../fish/guestfish-actions.pod:3062
11949 msgid "End of the partition in bytes."
11953 #: ../src/guestfs-actions.pod:4593 ../fish/guestfish-actions.pod:3064
11954 msgid "B<part_size>"
11958 #: ../src/guestfs-actions.pod:4595 ../fish/guestfish-actions.pod:3066
11959 msgid "Size of the partition in bytes."
11963 #: ../src/guestfs-actions.pod:4599
11965 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
11966 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
11971 #: ../src/guestfs-actions.pod:4605
11972 msgid "guestfs_part_set_bootable"
11976 #: ../src/guestfs-actions.pod:4607
11980 " guestfs_part_set_bootable (guestfs_h *g,\n"
11981 " const char *device,\n"
11983 " int bootable);\n"
11988 #: ../src/guestfs-actions.pod:4613 ../fish/guestfish-actions.pod:3074
11990 "This sets the bootable flag on partition numbered C<partnum> on device "
11991 "C<device>. Note that partitions are numbered from 1."
11995 #: ../src/guestfs-actions.pod:4616 ../fish/guestfish-actions.pod:3077
11997 "The bootable flag is used by some operating systems (notably Windows) to "
11998 "determine which partition to boot from. It is by no means universally "
12003 #: ../src/guestfs-actions.pod:4624
12004 msgid "guestfs_part_set_mbr_id"
12008 #: ../src/guestfs-actions.pod:4626
12012 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
12013 " const char *device,\n"
12020 #: ../src/guestfs-actions.pod:4632 ../fish/guestfish-actions.pod:3085
12022 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
12023 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
12024 "documentation are in fact hexadecimal numbers, but usually documented "
12025 "without any leading \"0x\" which might be confusing."
12029 #: ../src/guestfs-actions.pod:4646
12030 msgid "guestfs_part_set_name"
12034 #: ../src/guestfs-actions.pod:4648
12038 " guestfs_part_set_name (guestfs_h *g,\n"
12039 " const char *device,\n"
12041 " const char *name);\n"
12046 #: ../src/guestfs-actions.pod:4654 ../fish/guestfish-actions.pod:3099
12048 "This sets the partition name on partition numbered C<partnum> on device "
12049 "C<device>. Note that partitions are numbered from 1."
12053 #: ../src/guestfs-actions.pod:4657 ../fish/guestfish-actions.pod:3102
12055 "The partition name can only be set on certain types of partition table. "
12056 "This works on C<gpt> but not on C<mbr> partitions."
12060 #: ../src/guestfs-actions.pod:4664
12061 msgid "guestfs_part_to_dev"
12065 #: ../src/guestfs-actions.pod:4666
12069 " guestfs_part_to_dev (guestfs_h *g,\n"
12070 " const char *partition);\n"
12075 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3109
12077 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
12078 "partition number, returning the device name (eg. \"/dev/sdb\")."
12082 #: ../src/guestfs-actions.pod:4674
12084 "The named partition must exist, for example as a string returned from "
12085 "C<guestfs_list_partitions>."
12089 #: ../src/guestfs-actions.pod:4682
12090 msgid "guestfs_ping_daemon"
12094 #: ../src/guestfs-actions.pod:4684
12098 " guestfs_ping_daemon (guestfs_h *g);\n"
12103 #: ../src/guestfs-actions.pod:4687 ../fish/guestfish-actions.pod:3120
12105 "This is a test probe into the guestfs daemon running inside the qemu "
12106 "subprocess. Calling this function checks that the daemon responds to the "
12107 "ping message, without affecting the daemon or attached block device(s) in "
12112 #: ../src/guestfs-actions.pod:4696
12113 msgid "guestfs_pread"
12117 #: ../src/guestfs-actions.pod:4698
12121 " guestfs_pread (guestfs_h *g,\n"
12122 " const char *path,\n"
12124 " int64_t offset,\n"
12125 " size_t *size_r);\n"
12130 #: ../src/guestfs-actions.pod:4705 ../fish/guestfish-actions.pod:3129
12132 "This command lets you read part of a file. It reads C<count> bytes of the "
12133 "file, starting at C<offset>, from file C<path>."
12137 #: ../src/guestfs-actions.pod:4708 ../src/guestfs-actions.pod:4734
12138 #: ../fish/guestfish-actions.pod:3132 ../fish/guestfish-actions.pod:3147
12140 "This may read fewer bytes than requested. For further details see the "
12141 "L<pread(2)> system call."
12145 #: ../src/guestfs-actions.pod:4711
12146 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
12150 #: ../src/guestfs-actions.pod:4722
12151 msgid "guestfs_pread_device"
12155 #: ../src/guestfs-actions.pod:4724
12159 " guestfs_pread_device (guestfs_h *g,\n"
12160 " const char *device,\n"
12162 " int64_t offset,\n"
12163 " size_t *size_r);\n"
12168 #: ../src/guestfs-actions.pod:4731 ../fish/guestfish-actions.pod:3144
12170 "This command lets you read part of a file. It reads C<count> bytes of "
12171 "C<device>, starting at C<offset>."
12175 #: ../src/guestfs-actions.pod:4737
12176 msgid "See also C<guestfs_pread>."
12180 #: ../src/guestfs-actions.pod:4746
12181 msgid "(Added in 1.5.21)"
12185 #: ../src/guestfs-actions.pod:4748
12186 msgid "guestfs_pvcreate"
12190 #: ../src/guestfs-actions.pod:4750
12194 " guestfs_pvcreate (guestfs_h *g,\n"
12195 " const char *device);\n"
12200 #: ../src/guestfs-actions.pod:4754 ../fish/guestfish-actions.pod:3159
12202 "This creates an LVM physical volume on the named C<device>, where C<device> "
12203 "should usually be a partition name such as C</dev/sda1>."
12207 #: ../src/guestfs-actions.pod:4762
12208 msgid "guestfs_pvremove"
12212 #: ../src/guestfs-actions.pod:4764
12216 " guestfs_pvremove (guestfs_h *g,\n"
12217 " const char *device);\n"
12222 #: ../src/guestfs-actions.pod:4768 ../fish/guestfish-actions.pod:3167
12224 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12229 #: ../src/guestfs-actions.pod:4771 ../fish/guestfish-actions.pod:3170
12231 "The implementation uses the C<pvremove> command which refuses to wipe "
12232 "physical volumes that contain any volume groups, so you have to remove those "
12237 #: ../src/guestfs-actions.pod:4779
12238 msgid "guestfs_pvresize"
12242 #: ../src/guestfs-actions.pod:4781
12246 " guestfs_pvresize (guestfs_h *g,\n"
12247 " const char *device);\n"
12252 #: ../src/guestfs-actions.pod:4785 ../fish/guestfish-actions.pod:3178
12254 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12255 "the new size of the underlying device."
12259 #: ../src/guestfs-actions.pod:4792
12260 msgid "guestfs_pvresize_size"
12264 #: ../src/guestfs-actions.pod:4794
12268 " guestfs_pvresize_size (guestfs_h *g,\n"
12269 " const char *device,\n"
12270 " int64_t size);\n"
12275 #: ../src/guestfs-actions.pod:4799
12277 "This command is the same as C<guestfs_pvresize> except that it allows you to "
12278 "specify the new size (in bytes) explicitly."
12282 #: ../src/guestfs-actions.pod:4806
12283 msgid "guestfs_pvs"
12287 #: ../src/guestfs-actions.pod:4808
12291 " guestfs_pvs (guestfs_h *g);\n"
12296 #: ../src/guestfs-actions.pod:4811 ../fish/guestfish-actions.pod:3192
12298 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12303 #: ../src/guestfs-actions.pod:4814 ../fish/guestfish-actions.pod:3195
12305 "This returns a list of just the device names that contain PVs (eg. C</dev/"
12310 #: ../src/guestfs-actions.pod:4817
12311 msgid "See also C<guestfs_pvs_full>."
12315 #: ../src/guestfs-actions.pod:4825
12316 msgid "guestfs_pvs_full"
12320 #: ../src/guestfs-actions.pod:4827
12323 " struct guestfs_lvm_pv_list *\n"
12324 " guestfs_pvs_full (guestfs_h *g);\n"
12329 #: ../src/guestfs-actions.pod:4830 ../fish/guestfish-actions.pod:3204
12331 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12332 "(8)> command. The \"full\" version includes all fields."
12336 #: ../src/guestfs-actions.pod:4833
12338 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
12339 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
12343 #: ../src/guestfs-actions.pod:4839
12344 msgid "guestfs_pvuuid"
12348 #: ../src/guestfs-actions.pod:4841
12352 " guestfs_pvuuid (guestfs_h *g,\n"
12353 " const char *device);\n"
12358 #: ../src/guestfs-actions.pod:4845 ../fish/guestfish-actions.pod:3211
12359 msgid "This command returns the UUID of the LVM PV C<device>."
12363 #: ../src/guestfs-actions.pod:4852
12364 msgid "guestfs_pwrite"
12368 #: ../src/guestfs-actions.pod:4854
12372 " guestfs_pwrite (guestfs_h *g,\n"
12373 " const char *path,\n"
12374 " const char *content,\n"
12375 " size_t content_size,\n"
12376 " int64_t offset);\n"
12381 #: ../src/guestfs-actions.pod:4861 ../fish/guestfish-actions.pod:3217
12383 "This command writes to part of a file. It writes the data buffer C<content> "
12384 "to the file C<path> starting at offset C<offset>."
12388 #: ../src/guestfs-actions.pod:4864 ../fish/guestfish-actions.pod:3220
12390 "This command implements the L<pwrite(2)> system call, and like that system "
12391 "call it may not write the full data requested. The return value is the "
12392 "number of bytes that were actually written to the file. This could even be "
12393 "0, although short writes are unlikely for regular files in ordinary "
12398 #: ../src/guestfs-actions.pod:4870
12399 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
12403 #: ../src/guestfs-actions.pod:4879
12404 msgid "guestfs_pwrite_device"
12408 #: ../src/guestfs-actions.pod:4881
12412 " guestfs_pwrite_device (guestfs_h *g,\n"
12413 " const char *device,\n"
12414 " const char *content,\n"
12415 " size_t content_size,\n"
12416 " int64_t offset);\n"
12421 #: ../src/guestfs-actions.pod:4888 ../fish/guestfish-actions.pod:3235
12423 "This command writes to part of a device. It writes the data buffer "
12424 "C<content> to C<device> starting at offset C<offset>."
12428 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3238
12430 "This command implements the L<pwrite(2)> system call, and like that system "
12431 "call it may not write the full data requested (although short writes to disk "
12432 "devices and partitions are probably impossible with standard Linux kernels)."
12436 #: ../src/guestfs-actions.pod:4896
12437 msgid "See also C<guestfs_pwrite>."
12441 #: ../src/guestfs-actions.pod:4903
12442 msgid "(Added in 1.5.20)"
12446 #: ../src/guestfs-actions.pod:4905
12447 msgid "guestfs_read_file"
12451 #: ../src/guestfs-actions.pod:4907
12455 " guestfs_read_file (guestfs_h *g,\n"
12456 " const char *path,\n"
12457 " size_t *size_r);\n"
12462 #: ../src/guestfs-actions.pod:4912 ../fish/guestfish-actions.pod:3252
12463 msgid "This calls returns the contents of the file C<path> as a buffer."
12467 #: ../src/guestfs-actions.pod:4915
12469 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
12470 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
12471 "function is limited in the total size of file that can be handled."
12475 #: ../src/guestfs-actions.pod:4927
12476 msgid "(Added in 1.0.63)"
12480 #: ../src/guestfs-actions.pod:4929
12481 msgid "guestfs_read_lines"
12485 #: ../src/guestfs-actions.pod:4931
12489 " guestfs_read_lines (guestfs_h *g,\n"
12490 " const char *path);\n"
12495 #: ../src/guestfs-actions.pod:4937 ../fish/guestfish-actions.pod:3269
12497 "The file contents are returned as a list of lines. Trailing C<LF> and "
12498 "C<CRLF> character sequences are I<not> returned."
12502 #: ../src/guestfs-actions.pod:4940
12504 "Note that this function cannot correctly handle binary files (specifically, "
12505 "files containing C<\\0> character which is treated as end of line). For "
12506 "those you need to use the C<guestfs_read_file> function which has a more "
12507 "complex interface."
12511 #: ../src/guestfs-actions.pod:4951
12512 msgid "guestfs_readdir"
12516 #: ../src/guestfs-actions.pod:4953
12519 " struct guestfs_dirent_list *\n"
12520 " guestfs_readdir (guestfs_h *g,\n"
12521 " const char *dir);\n"
12526 #: ../src/guestfs-actions.pod:4957 ../fish/guestfish-actions.pod:3281
12527 msgid "This returns the list of directory entries in directory C<dir>."
12531 #: ../src/guestfs-actions.pod:4959 ../fish/guestfish-actions.pod:3283
12533 "All entries in the directory are returned, including C<.> and C<..>. The "
12534 "entries are I<not> sorted, but returned in the same order as the underlying "
12539 #: ../src/guestfs-actions.pod:4963 ../fish/guestfish-actions.pod:3287
12541 "Also this call returns basic file type information about each file. The "
12542 "C<ftyp> field will contain one of the following characters:"
12546 #: ../src/guestfs-actions.pod:4968 ../fish/guestfish-actions.pod:3292
12551 #: ../src/guestfs-actions.pod:4970 ../fish/guestfish-actions.pod:3294
12552 msgid "Block special"
12556 #: ../src/guestfs-actions.pod:4972 ../fish/guestfish-actions.pod:3296
12561 #: ../src/guestfs-actions.pod:4974 ../fish/guestfish-actions.pod:3298
12562 msgid "Char special"
12566 #: ../src/guestfs-actions.pod:4976 ../fish/guestfish-actions.pod:3300
12571 #: ../src/guestfs-actions.pod:4978 ../fish/guestfish-actions.pod:3302
12576 #: ../src/guestfs-actions.pod:4980 ../fish/guestfish-actions.pod:3304
12581 #: ../src/guestfs-actions.pod:4982 ../fish/guestfish-actions.pod:3306
12582 msgid "FIFO (named pipe)"
12586 #: ../src/guestfs-actions.pod:4984 ../fish/guestfish-actions.pod:3308
12591 #: ../src/guestfs-actions.pod:4986 ../fish/guestfish-actions.pod:3310
12592 msgid "Symbolic link"
12596 #: ../src/guestfs-actions.pod:4988 ../fish/guestfish-actions.pod:3312
12601 #: ../src/guestfs-actions.pod:4990 ../fish/guestfish-actions.pod:3314
12602 msgid "Regular file"
12606 #: ../src/guestfs-actions.pod:4992 ../fish/guestfish-actions.pod:3316
12611 #: ../src/guestfs-actions.pod:4994 ../fish/guestfish-actions.pod:3318
12616 #: ../src/guestfs-actions.pod:4996 ../fish/guestfish-actions.pod:3320
12621 #: ../src/guestfs-actions.pod:4998 ../fish/guestfish-actions.pod:3322
12622 msgid "Unknown file type"
12626 #: ../src/guestfs-actions.pod:5000 ../fish/guestfish-actions.pod:3324
12631 #: ../src/guestfs-actions.pod:5002 ../fish/guestfish-actions.pod:3326
12633 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12637 #: ../src/guestfs-actions.pod:5007
12639 "This function is primarily intended for use by programs. To get a simple "
12640 "list of names, use C<guestfs_ls>. To get a printable directory for human "
12641 "consumption, use C<guestfs_ll>."
12645 #: ../src/guestfs-actions.pod:5011
12647 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
12648 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
12652 #: ../src/guestfs-actions.pod:5017
12653 msgid "guestfs_readlink"
12657 #: ../src/guestfs-actions.pod:5019
12661 " guestfs_readlink (guestfs_h *g,\n"
12662 " const char *path);\n"
12667 #: ../src/guestfs-actions.pod:5023 ../fish/guestfish-actions.pod:3339
12668 msgid "This command reads the target of a symbolic link."
12672 #: ../src/guestfs-actions.pod:5030
12673 msgid "guestfs_readlinklist"
12677 #: ../src/guestfs-actions.pod:5032
12681 " guestfs_readlinklist (guestfs_h *g,\n"
12682 " const char *path,\n"
12683 " char *const *names);\n"
12688 #: ../src/guestfs-actions.pod:5037 ../fish/guestfish-actions.pod:3345
12690 "This call allows you to do a C<readlink> operation on multiple files, where "
12691 "all files are in the directory C<path>. C<names> is the list of files from "
12696 #: ../src/guestfs-actions.pod:5041 ../fish/guestfish-actions.pod:3349
12698 "On return you get a list of strings, with a one-to-one correspondence to the "
12699 "C<names> list. Each string is the value of the symbolic link."
12703 #: ../src/guestfs-actions.pod:5045 ../fish/guestfish-actions.pod:3353
12705 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12706 "result string is the empty string C<\"\">. However the whole operation is "
12707 "completed even if there were C<readlink(2)> errors, and so you can call this "
12708 "function with names where you don't know if they are symbolic links already "
12709 "(albeit slightly less efficient)."
12713 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3360
12715 "This call is intended for programs that want to efficiently list a directory "
12716 "contents without making many round-trips. Very long directory listings "
12717 "might cause the protocol message size to be exceeded, causing this call to "
12718 "fail. The caller must split up such requests into smaller groups of names."
12722 #: ../src/guestfs-actions.pod:5065
12723 msgid "guestfs_realpath"
12727 #: ../src/guestfs-actions.pod:5067
12731 " guestfs_realpath (guestfs_h *g,\n"
12732 " const char *path);\n"
12737 #: ../src/guestfs-actions.pod:5071 ../fish/guestfish-actions.pod:3371
12739 "Return the canonicalized absolute pathname of C<path>. The returned path "
12740 "has no C<.>, C<..> or symbolic link path elements."
12744 #: ../src/guestfs-actions.pod:5079
12745 msgid "guestfs_removexattr"
12749 #: ../src/guestfs-actions.pod:5081
12753 " guestfs_removexattr (guestfs_h *g,\n"
12754 " const char *xattr,\n"
12755 " const char *path);\n"
12760 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3378
12762 "This call removes the extended attribute named C<xattr> of the file C<path>."
12766 #: ../src/guestfs-actions.pod:5089
12767 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
12771 #: ../src/guestfs-actions.pod:5095
12772 msgid "guestfs_resize2fs"
12776 #: ../src/guestfs-actions.pod:5097
12780 " guestfs_resize2fs (guestfs_h *g,\n"
12781 " const char *device);\n"
12786 #: ../src/guestfs-actions.pod:5101 ../fish/guestfish-actions.pod:3387
12788 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12789 "underlying device."
12793 #: ../src/guestfs-actions.pod:5104
12795 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
12796 "C<device> before calling this command. For unknown reasons C<resize2fs> "
12797 "sometimes gives an error about this and sometimes not. In any case, it is "
12798 "always safe to call C<guestfs_e2fsck_f> before calling this function."
12802 #: ../src/guestfs-actions.pod:5114
12803 msgid "guestfs_resize2fs_size"
12807 #: ../src/guestfs-actions.pod:5116
12811 " guestfs_resize2fs_size (guestfs_h *g,\n"
12812 " const char *device,\n"
12813 " int64_t size);\n"
12818 #: ../src/guestfs-actions.pod:5121
12820 "This command is the same as C<guestfs_resize2fs> except that it allows you "
12821 "to specify the new size (in bytes) explicitly."
12825 #: ../src/guestfs-actions.pod:5128
12830 #: ../src/guestfs-actions.pod:5130
12834 " guestfs_rm (guestfs_h *g,\n"
12835 " const char *path);\n"
12840 #: ../src/guestfs-actions.pod:5134 ../fish/guestfish-actions.pod:3407
12841 msgid "Remove the single file C<path>."
12845 #: ../src/guestfs-actions.pod:5140
12846 msgid "guestfs_rm_rf"
12850 #: ../src/guestfs-actions.pod:5142
12854 " guestfs_rm_rf (guestfs_h *g,\n"
12855 " const char *path);\n"
12860 #: ../src/guestfs-actions.pod:5146 ../fish/guestfish-actions.pod:3413
12862 "Remove the file or directory C<path>, recursively removing the contents if "
12863 "its a directory. This is like the C<rm -rf> shell command."
12867 #: ../src/guestfs-actions.pod:5154
12868 msgid "guestfs_rmdir"
12872 #: ../src/guestfs-actions.pod:5156
12876 " guestfs_rmdir (guestfs_h *g,\n"
12877 " const char *path);\n"
12882 #: ../src/guestfs-actions.pod:5160 ../fish/guestfish-actions.pod:3421
12883 msgid "Remove the single directory C<path>."
12887 #: ../src/guestfs-actions.pod:5166
12888 msgid "guestfs_rmmountpoint"
12892 #: ../src/guestfs-actions.pod:5168
12896 " guestfs_rmmountpoint (guestfs_h *g,\n"
12897 " const char *exemptpath);\n"
12902 #: ../src/guestfs-actions.pod:5172
12904 "This calls removes a mountpoint that was previously created with "
12905 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
12909 #: ../src/guestfs-actions.pod:5180
12910 msgid "guestfs_scrub_device"
12914 #: ../src/guestfs-actions.pod:5182
12918 " guestfs_scrub_device (guestfs_h *g,\n"
12919 " const char *device);\n"
12924 #: ../src/guestfs-actions.pod:5186 ../fish/guestfish-actions.pod:3435
12926 "This command writes patterns over C<device> to make data retrieval more "
12931 #: ../src/guestfs-actions.pod:5189 ../src/guestfs-actions.pod:5210
12932 #: ../src/guestfs-actions.pod:5229 ../fish/guestfish-actions.pod:3438
12933 #: ../fish/guestfish-actions.pod:3453 ../fish/guestfish-actions.pod:3466
12935 "It is an interface to the L<scrub(1)> program. See that manual page for "
12940 #: ../src/guestfs-actions.pod:5197 ../src/guestfs-actions.pod:5215
12941 #: ../src/guestfs-actions.pod:5234
12942 msgid "(Added in 1.0.52)"
12946 #: ../src/guestfs-actions.pod:5199
12947 msgid "guestfs_scrub_file"
12951 #: ../src/guestfs-actions.pod:5201
12955 " guestfs_scrub_file (guestfs_h *g,\n"
12956 " const char *file);\n"
12961 #: ../src/guestfs-actions.pod:5205 ../fish/guestfish-actions.pod:3448
12963 "This command writes patterns over a file to make data retrieval more "
12968 #: ../src/guestfs-actions.pod:5208 ../fish/guestfish-actions.pod:3451
12969 msgid "The file is I<removed> after scrubbing."
12973 #: ../src/guestfs-actions.pod:5217
12974 msgid "guestfs_scrub_freespace"
12978 #: ../src/guestfs-actions.pod:5219
12982 " guestfs_scrub_freespace (guestfs_h *g,\n"
12983 " const char *dir);\n"
12988 #: ../src/guestfs-actions.pod:5223
12990 "This command creates the directory C<dir> and then fills it with files until "
12991 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
12992 "and deletes them. The intention is to scrub any free space on the partition "
12993 "containing C<dir>."
12997 #: ../src/guestfs-actions.pod:5236
12998 msgid "guestfs_set_append"
13002 #: ../src/guestfs-actions.pod:5238
13006 " guestfs_set_append (guestfs_h *g,\n"
13007 " const char *append);\n"
13012 #: ../src/guestfs-actions.pod:5242 ../fish/guestfish-actions.pod:3475
13014 "This function is used to add additional options to the guest kernel command "
13019 #: ../src/guestfs-actions.pod:5245 ../fish/guestfish-actions.pod:3478
13021 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
13022 "environment variable."
13026 #: ../src/guestfs-actions.pod:5248 ../fish/guestfish-actions.pod:3481
13028 "Setting C<append> to C<NULL> means I<no> additional options are passed "
13029 "(libguestfs always adds a few of its own)."
13033 #: ../src/guestfs-actions.pod:5255
13034 msgid "guestfs_set_autosync"
13038 #: ../src/guestfs-actions.pod:5257
13042 " guestfs_set_autosync (guestfs_h *g,\n"
13043 " int autosync);\n"
13048 #: ../src/guestfs-actions.pod:5261
13050 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
13051 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
13052 "the handle is closed (also if the program exits without closing handles)."
13056 #: ../src/guestfs-actions.pod:5266 ../fish/guestfish-actions.pod:3495
13058 "This is enabled by default (since libguestfs 1.5.24, previously it was "
13059 "disabled by default)."
13063 #: ../src/guestfs-actions.pod:5273
13064 msgid "guestfs_set_direct"
13068 #: ../src/guestfs-actions.pod:5275
13072 " guestfs_set_direct (guestfs_h *g,\n"
13078 #: ../src/guestfs-actions.pod:5279 ../fish/guestfish-actions.pod:3504
13080 "If the direct appliance mode flag is enabled, then stdin and stdout are "
13081 "passed directly through to the appliance once it is launched."
13085 #: ../src/guestfs-actions.pod:5283
13087 "One consequence of this is that log messages aren't caught by the library "
13088 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
13093 #: ../src/guestfs-actions.pod:5287 ../fish/guestfish-actions.pod:3512
13094 msgid "You probably don't want to use this unless you know what you are doing."
13098 #: ../src/guestfs-actions.pod:5290 ../fish/guestfish-actions.pod:3515
13099 msgid "The default is disabled."
13103 #: ../src/guestfs-actions.pod:5296
13104 msgid "guestfs_set_e2label"
13108 #: ../src/guestfs-actions.pod:5298
13112 " guestfs_set_e2label (guestfs_h *g,\n"
13113 " const char *device,\n"
13114 " const char *label);\n"
13119 #: ../src/guestfs-actions.pod:5303 ../fish/guestfish-actions.pod:3521
13121 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
13122 "C<label>. Filesystem labels are limited to 16 characters."
13126 #: ../src/guestfs-actions.pod:5307
13128 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
13129 "the existing label on a filesystem."
13133 #: ../src/guestfs-actions.pod:5314
13134 msgid "guestfs_set_e2uuid"
13138 #: ../src/guestfs-actions.pod:5316
13142 " guestfs_set_e2uuid (guestfs_h *g,\n"
13143 " const char *device,\n"
13144 " const char *uuid);\n"
13149 #: ../src/guestfs-actions.pod:5321 ../fish/guestfish-actions.pod:3532
13151 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13152 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13153 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13157 #: ../src/guestfs-actions.pod:5326
13159 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
13160 "the existing UUID of a filesystem."
13164 #: ../src/guestfs-actions.pod:5333
13165 msgid "guestfs_set_memsize"
13169 #: ../src/guestfs-actions.pod:5335
13173 " guestfs_set_memsize (guestfs_h *g,\n"
13179 #: ../src/guestfs-actions.pod:5339
13181 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13182 "This only has any effect if called before C<guestfs_launch>."
13186 #: ../src/guestfs-actions.pod:5343 ../fish/guestfish-actions.pod:3550
13188 "You can also change this by setting the environment variable "
13189 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13193 #: ../src/guestfs-actions.pod:5354
13194 msgid "guestfs_set_network"
13198 #: ../src/guestfs-actions.pod:5356
13202 " guestfs_set_network (guestfs_h *g,\n"
13208 #: ../src/guestfs-actions.pod:5360 ../fish/guestfish-actions.pod:3563
13210 "If C<network> is true, then the network is enabled in the libguestfs "
13211 "appliance. The default is false."
13215 #: ../src/guestfs-actions.pod:5363 ../fish/guestfish-actions.pod:3566
13217 "This affects whether commands are able to access the network (see L<guestfs"
13218 "(3)/RUNNING COMMANDS>)."
13222 #: ../src/guestfs-actions.pod:5366
13224 "You must call this before calling C<guestfs_launch>, otherwise it has no "
13229 #: ../src/guestfs-actions.pod:5373
13230 msgid "guestfs_set_path"
13234 #: ../src/guestfs-actions.pod:5375
13238 " guestfs_set_path (guestfs_h *g,\n"
13239 " const char *searchpath);\n"
13244 #: ../src/guestfs-actions.pod:5379 ../fish/guestfish-actions.pod:3578
13245 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13249 #: ../src/guestfs-actions.pod:5381 ../fish/guestfish-actions.pod:3580
13251 "The default is C<$libdir/guestfs> unless overridden by setting "
13252 "C<LIBGUESTFS_PATH> environment variable."
13256 #: ../src/guestfs-actions.pod:5384 ../fish/guestfish-actions.pod:3583
13257 msgid "Setting C<path> to C<NULL> restores the default path."
13261 #: ../src/guestfs-actions.pod:5390
13262 msgid "guestfs_set_qemu"
13266 #: ../src/guestfs-actions.pod:5392
13270 " guestfs_set_qemu (guestfs_h *g,\n"
13271 " const char *qemu);\n"
13276 #: ../src/guestfs-actions.pod:5396 ../fish/guestfish-actions.pod:3591
13277 msgid "Set the qemu binary that we will use."
13281 #: ../src/guestfs-actions.pod:5398 ../fish/guestfish-actions.pod:3593
13283 "The default is chosen when the library was compiled by the configure script."
13287 #: ../src/guestfs-actions.pod:5401 ../fish/guestfish-actions.pod:3596
13289 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13294 #: ../src/guestfs-actions.pod:5404 ../fish/guestfish-actions.pod:3599
13295 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13299 #: ../src/guestfs-actions.pod:5406 ../fish/guestfish-actions.pod:3601
13301 "Note that you should call this function as early as possible after creating "
13302 "the handle. This is because some pre-launch operations depend on testing "
13303 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13304 "don't retest features, and so you might see inconsistent results. Using the "
13305 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13306 "the qemu binary at the same time as the handle is created."
13310 #: ../src/guestfs-actions.pod:5418
13311 msgid "guestfs_set_recovery_proc"
13315 #: ../src/guestfs-actions.pod:5420
13319 " guestfs_set_recovery_proc (guestfs_h *g,\n"
13320 " int recoveryproc);\n"
13325 #: ../src/guestfs-actions.pod:5424
13327 "If this is called with the parameter C<false> then C<guestfs_launch> does "
13328 "not create a recovery process. The purpose of the recovery process is to "
13329 "stop runaway qemu processes in the case where the main program aborts "
13334 #: ../src/guestfs-actions.pod:5429
13336 "This only has any effect if called before C<guestfs_launch>, and the default "
13341 #: ../src/guestfs-actions.pod:5432 ../fish/guestfish-actions.pod:3623
13343 "About the only time when you would want to disable this is if the main "
13344 "process will fork itself into the background (\"daemonize\" itself). In "
13345 "this case the recovery process thinks that the main program has disappeared "
13346 "and so kills qemu, which is not very helpful."
13350 #: ../src/guestfs-actions.pod:5442
13351 msgid "guestfs_set_selinux"
13355 #: ../src/guestfs-actions.pod:5444
13359 " guestfs_set_selinux (guestfs_h *g,\n"
13365 #: ../src/guestfs-actions.pod:5448 ../fish/guestfish-actions.pod:3635
13367 "This sets the selinux flag that is passed to the appliance at boot time. "
13368 "The default is C<selinux=0> (disabled)."
13372 #: ../src/guestfs-actions.pod:5451 ../fish/guestfish-actions.pod:3638
13374 "Note that if SELinux is enabled, it is always in Permissive mode "
13375 "(C<enforcing=0>)."
13379 #: ../src/guestfs-actions.pod:5461
13380 msgid "guestfs_set_trace"
13384 #: ../src/guestfs-actions.pod:5463
13388 " guestfs_set_trace (guestfs_h *g,\n"
13394 #: ../src/guestfs-actions.pod:5467 ../fish/guestfish-actions.pod:3650
13396 "If the command trace flag is set to 1, then commands are printed on stderr "
13397 "before they are executed in a format which is very similar to the one used "
13398 "by guestfish. In other words, you can run a program with this enabled, and "
13399 "you will get out a script which you can feed to guestfish to perform the "
13400 "same set of actions."
13404 #: ../src/guestfs-actions.pod:5474 ../fish/guestfish-actions.pod:3657
13406 "If you want to trace C API calls into libguestfs (and other libraries) then "
13407 "possibly a better way is to use the external ltrace(1) command."
13411 #: ../src/guestfs-actions.pod:5478 ../fish/guestfish-actions.pod:3661
13413 "Command traces are disabled unless the environment variable "
13414 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13418 #: ../src/guestfs-actions.pod:5485
13419 msgid "guestfs_set_verbose"
13423 #: ../src/guestfs-actions.pod:5487
13427 " guestfs_set_verbose (guestfs_h *g,\n"
13433 #: ../src/guestfs-actions.pod:5491 ../fish/guestfish-actions.pod:3670
13434 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
13438 #: ../src/guestfs-actions.pod:5493 ../fish/guestfish-actions.pod:3672
13440 "Verbose messages are disabled unless the environment variable "
13441 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13445 #: ../src/guestfs-actions.pod:5500
13446 msgid "guestfs_setcon"
13450 #: ../src/guestfs-actions.pod:5502
13454 " guestfs_setcon (guestfs_h *g,\n"
13455 " const char *context);\n"
13460 #: ../src/guestfs-actions.pod:5506 ../fish/guestfish-actions.pod:3679
13462 "This sets the SELinux security context of the daemon to the string "
13467 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3682
13468 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13472 #: ../src/guestfs-actions.pod:5515
13473 msgid "guestfs_setxattr"
13477 #: ../src/guestfs-actions.pod:5517
13481 " guestfs_setxattr (guestfs_h *g,\n"
13482 " const char *xattr,\n"
13483 " const char *val,\n"
13485 " const char *path);\n"
13490 #: ../src/guestfs-actions.pod:5524 ../fish/guestfish-actions.pod:3688
13492 "This call sets the extended attribute named C<xattr> of the file C<path> to "
13493 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
13497 #: ../src/guestfs-actions.pod:5528
13498 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
13502 #: ../src/guestfs-actions.pod:5534
13503 msgid "guestfs_sfdisk"
13507 #: ../src/guestfs-actions.pod:5536
13511 " guestfs_sfdisk (guestfs_h *g,\n"
13512 " const char *device,\n"
13516 " char *const *lines);\n"
13521 #: ../src/guestfs-actions.pod:5544 ../fish/guestfish-actions.pod:3698
13523 "This is a direct interface to the L<sfdisk(8)> program for creating "
13524 "partitions on block devices."
13528 #: ../src/guestfs-actions.pod:5547 ../fish/guestfish-actions.pod:3701
13529 msgid "C<device> should be a block device, for example C</dev/sda>."
13533 #: ../src/guestfs-actions.pod:5549 ../fish/guestfish-actions.pod:3703
13535 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
13536 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
13537 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
13538 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
13539 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
13540 "the kernel) cannot work out the right geometry and you will need to tell it."
13544 #: ../src/guestfs-actions.pod:5557 ../fish/guestfish-actions.pod:3711
13546 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
13547 "refer to the L<sfdisk(8)> manpage."
13551 #: ../src/guestfs-actions.pod:5560 ../fish/guestfish-actions.pod:3714
13553 "To create a single partition occupying the whole disk, you would pass "
13554 "C<lines> as a single element list, when the single element being the string "
13559 #: ../src/guestfs-actions.pod:5564
13561 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
13565 #: ../src/guestfs-actions.pod:5574
13566 msgid "guestfs_sfdiskM"
13570 #: ../src/guestfs-actions.pod:5576
13574 " guestfs_sfdiskM (guestfs_h *g,\n"
13575 " const char *device,\n"
13576 " char *const *lines);\n"
13581 #: ../src/guestfs-actions.pod:5581
13583 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
13584 "partition sizes are specified in megabytes only (rounded to the nearest "
13585 "cylinder) and you don't need to specify the cyls, heads and sectors "
13586 "parameters which were rarely if ever used anyway."
13590 #: ../src/guestfs-actions.pod:5587
13592 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
13593 "C<guestfs_part_disk>"
13597 #: ../src/guestfs-actions.pod:5597
13598 msgid "guestfs_sfdisk_N"
13602 #: ../src/guestfs-actions.pod:5599
13606 " guestfs_sfdisk_N (guestfs_h *g,\n"
13607 " const char *device,\n"
13612 " const char *line);\n"
13617 #: ../src/guestfs-actions.pod:5608 ../fish/guestfish-actions.pod:3744
13619 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13620 "(note: C<n> counts from 1)."
13624 #: ../src/guestfs-actions.pod:5611
13626 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
13627 "for the cyls/heads/sectors parameters."
13631 #: ../src/guestfs-actions.pod:5614
13632 msgid "See also: C<guestfs_part_add>"
13636 #: ../src/guestfs-actions.pod:5623
13637 msgid "guestfs_sfdisk_disk_geometry"
13641 #: ../src/guestfs-actions.pod:5625
13645 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
13646 " const char *device);\n"
13651 #: ../src/guestfs-actions.pod:5629
13653 "This displays the disk geometry of C<device> read from the partition table. "
13654 "Especially in the case where the underlying block device has been resized, "
13655 "this can be different from the kernel's idea of the geometry (see "
13656 "C<guestfs_sfdisk_kernel_geometry>)."
13660 #: ../src/guestfs-actions.pod:5634 ../src/guestfs-actions.pod:5650
13661 #: ../fish/guestfish-actions.pod:3764 ../fish/guestfish-actions.pod:3773
13662 msgid "The result is in human-readable format, and not designed to be parsed."
13666 #: ../src/guestfs-actions.pod:5642
13667 msgid "guestfs_sfdisk_kernel_geometry"
13671 #: ../src/guestfs-actions.pod:5644
13675 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
13676 " const char *device);\n"
13681 #: ../src/guestfs-actions.pod:5648 ../fish/guestfish-actions.pod:3771
13682 msgid "This displays the kernel's idea of the geometry of C<device>."
13686 #: ../src/guestfs-actions.pod:5658
13687 msgid "guestfs_sfdisk_l"
13691 #: ../src/guestfs-actions.pod:5660
13695 " guestfs_sfdisk_l (guestfs_h *g,\n"
13696 " const char *device);\n"
13701 #: ../src/guestfs-actions.pod:5664 ../fish/guestfish-actions.pod:3780
13703 "This displays the partition table on C<device>, in the human-readable output "
13704 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13708 #: ../src/guestfs-actions.pod:5668
13709 msgid "See also: C<guestfs_part_list>"
13713 #: ../src/guestfs-actions.pod:5675
13718 #: ../src/guestfs-actions.pod:5677
13722 " guestfs_sh (guestfs_h *g,\n"
13723 " const char *command);\n"
13728 #: ../src/guestfs-actions.pod:5681 ../fish/guestfish-actions.pod:3790
13730 "This call runs a command from the guest filesystem via the guest's C</bin/"
13735 #: ../src/guestfs-actions.pod:5684
13736 msgid "This is like C<guestfs_command>, but passes the command to:"
13740 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3795
13743 " /bin/sh -c \"command\"\n"
13748 #: ../src/guestfs-actions.pod:5688 ../fish/guestfish-actions.pod:3797
13750 "Depending on the guest's shell, this usually results in wildcards being "
13751 "expanded, shell expressions being interpolated and so on."
13755 #: ../src/guestfs-actions.pod:5692
13756 msgid "All the provisos about C<guestfs_command> apply to this call."
13760 #: ../src/guestfs-actions.pod:5699
13761 msgid "guestfs_sh_lines"
13765 #: ../src/guestfs-actions.pod:5701
13769 " guestfs_sh_lines (guestfs_h *g,\n"
13770 " const char *command);\n"
13775 #: ../src/guestfs-actions.pod:5705
13777 "This is the same as C<guestfs_sh>, but splits the result into a list of "
13782 #: ../src/guestfs-actions.pod:5708
13783 msgid "See also: C<guestfs_command_lines>"
13787 #: ../src/guestfs-actions.pod:5716
13788 msgid "guestfs_sleep"
13792 #: ../src/guestfs-actions.pod:5718
13796 " guestfs_sleep (guestfs_h *g,\n"
13802 #: ../src/guestfs-actions.pod:5722 ../fish/guestfish-actions.pod:3816
13803 msgid "Sleep for C<secs> seconds."
13807 #: ../src/guestfs-actions.pod:5726
13808 msgid "(Added in 1.0.41)"
13812 #: ../src/guestfs-actions.pod:5728 ../src/guestfs-structs.pod:109
13813 msgid "guestfs_stat"
13817 #: ../src/guestfs-actions.pod:5730
13820 " struct guestfs_stat *\n"
13821 " guestfs_stat (guestfs_h *g,\n"
13822 " const char *path);\n"
13827 #: ../src/guestfs-actions.pod:5736 ../fish/guestfish-actions.pod:3824
13828 msgid "This is the same as the C<stat(2)> system call."
13832 #: ../src/guestfs-actions.pod:5744 ../src/guestfs-structs.pod:135
13833 msgid "guestfs_statvfs"
13837 #: ../src/guestfs-actions.pod:5746
13840 " struct guestfs_statvfs *\n"
13841 " guestfs_statvfs (guestfs_h *g,\n"
13842 " const char *path);\n"
13847 #: ../src/guestfs-actions.pod:5750 ../fish/guestfish-actions.pod:3830
13849 "Returns file system statistics for any mounted file system. C<path> should "
13850 "be a file or directory in the mounted file system (typically it is the mount "
13851 "point itself, but it doesn't need to be)."
13855 #: ../src/guestfs-actions.pod:5754 ../fish/guestfish-actions.pod:3834
13856 msgid "This is the same as the C<statvfs(2)> system call."
13860 #: ../src/guestfs-actions.pod:5756
13862 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
13863 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
13867 #: ../src/guestfs-actions.pod:5762
13868 msgid "guestfs_strings"
13872 #: ../src/guestfs-actions.pod:5764
13876 " guestfs_strings (guestfs_h *g,\n"
13877 " const char *path);\n"
13882 #: ../src/guestfs-actions.pod:5768 ../fish/guestfish-actions.pod:3840
13884 "This runs the L<strings(1)> command on a file and returns the list of "
13885 "printable strings found."
13889 #: ../src/guestfs-actions.pod:5780
13890 msgid "guestfs_strings_e"
13894 #: ../src/guestfs-actions.pod:5782
13898 " guestfs_strings_e (guestfs_h *g,\n"
13899 " const char *encoding,\n"
13900 " const char *path);\n"
13905 #: ../src/guestfs-actions.pod:5787
13907 "This is like the C<guestfs_strings> command, but allows you to specify the "
13908 "encoding of strings that are looked for in the source file C<path>."
13912 #: ../src/guestfs-actions.pod:5791 ../fish/guestfish-actions.pod:3854
13913 msgid "Allowed encodings are:"
13917 #: ../src/guestfs-actions.pod:5795 ../fish/guestfish-actions.pod:3858
13922 #: ../src/guestfs-actions.pod:5797
13924 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13925 "ISO-8859-X (this is what C<guestfs_strings> uses)."
13929 #: ../src/guestfs-actions.pod:5800 ../fish/guestfish-actions.pod:3863
13934 #: ../src/guestfs-actions.pod:5802 ../fish/guestfish-actions.pod:3865
13935 msgid "Single 8-bit-byte characters."
13939 #: ../src/guestfs-actions.pod:5804 ../fish/guestfish-actions.pod:3867
13944 #: ../src/guestfs-actions.pod:5806 ../fish/guestfish-actions.pod:3869
13945 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13949 #: ../src/guestfs-actions.pod:5809 ../fish/guestfish-actions.pod:3872
13950 msgid "l (lower case letter L)"
13954 #: ../src/guestfs-actions.pod:5811 ../fish/guestfish-actions.pod:3874
13956 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
13957 "examining binaries in Windows guests."
13961 #: ../src/guestfs-actions.pod:5814 ../fish/guestfish-actions.pod:3877
13966 #: ../src/guestfs-actions.pod:5816 ../fish/guestfish-actions.pod:3879
13967 msgid "32-bit big endian such as UCS-4BE."
13971 #: ../src/guestfs-actions.pod:5818 ../fish/guestfish-actions.pod:3881
13976 #: ../src/guestfs-actions.pod:5820 ../fish/guestfish-actions.pod:3883
13977 msgid "32-bit little endian such as UCS-4LE."
13981 #: ../src/guestfs-actions.pod:5824 ../fish/guestfish-actions.pod:3887
13982 msgid "The returned strings are transcoded to UTF-8."
13986 #: ../src/guestfs-actions.pod:5835
13987 msgid "guestfs_swapoff_device"
13991 #: ../src/guestfs-actions.pod:5837
13995 " guestfs_swapoff_device (guestfs_h *g,\n"
13996 " const char *device);\n"
14001 #: ../src/guestfs-actions.pod:5841
14003 "This command disables the libguestfs appliance swap device or partition "
14004 "named C<device>. See C<guestfs_swapon_device>."
14008 #: ../src/guestfs-actions.pod:5849
14009 msgid "guestfs_swapoff_file"
14013 #: ../src/guestfs-actions.pod:5851
14017 " guestfs_swapoff_file (guestfs_h *g,\n"
14018 " const char *file);\n"
14023 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3904
14024 msgid "This command disables the libguestfs appliance swap on file."
14028 #: ../src/guestfs-actions.pod:5861
14029 msgid "guestfs_swapoff_label"
14033 #: ../src/guestfs-actions.pod:5863
14037 " guestfs_swapoff_label (guestfs_h *g,\n"
14038 " const char *label);\n"
14043 #: ../src/guestfs-actions.pod:5867 ../fish/guestfish-actions.pod:3910
14045 "This command disables the libguestfs appliance swap on labeled swap "
14050 #: ../src/guestfs-actions.pod:5874
14051 msgid "guestfs_swapoff_uuid"
14055 #: ../src/guestfs-actions.pod:5876
14059 " guestfs_swapoff_uuid (guestfs_h *g,\n"
14060 " const char *uuid);\n"
14065 #: ../src/guestfs-actions.pod:5880 ../fish/guestfish-actions.pod:3917
14067 "This command disables the libguestfs appliance swap partition with the given "
14072 #: ../src/guestfs-actions.pod:5887
14073 msgid "guestfs_swapon_device"
14077 #: ../src/guestfs-actions.pod:5889
14081 " guestfs_swapon_device (guestfs_h *g,\n"
14082 " const char *device);\n"
14087 #: ../src/guestfs-actions.pod:5893
14089 "This command enables the libguestfs appliance to use the swap device or "
14090 "partition named C<device>. The increased memory is made available for all "
14091 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
14095 #: ../src/guestfs-actions.pod:5898 ../fish/guestfish-actions.pod:3929
14097 "Note that you should not swap to existing guest swap partitions unless you "
14098 "know what you are doing. They may contain hibernation information, or other "
14099 "information that the guest doesn't want you to trash. You also risk leaking "
14100 "information about the host to the guest this way. Instead, attach a new "
14101 "host device to the guest and swap on that."
14105 #: ../src/guestfs-actions.pod:5909
14106 msgid "guestfs_swapon_file"
14110 #: ../src/guestfs-actions.pod:5911
14114 " guestfs_swapon_file (guestfs_h *g,\n"
14115 " const char *file);\n"
14120 #: ../src/guestfs-actions.pod:5915
14122 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
14127 #: ../src/guestfs-actions.pod:5922
14128 msgid "guestfs_swapon_label"
14132 #: ../src/guestfs-actions.pod:5924
14136 " guestfs_swapon_label (guestfs_h *g,\n"
14137 " const char *label);\n"
14142 #: ../src/guestfs-actions.pod:5928
14144 "This command enables swap to a labeled swap partition. See "
14145 "C<guestfs_swapon_device> for other notes."
14149 #: ../src/guestfs-actions.pod:5935
14150 msgid "guestfs_swapon_uuid"
14154 #: ../src/guestfs-actions.pod:5937
14158 " guestfs_swapon_uuid (guestfs_h *g,\n"
14159 " const char *uuid);\n"
14164 #: ../src/guestfs-actions.pod:5941
14166 "This command enables swap to a swap partition with the given UUID. See "
14167 "C<guestfs_swapon_device> for other notes."
14171 #: ../src/guestfs-actions.pod:5948
14172 msgid "guestfs_sync"
14176 #: ../src/guestfs-actions.pod:5950
14180 " guestfs_sync (guestfs_h *g);\n"
14185 #: ../src/guestfs-actions.pod:5953 ../fish/guestfish-actions.pod:3961
14187 "This syncs the disk, so that any writes are flushed through to the "
14188 "underlying disk image."
14192 #: ../src/guestfs-actions.pod:5956 ../fish/guestfish-actions.pod:3964
14194 "You should always call this if you have modified a disk image, before "
14195 "closing the handle."
14199 #: ../src/guestfs-actions.pod:5963
14200 msgid "guestfs_tail"
14204 #: ../src/guestfs-actions.pod:5965
14208 " guestfs_tail (guestfs_h *g,\n"
14209 " const char *path);\n"
14214 #: ../src/guestfs-actions.pod:5969 ../fish/guestfish-actions.pod:3971
14216 "This command returns up to the last 10 lines of a file as a list of strings."
14220 #: ../src/guestfs-actions.pod:5981
14221 msgid "guestfs_tail_n"
14225 #: ../src/guestfs-actions.pod:5983
14229 " guestfs_tail_n (guestfs_h *g,\n"
14231 " const char *path);\n"
14236 #: ../src/guestfs-actions.pod:5988 ../fish/guestfish-actions.pod:3981
14238 "If the parameter C<nrlines> is a positive number, this returns the last "
14239 "C<nrlines> lines of the file C<path>."
14243 #: ../src/guestfs-actions.pod:5991 ../fish/guestfish-actions.pod:3984
14245 "If the parameter C<nrlines> is a negative number, this returns lines from "
14246 "the file C<path>, starting with the C<-nrlines>th line."
14250 #: ../src/guestfs-actions.pod:6005
14251 msgid "guestfs_tar_in"
14255 #: ../src/guestfs-actions.pod:6007
14259 " guestfs_tar_in (guestfs_h *g,\n"
14260 " const char *tarfile,\n"
14261 " const char *directory);\n"
14266 #: ../src/guestfs-actions.pod:6012 ../fish/guestfish-actions.pod:3996
14268 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14269 "tar file) into C<directory>."
14273 #: ../src/guestfs-actions.pod:6015
14275 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
14279 #: ../src/guestfs-actions.pod:6020 ../src/guestfs-actions.pod:6037
14280 #: ../src/guestfs-actions.pod:6053 ../src/guestfs-actions.pod:6069
14281 msgid "(Added in 1.0.3)"
14285 #: ../src/guestfs-actions.pod:6022
14286 msgid "guestfs_tar_out"
14290 #: ../src/guestfs-actions.pod:6024
14294 " guestfs_tar_out (guestfs_h *g,\n"
14295 " const char *directory,\n"
14296 " const char *tarfile);\n"
14301 #: ../src/guestfs-actions.pod:6029 ../fish/guestfish-actions.pod:4008
14303 "This command packs the contents of C<directory> and downloads it to local "
14308 #: ../src/guestfs-actions.pod:6032
14310 "To download a compressed tarball, use C<guestfs_tgz_out> or "
14311 "C<guestfs_txz_out>."
14315 #: ../src/guestfs-actions.pod:6039
14316 msgid "guestfs_tgz_in"
14320 #: ../src/guestfs-actions.pod:6041
14324 " guestfs_tgz_in (guestfs_h *g,\n"
14325 " const char *tarball,\n"
14326 " const char *directory);\n"
14331 #: ../src/guestfs-actions.pod:6046 ../fish/guestfish-actions.pod:4020
14333 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14334 "tar file) into C<directory>."
14338 #: ../src/guestfs-actions.pod:6049
14339 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
14343 #: ../src/guestfs-actions.pod:6055
14344 msgid "guestfs_tgz_out"
14348 #: ../src/guestfs-actions.pod:6057
14352 " guestfs_tgz_out (guestfs_h *g,\n"
14353 " const char *directory,\n"
14354 " const char *tarball);\n"
14359 #: ../src/guestfs-actions.pod:6062 ../fish/guestfish-actions.pod:4031
14361 "This command packs the contents of C<directory> and downloads it to local "
14366 #: ../src/guestfs-actions.pod:6065
14367 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
14371 #: ../src/guestfs-actions.pod:6071
14372 msgid "guestfs_touch"
14376 #: ../src/guestfs-actions.pod:6073
14380 " guestfs_touch (guestfs_h *g,\n"
14381 " const char *path);\n"
14386 #: ../src/guestfs-actions.pod:6077 ../fish/guestfish-actions.pod:4042
14388 "Touch acts like the L<touch(1)> command. It can be used to update the "
14389 "timestamps on a file, or, if the file does not exist, to create a new zero-"
14394 #: ../src/guestfs-actions.pod:6081 ../fish/guestfish-actions.pod:4046
14396 "This command only works on regular files, and will fail on other file types "
14397 "such as directories, symbolic links, block special etc."
14401 #: ../src/guestfs-actions.pod:6088
14402 msgid "guestfs_truncate"
14406 #: ../src/guestfs-actions.pod:6090
14410 " guestfs_truncate (guestfs_h *g,\n"
14411 " const char *path);\n"
14416 #: ../src/guestfs-actions.pod:6094 ../fish/guestfish-actions.pod:4053
14418 "This command truncates C<path> to a zero-length file. The file must exist "
14423 #: ../src/guestfs-actions.pod:6101
14424 msgid "guestfs_truncate_size"
14428 #: ../src/guestfs-actions.pod:6103
14432 " guestfs_truncate_size (guestfs_h *g,\n"
14433 " const char *path,\n"
14434 " int64_t size);\n"
14439 #: ../src/guestfs-actions.pod:6108 ../fish/guestfish-actions.pod:4060
14441 "This command truncates C<path> to size C<size> bytes. The file must exist "
14446 #: ../src/guestfs-actions.pod:6111
14448 "If the current file size is less than C<size> then the file is extended to "
14449 "the required size with zero bytes. This creates a sparse file (ie. disk "
14450 "blocks are not allocated for the file until you write to it). To create a "
14451 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
14455 #: ../src/guestfs-actions.pod:6121
14456 msgid "guestfs_tune2fs_l"
14460 #: ../src/guestfs-actions.pod:6123
14464 " guestfs_tune2fs_l (guestfs_h *g,\n"
14465 " const char *device);\n"
14470 #: ../src/guestfs-actions.pod:6127 ../fish/guestfish-actions.pod:4073
14472 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14477 #: ../src/guestfs-actions.pod:6130 ../fish/guestfish-actions.pod:4076
14479 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
14480 "for more details. The list of fields returned isn't clearly defined, and "
14481 "depends on both the version of C<tune2fs> that libguestfs was built against, "
14482 "and the filesystem itself."
14486 #: ../src/guestfs-actions.pod:6143
14487 msgid "guestfs_txz_in"
14491 #: ../src/guestfs-actions.pod:6145
14495 " guestfs_txz_in (guestfs_h *g,\n"
14496 " const char *tarball,\n"
14497 " const char *directory);\n"
14502 #: ../src/guestfs-actions.pod:6150 ../fish/guestfish-actions.pod:4085
14504 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
14505 "tar file) into C<directory>."
14509 #: ../src/guestfs-actions.pod:6157
14510 msgid "guestfs_txz_out"
14514 #: ../src/guestfs-actions.pod:6159
14518 " guestfs_txz_out (guestfs_h *g,\n"
14519 " const char *directory,\n"
14520 " const char *tarball);\n"
14525 #: ../src/guestfs-actions.pod:6164 ../fish/guestfish-actions.pod:4094
14527 "This command packs the contents of C<directory> and downloads it to local "
14528 "file C<tarball> (as an xz compressed tar archive)."
14532 #: ../src/guestfs-actions.pod:6171
14533 msgid "guestfs_umask"
14537 #: ../src/guestfs-actions.pod:6173
14541 " guestfs_umask (guestfs_h *g,\n"
14547 #: ../src/guestfs-actions.pod:6177 ../fish/guestfish-actions.pod:4103
14549 "This function sets the mask used for creating new files and device nodes to "
14554 #: ../src/guestfs-actions.pod:6180 ../fish/guestfish-actions.pod:4106
14556 "Typical umask values would be C<022> which creates new files with "
14557 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
14558 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
14562 #: ../src/guestfs-actions.pod:6185 ../fish/guestfish-actions.pod:4111
14564 "The default umask is C<022>. This is important because it means that "
14565 "directories and device nodes will be created with C<0644> or C<0755> mode "
14566 "even if you specify C<0777>."
14570 #: ../src/guestfs-actions.pod:6189
14572 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
14573 "C<guestfs_mkdir>."
14577 #: ../src/guestfs-actions.pod:6192 ../fish/guestfish-actions.pod:4118
14578 msgid "This call returns the previous umask."
14582 #: ../src/guestfs-actions.pod:6198
14583 msgid "guestfs_umount"
14587 #: ../src/guestfs-actions.pod:6200
14591 " guestfs_umount (guestfs_h *g,\n"
14592 " const char *pathordevice);\n"
14597 #: ../src/guestfs-actions.pod:6204 ../fish/guestfish-actions.pod:4126
14599 "This unmounts the given filesystem. The filesystem may be specified either "
14600 "by its mountpoint (path) or the device which contains the filesystem."
14604 #: ../src/guestfs-actions.pod:6212
14605 msgid "guestfs_umount_all"
14609 #: ../src/guestfs-actions.pod:6214
14613 " guestfs_umount_all (guestfs_h *g);\n"
14618 #: ../src/guestfs-actions.pod:6217 ../fish/guestfish-actions.pod:4136
14619 msgid "This unmounts all mounted filesystems."
14623 #: ../src/guestfs-actions.pod:6219 ../fish/guestfish-actions.pod:4138
14624 msgid "Some internal mounts are not unmounted by this call."
14628 #: ../src/guestfs-actions.pod:6225
14629 msgid "guestfs_upload"
14633 #: ../src/guestfs-actions.pod:6227
14637 " guestfs_upload (guestfs_h *g,\n"
14638 " const char *filename,\n"
14639 " const char *remotefilename);\n"
14644 #: ../src/guestfs-actions.pod:6232 ../src/guestfs-actions.pod:6251
14645 #: ../fish/guestfish-actions.pod:4144 ../fish/guestfish-actions.pod:4157
14646 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14650 #: ../src/guestfs-actions.pod:6237
14651 msgid "See also C<guestfs_download>."
14655 #: ../src/guestfs-actions.pod:6243
14656 msgid "guestfs_upload_offset"
14660 #: ../src/guestfs-actions.pod:6245
14664 " guestfs_upload_offset (guestfs_h *g,\n"
14665 " const char *filename,\n"
14666 " const char *remotefilename,\n"
14667 " int64_t offset);\n"
14672 #: ../src/guestfs-actions.pod:6254 ../fish/guestfish-actions.pod:4160
14674 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14675 "The intention is to overwrite parts of existing files or devices, although "
14676 "if a non-existant file is specified then it is created with a \"hole\" "
14677 "before C<offset>. The size of the data written is implicit in the size of "
14678 "the source C<filename>."
14682 #: ../src/guestfs-actions.pod:6261
14684 "Note that there is no limit on the amount of data that can be uploaded with "
14685 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
14686 "full amount unless an error occurs."
14690 #: ../src/guestfs-actions.pod:6266
14691 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
14695 #: ../src/guestfs-actions.pod:6272
14696 msgid "guestfs_utimens"
14700 #: ../src/guestfs-actions.pod:6274
14704 " guestfs_utimens (guestfs_h *g,\n"
14705 " const char *path,\n"
14706 " int64_t atsecs,\n"
14707 " int64_t atnsecs,\n"
14708 " int64_t mtsecs,\n"
14709 " int64_t mtnsecs);\n"
14714 #: ../src/guestfs-actions.pod:6282 ../fish/guestfish-actions.pod:4180
14715 msgid "This command sets the timestamps of a file with nanosecond precision."
14719 #: ../src/guestfs-actions.pod:6285 ../fish/guestfish-actions.pod:4183
14721 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14726 #: ../src/guestfs-actions.pod:6288 ../fish/guestfish-actions.pod:4186
14728 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14729 "nanoseconds from the epoch."
14733 #: ../src/guestfs-actions.pod:6291 ../fish/guestfish-actions.pod:4189
14735 "If the C<*nsecs> field contains the special value C<-1> then the "
14736 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14737 "ignored in this case)."
14741 #: ../src/guestfs-actions.pod:6295 ../fish/guestfish-actions.pod:4193
14743 "If the C<*nsecs> field contains the special value C<-2> then the "
14744 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14749 #: ../src/guestfs-actions.pod:6303 ../src/guestfs-structs.pod:175
14750 msgid "guestfs_version"
14754 #: ../src/guestfs-actions.pod:6305
14757 " struct guestfs_version *\n"
14758 " guestfs_version (guestfs_h *g);\n"
14763 #: ../src/guestfs-actions.pod:6308 ../fish/guestfish-actions.pod:4201
14765 "Return the libguestfs version number that the program is linked against."
14769 #: ../src/guestfs-actions.pod:6311 ../fish/guestfish-actions.pod:4204
14771 "Note that because of dynamic linking this is not necessarily the version of "
14772 "libguestfs that you compiled against. You can compile the program, and then "
14773 "at runtime dynamically link against a completely different C<libguestfs.so> "
14778 #: ../src/guestfs-actions.pod:6316 ../fish/guestfish-actions.pod:4209
14780 "This call was added in version C<1.0.58>. In previous versions of "
14781 "libguestfs there was no way to get the version number. From C code you can "
14782 "use dynamic linker functions to find out if this symbol exists (if it "
14783 "doesn't, then it's an earlier version)."
14787 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4215
14789 "The call returns a structure with four elements. The first three (C<major>, "
14790 "C<minor> and C<release>) are numbers and correspond to the usual version "
14791 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14792 "but may be used for distro-specific information."
14796 #: ../src/guestfs-actions.pod:6328 ../fish/guestfish-actions.pod:4221
14798 "To construct the original version string: C<$major.$minor.$release$extra>"
14802 #: ../src/guestfs-actions.pod:6331 ../fish/guestfish-actions.pod:4224
14803 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14807 #: ../src/guestfs-actions.pod:6333
14809 "I<Note:> Don't use this call to test for availability of features. In "
14810 "enterprise distributions we backport features from later versions into "
14811 "earlier versions, making this an unreliable way to test for features. Use "
14812 "C<guestfs_available> instead."
14816 #: ../src/guestfs-actions.pod:6339
14818 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
14819 "error. I<The caller must call C<guestfs_free_version> after use>."
14823 #: ../src/guestfs-actions.pod:6343
14824 msgid "(Added in 1.0.58)"
14828 #: ../src/guestfs-actions.pod:6345
14829 msgid "guestfs_vfs_label"
14833 #: ../src/guestfs-actions.pod:6347
14837 " guestfs_vfs_label (guestfs_h *g,\n"
14838 " const char *device);\n"
14843 #: ../src/guestfs-actions.pod:6351 ../fish/guestfish-actions.pod:4236
14844 msgid "This returns the filesystem label of the filesystem on C<device>."
14848 #: ../src/guestfs-actions.pod:6354 ../fish/guestfish-actions.pod:4239
14849 msgid "If the filesystem is unlabeled, this returns the empty string."
14853 #: ../src/guestfs-actions.pod:6356
14854 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
14858 #: ../src/guestfs-actions.pod:6361 ../src/guestfs-actions.pod:6398
14859 msgid "(Added in 1.3.18)"
14863 #: ../src/guestfs-actions.pod:6363
14864 msgid "guestfs_vfs_type"
14868 #: ../src/guestfs-actions.pod:6365
14872 " guestfs_vfs_type (guestfs_h *g,\n"
14873 " const char *device);\n"
14878 #: ../src/guestfs-actions.pod:6369 ../fish/guestfish-actions.pod:4247
14880 "This command gets the filesystem type corresponding to the filesystem on "
14885 #: ../src/guestfs-actions.pod:6372 ../fish/guestfish-actions.pod:4250
14887 "For most filesystems, the result is the name of the Linux VFS module which "
14888 "would be used to mount this filesystem if you mounted it without specifying "
14889 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14893 #: ../src/guestfs-actions.pod:6382
14894 msgid "guestfs_vfs_uuid"
14898 #: ../src/guestfs-actions.pod:6384
14902 " guestfs_vfs_uuid (guestfs_h *g,\n"
14903 " const char *device);\n"
14908 #: ../src/guestfs-actions.pod:6388 ../fish/guestfish-actions.pod:4259
14909 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14913 #: ../src/guestfs-actions.pod:6391 ../fish/guestfish-actions.pod:4262
14914 msgid "If the filesystem does not have a UUID, this returns the empty string."
14918 #: ../src/guestfs-actions.pod:6393
14919 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
14923 #: ../src/guestfs-actions.pod:6400
14924 msgid "guestfs_vg_activate"
14928 #: ../src/guestfs-actions.pod:6402
14932 " guestfs_vg_activate (guestfs_h *g,\n"
14934 " char *const *volgroups);\n"
14939 #: ../src/guestfs-actions.pod:6407 ../fish/guestfish-actions.pod:4270
14941 "This command activates or (if C<activate> is false) deactivates all logical "
14942 "volumes in the listed volume groups C<volgroups>. If activated, then they "
14943 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
14944 "deactivated, then those devices disappear."
14948 #: ../src/guestfs-actions.pod:6413 ../fish/guestfish-actions.pod:4276
14949 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14953 #: ../src/guestfs-actions.pod:6415 ../fish/guestfish-actions.pod:4278
14955 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14956 "activated or deactivated."
14960 #: ../src/guestfs-actions.pod:6422
14961 msgid "guestfs_vg_activate_all"
14965 #: ../src/guestfs-actions.pod:6424
14969 " guestfs_vg_activate_all (guestfs_h *g,\n"
14970 " int activate);\n"
14975 #: ../src/guestfs-actions.pod:6428 ../fish/guestfish-actions.pod:4285
14977 "This command activates or (if C<activate> is false) deactivates all logical "
14978 "volumes in all volume groups. If activated, then they are made known to the "
14979 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
14980 "those devices disappear."
14984 #: ../src/guestfs-actions.pod:6434 ../fish/guestfish-actions.pod:4291
14985 msgid "This command is the same as running C<vgchange -a y|n>"
14989 #: ../src/guestfs-actions.pod:6440
14990 msgid "guestfs_vgcreate"
14994 #: ../src/guestfs-actions.pod:6442
14998 " guestfs_vgcreate (guestfs_h *g,\n"
14999 " const char *volgroup,\n"
15000 " char *const *physvols);\n"
15005 #: ../src/guestfs-actions.pod:6447 ../fish/guestfish-actions.pod:4297
15007 "This creates an LVM volume group called C<volgroup> from the non-empty list "
15008 "of physical volumes C<physvols>."
15012 #: ../src/guestfs-actions.pod:6454
15013 msgid "guestfs_vglvuuids"
15017 #: ../src/guestfs-actions.pod:6456
15021 " guestfs_vglvuuids (guestfs_h *g,\n"
15022 " const char *vgname);\n"
15027 #: ../src/guestfs-actions.pod:6460 ../fish/guestfish-actions.pod:4304
15029 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
15030 "volumes created in this volume group."
15034 #: ../src/guestfs-actions.pod:6463
15036 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
15037 "associate logical volumes and volume groups."
15041 #: ../src/guestfs-actions.pod:6466
15042 msgid "See also C<guestfs_vgpvuuids>."
15046 #: ../src/guestfs-actions.pod:6474
15047 msgid "guestfs_vgpvuuids"
15051 #: ../src/guestfs-actions.pod:6476
15055 " guestfs_vgpvuuids (guestfs_h *g,\n"
15056 " const char *vgname);\n"
15061 #: ../src/guestfs-actions.pod:6480 ../fish/guestfish-actions.pod:4316
15063 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
15064 "volumes that this volume group resides on."
15068 #: ../src/guestfs-actions.pod:6483
15070 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
15071 "associate physical volumes and volume groups."
15075 #: ../src/guestfs-actions.pod:6486
15076 msgid "See also C<guestfs_vglvuuids>."
15080 #: ../src/guestfs-actions.pod:6494
15081 msgid "guestfs_vgremove"
15085 #: ../src/guestfs-actions.pod:6496
15089 " guestfs_vgremove (guestfs_h *g,\n"
15090 " const char *vgname);\n"
15095 #: ../src/guestfs-actions.pod:6500 ../fish/guestfish-actions.pod:4328
15096 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
15100 #: ../src/guestfs-actions.pod:6502 ../fish/guestfish-actions.pod:4330
15102 "This also forcibly removes all logical volumes in the volume group (if any)."
15106 #: ../src/guestfs-actions.pod:6509
15107 msgid "guestfs_vgrename"
15111 #: ../src/guestfs-actions.pod:6511
15115 " guestfs_vgrename (guestfs_h *g,\n"
15116 " const char *volgroup,\n"
15117 " const char *newvolgroup);\n"
15122 #: ../src/guestfs-actions.pod:6516 ../fish/guestfish-actions.pod:4337
15123 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
15127 #: ../src/guestfs-actions.pod:6522
15128 msgid "guestfs_vgs"
15132 #: ../src/guestfs-actions.pod:6524
15136 " guestfs_vgs (guestfs_h *g);\n"
15141 #: ../src/guestfs-actions.pod:6527 ../fish/guestfish-actions.pod:4343
15143 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15148 #: ../src/guestfs-actions.pod:6530 ../fish/guestfish-actions.pod:4346
15150 "This returns a list of just the volume group names that were detected (eg. "
15155 #: ../src/guestfs-actions.pod:6533
15156 msgid "See also C<guestfs_vgs_full>."
15160 #: ../src/guestfs-actions.pod:6541
15161 msgid "guestfs_vgs_full"
15165 #: ../src/guestfs-actions.pod:6543
15168 " struct guestfs_lvm_vg_list *\n"
15169 " guestfs_vgs_full (guestfs_h *g);\n"
15174 #: ../src/guestfs-actions.pod:6546 ../fish/guestfish-actions.pod:4355
15176 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15177 "> command. The \"full\" version includes all fields."
15181 #: ../src/guestfs-actions.pod:6549
15183 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
15184 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
15188 #: ../src/guestfs-actions.pod:6555
15189 msgid "guestfs_vgscan"
15193 #: ../src/guestfs-actions.pod:6557
15197 " guestfs_vgscan (guestfs_h *g);\n"
15202 #: ../src/guestfs-actions.pod:6560 ../fish/guestfish-actions.pod:4362
15204 "This rescans all block devices and rebuilds the list of LVM physical "
15205 "volumes, volume groups and logical volumes."
15209 #: ../src/guestfs-actions.pod:6567
15210 msgid "guestfs_vguuid"
15214 #: ../src/guestfs-actions.pod:6569
15218 " guestfs_vguuid (guestfs_h *g,\n"
15219 " const char *vgname);\n"
15224 #: ../src/guestfs-actions.pod:6573 ../fish/guestfish-actions.pod:4369
15225 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15229 #: ../src/guestfs-actions.pod:6580
15230 msgid "guestfs_wait_ready"
15234 #: ../src/guestfs-actions.pod:6582
15238 " guestfs_wait_ready (guestfs_h *g);\n"
15243 #: ../src/guestfs-actions.pod:6585
15244 msgid "This function is a no op."
15248 #: ../src/guestfs-actions.pod:6587
15250 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
15251 "calling C<guestfs_launch> to wait for the launch to complete. However this "
15252 "is no longer necessary because C<guestfs_launch> now does the waiting."
15256 #: ../src/guestfs-actions.pod:6592
15258 "If you see any calls to this function in code then you can just remove them, "
15259 "unless you want to retain compatibility with older versions of the API."
15263 #: ../src/guestfs-actions.pod:6600
15264 msgid "guestfs_wc_c"
15268 #: ../src/guestfs-actions.pod:6602
15272 " guestfs_wc_c (guestfs_h *g,\n"
15273 " const char *path);\n"
15278 #: ../src/guestfs-actions.pod:6606 ../fish/guestfish-actions.pod:4375
15280 "This command counts the characters in a file, using the C<wc -c> external "
15285 #: ../src/guestfs-actions.pod:6613
15286 msgid "guestfs_wc_l"
15290 #: ../src/guestfs-actions.pod:6615
15294 " guestfs_wc_l (guestfs_h *g,\n"
15295 " const char *path);\n"
15300 #: ../src/guestfs-actions.pod:6619 ../fish/guestfish-actions.pod:4382
15302 "This command counts the lines in a file, using the C<wc -l> external command."
15306 #: ../src/guestfs-actions.pod:6626
15307 msgid "guestfs_wc_w"
15311 #: ../src/guestfs-actions.pod:6628
15315 " guestfs_wc_w (guestfs_h *g,\n"
15316 " const char *path);\n"
15321 #: ../src/guestfs-actions.pod:6632 ../fish/guestfish-actions.pod:4389
15323 "This command counts the words in a file, using the C<wc -w> external command."
15327 #: ../src/guestfs-actions.pod:6639
15328 msgid "guestfs_write"
15332 #: ../src/guestfs-actions.pod:6641
15336 " guestfs_write (guestfs_h *g,\n"
15337 " const char *path,\n"
15338 " const char *content,\n"
15339 " size_t content_size);\n"
15344 #: ../src/guestfs-actions.pod:6647 ../fish/guestfish-actions.pod:4396
15346 "This call creates a file called C<path>. The content of the file is the "
15347 "string C<content> (which can contain any 8 bit data)."
15351 #: ../src/guestfs-actions.pod:6657
15352 msgid "guestfs_write_file"
15356 #: ../src/guestfs-actions.pod:6659
15360 " guestfs_write_file (guestfs_h *g,\n"
15361 " const char *path,\n"
15362 " const char *content,\n"
15368 #: ../src/guestfs-actions.pod:6665 ../fish/guestfish-actions.pod:4406
15370 "This call creates a file called C<path>. The contents of the file is the "
15371 "string C<content> (which can contain any 8 bit data), with length C<size>."
15375 #: ../src/guestfs-actions.pod:6669 ../fish/guestfish-actions.pod:4410
15377 "As a special case, if C<size> is C<0> then the length is calculated using "
15378 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15382 #: ../src/guestfs-actions.pod:6673 ../fish/guestfish-actions.pod:4414
15384 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15385 "I<not> work, even if the length is specified."
15389 #: ../src/guestfs-actions.pod:6681 ../fish/guestfish-actions.pod:4420
15391 "This function is deprecated. In new code, use the C<write> call instead."
15395 #: ../src/guestfs-actions.pod:6690
15396 msgid "guestfs_zegrep"
15400 #: ../src/guestfs-actions.pod:6692
15404 " guestfs_zegrep (guestfs_h *g,\n"
15405 " const char *regex,\n"
15406 " const char *path);\n"
15411 #: ../src/guestfs-actions.pod:6697 ../fish/guestfish-actions.pod:4431
15413 "This calls the external C<zegrep> program and returns the matching lines."
15417 #: ../src/guestfs-actions.pod:6709
15418 msgid "guestfs_zegrepi"
15422 #: ../src/guestfs-actions.pod:6711
15426 " guestfs_zegrepi (guestfs_h *g,\n"
15427 " const char *regex,\n"
15428 " const char *path);\n"
15433 #: ../src/guestfs-actions.pod:6716 ../fish/guestfish-actions.pod:4441
15435 "This calls the external C<zegrep -i> program and returns the matching lines."
15439 #: ../src/guestfs-actions.pod:6728
15440 msgid "guestfs_zero"
15444 #: ../src/guestfs-actions.pod:6730
15448 " guestfs_zero (guestfs_h *g,\n"
15449 " const char *device);\n"
15454 #: ../src/guestfs-actions.pod:6734 ../fish/guestfish-actions.pod:4451
15455 msgid "This command writes zeroes over the first few blocks of C<device>."
15459 #: ../src/guestfs-actions.pod:6736 ../fish/guestfish-actions.pod:4453
15461 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15462 "securely wipe the device). It should be sufficient to remove any partition "
15463 "tables, filesystem superblocks and so on."
15467 #: ../src/guestfs-actions.pod:6740
15468 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
15472 #: ../src/guestfs-actions.pod:6751
15473 msgid "guestfs_zero_device"
15477 #: ../src/guestfs-actions.pod:6753
15481 " guestfs_zero_device (guestfs_h *g,\n"
15482 " const char *device);\n"
15487 #: ../src/guestfs-actions.pod:6757
15489 "This command writes zeroes over the entire C<device>. Compare with "
15490 "C<guestfs_zero> which just zeroes the first few blocks of a device."
15494 #: ../src/guestfs-actions.pod:6771
15495 msgid "(Added in 1.3.1)"
15499 #: ../src/guestfs-actions.pod:6773
15500 msgid "guestfs_zerofree"
15504 #: ../src/guestfs-actions.pod:6775
15508 " guestfs_zerofree (guestfs_h *g,\n"
15509 " const char *device);\n"
15514 #: ../src/guestfs-actions.pod:6779 ../fish/guestfish-actions.pod:4474
15516 "This runs the I<zerofree> program on C<device>. This program claims to zero "
15517 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
15518 "possible to compress the filesystem more effectively."
15522 #: ../src/guestfs-actions.pod:6784 ../fish/guestfish-actions.pod:4479
15523 msgid "You should B<not> run this program if the filesystem is mounted."
15527 #: ../src/guestfs-actions.pod:6787 ../fish/guestfish-actions.pod:4482
15529 "It is possible that using this program can damage the filesystem or data on "
15534 #: ../src/guestfs-actions.pod:6794
15535 msgid "guestfs_zfgrep"
15539 #: ../src/guestfs-actions.pod:6796
15543 " guestfs_zfgrep (guestfs_h *g,\n"
15544 " const char *pattern,\n"
15545 " const char *path);\n"
15550 #: ../src/guestfs-actions.pod:6801 ../fish/guestfish-actions.pod:4489
15552 "This calls the external C<zfgrep> program and returns the matching lines."
15556 #: ../src/guestfs-actions.pod:6813
15557 msgid "guestfs_zfgrepi"
15561 #: ../src/guestfs-actions.pod:6815
15565 " guestfs_zfgrepi (guestfs_h *g,\n"
15566 " const char *pattern,\n"
15567 " const char *path);\n"
15572 #: ../src/guestfs-actions.pod:6820 ../fish/guestfish-actions.pod:4499
15574 "This calls the external C<zfgrep -i> program and returns the matching lines."
15578 #: ../src/guestfs-actions.pod:6832
15579 msgid "guestfs_zfile"
15583 #: ../src/guestfs-actions.pod:6834
15587 " guestfs_zfile (guestfs_h *g,\n"
15588 " const char *meth,\n"
15589 " const char *path);\n"
15594 #: ../src/guestfs-actions.pod:6839 ../fish/guestfish-actions.pod:4509
15596 "This command runs C<file> after first decompressing C<path> using C<method>."
15600 #: ../src/guestfs-actions.pod:6842 ../fish/guestfish-actions.pod:4512
15601 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
15605 #: ../src/guestfs-actions.pod:6844
15607 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
15612 #: ../src/guestfs-actions.pod:6850 ../fish/guestfish-actions.pod:4517
15614 "This function is deprecated. In new code, use the C<file> call instead."
15618 #: ../src/guestfs-actions.pod:6859
15619 msgid "guestfs_zgrep"
15623 #: ../src/guestfs-actions.pod:6861
15627 " guestfs_zgrep (guestfs_h *g,\n"
15628 " const char *regex,\n"
15629 " const char *path);\n"
15634 #: ../src/guestfs-actions.pod:6866 ../fish/guestfish-actions.pod:4528
15636 "This calls the external C<zgrep> program and returns the matching lines."
15640 #: ../src/guestfs-actions.pod:6878
15641 msgid "guestfs_zgrepi"
15645 #: ../src/guestfs-actions.pod:6880
15649 " guestfs_zgrepi (guestfs_h *g,\n"
15650 " const char *regex,\n"
15651 " const char *path);\n"
15656 #: ../src/guestfs-actions.pod:6885 ../fish/guestfish-actions.pod:4538
15658 "This calls the external C<zgrep -i> program and returns the matching lines."
15662 #: ../src/guestfs-availability.pod:3
15667 #: ../src/guestfs-availability.pod:5
15669 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
15670 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
15671 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
15672 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
15673 "L</guestfs_aug_save> L</guestfs_aug_set>"
15677 #: ../src/guestfs-availability.pod:21
15682 #: ../src/guestfs-availability.pod:23
15684 "The following functions: L</guestfs_inotify_add_watch> L</"
15685 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
15686 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
15690 #: ../src/guestfs-availability.pod:31
15691 msgid "B<linuxfsuuid>"
15695 #: ../src/guestfs-availability.pod:33
15697 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
15698 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
15702 #: ../src/guestfs-availability.pod:40
15703 msgid "B<linuxmodules>"
15707 #: ../src/guestfs-availability.pod:42
15708 msgid "The following functions: L</guestfs_modprobe>"
15712 #: ../src/guestfs-availability.pod:45
15713 msgid "B<linuxxattrs>"
15717 #: ../src/guestfs-availability.pod:47
15719 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> L</"
15720 "guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</"
15721 "guestfs_removexattr> L</guestfs_setxattr>"
15725 #: ../src/guestfs-availability.pod:56
15730 #: ../src/guestfs-availability.pod:58
15732 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
15733 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
15734 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
15738 #: ../src/guestfs-availability.pod:67
15743 #: ../src/guestfs-availability.pod:69
15745 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
15746 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
15747 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
15748 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
15749 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
15750 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
15751 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
15755 #: ../src/guestfs-availability.pod:92
15760 #: ../src/guestfs-availability.pod:94
15762 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
15763 "guestfs_mknod_b> L</guestfs_mknod_c>"
15767 #: ../src/guestfs-availability.pod:100
15772 #: ../src/guestfs-availability.pod:102
15773 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
15777 #: ../src/guestfs-availability.pod:105
15778 msgid "B<ntfsprogs>"
15782 #: ../src/guestfs-availability.pod:107
15784 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
15788 #: ../src/guestfs-availability.pod:111
15789 msgid "B<realpath>"
15793 #: ../src/guestfs-availability.pod:113
15794 msgid "The following functions: L</guestfs_realpath>"
15798 #: ../src/guestfs-availability.pod:116
15803 #: ../src/guestfs-availability.pod:118
15805 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
15806 "guestfs_scrub_freespace>"
15810 #: ../src/guestfs-availability.pod:123
15815 #: ../src/guestfs-availability.pod:125
15816 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
15820 #: ../src/guestfs-availability.pod:129
15825 #: ../src/guestfs-availability.pod:131
15826 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
15830 #: ../src/guestfs-availability.pod:135
15831 msgid "B<zerofree>"
15835 #: ../src/guestfs-availability.pod:137
15836 msgid "The following functions: L</guestfs_zerofree>"
15840 #: ../src/guestfs-structs.pod:1
15841 msgid "guestfs_int_bool"
15845 #: ../src/guestfs-structs.pod:3
15848 " struct guestfs_int_bool {\n"
15856 #: ../src/guestfs-structs.pod:8
15859 " struct guestfs_int_bool_list {\n"
15860 " uint32_t len; /* Number of elements in list. */\n"
15861 " struct guestfs_int_bool *val; /* Elements. */\n"
15867 #: ../src/guestfs-structs.pod:13
15870 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
15871 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
15876 #: ../src/guestfs-structs.pod:16
15877 msgid "guestfs_lvm_pv"
15881 #: ../src/guestfs-structs.pod:18
15884 " struct guestfs_lvm_pv {\n"
15885 " char *pv_name;\n"
15886 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
15887 " char pv_uuid[32];\n"
15889 " uint64_t pv_size;\n"
15890 " uint64_t dev_size;\n"
15891 " uint64_t pv_free;\n"
15892 " uint64_t pv_used;\n"
15893 " char *pv_attr;\n"
15894 " int64_t pv_pe_count;\n"
15895 " int64_t pv_pe_alloc_count;\n"
15896 " char *pv_tags;\n"
15897 " uint64_t pe_start;\n"
15898 " int64_t pv_mda_count;\n"
15899 " uint64_t pv_mda_free;\n"
15905 #: ../src/guestfs-structs.pod:36
15908 " struct guestfs_lvm_pv_list {\n"
15909 " uint32_t len; /* Number of elements in list. */\n"
15910 " struct guestfs_lvm_pv *val; /* Elements. */\n"
15916 #: ../src/guestfs-structs.pod:41
15919 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
15920 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
15925 #: ../src/guestfs-structs.pod:44
15926 msgid "guestfs_lvm_vg"
15930 #: ../src/guestfs-structs.pod:46
15933 " struct guestfs_lvm_vg {\n"
15934 " char *vg_name;\n"
15935 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
15936 " char vg_uuid[32];\n"
15938 " char *vg_attr;\n"
15939 " uint64_t vg_size;\n"
15940 " uint64_t vg_free;\n"
15941 " char *vg_sysid;\n"
15942 " uint64_t vg_extent_size;\n"
15943 " int64_t vg_extent_count;\n"
15944 " int64_t vg_free_count;\n"
15945 " int64_t max_lv;\n"
15946 " int64_t max_pv;\n"
15947 " int64_t pv_count;\n"
15948 " int64_t lv_count;\n"
15949 " int64_t snap_count;\n"
15950 " int64_t vg_seqno;\n"
15951 " char *vg_tags;\n"
15952 " int64_t vg_mda_count;\n"
15953 " uint64_t vg_mda_free;\n"
15959 #: ../src/guestfs-structs.pod:69
15962 " struct guestfs_lvm_vg_list {\n"
15963 " uint32_t len; /* Number of elements in list. */\n"
15964 " struct guestfs_lvm_vg *val; /* Elements. */\n"
15970 #: ../src/guestfs-structs.pod:74
15973 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
15974 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
15979 #: ../src/guestfs-structs.pod:77
15980 msgid "guestfs_lvm_lv"
15984 #: ../src/guestfs-structs.pod:79
15987 " struct guestfs_lvm_lv {\n"
15988 " char *lv_name;\n"
15989 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
15990 " char lv_uuid[32];\n"
15991 " char *lv_attr;\n"
15992 " int64_t lv_major;\n"
15993 " int64_t lv_minor;\n"
15994 " int64_t lv_kernel_major;\n"
15995 " int64_t lv_kernel_minor;\n"
15996 " uint64_t lv_size;\n"
15997 " int64_t seg_count;\n"
15999 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16000 " float snap_percent;\n"
16001 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16002 " float copy_percent;\n"
16003 " char *move_pv;\n"
16004 " char *lv_tags;\n"
16005 " char *mirror_log;\n"
16006 " char *modules;\n"
16012 #: ../src/guestfs-structs.pod:101
16015 " struct guestfs_lvm_lv_list {\n"
16016 " uint32_t len; /* Number of elements in list. */\n"
16017 " struct guestfs_lvm_lv *val; /* Elements. */\n"
16023 #: ../src/guestfs-structs.pod:106
16026 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
16027 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
16032 #: ../src/guestfs-structs.pod:111
16035 " struct guestfs_stat {\n"
16039 " int64_t nlink;\n"
16044 " int64_t blksize;\n"
16045 " int64_t blocks;\n"
16046 " int64_t atime;\n"
16047 " int64_t mtime;\n"
16048 " int64_t ctime;\n"
16054 #: ../src/guestfs-structs.pod:127
16057 " struct guestfs_stat_list {\n"
16058 " uint32_t len; /* Number of elements in list. */\n"
16059 " struct guestfs_stat *val; /* Elements. */\n"
16065 #: ../src/guestfs-structs.pod:132
16068 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
16069 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
16074 #: ../src/guestfs-structs.pod:137
16077 " struct guestfs_statvfs {\n"
16078 " int64_t bsize;\n"
16079 " int64_t frsize;\n"
16080 " int64_t blocks;\n"
16081 " int64_t bfree;\n"
16082 " int64_t bavail;\n"
16083 " int64_t files;\n"
16084 " int64_t ffree;\n"
16085 " int64_t favail;\n"
16088 " int64_t namemax;\n"
16094 #: ../src/guestfs-structs.pod:151
16097 " struct guestfs_statvfs_list {\n"
16098 " uint32_t len; /* Number of elements in list. */\n"
16099 " struct guestfs_statvfs *val; /* Elements. */\n"
16105 #: ../src/guestfs-structs.pod:156
16108 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
16109 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
16114 #: ../src/guestfs-structs.pod:159
16115 msgid "guestfs_dirent"
16119 #: ../src/guestfs-structs.pod:161
16122 " struct guestfs_dirent {\n"
16131 #: ../src/guestfs-structs.pod:167
16134 " struct guestfs_dirent_list {\n"
16135 " uint32_t len; /* Number of elements in list. */\n"
16136 " struct guestfs_dirent *val; /* Elements. */\n"
16142 #: ../src/guestfs-structs.pod:172
16145 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
16146 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
16151 #: ../src/guestfs-structs.pod:177
16154 " struct guestfs_version {\n"
16155 " int64_t major;\n"
16156 " int64_t minor;\n"
16157 " int64_t release;\n"
16164 #: ../src/guestfs-structs.pod:184
16167 " struct guestfs_version_list {\n"
16168 " uint32_t len; /* Number of elements in list. */\n"
16169 " struct guestfs_version *val; /* Elements. */\n"
16175 #: ../src/guestfs-structs.pod:189
16178 " void guestfs_free_version (struct guestfs_free_version *);\n"
16179 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
16184 #: ../src/guestfs-structs.pod:192
16185 msgid "guestfs_xattr"
16189 #: ../src/guestfs-structs.pod:194
16192 " struct guestfs_xattr {\n"
16193 " char *attrname;\n"
16194 " /* The next two fields describe a byte array. */\n"
16195 " uint32_t attrval_len;\n"
16196 " char *attrval;\n"
16202 #: ../src/guestfs-structs.pod:201
16205 " struct guestfs_xattr_list {\n"
16206 " uint32_t len; /* Number of elements in list. */\n"
16207 " struct guestfs_xattr *val; /* Elements. */\n"
16213 #: ../src/guestfs-structs.pod:206
16216 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
16217 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
16222 #: ../src/guestfs-structs.pod:209
16223 msgid "guestfs_inotify_event"
16227 #: ../src/guestfs-structs.pod:211
16230 " struct guestfs_inotify_event {\n"
16231 " int64_t in_wd;\n"
16232 " uint32_t in_mask;\n"
16233 " uint32_t in_cookie;\n"
16234 " char *in_name;\n"
16240 #: ../src/guestfs-structs.pod:218
16243 " struct guestfs_inotify_event_list {\n"
16244 " uint32_t len; /* Number of elements in list. */\n"
16245 " struct guestfs_inotify_event *val; /* Elements. */\n"
16251 #: ../src/guestfs-structs.pod:223
16254 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
16255 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
16260 #: ../src/guestfs-structs.pod:226
16261 msgid "guestfs_partition"
16265 #: ../src/guestfs-structs.pod:228
16268 " struct guestfs_partition {\n"
16269 " int32_t part_num;\n"
16270 " uint64_t part_start;\n"
16271 " uint64_t part_end;\n"
16272 " uint64_t part_size;\n"
16278 #: ../src/guestfs-structs.pod:235
16281 " struct guestfs_partition_list {\n"
16282 " uint32_t len; /* Number of elements in list. */\n"
16283 " struct guestfs_partition *val; /* Elements. */\n"
16289 #: ../src/guestfs-structs.pod:240
16292 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
16293 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
16298 #: ../fish/guestfish.pod:5
16299 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
16303 #: ../fish/guestfish.pod:9
16306 " guestfish [--options] [commands]\n"
16311 #: ../fish/guestfish.pod:11
16319 #: ../fish/guestfish.pod:13
16322 " guestfish [--ro|--rw] -a disk.img\n"
16327 #: ../fish/guestfish.pod:15
16330 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
16335 #: ../fish/guestfish.pod:17
16338 " guestfish -d libvirt-domain\n"
16343 #: ../fish/guestfish.pod:19
16346 " guestfish [--ro|--rw] -a disk.img -i\n"
16351 #: ../fish/guestfish.pod:21
16354 " guestfish -d libvirt-domain -i\n"
16359 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
16360 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
16361 #: ../tools/virt-rescue.pl:41
16366 #: ../fish/guestfish.pod:25
16368 "Using guestfish in read/write mode on live virtual machines can be "
16369 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16370 "option to use guestfish safely if the disk image or virtual machine might be "
16375 #: ../fish/guestfish.pod:32
16377 "Guestfish is a shell and command-line tool for examining and modifying "
16378 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16379 "functionality of the guestfs API, see L<guestfs(3)>."
16383 #: ../fish/guestfish.pod:36
16385 "Guestfish gives you structured access to the libguestfs API, from shell "
16386 "scripts or the command line or interactively. If you want to rescue a "
16387 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16392 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:846
16393 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58
16394 #: ../tools/virt-resize.pl:66 ../tools/virt-tar.pl:45
16399 #: ../fish/guestfish.pod:43
16400 msgid "As an interactive shell"
16404 #: ../fish/guestfish.pod:45
16412 #: ../fish/guestfish.pod:47
16415 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
16416 " editing virtual machine filesystems.\n"
16421 #: ../fish/guestfish.pod:50
16424 " Type: 'help' for a list of commands\n"
16425 " 'man' to read the manual\n"
16426 " 'quit' to quit the shell\n"
16431 #: ../fish/guestfish.pod:54
16434 " ><fs> add-ro disk.img\n"
16436 " ><fs> list-filesystems\n"
16437 " /dev/sda1: ext4\n"
16438 " /dev/vg_guest/lv_root: ext4\n"
16439 " /dev/vg_guest/lv_swap: swap\n"
16440 " ><fs> mount /dev/vg_guest/lv_root /\n"
16441 " ><fs> cat /etc/fstab\n"
16443 " # Created by anaconda\n"
16450 #: ../fish/guestfish.pod:67
16451 msgid "From shell scripts"
16455 #: ../fish/guestfish.pod:69
16456 msgid "Create a new C</etc/motd> file in a guest or disk image:"
16460 #: ../fish/guestfish.pod:71
16463 " guestfish <<_EOF_\n"
16466 " mount /dev/vg_guest/lv_root /\n"
16467 " write /etc/motd \"Welcome, new users\"\n"
16473 #: ../fish/guestfish.pod:78
16474 msgid "List the LVM logical volumes in a disk image:"
16478 #: ../fish/guestfish.pod:80
16481 " guestfish -a disk.img --ro <<_EOF_\n"
16489 #: ../fish/guestfish.pod:85
16490 msgid "List all the filesystems in a disk image:"
16494 #: ../fish/guestfish.pod:87
16497 " guestfish -a disk.img --ro <<_EOF_\n"
16499 " list-filesystems\n"
16505 #: ../fish/guestfish.pod:92
16506 msgid "On one command line"
16510 #: ../fish/guestfish.pod:94
16511 msgid "Update C</etc/resolv.conf> in a guest:"
16515 #: ../fish/guestfish.pod:96
16519 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
16520 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
16525 #: ../fish/guestfish.pod:100
16526 msgid "Edit C</boot/grub/grub.conf> interactively:"
16530 #: ../fish/guestfish.pod:102
16533 " guestfish --rw --add disk.img \\\n"
16534 " --mount /dev/vg_guest/lv_root \\\n"
16535 " --mount /dev/sda1:/boot \\\n"
16536 " edit /boot/grub/grub.conf\n"
16541 #: ../fish/guestfish.pod:107
16542 msgid "Mount disks automatically"
16546 #: ../fish/guestfish.pod:109
16548 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
16552 #: ../fish/guestfish.pod:112
16555 " guestfish --ro -a disk.img -i cat /etc/group\n"
16560 #: ../fish/guestfish.pod:114
16563 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
16568 #: ../fish/guestfish.pod:116
16569 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
16573 #: ../fish/guestfish.pod:118
16576 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
16581 #: ../fish/guestfish.pod:120
16582 msgid "As a script interpreter"
16586 #: ../fish/guestfish.pod:122
16587 msgid "Create a 100MB disk containing an ext2-formatted partition:"
16591 #: ../fish/guestfish.pod:124
16594 " #!/usr/bin/guestfish -f\n"
16595 " sparse test1.img 100M\n"
16597 " part-disk /dev/sda mbr\n"
16598 " mkfs ext2 /dev/sda1\n"
16603 #: ../fish/guestfish.pod:130
16604 msgid "Start with a prepared disk"
16608 #: ../fish/guestfish.pod:132
16610 "An alternate way to create a 100MB disk called C<test1.img> containing a "
16611 "single ext2-formatted partition:"
16615 #: ../fish/guestfish.pod:135
16618 " guestfish -N fs\n"
16623 #: ../fish/guestfish.pod:137
16624 msgid "To list what is available do:"
16628 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:837
16631 " guestfish -N help | less\n"
16636 #: ../fish/guestfish.pod:141
16637 msgid "Remote control"
16641 #: ../fish/guestfish.pod:143
16644 " eval \"`guestfish --listen`\"\n"
16645 " guestfish --remote add-ro disk.img\n"
16646 " guestfish --remote run\n"
16647 " guestfish --remote lvs\n"
16652 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
16653 #: ../fuse/guestmount.pod:73 ../inspector/virt-inspector.pl:68
16654 #: ../tools/virt-edit.pl:72 ../tools/virt-win-reg.pl:171
16655 #: ../tools/virt-df.pl:71 ../tools/virt-ls.pl:78 ../tools/virt-resize.pl:257
16656 #: ../tools/virt-list-filesystems.pl:50 ../tools/virt-tar.pl:98
16657 #: ../tools/virt-rescue.pl:103 ../tools/virt-make-fs.pl:153
16658 #: ../tools/virt-list-partitions.pl:51
16663 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
16664 #: ../inspector/virt-inspector.pl:76 ../tools/virt-edit.pl:80
16665 #: ../tools/virt-win-reg.pl:179 ../tools/virt-df.pl:79 ../tools/virt-ls.pl:86
16666 #: ../tools/virt-resize.pl:265 ../tools/virt-list-filesystems.pl:58
16667 #: ../tools/virt-tar.pl:106 ../tools/virt-rescue.pl:111
16668 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:59
16673 #: ../fish/guestfish.pod:154
16674 msgid "Displays general help on options."
16678 #: ../fish/guestfish.pod:156
16679 msgid "B<-h> | B<--cmd-help>"
16683 #: ../fish/guestfish.pod:158
16684 msgid "Lists all available guestfish commands."
16688 #: ../fish/guestfish.pod:160
16689 msgid "B<-h cmd> | B<--cmd-help cmd>"
16693 #: ../fish/guestfish.pod:162
16694 msgid "Displays detailed help on a single command C<cmd>."
16698 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
16699 msgid "B<-a image> | B<--add image>"
16703 #: ../fish/guestfish.pod:166
16704 msgid "Add a block device or virtual machine image to the shell."
16708 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
16710 "The format of the disk image is auto-detected. To override this and force a "
16711 "particular format use the I<--format=..> option."
16715 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
16716 msgid "B<-c URI> | B<--connect URI>"
16720 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
16722 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16723 "URI to use. The default is to use the default libvirt connection."
16727 #: ../fish/guestfish.pod:177
16732 #: ../fish/guestfish.pod:179
16734 "If using the I<--listen> option and a csh-like shell, use this option. See "
16735 "section L</REMOTE CONTROL AND CSH> below."
16739 #: ../fish/guestfish.pod:182 ../fuse/guestmount.pod:90
16740 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
16744 #: ../fish/guestfish.pod:184 ../fuse/guestmount.pod:92
16746 "Add disks from the named libvirt domain. If the I<--ro> option is also "
16747 "used, then any libvirt domain can be used. However in write mode, only "
16748 "libvirt domains which are shut down can be named here."
16752 #: ../fish/guestfish.pod:188
16753 msgid "B<-D> | B<--no-dest-paths>"
16757 #: ../fish/guestfish.pod:190
16759 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
16760 "to hit the tab key to complete paths on the guest filesystem, but this "
16761 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
16762 "allow this feature to be disabled."
16766 #: ../fish/guestfish.pod:195 ../fuse/guestmount.pod:108
16767 msgid "B<--echo-keys>"
16771 #: ../fish/guestfish.pod:197 ../fuse/guestmount.pod:110
16773 "When prompting for keys and passphrases, guestfish normally turns echoing "
16774 "off so you cannot see what you are typing. If you are not worried about "
16775 "Tempest attacks and there is no one else in the room you can specify this "
16776 "flag to see what you are typing."
16780 #: ../fish/guestfish.pod:202
16781 msgid "B<-f file> | B<--file file>"
16785 #: ../fish/guestfish.pod:204
16786 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
16790 #: ../fish/guestfish.pod:207
16793 " #!/usr/bin/guestfish -f\n"
16798 #: ../fish/guestfish.pod:209 ../fuse/guestmount.pod:115
16799 msgid "B<--format=raw|qcow2|..> | B<--format>"
16803 #: ../fish/guestfish.pod:211 ../fuse/guestmount.pod:117
16805 "The default for the I<-a> option is to auto-detect the format of the disk "
16806 "image. Using this forces the disk format for I<-a> options which follow on "
16807 "the command line. Using I<--format> with no argument switches back to auto-"
16808 "detection for subsequent I<-a> options."
16812 #: ../fish/guestfish.pod:216 ../fish/guestfish.pod:543
16813 #: ../inspector/virt-inspector.pl:515
16814 msgid "For example:"
16818 #: ../fish/guestfish.pod:218
16821 " guestfish --format=raw -a disk.img\n"
16826 #: ../fish/guestfish.pod:220
16827 msgid "forces raw format (no auto-detection) for C<disk.img>."
16831 #: ../fish/guestfish.pod:222
16834 " guestfish --format=raw -a disk.img --format -a another.img\n"
16839 #: ../fish/guestfish.pod:224
16841 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
16842 "detection for C<another.img>."
16846 #: ../fish/guestfish.pod:227
16848 "If you have untrusted raw-format guest disk images, you should use this "
16849 "option to specify the disk format. This avoids a possible security problem "
16850 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
16854 #: ../fish/guestfish.pod:232 ../fuse/guestmount.pod:135
16855 msgid "B<-i> | B<--inspector>"
16859 #: ../fish/guestfish.pod:234 ../fuse/guestmount.pod:137
16861 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
16862 "system and mount filesystems as they would be mounted on the real virtual "
16867 #: ../fish/guestfish.pod:238
16868 msgid "Typical usage is either:"
16872 #: ../fish/guestfish.pod:240
16875 " guestfish -d myguest -i\n"
16880 #: ../fish/guestfish.pod:242
16881 msgid "(for an inactive libvirt domain called I<myguest>), or:"
16885 #: ../fish/guestfish.pod:244
16888 " guestfish --ro -d myguest -i\n"
16893 #: ../fish/guestfish.pod:246
16894 msgid "(for active domains, readonly), or specify the block device directly:"
16898 #: ../fish/guestfish.pod:248
16901 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
16906 #: ../fish/guestfish.pod:250
16908 "Note that the command line syntax changed slightly over older versions of "
16909 "guestfish. You can still use the old syntax:"
16913 #: ../fish/guestfish.pod:253
16916 " guestfish [--ro] -i disk.img\n"
16921 #: ../fish/guestfish.pod:255
16924 " guestfish [--ro] -i libvirt-domain\n"
16929 #: ../fish/guestfish.pod:257 ../fuse/guestmount.pod:141
16930 msgid "B<--keys-from-stdin>"
16934 #: ../fish/guestfish.pod:259 ../fuse/guestmount.pod:143
16936 "Read key or passphrase parameters from stdin. The default is to try to read "
16937 "passphrases from the user by opening C</dev/tty>."
16941 #: ../fish/guestfish.pod:262
16942 msgid "B<--listen>"
16946 #: ../fish/guestfish.pod:264
16948 "Fork into the background and listen for remote commands. See section L</"
16949 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
16953 #: ../fish/guestfish.pod:267
16954 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
16958 #: ../fish/guestfish.pod:269
16959 msgid "Mount the named partition or logical volume on the given mountpoint."
16963 #: ../fish/guestfish.pod:271
16964 msgid "If the mountpoint is omitted, it defaults to C</>."
16968 #: ../fish/guestfish.pod:273
16969 msgid "You have to mount something on C</> before most commands will work."
16973 #: ../fish/guestfish.pod:275
16975 "If any I<-m> or I<--mount> options are given, the guest is automatically "
16980 #: ../fish/guestfish.pod:278
16982 "If you don't know what filesystems a disk image contains, you can either run "
16983 "guestfish without this option, then list the partitions and LVs available "
16984 "(see L</list-partitions> and L</lvs> commands), or you can use the L<virt-"
16985 "list-filesystems(1)> program."
16989 #: ../fish/guestfish.pod:283 ../fuse/guestmount.pod:154
16990 msgid "B<-n> | B<--no-sync>"
16994 #: ../fish/guestfish.pod:285
16996 "Disable autosync. This is enabled by default. See the discussion of "
16997 "autosync in the L<guestfs(3)> manpage."
17001 #: ../fish/guestfish.pod:288
17002 msgid "B<-N type> | B<--new type> | B<-N help>"
17006 #: ../fish/guestfish.pod:290
17008 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
17009 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
17010 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
17015 #: ../fish/guestfish.pod:295
17016 msgid "B<--progress-bars>"
17020 #: ../fish/guestfish.pod:297
17021 msgid "Enable progress bars, even when guestfish is used non-interactively."
17025 #: ../fish/guestfish.pod:299
17027 "Progress bars are enabled by default when guestfish is used as an "
17028 "interactive shell."
17032 #: ../fish/guestfish.pod:302
17033 msgid "B<--no-progress-bars>"
17037 #: ../fish/guestfish.pod:304
17038 msgid "Disable progress bars."
17042 #: ../fish/guestfish.pod:306
17043 msgid "B<--remote[=pid]>"
17047 #: ../fish/guestfish.pod:308
17049 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
17050 "CONTROL GUESTFISH OVER A SOCKET> below."
17054 #: ../fish/guestfish.pod:311 ../fuse/guestmount.pod:196
17055 msgid "B<-r> | B<--ro>"
17059 #: ../fish/guestfish.pod:313
17061 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
17062 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
17066 #: ../fish/guestfish.pod:316 ../tools/virt-rescue.pl:187
17068 "The option must always be used if the disk image or virtual machine might be "
17069 "running, and is generally recommended in cases where you don't need write "
17070 "access to the disk."
17074 #: ../fish/guestfish.pod:320
17076 "Note that prepared disk images created with I<-N> are not affected by the "
17081 #: ../fish/guestfish.pod:323
17082 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
17086 #: ../fish/guestfish.pod:325 ../fuse/guestmount.pod:208
17087 #: ../tools/virt-rescue.pl:195
17088 msgid "B<--selinux>"
17092 #: ../fish/guestfish.pod:327
17093 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
17097 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:212
17098 msgid "B<-v> | B<--verbose>"
17102 #: ../fish/guestfish.pod:331
17104 "Enable very verbose messages. This is particularly useful if you find a bug."
17108 #: ../fish/guestfish.pod:334 ../fuse/guestmount.pod:216
17109 msgid "B<-V> | B<--version>"
17113 #: ../fish/guestfish.pod:336
17114 msgid "Display the guestfish / libguestfs version number and exit."
17118 #: ../fish/guestfish.pod:338 ../fuse/guestmount.pod:220
17119 msgid "B<-w> | B<--rw>"
17123 #: ../fish/guestfish.pod:340
17125 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
17130 #: ../fish/guestfish.pod:343
17135 #: ../fish/guestfish.pod:345
17136 msgid "Echo each command before executing it."
17140 #: ../fish/guestfish.pod:349
17141 msgid "COMMANDS ON COMMAND LINE"
17145 #: ../fish/guestfish.pod:351
17147 "Any additional (non-option) arguments are treated as commands to execute."
17151 #: ../fish/guestfish.pod:354
17153 "Commands to execute should be separated by a colon (C<:>), where the colon "
17154 "is a separate parameter. Thus:"
17158 #: ../fish/guestfish.pod:357
17161 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
17166 #: ../fish/guestfish.pod:359
17168 "If there are no additional arguments, then we enter a shell, either an "
17169 "interactive shell with a prompt (if the input is a terminal) or a non-"
17170 "interactive shell."
17174 #: ../fish/guestfish.pod:363
17176 "In either command line mode or non-interactive shell, the first command that "
17177 "gives an error causes the whole shell to exit. In interactive mode (with a "
17178 "prompt) if a command fails, you can continue to enter commands."
17182 #: ../fish/guestfish.pod:368
17183 msgid "USING launch (OR run)"
17187 #: ../fish/guestfish.pod:370
17189 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
17190 "then launch it, then mount any disks you need, and finally issue actions/"
17191 "commands. So the general order of the day is:"
17195 #: ../fish/guestfish.pod:378
17196 msgid "add or -a/--add"
17200 #: ../fish/guestfish.pod:382
17201 msgid "launch (aka run)"
17205 #: ../fish/guestfish.pod:386
17206 msgid "mount or -m/--mount"
17210 #: ../fish/guestfish.pod:390
17211 msgid "any other commands"
17215 #: ../fish/guestfish.pod:394
17217 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
17218 "guest before mounting or performing any other commands."
17222 #: ../fish/guestfish.pod:397
17224 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
17225 "I<--new> options were given then C<run> is done automatically, simply "
17226 "because guestfish can't perform the action you asked for without doing this."
17230 #: ../fish/guestfish.pod:402
17231 msgid "OPENING DISKS FOR READ AND WRITE"
17235 #: ../fish/guestfish.pod:404
17237 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
17238 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
17239 "open disk images read-only or for writing."
17243 #: ../fish/guestfish.pod:408
17245 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
17246 "disk images supplied on the command line for write. To open a disk image "
17247 "read-only you have to do I<-a image --ro>."
17251 #: ../fish/guestfish.pod:412
17253 "This matters: If you accidentally open a live VM disk image writable then "
17254 "you will cause irreversible disk corruption."
17258 #: ../fish/guestfish.pod:415
17260 "By libguestfs 1.8 we intend to change the default the other way. Disk "
17261 "images will be opened read-only. You will have to either specify "
17262 "I<guestfish --rw> or change a configuration file in order to get write "
17263 "access for disk images specified by those other command line options."
17267 #: ../fish/guestfish.pod:420
17269 "This version of guestfish has a I<--rw> option which does nothing (it is "
17270 "already the default). However it is highly recommended that you use this "
17271 "option to indicate that guestfish needs write access, and to prepare your "
17272 "scripts for the day when this option will be required for write access."
17276 #: ../fish/guestfish.pod:426
17278 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
17279 "other libguestfs program apart from guestfish and guestmount."
17283 #: ../fish/guestfish.pod:429
17288 #: ../fish/guestfish.pod:431
17290 "You can quote ordinary parameters using either single or double quotes. For "
17295 #: ../fish/guestfish.pod:434
17298 " add \"file with a space.img\"\n"
17303 #: ../fish/guestfish.pod:436
17306 " rm '/file name'\n"
17311 #: ../fish/guestfish.pod:438
17319 #: ../fish/guestfish.pod:440
17321 "A few commands require a list of strings to be passed. For these, use a "
17322 "whitespace-separated list, enclosed in quotes. Strings containing "
17323 "whitespace to be passed through must be enclosed in single quotes. A "
17324 "literal single quote must be escaped with a backslash."
17328 #: ../fish/guestfish.pod:445
17331 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17332 " command \"/bin/echo 'foo bar'\"\n"
17333 " command \"/bin/echo \\'foo\\'\"\n"
17338 #: ../fish/guestfish.pod:449
17339 msgid "OPTIONAL ARGUMENTS"
17343 #: ../fish/guestfish.pod:451
17345 "Some commands take optional arguments. These arguments appear in this "
17346 "documentation as C<[argname:..]>. You can use them as in these examples:"
17350 #: ../fish/guestfish.pod:455
17353 " add-drive-opts filename\n"
17358 #: ../fish/guestfish.pod:457
17361 " add-drive-opts filename readonly:true\n"
17366 #: ../fish/guestfish.pod:459
17369 " add-drive-opts filename format:qcow2 readonly:false\n"
17374 #: ../fish/guestfish.pod:461
17376 "Each optional argument can appear at most once. All optional arguments must "
17377 "appear after the required ones."
17381 #: ../fish/guestfish.pod:464
17386 #: ../fish/guestfish.pod:466
17388 "This section applies to all commands which can take integers as parameters."
17392 #: ../fish/guestfish.pod:469
17393 msgid "SIZE SUFFIX"
17397 #: ../fish/guestfish.pod:471
17399 "When the command takes a parameter measured in bytes, you can use one of the "
17400 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17404 #: ../fish/guestfish.pod:477
17405 msgid "B<k> or B<K> or B<KiB>"
17409 #: ../fish/guestfish.pod:479
17410 msgid "The size in kilobytes (multiplied by 1024)."
17414 #: ../fish/guestfish.pod:481
17419 #: ../fish/guestfish.pod:483
17420 msgid "The size in SI 1000 byte units."
17424 #: ../fish/guestfish.pod:485
17425 msgid "B<M> or B<MiB>"
17429 #: ../fish/guestfish.pod:487
17430 msgid "The size in megabytes (multiplied by 1048576)."
17434 #: ../fish/guestfish.pod:489
17439 #: ../fish/guestfish.pod:491
17440 msgid "The size in SI 1000000 byte units."
17444 #: ../fish/guestfish.pod:493
17445 msgid "B<G> or B<GiB>"
17449 #: ../fish/guestfish.pod:495
17450 msgid "The size in gigabytes (multiplied by 2**30)."
17454 #: ../fish/guestfish.pod:497
17459 #: ../fish/guestfish.pod:499
17460 msgid "The size in SI 10**9 byte units."
17464 #: ../fish/guestfish.pod:501
17465 msgid "B<T> or B<TiB>"
17469 #: ../fish/guestfish.pod:503
17470 msgid "The size in terabytes (multiplied by 2**40)."
17474 #: ../fish/guestfish.pod:505
17479 #: ../fish/guestfish.pod:507
17480 msgid "The size in SI 10**12 byte units."
17484 #: ../fish/guestfish.pod:509
17485 msgid "B<P> or B<PiB>"
17489 #: ../fish/guestfish.pod:511
17490 msgid "The size in petabytes (multiplied by 2**50)."
17494 #: ../fish/guestfish.pod:513
17499 #: ../fish/guestfish.pod:515
17500 msgid "The size in SI 10**15 byte units."
17504 #: ../fish/guestfish.pod:517
17505 msgid "B<E> or B<EiB>"
17509 #: ../fish/guestfish.pod:519
17510 msgid "The size in exabytes (multiplied by 2**60)."
17514 #: ../fish/guestfish.pod:521
17519 #: ../fish/guestfish.pod:523
17520 msgid "The size in SI 10**18 byte units."
17524 #: ../fish/guestfish.pod:525
17525 msgid "B<Z> or B<ZiB>"
17529 #: ../fish/guestfish.pod:527
17530 msgid "The size in zettabytes (multiplied by 2**70)."
17534 #: ../fish/guestfish.pod:529
17539 #: ../fish/guestfish.pod:531
17540 msgid "The size in SI 10**21 byte units."
17544 #: ../fish/guestfish.pod:533
17545 msgid "B<Y> or B<YiB>"
17549 #: ../fish/guestfish.pod:535
17550 msgid "The size in yottabytes (multiplied by 2**80)."
17554 #: ../fish/guestfish.pod:537
17559 #: ../fish/guestfish.pod:539
17560 msgid "The size in SI 10**24 byte units."
17564 #: ../fish/guestfish.pod:545
17567 " truncate-size /file 1G\n"
17572 #: ../fish/guestfish.pod:547
17573 msgid "would truncate the file to 1 gigabyte."
17577 #: ../fish/guestfish.pod:549
17579 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
17580 "the parameter to L</memsize> is specified in megabytes already). Adding a "
17581 "suffix will probably not do what you expect."
17585 #: ../fish/guestfish.pod:553
17586 msgid "OCTAL AND HEXADECIMAL NUMBERS"
17590 #: ../fish/guestfish.pod:555
17592 "For specifying the radix (base) use the C convention: C<0> to prefix an "
17593 "octal number or C<0x> to prefix a hexadecimal number. For example:"
17597 #: ../fish/guestfish.pod:558
17600 " 1234 decimal number 1234\n"
17601 " 02322 octal number, equivalent to decimal 1234\n"
17602 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
17607 #: ../fish/guestfish.pod:562
17609 "When using the C<chmod> command, you almost always want to specify an octal "
17610 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
17611 "L<chmod(1)> program):"
17615 #: ../fish/guestfish.pod:566
17618 " chmod 0777 /public # OK\n"
17619 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
17624 #: ../fish/guestfish.pod:569
17626 "Commands that return numbers usually print them in decimal, but some "
17627 "commands print numbers in other radices (eg. C<umask> prints the mode in "
17628 "octal, preceeded by C<0>)."
17632 #: ../fish/guestfish.pod:573
17633 msgid "WILDCARDS AND GLOBBING"
17637 #: ../fish/guestfish.pod:575
17639 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
17640 "(globbing) by default. So for example the following will not do what you "
17645 #: ../fish/guestfish.pod:579
17653 #: ../fish/guestfish.pod:581
17655 "Assuming you don't have a directory called literally C</home/*> then the "
17656 "above command will return an error."
17660 #: ../fish/guestfish.pod:584
17661 msgid "To perform wildcard expansion, use the C<glob> command."
17665 #: ../fish/guestfish.pod:586
17668 " glob rm-rf /home/*\n"
17673 #: ../fish/guestfish.pod:588
17675 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
17676 "many times), equivalent to:"
17680 #: ../fish/guestfish.pod:591
17683 " rm-rf /home/jim\n"
17684 " rm-rf /home/joe\n"
17685 " rm-rf /home/mary\n"
17690 #: ../fish/guestfish.pod:595
17691 msgid "C<glob> only works on simple guest paths and not on device names."
17695 #: ../fish/guestfish.pod:597
17697 "If you have several parameters, each containing a wildcard, then glob will "
17698 "perform a Cartesian product."
17702 #: ../fish/guestfish.pod:600
17707 #: ../fish/guestfish.pod:602
17709 "Any line which starts with a I<#> character is treated as a comment and "
17710 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
17711 "a command. For example:"
17715 #: ../fish/guestfish.pod:606
17718 " # this is a comment\n"
17719 " # this is a comment\n"
17720 " foo # NOT a comment\n"
17725 #: ../fish/guestfish.pod:610
17726 msgid "Blank lines are also ignored."
17730 #: ../fish/guestfish.pod:612
17731 msgid "RUNNING COMMANDS LOCALLY"
17735 #: ../fish/guestfish.pod:614
17737 "Any line which starts with a I<!> character is treated as a command sent to "
17738 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
17742 #: ../fish/guestfish.pod:618
17746 " tgz-out /remote local/remote-data.tar.gz\n"
17751 #: ../fish/guestfish.pod:621
17753 "will create a directory C<local> on the host, and then export the contents "
17754 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17755 "(See C<tgz-out>)."
17759 #: ../fish/guestfish.pod:625
17761 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17762 "effect, due to the way that subprocesses work in Unix."
17766 #: ../fish/guestfish.pod:628
17771 #: ../fish/guestfish.pod:630
17773 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17774 "command (a guestfish command) to the second command (any host command). For "
17779 #: ../fish/guestfish.pod:634
17782 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17787 #: ../fish/guestfish.pod:636
17789 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17790 "program). The above command would list all accounts in the guest filesystem "
17791 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17795 #: ../fish/guestfish.pod:641
17798 " hexdump /bin/ls | head\n"
17799 " list-devices | tail -1\n"
17800 " tgz-out / - | tar ztf -\n"
17805 #: ../fish/guestfish.pod:645
17807 "The space before the pipe symbol is required, any space after the pipe "
17808 "symbol is optional. Everything after the pipe symbol is just passed "
17809 "straight to the host shell, so it can contain redirections, globs and "
17810 "anything else that makes sense on the host side."
17814 #: ../fish/guestfish.pod:650
17816 "To use a literal argument which begins with a pipe symbol, you have to quote "
17821 #: ../fish/guestfish.pod:653
17829 #: ../fish/guestfish.pod:655
17830 msgid "HOME DIRECTORIES"
17834 #: ../fish/guestfish.pod:657
17836 "If a parameter starts with the character C<~> then the tilde may be expanded "
17837 "as a home directory path (either C<~> for the current user's home directory, "
17838 "or C<~user> for another user)."
17842 #: ../fish/guestfish.pod:661
17844 "Note that home directory expansion happens for users known I<on the host>, "
17845 "not in the guest filesystem."
17849 #: ../fish/guestfish.pod:664
17851 "To use a literal argument which begins with a tilde, you have to quote it, "
17856 #: ../fish/guestfish.pod:667
17864 #: ../fish/guestfish.pod:671
17866 "Libguestfs has some support for Linux guests encrypted according to the "
17867 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17868 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
17869 "LUKS is supported."
17873 #: ../fish/guestfish.pod:676
17874 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17878 #: ../fish/guestfish.pod:678
17881 " ><fs> vfs-type /dev/sda2\n"
17887 #: ../fish/guestfish.pod:681
17889 "Then open those devices using L</luks-open>. This creates a device-mapper "
17890 "device called C</dev/mapper/luksdev>."
17894 #: ../fish/guestfish.pod:684
17897 " ><fs> luks-open /dev/sda2 luksdev\n"
17898 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17903 #: ../fish/guestfish.pod:687
17905 "Finally you have to tell LVM to scan for volume groups on the newly created "
17910 #: ../fish/guestfish.pod:690
17914 " vg-activate-all true\n"
17919 #: ../fish/guestfish.pod:693
17920 msgid "The logical volume(s) can now be mounted in the usual way."
17924 #: ../fish/guestfish.pod:695
17926 "Before closing a LUKS device you must unmount any logical volumes on it and "
17927 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17928 "one. Then you can close the mapper device:"
17932 #: ../fish/guestfish.pod:699
17935 " vg-activate false /dev/VG\n"
17936 " luks-close /dev/mapper/luksdev\n"
17941 #: ../fish/guestfish.pod:702
17942 msgid "WINDOWS PATHS"
17946 #: ../fish/guestfish.pod:704
17948 "If a path is prefixed with C<win:> then you can use Windows-style paths "
17949 "(with some limitations). The following commands are equivalent:"
17953 #: ../fish/guestfish.pod:707
17956 " file /WINDOWS/system32/config/system.LOG\n"
17961 #: ../fish/guestfish.pod:709
17964 " file win:/windows/system32/config/system.log\n"
17969 #: ../fish/guestfish.pod:711
17972 " file win:\\windows\\system32\\config\\system.log\n"
17977 #: ../fish/guestfish.pod:713
17980 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
17985 #: ../fish/guestfish.pod:715
17987 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
17988 "handles case insensitivity like Windows would. This only works in argument "
17989 "positions that expect a path."
17993 #: ../fish/guestfish.pod:719
17994 msgid "UPLOADING AND DOWNLOADING FILES"
17998 #: ../fish/guestfish.pod:721
18000 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
18001 "others which upload from or download to a local file, you can use the "
18002 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
18006 #: ../fish/guestfish.pod:725
18014 #: ../fish/guestfish.pod:727
18016 "reads stdin and creates from that a file C</foo> in the disk image, and:"
18020 #: ../fish/guestfish.pod:730
18023 " tar-out /etc - | tar tf -\n"
18028 #: ../fish/guestfish.pod:732
18030 "writes the tarball to stdout and then pipes that into the external \"tar\" "
18031 "command (see L</PIPES>)."
18035 #: ../fish/guestfish.pod:735
18037 "When using C<-> to read from stdin, the input is read up to the end of "
18038 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
18039 "some arbitrary end marker:"
18043 #: ../fish/guestfish.pod:739
18046 " upload -<<END /foo\n"
18055 #: ../fish/guestfish.pod:745
18057 "Any string of characters can be used instead of C<END>. The end marker must "
18058 "appear on a line of its own, without any preceeding or following characters "
18059 "(not even spaces)."
18063 #: ../fish/guestfish.pod:749
18065 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
18066 "upload local files (so-called \"FileIn\" parameters in the generator)."
18070 #: ../fish/guestfish.pod:752
18071 msgid "EXIT ON ERROR BEHAVIOUR"
18075 #: ../fish/guestfish.pod:754
18077 "By default, guestfish will ignore any errors when in interactive mode (ie. "
18078 "taking commands from a human over a tty), and will exit on the first error "
18079 "in non-interactive mode (scripts, commands given on the command line)."
18083 #: ../fish/guestfish.pod:759
18085 "If you prefix a command with a I<-> character, then that command will not "
18086 "cause guestfish to exit, even if that (one) command returns an error."
18090 #: ../fish/guestfish.pod:763
18091 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
18095 #: ../fish/guestfish.pod:765
18097 "Guestfish can be remote-controlled over a socket. This is useful "
18098 "particularly in shell scripts where you want to make several different "
18099 "changes to a filesystem, but you don't want the overhead of starting up a "
18100 "guestfish process each time."
18104 #: ../fish/guestfish.pod:770
18105 msgid "Start a guestfish server process using:"
18109 #: ../fish/guestfish.pod:772
18112 " eval \"`guestfish --listen`\"\n"
18117 #: ../fish/guestfish.pod:774
18118 msgid "and then send it commands by doing:"
18122 #: ../fish/guestfish.pod:776
18125 " guestfish --remote cmd [...]\n"
18130 #: ../fish/guestfish.pod:778
18131 msgid "To cause the server to exit, send it the exit command:"
18135 #: ../fish/guestfish.pod:780
18138 " guestfish --remote exit\n"
18143 #: ../fish/guestfish.pod:782
18145 "Note that the server will normally exit if there is an error in a command. "
18146 "You can change this in the usual way. See section L</EXIT ON ERROR "
18151 #: ../fish/guestfish.pod:786
18152 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18156 #: ../fish/guestfish.pod:788
18158 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18159 "is how the I<--remote> option knows where to send the commands. You can "
18160 "have several guestfish listener processes running using:"
18164 #: ../fish/guestfish.pod:792
18167 " eval \"`guestfish --listen`\"\n"
18168 " pid1=$GUESTFISH_PID\n"
18169 " eval \"`guestfish --listen`\"\n"
18170 " pid2=$GUESTFISH_PID\n"
18172 " guestfish --remote=$pid1 cmd\n"
18173 " guestfish --remote=$pid2 cmd\n"
18178 #: ../fish/guestfish.pod:800
18179 msgid "REMOTE CONTROL AND CSH"
18183 #: ../fish/guestfish.pod:802
18185 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18190 #: ../fish/guestfish.pod:805
18193 " eval \"`guestfish --listen --csh`\"\n"
18198 #: ../fish/guestfish.pod:807
18199 msgid "REMOTE CONTROL DETAILS"
18203 #: ../fish/guestfish.pod:809
18205 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
18206 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
18207 "and C<$PID> is the process ID of the server."
18211 #: ../fish/guestfish.pod:813
18212 msgid "Guestfish client and server versions must match exactly."
18216 #: ../fish/guestfish.pod:815
18217 msgid "PREPARED DISK IMAGES"
18221 #: ../fish/guestfish.pod:817
18223 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18224 "preformatted disk images that guestfish can make for you to save typing. "
18225 "This is particularly useful for testing purposes. This option is used "
18226 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18227 "can be mixed with I<-a>)."
18231 #: ../fish/guestfish.pod:823
18233 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18234 "the second and so on. Existing files in the current directory are "
18239 #: ../fish/guestfish.pod:827
18241 "The type briefly describes how the disk should be sized, partitioned, how "
18242 "filesystem(s) should be created, and how content should be added. "
18243 "Optionally the type can be followed by extra parameters, separated by C<:> "
18244 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
18245 "allocated disk, containing a single partition, with the partition formatted "
18246 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
18251 #: ../fish/guestfish.pod:835
18252 msgid "To list the available types and any extra parameters they take, run:"
18256 #: ../fish/guestfish.pod:839
18258 "Note that the prepared filesystem is not mounted. You would usually have to "
18259 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18263 #: ../fish/guestfish.pod:843
18265 "If any I<-N> or I<--new> options are given, the guest is automatically "
18270 #: ../fish/guestfish.pod:848
18271 msgid "Create a 100MB disk with an ext4-formatted partition:"
18275 #: ../fish/guestfish.pod:850
18278 " guestfish -N fs:ext4\n"
18283 #: ../fish/guestfish.pod:852
18284 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18288 #: ../fish/guestfish.pod:854
18291 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18296 #: ../fish/guestfish.pod:856
18297 msgid "Create a blank 200MB disk:"
18301 #: ../fish/guestfish.pod:858
18304 " guestfish -N disk:200M\n"
18309 #: ../fish/guestfish.pod:860
18310 msgid "PROGRESS BARS"
18314 #: ../fish/guestfish.pod:862
18316 "Some (not all) long-running commands send progress notification messages as "
18317 "they are running. Guestfish turns these messages into progress bars."
18321 #: ../fish/guestfish.pod:866
18323 "When a command that supports progress bars takes longer than two seconds to "
18324 "run, and if progress bars are enabled, then you will see one appearing below "
18329 #: ../fish/guestfish.pod:870
18332 " ><fs> copy-size /large-file /another-file 2048M\n"
18333 " / 10% [#####-----------------------------------------] 00:30\n"
18338 #: ../fish/guestfish.pod:873
18340 "The spinner on the left hand side moves round once for every progress "
18341 "notification received from the backend. This is a (reasonably) golden "
18342 "assurance that the command is \"doing something\" even if the progress bar "
18343 "is not moving, because the command is able to send the progress "
18344 "notifications. When the bar reaches 100% and the command finishes, the "
18345 "spinner disappears."
18349 #: ../fish/guestfish.pod:880
18351 "Progress bars are enabled by default when guestfish is used interactively. "
18352 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18353 "and you can disable them completely using I<--no-progress-bars>."
18357 #: ../fish/guestfish.pod:885
18358 msgid "GUESTFISH COMMANDS"
18362 #: ../fish/guestfish.pod:887
18364 "The commands in this section are guestfish convenience commands, in other "
18365 "words, they are not part of the L<guestfs(3)> API."
18369 #: ../fish/guestfish.pod:890
18374 #: ../fish/guestfish.pod:892
18383 #: ../fish/guestfish.pod:895
18384 msgid "Without any parameter, this provides general help."
18388 #: ../fish/guestfish.pod:897
18389 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18393 #: ../fish/guestfish.pod:899
18394 msgid "quit | exit"
18398 #: ../fish/guestfish.pod:901
18399 msgid "This exits guestfish. You can also use C<^D> key."
18403 #: ../fish/guestfish.pod:903
18404 msgid "@FISH_COMMANDS@"
18408 #: ../fish/guestfish.pod:905
18413 #: ../fish/guestfish.pod:909 ../test-tool/libguestfs-test-tool.pod:83
18418 #: ../fish/guestfish.pod:911
18420 "guestfish returns 0 if the commands completed without error, or 1 if there "
18425 #: ../fish/guestfish.pod:918
18430 #: ../fish/guestfish.pod:920
18432 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
18437 #: ../fish/guestfish.pod:923
18438 msgid "GUESTFISH_PID"
18442 #: ../fish/guestfish.pod:925
18444 "Used with the I<--remote> option to specify the remote guestfish process to "
18445 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
18449 #: ../fish/guestfish.pod:929
18454 #: ../fish/guestfish.pod:931
18456 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
18457 "not specified, the external L<hexedit(1)> program is used."
18461 #: ../fish/guestfish.pod:935
18466 #: ../fish/guestfish.pod:937
18468 "If compiled with GNU readline support, various files in the home directory "
18469 "can be used. See L</FILES>."
18473 #: ../fish/guestfish.pod:946
18475 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
18476 "effect as using the B<-v> option."
18480 #: ../fish/guestfish.pod:958
18482 "Set the path that guestfish uses to search for kernel and initrd.img. See "
18483 "the discussion of paths in L<guestfs(3)>."
18487 #: ../fish/guestfish.pod:969
18488 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
18492 #: ../fish/guestfish.pod:971
18497 #: ../fish/guestfish.pod:973
18499 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
18504 #: ../fish/guestfish.pod:988 ../test-tool/libguestfs-test-tool.pod:88
18509 #: ../fish/guestfish.pod:992
18510 msgid "$HOME/.guestfish"
18514 #: ../fish/guestfish.pod:994
18516 "If compiled with GNU readline support, then the command history is saved in "
18521 #: ../fish/guestfish.pod:997
18522 msgid "$HOME/.inputrc"
18526 #: ../fish/guestfish.pod:999
18527 msgid "/etc/inputrc"
18531 #: ../fish/guestfish.pod:1001
18533 "If compiled with GNU readline support, then these files can be used to "
18534 "configure readline. For further information, please see L<readline(3)/"
18535 "INITIALIZATION FILE>."
18539 #: ../fish/guestfish.pod:1005
18540 msgid "To write rules which only apply to guestfish, use:"
18544 #: ../fish/guestfish.pod:1007
18554 #: ../fish/guestfish.pod:1011
18556 "Variables that you can set in inputrc that change the behaviour of guestfish "
18557 "in useful ways include:"
18561 #: ../fish/guestfish.pod:1016
18562 msgid "completion-ignore-case (default: on)"
18566 #: ../fish/guestfish.pod:1018
18568 "By default, guestfish will ignore case when tab-completing paths on the "
18573 #: ../fish/guestfish.pod:1021
18576 " set completion-ignore-case off\n"
18581 #: ../fish/guestfish.pod:1023
18582 msgid "to make guestfish case sensitive."
18586 #: ../fish/guestfish.pod:1027
18591 #: ../fish/guestfish.pod:1029
18592 msgid "test2.img (etc)"
18596 #: ../fish/guestfish.pod:1031
18598 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
18599 "will be created in the file C<test1.img> in the current directory. The "
18600 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
18601 "the same name will be overwritten."
18605 #: ../fish/guestfish.pod:1040
18607 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
18608 "L<virt-edit(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, "
18609 "L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, "
18610 "L<virt-tar(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
18614 #: ../fish/guestfish.pod:1064 ../test-tool/libguestfs-test-tool.pod:124
18615 #: ../fuse/guestmount.pod:253 ../inspector/virt-inspector.pl:564
18616 #: ../tools/virt-edit.pl:370 ../tools/virt-win-reg.pl:518
18617 #: ../tools/virt-df.pl:657 ../tools/virt-ls.pl:251
18618 #: ../tools/virt-resize.pl:1516 ../tools/virt-list-filesystems.pl:206
18619 #: ../tools/virt-tar.pl:300 ../tools/virt-rescue.pl:285
18620 #: ../tools/virt-make-fs.pl:567 ../tools/virt-list-partitions.pl:273
18622 "This program is free software; you can redistribute it and/or modify it "
18623 "under the terms of the GNU General Public License as published by the Free "
18624 "Software Foundation; either version 2 of the License, or (at your option) "
18625 "any later version."
18629 #: ../fish/guestfish.pod:1069 ../test-tool/libguestfs-test-tool.pod:129
18630 #: ../fuse/guestmount.pod:258 ../inspector/virt-inspector.pl:569
18631 #: ../tools/virt-edit.pl:375 ../tools/virt-win-reg.pl:523
18632 #: ../tools/virt-df.pl:662 ../tools/virt-ls.pl:256
18633 #: ../tools/virt-resize.pl:1521 ../tools/virt-list-filesystems.pl:211
18634 #: ../tools/virt-tar.pl:305 ../tools/virt-rescue.pl:290
18635 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:278
18637 "This program is distributed in the hope that it will be useful, but WITHOUT "
18638 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
18639 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
18644 #: ../fish/guestfish.pod:1074 ../test-tool/libguestfs-test-tool.pod:134
18645 #: ../fuse/guestmount.pod:263 ../inspector/virt-inspector.pl:574
18646 #: ../tools/virt-edit.pl:380 ../tools/virt-win-reg.pl:528
18647 #: ../tools/virt-df.pl:667 ../tools/virt-ls.pl:261
18648 #: ../tools/virt-resize.pl:1526 ../tools/virt-list-filesystems.pl:216
18649 #: ../tools/virt-tar.pl:310 ../tools/virt-rescue.pl:295
18650 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:283
18652 "You should have received a copy of the GNU General Public License along with "
18653 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
18654 "Ave, Cambridge, MA 02139, USA."
18658 #: ../fish/guestfish-actions.pod:1
18663 #: ../fish/guestfish-actions.pod:3
18666 " add-cdrom filename\n"
18671 #: ../fish/guestfish-actions.pod:15
18673 "This call checks for the existence of C<filename>. This stops you from "
18674 "specifying other types of drive which are supported by qemu such as C<nbd:> "
18675 "and C<http:> URLs. To specify those, use the general L</config> call "
18680 #: ../fish/guestfish-actions.pod:22
18682 "If you just want to add an ISO file (often you use this as an efficient way "
18683 "to transfer large files into the guest), then you should probably use L</add-"
18684 "drive-ro> instead."
18688 #: ../fish/guestfish-actions.pod:35
18693 #: ../fish/guestfish-actions.pod:37
18698 #: ../fish/guestfish-actions.pod:39
18701 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
18706 #: ../fish/guestfish-actions.pod:41
18708 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
18709 "It works by connecting to libvirt, requesting the domain and domain XML from "
18710 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
18714 #: ../fish/guestfish-actions.pod:58
18716 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
18717 "libvirt.org/uri.html>). If this is not set then we connect to the default "
18718 "libvirt URI (or one set through an environment variable, see the libvirt "
18719 "documentation for full details). If you are using the C API directly then "
18720 "it is more flexible to create the libvirt connection object yourself, get "
18721 "the domain object, and call L</add-libvirt-dom>."
18725 #: ../fish/guestfish-actions.pod:66
18727 "The other optional parameters are passed directly through to L</add-drive-"
18732 #: ../fish/guestfish-actions.pod:69 ../fish/guestfish-actions.pod:133
18734 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
18738 #: ../fish/guestfish-actions.pod:71
18743 #: ../fish/guestfish-actions.pod:73
18746 " add-drive filename\n"
18751 #: ../fish/guestfish-actions.pod:75
18753 "This function is the equivalent of calling L</add-drive-opts> with no "
18754 "optional parameters, so the disk is added writable, with the format being "
18755 "detected automatically."
18759 #: ../fish/guestfish-actions.pod:79
18761 "Automatic detection of the format opens you up to a potential security hole "
18762 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
18763 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
18764 "you should think about replacing calls to this function with calls to L</add-"
18765 "drive-opts>, and specifying the format."
18769 #: ../fish/guestfish-actions.pod:86
18770 msgid "add-drive-opts"
18774 #: ../fish/guestfish-actions.pod:88
18779 #: ../fish/guestfish-actions.pod:90
18782 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
18787 #: ../fish/guestfish-actions.pod:117
18789 "This forces the image format. If you omit this (or use L</add-drive> or L</"
18790 "add-drive-ro>) then the format is automatically detected. Possible formats "
18791 "include C<raw> and C<qcow2>."
18795 #: ../fish/guestfish-actions.pod:128
18797 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
18798 "add-drive-with-if> call (q.v.)"
18802 #: ../fish/guestfish-actions.pod:135
18803 msgid "add-drive-ro"
18807 #: ../fish/guestfish-actions.pod:137
18812 #: ../fish/guestfish-actions.pod:139
18815 " add-drive-ro filename\n"
18820 #: ../fish/guestfish-actions.pod:141
18822 "This function is the equivalent of calling L</add-drive-opts> with the "
18823 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
18824 "is added read-only, with the format being detected automatically."
18828 #: ../fish/guestfish-actions.pod:146
18829 msgid "add-drive-ro-with-if"
18833 #: ../fish/guestfish-actions.pod:148
18836 " add-drive-ro-with-if filename iface\n"
18841 #: ../fish/guestfish-actions.pod:150
18843 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
18844 "interface emulation to use at run time."
18848 #: ../fish/guestfish-actions.pod:160
18849 msgid "add-drive-with-if"
18853 #: ../fish/guestfish-actions.pod:162
18856 " add-drive-with-if filename iface\n"
18861 #: ../fish/guestfish-actions.pod:164
18863 "This is the same as L</add-drive> but it allows you to specify the QEMU "
18864 "interface emulation to use at run time."
18868 #: ../fish/guestfish-actions.pod:174
18873 #: ../fish/guestfish-actions.pod:176
18876 " aug-clear augpath\n"
18881 #: ../fish/guestfish-actions.pod:181
18886 #: ../fish/guestfish-actions.pod:183
18894 #: ../fish/guestfish-actions.pod:185
18896 "Close the current Augeas handle and free up any resources used by it. After "
18897 "calling this, you have to call L</aug-init> again before you can use any "
18898 "other Augeas functions."
18902 #: ../fish/guestfish-actions.pod:190
18903 msgid "aug-defnode"
18907 #: ../fish/guestfish-actions.pod:192
18910 " aug-defnode name expr val\n"
18915 #: ../fish/guestfish-actions.pod:197
18917 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
18918 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
18919 "containing that single node."
18923 #: ../fish/guestfish-actions.pod:205
18928 #: ../fish/guestfish-actions.pod:207
18931 " aug-defvar name expr\n"
18936 #: ../fish/guestfish-actions.pod:216
18941 #: ../fish/guestfish-actions.pod:218
18944 " aug-get augpath\n"
18949 #: ../fish/guestfish-actions.pod:223
18954 #: ../fish/guestfish-actions.pod:225
18957 " aug-init root flags\n"
18962 #: ../fish/guestfish-actions.pod:231
18963 msgid "You must call this before using any other L</aug-*> commands."
18967 #: ../fish/guestfish-actions.pod:266
18968 msgid "Do not load the tree in L</aug-init>."
18972 #: ../fish/guestfish-actions.pod:270
18973 msgid "To close the handle, you can call L</aug-close>."
18977 #: ../fish/guestfish-actions.pod:274
18982 #: ../fish/guestfish-actions.pod:276
18985 " aug-insert augpath label true|false\n"
18990 #: ../fish/guestfish-actions.pod:286
18995 #: ../fish/guestfish-actions.pod:288
19003 #: ../fish/guestfish-actions.pod:295
19008 #: ../fish/guestfish-actions.pod:297
19011 " aug-ls augpath\n"
19016 #: ../fish/guestfish-actions.pod:299
19018 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
19019 "resulting nodes into alphabetical order."
19023 #: ../fish/guestfish-actions.pod:302
19028 #: ../fish/guestfish-actions.pod:304
19031 " aug-match augpath\n"
19036 #: ../fish/guestfish-actions.pod:310
19041 #: ../fish/guestfish-actions.pod:312
19044 " aug-mv src dest\n"
19049 #: ../fish/guestfish-actions.pod:317
19054 #: ../fish/guestfish-actions.pod:319
19057 " aug-rm augpath\n"
19062 #: ../fish/guestfish-actions.pod:325
19067 #: ../fish/guestfish-actions.pod:327
19075 #: ../fish/guestfish-actions.pod:331
19077 "The flags which were passed to L</aug-init> affect exactly how files are "
19082 #: ../fish/guestfish-actions.pod:334
19087 #: ../fish/guestfish-actions.pod:336
19090 " aug-set augpath val\n"
19095 #: ../fish/guestfish-actions.pod:340
19097 "In the Augeas API, it is possible to clear a node by setting the value to "
19098 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
19099 "this call. Instead you must use the L</aug-clear> call."
19103 #: ../fish/guestfish-actions.pod:345
19108 #: ../fish/guestfish-actions.pod:347
19111 " available 'groups ...'\n"
19116 #: ../fish/guestfish-actions.pod:353
19118 "The libguestfs groups, and the functions that those groups correspond to, "
19119 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
19120 "runtime by calling L</available-all-groups>."
19124 #: ../fish/guestfish-actions.pod:377
19125 msgid "You must call L</launch> before calling this function."
19129 #: ../fish/guestfish-actions.pod:399
19131 "This call was added in version C<1.0.80>. In previous versions of "
19132 "libguestfs all you could do would be to speculatively execute a command to "
19133 "find out if the daemon implemented it. See also L</version>."
19137 #: ../fish/guestfish-actions.pod:406
19138 msgid "available-all-groups"
19142 #: ../fish/guestfish-actions.pod:408
19145 " available-all-groups\n"
19150 #: ../fish/guestfish-actions.pod:410
19152 "This command returns a list of all optional groups that this daemon knows "
19153 "about. Note this returns both supported and unsupported groups. To find "
19154 "out which ones the daemon can actually support you have to call L</"
19155 "available> on each member of the returned list."
19159 #: ../fish/guestfish-actions.pod:416
19160 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
19164 #: ../fish/guestfish-actions.pod:418
19169 #: ../fish/guestfish-actions.pod:420
19172 " base64-in (base64file|-) filename\n"
19177 #: ../fish/guestfish-actions.pod:425 ../fish/guestfish-actions.pod:434
19178 #: ../fish/guestfish-actions.pod:658 ../fish/guestfish-actions.pod:827
19179 #: ../fish/guestfish-actions.pod:846 ../fish/guestfish-actions.pod:1223
19180 #: ../fish/guestfish-actions.pod:4002 ../fish/guestfish-actions.pod:4014
19181 #: ../fish/guestfish-actions.pod:4025 ../fish/guestfish-actions.pod:4036
19182 #: ../fish/guestfish-actions.pod:4088 ../fish/guestfish-actions.pod:4097
19183 #: ../fish/guestfish-actions.pod:4151 ../fish/guestfish-actions.pod:4174
19184 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
19188 #: ../fish/guestfish-actions.pod:427
19193 #: ../fish/guestfish-actions.pod:429
19196 " base64-out filename (base64file|-)\n"
19201 #: ../fish/guestfish-actions.pod:436
19202 msgid "blockdev-flushbufs"
19206 #: ../fish/guestfish-actions.pod:438
19209 " blockdev-flushbufs device\n"
19214 #: ../fish/guestfish-actions.pod:445
19215 msgid "blockdev-getbsz"
19219 #: ../fish/guestfish-actions.pod:447
19222 " blockdev-getbsz device\n"
19227 #: ../fish/guestfish-actions.pod:456
19228 msgid "blockdev-getro"
19232 #: ../fish/guestfish-actions.pod:458
19235 " blockdev-getro device\n"
19240 #: ../fish/guestfish-actions.pod:465
19241 msgid "blockdev-getsize64"
19245 #: ../fish/guestfish-actions.pod:467
19248 " blockdev-getsize64 device\n"
19253 #: ../fish/guestfish-actions.pod:471
19254 msgid "See also L</blockdev-getsz>."
19258 #: ../fish/guestfish-actions.pod:475
19259 msgid "blockdev-getss"
19263 #: ../fish/guestfish-actions.pod:477
19266 " blockdev-getss device\n"
19271 #: ../fish/guestfish-actions.pod:482
19273 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
19277 #: ../fish/guestfish-actions.pod:487
19278 msgid "blockdev-getsz"
19282 #: ../fish/guestfish-actions.pod:489
19285 " blockdev-getsz device\n"
19290 #: ../fish/guestfish-actions.pod:494
19292 "See also L</blockdev-getss> for the real sector size of the device, and L</"
19293 "blockdev-getsize64> for the more useful I<size in bytes>."
19297 #: ../fish/guestfish-actions.pod:500
19298 msgid "blockdev-rereadpt"
19302 #: ../fish/guestfish-actions.pod:502
19305 " blockdev-rereadpt device\n"
19310 #: ../fish/guestfish-actions.pod:508
19311 msgid "blockdev-setbsz"
19315 #: ../fish/guestfish-actions.pod:510
19318 " blockdev-setbsz device blocksize\n"
19323 #: ../fish/guestfish-actions.pod:519
19324 msgid "blockdev-setro"
19328 #: ../fish/guestfish-actions.pod:521
19331 " blockdev-setro device\n"
19336 #: ../fish/guestfish-actions.pod:527
19337 msgid "blockdev-setrw"
19341 #: ../fish/guestfish-actions.pod:529
19344 " blockdev-setrw device\n"
19349 #: ../fish/guestfish-actions.pod:535
19350 msgid "case-sensitive-path"
19354 #: ../fish/guestfish-actions.pod:537
19357 " case-sensitive-path path\n"
19362 #: ../fish/guestfish-actions.pod:561
19364 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
19365 "WINDOWS/system32\"> (the exact return value would depend on details of how "
19366 "the directories were originally created under Windows)."
19370 #: ../fish/guestfish-actions.pod:569
19371 msgid "See also L</realpath>."
19375 #: ../fish/guestfish-actions.pod:571
19380 #: ../fish/guestfish-actions.pod:573
19388 #: ../fish/guestfish-actions.pod:577
19390 "Note that this function cannot correctly handle binary files (specifically, "
19391 "files containing C<\\0> character which is treated as end of string). For "
19392 "those you need to use the L</read-file> or L</download> functions which have "
19393 "a more complex interface."
19397 #: ../fish/guestfish-actions.pod:585
19402 #: ../fish/guestfish-actions.pod:587
19405 " checksum csumtype path\n"
19410 #: ../fish/guestfish-actions.pod:630
19411 msgid "To get the checksum for a device, use L</checksum-device>."
19415 #: ../fish/guestfish-actions.pod:632
19416 msgid "To get the checksums for many files, use L</checksums-out>."
19420 #: ../fish/guestfish-actions.pod:634
19421 msgid "checksum-device"
19425 #: ../fish/guestfish-actions.pod:636
19428 " checksum-device csumtype device\n"
19433 #: ../fish/guestfish-actions.pod:638
19435 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
19436 "device named C<device>. For the types of checksums supported see the L</"
19437 "checksum> command."
19441 #: ../fish/guestfish-actions.pod:642
19442 msgid "checksums-out"
19446 #: ../fish/guestfish-actions.pod:644
19449 " checksums-out csumtype directory (sumsfile|-)\n"
19454 #: ../fish/guestfish-actions.pod:660
19459 #: ../fish/guestfish-actions.pod:662
19462 " chmod mode path\n"
19467 #: ../fish/guestfish-actions.pod:673
19472 #: ../fish/guestfish-actions.pod:675
19475 " chown owner group path\n"
19480 #: ../fish/guestfish-actions.pod:683
19485 #: ../fish/guestfish-actions.pod:685
19488 " command 'arguments ...'\n"
19493 #: ../fish/guestfish-actions.pod:692
19495 "The single parameter is an argv-style list of arguments. The first element "
19496 "is the name of the program to run. Subsequent elements are parameters. The "
19497 "list must be non-empty (ie. must contain a program name). Note that the "
19498 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
19502 #: ../fish/guestfish-actions.pod:720
19503 msgid "command-lines"
19507 #: ../fish/guestfish-actions.pod:722
19510 " command-lines 'arguments ...'\n"
19515 #: ../fish/guestfish-actions.pod:724
19517 "This is the same as L</command>, but splits the result into a list of lines."
19521 #: ../fish/guestfish-actions.pod:727
19522 msgid "See also: L</sh-lines>"
19526 #: ../fish/guestfish-actions.pod:732
19531 #: ../fish/guestfish-actions.pod:734
19534 " config qemuparam qemuvalue\n"
19539 #: ../fish/guestfish-actions.pod:745
19544 #: ../fish/guestfish-actions.pod:747
19547 " copy-size src dest size\n"
19552 #: ../fish/guestfish-actions.pod:755
19557 #: ../fish/guestfish-actions.pod:757
19565 #: ../fish/guestfish-actions.pod:762
19570 #: ../fish/guestfish-actions.pod:764
19578 #: ../fish/guestfish-actions.pod:769
19583 #: ../fish/guestfish-actions.pod:771
19591 #: ../fish/guestfish-actions.pod:778
19593 "If the destination is a device, it must be as large or larger than the "
19594 "source file or device, otherwise the copy will fail. This command cannot do "
19595 "partial copies (see L</copy-size>)."
19599 #: ../fish/guestfish-actions.pod:782
19604 #: ../fish/guestfish-actions.pod:784
19612 #: ../fish/guestfish-actions.pod:792
19617 #: ../fish/guestfish-actions.pod:794
19625 #: ../fish/guestfish-actions.pod:803
19630 #: ../fish/guestfish-actions.pod:805
19638 #: ../fish/guestfish-actions.pod:811
19640 "Another way to get the same information is to enable verbose messages with "
19641 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
19642 "before running the program."
19646 #: ../fish/guestfish-actions.pod:816
19651 #: ../fish/guestfish-actions.pod:818
19654 " download remotefilename (filename|-)\n"
19659 #: ../fish/guestfish-actions.pod:825
19660 msgid "See also L</upload>, L</cat>."
19664 #: ../fish/guestfish-actions.pod:829
19665 msgid "download-offset"
19669 #: ../fish/guestfish-actions.pod:831
19672 " download-offset remotefilename (filename|-) offset size\n"
19677 #: ../fish/guestfish-actions.pod:839
19679 "Note that there is no limit on the amount of data that can be downloaded "
19680 "with this call, unlike with L</pread>, and this call always reads the full "
19681 "amount unless an error occurs."
19685 #: ../fish/guestfish-actions.pod:844
19686 msgid "See also L</download>, L</pread>."
19690 #: ../fish/guestfish-actions.pod:848
19691 msgid "drop-caches"
19695 #: ../fish/guestfish-actions.pod:850
19698 " drop-caches whattodrop\n"
19703 #: ../fish/guestfish-actions.pod:862
19708 #: ../fish/guestfish-actions.pod:864
19716 #: ../fish/guestfish-actions.pod:876
19721 #: ../fish/guestfish-actions.pod:878
19724 " e2fsck-f device\n"
19729 #: ../fish/guestfish-actions.pod:884
19731 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
19732 "should use L</fsck>."
19736 #: ../fish/guestfish-actions.pod:887
19737 msgid "echo-daemon"
19741 #: ../fish/guestfish-actions.pod:889
19744 " echo-daemon 'words ...'\n"
19749 #: ../fish/guestfish-actions.pod:896
19750 msgid "See also L</ping-daemon>."
19754 #: ../fish/guestfish-actions.pod:898
19759 #: ../fish/guestfish-actions.pod:900
19762 " egrep regex path\n"
19767 #: ../fish/guestfish-actions.pod:908
19772 #: ../fish/guestfish-actions.pod:910
19775 " egrepi regex path\n"
19780 #: ../fish/guestfish-actions.pod:918
19785 #: ../fish/guestfish-actions.pod:920
19788 " equal file1 file2\n"
19793 #: ../fish/guestfish-actions.pod:927
19798 #: ../fish/guestfish-actions.pod:929
19806 #: ../fish/guestfish-actions.pod:934
19807 msgid "See also L</is-file>, L</is-dir>, L</stat>."
19811 #: ../fish/guestfish-actions.pod:936
19816 #: ../fish/guestfish-actions.pod:938
19819 " fallocate path len\n"
19824 #: ../fish/guestfish-actions.pod:955
19825 msgid "fallocate64"
19829 #: ../fish/guestfish-actions.pod:957
19832 " fallocate64 path len\n"
19837 #: ../fish/guestfish-actions.pod:963
19839 "Note that this call allocates disk blocks for the file. To create a sparse "
19840 "file use L</truncate-size> instead."
19844 #: ../fish/guestfish-actions.pod:966
19846 "The deprecated call L</fallocate> does the same, but owing to an oversight "
19847 "it only allowed 30 bit lengths to be specified, effectively limiting the "
19848 "maximum size of files created through that call to 1GB."
19852 #: ../fish/guestfish-actions.pod:975
19857 #: ../fish/guestfish-actions.pod:977
19860 " fgrep pattern path\n"
19865 #: ../fish/guestfish-actions.pod:985
19870 #: ../fish/guestfish-actions.pod:987
19873 " fgrepi pattern path\n"
19878 #: ../fish/guestfish-actions.pod:995
19883 #: ../fish/guestfish-actions.pod:997
19891 #: ../fish/guestfish-actions.pod:1009
19893 "This command can also be used on C</dev/> devices (and partitions, LV "
19894 "names). You can for example use this to determine if a device contains a "
19895 "filesystem, although it's usually better to use L</vfs-type>."
19899 #: ../fish/guestfish-actions.pod:1019
19900 msgid "file-architecture"
19904 #: ../fish/guestfish-actions.pod:1021
19907 " file-architecture filename\n"
19912 #: ../fish/guestfish-actions.pod:1124
19917 #: ../fish/guestfish-actions.pod:1126
19925 #: ../fish/guestfish-actions.pod:1130
19927 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
19928 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
19932 #: ../fish/guestfish-actions.pod:1134
19937 #: ../fish/guestfish-actions.pod:1136
19940 " fill c len path\n"
19945 #: ../fish/guestfish-actions.pod:1142
19947 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
19948 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
19949 "L</fill-pattern>."
19953 #: ../fish/guestfish-actions.pod:1147
19954 msgid "fill-pattern"
19958 #: ../fish/guestfish-actions.pod:1149
19961 " fill-pattern pattern len path\n"
19966 #: ../fish/guestfish-actions.pod:1151
19968 "This function is like L</fill> except that it creates a new file of length "
19969 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
19970 "is truncated if necessary to ensure the length of the file is exactly C<len> "
19975 #: ../fish/guestfish-actions.pod:1156
19980 #: ../fish/guestfish-actions.pod:1158
19983 " find directory\n"
19988 #: ../fish/guestfish-actions.pod:1172
19989 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
19993 #: ../fish/guestfish-actions.pod:1185
19994 msgid "See also L</find0>."
19998 #: ../fish/guestfish-actions.pod:1190
20003 #: ../fish/guestfish-actions.pod:1192
20006 " find0 directory (files|-)\n"
20011 #: ../fish/guestfish-actions.pod:1198
20013 "This command works the same way as L</find> with the following exceptions:"
20017 #: ../fish/guestfish-actions.pod:1225
20018 msgid "findfs-label"
20022 #: ../fish/guestfish-actions.pod:1227
20025 " findfs-label label\n"
20030 #: ../fish/guestfish-actions.pod:1233
20031 msgid "To find the label of a filesystem, use L</vfs-label>."
20035 #: ../fish/guestfish-actions.pod:1235
20036 msgid "findfs-uuid"
20040 #: ../fish/guestfish-actions.pod:1237
20043 " findfs-uuid uuid\n"
20048 #: ../fish/guestfish-actions.pod:1243
20049 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
20053 #: ../fish/guestfish-actions.pod:1245
20058 #: ../fish/guestfish-actions.pod:1247
20061 " fsck fstype device\n"
20066 #: ../fish/guestfish-actions.pod:1277
20071 #: ../fish/guestfish-actions.pod:1279
20079 #: ../fish/guestfish-actions.pod:1286
20080 msgid "get-autosync"
20084 #: ../fish/guestfish-actions.pod:1288
20092 #: ../fish/guestfish-actions.pod:1292
20097 #: ../fish/guestfish-actions.pod:1294
20105 #: ../fish/guestfish-actions.pod:1298
20106 msgid "get-e2label"
20110 #: ../fish/guestfish-actions.pod:1300
20113 " get-e2label device\n"
20118 #: ../fish/guestfish-actions.pod:1312
20123 #: ../fish/guestfish-actions.pod:1314
20126 " get-e2uuid device\n"
20131 #: ../fish/guestfish-actions.pod:1326
20132 msgid "get-memsize"
20136 #: ../fish/guestfish-actions.pod:1328
20144 #: ../fish/guestfish-actions.pod:1333
20146 "If L</set-memsize> was not called on this handle, and if "
20147 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
20148 "value for memsize."
20152 #: ../fish/guestfish-actions.pod:1340
20153 msgid "get-network"
20157 #: ../fish/guestfish-actions.pod:1342
20165 #: ../fish/guestfish-actions.pod:1346
20170 #: ../fish/guestfish-actions.pod:1348
20178 #: ../fish/guestfish-actions.pod:1355
20183 #: ../fish/guestfish-actions.pod:1357
20188 #: ../fish/guestfish-actions.pod:1359
20196 #: ../fish/guestfish-actions.pod:1366
20201 #: ../fish/guestfish-actions.pod:1368
20209 #: ../fish/guestfish-actions.pod:1375
20210 msgid "get-recovery-proc"
20214 #: ../fish/guestfish-actions.pod:1377
20217 " get-recovery-proc\n"
20222 #: ../fish/guestfish-actions.pod:1381
20223 msgid "get-selinux"
20227 #: ../fish/guestfish-actions.pod:1383
20235 #: ../fish/guestfish-actions.pod:1385
20237 "This returns the current setting of the selinux flag which is passed to the "
20238 "appliance at boot time. See L</set-selinux>."
20242 #: ../fish/guestfish-actions.pod:1391
20247 #: ../fish/guestfish-actions.pod:1393
20255 #: ../fish/guestfish-actions.pod:1400
20260 #: ../fish/guestfish-actions.pod:1402
20268 #: ../fish/guestfish-actions.pod:1406
20273 #: ../fish/guestfish-actions.pod:1408
20281 #: ../fish/guestfish-actions.pod:1410
20283 "Return the current umask. By default the umask is C<022> unless it has been "
20284 "set by calling L</umask>."
20288 #: ../fish/guestfish-actions.pod:1413
20289 msgid "get-verbose"
20293 #: ../fish/guestfish-actions.pod:1415
20301 #: ../fish/guestfish-actions.pod:1419
20306 #: ../fish/guestfish-actions.pod:1421
20314 #: ../fish/guestfish-actions.pod:1425
20315 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
20319 #: ../fish/guestfish-actions.pod:1428
20324 #: ../fish/guestfish-actions.pod:1430
20327 " getxattrs path\n"
20332 #: ../fish/guestfish-actions.pod:1438
20333 msgid "See also: L</lgetxattrs>, L<attr(5)>."
20337 #: ../fish/guestfish-actions.pod:1440
20338 msgid "glob-expand"
20342 #: ../fish/guestfish-actions.pod:1442
20345 " glob-expand pattern\n"
20350 #: ../fish/guestfish-actions.pod:1455
20355 #: ../fish/guestfish-actions.pod:1457
20358 " grep regex path\n"
20363 #: ../fish/guestfish-actions.pod:1465
20368 #: ../fish/guestfish-actions.pod:1467
20371 " grepi regex path\n"
20376 #: ../fish/guestfish-actions.pod:1475
20377 msgid "grub-install"
20381 #: ../fish/guestfish-actions.pod:1477
20384 " grub-install root device\n"
20389 #: ../fish/guestfish-actions.pod:1493
20394 #: ../fish/guestfish-actions.pod:1495
20402 #: ../fish/guestfish-actions.pod:1503
20407 #: ../fish/guestfish-actions.pod:1505
20410 " head-n nrlines path\n"
20415 #: ../fish/guestfish-actions.pod:1518
20420 #: ../fish/guestfish-actions.pod:1520
20428 #: ../fish/guestfish-actions.pod:1528
20433 #: ../fish/guestfish-actions.pod:1530
20436 " initrd-cat initrdpath filename\n"
20441 #: ../fish/guestfish-actions.pod:1542
20442 msgid "See also L</initrd-list>."
20446 #: ../fish/guestfish-actions.pod:1547
20447 msgid "initrd-list"
20451 #: ../fish/guestfish-actions.pod:1549
20454 " initrd-list path\n"
20459 #: ../fish/guestfish-actions.pod:1561
20460 msgid "inotify-add-watch"
20464 #: ../fish/guestfish-actions.pod:1563
20467 " inotify-add-watch path mask\n"
20472 #: ../fish/guestfish-actions.pod:1575
20473 msgid "inotify-close"
20477 #: ../fish/guestfish-actions.pod:1577
20485 #: ../fish/guestfish-actions.pod:1583
20486 msgid "inotify-files"
20490 #: ../fish/guestfish-actions.pod:1585
20498 #: ../fish/guestfish-actions.pod:1587
20500 "This function is a helpful wrapper around L</inotify-read> which just "
20501 "returns a list of pathnames of objects that were touched. The returned "
20502 "pathnames are sorted and deduplicated."
20506 #: ../fish/guestfish-actions.pod:1591
20507 msgid "inotify-init"
20511 #: ../fish/guestfish-actions.pod:1593
20514 " inotify-init maxevents\n"
20519 #: ../fish/guestfish-actions.pod:1599
20521 "C<maxevents> is the maximum number of events which will be queued up between "
20522 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
20523 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
20524 "default was 16384 events. Beyond this limit, the kernel throws away events, "
20525 "but records the fact that it threw them away by setting a flag "
20526 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
20530 #: ../fish/guestfish-actions.pod:1609
20532 "Before any events are generated, you have to add some watches to the "
20533 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
20534 "L</inotify-watch-all>."
20538 #: ../fish/guestfish-actions.pod:1615
20540 "Queued up events should be read periodically by calling L</inotify-read> (or "
20541 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
20542 "If you don't read the events out often enough then you risk the internal "
20543 "queue overflowing."
20547 #: ../fish/guestfish-actions.pod:1622
20549 "The handle should be closed after use by calling L</inotify-close>. This "
20550 "also removes any watches automatically."
20554 #: ../fish/guestfish-actions.pod:1631
20555 msgid "inotify-read"
20559 #: ../fish/guestfish-actions.pod:1633
20567 #: ../fish/guestfish-actions.pod:1646
20568 msgid "inotify-rm-watch"
20572 #: ../fish/guestfish-actions.pod:1648
20575 " inotify-rm-watch wd\n"
20580 #: ../fish/guestfish-actions.pod:1650
20581 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
20585 #: ../fish/guestfish-actions.pod:1653
20586 msgid "inspect-get-arch"
20590 #: ../fish/guestfish-actions.pod:1655
20593 " inspect-get-arch root\n"
20598 #: ../fish/guestfish-actions.pod:1657 ../fish/guestfish-actions.pod:1673
20599 #: ../fish/guestfish-actions.pod:1739 ../fish/guestfish-actions.pod:1757
20600 #: ../fish/guestfish-actions.pod:1778 ../fish/guestfish-actions.pod:1793
20601 #: ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1838
20602 #: ../fish/guestfish-actions.pod:1862 ../fish/guestfish-actions.pod:1892
20603 #: ../fish/guestfish-actions.pod:1923
20605 "This function should only be called with a root device string as returned by "
20610 #: ../fish/guestfish-actions.pod:1660
20612 "This returns the architecture of the inspected operating system. The "
20613 "possible return values are listed under L</file-architecture>."
20617 #: ../fish/guestfish-actions.pod:1669
20618 msgid "inspect-get-distro"
20622 #: ../fish/guestfish-actions.pod:1671
20625 " inspect-get-distro root\n"
20630 #: ../fish/guestfish-actions.pod:1735
20631 msgid "inspect-get-filesystems"
20635 #: ../fish/guestfish-actions.pod:1737
20638 " inspect-get-filesystems root\n"
20643 #: ../fish/guestfish-actions.pod:1750
20645 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
20646 "get-mountpoints>."
20650 #: ../fish/guestfish-actions.pod:1753
20651 msgid "inspect-get-major-version"
20655 #: ../fish/guestfish-actions.pod:1755
20658 " inspect-get-major-version root\n"
20663 #: ../fish/guestfish-actions.pod:1774
20664 msgid "inspect-get-minor-version"
20668 #: ../fish/guestfish-actions.pod:1776
20671 " inspect-get-minor-version root\n"
20676 #: ../fish/guestfish-actions.pod:1786
20678 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
20679 "get-major-version>."
20683 #: ../fish/guestfish-actions.pod:1789
20684 msgid "inspect-get-mountpoints"
20688 #: ../fish/guestfish-actions.pod:1791
20691 " inspect-get-mountpoints root\n"
20696 #: ../fish/guestfish-actions.pod:1809
20698 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
20699 "get-filesystems>."
20703 #: ../fish/guestfish-actions.pod:1812
20704 msgid "inspect-get-package-format"
20708 #: ../fish/guestfish-actions.pod:1814
20711 " inspect-get-package-format root\n"
20716 #: ../fish/guestfish-actions.pod:1819
20718 "This function and L</inspect-get-package-management> return the package "
20719 "format and package management tool used by the inspected operating system. "
20720 "For example for Fedora these functions would return C<rpm> (package format) "
20721 "and C<yum> (package management)."
20725 #: ../fish/guestfish-actions.pod:1834
20726 msgid "inspect-get-package-management"
20730 #: ../fish/guestfish-actions.pod:1836
20733 " inspect-get-package-management root\n"
20738 #: ../fish/guestfish-actions.pod:1841
20740 "L</inspect-get-package-format> and this function return the package format "
20741 "and package management tool used by the inspected operating system. For "
20742 "example for Fedora these functions would return C<rpm> (package format) and "
20743 "C<yum> (package management)."
20747 #: ../fish/guestfish-actions.pod:1858
20748 msgid "inspect-get-product-name"
20752 #: ../fish/guestfish-actions.pod:1860
20755 " inspect-get-product-name root\n"
20760 #: ../fish/guestfish-actions.pod:1875
20761 msgid "inspect-get-roots"
20765 #: ../fish/guestfish-actions.pod:1877
20768 " inspect-get-roots\n"
20773 #: ../fish/guestfish-actions.pod:1879
20775 "This function is a convenient way to get the list of root devices, as "
20776 "returned from a previous call to L</inspect-os>, but without redoing the "
20777 "whole inspection process."
20781 #: ../fish/guestfish-actions.pod:1883
20783 "This returns an empty list if either no root devices were found or the "
20784 "caller has not called L</inspect-os>."
20788 #: ../fish/guestfish-actions.pod:1888
20789 msgid "inspect-get-type"
20793 #: ../fish/guestfish-actions.pod:1890
20796 " inspect-get-type root\n"
20801 #: ../fish/guestfish-actions.pod:1919
20802 msgid "inspect-get-windows-systemroot"
20806 #: ../fish/guestfish-actions.pod:1921
20809 " inspect-get-windows-systemroot root\n"
20814 #: ../fish/guestfish-actions.pod:1935
20819 #: ../fish/guestfish-actions.pod:1937
20827 #: ../fish/guestfish-actions.pod:1952
20829 "You can pass the root string(s) returned to other L</inspect-get-*> "
20830 "functions in order to query further information about each operating system, "
20831 "such as the name and version."
20835 #: ../fish/guestfish-actions.pod:1957
20837 "This function uses other libguestfs features such as L</mount-ro> and L</"
20838 "umount-all> in order to mount and unmount filesystems and look at the "
20839 "contents. This should be called with no disks currently mounted. The "
20840 "function may also use Augeas, so any existing Augeas handle will be closed."
20844 #: ../fish/guestfish-actions.pod:1969 ../fish/guestfish-actions.pod:2125
20845 #: ../fish/guestfish-actions.pod:2171
20846 msgid "See also L</list-filesystems>."
20850 #: ../fish/guestfish-actions.pod:1971
20851 msgid "is-blockdev"
20855 #: ../fish/guestfish-actions.pod:1973
20858 " is-blockdev path\n"
20863 #: ../fish/guestfish-actions.pod:1978 ../fish/guestfish-actions.pod:1996
20864 #: ../fish/guestfish-actions.pod:2015 ../fish/guestfish-actions.pod:2024
20865 #: ../fish/guestfish-actions.pod:2034 ../fish/guestfish-actions.pod:2068
20866 #: ../fish/guestfish-actions.pod:2077
20867 msgid "See also L</stat>."
20871 #: ../fish/guestfish-actions.pod:1980
20876 #: ../fish/guestfish-actions.pod:1982
20884 #: ../fish/guestfish-actions.pod:1989
20889 #: ../fish/guestfish-actions.pod:1991
20892 " is-chardev path\n"
20897 #: ../fish/guestfish-actions.pod:1998
20902 #: ../fish/guestfish-actions.pod:2000
20910 #: ../fish/guestfish-actions.pod:2007
20915 #: ../fish/guestfish-actions.pod:2009
20923 #: ../fish/guestfish-actions.pod:2017
20928 #: ../fish/guestfish-actions.pod:2019
20936 #: ../fish/guestfish-actions.pod:2026
20941 #: ../fish/guestfish-actions.pod:2028
20949 #: ../fish/guestfish-actions.pod:2036
20950 msgid "is-launching"
20954 #: ../fish/guestfish-actions.pod:2038
20962 #: ../fish/guestfish-actions.pod:2045
20967 #: ../fish/guestfish-actions.pod:2047
20975 #: ../fish/guestfish-actions.pod:2052
20980 #: ../fish/guestfish-actions.pod:2054
20988 #: ../fish/guestfish-actions.pod:2061
20993 #: ../fish/guestfish-actions.pod:2063
20996 " is-socket path\n"
21001 #: ../fish/guestfish-actions.pod:2070
21006 #: ../fish/guestfish-actions.pod:2072
21009 " is-symlink path\n"
21014 #: ../fish/guestfish-actions.pod:2079
21015 msgid "kill-subprocess"
21019 #: ../fish/guestfish-actions.pod:2081
21022 " kill-subprocess\n"
21027 #: ../fish/guestfish-actions.pod:2085
21032 #: ../fish/guestfish-actions.pod:2087
21037 #: ../fish/guestfish-actions.pod:2089
21045 #: ../fish/guestfish-actions.pod:2097
21050 #: ../fish/guestfish-actions.pod:2099
21053 " lchown owner group path\n"
21058 #: ../fish/guestfish-actions.pod:2101
21060 "Change the file owner to C<owner> and group to C<group>. This is like L</"
21061 "chown> but if C<path> is a symlink then the link itself is changed, not the "
21066 #: ../fish/guestfish-actions.pod:2109
21071 #: ../fish/guestfish-actions.pod:2111
21074 " lgetxattrs path\n"
21079 #: ../fish/guestfish-actions.pod:2113
21081 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
21082 "it returns the extended attributes of the link itself."
21086 #: ../fish/guestfish-actions.pod:2117
21087 msgid "list-devices"
21091 #: ../fish/guestfish-actions.pod:2119
21099 #: ../fish/guestfish-actions.pod:2127
21100 msgid "list-filesystems"
21104 #: ../fish/guestfish-actions.pod:2129
21107 " list-filesystems\n"
21112 #: ../fish/guestfish-actions.pod:2148
21114 "This command runs other libguestfs commands, which might include L</mount> "
21115 "and L</umount>, and therefore you should use this soon after launch and only "
21116 "when nothing is mounted."
21120 #: ../fish/guestfish-actions.pod:2152
21122 "Not all of the filesystems returned will be mountable. In particular, swap "
21123 "partitions are returned in the list. Also this command does not check that "
21124 "each filesystem found is valid and mountable, and some filesystems might be "
21125 "mountable but require special options. Filesystems may not all belong to a "
21126 "single logical operating system (use L</inspect-os> to look for OSes)."
21130 #: ../fish/guestfish-actions.pod:2160
21131 msgid "list-partitions"
21135 #: ../fish/guestfish-actions.pod:2162
21138 " list-partitions\n"
21143 #: ../fish/guestfish-actions.pod:2168
21145 "This does not return logical volumes. For that you will need to call L</"
21150 #: ../fish/guestfish-actions.pod:2173
21155 #: ../fish/guestfish-actions.pod:2175
21163 #: ../fish/guestfish-actions.pod:2183
21168 #: ../fish/guestfish-actions.pod:2185
21171 " ln target linkname\n"
21176 #: ../fish/guestfish-actions.pod:2189
21181 #: ../fish/guestfish-actions.pod:2191
21184 " ln-f target linkname\n"
21189 #: ../fish/guestfish-actions.pod:2196
21194 #: ../fish/guestfish-actions.pod:2198
21197 " ln-s target linkname\n"
21202 #: ../fish/guestfish-actions.pod:2202
21207 #: ../fish/guestfish-actions.pod:2204
21210 " ln-sf target linkname\n"
21215 #: ../fish/guestfish-actions.pod:2209
21216 msgid "lremovexattr"
21220 #: ../fish/guestfish-actions.pod:2211
21223 " lremovexattr xattr path\n"
21228 #: ../fish/guestfish-actions.pod:2213
21230 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
21231 "it removes an extended attribute of the link itself."
21235 #: ../fish/guestfish-actions.pod:2217
21240 #: ../fish/guestfish-actions.pod:2219
21248 #: ../fish/guestfish-actions.pod:2225
21250 "This command is mostly useful for interactive sessions. Programs should "
21251 "probably use L</readdir> instead."
21255 #: ../fish/guestfish-actions.pod:2228
21260 #: ../fish/guestfish-actions.pod:2230
21263 " lsetxattr xattr val vallen path\n"
21268 #: ../fish/guestfish-actions.pod:2232
21270 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
21271 "sets an extended attribute of the link itself."
21275 #: ../fish/guestfish-actions.pod:2236
21280 #: ../fish/guestfish-actions.pod:2238
21288 #: ../fish/guestfish-actions.pod:2242
21290 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
21291 "the link is stat-ed, not the file it refers to."
21295 #: ../fish/guestfish-actions.pod:2248
21300 #: ../fish/guestfish-actions.pod:2250
21303 " lstatlist path 'names ...'\n"
21308 #: ../fish/guestfish-actions.pod:2252
21310 "This call allows you to perform the L</lstat> operation on multiple files, "
21311 "where all files are in the directory C<path>. C<names> is the list of files "
21312 "from this directory."
21316 #: ../fish/guestfish-actions.pod:2261
21318 "This call is intended for programs that want to efficiently list a directory "
21319 "contents without making many round-trips. See also L</lxattrlist> for a "
21320 "similarly efficient call for getting extended attributes. Very long "
21321 "directory listings might cause the protocol message size to be exceeded, "
21322 "causing this call to fail. The caller must split up such requests into "
21323 "smaller groups of names."
21327 #: ../fish/guestfish-actions.pod:2269
21328 msgid "luks-add-key"
21332 #: ../fish/guestfish-actions.pod:2271
21335 " luks-add-key device keyslot\n"
21340 #: ../fish/guestfish-actions.pod:2278
21342 "Note that if C<keyslot> already contains a key, then this command will "
21343 "fail. You have to use L</luks-kill-slot> first to remove that key."
21347 #: ../fish/guestfish-actions.pod:2282 ../fish/guestfish-actions.pod:2304
21348 #: ../fish/guestfish-actions.pod:2317 ../fish/guestfish-actions.pod:2331
21349 #: ../fish/guestfish-actions.pod:2354 ../fish/guestfish-actions.pod:2364
21351 "This command has one or more key or passphrase parameters. Guestfish will "
21352 "prompt for these separately."
21356 #: ../fish/guestfish-actions.pod:2285
21361 #: ../fish/guestfish-actions.pod:2287
21364 " luks-close device\n"
21369 #: ../fish/guestfish-actions.pod:2289
21371 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
21372 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
21373 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
21378 #: ../fish/guestfish-actions.pod:2295
21379 msgid "luks-format"
21383 #: ../fish/guestfish-actions.pod:2297
21386 " luks-format device keyslot\n"
21391 #: ../fish/guestfish-actions.pod:2310
21392 msgid "luks-format-cipher"
21396 #: ../fish/guestfish-actions.pod:2312
21399 " luks-format-cipher device keyslot cipher\n"
21404 #: ../fish/guestfish-actions.pod:2314
21406 "This command is the same as L</luks-format> but it also allows you to set "
21407 "the C<cipher> used."
21411 #: ../fish/guestfish-actions.pod:2323
21412 msgid "luks-kill-slot"
21416 #: ../fish/guestfish-actions.pod:2325
21419 " luks-kill-slot device keyslot\n"
21424 #: ../fish/guestfish-actions.pod:2334
21429 #: ../fish/guestfish-actions.pod:2336
21432 " luks-open device mapname\n"
21437 #: ../fish/guestfish-actions.pod:2350
21439 "If this block device contains LVM volume groups, then calling L</vgscan> "
21440 "followed by L</vg-activate-all> will make them visible."
21444 #: ../fish/guestfish-actions.pod:2357
21445 msgid "luks-open-ro"
21449 #: ../fish/guestfish-actions.pod:2359
21452 " luks-open-ro device mapname\n"
21457 #: ../fish/guestfish-actions.pod:2361
21459 "This is the same as L</luks-open> except that a read-only mapping is created."
21463 #: ../fish/guestfish-actions.pod:2367
21468 #: ../fish/guestfish-actions.pod:2369
21471 " lvcreate logvol volgroup mbytes\n"
21476 #: ../fish/guestfish-actions.pod:2374
21477 msgid "lvm-canonical-lv-name"
21481 #: ../fish/guestfish-actions.pod:2376
21484 " lvm-canonical-lv-name lvname\n"
21489 #: ../fish/guestfish-actions.pod:2385
21490 msgid "See also L</is-lv>."
21494 #: ../fish/guestfish-actions.pod:2387
21495 msgid "lvm-clear-filter"
21499 #: ../fish/guestfish-actions.pod:2389
21502 " lvm-clear-filter\n"
21507 #: ../fish/guestfish-actions.pod:2391
21509 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
21514 #: ../fish/guestfish-actions.pod:2397
21515 msgid "lvm-remove-all"
21519 #: ../fish/guestfish-actions.pod:2399
21522 " lvm-remove-all\n"
21527 #: ../fish/guestfish-actions.pod:2407
21528 msgid "lvm-set-filter"
21532 #: ../fish/guestfish-actions.pod:2409
21535 " lvm-set-filter 'devices ...'\n"
21540 #: ../fish/guestfish-actions.pod:2434
21545 #: ../fish/guestfish-actions.pod:2436
21548 " lvremove device\n"
21553 #: ../fish/guestfish-actions.pod:2444
21558 #: ../fish/guestfish-actions.pod:2446
21561 " lvrename logvol newlogvol\n"
21566 #: ../fish/guestfish-actions.pod:2450
21571 #: ../fish/guestfish-actions.pod:2452
21574 " lvresize device mbytes\n"
21579 #: ../fish/guestfish-actions.pod:2458
21580 msgid "lvresize-free"
21584 #: ../fish/guestfish-actions.pod:2460
21587 " lvresize-free lv percent\n"
21592 #: ../fish/guestfish-actions.pod:2468
21597 #: ../fish/guestfish-actions.pod:2470
21605 #: ../fish/guestfish-actions.pod:2478
21606 msgid "See also L</lvs-full>, L</list-filesystems>."
21610 #: ../fish/guestfish-actions.pod:2480
21615 #: ../fish/guestfish-actions.pod:2482
21623 #: ../fish/guestfish-actions.pod:2487
21628 #: ../fish/guestfish-actions.pod:2489
21636 #: ../fish/guestfish-actions.pod:2493
21641 #: ../fish/guestfish-actions.pod:2495
21644 " lxattrlist path 'names ...'\n"
21649 #: ../fish/guestfish-actions.pod:2511
21651 "This call is intended for programs that want to efficiently list a directory "
21652 "contents without making many round-trips. See also L</lstatlist> for a "
21653 "similarly efficient call for getting standard stats. Very long directory "
21654 "listings might cause the protocol message size to be exceeded, causing this "
21655 "call to fail. The caller must split up such requests into smaller groups of "
21660 #: ../fish/guestfish-actions.pod:2519
21665 #: ../fish/guestfish-actions.pod:2521
21673 #: ../fish/guestfish-actions.pod:2525
21678 #: ../fish/guestfish-actions.pod:2527
21681 " mkdir-mode path mode\n"
21686 #: ../fish/guestfish-actions.pod:2536
21687 msgid "See also L</mkdir>, L</umask>"
21691 #: ../fish/guestfish-actions.pod:2538
21696 #: ../fish/guestfish-actions.pod:2540
21704 #: ../fish/guestfish-actions.pod:2545
21709 #: ../fish/guestfish-actions.pod:2547
21712 " mkdtemp template\n"
21717 #: ../fish/guestfish-actions.pod:2568
21722 #: ../fish/guestfish-actions.pod:2570
21725 " mke2fs-J fstype blocksize device journal\n"
21730 #: ../fish/guestfish-actions.pod:2578
21731 msgid "See also L</mke2journal>."
21735 #: ../fish/guestfish-actions.pod:2580
21740 #: ../fish/guestfish-actions.pod:2582
21743 " mke2fs-JL fstype blocksize device label\n"
21748 #: ../fish/guestfish-actions.pod:2587
21749 msgid "See also L</mke2journal-L>."
21753 #: ../fish/guestfish-actions.pod:2589
21758 #: ../fish/guestfish-actions.pod:2591
21761 " mke2fs-JU fstype blocksize device uuid\n"
21766 #: ../fish/guestfish-actions.pod:2596
21767 msgid "See also L</mke2journal-U>."
21771 #: ../fish/guestfish-actions.pod:2598
21772 msgid "mke2journal"
21776 #: ../fish/guestfish-actions.pod:2600
21779 " mke2journal blocksize device\n"
21784 #: ../fish/guestfish-actions.pod:2607
21785 msgid "mke2journal-L"
21789 #: ../fish/guestfish-actions.pod:2609
21792 " mke2journal-L blocksize label device\n"
21797 #: ../fish/guestfish-actions.pod:2613
21798 msgid "mke2journal-U"
21802 #: ../fish/guestfish-actions.pod:2615
21805 " mke2journal-U blocksize uuid device\n"
21810 #: ../fish/guestfish-actions.pod:2619
21815 #: ../fish/guestfish-actions.pod:2621
21818 " mkfifo mode path\n"
21823 #: ../fish/guestfish-actions.pod:2623
21825 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
21826 "is just a convenient wrapper around L</mknod>."
21830 #: ../fish/guestfish-actions.pod:2629
21835 #: ../fish/guestfish-actions.pod:2631
21838 " mkfs fstype device\n"
21843 #: ../fish/guestfish-actions.pod:2637
21848 #: ../fish/guestfish-actions.pod:2639
21851 " mkfs-b fstype blocksize device\n"
21856 #: ../fish/guestfish-actions.pod:2641
21858 "This call is similar to L</mkfs>, but it allows you to control the block "
21859 "size of the resulting filesystem. Supported block sizes depend on the "
21860 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
21864 #: ../fish/guestfish-actions.pod:2649
21865 msgid "mkmountpoint"
21869 #: ../fish/guestfish-actions.pod:2651
21872 " mkmountpoint exemptpath\n"
21877 #: ../fish/guestfish-actions.pod:2653
21879 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
21880 "to create extra mountpoints before mounting the first filesystem."
21884 #: ../fish/guestfish-actions.pod:2677
21886 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
21887 "unexpected errors if you try to mix these calls. It is safest to manually "
21888 "unmount filesystems and remove mountpoints after use."
21892 #: ../fish/guestfish-actions.pod:2681
21894 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
21895 "for this to work for manual mountpoints, you must ensure that the innermost "
21896 "mountpoints have the longest pathnames, as in the example code above."
21900 #: ../fish/guestfish-actions.pod:2688
21902 "Autosync [see L</set-autosync>, this is set by default on handles] means "
21903 "that L</umount-all> is called when the handle is closed which can also "
21904 "trigger these issues."
21908 #: ../fish/guestfish-actions.pod:2692
21913 #: ../fish/guestfish-actions.pod:2694
21916 " mknod mode devmajor devminor path\n"
21921 #: ../fish/guestfish-actions.pod:2704
21923 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
21924 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
21925 "regular file). These constants are available in the standard Linux header "
21926 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
21927 "wrappers around this command which bitwise OR in the appropriate constant "
21932 #: ../fish/guestfish-actions.pod:2714
21937 #: ../fish/guestfish-actions.pod:2716
21940 " mknod-b mode devmajor devminor path\n"
21945 #: ../fish/guestfish-actions.pod:2718
21947 "This call creates a block device node called C<path> with mode C<mode> and "
21948 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
21949 "wrapper around L</mknod>."
21953 #: ../fish/guestfish-actions.pod:2724
21958 #: ../fish/guestfish-actions.pod:2726
21961 " mknod-c mode devmajor devminor path\n"
21966 #: ../fish/guestfish-actions.pod:2728
21968 "This call creates a char device node called C<path> with mode C<mode> and "
21969 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
21970 "wrapper around L</mknod>."
21974 #: ../fish/guestfish-actions.pod:2734
21979 #: ../fish/guestfish-actions.pod:2736
21987 #: ../fish/guestfish-actions.pod:2740
21992 #: ../fish/guestfish-actions.pod:2742
21995 " mkswap-L label device\n"
22000 #: ../fish/guestfish-actions.pod:2750
22005 #: ../fish/guestfish-actions.pod:2752
22008 " mkswap-U uuid device\n"
22013 #: ../fish/guestfish-actions.pod:2756
22014 msgid "mkswap-file"
22018 #: ../fish/guestfish-actions.pod:2758
22021 " mkswap-file path\n"
22026 #: ../fish/guestfish-actions.pod:2762
22028 "This command just writes a swap file signature to an existing file. To "
22029 "create the file itself, use something like L</fallocate>."
22033 #: ../fish/guestfish-actions.pod:2765
22038 #: ../fish/guestfish-actions.pod:2767
22041 " modprobe modulename\n"
22046 #: ../fish/guestfish-actions.pod:2774
22051 #: ../fish/guestfish-actions.pod:2776
22054 " mount device mountpoint\n"
22059 #: ../fish/guestfish-actions.pod:2792
22061 "B<Important note:> When you use this call, the filesystem options C<sync> "
22062 "and C<noatime> are set implicitly. This was originally done because we "
22063 "thought it would improve reliability, but it turns out that I<-o sync> has a "
22064 "very large negative performance impact and negligible effect on "
22065 "reliability. Therefore we recommend that you avoid using L</mount> in any "
22066 "code that needs performance, and instead use L</mount-options> (use an empty "
22067 "string for the first parameter if you don't want any options)."
22071 #: ../fish/guestfish-actions.pod:2802
22076 #: ../fish/guestfish-actions.pod:2804
22079 " mount-loop file mountpoint\n"
22084 #: ../fish/guestfish-actions.pod:2810
22085 msgid "mount-options"
22089 #: ../fish/guestfish-actions.pod:2812
22092 " mount-options options device mountpoint\n"
22097 #: ../fish/guestfish-actions.pod:2814
22099 "This is the same as the L</mount> command, but it allows you to set the "
22100 "mount options as for the L<mount(8)> I<-o> flag."
22104 #: ../fish/guestfish-actions.pod:2822
22109 #: ../fish/guestfish-actions.pod:2824
22112 " mount-ro device mountpoint\n"
22117 #: ../fish/guestfish-actions.pod:2826
22119 "This is the same as the L</mount> command, but it mounts the filesystem with "
22120 "the read-only (I<-o ro>) flag."
22124 #: ../fish/guestfish-actions.pod:2829
22129 #: ../fish/guestfish-actions.pod:2831
22132 " mount-vfs options vfstype device mountpoint\n"
22137 #: ../fish/guestfish-actions.pod:2833
22139 "This is the same as the L</mount> command, but it allows you to set both the "
22140 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
22144 #: ../fish/guestfish-actions.pod:2837
22145 msgid "mountpoints"
22149 #: ../fish/guestfish-actions.pod:2839
22157 #: ../fish/guestfish-actions.pod:2841
22159 "This call is similar to L</mounts>. That call returns a list of devices. "
22160 "This one returns a hash table (map) of device name to directory where the "
22161 "device is mounted."
22165 #: ../fish/guestfish-actions.pod:2845
22170 #: ../fish/guestfish-actions.pod:2847
22178 #: ../fish/guestfish-actions.pod:2854
22179 msgid "See also: L</mountpoints>"
22183 #: ../fish/guestfish-actions.pod:2856
22188 #: ../fish/guestfish-actions.pod:2858
22196 #: ../fish/guestfish-actions.pod:2863
22197 msgid "ntfs-3g-probe"
22201 #: ../fish/guestfish-actions.pod:2865
22204 " ntfs-3g-probe true|false device\n"
22209 #: ../fish/guestfish-actions.pod:2879
22214 #: ../fish/guestfish-actions.pod:2881
22217 " ntfsresize device\n"
22222 #: ../fish/guestfish-actions.pod:2887
22223 msgid "ntfsresize-size"
22227 #: ../fish/guestfish-actions.pod:2889
22230 " ntfsresize-size device size\n"
22235 #: ../fish/guestfish-actions.pod:2891
22237 "This command is the same as L</ntfsresize> except that it allows you to "
22238 "specify the new size (in bytes) explicitly."
22242 #: ../fish/guestfish-actions.pod:2894
22247 #: ../fish/guestfish-actions.pod:2896
22250 " part-add device prlogex startsect endsect\n"
22255 #: ../fish/guestfish-actions.pod:2898
22257 "This command adds a partition to C<device>. If there is no partition table "
22258 "on the device, call L</part-init> first."
22262 #: ../fish/guestfish-actions.pod:2910
22264 "Creating a partition which covers the whole disk is not so easy. Use L</"
22265 "part-disk> to do that."
22269 #: ../fish/guestfish-actions.pod:2913
22274 #: ../fish/guestfish-actions.pod:2915
22277 " part-del device partnum\n"
22282 #: ../fish/guestfish-actions.pod:2923
22287 #: ../fish/guestfish-actions.pod:2925
22290 " part-disk device parttype\n"
22295 #: ../fish/guestfish-actions.pod:2927
22297 "This command is simply a combination of L</part-init> followed by L</part-"
22298 "add> to create a single primary partition covering the whole disk."
22302 #: ../fish/guestfish-actions.pod:2931
22304 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
22305 "possible values are described in L</part-init>."
22309 #: ../fish/guestfish-actions.pod:2937
22310 msgid "part-get-bootable"
22314 #: ../fish/guestfish-actions.pod:2939
22317 " part-get-bootable device partnum\n"
22322 #: ../fish/guestfish-actions.pod:2944
22323 msgid "See also L</part-set-bootable>."
22327 #: ../fish/guestfish-actions.pod:2946
22328 msgid "part-get-mbr-id"
22332 #: ../fish/guestfish-actions.pod:2948
22335 " part-get-mbr-id device partnum\n"
22340 #: ../fish/guestfish-actions.pod:2953 ../fish/guestfish-actions.pod:3091
22342 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
22343 "undefined results for other partition table types (see L</part-get-"
22348 #: ../fish/guestfish-actions.pod:2957
22349 msgid "part-get-parttype"
22353 #: ../fish/guestfish-actions.pod:2959
22356 " part-get-parttype device\n"
22361 #: ../fish/guestfish-actions.pod:2964
22363 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
22364 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
22365 "possible, although unusual. See L</part-init> for a full list."
22369 #: ../fish/guestfish-actions.pod:2969
22374 #: ../fish/guestfish-actions.pod:2971
22377 " part-init device parttype\n"
22382 #: ../fish/guestfish-actions.pod:2977
22384 "Initially there are no partitions. Following this, you should call L</part-"
22385 "add> for each partition required."
22389 #: ../fish/guestfish-actions.pod:3040
22394 #: ../fish/guestfish-actions.pod:3042
22397 " part-list device\n"
22402 #: ../fish/guestfish-actions.pod:3057
22404 "Start of the partition I<in bytes>. To get sectors you have to divide by "
22405 "the device's sector size, see L</blockdev-getss>."
22409 #: ../fish/guestfish-actions.pod:3070
22410 msgid "part-set-bootable"
22414 #: ../fish/guestfish-actions.pod:3072
22417 " part-set-bootable device partnum true|false\n"
22422 #: ../fish/guestfish-actions.pod:3081
22423 msgid "part-set-mbr-id"
22427 #: ../fish/guestfish-actions.pod:3083
22430 " part-set-mbr-id device partnum idbyte\n"
22435 #: ../fish/guestfish-actions.pod:3095
22436 msgid "part-set-name"
22440 #: ../fish/guestfish-actions.pod:3097
22443 " part-set-name device partnum name\n"
22448 #: ../fish/guestfish-actions.pod:3105
22449 msgid "part-to-dev"
22453 #: ../fish/guestfish-actions.pod:3107
22456 " part-to-dev partition\n"
22461 #: ../fish/guestfish-actions.pod:3113
22463 "The named partition must exist, for example as a string returned from L</"
22464 "list-partitions>."
22468 #: ../fish/guestfish-actions.pod:3116
22469 msgid "ping-daemon"
22473 #: ../fish/guestfish-actions.pod:3118
22481 #: ../fish/guestfish-actions.pod:3125
22486 #: ../fish/guestfish-actions.pod:3127
22489 " pread path count offset\n"
22494 #: ../fish/guestfish-actions.pod:3135
22495 msgid "See also L</pwrite>, L</pread-device>."
22499 #: ../fish/guestfish-actions.pod:3140
22500 msgid "pread-device"
22504 #: ../fish/guestfish-actions.pod:3142
22507 " pread-device device count offset\n"
22512 #: ../fish/guestfish-actions.pod:3150
22513 msgid "See also L</pread>."
22517 #: ../fish/guestfish-actions.pod:3155
22522 #: ../fish/guestfish-actions.pod:3157
22525 " pvcreate device\n"
22530 #: ../fish/guestfish-actions.pod:3163
22535 #: ../fish/guestfish-actions.pod:3165
22538 " pvremove device\n"
22543 #: ../fish/guestfish-actions.pod:3174
22548 #: ../fish/guestfish-actions.pod:3176
22551 " pvresize device\n"
22556 #: ../fish/guestfish-actions.pod:3181
22557 msgid "pvresize-size"
22561 #: ../fish/guestfish-actions.pod:3183
22564 " pvresize-size device size\n"
22569 #: ../fish/guestfish-actions.pod:3185
22571 "This command is the same as L</pvresize> except that it allows you to "
22572 "specify the new size (in bytes) explicitly."
22576 #: ../fish/guestfish-actions.pod:3188
22581 #: ../fish/guestfish-actions.pod:3190
22589 #: ../fish/guestfish-actions.pod:3198
22590 msgid "See also L</pvs-full>."
22594 #: ../fish/guestfish-actions.pod:3200
22599 #: ../fish/guestfish-actions.pod:3202
22607 #: ../fish/guestfish-actions.pod:3207
22612 #: ../fish/guestfish-actions.pod:3209
22620 #: ../fish/guestfish-actions.pod:3213
22625 #: ../fish/guestfish-actions.pod:3215
22628 " pwrite path content offset\n"
22633 #: ../fish/guestfish-actions.pod:3226
22634 msgid "See also L</pread>, L</pwrite-device>."
22638 #: ../fish/guestfish-actions.pod:3231
22639 msgid "pwrite-device"
22643 #: ../fish/guestfish-actions.pod:3233
22646 " pwrite-device device content offset\n"
22651 #: ../fish/guestfish-actions.pod:3243
22652 msgid "See also L</pwrite>."
22656 #: ../fish/guestfish-actions.pod:3248
22661 #: ../fish/guestfish-actions.pod:3250
22664 " read-file path\n"
22669 #: ../fish/guestfish-actions.pod:3255
22671 "Unlike L</cat>, this function can correctly handle files that contain "
22672 "embedded ASCII NUL characters. However unlike L</download>, this function "
22673 "is limited in the total size of file that can be handled."
22677 #: ../fish/guestfish-actions.pod:3263
22682 #: ../fish/guestfish-actions.pod:3265
22685 " read-lines path\n"
22690 #: ../fish/guestfish-actions.pod:3272
22692 "Note that this function cannot correctly handle binary files (specifically, "
22693 "files containing C<\\0> character which is treated as end of line). For "
22694 "those you need to use the L</read-file> function which has a more complex "
22699 #: ../fish/guestfish-actions.pod:3277
22704 #: ../fish/guestfish-actions.pod:3279
22712 #: ../fish/guestfish-actions.pod:3331
22714 "This function is primarily intended for use by programs. To get a simple "
22715 "list of names, use L</ls>. To get a printable directory for human "
22716 "consumption, use L</ll>."
22720 #: ../fish/guestfish-actions.pod:3335
22725 #: ../fish/guestfish-actions.pod:3337
22733 #: ../fish/guestfish-actions.pod:3341
22734 msgid "readlinklist"
22738 #: ../fish/guestfish-actions.pod:3343
22741 " readlinklist path 'names ...'\n"
22746 #: ../fish/guestfish-actions.pod:3367
22751 #: ../fish/guestfish-actions.pod:3369
22759 #: ../fish/guestfish-actions.pod:3374
22760 msgid "removexattr"
22764 #: ../fish/guestfish-actions.pod:3376
22767 " removexattr xattr path\n"
22772 #: ../fish/guestfish-actions.pod:3381
22773 msgid "See also: L</lremovexattr>, L<attr(5)>."
22777 #: ../fish/guestfish-actions.pod:3383
22782 #: ../fish/guestfish-actions.pod:3385
22785 " resize2fs device\n"
22790 #: ../fish/guestfish-actions.pod:3390
22792 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
22793 "before calling this command. For unknown reasons C<resize2fs> sometimes "
22794 "gives an error about this and sometimes not. In any case, it is always safe "
22795 "to call L</e2fsck-f> before calling this function."
22799 #: ../fish/guestfish-actions.pod:3396
22800 msgid "resize2fs-size"
22804 #: ../fish/guestfish-actions.pod:3398
22807 " resize2fs-size device size\n"
22812 #: ../fish/guestfish-actions.pod:3400
22814 "This command is the same as L</resize2fs> except that it allows you to "
22815 "specify the new size (in bytes) explicitly."
22819 #: ../fish/guestfish-actions.pod:3403
22824 #: ../fish/guestfish-actions.pod:3405
22832 #: ../fish/guestfish-actions.pod:3409
22837 #: ../fish/guestfish-actions.pod:3411
22845 #: ../fish/guestfish-actions.pod:3417
22850 #: ../fish/guestfish-actions.pod:3419
22858 #: ../fish/guestfish-actions.pod:3423
22859 msgid "rmmountpoint"
22863 #: ../fish/guestfish-actions.pod:3425
22866 " rmmountpoint exemptpath\n"
22871 #: ../fish/guestfish-actions.pod:3427
22873 "This calls removes a mountpoint that was previously created with L</"
22874 "mkmountpoint>. See L</mkmountpoint> for full details."
22878 #: ../fish/guestfish-actions.pod:3431
22879 msgid "scrub-device"
22883 #: ../fish/guestfish-actions.pod:3433
22886 " scrub-device device\n"
22891 #: ../fish/guestfish-actions.pod:3444
22896 #: ../fish/guestfish-actions.pod:3446
22899 " scrub-file file\n"
22904 #: ../fish/guestfish-actions.pod:3456
22905 msgid "scrub-freespace"
22909 #: ../fish/guestfish-actions.pod:3458
22912 " scrub-freespace dir\n"
22917 #: ../fish/guestfish-actions.pod:3460
22919 "This command creates the directory C<dir> and then fills it with files until "
22920 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
22921 "deletes them. The intention is to scrub any free space on the partition "
22922 "containing C<dir>."
22926 #: ../fish/guestfish-actions.pod:3469
22931 #: ../fish/guestfish-actions.pod:3471
22936 #: ../fish/guestfish-actions.pod:3473
22939 " set-append append\n"
22944 #: ../fish/guestfish-actions.pod:3484
22945 msgid "set-autosync"
22949 #: ../fish/guestfish-actions.pod:3486
22954 #: ../fish/guestfish-actions.pod:3488
22957 " set-autosync true|false\n"
22962 #: ../fish/guestfish-actions.pod:3490
22964 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
22965 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
22966 "closed (also if the program exits without closing handles)."
22970 #: ../fish/guestfish-actions.pod:3498
22975 #: ../fish/guestfish-actions.pod:3500
22980 #: ../fish/guestfish-actions.pod:3502
22983 " set-direct true|false\n"
22988 #: ../fish/guestfish-actions.pod:3508
22990 "One consequence of this is that log messages aren't caught by the library "
22991 "and handled by L</set-log-message-callback>, but go straight to stdout."
22995 #: ../fish/guestfish-actions.pod:3517
22996 msgid "set-e2label"
23000 #: ../fish/guestfish-actions.pod:3519
23003 " set-e2label device label\n"
23008 #: ../fish/guestfish-actions.pod:3525
23010 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
23011 "label on a filesystem."
23015 #: ../fish/guestfish-actions.pod:3528
23020 #: ../fish/guestfish-actions.pod:3530
23023 " set-e2uuid device uuid\n"
23028 #: ../fish/guestfish-actions.pod:3537
23030 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
23031 "UUID of a filesystem."
23035 #: ../fish/guestfish-actions.pod:3540
23036 msgid "set-memsize"
23040 #: ../fish/guestfish-actions.pod:3542
23045 #: ../fish/guestfish-actions.pod:3544
23048 " set-memsize memsize\n"
23053 #: ../fish/guestfish-actions.pod:3546
23055 "This sets the memory size in megabytes allocated to the qemu subprocess. "
23056 "This only has any effect if called before L</launch>."
23060 #: ../fish/guestfish-actions.pod:3557
23061 msgid "set-network"
23065 #: ../fish/guestfish-actions.pod:3559
23070 #: ../fish/guestfish-actions.pod:3561
23073 " set-network true|false\n"
23078 #: ../fish/guestfish-actions.pod:3569
23080 "You must call this before calling L</launch>, otherwise it has no effect."
23084 #: ../fish/guestfish-actions.pod:3572
23089 #: ../fish/guestfish-actions.pod:3574
23094 #: ../fish/guestfish-actions.pod:3576
23097 " set-path searchpath\n"
23102 #: ../fish/guestfish-actions.pod:3585
23107 #: ../fish/guestfish-actions.pod:3587
23112 #: ../fish/guestfish-actions.pod:3589
23120 #: ../fish/guestfish-actions.pod:3609
23121 msgid "set-recovery-proc"
23125 #: ../fish/guestfish-actions.pod:3611
23126 msgid "recovery-proc"
23130 #: ../fish/guestfish-actions.pod:3613
23133 " set-recovery-proc true|false\n"
23138 #: ../fish/guestfish-actions.pod:3615
23140 "If this is called with the parameter C<false> then L</launch> does not "
23141 "create a recovery process. The purpose of the recovery process is to stop "
23142 "runaway qemu processes in the case where the main program aborts abruptly."
23146 #: ../fish/guestfish-actions.pod:3620
23148 "This only has any effect if called before L</launch>, and the default is "
23153 #: ../fish/guestfish-actions.pod:3629
23154 msgid "set-selinux"
23158 #: ../fish/guestfish-actions.pod:3631
23163 #: ../fish/guestfish-actions.pod:3633
23166 " set-selinux true|false\n"
23171 #: ../fish/guestfish-actions.pod:3644
23176 #: ../fish/guestfish-actions.pod:3646
23181 #: ../fish/guestfish-actions.pod:3648
23184 " set-trace true|false\n"
23189 #: ../fish/guestfish-actions.pod:3664
23190 msgid "set-verbose"
23194 #: ../fish/guestfish-actions.pod:3666
23199 #: ../fish/guestfish-actions.pod:3668
23202 " set-verbose true|false\n"
23207 #: ../fish/guestfish-actions.pod:3675
23212 #: ../fish/guestfish-actions.pod:3677
23215 " setcon context\n"
23220 #: ../fish/guestfish-actions.pod:3684
23225 #: ../fish/guestfish-actions.pod:3686
23228 " setxattr xattr val vallen path\n"
23233 #: ../fish/guestfish-actions.pod:3692
23234 msgid "See also: L</lsetxattr>, L<attr(5)>."
23238 #: ../fish/guestfish-actions.pod:3694
23243 #: ../fish/guestfish-actions.pod:3696
23246 " sfdisk device cyls heads sectors 'lines ...'\n"
23251 #: ../fish/guestfish-actions.pod:3718
23252 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
23256 #: ../fish/guestfish-actions.pod:3724
23261 #: ../fish/guestfish-actions.pod:3726
23264 " sfdiskM device 'lines ...'\n"
23269 #: ../fish/guestfish-actions.pod:3728
23271 "This is a simplified interface to the L</sfdisk> command, where partition "
23272 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
23273 "you don't need to specify the cyls, heads and sectors parameters which were "
23274 "rarely if ever used anyway."
23278 #: ../fish/guestfish-actions.pod:3734
23279 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
23283 #: ../fish/guestfish-actions.pod:3740
23288 #: ../fish/guestfish-actions.pod:3742
23291 " sfdisk-N device partnum cyls heads sectors line\n"
23296 #: ../fish/guestfish-actions.pod:3747
23298 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
23299 "cyls/heads/sectors parameters."
23303 #: ../fish/guestfish-actions.pod:3750
23304 msgid "See also: L</part-add>"
23308 #: ../fish/guestfish-actions.pod:3755
23309 msgid "sfdisk-disk-geometry"
23313 #: ../fish/guestfish-actions.pod:3757
23316 " sfdisk-disk-geometry device\n"
23321 #: ../fish/guestfish-actions.pod:3759
23323 "This displays the disk geometry of C<device> read from the partition table. "
23324 "Especially in the case where the underlying block device has been resized, "
23325 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
23326 "kernel-geometry>)."
23330 #: ../fish/guestfish-actions.pod:3767
23331 msgid "sfdisk-kernel-geometry"
23335 #: ../fish/guestfish-actions.pod:3769
23338 " sfdisk-kernel-geometry device\n"
23343 #: ../fish/guestfish-actions.pod:3776
23348 #: ../fish/guestfish-actions.pod:3778
23351 " sfdisk-l device\n"
23356 #: ../fish/guestfish-actions.pod:3784
23357 msgid "See also: L</part-list>"
23361 #: ../fish/guestfish-actions.pod:3786
23366 #: ../fish/guestfish-actions.pod:3788
23374 #: ../fish/guestfish-actions.pod:3793
23375 msgid "This is like L</command>, but passes the command to:"
23379 #: ../fish/guestfish-actions.pod:3801
23380 msgid "All the provisos about L</command> apply to this call."
23384 #: ../fish/guestfish-actions.pod:3803
23389 #: ../fish/guestfish-actions.pod:3805
23392 " sh-lines command\n"
23397 #: ../fish/guestfish-actions.pod:3807
23398 msgid "This is the same as L</sh>, but splits the result into a list of lines."
23402 #: ../fish/guestfish-actions.pod:3810
23403 msgid "See also: L</command-lines>"
23407 #: ../fish/guestfish-actions.pod:3812
23412 #: ../fish/guestfish-actions.pod:3814
23420 #: ../fish/guestfish-actions.pod:3818
23425 #: ../fish/guestfish-actions.pod:3820
23433 #: ../fish/guestfish-actions.pod:3826
23438 #: ../fish/guestfish-actions.pod:3828
23446 #: ../fish/guestfish-actions.pod:3836
23451 #: ../fish/guestfish-actions.pod:3838
23459 #: ../fish/guestfish-actions.pod:3846
23464 #: ../fish/guestfish-actions.pod:3848
23467 " strings-e encoding path\n"
23472 #: ../fish/guestfish-actions.pod:3850
23474 "This is like the L</strings> command, but allows you to specify the encoding "
23475 "of strings that are looked for in the source file C<path>."
23479 #: ../fish/guestfish-actions.pod:3860
23481 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
23482 "ISO-8859-X (this is what L</strings> uses)."
23486 #: ../fish/guestfish-actions.pod:3892
23487 msgid "swapoff-device"
23491 #: ../fish/guestfish-actions.pod:3894
23494 " swapoff-device device\n"
23499 #: ../fish/guestfish-actions.pod:3896
23501 "This command disables the libguestfs appliance swap device or partition "
23502 "named C<device>. See L</swapon-device>."
23506 #: ../fish/guestfish-actions.pod:3900
23507 msgid "swapoff-file"
23511 #: ../fish/guestfish-actions.pod:3902
23514 " swapoff-file file\n"
23519 #: ../fish/guestfish-actions.pod:3906
23520 msgid "swapoff-label"
23524 #: ../fish/guestfish-actions.pod:3908
23527 " swapoff-label label\n"
23532 #: ../fish/guestfish-actions.pod:3913
23533 msgid "swapoff-uuid"
23537 #: ../fish/guestfish-actions.pod:3915
23540 " swapoff-uuid uuid\n"
23545 #: ../fish/guestfish-actions.pod:3920
23546 msgid "swapon-device"
23550 #: ../fish/guestfish-actions.pod:3922
23553 " swapon-device device\n"
23558 #: ../fish/guestfish-actions.pod:3924
23560 "This command enables the libguestfs appliance to use the swap device or "
23561 "partition named C<device>. The increased memory is made available for all "
23562 "commands, for example those run using L</command> or L</sh>."
23566 #: ../fish/guestfish-actions.pod:3936
23567 msgid "swapon-file"
23571 #: ../fish/guestfish-actions.pod:3938
23574 " swapon-file file\n"
23579 #: ../fish/guestfish-actions.pod:3940
23581 "This command enables swap to a file. See L</swapon-device> for other notes."
23585 #: ../fish/guestfish-actions.pod:3943
23586 msgid "swapon-label"
23590 #: ../fish/guestfish-actions.pod:3945
23593 " swapon-label label\n"
23598 #: ../fish/guestfish-actions.pod:3947
23600 "This command enables swap to a labeled swap partition. See L</swapon-"
23601 "device> for other notes."
23605 #: ../fish/guestfish-actions.pod:3950
23606 msgid "swapon-uuid"
23610 #: ../fish/guestfish-actions.pod:3952
23613 " swapon-uuid uuid\n"
23618 #: ../fish/guestfish-actions.pod:3954
23620 "This command enables swap to a swap partition with the given UUID. See L</"
23621 "swapon-device> for other notes."
23625 #: ../fish/guestfish-actions.pod:3957
23630 #: ../fish/guestfish-actions.pod:3959
23638 #: ../fish/guestfish-actions.pod:3967
23643 #: ../fish/guestfish-actions.pod:3969
23651 #: ../fish/guestfish-actions.pod:3977
23656 #: ../fish/guestfish-actions.pod:3979
23659 " tail-n nrlines path\n"
23664 #: ../fish/guestfish-actions.pod:3992
23669 #: ../fish/guestfish-actions.pod:3994
23672 " tar-in (tarfile|-) directory\n"
23677 #: ../fish/guestfish-actions.pod:3999
23678 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
23682 #: ../fish/guestfish-actions.pod:4004
23687 #: ../fish/guestfish-actions.pod:4006
23690 " tar-out directory (tarfile|-)\n"
23695 #: ../fish/guestfish-actions.pod:4011
23696 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
23700 #: ../fish/guestfish-actions.pod:4016
23705 #: ../fish/guestfish-actions.pod:4018
23708 " tgz-in (tarball|-) directory\n"
23713 #: ../fish/guestfish-actions.pod:4023
23714 msgid "To upload an uncompressed tarball, use L</tar-in>."
23718 #: ../fish/guestfish-actions.pod:4027
23723 #: ../fish/guestfish-actions.pod:4029
23726 " tgz-out directory (tarball|-)\n"
23731 #: ../fish/guestfish-actions.pod:4034
23732 msgid "To download an uncompressed tarball, use L</tar-out>."
23736 #: ../fish/guestfish-actions.pod:4038
23741 #: ../fish/guestfish-actions.pod:4040
23749 #: ../fish/guestfish-actions.pod:4049
23754 #: ../fish/guestfish-actions.pod:4051
23762 #: ../fish/guestfish-actions.pod:4056
23763 msgid "truncate-size"
23767 #: ../fish/guestfish-actions.pod:4058
23770 " truncate-size path size\n"
23775 #: ../fish/guestfish-actions.pod:4063
23777 "If the current file size is less than C<size> then the file is extended to "
23778 "the required size with zero bytes. This creates a sparse file (ie. disk "
23779 "blocks are not allocated for the file until you write to it). To create a "
23780 "non-sparse file of zeroes, use L</fallocate64> instead."
23784 #: ../fish/guestfish-actions.pod:4069
23789 #: ../fish/guestfish-actions.pod:4071
23792 " tune2fs-l device\n"
23797 #: ../fish/guestfish-actions.pod:4081
23802 #: ../fish/guestfish-actions.pod:4083
23805 " txz-in (tarball|-) directory\n"
23810 #: ../fish/guestfish-actions.pod:4090
23815 #: ../fish/guestfish-actions.pod:4092
23818 " txz-out directory (tarball|-)\n"
23823 #: ../fish/guestfish-actions.pod:4099
23828 #: ../fish/guestfish-actions.pod:4101
23836 #: ../fish/guestfish-actions.pod:4115
23837 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
23841 #: ../fish/guestfish-actions.pod:4120
23846 #: ../fish/guestfish-actions.pod:4122
23851 #: ../fish/guestfish-actions.pod:4124
23854 " umount pathordevice\n"
23859 #: ../fish/guestfish-actions.pod:4130
23864 #: ../fish/guestfish-actions.pod:4132
23865 msgid "unmount-all"
23869 #: ../fish/guestfish-actions.pod:4134
23877 #: ../fish/guestfish-actions.pod:4140
23882 #: ../fish/guestfish-actions.pod:4142
23885 " upload (filename|-) remotefilename\n"
23890 #: ../fish/guestfish-actions.pod:4149
23891 msgid "See also L</download>."
23895 #: ../fish/guestfish-actions.pod:4153
23896 msgid "upload-offset"
23900 #: ../fish/guestfish-actions.pod:4155
23903 " upload-offset (filename|-) remotefilename offset\n"
23908 #: ../fish/guestfish-actions.pod:4167
23910 "Note that there is no limit on the amount of data that can be uploaded with "
23911 "this call, unlike with L</pwrite>, and this call always writes the full "
23912 "amount unless an error occurs."
23916 #: ../fish/guestfish-actions.pod:4172
23917 msgid "See also L</upload>, L</pwrite>."
23921 #: ../fish/guestfish-actions.pod:4176
23926 #: ../fish/guestfish-actions.pod:4178
23929 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
23934 #: ../fish/guestfish-actions.pod:4197
23939 #: ../fish/guestfish-actions.pod:4199
23947 #: ../fish/guestfish-actions.pod:4226
23949 "I<Note:> Don't use this call to test for availability of features. In "
23950 "enterprise distributions we backport features from later versions into "
23951 "earlier versions, making this an unreliable way to test for features. Use "
23952 "L</available> instead."
23956 #: ../fish/guestfish-actions.pod:4232
23961 #: ../fish/guestfish-actions.pod:4234
23964 " vfs-label device\n"
23969 #: ../fish/guestfish-actions.pod:4241
23970 msgid "To find a filesystem from the label, use L</findfs-label>."
23974 #: ../fish/guestfish-actions.pod:4243
23979 #: ../fish/guestfish-actions.pod:4245
23982 " vfs-type device\n"
23987 #: ../fish/guestfish-actions.pod:4255
23992 #: ../fish/guestfish-actions.pod:4257
23995 " vfs-uuid device\n"
24000 #: ../fish/guestfish-actions.pod:4264
24001 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
24005 #: ../fish/guestfish-actions.pod:4266
24006 msgid "vg-activate"
24010 #: ../fish/guestfish-actions.pod:4268
24013 " vg-activate true|false 'volgroups ...'\n"
24018 #: ../fish/guestfish-actions.pod:4281
24019 msgid "vg-activate-all"
24023 #: ../fish/guestfish-actions.pod:4283
24026 " vg-activate-all true|false\n"
24031 #: ../fish/guestfish-actions.pod:4293
24036 #: ../fish/guestfish-actions.pod:4295
24039 " vgcreate volgroup 'physvols ...'\n"
24044 #: ../fish/guestfish-actions.pod:4300
24049 #: ../fish/guestfish-actions.pod:4302
24052 " vglvuuids vgname\n"
24057 #: ../fish/guestfish-actions.pod:4307
24059 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
24060 "logical volumes and volume groups."
24064 #: ../fish/guestfish-actions.pod:4310
24065 msgid "See also L</vgpvuuids>."
24069 #: ../fish/guestfish-actions.pod:4312
24074 #: ../fish/guestfish-actions.pod:4314
24077 " vgpvuuids vgname\n"
24082 #: ../fish/guestfish-actions.pod:4319
24084 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
24085 "physical volumes and volume groups."
24089 #: ../fish/guestfish-actions.pod:4322
24090 msgid "See also L</vglvuuids>."
24094 #: ../fish/guestfish-actions.pod:4324
24099 #: ../fish/guestfish-actions.pod:4326
24102 " vgremove vgname\n"
24107 #: ../fish/guestfish-actions.pod:4333
24112 #: ../fish/guestfish-actions.pod:4335
24115 " vgrename volgroup newvolgroup\n"
24120 #: ../fish/guestfish-actions.pod:4339
24125 #: ../fish/guestfish-actions.pod:4341
24133 #: ../fish/guestfish-actions.pod:4349
24134 msgid "See also L</vgs-full>."
24138 #: ../fish/guestfish-actions.pod:4351
24143 #: ../fish/guestfish-actions.pod:4353
24151 #: ../fish/guestfish-actions.pod:4358
24156 #: ../fish/guestfish-actions.pod:4360
24164 #: ../fish/guestfish-actions.pod:4365
24169 #: ../fish/guestfish-actions.pod:4367
24177 #: ../fish/guestfish-actions.pod:4371
24182 #: ../fish/guestfish-actions.pod:4373
24190 #: ../fish/guestfish-actions.pod:4378
24195 #: ../fish/guestfish-actions.pod:4380
24203 #: ../fish/guestfish-actions.pod:4385
24208 #: ../fish/guestfish-actions.pod:4387
24216 #: ../fish/guestfish-actions.pod:4392
24221 #: ../fish/guestfish-actions.pod:4394
24224 " write path content\n"
24229 #: ../fish/guestfish-actions.pod:4402
24234 #: ../fish/guestfish-actions.pod:4404
24237 " write-file path content size\n"
24242 #: ../fish/guestfish-actions.pod:4427
24247 #: ../fish/guestfish-actions.pod:4429
24250 " zegrep regex path\n"
24255 #: ../fish/guestfish-actions.pod:4437
24260 #: ../fish/guestfish-actions.pod:4439
24263 " zegrepi regex path\n"
24268 #: ../fish/guestfish-actions.pod:4447
24273 #: ../fish/guestfish-actions.pod:4449
24281 #: ../fish/guestfish-actions.pod:4457
24282 msgid "See also: L</zero-device>, L</scrub-device>."
24286 #: ../fish/guestfish-actions.pod:4459
24287 msgid "zero-device"
24291 #: ../fish/guestfish-actions.pod:4461
24294 " zero-device device\n"
24299 #: ../fish/guestfish-actions.pod:4463
24301 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
24302 "which just zeroes the first few blocks of a device."
24306 #: ../fish/guestfish-actions.pod:4470
24311 #: ../fish/guestfish-actions.pod:4472
24314 " zerofree device\n"
24319 #: ../fish/guestfish-actions.pod:4485
24324 #: ../fish/guestfish-actions.pod:4487
24327 " zfgrep pattern path\n"
24332 #: ../fish/guestfish-actions.pod:4495
24337 #: ../fish/guestfish-actions.pod:4497
24340 " zfgrepi pattern path\n"
24345 #: ../fish/guestfish-actions.pod:4505
24350 #: ../fish/guestfish-actions.pod:4507
24353 " zfile meth path\n"
24358 #: ../fish/guestfish-actions.pod:4514
24360 "Since 1.0.63, use L</file> instead which can now process compressed files."
24364 #: ../fish/guestfish-actions.pod:4524
24369 #: ../fish/guestfish-actions.pod:4526
24372 " zgrep regex path\n"
24377 #: ../fish/guestfish-actions.pod:4534
24382 #: ../fish/guestfish-actions.pod:4536
24385 " zgrepi regex path\n"
24390 #: ../fish/guestfish-commands.pod:1
24395 #: ../fish/guestfish-commands.pod:3
24400 #: ../fish/guestfish-commands.pod:5
24403 " alloc filename size\n"
24408 #: ../fish/guestfish-commands.pod:7
24410 "This creates an empty (zeroed) file of the given size, and then adds so it "
24411 "can be further examined."
24415 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
24416 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
24420 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
24421 msgid "Size can be specified using standard suffixes, eg. C<1M>."
24425 #: ../fish/guestfish-commands.pod:14
24427 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
24428 "image, see L</PREPARED DISK IMAGES>."
24432 #: ../fish/guestfish-commands.pod:17
24437 #: ../fish/guestfish-commands.pod:19
24440 " copy-in local [local ...] /remotedir\n"
24445 #: ../fish/guestfish-commands.pod:21
24447 "C<copy-in> copies local files or directories recursively into the disk "
24448 "image, placing them in the directory called C</remotedir> (which must "
24449 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
24450 "other commands as necessary."
24454 #: ../fish/guestfish-commands.pod:26
24456 "Multiple local files and directories can be specified, but the last "
24457 "parameter must always be a remote directory. Wildcards cannot be used."
24461 #: ../fish/guestfish-commands.pod:30
24466 #: ../fish/guestfish-commands.pod:32
24469 " copy-out remote [remote ...] localdir\n"
24474 #: ../fish/guestfish-commands.pod:34
24476 "C<copy-out> copies remote files or directories recursively out of the disk "
24477 "image, placing them on the host disk in a local directory called C<localdir> "
24478 "(which must exist). This guestfish meta-command turns into a sequence of L</"
24479 "download>, L</tar-out> and other commands as necessary."
24483 #: ../fish/guestfish-commands.pod:40
24485 "Multiple remote files and directories can be specified, but the last "
24486 "parameter must always be a local directory. To download to the current "
24487 "directory, use C<.> as in:"
24491 #: ../fish/guestfish-commands.pod:44
24494 " copy-out /home .\n"
24499 #: ../fish/guestfish-commands.pod:46
24501 "Wildcards cannot be used in the ordinary command, but you can use them with "
24502 "the help of L</glob> like this:"
24506 #: ../fish/guestfish-commands.pod:49
24509 " glob copy-out /home/* .\n"
24514 #: ../fish/guestfish-commands.pod:51
24519 #: ../fish/guestfish-commands.pod:53
24522 " echo [params ...]\n"
24527 #: ../fish/guestfish-commands.pod:55
24528 msgid "This echos the parameters to the terminal."
24532 #: ../fish/guestfish-commands.pod:57
24537 #: ../fish/guestfish-commands.pod:59
24542 #: ../fish/guestfish-commands.pod:61
24547 #: ../fish/guestfish-commands.pod:63
24555 #: ../fish/guestfish-commands.pod:65
24557 "This is used to edit a file. It downloads the file, edits it locally using "
24558 "your editor, then uploads the result."
24562 #: ../fish/guestfish-commands.pod:68
24564 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
24565 "or C<emacs> you will get those corresponding editors."
24569 #: ../fish/guestfish-commands.pod:72
24574 #: ../fish/guestfish-commands.pod:74
24577 " glob command args...\n"
24582 #: ../fish/guestfish-commands.pod:76
24584 "Expand wildcards in any paths in the args list, and run C<command> "
24585 "repeatedly on each matching path."
24589 #: ../fish/guestfish-commands.pod:79
24590 msgid "See L</WILDCARDS AND GLOBBING>."
24594 #: ../fish/guestfish-commands.pod:81
24599 #: ../fish/guestfish-commands.pod:83
24602 " hexedit <filename|device>\n"
24603 " hexedit <filename|device> <max>\n"
24604 " hexedit <filename|device> <start> <max>\n"
24609 #: ../fish/guestfish-commands.pod:87
24611 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
24616 #: ../fish/guestfish-commands.pod:90
24618 "This command works by downloading potentially the whole file or device, "
24619 "editing it locally, then uploading it. If the file or device is large, you "
24620 "have to specify which part you wish to edit by using C<max> and/or C<start> "
24621 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
24622 "usual modifiers allowed such as C<1M> (1 megabyte)."
24626 #: ../fish/guestfish-commands.pod:97
24627 msgid "For example to edit the first few sectors of a disk you might do:"
24631 #: ../fish/guestfish-commands.pod:100
24634 " hexedit /dev/sda 1M\n"
24639 #: ../fish/guestfish-commands.pod:102
24641 "which would allow you to edit anywhere within the first megabyte of the disk."
24645 #: ../fish/guestfish-commands.pod:105
24646 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
24650 #: ../fish/guestfish-commands.pod:107
24653 " hexedit /dev/sda1 0x400 0x400\n"
24658 #: ../fish/guestfish-commands.pod:109
24659 msgid "(assuming the superblock is in the standard location)."
24663 #: ../fish/guestfish-commands.pod:111
24665 "This command requires the external L<hexedit(1)> program. You can specify "
24666 "another program to use by setting the C<HEXEDITOR> environment variable."
24670 #: ../fish/guestfish-commands.pod:115
24671 msgid "See also L</hexdump>."
24675 #: ../fish/guestfish-commands.pod:117
24680 #: ../fish/guestfish-commands.pod:119
24688 #: ../fish/guestfish-commands.pod:121
24690 "Change the local directory, ie. the current directory of guestfish itself."
24694 #: ../fish/guestfish-commands.pod:124
24695 msgid "Note that C<!cd> won't do what you might expect."
24699 #: ../fish/guestfish-commands.pod:126
24704 #: ../fish/guestfish-commands.pod:128
24709 #: ../fish/guestfish-commands.pod:130
24717 #: ../fish/guestfish-commands.pod:132
24718 msgid "Opens the manual page for guestfish."
24722 #: ../fish/guestfish-commands.pod:134
24727 #: ../fish/guestfish-commands.pod:136
24732 #: ../fish/guestfish-commands.pod:138
24740 #: ../fish/guestfish-commands.pod:140
24748 #: ../fish/guestfish-commands.pod:142
24749 msgid "This is used to view a file."
24753 #: ../fish/guestfish-commands.pod:144
24755 "The default viewer is C<$PAGER>. However if you use the alternate command "
24756 "C<less> you will get the C<less> command specifically."
24760 #: ../fish/guestfish-commands.pod:147
24765 #: ../fish/guestfish-commands.pod:149
24773 #: ../fish/guestfish-commands.pod:151
24775 "Close and reopen the libguestfs handle. It is not necessary to use this "
24776 "normally, because the handle is closed properly when guestfish exits. "
24777 "However this is occasionally useful for testing."
24781 #: ../fish/guestfish-commands.pod:155
24786 #: ../fish/guestfish-commands.pod:157
24789 " sparse filename size\n"
24794 #: ../fish/guestfish-commands.pod:159
24796 "This creates an empty sparse file of the given size, and then adds so it can "
24797 "be further examined."
24801 #: ../fish/guestfish-commands.pod:162
24803 "In all respects it works the same as the L</alloc> command, except that the "
24804 "image file is allocated sparsely, which means that disk blocks are not "
24805 "assigned to the file until they are needed. Sparse disk files only use "
24806 "space when written to, but they are slower and there is a danger you could "
24807 "run out of real disk space during a write operation."
24811 #: ../fish/guestfish-commands.pod:172
24816 #: ../fish/guestfish-commands.pod:174
24824 #: ../fish/guestfish-commands.pod:176
24826 "This command returns a list of the optional groups known to the daemon, and "
24827 "indicates which ones are supported by this build of the libguestfs appliance."
24831 #: ../fish/guestfish-commands.pod:180
24832 msgid "See also L<guestfs(3)/AVAILABILITY>."
24836 #: ../fish/guestfish-commands.pod:182
24841 #: ../fish/guestfish-commands.pod:184
24844 " time command args...\n"
24849 #: ../fish/guestfish-commands.pod:186
24851 "Run the command as usual, but print the elapsed time afterwards. This can "
24852 "be useful for benchmarking operations."
24856 #: ../test-tool/libguestfs-test-tool.pod:5
24857 msgid "libguestfs-test-tool - End user tests for libguestfs"
24861 #: ../test-tool/libguestfs-test-tool.pod:9
24864 " libguestfs-test-tool [--options]\n"
24869 #: ../test-tool/libguestfs-test-tool.pod:13
24871 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
24872 "and developers, to allow them to check basic libguestfs functionality is "
24873 "working. This is needed because libguestfs occasionally breaks for reasons "
24874 "beyond our control: usually because of changes in the underlying qemu or "
24875 "kernel packages, or the host environment."
24879 #: ../test-tool/libguestfs-test-tool.pod:20
24880 msgid "If you suspect a problem in libguestfs, then just run:"
24884 #: ../test-tool/libguestfs-test-tool.pod:22
24887 " libguestfs-test-tool\n"
24892 #: ../test-tool/libguestfs-test-tool.pod:24
24893 msgid "It will print lots of diagnostic messages."
24897 #: ../test-tool/libguestfs-test-tool.pod:26
24898 msgid "If it runs to completion successfully, you will see this near the end:"
24902 #: ../test-tool/libguestfs-test-tool.pod:28
24905 " ===== TEST FINISHED OK =====\n"
24910 #: ../test-tool/libguestfs-test-tool.pod:30
24911 msgid "and the test tool will exit with code 0."
24915 #: ../test-tool/libguestfs-test-tool.pod:32
24917 "If it fails (and/or exits with non-zero error code), please paste the "
24918 "B<complete, unedited> output of the test tool into a bug report. More "
24919 "information about reporting bugs can be found on the L<http://libguestfs.org/"
24924 #: ../test-tool/libguestfs-test-tool.pod:41
24929 #: ../test-tool/libguestfs-test-tool.pod:43
24930 msgid "Display short usage information and exit."
24934 #: ../test-tool/libguestfs-test-tool.pod:45
24935 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
24939 #: ../test-tool/libguestfs-test-tool.pod:47
24941 "Pass an alternate name for the helper program. libguestfs-test-tool will "
24942 "normally look in the C<$libexec> directory that was configured when the tool "
24947 #: ../test-tool/libguestfs-test-tool.pod:51
24948 msgid "I<--qemu qemu_binary>"
24952 #: ../test-tool/libguestfs-test-tool.pod:53
24954 "If you have downloaded another qemu binary, point this option at the full "
24955 "path of the binary to try it."
24959 #: ../test-tool/libguestfs-test-tool.pod:56
24960 msgid "I<--qemudir qemu_source_dir>"
24964 #: ../test-tool/libguestfs-test-tool.pod:58
24966 "If you have compiled qemu from source, point this option at the source "
24967 "directory to try it."
24971 #: ../test-tool/libguestfs-test-tool.pod:61
24972 msgid "I<--timeout N>"
24976 #: ../test-tool/libguestfs-test-tool.pod:63
24978 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
24979 "does not usually need to be adjusted unless your machine is very slow."
24983 #: ../test-tool/libguestfs-test-tool.pod:69
24984 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
24988 #: ../test-tool/libguestfs-test-tool.pod:71
24990 "If you have compiled another version of qemu from source and would like to "
24991 "try that, then you can use the I<--qemudir> option to point to the qemu "
24992 "source directory."
24996 #: ../test-tool/libguestfs-test-tool.pod:75
24998 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
24999 "option to point to the binary."
25003 #: ../test-tool/libguestfs-test-tool.pod:78
25005 "When using an alternate qemu with libguestfs, usually you would need to "
25006 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
25007 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
25008 "use either of the I<--qemudir> or I<--qemu> options."
25012 #: ../test-tool/libguestfs-test-tool.pod:85
25014 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
25015 "I<1> if there was an error."
25019 #: ../test-tool/libguestfs-test-tool.pod:92
25020 msgid "/usr/libexec/libguestfs-test-tool-helper"
25024 #: ../test-tool/libguestfs-test-tool.pod:94
25026 "This helper program is run inside the appliance and provides additional "
25031 #: ../test-tool/libguestfs-test-tool.pod:97
25032 msgid "/usr/bin/mkisofs"
25036 #: ../test-tool/libguestfs-test-tool.pod:99
25038 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
25039 "which is used as part of the tests."
25043 #: ../test-tool/libguestfs-test-tool.pod:106
25045 "For the full list of environment variables which may affect libguestfs, "
25046 "please see the L<guestfs(3)> manual page."
25050 #: ../test-tool/libguestfs-test-tool.pod:111
25051 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
25055 #: ../test-tool/libguestfs-test-tool.pod:121
25056 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
25060 #: ../fuse/guestmount.pod:5
25062 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
25066 #: ../fuse/guestmount.pod:9
25069 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
25074 #: ../fuse/guestmount.pod:11
25077 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
25082 #: ../fuse/guestmount.pod:13
25085 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
25090 #: ../fuse/guestmount.pod:17
25092 "You must I<not> use C<guestmount> in read-write mode on live virtual "
25093 "machines. If you do this, you risk disk corruption in the VM."
25097 #: ../fuse/guestmount.pod:22
25099 "The guestmount program can be used to mount virtual machine filesystems and "
25100 "other disk images on the host. It uses libguestfs for access to the guest "
25101 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
25102 "a mountable device."
25106 #: ../fuse/guestmount.pod:27
25108 "Along with other options, you have to give at least one device (I<-a> "
25109 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
25110 "option) or use the I<-i> inspection option. How this works is better "
25111 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
25116 #: ../fuse/guestmount.pod:33
25118 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
25119 "by you, and the filesystem will not be visible to any other users unless you "
25120 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
25121 "the filesystem, use the C<fusermount -u> command."
25125 #: ../fuse/guestmount.pod:41
25127 "For a typical Windows guest which has its main filesystem on the first "
25132 #: ../fuse/guestmount.pod:44
25135 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
25140 #: ../fuse/guestmount.pod:46
25142 "For a typical Linux guest which has a /boot filesystem on the first "
25143 "partition, and the root filesystem on a logical volume:"
25147 #: ../fuse/guestmount.pod:49
25150 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
25155 #: ../fuse/guestmount.pod:51
25156 msgid "To get libguestfs to detect guest mountpoints for you:"
25160 #: ../fuse/guestmount.pod:53
25163 " guestmount -a guest.img -i --ro /mnt\n"
25168 #: ../fuse/guestmount.pod:55
25169 msgid "For a libvirt guest called \"Guest\" you could do:"
25173 #: ../fuse/guestmount.pod:57
25176 " guestmount -d Guest -i --ro /mnt\n"
25181 #: ../fuse/guestmount.pod:59
25183 "If you don't know what filesystems are contained in a guest or disk image, "
25184 "use L<virt-list-filesystems(1)> first:"
25188 #: ../fuse/guestmount.pod:62
25191 " virt-list-filesystems MyGuest\n"
25196 #: ../fuse/guestmount.pod:64
25198 "If you want to trace the libguestfs calls but without excessive debugging "
25199 "information, we recommend:"
25203 #: ../fuse/guestmount.pod:67
25206 " guestmount [...] --trace /mnt\n"
25211 #: ../fuse/guestmount.pod:69
25212 msgid "If you want to debug the program, we recommend:"
25216 #: ../fuse/guestmount.pod:71
25219 " guestmount [...] --trace --verbose /mnt\n"
25224 #: ../fuse/guestmount.pod:79
25225 msgid "Add a block device or virtual machine image."
25229 #: ../fuse/guestmount.pod:96
25230 msgid "B<--dir-cache-timeout N>"
25234 #: ../fuse/guestmount.pod:98
25236 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
25237 "seconds. The readdir cache [actually, there are several semi-independent "
25238 "caches] is populated after a readdir(2) call with the stat and extended "
25239 "attributes of the files in the directory, in anticipation that they will be "
25240 "requested soon after."
25244 #: ../fuse/guestmount.pod:104
25246 "There is also a different attribute cache implemented by FUSE (see the FUSE "
25247 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
25248 "requests, only cache existing ones."
25252 #: ../fuse/guestmount.pod:122
25254 "If you have untrusted raw-format guest disk images, you should use this "
25255 "option to specify the disk format. This avoids a possible security problem "
25256 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
25257 "guestfs_add_drive_opts>."
25261 #: ../fuse/guestmount.pod:127
25262 msgid "B<--fuse-help>"
25266 #: ../fuse/guestmount.pod:129
25267 msgid "Display help on special FUSE options (see I<-o> below)."
25271 #: ../fuse/guestmount.pod:133
25272 msgid "Display brief help and exit."
25276 #: ../fuse/guestmount.pod:146
25277 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
25281 #: ../fuse/guestmount.pod:148
25283 "Mount the named partition or logical volume on the given mountpoint B<in the "
25284 "guest> (this has nothing to do with mountpoints in the host)."
25288 #: ../fuse/guestmount.pod:151
25290 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
25291 "something on C</>."
25295 #: ../fuse/guestmount.pod:156
25297 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
25298 "unmounted. If you specify this option, then we don't attempt to sync the "
25299 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
25303 #: ../fuse/guestmount.pod:161
25304 msgid "B<-o option> | B<--option option>"
25308 #: ../fuse/guestmount.pod:163
25309 msgid "Pass extra options to FUSE."
25313 #: ../fuse/guestmount.pod:165
25315 "To get a list of all the extra options supported by FUSE, use the command "
25316 "below. Note that only the FUSE I<-o> options can be passed, and only some "
25317 "of them are a good idea."
25321 #: ../fuse/guestmount.pod:169
25324 " guestmount --fuse-help\n"
25329 #: ../fuse/guestmount.pod:171
25330 msgid "Some potentially useful FUSE options:"
25334 #: ../fuse/guestmount.pod:175
25335 msgid "B<-o allow_other>"
25339 #: ../fuse/guestmount.pod:177
25340 msgid "Allow other users to see the filesystem."
25344 #: ../fuse/guestmount.pod:179
25345 msgid "B<-o attr_timeout=N>"
25349 #: ../fuse/guestmount.pod:181
25350 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
25354 #: ../fuse/guestmount.pod:183
25355 msgid "B<-o kernel_cache>"
25359 #: ../fuse/guestmount.pod:185
25361 "Allow the kernel to cache files (reduces the number of reads that have to go "
25362 "through the L<guestfs(3)> API). This is generally a good idea if you can "
25363 "afford the extra memory usage."
25367 #: ../fuse/guestmount.pod:189
25368 msgid "B<-o uid=N> B<-o gid=N>"
25372 #: ../fuse/guestmount.pod:191
25374 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
25375 "the chosen values."
25379 #: ../fuse/guestmount.pod:198
25381 "Add devices and mount everything read-only. Also disallow writes and make "
25382 "the disk appear read-only to FUSE."
25386 #: ../fuse/guestmount.pod:201
25388 "This is highly recommended if you are not going to edit the guest disk. If "
25389 "the guest is running and this option is I<not> supplied, then there is a "
25390 "strong risk of disk corruption in the guest. We try to prevent this from "
25391 "happening, but it is not always possible."
25395 #: ../fuse/guestmount.pod:206
25396 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
25400 #: ../fuse/guestmount.pod:210
25401 msgid "Enable SELinux support for the guest."
25405 #: ../fuse/guestmount.pod:214
25406 msgid "Enable verbose messages from underlying libguestfs."
25410 #: ../fuse/guestmount.pod:218
25411 msgid "Display the program version and exit."
25415 #: ../fuse/guestmount.pod:222
25417 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
25418 "FOR READ AND WRITE>."
25422 #: ../fuse/guestmount.pod:225
25423 msgid "B<-x> | B<--trace>"
25427 #: ../fuse/guestmount.pod:227
25428 msgid "Trace libguestfs calls."
25432 #: ../fuse/guestmount.pod:229
25433 msgid "This also stops the daemon from forking into the background."
25437 #: ../fuse/guestmount.pod:235
25439 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
25440 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
25445 #: ../inspector/virt-inspector.pl:35
25447 "virt-inspector - Display operating system version and other information "
25448 "about a virtual machine"
25452 #: ../inspector/virt-inspector.pl:39
25455 " virt-inspector [--connect URI] domname\n"
25460 #: ../inspector/virt-inspector.pl:41
25463 " virt-inspector guest.img [guest.img ...]\n"
25468 #: ../inspector/virt-inspector.pl:45
25470 "B<virt-inspector> examines a virtual machine or disk image and tries to "
25471 "determine the version of the operating system and other information about "
25472 "the virtual machine."
25476 #: ../inspector/virt-inspector.pl:49
25477 msgid "Virt-inspector produces XML output for feeding into other programs."
25481 #: ../inspector/virt-inspector.pl:51
25483 "In the normal usage, use C<virt-inspector domname> where C<domname> is the "
25484 "libvirt domain (see: C<virsh list --all>)."
25488 #: ../inspector/virt-inspector.pl:54
25490 "You can also run virt-inspector directly on disk images from a single "
25491 "virtual machine. Use C<virt-inspector guest.img>. In rare cases a domain "
25492 "has several block devices, in which case you should list them one after "
25493 "another, with the first corresponding to the guest's C</dev/sda>, the second "
25494 "to the guest's C</dev/sdb> and so on."
25498 #: ../inspector/virt-inspector.pl:60
25500 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
25501 "inspect several virtual machines, you have to run virt-inspector several "
25502 "times (for example, from a shell script for-loop)."
25506 #: ../inspector/virt-inspector.pl:65
25508 "Because virt-inspector needs direct access to guest images, it won't "
25509 "normally work over remote libvirt connections."
25513 #: ../inspector/virt-inspector.pl:78 ../tools/virt-edit.pl:82
25514 #: ../tools/virt-win-reg.pl:181 ../tools/virt-df.pl:81 ../tools/virt-ls.pl:88
25515 #: ../tools/virt-list-filesystems.pl:60 ../tools/virt-tar.pl:108
25516 #: ../tools/virt-rescue.pl:113 ../tools/virt-make-fs.pl:163
25517 #: ../tools/virt-list-partitions.pl:61
25518 msgid "Display brief help."
25522 #: ../inspector/virt-inspector.pl:84 ../tools/virt-edit.pl:88
25523 #: ../tools/virt-win-reg.pl:187 ../tools/virt-df.pl:87 ../tools/virt-ls.pl:94
25524 #: ../tools/virt-resize.pl:273 ../tools/virt-list-filesystems.pl:66
25525 #: ../tools/virt-tar.pl:114 ../tools/virt-rescue.pl:119
25526 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:67
25527 msgid "B<--version>"
25531 #: ../inspector/virt-inspector.pl:86 ../tools/virt-edit.pl:90
25532 #: ../tools/virt-win-reg.pl:189 ../tools/virt-df.pl:89 ../tools/virt-ls.pl:96
25533 #: ../tools/virt-resize.pl:275 ../tools/virt-list-filesystems.pl:68
25534 #: ../tools/virt-tar.pl:116 ../tools/virt-rescue.pl:121
25535 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:69
25536 msgid "Display version number and exit."
25540 #: ../inspector/virt-inspector.pl:92 ../tools/virt-edit.pl:112
25541 #: ../tools/virt-win-reg.pl:203 ../tools/virt-df.pl:95 ../tools/virt-ls.pl:102
25542 #: ../tools/virt-list-filesystems.pl:74 ../tools/virt-tar.pl:122
25543 #: ../tools/virt-rescue.pl:135 ../tools/virt-list-partitions.pl:75
25544 msgid "B<--connect URI> | B<-c URI>"
25548 #: ../inspector/virt-inspector.pl:94 ../tools/virt-edit.pl:114
25549 #: ../tools/virt-win-reg.pl:205 ../tools/virt-df.pl:97 ../tools/virt-ls.pl:104
25550 #: ../tools/virt-list-filesystems.pl:76 ../tools/virt-tar.pl:124
25551 #: ../tools/virt-rescue.pl:137 ../tools/virt-list-partitions.pl:77
25553 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
25554 "to the default libvirt hypervisor."
25558 #: ../inspector/virt-inspector.pl:97
25560 "Libvirt is only used if you specify a C<domname> on the command line. If "
25561 "you specify guest block devices directly, then libvirt is not used at all."
25565 #: ../inspector/virt-inspector.pl:105 ../tools/virt-edit.pl:124
25566 #: ../tools/virt-win-reg.pl:215 ../tools/virt-df.pl:117
25567 #: ../tools/virt-ls.pl:114 ../tools/virt-resize.pl:523
25568 #: ../tools/virt-list-filesystems.pl:86 ../tools/virt-tar.pl:134
25569 #: ../tools/virt-rescue.pl:147 ../tools/virt-list-partitions.pl:87
25570 msgid "B<--format> raw"
25574 #: ../inspector/virt-inspector.pl:107 ../tools/virt-edit.pl:126
25575 #: ../tools/virt-win-reg.pl:217 ../tools/virt-df.pl:119
25576 #: ../tools/virt-ls.pl:116 ../tools/virt-list-filesystems.pl:88
25577 #: ../tools/virt-tar.pl:136 ../tools/virt-rescue.pl:149
25578 #: ../tools/virt-list-partitions.pl:89
25580 "Specify the format of disk images given on the command line. If this is "
25581 "omitted then the format is autodetected from the content of the disk image."
25585 #: ../inspector/virt-inspector.pl:111 ../tools/virt-edit.pl:130
25586 #: ../tools/virt-win-reg.pl:221 ../tools/virt-df.pl:123
25587 #: ../tools/virt-ls.pl:120 ../tools/virt-list-filesystems.pl:92
25588 #: ../tools/virt-tar.pl:140 ../tools/virt-rescue.pl:153
25589 #: ../tools/virt-list-partitions.pl:93
25591 "If disk images are requested from libvirt, then this program asks libvirt "
25592 "for this information. In this case, the value of the format parameter is "
25597 #: ../inspector/virt-inspector.pl:115 ../tools/virt-edit.pl:134
25598 #: ../tools/virt-win-reg.pl:225 ../tools/virt-df.pl:127
25599 #: ../tools/virt-ls.pl:124 ../tools/virt-resize.pl:528
25600 #: ../tools/virt-resize.pl:543 ../tools/virt-list-filesystems.pl:96
25601 #: ../tools/virt-tar.pl:144 ../tools/virt-rescue.pl:157
25602 #: ../tools/virt-list-partitions.pl:97
25604 "If working with untrusted raw-format guest disk images, you should ensure "
25605 "the format is always specified."
25609 #: ../inspector/virt-inspector.pl:149
25614 #: ../inspector/virt-inspector.pl:151
25616 "The virt-inspector XML is described precisely in a RELAX NG schema which is "
25617 "supplied with libguestfs. This section is just an overview."
25621 #: ../inspector/virt-inspector.pl:154
25623 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
25624 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
25625 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
25626 "which is vanishingly rare in real world VMs."
25630 #: ../inspector/virt-inspector.pl:159
25631 msgid "E<lt>operatingsystemE<gt>"
25635 #: ../inspector/virt-inspector.pl:161
25637 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
25638 "describe the operating system, its architecture, the descriptive \"product "
25639 "name\" string, the type of OS and so on, as in this example:"
25643 #: ../inspector/virt-inspector.pl:165
25646 " <operatingsystems>\n"
25647 " <operatingsystem>\n"
25648 " <root>/dev/sda2</root>\n"
25649 " <name>windows</name>\n"
25650 " <arch>i386</arch>\n"
25651 " <distro>windows</distro>\n"
25652 " <product_name>Windows 7 Enterprise</product_name>\n"
25653 " <major_version>6</major_version>\n"
25654 " <minor_version>1</minor_version>\n"
25655 " <windows_systemroot>/Windows</windows_systemroot>\n"
25660 #: ../inspector/virt-inspector.pl:176
25662 "These fields are derived from the libguestfs inspection API, and you can "
25663 "find more details in L<guestfs(3)/INSPECTION>."
25667 #: ../inspector/virt-inspector.pl:179
25669 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
25670 "of view of libguestfs (block devices may have completely different names "
25671 "inside the VM itself)."
25675 #: ../inspector/virt-inspector.pl:240
25676 msgid "E<lt>mountpointsE<gt>"
25680 #: ../inspector/virt-inspector.pl:242
25682 "Un*x-like guests typically have multiple filesystems which are mounted at "
25683 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
25684 "element which looks like this:"
25688 #: ../inspector/virt-inspector.pl:246
25691 " <operatingsystems>\n"
25692 " <operatingsystem>\n"
25695 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
25696 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
25697 " </mountpoints>\n"
25702 #: ../inspector/virt-inspector.pl:254
25704 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
25705 "and may have completely different names inside the guest. Only mountable "
25706 "filesystems appear in this list, not things like swap devices."
25710 #: ../inspector/virt-inspector.pl:276
25711 msgid "E<lt>filesystemsE<gt>"
25715 #: ../inspector/virt-inspector.pl:278
25717 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
25718 "filesystems belonging to the guest, including swap and empty partitions. "
25719 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
25720 "this OS or shared by this OS and other OSes)."
25724 #: ../inspector/virt-inspector.pl:283
25725 msgid "You might see something like this:"
25729 #: ../inspector/virt-inspector.pl:285
25732 " <operatingsystems>\n"
25733 " <operatingsystem>\n"
25736 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
25737 " <type>ext4</type>\n"
25738 " <label>Fedora-13-x86_64</label>\n"
25739 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
25745 #: ../inspector/virt-inspector.pl:295
25747 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
25748 "the label, and the UUID."
25752 #: ../inspector/virt-inspector.pl:337
25753 msgid "E<lt>applicationsE<gt>"
25757 #: ../inspector/virt-inspector.pl:339
25759 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
25760 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
25761 "machine. At the moment we are only able to list RPMs and Debian packages "
25762 "installed, but in future we will support other Linux distros and Windows."
25766 #: ../inspector/virt-inspector.pl:345
25768 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
25769 "Typical values would be C<rpm> and C<deb>."
25773 #: ../inspector/virt-inspector.pl:348
25775 "E<lt>package_managementE<gt>, if present, describes the package manager. "
25776 "Typical values include C<yum>, C<up2date> and C<apt>"
25780 #: ../inspector/virt-inspector.pl:351
25781 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
25785 #: ../inspector/virt-inspector.pl:354
25788 " <operatingsystems>\n"
25789 " <operatingsystem>\n"
25791 " <applications>\n"
25793 " <name>coreutils</name>\n"
25794 " <version>8.5</version>\n"
25795 " <release>1</release>\n"
25796 " </application>\n"
25801 #: ../inspector/virt-inspector.pl:364
25803 "(The version and release fields may not be available for some package types)."
25807 #: ../inspector/virt-inspector.pl:510
25808 msgid "USING XPATH"
25812 #: ../inspector/virt-inspector.pl:512
25814 "You can use the XPath query language, and/or the xpath tool, in order to "
25815 "select parts of the XML."
25819 #: ../inspector/virt-inspector.pl:517
25822 " $ virt-inspector Guest | xpath //filesystems\n"
25823 " Found 1 nodes:\n"
25826 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
25827 " <type>ext4</type>\n"
25833 #: ../inspector/virt-inspector.pl:525
25836 " $ virt-inspector Guest | \\\n"
25837 " xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
25838 " Query didn't return a nodeset. Value: ext4\n"
25843 #: ../inspector/virt-inspector.pl:529 ../tools/virt-edit.pl:343
25844 #: ../tools/virt-win-reg.pl:141 ../tools/virt-win-reg.pl:477
25845 #: ../tools/virt-df.pl:633 ../tools/virt-ls.pl:225
25846 #: ../tools/virt-resize.pl:1479 ../tools/virt-list-filesystems.pl:179
25847 #: ../tools/virt-tar.pl:274 ../tools/virt-rescue.pl:260
25848 #: ../tools/virt-make-fs.pl:527 ../tools/virt-list-partitions.pl:247
25849 msgid "SHELL QUOTING"
25853 #: ../inspector/virt-inspector.pl:531 ../tools/virt-edit.pl:345
25854 #: ../tools/virt-win-reg.pl:479 ../tools/virt-df.pl:635
25855 #: ../tools/virt-ls.pl:227 ../tools/virt-resize.pl:1481
25856 #: ../tools/virt-list-filesystems.pl:181 ../tools/virt-tar.pl:276
25857 #: ../tools/virt-rescue.pl:262 ../tools/virt-make-fs.pl:529
25858 #: ../tools/virt-list-partitions.pl:249
25860 "Libvirt guest names can contain arbitrary characters, some of which have "
25861 "meaning to the shell such as C<#> and space. You may need to quote or "
25862 "escape these characters on the command line. See the shell manual page L<sh"
25863 "(1)> for details."
25867 #: ../inspector/virt-inspector.pl:538
25869 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
25870 "L<Sys::Virt(3)>, L<http://www.w3.org/TR/xpath/>, L<http://libguestfs.org/>."
25874 #: ../inspector/virt-inspector.pl:552 ../tools/virt-edit.pl:364
25875 #: ../tools/virt-win-reg.pl:512 ../tools/virt-df.pl:651
25876 #: ../tools/virt-ls.pl:245 ../tools/virt-resize.pl:1510
25877 #: ../tools/virt-list-filesystems.pl:200 ../tools/virt-tar.pl:294
25878 #: ../tools/virt-rescue.pl:279 ../tools/virt-make-fs.pl:561
25879 #: ../tools/virt-list-partitions.pl:267
25880 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
25884 #: ../inspector/virt-inspector.pl:556
25885 msgid "Matthew Booth L<mbooth@redhat.com>"
25889 #: ../inspector/virt-inspector.pl:562 ../tools/virt-win-reg.pl:516
25890 #: ../tools/virt-resize.pl:1514 ../tools/virt-make-fs.pl:565
25891 msgid "Copyright (C) 2010 Red Hat Inc."
25895 #: ../tools/virt-edit.pl:34
25896 msgid "virt-edit - Edit a file in a virtual machine"
25900 #: ../tools/virt-edit.pl:38
25903 " virt-edit [--options] domname file\n"
25908 #: ../tools/virt-edit.pl:40
25911 " virt-edit [--options] disk.img [disk.img ...] file\n"
25916 #: ../tools/virt-edit.pl:42
25919 " virt-edit [domname|disk.img] file -e 'expr'\n"
25924 #: ../tools/virt-edit.pl:46
25926 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
25927 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
25928 "doing this, but doesn't catch all cases."
25932 #: ../tools/virt-edit.pl:52
25934 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
25935 "the named virtual machine (or disk image)."
25939 #: ../tools/virt-edit.pl:55
25941 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
25942 "you should look at the L<guestfish(1)> tool."
25946 #: ../tools/virt-edit.pl:60
25947 msgid "Edit the named files interactively:"
25951 #: ../tools/virt-edit.pl:62
25954 " virt-edit mydomain /boot/grub/grub.conf\n"
25959 #: ../tools/virt-edit.pl:64
25962 " virt-edit mydomain /etc/passwd\n"
25967 #: ../tools/virt-edit.pl:66
25969 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
25970 "below). To change the init default level to 5:"
25974 #: ../tools/virt-edit.pl:70
25977 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
25982 #: ../tools/virt-edit.pl:96
25983 msgid "B<--backup extension> | B<-b extension>"
25987 #: ../tools/virt-edit.pl:98
25989 "Create a backup of the original file I<in the guest disk image>. The backup "
25990 "has the original filename with C<extension> added."
25994 #: ../tools/virt-edit.pl:101
25996 "Usually the first character of C<extension> would be a dot C<.> so you would "
26001 #: ../tools/virt-edit.pl:104
26004 " virt-edit -b .orig [etc]\n"
26009 #: ../tools/virt-edit.pl:106
26010 msgid "By default, no backup file is made."
26014 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:208
26015 #: ../tools/virt-df.pl:100 ../tools/virt-ls.pl:107
26016 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:127
26017 #: ../tools/virt-rescue.pl:140 ../tools/virt-list-partitions.pl:80
26019 "If you specify guest block devices directly, then libvirt is not used at all."
26023 #: ../tools/virt-edit.pl:141
26024 msgid "B<--expr EXPR> | B<-e EXPR>"
26028 #: ../tools/virt-edit.pl:143
26030 "Instead of launching the external editor, non-interactively apply the Perl "
26031 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
26036 #: ../tools/virt-edit.pl:147
26038 "Be careful to properly quote the expression to prevent it from being altered "
26043 #: ../tools/virt-edit.pl:268
26044 msgid "NON-INTERACTIVE EDITING"
26048 #: ../tools/virt-edit.pl:270
26050 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
26051 "administrator can interactively edit the file."
26055 #: ../tools/virt-edit.pl:273
26057 "There are two ways also to use C<virt-edit> from scripts in order to make "
26058 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
26059 "like this, it's less error-prone to write scripts directly using the "
26060 "libguestfs API and Augeas for configuration file editing.)"
26064 #: ../tools/virt-edit.pl:279
26066 "The first method is to temporarily set C<$EDITOR> to any script or program "
26067 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
26068 "update C<tmpfile> in place however it likes."
26072 #: ../tools/virt-edit.pl:283
26074 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
26075 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
26076 "instances of C<foo> with C<bar> in a file:"
26080 #: ../tools/virt-edit.pl:287
26083 " virt-edit domname filename -e 's/foo/bar/'\n"
26088 #: ../tools/virt-edit.pl:289
26090 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
26091 "For example to delete root's password you could do:"
26095 #: ../tools/virt-edit.pl:292
26098 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
26103 #: ../tools/virt-edit.pl:294
26105 "What really happens is that the snippet is evaluated as a Perl expression "
26106 "for each line of the file. The line, including the final C<\\n>, is passed "
26107 "in C<$_> and the expression should update C<$_> or leave it unchanged."
26111 #: ../tools/virt-edit.pl:299
26113 "To delete a line, set C<$_> to the empty string. For example, to delete the "
26114 "C<apache> user account from the password file you can do:"
26118 #: ../tools/virt-edit.pl:302
26121 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
26126 #: ../tools/virt-edit.pl:304
26128 "To insert a line, prepend or append it to C<$_>. However appending lines to "
26129 "the end of the file is rather difficult this way since there is no concept "
26130 "of \"last line of the file\" - your expression just doesn't get called "
26131 "again. You might want to use the first method (setting C<$EDITOR>) if you "
26136 #: ../tools/virt-edit.pl:310
26138 "The variable C<$lineno> contains the current line number. As is "
26139 "traditional, the first line in the file is number C<1>."
26143 #: ../tools/virt-edit.pl:313
26145 "The return value from the expression is ignored, but the expression may call "
26146 "C<die> in order to abort the whole program, leaving the original file "
26151 #: ../tools/virt-edit.pl:317
26153 "Remember when matching the end of a line that C<$_> may contain the final C<"
26154 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
26155 "newline then neither of these. Thus to match or substitute some text at the "
26156 "end of a line, use this regular expression:"
26160 #: ../tools/virt-edit.pl:322
26163 " /some text(\\r?\\n)?$/\n"
26168 #: ../tools/virt-edit.pl:324
26170 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
26171 "$_> itself (since that would remove all newlines from the file):"
26175 #: ../tools/virt-edit.pl:328
26178 " my $m = $_; chomp $m; $m =~ /some text$/\n"
26183 #: ../tools/virt-edit.pl:334
26188 #: ../tools/virt-edit.pl:336
26190 "If set, this string is used as the editor. It may contain arguments, eg. C<"
26195 #: ../tools/virt-edit.pl:339
26196 msgid "If not set, C<vi> is used."
26200 #: ../tools/virt-edit.pl:352
26202 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
26203 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, "
26208 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:510
26209 #: ../tools/virt-df.pl:649 ../tools/virt-ls.pl:243
26210 #: ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:198
26211 #: ../tools/virt-tar.pl:292 ../tools/virt-rescue.pl:277
26212 #: ../tools/virt-make-fs.pl:559 ../tools/virt-list-partitions.pl:265
26217 #: ../tools/virt-edit.pl:368 ../tools/virt-df.pl:655
26218 #: ../tools/virt-rescue.pl:283 ../tools/virt-list-partitions.pl:271
26219 msgid "Copyright (C) 2009-2010 Red Hat Inc."
26223 #: ../tools/virt-win-reg.pl:37
26225 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
26229 #: ../tools/virt-win-reg.pl:41
26232 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
26237 #: ../tools/virt-win-reg.pl:43
26240 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
26245 #: ../tools/virt-win-reg.pl:45
26248 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
26253 #: ../tools/virt-win-reg.pl:47
26256 " virt-win-reg --merge domname [input.reg ...]\n"
26261 #: ../tools/virt-win-reg.pl:49
26264 " virt-win-reg [--options] disk.img ... # instead of domname\n"
26269 #: ../tools/virt-win-reg.pl:53
26271 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
26272 "virtual machines. If you do this, you I<will> get irreversible disk "
26273 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
26274 "but doesn't catch all cases."
26278 #: ../tools/virt-win-reg.pl:58
26280 "Modifying the Windows Registry is an inherently risky operation. The format "
26281 "is deliberately obscure and undocumented, and Registry changes can leave the "
26282 "system unbootable. Therefore when using the C<--merge> option, make sure "
26283 "you have a reliable backup first."
26287 #: ../tools/virt-win-reg.pl:65
26289 "This program can export and merge Windows Registry entries from a Windows "
26294 #: ../tools/virt-win-reg.pl:68
26296 "The first parameter is the libvirt guest name or the raw disk image of a "
26301 #: ../tools/virt-win-reg.pl:71
26303 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
26304 "exported (recursively). For example:"
26308 #: ../tools/virt-win-reg.pl:74
26311 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
26316 #: ../tools/virt-win-reg.pl:76
26318 "You can also display single values from within registry keys, for example:"
26322 #: ../tools/virt-win-reg.pl:79
26325 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
26326 " $ virt-win-reg Windows7 $cvkey ProductName\n"
26327 " Windows 7 Enterprise\n"
26332 #: ../tools/virt-win-reg.pl:83
26334 "With C<--merge>, you can merge a textual regedit file into the Windows "
26339 #: ../tools/virt-win-reg.pl:86
26342 " $ virt-win-reg --merge Windows7 changes.reg\n"
26347 #: ../tools/virt-win-reg.pl:88
26348 msgid "SUPPORTED SYSTEMS"
26352 #: ../tools/virt-win-reg.pl:90
26354 "The program currently supports Windows NT-derived guests starting with "
26355 "Windows XP through to at least Windows 7."
26359 #: ../tools/virt-win-reg.pl:93
26361 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
26362 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
26363 "and C<HKEY_USERS\\.DEFAULT>."
26367 #: ../tools/virt-win-reg.pl:97
26369 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
26374 #: ../tools/virt-win-reg.pl:100
26376 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
26381 #: ../tools/virt-win-reg.pl:103
26386 #: ../tools/virt-win-reg.pl:105
26388 "This program is only meant for simple access to the registry. If you want "
26389 "to do complicated things with the registry, we suggest you download the "
26390 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
26391 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
26392 "L<hivexregedit(1)>."
26396 #: ../tools/virt-win-reg.pl:111
26401 #: ../tools/virt-win-reg.pl:113
26403 "C<virt-win-reg> expects that regedit files have already been reencoded in "
26404 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
26405 "style line endings. Since Windows regedit files are often in UTF-16LE with "
26406 "Windows-style line endings, you may need to reencode the whole file before "
26407 "or after processing."
26411 #: ../tools/virt-win-reg.pl:119
26413 "To reencode a file from Windows format to Linux (before processing it with "
26414 "the C<--merge> option), you would do something like this:"
26418 #: ../tools/virt-win-reg.pl:122
26421 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
26426 #: ../tools/virt-win-reg.pl:124
26428 "To go in the opposite direction, after exporting and before sending the file "
26429 "to a Windows user, do something like this:"
26433 #: ../tools/virt-win-reg.pl:127
26436 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
26441 #: ../tools/virt-win-reg.pl:129
26442 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
26446 #: ../tools/virt-win-reg.pl:131
26448 "If you are unsure about the current encoding, use the L<file(1)> command. "
26449 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
26450 "style (CRLF) line endings, like this:"
26454 #: ../tools/virt-win-reg.pl:135
26457 " $ file software.reg\n"
26458 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
26459 " with CRLF line terminators\n"
26464 #: ../tools/virt-win-reg.pl:139
26465 msgid "This file would need conversion before you could C<--merge> it."
26469 #: ../tools/virt-win-reg.pl:143
26471 "Be careful when passing parameters containing C<\\> (backslash) in the "
26472 "shell. Usually you will have to use 'single quotes' or double backslashes "
26473 "(but not both) to protect them from the shell."
26477 #: ../tools/virt-win-reg.pl:147
26478 msgid "Paths and value names are case-insensitive."
26482 #: ../tools/virt-win-reg.pl:149
26483 msgid "CurrentControlSet etc."
26487 #: ../tools/virt-win-reg.pl:151
26489 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
26490 "Registry at the level of the hive file, and therefore you cannot modify "
26495 #: ../tools/virt-win-reg.pl:155
26497 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
26498 "circumstances it might refer to another control set. The way to find out is "
26499 "to look at the C<HKLM\\SYSTEM\\Select> key:"
26503 #: ../tools/virt-win-reg.pl:159
26506 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
26507 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
26508 " \"Current\"=dword:00000001\n"
26509 " \"Default\"=dword:00000001\n"
26510 " \"Failed\"=dword:00000000\n"
26511 " \"LastKnownGood\"=dword:00000002\n"
26516 #: ../tools/virt-win-reg.pl:166
26517 msgid "\"Current\" is the one which Windows will choose when it boots."
26521 #: ../tools/virt-win-reg.pl:168
26523 "Similarly, other C<Current...> keys in the path may need to be replaced."
26527 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
26532 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:501
26533 msgid "Enable debugging messages."
26537 #: ../tools/virt-win-reg.pl:232
26542 #: ../tools/virt-win-reg.pl:234
26544 "In merge mode, this merges a textual regedit file into the Windows Registry "
26545 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
26546 "displays or exports Registry entries instead."
26550 #: ../tools/virt-win-reg.pl:238
26552 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
26553 "result in disk corruption. However exporting (without this flag) is always "
26558 #: ../tools/virt-win-reg.pl:246
26559 msgid "B<--encoding> UTF-16LE|ASCII"
26563 #: ../tools/virt-win-reg.pl:248
26565 "When merging (only), you may need to specify the encoding for strings to be "
26566 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
26567 "(3)/ENCODING STRINGS>."
26571 #: ../tools/virt-win-reg.pl:252
26573 "The default is to use UTF-16LE, which should work with recent versions of "
26578 #: ../tools/virt-win-reg.pl:486
26580 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
26581 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
26582 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26586 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
26588 "When reporting bugs, please enable debugging and capture the I<complete> "
26593 #: ../tools/virt-win-reg.pl:504
26596 " export LIBGUESTFS_DEBUG=1\n"
26597 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
26602 #: ../tools/virt-win-reg.pl:507
26604 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
26609 #: ../tools/virt-df.pl:36
26610 msgid "virt-df - Display free space on virtual filesystems"
26614 #: ../tools/virt-df.pl:40
26617 " virt-df [--options]\n"
26622 #: ../tools/virt-df.pl:42
26625 " virt-df [--options] domname\n"
26630 #: ../tools/virt-df.pl:44
26633 " virt-df [--options] disk.img [disk.img ...]\n"
26638 #: ../tools/virt-df.pl:48
26640 "C<virt-df> is a command line tool to display free space on virtual machine "
26641 "filesystems. Unlike other tools, it doesn't just display the amount of "
26642 "space allocated to a virtual machine, but can look inside the virtual "
26643 "machine to see how much space is really being used."
26647 #: ../tools/virt-df.pl:53
26649 "It is like the L<df(1)> command, but for virtual machines, except that it "
26650 "also works for Windows virtual machines."
26654 #: ../tools/virt-df.pl:56
26656 "If used without any arguments, C<virt-df> checks with libvirt to get a list "
26657 "of all active and inactive guests, and performs a C<df>-type operation on "
26658 "each one in turn, printing out the results."
26662 #: ../tools/virt-df.pl:60
26664 "If used with any argument(s), C<virt-df> performs a C<df>-type operation on "
26665 "either the single named libvirt domain, or on the disk image(s) listed on "
26666 "the command line (which must all belong to a single VM). In this mode (with "
26667 "arguments), C<virt-df> will I<only work for a single guest>. If you want to "
26668 "run on multiple guests, then you have to invoke C<virt-df> multiple times."
26672 #: ../tools/virt-df.pl:67
26674 "Use the C<--csv> option to get a format which can be easily parsed by other "
26675 "programs. Other options are mostly similar to standard C<df> options. See "
26676 "below for the complete list."
26680 #: ../tools/virt-df.pl:107
26685 #: ../tools/virt-df.pl:109
26687 "Write out the results in CSV format (comma-separated values). This format "
26688 "can be imported easily into databases and spreadsheets, but read L</NOTE "
26689 "ABOUT CSV FORMAT> below."
26693 #: ../tools/virt-df.pl:134
26694 msgid "B<--human-readable> | B<-h>"
26698 #: ../tools/virt-df.pl:136
26699 msgid "Print sizes in human-readable format."
26703 #: ../tools/virt-df.pl:138
26704 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
26708 #: ../tools/virt-df.pl:144
26709 msgid "B<--inodes> | B<-i>"
26713 #: ../tools/virt-df.pl:146
26714 msgid "Print inodes instead of blocks."
26718 #: ../tools/virt-df.pl:152
26719 msgid "B<--one-per-guest>"
26723 #: ../tools/virt-df.pl:154
26725 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
26726 "disks from several guests to a single libguestfs appliance."
26730 #: ../tools/virt-df.pl:157
26731 msgid "You might use this option in the following circumstances:"
26735 #: ../tools/virt-df.pl:163
26737 "If you think an untrusted guest might actively try to exploit the libguestfs "
26738 "appliance kernel, then this prevents one guest from interfering with the "
26739 "stats printed for another guest."
26743 #: ../tools/virt-df.pl:169
26745 "If the kernel has a bug which stops it from accessing a filesystem in one "
26746 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
26747 "and report stats for further guests."
26751 #: ../tools/virt-df.pl:180
26756 #: ../tools/virt-df.pl:182
26758 "Print UUIDs instead of names. This is useful for following a guest even "
26759 "when the guest is migrated or renamed, or when two guests happen to have the "
26764 #: ../tools/virt-df.pl:186
26766 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
26767 "images, we still print the disk image name even when this option is "
26772 #: ../tools/virt-df.pl:609
26773 msgid "NOTE ABOUT CSV FORMAT"
26777 #: ../tools/virt-df.pl:611
26779 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
26780 "should be easy to parse, but it is definitely not easy to parse."
26784 #: ../tools/virt-df.pl:614
26786 "Myth: Just split fields at commas. Reality: This does I<not> work "
26787 "reliably. This example has two columns:"
26791 #: ../tools/virt-df.pl:617
26794 " \"foo,bar\",baz\n"
26799 #: ../tools/virt-df.pl:619
26801 "Myth: Read the file one line at a time. Reality: This does I<not> work "
26802 "reliably. This example has one row:"
26806 #: ../tools/virt-df.pl:622
26815 #: ../tools/virt-df.pl:625
26817 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
26818 "packaged in major Linux distributions)."
26822 #: ../tools/virt-df.pl:628
26824 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
26825 "or Python's built-in csv library)."
26829 #: ../tools/virt-df.pl:631
26830 msgid "Most spreadsheets and databases can import CSV directly."
26834 #: ../tools/virt-df.pl:642
26836 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
26837 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26841 #: ../tools/virt-ls.pl:34
26842 msgid "virt-ls - List files in a virtual machine"
26846 #: ../tools/virt-ls.pl:38
26849 " virt-ls [--options] domname directory\n"
26854 #: ../tools/virt-ls.pl:40
26857 " virt-ls [--options] disk.img [disk.img ...] directory\n"
26862 #: ../tools/virt-ls.pl:44
26864 "C<virt-ls> is a command line tool to list the names of files in a directory "
26865 "inside a virtual machine or disk image."
26869 #: ../tools/virt-ls.pl:47
26871 "C<virt-ls> is just a simple wrapper around L<libguestfs(3)> functionality. "
26872 "For more complex cases you should look at the L<guestfish(1)> tool."
26876 #: ../tools/virt-ls.pl:51
26878 "C<virt-ls> can be used in one of three modes: simple, long and recursive. A "
26879 "simple listing is like the ordinary L<ls(1)> command:"
26883 #: ../tools/virt-ls.pl:54
26886 " $ virt-ls myguest /\n"
26894 #: ../tools/virt-ls.pl:59
26895 msgid "With the C<-l> (C<--long>) option, C<virt-ls> shows more detail:"
26899 #: ../tools/virt-ls.pl:61
26902 " $ virt-ls -l myguest /\n"
26904 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
26905 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
26911 #: ../tools/virt-ls.pl:67
26913 "With the C<-R> (C<--recursive>) option, C<virt-ls> lists the names of files "
26914 "and directories recursively:"
26918 #: ../tools/virt-ls.pl:70
26921 " $ virt-ls -R myguest /tmp\n"
26929 #: ../tools/virt-ls.pl:75
26931 "You I<cannot> combine these options. To do more complicated things, use "
26936 #: ../tools/virt-ls.pl:131 ../tools/virt-list-filesystems.pl:103
26937 #: ../tools/virt-list-partitions.pl:112
26938 msgid "B<-l> | B<--long>"
26942 #: ../tools/virt-ls.pl:133
26943 msgid "B<-R> | B<--recursive>"
26947 #: ../tools/virt-ls.pl:135
26949 "Select the mode. With neither of these options, C<virt-ls> produces a "
26950 "simple, flat list of the files in the named directory."
26954 #: ../tools/virt-ls.pl:138
26956 "C<virt-ls -l> produces a \"long listing\", which shows more detail (just "
26957 "like the plain C<ls -l> command)."
26961 #: ../tools/virt-ls.pl:141
26963 "C<virt-ls -R> produces a recursive list of files starting at the named "
26964 "directory. See the documentation for L<guestfs(3)/guestfs_find> for precise "
26969 #: ../tools/virt-ls.pl:145
26970 msgid "You cannot combine these options."
26974 #: ../tools/virt-ls.pl:234
26976 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<Sys::"
26977 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
26982 #: ../tools/virt-ls.pl:249 ../tools/virt-list-filesystems.pl:204
26983 #: ../tools/virt-tar.pl:298
26984 msgid "Copyright (C) 2009 Red Hat Inc."
26988 #: ../tools/virt-resize.pl:42
26989 msgid "virt-resize - Resize a virtual machine disk"
26993 #: ../tools/virt-resize.pl:46
26996 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
26997 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
26998 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
27003 #: ../tools/virt-resize.pl:52
27005 "Virt-resize is a tool which can resize a virtual machine disk, making it "
27006 "larger or smaller overall, and resizing or deleting any partitions contained "
27011 #: ../tools/virt-resize.pl:56
27013 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
27014 "not> be used on live virtual machines - for consistent results, shut the "
27015 "virtual machine down before resizing it."
27019 #: ../tools/virt-resize.pl:60
27021 "If you are not familiar with the associated tools: L<virt-list-partitions(1)"
27022 ">, L<virt-list-filesystems(1)> and L<virt-df(1)>, we recommend you go and "
27023 "read those manual pages first."
27027 #: ../tools/virt-resize.pl:68
27029 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
27030 "fill the extra 5GB of space."
27034 #: ../tools/virt-resize.pl:71
27037 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
27038 " virt-list-partitions -lht olddisk\n"
27039 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
27040 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
27045 #: ../tools/virt-resize.pl:76
27047 "As above, but make the /boot partition 200MB bigger, while giving the "
27048 "remaining space to /dev/sda2:"
27052 #: ../tools/virt-resize.pl:79
27055 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
27060 #: ../tools/virt-resize.pl:81
27061 msgid "As above, but the output format will be uncompressed qcow2:"
27065 #: ../tools/virt-resize.pl:83
27068 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
27069 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
27074 #: ../tools/virt-resize.pl:86
27075 msgid "DETAILED USAGE"
27079 #: ../tools/virt-resize.pl:88
27080 msgid "EXPANDING A VIRTUAL MACHINE DISK"
27084 #: ../tools/virt-resize.pl:92
27085 msgid "1. Shut down the virtual machine"
27089 #: ../tools/virt-resize.pl:94
27090 msgid "2. Locate input disk image"
27094 #: ../tools/virt-resize.pl:96
27096 "Locate the input disk image (ie. the file or device on the host containing "
27097 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
27098 "dumpxml> like this to find the disk image name:"
27102 #: ../tools/virt-resize.pl:100
27105 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
27106 " Found 1 nodes:\n"
27108 " <source dev=\"/dev/vg/lv_guest\" />\n"
27113 #: ../tools/virt-resize.pl:105
27114 msgid "3. Look at current sizing"
27118 #: ../tools/virt-resize.pl:107
27120 "Use L<virt-list-partitions(1)> to display the current partitions and sizes:"
27124 #: ../tools/virt-resize.pl:110
27127 " # virt-list-partitions -lht /dev/vg/lv_guest\n"
27128 " /dev/sda1 ext3 101.9M\n"
27129 " /dev/sda2 pv 7.9G\n"
27130 " /dev/sda device 8.0G\n"
27135 #: ../tools/virt-resize.pl:115
27137 "(This example is a virtual machine with an 8 GB disk which we would like to "
27138 "expand up to 10 GB)."
27142 #: ../tools/virt-resize.pl:118
27143 msgid "4. Create output disk"
27147 #: ../tools/virt-resize.pl:120
27149 "Virt-resize cannot do in-place disk modifications. You have to have space "
27150 "to store the resized output disk."
27154 #: ../tools/virt-resize.pl:123
27156 "To store the resized disk image in a file, create a file of a suitable size:"
27160 #: ../tools/virt-resize.pl:126
27163 " # rm -f outdisk\n"
27164 " # truncate -s 10G outdisk\n"
27169 #: ../tools/virt-resize.pl:129
27170 msgid "Or use L<lvcreate(1)> to create a logical volume:"
27174 #: ../tools/virt-resize.pl:131
27177 " # lvcreate -L 10G -n lv_name vg_name\n"
27182 #: ../tools/virt-resize.pl:133
27183 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
27187 #: ../tools/virt-resize.pl:135
27190 " # virsh pool-list\n"
27191 " # virsh vol-create-as poolname newvol 10G\n"
27196 #: ../tools/virt-resize.pl:138
27201 #: ../tools/virt-resize.pl:140
27203 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
27204 "file) and the output disk. The output disk is the one created in the "
27209 #: ../tools/virt-resize.pl:144
27212 " # virt-resize indisk outdisk\n"
27217 #: ../tools/virt-resize.pl:146
27219 "This command just copies disk image C<indisk> to disk image C<outdisk> "
27220 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
27221 "larger, then an extra, empty partition is created at the end of the disk "
27222 "covering the extra space. If C<outdisk> is smaller, then it will give an "
27227 #: ../tools/virt-resize.pl:152
27229 "More realistically you'd want to expand existing partitions in the disk "
27230 "image by passing extra options (for the full list see the L</OPTIONS> "
27235 #: ../tools/virt-resize.pl:156
27237 "L</--expand> is the most useful option. It expands the named partition "
27238 "within the disk to fill any extra space:"
27242 #: ../tools/virt-resize.pl:159
27245 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
27250 #: ../tools/virt-resize.pl:161
27252 "(In this case, an extra partition is I<not> created at the end of the disk, "
27253 "because there will be no unused space)."
27257 #: ../tools/virt-resize.pl:164
27259 "L</--resize> is the other commonly used option. The following would "
27260 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
27261 "rest of the available space:"
27265 #: ../tools/virt-resize.pl:168
27268 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
27269 " indisk outdisk\n"
27274 #: ../tools/virt-resize.pl:171
27276 "If the expanded partition in the image contains a filesystem or LVM PV, then "
27277 "if virt-resize knows how, it will resize the contents, the equivalent of "
27278 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
27279 ">. However virt-resize does not know how to resize some filesystems, so you "
27280 "would have to online resize them after booting the guest. And virt-resize "
27281 "also does not resize anything inside an LVM PV, it just resizes the PV "
27282 "itself and leaves the user to resize any LVs inside that PV as desired."
27286 #: ../tools/virt-resize.pl:180
27287 msgid "Other options are covered below."
27291 #: ../tools/virt-resize.pl:182
27296 #: ../tools/virt-resize.pl:184
27297 msgid "Thoroughly test the new disk image I<before> discarding the old one."
27301 #: ../tools/virt-resize.pl:186
27302 msgid "If you are using libvirt, edit the XML to point at the new disk:"
27306 #: ../tools/virt-resize.pl:188
27309 " # virsh edit guestname\n"
27314 #: ../tools/virt-resize.pl:190
27316 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
27317 "html#elementsDisks>"
27321 #: ../tools/virt-resize.pl:193
27322 msgid "Then start up the domain with the new, resized disk:"
27326 #: ../tools/virt-resize.pl:195
27329 " # virsh start guestname\n"
27334 #: ../tools/virt-resize.pl:197
27336 "and check that it still works. See also the L</NOTES> section below for "
27337 "additional information."
27341 #: ../tools/virt-resize.pl:200
27342 msgid "7. Resize LVs etc inside the guest"
27346 #: ../tools/virt-resize.pl:202
27347 msgid "(This can also be done offline using L<guestfish(1)>)"
27351 #: ../tools/virt-resize.pl:204
27353 "Once the guest has booted you should see the new space available, at least "
27354 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
27355 "may need to resize LVs inside PVs, and also resize filesystem types that "
27356 "virt-resize does not know how to expand."
27360 #: ../tools/virt-resize.pl:211
27361 msgid "SHRINKING A VIRTUAL MACHINE DISK"
27365 #: ../tools/virt-resize.pl:213
27367 "Shrinking is somewhat more complex than expanding, and only an overview is "
27372 #: ../tools/virt-resize.pl:216
27374 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
27375 "filesystems). The user has to shrink content before passing the disk image "
27376 "to virt-resize, and virt-resize will check that the content has been shrunk "
27381 #: ../tools/virt-resize.pl:221
27382 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
27386 #: ../tools/virt-resize.pl:223
27388 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
27389 "steps 3 and 4 above to allocate a new disk image."
27393 #: ../tools/virt-resize.pl:226
27395 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
27399 #: ../tools/virt-resize.pl:229
27400 msgid "IGNORING OR DELETING PARTITIONS"
27404 #: ../tools/virt-resize.pl:231
27406 "virt-resize also gives a convenient way to ignore or delete partitions when "
27407 "copying from the input disk to the output disk. Ignoring a partition speeds "
27408 "up the copy where you don't care about the existing contents of a "
27409 "partition. Deleting a partition removes it completely, but note that it "
27410 "also renumbers any partitions after the one which is deleted, which can "
27411 "leave some guests unbootable."
27415 #: ../tools/virt-resize.pl:238
27416 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
27420 #: ../tools/virt-resize.pl:240
27422 "If the input disk is in qcow2 format, then you may prefer that the output is "
27423 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
27424 "the fly. The output format is simply determined by the format of the empty "
27425 "output container that you provide. Thus to create qcow2 output, use:"
27429 #: ../tools/virt-resize.pl:246
27432 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
27437 #: ../tools/virt-resize.pl:248
27438 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
27442 #: ../tools/virt-resize.pl:250
27443 msgid "Similarly, to get non-sparse raw output use:"
27447 #: ../tools/virt-resize.pl:252
27450 " fallocate -l size outdisk\n"
27455 #: ../tools/virt-resize.pl:254
27457 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
27458 "dev/zero of=outdisk bs=1M count=..>)"
27462 #: ../tools/virt-resize.pl:267
27463 msgid "Display help."
27467 #: ../tools/virt-resize.pl:281
27468 msgid "B<--resize part=size>"
27472 #: ../tools/virt-resize.pl:283
27474 "Resize the named partition (expanding or shrinking it) so that it has the "
27479 #: ../tools/virt-resize.pl:286
27481 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
27482 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
27483 "Exabytes; or as a percentage of the current size; or as a relative number or "
27484 "percentage. For example:"
27488 #: ../tools/virt-resize.pl:291
27491 " --resize /dev/sda2=10G\n"
27496 #: ../tools/virt-resize.pl:293
27499 " --resize /dev/sda4=90%\n"
27504 #: ../tools/virt-resize.pl:295
27507 " --resize /dev/sda2=+1G\n"
27512 #: ../tools/virt-resize.pl:297
27515 " --resize /dev/sda2=-200M\n"
27520 #: ../tools/virt-resize.pl:299
27523 " --resize /dev/sda1=+128K\n"
27528 #: ../tools/virt-resize.pl:301
27531 " --resize /dev/sda1=+10%\n"
27536 #: ../tools/virt-resize.pl:303
27539 " --resize /dev/sda1=-10%\n"
27544 #: ../tools/virt-resize.pl:305
27546 "You can increase the size of any partition. Virt-resize will expand the "
27547 "direct content of the partition if it knows how (see C<--expand> below)."
27551 #: ../tools/virt-resize.pl:309
27553 "You can only I<decrease> the size of partitions that contain filesystems or "
27554 "PVs which have already been shrunk. Virt-resize will check this has been "
27555 "done before proceeding, or else will print an error (see also C<--resize-"
27560 #: ../tools/virt-resize.pl:314 ../tools/virt-resize.pl:406
27561 #: ../tools/virt-resize.pl:423
27562 msgid "You can give this option multiple times."
27566 #: ../tools/virt-resize.pl:320
27567 msgid "B<--resize-force part=size>"
27571 #: ../tools/virt-resize.pl:322
27573 "This is the same as C<--resize> except that it will let you decrease the "
27574 "size of any partition. Generally this means you will lose any data which "
27575 "was at the end of the partition you shrink, but you may not care about that "
27576 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
27577 "as a swap partition)."
27581 #: ../tools/virt-resize.pl:328
27582 msgid "See also the C<--ignore> option."
27586 #: ../tools/virt-resize.pl:334
27587 msgid "B<--expand part>"
27591 #: ../tools/virt-resize.pl:336
27593 "Expand the named partition so it uses up all extra space (space left over "
27594 "after any other resize changes that you request have been done)."
27598 #: ../tools/virt-resize.pl:339
27600 "If virt-resize knows how, it will expand the direct content of the "
27601 "partition. For example, if the partition is an LVM PV, it will expand the "
27602 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
27603 "content it doesn't know about alone."
27607 #: ../tools/virt-resize.pl:344
27608 msgid "Currently virt-resize can resize:"
27612 #: ../tools/virt-resize.pl:350
27614 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
27619 #: ../tools/virt-resize.pl:355
27621 "NTFS filesystems contained directly in a partition, if libguestfs was "
27622 "compiled with support for NTFS."
27626 #: ../tools/virt-resize.pl:358
27628 "The filesystem must have been shut down consistently last time it was used. "
27629 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
27630 "consistency check, so at the first boot after resizing Windows will check "
27635 #: ../tools/virt-resize.pl:365
27637 "LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
27638 "inside the PV. The user will have to resize LVs as desired."
27642 #: ../tools/virt-resize.pl:371 ../tools/virt-resize.pl:393
27643 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
27647 #: ../tools/virt-resize.pl:377
27648 msgid "B<--shrink part>"
27652 #: ../tools/virt-resize.pl:379
27654 "Shrink the named partition until the overall disk image fits in the "
27655 "destination. The named partition B<must> contain a filesystem or PV which "
27656 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
27657 "online tools). Virt-resize will check this and give an error if it has not "
27662 #: ../tools/virt-resize.pl:385
27664 "The amount by which the overall disk must be shrunk (after carrying out all "
27665 "other operations requested by the user) is called the \"deficit\". For "
27666 "example, a straight copy (assume no other operations) from a 5GB disk image "
27667 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
27668 "would give an error unless the user specified a partition to shrink and that "
27669 "partition had more than a gigabyte of free space."
27673 #: ../tools/virt-resize.pl:399
27674 msgid "B<--ignore part>"
27678 #: ../tools/virt-resize.pl:401
27680 "Ignore the named partition. Effectively this means the partition is "
27681 "allocated on the destination disk, but the content is not copied across from "
27682 "the source disk. The content of the partition will be blank (all zero "
27687 #: ../tools/virt-resize.pl:412
27688 msgid "B<--delete part>"
27692 #: ../tools/virt-resize.pl:414
27694 "Delete the named partition. It would be more accurate to describe this as "
27695 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
27696 "the original disk image is left intact."
27700 #: ../tools/virt-resize.pl:418
27702 "Note that when you delete a partition, then anything contained in the "
27703 "partition is also deleted. Furthermore, this causes any partitions that "
27704 "come after to be I<renumbered>, which can easily make your guest unbootable."
27708 #: ../tools/virt-resize.pl:429
27709 msgid "B<--LV-expand logvol>"
27713 #: ../tools/virt-resize.pl:431
27715 "This takes the logical volume and, as a final step, expands it to fill all "
27716 "the space available in its volume group. A typical usage, assuming a Linux "
27717 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
27718 "lv_root> would be:"
27722 #: ../tools/virt-resize.pl:436
27725 " virt-resize indisk outdisk \\\n"
27726 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
27731 #: ../tools/virt-resize.pl:439
27733 "This would first expand the partition (and PV), and then expand the root "
27734 "device to fill the extra space in the PV."
27738 #: ../tools/virt-resize.pl:442
27740 "The contents of the LV are also resized if virt-resize knows how to do "
27741 "that. You can stop virt-resize from trying to expand the content by using "
27742 "the option C<--no-expand-content>."
27746 #: ../tools/virt-resize.pl:446
27747 msgid "Use L<virt-list-filesystems(1)> to list the filesystems in the guest."
27751 #: ../tools/virt-resize.pl:449
27753 "You can give this option multiple times, I<but> it doesn't make sense to do "
27754 "this unless the logical volumes you specify are all in different volume "
27759 #: ../tools/virt-resize.pl:457
27760 msgid "B<--no-copy-boot-loader>"
27764 #: ../tools/virt-resize.pl:459
27766 "By default, virt-resize copies over some sectors at the start of the disk "
27767 "(up to the beginning of the first partition). Commonly these sectors "
27768 "contain the Master Boot Record (MBR) and the boot loader, and are required "
27769 "in order for the guest to boot correctly."
27773 #: ../tools/virt-resize.pl:464
27775 "If you specify this flag, then this initial copy is not done. You may need "
27776 "to reinstall the boot loader in this case."
27780 #: ../tools/virt-resize.pl:472
27781 msgid "B<--no-extra-partition>"
27785 #: ../tools/virt-resize.pl:474
27787 "By default, virt-resize creates an extra partition if there is any extra, "
27788 "unused space after all resizing has happened. Use this option to prevent "
27789 "the extra partition from being created. If you do this then the extra space "
27790 "will be inaccessible until you run fdisk, parted, or some other partitioning "
27791 "tool in the guest."
27795 #: ../tools/virt-resize.pl:480
27797 "Note that if the surplus space is smaller than 10 MB, no extra partition "
27802 #: ../tools/virt-resize.pl:487
27803 msgid "B<--no-expand-content>"
27807 #: ../tools/virt-resize.pl:489
27809 "By default, virt-resize will try to expand the direct contents of "
27810 "partitions, if it knows how (see C<--expand> option above)."
27814 #: ../tools/virt-resize.pl:492
27816 "If you give the C<--no-expand-content> option then virt-resize will not "
27821 #: ../tools/virt-resize.pl:499
27822 msgid "B<-d> | B<--debug>"
27826 #: ../tools/virt-resize.pl:507
27827 msgid "B<-n> | B<--dryrun>"
27831 #: ../tools/virt-resize.pl:509
27832 msgid "Print a summary of what would be done, but don't do anything."
27836 #: ../tools/virt-resize.pl:515
27837 msgid "B<-q> | B<--quiet>"
27841 #: ../tools/virt-resize.pl:517
27842 msgid "Don't print the summary."
27846 #: ../tools/virt-resize.pl:525
27848 "Specify the format of the input disk image. If this flag is not given then "
27849 "it is auto-detected from the image itself."
27853 #: ../tools/virt-resize.pl:531
27855 "Note that this option I<does not> affect the output format. See L</QCOW2 "
27856 "AND NON-SPARSE RAW FORMATS>."
27860 #: ../tools/virt-resize.pl:538
27861 msgid "B<--output-format> raw"
27865 #: ../tools/virt-resize.pl:540
27867 "Specify the format of the output disk image. If this flag is not given then "
27868 "it is auto-detected from the image itself."
27872 #: ../tools/virt-resize.pl:546
27874 "Note that you still need to create the output disk with the right format. "
27875 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
27879 #: ../tools/virt-resize.pl:1422 ../tools/virt-rescue.pl:90
27884 #: ../tools/virt-resize.pl:1424
27885 msgid "\"Partition 1 does not end on cylinder boundary.\""
27889 #: ../tools/virt-resize.pl:1426
27891 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
27892 "means the partitions will not be aligned to the ancient CHS geometry. "
27893 "However CHS geometry is meaningless for disks manufactured since the early "
27894 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
27895 "cylinders is not required by any modern operating system."
27899 #: ../tools/virt-resize.pl:1433
27900 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
27904 #: ../tools/virt-resize.pl:1435
27906 "In Windows Vista and later versions, Microsoft switched to using a separate "
27907 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
27908 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
27909 "the boot partition. Doing so seems to break the guest completely. However "
27910 "expanding the second partition (ie. C: drive) should work."
27914 #: ../tools/virt-resize.pl:1442
27916 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
27917 "NTFS partitions have been expanded. This is just a safety check and (unless "
27918 "it find errors) is nothing to worry about."
27922 #: ../tools/virt-resize.pl:1446
27923 msgid "GUEST BOOT STUCK AT \"GRUB\""
27927 #: ../tools/virt-resize.pl:1448
27929 "If a Linux guest does not boot after resizing, and the boot is stuck after "
27930 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
27931 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
27932 "although we think is to do with partition alignment."
27936 #: ../tools/virt-resize.pl:1453
27939 " guestfish -i -a newdisk\n"
27940 " ><fs> cat /boot/grub/device.map\n"
27941 " # check the contents of this file are sensible or\n"
27942 " # edit the file if necessary\n"
27943 " ><fs> grub-install / /dev/vda\n"
27949 #: ../tools/virt-resize.pl:1460
27951 "For more flexible guest reconfiguration, including if you need to specify "
27952 "other parameters to grub-install, use L<virt-rescue(1)>."
27956 #: ../tools/virt-resize.pl:1463
27957 msgid "ALTERNATIVE TOOLS"
27961 #: ../tools/virt-resize.pl:1465
27963 "There are several proprietary tools for resizing partitions. We won't "
27964 "mention any here."
27968 #: ../tools/virt-resize.pl:1468
27970 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
27971 "operations on disk images. They can resize and move partitions, but I don't "
27972 "think they can do anything with the contents, and they certainly don't "
27977 #: ../tools/virt-resize.pl:1473
27979 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
27980 "but at a much lower level. You will probably end up hand-calculating sector "
27981 "offsets, which is something that virt-resize was designed to avoid. If you "
27982 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
27987 #: ../tools/virt-resize.pl:1488
27989 "L<virt-list-partitions(1)>, L<virt-list-filesystems(1)>, L<virt-df(1)>, "
27990 "L<guestfs(3)>, L<guestfish(1)>, L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, "
27991 "L<resize2fs(8)>, L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)"
27992 ">, L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
27993 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
27997 #: ../tools/virt-list-filesystems.pl:32
27999 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
28003 #: ../tools/virt-list-filesystems.pl:36
28006 " virt-list-filesystems [--options] domname\n"
28011 #: ../tools/virt-list-filesystems.pl:38
28014 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
28019 #: ../tools/virt-list-filesystems.pl:42
28021 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
28022 "are contained in a virtual machine or disk image."
28026 #: ../tools/virt-list-filesystems.pl:46
28028 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
28029 "functionality. For more complex cases you should look at the L<guestfish(1)"
28034 #: ../tools/virt-list-filesystems.pl:105
28036 "With this option, C<virt-list-filesystems> displays the type of each "
28037 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
28041 #: ../tools/virt-list-filesystems.pl:112
28042 msgid "B<-a> | B<--all>"
28046 #: ../tools/virt-list-filesystems.pl:114
28048 "Normally we only show mountable filesystems. If this option is given then "
28049 "swap devices are shown too."
28053 #: ../tools/virt-list-filesystems.pl:188
28055 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-list-"
28056 "partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)"
28057 ">, L<http://libguestfs.org/>."
28061 #: ../tools/virt-tar.pl:33
28062 msgid "virt-tar - Extract or upload files to a virtual machine"
28066 #: ../tools/virt-tar.pl:37
28069 " virt-tar [--options] -x domname directory tarball\n"
28074 #: ../tools/virt-tar.pl:39
28077 " virt-tar [--options] -u domname tarball directory\n"
28082 #: ../tools/virt-tar.pl:41
28085 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
28090 #: ../tools/virt-tar.pl:43
28093 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
28098 #: ../tools/virt-tar.pl:47
28099 msgid "Download C</home> from the VM into a local tarball:"
28103 #: ../tools/virt-tar.pl:49
28106 " virt-tar -x domname /home home.tar\n"
28111 #: ../tools/virt-tar.pl:51
28114 " virt-tar -zx domname /home home.tar.gz\n"
28119 #: ../tools/virt-tar.pl:53
28120 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
28124 #: ../tools/virt-tar.pl:55
28127 " virt-tar -u domname uploadstuff.tar /tmp\n"
28132 #: ../tools/virt-tar.pl:57
28135 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
28140 #: ../tools/virt-tar.pl:61
28142 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
28143 "virtual machines. If you do this, you risk disk corruption in the VM. "
28144 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
28148 #: ../tools/virt-tar.pl:66
28150 "You can use C<-x> (extract) on live virtual machines, but you might get "
28151 "inconsistent results or errors if there is filesystem activity inside the "
28152 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
28153 "work, but the only way to guarantee consistent results is if the virtual "
28154 "machine is shut down."
28158 #: ../tools/virt-tar.pl:74
28160 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
28161 "parts of a guest filesystem. There are many possibilities: making backups, "
28162 "uploading data files, snooping on guest activity, fixing or customizing "
28167 #: ../tools/virt-tar.pl:79
28169 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
28170 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
28171 "should look at the L<guestfish(1)> tool."
28175 #: ../tools/virt-tar.pl:83
28177 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
28178 "its contents (recursively) from the virtual machine into a local tarball. "
28179 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
28180 "virtual machine. You cannot use these two options together."
28184 #: ../tools/virt-tar.pl:89
28186 "In addition, you may need to use the C<-z> (gZip) option to enable "
28187 "compression. When uploading, you have to specify C<-z> if the upload file "
28188 "is compressed because virt-tar won't detect this on its own."
28192 #: ../tools/virt-tar.pl:93
28194 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
28195 "example it cannot do PKZip files or bzip2 compression. If you want that "
28196 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
28197 "the L<libguestfs(3)> API)."
28201 #: ../tools/virt-tar.pl:151
28202 msgid "B<-x> | B<--extract> | B<--download>"
28206 #: ../tools/virt-tar.pl:153
28207 msgid "B<-u> | B<--upload>"
28211 #: ../tools/virt-tar.pl:155
28213 "Use C<-x> to extract (download) a directory from a virtual machine to a "
28218 #: ../tools/virt-tar.pl:158
28220 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
28221 "Please read the L</WARNING> section above before using this option."
28225 #: ../tools/virt-tar.pl:162
28226 msgid "You must specify exactly one of these options."
28230 #: ../tools/virt-tar.pl:168
28231 msgid "B<-z> | B<--gzip>"
28235 #: ../tools/virt-tar.pl:170
28236 msgid "Specify that the input or output tarball is gzip-compressed."
28240 #: ../tools/virt-tar.pl:283
28242 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<Sys::"
28243 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
28248 #: ../tools/virt-rescue.pl:33
28249 msgid "virt-rescue - Run a rescue shell on a virtual machine"
28253 #: ../tools/virt-rescue.pl:37
28256 " virt-rescue [--options] domname\n"
28261 #: ../tools/virt-rescue.pl:39
28264 " virt-rescue [--options] disk.img [disk.img ...]\n"
28269 #: ../tools/virt-rescue.pl:43
28271 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
28272 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
28273 "you from doing this, but doesn't catch all cases."
28277 #: ../tools/virt-rescue.pl:47
28279 "However if you use the I<--ro> (read only) option, then you can attach a "
28280 "shell to a live virtual machine. The results might be strange or "
28281 "inconsistent at times but you won't get disk corruption."
28285 #: ../tools/virt-rescue.pl:53
28287 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
28288 "need for a CD. virt-rescue gives you a rescue shell and some simple "
28289 "recovery tools which you can use to examine or rescue a virtual machine or "
28294 #: ../tools/virt-rescue.pl:58
28296 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
28297 "on disk image(s):"
28301 #: ../tools/virt-rescue.pl:61
28304 " virt-rescue GuestName\n"
28309 #: ../tools/virt-rescue.pl:63
28312 " virt-rescue --ro /path/to/disk.img\n"
28317 #: ../tools/virt-rescue.pl:65
28320 " virt-rescue /dev/sdc\n"
28325 #: ../tools/virt-rescue.pl:67
28326 msgid "For live VMs you I<must> use the --ro option."
28330 #: ../tools/virt-rescue.pl:69
28332 "When you run virt-rescue on a virtual machine or disk image, you are placed "
28333 "in an interactive bash shell where you can use many ordinary Linux "
28334 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
28335 "appliance. You must mount the virtual machine's filesystems by hand. There "
28336 "is an empty directory called C</sysroot> where you can mount filesystems."
28340 #: ../tools/virt-rescue.pl:76
28342 "In the example below, we list logical volumes, then choose one to mount "
28343 "under C</sysroot>:"
28347 #: ../tools/virt-rescue.pl:79
28351 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
28352 " lv_root vg_f11x64 -wi-a- 8.83G\n"
28353 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
28354 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
28355 " ><rescue> ls /sysroot\n"
28360 #: ../tools/virt-rescue.pl:86
28362 "If you don't know what filesystems are available on the virtual machine then "
28363 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
28367 #: ../tools/virt-rescue.pl:92
28369 "Virt-rescue can be used on I<any> disk image file or device, not just a "
28370 "virtual machine. For example you can use it on a blank file if you want to "
28371 "partition that file (although we would recommend using L<guestfish(1)> "
28372 "instead as it is more suitable for this purpose). You can even use virt-"
28373 "rescue on things like SD cards."
28377 #: ../tools/virt-rescue.pl:98
28379 "This tool is just designed for quick interactive hacking on a virtual "
28380 "machine. For more structured access to a virtual machine disk image, you "
28381 "should use L<guestfs(3)>. To get a structured shell that you can use to "
28382 "make scripted changes to guests, use L<guestfish(1)>."
28386 #: ../tools/virt-rescue.pl:127
28387 msgid "B<--append kernelopts>"
28391 #: ../tools/virt-rescue.pl:129
28392 msgid "Pass additional options to the rescue kernel."
28396 #: ../tools/virt-rescue.pl:164
28397 msgid "B<--memsize MB> | B<-m MB>"
28401 #: ../tools/virt-rescue.pl:166
28403 "Change the amount of memory allocated to the rescue system. The default is "
28404 "set by libguestfs and is small but adequate for running system tools. The "
28405 "occasional program might need more memory. The parameter is specified in "
28410 #: ../tools/virt-rescue.pl:175
28411 msgid "B<--network MB>"
28415 #: ../tools/virt-rescue.pl:177
28416 msgid "Enable QEMU user networking in the guest."
28420 #: ../tools/virt-rescue.pl:183
28421 msgid "B<--ro> | B<-r>"
28425 #: ../tools/virt-rescue.pl:185
28426 msgid "Open the image read-only."
28430 #: ../tools/virt-rescue.pl:197
28432 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
28433 "SELINUX> before using this option."
28437 #: ../tools/virt-rescue.pl:257
28439 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
28440 "ENVIRONMENT VARIABLES> for the complete list."
28444 #: ../tools/virt-rescue.pl:269
28446 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
28447 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
28451 #: ../tools/virt-make-fs.pl:37
28452 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
28456 #: ../tools/virt-make-fs.pl:41
28459 " virt-make-fs [--options] input.tar output.img\n"
28464 #: ../tools/virt-make-fs.pl:43
28467 " virt-make-fs [--options] input.tar.gz output.img\n"
28472 #: ../tools/virt-make-fs.pl:45
28475 " virt-make-fs [--options] directory output.img\n"
28480 #: ../tools/virt-make-fs.pl:49
28482 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
28483 "archive or some files in a directory. It is similar to tools like L<mkisofs"
28484 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
28485 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
28486 "you want to attach these filesystems to existing virtual machines (eg. to "
28487 "import large amounts of read-only data to a VM)."
28491 #: ../tools/virt-make-fs.pl:57
28492 msgid "Basic usage is:"
28496 #: ../tools/virt-make-fs.pl:59
28499 " virt-make-fs input output\n"
28504 #: ../tools/virt-make-fs.pl:61
28506 "where C<input> is either a directory containing files that you want to add, "
28507 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
28508 "C<output> is a disk image. The input type is detected automatically. The "
28509 "output disk image defaults to a raw ext2 image unless you specify extra "
28510 "flags (see L</OPTIONS> below)."
28514 #: ../tools/virt-make-fs.pl:67
28515 msgid "EXTRA SPACE"
28519 #: ../tools/virt-make-fs.pl:69
28521 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
28522 "the files that it contains, but might have extra space. Depending on how "
28523 "you are going to use the output, you might think this extra space is wasted "
28524 "and want to minimize it, or you might want to leave space so that more files "
28525 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
28526 "but you can use the C<--size> flag to leave space in the filesystem if you "
28531 #: ../tools/virt-make-fs.pl:77
28533 "An alternative way to leave extra space but not make the output image any "
28534 "bigger is to use an alternative disk image format (instead of the default "
28535 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
28536 "image format (check your hypervisor supports this before using it). This "
28537 "allows you to choose a large C<--size> but the extra space won't actually be "
28538 "allocated in the image until you try to store something in it."
28542 #: ../tools/virt-make-fs.pl:85
28544 "Don't forget that you can also use local commands including L<resize2fs(8)> "
28545 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-"
28546 "resize to build another image from scratch."
28550 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
28551 #: ../tools/virt-make-fs.pl:142
28556 #: ../tools/virt-make-fs.pl:91
28559 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
28564 #: ../tools/virt-make-fs.pl:93
28565 msgid "FILESYSTEM TYPE"
28569 #: ../tools/virt-make-fs.pl:95
28571 "The default filesystem type is C<ext2>. Just about any filesystem type that "
28572 "libguestfs supports can be used (but I<not> read-only formats like "
28573 "ISO9660). Here are some of the more common choices:"
28577 #: ../tools/virt-make-fs.pl:101
28582 #: ../tools/virt-make-fs.pl:103
28584 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
28585 "you are not going to use the filesystem in a way that requires the journal, "
28586 "then this is just wasted overhead."
28590 #: ../tools/virt-make-fs.pl:107
28591 msgid "I<ntfs> or I<vfat>"
28595 #: ../tools/virt-make-fs.pl:109
28596 msgid "Useful if exporting data to a Windows guest."
28600 #: ../tools/virt-make-fs.pl:111
28602 "I<Note for vfat>: The tar archive or local directory must only contain files "
28603 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
28604 "program running within libguestfs is unable to change the ownership of non-"
28605 "root files, since vfat itself does not support this."
28609 #: ../tools/virt-make-fs.pl:116
28614 #: ../tools/virt-make-fs.pl:118
28616 "Lower overhead than C<ext2>, but certain limitations on filename length and "
28617 "total filesystem size."
28621 #: ../tools/virt-make-fs.pl:125
28624 " virt-make-fs --type=minix input minixfs.img\n"
28629 #: ../tools/virt-make-fs.pl:127
28630 msgid "TO PARTITION OR NOT TO PARTITION"
28634 #: ../tools/virt-make-fs.pl:129
28635 msgid "Optionally virt-make-fs can add a partition table to the output disk."
28639 #: ../tools/virt-make-fs.pl:131
28641 "Adding a partition can make the disk image more compatible with certain "
28642 "virtualized operating systems which don't expect to see a filesystem "
28643 "directly located on a block device (Linux doesn't care and will happily "
28644 "handle both types)."
28648 #: ../tools/virt-make-fs.pl:136
28650 "On the other hand, if you have a partition table then the output image is no "
28651 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
28652 "directly on a partitioned disk image. (However libguestfs tools such as "
28653 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
28657 #: ../tools/virt-make-fs.pl:144
28658 msgid "Add an MBR partition:"
28662 #: ../tools/virt-make-fs.pl:146
28665 " virt-make-fs --partition -- input disk.img\n"
28670 #: ../tools/virt-make-fs.pl:148
28672 "If the output disk image could be terabyte-sized or larger, it's better to "
28673 "use an EFI/GPT-compatible partition table:"
28677 #: ../tools/virt-make-fs.pl:151
28680 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
28685 #: ../tools/virt-make-fs.pl:179
28686 msgid "Enable debugging information."
28690 #: ../tools/virt-make-fs.pl:185
28691 msgid "B<--size=E<lt>NE<gt>>"
28695 #: ../tools/virt-make-fs.pl:187
28696 msgid "B<--size=+E<lt>NE<gt>>"
28700 #: ../tools/virt-make-fs.pl:189
28701 msgid "B<-s E<lt>NE<gt>>"
28705 #: ../tools/virt-make-fs.pl:191
28706 msgid "B<-s +E<lt>NE<gt>>"
28710 #: ../tools/virt-make-fs.pl:193
28712 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
28716 #: ../tools/virt-make-fs.pl:196
28718 "If this option is I<not> given, then the output image will be just large "
28719 "enough to contain all the files, with not much wasted space."
28723 #: ../tools/virt-make-fs.pl:199
28725 "To choose a fixed size output disk, specify an absolute number followed by b/"
28726 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28727 "Petabytes or Exabytes. This must be large enough to contain all the input "
28728 "files, else you will get an error."
28732 #: ../tools/virt-make-fs.pl:204
28734 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
28735 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28736 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
28737 "the input files, and (approximately) an extra 200 MB free space."
28741 #: ../tools/virt-make-fs.pl:210
28743 "Note that virt-make-fs estimates free space, and therefore will not produce "
28744 "filesystems containing precisely the free space requested. (It is much more "
28745 "expensive and time-consuming to produce a filesystem which has precisely the "
28746 "desired free space)."
28750 #: ../tools/virt-make-fs.pl:219
28751 msgid "B<--format=E<lt>fmtE<gt>>"
28755 #: ../tools/virt-make-fs.pl:221
28756 msgid "B<-F E<lt>fmtE<gt>>"
28760 #: ../tools/virt-make-fs.pl:223
28761 msgid "Choose the output disk image format."
28765 #: ../tools/virt-make-fs.pl:225
28766 msgid "The default is C<raw> (raw disk image)."
28770 #: ../tools/virt-make-fs.pl:227
28772 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
28773 "that would really make sense here is C<qcow2>."
28777 #: ../tools/virt-make-fs.pl:234
28778 msgid "B<--type=E<lt>fsE<gt>>"
28782 #: ../tools/virt-make-fs.pl:236
28783 msgid "B<-t E<lt>fsE<gt>>"
28787 #: ../tools/virt-make-fs.pl:238
28788 msgid "Choose the output filesystem type."
28792 #: ../tools/virt-make-fs.pl:240
28793 msgid "The default is C<ext2>."
28797 #: ../tools/virt-make-fs.pl:242
28799 "Any filesystem which is supported read-write by libguestfs can be used here."
28803 #: ../tools/virt-make-fs.pl:249
28804 msgid "B<--partition>"
28808 #: ../tools/virt-make-fs.pl:251
28809 msgid "B<--partition=E<lt>parttypeE<gt>>"
28813 #: ../tools/virt-make-fs.pl:253
28815 "If specified, this flag adds an MBR partition table to the output disk image."
28819 #: ../tools/virt-make-fs.pl:256
28821 "You can change the partition table type, eg. C<--partition=gpt> for large "
28826 #: ../tools/virt-make-fs.pl:259
28828 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
28829 "might consider the next parameter to be the partition type. For example:"
28833 #: ../tools/virt-make-fs.pl:263
28836 " virt-make-fs --partition input.tar ...\n"
28841 #: ../tools/virt-make-fs.pl:265
28843 "would cause virt-make-fs to think you wanted to use a partition type of "
28844 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
28845 "dash) between options and the input file argument:"
28849 #: ../tools/virt-make-fs.pl:269
28852 " virt-make-fs --partition -- input.tar ...\n"
28857 #: ../tools/virt-make-fs.pl:536
28859 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
28860 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
28861 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28865 #: ../tools/virt-make-fs.pl:553
28868 " export LIBGUESTFS_DEBUG=1\n"
28869 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
28874 #: ../tools/virt-make-fs.pl:556
28876 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
28881 #: ../tools/virt-list-partitions.pl:32
28883 "virt-list-partitions - List partitions in a virtual machine or disk image"
28887 #: ../tools/virt-list-partitions.pl:36
28890 " virt-list-partitions [--options] domname\n"
28895 #: ../tools/virt-list-partitions.pl:38
28898 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
28903 #: ../tools/virt-list-partitions.pl:42
28905 "C<virt-list-partitions> is a command line tool to list the partitions that "
28906 "are contained in a virtual machine or disk image. It is mainly useful as a "
28907 "first step to using L<virt-resize(1)>."
28911 #: ../tools/virt-list-partitions.pl:47
28913 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
28914 "functionality. For more complex cases you should look at the L<guestfish(1)"
28919 #: ../tools/virt-list-partitions.pl:104
28920 msgid "B<-h> | B<--human-readable>"
28924 #: ../tools/virt-list-partitions.pl:106
28925 msgid "Show sizes in human-readable form (eg. \"1G\")."
28929 #: ../tools/virt-list-partitions.pl:114
28931 "With this option, C<virt-list-partitions> displays the type and size of each "
28932 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
28936 #: ../tools/virt-list-partitions.pl:121
28937 msgid "B<-t> | B<--total>"
28941 #: ../tools/virt-list-partitions.pl:123
28943 "Display the total size of each block device (as a separate row or rows)."
28947 #: ../tools/virt-list-partitions.pl:256
28949 "L<guestfs(3)>, L<guestfish(1)>, L<virt-list-filesystems(1)>, L<virt-resize(1)"
28950 ">, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://"
28951 "libguestfs.org/>."