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-11 18:35+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:584 ../inspector/virt-inspector.pl:588
815 #: ../tools/virt-df.pl:161 ../tools/virt-df.pl:167 ../tools/virt-resize.pl:348
816 #: ../tools/virt-resize.pl:353 ../tools/virt-resize.pl:363
821 #: ../src/guestfs.pod:362
823 "The kernel version that the command runs under will be different from what "
828 #: ../src/guestfs.pod:367
830 "If the command needs to communicate with daemons, then most likely they "
835 #: ../src/guestfs.pod:372
836 msgid "The command will be running in limited memory."
840 #: ../src/guestfs.pod:376
842 "The network may not be available unless you enable it (see L</"
843 "guestfs_set_network>)."
847 #: ../src/guestfs.pod:381
848 msgid "Only supports Linux guests (not Windows, BSD, etc)."
852 #: ../src/guestfs.pod:385
854 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
858 #: ../src/guestfs.pod:390
860 "For SELinux guests, you may need to enable SELinux and load policy first. "
861 "See L</SELINUX> in this manpage."
865 #: ../src/guestfs.pod:395
867 "I<Security:> It is not safe to run commands from untrusted, possibly "
868 "malicious guests. These commands may attempt to exploit your program by "
869 "sending unexpected output. They could also try to exploit the Linux kernel "
870 "or qemu provided by the libguestfs appliance. They could use the network "
871 "provided by the libguestfs appliance to bypass ordinary network partitions "
872 "and firewalls. They could use the elevated privileges or different SELinux "
873 "context of your program to their advantage."
877 #: ../src/guestfs.pod:404
879 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
880 "(a script which runs when the guest next boots normally), and to have this "
881 "script run the commands you want in the normal context of the running guest, "
882 "network security and so on."
886 #: ../src/guestfs.pod:411
888 "The two main API calls to run commands are L</guestfs_command> and L</"
889 "guestfs_sh> (there are also variations)."
893 #: ../src/guestfs.pod:414
895 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
896 "shell globs, redirections, etc will work."
900 #: ../src/guestfs.pod:417
901 msgid "CONFIGURATION FILES"
905 #: ../src/guestfs.pod:419
907 "To read and write configuration files in Linux guest filesystems, we "
908 "strongly recommend using Augeas. For example, Augeas understands how to "
909 "read and write, say, a Linux shadow password file or X.org configuration "
910 "file, and so avoids you having to write that code."
914 #: ../src/guestfs.pod:424
916 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
917 "document Augeas itself here because there is excellent documentation on the "
918 "L<http://augeas.net/> website."
922 #: ../src/guestfs.pod:428
924 "If you don't want to use Augeas (you fool!) then try calling L</"
925 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
930 #: ../src/guestfs.pod:432
935 #: ../src/guestfs.pod:434
937 "We support SELinux guests. To ensure that labeling happens correctly in "
938 "SELinux guests, you need to enable SELinux and load the guest's policy:"
942 #: ../src/guestfs.pod:440 ../src/guestfs.pod:953
947 #: ../src/guestfs.pod:442
948 msgid "Before launching, do:"
952 #: ../src/guestfs.pod:444
955 " guestfs_set_selinux (g, 1);\n"
960 #: ../src/guestfs.pod:446 ../src/guestfs.pod:957
965 #: ../src/guestfs.pod:448
967 "After mounting the guest's filesystem(s), load the policy. This is best "
968 "done by running the L<load_policy(8)> command in the guest itself:"
972 #: ../src/guestfs.pod:452
975 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
980 #: ../src/guestfs.pod:454
982 "(Older versions of C<load_policy> require you to specify the name of the "
987 #: ../src/guestfs.pod:457 ../src/guestfs.pod:963
992 #: ../src/guestfs.pod:459
994 "Optionally, set the security context for the API. The correct security "
995 "context to use can only be known by inspecting the guest. As an example:"
999 #: ../src/guestfs.pod:463
1002 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1007 #: ../src/guestfs.pod:467
1008 msgid "This will work for running commands and editing existing files."
1012 #: ../src/guestfs.pod:469
1014 "When new files are created, you may need to label them explicitly, for "
1015 "example by running the external command C<restorecon pathname>."
1019 #: ../src/guestfs.pod:473
1024 #: ../src/guestfs.pod:475
1026 "Certain calls are affected by the current file mode creation mask (the "
1027 "\"umask\"). In particular ones which create files or directories, such as "
1028 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1029 "either the default mode that the file is created with or modifies the mode "
1034 #: ../src/guestfs.pod:481
1036 "The default umask is C<022>, so files are created with modes such as C<0644> "
1037 "and directories with C<0755>."
1041 #: ../src/guestfs.pod:484
1043 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1044 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1045 "guestfs_chmod> after creating each file or directory."
1049 #: ../src/guestfs.pod:488
1050 msgid "For more information about umask, see L<umask(2)>."
1054 #: ../src/guestfs.pod:490 ../fish/guestfish.pod:669
1055 msgid "ENCRYPTED DISKS"
1059 #: ../src/guestfs.pod:492
1061 "Libguestfs allows you to access Linux guests which have been encrypted using "
1062 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1063 "standard. This includes nearly all whole disk encryption systems used by "
1064 "modern Linux guests."
1068 #: ../src/guestfs.pod:498
1070 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1071 "returns the string C<crypto_LUKS>)."
1075 #: ../src/guestfs.pod:501
1077 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1078 "will require the passphrase!"
1082 #: ../src/guestfs.pod:504
1084 "Opening a LUKS device creates a new device mapper device called C</dev/"
1085 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1086 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1087 "from and encrypted to the underlying block device respectively."
1091 #: ../src/guestfs.pod:510
1093 "LVM volume groups on the device can be made visible by calling L</"
1094 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1095 "(s) can now be mounted in the usual way."
1099 #: ../src/guestfs.pod:514
1101 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1102 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1103 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1104 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1105 "underlying encrypted block device)."
1109 #: ../src/guestfs.pod:521
1114 #: ../src/guestfs.pod:523
1116 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1117 "contains operating systems. (These APIs used to be in a separate Perl-only "
1118 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1119 "frequently used part of this library has been rewritten in C and moved into "
1124 #: ../src/guestfs.pod:529
1126 "Add all disks belonging to the unknown virtual machine and call L</"
1127 "guestfs_launch> in the usual way."
1131 #: ../src/guestfs.pod:532
1133 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1134 "and certain heuristics, and returns a list of operating systems that were "
1135 "found. An empty list means none were found. A single element is the root "
1136 "filesystem of the operating system. For dual- or multi-boot guests, "
1137 "multiple roots can be returned, each one corresponding to a separate "
1138 "operating system. (Multi-boot virtual machines are extremely rare in the "
1139 "world of virtualization, but since this scenario can happen, we have built "
1140 "libguestfs to deal with it.)"
1144 #: ../src/guestfs.pod:541
1146 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1147 "to get additional details about that operating system. For example, call L</"
1148 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1149 "Windows and Linux-based operating systems respectively."
1153 #: ../src/guestfs.pod:547
1155 "Un*x-like and Linux-based operating systems usually consist of several "
1156 "filesystems which are mounted at boot time (for example, a separate boot "
1157 "partition mounted on C</boot>). The inspection rules are able to detect how "
1158 "filesystems correspond to mount points. Call "
1159 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1160 "hash table like this example:"
1164 #: ../src/guestfs.pod:554
1167 " /boot => /dev/sda1\n"
1168 " / => /dev/vg_guest/lv_root\n"
1169 " /usr => /dev/vg_guest/lv_usr\n"
1174 #: ../src/guestfs.pod:558
1176 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1177 "filesystems as suggested."
1181 #: ../src/guestfs.pod:561
1183 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1184 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1188 #: ../src/guestfs.pod:565
1190 "Inspection currently only works for some common operating systems. "
1191 "Contributors are welcome to send patches for other operating systems that we "
1192 "currently cannot detect."
1196 #: ../src/guestfs.pod:569
1198 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1199 "for more details. The L</guestfs_inspect_os> function just ignores any "
1200 "encrypted devices."
1204 #: ../src/guestfs.pod:573
1206 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1207 "inspection and caches the results in the guest handle. Subsequent calls to "
1208 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1209 "read the disks. If you change the content of the guest disks, you can redo "
1210 "inspection by calling L</guestfs_inspect_os> again."
1214 #: ../src/guestfs.pod:580
1215 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1219 #: ../src/guestfs.pod:582
1221 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1222 "ntfs-3g.org/> driver."
1226 #: ../src/guestfs.pod:585
1228 "DOS and Windows still use drive letters, and the filesystems are always "
1229 "treated as case insensitive by Windows itself, and therefore you might find "
1230 "a Windows configuration file referring to a path like C<c:\\windows"
1231 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1232 "might be referred to as C</WINDOWS/System32>."
1236 #: ../src/guestfs.pod:591
1238 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1239 "libguestfs to read the appropriate Windows Registry and configuration files, "
1240 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1245 #: ../src/guestfs.pod:596
1247 "Replacing backslash characters with forward slash characters is also outside "
1248 "the scope of libguestfs, but something that you can easily do."
1252 #: ../src/guestfs.pod:599
1254 "Where we can help is in resolving the case insensitivity of paths. For "
1255 "this, call L</guestfs_case_sensitive_path>."
1259 #: ../src/guestfs.pod:602
1261 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1262 "files, through the library C<hivex> which is part of the libguestfs project "
1263 "although ships as a separate tarball. You have to locate and download the "
1264 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1265 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1266 "reg(1)> for more help on this issue."
1270 #: ../src/guestfs.pod:610
1271 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1275 #: ../src/guestfs.pod:612
1277 "Although we don't want to discourage you from using the C API, we will "
1278 "mention here that the same API is also available in other languages."
1282 #: ../src/guestfs.pod:615
1284 "The API is broadly identical in all supported languages. This means that "
1285 "the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, C<g."
1286 "mount(path)> in Python, and C<Guestfs.mount g path> in OCaml. In other "
1287 "words, a straightforward, predictable isomorphism between each language."
1291 #: ../src/guestfs.pod:621
1293 "Error messages are automatically transformed into exceptions if the language "
1298 #: ../src/guestfs.pod:624
1300 "We don't try to \"object orientify\" parts of the API in OO languages, "
1301 "although contributors are welcome to write higher level APIs above what we "
1302 "provide in their favourite languages if they wish."
1306 #: ../src/guestfs.pod:630
1311 #: ../src/guestfs.pod:632
1313 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1314 "identical to the C API. C++ classes and exceptions are not used."
1318 #: ../src/guestfs.pod:636
1323 #: ../src/guestfs.pod:638
1325 "The C# bindings are highly experimental. Please read the warnings at the "
1326 "top of C<csharp/Libguestfs.cs>."
1330 #: ../src/guestfs.pod:641
1335 #: ../src/guestfs.pod:643
1337 "This is the only language binding that is working but incomplete. Only "
1338 "calls which return simple integers have been bound in Haskell, and we are "
1339 "looking for help to complete this binding."
1343 #: ../src/guestfs.pod:647
1348 #: ../src/guestfs.pod:649
1350 "Full documentation is contained in the Javadoc which is distributed with "
1355 #: ../src/guestfs.pod:652
1360 #: ../src/guestfs.pod:654
1361 msgid "For documentation see the file C<guestfs.mli>."
1365 #: ../src/guestfs.pod:656
1370 #: ../src/guestfs.pod:658
1371 msgid "For documentation see L<Sys::Guestfs(3)>."
1375 #: ../src/guestfs.pod:660
1380 #: ../src/guestfs.pod:662
1382 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1383 "the php-libguestfs package for your distribution."
1387 #: ../src/guestfs.pod:665
1388 msgid "The PHP binding only works correctly on 64 bit machines."
1392 #: ../src/guestfs.pod:667
1397 #: ../src/guestfs.pod:669
1398 msgid "For documentation do:"
1402 #: ../src/guestfs.pod:671
1406 " >>> import guestfs\n"
1407 " >>> help (guestfs)\n"
1412 #: ../src/guestfs.pod:675
1417 #: ../src/guestfs.pod:677
1419 "Use the Guestfs module. There is no Ruby-specific documentation, but you "
1420 "can find examples written in Ruby in the libguestfs source."
1424 #: ../src/guestfs.pod:680
1425 msgid "B<shell scripts>"
1429 #: ../src/guestfs.pod:682
1430 msgid "For documentation see L<guestfish(1)>."
1434 #: ../src/guestfs.pod:686
1435 msgid "LIBGUESTFS GOTCHAS"
1439 #: ../src/guestfs.pod:688
1441 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1442 "system [...] that works in the way it is documented but is counterintuitive "
1443 "and almost invites mistakes.\""
1447 #: ../src/guestfs.pod:692
1449 "Since we developed libguestfs and the associated tools, there are several "
1450 "things we would have designed differently, but are now stuck with for "
1451 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1452 "release, you can expect these to change. Beware of them."
1456 #: ../src/guestfs.pod:700
1457 msgid "Autosync / forgetting to sync."
1461 #: ../src/guestfs.pod:702
1463 "When modifying a filesystem from C or another language, you B<must> unmount "
1464 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1465 "libguestfs handle. You can also call:"
1469 #: ../src/guestfs.pod:706
1472 " guestfs_set_autosync (g, 1);\n"
1477 #: ../src/guestfs.pod:708
1479 "to have the unmount/sync done automatically for you when the handle 'g' is "
1480 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1484 #: ../src/guestfs.pod:712
1486 "If you forget to do this, then it is entirely possible that your changes "
1487 "won't be written out, or will be partially written, or (very rarely) that "
1488 "you'll get disk corruption."
1492 #: ../src/guestfs.pod:716
1494 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1495 "guestfish scripts that forget to sync will work just fine, which can make "
1496 "this very puzzling if you are trying to debug a problem."
1500 #: ../src/guestfs.pod:720
1502 "Update: Autosync is enabled by default for all API users starting from "
1503 "libguestfs 1.5.24."
1507 #: ../src/guestfs.pod:723
1508 msgid "Mount option C<-o sync> should not be the default."
1512 #: ../src/guestfs.pod:725
1514 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1515 "However C<-o sync> does not add any reliability benefit, but does have a "
1516 "very large performance impact."
1520 #: ../src/guestfs.pod:729
1522 "The work around is to use L</guestfs_mount_options> and set the mount "
1523 "options that you actually want to use."
1527 #: ../src/guestfs.pod:732
1528 msgid "Read-only should be the default."
1532 #: ../src/guestfs.pod:734
1534 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1535 "specify I<--rw> if you want to make changes to the image."
1539 #: ../src/guestfs.pod:737
1540 msgid "This would reduce the potential to corrupt live VM images."
1544 #: ../src/guestfs.pod:739
1546 "Note that many filesystems change the disk when you just mount and unmount, "
1547 "even if you didn't perform any writes. You need to use L</"
1548 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1552 #: ../src/guestfs.pod:743
1553 msgid "guestfish command line is hard to use."
1557 #: ../src/guestfs.pod:745
1559 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1560 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1561 "exist, so it fails. In earlier versions of guestfish the error message was "
1562 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1563 "we should have used C<guestfish -c command> to run commands."
1567 #: ../src/guestfs.pod:752
1568 msgid "guestfish megabyte modifiers don't work right on all commands"
1572 #: ../src/guestfs.pod:754
1574 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1575 "other modifiers). What guestfish actually does is to multiply the number "
1576 "part by the modifier part and pass the result to the C API. However this "
1577 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1578 "expecting some other unit (eg. megabytes)."
1582 #: ../src/guestfs.pod:761
1583 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1587 #: ../src/guestfs.pod:763
1590 " lvcreate LV VG 100M\n"
1595 #: ../src/guestfs.pod:765
1597 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1598 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1599 "megabytes * megabytes) logical volume. The error message you get from this "
1600 "is also a little obscure."
1604 #: ../src/guestfs.pod:770
1606 "This could be fixed in the generator by specially marking parameters and "
1607 "return values which take bytes or other units."
1611 #: ../src/guestfs.pod:773
1612 msgid "Ambiguity between devices and paths"
1616 #: ../src/guestfs.pod:775
1618 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1619 "sdb2>) and a similar pathname. A file might just happen to be called "
1620 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1624 #: ../src/guestfs.pod:780
1626 "In the current API we usually resolve this ambiguity by having two separate "
1627 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1628 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1629 "detecting if the path supplied begins with C</dev/>."
1633 #: ../src/guestfs.pod:786
1635 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1636 "make paths/devices into structured names. One way to do this would be to "
1637 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1638 "aspect of grub. Another way would be to use a structured type, equivalent "
1639 "to this OCaml type:"
1643 #: ../src/guestfs.pod:792
1646 " type path = Path of string | Device of int | Partition of int * int\n"
1651 #: ../src/guestfs.pod:794
1652 msgid "which would allow you to pass arguments like:"
1656 #: ../src/guestfs.pod:796
1659 " Path \"/foo/bar\"\n"
1660 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1661 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1662 " Path \"/dev/sdb2\" (* not a device *)\n"
1667 #: ../src/guestfs.pod:801
1669 "As you can see there are still problems to resolve even with this "
1670 "representation. Also consider how it might work in guestfish."
1674 #: ../src/guestfs.pod:806
1675 msgid "PROTOCOL LIMITS"
1679 #: ../src/guestfs.pod:808
1681 "Internally libguestfs uses a message-based protocol to pass API calls and "
1682 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1683 "plenty more detail about this). The maximum message size used by the "
1684 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1685 "aware of this limit. The API calls which may be affected are individually "
1686 "documented, with a link back to this section of the documentation."
1690 #: ../src/guestfs.pod:816
1692 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1693 "a simple string. Because this string is at some point internally encoded as "
1694 "a message, the maximum size that it can return is slightly under 4 MB. If "
1695 "the requested file is larger than this then you will get an error."
1699 #: ../src/guestfs.pod:822
1701 "In order to transfer large files into and out of the guest filesystem, you "
1702 "need to use particular calls that support this. The sections L</UPLOADING> "
1703 "and L</DOWNLOADING> document how to do this."
1707 #: ../src/guestfs.pod:826
1709 "You might also consider mounting the disk image using our FUSE filesystem "
1710 "support (L<guestmount(1)>)."
1714 #: ../src/guestfs.pod:829
1715 msgid "KEYS AND PASSPHRASES"
1719 #: ../src/guestfs.pod:831
1721 "Certain libguestfs calls take a parameter that contains sensitive key "
1722 "material, passed in as a C string."
1726 #: ../src/guestfs.pod:834
1728 "In the future we would hope to change the libguestfs implementation so that "
1729 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1730 "swap. However this is I<not> done at the moment, because of the complexity "
1731 "of such an implementation."
1735 #: ../src/guestfs.pod:839
1737 "Therefore you should be aware that any key parameter you pass to libguestfs "
1738 "might end up being written out to the swap partition. If this is a concern, "
1739 "scrub the swap partition or don't use libguestfs on encrypted devices."
1743 #: ../src/guestfs.pod:844
1744 msgid "CONNECTION MANAGEMENT"
1748 #: ../src/guestfs.pod:846
1753 #: ../src/guestfs.pod:848
1755 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
1756 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
1757 "handle and release all resources used."
1761 #: ../src/guestfs.pod:852
1763 "For information on using multiple handles and threads, see the section L</"
1764 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
1768 #: ../src/guestfs.pod:855
1769 msgid "guestfs_create"
1773 #: ../src/guestfs.pod:857
1776 " guestfs_h *guestfs_create (void);\n"
1781 #: ../src/guestfs.pod:859
1782 msgid "Create a connection handle."
1786 #: ../src/guestfs.pod:861
1788 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
1789 "on the handle at least once."
1793 #: ../src/guestfs.pod:864
1795 "This function returns a non-NULL pointer to a handle on success or NULL on "
1800 #: ../src/guestfs.pod:867
1801 msgid "After configuring the handle, you have to call L</guestfs_launch>."
1805 #: ../src/guestfs.pod:869
1807 "You may also want to configure error handling for the handle. See L</ERROR "
1808 "HANDLING> section below."
1812 #: ../src/guestfs.pod:872
1813 msgid "guestfs_close"
1817 #: ../src/guestfs.pod:874
1820 " void guestfs_close (guestfs_h *g);\n"
1825 #: ../src/guestfs.pod:876
1826 msgid "This closes the connection handle and frees up all resources used."
1830 #: ../src/guestfs.pod:878
1831 msgid "ERROR HANDLING"
1835 #: ../src/guestfs.pod:880
1837 "API functions can return errors. For example, almost all functions that "
1838 "return C<int> will return C<-1> to indicate an error."
1842 #: ../src/guestfs.pod:883
1844 "Additional information is available for errors: an error message string and "
1845 "optionally an error number (errno) if the thing that failed was a system "
1850 #: ../src/guestfs.pod:887
1852 "You can get at the additional information about the last error on the handle "
1853 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
1854 "up an error handler with L</guestfs_set_error_handler>."
1858 #: ../src/guestfs.pod:892
1860 "When the handle is created, a default error handler is installed which "
1861 "prints the error message string to C<stderr>. For small short-running "
1862 "command line programs it is sufficient to do:"
1866 #: ../src/guestfs.pod:896
1869 " if (guestfs_launch (g) == -1)\n"
1870 " exit (EXIT_FAILURE);\n"
1875 #: ../src/guestfs.pod:899
1877 "since the default error handler will ensure that an error message has been "
1878 "printed to C<stderr> before the program exits."
1882 #: ../src/guestfs.pod:902
1884 "For other programs the caller will almost certainly want to install an "
1885 "alternate error handler or do error handling in-line like this:"
1889 #: ../src/guestfs.pod:905
1892 " g = guestfs_create ();\n"
1897 #: ../src/guestfs.pod:907
1900 " /* This disables the default behaviour of printing errors\n"
1902 " guestfs_set_error_handler (g, NULL, NULL);\n"
1907 #: ../src/guestfs.pod:911
1910 " if (guestfs_launch (g) == -1) {\n"
1911 " /* Examine the error message and print it etc. */\n"
1912 " char *msg = guestfs_last_error (g);\n"
1913 " int errnum = guestfs_last_errno (g);\n"
1914 " fprintf (stderr, \"%s\\n\", msg);\n"
1921 #: ../src/guestfs.pod:919
1923 "Out of memory errors are handled differently. The default action is to call "
1924 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
1925 "guestfs_set_out_of_memory_handler>."
1929 #: ../src/guestfs.pod:923
1931 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
1932 "because there is no handle if this happens there is no way to get additional "
1933 "error information. However L</guestfs_create> is supposed to be a "
1934 "lightweight operation which can only fail because of insufficient memory (it "
1935 "returns NULL in this case)."
1939 #: ../src/guestfs.pod:929
1940 msgid "guestfs_last_error"
1944 #: ../src/guestfs.pod:931
1947 " const char *guestfs_last_error (guestfs_h *g);\n"
1952 #: ../src/guestfs.pod:933
1954 "This returns the last error message that happened on C<g>. If there has not "
1955 "been an error since the handle was created, then this returns C<NULL>."
1959 #: ../src/guestfs.pod:937
1961 "The lifetime of the returned string is until the next error occurs, or L</"
1962 "guestfs_close> is called."
1966 #: ../src/guestfs.pod:940
1967 msgid "guestfs_last_errno"
1971 #: ../src/guestfs.pod:942
1974 " int guestfs_last_errno (guestfs_h *g);\n"
1979 #: ../src/guestfs.pod:944
1980 msgid "This returns the last error number (errno) that happened on C<g>."
1984 #: ../src/guestfs.pod:946
1985 msgid "If successful, an errno integer not equal to zero is returned."
1989 #: ../src/guestfs.pod:948
1991 "If no error, this returns 0. This call can return 0 in three situations:"
1995 #: ../src/guestfs.pod:955
1996 msgid "There has not been any error on the handle."
2000 #: ../src/guestfs.pod:959
2002 "There has been an error but the errno was meaningless. This corresponds to "
2003 "the case where the error did not come from a failed system call, but for "
2004 "some other reason."
2008 #: ../src/guestfs.pod:965
2010 "There was an error from a failed system call, but for some reason the errno "
2011 "was not captured and returned. This usually indicates a bug in libguestfs."
2015 #: ../src/guestfs.pod:971
2017 "Libguestfs tries to convert the errno from inside the applicance into a "
2018 "corresponding errno for the caller (not entirely trivial: the appliance "
2019 "might be running a completely different operating system from the library "
2020 "and error numbers are not standardized across Un*xen). If this could not be "
2021 "done, then the error is translated to C<EINVAL>. In practice this should "
2022 "only happen in very rare circumstances."
2026 #: ../src/guestfs.pod:979
2027 msgid "guestfs_set_error_handler"
2031 #: ../src/guestfs.pod:981
2034 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2036 " const char *msg);\n"
2037 " void guestfs_set_error_handler (guestfs_h *g,\n"
2038 " guestfs_error_handler_cb cb,\n"
2044 #: ../src/guestfs.pod:988
2046 "The callback C<cb> will be called if there is an error. The parameters "
2047 "passed to the callback are an opaque data pointer and the error message "
2052 #: ../src/guestfs.pod:992
2054 "C<errno> is not passed to the callback. To get that the callback must call "
2055 "L</guestfs_last_errno>."
2059 #: ../src/guestfs.pod:995
2061 "Note that the message string C<msg> is freed as soon as the callback "
2062 "function returns, so if you want to stash it somewhere you must make your "
2067 #: ../src/guestfs.pod:999
2068 msgid "The default handler prints messages on C<stderr>."
2072 #: ../src/guestfs.pod:1001
2073 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2077 #: ../src/guestfs.pod:1003
2078 msgid "guestfs_get_error_handler"
2082 #: ../src/guestfs.pod:1005
2085 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2086 " void **opaque_rtn);\n"
2091 #: ../src/guestfs.pod:1008
2092 msgid "Returns the current error handler callback."
2096 #: ../src/guestfs.pod:1010
2097 msgid "guestfs_set_out_of_memory_handler"
2101 #: ../src/guestfs.pod:1012
2104 " typedef void (*guestfs_abort_cb) (void);\n"
2105 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2106 " guestfs_abort_cb);\n"
2111 #: ../src/guestfs.pod:1016
2113 "The callback C<cb> will be called if there is an out of memory situation. "
2114 "I<Note this callback must not return>."
2118 #: ../src/guestfs.pod:1019
2119 msgid "The default is to call L<abort(3)>."
2123 #: ../src/guestfs.pod:1021
2125 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2129 #: ../src/guestfs.pod:1024
2130 msgid "guestfs_get_out_of_memory_handler"
2134 #: ../src/guestfs.pod:1026
2137 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2142 #: ../src/guestfs.pod:1028
2143 msgid "This returns the current out of memory handler."
2147 #: ../src/guestfs.pod:1030
2152 #: ../src/guestfs.pod:1032
2154 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
2159 #: ../src/guestfs.pod:1035
2161 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
2162 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2166 #: ../src/guestfs.pod:1038
2168 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2169 "to change the directories that libguestfs will search in. The value is a "
2170 "colon-separated list of paths. The current directory is I<not> searched "
2171 "unless the path contains an empty element or C<.>. For example "
2172 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2173 "then C</usr/lib/guestfs>."
2177 #: ../src/guestfs.pod:1045
2178 msgid "HIGH-LEVEL API ACTIONS"
2182 #: ../src/guestfs.pod:1047
2183 msgid "ABI GUARANTEE"
2187 #: ../src/guestfs.pod:1049
2189 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2190 "actions as outlined in this section. Although we will deprecate some "
2191 "actions, for example if they get replaced by newer calls, we will keep the "
2192 "old actions forever. This allows you the developer to program in confidence "
2193 "against the libguestfs API."
2197 #: ../src/guestfs.pod:1055 ../fish/guestfish.pod:907
2202 #: ../src/guestfs.pod:1057
2207 #: ../src/guestfs.pod:1059
2212 #: ../src/guestfs.pod:1061
2213 msgid "AVAILABILITY"
2217 #: ../src/guestfs.pod:1063
2218 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2222 #: ../src/guestfs.pod:1065
2224 "Using L</guestfs_available> you can test availability of the following "
2225 "groups of functions. This test queries the appliance to see if the "
2226 "appliance you are currently using supports the functionality."
2230 #: ../src/guestfs.pod:1070
2231 msgid "@AVAILABILITY@"
2235 #: ../src/guestfs.pod:1072
2236 msgid "GUESTFISH supported COMMAND"
2240 #: ../src/guestfs.pod:1074
2242 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2243 "prints out the available groups and whether they are supported by this build "
2244 "of libguestfs. Note however that you have to do C<run> first."
2248 #: ../src/guestfs.pod:1079
2249 msgid "SINGLE CALLS AT COMPILE TIME"
2253 #: ../src/guestfs.pod:1081
2255 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2256 "function, such as:"
2260 #: ../src/guestfs.pod:1084
2263 " #define LIBGUESTFS_HAVE_DD 1\n"
2268 #: ../src/guestfs.pod:1086
2269 msgid "if L</guestfs_dd> is available."
2273 #: ../src/guestfs.pod:1088
2275 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2276 "function is available at compile time, we recommended using build tools such "
2277 "as autoconf or cmake. For example in autotools you could use:"
2281 #: ../src/guestfs.pod:1093
2284 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2285 " AC_CHECK_FUNCS([guestfs_dd])\n"
2290 #: ../src/guestfs.pod:1096
2292 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2297 #: ../src/guestfs.pod:1099
2298 msgid "SINGLE CALLS AT RUN TIME"
2302 #: ../src/guestfs.pod:1101
2304 "Testing at compile time doesn't guarantee that a function really exists in "
2305 "the library. The reason is that you might be dynamically linked against a "
2306 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2307 "This situation unfortunately results in a segmentation fault, which is a "
2308 "shortcoming of the C dynamic linking system itself."
2312 #: ../src/guestfs.pod:1108
2314 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2315 "in this example program (note that you still need the compile time check as "
2320 #: ../src/guestfs.pod:1112
2323 " #include <stdio.h>\n"
2324 " #include <stdlib.h>\n"
2325 " #include <unistd.h>\n"
2326 " #include <dlfcn.h>\n"
2327 " #include <guestfs.h>\n"
2332 #: ../src/guestfs.pod:1118
2337 " #ifdef LIBGUESTFS_HAVE_DD\n"
2339 " int has_function;\n"
2344 #: ../src/guestfs.pod:1124
2347 " /* Test if the function guestfs_dd is really available. */\n"
2348 " dl = dlopen (NULL, RTLD_LAZY);\n"
2350 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2351 " exit (EXIT_FAILURE);\n"
2353 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2359 #: ../src/guestfs.pod:1133
2362 " if (!has_function)\n"
2363 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2365 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2366 " /* Now it's safe to call\n"
2367 " guestfs_dd (g, \"foo\", \"bar\");\n"
2371 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2378 #: ../src/guestfs.pod:1146
2380 "You may think the above is an awful lot of hassle, and it is. There are "
2381 "other ways outside of the C linking system to ensure that this kind of "
2382 "incompatibility never arises, such as using package versioning:"
2386 #: ../src/guestfs.pod:1151
2389 " Requires: libguestfs >= 1.0.80\n"
2394 #: ../src/guestfs.pod:1153
2395 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2399 #: ../src/guestfs.pod:1155
2401 "A recent feature of the API is the introduction of calls which take optional "
2402 "arguments. In C these are declared 3 ways. The main way is as a call which "
2403 "takes variable arguments (ie. C<...>), as in this example:"
2407 #: ../src/guestfs.pod:1160
2410 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2415 #: ../src/guestfs.pod:1162
2417 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2418 "call with no optional arguments specified:"
2422 #: ../src/guestfs.pod:1165
2425 " guestfs_add_drive_opts (g, filename, -1);\n"
2430 #: ../src/guestfs.pod:1167
2431 msgid "With a single optional argument:"
2435 #: ../src/guestfs.pod:1169
2438 " guestfs_add_drive_opts (g, filename,\n"
2439 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2445 #: ../src/guestfs.pod:1173
2450 #: ../src/guestfs.pod:1175
2453 " guestfs_add_drive_opts (g, filename,\n"
2454 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2455 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
2461 #: ../src/guestfs.pod:1180
2463 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
2468 #: ../src/guestfs.pod:1183
2469 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
2473 #: ../src/guestfs.pod:1185
2475 "The second variant has the same name with the suffix C<_va>, which works the "
2476 "same way but takes a C<va_list>. See the C manual for details. For the "
2477 "example function, this is declared:"
2481 #: ../src/guestfs.pod:1189
2484 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
2490 #: ../src/guestfs.pod:1192
2491 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
2495 #: ../src/guestfs.pod:1194
2497 "The third variant is useful where you need to construct these calls. You "
2498 "pass in a structure where you fill in the optional fields. The structure "
2499 "has a bitmask as the first element which you must set to indicate which "
2500 "fields you have filled in. For our example function the structure and call "
2505 #: ../src/guestfs.pod:1200
2508 " struct guestfs_add_drive_opts_argv {\n"
2509 " uint64_t bitmask;\n"
2511 " const char *format;\n"
2514 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
2515 " const struct guestfs_add_drive_opts_argv *optargs);\n"
2520 #: ../src/guestfs.pod:1209
2521 msgid "You could call it like this:"
2525 #: ../src/guestfs.pod:1211
2528 " struct guestfs_add_drive_opts_argv optargs = {\n"
2529 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
2530 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
2532 " .format = \"qcow2\"\n"
2538 #: ../src/guestfs.pod:1218
2541 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
2546 #: ../src/guestfs.pod:1220 ../src/guestfs-actions.pod:11
2547 #: ../src/guestfs-actions.pod: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:570 ../tools/virt-edit.pl:350
3814 #: ../tools/virt-win-reg.pl:484 ../tools/virt-df.pl:640
3815 #: ../tools/virt-ls.pl:232 ../tools/virt-resize.pl:1486
3816 #: ../tools/virt-list-filesystems.pl:186 ../tools/virt-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:580
3904 #: ../src/guestfs.pod:1983 ../fish/guestfish.pod:1057
3905 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
3906 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
3910 #: ../src/guestfs.pod:1985 ../fish/guestfish.pod:1059
3911 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248
3912 #: ../inspector/virt-inspector.pl:594 ../tools/virt-edit.pl:366
3913 #: ../tools/virt-win-reg.pl:514 ../tools/virt-df.pl:653
3914 #: ../tools/virt-ls.pl:247 ../tools/virt-resize.pl:1512
3915 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-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:2989
4018 #: ../src/guestfs-actions.pod:3004 ../src/guestfs-actions.pod:3024
4019 #: ../src/guestfs-actions.pod:3149 ../src/guestfs-actions.pod:3163
4020 #: ../src/guestfs-actions.pod:3176 ../src/guestfs-actions.pod:3190
4021 #: ../src/guestfs-actions.pod:3205 ../src/guestfs-actions.pod:3241
4022 #: ../src/guestfs-actions.pod:3313 ../src/guestfs-actions.pod:3333
4023 #: ../src/guestfs-actions.pod:3350 ../src/guestfs-actions.pod:3373
4024 #: ../src/guestfs-actions.pod:3396 ../src/guestfs-actions.pod:3428
4025 #: ../src/guestfs-actions.pod:3447 ../src/guestfs-actions.pod:3466
4026 #: ../src/guestfs-actions.pod:3501 ../src/guestfs-actions.pod:3513
4027 #: ../src/guestfs-actions.pod:3549 ../src/guestfs-actions.pod:3565
4028 #: ../src/guestfs-actions.pod:3578 ../src/guestfs-actions.pod:3593
4029 #: ../src/guestfs-actions.pod:3610 ../src/guestfs-actions.pod:3703
4030 #: ../src/guestfs-actions.pod:3723 ../src/guestfs-actions.pod:3736
4031 #: ../src/guestfs-actions.pod:3787 ../src/guestfs-actions.pod:3805
4032 #: ../src/guestfs-actions.pod:3823 ../src/guestfs-actions.pod:3839
4033 #: ../src/guestfs-actions.pod:3853 ../src/guestfs-actions.pod:3867
4034 #: ../src/guestfs-actions.pod:3884 ../src/guestfs-actions.pod:3899
4035 #: ../src/guestfs-actions.pod:3919 ../src/guestfs-actions.pod:3968
4036 #: ../src/guestfs-actions.pod:3999 ../src/guestfs-actions.pod:4018
4037 #: ../src/guestfs-actions.pod:4037 ../src/guestfs-actions.pod:4049
4038 #: ../src/guestfs-actions.pod:4066 ../src/guestfs-actions.pod:4079
4039 #: ../src/guestfs-actions.pod:4094 ../src/guestfs-actions.pod:4109
4040 #: ../src/guestfs-actions.pod:4144 ../src/guestfs-actions.pod:4159
4041 #: ../src/guestfs-actions.pod:4179 ../src/guestfs-actions.pod:4193
4042 #: ../src/guestfs-actions.pod:4210 ../src/guestfs-actions.pod:4259
4043 #: ../src/guestfs-actions.pod:4296 ../src/guestfs-actions.pod:4310
4044 #: ../src/guestfs-actions.pod:4338 ../src/guestfs-actions.pod:4355
4045 #: ../src/guestfs-actions.pod:4373 ../src/guestfs-actions.pod:4507
4046 #: ../src/guestfs-actions.pod:4564 ../src/guestfs-actions.pod:4586
4047 #: ../src/guestfs-actions.pod:4604 ../src/guestfs-actions.pod:4636
4048 #: ../src/guestfs-actions.pod:4702 ../src/guestfs-actions.pod:4719
4049 #: ../src/guestfs-actions.pod:4732 ../src/guestfs-actions.pod:4746
4050 #: ../src/guestfs-actions.pod:5035 ../src/guestfs-actions.pod:5054
4051 #: ../src/guestfs-actions.pod:5068 ../src/guestfs-actions.pod:5080
4052 #: ../src/guestfs-actions.pod:5094 ../src/guestfs-actions.pod:5106
4053 #: ../src/guestfs-actions.pod:5120 ../src/guestfs-actions.pod:5136
4054 #: ../src/guestfs-actions.pod:5157 ../src/guestfs-actions.pod:5176
4055 #: ../src/guestfs-actions.pod:5195 ../src/guestfs-actions.pod:5213
4056 #: ../src/guestfs-actions.pod:5236 ../src/guestfs-actions.pod:5254
4057 #: ../src/guestfs-actions.pod:5273 ../src/guestfs-actions.pod:5294
4058 #: ../src/guestfs-actions.pod:5313 ../src/guestfs-actions.pod:5330
4059 #: ../src/guestfs-actions.pod:5358 ../src/guestfs-actions.pod:5382
4060 #: ../src/guestfs-actions.pod:5401 ../src/guestfs-actions.pod:5425
4061 #: ../src/guestfs-actions.pod:5440 ../src/guestfs-actions.pod:5455
4062 #: ../src/guestfs-actions.pod:5474 ../src/guestfs-actions.pod:5511
4063 #: ../src/guestfs-actions.pod:5534 ../src/guestfs-actions.pod:5560
4064 #: ../src/guestfs-actions.pod:5668 ../src/guestfs-actions.pod:5789
4065 #: ../src/guestfs-actions.pod:5801 ../src/guestfs-actions.pod:5814
4066 #: ../src/guestfs-actions.pod:5827 ../src/guestfs-actions.pod:5849
4067 #: ../src/guestfs-actions.pod:5862 ../src/guestfs-actions.pod:5875
4068 #: ../src/guestfs-actions.pod:5888 ../src/guestfs-actions.pod:5903
4069 #: ../src/guestfs-actions.pod:5962 ../src/guestfs-actions.pod:5979
4070 #: ../src/guestfs-actions.pod:5995 ../src/guestfs-actions.pod:6011
4071 #: ../src/guestfs-actions.pod:6028 ../src/guestfs-actions.pod:6041
4072 #: ../src/guestfs-actions.pod:6061 ../src/guestfs-actions.pod:6097
4073 #: ../src/guestfs-actions.pod:6111 ../src/guestfs-actions.pod:6152
4074 #: ../src/guestfs-actions.pod:6165 ../src/guestfs-actions.pod:6183
4075 #: ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:6243
4076 #: ../src/guestfs-actions.pod:6362 ../src/guestfs-actions.pod:6380
4077 #: ../src/guestfs-actions.pod:6394 ../src/guestfs-actions.pod:6449
4078 #: ../src/guestfs-actions.pod:6462 ../src/guestfs-actions.pod:6507
4079 #: ../src/guestfs-actions.pod:6540 ../src/guestfs-actions.pod:6594
4080 #: ../src/guestfs-actions.pod:6620 ../src/guestfs-actions.pod:6686
4081 #: ../src/guestfs-actions.pod:6705 ../src/guestfs-actions.pod:6734
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:6628 ../src/guestfs-actions.pod:6797
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:4377 ../fish/guestfish-actions.pod:4474
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:2991 ../src/guestfs-actions.pod:3006
4114 #: ../src/guestfs-actions.pod:4146 ../src/guestfs-actions.pod:5215
4115 #: ../src/guestfs-actions.pod:5332 ../src/guestfs-actions.pod:5442
4116 #: ../src/guestfs-actions.pod:5905 ../src/guestfs-actions.pod:6030
4117 #: ../src/guestfs-actions.pod:6542
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:4282
4215 #: ../src/guestfs-actions.pod:4410 ../src/guestfs-actions.pod:4816
4216 #: ../src/guestfs-actions.pod:4842 ../src/guestfs-actions.pod:6138
4217 #: ../src/guestfs-actions.pod:6553 ../src/guestfs-actions.pod:6566
4218 #: ../src/guestfs-actions.pod:6579
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:4893
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:2679 ../src/guestfs-actions.pod:2735
4698 #: ../src/guestfs-actions.pod:2758 ../src/guestfs-actions.pod:3135
4699 #: ../src/guestfs-actions.pod:3485 ../src/guestfs-actions.pod:3655
4700 #: ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:4428
4701 #: ../src/guestfs-actions.pod:4621 ../src/guestfs-actions.pod:4791
4702 #: ../src/guestfs-actions.pod:4969 ../src/guestfs-actions.pod:5018
4703 #: ../src/guestfs-actions.pod:5581 ../src/guestfs-actions.pod:5597
4704 #: ../src/guestfs-actions.pod:5614 ../src/guestfs-actions.pod:5638
4705 #: ../src/guestfs-actions.pod:6302 ../src/guestfs-actions.pod:6321
4706 #: ../src/guestfs-actions.pod:6339 ../src/guestfs-actions.pod:6519
4707 #: ../src/guestfs-actions.pod:6791
4709 "This function returns a string, or NULL on error. I<The caller must free "
4710 "the returned string after use>."
4714 #: ../src/guestfs-actions.pod:354
4715 msgid "guestfs_aug_init"
4719 #: ../src/guestfs-actions.pod:356
4723 " guestfs_aug_init (guestfs_h *g,\n"
4724 " const char *root,\n"
4730 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:227
4732 "Create a new Augeas handle for editing configuration files. If there was "
4733 "any previous Augeas handle associated with this guestfs session, then it is "
4738 #: ../src/guestfs-actions.pod:365
4739 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4743 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:234
4745 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4749 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:237
4751 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4752 "logical I<or> of the following integers:"
4756 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:243
4757 msgid "C<AUG_SAVE_BACKUP> = 1"
4761 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:245
4762 msgid "Keep the original file with a C<.augsave> extension."
4766 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:247
4767 msgid "C<AUG_SAVE_NEWFILE> = 2"
4771 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:249
4773 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4774 "original. Overrides C<AUG_SAVE_BACKUP>."
4778 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:252
4779 msgid "C<AUG_TYPE_CHECK> = 4"
4783 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:254
4784 msgid "Typecheck lenses (can be expensive)."
4788 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:256
4789 msgid "C<AUG_NO_STDINC> = 8"
4793 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:258
4794 msgid "Do not use standard load path for modules."
4798 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:260
4799 msgid "C<AUG_SAVE_NOOP> = 16"
4803 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:262
4804 msgid "Make save a no-op, just record what would have been changed."
4808 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:264
4809 msgid "C<AUG_NO_LOAD> = 32"
4813 #: ../src/guestfs-actions.pod:400
4814 msgid "Do not load the tree in C<guestfs_aug_init>."
4818 #: ../src/guestfs-actions.pod:404
4819 msgid "To close the handle, you can call C<guestfs_aug_close>."
4823 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:272
4824 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4828 #: ../src/guestfs-actions.pod:412
4829 msgid "guestfs_aug_insert"
4833 #: ../src/guestfs-actions.pod:414
4837 " guestfs_aug_insert (guestfs_h *g,\n"
4838 " const char *augpath,\n"
4839 " const char *label,\n"
4845 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:278
4847 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4848 "or after C<path> (depending on the boolean flag C<before>)."
4852 #: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:282
4854 "C<path> must match exactly one existing node in the tree, and C<label> must "
4855 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4859 #: ../src/guestfs-actions.pod:432
4860 msgid "guestfs_aug_load"
4864 #: ../src/guestfs-actions.pod:434
4868 " guestfs_aug_load (guestfs_h *g);\n"
4873 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:290
4874 msgid "Load files into the tree."
4878 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:292
4879 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4883 #: ../src/guestfs-actions.pod:446
4884 msgid "guestfs_aug_ls"
4888 #: ../src/guestfs-actions.pod:448
4892 " guestfs_aug_ls (guestfs_h *g,\n"
4893 " const char *augpath);\n"
4898 #: ../src/guestfs-actions.pod:452
4900 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
4901 "sorting the resulting nodes into alphabetical order."
4905 #: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:471
4906 #: ../src/guestfs-actions.pod:617 ../src/guestfs-actions.pod:1065
4907 #: ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1375
4908 #: ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1497
4909 #: ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:2148
4910 #: ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:2183
4911 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:2250
4912 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2370
4913 #: ../src/guestfs-actions.pod:2573 ../src/guestfs-actions.pod:2698
4914 #: ../src/guestfs-actions.pod:2800 ../src/guestfs-actions.pod:3055
4915 #: ../src/guestfs-actions.pod:3117 ../src/guestfs-actions.pod:3222
4916 #: ../src/guestfs-actions.pod:3627 ../src/guestfs-actions.pod:4243
4917 #: ../src/guestfs-actions.pod:4763 ../src/guestfs-actions.pod:4889
4918 #: ../src/guestfs-actions.pod:5003 ../src/guestfs-actions.pod:5654
4919 #: ../src/guestfs-actions.pod:5715 ../src/guestfs-actions.pod:5770
4920 #: ../src/guestfs-actions.pod:5916 ../src/guestfs-actions.pod:5940
4921 #: ../src/guestfs-actions.pod:6412 ../src/guestfs-actions.pod:6432
4922 #: ../src/guestfs-actions.pod:6479 ../src/guestfs-actions.pod:6644
4923 #: ../src/guestfs-actions.pod:6663 ../src/guestfs-actions.pod:6748
4924 #: ../src/guestfs-actions.pod:6767 ../src/guestfs-actions.pod:6813
4925 #: ../src/guestfs-actions.pod:6832
4927 "This function returns a NULL-terminated array of strings (like L<environ(3)"
4928 ">), or NULL if there was an error. I<The caller must free the strings and "
4929 "the array after use>."
4933 #: ../src/guestfs-actions.pod:459 ../src/guestfs-actions.pod:990
4934 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1413
4935 #: ../src/guestfs-actions.pod:2878 ../src/guestfs-actions.pod:2909
4936 #: ../src/guestfs-actions.pod:3468 ../src/guestfs-actions.pod:3518
4937 #: ../src/guestfs-actions.pod:3705 ../src/guestfs-actions.pod:3738
4938 #: ../src/guestfs-actions.pod:3901 ../src/guestfs-actions.pod:4247
4939 #: ../src/guestfs-actions.pod:4704 ../src/guestfs-actions.pod:5082
4940 #: ../src/guestfs-actions.pod:5096 ../src/guestfs-actions.pod:5108
4941 #: ../src/guestfs-actions.pod:5516 ../src/guestfs-actions.pod:6154
4942 #: ../src/guestfs-actions.pod:6167 ../src/guestfs-actions.pod:6396
4943 #: ../src/guestfs-actions.pod:6599 ../src/guestfs-actions.pod:6632
4944 msgid "(Added in 0.8)"
4948 #: ../src/guestfs-actions.pod:461
4949 msgid "guestfs_aug_match"
4953 #: ../src/guestfs-actions.pod:463
4957 " guestfs_aug_match (guestfs_h *g,\n"
4958 " const char *augpath);\n"
4963 #: ../src/guestfs-actions.pod:467 ../fish/guestfish-actions.pod:306
4965 "Returns a list of paths which match the path expression C<path>. The "
4966 "returned paths are sufficiently qualified so that they match exactly one "
4967 "node in the current tree."
4971 #: ../src/guestfs-actions.pod:477
4972 msgid "guestfs_aug_mv"
4976 #: ../src/guestfs-actions.pod:479
4980 " guestfs_aug_mv (guestfs_h *g,\n"
4981 " const char *src,\n"
4982 " const char *dest);\n"
4987 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:314
4989 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4990 "C<dest> is overwritten if it exists."
4994 #: ../src/guestfs-actions.pod:491
4995 msgid "guestfs_aug_rm"
4999 #: ../src/guestfs-actions.pod:493
5003 " guestfs_aug_rm (guestfs_h *g,\n"
5004 " const char *augpath);\n"
5009 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:321
5010 msgid "Remove C<path> and all of its children."
5014 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:323
5015 msgid "On success this returns the number of entries which were removed."
5019 #: ../src/guestfs-actions.pod:505
5020 msgid "guestfs_aug_save"
5024 #: ../src/guestfs-actions.pod:507
5028 " guestfs_aug_save (guestfs_h *g);\n"
5033 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:329
5034 msgid "This writes all pending changes to disk."
5038 #: ../src/guestfs-actions.pod:512
5040 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5045 #: ../src/guestfs-actions.pod:519
5046 msgid "guestfs_aug_set"
5050 #: ../src/guestfs-actions.pod:521
5054 " guestfs_aug_set (guestfs_h *g,\n"
5055 " const char *augpath,\n"
5056 " const char *val);\n"
5061 #: ../src/guestfs-actions.pod:526 ../fish/guestfish-actions.pod:338
5062 msgid "Set the value associated with C<path> to C<val>."
5066 #: ../src/guestfs-actions.pod:528
5068 "In the Augeas API, it is possible to clear a node by setting the value to "
5069 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5070 "this call. Instead you must use the C<guestfs_aug_clear> call."
5074 #: ../src/guestfs-actions.pod:537
5075 msgid "guestfs_available"
5079 #: ../src/guestfs-actions.pod:539
5083 " guestfs_available (guestfs_h *g,\n"
5084 " char *const *groups);\n"
5089 #: ../src/guestfs-actions.pod:543 ../fish/guestfish-actions.pod:349
5091 "This command is used to check the availability of some groups of "
5092 "functionality in the appliance, which not all builds of the libguestfs "
5093 "appliance will be able to provide."
5097 #: ../src/guestfs-actions.pod:547
5099 "The libguestfs groups, and the functions that those groups correspond to, "
5100 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5101 "runtime by calling C<guestfs_available_all_groups>."
5105 #: ../src/guestfs-actions.pod:552 ../fish/guestfish-actions.pod:358
5107 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
5108 "\"]> would check for the availability of the Linux inotify functions and "
5109 "Augeas (configuration file editing) functions."
5113 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:363
5114 msgid "The command returns no error if I<all> requested groups are available."
5118 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:365
5120 "It fails with an error if one or more of the requested groups is unavailable "
5125 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:368
5127 "If an unknown group name is included in the list of groups then an error is "
5132 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:371
5137 #: ../src/guestfs-actions.pod:571
5138 msgid "You must call C<guestfs_launch> before calling this function."
5142 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:379
5144 "The reason is because we don't know what groups are supported by the "
5145 "appliance/daemon until it is running and can be queried."
5149 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:385
5151 "If a group of functions is available, this does not necessarily mean that "
5152 "they will work. You still have to check for errors when calling individual "
5153 "API functions even if they are available."
5157 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:392
5159 "It is usually the job of distro packagers to build complete functionality "
5160 "into the libguestfs appliance. Upstream libguestfs, if built from source "
5161 "with all requirements satisfied, will support everything."
5165 #: ../src/guestfs-actions.pod:593
5167 "This call was added in version C<1.0.80>. In previous versions of "
5168 "libguestfs all you could do would be to speculatively execute a command to "
5169 "find out if the daemon implemented it. See also C<guestfs_version>."
5173 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:1163
5174 msgid "(Added in 1.0.80)"
5178 #: ../src/guestfs-actions.pod:604
5179 msgid "guestfs_available_all_groups"
5183 #: ../src/guestfs-actions.pod:606
5187 " guestfs_available_all_groups (guestfs_h *g);\n"
5192 #: ../src/guestfs-actions.pod:609
5194 "This command returns a list of all optional groups that this daemon knows "
5195 "about. Note this returns both supported and unsupported groups. To find "
5196 "out which ones the daemon can actually support you have to call "
5197 "C<guestfs_available> on each member of the returned list."
5201 #: ../src/guestfs-actions.pod:615
5202 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
5206 #: ../src/guestfs-actions.pod:621
5207 msgid "(Added in 1.3.15)"
5211 #: ../src/guestfs-actions.pod:623
5212 msgid "guestfs_base64_in"
5216 #: ../src/guestfs-actions.pod:625
5220 " guestfs_base64_in (guestfs_h *g,\n"
5221 " const char *base64file,\n"
5222 " const char *filename);\n"
5227 #: ../src/guestfs-actions.pod:630 ../fish/guestfish-actions.pod:422
5229 "This command uploads base64-encoded data from C<base64file> to C<filename>."
5233 #: ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649
5234 msgid "(Added in 1.3.5)"
5238 #: ../src/guestfs-actions.pod:637
5239 msgid "guestfs_base64_out"
5243 #: ../src/guestfs-actions.pod:639
5247 " guestfs_base64_out (guestfs_h *g,\n"
5248 " const char *filename,\n"
5249 " const char *base64file);\n"
5254 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:431
5256 "This command downloads the contents of C<filename>, writing it out to local "
5257 "file C<base64file> encoded as base64."
5261 #: ../src/guestfs-actions.pod:651
5262 msgid "guestfs_blockdev_flushbufs"
5266 #: ../src/guestfs-actions.pod:653
5270 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
5271 " const char *device);\n"
5276 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:440
5278 "This tells the kernel to flush internal buffers associated with C<device>."
5282 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:677
5283 #: ../src/guestfs-actions.pod:692 ../src/guestfs-actions.pod:708
5284 #: ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:745
5285 #: ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:777
5286 #: ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805
5287 #: ../fish/guestfish-actions.pod:443 ../fish/guestfish-actions.pod:454
5288 #: ../fish/guestfish-actions.pod:463 ../fish/guestfish-actions.pod:473
5289 #: ../fish/guestfish-actions.pod:485 ../fish/guestfish-actions.pod:498
5290 #: ../fish/guestfish-actions.pod:506 ../fish/guestfish-actions.pod:517
5291 #: ../fish/guestfish-actions.pod:525 ../fish/guestfish-actions.pod:533
5292 msgid "This uses the L<blockdev(8)> command."
5296 #: ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:681
5297 #: ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:712
5298 #: ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749
5299 #: ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781
5300 #: ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809
5301 msgid "(Added in 0.9.3)"
5305 #: ../src/guestfs-actions.pod:666
5306 msgid "guestfs_blockdev_getbsz"
5310 #: ../src/guestfs-actions.pod:668
5314 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
5315 " const char *device);\n"
5320 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:449
5321 msgid "This returns the block size of a device."
5325 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:774
5326 #: ../fish/guestfish-actions.pod:451 ../fish/guestfish-actions.pod:514
5328 "(Note this is different from both I<size in blocks> and I<filesystem block "
5333 #: ../src/guestfs-actions.pod:683
5334 msgid "guestfs_blockdev_getro"
5338 #: ../src/guestfs-actions.pod:685
5342 " guestfs_blockdev_getro (guestfs_h *g,\n"
5343 " const char *device);\n"
5348 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:460
5350 "Returns a boolean indicating if the block device is read-only (true if read-"
5351 "only, false if not)."
5355 #: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:1396
5356 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:1891
5357 #: ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:1974
5358 #: ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2044
5359 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2092
5360 #: ../src/guestfs-actions.pod:2817 ../src/guestfs-actions.pod:2831
5361 #: ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:2860
5362 #: ../src/guestfs-actions.pod:2876 ../src/guestfs-actions.pod:2891
5363 #: ../src/guestfs-actions.pod:2907 ../src/guestfs-actions.pod:2921
5364 #: ../src/guestfs-actions.pod:2934 ../src/guestfs-actions.pod:2948
5365 #: ../src/guestfs-actions.pod:2963 ../src/guestfs-actions.pod:2978
5366 #: ../src/guestfs-actions.pod:4392
5367 msgid "This function returns a C truth value on success or -1 on error."
5371 #: ../src/guestfs-actions.pod:698
5372 msgid "guestfs_blockdev_getsize64"
5376 #: ../src/guestfs-actions.pod:700
5380 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
5381 " const char *device);\n"
5386 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:469
5387 msgid "This returns the size of the device in bytes."
5391 #: ../src/guestfs-actions.pod:706
5392 msgid "See also C<guestfs_blockdev_getsz>."
5396 #: ../src/guestfs-actions.pod:714
5397 msgid "guestfs_blockdev_getss"
5401 #: ../src/guestfs-actions.pod:716
5405 " guestfs_blockdev_getss (guestfs_h *g,\n"
5406 " const char *device);\n"
5411 #: ../src/guestfs-actions.pod:720 ../fish/guestfish-actions.pod:479
5413 "This returns the size of sectors on a block device. Usually 512, but can be "
5414 "larger for modern devices."
5418 #: ../src/guestfs-actions.pod:723
5420 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
5425 #: ../src/guestfs-actions.pod:732
5426 msgid "guestfs_blockdev_getsz"
5430 #: ../src/guestfs-actions.pod:734
5434 " guestfs_blockdev_getsz (guestfs_h *g,\n"
5435 " const char *device);\n"
5440 #: ../src/guestfs-actions.pod:738 ../fish/guestfish-actions.pod:491
5442 "This returns the size of the device in units of 512-byte sectors (even if "
5443 "the sectorsize isn't 512 bytes ... weird)."
5447 #: ../src/guestfs-actions.pod:741
5449 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
5450 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
5454 #: ../src/guestfs-actions.pod:751
5455 msgid "guestfs_blockdev_rereadpt"
5459 #: ../src/guestfs-actions.pod:753
5463 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5464 " const char *device);\n"
5469 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:504
5470 msgid "Reread the partition table on C<device>."
5474 #: ../src/guestfs-actions.pod:765
5475 msgid "guestfs_blockdev_setbsz"
5479 #: ../src/guestfs-actions.pod:767
5483 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5484 " const char *device,\n"
5485 " int blocksize);\n"
5490 #: ../src/guestfs-actions.pod:772 ../fish/guestfish-actions.pod:512
5491 msgid "This sets the block size of a device."
5495 #: ../src/guestfs-actions.pod:783
5496 msgid "guestfs_blockdev_setro"
5500 #: ../src/guestfs-actions.pod:785
5504 " guestfs_blockdev_setro (guestfs_h *g,\n"
5505 " const char *device);\n"
5510 #: ../src/guestfs-actions.pod:789 ../fish/guestfish-actions.pod:523
5511 msgid "Sets the block device named C<device> to read-only."
5515 #: ../src/guestfs-actions.pod:797
5516 msgid "guestfs_blockdev_setrw"
5520 #: ../src/guestfs-actions.pod:799
5524 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5525 " const char *device);\n"
5530 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:531
5531 msgid "Sets the block device named C<device> to read-write."
5535 #: ../src/guestfs-actions.pod:811
5536 msgid "guestfs_case_sensitive_path"
5540 #: ../src/guestfs-actions.pod:813
5544 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5545 " const char *path);\n"
5550 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:539
5552 "This can be used to resolve case insensitive paths on a filesystem which is "
5553 "case sensitive. The use case is to resolve paths which you have read from "
5554 "Windows configuration files or the Windows Registry, to the true path."
5558 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:544
5560 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5561 "(and probably others), which is that although the underlying filesystem is "
5562 "case-insensitive, the driver exports the filesystem to Linux as case-"
5567 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:549
5569 "One consequence of this is that special directories such as C<c:\\windows> "
5570 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5571 "precise details of how they were created. In Windows itself this would not "
5576 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:555
5578 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
5583 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:558
5585 "This function resolves the true case of each element in the path and returns "
5586 "the case-sensitive path."
5590 #: ../src/guestfs-actions.pod:839
5592 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
5593 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5594 "how the directories were originally created under Windows)."
5598 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:566
5599 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5603 #: ../src/guestfs-actions.pod:847
5604 msgid "See also C<guestfs_realpath>."
5608 #: ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:6324
5609 msgid "(Added in 1.0.75)"
5613 #: ../src/guestfs-actions.pod:854
5618 #: ../src/guestfs-actions.pod:856
5622 " guestfs_cat (guestfs_h *g,\n"
5623 " const char *path);\n"
5628 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:4879
5629 #: ../fish/guestfish-actions.pod:575 ../fish/guestfish-actions.pod:3221
5630 msgid "Return the contents of the file named C<path>."
5634 #: ../src/guestfs-actions.pod:862
5636 "Note that this function cannot correctly handle binary files (specifically, "
5637 "files containing C<\\0> character which is treated as end of string). For "
5638 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5639 "functions which have a more complex interface."
5643 #: ../src/guestfs-actions.pod:870 ../src/guestfs-actions.pod:1049
5644 #: ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1360
5645 #: ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1482
5646 #: ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1750
5647 #: ../src/guestfs-actions.pod:2168 ../src/guestfs-actions.pod:2187
5648 #: ../src/guestfs-actions.pod:2230 ../src/guestfs-actions.pod:2254
5649 #: ../src/guestfs-actions.pod:2271 ../src/guestfs-actions.pod:2300
5650 #: ../src/guestfs-actions.pod:4661 ../src/guestfs-actions.pod:4687
5651 #: ../src/guestfs-actions.pod:4818 ../src/guestfs-actions.pod:4844
5652 #: ../src/guestfs-actions.pod:4868 ../src/guestfs-actions.pod:5719
5653 #: ../src/guestfs-actions.pod:5774 ../src/guestfs-actions.pod:5920
5654 #: ../src/guestfs-actions.pod:5944 ../src/guestfs-actions.pod:6596
5655 #: ../src/guestfs-actions.pod:6622 ../src/guestfs-actions.pod:6648
5656 #: ../src/guestfs-actions.pod:6667 ../src/guestfs-actions.pod:6752
5657 #: ../src/guestfs-actions.pod:6771 ../src/guestfs-actions.pod:6817
5658 #: ../src/guestfs-actions.pod:6836 ../fish/guestfish-actions.pod:582
5659 #: ../fish/guestfish-actions.pod:717 ../fish/guestfish-actions.pod:729
5660 #: ../fish/guestfish-actions.pod:905 ../fish/guestfish-actions.pod:915
5661 #: ../fish/guestfish-actions.pod:982 ../fish/guestfish-actions.pod:992
5662 #: ../fish/guestfish-actions.pod:1187 ../fish/guestfish-actions.pod:1462
5663 #: ../fish/guestfish-actions.pod:1472 ../fish/guestfish-actions.pod:1500
5664 #: ../fish/guestfish-actions.pod:1515 ../fish/guestfish-actions.pod:1525
5665 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:3091
5666 #: ../fish/guestfish-actions.pod:3106 ../fish/guestfish-actions.pod:3182
5667 #: ../fish/guestfish-actions.pod:3199 ../fish/guestfish-actions.pod:3214
5668 #: ../fish/guestfish-actions.pod:3797 ../fish/guestfish-actions.pod:3843
5669 #: ../fish/guestfish-actions.pod:3928 ../fish/guestfish-actions.pod:3943
5670 #: ../fish/guestfish-actions.pod:4353 ../fish/guestfish-actions.pod:4371
5671 #: ../fish/guestfish-actions.pod:4388 ../fish/guestfish-actions.pod:4398
5672 #: ../fish/guestfish-actions.pod:4446 ../fish/guestfish-actions.pod:4456
5673 #: ../fish/guestfish-actions.pod:4485 ../fish/guestfish-actions.pod:4495
5675 "Because of the message protocol, there is a transfer limit of somewhere "
5676 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5680 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:3059
5681 #: ../src/guestfs-actions.pod:3121 ../src/guestfs-actions.pod:3138
5682 #: ../src/guestfs-actions.pod:3226 ../src/guestfs-actions.pod:3631
5683 #: ../src/guestfs-actions.pod:3645 ../src/guestfs-actions.pod:4767
5684 #: ../src/guestfs-actions.pod:4781 ../src/guestfs-actions.pod:6483
5685 #: ../src/guestfs-actions.pod:6497
5686 msgid "(Added in 0.4)"
5690 #: ../src/guestfs-actions.pod:875
5691 msgid "guestfs_checksum"
5695 #: ../src/guestfs-actions.pod:877
5699 " guestfs_checksum (guestfs_h *g,\n"
5700 " const char *csumtype,\n"
5701 " const char *path);\n"
5706 #: ../src/guestfs-actions.pod:882 ../fish/guestfish-actions.pod:589
5708 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5712 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:592
5714 "The type of checksum to compute is given by the C<csumtype> parameter which "
5715 "must have one of the following values:"
5719 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:597
5724 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:599
5726 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5731 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:602
5736 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:604
5737 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5741 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:606
5746 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:608
5747 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5751 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:610
5756 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:612
5757 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5761 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:614
5766 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:616
5767 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5771 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:618
5776 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:620
5777 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5781 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:622
5786 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:624
5787 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5791 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:628
5792 msgid "The checksum is returned as a printable string."
5796 #: ../src/guestfs-actions.pod:923
5797 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
5801 #: ../src/guestfs-actions.pod:925
5802 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
5806 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:1238
5807 #: ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:2833
5808 #: ../src/guestfs-actions.pod:2862 ../src/guestfs-actions.pod:2923
5809 #: ../src/guestfs-actions.pod:2950 ../src/guestfs-actions.pod:6185
5810 msgid "(Added in 1.0.2)"
5814 #: ../src/guestfs-actions.pod:932
5815 msgid "guestfs_checksum_device"
5819 #: ../src/guestfs-actions.pod:934
5823 " guestfs_checksum_device (guestfs_h *g,\n"
5824 " const char *csumtype,\n"
5825 " const char *device);\n"
5830 #: ../src/guestfs-actions.pod:939
5832 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5833 "device named C<device>. For the types of checksums supported see the "
5834 "C<guestfs_checksum> command."
5838 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:4298
5839 #: ../src/guestfs-actions.pod:4357 ../src/guestfs-actions.pod:4394
5840 #: ../src/guestfs-actions.pod:4412 ../src/guestfs-actions.pod:4588
5841 #: ../src/guestfs-actions.pod:6099 ../src/guestfs-actions.pod:6113
5842 #: ../src/guestfs-actions.pod:6509
5843 msgid "(Added in 1.3.2)"
5847 #: ../src/guestfs-actions.pod:948
5848 msgid "guestfs_checksums_out"
5852 #: ../src/guestfs-actions.pod:950
5856 " guestfs_checksums_out (guestfs_h *g,\n"
5857 " const char *csumtype,\n"
5858 " const char *directory,\n"
5859 " const char *sumsfile);\n"
5864 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:646
5866 "This command computes the checksums of all regular files in C<directory> and "
5867 "then emits a list of those checksums to the local output file C<sumsfile>."
5871 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:650
5873 "This can be used for verifying the integrity of a virtual machine. However "
5874 "to be properly secure you should pay attention to the output of the checksum "
5875 "command (it uses the ones from GNU coreutils). In particular when the "
5876 "filename is not printable, coreutils uses a special backslash syntax. For "
5877 "more information, see the GNU coreutils info file."
5881 #: ../src/guestfs-actions.pod:970
5882 msgid "(Added in 1.3.7)"
5886 #: ../src/guestfs-actions.pod:972
5887 msgid "guestfs_chmod"
5891 #: ../src/guestfs-actions.pod:974
5895 " guestfs_chmod (guestfs_h *g,\n"
5897 " const char *path);\n"
5902 #: ../src/guestfs-actions.pod:979 ../fish/guestfish-actions.pod:664
5904 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5909 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:667
5911 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5912 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5917 #: ../src/guestfs-actions.pod:986 ../src/guestfs-actions.pod:3882
5918 #: ../src/guestfs-actions.pod:3997 ../src/guestfs-actions.pod:4016
5919 #: ../src/guestfs-actions.pod:4035 ../fish/guestfish-actions.pod:671
5920 #: ../fish/guestfish-actions.pod:2581 ../fish/guestfish-actions.pod:2666
5921 #: ../fish/guestfish-actions.pod:2676 ../fish/guestfish-actions.pod:2686
5922 msgid "The mode actually set is affected by the umask."
5926 #: ../src/guestfs-actions.pod:992
5927 msgid "guestfs_chown"
5931 #: ../src/guestfs-actions.pod:994
5935 " guestfs_chown (guestfs_h *g,\n"
5938 " const char *path);\n"
5943 #: ../src/guestfs-actions.pod:1000 ../fish/guestfish-actions.pod:677
5944 msgid "Change the file owner to C<owner> and group to C<group>."
5948 #: ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:3020
5949 #: ../fish/guestfish-actions.pod:679 ../fish/guestfish-actions.pod:2059
5951 "Only numeric uid and gid are supported. If you want to use names, you will "
5952 "need to locate and parse the password file yourself (Augeas support makes "
5953 "this relatively easy)."
5957 #: ../src/guestfs-actions.pod:1010
5958 msgid "guestfs_command"
5962 #: ../src/guestfs-actions.pod:1012
5966 " guestfs_command (guestfs_h *g,\n"
5967 " char *const *arguments);\n"
5972 #: ../src/guestfs-actions.pod:1016 ../fish/guestfish-actions.pod:687
5974 "This call runs a command from the guest filesystem. The filesystem must be "
5975 "mounted, and must contain a compatible operating system (ie. something "
5976 "Linux, with the same or compatible processor architecture)."
5980 #: ../src/guestfs-actions.pod:1021
5982 "The single parameter is an argv-style list of arguments. The first element "
5983 "is the name of the program to run. Subsequent elements are parameters. The "
5984 "list must be non-empty (ie. must contain a program name). Note that the "
5985 "command runs directly, and is I<not> invoked via the shell (see "
5990 #: ../src/guestfs-actions.pod:1028 ../fish/guestfish-actions.pod:699
5991 msgid "The return value is anything printed to I<stdout> by the command."
5995 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:702
5997 "If the command returns a non-zero exit status, then this function returns an "
5998 "error message. The error message string is the content of I<stderr> from "
6003 #: ../src/guestfs-actions.pod:1035 ../fish/guestfish-actions.pod:706
6005 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
6006 "bin>. If you require a program from another location, you should provide "
6007 "the full path in the first parameter."
6011 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:711
6013 "Shared libraries and data files required by the program must be available on "
6014 "filesystems which are mounted in the correct places. It is the caller's "
6015 "responsibility to ensure all filesystems that are needed are mounted at the "
6020 #: ../src/guestfs-actions.pod:1052 ../src/guestfs-actions.pod:1072
6021 #: ../src/guestfs-actions.pod:1535
6022 msgid "(Added in 0.9.1)"
6026 #: ../src/guestfs-actions.pod:1054
6027 msgid "guestfs_command_lines"
6031 #: ../src/guestfs-actions.pod:1056
6035 " guestfs_command_lines (guestfs_h *g,\n"
6036 " char *const *arguments);\n"
6041 #: ../src/guestfs-actions.pod:1060
6043 "This is the same as C<guestfs_command>, but splits the result into a list of "
6048 #: ../src/guestfs-actions.pod:1063
6049 msgid "See also: C<guestfs_sh_lines>"
6053 #: ../src/guestfs-actions.pod:1074
6054 msgid "guestfs_config"
6058 #: ../src/guestfs-actions.pod:1076
6062 " guestfs_config (guestfs_h *g,\n"
6063 " const char *qemuparam,\n"
6064 " const char *qemuvalue);\n"
6069 #: ../src/guestfs-actions.pod:1081 ../fish/guestfish-actions.pod:736
6071 "This can be used to add arbitrary qemu command line parameters of the form "
6072 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
6073 "setting some parameters which would interfere with parameters that we use."
6077 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:741
6078 msgid "The first character of C<param> string must be a C<-> (dash)."
6082 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:743
6083 msgid "C<value> can be NULL."
6087 #: ../src/guestfs-actions.pod:1094
6088 msgid "guestfs_copy_size"
6092 #: ../src/guestfs-actions.pod:1096
6096 " guestfs_copy_size (guestfs_h *g,\n"
6097 " const char *src,\n"
6098 " const char *dest,\n"
6104 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:749
6106 "This command copies exactly C<size> bytes from one source device or file "
6107 "C<src> to another destination device or file C<dest>."
6111 #: ../src/guestfs-actions.pod:1105 ../fish/guestfish-actions.pod:752
6113 "Note this will fail if the source is too short or if the destination is not "
6118 #: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1233
6119 #: ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1684
6120 #: ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:6688
6121 #: ../src/guestfs-actions.pod:6707
6123 "This long-running command can generate progress notification messages so "
6124 "that the caller can display a progress bar or indicator. To receive these "
6125 "messages, the caller must register a progress callback. See L<guestfs(3)/"
6126 "guestfs_set_progress_callback>."
6130 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:3658
6131 #: ../src/guestfs-actions.pod:4794 ../src/guestfs-actions.pod:6416
6132 #: ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:6522
6133 msgid "(Added in 1.0.87)"
6137 #: ../src/guestfs-actions.pod:1117
6142 #: ../src/guestfs-actions.pod:1119
6146 " guestfs_cp (guestfs_h *g,\n"
6147 " const char *src,\n"
6148 " const char *dest);\n"
6153 #: ../src/guestfs-actions.pod:1124 ../fish/guestfish-actions.pod:759
6155 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6156 "destination filename or destination directory."
6160 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143
6161 #: ../src/guestfs-actions.pod:1215 ../src/guestfs-actions.pod:1289
6162 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:4261
6163 #: ../src/guestfs-actions.pod:4638
6164 msgid "(Added in 1.0.18)"
6168 #: ../src/guestfs-actions.pod:1131
6169 msgid "guestfs_cp_a"
6173 #: ../src/guestfs-actions.pod:1133
6177 " guestfs_cp_a (guestfs_h *g,\n"
6178 " const char *src,\n"
6179 " const char *dest);\n"
6184 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:766
6186 "This copies a file or directory from C<src> to C<dest> recursively using the "
6191 #: ../src/guestfs-actions.pod:1145
6196 #: ../src/guestfs-actions.pod:1147
6200 " guestfs_dd (guestfs_h *g,\n"
6201 " const char *src,\n"
6202 " const char *dest);\n"
6207 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:773
6209 "This command copies from one source device or file C<src> to another "
6210 "destination device or file C<dest>. Normally you would use this to copy to "
6211 "or from a device or partition, for example to duplicate a filesystem."
6215 #: ../src/guestfs-actions.pod:1157
6217 "If the destination is a device, it must be as large or larger than the "
6218 "source file or device, otherwise the copy will fail. This command cannot do "
6219 "partial copies (see C<guestfs_copy_size>)."
6223 #: ../src/guestfs-actions.pod:1165
6228 #: ../src/guestfs-actions.pod:1167
6232 " guestfs_df (guestfs_h *g);\n"
6237 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:786
6238 msgid "This command runs the C<df> command to report disk space used."
6242 #: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:1189
6243 #: ../fish/guestfish-actions.pod:788 ../fish/guestfish-actions.pod:799
6245 "This command is mostly useful for interactive sessions. It is I<not> "
6246 "intended that you try to parse the output string. Use C<statvfs> from "
6251 #: ../src/guestfs-actions.pod:1179 ../src/guestfs-actions.pod:1196
6252 #: ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:2233
6253 #: ../src/guestfs-actions.pod:2257 ../src/guestfs-actions.pod:2325
6254 #: ../src/guestfs-actions.pod:3768 ../src/guestfs-actions.pod:4161
6255 #: ../src/guestfs-actions.pod:5923 ../src/guestfs-actions.pod:5947
6256 #: ../src/guestfs-actions.pod:6555 ../src/guestfs-actions.pod:6568
6257 #: ../src/guestfs-actions.pod:6581
6258 msgid "(Added in 1.0.54)"
6262 #: ../src/guestfs-actions.pod:1181
6263 msgid "guestfs_df_h"
6267 #: ../src/guestfs-actions.pod:1183
6271 " guestfs_df_h (guestfs_h *g);\n"
6276 #: ../src/guestfs-actions.pod:1186 ../fish/guestfish-actions.pod:796
6278 "This command runs the C<df -h> command to report disk space used in human-"
6283 #: ../src/guestfs-actions.pod:1198
6284 msgid "guestfs_dmesg"
6288 #: ../src/guestfs-actions.pod:1200
6292 " guestfs_dmesg (guestfs_h *g);\n"
6297 #: ../src/guestfs-actions.pod:1203 ../fish/guestfish-actions.pod:807
6299 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
6300 "This is sometimes useful for extended debugging of problems."
6304 #: ../src/guestfs-actions.pod:1207
6306 "Another way to get the same information is to enable verbose messages with "
6307 "C<guestfs_set_verbose> or by setting the environment variable "
6308 "C<LIBGUESTFS_DEBUG=1> before running the program."
6312 #: ../src/guestfs-actions.pod:1217
6313 msgid "guestfs_download"
6317 #: ../src/guestfs-actions.pod:1219
6321 " guestfs_download (guestfs_h *g,\n"
6322 " const char *remotefilename,\n"
6323 " const char *filename);\n"
6328 #: ../src/guestfs-actions.pod:1224 ../src/guestfs-actions.pod:1249
6329 #: ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:833
6331 "Download file C<remotefilename> and save it as C<filename> on the local "
6336 #: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:6179
6337 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:4101
6338 msgid "C<filename> can also be a named pipe."
6342 #: ../src/guestfs-actions.pod:1229
6343 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
6347 #: ../src/guestfs-actions.pod:1240
6348 msgid "guestfs_download_offset"
6352 #: ../src/guestfs-actions.pod:1242
6356 " guestfs_download_offset (guestfs_h *g,\n"
6357 " const char *remotefilename,\n"
6358 " const char *filename,\n"
6359 " int64_t offset,\n"
6365 #: ../src/guestfs-actions.pod:1252 ../fish/guestfish-actions.pod:836
6367 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6368 "region must be within the file or device)."
6372 #: ../src/guestfs-actions.pod:1255
6374 "Note that there is no limit on the amount of data that can be downloaded "
6375 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
6376 "full amount unless an error occurs."
6380 #: ../src/guestfs-actions.pod:1260
6381 msgid "See also C<guestfs_download>, C<guestfs_pread>."
6385 #: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:6214
6386 msgid "(Added in 1.5.17)"
6390 #: ../src/guestfs-actions.pod:1271
6391 msgid "guestfs_drop_caches"
6395 #: ../src/guestfs-actions.pod:1273
6399 " guestfs_drop_caches (guestfs_h *g,\n"
6400 " int whattodrop);\n"
6405 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:852
6407 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6408 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6409 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6413 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:857
6414 msgid "Setting C<whattodrop> to 3 should drop everything."
6418 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:859
6420 "This automatically calls L<sync(2)> before the operation, so that the "
6421 "maximum guest memory is freed."
6425 #: ../src/guestfs-actions.pod:1291
6430 #: ../src/guestfs-actions.pod:1293
6434 " guestfs_du (guestfs_h *g,\n"
6435 " const char *path);\n"
6440 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:866
6442 "This command runs the C<du -s> command to estimate file space usage for "
6447 #: ../src/guestfs-actions.pod:1300 ../fish/guestfish-actions.pod:869
6449 "C<path> can be a file or a directory. If C<path> is a directory then the "
6450 "estimate includes the contents of the directory and all subdirectories "
6455 #: ../src/guestfs-actions.pod:1304 ../fish/guestfish-actions.pod:873
6457 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6461 #: ../src/guestfs-actions.pod:1311
6462 msgid "guestfs_e2fsck_f"
6466 #: ../src/guestfs-actions.pod:1313
6470 " guestfs_e2fsck_f (guestfs_h *g,\n"
6471 " const char *device);\n"
6476 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:880
6478 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6479 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
6484 #: ../src/guestfs-actions.pod:1321
6486 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
6487 "Normally you should use C<guestfs_fsck>."
6491 #: ../src/guestfs-actions.pod:1326
6492 msgid "(Added in 1.0.29)"
6496 #: ../src/guestfs-actions.pod:1328
6497 msgid "guestfs_echo_daemon"
6501 #: ../src/guestfs-actions.pod:1330
6505 " guestfs_echo_daemon (guestfs_h *g,\n"
6506 " char *const *words);\n"
6511 #: ../src/guestfs-actions.pod:1334 ../fish/guestfish-actions.pod:891
6513 "This command concatenates the list of C<words> passed with single spaces "
6514 "between them and returns the resulting string."
6518 #: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:894
6519 msgid "You can use this command to test the connection through to the daemon."
6523 #: ../src/guestfs-actions.pod:1339
6524 msgid "See also C<guestfs_ping_daemon>."
6528 #: ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:2071
6529 #: ../src/guestfs-actions.pod:5427
6530 msgid "(Added in 1.0.69)"
6534 #: ../src/guestfs-actions.pod:1346
6535 msgid "guestfs_egrep"
6539 #: ../src/guestfs-actions.pod:1348
6543 " guestfs_egrep (guestfs_h *g,\n"
6544 " const char *regex,\n"
6545 " const char *path);\n"
6550 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:902
6552 "This calls the external C<egrep> program and returns the matching lines."
6556 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1382
6557 #: ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1485
6558 #: ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:2171
6559 #: ../src/guestfs-actions.pod:2190 ../src/guestfs-actions.pod:2346
6560 #: ../src/guestfs-actions.pod:2359 ../src/guestfs-actions.pod:2374
6561 #: ../src/guestfs-actions.pod:2420 ../src/guestfs-actions.pod:2442
6562 #: ../src/guestfs-actions.pod:2455 ../src/guestfs-actions.pod:3151
6563 #: ../src/guestfs-actions.pod:3165 ../src/guestfs-actions.pod:3178
6564 #: ../src/guestfs-actions.pod:3192 ../src/guestfs-actions.pod:4096
6565 #: ../src/guestfs-actions.pod:4972 ../src/guestfs-actions.pod:5021
6566 #: ../src/guestfs-actions.pod:5791 ../src/guestfs-actions.pod:5803
6567 #: ../src/guestfs-actions.pod:5816 ../src/guestfs-actions.pod:5829
6568 #: ../src/guestfs-actions.pod:5851 ../src/guestfs-actions.pod:5864
6569 #: ../src/guestfs-actions.pod:5877 ../src/guestfs-actions.pod:5890
6570 #: ../src/guestfs-actions.pod:6651 ../src/guestfs-actions.pod:6670
6571 #: ../src/guestfs-actions.pod:6755 ../src/guestfs-actions.pod:6774
6572 #: ../src/guestfs-actions.pod:6820 ../src/guestfs-actions.pod:6839
6573 msgid "(Added in 1.0.66)"
6577 #: ../src/guestfs-actions.pod:1365
6578 msgid "guestfs_egrepi"
6582 #: ../src/guestfs-actions.pod:1367
6586 " guestfs_egrepi (guestfs_h *g,\n"
6587 " const char *regex,\n"
6588 " const char *path);\n"
6593 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
6595 "This calls the external C<egrep -i> program and returns the matching lines."
6599 #: ../src/guestfs-actions.pod:1384
6600 msgid "guestfs_equal"
6604 #: ../src/guestfs-actions.pod:1386
6608 " guestfs_equal (guestfs_h *g,\n"
6609 " const char *file1,\n"
6610 " const char *file2);\n"
6615 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
6617 "This compares the two files C<file1> and C<file2> and returns true if their "
6618 "content is exactly equal, or false otherwise."
6622 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:925
6623 msgid "The external L<cmp(1)> program is used for the comparison."
6627 #: ../src/guestfs-actions.pod:1400
6628 msgid "guestfs_exists"
6632 #: ../src/guestfs-actions.pod:1402
6636 " guestfs_exists (guestfs_h *g,\n"
6637 " const char *path);\n"
6642 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:931
6644 "This returns C<true> if and only if there is a file, directory (or anything) "
6645 "with the given C<path> name."
6649 #: ../src/guestfs-actions.pod:1409
6650 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6654 #: ../src/guestfs-actions.pod:1415
6655 msgid "guestfs_fallocate"
6659 #: ../src/guestfs-actions.pod:1417
6663 " guestfs_fallocate (guestfs_h *g,\n"
6664 " const char *path,\n"
6670 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1448
6671 #: ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:959
6673 "This command preallocates a file (containing zero bytes) named C<path> of "
6674 "size C<len> bytes. If the file exists already, it is overwritten."
6678 #: ../src/guestfs-actions.pod:1426 ../fish/guestfish-actions.pod:944
6680 "Do not confuse this with the guestfish-specific C<alloc> command which "
6681 "allocates a file in the host and attaches it as a device."
6685 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:948
6687 "This function is deprecated. In new code, use the C<fallocate64> call "
6692 #: ../src/guestfs-actions.pod:1441
6693 msgid "guestfs_fallocate64"
6697 #: ../src/guestfs-actions.pod:1443
6701 " guestfs_fallocate64 (guestfs_h *g,\n"
6702 " const char *path,\n"
6708 #: ../src/guestfs-actions.pod:1452
6710 "Note that this call allocates disk blocks for the file. To create a sparse "
6711 "file use C<guestfs_truncate_size> instead."
6715 #: ../src/guestfs-actions.pod:1455
6717 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6718 "oversight it only allowed 30 bit lengths to be specified, effectively "
6719 "limiting the maximum size of files created through that call to 1GB."
6723 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:971
6725 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6726 "commands which create a file in the host and attach it as a device."
6730 #: ../src/guestfs-actions.pod:1466
6731 msgid "(Added in 1.3.17)"
6735 #: ../src/guestfs-actions.pod:1468
6736 msgid "guestfs_fgrep"
6740 #: ../src/guestfs-actions.pod:1470
6744 " guestfs_fgrep (guestfs_h *g,\n"
6745 " const char *pattern,\n"
6746 " const char *path);\n"
6751 #: ../src/guestfs-actions.pod:1475 ../fish/guestfish-actions.pod:979
6753 "This calls the external C<fgrep> program and returns the matching lines."
6757 #: ../src/guestfs-actions.pod:1487
6758 msgid "guestfs_fgrepi"
6762 #: ../src/guestfs-actions.pod:1489
6766 " guestfs_fgrepi (guestfs_h *g,\n"
6767 " const char *pattern,\n"
6768 " const char *path);\n"
6773 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
6775 "This calls the external C<fgrep -i> program and returns the matching lines."
6779 #: ../src/guestfs-actions.pod:1506
6780 msgid "guestfs_file"
6784 #: ../src/guestfs-actions.pod:1508
6788 " guestfs_file (guestfs_h *g,\n"
6789 " const char *path);\n"
6794 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:999
6796 "This call uses the standard L<file(1)> command to determine the type or "
6797 "contents of the file."
6801 #: ../src/guestfs-actions.pod:1515 ../fish/guestfish-actions.pod:1002
6803 "This call will also transparently look inside various types of compressed "
6808 #: ../src/guestfs-actions.pod:1518 ../fish/guestfish-actions.pod:1005
6810 "The exact command which runs is C<file -zb path>. Note in particular that "
6811 "the filename is not prepended to the output (the C<-b> option)."
6815 #: ../src/guestfs-actions.pod:1522
6817 "This command can also be used on C</dev/> devices (and partitions, LV "
6818 "names). You can for example use this to determine if a device contains a "
6819 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
6823 #: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1014
6825 "If the C<path> does not begin with C</dev/> then this command only works for "
6826 "the content of regular files. For other file types (directory, symbolic "
6827 "link etc) it will just return the string C<directory> etc."
6831 #: ../src/guestfs-actions.pod:1537
6832 msgid "guestfs_file_architecture"
6836 #: ../src/guestfs-actions.pod:1539
6840 " guestfs_file_architecture (guestfs_h *g,\n"
6841 " const char *filename);\n"
6846 #: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1023
6848 "This detects the architecture of the binary C<filename>, and returns it if "
6853 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1026
6854 msgid "Currently defined architectures are:"
6858 #: ../src/guestfs-actions.pod:1550 ../fish/guestfish-actions.pod:1030
6863 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1032
6865 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6866 "irrespective of the precise processor requirements of the binary."
6870 #: ../src/guestfs-actions.pod:1555 ../fish/guestfish-actions.pod:1035
6875 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1037
6876 msgid "64 bit x86-64."
6880 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1039
6885 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1041
6886 msgid "32 bit SPARC."
6890 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1043
6895 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1045
6896 msgid "64 bit SPARC V9 and above."
6900 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1047
6905 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1049
6906 msgid "Intel Itanium."
6910 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1051
6915 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1053
6916 msgid "32 bit Power PC."
6920 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1055
6925 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1057
6926 msgid "64 bit Power PC."
6930 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1061
6931 msgid "Libguestfs may return other architecture strings in future."
6935 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1063
6936 msgid "The function works on at least the following types of files:"
6940 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1069
6941 msgid "many types of Un*x and Linux binary"
6945 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1073
6946 msgid "many types of Un*x and Linux shared library"
6950 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1077
6951 msgid "Windows Win32 and Win64 binaries"
6955 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1081
6956 msgid "Windows Win32 and Win64 DLLs"
6960 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1083
6961 msgid "Win32 binaries and DLLs return C<i386>."
6965 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1085
6966 msgid "Win64 binaries and DLLs return C<x86_64>."
6970 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1089
6971 msgid "Linux kernel modules"
6975 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1093
6976 msgid "Linux new-style initrd images"
6980 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1097
6981 msgid "some non-x86 Linux vmlinuz kernels"
6985 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1101
6986 msgid "What it can't do currently:"
6990 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1107
6991 msgid "static libraries (libfoo.a)"
6995 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1111
6996 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7000 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1115
7001 msgid "x86 Linux vmlinuz kernels"
7005 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1117
7007 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7008 "compressed code, and are horribly hard to unpack. If you want to find the "
7009 "architecture of a kernel, use the architecture of the associated initrd or "
7010 "kernel module(s) instead."
7014 #: ../src/guestfs-actions.pod:1647 ../src/guestfs-actions.pod:1810
7015 #: ../src/guestfs-actions.pod:1827 ../src/guestfs-actions.pod:2478
7016 #: ../src/guestfs-actions.pod:2551 ../src/guestfs-actions.pod:2577
7017 #: ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2625
7018 #: ../src/guestfs-actions.pod:2658 ../src/guestfs-actions.pod:2682
7019 #: ../src/guestfs-actions.pod:2738 ../src/guestfs-actions.pod:2804
7020 #: ../src/guestfs-actions.pod:2936
7021 msgid "(Added in 1.5.3)"
7025 #: ../src/guestfs-actions.pod:1649
7026 msgid "guestfs_filesize"
7030 #: ../src/guestfs-actions.pod:1651
7034 " guestfs_filesize (guestfs_h *g,\n"
7035 " const char *file);\n"
7040 #: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1128
7041 msgid "This command returns the size of C<file> in bytes."
7045 #: ../src/guestfs-actions.pod:1657
7047 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
7048 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
7049 "devices, use C<guestfs_blockdev_getsize64>."
7053 #: ../src/guestfs-actions.pod:1663
7054 msgid "(Added in 1.0.82)"
7058 #: ../src/guestfs-actions.pod:1665
7059 msgid "guestfs_fill"
7063 #: ../src/guestfs-actions.pod:1667
7067 " guestfs_fill (guestfs_h *g,\n"
7070 " const char *path);\n"
7075 #: ../src/guestfs-actions.pod:1673 ../fish/guestfish-actions.pod:1138
7077 "This command creates a new file called C<path>. The initial content of the "
7078 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
7083 #: ../src/guestfs-actions.pod:1677
7085 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7086 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7087 "bytes use C<guestfs_fill_pattern>."
7091 #: ../src/guestfs-actions.pod:1689
7092 msgid "(Added in 1.0.79)"
7096 #: ../src/guestfs-actions.pod:1691
7097 msgid "guestfs_fill_pattern"
7101 #: ../src/guestfs-actions.pod:1693
7105 " guestfs_fill_pattern (guestfs_h *g,\n"
7106 " const char *pattern,\n"
7108 " const char *path);\n"
7113 #: ../src/guestfs-actions.pod:1699
7115 "This function is like C<guestfs_fill> except that it creates a new file of "
7116 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7117 "pattern is truncated if necessary to ensure the length of the file is "
7118 "exactly C<len> bytes."
7122 #: ../src/guestfs-actions.pod:1711
7123 msgid "(Added in 1.3.12)"
7127 #: ../src/guestfs-actions.pod:1713
7128 msgid "guestfs_find"
7132 #: ../src/guestfs-actions.pod:1715
7136 " guestfs_find (guestfs_h *g,\n"
7137 " const char *directory);\n"
7142 #: ../src/guestfs-actions.pod:1719 ../fish/guestfish-actions.pod:1160
7144 "This command lists out all files and directories, recursively, starting at "
7145 "C<directory>. It is essentially equivalent to running the shell command "
7146 "C<find directory -print> but some post-processing happens on the output, "
7151 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1165
7153 "This returns a list of strings I<without any prefix>. Thus if the directory "
7158 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1168
7168 #: ../src/guestfs-actions.pod:1731
7170 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7174 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1175
7185 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1180
7186 msgid "If C<directory> is not a directory, then this command returns an error."
7190 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1183
7191 msgid "The returned list is sorted."
7195 #: ../src/guestfs-actions.pod:1744
7196 msgid "See also C<guestfs_find0>."
7200 #: ../src/guestfs-actions.pod:1753 ../src/guestfs-actions.pod:3595
7201 #: ../src/guestfs-actions.pod:5056
7202 msgid "(Added in 1.0.27)"
7206 #: ../src/guestfs-actions.pod:1755
7207 msgid "guestfs_find0"
7211 #: ../src/guestfs-actions.pod:1757
7215 " guestfs_find0 (guestfs_h *g,\n"
7216 " const char *directory,\n"
7217 " const char *files);\n"
7222 #: ../src/guestfs-actions.pod:1762 ../fish/guestfish-actions.pod:1194
7224 "This command lists out all files and directories, recursively, starting at "
7225 "C<directory>, placing the resulting list in the external file called "
7230 #: ../src/guestfs-actions.pod:1766
7232 "This command works the same way as C<guestfs_find> with the following "
7237 #: ../src/guestfs-actions.pod:1773 ../fish/guestfish-actions.pod:1205
7238 msgid "The resulting list is written to an external file."
7242 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1209
7244 "Items (filenames) in the result are separated by C<\\0> characters. See "
7245 "L<find(1)> option I<-print0>."
7249 #: ../src/guestfs-actions.pod:1782 ../fish/guestfish-actions.pod:1214
7250 msgid "This command is not limited in the number of names that it can return."
7254 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1219
7255 msgid "The result list is not sorted."
7259 #: ../src/guestfs-actions.pod:1793
7260 msgid "(Added in 1.0.74)"
7264 #: ../src/guestfs-actions.pod:1795
7265 msgid "guestfs_findfs_label"
7269 #: ../src/guestfs-actions.pod:1797
7273 " guestfs_findfs_label (guestfs_h *g,\n"
7274 " const char *label);\n"
7279 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1229
7281 "This command searches the filesystems and returns the one which has the "
7282 "given label. An error is returned if no such filesystem can be found."
7286 #: ../src/guestfs-actions.pod:1805
7287 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
7291 #: ../src/guestfs-actions.pod:1812
7292 msgid "guestfs_findfs_uuid"
7296 #: ../src/guestfs-actions.pod:1814
7300 " guestfs_findfs_uuid (guestfs_h *g,\n"
7301 " const char *uuid);\n"
7306 #: ../src/guestfs-actions.pod:1818 ../fish/guestfish-actions.pod:1239
7308 "This command searches the filesystems and returns the one which has the "
7309 "given UUID. An error is returned if no such filesystem can be found."
7313 #: ../src/guestfs-actions.pod:1822
7314 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
7318 #: ../src/guestfs-actions.pod:1829
7319 msgid "guestfs_fsck"
7323 #: ../src/guestfs-actions.pod:1831
7327 " guestfs_fsck (guestfs_h *g,\n"
7328 " const char *fstype,\n"
7329 " const char *device);\n"
7334 #: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1249
7336 "This runs the filesystem checker (fsck) on C<device> which should have "
7337 "filesystem type C<fstype>."
7341 #: ../src/guestfs-actions.pod:1839 ../fish/guestfish-actions.pod:1252
7343 "The returned integer is the status. See L<fsck(8)> for the list of status "
7344 "codes from C<fsck>."
7348 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1261
7349 msgid "Multiple status codes can be summed together."
7353 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1265
7355 "A non-zero return code can mean \"success\", for example if errors have been "
7356 "corrected on the filesystem."
7360 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1270
7361 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
7365 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1275
7367 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
7371 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:6693
7372 msgid "(Added in 1.0.16)"
7376 #: ../src/guestfs-actions.pod:1868
7377 msgid "guestfs_get_append"
7381 #: ../src/guestfs-actions.pod:1870
7385 " guestfs_get_append (guestfs_h *g);\n"
7390 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1281
7392 "Return the additional kernel options which are added to the guest kernel "
7397 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1284
7398 msgid "If C<NULL> then no options are added."
7402 #: ../src/guestfs-actions.pod:1878
7404 "This function returns a string which may be NULL. There is no way to return "
7405 "an error from this function. The string is owned by the guest handle and "
7406 "must I<not> be freed."
7410 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:4734
7411 #: ../src/guestfs-actions.pod:5197 ../src/guestfs-actions.pod:5565
7412 #: ../src/guestfs-actions.pod:5584 ../src/guestfs-actions.pod:5600
7413 #: ../src/guestfs-actions.pod:5617 ../src/guestfs-actions.pod:6364
7414 #: ../src/guestfs-actions.pod:6382 ../src/guestfs-actions.pod:6736
7415 msgid "(Added in 1.0.26)"
7419 #: ../src/guestfs-actions.pod:1884
7420 msgid "guestfs_get_autosync"
7424 #: ../src/guestfs-actions.pod:1886
7428 " guestfs_get_autosync (guestfs_h *g);\n"
7433 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1290
7434 msgid "Get the autosync flag."
7438 #: ../src/guestfs-actions.pod:1895
7439 msgid "guestfs_get_direct"
7443 #: ../src/guestfs-actions.pod:1897
7447 " guestfs_get_direct (guestfs_h *g);\n"
7452 #: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1296
7453 msgid "Return the direct appliance mode flag."
7457 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:5238
7458 msgid "(Added in 1.0.72)"
7462 #: ../src/guestfs-actions.pod:1906
7463 msgid "guestfs_get_e2label"
7467 #: ../src/guestfs-actions.pod:1908
7471 " guestfs_get_e2label (guestfs_h *g,\n"
7472 " const char *device);\n"
7477 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1302
7479 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7483 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1305
7485 "This function is deprecated. In new code, use the C<vfs_label> call instead."
7489 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1946
7490 #: ../src/guestfs-actions.pod:5256 ../src/guestfs-actions.pod:5275
7491 msgid "(Added in 1.0.15)"
7495 #: ../src/guestfs-actions.pod:1927
7496 msgid "guestfs_get_e2uuid"
7500 #: ../src/guestfs-actions.pod:1929
7504 " guestfs_get_e2uuid (guestfs_h *g,\n"
7505 " const char *device);\n"
7510 #: ../src/guestfs-actions.pod:1933 ../fish/guestfish-actions.pod:1316
7512 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7516 #: ../src/guestfs-actions.pod:1939 ../fish/guestfish-actions.pod:1319
7518 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
7522 #: ../src/guestfs-actions.pod:1948
7523 msgid "guestfs_get_memsize"
7527 #: ../src/guestfs-actions.pod:1950
7531 " guestfs_get_memsize (guestfs_h *g);\n"
7536 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1330
7538 "This gets the memory size in megabytes allocated to the qemu subprocess."
7542 #: ../src/guestfs-actions.pod:1956
7544 "If C<guestfs_set_memsize> was not called on this handle, and if "
7545 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7546 "value for memsize."
7550 #: ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2041
7551 #: ../src/guestfs-actions.pod:5291 ../src/guestfs-actions.pod:5398
7552 #: ../fish/guestfish-actions.pod:1337 ../fish/guestfish-actions.pod:1388
7553 #: ../fish/guestfish-actions.pod:3508 ../fish/guestfish-actions.pod:3595
7555 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7559 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:3886
7560 #: ../src/guestfs-actions.pod:4001 ../src/guestfs-actions.pod:4020
7561 #: ../src/guestfs-actions.pod:4039 ../src/guestfs-actions.pod:4051
7562 #: ../src/guestfs-actions.pod:4068 ../src/guestfs-actions.pod:4081
7563 #: ../src/guestfs-actions.pod:4959 ../src/guestfs-actions.pod:5296
7564 #: ../src/guestfs-actions.pod:5539 ../src/guestfs-actions.pod:6140
7565 msgid "(Added in 1.0.55)"
7569 #: ../src/guestfs-actions.pod:1967
7570 msgid "guestfs_get_network"
7574 #: ../src/guestfs-actions.pod:1969
7578 " guestfs_get_network (guestfs_h *g);\n"
7583 #: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1344
7584 msgid "This returns the enable network flag."
7588 #: ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:5315
7589 msgid "(Added in 1.5.4)"
7593 #: ../src/guestfs-actions.pod:1978
7594 msgid "guestfs_get_path"
7598 #: ../src/guestfs-actions.pod:1980
7602 " guestfs_get_path (guestfs_h *g);\n"
7607 #: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1350
7608 msgid "Return the current search path."
7612 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1352
7614 "This is always non-NULL. If it wasn't set already, then this will return "
7619 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2017
7621 "This function returns a string, or NULL on error. The string is owned by "
7622 "the guest handle and must I<not> be freed."
7626 #: ../src/guestfs-actions.pod:1993
7627 msgid "guestfs_get_pid"
7631 #: ../src/guestfs-actions.pod:1995
7635 " guestfs_get_pid (guestfs_h *g);\n"
7640 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1361
7642 "Return the process ID of the qemu subprocess. If there is no qemu "
7643 "subprocess, then this will return an error."
7647 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1364
7648 msgid "This is an internal call used for debugging and testing."
7652 #: ../src/guestfs-actions.pod:2005
7653 msgid "(Added in 1.0.56)"
7657 #: ../src/guestfs-actions.pod:2007
7658 msgid "guestfs_get_qemu"
7662 #: ../src/guestfs-actions.pod:2009
7666 " guestfs_get_qemu (guestfs_h *g);\n"
7671 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1370
7672 msgid "Return the current qemu binary."
7676 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1372
7678 "This is always non-NULL. If it wasn't set already, then this will return "
7679 "the default qemu binary name."
7683 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5360
7684 msgid "(Added in 1.0.6)"
7688 #: ../src/guestfs-actions.pod:2022
7689 msgid "guestfs_get_recovery_proc"
7693 #: ../src/guestfs-actions.pod:2024
7697 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7702 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1379
7703 msgid "Return the recovery process enabled flag."
7707 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:3026
7708 #: ../src/guestfs-actions.pod:3293 ../src/guestfs-actions.pod:3693
7709 #: ../src/guestfs-actions.pod:3725 ../src/guestfs-actions.pod:4664
7710 #: ../src/guestfs-actions.pod:5007 ../src/guestfs-actions.pod:5384
7711 #: ../src/guestfs-actions.pod:6043 ../src/guestfs-actions.pod:6063
7712 #: ../src/guestfs-actions.pod:6245
7713 msgid "(Added in 1.0.77)"
7717 #: ../src/guestfs-actions.pod:2033
7718 msgid "guestfs_get_selinux"
7722 #: ../src/guestfs-actions.pod:2035
7726 " guestfs_get_selinux (guestfs_h *g);\n"
7731 #: ../src/guestfs-actions.pod:2038
7733 "This returns the current setting of the selinux flag which is passed to the "
7734 "appliance at boot time. See C<guestfs_set_selinux>."
7738 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2109
7739 #: ../src/guestfs-actions.pod:5403 ../src/guestfs-actions.pod:5457
7740 msgid "(Added in 1.0.67)"
7744 #: ../src/guestfs-actions.pod:2048
7745 msgid "guestfs_get_state"
7749 #: ../src/guestfs-actions.pod:2050
7753 " guestfs_get_state (guestfs_h *g);\n"
7758 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1395
7760 "This returns the current state as an opaque integer. This is only useful "
7761 "for printing debug and internal error messages."
7765 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:2829
7766 #: ../src/guestfs-actions.pod:2858 ../src/guestfs-actions.pod:2919
7767 #: ../src/guestfs-actions.pod:2946 ../fish/guestfish-actions.pod:1398
7768 #: ../fish/guestfish-actions.pod:1941 ../fish/guestfish-actions.pod:1959
7769 #: ../fish/guestfish-actions.pod:1997 ../fish/guestfish-actions.pod:2013
7770 msgid "For more information on states, see L<guestfs(3)>."
7774 #: ../src/guestfs-actions.pod:2062
7775 msgid "guestfs_get_trace"
7779 #: ../src/guestfs-actions.pod:2064
7783 " guestfs_get_trace (guestfs_h *g);\n"
7788 #: ../src/guestfs-actions.pod:2067 ../fish/guestfish-actions.pod:1404
7789 msgid "Return the command trace flag."
7793 #: ../src/guestfs-actions.pod:2073
7794 msgid "guestfs_get_umask"
7798 #: ../src/guestfs-actions.pod:2075
7802 " guestfs_get_umask (guestfs_h *g);\n"
7807 #: ../src/guestfs-actions.pod:2078
7809 "Return the current umask. By default the umask is C<022> unless it has been "
7810 "set by calling C<guestfs_umask>."
7814 #: ../src/guestfs-actions.pod:2085
7815 msgid "guestfs_get_verbose"
7819 #: ../src/guestfs-actions.pod:2087
7823 " guestfs_get_verbose (guestfs_h *g);\n"
7828 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1417
7829 msgid "This returns the verbose messages flag."
7833 #: ../src/guestfs-actions.pod:2096
7834 msgid "guestfs_getcon"
7838 #: ../src/guestfs-actions.pod:2098
7842 " guestfs_getcon (guestfs_h *g);\n"
7847 #: ../src/guestfs-actions.pod:2101 ../fish/guestfish-actions.pod:1423
7848 msgid "This gets the SELinux security context of the daemon."
7852 #: ../src/guestfs-actions.pod:2103
7854 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
7858 #: ../src/guestfs-actions.pod:2111
7859 msgid "guestfs_getxattrs"
7863 #: ../src/guestfs-actions.pod:2113
7866 " struct guestfs_xattr_list *\n"
7867 " guestfs_getxattrs (guestfs_h *g,\n"
7868 " const char *path);\n"
7873 #: ../src/guestfs-actions.pod:2117 ../fish/guestfish-actions.pod:1432
7875 "This call lists the extended attributes of the file or directory C<path>."
7879 #: ../src/guestfs-actions.pod:2120 ../fish/guestfish-actions.pod:1435
7881 "At the system call level, this is a combination of the L<listxattr(2)> and "
7882 "L<getxattr(2)> calls."
7886 #: ../src/guestfs-actions.pod:2123
7887 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
7891 #: ../src/guestfs-actions.pod:2125 ../src/guestfs-actions.pod:3038
7892 #: ../src/guestfs-actions.pod:3689
7894 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
7895 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
7899 #: ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:3042
7900 #: ../src/guestfs-actions.pod:3207 ../src/guestfs-actions.pod:3243
7901 #: ../src/guestfs-actions.pod:5037 ../src/guestfs-actions.pod:5476
7902 #: ../src/guestfs-actions.pod:6801
7903 msgid "(Added in 1.0.59)"
7907 #: ../src/guestfs-actions.pod:2131
7908 msgid "guestfs_glob_expand"
7912 #: ../src/guestfs-actions.pod:2133
7916 " guestfs_glob_expand (guestfs_h *g,\n"
7917 " const char *pattern);\n"
7922 #: ../src/guestfs-actions.pod:2137 ../fish/guestfish-actions.pod:1444
7924 "This command searches for all the pathnames matching C<pattern> according to "
7925 "the wildcard expansion rules used by the shell."
7929 #: ../src/guestfs-actions.pod:2141 ../fish/guestfish-actions.pod:1448
7931 "If no paths match, then this returns an empty list (note: not an error)."
7935 #: ../src/guestfs-actions.pod:2144 ../fish/guestfish-actions.pod:1451
7937 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
7938 "GLOB_BRACE>. See that manual page for more details."
7942 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:5641
7943 #: ../src/guestfs-actions.pod:5658
7944 msgid "(Added in 1.0.50)"
7948 #: ../src/guestfs-actions.pod:2154
7949 msgid "guestfs_grep"
7953 #: ../src/guestfs-actions.pod:2156
7957 " guestfs_grep (guestfs_h *g,\n"
7958 " const char *regex,\n"
7959 " const char *path);\n"
7964 #: ../src/guestfs-actions.pod:2161 ../fish/guestfish-actions.pod:1459
7965 msgid "This calls the external C<grep> program and returns the matching lines."
7969 #: ../src/guestfs-actions.pod:2173
7970 msgid "guestfs_grepi"
7974 #: ../src/guestfs-actions.pod:2175
7978 " guestfs_grepi (guestfs_h *g,\n"
7979 " const char *regex,\n"
7980 " const char *path);\n"
7985 #: ../src/guestfs-actions.pod:2180 ../fish/guestfish-actions.pod:1469
7987 "This calls the external C<grep -i> program and returns the matching lines."
7991 #: ../src/guestfs-actions.pod:2192
7992 msgid "guestfs_grub_install"
7996 #: ../src/guestfs-actions.pod:2194
8000 " guestfs_grub_install (guestfs_h *g,\n"
8001 " const char *root,\n"
8002 " const char *device);\n"
8007 #: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1479
8009 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
8010 "the root directory being C<root>."
8014 #: ../src/guestfs-actions.pod:2202 ../fish/guestfish-actions.pod:1482
8016 "Note: If grub-install reports the error \"No suitable drive was found in the "
8017 "generated device map.\" it may be that you need to create a C</boot/grub/"
8018 "device.map> file first that contains the mapping between grub device names "
8019 "and Linux device names. It is usually sufficient to create a file "
8024 #: ../src/guestfs-actions.pod:2209 ../fish/guestfish-actions.pod:1489
8032 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1491
8033 msgid "replacing C</dev/vda> with the name of the installation device."
8037 #: ../src/guestfs-actions.pod:2215
8038 msgid "(Added in 1.0.17)"
8042 #: ../src/guestfs-actions.pod:2217
8043 msgid "guestfs_head"
8047 #: ../src/guestfs-actions.pod:2219
8051 " guestfs_head (guestfs_h *g,\n"
8052 " const char *path);\n"
8057 #: ../src/guestfs-actions.pod:2223 ../fish/guestfish-actions.pod:1497
8059 "This command returns up to the first 10 lines of a file as a list of strings."
8063 #: ../src/guestfs-actions.pod:2235
8064 msgid "guestfs_head_n"
8068 #: ../src/guestfs-actions.pod:2237
8072 " guestfs_head_n (guestfs_h *g,\n"
8074 " const char *path);\n"
8079 #: ../src/guestfs-actions.pod:2242 ../fish/guestfish-actions.pod:1507
8081 "If the parameter C<nrlines> is a positive number, this returns the first "
8082 "C<nrlines> lines of the file C<path>."
8086 #: ../src/guestfs-actions.pod:2245 ../fish/guestfish-actions.pod:1510
8088 "If the parameter C<nrlines> is a negative number, this returns lines from "
8089 "the file C<path>, excluding the last C<nrlines> lines."
8093 #: ../src/guestfs-actions.pod:2248 ../src/guestfs-actions.pod:5938
8094 #: ../fish/guestfish-actions.pod:1513 ../fish/guestfish-actions.pod:3941
8095 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8099 #: ../src/guestfs-actions.pod:2259
8100 msgid "guestfs_hexdump"
8104 #: ../src/guestfs-actions.pod:2261
8108 " guestfs_hexdump (guestfs_h *g,\n"
8109 " const char *path);\n"
8114 #: ../src/guestfs-actions.pod:2265 ../fish/guestfish-actions.pod:1522
8116 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
8117 "readable, canonical hex dump of the file."
8121 #: ../src/guestfs-actions.pod:2274 ../src/guestfs-actions.pod:5722
8122 #: ../src/guestfs-actions.pod:5777
8123 msgid "(Added in 1.0.22)"
8127 #: ../src/guestfs-actions.pod:2276
8128 msgid "guestfs_initrd_cat"
8132 #: ../src/guestfs-actions.pod:2278
8136 " guestfs_initrd_cat (guestfs_h *g,\n"
8137 " const char *initrdpath,\n"
8138 " const char *filename,\n"
8139 " size_t *size_r);\n"
8144 #: ../src/guestfs-actions.pod:2284 ../fish/guestfish-actions.pod:1532
8146 "This command unpacks the file C<filename> from the initrd file called "
8147 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8152 #: ../src/guestfs-actions.pod:2288 ../fish/guestfish-actions.pod:1536
8154 "For example, in guestfish you could use the following command to examine the "
8155 "boot script (usually called C</init>) contained in a Linux initrd or "
8160 #: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1540
8163 " initrd-cat /boot/initrd-<version>.img init\n"
8168 #: ../src/guestfs-actions.pod:2294
8169 msgid "See also C<guestfs_initrd_list>."
8173 #: ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:4657
8174 #: ../src/guestfs-actions.pod:4683 ../src/guestfs-actions.pod:4864
8176 "This function returns a buffer, or NULL on error. The size of the returned "
8177 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8182 #: ../src/guestfs-actions.pod:2305
8183 msgid "guestfs_initrd_list"
8187 #: ../src/guestfs-actions.pod:2307
8191 " guestfs_initrd_list (guestfs_h *g,\n"
8192 " const char *path);\n"
8197 #: ../src/guestfs-actions.pod:2311 ../fish/guestfish-actions.pod:1551
8198 msgid "This command lists out files contained in an initrd."
8202 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1553
8204 "The files are listed without any initial C</> character. The files are "
8205 "listed in the order they appear (not necessarily alphabetical). Directory "
8206 "names are listed as separate items."
8210 #: ../src/guestfs-actions.pod:2317 ../fish/guestfish-actions.pod:1557
8212 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8213 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8218 #: ../src/guestfs-actions.pod:2327
8219 msgid "guestfs_inotify_add_watch"
8223 #: ../src/guestfs-actions.pod:2329
8227 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8228 " const char *path,\n"
8234 #: ../src/guestfs-actions.pod:2334 ../fish/guestfish-actions.pod:1565
8235 msgid "Watch C<path> for the events listed in C<mask>."
8239 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1567
8241 "Note that if C<path> is a directory then events within that directory are "
8242 "watched, but this does I<not> happen recursively (in subdirectories)."
8246 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1571
8248 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8249 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
8253 #: ../src/guestfs-actions.pod:2348
8254 msgid "guestfs_inotify_close"
8258 #: ../src/guestfs-actions.pod:2350
8262 " guestfs_inotify_close (guestfs_h *g);\n"
8267 #: ../src/guestfs-actions.pod:2353 ../fish/guestfish-actions.pod:1579
8269 "This closes the inotify handle which was previously opened by inotify_init. "
8270 "It removes all watches, throws away any pending events, and deallocates all "
8275 #: ../src/guestfs-actions.pod:2361
8276 msgid "guestfs_inotify_files"
8280 #: ../src/guestfs-actions.pod:2363
8284 " guestfs_inotify_files (guestfs_h *g);\n"
8289 #: ../src/guestfs-actions.pod:2366
8291 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
8292 "returns a list of pathnames of objects that were touched. The returned "
8293 "pathnames are sorted and deduplicated."
8297 #: ../src/guestfs-actions.pod:2376
8298 msgid "guestfs_inotify_init"
8302 #: ../src/guestfs-actions.pod:2378
8306 " guestfs_inotify_init (guestfs_h *g,\n"
8307 " int maxevents);\n"
8312 #: ../src/guestfs-actions.pod:2382 ../fish/guestfish-actions.pod:1595
8314 "This command creates a new inotify handle. The inotify subsystem can be "
8315 "used to notify events which happen to objects in the guest filesystem."
8319 #: ../src/guestfs-actions.pod:2386
8321 "C<maxevents> is the maximum number of events which will be queued up between "
8322 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
8323 "passed as C<0>, then the kernel (or previously set) default is used. For "
8324 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
8325 "throws away events, but records the fact that it threw them away by setting "
8326 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
8327 "C<guestfs_inotify_read>)."
8331 #: ../src/guestfs-actions.pod:2396
8333 "Before any events are generated, you have to add some watches to the "
8334 "internal watch list. See: C<guestfs_inotify_add_watch>, "
8335 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
8339 #: ../src/guestfs-actions.pod:2402
8341 "Queued up events should be read periodically by calling "
8342 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
8343 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
8344 "often enough then you risk the internal queue overflowing."
8348 #: ../src/guestfs-actions.pod:2409
8350 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
8351 "This also removes any watches automatically."
8355 #: ../src/guestfs-actions.pod:2413 ../fish/guestfish-actions.pod:1626
8357 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
8358 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
8359 "that there is one global inotify handle per libguestfs instance."
8363 #: ../src/guestfs-actions.pod:2422
8364 msgid "guestfs_inotify_read"
8368 #: ../src/guestfs-actions.pod:2424
8371 " struct guestfs_inotify_event_list *\n"
8372 " guestfs_inotify_read (guestfs_h *g);\n"
8377 #: ../src/guestfs-actions.pod:2427 ../fish/guestfish-actions.pod:1635
8379 "Return the complete queue of events that have happened since the previous "
8384 #: ../src/guestfs-actions.pod:2430 ../fish/guestfish-actions.pod:1638
8385 msgid "If no events have happened, this returns an empty list."
8389 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1640
8391 "I<Note>: In order to make sure that all events have been read, you must call "
8392 "this function repeatedly until it returns an empty list. The reason is that "
8393 "the call will read events up to the maximum appliance-to-host message size "
8394 "and leave remaining events in the queue."
8398 #: ../src/guestfs-actions.pod:2438
8400 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
8401 "there was an error. I<The caller must call "
8402 "C<guestfs_free_inotify_event_list> after use>."
8406 #: ../src/guestfs-actions.pod:2444
8407 msgid "guestfs_inotify_rm_watch"
8411 #: ../src/guestfs-actions.pod:2446
8415 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
8421 #: ../src/guestfs-actions.pod:2450
8423 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
8427 #: ../src/guestfs-actions.pod:2457
8428 msgid "guestfs_inspect_get_arch"
8432 #: ../src/guestfs-actions.pod:2459
8436 " guestfs_inspect_get_arch (guestfs_h *g,\n"
8437 " const char *root);\n"
8442 #: ../src/guestfs-actions.pod:2463 ../src/guestfs-actions.pod:2486
8443 #: ../src/guestfs-actions.pod:2559 ../src/guestfs-actions.pod:2585
8444 #: ../src/guestfs-actions.pod:2612 ../src/guestfs-actions.pod:2633
8445 #: ../src/guestfs-actions.pod:2666 ../src/guestfs-actions.pod:2708
8446 #: ../src/guestfs-actions.pod:2746
8448 "This function should only be called with a root device string as returned by "
8449 "C<guestfs_inspect_os>."
8453 #: ../src/guestfs-actions.pod:2466
8455 "This returns the architecture of the inspected operating system. The "
8456 "possible return values are listed under C<guestfs_file_architecture>."
8460 #: ../src/guestfs-actions.pod:2470 ../fish/guestfish-actions.pod:1664
8462 "If the architecture could not be determined, then the string C<unknown> is "
8467 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2546
8468 #: ../src/guestfs-actions.pod:2600 ../src/guestfs-actions.pod:2677
8469 #: ../src/guestfs-actions.pod:2696 ../src/guestfs-actions.pod:2733
8470 #: ../src/guestfs-actions.pod:2756 ../src/guestfs-actions.pod:2796
8471 #: ../fish/guestfish-actions.pod:1667 ../fish/guestfish-actions.pod:1733
8472 #: ../fish/guestfish-actions.pod:1772 ../fish/guestfish-actions.pod:1827
8473 #: ../fish/guestfish-actions.pod:1840 ../fish/guestfish-actions.pod:1871
8474 #: ../fish/guestfish-actions.pod:1887 ../fish/guestfish-actions.pod:1921
8475 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
8479 #: ../src/guestfs-actions.pod:2480
8480 msgid "guestfs_inspect_get_distro"
8484 #: ../src/guestfs-actions.pod:2482
8488 " guestfs_inspect_get_distro (guestfs_h *g,\n"
8489 " const char *root);\n"
8494 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1676
8496 "This returns the distro (distribution) of the inspected operating system."
8500 #: ../src/guestfs-actions.pod:2492 ../fish/guestfish-actions.pod:1679
8501 msgid "Currently defined distros are:"
8505 #: ../src/guestfs-actions.pod:2496 ../fish/guestfish-actions.pod:1683
8506 msgid "\"archlinux\""
8510 #: ../src/guestfs-actions.pod:2498 ../fish/guestfish-actions.pod:1685
8515 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1687
8520 #: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1689
8521 msgid "Debian or a Debian-derived distro such as Ubuntu."
8525 #: ../src/guestfs-actions.pod:2504 ../fish/guestfish-actions.pod:1691
8530 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1693
8535 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1695
8540 #: ../src/guestfs-actions.pod:2510 ../fish/guestfish-actions.pod:1697
8545 #: ../src/guestfs-actions.pod:2512 ../fish/guestfish-actions.pod:1699
8550 #: ../src/guestfs-actions.pod:2514 ../fish/guestfish-actions.pod:1701
8555 #: ../src/guestfs-actions.pod:2516 ../fish/guestfish-actions.pod:1703
8560 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1705
8565 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1707
8566 msgid "\"redhat-based\""
8570 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1709
8571 msgid "Some Red Hat-derived distro."
8575 #: ../src/guestfs-actions.pod:2524 ../fish/guestfish-actions.pod:1711
8580 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1713
8581 msgid "Red Hat Enterprise Linux and some derivatives."
8585 #: ../src/guestfs-actions.pod:2528 ../src/guestfs-actions.pod:2720
8586 #: ../fish/guestfish-actions.pod:1715 ../fish/guestfish-actions.pod:1858
8591 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1717
8593 "Windows does not have distributions. This string is returned if the OS type "
8598 #: ../src/guestfs-actions.pod:2533 ../fish/guestfish-actions.pod:1720
8603 #: ../src/guestfs-actions.pod:2535 ../fish/guestfish-actions.pod:1722
8608 #: ../src/guestfs-actions.pod:2537 ../src/guestfs-actions.pod:2724
8609 #: ../fish/guestfish-actions.pod:1724 ../fish/guestfish-actions.pod:1862
8614 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1726
8615 msgid "The distro could not be determined."
8619 #: ../src/guestfs-actions.pod:2543 ../src/guestfs-actions.pod:2730
8620 #: ../fish/guestfish-actions.pod:1730 ../fish/guestfish-actions.pod:1868
8622 "Future versions of libguestfs may return other strings here. The caller "
8623 "should be prepared to handle any string."
8627 #: ../src/guestfs-actions.pod:2553
8628 msgid "guestfs_inspect_get_filesystems"
8632 #: ../src/guestfs-actions.pod:2555
8636 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
8637 " const char *root);\n"
8642 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1742
8644 "This returns a list of all the filesystems that we think are associated with "
8645 "this operating system. This includes the root filesystem, other ordinary "
8646 "filesystems, and non-mounted devices like swap partitions."
8650 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1747
8652 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8653 "to be shared between operating systems."
8657 #: ../src/guestfs-actions.pod:2570
8659 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8660 "C<guestfs_inspect_get_mountpoints>."
8664 #: ../src/guestfs-actions.pod:2579
8665 msgid "guestfs_inspect_get_major_version"
8669 #: ../src/guestfs-actions.pod:2581
8673 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
8674 " const char *root);\n"
8679 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1760
8681 "This returns the major version number of the inspected operating system."
8685 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1763
8687 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8688 "popular public names used by the operating system. Notably the operating "
8689 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8690 "1). You can find out the real versions corresponding to releases of Windows "
8691 "by consulting Wikipedia or MSDN."
8695 #: ../src/guestfs-actions.pod:2598 ../src/guestfs-actions.pod:2618
8696 #: ../fish/guestfish-actions.pod:1770 ../fish/guestfish-actions.pod:1784
8697 msgid "If the version could not be determined, then C<0> is returned."
8701 #: ../src/guestfs-actions.pod:2606
8702 msgid "guestfs_inspect_get_minor_version"
8706 #: ../src/guestfs-actions.pod:2608
8710 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
8711 " const char *root);\n"
8716 #: ../src/guestfs-actions.pod:2615 ../fish/guestfish-actions.pod:1781
8718 "This returns the minor version number of the inspected operating system."
8722 #: ../src/guestfs-actions.pod:2620
8724 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8725 "C<guestfs_inspect_get_major_version>."
8729 #: ../src/guestfs-actions.pod:2627
8730 msgid "guestfs_inspect_get_mountpoints"
8734 #: ../src/guestfs-actions.pod:2629
8738 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
8739 " const char *root);\n"
8744 #: ../src/guestfs-actions.pod:2636 ../fish/guestfish-actions.pod:1796
8746 "This returns a hash of where we think the filesystems associated with this "
8747 "operating system should be mounted. Callers should note that this is at "
8748 "best an educated guess made by reading configuration files such as C</etc/"
8753 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1801
8755 "Each element in the returned hashtable has a key which is the path of the "
8756 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8757 "mounted there (eg. C</dev/sda1>)."
8761 #: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1806
8763 "Non-mounted devices such as swap devices are I<not> returned in this list."
8767 #: ../src/guestfs-actions.pod:2649
8769 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8770 "C<guestfs_inspect_get_filesystems>."
8774 #: ../src/guestfs-actions.pod:2652 ../src/guestfs-actions.pod:3095
8775 #: ../src/guestfs-actions.pod:4223 ../src/guestfs-actions.pod:6079
8777 "This function returns a NULL-terminated array of strings, or NULL if there "
8778 "was an error. The array of strings will always have length C<2n+1>, where "
8779 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
8780 "caller must free the strings and the array after use>."
8784 #: ../src/guestfs-actions.pod:2660
8785 msgid "guestfs_inspect_get_product_name"
8789 #: ../src/guestfs-actions.pod:2662
8793 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
8794 " const char *root);\n"
8799 #: ../src/guestfs-actions.pod:2669 ../fish/guestfish-actions.pod:1819
8801 "This returns the product name of the inspected operating system. The "
8802 "product name is generally some freeform string which can be displayed to the "
8803 "user, but should not be parsed by programs."
8807 #: ../src/guestfs-actions.pod:2674 ../fish/guestfish-actions.pod:1824
8809 "If the product name could not be determined, then the string C<unknown> is "
8814 #: ../src/guestfs-actions.pod:2684
8815 msgid "guestfs_inspect_get_roots"
8819 #: ../src/guestfs-actions.pod:2686
8823 " guestfs_inspect_get_roots (guestfs_h *g);\n"
8828 #: ../src/guestfs-actions.pod:2689
8830 "This function is a convenient way to get the list of root devices, as "
8831 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
8832 "the whole inspection process."
8836 #: ../src/guestfs-actions.pod:2693
8838 "This returns an empty list if either no root devices were found or the "
8839 "caller has not called C<guestfs_inspect_os>."
8843 #: ../src/guestfs-actions.pod:2702
8844 msgid "guestfs_inspect_get_type"
8848 #: ../src/guestfs-actions.pod:2704
8852 " guestfs_inspect_get_type (guestfs_h *g,\n"
8853 " const char *root);\n"
8858 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1849
8860 "This returns the type of the inspected operating system. Currently defined "
8865 #: ../src/guestfs-actions.pod:2716 ../fish/guestfish-actions.pod:1854
8870 #: ../src/guestfs-actions.pod:2718 ../fish/guestfish-actions.pod:1856
8871 msgid "Any Linux-based operating system."
8875 #: ../src/guestfs-actions.pod:2722 ../fish/guestfish-actions.pod:1860
8876 msgid "Any Microsoft Windows operating system."
8880 #: ../src/guestfs-actions.pod:2726 ../fish/guestfish-actions.pod:1864
8881 msgid "The operating system type could not be determined."
8885 #: ../src/guestfs-actions.pod:2740
8886 msgid "guestfs_inspect_get_windows_systemroot"
8890 #: ../src/guestfs-actions.pod:2742
8894 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
8895 " const char *root);\n"
8900 #: ../src/guestfs-actions.pod:2749 ../fish/guestfish-actions.pod:1880
8902 "This returns the Windows systemroot of the inspected guest. The systemroot "
8903 "is a directory path such as C</WINDOWS>."
8907 #: ../src/guestfs-actions.pod:2752 ../fish/guestfish-actions.pod:1883
8909 "This call assumes that the guest is Windows and that the systemroot could be "
8910 "determined by inspection. If this is not the case then an error is returned."
8914 #: ../src/guestfs-actions.pod:2761
8915 msgid "(Added in 1.5.25)"
8919 #: ../src/guestfs-actions.pod:2763
8920 msgid "guestfs_inspect_os"
8924 #: ../src/guestfs-actions.pod:2765
8928 " guestfs_inspect_os (guestfs_h *g);\n"
8933 #: ../src/guestfs-actions.pod:2768 ../fish/guestfish-actions.pod:1893
8935 "This function uses other libguestfs functions and certain heuristics to "
8936 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
8937 "for operating systems."
8941 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1897
8942 msgid "The list returned is empty if no operating systems were found."
8946 #: ../src/guestfs-actions.pod:2774 ../fish/guestfish-actions.pod:1899
8948 "If one operating system was found, then this returns a list with a single "
8949 "element, which is the name of the root filesystem of this operating system. "
8950 "It is also possible for this function to return a list containing more than "
8951 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
8952 "element being the root filesystem of one of the operating systems."
8956 #: ../src/guestfs-actions.pod:2781
8958 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
8959 "functions in order to query further information about each operating system, "
8960 "such as the name and version."
8964 #: ../src/guestfs-actions.pod:2786
8966 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
8967 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
8968 "the contents. This should be called with no disks currently mounted. The "
8969 "function may also use Augeas, so any existing Augeas handle will be closed."
8973 #: ../src/guestfs-actions.pod:2792 ../fish/guestfish-actions.pod:1917
8975 "This function cannot decrypt encrypted disks. The caller must do that first "
8976 "(supplying the necessary keys) if the disk is encrypted."
8980 #: ../src/guestfs-actions.pod:2798 ../src/guestfs-actions.pod:3053
8981 #: ../src/guestfs-actions.pod:3115
8982 msgid "See also C<guestfs_list_filesystems>."
8986 #: ../src/guestfs-actions.pod:2806
8987 msgid "guestfs_is_blockdev"
8991 #: ../src/guestfs-actions.pod:2808
8995 " guestfs_is_blockdev (guestfs_h *g,\n"
8996 " const char *path);\n"
9001 #: ../src/guestfs-actions.pod:2812 ../fish/guestfish-actions.pod:1929
9003 "This returns C<true> if and only if there is a block device with the given "
9008 #: ../src/guestfs-actions.pod:2815 ../src/guestfs-actions.pod:2844
9009 #: ../src/guestfs-actions.pod:2874 ../src/guestfs-actions.pod:2889
9010 #: ../src/guestfs-actions.pod:2905 ../src/guestfs-actions.pod:2961
9011 #: ../src/guestfs-actions.pod:2976
9012 msgid "See also C<guestfs_stat>."
9016 #: ../src/guestfs-actions.pod:2819 ../src/guestfs-actions.pod:2848
9017 #: ../src/guestfs-actions.pod:2893 ../src/guestfs-actions.pod:2965
9018 #: ../src/guestfs-actions.pod:2980
9019 msgid "(Added in 1.5.10)"
9023 #: ../src/guestfs-actions.pod:2821
9024 msgid "guestfs_is_busy"
9028 #: ../src/guestfs-actions.pod:2823
9032 " guestfs_is_busy (guestfs_h *g);\n"
9037 #: ../src/guestfs-actions.pod:2826 ../fish/guestfish-actions.pod:1938
9039 "This returns true iff this handle is busy processing a command (in the "
9044 #: ../src/guestfs-actions.pod:2835
9045 msgid "guestfs_is_chardev"
9049 #: ../src/guestfs-actions.pod:2837
9053 " guestfs_is_chardev (guestfs_h *g,\n"
9054 " const char *path);\n"
9059 #: ../src/guestfs-actions.pod:2841 ../fish/guestfish-actions.pod:1947
9061 "This returns C<true> if and only if there is a character device with the "
9062 "given C<path> name."
9066 #: ../src/guestfs-actions.pod:2850
9067 msgid "guestfs_is_config"
9071 #: ../src/guestfs-actions.pod:2852
9075 " guestfs_is_config (guestfs_h *g);\n"
9080 #: ../src/guestfs-actions.pod:2855 ../fish/guestfish-actions.pod:1956
9082 "This returns true iff this handle is being configured (in the C<CONFIG> "
9087 #: ../src/guestfs-actions.pod:2864
9088 msgid "guestfs_is_dir"
9092 #: ../src/guestfs-actions.pod:2866
9096 " guestfs_is_dir (guestfs_h *g,\n"
9097 " const char *path);\n"
9102 #: ../src/guestfs-actions.pod:2870 ../fish/guestfish-actions.pod:1965
9104 "This returns C<true> if and only if there is a directory with the given "
9105 "C<path> name. Note that it returns false for other objects like files."
9109 #: ../src/guestfs-actions.pod:2880
9110 msgid "guestfs_is_fifo"
9114 #: ../src/guestfs-actions.pod:2882
9118 " guestfs_is_fifo (guestfs_h *g,\n"
9119 " const char *path);\n"
9124 #: ../src/guestfs-actions.pod:2886 ../fish/guestfish-actions.pod:1975
9126 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9127 "given C<path> name."
9131 #: ../src/guestfs-actions.pod:2895
9132 msgid "guestfs_is_file"
9136 #: ../src/guestfs-actions.pod:2897
9140 " guestfs_is_file (guestfs_h *g,\n"
9141 " const char *path);\n"
9146 #: ../src/guestfs-actions.pod:2901 ../fish/guestfish-actions.pod:1984
9148 "This returns C<true> if and only if there is a regular file with the given "
9149 "C<path> name. Note that it returns false for other objects like directories."
9153 #: ../src/guestfs-actions.pod:2911
9154 msgid "guestfs_is_launching"
9158 #: ../src/guestfs-actions.pod:2913
9162 " guestfs_is_launching (guestfs_h *g);\n"
9167 #: ../src/guestfs-actions.pod:2916 ../fish/guestfish-actions.pod:1994
9169 "This returns true iff this handle is launching the subprocess (in the "
9170 "C<LAUNCHING> state)."
9174 #: ../src/guestfs-actions.pod:2925
9175 msgid "guestfs_is_lv"
9179 #: ../src/guestfs-actions.pod:2927
9183 " guestfs_is_lv (guestfs_h *g,\n"
9184 " const char *device);\n"
9189 #: ../src/guestfs-actions.pod:2931 ../fish/guestfish-actions.pod:2003
9191 "This command tests whether C<device> is a logical volume, and returns true "
9192 "iff this is the case."
9196 #: ../src/guestfs-actions.pod:2938
9197 msgid "guestfs_is_ready"
9201 #: ../src/guestfs-actions.pod:2940
9205 " guestfs_is_ready (guestfs_h *g);\n"
9210 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2010
9212 "This returns true iff this handle is ready to accept commands (in the "
9217 #: ../src/guestfs-actions.pod:2952
9218 msgid "guestfs_is_socket"
9222 #: ../src/guestfs-actions.pod:2954
9226 " guestfs_is_socket (guestfs_h *g,\n"
9227 " const char *path);\n"
9232 #: ../src/guestfs-actions.pod:2958 ../fish/guestfish-actions.pod:2019
9234 "This returns C<true> if and only if there is a Unix domain socket with the "
9235 "given C<path> name."
9239 #: ../src/guestfs-actions.pod:2967
9240 msgid "guestfs_is_symlink"
9244 #: ../src/guestfs-actions.pod:2969
9248 " guestfs_is_symlink (guestfs_h *g,\n"
9249 " const char *path);\n"
9254 #: ../src/guestfs-actions.pod:2973 ../fish/guestfish-actions.pod:2028
9256 "This returns C<true> if and only if there is a symbolic link with the given "
9261 #: ../src/guestfs-actions.pod:2982
9262 msgid "guestfs_kill_subprocess"
9266 #: ../src/guestfs-actions.pod:2984
9270 " guestfs_kill_subprocess (guestfs_h *g);\n"
9275 #: ../src/guestfs-actions.pod:2987 ../fish/guestfish-actions.pod:2037
9276 msgid "This kills the qemu subprocess. You should never need to call this."
9280 #: ../src/guestfs-actions.pod:2993
9281 msgid "guestfs_launch"
9285 #: ../src/guestfs-actions.pod:2995
9289 " guestfs_launch (guestfs_h *g);\n"
9294 #: ../src/guestfs-actions.pod:2998 ../fish/guestfish-actions.pod:2045
9296 "Internally libguestfs is implemented by running a virtual machine using "
9301 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2048
9303 "You should call this after configuring the handle (eg. adding drives) but "
9304 "before performing any actions."
9308 #: ../src/guestfs-actions.pod:3008
9309 msgid "guestfs_lchown"
9313 #: ../src/guestfs-actions.pod:3010
9317 " guestfs_lchown (guestfs_h *g,\n"
9320 " const char *path);\n"
9325 #: ../src/guestfs-actions.pod:3016
9327 "Change the file owner to C<owner> and group to C<group>. This is like "
9328 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
9329 "changed, not the target."
9333 #: ../src/guestfs-actions.pod:3028
9334 msgid "guestfs_lgetxattrs"
9338 #: ../src/guestfs-actions.pod:3030
9341 " struct guestfs_xattr_list *\n"
9342 " guestfs_lgetxattrs (guestfs_h *g,\n"
9343 " const char *path);\n"
9348 #: ../src/guestfs-actions.pod:3034
9350 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
9351 "then it returns the extended attributes of the link itself."
9355 #: ../src/guestfs-actions.pod:3044
9356 msgid "guestfs_list_devices"
9360 #: ../src/guestfs-actions.pod:3046
9364 " guestfs_list_devices (guestfs_h *g);\n"
9369 #: ../src/guestfs-actions.pod:3049 ../fish/guestfish-actions.pod:2075
9370 msgid "List all the block devices."
9374 #: ../src/guestfs-actions.pod:3051 ../fish/guestfish-actions.pod:2077
9375 msgid "The full block device names are returned, eg. C</dev/sda>."
9379 #: ../src/guestfs-actions.pod:3061
9380 msgid "guestfs_list_filesystems"
9384 #: ../src/guestfs-actions.pod:3063
9388 " guestfs_list_filesystems (guestfs_h *g);\n"
9393 #: ../src/guestfs-actions.pod:3066 ../fish/guestfish-actions.pod:2085
9395 "This inspection command looks for filesystems on partitions, block devices "
9396 "and logical volumes, returning a list of devices containing filesystems and "
9401 #: ../src/guestfs-actions.pod:3070 ../fish/guestfish-actions.pod:2089
9403 "The return value is a hash, where the keys are the devices containing "
9404 "filesystems, and the values are the filesystem types. For example:"
9408 #: ../src/guestfs-actions.pod:3074 ../fish/guestfish-actions.pod:2093
9411 " \"/dev/sda1\" => \"ntfs\"\n"
9412 " \"/dev/sda2\" => \"ext2\"\n"
9413 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9414 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9419 #: ../src/guestfs-actions.pod:3079 ../fish/guestfish-actions.pod:2098
9421 "The value can have the special value \"unknown\", meaning the content of the "
9422 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9426 #: ../src/guestfs-actions.pod:3083
9428 "This command runs other libguestfs commands, which might include "
9429 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
9430 "soon after launch and only when nothing is mounted."
9434 #: ../src/guestfs-actions.pod:3087
9436 "Not all of the filesystems returned will be mountable. In particular, swap "
9437 "partitions are returned in the list. Also this command does not check that "
9438 "each filesystem found is valid and mountable, and some filesystems might be "
9439 "mountable but require special options. Filesystems may not all belong to a "
9440 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
9444 #: ../src/guestfs-actions.pod:3101 ../src/guestfs-actions.pod:4624
9445 msgid "(Added in 1.5.15)"
9449 #: ../src/guestfs-actions.pod:3103
9450 msgid "guestfs_list_partitions"
9454 #: ../src/guestfs-actions.pod:3105
9458 " guestfs_list_partitions (guestfs_h *g);\n"
9463 #: ../src/guestfs-actions.pod:3108 ../fish/guestfish-actions.pod:2118
9464 msgid "List all the partitions detected on all block devices."
9468 #: ../src/guestfs-actions.pod:3110 ../fish/guestfish-actions.pod:2120
9469 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9473 #: ../src/guestfs-actions.pod:3112
9475 "This does not return logical volumes. For that you will need to call "
9480 #: ../src/guestfs-actions.pod:3123
9485 #: ../src/guestfs-actions.pod:3125
9489 " guestfs_ll (guestfs_h *g,\n"
9490 " const char *directory);\n"
9495 #: ../src/guestfs-actions.pod:3129 ../fish/guestfish-actions.pod:2131
9497 "List the files in C<directory> (relative to the root directory, there is no "
9498 "cwd) in the format of 'ls -la'."
9502 #: ../src/guestfs-actions.pod:3132 ../fish/guestfish-actions.pod:2134
9504 "This command is mostly useful for interactive sessions. It is I<not> "
9505 "intended that you try to parse the output string."
9509 #: ../src/guestfs-actions.pod:3140
9514 #: ../src/guestfs-actions.pod:3142
9518 " guestfs_ln (guestfs_h *g,\n"
9519 " const char *target,\n"
9520 " const char *linkname);\n"
9525 #: ../src/guestfs-actions.pod:3147 ../fish/guestfish-actions.pod:2141
9526 msgid "This command creates a hard link using the C<ln> command."
9530 #: ../src/guestfs-actions.pod:3153
9531 msgid "guestfs_ln_f"
9535 #: ../src/guestfs-actions.pod:3155
9539 " guestfs_ln_f (guestfs_h *g,\n"
9540 " const char *target,\n"
9541 " const char *linkname);\n"
9546 #: ../src/guestfs-actions.pod:3160 ../fish/guestfish-actions.pod:2147
9548 "This command creates a hard link using the C<ln -f> command. The C<-f> "
9549 "option removes the link (C<linkname>) if it exists already."
9553 #: ../src/guestfs-actions.pod:3167
9554 msgid "guestfs_ln_s"
9558 #: ../src/guestfs-actions.pod:3169
9562 " guestfs_ln_s (guestfs_h *g,\n"
9563 " const char *target,\n"
9564 " const char *linkname);\n"
9569 #: ../src/guestfs-actions.pod:3174 ../fish/guestfish-actions.pod:2154
9570 msgid "This command creates a symbolic link using the C<ln -s> command."
9574 #: ../src/guestfs-actions.pod:3180
9575 msgid "guestfs_ln_sf"
9579 #: ../src/guestfs-actions.pod:3182
9583 " guestfs_ln_sf (guestfs_h *g,\n"
9584 " const char *target,\n"
9585 " const char *linkname);\n"
9590 #: ../src/guestfs-actions.pod:3187 ../fish/guestfish-actions.pod:2160
9592 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
9593 "option removes the link (C<linkname>) if it exists already."
9597 #: ../src/guestfs-actions.pod:3194
9598 msgid "guestfs_lremovexattr"
9602 #: ../src/guestfs-actions.pod:3196
9606 " guestfs_lremovexattr (guestfs_h *g,\n"
9607 " const char *xattr,\n"
9608 " const char *path);\n"
9613 #: ../src/guestfs-actions.pod:3201
9615 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
9616 "link, then it removes an extended attribute of the link itself."
9620 #: ../src/guestfs-actions.pod:3209
9625 #: ../src/guestfs-actions.pod:3211
9629 " guestfs_ls (guestfs_h *g,\n"
9630 " const char *directory);\n"
9635 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2175
9637 "List the files in C<directory> (relative to the root directory, there is no "
9638 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
9642 #: ../src/guestfs-actions.pod:3219
9644 "This command is mostly useful for interactive sessions. Programs should "
9645 "probably use C<guestfs_readdir> instead."
9649 #: ../src/guestfs-actions.pod:3228
9650 msgid "guestfs_lsetxattr"
9654 #: ../src/guestfs-actions.pod:3230
9658 " guestfs_lsetxattr (guestfs_h *g,\n"
9659 " const char *xattr,\n"
9660 " const char *val,\n"
9662 " const char *path);\n"
9667 #: ../src/guestfs-actions.pod:3237
9669 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
9670 "then it sets an extended attribute of the link itself."
9674 #: ../src/guestfs-actions.pod:3245
9675 msgid "guestfs_lstat"
9679 #: ../src/guestfs-actions.pod:3247
9682 " struct guestfs_stat *\n"
9683 " guestfs_lstat (guestfs_h *g,\n"
9684 " const char *path);\n"
9689 #: ../src/guestfs-actions.pod:3251 ../src/guestfs-actions.pod:5678
9690 #: ../fish/guestfish-actions.pod:2194 ../fish/guestfish-actions.pod:3776
9691 msgid "Returns file information for the given C<path>."
9695 #: ../src/guestfs-actions.pod:3253
9697 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
9698 "link, then the link is stat-ed, not the file it refers to."
9702 #: ../src/guestfs-actions.pod:3257 ../fish/guestfish-actions.pod:2200
9703 msgid "This is the same as the C<lstat(2)> system call."
9707 #: ../src/guestfs-actions.pod:3259 ../src/guestfs-actions.pod:5682
9709 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
9710 "error. I<The caller must call C<guestfs_free_stat> after use>."
9714 #: ../src/guestfs-actions.pod:3263 ../src/guestfs-actions.pod:5686
9715 #: ../src/guestfs-actions.pod:5704 ../src/guestfs-actions.pod:6085
9716 msgid "(Added in 0.9.2)"
9720 #: ../src/guestfs-actions.pod:3265
9721 msgid "guestfs_lstatlist"
9725 #: ../src/guestfs-actions.pod:3267
9728 " struct guestfs_stat_list *\n"
9729 " guestfs_lstatlist (guestfs_h *g,\n"
9730 " const char *path,\n"
9731 " char *const *names);\n"
9736 #: ../src/guestfs-actions.pod:3272
9738 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
9739 "files, where all files are in the directory C<path>. C<names> is the list "
9740 "of files from this directory."
9744 #: ../src/guestfs-actions.pod:3276 ../fish/guestfish-actions.pod:2210
9746 "On return you get a list of stat structs, with a one-to-one correspondence "
9747 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9748 "then the C<ino> field of that structure is set to C<-1>."
9752 #: ../src/guestfs-actions.pod:3281
9754 "This call is intended for programs that want to efficiently list a directory "
9755 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
9756 "for a similarly efficient call for getting extended attributes. Very long "
9757 "directory listings might cause the protocol message size to be exceeded, "
9758 "causing this call to fail. The caller must split up such requests into "
9759 "smaller groups of names."
9763 #: ../src/guestfs-actions.pod:3289
9765 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
9766 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
9770 #: ../src/guestfs-actions.pod:3295
9771 msgid "guestfs_luks_add_key"
9775 #: ../src/guestfs-actions.pod:3297
9779 " guestfs_luks_add_key (guestfs_h *g,\n"
9780 " const char *device,\n"
9781 " const char *key,\n"
9782 " const char *newkey,\n"
9788 #: ../src/guestfs-actions.pod:3304 ../fish/guestfish-actions.pod:2227
9790 "This command adds a new key on LUKS device C<device>. C<key> is any "
9791 "existing key, and is used to access the device. C<newkey> is the new key to "
9792 "add. C<keyslot> is the key slot that will be replaced."
9796 #: ../src/guestfs-actions.pod:3309
9798 "Note that if C<keyslot> already contains a key, then this command will "
9799 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
9803 #: ../src/guestfs-actions.pod:3315 ../src/guestfs-actions.pod:3355
9804 #: ../src/guestfs-actions.pod:3378 ../src/guestfs-actions.pod:3398
9805 #: ../src/guestfs-actions.pod:3430 ../src/guestfs-actions.pod:3449
9807 "This function takes a key or passphrase parameter which could contain "
9808 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
9813 #: ../src/guestfs-actions.pod:3319 ../src/guestfs-actions.pod:3359
9814 #: ../src/guestfs-actions.pod:3382 ../src/guestfs-actions.pod:3402
9815 msgid "(Added in 1.5.2)"
9819 #: ../src/guestfs-actions.pod:3321
9820 msgid "guestfs_luks_close"
9824 #: ../src/guestfs-actions.pod:3323
9828 " guestfs_luks_close (guestfs_h *g,\n"
9829 " const char *device);\n"
9834 #: ../src/guestfs-actions.pod:3327
9836 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
9837 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
9838 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
9839 "underlying block device."
9843 #: ../src/guestfs-actions.pod:3335 ../src/guestfs-actions.pod:3434
9844 #: ../src/guestfs-actions.pod:3453 ../src/guestfs-actions.pod:3503
9845 #: ../src/guestfs-actions.pod:3551
9846 msgid "(Added in 1.5.1)"
9850 #: ../src/guestfs-actions.pod:3337
9851 msgid "guestfs_luks_format"
9855 #: ../src/guestfs-actions.pod:3339
9859 " guestfs_luks_format (guestfs_h *g,\n"
9860 " const char *device,\n"
9861 " const char *key,\n"
9867 #: ../src/guestfs-actions.pod:3345 ../fish/guestfish-actions.pod:2253
9869 "This command erases existing data on C<device> and formats the device as a "
9870 "LUKS encrypted device. C<key> is the initial key, which is added to key "
9871 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
9875 #: ../src/guestfs-actions.pod:3352 ../src/guestfs-actions.pod:3375
9876 #: ../src/guestfs-actions.pod:3515 ../src/guestfs-actions.pod:4375
9877 #: ../src/guestfs-actions.pod:5138 ../src/guestfs-actions.pod:5513
9878 #: ../src/guestfs-actions.pod:5536 ../src/guestfs-actions.pod:5562
9879 #: ../src/guestfs-actions.pod:6712 ../fish/guestfish-actions.pod:2261
9880 #: ../fish/guestfish-actions.pod:2274 ../fish/guestfish-actions.pod:2358
9881 #: ../fish/guestfish-actions.pod:2888 ../fish/guestfish-actions.pod:3395
9882 #: ../fish/guestfish-actions.pod:3675 ../fish/guestfish-actions.pod:3691
9883 #: ../fish/guestfish-actions.pod:3706 ../fish/guestfish-actions.pod:4421
9885 "B<This command is dangerous. Without careful use you can easily destroy all "
9890 #: ../src/guestfs-actions.pod:3361
9891 msgid "guestfs_luks_format_cipher"
9895 #: ../src/guestfs-actions.pod:3363
9899 " guestfs_luks_format_cipher (guestfs_h *g,\n"
9900 " const char *device,\n"
9901 " const char *key,\n"
9903 " const char *cipher);\n"
9908 #: ../src/guestfs-actions.pod:3370
9910 "This command is the same as C<guestfs_luks_format> but it also allows you to "
9911 "set the C<cipher> used."
9915 #: ../src/guestfs-actions.pod:3384
9916 msgid "guestfs_luks_kill_slot"
9920 #: ../src/guestfs-actions.pod:3386
9924 " guestfs_luks_kill_slot (guestfs_h *g,\n"
9925 " const char *device,\n"
9926 " const char *key,\n"
9932 #: ../src/guestfs-actions.pod:3392 ../fish/guestfish-actions.pod:2281
9934 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
9935 "device C<device>. C<key> must be one of the I<other> keys."
9939 #: ../src/guestfs-actions.pod:3404
9940 msgid "guestfs_luks_open"
9944 #: ../src/guestfs-actions.pod:3406
9948 " guestfs_luks_open (guestfs_h *g,\n"
9949 " const char *device,\n"
9950 " const char *key,\n"
9951 " const char *mapname);\n"
9956 #: ../src/guestfs-actions.pod:3412 ../fish/guestfish-actions.pod:2292
9958 "This command opens a block device which has been encrypted according to the "
9959 "Linux Unified Key Setup (LUKS) standard."
9963 #: ../src/guestfs-actions.pod:3415 ../fish/guestfish-actions.pod:2295
9964 msgid "C<device> is the encrypted block device or partition."
9968 #: ../src/guestfs-actions.pod:3417 ../fish/guestfish-actions.pod:2297
9970 "The caller must supply one of the keys associated with the LUKS block "
9971 "device, in the C<key> parameter."
9975 #: ../src/guestfs-actions.pod:3420 ../fish/guestfish-actions.pod:2300
9977 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
9978 "writes to this block device are decrypted from and encrypted to the "
9979 "underlying C<device> respectively."
9983 #: ../src/guestfs-actions.pod:3424
9985 "If this block device contains LVM volume groups, then calling "
9986 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
9991 #: ../src/guestfs-actions.pod:3436
9992 msgid "guestfs_luks_open_ro"
9996 #: ../src/guestfs-actions.pod:3438
10000 " guestfs_luks_open_ro (guestfs_h *g,\n"
10001 " const char *device,\n"
10002 " const char *key,\n"
10003 " const char *mapname);\n"
10008 #: ../src/guestfs-actions.pod:3444
10010 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
10015 #: ../src/guestfs-actions.pod:3455
10016 msgid "guestfs_lvcreate"
10020 #: ../src/guestfs-actions.pod:3457
10024 " guestfs_lvcreate (guestfs_h *g,\n"
10025 " const char *logvol,\n"
10026 " const char *volgroup,\n"
10032 #: ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:2325
10034 "This creates an LVM logical volume called C<logvol> on the volume group "
10035 "C<volgroup>, with C<size> megabytes."
10039 #: ../src/guestfs-actions.pod:3470
10040 msgid "guestfs_lvm_canonical_lv_name"
10044 #: ../src/guestfs-actions.pod:3472
10048 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
10049 " const char *lvname);\n"
10054 #: ../src/guestfs-actions.pod:3476 ../fish/guestfish-actions.pod:2332
10056 "This converts alternative naming schemes for LVs that you might find to the "
10057 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
10062 #: ../src/guestfs-actions.pod:3480 ../fish/guestfish-actions.pod:2336
10064 "This command returns an error if the C<lvname> parameter does not refer to a "
10069 #: ../src/guestfs-actions.pod:3483
10070 msgid "See also C<guestfs_is_lv>."
10074 #: ../src/guestfs-actions.pod:3488
10075 msgid "(Added in 1.5.24)"
10079 #: ../src/guestfs-actions.pod:3490
10080 msgid "guestfs_lvm_clear_filter"
10084 #: ../src/guestfs-actions.pod:3492
10088 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
10093 #: ../src/guestfs-actions.pod:3495
10095 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
10096 "see every block device."
10100 #: ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3540
10101 #: ../fish/guestfish-actions.pod:2348 ../fish/guestfish-actions.pod:2379
10103 "This command also clears the LVM cache and performs a volume group scan."
10107 #: ../src/guestfs-actions.pod:3505
10108 msgid "guestfs_lvm_remove_all"
10112 #: ../src/guestfs-actions.pod:3507
10116 " guestfs_lvm_remove_all (guestfs_h *g);\n"
10121 #: ../src/guestfs-actions.pod:3510 ../fish/guestfish-actions.pod:2355
10123 "This command removes all LVM logical volumes, volume groups and physical "
10128 #: ../src/guestfs-actions.pod:3520
10129 msgid "guestfs_lvm_set_filter"
10133 #: ../src/guestfs-actions.pod:3522
10137 " guestfs_lvm_set_filter (guestfs_h *g,\n"
10138 " char *const *devices);\n"
10143 #: ../src/guestfs-actions.pod:3526 ../fish/guestfish-actions.pod:2365
10145 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10146 "block devices in the list C<devices>, and will ignore all other attached "
10151 #: ../src/guestfs-actions.pod:3530 ../fish/guestfish-actions.pod:2369
10153 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10154 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10155 "there are two types of duplication possible: either cloned PVs/VGs which "
10156 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10157 "same name. In normal operation you cannot create this situation, but you "
10158 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10159 "inside the LVM metadata."
10163 #: ../src/guestfs-actions.pod:3543 ../fish/guestfish-actions.pod:2382
10164 msgid "You can filter whole block devices or individual partitions."
10168 #: ../src/guestfs-actions.pod:3545 ../fish/guestfish-actions.pod:2384
10170 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10171 "filesystem), even if you are not filtering out that VG."
10175 #: ../src/guestfs-actions.pod:3553
10176 msgid "guestfs_lvremove"
10180 #: ../src/guestfs-actions.pod:3555
10184 " guestfs_lvremove (guestfs_h *g,\n"
10185 " const char *device);\n"
10190 #: ../src/guestfs-actions.pod:3559 ../fish/guestfish-actions.pod:2392
10192 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10193 "LV, such as C</dev/VG/LV>."
10197 #: ../src/guestfs-actions.pod:3562 ../fish/guestfish-actions.pod:2395
10199 "You can also remove all LVs in a volume group by specifying the VG name, C</"
10204 #: ../src/guestfs-actions.pod:3567 ../src/guestfs-actions.pod:4721
10205 #: ../src/guestfs-actions.pod:6451
10206 msgid "(Added in 1.0.13)"
10210 #: ../src/guestfs-actions.pod:3569
10211 msgid "guestfs_lvrename"
10215 #: ../src/guestfs-actions.pod:3571
10219 " guestfs_lvrename (guestfs_h *g,\n"
10220 " const char *logvol,\n"
10221 " const char *newlogvol);\n"
10226 #: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2402
10227 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10231 #: ../src/guestfs-actions.pod:3580 ../src/guestfs-actions.pod:6464
10232 msgid "(Added in 1.0.83)"
10236 #: ../src/guestfs-actions.pod:3582
10237 msgid "guestfs_lvresize"
10241 #: ../src/guestfs-actions.pod:3584
10245 " guestfs_lvresize (guestfs_h *g,\n"
10246 " const char *device,\n"
10252 #: ../src/guestfs-actions.pod:3589 ../fish/guestfish-actions.pod:2408
10254 "This resizes (expands or shrinks) an existing LVM logical volume to "
10255 "C<mbytes>. When reducing, data in the reduced part is lost."
10259 #: ../src/guestfs-actions.pod:3597
10260 msgid "guestfs_lvresize_free"
10264 #: ../src/guestfs-actions.pod:3599
10268 " guestfs_lvresize_free (guestfs_h *g,\n"
10269 " const char *lv,\n"
10275 #: ../src/guestfs-actions.pod:3604 ../fish/guestfish-actions.pod:2416
10277 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10278 "remaining free space in the volume group. Commonly you would call this with "
10279 "pc = 100 which expands the logical volume as much as possible, using all "
10280 "remaining free space in the volume group."
10284 #: ../src/guestfs-actions.pod:3612
10285 msgid "(Added in 1.3.3)"
10289 #: ../src/guestfs-actions.pod:3614
10290 msgid "guestfs_lvs"
10294 #: ../src/guestfs-actions.pod:3616
10298 " guestfs_lvs (guestfs_h *g);\n"
10303 #: ../src/guestfs-actions.pod:3619 ../fish/guestfish-actions.pod:2426
10305 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10310 #: ../src/guestfs-actions.pod:3622 ../fish/guestfish-actions.pod:2429
10312 "This returns a list of the logical volume device names (eg. C</dev/"
10313 "VolGroup00/LogVol00>)."
10317 #: ../src/guestfs-actions.pod:3625
10318 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
10322 #: ../src/guestfs-actions.pod:3633
10323 msgid "guestfs_lvs_full"
10327 #: ../src/guestfs-actions.pod:3635
10330 " struct guestfs_lvm_lv_list *\n"
10331 " guestfs_lvs_full (guestfs_h *g);\n"
10336 #: ../src/guestfs-actions.pod:3638 ../fish/guestfish-actions.pod:2438
10338 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10339 "(8)> command. The \"full\" version includes all fields."
10343 #: ../src/guestfs-actions.pod:3641
10345 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
10346 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
10350 #: ../src/guestfs-actions.pod:3647
10351 msgid "guestfs_lvuuid"
10355 #: ../src/guestfs-actions.pod:3649
10359 " guestfs_lvuuid (guestfs_h *g,\n"
10360 " const char *device);\n"
10365 #: ../src/guestfs-actions.pod:3653 ../fish/guestfish-actions.pod:2445
10366 msgid "This command returns the UUID of the LVM LV C<device>."
10370 #: ../src/guestfs-actions.pod:3660
10371 msgid "guestfs_lxattrlist"
10375 #: ../src/guestfs-actions.pod:3662
10378 " struct guestfs_xattr_list *\n"
10379 " guestfs_lxattrlist (guestfs_h *g,\n"
10380 " const char *path,\n"
10381 " char *const *names);\n"
10386 #: ../src/guestfs-actions.pod:3667 ../fish/guestfish-actions.pod:2451
10388 "This call allows you to get the extended attributes of multiple files, where "
10389 "all files are in the directory C<path>. C<names> is the list of files from "
10394 #: ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:2455
10396 "On return you get a flat list of xattr structs which must be interpreted "
10397 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10398 "C<attrval> in this struct is zero-length to indicate there was an error "
10399 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10400 "number (the number of following attributes for this file, which could be C<"
10401 "\"0\">). Then after the first xattr struct are the zero or more attributes "
10402 "for the first named file. This repeats for the second and subsequent files."
10406 #: ../src/guestfs-actions.pod:3681
10408 "This call is intended for programs that want to efficiently list a directory "
10409 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
10410 "a similarly efficient call for getting standard stats. Very long directory "
10411 "listings might cause the protocol message size to be exceeded, causing this "
10412 "call to fail. The caller must split up such requests into smaller groups of "
10417 #: ../src/guestfs-actions.pod:3695
10418 msgid "guestfs_mkdir"
10422 #: ../src/guestfs-actions.pod:3697
10426 " guestfs_mkdir (guestfs_h *g,\n"
10427 " const char *path);\n"
10432 #: ../src/guestfs-actions.pod:3701 ../fish/guestfish-actions.pod:2477
10433 msgid "Create a directory named C<path>."
10437 #: ../src/guestfs-actions.pod:3707
10438 msgid "guestfs_mkdir_mode"
10442 #: ../src/guestfs-actions.pod:3709
10446 " guestfs_mkdir_mode (guestfs_h *g,\n"
10447 " const char *path,\n"
10453 #: ../src/guestfs-actions.pod:3714 ../fish/guestfish-actions.pod:2483
10455 "This command creates a directory, setting the initial permissions of the "
10456 "directory to C<mode>."
10460 #: ../src/guestfs-actions.pod:3717 ../fish/guestfish-actions.pod:2486
10462 "For common Linux filesystems, the actual mode which is set will be C<mode & "
10463 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
10468 #: ../src/guestfs-actions.pod:3721
10469 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
10473 #: ../src/guestfs-actions.pod:3727
10474 msgid "guestfs_mkdir_p"
10478 #: ../src/guestfs-actions.pod:3729
10482 " guestfs_mkdir_p (guestfs_h *g,\n"
10483 " const char *path);\n"
10488 #: ../src/guestfs-actions.pod:3733 ../fish/guestfish-actions.pod:2496
10490 "Create a directory named C<path>, creating any parent directories as "
10491 "necessary. This is like the C<mkdir -p> shell command."
10495 #: ../src/guestfs-actions.pod:3740
10496 msgid "guestfs_mkdtemp"
10500 #: ../src/guestfs-actions.pod:3742
10504 " guestfs_mkdtemp (guestfs_h *g,\n"
10505 " const char *template);\n"
10510 #: ../src/guestfs-actions.pod:3746 ../fish/guestfish-actions.pod:2503
10512 "This command creates a temporary directory. The C<template> parameter "
10513 "should be a full pathname for the temporary directory name with the final "
10514 "six characters being \"XXXXXX\"."
10518 #: ../src/guestfs-actions.pod:3751 ../fish/guestfish-actions.pod:2508
10520 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10521 "being suitable for Windows filesystems."
10525 #: ../src/guestfs-actions.pod:3754 ../fish/guestfish-actions.pod:2511
10526 msgid "The name of the temporary directory that was created is returned."
10530 #: ../src/guestfs-actions.pod:3757 ../fish/guestfish-actions.pod:2514
10531 msgid "The temporary directory is created with mode 0700 and is owned by root."
10535 #: ../src/guestfs-actions.pod:3760 ../fish/guestfish-actions.pod:2517
10537 "The caller is responsible for deleting the temporary directory and its "
10538 "contents after use."
10542 #: ../src/guestfs-actions.pod:3763 ../fish/guestfish-actions.pod:2520
10543 msgid "See also: L<mkdtemp(3)>"
10547 #: ../src/guestfs-actions.pod:3770
10548 msgid "guestfs_mke2fs_J"
10552 #: ../src/guestfs-actions.pod:3772
10556 " guestfs_mke2fs_J (guestfs_h *g,\n"
10557 " const char *fstype,\n"
10558 " int blocksize,\n"
10559 " const char *device,\n"
10560 " const char *journal);\n"
10565 #: ../src/guestfs-actions.pod:3779 ../fish/guestfish-actions.pod:2526
10567 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10568 "C<journal>. It is equivalent to the command:"
10572 #: ../src/guestfs-actions.pod:3783 ../fish/guestfish-actions.pod:2530
10575 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10580 #: ../src/guestfs-actions.pod:3785
10581 msgid "See also C<guestfs_mke2journal>."
10585 #: ../src/guestfs-actions.pod:3789 ../src/guestfs-actions.pod:3807
10586 #: ../src/guestfs-actions.pod:3825 ../src/guestfs-actions.pod:3841
10587 #: ../src/guestfs-actions.pod:3855 ../src/guestfs-actions.pod:3869
10588 #: ../src/guestfs-actions.pod:3921 ../src/guestfs-actions.pod:4111
10589 msgid "(Added in 1.0.68)"
10593 #: ../src/guestfs-actions.pod:3791
10594 msgid "guestfs_mke2fs_JL"
10598 #: ../src/guestfs-actions.pod:3793
10602 " guestfs_mke2fs_JL (guestfs_h *g,\n"
10603 " const char *fstype,\n"
10604 " int blocksize,\n"
10605 " const char *device,\n"
10606 " const char *label);\n"
10611 #: ../src/guestfs-actions.pod:3800 ../fish/guestfish-actions.pod:2538
10613 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10614 "the journal labeled C<label>."
10618 #: ../src/guestfs-actions.pod:3803
10619 msgid "See also C<guestfs_mke2journal_L>."
10623 #: ../src/guestfs-actions.pod:3809
10624 msgid "guestfs_mke2fs_JU"
10628 #: ../src/guestfs-actions.pod:3811
10632 " guestfs_mke2fs_JU (guestfs_h *g,\n"
10633 " const char *fstype,\n"
10634 " int blocksize,\n"
10635 " const char *device,\n"
10636 " const char *uuid);\n"
10641 #: ../src/guestfs-actions.pod:3818 ../fish/guestfish-actions.pod:2547
10643 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10644 "the journal with UUID C<uuid>."
10648 #: ../src/guestfs-actions.pod:3821
10649 msgid "See also C<guestfs_mke2journal_U>."
10653 #: ../src/guestfs-actions.pod:3827
10654 msgid "guestfs_mke2journal"
10658 #: ../src/guestfs-actions.pod:3829
10662 " guestfs_mke2journal (guestfs_h *g,\n"
10663 " int blocksize,\n"
10664 " const char *device);\n"
10669 #: ../src/guestfs-actions.pod:3834 ../fish/guestfish-actions.pod:2556
10671 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10676 #: ../src/guestfs-actions.pod:3837 ../fish/guestfish-actions.pod:2559
10679 " mke2fs -O journal_dev -b blocksize device\n"
10684 #: ../src/guestfs-actions.pod:3843
10685 msgid "guestfs_mke2journal_L"
10689 #: ../src/guestfs-actions.pod:3845
10693 " guestfs_mke2journal_L (guestfs_h *g,\n"
10694 " int blocksize,\n"
10695 " const char *label,\n"
10696 " const char *device);\n"
10701 #: ../src/guestfs-actions.pod:3851 ../fish/guestfish-actions.pod:2565
10702 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10706 #: ../src/guestfs-actions.pod:3857
10707 msgid "guestfs_mke2journal_U"
10711 #: ../src/guestfs-actions.pod:3859
10715 " guestfs_mke2journal_U (guestfs_h *g,\n"
10716 " int blocksize,\n"
10717 " const char *uuid,\n"
10718 " const char *device);\n"
10723 #: ../src/guestfs-actions.pod:3865 ../fish/guestfish-actions.pod:2571
10724 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10728 #: ../src/guestfs-actions.pod:3871
10729 msgid "guestfs_mkfifo"
10733 #: ../src/guestfs-actions.pod:3873
10737 " guestfs_mkfifo (guestfs_h *g,\n"
10739 " const char *path);\n"
10744 #: ../src/guestfs-actions.pod:3878
10746 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10747 "is just a convenient wrapper around C<guestfs_mknod>."
10751 #: ../src/guestfs-actions.pod:3888
10752 msgid "guestfs_mkfs"
10756 #: ../src/guestfs-actions.pod:3890
10760 " guestfs_mkfs (guestfs_h *g,\n"
10761 " const char *fstype,\n"
10762 " const char *device);\n"
10767 #: ../src/guestfs-actions.pod:3895 ../fish/guestfish-actions.pod:2587
10769 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10770 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10774 #: ../src/guestfs-actions.pod:3903
10775 msgid "guestfs_mkfs_b"
10779 #: ../src/guestfs-actions.pod:3905
10783 " guestfs_mkfs_b (guestfs_h *g,\n"
10784 " const char *fstype,\n"
10785 " int blocksize,\n"
10786 " const char *device);\n"
10791 #: ../src/guestfs-actions.pod:3911
10793 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
10794 "block size of the resulting filesystem. Supported block sizes depend on the "
10795 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10799 #: ../src/guestfs-actions.pod:3916 ../fish/guestfish-actions.pod:2600
10801 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10806 #: ../src/guestfs-actions.pod:3923
10807 msgid "guestfs_mkmountpoint"
10811 #: ../src/guestfs-actions.pod:3925
10815 " guestfs_mkmountpoint (guestfs_h *g,\n"
10816 " const char *exemptpath);\n"
10821 #: ../src/guestfs-actions.pod:3929
10823 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
10824 "that can be used to create extra mountpoints before mounting the first "
10829 #: ../src/guestfs-actions.pod:3933 ../fish/guestfish-actions.pod:2611
10831 "These calls are I<only> necessary in some very limited circumstances, mainly "
10832 "the case where you want to mount a mix of unrelated and/or read-only "
10833 "filesystems together."
10837 #: ../src/guestfs-actions.pod:3937 ../fish/guestfish-actions.pod:2615
10839 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10840 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10841 "inside that. You can unpack this as follows in guestfish:"
10845 #: ../src/guestfs-actions.pod:3942 ../fish/guestfish-actions.pod:2620
10848 " add-ro Fedora-11-i686-Live.iso\n"
10850 " mkmountpoint /cd\n"
10851 " mkmountpoint /sqsh\n"
10852 " mkmountpoint /ext3fs\n"
10853 " mount /dev/sda /cd\n"
10854 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10855 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10860 #: ../src/guestfs-actions.pod:3951 ../fish/guestfish-actions.pod:2629
10861 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
10865 #: ../src/guestfs-actions.pod:3953
10867 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
10868 "may get unexpected errors if you try to mix these calls. It is safest to "
10869 "manually unmount filesystems and remove mountpoints after use."
10873 #: ../src/guestfs-actions.pod:3957
10875 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
10876 "first, so for this to work for manual mountpoints, you must ensure that the "
10877 "innermost mountpoints have the longest pathnames, as in the example code "
10882 #: ../src/guestfs-actions.pod:3962 ../fish/guestfish-actions.pod:2640
10884 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
10888 #: ../src/guestfs-actions.pod:3964
10890 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
10891 "means that C<guestfs_umount_all> is called when the handle is closed which "
10892 "can also trigger these issues."
10896 #: ../src/guestfs-actions.pod:3970 ../src/guestfs-actions.pod:4229
10897 #: ../src/guestfs-actions.pod:5122
10898 msgid "(Added in 1.0.62)"
10902 #: ../src/guestfs-actions.pod:3972
10903 msgid "guestfs_mknod"
10907 #: ../src/guestfs-actions.pod:3974
10911 " guestfs_mknod (guestfs_h *g,\n"
10915 " const char *path);\n"
10920 #: ../src/guestfs-actions.pod:3981 ../fish/guestfish-actions.pod:2650
10922 "This call creates block or character special devices, or named pipes (FIFOs)."
10926 #: ../src/guestfs-actions.pod:3984 ../fish/guestfish-actions.pod:2653
10928 "The C<mode> parameter should be the mode, using the standard constants. "
10929 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
10930 "used when creating block and character special devices."
10934 #: ../src/guestfs-actions.pod:3989
10936 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
10937 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
10938 "regular file). These constants are available in the standard Linux header "
10939 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
10940 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
10941 "the appropriate constant for you."
10945 #: ../src/guestfs-actions.pod:4003
10946 msgid "guestfs_mknod_b"
10950 #: ../src/guestfs-actions.pod:4005
10954 " guestfs_mknod_b (guestfs_h *g,\n"
10958 " const char *path);\n"
10963 #: ../src/guestfs-actions.pod:4012
10965 "This call creates a block device node called C<path> with mode C<mode> and "
10966 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10967 "wrapper around C<guestfs_mknod>."
10971 #: ../src/guestfs-actions.pod:4022
10972 msgid "guestfs_mknod_c"
10976 #: ../src/guestfs-actions.pod:4024
10980 " guestfs_mknod_c (guestfs_h *g,\n"
10984 " const char *path);\n"
10989 #: ../src/guestfs-actions.pod:4031
10991 "This call creates a char device node called C<path> with mode C<mode> and "
10992 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10993 "wrapper around C<guestfs_mknod>."
10997 #: ../src/guestfs-actions.pod:4041
10998 msgid "guestfs_mkswap"
11002 #: ../src/guestfs-actions.pod:4043
11006 " guestfs_mkswap (guestfs_h *g,\n"
11007 " const char *device);\n"
11012 #: ../src/guestfs-actions.pod:4047 ../fish/guestfish-actions.pod:2692
11013 msgid "Create a swap partition on C<device>."
11017 #: ../src/guestfs-actions.pod:4053
11018 msgid "guestfs_mkswap_L"
11022 #: ../src/guestfs-actions.pod:4055
11026 " guestfs_mkswap_L (guestfs_h *g,\n"
11027 " const char *label,\n"
11028 " const char *device);\n"
11033 #: ../src/guestfs-actions.pod:4060 ../fish/guestfish-actions.pod:2698
11034 msgid "Create a swap partition on C<device> with label C<label>."
11038 #: ../src/guestfs-actions.pod:4062 ../fish/guestfish-actions.pod:2700
11040 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
11041 "sda>), just to a partition. This appears to be a limitation of the kernel "
11046 #: ../src/guestfs-actions.pod:4070
11047 msgid "guestfs_mkswap_U"
11051 #: ../src/guestfs-actions.pod:4072
11055 " guestfs_mkswap_U (guestfs_h *g,\n"
11056 " const char *uuid,\n"
11057 " const char *device);\n"
11062 #: ../src/guestfs-actions.pod:4077 ../fish/guestfish-actions.pod:2708
11063 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11067 #: ../src/guestfs-actions.pod:4083
11068 msgid "guestfs_mkswap_file"
11072 #: ../src/guestfs-actions.pod:4085
11076 " guestfs_mkswap_file (guestfs_h *g,\n"
11077 " const char *path);\n"
11082 #: ../src/guestfs-actions.pod:4089 ../fish/guestfish-actions.pod:2714
11083 msgid "Create a swap file."
11087 #: ../src/guestfs-actions.pod:4091
11089 "This command just writes a swap file signature to an existing file. To "
11090 "create the file itself, use something like C<guestfs_fallocate>."
11094 #: ../src/guestfs-actions.pod:4098
11095 msgid "guestfs_modprobe"
11099 #: ../src/guestfs-actions.pod:4100
11103 " guestfs_modprobe (guestfs_h *g,\n"
11104 " const char *modulename);\n"
11109 #: ../src/guestfs-actions.pod:4104 ../fish/guestfish-actions.pod:2723
11110 msgid "This loads a kernel module in the appliance."
11114 #: ../src/guestfs-actions.pod:4106 ../fish/guestfish-actions.pod:2725
11116 "The kernel module must have been whitelisted when libguestfs was built (see "
11117 "C<appliance/kmod.whitelist.in> in the source)."
11121 #: ../src/guestfs-actions.pod:4113
11122 msgid "guestfs_mount"
11126 #: ../src/guestfs-actions.pod:4115
11130 " guestfs_mount (guestfs_h *g,\n"
11131 " const char *device,\n"
11132 " const char *mountpoint);\n"
11137 #: ../src/guestfs-actions.pod:4120 ../fish/guestfish-actions.pod:2732
11139 "Mount a guest disk at a position in the filesystem. Block devices are named "
11140 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11141 "those block devices contain partitions, they will have the usual names (eg. "
11142 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11146 #: ../src/guestfs-actions.pod:4126 ../fish/guestfish-actions.pod:2738
11148 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11149 "mounted on C</> before others can be mounted. Other filesystems can only be "
11150 "mounted on directories which already exist."
11154 #: ../src/guestfs-actions.pod:4131 ../fish/guestfish-actions.pod:2743
11156 "The mounted filesystem is writable, if we have sufficient permissions on the "
11157 "underlying device."
11161 #: ../src/guestfs-actions.pod:4134
11163 "B<Important note:> When you use this call, the filesystem options C<sync> "
11164 "and C<noatime> are set implicitly. This was originally done because we "
11165 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11166 "very large negative performance impact and negligible effect on "
11167 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
11168 "in any code that needs performance, and instead use C<guestfs_mount_options> "
11169 "(use an empty string for the first parameter if you don't want any options)."
11173 #: ../src/guestfs-actions.pod:4148
11174 msgid "guestfs_mount_loop"
11178 #: ../src/guestfs-actions.pod:4150
11182 " guestfs_mount_loop (guestfs_h *g,\n"
11183 " const char *file,\n"
11184 " const char *mountpoint);\n"
11189 #: ../src/guestfs-actions.pod:4155 ../fish/guestfish-actions.pod:2760
11191 "This command lets you mount C<file> (a filesystem image in a file) on a "
11192 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11197 #: ../src/guestfs-actions.pod:4163
11198 msgid "guestfs_mount_options"
11202 #: ../src/guestfs-actions.pod:4165
11206 " guestfs_mount_options (guestfs_h *g,\n"
11207 " const char *options,\n"
11208 " const char *device,\n"
11209 " const char *mountpoint);\n"
11214 #: ../src/guestfs-actions.pod:4171
11216 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11217 "the mount options as for the L<mount(8)> I<-o> flag."
11221 #: ../src/guestfs-actions.pod:4175 ../fish/guestfish-actions.pod:2772
11223 "If the C<options> parameter is an empty string, then no options are passed "
11224 "(all options default to whatever the filesystem uses)."
11228 #: ../src/guestfs-actions.pod:4181 ../src/guestfs-actions.pod:4195
11229 #: ../src/guestfs-actions.pod:4212
11230 msgid "(Added in 1.0.10)"
11234 #: ../src/guestfs-actions.pod:4183
11235 msgid "guestfs_mount_ro"
11239 #: ../src/guestfs-actions.pod:4185
11243 " guestfs_mount_ro (guestfs_h *g,\n"
11244 " const char *device,\n"
11245 " const char *mountpoint);\n"
11250 #: ../src/guestfs-actions.pod:4190
11252 "This is the same as the C<guestfs_mount> command, but it mounts the "
11253 "filesystem with the read-only (I<-o ro>) flag."
11257 #: ../src/guestfs-actions.pod:4197
11258 msgid "guestfs_mount_vfs"
11262 #: ../src/guestfs-actions.pod:4199
11266 " guestfs_mount_vfs (guestfs_h *g,\n"
11267 " const char *options,\n"
11268 " const char *vfstype,\n"
11269 " const char *device,\n"
11270 " const char *mountpoint);\n"
11275 #: ../src/guestfs-actions.pod:4206
11277 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11278 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
11283 #: ../src/guestfs-actions.pod:4214
11284 msgid "guestfs_mountpoints"
11288 #: ../src/guestfs-actions.pod:4216
11292 " guestfs_mountpoints (guestfs_h *g);\n"
11297 #: ../src/guestfs-actions.pod:4219
11299 "This call is similar to C<guestfs_mounts>. That call returns a list of "
11300 "devices. This one returns a hash table (map) of device name to directory "
11301 "where the device is mounted."
11305 #: ../src/guestfs-actions.pod:4231
11306 msgid "guestfs_mounts"
11310 #: ../src/guestfs-actions.pod:4233
11314 " guestfs_mounts (guestfs_h *g);\n"
11319 #: ../src/guestfs-actions.pod:4236 ../fish/guestfish-actions.pod:2803
11321 "This returns the list of currently mounted filesystems. It returns the list "
11322 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11326 #: ../src/guestfs-actions.pod:4239 ../fish/guestfish-actions.pod:2806
11327 msgid "Some internal mounts are not shown."
11331 #: ../src/guestfs-actions.pod:4241
11332 msgid "See also: C<guestfs_mountpoints>"
11336 #: ../src/guestfs-actions.pod:4249
11341 #: ../src/guestfs-actions.pod:4251
11345 " guestfs_mv (guestfs_h *g,\n"
11346 " const char *src,\n"
11347 " const char *dest);\n"
11352 #: ../src/guestfs-actions.pod:4256 ../fish/guestfish-actions.pod:2814
11354 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11355 "destination filename or destination directory."
11359 #: ../src/guestfs-actions.pod:4263
11360 msgid "guestfs_ntfs_3g_probe"
11364 #: ../src/guestfs-actions.pod:4265
11368 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
11370 " const char *device);\n"
11375 #: ../src/guestfs-actions.pod:4270 ../fish/guestfish-actions.pod:2821
11377 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11378 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
11379 "write, and some cannot be mounted at all)."
11383 #: ../src/guestfs-actions.pod:4274 ../fish/guestfish-actions.pod:2825
11385 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11386 "can be mounted read-write. Set it to false if you want to test if the "
11387 "volume can be mounted read-only."
11391 #: ../src/guestfs-actions.pod:4278 ../fish/guestfish-actions.pod:2829
11393 "The return value is an integer which C<0> if the operation would succeed, or "
11394 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11398 #: ../src/guestfs-actions.pod:4284
11399 msgid "(Added in 1.0.43)"
11403 #: ../src/guestfs-actions.pod:4286
11404 msgid "guestfs_ntfsresize"
11408 #: ../src/guestfs-actions.pod:4288
11412 " guestfs_ntfsresize (guestfs_h *g,\n"
11413 " const char *device);\n"
11418 #: ../src/guestfs-actions.pod:4292 ../fish/guestfish-actions.pod:2837
11420 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
11421 "size of the underlying device. See also L<ntfsresize(8)>."
11425 #: ../src/guestfs-actions.pod:4300
11426 msgid "guestfs_ntfsresize_size"
11430 #: ../src/guestfs-actions.pod:4302
11434 " guestfs_ntfsresize_size (guestfs_h *g,\n"
11435 " const char *device,\n"
11436 " int64_t size);\n"
11441 #: ../src/guestfs-actions.pod:4307
11443 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
11444 "to specify the new size (in bytes) explicitly."
11448 #: ../src/guestfs-actions.pod:4312 ../src/guestfs-actions.pod:4748
11449 #: ../src/guestfs-actions.pod:4821 ../src/guestfs-actions.pod:5070
11450 msgid "(Added in 1.3.14)"
11454 #: ../src/guestfs-actions.pod:4314
11455 msgid "guestfs_part_add"
11459 #: ../src/guestfs-actions.pod:4316
11463 " guestfs_part_add (guestfs_h *g,\n"
11464 " const char *device,\n"
11465 " const char *prlogex,\n"
11466 " int64_t startsect,\n"
11467 " int64_t endsect);\n"
11472 #: ../src/guestfs-actions.pod:4323
11474 "This command adds a partition to C<device>. If there is no partition table "
11475 "on the device, call C<guestfs_part_init> first."
11479 #: ../src/guestfs-actions.pod:4326 ../fish/guestfish-actions.pod:2855
11481 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11482 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11483 "C<logical>) and C<e> (or C<extended>) partition types."
11487 #: ../src/guestfs-actions.pod:4331 ../fish/guestfish-actions.pod:2860
11489 "C<startsect> and C<endsect> are the start and end of the partition in "
11490 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11491 "from the end of the disk (C<-1> is the last sector)."
11495 #: ../src/guestfs-actions.pod:4335
11497 "Creating a partition which covers the whole disk is not so easy. Use "
11498 "C<guestfs_part_disk> to do that."
11502 #: ../src/guestfs-actions.pod:4340 ../src/guestfs-actions.pod:4378
11503 #: ../src/guestfs-actions.pod:4431 ../src/guestfs-actions.pod:4509
11504 #: ../src/guestfs-actions.pod:4547 ../src/guestfs-actions.pod:4566
11505 #: ../src/guestfs-actions.pod:4606
11506 msgid "(Added in 1.0.78)"
11510 #: ../src/guestfs-actions.pod:4342
11511 msgid "guestfs_part_del"
11515 #: ../src/guestfs-actions.pod:4344
11519 " guestfs_part_del (guestfs_h *g,\n"
11520 " const char *device,\n"
11526 #: ../src/guestfs-actions.pod:4349 ../fish/guestfish-actions.pod:2871
11527 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11531 #: ../src/guestfs-actions.pod:4351 ../fish/guestfish-actions.pod:2873
11533 "Note that in the case of MBR partitioning, deleting an extended partition "
11534 "also deletes any logical partitions it contains."
11538 #: ../src/guestfs-actions.pod:4359
11539 msgid "guestfs_part_disk"
11543 #: ../src/guestfs-actions.pod:4361
11547 " guestfs_part_disk (guestfs_h *g,\n"
11548 " const char *device,\n"
11549 " const char *parttype);\n"
11554 #: ../src/guestfs-actions.pod:4366
11556 "This command is simply a combination of C<guestfs_part_init> followed by "
11557 "C<guestfs_part_add> to create a single primary partition covering the whole "
11562 #: ../src/guestfs-actions.pod:4370
11564 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11565 "possible values are described in C<guestfs_part_init>."
11569 #: ../src/guestfs-actions.pod:4380
11570 msgid "guestfs_part_get_bootable"
11574 #: ../src/guestfs-actions.pod:4382
11578 " guestfs_part_get_bootable (guestfs_h *g,\n"
11579 " const char *device,\n"
11585 #: ../src/guestfs-actions.pod:4387 ../fish/guestfish-actions.pod:2895
11587 "This command returns true if the partition C<partnum> on C<device> has the "
11588 "bootable flag set."
11592 #: ../src/guestfs-actions.pod:4390
11593 msgid "See also C<guestfs_part_set_bootable>."
11597 #: ../src/guestfs-actions.pod:4396
11598 msgid "guestfs_part_get_mbr_id"
11602 #: ../src/guestfs-actions.pod:4398
11606 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
11607 " const char *device,\n"
11613 #: ../src/guestfs-actions.pod:4403 ../fish/guestfish-actions.pod:2904
11615 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11616 "partition C<partnum>."
11620 #: ../src/guestfs-actions.pod:4406 ../src/guestfs-actions.pod:4582
11622 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11623 "undefined results for other partition table types (see "
11624 "C<guestfs_part_get_parttype>)."
11628 #: ../src/guestfs-actions.pod:4414
11629 msgid "guestfs_part_get_parttype"
11633 #: ../src/guestfs-actions.pod:4416
11637 " guestfs_part_get_parttype (guestfs_h *g,\n"
11638 " const char *device);\n"
11643 #: ../src/guestfs-actions.pod:4420 ../fish/guestfish-actions.pod:2915
11645 "This command examines the partition table on C<device> and returns the "
11646 "partition table type (format) being used."
11650 #: ../src/guestfs-actions.pod:4423
11652 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11653 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11654 "possible, although unusual. See C<guestfs_part_init> for a full list."
11658 #: ../src/guestfs-actions.pod:4433
11659 msgid "guestfs_part_init"
11663 #: ../src/guestfs-actions.pod:4435
11667 " guestfs_part_init (guestfs_h *g,\n"
11668 " const char *device,\n"
11669 " const char *parttype);\n"
11674 #: ../src/guestfs-actions.pod:4440 ../fish/guestfish-actions.pod:2927
11676 "This creates an empty partition table on C<device> of one of the partition "
11677 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11678 "(for large disks)."
11682 #: ../src/guestfs-actions.pod:4444
11684 "Initially there are no partitions. Following this, you should call "
11685 "C<guestfs_part_add> for each partition required."
11689 #: ../src/guestfs-actions.pod:4447 ../fish/guestfish-actions.pod:2934
11690 msgid "Possible values for C<parttype> are:"
11694 #: ../src/guestfs-actions.pod:4451 ../fish/guestfish-actions.pod:2938
11695 msgid "B<efi> | B<gpt>"
11699 #: ../src/guestfs-actions.pod:4453 ../fish/guestfish-actions.pod:2940
11700 msgid "Intel EFI / GPT partition table."
11704 #: ../src/guestfs-actions.pod:4455 ../fish/guestfish-actions.pod:2942
11706 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11707 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11708 "the C<mbr> format."
11712 #: ../src/guestfs-actions.pod:4459 ../fish/guestfish-actions.pod:2946
11713 msgid "B<mbr> | B<msdos>"
11717 #: ../src/guestfs-actions.pod:4461 ../fish/guestfish-actions.pod:2948
11719 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11720 "Windows. This partition type will B<only> work for device sizes up to 2 "
11721 "TB. For large disks we recommend using C<gpt>."
11725 #: ../src/guestfs-actions.pod:4468 ../fish/guestfish-actions.pod:2955
11727 "Other partition table types that may work but are not supported include:"
11731 #: ../src/guestfs-actions.pod:4473 ../fish/guestfish-actions.pod:2960
11736 #: ../src/guestfs-actions.pod:4475 ../fish/guestfish-actions.pod:2962
11737 msgid "AIX disk labels."
11741 #: ../src/guestfs-actions.pod:4477 ../fish/guestfish-actions.pod:2964
11742 msgid "B<amiga> | B<rdb>"
11746 #: ../src/guestfs-actions.pod:4479 ../fish/guestfish-actions.pod:2966
11747 msgid "Amiga \"Rigid Disk Block\" format."
11751 #: ../src/guestfs-actions.pod:4481 ../fish/guestfish-actions.pod:2968
11756 #: ../src/guestfs-actions.pod:4483 ../fish/guestfish-actions.pod:2970
11757 msgid "BSD disk labels."
11761 #: ../src/guestfs-actions.pod:4485 ../fish/guestfish-actions.pod:2972
11766 #: ../src/guestfs-actions.pod:4487 ../fish/guestfish-actions.pod:2974
11767 msgid "DASD, used on IBM mainframes."
11771 #: ../src/guestfs-actions.pod:4489 ../fish/guestfish-actions.pod:2976
11776 #: ../src/guestfs-actions.pod:4491 ../fish/guestfish-actions.pod:2978
11777 msgid "MIPS/SGI volumes."
11781 #: ../src/guestfs-actions.pod:4493 ../fish/guestfish-actions.pod:2980
11786 #: ../src/guestfs-actions.pod:4495 ../fish/guestfish-actions.pod:2982
11787 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11791 #: ../src/guestfs-actions.pod:4497 ../fish/guestfish-actions.pod:2984
11796 #: ../src/guestfs-actions.pod:4499 ../fish/guestfish-actions.pod:2986
11797 msgid "NEC PC-98 format, common in Japan apparently."
11801 #: ../src/guestfs-actions.pod:4501 ../fish/guestfish-actions.pod:2988
11806 #: ../src/guestfs-actions.pod:4503 ../fish/guestfish-actions.pod:2990
11807 msgid "Sun disk labels."
11811 #: ../src/guestfs-actions.pod:4511
11812 msgid "guestfs_part_list"
11816 #: ../src/guestfs-actions.pod:4513
11819 " struct guestfs_partition_list *\n"
11820 " guestfs_part_list (guestfs_h *g,\n"
11821 " const char *device);\n"
11826 #: ../src/guestfs-actions.pod:4517 ../fish/guestfish-actions.pod:2998
11828 "This command parses the partition table on C<device> and returns the list of "
11829 "partitions found."
11833 #: ../src/guestfs-actions.pod:4520 ../fish/guestfish-actions.pod:3001
11834 msgid "The fields in the returned structure are:"
11838 #: ../src/guestfs-actions.pod:4524 ../fish/guestfish-actions.pod:3005
11839 msgid "B<part_num>"
11843 #: ../src/guestfs-actions.pod:4526 ../fish/guestfish-actions.pod:3007
11844 msgid "Partition number, counting from 1."
11848 #: ../src/guestfs-actions.pod:4528 ../fish/guestfish-actions.pod:3009
11849 msgid "B<part_start>"
11853 #: ../src/guestfs-actions.pod:4530
11855 "Start of the partition I<in bytes>. To get sectors you have to divide by "
11856 "the device's sector size, see C<guestfs_blockdev_getss>."
11860 #: ../src/guestfs-actions.pod:4533 ../fish/guestfish-actions.pod:3014
11861 msgid "B<part_end>"
11865 #: ../src/guestfs-actions.pod:4535 ../fish/guestfish-actions.pod:3016
11866 msgid "End of the partition in bytes."
11870 #: ../src/guestfs-actions.pod:4537 ../fish/guestfish-actions.pod:3018
11871 msgid "B<part_size>"
11875 #: ../src/guestfs-actions.pod:4539 ../fish/guestfish-actions.pod:3020
11876 msgid "Size of the partition in bytes."
11880 #: ../src/guestfs-actions.pod:4543
11882 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
11883 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
11888 #: ../src/guestfs-actions.pod:4549
11889 msgid "guestfs_part_set_bootable"
11893 #: ../src/guestfs-actions.pod:4551
11897 " guestfs_part_set_bootable (guestfs_h *g,\n"
11898 " const char *device,\n"
11900 " int bootable);\n"
11905 #: ../src/guestfs-actions.pod:4557 ../fish/guestfish-actions.pod:3028
11907 "This sets the bootable flag on partition numbered C<partnum> on device "
11908 "C<device>. Note that partitions are numbered from 1."
11912 #: ../src/guestfs-actions.pod:4560 ../fish/guestfish-actions.pod:3031
11914 "The bootable flag is used by some operating systems (notably Windows) to "
11915 "determine which partition to boot from. It is by no means universally "
11920 #: ../src/guestfs-actions.pod:4568
11921 msgid "guestfs_part_set_mbr_id"
11925 #: ../src/guestfs-actions.pod:4570
11929 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
11930 " const char *device,\n"
11937 #: ../src/guestfs-actions.pod:4576 ../fish/guestfish-actions.pod:3039
11939 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
11940 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
11941 "documentation are in fact hexadecimal numbers, but usually documented "
11942 "without any leading \"0x\" which might be confusing."
11946 #: ../src/guestfs-actions.pod:4590
11947 msgid "guestfs_part_set_name"
11951 #: ../src/guestfs-actions.pod:4592
11955 " guestfs_part_set_name (guestfs_h *g,\n"
11956 " const char *device,\n"
11958 " const char *name);\n"
11963 #: ../src/guestfs-actions.pod:4598 ../fish/guestfish-actions.pod:3053
11965 "This sets the partition name on partition numbered C<partnum> on device "
11966 "C<device>. Note that partitions are numbered from 1."
11970 #: ../src/guestfs-actions.pod:4601 ../fish/guestfish-actions.pod:3056
11972 "The partition name can only be set on certain types of partition table. "
11973 "This works on C<gpt> but not on C<mbr> partitions."
11977 #: ../src/guestfs-actions.pod:4608
11978 msgid "guestfs_part_to_dev"
11982 #: ../src/guestfs-actions.pod:4610
11986 " guestfs_part_to_dev (guestfs_h *g,\n"
11987 " const char *partition);\n"
11992 #: ../src/guestfs-actions.pod:4614 ../fish/guestfish-actions.pod:3063
11994 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
11995 "partition number, returning the device name (eg. \"/dev/sdb\")."
11999 #: ../src/guestfs-actions.pod:4618
12001 "The named partition must exist, for example as a string returned from "
12002 "C<guestfs_list_partitions>."
12006 #: ../src/guestfs-actions.pod:4626
12007 msgid "guestfs_ping_daemon"
12011 #: ../src/guestfs-actions.pod:4628
12015 " guestfs_ping_daemon (guestfs_h *g);\n"
12020 #: ../src/guestfs-actions.pod:4631 ../fish/guestfish-actions.pod:3074
12022 "This is a test probe into the guestfs daemon running inside the qemu "
12023 "subprocess. Calling this function checks that the daemon responds to the "
12024 "ping message, without affecting the daemon or attached block device(s) in "
12029 #: ../src/guestfs-actions.pod:4640
12030 msgid "guestfs_pread"
12034 #: ../src/guestfs-actions.pod:4642
12038 " guestfs_pread (guestfs_h *g,\n"
12039 " const char *path,\n"
12041 " int64_t offset,\n"
12042 " size_t *size_r);\n"
12047 #: ../src/guestfs-actions.pod:4649 ../fish/guestfish-actions.pod:3083
12049 "This command lets you read part of a file. It reads C<count> bytes of the "
12050 "file, starting at C<offset>, from file C<path>."
12054 #: ../src/guestfs-actions.pod:4652 ../src/guestfs-actions.pod:4678
12055 #: ../fish/guestfish-actions.pod:3086 ../fish/guestfish-actions.pod:3101
12057 "This may read fewer bytes than requested. For further details see the "
12058 "L<pread(2)> system call."
12062 #: ../src/guestfs-actions.pod:4655
12063 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
12067 #: ../src/guestfs-actions.pod:4666
12068 msgid "guestfs_pread_device"
12072 #: ../src/guestfs-actions.pod:4668
12076 " guestfs_pread_device (guestfs_h *g,\n"
12077 " const char *device,\n"
12079 " int64_t offset,\n"
12080 " size_t *size_r);\n"
12085 #: ../src/guestfs-actions.pod:4675 ../fish/guestfish-actions.pod:3098
12087 "This command lets you read part of a file. It reads C<count> bytes of "
12088 "C<device>, starting at C<offset>."
12092 #: ../src/guestfs-actions.pod:4681
12093 msgid "See also C<guestfs_pread>."
12097 #: ../src/guestfs-actions.pod:4690
12098 msgid "(Added in 1.5.21)"
12102 #: ../src/guestfs-actions.pod:4692
12103 msgid "guestfs_pvcreate"
12107 #: ../src/guestfs-actions.pod:4694
12111 " guestfs_pvcreate (guestfs_h *g,\n"
12112 " const char *device);\n"
12117 #: ../src/guestfs-actions.pod:4698 ../fish/guestfish-actions.pod:3113
12119 "This creates an LVM physical volume on the named C<device>, where C<device> "
12120 "should usually be a partition name such as C</dev/sda1>."
12124 #: ../src/guestfs-actions.pod:4706
12125 msgid "guestfs_pvremove"
12129 #: ../src/guestfs-actions.pod:4708
12133 " guestfs_pvremove (guestfs_h *g,\n"
12134 " const char *device);\n"
12139 #: ../src/guestfs-actions.pod:4712 ../fish/guestfish-actions.pod:3121
12141 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12146 #: ../src/guestfs-actions.pod:4715 ../fish/guestfish-actions.pod:3124
12148 "The implementation uses the C<pvremove> command which refuses to wipe "
12149 "physical volumes that contain any volume groups, so you have to remove those "
12154 #: ../src/guestfs-actions.pod:4723
12155 msgid "guestfs_pvresize"
12159 #: ../src/guestfs-actions.pod:4725
12163 " guestfs_pvresize (guestfs_h *g,\n"
12164 " const char *device);\n"
12169 #: ../src/guestfs-actions.pod:4729 ../fish/guestfish-actions.pod:3132
12171 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12172 "the new size of the underlying device."
12176 #: ../src/guestfs-actions.pod:4736
12177 msgid "guestfs_pvresize_size"
12181 #: ../src/guestfs-actions.pod:4738
12185 " guestfs_pvresize_size (guestfs_h *g,\n"
12186 " const char *device,\n"
12187 " int64_t size);\n"
12192 #: ../src/guestfs-actions.pod:4743
12194 "This command is the same as C<guestfs_pvresize> except that it allows you to "
12195 "specify the new size (in bytes) explicitly."
12199 #: ../src/guestfs-actions.pod:4750
12200 msgid "guestfs_pvs"
12204 #: ../src/guestfs-actions.pod:4752
12208 " guestfs_pvs (guestfs_h *g);\n"
12213 #: ../src/guestfs-actions.pod:4755 ../fish/guestfish-actions.pod:3146
12215 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12220 #: ../src/guestfs-actions.pod:4758 ../fish/guestfish-actions.pod:3149
12222 "This returns a list of just the device names that contain PVs (eg. C</dev/"
12227 #: ../src/guestfs-actions.pod:4761
12228 msgid "See also C<guestfs_pvs_full>."
12232 #: ../src/guestfs-actions.pod:4769
12233 msgid "guestfs_pvs_full"
12237 #: ../src/guestfs-actions.pod:4771
12240 " struct guestfs_lvm_pv_list *\n"
12241 " guestfs_pvs_full (guestfs_h *g);\n"
12246 #: ../src/guestfs-actions.pod:4774 ../fish/guestfish-actions.pod:3158
12248 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12249 "(8)> command. The \"full\" version includes all fields."
12253 #: ../src/guestfs-actions.pod:4777
12255 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
12256 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
12260 #: ../src/guestfs-actions.pod:4783
12261 msgid "guestfs_pvuuid"
12265 #: ../src/guestfs-actions.pod:4785
12269 " guestfs_pvuuid (guestfs_h *g,\n"
12270 " const char *device);\n"
12275 #: ../src/guestfs-actions.pod:4789 ../fish/guestfish-actions.pod:3165
12276 msgid "This command returns the UUID of the LVM PV C<device>."
12280 #: ../src/guestfs-actions.pod:4796
12281 msgid "guestfs_pwrite"
12285 #: ../src/guestfs-actions.pod:4798
12289 " guestfs_pwrite (guestfs_h *g,\n"
12290 " const char *path,\n"
12291 " const char *content,\n"
12292 " size_t content_size,\n"
12293 " int64_t offset);\n"
12298 #: ../src/guestfs-actions.pod:4805 ../fish/guestfish-actions.pod:3171
12300 "This command writes to part of a file. It writes the data buffer C<content> "
12301 "to the file C<path> starting at offset C<offset>."
12305 #: ../src/guestfs-actions.pod:4808 ../fish/guestfish-actions.pod:3174
12307 "This command implements the L<pwrite(2)> system call, and like that system "
12308 "call it may not write the full data requested. The return value is the "
12309 "number of bytes that were actually written to the file. This could even be "
12310 "0, although short writes are unlikely for regular files in ordinary "
12315 #: ../src/guestfs-actions.pod:4814
12316 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
12320 #: ../src/guestfs-actions.pod:4823
12321 msgid "guestfs_pwrite_device"
12325 #: ../src/guestfs-actions.pod:4825
12329 " guestfs_pwrite_device (guestfs_h *g,\n"
12330 " const char *device,\n"
12331 " const char *content,\n"
12332 " size_t content_size,\n"
12333 " int64_t offset);\n"
12338 #: ../src/guestfs-actions.pod:4832 ../fish/guestfish-actions.pod:3189
12340 "This command writes to part of a device. It writes the data buffer "
12341 "C<content> to C<device> starting at offset C<offset>."
12345 #: ../src/guestfs-actions.pod:4835 ../fish/guestfish-actions.pod:3192
12347 "This command implements the L<pwrite(2)> system call, and like that system "
12348 "call it may not write the full data requested (although short writes to disk "
12349 "devices and partitions are probably impossible with standard Linux kernels)."
12353 #: ../src/guestfs-actions.pod:4840
12354 msgid "See also C<guestfs_pwrite>."
12358 #: ../src/guestfs-actions.pod:4847
12359 msgid "(Added in 1.5.20)"
12363 #: ../src/guestfs-actions.pod:4849
12364 msgid "guestfs_read_file"
12368 #: ../src/guestfs-actions.pod:4851
12372 " guestfs_read_file (guestfs_h *g,\n"
12373 " const char *path,\n"
12374 " size_t *size_r);\n"
12379 #: ../src/guestfs-actions.pod:4856 ../fish/guestfish-actions.pod:3206
12380 msgid "This calls returns the contents of the file C<path> as a buffer."
12384 #: ../src/guestfs-actions.pod:4859
12386 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
12387 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
12388 "function is limited in the total size of file that can be handled."
12392 #: ../src/guestfs-actions.pod:4871
12393 msgid "(Added in 1.0.63)"
12397 #: ../src/guestfs-actions.pod:4873
12398 msgid "guestfs_read_lines"
12402 #: ../src/guestfs-actions.pod:4875
12406 " guestfs_read_lines (guestfs_h *g,\n"
12407 " const char *path);\n"
12412 #: ../src/guestfs-actions.pod:4881 ../fish/guestfish-actions.pod:3223
12414 "The file contents are returned as a list of lines. Trailing C<LF> and "
12415 "C<CRLF> character sequences are I<not> returned."
12419 #: ../src/guestfs-actions.pod:4884
12421 "Note that this function cannot correctly handle binary files (specifically, "
12422 "files containing C<\\0> character which is treated as end of line). For "
12423 "those you need to use the C<guestfs_read_file> function which has a more "
12424 "complex interface."
12428 #: ../src/guestfs-actions.pod:4895
12429 msgid "guestfs_readdir"
12433 #: ../src/guestfs-actions.pod:4897
12436 " struct guestfs_dirent_list *\n"
12437 " guestfs_readdir (guestfs_h *g,\n"
12438 " const char *dir);\n"
12443 #: ../src/guestfs-actions.pod:4901 ../fish/guestfish-actions.pod:3235
12444 msgid "This returns the list of directory entries in directory C<dir>."
12448 #: ../src/guestfs-actions.pod:4903 ../fish/guestfish-actions.pod:3237
12450 "All entries in the directory are returned, including C<.> and C<..>. The "
12451 "entries are I<not> sorted, but returned in the same order as the underlying "
12456 #: ../src/guestfs-actions.pod:4907 ../fish/guestfish-actions.pod:3241
12458 "Also this call returns basic file type information about each file. The "
12459 "C<ftyp> field will contain one of the following characters:"
12463 #: ../src/guestfs-actions.pod:4912 ../fish/guestfish-actions.pod:3246
12468 #: ../src/guestfs-actions.pod:4914 ../fish/guestfish-actions.pod:3248
12469 msgid "Block special"
12473 #: ../src/guestfs-actions.pod:4916 ../fish/guestfish-actions.pod:3250
12478 #: ../src/guestfs-actions.pod:4918 ../fish/guestfish-actions.pod:3252
12479 msgid "Char special"
12483 #: ../src/guestfs-actions.pod:4920 ../fish/guestfish-actions.pod:3254
12488 #: ../src/guestfs-actions.pod:4922 ../fish/guestfish-actions.pod:3256
12493 #: ../src/guestfs-actions.pod:4924 ../fish/guestfish-actions.pod:3258
12498 #: ../src/guestfs-actions.pod:4926 ../fish/guestfish-actions.pod:3260
12499 msgid "FIFO (named pipe)"
12503 #: ../src/guestfs-actions.pod:4928 ../fish/guestfish-actions.pod:3262
12508 #: ../src/guestfs-actions.pod:4930 ../fish/guestfish-actions.pod:3264
12509 msgid "Symbolic link"
12513 #: ../src/guestfs-actions.pod:4932 ../fish/guestfish-actions.pod:3266
12518 #: ../src/guestfs-actions.pod:4934 ../fish/guestfish-actions.pod:3268
12519 msgid "Regular file"
12523 #: ../src/guestfs-actions.pod:4936 ../fish/guestfish-actions.pod:3270
12528 #: ../src/guestfs-actions.pod:4938 ../fish/guestfish-actions.pod:3272
12533 #: ../src/guestfs-actions.pod:4940 ../fish/guestfish-actions.pod:3274
12538 #: ../src/guestfs-actions.pod:4942 ../fish/guestfish-actions.pod:3276
12539 msgid "Unknown file type"
12543 #: ../src/guestfs-actions.pod:4944 ../fish/guestfish-actions.pod:3278
12548 #: ../src/guestfs-actions.pod:4946 ../fish/guestfish-actions.pod:3280
12550 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12554 #: ../src/guestfs-actions.pod:4951
12556 "This function is primarily intended for use by programs. To get a simple "
12557 "list of names, use C<guestfs_ls>. To get a printable directory for human "
12558 "consumption, use C<guestfs_ll>."
12562 #: ../src/guestfs-actions.pod:4955
12564 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
12565 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
12569 #: ../src/guestfs-actions.pod:4961
12570 msgid "guestfs_readlink"
12574 #: ../src/guestfs-actions.pod:4963
12578 " guestfs_readlink (guestfs_h *g,\n"
12579 " const char *path);\n"
12584 #: ../src/guestfs-actions.pod:4967 ../fish/guestfish-actions.pod:3293
12585 msgid "This command reads the target of a symbolic link."
12589 #: ../src/guestfs-actions.pod:4974
12590 msgid "guestfs_readlinklist"
12594 #: ../src/guestfs-actions.pod:4976
12598 " guestfs_readlinklist (guestfs_h *g,\n"
12599 " const char *path,\n"
12600 " char *const *names);\n"
12605 #: ../src/guestfs-actions.pod:4981 ../fish/guestfish-actions.pod:3299
12607 "This call allows you to do a C<readlink> operation on multiple files, where "
12608 "all files are in the directory C<path>. C<names> is the list of files from "
12613 #: ../src/guestfs-actions.pod:4985 ../fish/guestfish-actions.pod:3303
12615 "On return you get a list of strings, with a one-to-one correspondence to the "
12616 "C<names> list. Each string is the value of the symbolic link."
12620 #: ../src/guestfs-actions.pod:4989 ../fish/guestfish-actions.pod:3307
12622 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12623 "result string is the empty string C<\"\">. However the whole operation is "
12624 "completed even if there were C<readlink(2)> errors, and so you can call this "
12625 "function with names where you don't know if they are symbolic links already "
12626 "(albeit slightly less efficient)."
12630 #: ../src/guestfs-actions.pod:4996 ../fish/guestfish-actions.pod:3314
12632 "This call is intended for programs that want to efficiently list a directory "
12633 "contents without making many round-trips. Very long directory listings "
12634 "might cause the protocol message size to be exceeded, causing this call to "
12635 "fail. The caller must split up such requests into smaller groups of names."
12639 #: ../src/guestfs-actions.pod:5009
12640 msgid "guestfs_realpath"
12644 #: ../src/guestfs-actions.pod:5011
12648 " guestfs_realpath (guestfs_h *g,\n"
12649 " const char *path);\n"
12654 #: ../src/guestfs-actions.pod:5015 ../fish/guestfish-actions.pod:3325
12656 "Return the canonicalized absolute pathname of C<path>. The returned path "
12657 "has no C<.>, C<..> or symbolic link path elements."
12661 #: ../src/guestfs-actions.pod:5023
12662 msgid "guestfs_removexattr"
12666 #: ../src/guestfs-actions.pod:5025
12670 " guestfs_removexattr (guestfs_h *g,\n"
12671 " const char *xattr,\n"
12672 " const char *path);\n"
12677 #: ../src/guestfs-actions.pod:5030 ../fish/guestfish-actions.pod:3332
12679 "This call removes the extended attribute named C<xattr> of the file C<path>."
12683 #: ../src/guestfs-actions.pod:5033
12684 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
12688 #: ../src/guestfs-actions.pod:5039
12689 msgid "guestfs_resize2fs"
12693 #: ../src/guestfs-actions.pod:5041
12697 " guestfs_resize2fs (guestfs_h *g,\n"
12698 " const char *device);\n"
12703 #: ../src/guestfs-actions.pod:5045 ../fish/guestfish-actions.pod:3341
12705 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12706 "underlying device."
12710 #: ../src/guestfs-actions.pod:5048
12712 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
12713 "C<device> before calling this command. For unknown reasons C<resize2fs> "
12714 "sometimes gives an error about this and sometimes not. In any case, it is "
12715 "always safe to call C<guestfs_e2fsck_f> before calling this function."
12719 #: ../src/guestfs-actions.pod:5058
12720 msgid "guestfs_resize2fs_size"
12724 #: ../src/guestfs-actions.pod:5060
12728 " guestfs_resize2fs_size (guestfs_h *g,\n"
12729 " const char *device,\n"
12730 " int64_t size);\n"
12735 #: ../src/guestfs-actions.pod:5065
12737 "This command is the same as C<guestfs_resize2fs> except that it allows you "
12738 "to specify the new size (in bytes) explicitly."
12742 #: ../src/guestfs-actions.pod:5072
12747 #: ../src/guestfs-actions.pod:5074
12751 " guestfs_rm (guestfs_h *g,\n"
12752 " const char *path);\n"
12757 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3361
12758 msgid "Remove the single file C<path>."
12762 #: ../src/guestfs-actions.pod:5084
12763 msgid "guestfs_rm_rf"
12767 #: ../src/guestfs-actions.pod:5086
12771 " guestfs_rm_rf (guestfs_h *g,\n"
12772 " const char *path);\n"
12777 #: ../src/guestfs-actions.pod:5090 ../fish/guestfish-actions.pod:3367
12779 "Remove the file or directory C<path>, recursively removing the contents if "
12780 "its a directory. This is like the C<rm -rf> shell command."
12784 #: ../src/guestfs-actions.pod:5098
12785 msgid "guestfs_rmdir"
12789 #: ../src/guestfs-actions.pod:5100
12793 " guestfs_rmdir (guestfs_h *g,\n"
12794 " const char *path);\n"
12799 #: ../src/guestfs-actions.pod:5104 ../fish/guestfish-actions.pod:3375
12800 msgid "Remove the single directory C<path>."
12804 #: ../src/guestfs-actions.pod:5110
12805 msgid "guestfs_rmmountpoint"
12809 #: ../src/guestfs-actions.pod:5112
12813 " guestfs_rmmountpoint (guestfs_h *g,\n"
12814 " const char *exemptpath);\n"
12819 #: ../src/guestfs-actions.pod:5116
12821 "This calls removes a mountpoint that was previously created with "
12822 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
12826 #: ../src/guestfs-actions.pod:5124
12827 msgid "guestfs_scrub_device"
12831 #: ../src/guestfs-actions.pod:5126
12835 " guestfs_scrub_device (guestfs_h *g,\n"
12836 " const char *device);\n"
12841 #: ../src/guestfs-actions.pod:5130 ../fish/guestfish-actions.pod:3389
12843 "This command writes patterns over C<device> to make data retrieval more "
12848 #: ../src/guestfs-actions.pod:5133 ../src/guestfs-actions.pod:5154
12849 #: ../src/guestfs-actions.pod:5173 ../fish/guestfish-actions.pod:3392
12850 #: ../fish/guestfish-actions.pod:3407 ../fish/guestfish-actions.pod:3420
12852 "It is an interface to the L<scrub(1)> program. See that manual page for "
12857 #: ../src/guestfs-actions.pod:5141 ../src/guestfs-actions.pod:5159
12858 #: ../src/guestfs-actions.pod:5178
12859 msgid "(Added in 1.0.52)"
12863 #: ../src/guestfs-actions.pod:5143
12864 msgid "guestfs_scrub_file"
12868 #: ../src/guestfs-actions.pod:5145
12872 " guestfs_scrub_file (guestfs_h *g,\n"
12873 " const char *file);\n"
12878 #: ../src/guestfs-actions.pod:5149 ../fish/guestfish-actions.pod:3402
12880 "This command writes patterns over a file to make data retrieval more "
12885 #: ../src/guestfs-actions.pod:5152 ../fish/guestfish-actions.pod:3405
12886 msgid "The file is I<removed> after scrubbing."
12890 #: ../src/guestfs-actions.pod:5161
12891 msgid "guestfs_scrub_freespace"
12895 #: ../src/guestfs-actions.pod:5163
12899 " guestfs_scrub_freespace (guestfs_h *g,\n"
12900 " const char *dir);\n"
12905 #: ../src/guestfs-actions.pod:5167
12907 "This command creates the directory C<dir> and then fills it with files until "
12908 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
12909 "and deletes them. The intention is to scrub any free space on the partition "
12910 "containing C<dir>."
12914 #: ../src/guestfs-actions.pod:5180
12915 msgid "guestfs_set_append"
12919 #: ../src/guestfs-actions.pod:5182
12923 " guestfs_set_append (guestfs_h *g,\n"
12924 " const char *append);\n"
12929 #: ../src/guestfs-actions.pod:5186 ../fish/guestfish-actions.pod:3429
12931 "This function is used to add additional options to the guest kernel command "
12936 #: ../src/guestfs-actions.pod:5189 ../fish/guestfish-actions.pod:3432
12938 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
12939 "environment variable."
12943 #: ../src/guestfs-actions.pod:5192 ../fish/guestfish-actions.pod:3435
12945 "Setting C<append> to C<NULL> means I<no> additional options are passed "
12946 "(libguestfs always adds a few of its own)."
12950 #: ../src/guestfs-actions.pod:5199
12951 msgid "guestfs_set_autosync"
12955 #: ../src/guestfs-actions.pod:5201
12959 " guestfs_set_autosync (guestfs_h *g,\n"
12960 " int autosync);\n"
12965 #: ../src/guestfs-actions.pod:5205
12967 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
12968 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
12969 "the handle is closed (also if the program exits without closing handles)."
12973 #: ../src/guestfs-actions.pod:5210 ../fish/guestfish-actions.pod:3449
12975 "This is enabled by default (since libguestfs 1.5.24, previously it was "
12976 "disabled by default)."
12980 #: ../src/guestfs-actions.pod:5217
12981 msgid "guestfs_set_direct"
12985 #: ../src/guestfs-actions.pod:5219
12989 " guestfs_set_direct (guestfs_h *g,\n"
12995 #: ../src/guestfs-actions.pod:5223 ../fish/guestfish-actions.pod:3458
12997 "If the direct appliance mode flag is enabled, then stdin and stdout are "
12998 "passed directly through to the appliance once it is launched."
13002 #: ../src/guestfs-actions.pod:5227
13004 "One consequence of this is that log messages aren't caught by the library "
13005 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
13010 #: ../src/guestfs-actions.pod:5231 ../fish/guestfish-actions.pod:3466
13011 msgid "You probably don't want to use this unless you know what you are doing."
13015 #: ../src/guestfs-actions.pod:5234 ../fish/guestfish-actions.pod:3469
13016 msgid "The default is disabled."
13020 #: ../src/guestfs-actions.pod:5240
13021 msgid "guestfs_set_e2label"
13025 #: ../src/guestfs-actions.pod:5242
13029 " guestfs_set_e2label (guestfs_h *g,\n"
13030 " const char *device,\n"
13031 " const char *label);\n"
13036 #: ../src/guestfs-actions.pod:5247 ../fish/guestfish-actions.pod:3475
13038 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
13039 "C<label>. Filesystem labels are limited to 16 characters."
13043 #: ../src/guestfs-actions.pod:5251
13045 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
13046 "the existing label on a filesystem."
13050 #: ../src/guestfs-actions.pod:5258
13051 msgid "guestfs_set_e2uuid"
13055 #: ../src/guestfs-actions.pod:5260
13059 " guestfs_set_e2uuid (guestfs_h *g,\n"
13060 " const char *device,\n"
13061 " const char *uuid);\n"
13066 #: ../src/guestfs-actions.pod:5265 ../fish/guestfish-actions.pod:3486
13068 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13069 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13070 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13074 #: ../src/guestfs-actions.pod:5270
13076 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
13077 "the existing UUID of a filesystem."
13081 #: ../src/guestfs-actions.pod:5277
13082 msgid "guestfs_set_memsize"
13086 #: ../src/guestfs-actions.pod:5279
13090 " guestfs_set_memsize (guestfs_h *g,\n"
13096 #: ../src/guestfs-actions.pod:5283
13098 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13099 "This only has any effect if called before C<guestfs_launch>."
13103 #: ../src/guestfs-actions.pod:5287 ../fish/guestfish-actions.pod:3504
13105 "You can also change this by setting the environment variable "
13106 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13110 #: ../src/guestfs-actions.pod:5298
13111 msgid "guestfs_set_network"
13115 #: ../src/guestfs-actions.pod:5300
13119 " guestfs_set_network (guestfs_h *g,\n"
13125 #: ../src/guestfs-actions.pod:5304 ../fish/guestfish-actions.pod:3517
13127 "If C<network> is true, then the network is enabled in the libguestfs "
13128 "appliance. The default is false."
13132 #: ../src/guestfs-actions.pod:5307 ../fish/guestfish-actions.pod:3520
13134 "This affects whether commands are able to access the network (see L<guestfs"
13135 "(3)/RUNNING COMMANDS>)."
13139 #: ../src/guestfs-actions.pod:5310
13141 "You must call this before calling C<guestfs_launch>, otherwise it has no "
13146 #: ../src/guestfs-actions.pod:5317
13147 msgid "guestfs_set_path"
13151 #: ../src/guestfs-actions.pod:5319
13155 " guestfs_set_path (guestfs_h *g,\n"
13156 " const char *searchpath);\n"
13161 #: ../src/guestfs-actions.pod:5323 ../fish/guestfish-actions.pod:3532
13162 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13166 #: ../src/guestfs-actions.pod:5325 ../fish/guestfish-actions.pod:3534
13168 "The default is C<$libdir/guestfs> unless overridden by setting "
13169 "C<LIBGUESTFS_PATH> environment variable."
13173 #: ../src/guestfs-actions.pod:5328 ../fish/guestfish-actions.pod:3537
13174 msgid "Setting C<path> to C<NULL> restores the default path."
13178 #: ../src/guestfs-actions.pod:5334
13179 msgid "guestfs_set_qemu"
13183 #: ../src/guestfs-actions.pod:5336
13187 " guestfs_set_qemu (guestfs_h *g,\n"
13188 " const char *qemu);\n"
13193 #: ../src/guestfs-actions.pod:5340 ../fish/guestfish-actions.pod:3545
13194 msgid "Set the qemu binary that we will use."
13198 #: ../src/guestfs-actions.pod:5342 ../fish/guestfish-actions.pod:3547
13200 "The default is chosen when the library was compiled by the configure script."
13204 #: ../src/guestfs-actions.pod:5345 ../fish/guestfish-actions.pod:3550
13206 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13211 #: ../src/guestfs-actions.pod:5348 ../fish/guestfish-actions.pod:3553
13212 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13216 #: ../src/guestfs-actions.pod:5350 ../fish/guestfish-actions.pod:3555
13218 "Note that you should call this function as early as possible after creating "
13219 "the handle. This is because some pre-launch operations depend on testing "
13220 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13221 "don't retest features, and so you might see inconsistent results. Using the "
13222 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13223 "the qemu binary at the same time as the handle is created."
13227 #: ../src/guestfs-actions.pod:5362
13228 msgid "guestfs_set_recovery_proc"
13232 #: ../src/guestfs-actions.pod:5364
13236 " guestfs_set_recovery_proc (guestfs_h *g,\n"
13237 " int recoveryproc);\n"
13242 #: ../src/guestfs-actions.pod:5368
13244 "If this is called with the parameter C<false> then C<guestfs_launch> does "
13245 "not create a recovery process. The purpose of the recovery process is to "
13246 "stop runaway qemu processes in the case where the main program aborts "
13251 #: ../src/guestfs-actions.pod:5373
13253 "This only has any effect if called before C<guestfs_launch>, and the default "
13258 #: ../src/guestfs-actions.pod:5376 ../fish/guestfish-actions.pod:3577
13260 "About the only time when you would want to disable this is if the main "
13261 "process will fork itself into the background (\"daemonize\" itself). In "
13262 "this case the recovery process thinks that the main program has disappeared "
13263 "and so kills qemu, which is not very helpful."
13267 #: ../src/guestfs-actions.pod:5386
13268 msgid "guestfs_set_selinux"
13272 #: ../src/guestfs-actions.pod:5388
13276 " guestfs_set_selinux (guestfs_h *g,\n"
13282 #: ../src/guestfs-actions.pod:5392 ../fish/guestfish-actions.pod:3589
13284 "This sets the selinux flag that is passed to the appliance at boot time. "
13285 "The default is C<selinux=0> (disabled)."
13289 #: ../src/guestfs-actions.pod:5395 ../fish/guestfish-actions.pod:3592
13291 "Note that if SELinux is enabled, it is always in Permissive mode "
13292 "(C<enforcing=0>)."
13296 #: ../src/guestfs-actions.pod:5405
13297 msgid "guestfs_set_trace"
13301 #: ../src/guestfs-actions.pod:5407
13305 " guestfs_set_trace (guestfs_h *g,\n"
13311 #: ../src/guestfs-actions.pod:5411 ../fish/guestfish-actions.pod:3604
13313 "If the command trace flag is set to 1, then commands are printed on stderr "
13314 "before they are executed in a format which is very similar to the one used "
13315 "by guestfish. In other words, you can run a program with this enabled, and "
13316 "you will get out a script which you can feed to guestfish to perform the "
13317 "same set of actions."
13321 #: ../src/guestfs-actions.pod:5418 ../fish/guestfish-actions.pod:3611
13323 "If you want to trace C API calls into libguestfs (and other libraries) then "
13324 "possibly a better way is to use the external ltrace(1) command."
13328 #: ../src/guestfs-actions.pod:5422 ../fish/guestfish-actions.pod:3615
13330 "Command traces are disabled unless the environment variable "
13331 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13335 #: ../src/guestfs-actions.pod:5429
13336 msgid "guestfs_set_verbose"
13340 #: ../src/guestfs-actions.pod:5431
13344 " guestfs_set_verbose (guestfs_h *g,\n"
13350 #: ../src/guestfs-actions.pod:5435 ../fish/guestfish-actions.pod:3624
13351 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
13355 #: ../src/guestfs-actions.pod:5437 ../fish/guestfish-actions.pod:3626
13357 "Verbose messages are disabled unless the environment variable "
13358 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13362 #: ../src/guestfs-actions.pod:5444
13363 msgid "guestfs_setcon"
13367 #: ../src/guestfs-actions.pod:5446
13371 " guestfs_setcon (guestfs_h *g,\n"
13372 " const char *context);\n"
13377 #: ../src/guestfs-actions.pod:5450 ../fish/guestfish-actions.pod:3633
13379 "This sets the SELinux security context of the daemon to the string "
13384 #: ../src/guestfs-actions.pod:5453 ../fish/guestfish-actions.pod:3636
13385 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13389 #: ../src/guestfs-actions.pod:5459
13390 msgid "guestfs_setxattr"
13394 #: ../src/guestfs-actions.pod:5461
13398 " guestfs_setxattr (guestfs_h *g,\n"
13399 " const char *xattr,\n"
13400 " const char *val,\n"
13402 " const char *path);\n"
13407 #: ../src/guestfs-actions.pod:5468 ../fish/guestfish-actions.pod:3642
13409 "This call sets the extended attribute named C<xattr> of the file C<path> to "
13410 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
13414 #: ../src/guestfs-actions.pod:5472
13415 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
13419 #: ../src/guestfs-actions.pod:5478
13420 msgid "guestfs_sfdisk"
13424 #: ../src/guestfs-actions.pod:5480
13428 " guestfs_sfdisk (guestfs_h *g,\n"
13429 " const char *device,\n"
13433 " char *const *lines);\n"
13438 #: ../src/guestfs-actions.pod:5488 ../fish/guestfish-actions.pod:3652
13440 "This is a direct interface to the L<sfdisk(8)> program for creating "
13441 "partitions on block devices."
13445 #: ../src/guestfs-actions.pod:5491 ../fish/guestfish-actions.pod:3655
13446 msgid "C<device> should be a block device, for example C</dev/sda>."
13450 #: ../src/guestfs-actions.pod:5493 ../fish/guestfish-actions.pod:3657
13452 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
13453 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
13454 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
13455 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
13456 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
13457 "the kernel) cannot work out the right geometry and you will need to tell it."
13461 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:3665
13463 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
13464 "refer to the L<sfdisk(8)> manpage."
13468 #: ../src/guestfs-actions.pod:5504 ../fish/guestfish-actions.pod:3668
13470 "To create a single partition occupying the whole disk, you would pass "
13471 "C<lines> as a single element list, when the single element being the string "
13476 #: ../src/guestfs-actions.pod:5508
13478 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
13482 #: ../src/guestfs-actions.pod:5518
13483 msgid "guestfs_sfdiskM"
13487 #: ../src/guestfs-actions.pod:5520
13491 " guestfs_sfdiskM (guestfs_h *g,\n"
13492 " const char *device,\n"
13493 " char *const *lines);\n"
13498 #: ../src/guestfs-actions.pod:5525
13500 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
13501 "partition sizes are specified in megabytes only (rounded to the nearest "
13502 "cylinder) and you don't need to specify the cyls, heads and sectors "
13503 "parameters which were rarely if ever used anyway."
13507 #: ../src/guestfs-actions.pod:5531
13509 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
13510 "C<guestfs_part_disk>"
13514 #: ../src/guestfs-actions.pod:5541
13515 msgid "guestfs_sfdisk_N"
13519 #: ../src/guestfs-actions.pod:5543
13523 " guestfs_sfdisk_N (guestfs_h *g,\n"
13524 " const char *device,\n"
13529 " const char *line);\n"
13534 #: ../src/guestfs-actions.pod:5552 ../fish/guestfish-actions.pod:3698
13536 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13537 "(note: C<n> counts from 1)."
13541 #: ../src/guestfs-actions.pod:5555
13543 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
13544 "for the cyls/heads/sectors parameters."
13548 #: ../src/guestfs-actions.pod:5558
13549 msgid "See also: C<guestfs_part_add>"
13553 #: ../src/guestfs-actions.pod:5567
13554 msgid "guestfs_sfdisk_disk_geometry"
13558 #: ../src/guestfs-actions.pod:5569
13562 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
13563 " const char *device);\n"
13568 #: ../src/guestfs-actions.pod:5573
13570 "This displays the disk geometry of C<device> read from the partition table. "
13571 "Especially in the case where the underlying block device has been resized, "
13572 "this can be different from the kernel's idea of the geometry (see "
13573 "C<guestfs_sfdisk_kernel_geometry>)."
13577 #: ../src/guestfs-actions.pod:5578 ../src/guestfs-actions.pod:5594
13578 #: ../fish/guestfish-actions.pod:3718 ../fish/guestfish-actions.pod:3727
13579 msgid "The result is in human-readable format, and not designed to be parsed."
13583 #: ../src/guestfs-actions.pod:5586
13584 msgid "guestfs_sfdisk_kernel_geometry"
13588 #: ../src/guestfs-actions.pod:5588
13592 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
13593 " const char *device);\n"
13598 #: ../src/guestfs-actions.pod:5592 ../fish/guestfish-actions.pod:3725
13599 msgid "This displays the kernel's idea of the geometry of C<device>."
13603 #: ../src/guestfs-actions.pod:5602
13604 msgid "guestfs_sfdisk_l"
13608 #: ../src/guestfs-actions.pod:5604
13612 " guestfs_sfdisk_l (guestfs_h *g,\n"
13613 " const char *device);\n"
13618 #: ../src/guestfs-actions.pod:5608 ../fish/guestfish-actions.pod:3734
13620 "This displays the partition table on C<device>, in the human-readable output "
13621 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13625 #: ../src/guestfs-actions.pod:5612
13626 msgid "See also: C<guestfs_part_list>"
13630 #: ../src/guestfs-actions.pod:5619
13635 #: ../src/guestfs-actions.pod:5621
13639 " guestfs_sh (guestfs_h *g,\n"
13640 " const char *command);\n"
13645 #: ../src/guestfs-actions.pod:5625 ../fish/guestfish-actions.pod:3744
13647 "This call runs a command from the guest filesystem via the guest's C</bin/"
13652 #: ../src/guestfs-actions.pod:5628
13653 msgid "This is like C<guestfs_command>, but passes the command to:"
13657 #: ../src/guestfs-actions.pod:5630 ../fish/guestfish-actions.pod:3749
13660 " /bin/sh -c \"command\"\n"
13665 #: ../src/guestfs-actions.pod:5632 ../fish/guestfish-actions.pod:3751
13667 "Depending on the guest's shell, this usually results in wildcards being "
13668 "expanded, shell expressions being interpolated and so on."
13672 #: ../src/guestfs-actions.pod:5636
13673 msgid "All the provisos about C<guestfs_command> apply to this call."
13677 #: ../src/guestfs-actions.pod:5643
13678 msgid "guestfs_sh_lines"
13682 #: ../src/guestfs-actions.pod:5645
13686 " guestfs_sh_lines (guestfs_h *g,\n"
13687 " const char *command);\n"
13692 #: ../src/guestfs-actions.pod:5649
13694 "This is the same as C<guestfs_sh>, but splits the result into a list of "
13699 #: ../src/guestfs-actions.pod:5652
13700 msgid "See also: C<guestfs_command_lines>"
13704 #: ../src/guestfs-actions.pod:5660
13705 msgid "guestfs_sleep"
13709 #: ../src/guestfs-actions.pod:5662
13713 " guestfs_sleep (guestfs_h *g,\n"
13719 #: ../src/guestfs-actions.pod:5666 ../fish/guestfish-actions.pod:3770
13720 msgid "Sleep for C<secs> seconds."
13724 #: ../src/guestfs-actions.pod:5670
13725 msgid "(Added in 1.0.41)"
13729 #: ../src/guestfs-actions.pod:5672 ../src/guestfs-structs.pod:109
13730 msgid "guestfs_stat"
13734 #: ../src/guestfs-actions.pod:5674
13737 " struct guestfs_stat *\n"
13738 " guestfs_stat (guestfs_h *g,\n"
13739 " const char *path);\n"
13744 #: ../src/guestfs-actions.pod:5680 ../fish/guestfish-actions.pod:3778
13745 msgid "This is the same as the C<stat(2)> system call."
13749 #: ../src/guestfs-actions.pod:5688 ../src/guestfs-structs.pod:135
13750 msgid "guestfs_statvfs"
13754 #: ../src/guestfs-actions.pod:5690
13757 " struct guestfs_statvfs *\n"
13758 " guestfs_statvfs (guestfs_h *g,\n"
13759 " const char *path);\n"
13764 #: ../src/guestfs-actions.pod:5694 ../fish/guestfish-actions.pod:3784
13766 "Returns file system statistics for any mounted file system. C<path> should "
13767 "be a file or directory in the mounted file system (typically it is the mount "
13768 "point itself, but it doesn't need to be)."
13772 #: ../src/guestfs-actions.pod:5698 ../fish/guestfish-actions.pod:3788
13773 msgid "This is the same as the C<statvfs(2)> system call."
13777 #: ../src/guestfs-actions.pod:5700
13779 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
13780 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
13784 #: ../src/guestfs-actions.pod:5706
13785 msgid "guestfs_strings"
13789 #: ../src/guestfs-actions.pod:5708
13793 " guestfs_strings (guestfs_h *g,\n"
13794 " const char *path);\n"
13799 #: ../src/guestfs-actions.pod:5712 ../fish/guestfish-actions.pod:3794
13801 "This runs the L<strings(1)> command on a file and returns the list of "
13802 "printable strings found."
13806 #: ../src/guestfs-actions.pod:5724
13807 msgid "guestfs_strings_e"
13811 #: ../src/guestfs-actions.pod:5726
13815 " guestfs_strings_e (guestfs_h *g,\n"
13816 " const char *encoding,\n"
13817 " const char *path);\n"
13822 #: ../src/guestfs-actions.pod:5731
13824 "This is like the C<guestfs_strings> command, but allows you to specify the "
13825 "encoding of strings that are looked for in the source file C<path>."
13829 #: ../src/guestfs-actions.pod:5735 ../fish/guestfish-actions.pod:3808
13830 msgid "Allowed encodings are:"
13834 #: ../src/guestfs-actions.pod:5739 ../fish/guestfish-actions.pod:3812
13839 #: ../src/guestfs-actions.pod:5741
13841 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13842 "ISO-8859-X (this is what C<guestfs_strings> uses)."
13846 #: ../src/guestfs-actions.pod:5744 ../fish/guestfish-actions.pod:3817
13851 #: ../src/guestfs-actions.pod:5746 ../fish/guestfish-actions.pod:3819
13852 msgid "Single 8-bit-byte characters."
13856 #: ../src/guestfs-actions.pod:5748 ../fish/guestfish-actions.pod:3821
13861 #: ../src/guestfs-actions.pod:5750 ../fish/guestfish-actions.pod:3823
13862 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13866 #: ../src/guestfs-actions.pod:5753 ../fish/guestfish-actions.pod:3826
13867 msgid "l (lower case letter L)"
13871 #: ../src/guestfs-actions.pod:5755 ../fish/guestfish-actions.pod:3828
13873 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
13874 "examining binaries in Windows guests."
13878 #: ../src/guestfs-actions.pod:5758 ../fish/guestfish-actions.pod:3831
13883 #: ../src/guestfs-actions.pod:5760 ../fish/guestfish-actions.pod:3833
13884 msgid "32-bit big endian such as UCS-4BE."
13888 #: ../src/guestfs-actions.pod:5762 ../fish/guestfish-actions.pod:3835
13893 #: ../src/guestfs-actions.pod:5764 ../fish/guestfish-actions.pod:3837
13894 msgid "32-bit little endian such as UCS-4LE."
13898 #: ../src/guestfs-actions.pod:5768 ../fish/guestfish-actions.pod:3841
13899 msgid "The returned strings are transcoded to UTF-8."
13903 #: ../src/guestfs-actions.pod:5779
13904 msgid "guestfs_swapoff_device"
13908 #: ../src/guestfs-actions.pod:5781
13912 " guestfs_swapoff_device (guestfs_h *g,\n"
13913 " const char *device);\n"
13918 #: ../src/guestfs-actions.pod:5785
13920 "This command disables the libguestfs appliance swap device or partition "
13921 "named C<device>. See C<guestfs_swapon_device>."
13925 #: ../src/guestfs-actions.pod:5793
13926 msgid "guestfs_swapoff_file"
13930 #: ../src/guestfs-actions.pod:5795
13934 " guestfs_swapoff_file (guestfs_h *g,\n"
13935 " const char *file);\n"
13940 #: ../src/guestfs-actions.pod:5799 ../fish/guestfish-actions.pod:3858
13941 msgid "This command disables the libguestfs appliance swap on file."
13945 #: ../src/guestfs-actions.pod:5805
13946 msgid "guestfs_swapoff_label"
13950 #: ../src/guestfs-actions.pod:5807
13954 " guestfs_swapoff_label (guestfs_h *g,\n"
13955 " const char *label);\n"
13960 #: ../src/guestfs-actions.pod:5811 ../fish/guestfish-actions.pod:3864
13962 "This command disables the libguestfs appliance swap on labeled swap "
13967 #: ../src/guestfs-actions.pod:5818
13968 msgid "guestfs_swapoff_uuid"
13972 #: ../src/guestfs-actions.pod:5820
13976 " guestfs_swapoff_uuid (guestfs_h *g,\n"
13977 " const char *uuid);\n"
13982 #: ../src/guestfs-actions.pod:5824 ../fish/guestfish-actions.pod:3871
13984 "This command disables the libguestfs appliance swap partition with the given "
13989 #: ../src/guestfs-actions.pod:5831
13990 msgid "guestfs_swapon_device"
13994 #: ../src/guestfs-actions.pod:5833
13998 " guestfs_swapon_device (guestfs_h *g,\n"
13999 " const char *device);\n"
14004 #: ../src/guestfs-actions.pod:5837
14006 "This command enables the libguestfs appliance to use the swap device or "
14007 "partition named C<device>. The increased memory is made available for all "
14008 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
14012 #: ../src/guestfs-actions.pod:5842 ../fish/guestfish-actions.pod:3883
14014 "Note that you should not swap to existing guest swap partitions unless you "
14015 "know what you are doing. They may contain hibernation information, or other "
14016 "information that the guest doesn't want you to trash. You also risk leaking "
14017 "information about the host to the guest this way. Instead, attach a new "
14018 "host device to the guest and swap on that."
14022 #: ../src/guestfs-actions.pod:5853
14023 msgid "guestfs_swapon_file"
14027 #: ../src/guestfs-actions.pod:5855
14031 " guestfs_swapon_file (guestfs_h *g,\n"
14032 " const char *file);\n"
14037 #: ../src/guestfs-actions.pod:5859
14039 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
14044 #: ../src/guestfs-actions.pod:5866
14045 msgid "guestfs_swapon_label"
14049 #: ../src/guestfs-actions.pod:5868
14053 " guestfs_swapon_label (guestfs_h *g,\n"
14054 " const char *label);\n"
14059 #: ../src/guestfs-actions.pod:5872
14061 "This command enables swap to a labeled swap partition. See "
14062 "C<guestfs_swapon_device> for other notes."
14066 #: ../src/guestfs-actions.pod:5879
14067 msgid "guestfs_swapon_uuid"
14071 #: ../src/guestfs-actions.pod:5881
14075 " guestfs_swapon_uuid (guestfs_h *g,\n"
14076 " const char *uuid);\n"
14081 #: ../src/guestfs-actions.pod:5885
14083 "This command enables swap to a swap partition with the given UUID. See "
14084 "C<guestfs_swapon_device> for other notes."
14088 #: ../src/guestfs-actions.pod:5892
14089 msgid "guestfs_sync"
14093 #: ../src/guestfs-actions.pod:5894
14097 " guestfs_sync (guestfs_h *g);\n"
14102 #: ../src/guestfs-actions.pod:5897 ../fish/guestfish-actions.pod:3915
14104 "This syncs the disk, so that any writes are flushed through to the "
14105 "underlying disk image."
14109 #: ../src/guestfs-actions.pod:5900 ../fish/guestfish-actions.pod:3918
14111 "You should always call this if you have modified a disk image, before "
14112 "closing the handle."
14116 #: ../src/guestfs-actions.pod:5907
14117 msgid "guestfs_tail"
14121 #: ../src/guestfs-actions.pod:5909
14125 " guestfs_tail (guestfs_h *g,\n"
14126 " const char *path);\n"
14131 #: ../src/guestfs-actions.pod:5913 ../fish/guestfish-actions.pod:3925
14133 "This command returns up to the last 10 lines of a file as a list of strings."
14137 #: ../src/guestfs-actions.pod:5925
14138 msgid "guestfs_tail_n"
14142 #: ../src/guestfs-actions.pod:5927
14146 " guestfs_tail_n (guestfs_h *g,\n"
14148 " const char *path);\n"
14153 #: ../src/guestfs-actions.pod:5932 ../fish/guestfish-actions.pod:3935
14155 "If the parameter C<nrlines> is a positive number, this returns the last "
14156 "C<nrlines> lines of the file C<path>."
14160 #: ../src/guestfs-actions.pod:5935 ../fish/guestfish-actions.pod:3938
14162 "If the parameter C<nrlines> is a negative number, this returns lines from "
14163 "the file C<path>, starting with the C<-nrlines>th line."
14167 #: ../src/guestfs-actions.pod:5949
14168 msgid "guestfs_tar_in"
14172 #: ../src/guestfs-actions.pod:5951
14176 " guestfs_tar_in (guestfs_h *g,\n"
14177 " const char *tarfile,\n"
14178 " const char *directory);\n"
14183 #: ../src/guestfs-actions.pod:5956 ../fish/guestfish-actions.pod:3950
14185 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14186 "tar file) into C<directory>."
14190 #: ../src/guestfs-actions.pod:5959
14192 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
14196 #: ../src/guestfs-actions.pod:5964 ../src/guestfs-actions.pod:5981
14197 #: ../src/guestfs-actions.pod:5997 ../src/guestfs-actions.pod:6013
14198 msgid "(Added in 1.0.3)"
14202 #: ../src/guestfs-actions.pod:5966
14203 msgid "guestfs_tar_out"
14207 #: ../src/guestfs-actions.pod:5968
14211 " guestfs_tar_out (guestfs_h *g,\n"
14212 " const char *directory,\n"
14213 " const char *tarfile);\n"
14218 #: ../src/guestfs-actions.pod:5973 ../fish/guestfish-actions.pod:3962
14220 "This command packs the contents of C<directory> and downloads it to local "
14225 #: ../src/guestfs-actions.pod:5976
14227 "To download a compressed tarball, use C<guestfs_tgz_out> or "
14228 "C<guestfs_txz_out>."
14232 #: ../src/guestfs-actions.pod:5983
14233 msgid "guestfs_tgz_in"
14237 #: ../src/guestfs-actions.pod:5985
14241 " guestfs_tgz_in (guestfs_h *g,\n"
14242 " const char *tarball,\n"
14243 " const char *directory);\n"
14248 #: ../src/guestfs-actions.pod:5990 ../fish/guestfish-actions.pod:3974
14250 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14251 "tar file) into C<directory>."
14255 #: ../src/guestfs-actions.pod:5993
14256 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
14260 #: ../src/guestfs-actions.pod:5999
14261 msgid "guestfs_tgz_out"
14265 #: ../src/guestfs-actions.pod:6001
14269 " guestfs_tgz_out (guestfs_h *g,\n"
14270 " const char *directory,\n"
14271 " const char *tarball);\n"
14276 #: ../src/guestfs-actions.pod:6006 ../fish/guestfish-actions.pod:3985
14278 "This command packs the contents of C<directory> and downloads it to local "
14283 #: ../src/guestfs-actions.pod:6009
14284 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
14288 #: ../src/guestfs-actions.pod:6015
14289 msgid "guestfs_touch"
14293 #: ../src/guestfs-actions.pod:6017
14297 " guestfs_touch (guestfs_h *g,\n"
14298 " const char *path);\n"
14303 #: ../src/guestfs-actions.pod:6021 ../fish/guestfish-actions.pod:3996
14305 "Touch acts like the L<touch(1)> command. It can be used to update the "
14306 "timestamps on a file, or, if the file does not exist, to create a new zero-"
14311 #: ../src/guestfs-actions.pod:6025 ../fish/guestfish-actions.pod:4000
14313 "This command only works on regular files, and will fail on other file types "
14314 "such as directories, symbolic links, block special etc."
14318 #: ../src/guestfs-actions.pod:6032
14319 msgid "guestfs_truncate"
14323 #: ../src/guestfs-actions.pod:6034
14327 " guestfs_truncate (guestfs_h *g,\n"
14328 " const char *path);\n"
14333 #: ../src/guestfs-actions.pod:6038 ../fish/guestfish-actions.pod:4007
14335 "This command truncates C<path> to a zero-length file. The file must exist "
14340 #: ../src/guestfs-actions.pod:6045
14341 msgid "guestfs_truncate_size"
14345 #: ../src/guestfs-actions.pod:6047
14349 " guestfs_truncate_size (guestfs_h *g,\n"
14350 " const char *path,\n"
14351 " int64_t size);\n"
14356 #: ../src/guestfs-actions.pod:6052 ../fish/guestfish-actions.pod:4014
14358 "This command truncates C<path> to size C<size> bytes. The file must exist "
14363 #: ../src/guestfs-actions.pod:6055
14365 "If the current file size is less than C<size> then the file is extended to "
14366 "the required size with zero bytes. This creates a sparse file (ie. disk "
14367 "blocks are not allocated for the file until you write to it). To create a "
14368 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
14372 #: ../src/guestfs-actions.pod:6065
14373 msgid "guestfs_tune2fs_l"
14377 #: ../src/guestfs-actions.pod:6067
14381 " guestfs_tune2fs_l (guestfs_h *g,\n"
14382 " const char *device);\n"
14387 #: ../src/guestfs-actions.pod:6071 ../fish/guestfish-actions.pod:4027
14389 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14394 #: ../src/guestfs-actions.pod:6074 ../fish/guestfish-actions.pod:4030
14396 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
14397 "for more details. The list of fields returned isn't clearly defined, and "
14398 "depends on both the version of C<tune2fs> that libguestfs was built against, "
14399 "and the filesystem itself."
14403 #: ../src/guestfs-actions.pod:6087
14404 msgid "guestfs_txz_in"
14408 #: ../src/guestfs-actions.pod:6089
14412 " guestfs_txz_in (guestfs_h *g,\n"
14413 " const char *tarball,\n"
14414 " const char *directory);\n"
14419 #: ../src/guestfs-actions.pod:6094 ../fish/guestfish-actions.pod:4039
14421 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
14422 "tar file) into C<directory>."
14426 #: ../src/guestfs-actions.pod:6101
14427 msgid "guestfs_txz_out"
14431 #: ../src/guestfs-actions.pod:6103
14435 " guestfs_txz_out (guestfs_h *g,\n"
14436 " const char *directory,\n"
14437 " const char *tarball);\n"
14442 #: ../src/guestfs-actions.pod:6108 ../fish/guestfish-actions.pod:4048
14444 "This command packs the contents of C<directory> and downloads it to local "
14445 "file C<tarball> (as an xz compressed tar archive)."
14449 #: ../src/guestfs-actions.pod:6115
14450 msgid "guestfs_umask"
14454 #: ../src/guestfs-actions.pod:6117
14458 " guestfs_umask (guestfs_h *g,\n"
14464 #: ../src/guestfs-actions.pod:6121 ../fish/guestfish-actions.pod:4057
14466 "This function sets the mask used for creating new files and device nodes to "
14471 #: ../src/guestfs-actions.pod:6124 ../fish/guestfish-actions.pod:4060
14473 "Typical umask values would be C<022> which creates new files with "
14474 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
14475 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
14479 #: ../src/guestfs-actions.pod:6129 ../fish/guestfish-actions.pod:4065
14481 "The default umask is C<022>. This is important because it means that "
14482 "directories and device nodes will be created with C<0644> or C<0755> mode "
14483 "even if you specify C<0777>."
14487 #: ../src/guestfs-actions.pod:6133
14489 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
14490 "C<guestfs_mkdir>."
14494 #: ../src/guestfs-actions.pod:6136 ../fish/guestfish-actions.pod:4072
14495 msgid "This call returns the previous umask."
14499 #: ../src/guestfs-actions.pod:6142
14500 msgid "guestfs_umount"
14504 #: ../src/guestfs-actions.pod:6144
14508 " guestfs_umount (guestfs_h *g,\n"
14509 " const char *pathordevice);\n"
14514 #: ../src/guestfs-actions.pod:6148 ../fish/guestfish-actions.pod:4080
14516 "This unmounts the given filesystem. The filesystem may be specified either "
14517 "by its mountpoint (path) or the device which contains the filesystem."
14521 #: ../src/guestfs-actions.pod:6156
14522 msgid "guestfs_umount_all"
14526 #: ../src/guestfs-actions.pod:6158
14530 " guestfs_umount_all (guestfs_h *g);\n"
14535 #: ../src/guestfs-actions.pod:6161 ../fish/guestfish-actions.pod:4090
14536 msgid "This unmounts all mounted filesystems."
14540 #: ../src/guestfs-actions.pod:6163 ../fish/guestfish-actions.pod:4092
14541 msgid "Some internal mounts are not unmounted by this call."
14545 #: ../src/guestfs-actions.pod:6169
14546 msgid "guestfs_upload"
14550 #: ../src/guestfs-actions.pod:6171
14554 " guestfs_upload (guestfs_h *g,\n"
14555 " const char *filename,\n"
14556 " const char *remotefilename);\n"
14561 #: ../src/guestfs-actions.pod:6176 ../src/guestfs-actions.pod:6195
14562 #: ../fish/guestfish-actions.pod:4098 ../fish/guestfish-actions.pod:4111
14563 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14567 #: ../src/guestfs-actions.pod:6181
14568 msgid "See also C<guestfs_download>."
14572 #: ../src/guestfs-actions.pod:6187
14573 msgid "guestfs_upload_offset"
14577 #: ../src/guestfs-actions.pod:6189
14581 " guestfs_upload_offset (guestfs_h *g,\n"
14582 " const char *filename,\n"
14583 " const char *remotefilename,\n"
14584 " int64_t offset);\n"
14589 #: ../src/guestfs-actions.pod:6198 ../fish/guestfish-actions.pod:4114
14591 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14592 "The intention is to overwrite parts of existing files or devices, although "
14593 "if a non-existant file is specified then it is created with a \"hole\" "
14594 "before C<offset>. The size of the data written is implicit in the size of "
14595 "the source C<filename>."
14599 #: ../src/guestfs-actions.pod:6205
14601 "Note that there is no limit on the amount of data that can be uploaded with "
14602 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
14603 "full amount unless an error occurs."
14607 #: ../src/guestfs-actions.pod:6210
14608 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
14612 #: ../src/guestfs-actions.pod:6216
14613 msgid "guestfs_utimens"
14617 #: ../src/guestfs-actions.pod:6218
14621 " guestfs_utimens (guestfs_h *g,\n"
14622 " const char *path,\n"
14623 " int64_t atsecs,\n"
14624 " int64_t atnsecs,\n"
14625 " int64_t mtsecs,\n"
14626 " int64_t mtnsecs);\n"
14631 #: ../src/guestfs-actions.pod:6226 ../fish/guestfish-actions.pod:4134
14632 msgid "This command sets the timestamps of a file with nanosecond precision."
14636 #: ../src/guestfs-actions.pod:6229 ../fish/guestfish-actions.pod:4137
14638 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14643 #: ../src/guestfs-actions.pod:6232 ../fish/guestfish-actions.pod:4140
14645 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14646 "nanoseconds from the epoch."
14650 #: ../src/guestfs-actions.pod:6235 ../fish/guestfish-actions.pod:4143
14652 "If the C<*nsecs> field contains the special value C<-1> then the "
14653 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14654 "ignored in this case)."
14658 #: ../src/guestfs-actions.pod:6239 ../fish/guestfish-actions.pod:4147
14660 "If the C<*nsecs> field contains the special value C<-2> then the "
14661 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14666 #: ../src/guestfs-actions.pod:6247 ../src/guestfs-structs.pod:175
14667 msgid "guestfs_version"
14671 #: ../src/guestfs-actions.pod:6249
14674 " struct guestfs_version *\n"
14675 " guestfs_version (guestfs_h *g);\n"
14680 #: ../src/guestfs-actions.pod:6252 ../fish/guestfish-actions.pod:4155
14682 "Return the libguestfs version number that the program is linked against."
14686 #: ../src/guestfs-actions.pod:6255 ../fish/guestfish-actions.pod:4158
14688 "Note that because of dynamic linking this is not necessarily the version of "
14689 "libguestfs that you compiled against. You can compile the program, and then "
14690 "at runtime dynamically link against a completely different C<libguestfs.so> "
14695 #: ../src/guestfs-actions.pod:6260 ../fish/guestfish-actions.pod:4163
14697 "This call was added in version C<1.0.58>. In previous versions of "
14698 "libguestfs there was no way to get the version number. From C code you can "
14699 "use dynamic linker functions to find out if this symbol exists (if it "
14700 "doesn't, then it's an earlier version)."
14704 #: ../src/guestfs-actions.pod:6266 ../fish/guestfish-actions.pod:4169
14706 "The call returns a structure with four elements. The first three (C<major>, "
14707 "C<minor> and C<release>) are numbers and correspond to the usual version "
14708 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14709 "but may be used for distro-specific information."
14713 #: ../src/guestfs-actions.pod:6272 ../fish/guestfish-actions.pod:4175
14715 "To construct the original version string: C<$major.$minor.$release$extra>"
14719 #: ../src/guestfs-actions.pod:6275 ../fish/guestfish-actions.pod:4178
14720 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14724 #: ../src/guestfs-actions.pod:6277
14726 "I<Note:> Don't use this call to test for availability of features. In "
14727 "enterprise distributions we backport features from later versions into "
14728 "earlier versions, making this an unreliable way to test for features. Use "
14729 "C<guestfs_available> instead."
14733 #: ../src/guestfs-actions.pod:6283
14735 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
14736 "error. I<The caller must call C<guestfs_free_version> after use>."
14740 #: ../src/guestfs-actions.pod:6287
14741 msgid "(Added in 1.0.58)"
14745 #: ../src/guestfs-actions.pod:6289
14746 msgid "guestfs_vfs_label"
14750 #: ../src/guestfs-actions.pod:6291
14754 " guestfs_vfs_label (guestfs_h *g,\n"
14755 " const char *device);\n"
14760 #: ../src/guestfs-actions.pod:6295 ../fish/guestfish-actions.pod:4190
14761 msgid "This returns the filesystem label of the filesystem on C<device>."
14765 #: ../src/guestfs-actions.pod:6298 ../fish/guestfish-actions.pod:4193
14766 msgid "If the filesystem is unlabeled, this returns the empty string."
14770 #: ../src/guestfs-actions.pod:6300
14771 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
14775 #: ../src/guestfs-actions.pod:6305 ../src/guestfs-actions.pod:6342
14776 msgid "(Added in 1.3.18)"
14780 #: ../src/guestfs-actions.pod:6307
14781 msgid "guestfs_vfs_type"
14785 #: ../src/guestfs-actions.pod:6309
14789 " guestfs_vfs_type (guestfs_h *g,\n"
14790 " const char *device);\n"
14795 #: ../src/guestfs-actions.pod:6313 ../fish/guestfish-actions.pod:4201
14797 "This command gets the filesystem type corresponding to the filesystem on "
14802 #: ../src/guestfs-actions.pod:6316 ../fish/guestfish-actions.pod:4204
14804 "For most filesystems, the result is the name of the Linux VFS module which "
14805 "would be used to mount this filesystem if you mounted it without specifying "
14806 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14810 #: ../src/guestfs-actions.pod:6326
14811 msgid "guestfs_vfs_uuid"
14815 #: ../src/guestfs-actions.pod:6328
14819 " guestfs_vfs_uuid (guestfs_h *g,\n"
14820 " const char *device);\n"
14825 #: ../src/guestfs-actions.pod:6332 ../fish/guestfish-actions.pod:4213
14826 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14830 #: ../src/guestfs-actions.pod:6335 ../fish/guestfish-actions.pod:4216
14831 msgid "If the filesystem does not have a UUID, this returns the empty string."
14835 #: ../src/guestfs-actions.pod:6337
14836 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
14840 #: ../src/guestfs-actions.pod:6344
14841 msgid "guestfs_vg_activate"
14845 #: ../src/guestfs-actions.pod:6346
14849 " guestfs_vg_activate (guestfs_h *g,\n"
14851 " char *const *volgroups);\n"
14856 #: ../src/guestfs-actions.pod:6351 ../fish/guestfish-actions.pod:4224
14858 "This command activates or (if C<activate> is false) deactivates all logical "
14859 "volumes in the listed volume groups C<volgroups>. If activated, then they "
14860 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
14861 "deactivated, then those devices disappear."
14865 #: ../src/guestfs-actions.pod:6357 ../fish/guestfish-actions.pod:4230
14866 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14870 #: ../src/guestfs-actions.pod:6359 ../fish/guestfish-actions.pod:4232
14872 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14873 "activated or deactivated."
14877 #: ../src/guestfs-actions.pod:6366
14878 msgid "guestfs_vg_activate_all"
14882 #: ../src/guestfs-actions.pod:6368
14886 " guestfs_vg_activate_all (guestfs_h *g,\n"
14887 " int activate);\n"
14892 #: ../src/guestfs-actions.pod:6372 ../fish/guestfish-actions.pod:4239
14894 "This command activates or (if C<activate> is false) deactivates all logical "
14895 "volumes in all volume groups. If activated, then they are made known to the "
14896 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
14897 "those devices disappear."
14901 #: ../src/guestfs-actions.pod:6378 ../fish/guestfish-actions.pod:4245
14902 msgid "This command is the same as running C<vgchange -a y|n>"
14906 #: ../src/guestfs-actions.pod:6384
14907 msgid "guestfs_vgcreate"
14911 #: ../src/guestfs-actions.pod:6386
14915 " guestfs_vgcreate (guestfs_h *g,\n"
14916 " const char *volgroup,\n"
14917 " char *const *physvols);\n"
14922 #: ../src/guestfs-actions.pod:6391 ../fish/guestfish-actions.pod:4251
14924 "This creates an LVM volume group called C<volgroup> from the non-empty list "
14925 "of physical volumes C<physvols>."
14929 #: ../src/guestfs-actions.pod:6398
14930 msgid "guestfs_vglvuuids"
14934 #: ../src/guestfs-actions.pod:6400
14938 " guestfs_vglvuuids (guestfs_h *g,\n"
14939 " const char *vgname);\n"
14944 #: ../src/guestfs-actions.pod:6404 ../fish/guestfish-actions.pod:4258
14946 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
14947 "volumes created in this volume group."
14951 #: ../src/guestfs-actions.pod:6407
14953 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
14954 "associate logical volumes and volume groups."
14958 #: ../src/guestfs-actions.pod:6410
14959 msgid "See also C<guestfs_vgpvuuids>."
14963 #: ../src/guestfs-actions.pod:6418
14964 msgid "guestfs_vgpvuuids"
14968 #: ../src/guestfs-actions.pod:6420
14972 " guestfs_vgpvuuids (guestfs_h *g,\n"
14973 " const char *vgname);\n"
14978 #: ../src/guestfs-actions.pod:6424 ../fish/guestfish-actions.pod:4270
14980 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
14981 "volumes that this volume group resides on."
14985 #: ../src/guestfs-actions.pod:6427
14987 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
14988 "associate physical volumes and volume groups."
14992 #: ../src/guestfs-actions.pod:6430
14993 msgid "See also C<guestfs_vglvuuids>."
14997 #: ../src/guestfs-actions.pod:6438
14998 msgid "guestfs_vgremove"
15002 #: ../src/guestfs-actions.pod:6440
15006 " guestfs_vgremove (guestfs_h *g,\n"
15007 " const char *vgname);\n"
15012 #: ../src/guestfs-actions.pod:6444 ../fish/guestfish-actions.pod:4282
15013 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
15017 #: ../src/guestfs-actions.pod:6446 ../fish/guestfish-actions.pod:4284
15019 "This also forcibly removes all logical volumes in the volume group (if any)."
15023 #: ../src/guestfs-actions.pod:6453
15024 msgid "guestfs_vgrename"
15028 #: ../src/guestfs-actions.pod:6455
15032 " guestfs_vgrename (guestfs_h *g,\n"
15033 " const char *volgroup,\n"
15034 " const char *newvolgroup);\n"
15039 #: ../src/guestfs-actions.pod:6460 ../fish/guestfish-actions.pod:4291
15040 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
15044 #: ../src/guestfs-actions.pod:6466
15045 msgid "guestfs_vgs"
15049 #: ../src/guestfs-actions.pod:6468
15053 " guestfs_vgs (guestfs_h *g);\n"
15058 #: ../src/guestfs-actions.pod:6471 ../fish/guestfish-actions.pod:4297
15060 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15065 #: ../src/guestfs-actions.pod:6474 ../fish/guestfish-actions.pod:4300
15067 "This returns a list of just the volume group names that were detected (eg. "
15072 #: ../src/guestfs-actions.pod:6477
15073 msgid "See also C<guestfs_vgs_full>."
15077 #: ../src/guestfs-actions.pod:6485
15078 msgid "guestfs_vgs_full"
15082 #: ../src/guestfs-actions.pod:6487
15085 " struct guestfs_lvm_vg_list *\n"
15086 " guestfs_vgs_full (guestfs_h *g);\n"
15091 #: ../src/guestfs-actions.pod:6490 ../fish/guestfish-actions.pod:4309
15093 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15094 "> command. The \"full\" version includes all fields."
15098 #: ../src/guestfs-actions.pod:6493
15100 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
15101 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
15105 #: ../src/guestfs-actions.pod:6499
15106 msgid "guestfs_vgscan"
15110 #: ../src/guestfs-actions.pod:6501
15114 " guestfs_vgscan (guestfs_h *g);\n"
15119 #: ../src/guestfs-actions.pod:6504 ../fish/guestfish-actions.pod:4316
15121 "This rescans all block devices and rebuilds the list of LVM physical "
15122 "volumes, volume groups and logical volumes."
15126 #: ../src/guestfs-actions.pod:6511
15127 msgid "guestfs_vguuid"
15131 #: ../src/guestfs-actions.pod:6513
15135 " guestfs_vguuid (guestfs_h *g,\n"
15136 " const char *vgname);\n"
15141 #: ../src/guestfs-actions.pod:6517 ../fish/guestfish-actions.pod:4323
15142 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15146 #: ../src/guestfs-actions.pod:6524
15147 msgid "guestfs_wait_ready"
15151 #: ../src/guestfs-actions.pod:6526
15155 " guestfs_wait_ready (guestfs_h *g);\n"
15160 #: ../src/guestfs-actions.pod:6529
15161 msgid "This function is a no op."
15165 #: ../src/guestfs-actions.pod:6531
15167 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
15168 "calling C<guestfs_launch> to wait for the launch to complete. However this "
15169 "is no longer necessary because C<guestfs_launch> now does the waiting."
15173 #: ../src/guestfs-actions.pod:6536
15175 "If you see any calls to this function in code then you can just remove them, "
15176 "unless you want to retain compatibility with older versions of the API."
15180 #: ../src/guestfs-actions.pod:6544
15181 msgid "guestfs_wc_c"
15185 #: ../src/guestfs-actions.pod:6546
15189 " guestfs_wc_c (guestfs_h *g,\n"
15190 " const char *path);\n"
15195 #: ../src/guestfs-actions.pod:6550 ../fish/guestfish-actions.pod:4329
15197 "This command counts the characters in a file, using the C<wc -c> external "
15202 #: ../src/guestfs-actions.pod:6557
15203 msgid "guestfs_wc_l"
15207 #: ../src/guestfs-actions.pod:6559
15211 " guestfs_wc_l (guestfs_h *g,\n"
15212 " const char *path);\n"
15217 #: ../src/guestfs-actions.pod:6563 ../fish/guestfish-actions.pod:4336
15219 "This command counts the lines in a file, using the C<wc -l> external command."
15223 #: ../src/guestfs-actions.pod:6570
15224 msgid "guestfs_wc_w"
15228 #: ../src/guestfs-actions.pod:6572
15232 " guestfs_wc_w (guestfs_h *g,\n"
15233 " const char *path);\n"
15238 #: ../src/guestfs-actions.pod:6576 ../fish/guestfish-actions.pod:4343
15240 "This command counts the words in a file, using the C<wc -w> external command."
15244 #: ../src/guestfs-actions.pod:6583
15245 msgid "guestfs_write"
15249 #: ../src/guestfs-actions.pod:6585
15253 " guestfs_write (guestfs_h *g,\n"
15254 " const char *path,\n"
15255 " const char *content,\n"
15256 " size_t content_size);\n"
15261 #: ../src/guestfs-actions.pod:6591 ../fish/guestfish-actions.pod:4350
15263 "This call creates a file called C<path>. The content of the file is the "
15264 "string C<content> (which can contain any 8 bit data)."
15268 #: ../src/guestfs-actions.pod:6601
15269 msgid "guestfs_write_file"
15273 #: ../src/guestfs-actions.pod:6603
15277 " guestfs_write_file (guestfs_h *g,\n"
15278 " const char *path,\n"
15279 " const char *content,\n"
15285 #: ../src/guestfs-actions.pod:6609 ../fish/guestfish-actions.pod:4360
15287 "This call creates a file called C<path>. The contents of the file is the "
15288 "string C<content> (which can contain any 8 bit data), with length C<size>."
15292 #: ../src/guestfs-actions.pod:6613 ../fish/guestfish-actions.pod:4364
15294 "As a special case, if C<size> is C<0> then the length is calculated using "
15295 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15299 #: ../src/guestfs-actions.pod:6617 ../fish/guestfish-actions.pod:4368
15301 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15302 "I<not> work, even if the length is specified."
15306 #: ../src/guestfs-actions.pod:6625 ../fish/guestfish-actions.pod:4374
15308 "This function is deprecated. In new code, use the C<write> call instead."
15312 #: ../src/guestfs-actions.pod:6634
15313 msgid "guestfs_zegrep"
15317 #: ../src/guestfs-actions.pod:6636
15321 " guestfs_zegrep (guestfs_h *g,\n"
15322 " const char *regex,\n"
15323 " const char *path);\n"
15328 #: ../src/guestfs-actions.pod:6641 ../fish/guestfish-actions.pod:4385
15330 "This calls the external C<zegrep> program and returns the matching lines."
15334 #: ../src/guestfs-actions.pod:6653
15335 msgid "guestfs_zegrepi"
15339 #: ../src/guestfs-actions.pod:6655
15343 " guestfs_zegrepi (guestfs_h *g,\n"
15344 " const char *regex,\n"
15345 " const char *path);\n"
15350 #: ../src/guestfs-actions.pod:6660 ../fish/guestfish-actions.pod:4395
15352 "This calls the external C<zegrep -i> program and returns the matching lines."
15356 #: ../src/guestfs-actions.pod:6672
15357 msgid "guestfs_zero"
15361 #: ../src/guestfs-actions.pod:6674
15365 " guestfs_zero (guestfs_h *g,\n"
15366 " const char *device);\n"
15371 #: ../src/guestfs-actions.pod:6678 ../fish/guestfish-actions.pod:4405
15372 msgid "This command writes zeroes over the first few blocks of C<device>."
15376 #: ../src/guestfs-actions.pod:6680 ../fish/guestfish-actions.pod:4407
15378 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15379 "securely wipe the device). It should be sufficient to remove any partition "
15380 "tables, filesystem superblocks and so on."
15384 #: ../src/guestfs-actions.pod:6684
15385 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
15389 #: ../src/guestfs-actions.pod:6695
15390 msgid "guestfs_zero_device"
15394 #: ../src/guestfs-actions.pod:6697
15398 " guestfs_zero_device (guestfs_h *g,\n"
15399 " const char *device);\n"
15404 #: ../src/guestfs-actions.pod:6701
15406 "This command writes zeroes over the entire C<device>. Compare with "
15407 "C<guestfs_zero> which just zeroes the first few blocks of a device."
15411 #: ../src/guestfs-actions.pod:6715
15412 msgid "(Added in 1.3.1)"
15416 #: ../src/guestfs-actions.pod:6717
15417 msgid "guestfs_zerofree"
15421 #: ../src/guestfs-actions.pod:6719
15425 " guestfs_zerofree (guestfs_h *g,\n"
15426 " const char *device);\n"
15431 #: ../src/guestfs-actions.pod:6723 ../fish/guestfish-actions.pod:4428
15433 "This runs the I<zerofree> program on C<device>. This program claims to zero "
15434 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
15435 "possible to compress the filesystem more effectively."
15439 #: ../src/guestfs-actions.pod:6728 ../fish/guestfish-actions.pod:4433
15440 msgid "You should B<not> run this program if the filesystem is mounted."
15444 #: ../src/guestfs-actions.pod:6731 ../fish/guestfish-actions.pod:4436
15446 "It is possible that using this program can damage the filesystem or data on "
15451 #: ../src/guestfs-actions.pod:6738
15452 msgid "guestfs_zfgrep"
15456 #: ../src/guestfs-actions.pod:6740
15460 " guestfs_zfgrep (guestfs_h *g,\n"
15461 " const char *pattern,\n"
15462 " const char *path);\n"
15467 #: ../src/guestfs-actions.pod:6745 ../fish/guestfish-actions.pod:4443
15469 "This calls the external C<zfgrep> program and returns the matching lines."
15473 #: ../src/guestfs-actions.pod:6757
15474 msgid "guestfs_zfgrepi"
15478 #: ../src/guestfs-actions.pod:6759
15482 " guestfs_zfgrepi (guestfs_h *g,\n"
15483 " const char *pattern,\n"
15484 " const char *path);\n"
15489 #: ../src/guestfs-actions.pod:6764 ../fish/guestfish-actions.pod:4453
15491 "This calls the external C<zfgrep -i> program and returns the matching lines."
15495 #: ../src/guestfs-actions.pod:6776
15496 msgid "guestfs_zfile"
15500 #: ../src/guestfs-actions.pod:6778
15504 " guestfs_zfile (guestfs_h *g,\n"
15505 " const char *meth,\n"
15506 " const char *path);\n"
15511 #: ../src/guestfs-actions.pod:6783 ../fish/guestfish-actions.pod:4463
15513 "This command runs C<file> after first decompressing C<path> using C<method>."
15517 #: ../src/guestfs-actions.pod:6786 ../fish/guestfish-actions.pod:4466
15518 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
15522 #: ../src/guestfs-actions.pod:6788
15524 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
15529 #: ../src/guestfs-actions.pod:6794 ../fish/guestfish-actions.pod:4471
15531 "This function is deprecated. In new code, use the C<file> call instead."
15535 #: ../src/guestfs-actions.pod:6803
15536 msgid "guestfs_zgrep"
15540 #: ../src/guestfs-actions.pod:6805
15544 " guestfs_zgrep (guestfs_h *g,\n"
15545 " const char *regex,\n"
15546 " const char *path);\n"
15551 #: ../src/guestfs-actions.pod:6810 ../fish/guestfish-actions.pod:4482
15553 "This calls the external C<zgrep> program and returns the matching lines."
15557 #: ../src/guestfs-actions.pod:6822
15558 msgid "guestfs_zgrepi"
15562 #: ../src/guestfs-actions.pod:6824
15566 " guestfs_zgrepi (guestfs_h *g,\n"
15567 " const char *regex,\n"
15568 " const char *path);\n"
15573 #: ../src/guestfs-actions.pod:6829 ../fish/guestfish-actions.pod:4492
15575 "This calls the external C<zgrep -i> program and returns the matching lines."
15579 #: ../src/guestfs-availability.pod:3
15584 #: ../src/guestfs-availability.pod:5
15586 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
15587 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
15588 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
15589 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
15590 "L</guestfs_aug_save> L</guestfs_aug_set>"
15594 #: ../src/guestfs-availability.pod:21
15599 #: ../src/guestfs-availability.pod:23
15601 "The following functions: L</guestfs_inotify_add_watch> L</"
15602 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
15603 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
15607 #: ../src/guestfs-availability.pod:31
15608 msgid "B<linuxfsuuid>"
15612 #: ../src/guestfs-availability.pod:33
15614 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
15615 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
15619 #: ../src/guestfs-availability.pod:40
15620 msgid "B<linuxmodules>"
15624 #: ../src/guestfs-availability.pod:42
15625 msgid "The following functions: L</guestfs_modprobe>"
15629 #: ../src/guestfs-availability.pod:45
15630 msgid "B<linuxxattrs>"
15634 #: ../src/guestfs-availability.pod:47
15636 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> L</"
15637 "guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</"
15638 "guestfs_removexattr> L</guestfs_setxattr>"
15642 #: ../src/guestfs-availability.pod:56
15647 #: ../src/guestfs-availability.pod:58
15649 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
15650 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
15651 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
15655 #: ../src/guestfs-availability.pod:67
15660 #: ../src/guestfs-availability.pod:69
15662 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
15663 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
15664 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
15665 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
15666 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
15667 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
15668 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
15672 #: ../src/guestfs-availability.pod:92
15677 #: ../src/guestfs-availability.pod:94
15679 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
15680 "guestfs_mknod_b> L</guestfs_mknod_c>"
15684 #: ../src/guestfs-availability.pod:100
15689 #: ../src/guestfs-availability.pod:102
15690 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
15694 #: ../src/guestfs-availability.pod:105
15695 msgid "B<ntfsprogs>"
15699 #: ../src/guestfs-availability.pod:107
15701 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
15705 #: ../src/guestfs-availability.pod:111
15706 msgid "B<realpath>"
15710 #: ../src/guestfs-availability.pod:113
15711 msgid "The following functions: L</guestfs_realpath>"
15715 #: ../src/guestfs-availability.pod:116
15720 #: ../src/guestfs-availability.pod:118
15722 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
15723 "guestfs_scrub_freespace>"
15727 #: ../src/guestfs-availability.pod:123
15732 #: ../src/guestfs-availability.pod:125
15733 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
15737 #: ../src/guestfs-availability.pod:129
15742 #: ../src/guestfs-availability.pod:131
15743 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
15747 #: ../src/guestfs-availability.pod:135
15748 msgid "B<zerofree>"
15752 #: ../src/guestfs-availability.pod:137
15753 msgid "The following functions: L</guestfs_zerofree>"
15757 #: ../src/guestfs-structs.pod:1
15758 msgid "guestfs_int_bool"
15762 #: ../src/guestfs-structs.pod:3
15765 " struct guestfs_int_bool {\n"
15773 #: ../src/guestfs-structs.pod:8
15776 " struct guestfs_int_bool_list {\n"
15777 " uint32_t len; /* Number of elements in list. */\n"
15778 " struct guestfs_int_bool *val; /* Elements. */\n"
15784 #: ../src/guestfs-structs.pod:13
15787 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
15788 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
15793 #: ../src/guestfs-structs.pod:16
15794 msgid "guestfs_lvm_pv"
15798 #: ../src/guestfs-structs.pod:18
15801 " struct guestfs_lvm_pv {\n"
15802 " char *pv_name;\n"
15803 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
15804 " char pv_uuid[32];\n"
15806 " uint64_t pv_size;\n"
15807 " uint64_t dev_size;\n"
15808 " uint64_t pv_free;\n"
15809 " uint64_t pv_used;\n"
15810 " char *pv_attr;\n"
15811 " int64_t pv_pe_count;\n"
15812 " int64_t pv_pe_alloc_count;\n"
15813 " char *pv_tags;\n"
15814 " uint64_t pe_start;\n"
15815 " int64_t pv_mda_count;\n"
15816 " uint64_t pv_mda_free;\n"
15822 #: ../src/guestfs-structs.pod:36
15825 " struct guestfs_lvm_pv_list {\n"
15826 " uint32_t len; /* Number of elements in list. */\n"
15827 " struct guestfs_lvm_pv *val; /* Elements. */\n"
15833 #: ../src/guestfs-structs.pod:41
15836 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
15837 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
15842 #: ../src/guestfs-structs.pod:44
15843 msgid "guestfs_lvm_vg"
15847 #: ../src/guestfs-structs.pod:46
15850 " struct guestfs_lvm_vg {\n"
15851 " char *vg_name;\n"
15852 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
15853 " char vg_uuid[32];\n"
15855 " char *vg_attr;\n"
15856 " uint64_t vg_size;\n"
15857 " uint64_t vg_free;\n"
15858 " char *vg_sysid;\n"
15859 " uint64_t vg_extent_size;\n"
15860 " int64_t vg_extent_count;\n"
15861 " int64_t vg_free_count;\n"
15862 " int64_t max_lv;\n"
15863 " int64_t max_pv;\n"
15864 " int64_t pv_count;\n"
15865 " int64_t lv_count;\n"
15866 " int64_t snap_count;\n"
15867 " int64_t vg_seqno;\n"
15868 " char *vg_tags;\n"
15869 " int64_t vg_mda_count;\n"
15870 " uint64_t vg_mda_free;\n"
15876 #: ../src/guestfs-structs.pod:69
15879 " struct guestfs_lvm_vg_list {\n"
15880 " uint32_t len; /* Number of elements in list. */\n"
15881 " struct guestfs_lvm_vg *val; /* Elements. */\n"
15887 #: ../src/guestfs-structs.pod:74
15890 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
15891 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
15896 #: ../src/guestfs-structs.pod:77
15897 msgid "guestfs_lvm_lv"
15901 #: ../src/guestfs-structs.pod:79
15904 " struct guestfs_lvm_lv {\n"
15905 " char *lv_name;\n"
15906 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
15907 " char lv_uuid[32];\n"
15908 " char *lv_attr;\n"
15909 " int64_t lv_major;\n"
15910 " int64_t lv_minor;\n"
15911 " int64_t lv_kernel_major;\n"
15912 " int64_t lv_kernel_minor;\n"
15913 " uint64_t lv_size;\n"
15914 " int64_t seg_count;\n"
15916 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
15917 " float snap_percent;\n"
15918 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
15919 " float copy_percent;\n"
15920 " char *move_pv;\n"
15921 " char *lv_tags;\n"
15922 " char *mirror_log;\n"
15923 " char *modules;\n"
15929 #: ../src/guestfs-structs.pod:101
15932 " struct guestfs_lvm_lv_list {\n"
15933 " uint32_t len; /* Number of elements in list. */\n"
15934 " struct guestfs_lvm_lv *val; /* Elements. */\n"
15940 #: ../src/guestfs-structs.pod:106
15943 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
15944 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
15949 #: ../src/guestfs-structs.pod:111
15952 " struct guestfs_stat {\n"
15956 " int64_t nlink;\n"
15961 " int64_t blksize;\n"
15962 " int64_t blocks;\n"
15963 " int64_t atime;\n"
15964 " int64_t mtime;\n"
15965 " int64_t ctime;\n"
15971 #: ../src/guestfs-structs.pod:127
15974 " struct guestfs_stat_list {\n"
15975 " uint32_t len; /* Number of elements in list. */\n"
15976 " struct guestfs_stat *val; /* Elements. */\n"
15982 #: ../src/guestfs-structs.pod:132
15985 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
15986 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
15991 #: ../src/guestfs-structs.pod:137
15994 " struct guestfs_statvfs {\n"
15995 " int64_t bsize;\n"
15996 " int64_t frsize;\n"
15997 " int64_t blocks;\n"
15998 " int64_t bfree;\n"
15999 " int64_t bavail;\n"
16000 " int64_t files;\n"
16001 " int64_t ffree;\n"
16002 " int64_t favail;\n"
16005 " int64_t namemax;\n"
16011 #: ../src/guestfs-structs.pod:151
16014 " struct guestfs_statvfs_list {\n"
16015 " uint32_t len; /* Number of elements in list. */\n"
16016 " struct guestfs_statvfs *val; /* Elements. */\n"
16022 #: ../src/guestfs-structs.pod:156
16025 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
16026 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
16031 #: ../src/guestfs-structs.pod:159
16032 msgid "guestfs_dirent"
16036 #: ../src/guestfs-structs.pod:161
16039 " struct guestfs_dirent {\n"
16048 #: ../src/guestfs-structs.pod:167
16051 " struct guestfs_dirent_list {\n"
16052 " uint32_t len; /* Number of elements in list. */\n"
16053 " struct guestfs_dirent *val; /* Elements. */\n"
16059 #: ../src/guestfs-structs.pod:172
16062 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
16063 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
16068 #: ../src/guestfs-structs.pod:177
16071 " struct guestfs_version {\n"
16072 " int64_t major;\n"
16073 " int64_t minor;\n"
16074 " int64_t release;\n"
16081 #: ../src/guestfs-structs.pod:184
16084 " struct guestfs_version_list {\n"
16085 " uint32_t len; /* Number of elements in list. */\n"
16086 " struct guestfs_version *val; /* Elements. */\n"
16092 #: ../src/guestfs-structs.pod:189
16095 " void guestfs_free_version (struct guestfs_free_version *);\n"
16096 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
16101 #: ../src/guestfs-structs.pod:192
16102 msgid "guestfs_xattr"
16106 #: ../src/guestfs-structs.pod:194
16109 " struct guestfs_xattr {\n"
16110 " char *attrname;\n"
16111 " /* The next two fields describe a byte array. */\n"
16112 " uint32_t attrval_len;\n"
16113 " char *attrval;\n"
16119 #: ../src/guestfs-structs.pod:201
16122 " struct guestfs_xattr_list {\n"
16123 " uint32_t len; /* Number of elements in list. */\n"
16124 " struct guestfs_xattr *val; /* Elements. */\n"
16130 #: ../src/guestfs-structs.pod:206
16133 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
16134 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
16139 #: ../src/guestfs-structs.pod:209
16140 msgid "guestfs_inotify_event"
16144 #: ../src/guestfs-structs.pod:211
16147 " struct guestfs_inotify_event {\n"
16148 " int64_t in_wd;\n"
16149 " uint32_t in_mask;\n"
16150 " uint32_t in_cookie;\n"
16151 " char *in_name;\n"
16157 #: ../src/guestfs-structs.pod:218
16160 " struct guestfs_inotify_event_list {\n"
16161 " uint32_t len; /* Number of elements in list. */\n"
16162 " struct guestfs_inotify_event *val; /* Elements. */\n"
16168 #: ../src/guestfs-structs.pod:223
16171 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
16172 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
16177 #: ../src/guestfs-structs.pod:226
16178 msgid "guestfs_partition"
16182 #: ../src/guestfs-structs.pod:228
16185 " struct guestfs_partition {\n"
16186 " int32_t part_num;\n"
16187 " uint64_t part_start;\n"
16188 " uint64_t part_end;\n"
16189 " uint64_t part_size;\n"
16195 #: ../src/guestfs-structs.pod:235
16198 " struct guestfs_partition_list {\n"
16199 " uint32_t len; /* Number of elements in list. */\n"
16200 " struct guestfs_partition *val; /* Elements. */\n"
16206 #: ../src/guestfs-structs.pod:240
16209 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
16210 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
16215 #: ../fish/guestfish.pod:5
16216 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
16220 #: ../fish/guestfish.pod:9
16223 " guestfish [--options] [commands]\n"
16228 #: ../fish/guestfish.pod:11
16236 #: ../fish/guestfish.pod:13
16239 " guestfish [--ro|--rw] -a disk.img\n"
16244 #: ../fish/guestfish.pod:15
16247 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
16252 #: ../fish/guestfish.pod:17
16255 " guestfish -d libvirt-domain\n"
16260 #: ../fish/guestfish.pod:19
16263 " guestfish [--ro|--rw] -a disk.img -i\n"
16268 #: ../fish/guestfish.pod:21
16271 " guestfish -d libvirt-domain -i\n"
16276 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
16277 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
16278 #: ../tools/virt-rescue.pl:41
16283 #: ../fish/guestfish.pod:25
16285 "Using guestfish in read/write mode on live virtual machines can be "
16286 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16287 "option to use guestfish safely if the disk image or virtual machine might be "
16292 #: ../fish/guestfish.pod:32
16294 "Guestfish is a shell and command-line tool for examining and modifying "
16295 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16296 "functionality of the guestfs API, see L<guestfs(3)>."
16300 #: ../fish/guestfish.pod:36
16302 "Guestfish gives you structured access to the libguestfs API, from shell "
16303 "scripts or the command line or interactively. If you want to rescue a "
16304 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16309 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:846
16310 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58
16311 #: ../tools/virt-resize.pl:66 ../tools/virt-tar.pl:45
16316 #: ../fish/guestfish.pod:43
16317 msgid "As an interactive shell"
16321 #: ../fish/guestfish.pod:45
16329 #: ../fish/guestfish.pod:47
16332 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
16333 " editing virtual machine filesystems.\n"
16338 #: ../fish/guestfish.pod:50
16341 " Type: 'help' for a list of commands\n"
16342 " 'man' to read the manual\n"
16343 " 'quit' to quit the shell\n"
16348 #: ../fish/guestfish.pod:54
16351 " ><fs> add-ro disk.img\n"
16353 " ><fs> list-filesystems\n"
16354 " /dev/sda1: ext4\n"
16355 " /dev/vg_guest/lv_root: ext4\n"
16356 " /dev/vg_guest/lv_swap: swap\n"
16357 " ><fs> mount /dev/vg_guest/lv_root /\n"
16358 " ><fs> cat /etc/fstab\n"
16360 " # Created by anaconda\n"
16367 #: ../fish/guestfish.pod:67
16368 msgid "From shell scripts"
16372 #: ../fish/guestfish.pod:69
16373 msgid "Create a new C</etc/motd> file in a guest or disk image:"
16377 #: ../fish/guestfish.pod:71
16380 " guestfish <<_EOF_\n"
16383 " mount /dev/vg_guest/lv_root /\n"
16384 " write /etc/motd \"Welcome, new users\"\n"
16390 #: ../fish/guestfish.pod:78
16391 msgid "List the LVM logical volumes in a disk image:"
16395 #: ../fish/guestfish.pod:80
16398 " guestfish -a disk.img --ro <<_EOF_\n"
16406 #: ../fish/guestfish.pod:85
16407 msgid "List all the filesystems in a disk image:"
16411 #: ../fish/guestfish.pod:87
16414 " guestfish -a disk.img --ro <<_EOF_\n"
16416 " list-filesystems\n"
16422 #: ../fish/guestfish.pod:92
16423 msgid "On one command line"
16427 #: ../fish/guestfish.pod:94
16428 msgid "Update C</etc/resolv.conf> in a guest:"
16432 #: ../fish/guestfish.pod:96
16436 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
16437 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
16442 #: ../fish/guestfish.pod:100
16443 msgid "Edit C</boot/grub/grub.conf> interactively:"
16447 #: ../fish/guestfish.pod:102
16450 " guestfish --rw --add disk.img \\\n"
16451 " --mount /dev/vg_guest/lv_root \\\n"
16452 " --mount /dev/sda1:/boot \\\n"
16453 " edit /boot/grub/grub.conf\n"
16458 #: ../fish/guestfish.pod:107
16459 msgid "Mount disks automatically"
16463 #: ../fish/guestfish.pod:109
16465 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
16469 #: ../fish/guestfish.pod:112
16472 " guestfish --ro -a disk.img -i cat /etc/group\n"
16477 #: ../fish/guestfish.pod:114
16480 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
16485 #: ../fish/guestfish.pod:116
16486 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
16490 #: ../fish/guestfish.pod:118
16493 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
16498 #: ../fish/guestfish.pod:120
16499 msgid "As a script interpreter"
16503 #: ../fish/guestfish.pod:122
16504 msgid "Create a 100MB disk containing an ext2-formatted partition:"
16508 #: ../fish/guestfish.pod:124
16511 " #!/usr/bin/guestfish -f\n"
16512 " sparse test1.img 100M\n"
16514 " part-disk /dev/sda mbr\n"
16515 " mkfs ext2 /dev/sda1\n"
16520 #: ../fish/guestfish.pod:130
16521 msgid "Start with a prepared disk"
16525 #: ../fish/guestfish.pod:132
16527 "An alternate way to create a 100MB disk called C<test1.img> containing a "
16528 "single ext2-formatted partition:"
16532 #: ../fish/guestfish.pod:135
16535 " guestfish -N fs\n"
16540 #: ../fish/guestfish.pod:137
16541 msgid "To list what is available do:"
16545 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:837
16548 " guestfish -N help | less\n"
16553 #: ../fish/guestfish.pod:141
16554 msgid "Remote control"
16558 #: ../fish/guestfish.pod:143
16561 " eval \"`guestfish --listen`\"\n"
16562 " guestfish --remote add-ro disk.img\n"
16563 " guestfish --remote run\n"
16564 " guestfish --remote lvs\n"
16569 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
16570 #: ../fuse/guestmount.pod:73 ../inspector/virt-inspector.pl:68
16571 #: ../tools/virt-edit.pl:72 ../tools/virt-win-reg.pl:171
16572 #: ../tools/virt-df.pl:71 ../tools/virt-ls.pl:78 ../tools/virt-resize.pl:257
16573 #: ../tools/virt-list-filesystems.pl:50 ../tools/virt-tar.pl:98
16574 #: ../tools/virt-rescue.pl:103 ../tools/virt-make-fs.pl:153
16575 #: ../tools/virt-list-partitions.pl:51
16580 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
16581 #: ../inspector/virt-inspector.pl:76 ../tools/virt-edit.pl:80
16582 #: ../tools/virt-win-reg.pl:179 ../tools/virt-df.pl:79 ../tools/virt-ls.pl:86
16583 #: ../tools/virt-resize.pl:265 ../tools/virt-list-filesystems.pl:58
16584 #: ../tools/virt-tar.pl:106 ../tools/virt-rescue.pl:111
16585 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:59
16590 #: ../fish/guestfish.pod:154
16591 msgid "Displays general help on options."
16595 #: ../fish/guestfish.pod:156
16596 msgid "B<-h> | B<--cmd-help>"
16600 #: ../fish/guestfish.pod:158
16601 msgid "Lists all available guestfish commands."
16605 #: ../fish/guestfish.pod:160
16606 msgid "B<-h cmd> | B<--cmd-help cmd>"
16610 #: ../fish/guestfish.pod:162
16611 msgid "Displays detailed help on a single command C<cmd>."
16615 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
16616 msgid "B<-a image> | B<--add image>"
16620 #: ../fish/guestfish.pod:166
16621 msgid "Add a block device or virtual machine image to the shell."
16625 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
16627 "The format of the disk image is auto-detected. To override this and force a "
16628 "particular format use the I<--format=..> option."
16632 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
16633 msgid "B<-c URI> | B<--connect URI>"
16637 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
16639 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16640 "URI to use. The default is to use the default libvirt connection."
16644 #: ../fish/guestfish.pod:177
16649 #: ../fish/guestfish.pod:179
16651 "If using the I<--listen> option and a csh-like shell, use this option. See "
16652 "section L</REMOTE CONTROL AND CSH> below."
16656 #: ../fish/guestfish.pod:182 ../fuse/guestmount.pod:90
16657 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
16661 #: ../fish/guestfish.pod:184 ../fuse/guestmount.pod:92
16663 "Add disks from the named libvirt domain. If the I<--ro> option is also "
16664 "used, then any libvirt domain can be used. However in write mode, only "
16665 "libvirt domains which are shut down can be named here."
16669 #: ../fish/guestfish.pod:188
16670 msgid "B<-D> | B<--no-dest-paths>"
16674 #: ../fish/guestfish.pod:190
16676 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
16677 "to hit the tab key to complete paths on the guest filesystem, but this "
16678 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
16679 "allow this feature to be disabled."
16683 #: ../fish/guestfish.pod:195 ../fuse/guestmount.pod:108
16684 msgid "B<--echo-keys>"
16688 #: ../fish/guestfish.pod:197 ../fuse/guestmount.pod:110
16690 "When prompting for keys and passphrases, guestfish normally turns echoing "
16691 "off so you cannot see what you are typing. If you are not worried about "
16692 "Tempest attacks and there is no one else in the room you can specify this "
16693 "flag to see what you are typing."
16697 #: ../fish/guestfish.pod:202
16698 msgid "B<-f file> | B<--file file>"
16702 #: ../fish/guestfish.pod:204
16703 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
16707 #: ../fish/guestfish.pod:207
16710 " #!/usr/bin/guestfish -f\n"
16715 #: ../fish/guestfish.pod:209 ../fuse/guestmount.pod:115
16716 msgid "B<--format=raw|qcow2|..> | B<--format>"
16720 #: ../fish/guestfish.pod:211 ../fuse/guestmount.pod:117
16722 "The default for the I<-a> option is to auto-detect the format of the disk "
16723 "image. Using this forces the disk format for I<-a> options which follow on "
16724 "the command line. Using I<--format> with no argument switches back to auto-"
16725 "detection for subsequent I<-a> options."
16729 #: ../fish/guestfish.pod:216 ../fish/guestfish.pod:543
16730 #: ../inspector/virt-inspector.pl:549
16731 msgid "For example:"
16735 #: ../fish/guestfish.pod:218
16738 " guestfish --format=raw -a disk.img\n"
16743 #: ../fish/guestfish.pod:220
16744 msgid "forces raw format (no auto-detection) for C<disk.img>."
16748 #: ../fish/guestfish.pod:222
16751 " guestfish --format=raw -a disk.img --format -a another.img\n"
16756 #: ../fish/guestfish.pod:224
16758 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
16759 "detection for C<another.img>."
16763 #: ../fish/guestfish.pod:227
16765 "If you have untrusted raw-format guest disk images, you should use this "
16766 "option to specify the disk format. This avoids a possible security problem "
16767 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
16771 #: ../fish/guestfish.pod:232 ../fuse/guestmount.pod:135
16772 msgid "B<-i> | B<--inspector>"
16776 #: ../fish/guestfish.pod:234 ../fuse/guestmount.pod:137
16778 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
16779 "system and mount filesystems as they would be mounted on the real virtual "
16784 #: ../fish/guestfish.pod:238
16785 msgid "Typical usage is either:"
16789 #: ../fish/guestfish.pod:240
16792 " guestfish -d myguest -i\n"
16797 #: ../fish/guestfish.pod:242
16798 msgid "(for an inactive libvirt domain called I<myguest>), or:"
16802 #: ../fish/guestfish.pod:244
16805 " guestfish --ro -d myguest -i\n"
16810 #: ../fish/guestfish.pod:246
16811 msgid "(for active domains, readonly), or specify the block device directly:"
16815 #: ../fish/guestfish.pod:248
16818 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
16823 #: ../fish/guestfish.pod:250
16825 "Note that the command line syntax changed slightly over older versions of "
16826 "guestfish. You can still use the old syntax:"
16830 #: ../fish/guestfish.pod:253
16833 " guestfish [--ro] -i disk.img\n"
16838 #: ../fish/guestfish.pod:255
16841 " guestfish [--ro] -i libvirt-domain\n"
16846 #: ../fish/guestfish.pod:257 ../fuse/guestmount.pod:141
16847 msgid "B<--keys-from-stdin>"
16851 #: ../fish/guestfish.pod:259 ../fuse/guestmount.pod:143
16853 "Read key or passphrase parameters from stdin. The default is to try to read "
16854 "passphrases from the user by opening C</dev/tty>."
16858 #: ../fish/guestfish.pod:262
16859 msgid "B<--listen>"
16863 #: ../fish/guestfish.pod:264
16865 "Fork into the background and listen for remote commands. See section L</"
16866 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
16870 #: ../fish/guestfish.pod:267
16871 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
16875 #: ../fish/guestfish.pod:269
16876 msgid "Mount the named partition or logical volume on the given mountpoint."
16880 #: ../fish/guestfish.pod:271
16881 msgid "If the mountpoint is omitted, it defaults to C</>."
16885 #: ../fish/guestfish.pod:273
16886 msgid "You have to mount something on C</> before most commands will work."
16890 #: ../fish/guestfish.pod:275
16892 "If any I<-m> or I<--mount> options are given, the guest is automatically "
16897 #: ../fish/guestfish.pod:278
16899 "If you don't know what filesystems a disk image contains, you can either run "
16900 "guestfish without this option, then list the partitions and LVs available "
16901 "(see L</list-partitions> and L</lvs> commands), or you can use the L<virt-"
16902 "list-filesystems(1)> program."
16906 #: ../fish/guestfish.pod:283 ../fuse/guestmount.pod:154
16907 msgid "B<-n> | B<--no-sync>"
16911 #: ../fish/guestfish.pod:285
16913 "Disable autosync. This is enabled by default. See the discussion of "
16914 "autosync in the L<guestfs(3)> manpage."
16918 #: ../fish/guestfish.pod:288
16919 msgid "B<-N type> | B<--new type> | B<-N help>"
16923 #: ../fish/guestfish.pod:290
16925 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
16926 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
16927 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
16932 #: ../fish/guestfish.pod:295
16933 msgid "B<--progress-bars>"
16937 #: ../fish/guestfish.pod:297
16938 msgid "Enable progress bars, even when guestfish is used non-interactively."
16942 #: ../fish/guestfish.pod:299
16944 "Progress bars are enabled by default when guestfish is used as an "
16945 "interactive shell."
16949 #: ../fish/guestfish.pod:302
16950 msgid "B<--no-progress-bars>"
16954 #: ../fish/guestfish.pod:304
16955 msgid "Disable progress bars."
16959 #: ../fish/guestfish.pod:306
16960 msgid "B<--remote[=pid]>"
16964 #: ../fish/guestfish.pod:308
16966 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
16967 "CONTROL GUESTFISH OVER A SOCKET> below."
16971 #: ../fish/guestfish.pod:311 ../fuse/guestmount.pod:196
16972 msgid "B<-r> | B<--ro>"
16976 #: ../fish/guestfish.pod:313
16978 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
16979 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
16983 #: ../fish/guestfish.pod:316 ../tools/virt-rescue.pl:187
16985 "The option must always be used if the disk image or virtual machine might be "
16986 "running, and is generally recommended in cases where you don't need write "
16987 "access to the disk."
16991 #: ../fish/guestfish.pod:320
16993 "Note that prepared disk images created with I<-N> are not affected by the "
16998 #: ../fish/guestfish.pod:323
16999 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
17003 #: ../fish/guestfish.pod:325 ../fuse/guestmount.pod:208
17004 #: ../tools/virt-rescue.pl:195
17005 msgid "B<--selinux>"
17009 #: ../fish/guestfish.pod:327
17010 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
17014 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:212
17015 msgid "B<-v> | B<--verbose>"
17019 #: ../fish/guestfish.pod:331
17021 "Enable very verbose messages. This is particularly useful if you find a bug."
17025 #: ../fish/guestfish.pod:334 ../fuse/guestmount.pod:216
17026 msgid "B<-V> | B<--version>"
17030 #: ../fish/guestfish.pod:336
17031 msgid "Display the guestfish / libguestfs version number and exit."
17035 #: ../fish/guestfish.pod:338 ../fuse/guestmount.pod:220
17036 msgid "B<-w> | B<--rw>"
17040 #: ../fish/guestfish.pod:340
17042 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
17047 #: ../fish/guestfish.pod:343
17052 #: ../fish/guestfish.pod:345
17053 msgid "Echo each command before executing it."
17057 #: ../fish/guestfish.pod:349
17058 msgid "COMMANDS ON COMMAND LINE"
17062 #: ../fish/guestfish.pod:351
17064 "Any additional (non-option) arguments are treated as commands to execute."
17068 #: ../fish/guestfish.pod:354
17070 "Commands to execute should be separated by a colon (C<:>), where the colon "
17071 "is a separate parameter. Thus:"
17075 #: ../fish/guestfish.pod:357
17078 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
17083 #: ../fish/guestfish.pod:359
17085 "If there are no additional arguments, then we enter a shell, either an "
17086 "interactive shell with a prompt (if the input is a terminal) or a non-"
17087 "interactive shell."
17091 #: ../fish/guestfish.pod:363
17093 "In either command line mode or non-interactive shell, the first command that "
17094 "gives an error causes the whole shell to exit. In interactive mode (with a "
17095 "prompt) if a command fails, you can continue to enter commands."
17099 #: ../fish/guestfish.pod:368
17100 msgid "USING launch (OR run)"
17104 #: ../fish/guestfish.pod:370
17106 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
17107 "then launch it, then mount any disks you need, and finally issue actions/"
17108 "commands. So the general order of the day is:"
17112 #: ../fish/guestfish.pod:378
17113 msgid "add or -a/--add"
17117 #: ../fish/guestfish.pod:382
17118 msgid "launch (aka run)"
17122 #: ../fish/guestfish.pod:386
17123 msgid "mount or -m/--mount"
17127 #: ../fish/guestfish.pod:390
17128 msgid "any other commands"
17132 #: ../fish/guestfish.pod:394
17134 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
17135 "guest before mounting or performing any other commands."
17139 #: ../fish/guestfish.pod:397
17141 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
17142 "I<--new> options were given then C<run> is done automatically, simply "
17143 "because guestfish can't perform the action you asked for without doing this."
17147 #: ../fish/guestfish.pod:402
17148 msgid "OPENING DISKS FOR READ AND WRITE"
17152 #: ../fish/guestfish.pod:404
17154 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
17155 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
17156 "open disk images read-only or for writing."
17160 #: ../fish/guestfish.pod:408
17162 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
17163 "disk images supplied on the command line for write. To open a disk image "
17164 "read-only you have to do I<-a image --ro>."
17168 #: ../fish/guestfish.pod:412
17170 "This matters: If you accidentally open a live VM disk image writable then "
17171 "you will cause irreversible disk corruption."
17175 #: ../fish/guestfish.pod:415
17177 "By libguestfs 1.8 we intend to change the default the other way. Disk "
17178 "images will be opened read-only. You will have to either specify "
17179 "I<guestfish --rw> or change a configuration file in order to get write "
17180 "access for disk images specified by those other command line options."
17184 #: ../fish/guestfish.pod:420
17186 "This version of guestfish has a I<--rw> option which does nothing (it is "
17187 "already the default). However it is highly recommended that you use this "
17188 "option to indicate that guestfish needs write access, and to prepare your "
17189 "scripts for the day when this option will be required for write access."
17193 #: ../fish/guestfish.pod:426
17195 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
17196 "other libguestfs program apart from guestfish and guestmount."
17200 #: ../fish/guestfish.pod:429
17205 #: ../fish/guestfish.pod:431
17207 "You can quote ordinary parameters using either single or double quotes. For "
17212 #: ../fish/guestfish.pod:434
17215 " add \"file with a space.img\"\n"
17220 #: ../fish/guestfish.pod:436
17223 " rm '/file name'\n"
17228 #: ../fish/guestfish.pod:438
17236 #: ../fish/guestfish.pod:440
17238 "A few commands require a list of strings to be passed. For these, use a "
17239 "whitespace-separated list, enclosed in quotes. Strings containing "
17240 "whitespace to be passed through must be enclosed in single quotes. A "
17241 "literal single quote must be escaped with a backslash."
17245 #: ../fish/guestfish.pod:445
17248 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17249 " command \"/bin/echo 'foo bar'\"\n"
17250 " command \"/bin/echo \\'foo\\'\"\n"
17255 #: ../fish/guestfish.pod:449
17256 msgid "OPTIONAL ARGUMENTS"
17260 #: ../fish/guestfish.pod:451
17262 "Some commands take optional arguments. These arguments appear in this "
17263 "documentation as C<[argname:..]>. You can use them as in these examples:"
17267 #: ../fish/guestfish.pod:455
17270 " add-drive-opts filename\n"
17275 #: ../fish/guestfish.pod:457
17278 " add-drive-opts filename readonly:true\n"
17283 #: ../fish/guestfish.pod:459
17286 " add-drive-opts filename format:qcow2 readonly:false\n"
17291 #: ../fish/guestfish.pod:461
17293 "Each optional argument can appear at most once. All optional arguments must "
17294 "appear after the required ones."
17298 #: ../fish/guestfish.pod:464
17303 #: ../fish/guestfish.pod:466
17305 "This section applies to all commands which can take integers as parameters."
17309 #: ../fish/guestfish.pod:469
17310 msgid "SIZE SUFFIX"
17314 #: ../fish/guestfish.pod:471
17316 "When the command takes a parameter measured in bytes, you can use one of the "
17317 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17321 #: ../fish/guestfish.pod:477
17322 msgid "B<k> or B<K> or B<KiB>"
17326 #: ../fish/guestfish.pod:479
17327 msgid "The size in kilobytes (multiplied by 1024)."
17331 #: ../fish/guestfish.pod:481
17336 #: ../fish/guestfish.pod:483
17337 msgid "The size in SI 1000 byte units."
17341 #: ../fish/guestfish.pod:485
17342 msgid "B<M> or B<MiB>"
17346 #: ../fish/guestfish.pod:487
17347 msgid "The size in megabytes (multiplied by 1048576)."
17351 #: ../fish/guestfish.pod:489
17356 #: ../fish/guestfish.pod:491
17357 msgid "The size in SI 1000000 byte units."
17361 #: ../fish/guestfish.pod:493
17362 msgid "B<G> or B<GiB>"
17366 #: ../fish/guestfish.pod:495
17367 msgid "The size in gigabytes (multiplied by 2**30)."
17371 #: ../fish/guestfish.pod:497
17376 #: ../fish/guestfish.pod:499
17377 msgid "The size in SI 10**9 byte units."
17381 #: ../fish/guestfish.pod:501
17382 msgid "B<T> or B<TiB>"
17386 #: ../fish/guestfish.pod:503
17387 msgid "The size in terabytes (multiplied by 2**40)."
17391 #: ../fish/guestfish.pod:505
17396 #: ../fish/guestfish.pod:507
17397 msgid "The size in SI 10**12 byte units."
17401 #: ../fish/guestfish.pod:509
17402 msgid "B<P> or B<PiB>"
17406 #: ../fish/guestfish.pod:511
17407 msgid "The size in petabytes (multiplied by 2**50)."
17411 #: ../fish/guestfish.pod:513
17416 #: ../fish/guestfish.pod:515
17417 msgid "The size in SI 10**15 byte units."
17421 #: ../fish/guestfish.pod:517
17422 msgid "B<E> or B<EiB>"
17426 #: ../fish/guestfish.pod:519
17427 msgid "The size in exabytes (multiplied by 2**60)."
17431 #: ../fish/guestfish.pod:521
17436 #: ../fish/guestfish.pod:523
17437 msgid "The size in SI 10**18 byte units."
17441 #: ../fish/guestfish.pod:525
17442 msgid "B<Z> or B<ZiB>"
17446 #: ../fish/guestfish.pod:527
17447 msgid "The size in zettabytes (multiplied by 2**70)."
17451 #: ../fish/guestfish.pod:529
17456 #: ../fish/guestfish.pod:531
17457 msgid "The size in SI 10**21 byte units."
17461 #: ../fish/guestfish.pod:533
17462 msgid "B<Y> or B<YiB>"
17466 #: ../fish/guestfish.pod:535
17467 msgid "The size in yottabytes (multiplied by 2**80)."
17471 #: ../fish/guestfish.pod:537
17476 #: ../fish/guestfish.pod:539
17477 msgid "The size in SI 10**24 byte units."
17481 #: ../fish/guestfish.pod:545
17484 " truncate-size /file 1G\n"
17489 #: ../fish/guestfish.pod:547
17490 msgid "would truncate the file to 1 gigabyte."
17494 #: ../fish/guestfish.pod:549
17496 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
17497 "the parameter to L</memsize> is specified in megabytes already). Adding a "
17498 "suffix will probably not do what you expect."
17502 #: ../fish/guestfish.pod:553
17503 msgid "OCTAL AND HEXADECIMAL NUMBERS"
17507 #: ../fish/guestfish.pod:555
17509 "For specifying the radix (base) use the C convention: C<0> to prefix an "
17510 "octal number or C<0x> to prefix a hexadecimal number. For example:"
17514 #: ../fish/guestfish.pod:558
17517 " 1234 decimal number 1234\n"
17518 " 02322 octal number, equivalent to decimal 1234\n"
17519 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
17524 #: ../fish/guestfish.pod:562
17526 "When using the C<chmod> command, you almost always want to specify an octal "
17527 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
17528 "L<chmod(1)> program):"
17532 #: ../fish/guestfish.pod:566
17535 " chmod 0777 /public # OK\n"
17536 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
17541 #: ../fish/guestfish.pod:569
17543 "Commands that return numbers usually print them in decimal, but some "
17544 "commands print numbers in other radices (eg. C<umask> prints the mode in "
17545 "octal, preceeded by C<0>)."
17549 #: ../fish/guestfish.pod:573
17550 msgid "WILDCARDS AND GLOBBING"
17554 #: ../fish/guestfish.pod:575
17556 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
17557 "(globbing) by default. So for example the following will not do what you "
17562 #: ../fish/guestfish.pod:579
17570 #: ../fish/guestfish.pod:581
17572 "Assuming you don't have a directory called literally C</home/*> then the "
17573 "above command will return an error."
17577 #: ../fish/guestfish.pod:584
17578 msgid "To perform wildcard expansion, use the C<glob> command."
17582 #: ../fish/guestfish.pod:586
17585 " glob rm-rf /home/*\n"
17590 #: ../fish/guestfish.pod:588
17592 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
17593 "many times), equivalent to:"
17597 #: ../fish/guestfish.pod:591
17600 " rm-rf /home/jim\n"
17601 " rm-rf /home/joe\n"
17602 " rm-rf /home/mary\n"
17607 #: ../fish/guestfish.pod:595
17608 msgid "C<glob> only works on simple guest paths and not on device names."
17612 #: ../fish/guestfish.pod:597
17614 "If you have several parameters, each containing a wildcard, then glob will "
17615 "perform a Cartesian product."
17619 #: ../fish/guestfish.pod:600
17624 #: ../fish/guestfish.pod:602
17626 "Any line which starts with a I<#> character is treated as a comment and "
17627 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
17628 "a command. For example:"
17632 #: ../fish/guestfish.pod:606
17635 " # this is a comment\n"
17636 " # this is a comment\n"
17637 " foo # NOT a comment\n"
17642 #: ../fish/guestfish.pod:610
17643 msgid "Blank lines are also ignored."
17647 #: ../fish/guestfish.pod:612
17648 msgid "RUNNING COMMANDS LOCALLY"
17652 #: ../fish/guestfish.pod:614
17654 "Any line which starts with a I<!> character is treated as a command sent to "
17655 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
17659 #: ../fish/guestfish.pod:618
17663 " tgz-out /remote local/remote-data.tar.gz\n"
17668 #: ../fish/guestfish.pod:621
17670 "will create a directory C<local> on the host, and then export the contents "
17671 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17672 "(See C<tgz-out>)."
17676 #: ../fish/guestfish.pod:625
17678 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17679 "effect, due to the way that subprocesses work in Unix."
17683 #: ../fish/guestfish.pod:628
17688 #: ../fish/guestfish.pod:630
17690 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17691 "command (a guestfish command) to the second command (any host command). For "
17696 #: ../fish/guestfish.pod:634
17699 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17704 #: ../fish/guestfish.pod:636
17706 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17707 "program). The above command would list all accounts in the guest filesystem "
17708 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17712 #: ../fish/guestfish.pod:641
17715 " hexdump /bin/ls | head\n"
17716 " list-devices | tail -1\n"
17717 " tgz-out / - | tar ztf -\n"
17722 #: ../fish/guestfish.pod:645
17724 "The space before the pipe symbol is required, any space after the pipe "
17725 "symbol is optional. Everything after the pipe symbol is just passed "
17726 "straight to the host shell, so it can contain redirections, globs and "
17727 "anything else that makes sense on the host side."
17731 #: ../fish/guestfish.pod:650
17733 "To use a literal argument which begins with a pipe symbol, you have to quote "
17738 #: ../fish/guestfish.pod:653
17746 #: ../fish/guestfish.pod:655
17747 msgid "HOME DIRECTORIES"
17751 #: ../fish/guestfish.pod:657
17753 "If a parameter starts with the character C<~> then the tilde may be expanded "
17754 "as a home directory path (either C<~> for the current user's home directory, "
17755 "or C<~user> for another user)."
17759 #: ../fish/guestfish.pod:661
17761 "Note that home directory expansion happens for users known I<on the host>, "
17762 "not in the guest filesystem."
17766 #: ../fish/guestfish.pod:664
17768 "To use a literal argument which begins with a tilde, you have to quote it, "
17773 #: ../fish/guestfish.pod:667
17781 #: ../fish/guestfish.pod:671
17783 "Libguestfs has some support for Linux guests encrypted according to the "
17784 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17785 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
17786 "LUKS is supported."
17790 #: ../fish/guestfish.pod:676
17791 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17795 #: ../fish/guestfish.pod:678
17798 " ><fs> vfs-type /dev/sda2\n"
17804 #: ../fish/guestfish.pod:681
17806 "Then open those devices using L</luks-open>. This creates a device-mapper "
17807 "device called C</dev/mapper/luksdev>."
17811 #: ../fish/guestfish.pod:684
17814 " ><fs> luks-open /dev/sda2 luksdev\n"
17815 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17820 #: ../fish/guestfish.pod:687
17822 "Finally you have to tell LVM to scan for volume groups on the newly created "
17827 #: ../fish/guestfish.pod:690
17831 " vg-activate-all true\n"
17836 #: ../fish/guestfish.pod:693
17837 msgid "The logical volume(s) can now be mounted in the usual way."
17841 #: ../fish/guestfish.pod:695
17843 "Before closing a LUKS device you must unmount any logical volumes on it and "
17844 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17845 "one. Then you can close the mapper device:"
17849 #: ../fish/guestfish.pod:699
17852 " vg-activate false /dev/VG\n"
17853 " luks-close /dev/mapper/luksdev\n"
17858 #: ../fish/guestfish.pod:702
17859 msgid "WINDOWS PATHS"
17863 #: ../fish/guestfish.pod:704
17865 "If a path is prefixed with C<win:> then you can use Windows-style paths "
17866 "(with some limitations). The following commands are equivalent:"
17870 #: ../fish/guestfish.pod:707
17873 " file /WINDOWS/system32/config/system.LOG\n"
17878 #: ../fish/guestfish.pod:709
17881 " file win:/windows/system32/config/system.log\n"
17886 #: ../fish/guestfish.pod:711
17889 " file win:\\windows\\system32\\config\\system.log\n"
17894 #: ../fish/guestfish.pod:713
17897 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
17902 #: ../fish/guestfish.pod:715
17904 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
17905 "handles case insensitivity like Windows would. This only works in argument "
17906 "positions that expect a path."
17910 #: ../fish/guestfish.pod:719
17911 msgid "UPLOADING AND DOWNLOADING FILES"
17915 #: ../fish/guestfish.pod:721
17917 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
17918 "others which upload from or download to a local file, you can use the "
17919 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
17923 #: ../fish/guestfish.pod:725
17931 #: ../fish/guestfish.pod:727
17933 "reads stdin and creates from that a file C</foo> in the disk image, and:"
17937 #: ../fish/guestfish.pod:730
17940 " tar-out /etc - | tar tf -\n"
17945 #: ../fish/guestfish.pod:732
17947 "writes the tarball to stdout and then pipes that into the external \"tar\" "
17948 "command (see L</PIPES>)."
17952 #: ../fish/guestfish.pod:735
17954 "When using C<-> to read from stdin, the input is read up to the end of "
17955 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
17956 "some arbitrary end marker:"
17960 #: ../fish/guestfish.pod:739
17963 " upload -<<END /foo\n"
17972 #: ../fish/guestfish.pod:745
17974 "Any string of characters can be used instead of C<END>. The end marker must "
17975 "appear on a line of its own, without any preceeding or following characters "
17976 "(not even spaces)."
17980 #: ../fish/guestfish.pod:749
17982 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
17983 "upload local files (so-called \"FileIn\" parameters in the generator)."
17987 #: ../fish/guestfish.pod:752
17988 msgid "EXIT ON ERROR BEHAVIOUR"
17992 #: ../fish/guestfish.pod:754
17994 "By default, guestfish will ignore any errors when in interactive mode (ie. "
17995 "taking commands from a human over a tty), and will exit on the first error "
17996 "in non-interactive mode (scripts, commands given on the command line)."
18000 #: ../fish/guestfish.pod:759
18002 "If you prefix a command with a I<-> character, then that command will not "
18003 "cause guestfish to exit, even if that (one) command returns an error."
18007 #: ../fish/guestfish.pod:763
18008 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
18012 #: ../fish/guestfish.pod:765
18014 "Guestfish can be remote-controlled over a socket. This is useful "
18015 "particularly in shell scripts where you want to make several different "
18016 "changes to a filesystem, but you don't want the overhead of starting up a "
18017 "guestfish process each time."
18021 #: ../fish/guestfish.pod:770
18022 msgid "Start a guestfish server process using:"
18026 #: ../fish/guestfish.pod:772
18029 " eval \"`guestfish --listen`\"\n"
18034 #: ../fish/guestfish.pod:774
18035 msgid "and then send it commands by doing:"
18039 #: ../fish/guestfish.pod:776
18042 " guestfish --remote cmd [...]\n"
18047 #: ../fish/guestfish.pod:778
18048 msgid "To cause the server to exit, send it the exit command:"
18052 #: ../fish/guestfish.pod:780
18055 " guestfish --remote exit\n"
18060 #: ../fish/guestfish.pod:782
18062 "Note that the server will normally exit if there is an error in a command. "
18063 "You can change this in the usual way. See section L</EXIT ON ERROR "
18068 #: ../fish/guestfish.pod:786
18069 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18073 #: ../fish/guestfish.pod:788
18075 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18076 "is how the I<--remote> option knows where to send the commands. You can "
18077 "have several guestfish listener processes running using:"
18081 #: ../fish/guestfish.pod:792
18084 " eval \"`guestfish --listen`\"\n"
18085 " pid1=$GUESTFISH_PID\n"
18086 " eval \"`guestfish --listen`\"\n"
18087 " pid2=$GUESTFISH_PID\n"
18089 " guestfish --remote=$pid1 cmd\n"
18090 " guestfish --remote=$pid2 cmd\n"
18095 #: ../fish/guestfish.pod:800
18096 msgid "REMOTE CONTROL AND CSH"
18100 #: ../fish/guestfish.pod:802
18102 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18107 #: ../fish/guestfish.pod:805
18110 " eval \"`guestfish --listen --csh`\"\n"
18115 #: ../fish/guestfish.pod:807
18116 msgid "REMOTE CONTROL DETAILS"
18120 #: ../fish/guestfish.pod:809
18122 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
18123 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
18124 "and C<$PID> is the process ID of the server."
18128 #: ../fish/guestfish.pod:813
18129 msgid "Guestfish client and server versions must match exactly."
18133 #: ../fish/guestfish.pod:815
18134 msgid "PREPARED DISK IMAGES"
18138 #: ../fish/guestfish.pod:817
18140 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18141 "preformatted disk images that guestfish can make for you to save typing. "
18142 "This is particularly useful for testing purposes. This option is used "
18143 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18144 "can be mixed with I<-a>)."
18148 #: ../fish/guestfish.pod:823
18150 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18151 "the second and so on. Existing files in the current directory are "
18156 #: ../fish/guestfish.pod:827
18158 "The type briefly describes how the disk should be sized, partitioned, how "
18159 "filesystem(s) should be created, and how content should be added. "
18160 "Optionally the type can be followed by extra parameters, separated by C<:> "
18161 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
18162 "allocated disk, containing a single partition, with the partition formatted "
18163 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
18168 #: ../fish/guestfish.pod:835
18169 msgid "To list the available types and any extra parameters they take, run:"
18173 #: ../fish/guestfish.pod:839
18175 "Note that the prepared filesystem is not mounted. You would usually have to "
18176 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18180 #: ../fish/guestfish.pod:843
18182 "If any I<-N> or I<--new> options are given, the guest is automatically "
18187 #: ../fish/guestfish.pod:848
18188 msgid "Create a 100MB disk with an ext4-formatted partition:"
18192 #: ../fish/guestfish.pod:850
18195 " guestfish -N fs:ext4\n"
18200 #: ../fish/guestfish.pod:852
18201 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18205 #: ../fish/guestfish.pod:854
18208 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18213 #: ../fish/guestfish.pod:856
18214 msgid "Create a blank 200MB disk:"
18218 #: ../fish/guestfish.pod:858
18221 " guestfish -N disk:200M\n"
18226 #: ../fish/guestfish.pod:860
18227 msgid "PROGRESS BARS"
18231 #: ../fish/guestfish.pod:862
18233 "Some (not all) long-running commands send progress notification messages as "
18234 "they are running. Guestfish turns these messages into progress bars."
18238 #: ../fish/guestfish.pod:866
18240 "When a command that supports progress bars takes longer than two seconds to "
18241 "run, and if progress bars are enabled, then you will see one appearing below "
18246 #: ../fish/guestfish.pod:870
18249 " ><fs> copy-size /large-file /another-file 2048M\n"
18250 " / 10% [#####-----------------------------------------] 00:30\n"
18255 #: ../fish/guestfish.pod:873
18257 "The spinner on the left hand side moves round once for every progress "
18258 "notification received from the backend. This is a (reasonably) golden "
18259 "assurance that the command is \"doing something\" even if the progress bar "
18260 "is not moving, because the command is able to send the progress "
18261 "notifications. When the bar reaches 100% and the command finishes, the "
18262 "spinner disappears."
18266 #: ../fish/guestfish.pod:880
18268 "Progress bars are enabled by default when guestfish is used interactively. "
18269 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18270 "and you can disable them completely using I<--no-progress-bars>."
18274 #: ../fish/guestfish.pod:885
18275 msgid "GUESTFISH COMMANDS"
18279 #: ../fish/guestfish.pod:887
18281 "The commands in this section are guestfish convenience commands, in other "
18282 "words, they are not part of the L<guestfs(3)> API."
18286 #: ../fish/guestfish.pod:890
18291 #: ../fish/guestfish.pod:892
18300 #: ../fish/guestfish.pod:895
18301 msgid "Without any parameter, this provides general help."
18305 #: ../fish/guestfish.pod:897
18306 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18310 #: ../fish/guestfish.pod:899
18311 msgid "quit | exit"
18315 #: ../fish/guestfish.pod:901
18316 msgid "This exits guestfish. You can also use C<^D> key."
18320 #: ../fish/guestfish.pod:903
18321 msgid "@FISH_COMMANDS@"
18325 #: ../fish/guestfish.pod:905
18330 #: ../fish/guestfish.pod:909 ../test-tool/libguestfs-test-tool.pod:83
18335 #: ../fish/guestfish.pod:911
18337 "guestfish returns 0 if the commands completed without error, or 1 if there "
18342 #: ../fish/guestfish.pod:918
18347 #: ../fish/guestfish.pod:920
18349 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
18354 #: ../fish/guestfish.pod:923
18355 msgid "GUESTFISH_PID"
18359 #: ../fish/guestfish.pod:925
18361 "Used with the I<--remote> option to specify the remote guestfish process to "
18362 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
18366 #: ../fish/guestfish.pod:929
18371 #: ../fish/guestfish.pod:931
18373 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
18374 "not specified, the external L<hexedit(1)> program is used."
18378 #: ../fish/guestfish.pod:935
18383 #: ../fish/guestfish.pod:937
18385 "If compiled with GNU readline support, various files in the home directory "
18386 "can be used. See L</FILES>."
18390 #: ../fish/guestfish.pod:946
18392 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
18393 "effect as using the B<-v> option."
18397 #: ../fish/guestfish.pod:958
18399 "Set the path that guestfish uses to search for kernel and initrd.img. See "
18400 "the discussion of paths in L<guestfs(3)>."
18404 #: ../fish/guestfish.pod:969
18405 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
18409 #: ../fish/guestfish.pod:971
18414 #: ../fish/guestfish.pod:973
18416 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
18421 #: ../fish/guestfish.pod:988 ../test-tool/libguestfs-test-tool.pod:88
18426 #: ../fish/guestfish.pod:992
18427 msgid "$HOME/.guestfish"
18431 #: ../fish/guestfish.pod:994
18433 "If compiled with GNU readline support, then the command history is saved in "
18438 #: ../fish/guestfish.pod:997
18439 msgid "$HOME/.inputrc"
18443 #: ../fish/guestfish.pod:999
18444 msgid "/etc/inputrc"
18448 #: ../fish/guestfish.pod:1001
18450 "If compiled with GNU readline support, then these files can be used to "
18451 "configure readline. For further information, please see L<readline(3)/"
18452 "INITIALIZATION FILE>."
18456 #: ../fish/guestfish.pod:1005
18457 msgid "To write rules which only apply to guestfish, use:"
18461 #: ../fish/guestfish.pod:1007
18471 #: ../fish/guestfish.pod:1011
18473 "Variables that you can set in inputrc that change the behaviour of guestfish "
18474 "in useful ways include:"
18478 #: ../fish/guestfish.pod:1016
18479 msgid "completion-ignore-case (default: on)"
18483 #: ../fish/guestfish.pod:1018
18485 "By default, guestfish will ignore case when tab-completing paths on the "
18490 #: ../fish/guestfish.pod:1021
18493 " set completion-ignore-case off\n"
18498 #: ../fish/guestfish.pod:1023
18499 msgid "to make guestfish case sensitive."
18503 #: ../fish/guestfish.pod:1027
18508 #: ../fish/guestfish.pod:1029
18509 msgid "test2.img (etc)"
18513 #: ../fish/guestfish.pod:1031
18515 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
18516 "will be created in the file C<test1.img> in the current directory. The "
18517 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
18518 "the same name will be overwritten."
18522 #: ../fish/guestfish.pod:1040
18524 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
18525 "L<virt-edit(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, "
18526 "L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, "
18527 "L<virt-tar(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
18531 #: ../fish/guestfish.pod:1064 ../test-tool/libguestfs-test-tool.pod:124
18532 #: ../fuse/guestmount.pod:253 ../inspector/virt-inspector.pl:598
18533 #: ../tools/virt-edit.pl:370 ../tools/virt-win-reg.pl:518
18534 #: ../tools/virt-df.pl:657 ../tools/virt-ls.pl:251
18535 #: ../tools/virt-resize.pl:1516 ../tools/virt-list-filesystems.pl:206
18536 #: ../tools/virt-tar.pl:300 ../tools/virt-rescue.pl:285
18537 #: ../tools/virt-make-fs.pl:567 ../tools/virt-list-partitions.pl:273
18539 "This program is free software; you can redistribute it and/or modify it "
18540 "under the terms of the GNU General Public License as published by the Free "
18541 "Software Foundation; either version 2 of the License, or (at your option) "
18542 "any later version."
18546 #: ../fish/guestfish.pod:1069 ../test-tool/libguestfs-test-tool.pod:129
18547 #: ../fuse/guestmount.pod:258 ../inspector/virt-inspector.pl:603
18548 #: ../tools/virt-edit.pl:375 ../tools/virt-win-reg.pl:523
18549 #: ../tools/virt-df.pl:662 ../tools/virt-ls.pl:256
18550 #: ../tools/virt-resize.pl:1521 ../tools/virt-list-filesystems.pl:211
18551 #: ../tools/virt-tar.pl:305 ../tools/virt-rescue.pl:290
18552 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:278
18554 "This program is distributed in the hope that it will be useful, but WITHOUT "
18555 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
18556 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
18561 #: ../fish/guestfish.pod:1074 ../test-tool/libguestfs-test-tool.pod:134
18562 #: ../fuse/guestmount.pod:263 ../inspector/virt-inspector.pl:608
18563 #: ../tools/virt-edit.pl:380 ../tools/virt-win-reg.pl:528
18564 #: ../tools/virt-df.pl:667 ../tools/virt-ls.pl:261
18565 #: ../tools/virt-resize.pl:1526 ../tools/virt-list-filesystems.pl:216
18566 #: ../tools/virt-tar.pl:310 ../tools/virt-rescue.pl:295
18567 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:283
18569 "You should have received a copy of the GNU General Public License along with "
18570 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
18571 "Ave, Cambridge, MA 02139, USA."
18575 #: ../fish/guestfish-actions.pod:1
18580 #: ../fish/guestfish-actions.pod:3
18583 " add-cdrom filename\n"
18588 #: ../fish/guestfish-actions.pod:15
18590 "This call checks for the existence of C<filename>. This stops you from "
18591 "specifying other types of drive which are supported by qemu such as C<nbd:> "
18592 "and C<http:> URLs. To specify those, use the general L</config> call "
18597 #: ../fish/guestfish-actions.pod:22
18599 "If you just want to add an ISO file (often you use this as an efficient way "
18600 "to transfer large files into the guest), then you should probably use L</add-"
18601 "drive-ro> instead."
18605 #: ../fish/guestfish-actions.pod:35
18610 #: ../fish/guestfish-actions.pod:37
18615 #: ../fish/guestfish-actions.pod:39
18618 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
18623 #: ../fish/guestfish-actions.pod:41
18625 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
18626 "It works by connecting to libvirt, requesting the domain and domain XML from "
18627 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
18631 #: ../fish/guestfish-actions.pod:58
18633 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
18634 "libvirt.org/uri.html>). If this is not set then we connect to the default "
18635 "libvirt URI (or one set through an environment variable, see the libvirt "
18636 "documentation for full details). If you are using the C API directly then "
18637 "it is more flexible to create the libvirt connection object yourself, get "
18638 "the domain object, and call L</add-libvirt-dom>."
18642 #: ../fish/guestfish-actions.pod:66
18644 "The other optional parameters are passed directly through to L</add-drive-"
18649 #: ../fish/guestfish-actions.pod:69 ../fish/guestfish-actions.pod:133
18651 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
18655 #: ../fish/guestfish-actions.pod:71
18660 #: ../fish/guestfish-actions.pod:73
18663 " add-drive filename\n"
18668 #: ../fish/guestfish-actions.pod:75
18670 "This function is the equivalent of calling L</add-drive-opts> with no "
18671 "optional parameters, so the disk is added writable, with the format being "
18672 "detected automatically."
18676 #: ../fish/guestfish-actions.pod:79
18678 "Automatic detection of the format opens you up to a potential security hole "
18679 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
18680 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
18681 "you should think about replacing calls to this function with calls to L</add-"
18682 "drive-opts>, and specifying the format."
18686 #: ../fish/guestfish-actions.pod:86
18687 msgid "add-drive-opts"
18691 #: ../fish/guestfish-actions.pod:88
18696 #: ../fish/guestfish-actions.pod:90
18699 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
18704 #: ../fish/guestfish-actions.pod:117
18706 "This forces the image format. If you omit this (or use L</add-drive> or L</"
18707 "add-drive-ro>) then the format is automatically detected. Possible formats "
18708 "include C<raw> and C<qcow2>."
18712 #: ../fish/guestfish-actions.pod:128
18714 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
18715 "add-drive-with-if> call (q.v.)"
18719 #: ../fish/guestfish-actions.pod:135
18720 msgid "add-drive-ro"
18724 #: ../fish/guestfish-actions.pod:137
18729 #: ../fish/guestfish-actions.pod:139
18732 " add-drive-ro filename\n"
18737 #: ../fish/guestfish-actions.pod:141
18739 "This function is the equivalent of calling L</add-drive-opts> with the "
18740 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
18741 "is added read-only, with the format being detected automatically."
18745 #: ../fish/guestfish-actions.pod:146
18746 msgid "add-drive-ro-with-if"
18750 #: ../fish/guestfish-actions.pod:148
18753 " add-drive-ro-with-if filename iface\n"
18758 #: ../fish/guestfish-actions.pod:150
18760 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
18761 "interface emulation to use at run time."
18765 #: ../fish/guestfish-actions.pod:160
18766 msgid "add-drive-with-if"
18770 #: ../fish/guestfish-actions.pod:162
18773 " add-drive-with-if filename iface\n"
18778 #: ../fish/guestfish-actions.pod:164
18780 "This is the same as L</add-drive> but it allows you to specify the QEMU "
18781 "interface emulation to use at run time."
18785 #: ../fish/guestfish-actions.pod:174
18790 #: ../fish/guestfish-actions.pod:176
18793 " aug-clear augpath\n"
18798 #: ../fish/guestfish-actions.pod:181
18803 #: ../fish/guestfish-actions.pod:183
18811 #: ../fish/guestfish-actions.pod:185
18813 "Close the current Augeas handle and free up any resources used by it. After "
18814 "calling this, you have to call L</aug-init> again before you can use any "
18815 "other Augeas functions."
18819 #: ../fish/guestfish-actions.pod:190
18820 msgid "aug-defnode"
18824 #: ../fish/guestfish-actions.pod:192
18827 " aug-defnode name expr val\n"
18832 #: ../fish/guestfish-actions.pod:197
18834 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
18835 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
18836 "containing that single node."
18840 #: ../fish/guestfish-actions.pod:205
18845 #: ../fish/guestfish-actions.pod:207
18848 " aug-defvar name expr\n"
18853 #: ../fish/guestfish-actions.pod:216
18858 #: ../fish/guestfish-actions.pod:218
18861 " aug-get augpath\n"
18866 #: ../fish/guestfish-actions.pod:223
18871 #: ../fish/guestfish-actions.pod:225
18874 " aug-init root flags\n"
18879 #: ../fish/guestfish-actions.pod:231
18880 msgid "You must call this before using any other L</aug-*> commands."
18884 #: ../fish/guestfish-actions.pod:266
18885 msgid "Do not load the tree in L</aug-init>."
18889 #: ../fish/guestfish-actions.pod:270
18890 msgid "To close the handle, you can call L</aug-close>."
18894 #: ../fish/guestfish-actions.pod:274
18899 #: ../fish/guestfish-actions.pod:276
18902 " aug-insert augpath label true|false\n"
18907 #: ../fish/guestfish-actions.pod:286
18912 #: ../fish/guestfish-actions.pod:288
18920 #: ../fish/guestfish-actions.pod:295
18925 #: ../fish/guestfish-actions.pod:297
18928 " aug-ls augpath\n"
18933 #: ../fish/guestfish-actions.pod:299
18935 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
18936 "resulting nodes into alphabetical order."
18940 #: ../fish/guestfish-actions.pod:302
18945 #: ../fish/guestfish-actions.pod:304
18948 " aug-match augpath\n"
18953 #: ../fish/guestfish-actions.pod:310
18958 #: ../fish/guestfish-actions.pod:312
18961 " aug-mv src dest\n"
18966 #: ../fish/guestfish-actions.pod:317
18971 #: ../fish/guestfish-actions.pod:319
18974 " aug-rm augpath\n"
18979 #: ../fish/guestfish-actions.pod:325
18984 #: ../fish/guestfish-actions.pod:327
18992 #: ../fish/guestfish-actions.pod:331
18994 "The flags which were passed to L</aug-init> affect exactly how files are "
18999 #: ../fish/guestfish-actions.pod:334
19004 #: ../fish/guestfish-actions.pod:336
19007 " aug-set augpath val\n"
19012 #: ../fish/guestfish-actions.pod:340
19014 "In the Augeas API, it is possible to clear a node by setting the value to "
19015 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
19016 "this call. Instead you must use the L</aug-clear> call."
19020 #: ../fish/guestfish-actions.pod:345
19025 #: ../fish/guestfish-actions.pod:347
19028 " available 'groups ...'\n"
19033 #: ../fish/guestfish-actions.pod:353
19035 "The libguestfs groups, and the functions that those groups correspond to, "
19036 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
19037 "runtime by calling L</available-all-groups>."
19041 #: ../fish/guestfish-actions.pod:377
19042 msgid "You must call L</launch> before calling this function."
19046 #: ../fish/guestfish-actions.pod:399
19048 "This call was added in version C<1.0.80>. In previous versions of "
19049 "libguestfs all you could do would be to speculatively execute a command to "
19050 "find out if the daemon implemented it. See also L</version>."
19054 #: ../fish/guestfish-actions.pod:406
19055 msgid "available-all-groups"
19059 #: ../fish/guestfish-actions.pod:408
19062 " available-all-groups\n"
19067 #: ../fish/guestfish-actions.pod:410
19069 "This command returns a list of all optional groups that this daemon knows "
19070 "about. Note this returns both supported and unsupported groups. To find "
19071 "out which ones the daemon can actually support you have to call L</"
19072 "available> on each member of the returned list."
19076 #: ../fish/guestfish-actions.pod:416
19077 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
19081 #: ../fish/guestfish-actions.pod:418
19086 #: ../fish/guestfish-actions.pod:420
19089 " base64-in (base64file|-) filename\n"
19094 #: ../fish/guestfish-actions.pod:425 ../fish/guestfish-actions.pod:434
19095 #: ../fish/guestfish-actions.pod:658 ../fish/guestfish-actions.pod:827
19096 #: ../fish/guestfish-actions.pod:846 ../fish/guestfish-actions.pod:1223
19097 #: ../fish/guestfish-actions.pod:3956 ../fish/guestfish-actions.pod:3968
19098 #: ../fish/guestfish-actions.pod:3979 ../fish/guestfish-actions.pod:3990
19099 #: ../fish/guestfish-actions.pod:4042 ../fish/guestfish-actions.pod:4051
19100 #: ../fish/guestfish-actions.pod:4105 ../fish/guestfish-actions.pod:4128
19101 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
19105 #: ../fish/guestfish-actions.pod:427
19110 #: ../fish/guestfish-actions.pod:429
19113 " base64-out filename (base64file|-)\n"
19118 #: ../fish/guestfish-actions.pod:436
19119 msgid "blockdev-flushbufs"
19123 #: ../fish/guestfish-actions.pod:438
19126 " blockdev-flushbufs device\n"
19131 #: ../fish/guestfish-actions.pod:445
19132 msgid "blockdev-getbsz"
19136 #: ../fish/guestfish-actions.pod:447
19139 " blockdev-getbsz device\n"
19144 #: ../fish/guestfish-actions.pod:456
19145 msgid "blockdev-getro"
19149 #: ../fish/guestfish-actions.pod:458
19152 " blockdev-getro device\n"
19157 #: ../fish/guestfish-actions.pod:465
19158 msgid "blockdev-getsize64"
19162 #: ../fish/guestfish-actions.pod:467
19165 " blockdev-getsize64 device\n"
19170 #: ../fish/guestfish-actions.pod:471
19171 msgid "See also L</blockdev-getsz>."
19175 #: ../fish/guestfish-actions.pod:475
19176 msgid "blockdev-getss"
19180 #: ../fish/guestfish-actions.pod:477
19183 " blockdev-getss device\n"
19188 #: ../fish/guestfish-actions.pod:482
19190 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
19194 #: ../fish/guestfish-actions.pod:487
19195 msgid "blockdev-getsz"
19199 #: ../fish/guestfish-actions.pod:489
19202 " blockdev-getsz device\n"
19207 #: ../fish/guestfish-actions.pod:494
19209 "See also L</blockdev-getss> for the real sector size of the device, and L</"
19210 "blockdev-getsize64> for the more useful I<size in bytes>."
19214 #: ../fish/guestfish-actions.pod:500
19215 msgid "blockdev-rereadpt"
19219 #: ../fish/guestfish-actions.pod:502
19222 " blockdev-rereadpt device\n"
19227 #: ../fish/guestfish-actions.pod:508
19228 msgid "blockdev-setbsz"
19232 #: ../fish/guestfish-actions.pod:510
19235 " blockdev-setbsz device blocksize\n"
19240 #: ../fish/guestfish-actions.pod:519
19241 msgid "blockdev-setro"
19245 #: ../fish/guestfish-actions.pod:521
19248 " blockdev-setro device\n"
19253 #: ../fish/guestfish-actions.pod:527
19254 msgid "blockdev-setrw"
19258 #: ../fish/guestfish-actions.pod:529
19261 " blockdev-setrw device\n"
19266 #: ../fish/guestfish-actions.pod:535
19267 msgid "case-sensitive-path"
19271 #: ../fish/guestfish-actions.pod:537
19274 " case-sensitive-path path\n"
19279 #: ../fish/guestfish-actions.pod:561
19281 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
19282 "WINDOWS/system32\"> (the exact return value would depend on details of how "
19283 "the directories were originally created under Windows)."
19287 #: ../fish/guestfish-actions.pod:569
19288 msgid "See also L</realpath>."
19292 #: ../fish/guestfish-actions.pod:571
19297 #: ../fish/guestfish-actions.pod:573
19305 #: ../fish/guestfish-actions.pod:577
19307 "Note that this function cannot correctly handle binary files (specifically, "
19308 "files containing C<\\0> character which is treated as end of string). For "
19309 "those you need to use the L</read-file> or L</download> functions which have "
19310 "a more complex interface."
19314 #: ../fish/guestfish-actions.pod:585
19319 #: ../fish/guestfish-actions.pod:587
19322 " checksum csumtype path\n"
19327 #: ../fish/guestfish-actions.pod:630
19328 msgid "To get the checksum for a device, use L</checksum-device>."
19332 #: ../fish/guestfish-actions.pod:632
19333 msgid "To get the checksums for many files, use L</checksums-out>."
19337 #: ../fish/guestfish-actions.pod:634
19338 msgid "checksum-device"
19342 #: ../fish/guestfish-actions.pod:636
19345 " checksum-device csumtype device\n"
19350 #: ../fish/guestfish-actions.pod:638
19352 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
19353 "device named C<device>. For the types of checksums supported see the L</"
19354 "checksum> command."
19358 #: ../fish/guestfish-actions.pod:642
19359 msgid "checksums-out"
19363 #: ../fish/guestfish-actions.pod:644
19366 " checksums-out csumtype directory (sumsfile|-)\n"
19371 #: ../fish/guestfish-actions.pod:660
19376 #: ../fish/guestfish-actions.pod:662
19379 " chmod mode path\n"
19384 #: ../fish/guestfish-actions.pod:673
19389 #: ../fish/guestfish-actions.pod:675
19392 " chown owner group path\n"
19397 #: ../fish/guestfish-actions.pod:683
19402 #: ../fish/guestfish-actions.pod:685
19405 " command 'arguments ...'\n"
19410 #: ../fish/guestfish-actions.pod:692
19412 "The single parameter is an argv-style list of arguments. The first element "
19413 "is the name of the program to run. Subsequent elements are parameters. The "
19414 "list must be non-empty (ie. must contain a program name). Note that the "
19415 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
19419 #: ../fish/guestfish-actions.pod:720
19420 msgid "command-lines"
19424 #: ../fish/guestfish-actions.pod:722
19427 " command-lines 'arguments ...'\n"
19432 #: ../fish/guestfish-actions.pod:724
19434 "This is the same as L</command>, but splits the result into a list of lines."
19438 #: ../fish/guestfish-actions.pod:727
19439 msgid "See also: L</sh-lines>"
19443 #: ../fish/guestfish-actions.pod:732
19448 #: ../fish/guestfish-actions.pod:734
19451 " config qemuparam qemuvalue\n"
19456 #: ../fish/guestfish-actions.pod:745
19461 #: ../fish/guestfish-actions.pod:747
19464 " copy-size src dest size\n"
19469 #: ../fish/guestfish-actions.pod:755
19474 #: ../fish/guestfish-actions.pod:757
19482 #: ../fish/guestfish-actions.pod:762
19487 #: ../fish/guestfish-actions.pod:764
19495 #: ../fish/guestfish-actions.pod:769
19500 #: ../fish/guestfish-actions.pod:771
19508 #: ../fish/guestfish-actions.pod:778
19510 "If the destination is a device, it must be as large or larger than the "
19511 "source file or device, otherwise the copy will fail. This command cannot do "
19512 "partial copies (see L</copy-size>)."
19516 #: ../fish/guestfish-actions.pod:782
19521 #: ../fish/guestfish-actions.pod:784
19529 #: ../fish/guestfish-actions.pod:792
19534 #: ../fish/guestfish-actions.pod:794
19542 #: ../fish/guestfish-actions.pod:803
19547 #: ../fish/guestfish-actions.pod:805
19555 #: ../fish/guestfish-actions.pod:811
19557 "Another way to get the same information is to enable verbose messages with "
19558 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
19559 "before running the program."
19563 #: ../fish/guestfish-actions.pod:816
19568 #: ../fish/guestfish-actions.pod:818
19571 " download remotefilename (filename|-)\n"
19576 #: ../fish/guestfish-actions.pod:825
19577 msgid "See also L</upload>, L</cat>."
19581 #: ../fish/guestfish-actions.pod:829
19582 msgid "download-offset"
19586 #: ../fish/guestfish-actions.pod:831
19589 " download-offset remotefilename (filename|-) offset size\n"
19594 #: ../fish/guestfish-actions.pod:839
19596 "Note that there is no limit on the amount of data that can be downloaded "
19597 "with this call, unlike with L</pread>, and this call always reads the full "
19598 "amount unless an error occurs."
19602 #: ../fish/guestfish-actions.pod:844
19603 msgid "See also L</download>, L</pread>."
19607 #: ../fish/guestfish-actions.pod:848
19608 msgid "drop-caches"
19612 #: ../fish/guestfish-actions.pod:850
19615 " drop-caches whattodrop\n"
19620 #: ../fish/guestfish-actions.pod:862
19625 #: ../fish/guestfish-actions.pod:864
19633 #: ../fish/guestfish-actions.pod:876
19638 #: ../fish/guestfish-actions.pod:878
19641 " e2fsck-f device\n"
19646 #: ../fish/guestfish-actions.pod:884
19648 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
19649 "should use L</fsck>."
19653 #: ../fish/guestfish-actions.pod:887
19654 msgid "echo-daemon"
19658 #: ../fish/guestfish-actions.pod:889
19661 " echo-daemon 'words ...'\n"
19666 #: ../fish/guestfish-actions.pod:896
19667 msgid "See also L</ping-daemon>."
19671 #: ../fish/guestfish-actions.pod:898
19676 #: ../fish/guestfish-actions.pod:900
19679 " egrep regex path\n"
19684 #: ../fish/guestfish-actions.pod:908
19689 #: ../fish/guestfish-actions.pod:910
19692 " egrepi regex path\n"
19697 #: ../fish/guestfish-actions.pod:918
19702 #: ../fish/guestfish-actions.pod:920
19705 " equal file1 file2\n"
19710 #: ../fish/guestfish-actions.pod:927
19715 #: ../fish/guestfish-actions.pod:929
19723 #: ../fish/guestfish-actions.pod:934
19724 msgid "See also L</is-file>, L</is-dir>, L</stat>."
19728 #: ../fish/guestfish-actions.pod:936
19733 #: ../fish/guestfish-actions.pod:938
19736 " fallocate path len\n"
19741 #: ../fish/guestfish-actions.pod:955
19742 msgid "fallocate64"
19746 #: ../fish/guestfish-actions.pod:957
19749 " fallocate64 path len\n"
19754 #: ../fish/guestfish-actions.pod:963
19756 "Note that this call allocates disk blocks for the file. To create a sparse "
19757 "file use L</truncate-size> instead."
19761 #: ../fish/guestfish-actions.pod:966
19763 "The deprecated call L</fallocate> does the same, but owing to an oversight "
19764 "it only allowed 30 bit lengths to be specified, effectively limiting the "
19765 "maximum size of files created through that call to 1GB."
19769 #: ../fish/guestfish-actions.pod:975
19774 #: ../fish/guestfish-actions.pod:977
19777 " fgrep pattern path\n"
19782 #: ../fish/guestfish-actions.pod:985
19787 #: ../fish/guestfish-actions.pod:987
19790 " fgrepi pattern path\n"
19795 #: ../fish/guestfish-actions.pod:995
19800 #: ../fish/guestfish-actions.pod:997
19808 #: ../fish/guestfish-actions.pod:1009
19810 "This command can also be used on C</dev/> devices (and partitions, LV "
19811 "names). You can for example use this to determine if a device contains a "
19812 "filesystem, although it's usually better to use L</vfs-type>."
19816 #: ../fish/guestfish-actions.pod:1019
19817 msgid "file-architecture"
19821 #: ../fish/guestfish-actions.pod:1021
19824 " file-architecture filename\n"
19829 #: ../fish/guestfish-actions.pod:1124
19834 #: ../fish/guestfish-actions.pod:1126
19842 #: ../fish/guestfish-actions.pod:1130
19844 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
19845 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
19849 #: ../fish/guestfish-actions.pod:1134
19854 #: ../fish/guestfish-actions.pod:1136
19857 " fill c len path\n"
19862 #: ../fish/guestfish-actions.pod:1142
19864 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
19865 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
19866 "L</fill-pattern>."
19870 #: ../fish/guestfish-actions.pod:1147
19871 msgid "fill-pattern"
19875 #: ../fish/guestfish-actions.pod:1149
19878 " fill-pattern pattern len path\n"
19883 #: ../fish/guestfish-actions.pod:1151
19885 "This function is like L</fill> except that it creates a new file of length "
19886 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
19887 "is truncated if necessary to ensure the length of the file is exactly C<len> "
19892 #: ../fish/guestfish-actions.pod:1156
19897 #: ../fish/guestfish-actions.pod:1158
19900 " find directory\n"
19905 #: ../fish/guestfish-actions.pod:1172
19906 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
19910 #: ../fish/guestfish-actions.pod:1185
19911 msgid "See also L</find0>."
19915 #: ../fish/guestfish-actions.pod:1190
19920 #: ../fish/guestfish-actions.pod:1192
19923 " find0 directory (files|-)\n"
19928 #: ../fish/guestfish-actions.pod:1198
19930 "This command works the same way as L</find> with the following exceptions:"
19934 #: ../fish/guestfish-actions.pod:1225
19935 msgid "findfs-label"
19939 #: ../fish/guestfish-actions.pod:1227
19942 " findfs-label label\n"
19947 #: ../fish/guestfish-actions.pod:1233
19948 msgid "To find the label of a filesystem, use L</vfs-label>."
19952 #: ../fish/guestfish-actions.pod:1235
19953 msgid "findfs-uuid"
19957 #: ../fish/guestfish-actions.pod:1237
19960 " findfs-uuid uuid\n"
19965 #: ../fish/guestfish-actions.pod:1243
19966 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
19970 #: ../fish/guestfish-actions.pod:1245
19975 #: ../fish/guestfish-actions.pod:1247
19978 " fsck fstype device\n"
19983 #: ../fish/guestfish-actions.pod:1277
19988 #: ../fish/guestfish-actions.pod:1279
19996 #: ../fish/guestfish-actions.pod:1286
19997 msgid "get-autosync"
20001 #: ../fish/guestfish-actions.pod:1288
20009 #: ../fish/guestfish-actions.pod:1292
20014 #: ../fish/guestfish-actions.pod:1294
20022 #: ../fish/guestfish-actions.pod:1298
20023 msgid "get-e2label"
20027 #: ../fish/guestfish-actions.pod:1300
20030 " get-e2label device\n"
20035 #: ../fish/guestfish-actions.pod:1312
20040 #: ../fish/guestfish-actions.pod:1314
20043 " get-e2uuid device\n"
20048 #: ../fish/guestfish-actions.pod:1326
20049 msgid "get-memsize"
20053 #: ../fish/guestfish-actions.pod:1328
20061 #: ../fish/guestfish-actions.pod:1333
20063 "If L</set-memsize> was not called on this handle, and if "
20064 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
20065 "value for memsize."
20069 #: ../fish/guestfish-actions.pod:1340
20070 msgid "get-network"
20074 #: ../fish/guestfish-actions.pod:1342
20082 #: ../fish/guestfish-actions.pod:1346
20087 #: ../fish/guestfish-actions.pod:1348
20095 #: ../fish/guestfish-actions.pod:1355
20100 #: ../fish/guestfish-actions.pod:1357
20105 #: ../fish/guestfish-actions.pod:1359
20113 #: ../fish/guestfish-actions.pod:1366
20118 #: ../fish/guestfish-actions.pod:1368
20126 #: ../fish/guestfish-actions.pod:1375
20127 msgid "get-recovery-proc"
20131 #: ../fish/guestfish-actions.pod:1377
20134 " get-recovery-proc\n"
20139 #: ../fish/guestfish-actions.pod:1381
20140 msgid "get-selinux"
20144 #: ../fish/guestfish-actions.pod:1383
20152 #: ../fish/guestfish-actions.pod:1385
20154 "This returns the current setting of the selinux flag which is passed to the "
20155 "appliance at boot time. See L</set-selinux>."
20159 #: ../fish/guestfish-actions.pod:1391
20164 #: ../fish/guestfish-actions.pod:1393
20172 #: ../fish/guestfish-actions.pod:1400
20177 #: ../fish/guestfish-actions.pod:1402
20185 #: ../fish/guestfish-actions.pod:1406
20190 #: ../fish/guestfish-actions.pod:1408
20198 #: ../fish/guestfish-actions.pod:1410
20200 "Return the current umask. By default the umask is C<022> unless it has been "
20201 "set by calling L</umask>."
20205 #: ../fish/guestfish-actions.pod:1413
20206 msgid "get-verbose"
20210 #: ../fish/guestfish-actions.pod:1415
20218 #: ../fish/guestfish-actions.pod:1419
20223 #: ../fish/guestfish-actions.pod:1421
20231 #: ../fish/guestfish-actions.pod:1425
20232 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
20236 #: ../fish/guestfish-actions.pod:1428
20241 #: ../fish/guestfish-actions.pod:1430
20244 " getxattrs path\n"
20249 #: ../fish/guestfish-actions.pod:1438
20250 msgid "See also: L</lgetxattrs>, L<attr(5)>."
20254 #: ../fish/guestfish-actions.pod:1440
20255 msgid "glob-expand"
20259 #: ../fish/guestfish-actions.pod:1442
20262 " glob-expand pattern\n"
20267 #: ../fish/guestfish-actions.pod:1455
20272 #: ../fish/guestfish-actions.pod:1457
20275 " grep regex path\n"
20280 #: ../fish/guestfish-actions.pod:1465
20285 #: ../fish/guestfish-actions.pod:1467
20288 " grepi regex path\n"
20293 #: ../fish/guestfish-actions.pod:1475
20294 msgid "grub-install"
20298 #: ../fish/guestfish-actions.pod:1477
20301 " grub-install root device\n"
20306 #: ../fish/guestfish-actions.pod:1493
20311 #: ../fish/guestfish-actions.pod:1495
20319 #: ../fish/guestfish-actions.pod:1503
20324 #: ../fish/guestfish-actions.pod:1505
20327 " head-n nrlines path\n"
20332 #: ../fish/guestfish-actions.pod:1518
20337 #: ../fish/guestfish-actions.pod:1520
20345 #: ../fish/guestfish-actions.pod:1528
20350 #: ../fish/guestfish-actions.pod:1530
20353 " initrd-cat initrdpath filename\n"
20358 #: ../fish/guestfish-actions.pod:1542
20359 msgid "See also L</initrd-list>."
20363 #: ../fish/guestfish-actions.pod:1547
20364 msgid "initrd-list"
20368 #: ../fish/guestfish-actions.pod:1549
20371 " initrd-list path\n"
20376 #: ../fish/guestfish-actions.pod:1561
20377 msgid "inotify-add-watch"
20381 #: ../fish/guestfish-actions.pod:1563
20384 " inotify-add-watch path mask\n"
20389 #: ../fish/guestfish-actions.pod:1575
20390 msgid "inotify-close"
20394 #: ../fish/guestfish-actions.pod:1577
20402 #: ../fish/guestfish-actions.pod:1583
20403 msgid "inotify-files"
20407 #: ../fish/guestfish-actions.pod:1585
20415 #: ../fish/guestfish-actions.pod:1587
20417 "This function is a helpful wrapper around L</inotify-read> which just "
20418 "returns a list of pathnames of objects that were touched. The returned "
20419 "pathnames are sorted and deduplicated."
20423 #: ../fish/guestfish-actions.pod:1591
20424 msgid "inotify-init"
20428 #: ../fish/guestfish-actions.pod:1593
20431 " inotify-init maxevents\n"
20436 #: ../fish/guestfish-actions.pod:1599
20438 "C<maxevents> is the maximum number of events which will be queued up between "
20439 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
20440 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
20441 "default was 16384 events. Beyond this limit, the kernel throws away events, "
20442 "but records the fact that it threw them away by setting a flag "
20443 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
20447 #: ../fish/guestfish-actions.pod:1609
20449 "Before any events are generated, you have to add some watches to the "
20450 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
20451 "L</inotify-watch-all>."
20455 #: ../fish/guestfish-actions.pod:1615
20457 "Queued up events should be read periodically by calling L</inotify-read> (or "
20458 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
20459 "If you don't read the events out often enough then you risk the internal "
20460 "queue overflowing."
20464 #: ../fish/guestfish-actions.pod:1622
20466 "The handle should be closed after use by calling L</inotify-close>. This "
20467 "also removes any watches automatically."
20471 #: ../fish/guestfish-actions.pod:1631
20472 msgid "inotify-read"
20476 #: ../fish/guestfish-actions.pod:1633
20484 #: ../fish/guestfish-actions.pod:1646
20485 msgid "inotify-rm-watch"
20489 #: ../fish/guestfish-actions.pod:1648
20492 " inotify-rm-watch wd\n"
20497 #: ../fish/guestfish-actions.pod:1650
20498 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
20502 #: ../fish/guestfish-actions.pod:1653
20503 msgid "inspect-get-arch"
20507 #: ../fish/guestfish-actions.pod:1655
20510 " inspect-get-arch root\n"
20515 #: ../fish/guestfish-actions.pod:1657 ../fish/guestfish-actions.pod:1673
20516 #: ../fish/guestfish-actions.pod:1739 ../fish/guestfish-actions.pod:1757
20517 #: ../fish/guestfish-actions.pod:1778 ../fish/guestfish-actions.pod:1793
20518 #: ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1846
20519 #: ../fish/guestfish-actions.pod:1877
20521 "This function should only be called with a root device string as returned by "
20526 #: ../fish/guestfish-actions.pod:1660
20528 "This returns the architecture of the inspected operating system. The "
20529 "possible return values are listed under L</file-architecture>."
20533 #: ../fish/guestfish-actions.pod:1669
20534 msgid "inspect-get-distro"
20538 #: ../fish/guestfish-actions.pod:1671
20541 " inspect-get-distro root\n"
20546 #: ../fish/guestfish-actions.pod:1735
20547 msgid "inspect-get-filesystems"
20551 #: ../fish/guestfish-actions.pod:1737
20554 " inspect-get-filesystems root\n"
20559 #: ../fish/guestfish-actions.pod:1750
20561 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
20562 "get-mountpoints>."
20566 #: ../fish/guestfish-actions.pod:1753
20567 msgid "inspect-get-major-version"
20571 #: ../fish/guestfish-actions.pod:1755
20574 " inspect-get-major-version root\n"
20579 #: ../fish/guestfish-actions.pod:1774
20580 msgid "inspect-get-minor-version"
20584 #: ../fish/guestfish-actions.pod:1776
20587 " inspect-get-minor-version root\n"
20592 #: ../fish/guestfish-actions.pod:1786
20594 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
20595 "get-major-version>."
20599 #: ../fish/guestfish-actions.pod:1789
20600 msgid "inspect-get-mountpoints"
20604 #: ../fish/guestfish-actions.pod:1791
20607 " inspect-get-mountpoints root\n"
20612 #: ../fish/guestfish-actions.pod:1809
20614 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
20615 "get-filesystems>."
20619 #: ../fish/guestfish-actions.pod:1812
20620 msgid "inspect-get-product-name"
20624 #: ../fish/guestfish-actions.pod:1814
20627 " inspect-get-product-name root\n"
20632 #: ../fish/guestfish-actions.pod:1829
20633 msgid "inspect-get-roots"
20637 #: ../fish/guestfish-actions.pod:1831
20640 " inspect-get-roots\n"
20645 #: ../fish/guestfish-actions.pod:1833
20647 "This function is a convenient way to get the list of root devices, as "
20648 "returned from a previous call to L</inspect-os>, but without redoing the "
20649 "whole inspection process."
20653 #: ../fish/guestfish-actions.pod:1837
20655 "This returns an empty list if either no root devices were found or the "
20656 "caller has not called L</inspect-os>."
20660 #: ../fish/guestfish-actions.pod:1842
20661 msgid "inspect-get-type"
20665 #: ../fish/guestfish-actions.pod:1844
20668 " inspect-get-type root\n"
20673 #: ../fish/guestfish-actions.pod:1873
20674 msgid "inspect-get-windows-systemroot"
20678 #: ../fish/guestfish-actions.pod:1875
20681 " inspect-get-windows-systemroot root\n"
20686 #: ../fish/guestfish-actions.pod:1889
20691 #: ../fish/guestfish-actions.pod:1891
20699 #: ../fish/guestfish-actions.pod:1906
20701 "You can pass the root string(s) returned to other L</inspect-get-*> "
20702 "functions in order to query further information about each operating system, "
20703 "such as the name and version."
20707 #: ../fish/guestfish-actions.pod:1911
20709 "This function uses other libguestfs features such as L</mount-ro> and L</"
20710 "umount-all> in order to mount and unmount filesystems and look at the "
20711 "contents. This should be called with no disks currently mounted. The "
20712 "function may also use Augeas, so any existing Augeas handle will be closed."
20716 #: ../fish/guestfish-actions.pod:1923 ../fish/guestfish-actions.pod:2079
20717 #: ../fish/guestfish-actions.pod:2125
20718 msgid "See also L</list-filesystems>."
20722 #: ../fish/guestfish-actions.pod:1925
20723 msgid "is-blockdev"
20727 #: ../fish/guestfish-actions.pod:1927
20730 " is-blockdev path\n"
20735 #: ../fish/guestfish-actions.pod:1932 ../fish/guestfish-actions.pod:1950
20736 #: ../fish/guestfish-actions.pod:1969 ../fish/guestfish-actions.pod:1978
20737 #: ../fish/guestfish-actions.pod:1988 ../fish/guestfish-actions.pod:2022
20738 #: ../fish/guestfish-actions.pod:2031
20739 msgid "See also L</stat>."
20743 #: ../fish/guestfish-actions.pod:1934
20748 #: ../fish/guestfish-actions.pod:1936
20756 #: ../fish/guestfish-actions.pod:1943
20761 #: ../fish/guestfish-actions.pod:1945
20764 " is-chardev path\n"
20769 #: ../fish/guestfish-actions.pod:1952
20774 #: ../fish/guestfish-actions.pod:1954
20782 #: ../fish/guestfish-actions.pod:1961
20787 #: ../fish/guestfish-actions.pod:1963
20795 #: ../fish/guestfish-actions.pod:1971
20800 #: ../fish/guestfish-actions.pod:1973
20808 #: ../fish/guestfish-actions.pod:1980
20813 #: ../fish/guestfish-actions.pod:1982
20821 #: ../fish/guestfish-actions.pod:1990
20822 msgid "is-launching"
20826 #: ../fish/guestfish-actions.pod:1992
20834 #: ../fish/guestfish-actions.pod:1999
20839 #: ../fish/guestfish-actions.pod:2001
20847 #: ../fish/guestfish-actions.pod:2006
20852 #: ../fish/guestfish-actions.pod:2008
20860 #: ../fish/guestfish-actions.pod:2015
20865 #: ../fish/guestfish-actions.pod:2017
20868 " is-socket path\n"
20873 #: ../fish/guestfish-actions.pod:2024
20878 #: ../fish/guestfish-actions.pod:2026
20881 " is-symlink path\n"
20886 #: ../fish/guestfish-actions.pod:2033
20887 msgid "kill-subprocess"
20891 #: ../fish/guestfish-actions.pod:2035
20894 " kill-subprocess\n"
20899 #: ../fish/guestfish-actions.pod:2039
20904 #: ../fish/guestfish-actions.pod:2041
20909 #: ../fish/guestfish-actions.pod:2043
20917 #: ../fish/guestfish-actions.pod:2051
20922 #: ../fish/guestfish-actions.pod:2053
20925 " lchown owner group path\n"
20930 #: ../fish/guestfish-actions.pod:2055
20932 "Change the file owner to C<owner> and group to C<group>. This is like L</"
20933 "chown> but if C<path> is a symlink then the link itself is changed, not the "
20938 #: ../fish/guestfish-actions.pod:2063
20943 #: ../fish/guestfish-actions.pod:2065
20946 " lgetxattrs path\n"
20951 #: ../fish/guestfish-actions.pod:2067
20953 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
20954 "it returns the extended attributes of the link itself."
20958 #: ../fish/guestfish-actions.pod:2071
20959 msgid "list-devices"
20963 #: ../fish/guestfish-actions.pod:2073
20971 #: ../fish/guestfish-actions.pod:2081
20972 msgid "list-filesystems"
20976 #: ../fish/guestfish-actions.pod:2083
20979 " list-filesystems\n"
20984 #: ../fish/guestfish-actions.pod:2102
20986 "This command runs other libguestfs commands, which might include L</mount> "
20987 "and L</umount>, and therefore you should use this soon after launch and only "
20988 "when nothing is mounted."
20992 #: ../fish/guestfish-actions.pod:2106
20994 "Not all of the filesystems returned will be mountable. In particular, swap "
20995 "partitions are returned in the list. Also this command does not check that "
20996 "each filesystem found is valid and mountable, and some filesystems might be "
20997 "mountable but require special options. Filesystems may not all belong to a "
20998 "single logical operating system (use L</inspect-os> to look for OSes)."
21002 #: ../fish/guestfish-actions.pod:2114
21003 msgid "list-partitions"
21007 #: ../fish/guestfish-actions.pod:2116
21010 " list-partitions\n"
21015 #: ../fish/guestfish-actions.pod:2122
21017 "This does not return logical volumes. For that you will need to call L</"
21022 #: ../fish/guestfish-actions.pod:2127
21027 #: ../fish/guestfish-actions.pod:2129
21035 #: ../fish/guestfish-actions.pod:2137
21040 #: ../fish/guestfish-actions.pod:2139
21043 " ln target linkname\n"
21048 #: ../fish/guestfish-actions.pod:2143
21053 #: ../fish/guestfish-actions.pod:2145
21056 " ln-f target linkname\n"
21061 #: ../fish/guestfish-actions.pod:2150
21066 #: ../fish/guestfish-actions.pod:2152
21069 " ln-s target linkname\n"
21074 #: ../fish/guestfish-actions.pod:2156
21079 #: ../fish/guestfish-actions.pod:2158
21082 " ln-sf target linkname\n"
21087 #: ../fish/guestfish-actions.pod:2163
21088 msgid "lremovexattr"
21092 #: ../fish/guestfish-actions.pod:2165
21095 " lremovexattr xattr path\n"
21100 #: ../fish/guestfish-actions.pod:2167
21102 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
21103 "it removes an extended attribute of the link itself."
21107 #: ../fish/guestfish-actions.pod:2171
21112 #: ../fish/guestfish-actions.pod:2173
21120 #: ../fish/guestfish-actions.pod:2179
21122 "This command is mostly useful for interactive sessions. Programs should "
21123 "probably use L</readdir> instead."
21127 #: ../fish/guestfish-actions.pod:2182
21132 #: ../fish/guestfish-actions.pod:2184
21135 " lsetxattr xattr val vallen path\n"
21140 #: ../fish/guestfish-actions.pod:2186
21142 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
21143 "sets an extended attribute of the link itself."
21147 #: ../fish/guestfish-actions.pod:2190
21152 #: ../fish/guestfish-actions.pod:2192
21160 #: ../fish/guestfish-actions.pod:2196
21162 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
21163 "the link is stat-ed, not the file it refers to."
21167 #: ../fish/guestfish-actions.pod:2202
21172 #: ../fish/guestfish-actions.pod:2204
21175 " lstatlist path 'names ...'\n"
21180 #: ../fish/guestfish-actions.pod:2206
21182 "This call allows you to perform the L</lstat> operation on multiple files, "
21183 "where all files are in the directory C<path>. C<names> is the list of files "
21184 "from this directory."
21188 #: ../fish/guestfish-actions.pod:2215
21190 "This call is intended for programs that want to efficiently list a directory "
21191 "contents without making many round-trips. See also L</lxattrlist> for a "
21192 "similarly efficient call for getting extended attributes. Very long "
21193 "directory listings might cause the protocol message size to be exceeded, "
21194 "causing this call to fail. The caller must split up such requests into "
21195 "smaller groups of names."
21199 #: ../fish/guestfish-actions.pod:2223
21200 msgid "luks-add-key"
21204 #: ../fish/guestfish-actions.pod:2225
21207 " luks-add-key device keyslot\n"
21212 #: ../fish/guestfish-actions.pod:2232
21214 "Note that if C<keyslot> already contains a key, then this command will "
21215 "fail. You have to use L</luks-kill-slot> first to remove that key."
21219 #: ../fish/guestfish-actions.pod:2236 ../fish/guestfish-actions.pod:2258
21220 #: ../fish/guestfish-actions.pod:2271 ../fish/guestfish-actions.pod:2285
21221 #: ../fish/guestfish-actions.pod:2308 ../fish/guestfish-actions.pod:2318
21223 "This command has one or more key or passphrase parameters. Guestfish will "
21224 "prompt for these separately."
21228 #: ../fish/guestfish-actions.pod:2239
21233 #: ../fish/guestfish-actions.pod:2241
21236 " luks-close device\n"
21241 #: ../fish/guestfish-actions.pod:2243
21243 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
21244 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
21245 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
21250 #: ../fish/guestfish-actions.pod:2249
21251 msgid "luks-format"
21255 #: ../fish/guestfish-actions.pod:2251
21258 " luks-format device keyslot\n"
21263 #: ../fish/guestfish-actions.pod:2264
21264 msgid "luks-format-cipher"
21268 #: ../fish/guestfish-actions.pod:2266
21271 " luks-format-cipher device keyslot cipher\n"
21276 #: ../fish/guestfish-actions.pod:2268
21278 "This command is the same as L</luks-format> but it also allows you to set "
21279 "the C<cipher> used."
21283 #: ../fish/guestfish-actions.pod:2277
21284 msgid "luks-kill-slot"
21288 #: ../fish/guestfish-actions.pod:2279
21291 " luks-kill-slot device keyslot\n"
21296 #: ../fish/guestfish-actions.pod:2288
21301 #: ../fish/guestfish-actions.pod:2290
21304 " luks-open device mapname\n"
21309 #: ../fish/guestfish-actions.pod:2304
21311 "If this block device contains LVM volume groups, then calling L</vgscan> "
21312 "followed by L</vg-activate-all> will make them visible."
21316 #: ../fish/guestfish-actions.pod:2311
21317 msgid "luks-open-ro"
21321 #: ../fish/guestfish-actions.pod:2313
21324 " luks-open-ro device mapname\n"
21329 #: ../fish/guestfish-actions.pod:2315
21331 "This is the same as L</luks-open> except that a read-only mapping is created."
21335 #: ../fish/guestfish-actions.pod:2321
21340 #: ../fish/guestfish-actions.pod:2323
21343 " lvcreate logvol volgroup mbytes\n"
21348 #: ../fish/guestfish-actions.pod:2328
21349 msgid "lvm-canonical-lv-name"
21353 #: ../fish/guestfish-actions.pod:2330
21356 " lvm-canonical-lv-name lvname\n"
21361 #: ../fish/guestfish-actions.pod:2339
21362 msgid "See also L</is-lv>."
21366 #: ../fish/guestfish-actions.pod:2341
21367 msgid "lvm-clear-filter"
21371 #: ../fish/guestfish-actions.pod:2343
21374 " lvm-clear-filter\n"
21379 #: ../fish/guestfish-actions.pod:2345
21381 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
21386 #: ../fish/guestfish-actions.pod:2351
21387 msgid "lvm-remove-all"
21391 #: ../fish/guestfish-actions.pod:2353
21394 " lvm-remove-all\n"
21399 #: ../fish/guestfish-actions.pod:2361
21400 msgid "lvm-set-filter"
21404 #: ../fish/guestfish-actions.pod:2363
21407 " lvm-set-filter 'devices ...'\n"
21412 #: ../fish/guestfish-actions.pod:2388
21417 #: ../fish/guestfish-actions.pod:2390
21420 " lvremove device\n"
21425 #: ../fish/guestfish-actions.pod:2398
21430 #: ../fish/guestfish-actions.pod:2400
21433 " lvrename logvol newlogvol\n"
21438 #: ../fish/guestfish-actions.pod:2404
21443 #: ../fish/guestfish-actions.pod:2406
21446 " lvresize device mbytes\n"
21451 #: ../fish/guestfish-actions.pod:2412
21452 msgid "lvresize-free"
21456 #: ../fish/guestfish-actions.pod:2414
21459 " lvresize-free lv percent\n"
21464 #: ../fish/guestfish-actions.pod:2422
21469 #: ../fish/guestfish-actions.pod:2424
21477 #: ../fish/guestfish-actions.pod:2432
21478 msgid "See also L</lvs-full>, L</list-filesystems>."
21482 #: ../fish/guestfish-actions.pod:2434
21487 #: ../fish/guestfish-actions.pod:2436
21495 #: ../fish/guestfish-actions.pod:2441
21500 #: ../fish/guestfish-actions.pod:2443
21508 #: ../fish/guestfish-actions.pod:2447
21513 #: ../fish/guestfish-actions.pod:2449
21516 " lxattrlist path 'names ...'\n"
21521 #: ../fish/guestfish-actions.pod:2465
21523 "This call is intended for programs that want to efficiently list a directory "
21524 "contents without making many round-trips. See also L</lstatlist> for a "
21525 "similarly efficient call for getting standard stats. Very long directory "
21526 "listings might cause the protocol message size to be exceeded, causing this "
21527 "call to fail. The caller must split up such requests into smaller groups of "
21532 #: ../fish/guestfish-actions.pod:2473
21537 #: ../fish/guestfish-actions.pod:2475
21545 #: ../fish/guestfish-actions.pod:2479
21550 #: ../fish/guestfish-actions.pod:2481
21553 " mkdir-mode path mode\n"
21558 #: ../fish/guestfish-actions.pod:2490
21559 msgid "See also L</mkdir>, L</umask>"
21563 #: ../fish/guestfish-actions.pod:2492
21568 #: ../fish/guestfish-actions.pod:2494
21576 #: ../fish/guestfish-actions.pod:2499
21581 #: ../fish/guestfish-actions.pod:2501
21584 " mkdtemp template\n"
21589 #: ../fish/guestfish-actions.pod:2522
21594 #: ../fish/guestfish-actions.pod:2524
21597 " mke2fs-J fstype blocksize device journal\n"
21602 #: ../fish/guestfish-actions.pod:2532
21603 msgid "See also L</mke2journal>."
21607 #: ../fish/guestfish-actions.pod:2534
21612 #: ../fish/guestfish-actions.pod:2536
21615 " mke2fs-JL fstype blocksize device label\n"
21620 #: ../fish/guestfish-actions.pod:2541
21621 msgid "See also L</mke2journal-L>."
21625 #: ../fish/guestfish-actions.pod:2543
21630 #: ../fish/guestfish-actions.pod:2545
21633 " mke2fs-JU fstype blocksize device uuid\n"
21638 #: ../fish/guestfish-actions.pod:2550
21639 msgid "See also L</mke2journal-U>."
21643 #: ../fish/guestfish-actions.pod:2552
21644 msgid "mke2journal"
21648 #: ../fish/guestfish-actions.pod:2554
21651 " mke2journal blocksize device\n"
21656 #: ../fish/guestfish-actions.pod:2561
21657 msgid "mke2journal-L"
21661 #: ../fish/guestfish-actions.pod:2563
21664 " mke2journal-L blocksize label device\n"
21669 #: ../fish/guestfish-actions.pod:2567
21670 msgid "mke2journal-U"
21674 #: ../fish/guestfish-actions.pod:2569
21677 " mke2journal-U blocksize uuid device\n"
21682 #: ../fish/guestfish-actions.pod:2573
21687 #: ../fish/guestfish-actions.pod:2575
21690 " mkfifo mode path\n"
21695 #: ../fish/guestfish-actions.pod:2577
21697 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
21698 "is just a convenient wrapper around L</mknod>."
21702 #: ../fish/guestfish-actions.pod:2583
21707 #: ../fish/guestfish-actions.pod:2585
21710 " mkfs fstype device\n"
21715 #: ../fish/guestfish-actions.pod:2591
21720 #: ../fish/guestfish-actions.pod:2593
21723 " mkfs-b fstype blocksize device\n"
21728 #: ../fish/guestfish-actions.pod:2595
21730 "This call is similar to L</mkfs>, but it allows you to control the block "
21731 "size of the resulting filesystem. Supported block sizes depend on the "
21732 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
21736 #: ../fish/guestfish-actions.pod:2603
21737 msgid "mkmountpoint"
21741 #: ../fish/guestfish-actions.pod:2605
21744 " mkmountpoint exemptpath\n"
21749 #: ../fish/guestfish-actions.pod:2607
21751 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
21752 "to create extra mountpoints before mounting the first filesystem."
21756 #: ../fish/guestfish-actions.pod:2631
21758 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
21759 "unexpected errors if you try to mix these calls. It is safest to manually "
21760 "unmount filesystems and remove mountpoints after use."
21764 #: ../fish/guestfish-actions.pod:2635
21766 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
21767 "for this to work for manual mountpoints, you must ensure that the innermost "
21768 "mountpoints have the longest pathnames, as in the example code above."
21772 #: ../fish/guestfish-actions.pod:2642
21774 "Autosync [see L</set-autosync>, this is set by default on handles] means "
21775 "that L</umount-all> is called when the handle is closed which can also "
21776 "trigger these issues."
21780 #: ../fish/guestfish-actions.pod:2646
21785 #: ../fish/guestfish-actions.pod:2648
21788 " mknod mode devmajor devminor path\n"
21793 #: ../fish/guestfish-actions.pod:2658
21795 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
21796 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
21797 "regular file). These constants are available in the standard Linux header "
21798 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
21799 "wrappers around this command which bitwise OR in the appropriate constant "
21804 #: ../fish/guestfish-actions.pod:2668
21809 #: ../fish/guestfish-actions.pod:2670
21812 " mknod-b mode devmajor devminor path\n"
21817 #: ../fish/guestfish-actions.pod:2672
21819 "This call creates a block device node called C<path> with mode C<mode> and "
21820 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
21821 "wrapper around L</mknod>."
21825 #: ../fish/guestfish-actions.pod:2678
21830 #: ../fish/guestfish-actions.pod:2680
21833 " mknod-c mode devmajor devminor path\n"
21838 #: ../fish/guestfish-actions.pod:2682
21840 "This call creates a char device node called C<path> with mode C<mode> and "
21841 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
21842 "wrapper around L</mknod>."
21846 #: ../fish/guestfish-actions.pod:2688
21851 #: ../fish/guestfish-actions.pod:2690
21859 #: ../fish/guestfish-actions.pod:2694
21864 #: ../fish/guestfish-actions.pod:2696
21867 " mkswap-L label device\n"
21872 #: ../fish/guestfish-actions.pod:2704
21877 #: ../fish/guestfish-actions.pod:2706
21880 " mkswap-U uuid device\n"
21885 #: ../fish/guestfish-actions.pod:2710
21886 msgid "mkswap-file"
21890 #: ../fish/guestfish-actions.pod:2712
21893 " mkswap-file path\n"
21898 #: ../fish/guestfish-actions.pod:2716
21900 "This command just writes a swap file signature to an existing file. To "
21901 "create the file itself, use something like L</fallocate>."
21905 #: ../fish/guestfish-actions.pod:2719
21910 #: ../fish/guestfish-actions.pod:2721
21913 " modprobe modulename\n"
21918 #: ../fish/guestfish-actions.pod:2728
21923 #: ../fish/guestfish-actions.pod:2730
21926 " mount device mountpoint\n"
21931 #: ../fish/guestfish-actions.pod:2746
21933 "B<Important note:> When you use this call, the filesystem options C<sync> "
21934 "and C<noatime> are set implicitly. This was originally done because we "
21935 "thought it would improve reliability, but it turns out that I<-o sync> has a "
21936 "very large negative performance impact and negligible effect on "
21937 "reliability. Therefore we recommend that you avoid using L</mount> in any "
21938 "code that needs performance, and instead use L</mount-options> (use an empty "
21939 "string for the first parameter if you don't want any options)."
21943 #: ../fish/guestfish-actions.pod:2756
21948 #: ../fish/guestfish-actions.pod:2758
21951 " mount-loop file mountpoint\n"
21956 #: ../fish/guestfish-actions.pod:2764
21957 msgid "mount-options"
21961 #: ../fish/guestfish-actions.pod:2766
21964 " mount-options options device mountpoint\n"
21969 #: ../fish/guestfish-actions.pod:2768
21971 "This is the same as the L</mount> command, but it allows you to set the "
21972 "mount options as for the L<mount(8)> I<-o> flag."
21976 #: ../fish/guestfish-actions.pod:2776
21981 #: ../fish/guestfish-actions.pod:2778
21984 " mount-ro device mountpoint\n"
21989 #: ../fish/guestfish-actions.pod:2780
21991 "This is the same as the L</mount> command, but it mounts the filesystem with "
21992 "the read-only (I<-o ro>) flag."
21996 #: ../fish/guestfish-actions.pod:2783
22001 #: ../fish/guestfish-actions.pod:2785
22004 " mount-vfs options vfstype device mountpoint\n"
22009 #: ../fish/guestfish-actions.pod:2787
22011 "This is the same as the L</mount> command, but it allows you to set both the "
22012 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
22016 #: ../fish/guestfish-actions.pod:2791
22017 msgid "mountpoints"
22021 #: ../fish/guestfish-actions.pod:2793
22029 #: ../fish/guestfish-actions.pod:2795
22031 "This call is similar to L</mounts>. That call returns a list of devices. "
22032 "This one returns a hash table (map) of device name to directory where the "
22033 "device is mounted."
22037 #: ../fish/guestfish-actions.pod:2799
22042 #: ../fish/guestfish-actions.pod:2801
22050 #: ../fish/guestfish-actions.pod:2808
22051 msgid "See also: L</mountpoints>"
22055 #: ../fish/guestfish-actions.pod:2810
22060 #: ../fish/guestfish-actions.pod:2812
22068 #: ../fish/guestfish-actions.pod:2817
22069 msgid "ntfs-3g-probe"
22073 #: ../fish/guestfish-actions.pod:2819
22076 " ntfs-3g-probe true|false device\n"
22081 #: ../fish/guestfish-actions.pod:2833
22086 #: ../fish/guestfish-actions.pod:2835
22089 " ntfsresize device\n"
22094 #: ../fish/guestfish-actions.pod:2841
22095 msgid "ntfsresize-size"
22099 #: ../fish/guestfish-actions.pod:2843
22102 " ntfsresize-size device size\n"
22107 #: ../fish/guestfish-actions.pod:2845
22109 "This command is the same as L</ntfsresize> except that it allows you to "
22110 "specify the new size (in bytes) explicitly."
22114 #: ../fish/guestfish-actions.pod:2848
22119 #: ../fish/guestfish-actions.pod:2850
22122 " part-add device prlogex startsect endsect\n"
22127 #: ../fish/guestfish-actions.pod:2852
22129 "This command adds a partition to C<device>. If there is no partition table "
22130 "on the device, call L</part-init> first."
22134 #: ../fish/guestfish-actions.pod:2864
22136 "Creating a partition which covers the whole disk is not so easy. Use L</"
22137 "part-disk> to do that."
22141 #: ../fish/guestfish-actions.pod:2867
22146 #: ../fish/guestfish-actions.pod:2869
22149 " part-del device partnum\n"
22154 #: ../fish/guestfish-actions.pod:2877
22159 #: ../fish/guestfish-actions.pod:2879
22162 " part-disk device parttype\n"
22167 #: ../fish/guestfish-actions.pod:2881
22169 "This command is simply a combination of L</part-init> followed by L</part-"
22170 "add> to create a single primary partition covering the whole disk."
22174 #: ../fish/guestfish-actions.pod:2885
22176 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
22177 "possible values are described in L</part-init>."
22181 #: ../fish/guestfish-actions.pod:2891
22182 msgid "part-get-bootable"
22186 #: ../fish/guestfish-actions.pod:2893
22189 " part-get-bootable device partnum\n"
22194 #: ../fish/guestfish-actions.pod:2898
22195 msgid "See also L</part-set-bootable>."
22199 #: ../fish/guestfish-actions.pod:2900
22200 msgid "part-get-mbr-id"
22204 #: ../fish/guestfish-actions.pod:2902
22207 " part-get-mbr-id device partnum\n"
22212 #: ../fish/guestfish-actions.pod:2907 ../fish/guestfish-actions.pod:3045
22214 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
22215 "undefined results for other partition table types (see L</part-get-"
22220 #: ../fish/guestfish-actions.pod:2911
22221 msgid "part-get-parttype"
22225 #: ../fish/guestfish-actions.pod:2913
22228 " part-get-parttype device\n"
22233 #: ../fish/guestfish-actions.pod:2918
22235 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
22236 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
22237 "possible, although unusual. See L</part-init> for a full list."
22241 #: ../fish/guestfish-actions.pod:2923
22246 #: ../fish/guestfish-actions.pod:2925
22249 " part-init device parttype\n"
22254 #: ../fish/guestfish-actions.pod:2931
22256 "Initially there are no partitions. Following this, you should call L</part-"
22257 "add> for each partition required."
22261 #: ../fish/guestfish-actions.pod:2994
22266 #: ../fish/guestfish-actions.pod:2996
22269 " part-list device\n"
22274 #: ../fish/guestfish-actions.pod:3011
22276 "Start of the partition I<in bytes>. To get sectors you have to divide by "
22277 "the device's sector size, see L</blockdev-getss>."
22281 #: ../fish/guestfish-actions.pod:3024
22282 msgid "part-set-bootable"
22286 #: ../fish/guestfish-actions.pod:3026
22289 " part-set-bootable device partnum true|false\n"
22294 #: ../fish/guestfish-actions.pod:3035
22295 msgid "part-set-mbr-id"
22299 #: ../fish/guestfish-actions.pod:3037
22302 " part-set-mbr-id device partnum idbyte\n"
22307 #: ../fish/guestfish-actions.pod:3049
22308 msgid "part-set-name"
22312 #: ../fish/guestfish-actions.pod:3051
22315 " part-set-name device partnum name\n"
22320 #: ../fish/guestfish-actions.pod:3059
22321 msgid "part-to-dev"
22325 #: ../fish/guestfish-actions.pod:3061
22328 " part-to-dev partition\n"
22333 #: ../fish/guestfish-actions.pod:3067
22335 "The named partition must exist, for example as a string returned from L</"
22336 "list-partitions>."
22340 #: ../fish/guestfish-actions.pod:3070
22341 msgid "ping-daemon"
22345 #: ../fish/guestfish-actions.pod:3072
22353 #: ../fish/guestfish-actions.pod:3079
22358 #: ../fish/guestfish-actions.pod:3081
22361 " pread path count offset\n"
22366 #: ../fish/guestfish-actions.pod:3089
22367 msgid "See also L</pwrite>, L</pread-device>."
22371 #: ../fish/guestfish-actions.pod:3094
22372 msgid "pread-device"
22376 #: ../fish/guestfish-actions.pod:3096
22379 " pread-device device count offset\n"
22384 #: ../fish/guestfish-actions.pod:3104
22385 msgid "See also L</pread>."
22389 #: ../fish/guestfish-actions.pod:3109
22394 #: ../fish/guestfish-actions.pod:3111
22397 " pvcreate device\n"
22402 #: ../fish/guestfish-actions.pod:3117
22407 #: ../fish/guestfish-actions.pod:3119
22410 " pvremove device\n"
22415 #: ../fish/guestfish-actions.pod:3128
22420 #: ../fish/guestfish-actions.pod:3130
22423 " pvresize device\n"
22428 #: ../fish/guestfish-actions.pod:3135
22429 msgid "pvresize-size"
22433 #: ../fish/guestfish-actions.pod:3137
22436 " pvresize-size device size\n"
22441 #: ../fish/guestfish-actions.pod:3139
22443 "This command is the same as L</pvresize> except that it allows you to "
22444 "specify the new size (in bytes) explicitly."
22448 #: ../fish/guestfish-actions.pod:3142
22453 #: ../fish/guestfish-actions.pod:3144
22461 #: ../fish/guestfish-actions.pod:3152
22462 msgid "See also L</pvs-full>."
22466 #: ../fish/guestfish-actions.pod:3154
22471 #: ../fish/guestfish-actions.pod:3156
22479 #: ../fish/guestfish-actions.pod:3161
22484 #: ../fish/guestfish-actions.pod:3163
22492 #: ../fish/guestfish-actions.pod:3167
22497 #: ../fish/guestfish-actions.pod:3169
22500 " pwrite path content offset\n"
22505 #: ../fish/guestfish-actions.pod:3180
22506 msgid "See also L</pread>, L</pwrite-device>."
22510 #: ../fish/guestfish-actions.pod:3185
22511 msgid "pwrite-device"
22515 #: ../fish/guestfish-actions.pod:3187
22518 " pwrite-device device content offset\n"
22523 #: ../fish/guestfish-actions.pod:3197
22524 msgid "See also L</pwrite>."
22528 #: ../fish/guestfish-actions.pod:3202
22533 #: ../fish/guestfish-actions.pod:3204
22536 " read-file path\n"
22541 #: ../fish/guestfish-actions.pod:3209
22543 "Unlike L</cat>, this function can correctly handle files that contain "
22544 "embedded ASCII NUL characters. However unlike L</download>, this function "
22545 "is limited in the total size of file that can be handled."
22549 #: ../fish/guestfish-actions.pod:3217
22554 #: ../fish/guestfish-actions.pod:3219
22557 " read-lines path\n"
22562 #: ../fish/guestfish-actions.pod:3226
22564 "Note that this function cannot correctly handle binary files (specifically, "
22565 "files containing C<\\0> character which is treated as end of line). For "
22566 "those you need to use the L</read-file> function which has a more complex "
22571 #: ../fish/guestfish-actions.pod:3231
22576 #: ../fish/guestfish-actions.pod:3233
22584 #: ../fish/guestfish-actions.pod:3285
22586 "This function is primarily intended for use by programs. To get a simple "
22587 "list of names, use L</ls>. To get a printable directory for human "
22588 "consumption, use L</ll>."
22592 #: ../fish/guestfish-actions.pod:3289
22597 #: ../fish/guestfish-actions.pod:3291
22605 #: ../fish/guestfish-actions.pod:3295
22606 msgid "readlinklist"
22610 #: ../fish/guestfish-actions.pod:3297
22613 " readlinklist path 'names ...'\n"
22618 #: ../fish/guestfish-actions.pod:3321
22623 #: ../fish/guestfish-actions.pod:3323
22631 #: ../fish/guestfish-actions.pod:3328
22632 msgid "removexattr"
22636 #: ../fish/guestfish-actions.pod:3330
22639 " removexattr xattr path\n"
22644 #: ../fish/guestfish-actions.pod:3335
22645 msgid "See also: L</lremovexattr>, L<attr(5)>."
22649 #: ../fish/guestfish-actions.pod:3337
22654 #: ../fish/guestfish-actions.pod:3339
22657 " resize2fs device\n"
22662 #: ../fish/guestfish-actions.pod:3344
22664 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
22665 "before calling this command. For unknown reasons C<resize2fs> sometimes "
22666 "gives an error about this and sometimes not. In any case, it is always safe "
22667 "to call L</e2fsck-f> before calling this function."
22671 #: ../fish/guestfish-actions.pod:3350
22672 msgid "resize2fs-size"
22676 #: ../fish/guestfish-actions.pod:3352
22679 " resize2fs-size device size\n"
22684 #: ../fish/guestfish-actions.pod:3354
22686 "This command is the same as L</resize2fs> except that it allows you to "
22687 "specify the new size (in bytes) explicitly."
22691 #: ../fish/guestfish-actions.pod:3357
22696 #: ../fish/guestfish-actions.pod:3359
22704 #: ../fish/guestfish-actions.pod:3363
22709 #: ../fish/guestfish-actions.pod:3365
22717 #: ../fish/guestfish-actions.pod:3371
22722 #: ../fish/guestfish-actions.pod:3373
22730 #: ../fish/guestfish-actions.pod:3377
22731 msgid "rmmountpoint"
22735 #: ../fish/guestfish-actions.pod:3379
22738 " rmmountpoint exemptpath\n"
22743 #: ../fish/guestfish-actions.pod:3381
22745 "This calls removes a mountpoint that was previously created with L</"
22746 "mkmountpoint>. See L</mkmountpoint> for full details."
22750 #: ../fish/guestfish-actions.pod:3385
22751 msgid "scrub-device"
22755 #: ../fish/guestfish-actions.pod:3387
22758 " scrub-device device\n"
22763 #: ../fish/guestfish-actions.pod:3398
22768 #: ../fish/guestfish-actions.pod:3400
22771 " scrub-file file\n"
22776 #: ../fish/guestfish-actions.pod:3410
22777 msgid "scrub-freespace"
22781 #: ../fish/guestfish-actions.pod:3412
22784 " scrub-freespace dir\n"
22789 #: ../fish/guestfish-actions.pod:3414
22791 "This command creates the directory C<dir> and then fills it with files until "
22792 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
22793 "deletes them. The intention is to scrub any free space on the partition "
22794 "containing C<dir>."
22798 #: ../fish/guestfish-actions.pod:3423
22803 #: ../fish/guestfish-actions.pod:3425
22808 #: ../fish/guestfish-actions.pod:3427
22811 " set-append append\n"
22816 #: ../fish/guestfish-actions.pod:3438
22817 msgid "set-autosync"
22821 #: ../fish/guestfish-actions.pod:3440
22826 #: ../fish/guestfish-actions.pod:3442
22829 " set-autosync true|false\n"
22834 #: ../fish/guestfish-actions.pod:3444
22836 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
22837 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
22838 "closed (also if the program exits without closing handles)."
22842 #: ../fish/guestfish-actions.pod:3452
22847 #: ../fish/guestfish-actions.pod:3454
22852 #: ../fish/guestfish-actions.pod:3456
22855 " set-direct true|false\n"
22860 #: ../fish/guestfish-actions.pod:3462
22862 "One consequence of this is that log messages aren't caught by the library "
22863 "and handled by L</set-log-message-callback>, but go straight to stdout."
22867 #: ../fish/guestfish-actions.pod:3471
22868 msgid "set-e2label"
22872 #: ../fish/guestfish-actions.pod:3473
22875 " set-e2label device label\n"
22880 #: ../fish/guestfish-actions.pod:3479
22882 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
22883 "label on a filesystem."
22887 #: ../fish/guestfish-actions.pod:3482
22892 #: ../fish/guestfish-actions.pod:3484
22895 " set-e2uuid device uuid\n"
22900 #: ../fish/guestfish-actions.pod:3491
22902 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
22903 "UUID of a filesystem."
22907 #: ../fish/guestfish-actions.pod:3494
22908 msgid "set-memsize"
22912 #: ../fish/guestfish-actions.pod:3496
22917 #: ../fish/guestfish-actions.pod:3498
22920 " set-memsize memsize\n"
22925 #: ../fish/guestfish-actions.pod:3500
22927 "This sets the memory size in megabytes allocated to the qemu subprocess. "
22928 "This only has any effect if called before L</launch>."
22932 #: ../fish/guestfish-actions.pod:3511
22933 msgid "set-network"
22937 #: ../fish/guestfish-actions.pod:3513
22942 #: ../fish/guestfish-actions.pod:3515
22945 " set-network true|false\n"
22950 #: ../fish/guestfish-actions.pod:3523
22952 "You must call this before calling L</launch>, otherwise it has no effect."
22956 #: ../fish/guestfish-actions.pod:3526
22961 #: ../fish/guestfish-actions.pod:3528
22966 #: ../fish/guestfish-actions.pod:3530
22969 " set-path searchpath\n"
22974 #: ../fish/guestfish-actions.pod:3539
22979 #: ../fish/guestfish-actions.pod:3541
22984 #: ../fish/guestfish-actions.pod:3543
22992 #: ../fish/guestfish-actions.pod:3563
22993 msgid "set-recovery-proc"
22997 #: ../fish/guestfish-actions.pod:3565
22998 msgid "recovery-proc"
23002 #: ../fish/guestfish-actions.pod:3567
23005 " set-recovery-proc true|false\n"
23010 #: ../fish/guestfish-actions.pod:3569
23012 "If this is called with the parameter C<false> then L</launch> does not "
23013 "create a recovery process. The purpose of the recovery process is to stop "
23014 "runaway qemu processes in the case where the main program aborts abruptly."
23018 #: ../fish/guestfish-actions.pod:3574
23020 "This only has any effect if called before L</launch>, and the default is "
23025 #: ../fish/guestfish-actions.pod:3583
23026 msgid "set-selinux"
23030 #: ../fish/guestfish-actions.pod:3585
23035 #: ../fish/guestfish-actions.pod:3587
23038 " set-selinux true|false\n"
23043 #: ../fish/guestfish-actions.pod:3598
23048 #: ../fish/guestfish-actions.pod:3600
23053 #: ../fish/guestfish-actions.pod:3602
23056 " set-trace true|false\n"
23061 #: ../fish/guestfish-actions.pod:3618
23062 msgid "set-verbose"
23066 #: ../fish/guestfish-actions.pod:3620
23071 #: ../fish/guestfish-actions.pod:3622
23074 " set-verbose true|false\n"
23079 #: ../fish/guestfish-actions.pod:3629
23084 #: ../fish/guestfish-actions.pod:3631
23087 " setcon context\n"
23092 #: ../fish/guestfish-actions.pod:3638
23097 #: ../fish/guestfish-actions.pod:3640
23100 " setxattr xattr val vallen path\n"
23105 #: ../fish/guestfish-actions.pod:3646
23106 msgid "See also: L</lsetxattr>, L<attr(5)>."
23110 #: ../fish/guestfish-actions.pod:3648
23115 #: ../fish/guestfish-actions.pod:3650
23118 " sfdisk device cyls heads sectors 'lines ...'\n"
23123 #: ../fish/guestfish-actions.pod:3672
23124 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
23128 #: ../fish/guestfish-actions.pod:3678
23133 #: ../fish/guestfish-actions.pod:3680
23136 " sfdiskM device 'lines ...'\n"
23141 #: ../fish/guestfish-actions.pod:3682
23143 "This is a simplified interface to the L</sfdisk> command, where partition "
23144 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
23145 "you don't need to specify the cyls, heads and sectors parameters which were "
23146 "rarely if ever used anyway."
23150 #: ../fish/guestfish-actions.pod:3688
23151 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
23155 #: ../fish/guestfish-actions.pod:3694
23160 #: ../fish/guestfish-actions.pod:3696
23163 " sfdisk-N device partnum cyls heads sectors line\n"
23168 #: ../fish/guestfish-actions.pod:3701
23170 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
23171 "cyls/heads/sectors parameters."
23175 #: ../fish/guestfish-actions.pod:3704
23176 msgid "See also: L</part-add>"
23180 #: ../fish/guestfish-actions.pod:3709
23181 msgid "sfdisk-disk-geometry"
23185 #: ../fish/guestfish-actions.pod:3711
23188 " sfdisk-disk-geometry device\n"
23193 #: ../fish/guestfish-actions.pod:3713
23195 "This displays the disk geometry of C<device> read from the partition table. "
23196 "Especially in the case where the underlying block device has been resized, "
23197 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
23198 "kernel-geometry>)."
23202 #: ../fish/guestfish-actions.pod:3721
23203 msgid "sfdisk-kernel-geometry"
23207 #: ../fish/guestfish-actions.pod:3723
23210 " sfdisk-kernel-geometry device\n"
23215 #: ../fish/guestfish-actions.pod:3730
23220 #: ../fish/guestfish-actions.pod:3732
23223 " sfdisk-l device\n"
23228 #: ../fish/guestfish-actions.pod:3738
23229 msgid "See also: L</part-list>"
23233 #: ../fish/guestfish-actions.pod:3740
23238 #: ../fish/guestfish-actions.pod:3742
23246 #: ../fish/guestfish-actions.pod:3747
23247 msgid "This is like L</command>, but passes the command to:"
23251 #: ../fish/guestfish-actions.pod:3755
23252 msgid "All the provisos about L</command> apply to this call."
23256 #: ../fish/guestfish-actions.pod:3757
23261 #: ../fish/guestfish-actions.pod:3759
23264 " sh-lines command\n"
23269 #: ../fish/guestfish-actions.pod:3761
23270 msgid "This is the same as L</sh>, but splits the result into a list of lines."
23274 #: ../fish/guestfish-actions.pod:3764
23275 msgid "See also: L</command-lines>"
23279 #: ../fish/guestfish-actions.pod:3766
23284 #: ../fish/guestfish-actions.pod:3768
23292 #: ../fish/guestfish-actions.pod:3772
23297 #: ../fish/guestfish-actions.pod:3774
23305 #: ../fish/guestfish-actions.pod:3780
23310 #: ../fish/guestfish-actions.pod:3782
23318 #: ../fish/guestfish-actions.pod:3790
23323 #: ../fish/guestfish-actions.pod:3792
23331 #: ../fish/guestfish-actions.pod:3800
23336 #: ../fish/guestfish-actions.pod:3802
23339 " strings-e encoding path\n"
23344 #: ../fish/guestfish-actions.pod:3804
23346 "This is like the L</strings> command, but allows you to specify the encoding "
23347 "of strings that are looked for in the source file C<path>."
23351 #: ../fish/guestfish-actions.pod:3814
23353 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
23354 "ISO-8859-X (this is what L</strings> uses)."
23358 #: ../fish/guestfish-actions.pod:3846
23359 msgid "swapoff-device"
23363 #: ../fish/guestfish-actions.pod:3848
23366 " swapoff-device device\n"
23371 #: ../fish/guestfish-actions.pod:3850
23373 "This command disables the libguestfs appliance swap device or partition "
23374 "named C<device>. See L</swapon-device>."
23378 #: ../fish/guestfish-actions.pod:3854
23379 msgid "swapoff-file"
23383 #: ../fish/guestfish-actions.pod:3856
23386 " swapoff-file file\n"
23391 #: ../fish/guestfish-actions.pod:3860
23392 msgid "swapoff-label"
23396 #: ../fish/guestfish-actions.pod:3862
23399 " swapoff-label label\n"
23404 #: ../fish/guestfish-actions.pod:3867
23405 msgid "swapoff-uuid"
23409 #: ../fish/guestfish-actions.pod:3869
23412 " swapoff-uuid uuid\n"
23417 #: ../fish/guestfish-actions.pod:3874
23418 msgid "swapon-device"
23422 #: ../fish/guestfish-actions.pod:3876
23425 " swapon-device device\n"
23430 #: ../fish/guestfish-actions.pod:3878
23432 "This command enables the libguestfs appliance to use the swap device or "
23433 "partition named C<device>. The increased memory is made available for all "
23434 "commands, for example those run using L</command> or L</sh>."
23438 #: ../fish/guestfish-actions.pod:3890
23439 msgid "swapon-file"
23443 #: ../fish/guestfish-actions.pod:3892
23446 " swapon-file file\n"
23451 #: ../fish/guestfish-actions.pod:3894
23453 "This command enables swap to a file. See L</swapon-device> for other notes."
23457 #: ../fish/guestfish-actions.pod:3897
23458 msgid "swapon-label"
23462 #: ../fish/guestfish-actions.pod:3899
23465 " swapon-label label\n"
23470 #: ../fish/guestfish-actions.pod:3901
23472 "This command enables swap to a labeled swap partition. See L</swapon-"
23473 "device> for other notes."
23477 #: ../fish/guestfish-actions.pod:3904
23478 msgid "swapon-uuid"
23482 #: ../fish/guestfish-actions.pod:3906
23485 " swapon-uuid uuid\n"
23490 #: ../fish/guestfish-actions.pod:3908
23492 "This command enables swap to a swap partition with the given UUID. See L</"
23493 "swapon-device> for other notes."
23497 #: ../fish/guestfish-actions.pod:3911
23502 #: ../fish/guestfish-actions.pod:3913
23510 #: ../fish/guestfish-actions.pod:3921
23515 #: ../fish/guestfish-actions.pod:3923
23523 #: ../fish/guestfish-actions.pod:3931
23528 #: ../fish/guestfish-actions.pod:3933
23531 " tail-n nrlines path\n"
23536 #: ../fish/guestfish-actions.pod:3946
23541 #: ../fish/guestfish-actions.pod:3948
23544 " tar-in (tarfile|-) directory\n"
23549 #: ../fish/guestfish-actions.pod:3953
23550 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
23554 #: ../fish/guestfish-actions.pod:3958
23559 #: ../fish/guestfish-actions.pod:3960
23562 " tar-out directory (tarfile|-)\n"
23567 #: ../fish/guestfish-actions.pod:3965
23568 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
23572 #: ../fish/guestfish-actions.pod:3970
23577 #: ../fish/guestfish-actions.pod:3972
23580 " tgz-in (tarball|-) directory\n"
23585 #: ../fish/guestfish-actions.pod:3977
23586 msgid "To upload an uncompressed tarball, use L</tar-in>."
23590 #: ../fish/guestfish-actions.pod:3981
23595 #: ../fish/guestfish-actions.pod:3983
23598 " tgz-out directory (tarball|-)\n"
23603 #: ../fish/guestfish-actions.pod:3988
23604 msgid "To download an uncompressed tarball, use L</tar-out>."
23608 #: ../fish/guestfish-actions.pod:3992
23613 #: ../fish/guestfish-actions.pod:3994
23621 #: ../fish/guestfish-actions.pod:4003
23626 #: ../fish/guestfish-actions.pod:4005
23634 #: ../fish/guestfish-actions.pod:4010
23635 msgid "truncate-size"
23639 #: ../fish/guestfish-actions.pod:4012
23642 " truncate-size path size\n"
23647 #: ../fish/guestfish-actions.pod:4017
23649 "If the current file size is less than C<size> then the file is extended to "
23650 "the required size with zero bytes. This creates a sparse file (ie. disk "
23651 "blocks are not allocated for the file until you write to it). To create a "
23652 "non-sparse file of zeroes, use L</fallocate64> instead."
23656 #: ../fish/guestfish-actions.pod:4023
23661 #: ../fish/guestfish-actions.pod:4025
23664 " tune2fs-l device\n"
23669 #: ../fish/guestfish-actions.pod:4035
23674 #: ../fish/guestfish-actions.pod:4037
23677 " txz-in (tarball|-) directory\n"
23682 #: ../fish/guestfish-actions.pod:4044
23687 #: ../fish/guestfish-actions.pod:4046
23690 " txz-out directory (tarball|-)\n"
23695 #: ../fish/guestfish-actions.pod:4053
23700 #: ../fish/guestfish-actions.pod:4055
23708 #: ../fish/guestfish-actions.pod:4069
23709 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
23713 #: ../fish/guestfish-actions.pod:4074
23718 #: ../fish/guestfish-actions.pod:4076
23723 #: ../fish/guestfish-actions.pod:4078
23726 " umount pathordevice\n"
23731 #: ../fish/guestfish-actions.pod:4084
23736 #: ../fish/guestfish-actions.pod:4086
23737 msgid "unmount-all"
23741 #: ../fish/guestfish-actions.pod:4088
23749 #: ../fish/guestfish-actions.pod:4094
23754 #: ../fish/guestfish-actions.pod:4096
23757 " upload (filename|-) remotefilename\n"
23762 #: ../fish/guestfish-actions.pod:4103
23763 msgid "See also L</download>."
23767 #: ../fish/guestfish-actions.pod:4107
23768 msgid "upload-offset"
23772 #: ../fish/guestfish-actions.pod:4109
23775 " upload-offset (filename|-) remotefilename offset\n"
23780 #: ../fish/guestfish-actions.pod:4121
23782 "Note that there is no limit on the amount of data that can be uploaded with "
23783 "this call, unlike with L</pwrite>, and this call always writes the full "
23784 "amount unless an error occurs."
23788 #: ../fish/guestfish-actions.pod:4126
23789 msgid "See also L</upload>, L</pwrite>."
23793 #: ../fish/guestfish-actions.pod:4130
23798 #: ../fish/guestfish-actions.pod:4132
23801 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
23806 #: ../fish/guestfish-actions.pod:4151
23811 #: ../fish/guestfish-actions.pod:4153
23819 #: ../fish/guestfish-actions.pod:4180
23821 "I<Note:> Don't use this call to test for availability of features. In "
23822 "enterprise distributions we backport features from later versions into "
23823 "earlier versions, making this an unreliable way to test for features. Use "
23824 "L</available> instead."
23828 #: ../fish/guestfish-actions.pod:4186
23833 #: ../fish/guestfish-actions.pod:4188
23836 " vfs-label device\n"
23841 #: ../fish/guestfish-actions.pod:4195
23842 msgid "To find a filesystem from the label, use L</findfs-label>."
23846 #: ../fish/guestfish-actions.pod:4197
23851 #: ../fish/guestfish-actions.pod:4199
23854 " vfs-type device\n"
23859 #: ../fish/guestfish-actions.pod:4209
23864 #: ../fish/guestfish-actions.pod:4211
23867 " vfs-uuid device\n"
23872 #: ../fish/guestfish-actions.pod:4218
23873 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
23877 #: ../fish/guestfish-actions.pod:4220
23878 msgid "vg-activate"
23882 #: ../fish/guestfish-actions.pod:4222
23885 " vg-activate true|false 'volgroups ...'\n"
23890 #: ../fish/guestfish-actions.pod:4235
23891 msgid "vg-activate-all"
23895 #: ../fish/guestfish-actions.pod:4237
23898 " vg-activate-all true|false\n"
23903 #: ../fish/guestfish-actions.pod:4247
23908 #: ../fish/guestfish-actions.pod:4249
23911 " vgcreate volgroup 'physvols ...'\n"
23916 #: ../fish/guestfish-actions.pod:4254
23921 #: ../fish/guestfish-actions.pod:4256
23924 " vglvuuids vgname\n"
23929 #: ../fish/guestfish-actions.pod:4261
23931 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
23932 "logical volumes and volume groups."
23936 #: ../fish/guestfish-actions.pod:4264
23937 msgid "See also L</vgpvuuids>."
23941 #: ../fish/guestfish-actions.pod:4266
23946 #: ../fish/guestfish-actions.pod:4268
23949 " vgpvuuids vgname\n"
23954 #: ../fish/guestfish-actions.pod:4273
23956 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
23957 "physical volumes and volume groups."
23961 #: ../fish/guestfish-actions.pod:4276
23962 msgid "See also L</vglvuuids>."
23966 #: ../fish/guestfish-actions.pod:4278
23971 #: ../fish/guestfish-actions.pod:4280
23974 " vgremove vgname\n"
23979 #: ../fish/guestfish-actions.pod:4287
23984 #: ../fish/guestfish-actions.pod:4289
23987 " vgrename volgroup newvolgroup\n"
23992 #: ../fish/guestfish-actions.pod:4293
23997 #: ../fish/guestfish-actions.pod:4295
24005 #: ../fish/guestfish-actions.pod:4303
24006 msgid "See also L</vgs-full>."
24010 #: ../fish/guestfish-actions.pod:4305
24015 #: ../fish/guestfish-actions.pod:4307
24023 #: ../fish/guestfish-actions.pod:4312
24028 #: ../fish/guestfish-actions.pod:4314
24036 #: ../fish/guestfish-actions.pod:4319
24041 #: ../fish/guestfish-actions.pod:4321
24049 #: ../fish/guestfish-actions.pod:4325
24054 #: ../fish/guestfish-actions.pod:4327
24062 #: ../fish/guestfish-actions.pod:4332
24067 #: ../fish/guestfish-actions.pod:4334
24075 #: ../fish/guestfish-actions.pod:4339
24080 #: ../fish/guestfish-actions.pod:4341
24088 #: ../fish/guestfish-actions.pod:4346
24093 #: ../fish/guestfish-actions.pod:4348
24096 " write path content\n"
24101 #: ../fish/guestfish-actions.pod:4356
24106 #: ../fish/guestfish-actions.pod:4358
24109 " write-file path content size\n"
24114 #: ../fish/guestfish-actions.pod:4381
24119 #: ../fish/guestfish-actions.pod:4383
24122 " zegrep regex path\n"
24127 #: ../fish/guestfish-actions.pod:4391
24132 #: ../fish/guestfish-actions.pod:4393
24135 " zegrepi regex path\n"
24140 #: ../fish/guestfish-actions.pod:4401
24145 #: ../fish/guestfish-actions.pod:4403
24153 #: ../fish/guestfish-actions.pod:4411
24154 msgid "See also: L</zero-device>, L</scrub-device>."
24158 #: ../fish/guestfish-actions.pod:4413
24159 msgid "zero-device"
24163 #: ../fish/guestfish-actions.pod:4415
24166 " zero-device device\n"
24171 #: ../fish/guestfish-actions.pod:4417
24173 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
24174 "which just zeroes the first few blocks of a device."
24178 #: ../fish/guestfish-actions.pod:4424
24183 #: ../fish/guestfish-actions.pod:4426
24186 " zerofree device\n"
24191 #: ../fish/guestfish-actions.pod:4439
24196 #: ../fish/guestfish-actions.pod:4441
24199 " zfgrep pattern path\n"
24204 #: ../fish/guestfish-actions.pod:4449
24209 #: ../fish/guestfish-actions.pod:4451
24212 " zfgrepi pattern path\n"
24217 #: ../fish/guestfish-actions.pod:4459
24222 #: ../fish/guestfish-actions.pod:4461
24225 " zfile meth path\n"
24230 #: ../fish/guestfish-actions.pod:4468
24232 "Since 1.0.63, use L</file> instead which can now process compressed files."
24236 #: ../fish/guestfish-actions.pod:4478
24241 #: ../fish/guestfish-actions.pod:4480
24244 " zgrep regex path\n"
24249 #: ../fish/guestfish-actions.pod:4488
24254 #: ../fish/guestfish-actions.pod:4490
24257 " zgrepi regex path\n"
24262 #: ../fish/guestfish-commands.pod:1
24267 #: ../fish/guestfish-commands.pod:3
24272 #: ../fish/guestfish-commands.pod:5
24275 " alloc filename size\n"
24280 #: ../fish/guestfish-commands.pod:7
24282 "This creates an empty (zeroed) file of the given size, and then adds so it "
24283 "can be further examined."
24287 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
24288 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
24292 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
24293 msgid "Size can be specified using standard suffixes, eg. C<1M>."
24297 #: ../fish/guestfish-commands.pod:14
24299 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
24300 "image, see L</PREPARED DISK IMAGES>."
24304 #: ../fish/guestfish-commands.pod:17
24309 #: ../fish/guestfish-commands.pod:19
24312 " copy-in local [local ...] /remotedir\n"
24317 #: ../fish/guestfish-commands.pod:21
24319 "C<copy-in> copies local files or directories recursively into the disk "
24320 "image, placing them in the directory called C</remotedir> (which must "
24321 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
24322 "other commands as necessary."
24326 #: ../fish/guestfish-commands.pod:26
24328 "Multiple local files and directories can be specified, but the last "
24329 "parameter must always be a remote directory. Wildcards cannot be used."
24333 #: ../fish/guestfish-commands.pod:30
24338 #: ../fish/guestfish-commands.pod:32
24341 " copy-out remote [remote ...] localdir\n"
24346 #: ../fish/guestfish-commands.pod:34
24348 "C<copy-out> copies remote files or directories recursively out of the disk "
24349 "image, placing them on the host disk in a local directory called C<localdir> "
24350 "(which must exist). This guestfish meta-command turns into a sequence of L</"
24351 "download>, L</tar-out> and other commands as necessary."
24355 #: ../fish/guestfish-commands.pod:40
24357 "Multiple remote files and directories can be specified, but the last "
24358 "parameter must always be a local directory. To download to the current "
24359 "directory, use C<.> as in:"
24363 #: ../fish/guestfish-commands.pod:44
24366 " copy-out /home .\n"
24371 #: ../fish/guestfish-commands.pod:46
24373 "Wildcards cannot be used in the ordinary command, but you can use them with "
24374 "the help of L</glob> like this:"
24378 #: ../fish/guestfish-commands.pod:49
24381 " glob copy-out /home/* .\n"
24386 #: ../fish/guestfish-commands.pod:51
24391 #: ../fish/guestfish-commands.pod:53
24394 " echo [params ...]\n"
24399 #: ../fish/guestfish-commands.pod:55
24400 msgid "This echos the parameters to the terminal."
24404 #: ../fish/guestfish-commands.pod:57
24409 #: ../fish/guestfish-commands.pod:59
24414 #: ../fish/guestfish-commands.pod:61
24419 #: ../fish/guestfish-commands.pod:63
24427 #: ../fish/guestfish-commands.pod:65
24429 "This is used to edit a file. It downloads the file, edits it locally using "
24430 "your editor, then uploads the result."
24434 #: ../fish/guestfish-commands.pod:68
24436 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
24437 "or C<emacs> you will get those corresponding editors."
24441 #: ../fish/guestfish-commands.pod:72
24446 #: ../fish/guestfish-commands.pod:74
24449 " glob command args...\n"
24454 #: ../fish/guestfish-commands.pod:76
24456 "Expand wildcards in any paths in the args list, and run C<command> "
24457 "repeatedly on each matching path."
24461 #: ../fish/guestfish-commands.pod:79
24462 msgid "See L</WILDCARDS AND GLOBBING>."
24466 #: ../fish/guestfish-commands.pod:81
24471 #: ../fish/guestfish-commands.pod:83
24474 " hexedit <filename|device>\n"
24475 " hexedit <filename|device> <max>\n"
24476 " hexedit <filename|device> <start> <max>\n"
24481 #: ../fish/guestfish-commands.pod:87
24483 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
24488 #: ../fish/guestfish-commands.pod:90
24490 "This command works by downloading potentially the whole file or device, "
24491 "editing it locally, then uploading it. If the file or device is large, you "
24492 "have to specify which part you wish to edit by using C<max> and/or C<start> "
24493 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
24494 "usual modifiers allowed such as C<1M> (1 megabyte)."
24498 #: ../fish/guestfish-commands.pod:97
24499 msgid "For example to edit the first few sectors of a disk you might do:"
24503 #: ../fish/guestfish-commands.pod:100
24506 " hexedit /dev/sda 1M\n"
24511 #: ../fish/guestfish-commands.pod:102
24513 "which would allow you to edit anywhere within the first megabyte of the disk."
24517 #: ../fish/guestfish-commands.pod:105
24518 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
24522 #: ../fish/guestfish-commands.pod:107
24525 " hexedit /dev/sda1 0x400 0x400\n"
24530 #: ../fish/guestfish-commands.pod:109
24531 msgid "(assuming the superblock is in the standard location)."
24535 #: ../fish/guestfish-commands.pod:111
24537 "This command requires the external L<hexedit(1)> program. You can specify "
24538 "another program to use by setting the C<HEXEDITOR> environment variable."
24542 #: ../fish/guestfish-commands.pod:115
24543 msgid "See also L</hexdump>."
24547 #: ../fish/guestfish-commands.pod:117
24552 #: ../fish/guestfish-commands.pod:119
24560 #: ../fish/guestfish-commands.pod:121
24562 "Change the local directory, ie. the current directory of guestfish itself."
24566 #: ../fish/guestfish-commands.pod:124
24567 msgid "Note that C<!cd> won't do what you might expect."
24571 #: ../fish/guestfish-commands.pod:126
24576 #: ../fish/guestfish-commands.pod:128
24581 #: ../fish/guestfish-commands.pod:130
24589 #: ../fish/guestfish-commands.pod:132
24590 msgid "Opens the manual page for guestfish."
24594 #: ../fish/guestfish-commands.pod:134
24599 #: ../fish/guestfish-commands.pod:136
24604 #: ../fish/guestfish-commands.pod:138
24612 #: ../fish/guestfish-commands.pod:140
24620 #: ../fish/guestfish-commands.pod:142
24621 msgid "This is used to view a file."
24625 #: ../fish/guestfish-commands.pod:144
24627 "The default viewer is C<$PAGER>. However if you use the alternate command "
24628 "C<less> you will get the C<less> command specifically."
24632 #: ../fish/guestfish-commands.pod:147
24637 #: ../fish/guestfish-commands.pod:149
24645 #: ../fish/guestfish-commands.pod:151
24647 "Close and reopen the libguestfs handle. It is not necessary to use this "
24648 "normally, because the handle is closed properly when guestfish exits. "
24649 "However this is occasionally useful for testing."
24653 #: ../fish/guestfish-commands.pod:155
24658 #: ../fish/guestfish-commands.pod:157
24661 " sparse filename size\n"
24666 #: ../fish/guestfish-commands.pod:159
24668 "This creates an empty sparse file of the given size, and then adds so it can "
24669 "be further examined."
24673 #: ../fish/guestfish-commands.pod:162
24675 "In all respects it works the same as the L</alloc> command, except that the "
24676 "image file is allocated sparsely, which means that disk blocks are not "
24677 "assigned to the file until they are needed. Sparse disk files only use "
24678 "space when written to, but they are slower and there is a danger you could "
24679 "run out of real disk space during a write operation."
24683 #: ../fish/guestfish-commands.pod:172
24688 #: ../fish/guestfish-commands.pod:174
24696 #: ../fish/guestfish-commands.pod:176
24698 "This command returns a list of the optional groups known to the daemon, and "
24699 "indicates which ones are supported by this build of the libguestfs appliance."
24703 #: ../fish/guestfish-commands.pod:180
24704 msgid "See also L<guestfs(3)/AVAILABILITY>."
24708 #: ../fish/guestfish-commands.pod:182
24713 #: ../fish/guestfish-commands.pod:184
24716 " time command args...\n"
24721 #: ../fish/guestfish-commands.pod:186
24723 "Run the command as usual, but print the elapsed time afterwards. This can "
24724 "be useful for benchmarking operations."
24728 #: ../test-tool/libguestfs-test-tool.pod:5
24729 msgid "libguestfs-test-tool - End user tests for libguestfs"
24733 #: ../test-tool/libguestfs-test-tool.pod:9
24736 " libguestfs-test-tool [--options]\n"
24741 #: ../test-tool/libguestfs-test-tool.pod:13
24743 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
24744 "and developers, to allow them to check basic libguestfs functionality is "
24745 "working. This is needed because libguestfs occasionally breaks for reasons "
24746 "beyond our control: usually because of changes in the underlying qemu or "
24747 "kernel packages, or the host environment."
24751 #: ../test-tool/libguestfs-test-tool.pod:20
24752 msgid "If you suspect a problem in libguestfs, then just run:"
24756 #: ../test-tool/libguestfs-test-tool.pod:22
24759 " libguestfs-test-tool\n"
24764 #: ../test-tool/libguestfs-test-tool.pod:24
24765 msgid "It will print lots of diagnostic messages."
24769 #: ../test-tool/libguestfs-test-tool.pod:26
24770 msgid "If it runs to completion successfully, you will see this near the end:"
24774 #: ../test-tool/libguestfs-test-tool.pod:28
24777 " ===== TEST FINISHED OK =====\n"
24782 #: ../test-tool/libguestfs-test-tool.pod:30
24783 msgid "and the test tool will exit with code 0."
24787 #: ../test-tool/libguestfs-test-tool.pod:32
24789 "If it fails (and/or exits with non-zero error code), please paste the "
24790 "B<complete, unedited> output of the test tool into a bug report. More "
24791 "information about reporting bugs can be found on the L<http://libguestfs.org/"
24796 #: ../test-tool/libguestfs-test-tool.pod:41
24801 #: ../test-tool/libguestfs-test-tool.pod:43
24802 msgid "Display short usage information and exit."
24806 #: ../test-tool/libguestfs-test-tool.pod:45
24807 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
24811 #: ../test-tool/libguestfs-test-tool.pod:47
24813 "Pass an alternate name for the helper program. libguestfs-test-tool will "
24814 "normally look in the C<$libexec> directory that was configured when the tool "
24819 #: ../test-tool/libguestfs-test-tool.pod:51
24820 msgid "I<--qemu qemu_binary>"
24824 #: ../test-tool/libguestfs-test-tool.pod:53
24826 "If you have downloaded another qemu binary, point this option at the full "
24827 "path of the binary to try it."
24831 #: ../test-tool/libguestfs-test-tool.pod:56
24832 msgid "I<--qemudir qemu_source_dir>"
24836 #: ../test-tool/libguestfs-test-tool.pod:58
24838 "If you have compiled qemu from source, point this option at the source "
24839 "directory to try it."
24843 #: ../test-tool/libguestfs-test-tool.pod:61
24844 msgid "I<--timeout N>"
24848 #: ../test-tool/libguestfs-test-tool.pod:63
24850 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
24851 "does not usually need to be adjusted unless your machine is very slow."
24855 #: ../test-tool/libguestfs-test-tool.pod:69
24856 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
24860 #: ../test-tool/libguestfs-test-tool.pod:71
24862 "If you have compiled another version of qemu from source and would like to "
24863 "try that, then you can use the I<--qemudir> option to point to the qemu "
24864 "source directory."
24868 #: ../test-tool/libguestfs-test-tool.pod:75
24870 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
24871 "option to point to the binary."
24875 #: ../test-tool/libguestfs-test-tool.pod:78
24877 "When using an alternate qemu with libguestfs, usually you would need to "
24878 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
24879 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
24880 "use either of the I<--qemudir> or I<--qemu> options."
24884 #: ../test-tool/libguestfs-test-tool.pod:85
24886 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
24887 "I<1> if there was an error."
24891 #: ../test-tool/libguestfs-test-tool.pod:92
24892 msgid "/usr/libexec/libguestfs-test-tool-helper"
24896 #: ../test-tool/libguestfs-test-tool.pod:94
24898 "This helper program is run inside the appliance and provides additional "
24903 #: ../test-tool/libguestfs-test-tool.pod:97
24904 msgid "/usr/bin/mkisofs"
24908 #: ../test-tool/libguestfs-test-tool.pod:99
24910 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
24911 "which is used as part of the tests."
24915 #: ../test-tool/libguestfs-test-tool.pod:106
24917 "For the full list of environment variables which may affect libguestfs, "
24918 "please see the L<guestfs(3)> manual page."
24922 #: ../test-tool/libguestfs-test-tool.pod:111
24923 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
24927 #: ../test-tool/libguestfs-test-tool.pod:121
24928 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
24932 #: ../fuse/guestmount.pod:5
24934 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
24938 #: ../fuse/guestmount.pod:9
24941 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
24946 #: ../fuse/guestmount.pod:11
24949 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
24954 #: ../fuse/guestmount.pod:13
24957 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
24962 #: ../fuse/guestmount.pod:17
24964 "You must I<not> use C<guestmount> in read-write mode on live virtual "
24965 "machines. If you do this, you risk disk corruption in the VM."
24969 #: ../fuse/guestmount.pod:22
24971 "The guestmount program can be used to mount virtual machine filesystems and "
24972 "other disk images on the host. It uses libguestfs for access to the guest "
24973 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
24974 "a mountable device."
24978 #: ../fuse/guestmount.pod:27
24980 "Along with other options, you have to give at least one device (I<-a> "
24981 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
24982 "option) or use the I<-i> inspection option. How this works is better "
24983 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
24988 #: ../fuse/guestmount.pod:33
24990 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
24991 "by you, and the filesystem will not be visible to any other users unless you "
24992 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
24993 "the filesystem, use the C<fusermount -u> command."
24997 #: ../fuse/guestmount.pod:41
24999 "For a typical Windows guest which has its main filesystem on the first "
25004 #: ../fuse/guestmount.pod:44
25007 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
25012 #: ../fuse/guestmount.pod:46
25014 "For a typical Linux guest which has a /boot filesystem on the first "
25015 "partition, and the root filesystem on a logical volume:"
25019 #: ../fuse/guestmount.pod:49
25022 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
25027 #: ../fuse/guestmount.pod:51
25028 msgid "To get libguestfs to detect guest mountpoints for you:"
25032 #: ../fuse/guestmount.pod:53
25035 " guestmount -a guest.img -i --ro /mnt\n"
25040 #: ../fuse/guestmount.pod:55
25041 msgid "For a libvirt guest called \"Guest\" you could do:"
25045 #: ../fuse/guestmount.pod:57
25048 " guestmount -d Guest -i --ro /mnt\n"
25053 #: ../fuse/guestmount.pod:59
25055 "If you don't know what filesystems are contained in a guest or disk image, "
25056 "use L<virt-list-filesystems(1)> first:"
25060 #: ../fuse/guestmount.pod:62
25063 " virt-list-filesystems MyGuest\n"
25068 #: ../fuse/guestmount.pod:64
25070 "If you want to trace the libguestfs calls but without excessive debugging "
25071 "information, we recommend:"
25075 #: ../fuse/guestmount.pod:67
25078 " guestmount [...] --trace /mnt\n"
25083 #: ../fuse/guestmount.pod:69
25084 msgid "If you want to debug the program, we recommend:"
25088 #: ../fuse/guestmount.pod:71
25091 " guestmount [...] --trace --verbose /mnt\n"
25096 #: ../fuse/guestmount.pod:79
25097 msgid "Add a block device or virtual machine image."
25101 #: ../fuse/guestmount.pod:96
25102 msgid "B<--dir-cache-timeout N>"
25106 #: ../fuse/guestmount.pod:98
25108 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
25109 "seconds. The readdir cache [actually, there are several semi-independent "
25110 "caches] is populated after a readdir(2) call with the stat and extended "
25111 "attributes of the files in the directory, in anticipation that they will be "
25112 "requested soon after."
25116 #: ../fuse/guestmount.pod:104
25118 "There is also a different attribute cache implemented by FUSE (see the FUSE "
25119 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
25120 "requests, only cache existing ones."
25124 #: ../fuse/guestmount.pod:122
25126 "If you have untrusted raw-format guest disk images, you should use this "
25127 "option to specify the disk format. This avoids a possible security problem "
25128 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
25129 "guestfs_add_drive_opts>."
25133 #: ../fuse/guestmount.pod:127
25134 msgid "B<--fuse-help>"
25138 #: ../fuse/guestmount.pod:129
25139 msgid "Display help on special FUSE options (see I<-o> below)."
25143 #: ../fuse/guestmount.pod:133
25144 msgid "Display brief help and exit."
25148 #: ../fuse/guestmount.pod:146
25149 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
25153 #: ../fuse/guestmount.pod:148
25155 "Mount the named partition or logical volume on the given mountpoint B<in the "
25156 "guest> (this has nothing to do with mountpoints in the host)."
25160 #: ../fuse/guestmount.pod:151
25162 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
25163 "something on C</>."
25167 #: ../fuse/guestmount.pod:156
25169 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
25170 "unmounted. If you specify this option, then we don't attempt to sync the "
25171 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
25175 #: ../fuse/guestmount.pod:161
25176 msgid "B<-o option> | B<--option option>"
25180 #: ../fuse/guestmount.pod:163
25181 msgid "Pass extra options to FUSE."
25185 #: ../fuse/guestmount.pod:165
25187 "To get a list of all the extra options supported by FUSE, use the command "
25188 "below. Note that only the FUSE I<-o> options can be passed, and only some "
25189 "of them are a good idea."
25193 #: ../fuse/guestmount.pod:169
25196 " guestmount --fuse-help\n"
25201 #: ../fuse/guestmount.pod:171
25202 msgid "Some potentially useful FUSE options:"
25206 #: ../fuse/guestmount.pod:175
25207 msgid "B<-o allow_other>"
25211 #: ../fuse/guestmount.pod:177
25212 msgid "Allow other users to see the filesystem."
25216 #: ../fuse/guestmount.pod:179
25217 msgid "B<-o attr_timeout=N>"
25221 #: ../fuse/guestmount.pod:181
25222 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
25226 #: ../fuse/guestmount.pod:183
25227 msgid "B<-o kernel_cache>"
25231 #: ../fuse/guestmount.pod:185
25233 "Allow the kernel to cache files (reduces the number of reads that have to go "
25234 "through the L<guestfs(3)> API). This is generally a good idea if you can "
25235 "afford the extra memory usage."
25239 #: ../fuse/guestmount.pod:189
25240 msgid "B<-o uid=N> B<-o gid=N>"
25244 #: ../fuse/guestmount.pod:191
25246 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
25247 "the chosen values."
25251 #: ../fuse/guestmount.pod:198
25253 "Add devices and mount everything read-only. Also disallow writes and make "
25254 "the disk appear read-only to FUSE."
25258 #: ../fuse/guestmount.pod:201
25260 "This is highly recommended if you are not going to edit the guest disk. If "
25261 "the guest is running and this option is I<not> supplied, then there is a "
25262 "strong risk of disk corruption in the guest. We try to prevent this from "
25263 "happening, but it is not always possible."
25267 #: ../fuse/guestmount.pod:206
25268 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
25272 #: ../fuse/guestmount.pod:210
25273 msgid "Enable SELinux support for the guest."
25277 #: ../fuse/guestmount.pod:214
25278 msgid "Enable verbose messages from underlying libguestfs."
25282 #: ../fuse/guestmount.pod:218
25283 msgid "Display the program version and exit."
25287 #: ../fuse/guestmount.pod:222
25289 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
25290 "FOR READ AND WRITE>."
25294 #: ../fuse/guestmount.pod:225
25295 msgid "B<-x> | B<--trace>"
25299 #: ../fuse/guestmount.pod:227
25300 msgid "Trace libguestfs calls."
25304 #: ../fuse/guestmount.pod:229
25305 msgid "This also stops the daemon from forking into the background."
25309 #: ../fuse/guestmount.pod:235
25311 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
25312 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
25317 #: ../inspector/virt-inspector.pl:35
25319 "virt-inspector - Display operating system version and other information "
25320 "about a virtual machine"
25324 #: ../inspector/virt-inspector.pl:39
25327 " virt-inspector [--connect URI] domname\n"
25332 #: ../inspector/virt-inspector.pl:41
25335 " virt-inspector guest.img [guest.img ...]\n"
25340 #: ../inspector/virt-inspector.pl:45
25342 "B<virt-inspector> examines a virtual machine or disk image and tries to "
25343 "determine the version of the operating system and other information about "
25344 "the virtual machine."
25348 #: ../inspector/virt-inspector.pl:49
25349 msgid "Virt-inspector produces XML output for feeding into other programs."
25353 #: ../inspector/virt-inspector.pl:51
25355 "In the normal usage, use C<virt-inspector domname> where C<domname> is the "
25356 "libvirt domain (see: C<virsh list --all>)."
25360 #: ../inspector/virt-inspector.pl:54
25362 "You can also run virt-inspector directly on disk images from a single "
25363 "virtual machine. Use C<virt-inspector guest.img>. In rare cases a domain "
25364 "has several block devices, in which case you should list them one after "
25365 "another, with the first corresponding to the guest's C</dev/sda>, the second "
25366 "to the guest's C</dev/sdb> and so on."
25370 #: ../inspector/virt-inspector.pl:60
25372 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
25373 "inspect several virtual machines, you have to run virt-inspector several "
25374 "times (for example, from a shell script for-loop)."
25378 #: ../inspector/virt-inspector.pl:65
25380 "Because virt-inspector needs direct access to guest images, it won't "
25381 "normally work over remote libvirt connections."
25385 #: ../inspector/virt-inspector.pl:78 ../tools/virt-edit.pl:82
25386 #: ../tools/virt-win-reg.pl:181 ../tools/virt-df.pl:81 ../tools/virt-ls.pl:88
25387 #: ../tools/virt-list-filesystems.pl:60 ../tools/virt-tar.pl:108
25388 #: ../tools/virt-rescue.pl:113 ../tools/virt-make-fs.pl:163
25389 #: ../tools/virt-list-partitions.pl:61
25390 msgid "Display brief help."
25394 #: ../inspector/virt-inspector.pl:84 ../tools/virt-edit.pl:88
25395 #: ../tools/virt-win-reg.pl:187 ../tools/virt-df.pl:87 ../tools/virt-ls.pl:94
25396 #: ../tools/virt-resize.pl:273 ../tools/virt-list-filesystems.pl:66
25397 #: ../tools/virt-tar.pl:114 ../tools/virt-rescue.pl:119
25398 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:67
25399 msgid "B<--version>"
25403 #: ../inspector/virt-inspector.pl:86 ../tools/virt-edit.pl:90
25404 #: ../tools/virt-win-reg.pl:189 ../tools/virt-df.pl:89 ../tools/virt-ls.pl:96
25405 #: ../tools/virt-resize.pl:275 ../tools/virt-list-filesystems.pl:68
25406 #: ../tools/virt-tar.pl:116 ../tools/virt-rescue.pl:121
25407 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:69
25408 msgid "Display version number and exit."
25412 #: ../inspector/virt-inspector.pl:92 ../tools/virt-edit.pl:112
25413 #: ../tools/virt-win-reg.pl:203 ../tools/virt-df.pl:95 ../tools/virt-ls.pl:102
25414 #: ../tools/virt-list-filesystems.pl:74 ../tools/virt-tar.pl:122
25415 #: ../tools/virt-rescue.pl:135 ../tools/virt-list-partitions.pl:75
25416 msgid "B<--connect URI> | B<-c URI>"
25420 #: ../inspector/virt-inspector.pl:94 ../tools/virt-edit.pl:114
25421 #: ../tools/virt-win-reg.pl:205 ../tools/virt-df.pl:97 ../tools/virt-ls.pl:104
25422 #: ../tools/virt-list-filesystems.pl:76 ../tools/virt-tar.pl:124
25423 #: ../tools/virt-rescue.pl:137 ../tools/virt-list-partitions.pl:77
25425 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
25426 "to the default libvirt hypervisor."
25430 #: ../inspector/virt-inspector.pl:97
25432 "Libvirt is only used if you specify a C<domname> on the command line. If "
25433 "you specify guest block devices directly, then libvirt is not used at all."
25437 #: ../inspector/virt-inspector.pl:105 ../tools/virt-edit.pl:124
25438 #: ../tools/virt-win-reg.pl:215 ../tools/virt-df.pl:117
25439 #: ../tools/virt-ls.pl:114 ../tools/virt-resize.pl:523
25440 #: ../tools/virt-list-filesystems.pl:86 ../tools/virt-tar.pl:134
25441 #: ../tools/virt-rescue.pl:147 ../tools/virt-list-partitions.pl:87
25442 msgid "B<--format> raw"
25446 #: ../inspector/virt-inspector.pl:107 ../tools/virt-edit.pl:126
25447 #: ../tools/virt-win-reg.pl:217 ../tools/virt-df.pl:119
25448 #: ../tools/virt-ls.pl:116 ../tools/virt-list-filesystems.pl:88
25449 #: ../tools/virt-tar.pl:136 ../tools/virt-rescue.pl:149
25450 #: ../tools/virt-list-partitions.pl:89
25452 "Specify the format of disk images given on the command line. If this is "
25453 "omitted then the format is autodetected from the content of the disk image."
25457 #: ../inspector/virt-inspector.pl:111 ../tools/virt-edit.pl:130
25458 #: ../tools/virt-win-reg.pl:221 ../tools/virt-df.pl:123
25459 #: ../tools/virt-ls.pl:120 ../tools/virt-list-filesystems.pl:92
25460 #: ../tools/virt-tar.pl:140 ../tools/virt-rescue.pl:153
25461 #: ../tools/virt-list-partitions.pl:93
25463 "If disk images are requested from libvirt, then this program asks libvirt "
25464 "for this information. In this case, the value of the format parameter is "
25469 #: ../inspector/virt-inspector.pl:115 ../tools/virt-edit.pl:134
25470 #: ../tools/virt-win-reg.pl:225 ../tools/virt-df.pl:127
25471 #: ../tools/virt-ls.pl:124 ../tools/virt-resize.pl:528
25472 #: ../tools/virt-resize.pl:543 ../tools/virt-list-filesystems.pl:96
25473 #: ../tools/virt-tar.pl:144 ../tools/virt-rescue.pl:157
25474 #: ../tools/virt-list-partitions.pl:97
25476 "If working with untrusted raw-format guest disk images, you should ensure "
25477 "the format is always specified."
25481 #: ../inspector/virt-inspector.pl:149
25486 #: ../inspector/virt-inspector.pl:151
25488 "The virt-inspector XML is described precisely in a RELAX NG schema which is "
25489 "supplied with libguestfs. This section is just an overview."
25493 #: ../inspector/virt-inspector.pl:154
25495 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
25496 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
25497 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
25498 "which is vanishingly rare in real world VMs."
25502 #: ../inspector/virt-inspector.pl:159
25503 msgid "E<lt>operatingsystemE<gt>"
25507 #: ../inspector/virt-inspector.pl:161
25509 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
25510 "describe the operating system, its architecture, the descriptive \"product "
25511 "name\" string, the type of OS and so on, as in this example:"
25515 #: ../inspector/virt-inspector.pl:165
25518 " <operatingsystems>\n"
25519 " <operatingsystem>\n"
25520 " <root>/dev/sda2</root>\n"
25521 " <name>windows</name>\n"
25522 " <arch>i386</arch>\n"
25523 " <distro>windows</distro>\n"
25524 " <product_name>Windows 7 Enterprise</product_name>\n"
25525 " <major_version>6</major_version>\n"
25526 " <minor_version>1</minor_version>\n"
25527 " <windows_systemroot>/Windows</windows_systemroot>\n"
25532 #: ../inspector/virt-inspector.pl:176
25534 "These fields are derived from the libguestfs inspection API, and you can "
25535 "find more details in L<guestfs(3)/INSPECTION>."
25539 #: ../inspector/virt-inspector.pl:179
25541 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
25542 "of view of libguestfs (block devices may have completely different names "
25543 "inside the VM itself)."
25547 #: ../inspector/virt-inspector.pl:240
25548 msgid "E<lt>mountpointsE<gt>"
25552 #: ../inspector/virt-inspector.pl:242
25554 "Un*x-like guests typically have multiple filesystems which are mounted at "
25555 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
25556 "element which looks like this:"
25560 #: ../inspector/virt-inspector.pl:246
25563 " <operatingsystems>\n"
25564 " <operatingsystem>\n"
25567 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
25568 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
25569 " </mountpoints>\n"
25574 #: ../inspector/virt-inspector.pl:254
25576 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
25577 "and may have completely different names inside the guest. Only mountable "
25578 "filesystems appear in this list, not things like swap devices."
25582 #: ../inspector/virt-inspector.pl:276
25583 msgid "E<lt>filesystemsE<gt>"
25587 #: ../inspector/virt-inspector.pl:278
25589 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
25590 "filesystems belonging to the guest, including swap and empty partitions. "
25591 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
25592 "this OS or shared by this OS and other OSes)."
25596 #: ../inspector/virt-inspector.pl:283
25597 msgid "You might see something like this:"
25601 #: ../inspector/virt-inspector.pl:285
25604 " <operatingsystems>\n"
25605 " <operatingsystem>\n"
25608 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
25609 " <type>ext4</type>\n"
25610 " <label>Fedora-13-x86_64</label>\n"
25611 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
25617 #: ../inspector/virt-inspector.pl:295
25619 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
25620 "the label, and the UUID."
25624 #: ../inspector/virt-inspector.pl:337
25625 msgid "E<lt>applicationsE<gt>"
25629 #: ../inspector/virt-inspector.pl:339
25631 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
25632 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
25633 "machine. At the moment we are only able to list RPMs and Debian packages "
25634 "installed, but in future we will support other Linux distros and Windows."
25638 #: ../inspector/virt-inspector.pl:345
25640 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
25641 "Typical values would be C<rpm> and C<deb>."
25645 #: ../inspector/virt-inspector.pl:348
25647 "E<lt>package_managementE<gt>, if present, describes the package manager. "
25648 "Typical values include C<yum>, C<up2date> and C<apt>"
25652 #: ../inspector/virt-inspector.pl:351
25653 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
25657 #: ../inspector/virt-inspector.pl:354
25660 " <operatingsystems>\n"
25661 " <operatingsystem>\n"
25663 " <applications>\n"
25665 " <name>coreutils</name>\n"
25666 " <version>8.5</version>\n"
25667 " <release>1</release>\n"
25668 " </application>\n"
25673 #: ../inspector/virt-inspector.pl:364
25675 "(The version and release fields may not be available for some package types)."
25679 #: ../inspector/virt-inspector.pl:544
25680 msgid "USING XPATH"
25684 #: ../inspector/virt-inspector.pl:546
25686 "You can use the XPath query language, and/or the xpath tool, in order to "
25687 "select parts of the XML."
25691 #: ../inspector/virt-inspector.pl:551
25694 " $ virt-inspector Guest | xpath //filesystems\n"
25695 " Found 1 nodes:\n"
25698 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
25699 " <type>ext4</type>\n"
25705 #: ../inspector/virt-inspector.pl:559
25708 " $ virt-inspector Guest | \\\n"
25709 " xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
25710 " Query didn't return a nodeset. Value: ext4\n"
25715 #: ../inspector/virt-inspector.pl:563 ../tools/virt-edit.pl:343
25716 #: ../tools/virt-win-reg.pl:141 ../tools/virt-win-reg.pl:477
25717 #: ../tools/virt-df.pl:633 ../tools/virt-ls.pl:225
25718 #: ../tools/virt-resize.pl:1479 ../tools/virt-list-filesystems.pl:179
25719 #: ../tools/virt-tar.pl:274 ../tools/virt-rescue.pl:260
25720 #: ../tools/virt-make-fs.pl:527 ../tools/virt-list-partitions.pl:247
25721 msgid "SHELL QUOTING"
25725 #: ../inspector/virt-inspector.pl:565 ../tools/virt-edit.pl:345
25726 #: ../tools/virt-win-reg.pl:479 ../tools/virt-df.pl:635
25727 #: ../tools/virt-ls.pl:227 ../tools/virt-resize.pl:1481
25728 #: ../tools/virt-list-filesystems.pl:181 ../tools/virt-tar.pl:276
25729 #: ../tools/virt-rescue.pl:262 ../tools/virt-make-fs.pl:529
25730 #: ../tools/virt-list-partitions.pl:249
25732 "Libvirt guest names can contain arbitrary characters, some of which have "
25733 "meaning to the shell such as C<#> and space. You may need to quote or "
25734 "escape these characters on the command line. See the shell manual page L<sh"
25735 "(1)> for details."
25739 #: ../inspector/virt-inspector.pl:572
25741 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
25742 "L<Sys::Virt(3)>, L<http://www.w3.org/TR/xpath/>, L<http://libguestfs.org/>."
25746 #: ../inspector/virt-inspector.pl:586 ../tools/virt-edit.pl:364
25747 #: ../tools/virt-win-reg.pl:512 ../tools/virt-df.pl:651
25748 #: ../tools/virt-ls.pl:245 ../tools/virt-resize.pl:1510
25749 #: ../tools/virt-list-filesystems.pl:200 ../tools/virt-tar.pl:294
25750 #: ../tools/virt-rescue.pl:279 ../tools/virt-make-fs.pl:561
25751 #: ../tools/virt-list-partitions.pl:267
25752 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
25756 #: ../inspector/virt-inspector.pl:590
25757 msgid "Matthew Booth L<mbooth@redhat.com>"
25761 #: ../inspector/virt-inspector.pl:596 ../tools/virt-win-reg.pl:516
25762 #: ../tools/virt-resize.pl:1514 ../tools/virt-make-fs.pl:565
25763 msgid "Copyright (C) 2010 Red Hat Inc."
25767 #: ../tools/virt-edit.pl:34
25768 msgid "virt-edit - Edit a file in a virtual machine"
25772 #: ../tools/virt-edit.pl:38
25775 " virt-edit [--options] domname file\n"
25780 #: ../tools/virt-edit.pl:40
25783 " virt-edit [--options] disk.img [disk.img ...] file\n"
25788 #: ../tools/virt-edit.pl:42
25791 " virt-edit [domname|disk.img] file -e 'expr'\n"
25796 #: ../tools/virt-edit.pl:46
25798 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
25799 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
25800 "doing this, but doesn't catch all cases."
25804 #: ../tools/virt-edit.pl:52
25806 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
25807 "the named virtual machine (or disk image)."
25811 #: ../tools/virt-edit.pl:55
25813 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
25814 "you should look at the L<guestfish(1)> tool."
25818 #: ../tools/virt-edit.pl:60
25819 msgid "Edit the named files interactively:"
25823 #: ../tools/virt-edit.pl:62
25826 " virt-edit mydomain /boot/grub/grub.conf\n"
25831 #: ../tools/virt-edit.pl:64
25834 " virt-edit mydomain /etc/passwd\n"
25839 #: ../tools/virt-edit.pl:66
25841 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
25842 "below). To change the init default level to 5:"
25846 #: ../tools/virt-edit.pl:70
25849 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
25854 #: ../tools/virt-edit.pl:96
25855 msgid "B<--backup extension> | B<-b extension>"
25859 #: ../tools/virt-edit.pl:98
25861 "Create a backup of the original file I<in the guest disk image>. The backup "
25862 "has the original filename with C<extension> added."
25866 #: ../tools/virt-edit.pl:101
25868 "Usually the first character of C<extension> would be a dot C<.> so you would "
25873 #: ../tools/virt-edit.pl:104
25876 " virt-edit -b .orig [etc]\n"
25881 #: ../tools/virt-edit.pl:106
25882 msgid "By default, no backup file is made."
25886 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:208
25887 #: ../tools/virt-df.pl:100 ../tools/virt-ls.pl:107
25888 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:127
25889 #: ../tools/virt-rescue.pl:140 ../tools/virt-list-partitions.pl:80
25891 "If you specify guest block devices directly, then libvirt is not used at all."
25895 #: ../tools/virt-edit.pl:141
25896 msgid "B<--expr EXPR> | B<-e EXPR>"
25900 #: ../tools/virt-edit.pl:143
25902 "Instead of launching the external editor, non-interactively apply the Perl "
25903 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
25908 #: ../tools/virt-edit.pl:147
25910 "Be careful to properly quote the expression to prevent it from being altered "
25915 #: ../tools/virt-edit.pl:268
25916 msgid "NON-INTERACTIVE EDITING"
25920 #: ../tools/virt-edit.pl:270
25922 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
25923 "administrator can interactively edit the file."
25927 #: ../tools/virt-edit.pl:273
25929 "There are two ways also to use C<virt-edit> from scripts in order to make "
25930 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
25931 "like this, it's less error-prone to write scripts directly using the "
25932 "libguestfs API and Augeas for configuration file editing.)"
25936 #: ../tools/virt-edit.pl:279
25938 "The first method is to temporarily set C<$EDITOR> to any script or program "
25939 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
25940 "update C<tmpfile> in place however it likes."
25944 #: ../tools/virt-edit.pl:283
25946 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
25947 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
25948 "instances of C<foo> with C<bar> in a file:"
25952 #: ../tools/virt-edit.pl:287
25955 " virt-edit domname filename -e 's/foo/bar/'\n"
25960 #: ../tools/virt-edit.pl:289
25962 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
25963 "For example to delete root's password you could do:"
25967 #: ../tools/virt-edit.pl:292
25970 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
25975 #: ../tools/virt-edit.pl:294
25977 "What really happens is that the snippet is evaluated as a Perl expression "
25978 "for each line of the file. The line, including the final C<\\n>, is passed "
25979 "in C<$_> and the expression should update C<$_> or leave it unchanged."
25983 #: ../tools/virt-edit.pl:299
25985 "To delete a line, set C<$_> to the empty string. For example, to delete the "
25986 "C<apache> user account from the password file you can do:"
25990 #: ../tools/virt-edit.pl:302
25993 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
25998 #: ../tools/virt-edit.pl:304
26000 "To insert a line, prepend or append it to C<$_>. However appending lines to "
26001 "the end of the file is rather difficult this way since there is no concept "
26002 "of \"last line of the file\" - your expression just doesn't get called "
26003 "again. You might want to use the first method (setting C<$EDITOR>) if you "
26008 #: ../tools/virt-edit.pl:310
26010 "The variable C<$lineno> contains the current line number. As is "
26011 "traditional, the first line in the file is number C<1>."
26015 #: ../tools/virt-edit.pl:313
26017 "The return value from the expression is ignored, but the expression may call "
26018 "C<die> in order to abort the whole program, leaving the original file "
26023 #: ../tools/virt-edit.pl:317
26025 "Remember when matching the end of a line that C<$_> may contain the final C<"
26026 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
26027 "newline then neither of these. Thus to match or substitute some text at the "
26028 "end of a line, use this regular expression:"
26032 #: ../tools/virt-edit.pl:322
26035 " /some text(\\r?\\n)?$/\n"
26040 #: ../tools/virt-edit.pl:324
26042 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
26043 "$_> itself (since that would remove all newlines from the file):"
26047 #: ../tools/virt-edit.pl:328
26050 " my $m = $_; chomp $m; $m =~ /some text$/\n"
26055 #: ../tools/virt-edit.pl:334
26060 #: ../tools/virt-edit.pl:336
26062 "If set, this string is used as the editor. It may contain arguments, eg. C<"
26067 #: ../tools/virt-edit.pl:339
26068 msgid "If not set, C<vi> is used."
26072 #: ../tools/virt-edit.pl:352
26074 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
26075 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, "
26080 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:510
26081 #: ../tools/virt-df.pl:649 ../tools/virt-ls.pl:243
26082 #: ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:198
26083 #: ../tools/virt-tar.pl:292 ../tools/virt-rescue.pl:277
26084 #: ../tools/virt-make-fs.pl:559 ../tools/virt-list-partitions.pl:265
26089 #: ../tools/virt-edit.pl:368 ../tools/virt-df.pl:655
26090 #: ../tools/virt-rescue.pl:283 ../tools/virt-list-partitions.pl:271
26091 msgid "Copyright (C) 2009-2010 Red Hat Inc."
26095 #: ../tools/virt-win-reg.pl:37
26097 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
26101 #: ../tools/virt-win-reg.pl:41
26104 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
26109 #: ../tools/virt-win-reg.pl:43
26112 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
26117 #: ../tools/virt-win-reg.pl:45
26120 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
26125 #: ../tools/virt-win-reg.pl:47
26128 " virt-win-reg --merge domname [input.reg ...]\n"
26133 #: ../tools/virt-win-reg.pl:49
26136 " virt-win-reg [--options] disk.img ... # instead of domname\n"
26141 #: ../tools/virt-win-reg.pl:53
26143 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
26144 "virtual machines. If you do this, you I<will> get irreversible disk "
26145 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
26146 "but doesn't catch all cases."
26150 #: ../tools/virt-win-reg.pl:58
26152 "Modifying the Windows Registry is an inherently risky operation. The format "
26153 "is deliberately obscure and undocumented, and Registry changes can leave the "
26154 "system unbootable. Therefore when using the C<--merge> option, make sure "
26155 "you have a reliable backup first."
26159 #: ../tools/virt-win-reg.pl:65
26161 "This program can export and merge Windows Registry entries from a Windows "
26166 #: ../tools/virt-win-reg.pl:68
26168 "The first parameter is the libvirt guest name or the raw disk image of a "
26173 #: ../tools/virt-win-reg.pl:71
26175 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
26176 "exported (recursively). For example:"
26180 #: ../tools/virt-win-reg.pl:74
26183 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
26188 #: ../tools/virt-win-reg.pl:76
26190 "You can also display single values from within registry keys, for example:"
26194 #: ../tools/virt-win-reg.pl:79
26197 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
26198 " $ virt-win-reg Windows7 $cvkey ProductName\n"
26199 " Windows 7 Enterprise\n"
26204 #: ../tools/virt-win-reg.pl:83
26206 "With C<--merge>, you can merge a textual regedit file into the Windows "
26211 #: ../tools/virt-win-reg.pl:86
26214 " $ virt-win-reg --merge Windows7 changes.reg\n"
26219 #: ../tools/virt-win-reg.pl:88
26220 msgid "SUPPORTED SYSTEMS"
26224 #: ../tools/virt-win-reg.pl:90
26226 "The program currently supports Windows NT-derived guests starting with "
26227 "Windows XP through to at least Windows 7."
26231 #: ../tools/virt-win-reg.pl:93
26233 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
26234 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
26235 "and C<HKEY_USERS\\.DEFAULT>."
26239 #: ../tools/virt-win-reg.pl:97
26241 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
26246 #: ../tools/virt-win-reg.pl:100
26248 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
26253 #: ../tools/virt-win-reg.pl:103
26258 #: ../tools/virt-win-reg.pl:105
26260 "This program is only meant for simple access to the registry. If you want "
26261 "to do complicated things with the registry, we suggest you download the "
26262 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
26263 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
26264 "L<hivexregedit(1)>."
26268 #: ../tools/virt-win-reg.pl:111
26273 #: ../tools/virt-win-reg.pl:113
26275 "C<virt-win-reg> expects that regedit files have already been reencoded in "
26276 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
26277 "style line endings. Since Windows regedit files are often in UTF-16LE with "
26278 "Windows-style line endings, you may need to reencode the whole file before "
26279 "or after processing."
26283 #: ../tools/virt-win-reg.pl:119
26285 "To reencode a file from Windows format to Linux (before processing it with "
26286 "the C<--merge> option), you would do something like this:"
26290 #: ../tools/virt-win-reg.pl:122
26293 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
26298 #: ../tools/virt-win-reg.pl:124
26300 "To go in the opposite direction, after exporting and before sending the file "
26301 "to a Windows user, do something like this:"
26305 #: ../tools/virt-win-reg.pl:127
26308 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
26313 #: ../tools/virt-win-reg.pl:129
26314 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
26318 #: ../tools/virt-win-reg.pl:131
26320 "If you are unsure about the current encoding, use the L<file(1)> command. "
26321 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
26322 "style (CRLF) line endings, like this:"
26326 #: ../tools/virt-win-reg.pl:135
26329 " $ file software.reg\n"
26330 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
26331 " with CRLF line terminators\n"
26336 #: ../tools/virt-win-reg.pl:139
26337 msgid "This file would need conversion before you could C<--merge> it."
26341 #: ../tools/virt-win-reg.pl:143
26343 "Be careful when passing parameters containing C<\\> (backslash) in the "
26344 "shell. Usually you will have to use 'single quotes' or double backslashes "
26345 "(but not both) to protect them from the shell."
26349 #: ../tools/virt-win-reg.pl:147
26350 msgid "Paths and value names are case-insensitive."
26354 #: ../tools/virt-win-reg.pl:149
26355 msgid "CurrentControlSet etc."
26359 #: ../tools/virt-win-reg.pl:151
26361 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
26362 "Registry at the level of the hive file, and therefore you cannot modify "
26367 #: ../tools/virt-win-reg.pl:155
26369 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
26370 "circumstances it might refer to another control set. The way to find out is "
26371 "to look at the C<HKLM\\SYSTEM\\Select> key:"
26375 #: ../tools/virt-win-reg.pl:159
26378 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
26379 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
26380 " \"Current\"=dword:00000001\n"
26381 " \"Default\"=dword:00000001\n"
26382 " \"Failed\"=dword:00000000\n"
26383 " \"LastKnownGood\"=dword:00000002\n"
26388 #: ../tools/virt-win-reg.pl:166
26389 msgid "\"Current\" is the one which Windows will choose when it boots."
26393 #: ../tools/virt-win-reg.pl:168
26395 "Similarly, other C<Current...> keys in the path may need to be replaced."
26399 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
26404 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:501
26405 msgid "Enable debugging messages."
26409 #: ../tools/virt-win-reg.pl:232
26414 #: ../tools/virt-win-reg.pl:234
26416 "In merge mode, this merges a textual regedit file into the Windows Registry "
26417 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
26418 "displays or exports Registry entries instead."
26422 #: ../tools/virt-win-reg.pl:238
26424 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
26425 "result in disk corruption. However exporting (without this flag) is always "
26430 #: ../tools/virt-win-reg.pl:246
26431 msgid "B<--encoding> UTF-16LE|ASCII"
26435 #: ../tools/virt-win-reg.pl:248
26437 "When merging (only), you may need to specify the encoding for strings to be "
26438 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
26439 "(3)/ENCODING STRINGS>."
26443 #: ../tools/virt-win-reg.pl:252
26445 "The default is to use UTF-16LE, which should work with recent versions of "
26450 #: ../tools/virt-win-reg.pl:486
26452 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
26453 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
26454 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26458 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
26460 "When reporting bugs, please enable debugging and capture the I<complete> "
26465 #: ../tools/virt-win-reg.pl:504
26468 " export LIBGUESTFS_DEBUG=1\n"
26469 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
26474 #: ../tools/virt-win-reg.pl:507
26476 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
26481 #: ../tools/virt-df.pl:36
26482 msgid "virt-df - Display free space on virtual filesystems"
26486 #: ../tools/virt-df.pl:40
26489 " virt-df [--options]\n"
26494 #: ../tools/virt-df.pl:42
26497 " virt-df [--options] domname\n"
26502 #: ../tools/virt-df.pl:44
26505 " virt-df [--options] disk.img [disk.img ...]\n"
26510 #: ../tools/virt-df.pl:48
26512 "C<virt-df> is a command line tool to display free space on virtual machine "
26513 "filesystems. Unlike other tools, it doesn't just display the amount of "
26514 "space allocated to a virtual machine, but can look inside the virtual "
26515 "machine to see how much space is really being used."
26519 #: ../tools/virt-df.pl:53
26521 "It is like the L<df(1)> command, but for virtual machines, except that it "
26522 "also works for Windows virtual machines."
26526 #: ../tools/virt-df.pl:56
26528 "If used without any arguments, C<virt-df> checks with libvirt to get a list "
26529 "of all active and inactive guests, and performs a C<df>-type operation on "
26530 "each one in turn, printing out the results."
26534 #: ../tools/virt-df.pl:60
26536 "If used with any argument(s), C<virt-df> performs a C<df>-type operation on "
26537 "either the single named libvirt domain, or on the disk image(s) listed on "
26538 "the command line (which must all belong to a single VM). In this mode (with "
26539 "arguments), C<virt-df> will I<only work for a single guest>. If you want to "
26540 "run on multiple guests, then you have to invoke C<virt-df> multiple times."
26544 #: ../tools/virt-df.pl:67
26546 "Use the C<--csv> option to get a format which can be easily parsed by other "
26547 "programs. Other options are mostly similar to standard C<df> options. See "
26548 "below for the complete list."
26552 #: ../tools/virt-df.pl:107
26557 #: ../tools/virt-df.pl:109
26559 "Write out the results in CSV format (comma-separated values). This format "
26560 "can be imported easily into databases and spreadsheets, but read L</NOTE "
26561 "ABOUT CSV FORMAT> below."
26565 #: ../tools/virt-df.pl:134
26566 msgid "B<--human-readable> | B<-h>"
26570 #: ../tools/virt-df.pl:136
26571 msgid "Print sizes in human-readable format."
26575 #: ../tools/virt-df.pl:138
26576 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
26580 #: ../tools/virt-df.pl:144
26581 msgid "B<--inodes> | B<-i>"
26585 #: ../tools/virt-df.pl:146
26586 msgid "Print inodes instead of blocks."
26590 #: ../tools/virt-df.pl:152
26591 msgid "B<--one-per-guest>"
26595 #: ../tools/virt-df.pl:154
26597 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
26598 "disks from several guests to a single libguestfs appliance."
26602 #: ../tools/virt-df.pl:157
26603 msgid "You might use this option in the following circumstances:"
26607 #: ../tools/virt-df.pl:163
26609 "If you think an untrusted guest might actively try to exploit the libguestfs "
26610 "appliance kernel, then this prevents one guest from interfering with the "
26611 "stats printed for another guest."
26615 #: ../tools/virt-df.pl:169
26617 "If the kernel has a bug which stops it from accessing a filesystem in one "
26618 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
26619 "and report stats for further guests."
26623 #: ../tools/virt-df.pl:180
26628 #: ../tools/virt-df.pl:182
26630 "Print UUIDs instead of names. This is useful for following a guest even "
26631 "when the guest is migrated or renamed, or when two guests happen to have the "
26636 #: ../tools/virt-df.pl:186
26638 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
26639 "images, we still print the disk image name even when this option is "
26644 #: ../tools/virt-df.pl:609
26645 msgid "NOTE ABOUT CSV FORMAT"
26649 #: ../tools/virt-df.pl:611
26651 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
26652 "should be easy to parse, but it is definitely not easy to parse."
26656 #: ../tools/virt-df.pl:614
26658 "Myth: Just split fields at commas. Reality: This does I<not> work "
26659 "reliably. This example has two columns:"
26663 #: ../tools/virt-df.pl:617
26666 " \"foo,bar\",baz\n"
26671 #: ../tools/virt-df.pl:619
26673 "Myth: Read the file one line at a time. Reality: This does I<not> work "
26674 "reliably. This example has one row:"
26678 #: ../tools/virt-df.pl:622
26687 #: ../tools/virt-df.pl:625
26689 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
26690 "packaged in major Linux distributions)."
26694 #: ../tools/virt-df.pl:628
26696 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
26697 "or Python's built-in csv library)."
26701 #: ../tools/virt-df.pl:631
26702 msgid "Most spreadsheets and databases can import CSV directly."
26706 #: ../tools/virt-df.pl:642
26708 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
26709 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26713 #: ../tools/virt-ls.pl:34
26714 msgid "virt-ls - List files in a virtual machine"
26718 #: ../tools/virt-ls.pl:38
26721 " virt-ls [--options] domname directory\n"
26726 #: ../tools/virt-ls.pl:40
26729 " virt-ls [--options] disk.img [disk.img ...] directory\n"
26734 #: ../tools/virt-ls.pl:44
26736 "C<virt-ls> is a command line tool to list the names of files in a directory "
26737 "inside a virtual machine or disk image."
26741 #: ../tools/virt-ls.pl:47
26743 "C<virt-ls> is just a simple wrapper around L<libguestfs(3)> functionality. "
26744 "For more complex cases you should look at the L<guestfish(1)> tool."
26748 #: ../tools/virt-ls.pl:51
26750 "C<virt-ls> can be used in one of three modes: simple, long and recursive. A "
26751 "simple listing is like the ordinary L<ls(1)> command:"
26755 #: ../tools/virt-ls.pl:54
26758 " $ virt-ls myguest /\n"
26766 #: ../tools/virt-ls.pl:59
26767 msgid "With the C<-l> (C<--long>) option, C<virt-ls> shows more detail:"
26771 #: ../tools/virt-ls.pl:61
26774 " $ virt-ls -l myguest /\n"
26776 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
26777 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
26783 #: ../tools/virt-ls.pl:67
26785 "With the C<-R> (C<--recursive>) option, C<virt-ls> lists the names of files "
26786 "and directories recursively:"
26790 #: ../tools/virt-ls.pl:70
26793 " $ virt-ls -R myguest /tmp\n"
26801 #: ../tools/virt-ls.pl:75
26803 "You I<cannot> combine these options. To do more complicated things, use "
26808 #: ../tools/virt-ls.pl:131 ../tools/virt-list-filesystems.pl:103
26809 #: ../tools/virt-list-partitions.pl:112
26810 msgid "B<-l> | B<--long>"
26814 #: ../tools/virt-ls.pl:133
26815 msgid "B<-R> | B<--recursive>"
26819 #: ../tools/virt-ls.pl:135
26821 "Select the mode. With neither of these options, C<virt-ls> produces a "
26822 "simple, flat list of the files in the named directory."
26826 #: ../tools/virt-ls.pl:138
26828 "C<virt-ls -l> produces a \"long listing\", which shows more detail (just "
26829 "like the plain C<ls -l> command)."
26833 #: ../tools/virt-ls.pl:141
26835 "C<virt-ls -R> produces a recursive list of files starting at the named "
26836 "directory. See the documentation for L<guestfs(3)/guestfs_find> for precise "
26841 #: ../tools/virt-ls.pl:145
26842 msgid "You cannot combine these options."
26846 #: ../tools/virt-ls.pl:234
26848 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<Sys::"
26849 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
26854 #: ../tools/virt-ls.pl:249 ../tools/virt-list-filesystems.pl:204
26855 #: ../tools/virt-tar.pl:298
26856 msgid "Copyright (C) 2009 Red Hat Inc."
26860 #: ../tools/virt-resize.pl:42
26861 msgid "virt-resize - Resize a virtual machine disk"
26865 #: ../tools/virt-resize.pl:46
26868 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
26869 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
26870 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
26875 #: ../tools/virt-resize.pl:52
26877 "Virt-resize is a tool which can resize a virtual machine disk, making it "
26878 "larger or smaller overall, and resizing or deleting any partitions contained "
26883 #: ../tools/virt-resize.pl:56
26885 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
26886 "not> be used on live virtual machines - for consistent results, shut the "
26887 "virtual machine down before resizing it."
26891 #: ../tools/virt-resize.pl:60
26893 "If you are not familiar with the associated tools: L<virt-list-partitions(1)"
26894 ">, L<virt-list-filesystems(1)> and L<virt-df(1)>, we recommend you go and "
26895 "read those manual pages first."
26899 #: ../tools/virt-resize.pl:68
26901 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
26902 "fill the extra 5GB of space."
26906 #: ../tools/virt-resize.pl:71
26909 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
26910 " virt-list-partitions -lht olddisk\n"
26911 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
26912 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
26917 #: ../tools/virt-resize.pl:76
26919 "As above, but make the /boot partition 200MB bigger, while giving the "
26920 "remaining space to /dev/sda2:"
26924 #: ../tools/virt-resize.pl:79
26927 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
26932 #: ../tools/virt-resize.pl:81
26933 msgid "As above, but the output format will be uncompressed qcow2:"
26937 #: ../tools/virt-resize.pl:83
26940 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
26941 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
26946 #: ../tools/virt-resize.pl:86
26947 msgid "DETAILED USAGE"
26951 #: ../tools/virt-resize.pl:88
26952 msgid "EXPANDING A VIRTUAL MACHINE DISK"
26956 #: ../tools/virt-resize.pl:92
26957 msgid "1. Shut down the virtual machine"
26961 #: ../tools/virt-resize.pl:94
26962 msgid "2. Locate input disk image"
26966 #: ../tools/virt-resize.pl:96
26968 "Locate the input disk image (ie. the file or device on the host containing "
26969 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
26970 "dumpxml> like this to find the disk image name:"
26974 #: ../tools/virt-resize.pl:100
26977 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
26978 " Found 1 nodes:\n"
26980 " <source dev=\"/dev/vg/lv_guest\" />\n"
26985 #: ../tools/virt-resize.pl:105
26986 msgid "3. Look at current sizing"
26990 #: ../tools/virt-resize.pl:107
26992 "Use L<virt-list-partitions(1)> to display the current partitions and sizes:"
26996 #: ../tools/virt-resize.pl:110
26999 " # virt-list-partitions -lht /dev/vg/lv_guest\n"
27000 " /dev/sda1 ext3 101.9M\n"
27001 " /dev/sda2 pv 7.9G\n"
27002 " /dev/sda device 8.0G\n"
27007 #: ../tools/virt-resize.pl:115
27009 "(This example is a virtual machine with an 8 GB disk which we would like to "
27010 "expand up to 10 GB)."
27014 #: ../tools/virt-resize.pl:118
27015 msgid "4. Create output disk"
27019 #: ../tools/virt-resize.pl:120
27021 "Virt-resize cannot do in-place disk modifications. You have to have space "
27022 "to store the resized output disk."
27026 #: ../tools/virt-resize.pl:123
27028 "To store the resized disk image in a file, create a file of a suitable size:"
27032 #: ../tools/virt-resize.pl:126
27035 " # rm -f outdisk\n"
27036 " # truncate -s 10G outdisk\n"
27041 #: ../tools/virt-resize.pl:129
27042 msgid "Or use L<lvcreate(1)> to create a logical volume:"
27046 #: ../tools/virt-resize.pl:131
27049 " # lvcreate -L 10G -n lv_name vg_name\n"
27054 #: ../tools/virt-resize.pl:133
27055 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
27059 #: ../tools/virt-resize.pl:135
27062 " # virsh pool-list\n"
27063 " # virsh vol-create-as poolname newvol 10G\n"
27068 #: ../tools/virt-resize.pl:138
27073 #: ../tools/virt-resize.pl:140
27075 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
27076 "file) and the output disk. The output disk is the one created in the "
27081 #: ../tools/virt-resize.pl:144
27084 " # virt-resize indisk outdisk\n"
27089 #: ../tools/virt-resize.pl:146
27091 "This command just copies disk image C<indisk> to disk image C<outdisk> "
27092 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
27093 "larger, then an extra, empty partition is created at the end of the disk "
27094 "covering the extra space. If C<outdisk> is smaller, then it will give an "
27099 #: ../tools/virt-resize.pl:152
27101 "More realistically you'd want to expand existing partitions in the disk "
27102 "image by passing extra options (for the full list see the L</OPTIONS> "
27107 #: ../tools/virt-resize.pl:156
27109 "L</--expand> is the most useful option. It expands the named partition "
27110 "within the disk to fill any extra space:"
27114 #: ../tools/virt-resize.pl:159
27117 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
27122 #: ../tools/virt-resize.pl:161
27124 "(In this case, an extra partition is I<not> created at the end of the disk, "
27125 "because there will be no unused space)."
27129 #: ../tools/virt-resize.pl:164
27131 "L</--resize> is the other commonly used option. The following would "
27132 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
27133 "rest of the available space:"
27137 #: ../tools/virt-resize.pl:168
27140 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
27141 " indisk outdisk\n"
27146 #: ../tools/virt-resize.pl:171
27148 "If the expanded partition in the image contains a filesystem or LVM PV, then "
27149 "if virt-resize knows how, it will resize the contents, the equivalent of "
27150 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
27151 ">. However virt-resize does not know how to resize some filesystems, so you "
27152 "would have to online resize them after booting the guest. And virt-resize "
27153 "also does not resize anything inside an LVM PV, it just resizes the PV "
27154 "itself and leaves the user to resize any LVs inside that PV as desired."
27158 #: ../tools/virt-resize.pl:180
27159 msgid "Other options are covered below."
27163 #: ../tools/virt-resize.pl:182
27168 #: ../tools/virt-resize.pl:184
27169 msgid "Thoroughly test the new disk image I<before> discarding the old one."
27173 #: ../tools/virt-resize.pl:186
27174 msgid "If you are using libvirt, edit the XML to point at the new disk:"
27178 #: ../tools/virt-resize.pl:188
27181 " # virsh edit guestname\n"
27186 #: ../tools/virt-resize.pl:190
27188 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
27189 "html#elementsDisks>"
27193 #: ../tools/virt-resize.pl:193
27194 msgid "Then start up the domain with the new, resized disk:"
27198 #: ../tools/virt-resize.pl:195
27201 " # virsh start guestname\n"
27206 #: ../tools/virt-resize.pl:197
27208 "and check that it still works. See also the L</NOTES> section below for "
27209 "additional information."
27213 #: ../tools/virt-resize.pl:200
27214 msgid "7. Resize LVs etc inside the guest"
27218 #: ../tools/virt-resize.pl:202
27219 msgid "(This can also be done offline using L<guestfish(1)>)"
27223 #: ../tools/virt-resize.pl:204
27225 "Once the guest has booted you should see the new space available, at least "
27226 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
27227 "may need to resize LVs inside PVs, and also resize filesystem types that "
27228 "virt-resize does not know how to expand."
27232 #: ../tools/virt-resize.pl:211
27233 msgid "SHRINKING A VIRTUAL MACHINE DISK"
27237 #: ../tools/virt-resize.pl:213
27239 "Shrinking is somewhat more complex than expanding, and only an overview is "
27244 #: ../tools/virt-resize.pl:216
27246 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
27247 "filesystems). The user has to shrink content before passing the disk image "
27248 "to virt-resize, and virt-resize will check that the content has been shrunk "
27253 #: ../tools/virt-resize.pl:221
27254 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
27258 #: ../tools/virt-resize.pl:223
27260 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
27261 "steps 3 and 4 above to allocate a new disk image."
27265 #: ../tools/virt-resize.pl:226
27267 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
27271 #: ../tools/virt-resize.pl:229
27272 msgid "IGNORING OR DELETING PARTITIONS"
27276 #: ../tools/virt-resize.pl:231
27278 "virt-resize also gives a convenient way to ignore or delete partitions when "
27279 "copying from the input disk to the output disk. Ignoring a partition speeds "
27280 "up the copy where you don't care about the existing contents of a "
27281 "partition. Deleting a partition removes it completely, but note that it "
27282 "also renumbers any partitions after the one which is deleted, which can "
27283 "leave some guests unbootable."
27287 #: ../tools/virt-resize.pl:238
27288 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
27292 #: ../tools/virt-resize.pl:240
27294 "If the input disk is in qcow2 format, then you may prefer that the output is "
27295 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
27296 "the fly. The output format is simply determined by the format of the empty "
27297 "output container that you provide. Thus to create qcow2 output, use:"
27301 #: ../tools/virt-resize.pl:246
27304 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
27309 #: ../tools/virt-resize.pl:248
27310 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
27314 #: ../tools/virt-resize.pl:250
27315 msgid "Similarly, to get non-sparse raw output use:"
27319 #: ../tools/virt-resize.pl:252
27322 " fallocate -l size outdisk\n"
27327 #: ../tools/virt-resize.pl:254
27329 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
27330 "dev/zero of=outdisk bs=1M count=..>)"
27334 #: ../tools/virt-resize.pl:267
27335 msgid "Display help."
27339 #: ../tools/virt-resize.pl:281
27340 msgid "B<--resize part=size>"
27344 #: ../tools/virt-resize.pl:283
27346 "Resize the named partition (expanding or shrinking it) so that it has the "
27351 #: ../tools/virt-resize.pl:286
27353 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
27354 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
27355 "Exabytes; or as a percentage of the current size; or as a relative number or "
27356 "percentage. For example:"
27360 #: ../tools/virt-resize.pl:291
27363 " --resize /dev/sda2=10G\n"
27368 #: ../tools/virt-resize.pl:293
27371 " --resize /dev/sda4=90%\n"
27376 #: ../tools/virt-resize.pl:295
27379 " --resize /dev/sda2=+1G\n"
27384 #: ../tools/virt-resize.pl:297
27387 " --resize /dev/sda2=-200M\n"
27392 #: ../tools/virt-resize.pl:299
27395 " --resize /dev/sda1=+128K\n"
27400 #: ../tools/virt-resize.pl:301
27403 " --resize /dev/sda1=+10%\n"
27408 #: ../tools/virt-resize.pl:303
27411 " --resize /dev/sda1=-10%\n"
27416 #: ../tools/virt-resize.pl:305
27418 "You can increase the size of any partition. Virt-resize will expand the "
27419 "direct content of the partition if it knows how (see C<--expand> below)."
27423 #: ../tools/virt-resize.pl:309
27425 "You can only I<decrease> the size of partitions that contain filesystems or "
27426 "PVs which have already been shrunk. Virt-resize will check this has been "
27427 "done before proceeding, or else will print an error (see also C<--resize-"
27432 #: ../tools/virt-resize.pl:314 ../tools/virt-resize.pl:406
27433 #: ../tools/virt-resize.pl:423
27434 msgid "You can give this option multiple times."
27438 #: ../tools/virt-resize.pl:320
27439 msgid "B<--resize-force part=size>"
27443 #: ../tools/virt-resize.pl:322
27445 "This is the same as C<--resize> except that it will let you decrease the "
27446 "size of any partition. Generally this means you will lose any data which "
27447 "was at the end of the partition you shrink, but you may not care about that "
27448 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
27449 "as a swap partition)."
27453 #: ../tools/virt-resize.pl:328
27454 msgid "See also the C<--ignore> option."
27458 #: ../tools/virt-resize.pl:334
27459 msgid "B<--expand part>"
27463 #: ../tools/virt-resize.pl:336
27465 "Expand the named partition so it uses up all extra space (space left over "
27466 "after any other resize changes that you request have been done)."
27470 #: ../tools/virt-resize.pl:339
27472 "If virt-resize knows how, it will expand the direct content of the "
27473 "partition. For example, if the partition is an LVM PV, it will expand the "
27474 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
27475 "content it doesn't know about alone."
27479 #: ../tools/virt-resize.pl:344
27480 msgid "Currently virt-resize can resize:"
27484 #: ../tools/virt-resize.pl:350
27486 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
27491 #: ../tools/virt-resize.pl:355
27493 "NTFS filesystems contained directly in a partition, if libguestfs was "
27494 "compiled with support for NTFS."
27498 #: ../tools/virt-resize.pl:358
27500 "The filesystem must have been shut down consistently last time it was used. "
27501 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
27502 "consistency check, so at the first boot after resizing Windows will check "
27507 #: ../tools/virt-resize.pl:365
27509 "LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
27510 "inside the PV. The user will have to resize LVs as desired."
27514 #: ../tools/virt-resize.pl:371 ../tools/virt-resize.pl:393
27515 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
27519 #: ../tools/virt-resize.pl:377
27520 msgid "B<--shrink part>"
27524 #: ../tools/virt-resize.pl:379
27526 "Shrink the named partition until the overall disk image fits in the "
27527 "destination. The named partition B<must> contain a filesystem or PV which "
27528 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
27529 "online tools). Virt-resize will check this and give an error if it has not "
27534 #: ../tools/virt-resize.pl:385
27536 "The amount by which the overall disk must be shrunk (after carrying out all "
27537 "other operations requested by the user) is called the \"deficit\". For "
27538 "example, a straight copy (assume no other operations) from a 5GB disk image "
27539 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
27540 "would give an error unless the user specified a partition to shrink and that "
27541 "partition had more than a gigabyte of free space."
27545 #: ../tools/virt-resize.pl:399
27546 msgid "B<--ignore part>"
27550 #: ../tools/virt-resize.pl:401
27552 "Ignore the named partition. Effectively this means the partition is "
27553 "allocated on the destination disk, but the content is not copied across from "
27554 "the source disk. The content of the partition will be blank (all zero "
27559 #: ../tools/virt-resize.pl:412
27560 msgid "B<--delete part>"
27564 #: ../tools/virt-resize.pl:414
27566 "Delete the named partition. It would be more accurate to describe this as "
27567 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
27568 "the original disk image is left intact."
27572 #: ../tools/virt-resize.pl:418
27574 "Note that when you delete a partition, then anything contained in the "
27575 "partition is also deleted. Furthermore, this causes any partitions that "
27576 "come after to be I<renumbered>, which can easily make your guest unbootable."
27580 #: ../tools/virt-resize.pl:429
27581 msgid "B<--LV-expand logvol>"
27585 #: ../tools/virt-resize.pl:431
27587 "This takes the logical volume and, as a final step, expands it to fill all "
27588 "the space available in its volume group. A typical usage, assuming a Linux "
27589 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
27590 "lv_root> would be:"
27594 #: ../tools/virt-resize.pl:436
27597 " virt-resize indisk outdisk \\\n"
27598 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
27603 #: ../tools/virt-resize.pl:439
27605 "This would first expand the partition (and PV), and then expand the root "
27606 "device to fill the extra space in the PV."
27610 #: ../tools/virt-resize.pl:442
27612 "The contents of the LV are also resized if virt-resize knows how to do "
27613 "that. You can stop virt-resize from trying to expand the content by using "
27614 "the option C<--no-expand-content>."
27618 #: ../tools/virt-resize.pl:446
27619 msgid "Use L<virt-list-filesystems(1)> to list the filesystems in the guest."
27623 #: ../tools/virt-resize.pl:449
27625 "You can give this option multiple times, I<but> it doesn't make sense to do "
27626 "this unless the logical volumes you specify are all in different volume "
27631 #: ../tools/virt-resize.pl:457
27632 msgid "B<--no-copy-boot-loader>"
27636 #: ../tools/virt-resize.pl:459
27638 "By default, virt-resize copies over some sectors at the start of the disk "
27639 "(up to the beginning of the first partition). Commonly these sectors "
27640 "contain the Master Boot Record (MBR) and the boot loader, and are required "
27641 "in order for the guest to boot correctly."
27645 #: ../tools/virt-resize.pl:464
27647 "If you specify this flag, then this initial copy is not done. You may need "
27648 "to reinstall the boot loader in this case."
27652 #: ../tools/virt-resize.pl:472
27653 msgid "B<--no-extra-partition>"
27657 #: ../tools/virt-resize.pl:474
27659 "By default, virt-resize creates an extra partition if there is any extra, "
27660 "unused space after all resizing has happened. Use this option to prevent "
27661 "the extra partition from being created. If you do this then the extra space "
27662 "will be inaccessible until you run fdisk, parted, or some other partitioning "
27663 "tool in the guest."
27667 #: ../tools/virt-resize.pl:480
27669 "Note that if the surplus space is smaller than 10 MB, no extra partition "
27674 #: ../tools/virt-resize.pl:487
27675 msgid "B<--no-expand-content>"
27679 #: ../tools/virt-resize.pl:489
27681 "By default, virt-resize will try to expand the direct contents of "
27682 "partitions, if it knows how (see C<--expand> option above)."
27686 #: ../tools/virt-resize.pl:492
27688 "If you give the C<--no-expand-content> option then virt-resize will not "
27693 #: ../tools/virt-resize.pl:499
27694 msgid "B<-d> | B<--debug>"
27698 #: ../tools/virt-resize.pl:507
27699 msgid "B<-n> | B<--dryrun>"
27703 #: ../tools/virt-resize.pl:509
27704 msgid "Print a summary of what would be done, but don't do anything."
27708 #: ../tools/virt-resize.pl:515
27709 msgid "B<-q> | B<--quiet>"
27713 #: ../tools/virt-resize.pl:517
27714 msgid "Don't print the summary."
27718 #: ../tools/virt-resize.pl:525
27720 "Specify the format of the input disk image. If this flag is not given then "
27721 "it is auto-detected from the image itself."
27725 #: ../tools/virt-resize.pl:531
27727 "Note that this option I<does not> affect the output format. See L</QCOW2 "
27728 "AND NON-SPARSE RAW FORMATS>."
27732 #: ../tools/virt-resize.pl:538
27733 msgid "B<--output-format> raw"
27737 #: ../tools/virt-resize.pl:540
27739 "Specify the format of the output disk image. If this flag is not given then "
27740 "it is auto-detected from the image itself."
27744 #: ../tools/virt-resize.pl:546
27746 "Note that you still need to create the output disk with the right format. "
27747 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
27751 #: ../tools/virt-resize.pl:1422 ../tools/virt-rescue.pl:90
27756 #: ../tools/virt-resize.pl:1424
27757 msgid "\"Partition 1 does not end on cylinder boundary.\""
27761 #: ../tools/virt-resize.pl:1426
27763 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
27764 "means the partitions will not be aligned to the ancient CHS geometry. "
27765 "However CHS geometry is meaningless for disks manufactured since the early "
27766 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
27767 "cylinders is not required by any modern operating system."
27771 #: ../tools/virt-resize.pl:1433
27772 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
27776 #: ../tools/virt-resize.pl:1435
27778 "In Windows Vista and later versions, Microsoft switched to using a separate "
27779 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
27780 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
27781 "the boot partition. Doing so seems to break the guest completely. However "
27782 "expanding the second partition (ie. C: drive) should work."
27786 #: ../tools/virt-resize.pl:1442
27788 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
27789 "NTFS partitions have been expanded. This is just a safety check and (unless "
27790 "it find errors) is nothing to worry about."
27794 #: ../tools/virt-resize.pl:1446
27795 msgid "GUEST BOOT STUCK AT \"GRUB\""
27799 #: ../tools/virt-resize.pl:1448
27801 "If a Linux guest does not boot after resizing, and the boot is stuck after "
27802 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
27803 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
27804 "although we think is to do with partition alignment."
27808 #: ../tools/virt-resize.pl:1453
27811 " guestfish -i -a newdisk\n"
27812 " ><fs> cat /boot/grub/device.map\n"
27813 " # check the contents of this file are sensible or\n"
27814 " # edit the file if necessary\n"
27815 " ><fs> grub-install / /dev/vda\n"
27821 #: ../tools/virt-resize.pl:1460
27823 "For more flexible guest reconfiguration, including if you need to specify "
27824 "other parameters to grub-install, use L<virt-rescue(1)>."
27828 #: ../tools/virt-resize.pl:1463
27829 msgid "ALTERNATIVE TOOLS"
27833 #: ../tools/virt-resize.pl:1465
27835 "There are several proprietary tools for resizing partitions. We won't "
27836 "mention any here."
27840 #: ../tools/virt-resize.pl:1468
27842 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
27843 "operations on disk images. They can resize and move partitions, but I don't "
27844 "think they can do anything with the contents, and they certainly don't "
27849 #: ../tools/virt-resize.pl:1473
27851 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
27852 "but at a much lower level. You will probably end up hand-calculating sector "
27853 "offsets, which is something that virt-resize was designed to avoid. If you "
27854 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
27859 #: ../tools/virt-resize.pl:1488
27861 "L<virt-list-partitions(1)>, L<virt-list-filesystems(1)>, L<virt-df(1)>, "
27862 "L<guestfs(3)>, L<guestfish(1)>, L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, "
27863 "L<resize2fs(8)>, L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)"
27864 ">, L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
27865 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
27869 #: ../tools/virt-list-filesystems.pl:32
27871 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
27875 #: ../tools/virt-list-filesystems.pl:36
27878 " virt-list-filesystems [--options] domname\n"
27883 #: ../tools/virt-list-filesystems.pl:38
27886 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
27891 #: ../tools/virt-list-filesystems.pl:42
27893 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
27894 "are contained in a virtual machine or disk image."
27898 #: ../tools/virt-list-filesystems.pl:46
27900 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
27901 "functionality. For more complex cases you should look at the L<guestfish(1)"
27906 #: ../tools/virt-list-filesystems.pl:105
27908 "With this option, C<virt-list-filesystems> displays the type of each "
27909 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
27913 #: ../tools/virt-list-filesystems.pl:112
27914 msgid "B<-a> | B<--all>"
27918 #: ../tools/virt-list-filesystems.pl:114
27920 "Normally we only show mountable filesystems. If this option is given then "
27921 "swap devices are shown too."
27925 #: ../tools/virt-list-filesystems.pl:188
27927 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-list-"
27928 "partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)"
27929 ">, L<http://libguestfs.org/>."
27933 #: ../tools/virt-tar.pl:33
27934 msgid "virt-tar - Extract or upload files to a virtual machine"
27938 #: ../tools/virt-tar.pl:37
27941 " virt-tar [--options] -x domname directory tarball\n"
27946 #: ../tools/virt-tar.pl:39
27949 " virt-tar [--options] -u domname tarball directory\n"
27954 #: ../tools/virt-tar.pl:41
27957 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
27962 #: ../tools/virt-tar.pl:43
27965 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
27970 #: ../tools/virt-tar.pl:47
27971 msgid "Download C</home> from the VM into a local tarball:"
27975 #: ../tools/virt-tar.pl:49
27978 " virt-tar -x domname /home home.tar\n"
27983 #: ../tools/virt-tar.pl:51
27986 " virt-tar -zx domname /home home.tar.gz\n"
27991 #: ../tools/virt-tar.pl:53
27992 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
27996 #: ../tools/virt-tar.pl:55
27999 " virt-tar -u domname uploadstuff.tar /tmp\n"
28004 #: ../tools/virt-tar.pl:57
28007 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
28012 #: ../tools/virt-tar.pl:61
28014 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
28015 "virtual machines. If you do this, you risk disk corruption in the VM. "
28016 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
28020 #: ../tools/virt-tar.pl:66
28022 "You can use C<-x> (extract) on live virtual machines, but you might get "
28023 "inconsistent results or errors if there is filesystem activity inside the "
28024 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
28025 "work, but the only way to guarantee consistent results is if the virtual "
28026 "machine is shut down."
28030 #: ../tools/virt-tar.pl:74
28032 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
28033 "parts of a guest filesystem. There are many possibilities: making backups, "
28034 "uploading data files, snooping on guest activity, fixing or customizing "
28039 #: ../tools/virt-tar.pl:79
28041 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
28042 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
28043 "should look at the L<guestfish(1)> tool."
28047 #: ../tools/virt-tar.pl:83
28049 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
28050 "its contents (recursively) from the virtual machine into a local tarball. "
28051 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
28052 "virtual machine. You cannot use these two options together."
28056 #: ../tools/virt-tar.pl:89
28058 "In addition, you may need to use the C<-z> (gZip) option to enable "
28059 "compression. When uploading, you have to specify C<-z> if the upload file "
28060 "is compressed because virt-tar won't detect this on its own."
28064 #: ../tools/virt-tar.pl:93
28066 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
28067 "example it cannot do PKZip files or bzip2 compression. If you want that "
28068 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
28069 "the L<libguestfs(3)> API)."
28073 #: ../tools/virt-tar.pl:151
28074 msgid "B<-x> | B<--extract> | B<--download>"
28078 #: ../tools/virt-tar.pl:153
28079 msgid "B<-u> | B<--upload>"
28083 #: ../tools/virt-tar.pl:155
28085 "Use C<-x> to extract (download) a directory from a virtual machine to a "
28090 #: ../tools/virt-tar.pl:158
28092 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
28093 "Please read the L</WARNING> section above before using this option."
28097 #: ../tools/virt-tar.pl:162
28098 msgid "You must specify exactly one of these options."
28102 #: ../tools/virt-tar.pl:168
28103 msgid "B<-z> | B<--gzip>"
28107 #: ../tools/virt-tar.pl:170
28108 msgid "Specify that the input or output tarball is gzip-compressed."
28112 #: ../tools/virt-tar.pl:283
28114 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<Sys::"
28115 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
28120 #: ../tools/virt-rescue.pl:33
28121 msgid "virt-rescue - Run a rescue shell on a virtual machine"
28125 #: ../tools/virt-rescue.pl:37
28128 " virt-rescue [--options] domname\n"
28133 #: ../tools/virt-rescue.pl:39
28136 " virt-rescue [--options] disk.img [disk.img ...]\n"
28141 #: ../tools/virt-rescue.pl:43
28143 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
28144 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
28145 "you from doing this, but doesn't catch all cases."
28149 #: ../tools/virt-rescue.pl:47
28151 "However if you use the I<--ro> (read only) option, then you can attach a "
28152 "shell to a live virtual machine. The results might be strange or "
28153 "inconsistent at times but you won't get disk corruption."
28157 #: ../tools/virt-rescue.pl:53
28159 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
28160 "need for a CD. virt-rescue gives you a rescue shell and some simple "
28161 "recovery tools which you can use to examine or rescue a virtual machine or "
28166 #: ../tools/virt-rescue.pl:58
28168 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
28169 "on disk image(s):"
28173 #: ../tools/virt-rescue.pl:61
28176 " virt-rescue GuestName\n"
28181 #: ../tools/virt-rescue.pl:63
28184 " virt-rescue --ro /path/to/disk.img\n"
28189 #: ../tools/virt-rescue.pl:65
28192 " virt-rescue /dev/sdc\n"
28197 #: ../tools/virt-rescue.pl:67
28198 msgid "For live VMs you I<must> use the --ro option."
28202 #: ../tools/virt-rescue.pl:69
28204 "When you run virt-rescue on a virtual machine or disk image, you are placed "
28205 "in an interactive bash shell where you can use many ordinary Linux "
28206 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
28207 "appliance. You must mount the virtual machine's filesystems by hand. There "
28208 "is an empty directory called C</sysroot> where you can mount filesystems."
28212 #: ../tools/virt-rescue.pl:76
28214 "In the example below, we list logical volumes, then choose one to mount "
28215 "under C</sysroot>:"
28219 #: ../tools/virt-rescue.pl:79
28223 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
28224 " lv_root vg_f11x64 -wi-a- 8.83G\n"
28225 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
28226 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
28227 " ><rescue> ls /sysroot\n"
28232 #: ../tools/virt-rescue.pl:86
28234 "If you don't know what filesystems are available on the virtual machine then "
28235 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
28239 #: ../tools/virt-rescue.pl:92
28241 "Virt-rescue can be used on I<any> disk image file or device, not just a "
28242 "virtual machine. For example you can use it on a blank file if you want to "
28243 "partition that file (although we would recommend using L<guestfish(1)> "
28244 "instead as it is more suitable for this purpose). You can even use virt-"
28245 "rescue on things like SD cards."
28249 #: ../tools/virt-rescue.pl:98
28251 "This tool is just designed for quick interactive hacking on a virtual "
28252 "machine. For more structured access to a virtual machine disk image, you "
28253 "should use L<guestfs(3)>. To get a structured shell that you can use to "
28254 "make scripted changes to guests, use L<guestfish(1)>."
28258 #: ../tools/virt-rescue.pl:127
28259 msgid "B<--append kernelopts>"
28263 #: ../tools/virt-rescue.pl:129
28264 msgid "Pass additional options to the rescue kernel."
28268 #: ../tools/virt-rescue.pl:164
28269 msgid "B<--memsize MB> | B<-m MB>"
28273 #: ../tools/virt-rescue.pl:166
28275 "Change the amount of memory allocated to the rescue system. The default is "
28276 "set by libguestfs and is small but adequate for running system tools. The "
28277 "occasional program might need more memory. The parameter is specified in "
28282 #: ../tools/virt-rescue.pl:175
28283 msgid "B<--network MB>"
28287 #: ../tools/virt-rescue.pl:177
28288 msgid "Enable QEMU user networking in the guest."
28292 #: ../tools/virt-rescue.pl:183
28293 msgid "B<--ro> | B<-r>"
28297 #: ../tools/virt-rescue.pl:185
28298 msgid "Open the image read-only."
28302 #: ../tools/virt-rescue.pl:197
28304 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
28305 "SELINUX> before using this option."
28309 #: ../tools/virt-rescue.pl:257
28311 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
28312 "ENVIRONMENT VARIABLES> for the complete list."
28316 #: ../tools/virt-rescue.pl:269
28318 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
28319 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
28323 #: ../tools/virt-make-fs.pl:37
28324 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
28328 #: ../tools/virt-make-fs.pl:41
28331 " virt-make-fs [--options] input.tar output.img\n"
28336 #: ../tools/virt-make-fs.pl:43
28339 " virt-make-fs [--options] input.tar.gz output.img\n"
28344 #: ../tools/virt-make-fs.pl:45
28347 " virt-make-fs [--options] directory output.img\n"
28352 #: ../tools/virt-make-fs.pl:49
28354 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
28355 "archive or some files in a directory. It is similar to tools like L<mkisofs"
28356 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
28357 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
28358 "you want to attach these filesystems to existing virtual machines (eg. to "
28359 "import large amounts of read-only data to a VM)."
28363 #: ../tools/virt-make-fs.pl:57
28364 msgid "Basic usage is:"
28368 #: ../tools/virt-make-fs.pl:59
28371 " virt-make-fs input output\n"
28376 #: ../tools/virt-make-fs.pl:61
28378 "where C<input> is either a directory containing files that you want to add, "
28379 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
28380 "C<output> is a disk image. The input type is detected automatically. The "
28381 "output disk image defaults to a raw ext2 image unless you specify extra "
28382 "flags (see L</OPTIONS> below)."
28386 #: ../tools/virt-make-fs.pl:67
28387 msgid "EXTRA SPACE"
28391 #: ../tools/virt-make-fs.pl:69
28393 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
28394 "the files that it contains, but might have extra space. Depending on how "
28395 "you are going to use the output, you might think this extra space is wasted "
28396 "and want to minimize it, or you might want to leave space so that more files "
28397 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
28398 "but you can use the C<--size> flag to leave space in the filesystem if you "
28403 #: ../tools/virt-make-fs.pl:77
28405 "An alternative way to leave extra space but not make the output image any "
28406 "bigger is to use an alternative disk image format (instead of the default "
28407 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
28408 "image format (check your hypervisor supports this before using it). This "
28409 "allows you to choose a large C<--size> but the extra space won't actually be "
28410 "allocated in the image until you try to store something in it."
28414 #: ../tools/virt-make-fs.pl:85
28416 "Don't forget that you can also use local commands including L<resize2fs(8)> "
28417 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-"
28418 "resize to build another image from scratch."
28422 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
28423 #: ../tools/virt-make-fs.pl:142
28428 #: ../tools/virt-make-fs.pl:91
28431 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
28436 #: ../tools/virt-make-fs.pl:93
28437 msgid "FILESYSTEM TYPE"
28441 #: ../tools/virt-make-fs.pl:95
28443 "The default filesystem type is C<ext2>. Just about any filesystem type that "
28444 "libguestfs supports can be used (but I<not> read-only formats like "
28445 "ISO9660). Here are some of the more common choices:"
28449 #: ../tools/virt-make-fs.pl:101
28454 #: ../tools/virt-make-fs.pl:103
28456 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
28457 "you are not going to use the filesystem in a way that requires the journal, "
28458 "then this is just wasted overhead."
28462 #: ../tools/virt-make-fs.pl:107
28463 msgid "I<ntfs> or I<vfat>"
28467 #: ../tools/virt-make-fs.pl:109
28468 msgid "Useful if exporting data to a Windows guest."
28472 #: ../tools/virt-make-fs.pl:111
28474 "I<Note for vfat>: The tar archive or local directory must only contain files "
28475 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
28476 "program running within libguestfs is unable to change the ownership of non-"
28477 "root files, since vfat itself does not support this."
28481 #: ../tools/virt-make-fs.pl:116
28486 #: ../tools/virt-make-fs.pl:118
28488 "Lower overhead than C<ext2>, but certain limitations on filename length and "
28489 "total filesystem size."
28493 #: ../tools/virt-make-fs.pl:125
28496 " virt-make-fs --type=minix input minixfs.img\n"
28501 #: ../tools/virt-make-fs.pl:127
28502 msgid "TO PARTITION OR NOT TO PARTITION"
28506 #: ../tools/virt-make-fs.pl:129
28507 msgid "Optionally virt-make-fs can add a partition table to the output disk."
28511 #: ../tools/virt-make-fs.pl:131
28513 "Adding a partition can make the disk image more compatible with certain "
28514 "virtualized operating systems which don't expect to see a filesystem "
28515 "directly located on a block device (Linux doesn't care and will happily "
28516 "handle both types)."
28520 #: ../tools/virt-make-fs.pl:136
28522 "On the other hand, if you have a partition table then the output image is no "
28523 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
28524 "directly on a partitioned disk image. (However libguestfs tools such as "
28525 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
28529 #: ../tools/virt-make-fs.pl:144
28530 msgid "Add an MBR partition:"
28534 #: ../tools/virt-make-fs.pl:146
28537 " virt-make-fs --partition -- input disk.img\n"
28542 #: ../tools/virt-make-fs.pl:148
28544 "If the output disk image could be terabyte-sized or larger, it's better to "
28545 "use an EFI/GPT-compatible partition table:"
28549 #: ../tools/virt-make-fs.pl:151
28552 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
28557 #: ../tools/virt-make-fs.pl:179
28558 msgid "Enable debugging information."
28562 #: ../tools/virt-make-fs.pl:185
28563 msgid "B<--size=E<lt>NE<gt>>"
28567 #: ../tools/virt-make-fs.pl:187
28568 msgid "B<--size=+E<lt>NE<gt>>"
28572 #: ../tools/virt-make-fs.pl:189
28573 msgid "B<-s E<lt>NE<gt>>"
28577 #: ../tools/virt-make-fs.pl:191
28578 msgid "B<-s +E<lt>NE<gt>>"
28582 #: ../tools/virt-make-fs.pl:193
28584 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
28588 #: ../tools/virt-make-fs.pl:196
28590 "If this option is I<not> given, then the output image will be just large "
28591 "enough to contain all the files, with not much wasted space."
28595 #: ../tools/virt-make-fs.pl:199
28597 "To choose a fixed size output disk, specify an absolute number followed by b/"
28598 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28599 "Petabytes or Exabytes. This must be large enough to contain all the input "
28600 "files, else you will get an error."
28604 #: ../tools/virt-make-fs.pl:204
28606 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
28607 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28608 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
28609 "the input files, and (approximately) an extra 200 MB free space."
28613 #: ../tools/virt-make-fs.pl:210
28615 "Note that virt-make-fs estimates free space, and therefore will not produce "
28616 "filesystems containing precisely the free space requested. (It is much more "
28617 "expensive and time-consuming to produce a filesystem which has precisely the "
28618 "desired free space)."
28622 #: ../tools/virt-make-fs.pl:219
28623 msgid "B<--format=E<lt>fmtE<gt>>"
28627 #: ../tools/virt-make-fs.pl:221
28628 msgid "B<-F E<lt>fmtE<gt>>"
28632 #: ../tools/virt-make-fs.pl:223
28633 msgid "Choose the output disk image format."
28637 #: ../tools/virt-make-fs.pl:225
28638 msgid "The default is C<raw> (raw disk image)."
28642 #: ../tools/virt-make-fs.pl:227
28644 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
28645 "that would really make sense here is C<qcow2>."
28649 #: ../tools/virt-make-fs.pl:234
28650 msgid "B<--type=E<lt>fsE<gt>>"
28654 #: ../tools/virt-make-fs.pl:236
28655 msgid "B<-t E<lt>fsE<gt>>"
28659 #: ../tools/virt-make-fs.pl:238
28660 msgid "Choose the output filesystem type."
28664 #: ../tools/virt-make-fs.pl:240
28665 msgid "The default is C<ext2>."
28669 #: ../tools/virt-make-fs.pl:242
28671 "Any filesystem which is supported read-write by libguestfs can be used here."
28675 #: ../tools/virt-make-fs.pl:249
28676 msgid "B<--partition>"
28680 #: ../tools/virt-make-fs.pl:251
28681 msgid "B<--partition=E<lt>parttypeE<gt>>"
28685 #: ../tools/virt-make-fs.pl:253
28687 "If specified, this flag adds an MBR partition table to the output disk image."
28691 #: ../tools/virt-make-fs.pl:256
28693 "You can change the partition table type, eg. C<--partition=gpt> for large "
28698 #: ../tools/virt-make-fs.pl:259
28700 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
28701 "might consider the next parameter to be the partition type. For example:"
28705 #: ../tools/virt-make-fs.pl:263
28708 " virt-make-fs --partition input.tar ...\n"
28713 #: ../tools/virt-make-fs.pl:265
28715 "would cause virt-make-fs to think you wanted to use a partition type of "
28716 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
28717 "dash) between options and the input file argument:"
28721 #: ../tools/virt-make-fs.pl:269
28724 " virt-make-fs --partition -- input.tar ...\n"
28729 #: ../tools/virt-make-fs.pl:536
28731 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
28732 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
28733 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28737 #: ../tools/virt-make-fs.pl:553
28740 " export LIBGUESTFS_DEBUG=1\n"
28741 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
28746 #: ../tools/virt-make-fs.pl:556
28748 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
28753 #: ../tools/virt-list-partitions.pl:32
28755 "virt-list-partitions - List partitions in a virtual machine or disk image"
28759 #: ../tools/virt-list-partitions.pl:36
28762 " virt-list-partitions [--options] domname\n"
28767 #: ../tools/virt-list-partitions.pl:38
28770 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
28775 #: ../tools/virt-list-partitions.pl:42
28777 "C<virt-list-partitions> is a command line tool to list the partitions that "
28778 "are contained in a virtual machine or disk image. It is mainly useful as a "
28779 "first step to using L<virt-resize(1)>."
28783 #: ../tools/virt-list-partitions.pl:47
28785 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
28786 "functionality. For more complex cases you should look at the L<guestfish(1)"
28791 #: ../tools/virt-list-partitions.pl:104
28792 msgid "B<-h> | B<--human-readable>"
28796 #: ../tools/virt-list-partitions.pl:106
28797 msgid "Show sizes in human-readable form (eg. \"1G\")."
28801 #: ../tools/virt-list-partitions.pl:114
28803 "With this option, C<virt-list-partitions> displays the type and size of each "
28804 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
28808 #: ../tools/virt-list-partitions.pl:121
28809 msgid "B<-t> | B<--total>"
28813 #: ../tools/virt-list-partitions.pl:123
28815 "Display the total size of each block device (as a separate row or rows)."
28819 #: ../tools/virt-list-partitions.pl:256
28821 "L<guestfs(3)>, L<guestfish(1)>, L<virt-list-filesystems(1)>, L<virt-resize(1)"
28822 ">, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://"
28823 "libguestfs.org/>."