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-16 19:06+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:957
782 #: ../src/guestfs.pod:961 ../src/guestfs.pod:965 ../src/guestfs.pod:970
783 #: ../src/guestfs.pod:978 ../src/guestfs.pod:997 ../src/guestfs.pod:1005
784 #: ../src/guestfs.pod:1027 ../src/guestfs.pod:1031 ../src/guestfs.pod:1035
785 #: ../src/guestfs.pod:1039 ../src/guestfs.pod:1043 ../src/guestfs.pod:1047
786 #: ../src/guestfs.pod:1529 ../src/guestfs.pod:1534 ../src/guestfs.pod:1538
787 #: ../src/guestfs.pod:1648 ../src/guestfs.pod:1653 ../src/guestfs.pod:1657
788 #: ../src/guestfs.pod:2001 ../src/guestfs.pod:2007 ../src/guestfs.pod:2012
789 #: ../src/guestfs.pod:2018 ../src/guestfs.pod:2125 ../src/guestfs.pod:2129
790 #: ../src/guestfs.pod:2133 ../src/guestfs.pod:2137
791 #: ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22
792 #: ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577
793 #: ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591
794 #: ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591
795 #: ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599
796 #: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611
797 #: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625
798 #: ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633
799 #: ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775
800 #: ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785
801 #: ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850
802 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod:376
803 #: ../fish/guestfish.pod:380 ../fish/guestfish.pod:384
804 #: ../fish/guestfish.pod:388 ../fish/guestfish-actions.pod:13
805 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:375
806 #: ../fish/guestfish-actions.pod:383 ../fish/guestfish-actions.pod:390
807 #: ../fish/guestfish-actions.pod:397 ../fish/guestfish-actions.pod:1067
808 #: ../fish/guestfish-actions.pod:1071 ../fish/guestfish-actions.pod:1075
809 #: ../fish/guestfish-actions.pod:1079 ../fish/guestfish-actions.pod:1087
810 #: ../fish/guestfish-actions.pod:1091 ../fish/guestfish-actions.pod:1095
811 #: ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1109
812 #: ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1203
813 #: ../fish/guestfish-actions.pod:1207 ../fish/guestfish-actions.pod:1212
814 #: ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1259
815 #: ../fish/guestfish-actions.pod:1263 ../fish/guestfish-actions.pod:1268
816 #: ../inspector/virt-inspector.pl:466 ../inspector/virt-inspector.pl:470
817 #: ../tools/virt-df.pl:161 ../tools/virt-df.pl:167 ../tools/virt-resize.pl:348
818 #: ../tools/virt-resize.pl:353 ../tools/virt-resize.pl:363
823 #: ../src/guestfs.pod:362
825 "The kernel version that the command runs under will be different from what "
830 #: ../src/guestfs.pod:367
832 "If the command needs to communicate with daemons, then most likely they "
837 #: ../src/guestfs.pod:372
838 msgid "The command will be running in limited memory."
842 #: ../src/guestfs.pod:376
844 "The network may not be available unless you enable it (see L</"
845 "guestfs_set_network>)."
849 #: ../src/guestfs.pod:381
850 msgid "Only supports Linux guests (not Windows, BSD, etc)."
854 #: ../src/guestfs.pod:385
856 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
860 #: ../src/guestfs.pod:390
862 "For SELinux guests, you may need to enable SELinux and load policy first. "
863 "See L</SELINUX> in this manpage."
867 #: ../src/guestfs.pod:395
869 "I<Security:> It is not safe to run commands from untrusted, possibly "
870 "malicious guests. These commands may attempt to exploit your program by "
871 "sending unexpected output. They could also try to exploit the Linux kernel "
872 "or qemu provided by the libguestfs appliance. They could use the network "
873 "provided by the libguestfs appliance to bypass ordinary network partitions "
874 "and firewalls. They could use the elevated privileges or different SELinux "
875 "context of your program to their advantage."
879 #: ../src/guestfs.pod:404
881 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
882 "(a script which runs when the guest next boots normally), and to have this "
883 "script run the commands you want in the normal context of the running guest, "
884 "network security and so on. For information about other security issues, "
889 #: ../src/guestfs.pod:412
891 "The two main API calls to run commands are L</guestfs_command> and L</"
892 "guestfs_sh> (there are also variations)."
896 #: ../src/guestfs.pod:415
898 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
899 "shell globs, redirections, etc will work."
903 #: ../src/guestfs.pod:418
904 msgid "CONFIGURATION FILES"
908 #: ../src/guestfs.pod:420
910 "To read and write configuration files in Linux guest filesystems, we "
911 "strongly recommend using Augeas. For example, Augeas understands how to "
912 "read and write, say, a Linux shadow password file or X.org configuration "
913 "file, and so avoids you having to write that code."
917 #: ../src/guestfs.pod:425
919 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
920 "document Augeas itself here because there is excellent documentation on the "
921 "L<http://augeas.net/> website."
925 #: ../src/guestfs.pod:429
927 "If you don't want to use Augeas (you fool!) then try calling L</"
928 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
933 #: ../src/guestfs.pod:433
938 #: ../src/guestfs.pod:435
940 "We support SELinux guests. To ensure that labeling happens correctly in "
941 "SELinux guests, you need to enable SELinux and load the guest's policy:"
945 #: ../src/guestfs.pod:441 ../src/guestfs.pod:1150 ../src/guestfs.pod:1281
950 #: ../src/guestfs.pod:443
951 msgid "Before launching, do:"
955 #: ../src/guestfs.pod:445
958 " guestfs_set_selinux (g, 1);\n"
963 #: ../src/guestfs.pod:447 ../src/guestfs.pod:1154 ../src/guestfs.pod:1285
968 #: ../src/guestfs.pod:449
970 "After mounting the guest's filesystem(s), load the policy. This is best "
971 "done by running the L<load_policy(8)> command in the guest itself:"
975 #: ../src/guestfs.pod:453
978 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
983 #: ../src/guestfs.pod:455
985 "(Older versions of C<load_policy> require you to specify the name of the "
990 #: ../src/guestfs.pod:458 ../src/guestfs.pod:1291
995 #: ../src/guestfs.pod:460
997 "Optionally, set the security context for the API. The correct security "
998 "context to use can only be known by inspecting the guest. As an example:"
1002 #: ../src/guestfs.pod:464
1005 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1010 #: ../src/guestfs.pod:468
1011 msgid "This will work for running commands and editing existing files."
1015 #: ../src/guestfs.pod:470
1017 "When new files are created, you may need to label them explicitly, for "
1018 "example by running the external command C<restorecon pathname>."
1022 #: ../src/guestfs.pod:474
1027 #: ../src/guestfs.pod:476
1029 "Certain calls are affected by the current file mode creation mask (the "
1030 "\"umask\"). In particular ones which create files or directories, such as "
1031 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1032 "either the default mode that the file is created with or modifies the mode "
1037 #: ../src/guestfs.pod:482
1039 "The default umask is C<022>, so files are created with modes such as C<0644> "
1040 "and directories with C<0755>."
1044 #: ../src/guestfs.pod:485
1046 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1047 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1048 "guestfs_chmod> after creating each file or directory."
1052 #: ../src/guestfs.pod:489
1053 msgid "For more information about umask, see L<umask(2)>."
1057 #: ../src/guestfs.pod:491 ../fish/guestfish.pod:669
1058 msgid "ENCRYPTED DISKS"
1062 #: ../src/guestfs.pod:493
1064 "Libguestfs allows you to access Linux guests which have been encrypted using "
1065 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1066 "standard. This includes nearly all whole disk encryption systems used by "
1067 "modern Linux guests."
1071 #: ../src/guestfs.pod:499
1073 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1074 "returns the string C<crypto_LUKS>)."
1078 #: ../src/guestfs.pod:502
1080 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1081 "will require the passphrase!"
1085 #: ../src/guestfs.pod:505
1087 "Opening a LUKS device creates a new device mapper device called C</dev/"
1088 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1089 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1090 "from and encrypted to the underlying block device respectively."
1094 #: ../src/guestfs.pod:511
1096 "LVM volume groups on the device can be made visible by calling L</"
1097 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1098 "(s) can now be mounted in the usual way."
1102 #: ../src/guestfs.pod:515
1104 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1105 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1106 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1107 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1108 "underlying encrypted block device)."
1112 #: ../src/guestfs.pod:522
1117 #: ../src/guestfs.pod:524
1119 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1120 "contains operating systems. (These APIs used to be in a separate Perl-only "
1121 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1122 "frequently used part of this library has been rewritten in C and moved into "
1127 #: ../src/guestfs.pod:530
1129 "Add all disks belonging to the unknown virtual machine and call L</"
1130 "guestfs_launch> in the usual way."
1134 #: ../src/guestfs.pod:533
1136 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1137 "and certain heuristics, and returns a list of operating systems that were "
1138 "found. An empty list means none were found. A single element is the root "
1139 "filesystem of the operating system. For dual- or multi-boot guests, "
1140 "multiple roots can be returned, each one corresponding to a separate "
1141 "operating system. (Multi-boot virtual machines are extremely rare in the "
1142 "world of virtualization, but since this scenario can happen, we have built "
1143 "libguestfs to deal with it.)"
1147 #: ../src/guestfs.pod:542
1149 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1150 "to get additional details about that operating system. For example, call L</"
1151 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1152 "Windows and Linux-based operating systems respectively."
1156 #: ../src/guestfs.pod:548
1158 "Un*x-like and Linux-based operating systems usually consist of several "
1159 "filesystems which are mounted at boot time (for example, a separate boot "
1160 "partition mounted on C</boot>). The inspection rules are able to detect how "
1161 "filesystems correspond to mount points. Call "
1162 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1163 "hash table like this example:"
1167 #: ../src/guestfs.pod:555
1170 " /boot => /dev/sda1\n"
1171 " / => /dev/vg_guest/lv_root\n"
1172 " /usr => /dev/vg_guest/lv_usr\n"
1177 #: ../src/guestfs.pod:559
1179 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1180 "filesystems as suggested."
1184 #: ../src/guestfs.pod:562
1186 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1187 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1191 #: ../src/guestfs.pod:566
1193 "Inspection currently only works for some common operating systems. "
1194 "Contributors are welcome to send patches for other operating systems that we "
1195 "currently cannot detect."
1199 #: ../src/guestfs.pod:570
1201 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1202 "for more details. The L</guestfs_inspect_os> function just ignores any "
1203 "encrypted devices."
1207 #: ../src/guestfs.pod:574
1209 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1210 "inspection and caches the results in the guest handle. Subsequent calls to "
1211 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1212 "read the disks. If you change the content of the guest disks, you can redo "
1213 "inspection by calling L</guestfs_inspect_os> again. (L</"
1214 "guestfs_inspect_list_applications> works a little differently from the other "
1215 "calls and does read the disks. See documentation for that function for "
1220 #: ../src/guestfs.pod:583
1221 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1225 #: ../src/guestfs.pod:585
1227 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1228 "ntfs-3g.org/> driver."
1232 #: ../src/guestfs.pod:588
1234 "DOS and Windows still use drive letters, and the filesystems are always "
1235 "treated as case insensitive by Windows itself, and therefore you might find "
1236 "a Windows configuration file referring to a path like C<c:\\windows"
1237 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1238 "might be referred to as C</WINDOWS/System32>."
1242 #: ../src/guestfs.pod:594
1244 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1245 "libguestfs to read the appropriate Windows Registry and configuration files, "
1246 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1251 #: ../src/guestfs.pod:599
1253 "Replacing backslash characters with forward slash characters is also outside "
1254 "the scope of libguestfs, but something that you can easily do."
1258 #: ../src/guestfs.pod:602
1260 "Where we can help is in resolving the case insensitivity of paths. For "
1261 "this, call L</guestfs_case_sensitive_path>."
1265 #: ../src/guestfs.pod:605
1267 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1268 "files, through the library C<hivex> which is part of the libguestfs project "
1269 "although ships as a separate tarball. You have to locate and download the "
1270 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1271 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1272 "reg(1)> for more help on this issue."
1276 #: ../src/guestfs.pod:613
1277 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1281 #: ../src/guestfs.pod:615
1283 "Although we don't want to discourage you from using the C API, we will "
1284 "mention here that the same API is also available in other languages."
1288 #: ../src/guestfs.pod:618
1290 "The API is broadly identical in all supported languages. This means that "
1291 "the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, C<g."
1292 "mount(path)> in Python, and C<Guestfs.mount g path> in OCaml. In other "
1293 "words, a straightforward, predictable isomorphism between each language."
1297 #: ../src/guestfs.pod:624
1299 "Error messages are automatically transformed into exceptions if the language "
1304 #: ../src/guestfs.pod:627
1306 "We don't try to \"object orientify\" parts of the API in OO languages, "
1307 "although contributors are welcome to write higher level APIs above what we "
1308 "provide in their favourite languages if they wish."
1312 #: ../src/guestfs.pod:633
1317 #: ../src/guestfs.pod:635
1319 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1320 "identical to the C API. C++ classes and exceptions are not used."
1324 #: ../src/guestfs.pod:639
1329 #: ../src/guestfs.pod:641
1331 "The C# bindings are highly experimental. Please read the warnings at the "
1332 "top of C<csharp/Libguestfs.cs>."
1336 #: ../src/guestfs.pod:644
1341 #: ../src/guestfs.pod:646
1343 "This is the only language binding that is working but incomplete. Only "
1344 "calls which return simple integers have been bound in Haskell, and we are "
1345 "looking for help to complete this binding."
1349 #: ../src/guestfs.pod:650
1354 #: ../src/guestfs.pod:652
1356 "Full documentation is contained in the Javadoc which is distributed with "
1361 #: ../src/guestfs.pod:655
1366 #: ../src/guestfs.pod:657
1367 msgid "For documentation see the file C<guestfs.mli>."
1371 #: ../src/guestfs.pod:659
1376 #: ../src/guestfs.pod:661
1377 msgid "For documentation see L<Sys::Guestfs(3)>."
1381 #: ../src/guestfs.pod:663
1386 #: ../src/guestfs.pod:665
1388 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1389 "the php-libguestfs package for your distribution."
1393 #: ../src/guestfs.pod:668
1394 msgid "The PHP binding only works correctly on 64 bit machines."
1398 #: ../src/guestfs.pod:670
1403 #: ../src/guestfs.pod:672
1404 msgid "For documentation do:"
1408 #: ../src/guestfs.pod:674
1412 " >>> import guestfs\n"
1413 " >>> help (guestfs)\n"
1418 #: ../src/guestfs.pod:678
1423 #: ../src/guestfs.pod:680
1425 "Use the Guestfs module. There is no Ruby-specific documentation, but you "
1426 "can find examples written in Ruby in the libguestfs source."
1430 #: ../src/guestfs.pod:683
1431 msgid "B<shell scripts>"
1435 #: ../src/guestfs.pod:685
1436 msgid "For documentation see L<guestfish(1)>."
1440 #: ../src/guestfs.pod:689
1441 msgid "LIBGUESTFS GOTCHAS"
1445 #: ../src/guestfs.pod:691
1447 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1448 "system [...] that works in the way it is documented but is counterintuitive "
1449 "and almost invites mistakes.\""
1453 #: ../src/guestfs.pod:695
1455 "Since we developed libguestfs and the associated tools, there are several "
1456 "things we would have designed differently, but are now stuck with for "
1457 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1458 "release, you can expect these to change. Beware of them."
1462 #: ../src/guestfs.pod:703
1463 msgid "Autosync / forgetting to sync."
1467 #: ../src/guestfs.pod:705
1469 "When modifying a filesystem from C or another language, you B<must> unmount "
1470 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1471 "libguestfs handle. You can also call:"
1475 #: ../src/guestfs.pod:709
1478 " guestfs_set_autosync (g, 1);\n"
1483 #: ../src/guestfs.pod:711
1485 "to have the unmount/sync done automatically for you when the handle 'g' is "
1486 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1490 #: ../src/guestfs.pod:715
1492 "If you forget to do this, then it is entirely possible that your changes "
1493 "won't be written out, or will be partially written, or (very rarely) that "
1494 "you'll get disk corruption."
1498 #: ../src/guestfs.pod:719
1500 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1501 "guestfish scripts that forget to sync will work just fine, which can make "
1502 "this very puzzling if you are trying to debug a problem."
1506 #: ../src/guestfs.pod:723
1508 "Update: Autosync is enabled by default for all API users starting from "
1509 "libguestfs 1.5.24."
1513 #: ../src/guestfs.pod:726
1514 msgid "Mount option C<-o sync> should not be the default."
1518 #: ../src/guestfs.pod:728
1520 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1521 "However C<-o sync> does not add any reliability benefit, but does have a "
1522 "very large performance impact."
1526 #: ../src/guestfs.pod:732
1528 "The work around is to use L</guestfs_mount_options> and set the mount "
1529 "options that you actually want to use."
1533 #: ../src/guestfs.pod:735
1534 msgid "Read-only should be the default."
1538 #: ../src/guestfs.pod:737
1540 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1541 "specify I<--rw> if you want to make changes to the image."
1545 #: ../src/guestfs.pod:740
1546 msgid "This would reduce the potential to corrupt live VM images."
1550 #: ../src/guestfs.pod:742
1552 "Note that many filesystems change the disk when you just mount and unmount, "
1553 "even if you didn't perform any writes. You need to use L</"
1554 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1558 #: ../src/guestfs.pod:746
1559 msgid "guestfish command line is hard to use."
1563 #: ../src/guestfs.pod:748
1565 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1566 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1567 "exist, so it fails. In earlier versions of guestfish the error message was "
1568 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1569 "we should have used C<guestfish -c command> to run commands."
1573 #: ../src/guestfs.pod:755
1574 msgid "guestfish megabyte modifiers don't work right on all commands"
1578 #: ../src/guestfs.pod:757
1580 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1581 "other modifiers). What guestfish actually does is to multiply the number "
1582 "part by the modifier part and pass the result to the C API. However this "
1583 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1584 "expecting some other unit (eg. megabytes)."
1588 #: ../src/guestfs.pod:764
1589 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1593 #: ../src/guestfs.pod:766
1596 " lvcreate LV VG 100M\n"
1601 #: ../src/guestfs.pod:768
1603 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1604 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1605 "megabytes * megabytes) logical volume. The error message you get from this "
1606 "is also a little obscure."
1610 #: ../src/guestfs.pod:773
1612 "This could be fixed in the generator by specially marking parameters and "
1613 "return values which take bytes or other units."
1617 #: ../src/guestfs.pod:776
1618 msgid "Ambiguity between devices and paths"
1622 #: ../src/guestfs.pod:778
1624 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1625 "sdb2>) and a similar pathname. A file might just happen to be called "
1626 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1630 #: ../src/guestfs.pod:783
1632 "In the current API we usually resolve this ambiguity by having two separate "
1633 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1634 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1635 "detecting if the path supplied begins with C</dev/>."
1639 #: ../src/guestfs.pod:789
1641 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1642 "make paths/devices into structured names. One way to do this would be to "
1643 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1644 "aspect of grub. Another way would be to use a structured type, equivalent "
1645 "to this OCaml type:"
1649 #: ../src/guestfs.pod:795
1652 " type path = Path of string | Device of int | Partition of int * int\n"
1657 #: ../src/guestfs.pod:797
1658 msgid "which would allow you to pass arguments like:"
1662 #: ../src/guestfs.pod:799
1665 " Path \"/foo/bar\"\n"
1666 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1667 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1668 " Path \"/dev/sdb2\" (* not a device *)\n"
1673 #: ../src/guestfs.pod:804
1675 "As you can see there are still problems to resolve even with this "
1676 "representation. Also consider how it might work in guestfish."
1680 #: ../src/guestfs.pod:809
1681 msgid "PROTOCOL LIMITS"
1685 #: ../src/guestfs.pod:811
1687 "Internally libguestfs uses a message-based protocol to pass API calls and "
1688 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1689 "plenty more detail about this). The maximum message size used by the "
1690 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1691 "aware of this limit. The API calls which may be affected are individually "
1692 "documented, with a link back to this section of the documentation."
1696 #: ../src/guestfs.pod:819
1698 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1699 "a simple string. Because this string is at some point internally encoded as "
1700 "a message, the maximum size that it can return is slightly under 4 MB. If "
1701 "the requested file is larger than this then you will get an error."
1705 #: ../src/guestfs.pod:825
1707 "In order to transfer large files into and out of the guest filesystem, you "
1708 "need to use particular calls that support this. The sections L</UPLOADING> "
1709 "and L</DOWNLOADING> document how to do this."
1713 #: ../src/guestfs.pod:829
1715 "You might also consider mounting the disk image using our FUSE filesystem "
1716 "support (L<guestmount(1)>)."
1720 #: ../src/guestfs.pod:832
1721 msgid "KEYS AND PASSPHRASES"
1725 #: ../src/guestfs.pod:834
1727 "Certain libguestfs calls take a parameter that contains sensitive key "
1728 "material, passed in as a C string."
1732 #: ../src/guestfs.pod:837
1734 "In the future we would hope to change the libguestfs implementation so that "
1735 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1736 "swap. However this is I<not> done at the moment, because of the complexity "
1737 "of such an implementation."
1741 #: ../src/guestfs.pod:842
1743 "Therefore you should be aware that any key parameter you pass to libguestfs "
1744 "might end up being written out to the swap partition. If this is a concern, "
1745 "scrub the swap partition or don't use libguestfs on encrypted devices."
1749 #: ../src/guestfs.pod:847
1750 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1754 #: ../src/guestfs.pod:849
1756 "All high-level libguestfs actions are synchronous. If you want to use "
1757 "libguestfs asynchronously then you must create a thread."
1761 #: ../src/guestfs.pod:852
1763 "Only use the handle from a single thread. Either use the handle exclusively "
1764 "from one thread, or provide your own mutex so that two threads cannot issue "
1765 "calls on the same handle at the same time."
1769 #: ../src/guestfs.pod:856
1771 "See the graphical program guestfs-browser for one possible architecture for "
1772 "multithreaded programs using libvirt and libguestfs."
1776 #: ../src/guestfs.pod:859
1781 #: ../src/guestfs.pod:861
1783 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
1788 #: ../src/guestfs.pod:864
1790 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1791 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1795 #: ../src/guestfs.pod:867
1797 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1798 "to change the directories that libguestfs will search in. The value is a "
1799 "colon-separated list of paths. The current directory is I<not> searched "
1800 "unless the path contains an empty element or C<.>. For example "
1801 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1802 "then C</usr/lib/guestfs>."
1806 #: ../src/guestfs.pod:874
1807 msgid "QEMU WRAPPERS"
1811 #: ../src/guestfs.pod:876
1813 "If you want to compile your own qemu, run qemu from a non-standard location, "
1814 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1819 #: ../src/guestfs.pod:880
1821 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1822 "last command in the shell script (so that qemu replaces the shell and "
1823 "becomes the direct child of the libguestfs-using program). If you don't do "
1824 "this, then the qemu process won't be cleaned up correctly."
1828 #: ../src/guestfs.pod:885
1830 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1835 #: ../src/guestfs.pod:888
1839 " qemudir=/home/rjones/d/qemu\n"
1840 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
1845 #: ../src/guestfs.pod:892
1847 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1848 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1853 #: ../src/guestfs.pod:896
1856 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1861 #: ../src/guestfs.pod:898
1863 "Note that libguestfs also calls qemu with the -help and -version options in "
1864 "order to determine features."
1868 #: ../src/guestfs.pod:901
1869 msgid "ABI GUARANTEE"
1873 #: ../src/guestfs.pod:903
1875 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
1876 "actions as outlined in this section. Although we will deprecate some "
1877 "actions, for example if they get replaced by newer calls, we will keep the "
1878 "old actions forever. This allows you the developer to program in confidence "
1879 "against the libguestfs API."
1883 #: ../src/guestfs.pod:909
1884 msgid "BLOCK DEVICE NAMING"
1888 #: ../src/guestfs.pod:911
1890 "In the kernel there is now quite a profusion of schemata for naming block "
1891 "devices (in this context, by I<block device> I mean a physical or virtual "
1892 "hard drive). The original Linux IDE driver used names starting with C</dev/"
1893 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
1894 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
1895 "for the old IDE driver (particularly for SATA devices) those devices also "
1896 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
1897 "paravirtualized drivers. This has created several different naming systems, "
1898 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
1902 #: ../src/guestfs.pod:923
1904 "As discussed above, libguestfs uses a qemu appliance running an embedded "
1905 "Linux kernel to access block devices. We can run a variety of appliances "
1906 "based on a variety of Linux kernels."
1910 #: ../src/guestfs.pod:927
1912 "This causes a problem for libguestfs because many API calls use device or "
1913 "partition names. Working scripts and the recipe (example) scripts that we "
1914 "make available over the internet could fail if the naming scheme changes."
1918 #: ../src/guestfs.pod:932
1920 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
1921 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
1922 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
1923 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
1927 #: ../src/guestfs.pod:938
1929 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
1930 "L</guestfs_list_partitions> and similar calls return the true names of the "
1931 "devices and partitions as known to the appliance."
1935 #: ../src/guestfs.pod:943
1936 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
1940 #: ../src/guestfs.pod:945
1942 "Usually this translation is transparent. However in some (very rare) cases "
1943 "you may need to know the exact algorithm. Such cases include where you use "
1944 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
1945 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
1949 #: ../src/guestfs.pod:951
1951 "The algorithm is applied only to I<parameters> which are known to be either "
1952 "device or partition names. Return values from functions such as L</"
1953 "guestfs_list_devices> are never changed."
1957 #: ../src/guestfs.pod:959
1958 msgid "Is the string a parameter which is a device or partition name?"
1962 #: ../src/guestfs.pod:963
1963 msgid "Does the string begin with C</dev/sd>?"
1967 #: ../src/guestfs.pod:967
1969 "Does the named device exist? If so, we use that device. However if I<not> "
1970 "then we continue with this algorithm."
1974 #: ../src/guestfs.pod:972
1975 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
1979 #: ../src/guestfs.pod:974
1980 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
1984 #: ../src/guestfs.pod:976
1985 msgid "If that named device exists, use it. If not, continue."
1989 #: ../src/guestfs.pod:980
1990 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
1994 #: ../src/guestfs.pod:982
1995 msgid "If that named device exists, use it. If not, return an error."
1999 #: ../src/guestfs.pod:986
2000 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2004 #: ../src/guestfs.pod:988
2006 "Although the standard naming scheme and automatic translation is useful for "
2007 "simple programs and guestfish scripts, for larger programs it is best not to "
2008 "rely on this mechanism."
2012 #: ../src/guestfs.pod:992
2014 "Where possible for maximum future portability programs using libguestfs "
2015 "should use these future-proof techniques:"
2019 #: ../src/guestfs.pod:999
2021 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2022 "device names, and then use those names directly."
2026 #: ../src/guestfs.pod:1002
2028 "Since those device names exist by definition, they will never be translated."
2032 #: ../src/guestfs.pod:1007
2034 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2035 "filesystem labels."
2039 #: ../src/guestfs.pod:1012
2044 #: ../src/guestfs.pod:1014
2046 "This section discusses security implications of using libguestfs, "
2047 "particularly with untrusted or malicious guests or disk images."
2051 #: ../src/guestfs.pod:1017
2052 msgid "GENERAL SECURITY CONSIDERATIONS"
2056 #: ../src/guestfs.pod:1019
2058 "Be careful with any files or data that you download from a guest (by "
2059 "\"download\" we mean not just the L</guestfs_download> command but any "
2060 "command that reads files, filenames, directories or anything else from a "
2061 "disk image). An attacker could manipulate the data to fool your program "
2062 "into doing the wrong thing. Consider cases such as:"
2066 #: ../src/guestfs.pod:1029
2067 msgid "the data (file etc) not being present"
2071 #: ../src/guestfs.pod:1033
2072 msgid "being present but empty"
2076 #: ../src/guestfs.pod:1037
2077 msgid "being much larger than normal"
2081 #: ../src/guestfs.pod:1041
2082 msgid "containing arbitrary 8 bit data"
2086 #: ../src/guestfs.pod:1045
2087 msgid "being in an unexpected character encoding"
2091 #: ../src/guestfs.pod:1049
2092 msgid "containing homoglyphs."
2096 #: ../src/guestfs.pod:1053
2097 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2101 #: ../src/guestfs.pod:1055
2103 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2104 "(VFS) module can sometimes be escalated into exploits by deliberately "
2105 "creating a malicious, malformed filesystem. These exploits are very severe "
2106 "for two reasons. Firstly there are very many filesystem drivers in the "
2107 "kernel, and many of them are infrequently used and not much developer "
2108 "attention has been paid to the code. Linux userspace helps potential "
2109 "crackers by detecting the filesystem type and automatically choosing the "
2110 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2111 "the administrator. Secondly, a kernel-level exploit is like a local root "
2112 "exploit (worse in some ways), giving immediate and total access to the "
2113 "system right down to the hardware level."
2117 #: ../src/guestfs.pod:1068
2119 "That explains why you should never mount a filesystem from an untrusted "
2120 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2121 "inside a qemu virtual machine, usually running as a non-root user. The "
2122 "attacker would need to write a filesystem which first exploited the kernel, "
2123 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2124 "the libguestfs protocol, and finally to be as serious as the host kernel "
2125 "exploit it would need to escalate its privileges to root. This multi-step "
2126 "escalation, performed by a static piece of data, is thought to be extremely "
2127 "hard to do, although we never say 'never' about security issues."
2131 #: ../src/guestfs.pod:1079
2133 "In any case callers can reduce the attack surface by forcing the filesystem "
2134 "type when mounting (use L</guestfs_mount_vfs>)."
2138 #: ../src/guestfs.pod:1082
2139 msgid "PROTOCOL SECURITY"
2143 #: ../src/guestfs.pod:1084
2145 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2146 "defined upper message size. However a program that uses libguestfs must "
2147 "also take care - for example you can write a program that downloads a binary "
2148 "from a disk image and executes it locally, and no amount of protocol "
2149 "security will save you from the consequences."
2153 #: ../src/guestfs.pod:1090
2154 msgid "INSPECTION SECURITY"
2158 #: ../src/guestfs.pod:1092
2160 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2161 "directly from the guest, and these could contain any 8 bit data. Callers "
2162 "should be careful to escape these before printing them to a structured file "
2163 "(for example, use HTML escaping if creating a web page)."
2167 #: ../src/guestfs.pod:1098
2169 "Guest configuration may be altered in unusual ways by the administrator of "
2170 "the virtual machine, and may not reflect reality (particularly for untrusted "
2171 "or actively malicious guests). For example we parse the hostname from "
2172 "configuration files like C</etc/sysconfig/network> that we find in the "
2173 "guest, but the guest administrator can easily manipulate these files to "
2174 "provide the wrong hostname."
2178 #: ../src/guestfs.pod:1106
2180 "The inspection API parses guest configuration using two external libraries: "
2181 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2182 "designed to be robust in the face of malicious data, although denial of "
2183 "service attacks are still possible, for example with oversized configuration "
2188 #: ../src/guestfs.pod:1112
2189 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2193 #: ../src/guestfs.pod:1114
2195 "Be very cautious about running commands from the guest. By running a "
2196 "command in the guest, you are giving CPU time to a binary that you do not "
2197 "control, under the same user account as the library, albeit wrapped in qemu "
2198 "virtualization. More information and alternatives can be found in the "
2199 "section L</RUNNING COMMANDS>."
2203 #: ../src/guestfs.pod:1120
2204 msgid "CVE-2010-3851"
2208 #: ../src/guestfs.pod:1122
2209 msgid "https://bugzilla.redhat.com/642934"
2213 #: ../src/guestfs.pod:1124
2215 "This security bug concerns the automatic disk format detection that qemu "
2216 "does on disk images."
2220 #: ../src/guestfs.pod:1127
2222 "A raw disk image is just the raw bytes, there is no header. Other disk "
2223 "images like qcow2 contain a special header. Qemu deals with this by looking "
2224 "for one of the known headers, and if none is found then assuming the disk "
2225 "image must be raw."
2229 #: ../src/guestfs.pod:1132
2231 "This allows a guest which has been given a raw disk image to write some "
2232 "other header. At next boot (or when the disk image is accessed by "
2233 "libguestfs) qemu would do autodetection and think the disk image format was, "
2234 "say, qcow2 based on the header written by the guest."
2238 #: ../src/guestfs.pod:1137
2240 "This in itself would not be a problem, but qcow2 offers many features, one "
2241 "of which is to allow a disk image to refer to another image (called the "
2242 "\"backing disk\"). It does this by placing the path to the backing disk "
2243 "into the qcow2 header. This path is not validated and could point to any "
2244 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2245 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2246 "control of the attacker."
2250 #: ../src/guestfs.pod:1145
2252 "In libguestfs this is rather hard to exploit except under two circumstances:"
2256 #: ../src/guestfs.pod:1152
2257 msgid "You have enabled the network or have opened the disk in write mode."
2261 #: ../src/guestfs.pod:1156
2263 "You are also running untrusted code from the guest (see L</RUNNING "
2268 #: ../src/guestfs.pod:1161
2270 "The way to avoid this is to specify the expected disk format when adding "
2271 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2272 "should always do this if the disk is raw format, and it's a good idea for "
2277 #: ../src/guestfs.pod:1166
2279 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2280 "format is fetched from libvirt and passed through."
2284 #: ../src/guestfs.pod:1169
2286 "For libguestfs tools, use the I<--format> command line parameter as "
2291 #: ../src/guestfs.pod:1172
2292 msgid "CONNECTION MANAGEMENT"
2296 #: ../src/guestfs.pod:1174
2301 #: ../src/guestfs.pod:1176
2303 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2304 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2305 "handle and release all resources used."
2309 #: ../src/guestfs.pod:1180
2311 "For information on using multiple handles and threads, see the section L</"
2312 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2316 #: ../src/guestfs.pod:1183
2317 msgid "guestfs_create"
2321 #: ../src/guestfs.pod:1185
2324 " guestfs_h *guestfs_create (void);\n"
2329 #: ../src/guestfs.pod:1187
2330 msgid "Create a connection handle."
2334 #: ../src/guestfs.pod:1189
2336 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2337 "on the handle at least once."
2341 #: ../src/guestfs.pod:1192
2343 "This function returns a non-NULL pointer to a handle on success or NULL on "
2348 #: ../src/guestfs.pod:1195
2349 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2353 #: ../src/guestfs.pod:1197
2355 "You may also want to configure error handling for the handle. See L</ERROR "
2356 "HANDLING> section below."
2360 #: ../src/guestfs.pod:1200
2361 msgid "guestfs_close"
2365 #: ../src/guestfs.pod:1202
2368 " void guestfs_close (guestfs_h *g);\n"
2373 #: ../src/guestfs.pod:1204
2374 msgid "This closes the connection handle and frees up all resources used."
2378 #: ../src/guestfs.pod:1206
2379 msgid "ERROR HANDLING"
2383 #: ../src/guestfs.pod:1208
2385 "API functions can return errors. For example, almost all functions that "
2386 "return C<int> will return C<-1> to indicate an error."
2390 #: ../src/guestfs.pod:1211
2392 "Additional information is available for errors: an error message string and "
2393 "optionally an error number (errno) if the thing that failed was a system "
2398 #: ../src/guestfs.pod:1215
2400 "You can get at the additional information about the last error on the handle "
2401 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2402 "up an error handler with L</guestfs_set_error_handler>."
2406 #: ../src/guestfs.pod:1220
2408 "When the handle is created, a default error handler is installed which "
2409 "prints the error message string to C<stderr>. For small short-running "
2410 "command line programs it is sufficient to do:"
2414 #: ../src/guestfs.pod:1224
2417 " if (guestfs_launch (g) == -1)\n"
2418 " exit (EXIT_FAILURE);\n"
2423 #: ../src/guestfs.pod:1227
2425 "since the default error handler will ensure that an error message has been "
2426 "printed to C<stderr> before the program exits."
2430 #: ../src/guestfs.pod:1230
2432 "For other programs the caller will almost certainly want to install an "
2433 "alternate error handler or do error handling in-line like this:"
2437 #: ../src/guestfs.pod:1233
2440 " g = guestfs_create ();\n"
2445 #: ../src/guestfs.pod:1235
2448 " /* This disables the default behaviour of printing errors\n"
2450 " guestfs_set_error_handler (g, NULL, NULL);\n"
2455 #: ../src/guestfs.pod:1239
2458 " if (guestfs_launch (g) == -1) {\n"
2459 " /* Examine the error message and print it etc. */\n"
2460 " char *msg = guestfs_last_error (g);\n"
2461 " int errnum = guestfs_last_errno (g);\n"
2462 " fprintf (stderr, \"%s\\n\", msg);\n"
2469 #: ../src/guestfs.pod:1247
2471 "Out of memory errors are handled differently. The default action is to call "
2472 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
2473 "guestfs_set_out_of_memory_handler>."
2477 #: ../src/guestfs.pod:1251
2479 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2480 "because there is no handle if this happens there is no way to get additional "
2481 "error information. However L</guestfs_create> is supposed to be a "
2482 "lightweight operation which can only fail because of insufficient memory (it "
2483 "returns NULL in this case)."
2487 #: ../src/guestfs.pod:1257
2488 msgid "guestfs_last_error"
2492 #: ../src/guestfs.pod:1259
2495 " const char *guestfs_last_error (guestfs_h *g);\n"
2500 #: ../src/guestfs.pod:1261
2502 "This returns the last error message that happened on C<g>. If there has not "
2503 "been an error since the handle was created, then this returns C<NULL>."
2507 #: ../src/guestfs.pod:1265
2509 "The lifetime of the returned string is until the next error occurs, or L</"
2510 "guestfs_close> is called."
2514 #: ../src/guestfs.pod:1268
2515 msgid "guestfs_last_errno"
2519 #: ../src/guestfs.pod:1270
2522 " int guestfs_last_errno (guestfs_h *g);\n"
2527 #: ../src/guestfs.pod:1272
2528 msgid "This returns the last error number (errno) that happened on C<g>."
2532 #: ../src/guestfs.pod:1274
2533 msgid "If successful, an errno integer not equal to zero is returned."
2537 #: ../src/guestfs.pod:1276
2539 "If no error, this returns 0. This call can return 0 in three situations:"
2543 #: ../src/guestfs.pod:1283
2544 msgid "There has not been any error on the handle."
2548 #: ../src/guestfs.pod:1287
2550 "There has been an error but the errno was meaningless. This corresponds to "
2551 "the case where the error did not come from a failed system call, but for "
2552 "some other reason."
2556 #: ../src/guestfs.pod:1293
2558 "There was an error from a failed system call, but for some reason the errno "
2559 "was not captured and returned. This usually indicates a bug in libguestfs."
2563 #: ../src/guestfs.pod:1299
2565 "Libguestfs tries to convert the errno from inside the applicance into a "
2566 "corresponding errno for the caller (not entirely trivial: the appliance "
2567 "might be running a completely different operating system from the library "
2568 "and error numbers are not standardized across Un*xen). If this could not be "
2569 "done, then the error is translated to C<EINVAL>. In practice this should "
2570 "only happen in very rare circumstances."
2574 #: ../src/guestfs.pod:1307
2575 msgid "guestfs_set_error_handler"
2579 #: ../src/guestfs.pod:1309
2582 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2584 " const char *msg);\n"
2585 " void guestfs_set_error_handler (guestfs_h *g,\n"
2586 " guestfs_error_handler_cb cb,\n"
2592 #: ../src/guestfs.pod:1316
2594 "The callback C<cb> will be called if there is an error. The parameters "
2595 "passed to the callback are an opaque data pointer and the error message "
2600 #: ../src/guestfs.pod:1320
2602 "C<errno> is not passed to the callback. To get that the callback must call "
2603 "L</guestfs_last_errno>."
2607 #: ../src/guestfs.pod:1323
2609 "Note that the message string C<msg> is freed as soon as the callback "
2610 "function returns, so if you want to stash it somewhere you must make your "
2615 #: ../src/guestfs.pod:1327
2616 msgid "The default handler prints messages on C<stderr>."
2620 #: ../src/guestfs.pod:1329
2621 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2625 #: ../src/guestfs.pod:1331
2626 msgid "guestfs_get_error_handler"
2630 #: ../src/guestfs.pod:1333
2633 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2634 " void **opaque_rtn);\n"
2639 #: ../src/guestfs.pod:1336
2640 msgid "Returns the current error handler callback."
2644 #: ../src/guestfs.pod:1338
2645 msgid "guestfs_set_out_of_memory_handler"
2649 #: ../src/guestfs.pod:1340
2652 " typedef void (*guestfs_abort_cb) (void);\n"
2653 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2654 " guestfs_abort_cb);\n"
2659 #: ../src/guestfs.pod:1344
2661 "The callback C<cb> will be called if there is an out of memory situation. "
2662 "I<Note this callback must not return>."
2666 #: ../src/guestfs.pod:1347
2667 msgid "The default is to call L<abort(3)>."
2671 #: ../src/guestfs.pod:1349
2673 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2677 #: ../src/guestfs.pod:1352
2678 msgid "guestfs_get_out_of_memory_handler"
2682 #: ../src/guestfs.pod:1354
2685 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2690 #: ../src/guestfs.pod:1356
2691 msgid "This returns the current out of memory handler."
2695 #: ../src/guestfs.pod:1358
2700 #: ../src/guestfs.pod:1360 ../fish/guestfish.pod:907
2705 #: ../src/guestfs.pod:1362
2710 #: ../src/guestfs.pod:1364
2715 #: ../src/guestfs.pod:1366
2716 msgid "AVAILABILITY"
2720 #: ../src/guestfs.pod:1368
2721 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2725 #: ../src/guestfs.pod:1370
2727 "Using L</guestfs_available> you can test availability of the following "
2728 "groups of functions. This test queries the appliance to see if the "
2729 "appliance you are currently using supports the functionality."
2733 #: ../src/guestfs.pod:1375
2734 msgid "@AVAILABILITY@"
2738 #: ../src/guestfs.pod:1377
2739 msgid "GUESTFISH supported COMMAND"
2743 #: ../src/guestfs.pod:1379
2745 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2746 "prints out the available groups and whether they are supported by this build "
2747 "of libguestfs. Note however that you have to do C<run> first."
2751 #: ../src/guestfs.pod:1384
2752 msgid "SINGLE CALLS AT COMPILE TIME"
2756 #: ../src/guestfs.pod:1386
2758 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2759 "function, such as:"
2763 #: ../src/guestfs.pod:1389
2766 " #define LIBGUESTFS_HAVE_DD 1\n"
2771 #: ../src/guestfs.pod:1391
2772 msgid "if L</guestfs_dd> is available."
2776 #: ../src/guestfs.pod:1393
2778 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2779 "function is available at compile time, we recommended using build tools such "
2780 "as autoconf or cmake. For example in autotools you could use:"
2784 #: ../src/guestfs.pod:1398
2787 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2788 " AC_CHECK_FUNCS([guestfs_dd])\n"
2793 #: ../src/guestfs.pod:1401
2795 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2800 #: ../src/guestfs.pod:1404
2801 msgid "SINGLE CALLS AT RUN TIME"
2805 #: ../src/guestfs.pod:1406
2807 "Testing at compile time doesn't guarantee that a function really exists in "
2808 "the library. The reason is that you might be dynamically linked against a "
2809 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2810 "This situation unfortunately results in a segmentation fault, which is a "
2811 "shortcoming of the C dynamic linking system itself."
2815 #: ../src/guestfs.pod:1413
2817 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2818 "in this example program (note that you still need the compile time check as "
2823 #: ../src/guestfs.pod:1417
2826 " #include <stdio.h>\n"
2827 " #include <stdlib.h>\n"
2828 " #include <unistd.h>\n"
2829 " #include <dlfcn.h>\n"
2830 " #include <guestfs.h>\n"
2835 #: ../src/guestfs.pod:1423
2840 " #ifdef LIBGUESTFS_HAVE_DD\n"
2842 " int has_function;\n"
2847 #: ../src/guestfs.pod:1429
2850 " /* Test if the function guestfs_dd is really available. */\n"
2851 " dl = dlopen (NULL, RTLD_LAZY);\n"
2853 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2854 " exit (EXIT_FAILURE);\n"
2856 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2862 #: ../src/guestfs.pod:1438
2865 " if (!has_function)\n"
2866 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2868 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2869 " /* Now it's safe to call\n"
2870 " guestfs_dd (g, \"foo\", \"bar\");\n"
2874 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2881 #: ../src/guestfs.pod:1451
2883 "You may think the above is an awful lot of hassle, and it is. There are "
2884 "other ways outside of the C linking system to ensure that this kind of "
2885 "incompatibility never arises, such as using package versioning:"
2889 #: ../src/guestfs.pod:1456
2892 " Requires: libguestfs >= 1.0.80\n"
2897 #: ../src/guestfs.pod:1458
2898 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2902 #: ../src/guestfs.pod:1460
2904 "A recent feature of the API is the introduction of calls which take optional "
2905 "arguments. In C these are declared 3 ways. The main way is as a call which "
2906 "takes variable arguments (ie. C<...>), as in this example:"
2910 #: ../src/guestfs.pod:1465
2913 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2918 #: ../src/guestfs.pod:1467
2920 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2921 "call with no optional arguments specified:"
2925 #: ../src/guestfs.pod:1470
2928 " guestfs_add_drive_opts (g, filename, -1);\n"
2933 #: ../src/guestfs.pod:1472
2934 msgid "With a single optional argument:"
2938 #: ../src/guestfs.pod:1474
2941 " guestfs_add_drive_opts (g, filename,\n"
2942 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2948 #: ../src/guestfs.pod:1478
2953 #: ../src/guestfs.pod:1480
2956 " guestfs_add_drive_opts (g, filename,\n"
2957 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2958 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
2964 #: ../src/guestfs.pod:1485
2966 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
2971 #: ../src/guestfs.pod:1488
2972 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
2976 #: ../src/guestfs.pod:1490
2978 "The second variant has the same name with the suffix C<_va>, which works the "
2979 "same way but takes a C<va_list>. See the C manual for details. For the "
2980 "example function, this is declared:"
2984 #: ../src/guestfs.pod:1494
2987 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
2993 #: ../src/guestfs.pod:1497
2994 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
2998 #: ../src/guestfs.pod:1499
3000 "The third variant is useful where you need to construct these calls. You "
3001 "pass in a structure where you fill in the optional fields. The structure "
3002 "has a bitmask as the first element which you must set to indicate which "
3003 "fields you have filled in. For our example function the structure and call "
3008 #: ../src/guestfs.pod:1505
3011 " struct guestfs_add_drive_opts_argv {\n"
3012 " uint64_t bitmask;\n"
3014 " const char *format;\n"
3017 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3018 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3023 #: ../src/guestfs.pod:1514
3024 msgid "You could call it like this:"
3028 #: ../src/guestfs.pod:1516
3031 " struct guestfs_add_drive_opts_argv optargs = {\n"
3032 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3033 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3035 " .format = \"qcow2\"\n"
3041 #: ../src/guestfs.pod:1523
3044 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3049 #: ../src/guestfs.pod:1525 ../src/guestfs-actions.pod:11
3050 #: ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9
3051 #: ../fish/guestfish-actions.pod:1255
3056 #: ../src/guestfs.pod:1531
3057 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3061 #: ../src/guestfs.pod:1536
3062 msgid "You do not need to fill in all fields of the structure."
3066 #: ../src/guestfs.pod:1540
3068 "There must be a one-to-one correspondence between fields of the structure "
3069 "that are filled in, and bits set in the bitmask."
3073 #: ../src/guestfs.pod:1545
3074 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3078 #: ../src/guestfs.pod:1547
3080 "In other languages, optional arguments are expressed in the way that is "
3081 "natural for that language. We refer you to the language-specific "
3082 "documentation for more details on that."
3086 #: ../src/guestfs.pod:1551
3087 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3091 #: ../src/guestfs.pod:1553
3092 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3096 #: ../src/guestfs.pod:1555
3098 "The child process generates events in some situations. Current events "
3099 "include: receiving a log message, the child process exits."
3103 #: ../src/guestfs.pod:1558
3105 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3110 #: ../src/guestfs.pod:1561
3112 "Only I<one callback of each type> can be registered for each handle. "
3113 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3114 "that type. Cancel all callbacks of this type by calling this function with "
3115 "C<cb> set to C<NULL>."
3119 #: ../src/guestfs.pod:1566
3120 msgid "guestfs_set_log_message_callback"
3124 #: ../src/guestfs.pod:1568
3127 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3128 " char *buf, int len);\n"
3129 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3130 " guestfs_log_message_cb cb,\n"
3136 #: ../src/guestfs.pod:1574
3138 "The callback function C<cb> will be called whenever qemu or the guest writes "
3139 "anything to the console."
3143 #: ../src/guestfs.pod:1577
3144 msgid "Use this function to capture kernel messages and similar."
3148 #: ../src/guestfs.pod:1579
3150 "Normally there is no log message handler, and log messages are just "
3155 #: ../src/guestfs.pod:1582
3156 msgid "guestfs_set_subprocess_quit_callback"
3160 #: ../src/guestfs.pod:1584
3163 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3164 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3165 " guestfs_subprocess_quit_cb cb,\n"
3171 #: ../src/guestfs.pod:1589
3173 "The callback function C<cb> will be called when the child process quits, "
3174 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3175 "corresponds to a transition from any state to the CONFIG state)."
3179 #: ../src/guestfs.pod:1594
3180 msgid "guestfs_set_launch_done_callback"
3184 #: ../src/guestfs.pod:1596
3187 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3188 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3189 " guestfs_launch_done_cb cb,\n"
3195 #: ../src/guestfs.pod:1601
3197 "The callback function C<cb> will be called when the child process becomes "
3198 "ready first time after it has been launched. (This corresponds to a "
3199 "transition from LAUNCHING to the READY state)."
3203 #: ../src/guestfs.pod:1605
3204 msgid "guestfs_set_close_callback"
3208 #: ../src/guestfs.pod:1607
3211 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3212 " void guestfs_set_close_callback (guestfs_h *g,\n"
3213 " guestfs_close_cb cb,\n"
3219 #: ../src/guestfs.pod:1612
3221 "The callback function C<cb> will be called while the handle is being closed "
3222 "(synchronously from L</guestfs_close>)."
3226 #: ../src/guestfs.pod:1615
3228 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3229 "handles that are open when the program exits. This means that this callback "
3230 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3231 "problems in higher-level languages (eg. if your HLL interpreter has already "
3232 "been cleaned up by the time this is called, and if your callback then jumps "
3233 "into some HLL function)."
3237 #: ../src/guestfs.pod:1623
3238 msgid "guestfs_set_progress_callback"
3242 #: ../src/guestfs.pod:1625
3245 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3246 " int proc_nr, int serial,\n"
3247 " uint64_t position, uint64_t total);\n"
3248 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3249 " guestfs_progress_cb cb,\n"
3255 #: ../src/guestfs.pod:1632
3257 "Some long-running operations can generate progress messages. If this "
3258 "callback is registered, then it will be called each time a progress message "
3259 "is generated (usually two seconds after the operation started, and three "
3260 "times per second thereafter until it completes, although the frequency may "
3261 "change in future versions)."
3265 #: ../src/guestfs.pod:1638
3267 "The callback receives two numbers: C<position> and C<total>. The units of "
3268 "C<total> are not defined, although for some operations C<total> may relate "
3269 "in some way to the amount of data to be transferred (eg. in bytes or "
3270 "megabytes), and C<position> may be the portion which has been transferred."
3274 #: ../src/guestfs.pod:1644
3275 msgid "The only defined and stable parts of the API are:"
3279 #: ../src/guestfs.pod:1650
3281 "The callback can display to the user some type of progress bar or indicator "
3282 "which shows the ratio of C<position>:C<total>."
3286 #: ../src/guestfs.pod:1655
3287 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3291 #: ../src/guestfs.pod:1659
3293 "If any progress notification is sent during a call, then a final progress "
3294 "notification is always sent when C<position> = C<total>."
3298 #: ../src/guestfs.pod:1662
3300 "This is to simplify caller code, so callers can easily set the progress "
3301 "indicator to \"100%\" at the end of the operation, without requiring special "
3302 "code to detect this case."
3306 #: ../src/guestfs.pod:1668
3308 "The callback also receives the procedure number and serial number of the "
3309 "call. These are only useful for debugging protocol issues, and the callback "
3310 "can normally ignore them. The callback may want to print these numbers in "
3311 "error messages or debugging messages."
3315 #: ../src/guestfs.pod:1673
3316 msgid "PRIVATE DATA AREA"
3320 #: ../src/guestfs.pod:1675
3322 "You can attach named pieces of private data to the libguestfs handle, and "
3323 "fetch them by name for the lifetime of the handle. This is called the "
3324 "private data area and is only available from the C API."
3328 #: ../src/guestfs.pod:1679
3329 msgid "To attach a named piece of data, use the following call:"
3333 #: ../src/guestfs.pod:1681
3336 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3341 #: ../src/guestfs.pod:1683
3343 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3344 "pointer (which can be C<NULL>). Any previous item with the same name is "
3349 #: ../src/guestfs.pod:1687
3351 "You can use any C<key> you want, but names beginning with an underscore "
3352 "character are reserved for internal libguestfs purposes (for implementing "
3353 "language bindings). It is recommended to prefix the name with some unique "
3354 "string to avoid collisions with other users."
3358 #: ../src/guestfs.pod:1692
3359 msgid "To retrieve the pointer, use:"
3363 #: ../src/guestfs.pod:1694
3366 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3371 #: ../src/guestfs.pod:1696
3373 "This function returns C<NULL> if either no data is found associated with "
3374 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3379 #: ../src/guestfs.pod:1700
3381 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3382 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3383 "all. In particular, libguestfs does I<not> try to free the data when the "
3384 "handle is closed. If the data must be freed, then the caller must either "
3385 "free it before calling L</guestfs_close> or must set up a close callback to "
3386 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3387 "can be registered for a handle)."
3391 #: ../src/guestfs.pod:1708
3393 "The private data area is implemented using a hash table, and should be "
3394 "reasonably efficient for moderate numbers of keys."
3398 #: ../src/guestfs.pod:1711 ../src/guestfs.pod:1716
3403 #: ../src/guestfs.pod:1713
3405 "<!-- old anchor for the next section --> <a name="
3406 "\"state_machine_and_low_level_event_api\"/>"
3410 #: ../src/guestfs.pod:1718
3411 msgid "ARCHITECTURE"
3415 #: ../src/guestfs.pod:1720
3417 "Internally, libguestfs is implemented by running an appliance (a special "
3418 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
3419 "process of the main program."
3423 #: ../src/guestfs.pod:1724
3426 " ___________________\n"
3428 " | main program |\n"
3430 " | | child process / appliance\n"
3431 " | | __________________________\n"
3433 " +-------------------+ RPC | +-----------------+ |\n"
3434 " | libguestfs <--------------------> guestfsd | |\n"
3435 " | | | +-----------------+ |\n"
3436 " \\___________________/ | | Linux kernel | |\n"
3437 " | +--^--------------+ |\n"
3438 " \\_________|________________/\n"
3444 " \\______________/\n"
3449 #: ../src/guestfs.pod:1744
3451 "The library, linked to the main program, creates the child process and hence "
3452 "the appliance in the L</guestfs_launch> function."
3456 #: ../src/guestfs.pod:1747
3458 "Inside the appliance is a Linux kernel and a complete stack of userspace "
3459 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
3460 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
3461 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
3462 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
3463 "attached to the qemu process which translates device access by the "
3464 "appliance's Linux kernel into accesses to the image."
3468 #: ../src/guestfs.pod:1756
3470 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
3471 "Although the disk image you are attached to might also be used by some "
3472 "virtual machine, libguestfs doesn't know or care about this. (But you will "
3473 "care if both libguestfs's qemu process and your virtual machine are trying "
3474 "to update the disk image at the same time, since these usually results in "
3475 "massive disk corruption)."
3479 #: ../src/guestfs.pod:1763
3480 msgid "STATE MACHINE"
3484 #: ../src/guestfs.pod:1765
3485 msgid "libguestfs uses a state machine to model the child process:"
3489 #: ../src/guestfs.pod:1767
3501 " / | \\ \\ guestfs_launch\n"
3502 " / | _\\__V______\n"
3504 " / | | LAUNCHING |\n"
3505 " / | \\___________/\n"
3507 " / | guestfs_launch\n"
3509 " ______ / __|____V\n"
3510 " / \\ ------> / \\\n"
3511 " | BUSY | | READY |\n"
3512 " \\______/ <------ \\________/\n"
3517 #: ../src/guestfs.pod:1789
3519 "The normal transitions are (1) CONFIG (when the handle is created, but there "
3520 "is no child process), (2) LAUNCHING (when the child process is booting up), "
3521 "(3) alternating between READY and BUSY as commands are issued to, and "
3522 "carried out by, the child process."
3526 #: ../src/guestfs.pod:1794
3528 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
3529 "asynchronously at any time (eg. due to some internal error), and that causes "
3530 "the state to transition back to CONFIG."
3534 #: ../src/guestfs.pod:1798
3536 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
3537 "issued when in the CONFIG state."
3541 #: ../src/guestfs.pod:1801
3543 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
3544 "L</guestfs_launch> blocks until the child process is READY to accept "
3545 "commands (or until some failure or timeout). L</guestfs_launch> internally "
3546 "moves the state from CONFIG to LAUNCHING while it is running."
3550 #: ../src/guestfs.pod:1807
3552 "API actions such as L</guestfs_mount> can only be issued when in the READY "
3553 "state. These API calls block waiting for the command to be carried out (ie. "
3554 "the state to transition to BUSY and then back to READY). There are no non-"
3555 "blocking versions, and no way to issue more than one command per handle at "
3560 #: ../src/guestfs.pod:1813
3562 "Finally, the child process sends asynchronous messages back to the main "
3563 "program, such as kernel log messages. You can register a callback to "
3564 "receive these messages."
3568 #: ../src/guestfs.pod:1817
3573 #: ../src/guestfs.pod:1819
3574 msgid "COMMUNICATION PROTOCOL"
3578 #: ../src/guestfs.pod:1821
3580 "Don't rely on using this protocol directly. This section documents how it "
3581 "currently works, but it may change at any time."
3585 #: ../src/guestfs.pod:1824
3587 "The protocol used to talk between the library and the daemon running inside "
3588 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3589 "1014, RFC 1832, RFC 4506)."
3593 #: ../src/guestfs.pod:1828
3595 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3596 "this file is automatically generated)."
3600 #: ../src/guestfs.pod:1831
3602 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3603 "and C<FileOut> parameters, which are handled with very simple request/reply "
3604 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3605 "parameters, which use the same request and reply messages, but they may also "
3606 "be followed by files sent using a chunked encoding."
3610 #: ../src/guestfs.pod:1838
3611 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3615 #: ../src/guestfs.pod:1840
3616 msgid "For ordinary functions, the request message is:"
3620 #: ../src/guestfs.pod:1842
3623 " total length (header + arguments,\n"
3624 " but not including the length word itself)\n"
3625 " struct guestfs_message_header (encoded as XDR)\n"
3626 " struct guestfs_<foo>_args (encoded as XDR)\n"
3631 #: ../src/guestfs.pod:1847
3633 "The total length field allows the daemon to allocate a fixed size buffer "
3634 "into which it slurps the rest of the message. As a result, the total length "
3635 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3636 "effective size of any request is limited to somewhere under this size."
3640 #: ../src/guestfs.pod:1853
3642 "Note also that many functions don't take any arguments, in which case the "
3643 "C<guestfs_I<foo>_args> is completely omitted."
3647 #: ../src/guestfs.pod:1856
3649 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3650 "receiver knows what type of args structure to expect, or none at all."
3654 #: ../src/guestfs.pod:1860
3655 msgid "The reply message for ordinary functions is:"
3659 #: ../src/guestfs.pod:1862
3662 " total length (header + ret,\n"
3663 " but not including the length word itself)\n"
3664 " struct guestfs_message_header (encoded as XDR)\n"
3665 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3670 #: ../src/guestfs.pod:1867
3672 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3673 "functions that return no formal return values."
3677 #: ../src/guestfs.pod:1870
3679 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3683 #: ../src/guestfs.pod:1873
3685 "In the case of an error, a flag is set in the header, and the reply message "
3686 "is slightly changed:"
3690 #: ../src/guestfs.pod:1876
3693 " total length (header + error,\n"
3694 " but not including the length word itself)\n"
3695 " struct guestfs_message_header (encoded as XDR)\n"
3696 " struct guestfs_message_error (encoded as XDR)\n"
3701 #: ../src/guestfs.pod:1881
3703 "The C<guestfs_message_error> structure contains the error message as a "
3708 #: ../src/guestfs.pod:1884
3709 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3713 #: ../src/guestfs.pod:1886
3715 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3716 "The normal request message is sent (see above). However this is followed by "
3717 "a sequence of file chunks."
3721 #: ../src/guestfs.pod:1890
3724 " total length (header + arguments,\n"
3725 " but not including the length word itself,\n"
3726 " and not including the chunks)\n"
3727 " struct guestfs_message_header (encoded as XDR)\n"
3728 " struct guestfs_<foo>_args (encoded as XDR)\n"
3729 " sequence of chunks for FileIn param #0\n"
3730 " sequence of chunks for FileIn param #1 etc.\n"
3735 #: ../src/guestfs.pod:1898
3736 msgid "The \"sequence of chunks\" is:"
3740 #: ../src/guestfs.pod:1900
3743 " length of chunk (not including length word itself)\n"
3744 " struct guestfs_chunk (encoded as XDR)\n"
3745 " length of chunk\n"
3746 " struct guestfs_chunk (encoded as XDR)\n"
3748 " length of chunk\n"
3749 " struct guestfs_chunk (with data.data_len == 0)\n"
3754 #: ../src/guestfs.pod:1908
3756 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3757 "is set in the final chunk to indicate either successful completion or early "
3762 #: ../src/guestfs.pod:1912
3764 "At time of writing there are no functions that have more than one FileIn "
3765 "parameter. However this is (theoretically) supported, by sending the "
3766 "sequence of chunks for each FileIn parameter one after another (from left to "
3771 #: ../src/guestfs.pod:1917
3773 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3774 "transfer. The library does this by sending a chunk with a special flag set "
3775 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3776 "RPC, does I<not> send any reply, and goes back to reading the next request."
3780 #: ../src/guestfs.pod:1923
3782 "The daemon may also cancel. It does this by writing a special word "
3783 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3784 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3785 "cancel chunk). The special word is chosen so that even if cancellation "
3786 "happens right at the end of the transfer (after the library has finished "
3787 "writing and has started listening for the reply), the \"spurious\" cancel "
3788 "flag will not be confused with the reply message."
3792 #: ../src/guestfs.pod:1932
3794 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3795 "limit), and also files where the size is not known in advance (eg. from "
3796 "pipes or sockets). However the chunks are rather small "
3797 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3798 "to keep much in memory."
3802 #: ../src/guestfs.pod:1938
3803 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3807 #: ../src/guestfs.pod:1940
3809 "The protocol for FileOut parameters is exactly the same as for FileIn "
3810 "parameters, but with the roles of daemon and library reversed."
3814 #: ../src/guestfs.pod:1943
3817 " total length (header + ret,\n"
3818 " but not including the length word itself,\n"
3819 " and not including the chunks)\n"
3820 " struct guestfs_message_header (encoded as XDR)\n"
3821 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3822 " sequence of chunks for FileOut param #0\n"
3823 " sequence of chunks for FileOut param #1 etc.\n"
3828 #: ../src/guestfs.pod:1951
3829 msgid "INITIAL MESSAGE"
3833 #: ../src/guestfs.pod:1953
3835 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3836 "which indicates that the guest and daemon is alive. This is what L</"
3837 "guestfs_launch> waits for."
3841 #: ../src/guestfs.pod:1957
3842 msgid "PROGRESS NOTIFICATION MESSAGES"
3846 #: ../src/guestfs.pod:1959
3848 "The daemon may send progress notification messages at any time. These are "
3849 "distinguished by the normal length word being replaced by "
3850 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3854 #: ../src/guestfs.pod:1963
3856 "The library turns them into progress callbacks (see "
3857 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3858 "discards them if not."
3862 #: ../src/guestfs.pod:1967
3864 "The daemon self-limits the frequency of progress messages it sends (see "
3865 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3870 #: ../src/guestfs.pod:1971
3871 msgid "LIBGUESTFS VERSION NUMBERS"
3875 #: ../src/guestfs.pod:1973
3877 "Since April 2010, libguestfs has started to make separate development and "
3878 "stable releases, along with corresponding branches in our git repository. "
3879 "These separate releases can be identified by version number:"
3883 #: ../src/guestfs.pod:1978
3886 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3887 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3893 " | `-------- sub-version\n"
3895 " `------ always '1' because we don't change the ABI\n"
3900 #: ../src/guestfs.pod:1989
3901 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3905 #: ../src/guestfs.pod:1991
3907 "As time passes we cherry pick fixes from the development branch and backport "
3908 "those into the stable branch, the effect being that the stable branch should "
3909 "get more stable and less buggy over time. So the stable releases are ideal "
3910 "for people who don't need new features but would just like the software to "
3915 #: ../src/guestfs.pod:1997
3916 msgid "Our criteria for backporting changes are:"
3920 #: ../src/guestfs.pod:2003
3922 "Documentation changes which don't affect any code are backported unless the "
3923 "documentation refers to a future feature which is not in stable."
3927 #: ../src/guestfs.pod:2009
3929 "Bug fixes which are not controversial, fix obvious problems, and have been "
3930 "well tested are backported."
3934 #: ../src/guestfs.pod:2014
3936 "Simple rearrangements of code which shouldn't affect how it works get "
3937 "backported. This is so that the code in the two branches doesn't get too "
3938 "far out of step, allowing us to backport future fixes more easily."
3942 #: ../src/guestfs.pod:2020
3944 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3945 "exceptional case: the new feature is required in order to implement an "
3946 "important bug fix."
3950 #: ../src/guestfs.pod:2026
3952 "A new stable branch starts when we think the new features in development are "
3953 "substantial and compelling enough over the current stable branch to warrant "
3954 "it. When that happens we create new stable and development versions 1.N.0 "
3955 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
3956 "stable at this point, but by backporting fixes from development, that branch "
3957 "will stabilize over time."
3961 #: ../src/guestfs.pod:2034 ../fish/guestfish.pod:914
3962 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
3963 #: ../tools/virt-rescue.pl:255
3964 msgid "ENVIRONMENT VARIABLES"
3968 #: ../src/guestfs.pod:2038 ../fish/guestfish.pod:940
3969 msgid "LIBGUESTFS_APPEND"
3973 #: ../src/guestfs.pod:2040 ../fish/guestfish.pod:942
3974 msgid "Pass additional options to the guest kernel."
3978 #: ../src/guestfs.pod:2042 ../fish/guestfish.pod:944
3979 msgid "LIBGUESTFS_DEBUG"
3983 #: ../src/guestfs.pod:2044
3985 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
3986 "effect as calling C<guestfs_set_verbose (g, 1)>."
3990 #: ../src/guestfs.pod:2047 ../fish/guestfish.pod:949
3991 msgid "LIBGUESTFS_MEMSIZE"
3995 #: ../src/guestfs.pod:2049 ../fish/guestfish.pod:951
3997 "Set the memory allocated to the qemu process, in megabytes. For example:"
4001 #: ../src/guestfs.pod:2052 ../fish/guestfish.pod:954
4004 " LIBGUESTFS_MEMSIZE=700\n"
4009 #: ../src/guestfs.pod:2054 ../fish/guestfish.pod:956
4010 msgid "LIBGUESTFS_PATH"
4014 #: ../src/guestfs.pod:2056
4016 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
4017 "the discussion of paths in section PATH above."
4021 #: ../src/guestfs.pod:2059 ../fish/guestfish.pod:961
4022 msgid "LIBGUESTFS_QEMU"
4026 #: ../src/guestfs.pod:2061 ../fish/guestfish.pod:963
4028 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
4029 "which was found at compile time by the configure script is used."
4033 #: ../src/guestfs.pod:2065
4034 msgid "See also L</QEMU WRAPPERS> above."
4038 #: ../src/guestfs.pod:2067 ../fish/guestfish.pod:967
4039 msgid "LIBGUESTFS_TRACE"
4043 #: ../src/guestfs.pod:2069
4045 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
4046 "effect as calling C<guestfs_set_trace (g, 1)>."
4050 #: ../src/guestfs.pod:2072 ../fish/guestfish.pod:976
4055 #: ../src/guestfs.pod:2074 ../fish/guestfish.pod:978
4056 msgid "Location of temporary directory, defaults to C</tmp>."
4060 #: ../src/guestfs.pod:2076 ../fish/guestfish.pod:980
4062 "If libguestfs was compiled to use the supermin appliance then the real "
4063 "appliance is cached in this directory, shared between all handles belonging "
4064 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
4065 "use in case C</tmp> is not large enough."
4069 #: ../src/guestfs.pod:2084 ../fish/guestfish.pod:1038
4070 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233
4071 #: ../inspector/virt-inspector.pl:452 ../tools/virt-edit.pl:350
4072 #: ../tools/virt-win-reg.pl:484 ../tools/virt-df.pl:640
4073 #: ../tools/virt-ls.pl:232 ../tools/virt-resize.pl:1486
4074 #: ../tools/virt-list-filesystems.pl:186 ../tools/virt-tar.pl:281
4075 #: ../tools/virt-rescue.pl:267 ../tools/virt-make-fs.pl:534
4076 #: ../tools/virt-list-partitions.pl:254
4081 #: ../src/guestfs.pod:2086
4083 "L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, L<virt-edit"
4084 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
4085 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
4086 "tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
4087 "L<http://libguestfs.org/>."
4091 #: ../src/guestfs.pod:2104
4093 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
4094 "(8)>, L<disktype(1)>."
4098 #: ../src/guestfs.pod:2111 ../tools/virt-win-reg.pl:499
4099 #: ../tools/virt-make-fs.pl:548
4104 #: ../src/guestfs.pod:2113
4105 msgid "To get a list of bugs against libguestfs use this link:"
4109 #: ../src/guestfs.pod:2115
4111 "L<https://bugzilla.redhat.com/buglist.cgi?"
4112 "component=libguestfs&product=Virtualization+Tools>"
4116 #: ../src/guestfs.pod:2117
4117 msgid "To report a new bug against libguestfs use this link:"
4121 #: ../src/guestfs.pod:2119
4123 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
4124 "component=libguestfs&product=Virtualization+Tools>"
4128 #: ../src/guestfs.pod:2121
4129 msgid "When reporting a bug, please check:"
4133 #: ../src/guestfs.pod:2127
4134 msgid "That the bug hasn't been reported already."
4138 #: ../src/guestfs.pod:2131
4139 msgid "That you are testing a recent version."
4143 #: ../src/guestfs.pod:2135
4144 msgid "Describe the bug accurately, and give a way to reproduce it."
4148 #: ../src/guestfs.pod:2139
4150 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
4155 #: ../src/guestfs.pod:2144 ../fish/guestfish.pod:1055
4156 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
4157 #: ../inspector/virt-inspector.pl:462
4162 #: ../src/guestfs.pod:2146 ../fish/guestfish.pod:1057
4163 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
4164 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4168 #: ../src/guestfs.pod:2148 ../fish/guestfish.pod:1059
4169 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248
4170 #: ../inspector/virt-inspector.pl:476 ../tools/virt-edit.pl:366
4171 #: ../tools/virt-win-reg.pl:514 ../tools/virt-df.pl:653
4172 #: ../tools/virt-ls.pl:247 ../tools/virt-resize.pl:1512
4173 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:296
4174 #: ../tools/virt-rescue.pl:281 ../tools/virt-make-fs.pl:563
4175 #: ../tools/virt-list-partitions.pl:269
4180 #: ../src/guestfs.pod:2150 ../fish/guestfish.pod:1061
4181 #: ../fuse/guestmount.pod:250
4182 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
4186 #: ../src/guestfs.pod:2153
4188 "This library is free software; you can redistribute it and/or modify it "
4189 "under the terms of the GNU Lesser General Public License as published by the "
4190 "Free Software Foundation; either version 2 of the License, or (at your "
4191 "option) any later version."
4195 #: ../src/guestfs.pod:2158
4197 "This library is distributed in the hope that it will be useful, but WITHOUT "
4198 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4199 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4204 #: ../src/guestfs.pod:2163
4206 "You should have received a copy of the GNU Lesser General Public License "
4207 "along with this library; if not, write to the Free Software Foundation, "
4208 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4212 #: ../src/guestfs-actions.pod:1
4213 msgid "guestfs_add_cdrom"
4217 #: ../src/guestfs-actions.pod:3
4221 " guestfs_add_cdrom (guestfs_h *g,\n"
4222 " const char *filename);\n"
4227 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
4228 msgid "This function adds a virtual CD-ROM disk image to the guest."
4232 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
4233 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
4237 #: ../src/guestfs-actions.pod:17
4239 "This call checks for the existence of C<filename>. This stops you from "
4240 "specifying other types of drive which are supported by qemu such as C<nbd:> "
4241 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
4246 #: ../src/guestfs-actions.pod:24
4248 "If you just want to add an ISO file (often you use this as an efficient way "
4249 "to transfer large files into the guest), then you should probably use "
4250 "C<guestfs_add_drive_ro> instead."
4254 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126
4255 #: ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224
4256 #: ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259
4257 #: ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293
4258 #: ../src/guestfs-actions.pod:408 ../src/guestfs-actions.pod:428
4259 #: ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:487
4260 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:533
4261 #: ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:633
4262 #: ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:662
4263 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779
4264 #: ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807
4265 #: ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:988
4266 #: ../src/guestfs-actions.pod:1006 ../src/guestfs-actions.pod:1090
4267 #: ../src/guestfs-actions.pod:1108 ../src/guestfs-actions.pod:1127
4268 #: ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1161
4269 #: ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1262
4270 #: ../src/guestfs-actions.pod:1287 ../src/guestfs-actions.pod:1324
4271 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1464
4272 #: ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1704
4273 #: ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:2213
4274 #: ../src/guestfs-actions.pod:2357 ../src/guestfs-actions.pod:2418
4275 #: ../src/guestfs-actions.pod:2453 ../src/guestfs-actions.pod:3182
4276 #: ../src/guestfs-actions.pod:3197 ../src/guestfs-actions.pod:3217
4277 #: ../src/guestfs-actions.pod:3342 ../src/guestfs-actions.pod:3356
4278 #: ../src/guestfs-actions.pod:3369 ../src/guestfs-actions.pod:3383
4279 #: ../src/guestfs-actions.pod:3398 ../src/guestfs-actions.pod:3434
4280 #: ../src/guestfs-actions.pod:3506 ../src/guestfs-actions.pod:3526
4281 #: ../src/guestfs-actions.pod:3543 ../src/guestfs-actions.pod:3566
4282 #: ../src/guestfs-actions.pod:3589 ../src/guestfs-actions.pod:3621
4283 #: ../src/guestfs-actions.pod:3640 ../src/guestfs-actions.pod:3659
4284 #: ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:3706
4285 #: ../src/guestfs-actions.pod:3742 ../src/guestfs-actions.pod:3758
4286 #: ../src/guestfs-actions.pod:3771 ../src/guestfs-actions.pod:3786
4287 #: ../src/guestfs-actions.pod:3803 ../src/guestfs-actions.pod:3896
4288 #: ../src/guestfs-actions.pod:3916 ../src/guestfs-actions.pod:3929
4289 #: ../src/guestfs-actions.pod:3980 ../src/guestfs-actions.pod:3998
4290 #: ../src/guestfs-actions.pod:4016 ../src/guestfs-actions.pod:4032
4291 #: ../src/guestfs-actions.pod:4046 ../src/guestfs-actions.pod:4060
4292 #: ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:4092
4293 #: ../src/guestfs-actions.pod:4112 ../src/guestfs-actions.pod:4161
4294 #: ../src/guestfs-actions.pod:4192 ../src/guestfs-actions.pod:4211
4295 #: ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:4242
4296 #: ../src/guestfs-actions.pod:4259 ../src/guestfs-actions.pod:4272
4297 #: ../src/guestfs-actions.pod:4287 ../src/guestfs-actions.pod:4302
4298 #: ../src/guestfs-actions.pod:4337 ../src/guestfs-actions.pod:4352
4299 #: ../src/guestfs-actions.pod:4372 ../src/guestfs-actions.pod:4386
4300 #: ../src/guestfs-actions.pod:4403 ../src/guestfs-actions.pod:4452
4301 #: ../src/guestfs-actions.pod:4489 ../src/guestfs-actions.pod:4503
4302 #: ../src/guestfs-actions.pod:4531 ../src/guestfs-actions.pod:4548
4303 #: ../src/guestfs-actions.pod:4566 ../src/guestfs-actions.pod:4700
4304 #: ../src/guestfs-actions.pod:4757 ../src/guestfs-actions.pod:4779
4305 #: ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4829
4306 #: ../src/guestfs-actions.pod:4895 ../src/guestfs-actions.pod:4912
4307 #: ../src/guestfs-actions.pod:4925 ../src/guestfs-actions.pod:4939
4308 #: ../src/guestfs-actions.pod:5228 ../src/guestfs-actions.pod:5247
4309 #: ../src/guestfs-actions.pod:5261 ../src/guestfs-actions.pod:5273
4310 #: ../src/guestfs-actions.pod:5287 ../src/guestfs-actions.pod:5299
4311 #: ../src/guestfs-actions.pod:5313 ../src/guestfs-actions.pod:5329
4312 #: ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:5369
4313 #: ../src/guestfs-actions.pod:5388 ../src/guestfs-actions.pod:5406
4314 #: ../src/guestfs-actions.pod:5429 ../src/guestfs-actions.pod:5447
4315 #: ../src/guestfs-actions.pod:5466 ../src/guestfs-actions.pod:5487
4316 #: ../src/guestfs-actions.pod:5506 ../src/guestfs-actions.pod:5523
4317 #: ../src/guestfs-actions.pod:5551 ../src/guestfs-actions.pod:5575
4318 #: ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:5618
4319 #: ../src/guestfs-actions.pod:5633 ../src/guestfs-actions.pod:5648
4320 #: ../src/guestfs-actions.pod:5667 ../src/guestfs-actions.pod:5704
4321 #: ../src/guestfs-actions.pod:5727 ../src/guestfs-actions.pod:5753
4322 #: ../src/guestfs-actions.pod:5861 ../src/guestfs-actions.pod:5982
4323 #: ../src/guestfs-actions.pod:5994 ../src/guestfs-actions.pod:6007
4324 #: ../src/guestfs-actions.pod:6020 ../src/guestfs-actions.pod:6042
4325 #: ../src/guestfs-actions.pod:6055 ../src/guestfs-actions.pod:6068
4326 #: ../src/guestfs-actions.pod:6081 ../src/guestfs-actions.pod:6096
4327 #: ../src/guestfs-actions.pod:6155 ../src/guestfs-actions.pod:6172
4328 #: ../src/guestfs-actions.pod:6188 ../src/guestfs-actions.pod:6204
4329 #: ../src/guestfs-actions.pod:6221 ../src/guestfs-actions.pod:6234
4330 #: ../src/guestfs-actions.pod:6254 ../src/guestfs-actions.pod:6290
4331 #: ../src/guestfs-actions.pod:6304 ../src/guestfs-actions.pod:6345
4332 #: ../src/guestfs-actions.pod:6358 ../src/guestfs-actions.pod:6376
4333 #: ../src/guestfs-actions.pod:6405 ../src/guestfs-actions.pod:6436
4334 #: ../src/guestfs-actions.pod:6555 ../src/guestfs-actions.pod:6573
4335 #: ../src/guestfs-actions.pod:6587 ../src/guestfs-actions.pod:6642
4336 #: ../src/guestfs-actions.pod:6655 ../src/guestfs-actions.pod:6700
4337 #: ../src/guestfs-actions.pod:6733 ../src/guestfs-actions.pod:6787
4338 #: ../src/guestfs-actions.pod:6813 ../src/guestfs-actions.pod:6879
4339 #: ../src/guestfs-actions.pod:6898 ../src/guestfs-actions.pod:6927
4340 msgid "This function returns 0 on success or -1 on error."
4344 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240
4345 #: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:28
4346 #: ../fish/guestfish-actions.pod:153 ../fish/guestfish-actions.pod:167
4348 "This function is deprecated. In new code, use the C<add_drive_opts> call "
4353 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243
4354 #: ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435
4355 #: ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1942
4356 #: ../src/guestfs-actions.pod:6821 ../src/guestfs-actions.pod:6990
4357 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:156
4358 #: ../fish/guestfish-actions.pod:170 ../fish/guestfish-actions.pod:951
4359 #: ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1322
4360 #: ../fish/guestfish-actions.pod:4549 ../fish/guestfish-actions.pod:4646
4362 "Deprecated functions will not be removed from the API, but the fact that "
4363 "they are deprecated indicates that there are problems with correct use of "
4368 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128
4369 #: ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1893
4370 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2094
4371 #: ../src/guestfs-actions.pod:3184 ../src/guestfs-actions.pod:3199
4372 #: ../src/guestfs-actions.pod:4339 ../src/guestfs-actions.pod:5408
4373 #: ../src/guestfs-actions.pod:5525 ../src/guestfs-actions.pod:5635
4374 #: ../src/guestfs-actions.pod:6098 ../src/guestfs-actions.pod:6223
4375 #: ../src/guestfs-actions.pod:6735
4376 msgid "(Added in 0.3)"
4380 #: ../src/guestfs-actions.pod:41
4381 msgid "guestfs_add_domain"
4385 #: ../src/guestfs-actions.pod:43
4389 " guestfs_add_domain (guestfs_h *g,\n"
4390 " const char *dom,\n"
4396 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137
4398 "You may supply a list of optional arguments to this call. Use zero or more "
4399 "of the following pairs of parameters, and terminate the list with C<-1> on "
4400 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
4404 #: ../src/guestfs-actions.pod:53
4407 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
4408 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
4409 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
4414 #: ../src/guestfs-actions.pod:57
4416 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
4417 "It works by connecting to libvirt, requesting the domain and domain XML from "
4418 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
4423 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
4425 "The number of disks added is returned. This operation is atomic: if an "
4426 "error is returned, then no disks are added."
4430 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
4432 "This function does some minimal checks to make sure the libvirt domain is "
4433 "not running (unless C<readonly> is true). In a future version we will try "
4434 "to acquire the libvirt lock on each disk."
4438 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
4440 "Disks must be accessible locally. This often means that adding disks from a "
4441 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
4442 "unless those disks are accessible via the same device path locally too."
4446 #: ../src/guestfs-actions.pod:74
4448 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
4449 "libvirt.org/uri.html>). If this is not set then we connect to the default "
4450 "libvirt URI (or one set through an environment variable, see the libvirt "
4451 "documentation for full details). If you are using the C API directly then "
4452 "it is more flexible to create the libvirt connection object yourself, get "
4453 "the domain object, and call C<guestfs_add_libvirt_dom>."
4457 #: ../src/guestfs-actions.pod:82
4459 "The other optional parameters are passed directly through to "
4460 "C<guestfs_add_drive_opts>."
4464 #: ../src/guestfs-actions.pod:85 ../src/guestfs-actions.pod:336
4465 #: ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:679
4466 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728
4467 #: ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:1307
4468 #: ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1864
4469 #: ../src/guestfs-actions.pod:1963 ../src/guestfs-actions.pod:2003
4470 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2081
4471 #: ../src/guestfs-actions.pod:2344 ../src/guestfs-actions.pod:2630
4472 #: ../src/guestfs-actions.pod:2651 ../src/guestfs-actions.pod:4475
4473 #: ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:5009
4474 #: ../src/guestfs-actions.pod:5035 ../src/guestfs-actions.pod:6331
4475 #: ../src/guestfs-actions.pod:6746 ../src/guestfs-actions.pod:6759
4476 #: ../src/guestfs-actions.pod:6772
4477 msgid "On error this function returns -1."
4481 #: ../src/guestfs-actions.pod:87
4482 msgid "guestfs_add_domain_va"
4486 #: ../src/guestfs-actions.pod:89
4490 " guestfs_add_domain_va (guestfs_h *g,\n"
4491 " const char *dom,\n"
4497 #: ../src/guestfs-actions.pod:94
4498 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
4502 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107
4503 #: ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211
4504 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4508 #: ../src/guestfs-actions.pod:98
4509 msgid "guestfs_add_domain_argv"
4513 #: ../src/guestfs-actions.pod:100
4517 " guestfs_add_domain_argv (guestfs_h *g,\n"
4518 " const char *dom,\n"
4519 " const struct guestfs_add_domain_argv *optargs);\n"
4524 #: ../src/guestfs-actions.pod:105
4525 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
4529 #: ../src/guestfs-actions.pod:109
4530 msgid "guestfs_add_drive"
4534 #: ../src/guestfs-actions.pod:111
4538 " guestfs_add_drive (guestfs_h *g,\n"
4539 " const char *filename);\n"
4544 #: ../src/guestfs-actions.pod:115
4546 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
4547 "optional parameters, so the disk is added writable, with the format being "
4548 "detected automatically."
4552 #: ../src/guestfs-actions.pod:119
4554 "Automatic detection of the format opens you up to a potential security hole "
4555 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4556 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4557 "you should think about replacing calls to this function with calls to "
4558 "C<guestfs_add_drive_opts>, and specifying the format."
4562 #: ../src/guestfs-actions.pod:130
4563 msgid "guestfs_add_drive_opts"
4567 #: ../src/guestfs-actions.pod:132
4571 " guestfs_add_drive_opts (guestfs_h *g,\n"
4572 " const char *filename,\n"
4578 #: ../src/guestfs-actions.pod:142
4581 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
4582 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
4583 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
4588 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:92
4590 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4591 "The first time you call this function, the disk appears as C</dev/sda>, the "
4592 "second time as C</dev/sdb>, and so on."
4596 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:97
4598 "You don't necessarily need to be root when using libguestfs. However you "
4599 "obviously do need sufficient permissions to access the filename for whatever "
4600 "operations you want to perform (ie. read access if you just want to read the "
4601 "image or write access if you want to modify the image)."
4605 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:103
4606 msgid "This call checks that C<filename> exists."
4610 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:105
4611 msgid "The optional arguments are:"
4615 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:109
4620 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:111
4622 "If true then the image is treated as read-only. Writes are still allowed, "
4623 "but they are stored in a temporary snapshot overlay which is discarded at "
4624 "the end. The disk that you add is not modified."
4628 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:115
4633 #: ../src/guestfs-actions.pod:171
4635 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4636 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4637 "Possible formats include C<raw> and C<qcow2>."
4641 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:121
4643 "Automatic detection of the format opens you up to a potential security hole "
4644 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4645 "RHBZ#642934. Specifying the format closes this security hole."
4649 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:126
4654 #: ../src/guestfs-actions.pod:182
4656 "This rarely-used option lets you emulate the behaviour of the deprecated "
4657 "C<guestfs_add_drive_with_if> call (q.v.)"
4661 #: ../src/guestfs-actions.pod:189
4662 msgid "(Added in 1.5.23)"
4666 #: ../src/guestfs-actions.pod:191
4667 msgid "guestfs_add_drive_opts_va"
4671 #: ../src/guestfs-actions.pod:193
4675 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
4676 " const char *filename,\n"
4682 #: ../src/guestfs-actions.pod:198
4683 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4687 #: ../src/guestfs-actions.pod:202
4688 msgid "guestfs_add_drive_opts_argv"
4692 #: ../src/guestfs-actions.pod:204
4696 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4697 " const char *filename,\n"
4698 " const struct guestfs_add_drive_opts_argv *optargs);\n"
4703 #: ../src/guestfs-actions.pod:209
4704 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4708 #: ../src/guestfs-actions.pod:213
4709 msgid "guestfs_add_drive_ro"
4713 #: ../src/guestfs-actions.pod:215
4717 " guestfs_add_drive_ro (guestfs_h *g,\n"
4718 " const char *filename);\n"
4723 #: ../src/guestfs-actions.pod:219
4725 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4726 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4727 "disk is added read-only, with the format being detected automatically."
4731 #: ../src/guestfs-actions.pod:226
4732 msgid "(Added in 1.0.38)"
4736 #: ../src/guestfs-actions.pod:228
4737 msgid "guestfs_add_drive_ro_with_if"
4741 #: ../src/guestfs-actions.pod:230
4745 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4746 " const char *filename,\n"
4747 " const char *iface);\n"
4752 #: ../src/guestfs-actions.pod:235
4754 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4755 "QEMU interface emulation to use at run time."
4759 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268
4760 #: ../src/guestfs-actions.pod:2303
4761 msgid "(Added in 1.0.84)"
4765 #: ../src/guestfs-actions.pod:249
4766 msgid "guestfs_add_drive_with_if"
4770 #: ../src/guestfs-actions.pod:251
4774 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4775 " const char *filename,\n"
4776 " const char *iface);\n"
4781 #: ../src/guestfs-actions.pod:256
4783 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4784 "QEMU interface emulation to use at run time."
4788 #: ../src/guestfs-actions.pod:270
4789 msgid "guestfs_aug_clear"
4793 #: ../src/guestfs-actions.pod:272
4797 " guestfs_aug_clear (guestfs_h *g,\n"
4798 " const char *augpath);\n"
4803 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:178
4805 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4806 "L<augtool(1)> C<clear> command."
4810 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2083
4811 msgid "(Added in 1.3.4)"
4815 #: ../src/guestfs-actions.pod:283
4816 msgid "guestfs_aug_close"
4820 #: ../src/guestfs-actions.pod:285
4824 " guestfs_aug_close (guestfs_h *g);\n"
4829 #: ../src/guestfs-actions.pod:288
4831 "Close the current Augeas handle and free up any resources used by it. After "
4832 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4833 "any other Augeas functions."
4837 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320
4838 #: ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352
4839 #: ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430
4840 #: ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:475
4841 #: ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503
4842 #: ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535
4843 #: ../src/guestfs-actions.pod:5086
4844 msgid "(Added in 0.7)"
4848 #: ../src/guestfs-actions.pod:297
4849 msgid "guestfs_aug_defnode"
4853 #: ../src/guestfs-actions.pod:299
4856 " struct guestfs_int_bool *\n"
4857 " guestfs_aug_defnode (guestfs_h *g,\n"
4858 " const char *name,\n"
4859 " const char *expr,\n"
4860 " const char *val);\n"
4865 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:194
4867 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4871 #: ../src/guestfs-actions.pod:308
4873 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4874 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4875 "containing that single node."
4879 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:201
4881 "On success this returns a pair containing the number of nodes in the "
4882 "nodeset, and a boolean flag if a node was created."
4886 #: ../src/guestfs-actions.pod:316
4888 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4889 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4893 #: ../src/guestfs-actions.pod:322
4894 msgid "guestfs_aug_defvar"
4898 #: ../src/guestfs-actions.pod:324
4902 " guestfs_aug_defvar (guestfs_h *g,\n"
4903 " const char *name,\n"
4904 " const char *expr);\n"
4909 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:209
4911 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4912 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4916 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:213
4918 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4919 "evaluates to something which is not a nodeset."
4923 #: ../src/guestfs-actions.pod:340
4924 msgid "guestfs_aug_get"
4928 #: ../src/guestfs-actions.pod:342
4932 " guestfs_aug_get (guestfs_h *g,\n"
4933 " const char *augpath);\n"
4938 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:220
4940 "Look up the value associated with C<path>. If C<path> matches exactly one "
4941 "node, the C<value> is returned."
4945 #: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:849
4946 #: ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:927
4947 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1046
4948 #: ../src/guestfs-actions.pod:1176 ../src/guestfs-actions.pod:1193
4949 #: ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1341
4950 #: ../src/guestfs-actions.pod:1532 ../src/guestfs-actions.pod:1644
4951 #: ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824
4952 #: ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1936
4953 #: ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2268
4954 #: ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2556
4955 #: ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2712
4956 #: ../src/guestfs-actions.pod:2741 ../src/guestfs-actions.pod:2763
4957 #: ../src/guestfs-actions.pod:2823 ../src/guestfs-actions.pod:2846
4958 #: ../src/guestfs-actions.pod:3328 ../src/guestfs-actions.pod:3678
4959 #: ../src/guestfs-actions.pod:3848 ../src/guestfs-actions.pod:3958
4960 #: ../src/guestfs-actions.pod:4621 ../src/guestfs-actions.pod:4814
4961 #: ../src/guestfs-actions.pod:4984 ../src/guestfs-actions.pod:5162
4962 #: ../src/guestfs-actions.pod:5211 ../src/guestfs-actions.pod:5774
4963 #: ../src/guestfs-actions.pod:5790 ../src/guestfs-actions.pod:5807
4964 #: ../src/guestfs-actions.pod:5831 ../src/guestfs-actions.pod:6495
4965 #: ../src/guestfs-actions.pod:6514 ../src/guestfs-actions.pod:6532
4966 #: ../src/guestfs-actions.pod:6712 ../src/guestfs-actions.pod:6984
4968 "This function returns a string, or NULL on error. I<The caller must free "
4969 "the returned string after use>."
4973 #: ../src/guestfs-actions.pod:354
4974 msgid "guestfs_aug_init"
4978 #: ../src/guestfs-actions.pod:356
4982 " guestfs_aug_init (guestfs_h *g,\n"
4983 " const char *root,\n"
4989 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:227
4991 "Create a new Augeas handle for editing configuration files. If there was "
4992 "any previous Augeas handle associated with this guestfs session, then it is "
4997 #: ../src/guestfs-actions.pod:365
4998 msgid "You must call this before using any other C<guestfs_aug_*> commands."
5002 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:234
5004 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
5008 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:237
5010 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
5011 "logical I<or> of the following integers:"
5015 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:243
5016 msgid "C<AUG_SAVE_BACKUP> = 1"
5020 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:245
5021 msgid "Keep the original file with a C<.augsave> extension."
5025 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:247
5026 msgid "C<AUG_SAVE_NEWFILE> = 2"
5030 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:249
5032 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5033 "original. Overrides C<AUG_SAVE_BACKUP>."
5037 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:252
5038 msgid "C<AUG_TYPE_CHECK> = 4"
5042 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:254
5043 msgid "Typecheck lenses (can be expensive)."
5047 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:256
5048 msgid "C<AUG_NO_STDINC> = 8"
5052 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:258
5053 msgid "Do not use standard load path for modules."
5057 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:260
5058 msgid "C<AUG_SAVE_NOOP> = 16"
5062 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:262
5063 msgid "Make save a no-op, just record what would have been changed."
5067 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:264
5068 msgid "C<AUG_NO_LOAD> = 32"
5072 #: ../src/guestfs-actions.pod:400
5073 msgid "Do not load the tree in C<guestfs_aug_init>."
5077 #: ../src/guestfs-actions.pod:404
5078 msgid "To close the handle, you can call C<guestfs_aug_close>."
5082 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:272
5083 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5087 #: ../src/guestfs-actions.pod:412
5088 msgid "guestfs_aug_insert"
5092 #: ../src/guestfs-actions.pod:414
5096 " guestfs_aug_insert (guestfs_h *g,\n"
5097 " const char *augpath,\n"
5098 " const char *label,\n"
5104 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:278
5106 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5107 "or after C<path> (depending on the boolean flag C<before>)."
5111 #: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:282
5113 "C<path> must match exactly one existing node in the tree, and C<label> must "
5114 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5118 #: ../src/guestfs-actions.pod:432
5119 msgid "guestfs_aug_load"
5123 #: ../src/guestfs-actions.pod:434
5127 " guestfs_aug_load (guestfs_h *g);\n"
5132 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:290
5133 msgid "Load files into the tree."
5137 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:292
5138 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5142 #: ../src/guestfs-actions.pod:446
5143 msgid "guestfs_aug_ls"
5147 #: ../src/guestfs-actions.pod:448
5151 " guestfs_aug_ls (guestfs_h *g,\n"
5152 " const char *augpath);\n"
5157 #: ../src/guestfs-actions.pod:452
5159 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
5160 "sorting the resulting nodes into alphabetical order."
5164 #: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:471
5165 #: ../src/guestfs-actions.pod:617 ../src/guestfs-actions.pod:1065
5166 #: ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1375
5167 #: ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1497
5168 #: ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:2148
5169 #: ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:2183
5170 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:2250
5171 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2370
5172 #: ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:2782
5173 #: ../src/guestfs-actions.pod:2993 ../src/guestfs-actions.pod:3248
5174 #: ../src/guestfs-actions.pod:3310 ../src/guestfs-actions.pod:3415
5175 #: ../src/guestfs-actions.pod:3820 ../src/guestfs-actions.pod:4436
5176 #: ../src/guestfs-actions.pod:4956 ../src/guestfs-actions.pod:5082
5177 #: ../src/guestfs-actions.pod:5196 ../src/guestfs-actions.pod:5847
5178 #: ../src/guestfs-actions.pod:5908 ../src/guestfs-actions.pod:5963
5179 #: ../src/guestfs-actions.pod:6109 ../src/guestfs-actions.pod:6133
5180 #: ../src/guestfs-actions.pod:6605 ../src/guestfs-actions.pod:6625
5181 #: ../src/guestfs-actions.pod:6672 ../src/guestfs-actions.pod:6837
5182 #: ../src/guestfs-actions.pod:6856 ../src/guestfs-actions.pod:6941
5183 #: ../src/guestfs-actions.pod:6960 ../src/guestfs-actions.pod:7006
5184 #: ../src/guestfs-actions.pod:7025
5186 "This function returns a NULL-terminated array of strings (like L<environ(3)"
5187 ">), or NULL if there was an error. I<The caller must free the strings and "
5188 "the array after use>."
5192 #: ../src/guestfs-actions.pod:459 ../src/guestfs-actions.pod:990
5193 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1413
5194 #: ../src/guestfs-actions.pod:3071 ../src/guestfs-actions.pod:3102
5195 #: ../src/guestfs-actions.pod:3661 ../src/guestfs-actions.pod:3711
5196 #: ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:3931
5197 #: ../src/guestfs-actions.pod:4094 ../src/guestfs-actions.pod:4440
5198 #: ../src/guestfs-actions.pod:4897 ../src/guestfs-actions.pod:5275
5199 #: ../src/guestfs-actions.pod:5289 ../src/guestfs-actions.pod:5301
5200 #: ../src/guestfs-actions.pod:5709 ../src/guestfs-actions.pod:6347
5201 #: ../src/guestfs-actions.pod:6360 ../src/guestfs-actions.pod:6589
5202 #: ../src/guestfs-actions.pod:6792 ../src/guestfs-actions.pod:6825
5203 msgid "(Added in 0.8)"
5207 #: ../src/guestfs-actions.pod:461
5208 msgid "guestfs_aug_match"
5212 #: ../src/guestfs-actions.pod:463
5216 " guestfs_aug_match (guestfs_h *g,\n"
5217 " const char *augpath);\n"
5222 #: ../src/guestfs-actions.pod:467 ../fish/guestfish-actions.pod:306
5224 "Returns a list of paths which match the path expression C<path>. The "
5225 "returned paths are sufficiently qualified so that they match exactly one "
5226 "node in the current tree."
5230 #: ../src/guestfs-actions.pod:477
5231 msgid "guestfs_aug_mv"
5235 #: ../src/guestfs-actions.pod:479
5239 " guestfs_aug_mv (guestfs_h *g,\n"
5240 " const char *src,\n"
5241 " const char *dest);\n"
5246 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:314
5248 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
5249 "C<dest> is overwritten if it exists."
5253 #: ../src/guestfs-actions.pod:491
5254 msgid "guestfs_aug_rm"
5258 #: ../src/guestfs-actions.pod:493
5262 " guestfs_aug_rm (guestfs_h *g,\n"
5263 " const char *augpath);\n"
5268 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:321
5269 msgid "Remove C<path> and all of its children."
5273 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:323
5274 msgid "On success this returns the number of entries which were removed."
5278 #: ../src/guestfs-actions.pod:505
5279 msgid "guestfs_aug_save"
5283 #: ../src/guestfs-actions.pod:507
5287 " guestfs_aug_save (guestfs_h *g);\n"
5292 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:329
5293 msgid "This writes all pending changes to disk."
5297 #: ../src/guestfs-actions.pod:512
5299 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5304 #: ../src/guestfs-actions.pod:519
5305 msgid "guestfs_aug_set"
5309 #: ../src/guestfs-actions.pod:521
5313 " guestfs_aug_set (guestfs_h *g,\n"
5314 " const char *augpath,\n"
5315 " const char *val);\n"
5320 #: ../src/guestfs-actions.pod:526 ../fish/guestfish-actions.pod:338
5321 msgid "Set the value associated with C<path> to C<val>."
5325 #: ../src/guestfs-actions.pod:528
5327 "In the Augeas API, it is possible to clear a node by setting the value to "
5328 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5329 "this call. Instead you must use the C<guestfs_aug_clear> call."
5333 #: ../src/guestfs-actions.pod:537
5334 msgid "guestfs_available"
5338 #: ../src/guestfs-actions.pod:539
5342 " guestfs_available (guestfs_h *g,\n"
5343 " char *const *groups);\n"
5348 #: ../src/guestfs-actions.pod:543 ../fish/guestfish-actions.pod:349
5350 "This command is used to check the availability of some groups of "
5351 "functionality in the appliance, which not all builds of the libguestfs "
5352 "appliance will be able to provide."
5356 #: ../src/guestfs-actions.pod:547
5358 "The libguestfs groups, and the functions that those groups correspond to, "
5359 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5360 "runtime by calling C<guestfs_available_all_groups>."
5364 #: ../src/guestfs-actions.pod:552 ../fish/guestfish-actions.pod:358
5366 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
5367 "\"]> would check for the availability of the Linux inotify functions and "
5368 "Augeas (configuration file editing) functions."
5372 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:363
5373 msgid "The command returns no error if I<all> requested groups are available."
5377 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:365
5379 "It fails with an error if one or more of the requested groups is unavailable "
5384 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:368
5386 "If an unknown group name is included in the list of groups then an error is "
5391 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:371
5396 #: ../src/guestfs-actions.pod:571
5397 msgid "You must call C<guestfs_launch> before calling this function."
5401 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:379
5403 "The reason is because we don't know what groups are supported by the "
5404 "appliance/daemon until it is running and can be queried."
5408 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:385
5410 "If a group of functions is available, this does not necessarily mean that "
5411 "they will work. You still have to check for errors when calling individual "
5412 "API functions even if they are available."
5416 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:392
5418 "It is usually the job of distro packagers to build complete functionality "
5419 "into the libguestfs appliance. Upstream libguestfs, if built from source "
5420 "with all requirements satisfied, will support everything."
5424 #: ../src/guestfs-actions.pod:593
5426 "This call was added in version C<1.0.80>. In previous versions of "
5427 "libguestfs all you could do would be to speculatively execute a command to "
5428 "find out if the daemon implemented it. See also C<guestfs_version>."
5432 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:1163
5433 msgid "(Added in 1.0.80)"
5437 #: ../src/guestfs-actions.pod:604
5438 msgid "guestfs_available_all_groups"
5442 #: ../src/guestfs-actions.pod:606
5446 " guestfs_available_all_groups (guestfs_h *g);\n"
5451 #: ../src/guestfs-actions.pod:609
5453 "This command returns a list of all optional groups that this daemon knows "
5454 "about. Note this returns both supported and unsupported groups. To find "
5455 "out which ones the daemon can actually support you have to call "
5456 "C<guestfs_available> on each member of the returned list."
5460 #: ../src/guestfs-actions.pod:615
5461 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
5465 #: ../src/guestfs-actions.pod:621
5466 msgid "(Added in 1.3.15)"
5470 #: ../src/guestfs-actions.pod:623
5471 msgid "guestfs_base64_in"
5475 #: ../src/guestfs-actions.pod:625
5479 " guestfs_base64_in (guestfs_h *g,\n"
5480 " const char *base64file,\n"
5481 " const char *filename);\n"
5486 #: ../src/guestfs-actions.pod:630 ../fish/guestfish-actions.pod:422
5488 "This command uploads base64-encoded data from C<base64file> to C<filename>."
5492 #: ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649
5493 msgid "(Added in 1.3.5)"
5497 #: ../src/guestfs-actions.pod:637
5498 msgid "guestfs_base64_out"
5502 #: ../src/guestfs-actions.pod:639
5506 " guestfs_base64_out (guestfs_h *g,\n"
5507 " const char *filename,\n"
5508 " const char *base64file);\n"
5513 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:431
5515 "This command downloads the contents of C<filename>, writing it out to local "
5516 "file C<base64file> encoded as base64."
5520 #: ../src/guestfs-actions.pod:651
5521 msgid "guestfs_blockdev_flushbufs"
5525 #: ../src/guestfs-actions.pod:653
5529 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
5530 " const char *device);\n"
5535 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:440
5537 "This tells the kernel to flush internal buffers associated with C<device>."
5541 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:677
5542 #: ../src/guestfs-actions.pod:692 ../src/guestfs-actions.pod:708
5543 #: ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:745
5544 #: ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:777
5545 #: ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805
5546 #: ../fish/guestfish-actions.pod:443 ../fish/guestfish-actions.pod:454
5547 #: ../fish/guestfish-actions.pod:463 ../fish/guestfish-actions.pod:473
5548 #: ../fish/guestfish-actions.pod:485 ../fish/guestfish-actions.pod:498
5549 #: ../fish/guestfish-actions.pod:506 ../fish/guestfish-actions.pod:517
5550 #: ../fish/guestfish-actions.pod:525 ../fish/guestfish-actions.pod:533
5551 msgid "This uses the L<blockdev(8)> command."
5555 #: ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:681
5556 #: ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:712
5557 #: ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749
5558 #: ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781
5559 #: ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809
5560 msgid "(Added in 0.9.3)"
5564 #: ../src/guestfs-actions.pod:666
5565 msgid "guestfs_blockdev_getbsz"
5569 #: ../src/guestfs-actions.pod:668
5573 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
5574 " const char *device);\n"
5579 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:449
5580 msgid "This returns the block size of a device."
5584 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:774
5585 #: ../fish/guestfish-actions.pod:451 ../fish/guestfish-actions.pod:514
5587 "(Note this is different from both I<size in blocks> and I<filesystem block "
5592 #: ../src/guestfs-actions.pod:683
5593 msgid "guestfs_blockdev_getro"
5597 #: ../src/guestfs-actions.pod:685
5601 " guestfs_blockdev_getro (guestfs_h *g,\n"
5602 " const char *device);\n"
5607 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:460
5609 "Returns a boolean indicating if the block device is read-only (true if read-"
5610 "only, false if not)."
5614 #: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:1396
5615 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:1891
5616 #: ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:1974
5617 #: ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2044
5618 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2092
5619 #: ../src/guestfs-actions.pod:3010 ../src/guestfs-actions.pod:3024
5620 #: ../src/guestfs-actions.pod:3039 ../src/guestfs-actions.pod:3053
5621 #: ../src/guestfs-actions.pod:3069 ../src/guestfs-actions.pod:3084
5622 #: ../src/guestfs-actions.pod:3100 ../src/guestfs-actions.pod:3114
5623 #: ../src/guestfs-actions.pod:3127 ../src/guestfs-actions.pod:3141
5624 #: ../src/guestfs-actions.pod:3156 ../src/guestfs-actions.pod:3171
5625 #: ../src/guestfs-actions.pod:4585
5626 msgid "This function returns a C truth value on success or -1 on error."
5630 #: ../src/guestfs-actions.pod:698
5631 msgid "guestfs_blockdev_getsize64"
5635 #: ../src/guestfs-actions.pod:700
5639 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
5640 " const char *device);\n"
5645 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:469
5646 msgid "This returns the size of the device in bytes."
5650 #: ../src/guestfs-actions.pod:706
5651 msgid "See also C<guestfs_blockdev_getsz>."
5655 #: ../src/guestfs-actions.pod:714
5656 msgid "guestfs_blockdev_getss"
5660 #: ../src/guestfs-actions.pod:716
5664 " guestfs_blockdev_getss (guestfs_h *g,\n"
5665 " const char *device);\n"
5670 #: ../src/guestfs-actions.pod:720 ../fish/guestfish-actions.pod:479
5672 "This returns the size of sectors on a block device. Usually 512, but can be "
5673 "larger for modern devices."
5677 #: ../src/guestfs-actions.pod:723
5679 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
5684 #: ../src/guestfs-actions.pod:732
5685 msgid "guestfs_blockdev_getsz"
5689 #: ../src/guestfs-actions.pod:734
5693 " guestfs_blockdev_getsz (guestfs_h *g,\n"
5694 " const char *device);\n"
5699 #: ../src/guestfs-actions.pod:738 ../fish/guestfish-actions.pod:491
5701 "This returns the size of the device in units of 512-byte sectors (even if "
5702 "the sectorsize isn't 512 bytes ... weird)."
5706 #: ../src/guestfs-actions.pod:741
5708 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
5709 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
5713 #: ../src/guestfs-actions.pod:751
5714 msgid "guestfs_blockdev_rereadpt"
5718 #: ../src/guestfs-actions.pod:753
5722 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5723 " const char *device);\n"
5728 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:504
5729 msgid "Reread the partition table on C<device>."
5733 #: ../src/guestfs-actions.pod:765
5734 msgid "guestfs_blockdev_setbsz"
5738 #: ../src/guestfs-actions.pod:767
5742 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5743 " const char *device,\n"
5744 " int blocksize);\n"
5749 #: ../src/guestfs-actions.pod:772 ../fish/guestfish-actions.pod:512
5750 msgid "This sets the block size of a device."
5754 #: ../src/guestfs-actions.pod:783
5755 msgid "guestfs_blockdev_setro"
5759 #: ../src/guestfs-actions.pod:785
5763 " guestfs_blockdev_setro (guestfs_h *g,\n"
5764 " const char *device);\n"
5769 #: ../src/guestfs-actions.pod:789 ../fish/guestfish-actions.pod:523
5770 msgid "Sets the block device named C<device> to read-only."
5774 #: ../src/guestfs-actions.pod:797
5775 msgid "guestfs_blockdev_setrw"
5779 #: ../src/guestfs-actions.pod:799
5783 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5784 " const char *device);\n"
5789 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:531
5790 msgid "Sets the block device named C<device> to read-write."
5794 #: ../src/guestfs-actions.pod:811
5795 msgid "guestfs_case_sensitive_path"
5799 #: ../src/guestfs-actions.pod:813
5803 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5804 " const char *path);\n"
5809 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:539
5811 "This can be used to resolve case insensitive paths on a filesystem which is "
5812 "case sensitive. The use case is to resolve paths which you have read from "
5813 "Windows configuration files or the Windows Registry, to the true path."
5817 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:544
5819 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5820 "(and probably others), which is that although the underlying filesystem is "
5821 "case-insensitive, the driver exports the filesystem to Linux as case-"
5826 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:549
5828 "One consequence of this is that special directories such as C<c:\\windows> "
5829 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5830 "precise details of how they were created. In Windows itself this would not "
5835 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:555
5837 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
5842 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:558
5844 "This function resolves the true case of each element in the path and returns "
5845 "the case-sensitive path."
5849 #: ../src/guestfs-actions.pod:839
5851 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
5852 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5853 "how the directories were originally created under Windows)."
5857 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:566
5858 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5862 #: ../src/guestfs-actions.pod:847
5863 msgid "See also C<guestfs_realpath>."
5867 #: ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:6517
5868 msgid "(Added in 1.0.75)"
5872 #: ../src/guestfs-actions.pod:854
5877 #: ../src/guestfs-actions.pod:856
5881 " guestfs_cat (guestfs_h *g,\n"
5882 " const char *path);\n"
5887 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:5072
5888 #: ../fish/guestfish-actions.pod:575 ../fish/guestfish-actions.pod:3393
5889 msgid "Return the contents of the file named C<path>."
5893 #: ../src/guestfs-actions.pod:862
5895 "Note that this function cannot correctly handle binary files (specifically, "
5896 "files containing C<\\0> character which is treated as end of string). For "
5897 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5898 "functions which have a more complex interface."
5902 #: ../src/guestfs-actions.pod:870 ../src/guestfs-actions.pod:1049
5903 #: ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1360
5904 #: ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1482
5905 #: ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1750
5906 #: ../src/guestfs-actions.pod:2168 ../src/guestfs-actions.pod:2187
5907 #: ../src/guestfs-actions.pod:2230 ../src/guestfs-actions.pod:2254
5908 #: ../src/guestfs-actions.pod:2271 ../src/guestfs-actions.pod:2300
5909 #: ../src/guestfs-actions.pod:4854 ../src/guestfs-actions.pod:4880
5910 #: ../src/guestfs-actions.pod:5011 ../src/guestfs-actions.pod:5037
5911 #: ../src/guestfs-actions.pod:5061 ../src/guestfs-actions.pod:5912
5912 #: ../src/guestfs-actions.pod:5967 ../src/guestfs-actions.pod:6113
5913 #: ../src/guestfs-actions.pod:6137 ../src/guestfs-actions.pod:6789
5914 #: ../src/guestfs-actions.pod:6815 ../src/guestfs-actions.pod:6841
5915 #: ../src/guestfs-actions.pod:6860 ../src/guestfs-actions.pod:6945
5916 #: ../src/guestfs-actions.pod:6964 ../src/guestfs-actions.pod:7010
5917 #: ../src/guestfs-actions.pod:7029 ../fish/guestfish-actions.pod:582
5918 #: ../fish/guestfish-actions.pod:717 ../fish/guestfish-actions.pod:729
5919 #: ../fish/guestfish-actions.pod:905 ../fish/guestfish-actions.pod:915
5920 #: ../fish/guestfish-actions.pod:982 ../fish/guestfish-actions.pod:992
5921 #: ../fish/guestfish-actions.pod:1187 ../fish/guestfish-actions.pod:1462
5922 #: ../fish/guestfish-actions.pod:1472 ../fish/guestfish-actions.pod:1500
5923 #: ../fish/guestfish-actions.pod:1515 ../fish/guestfish-actions.pod:1525
5924 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:3263
5925 #: ../fish/guestfish-actions.pod:3278 ../fish/guestfish-actions.pod:3354
5926 #: ../fish/guestfish-actions.pod:3371 ../fish/guestfish-actions.pod:3386
5927 #: ../fish/guestfish-actions.pod:3969 ../fish/guestfish-actions.pod:4015
5928 #: ../fish/guestfish-actions.pod:4100 ../fish/guestfish-actions.pod:4115
5929 #: ../fish/guestfish-actions.pod:4525 ../fish/guestfish-actions.pod:4543
5930 #: ../fish/guestfish-actions.pod:4560 ../fish/guestfish-actions.pod:4570
5931 #: ../fish/guestfish-actions.pod:4618 ../fish/guestfish-actions.pod:4628
5932 #: ../fish/guestfish-actions.pod:4657 ../fish/guestfish-actions.pod:4667
5934 "Because of the message protocol, there is a transfer limit of somewhere "
5935 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5939 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:3252
5940 #: ../src/guestfs-actions.pod:3314 ../src/guestfs-actions.pod:3331
5941 #: ../src/guestfs-actions.pod:3419 ../src/guestfs-actions.pod:3824
5942 #: ../src/guestfs-actions.pod:3838 ../src/guestfs-actions.pod:4960
5943 #: ../src/guestfs-actions.pod:4974 ../src/guestfs-actions.pod:6676
5944 #: ../src/guestfs-actions.pod:6690
5945 msgid "(Added in 0.4)"
5949 #: ../src/guestfs-actions.pod:875
5950 msgid "guestfs_checksum"
5954 #: ../src/guestfs-actions.pod:877
5958 " guestfs_checksum (guestfs_h *g,\n"
5959 " const char *csumtype,\n"
5960 " const char *path);\n"
5965 #: ../src/guestfs-actions.pod:882 ../fish/guestfish-actions.pod:589
5967 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5971 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:592
5973 "The type of checksum to compute is given by the C<csumtype> parameter which "
5974 "must have one of the following values:"
5978 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:597
5983 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:599
5985 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5990 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:602
5995 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:604
5996 msgid "Compute the MD5 hash (using the C<md5sum> program)."
6000 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:606
6005 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:608
6006 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
6010 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:610
6015 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:612
6016 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
6020 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:614
6025 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:616
6026 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
6030 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:618
6035 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:620
6036 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
6040 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:622
6045 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:624
6046 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
6050 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:628
6051 msgid "The checksum is returned as a printable string."
6055 #: ../src/guestfs-actions.pod:923
6056 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
6060 #: ../src/guestfs-actions.pod:925
6061 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
6065 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:1238
6066 #: ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:3026
6067 #: ../src/guestfs-actions.pod:3055 ../src/guestfs-actions.pod:3116
6068 #: ../src/guestfs-actions.pod:3143 ../src/guestfs-actions.pod:6378
6069 msgid "(Added in 1.0.2)"
6073 #: ../src/guestfs-actions.pod:932
6074 msgid "guestfs_checksum_device"
6078 #: ../src/guestfs-actions.pod:934
6082 " guestfs_checksum_device (guestfs_h *g,\n"
6083 " const char *csumtype,\n"
6084 " const char *device);\n"
6089 #: ../src/guestfs-actions.pod:939
6091 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
6092 "device named C<device>. For the types of checksums supported see the "
6093 "C<guestfs_checksum> command."
6097 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:4491
6098 #: ../src/guestfs-actions.pod:4550 ../src/guestfs-actions.pod:4587
6099 #: ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:4781
6100 #: ../src/guestfs-actions.pod:6292 ../src/guestfs-actions.pod:6306
6101 #: ../src/guestfs-actions.pod:6702
6102 msgid "(Added in 1.3.2)"
6106 #: ../src/guestfs-actions.pod:948
6107 msgid "guestfs_checksums_out"
6111 #: ../src/guestfs-actions.pod:950
6115 " guestfs_checksums_out (guestfs_h *g,\n"
6116 " const char *csumtype,\n"
6117 " const char *directory,\n"
6118 " const char *sumsfile);\n"
6123 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:646
6125 "This command computes the checksums of all regular files in C<directory> and "
6126 "then emits a list of those checksums to the local output file C<sumsfile>."
6130 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:650
6132 "This can be used for verifying the integrity of a virtual machine. However "
6133 "to be properly secure you should pay attention to the output of the checksum "
6134 "command (it uses the ones from GNU coreutils). In particular when the "
6135 "filename is not printable, coreutils uses a special backslash syntax. For "
6136 "more information, see the GNU coreutils info file."
6140 #: ../src/guestfs-actions.pod:970
6141 msgid "(Added in 1.3.7)"
6145 #: ../src/guestfs-actions.pod:972
6146 msgid "guestfs_chmod"
6150 #: ../src/guestfs-actions.pod:974
6154 " guestfs_chmod (guestfs_h *g,\n"
6156 " const char *path);\n"
6161 #: ../src/guestfs-actions.pod:979 ../fish/guestfish-actions.pod:664
6163 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
6168 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:667
6170 "I<Note>: When using this command from guestfish, C<mode> by default would be "
6171 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
6176 #: ../src/guestfs-actions.pod:986 ../src/guestfs-actions.pod:4075
6177 #: ../src/guestfs-actions.pod:4190 ../src/guestfs-actions.pod:4209
6178 #: ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:671
6179 #: ../fish/guestfish-actions.pod:2753 ../fish/guestfish-actions.pod:2838
6180 #: ../fish/guestfish-actions.pod:2848 ../fish/guestfish-actions.pod:2858
6181 msgid "The mode actually set is affected by the umask."
6185 #: ../src/guestfs-actions.pod:992
6186 msgid "guestfs_chown"
6190 #: ../src/guestfs-actions.pod:994
6194 " guestfs_chown (guestfs_h *g,\n"
6197 " const char *path);\n"
6202 #: ../src/guestfs-actions.pod:1000 ../fish/guestfish-actions.pod:677
6203 msgid "Change the file owner to C<owner> and group to C<group>."
6207 #: ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:3213
6208 #: ../fish/guestfish-actions.pod:679 ../fish/guestfish-actions.pod:2231
6210 "Only numeric uid and gid are supported. If you want to use names, you will "
6211 "need to locate and parse the password file yourself (Augeas support makes "
6212 "this relatively easy)."
6216 #: ../src/guestfs-actions.pod:1010
6217 msgid "guestfs_command"
6221 #: ../src/guestfs-actions.pod:1012
6225 " guestfs_command (guestfs_h *g,\n"
6226 " char *const *arguments);\n"
6231 #: ../src/guestfs-actions.pod:1016 ../fish/guestfish-actions.pod:687
6233 "This call runs a command from the guest filesystem. The filesystem must be "
6234 "mounted, and must contain a compatible operating system (ie. something "
6235 "Linux, with the same or compatible processor architecture)."
6239 #: ../src/guestfs-actions.pod:1021
6241 "The single parameter is an argv-style list of arguments. The first element "
6242 "is the name of the program to run. Subsequent elements are parameters. The "
6243 "list must be non-empty (ie. must contain a program name). Note that the "
6244 "command runs directly, and is I<not> invoked via the shell (see "
6249 #: ../src/guestfs-actions.pod:1028 ../fish/guestfish-actions.pod:699
6250 msgid "The return value is anything printed to I<stdout> by the command."
6254 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:702
6256 "If the command returns a non-zero exit status, then this function returns an "
6257 "error message. The error message string is the content of I<stderr> from "
6262 #: ../src/guestfs-actions.pod:1035 ../fish/guestfish-actions.pod:706
6264 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
6265 "bin>. If you require a program from another location, you should provide "
6266 "the full path in the first parameter."
6270 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:711
6272 "Shared libraries and data files required by the program must be available on "
6273 "filesystems which are mounted in the correct places. It is the caller's "
6274 "responsibility to ensure all filesystems that are needed are mounted at the "
6279 #: ../src/guestfs-actions.pod:1052 ../src/guestfs-actions.pod:1072
6280 #: ../src/guestfs-actions.pod:1535
6281 msgid "(Added in 0.9.1)"
6285 #: ../src/guestfs-actions.pod:1054
6286 msgid "guestfs_command_lines"
6290 #: ../src/guestfs-actions.pod:1056
6294 " guestfs_command_lines (guestfs_h *g,\n"
6295 " char *const *arguments);\n"
6300 #: ../src/guestfs-actions.pod:1060
6302 "This is the same as C<guestfs_command>, but splits the result into a list of "
6307 #: ../src/guestfs-actions.pod:1063
6308 msgid "See also: C<guestfs_sh_lines>"
6312 #: ../src/guestfs-actions.pod:1074
6313 msgid "guestfs_config"
6317 #: ../src/guestfs-actions.pod:1076
6321 " guestfs_config (guestfs_h *g,\n"
6322 " const char *qemuparam,\n"
6323 " const char *qemuvalue);\n"
6328 #: ../src/guestfs-actions.pod:1081 ../fish/guestfish-actions.pod:736
6330 "This can be used to add arbitrary qemu command line parameters of the form "
6331 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
6332 "setting some parameters which would interfere with parameters that we use."
6336 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:741
6337 msgid "The first character of C<param> string must be a C<-> (dash)."
6341 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:743
6342 msgid "C<value> can be NULL."
6346 #: ../src/guestfs-actions.pod:1094
6347 msgid "guestfs_copy_size"
6351 #: ../src/guestfs-actions.pod:1096
6355 " guestfs_copy_size (guestfs_h *g,\n"
6356 " const char *src,\n"
6357 " const char *dest,\n"
6363 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:749
6365 "This command copies exactly C<size> bytes from one source device or file "
6366 "C<src> to another destination device or file C<dest>."
6370 #: ../src/guestfs-actions.pod:1105 ../fish/guestfish-actions.pod:752
6372 "Note this will fail if the source is too short or if the destination is not "
6377 #: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1233
6378 #: ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1684
6379 #: ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:6881
6380 #: ../src/guestfs-actions.pod:6900
6382 "This long-running command can generate progress notification messages so "
6383 "that the caller can display a progress bar or indicator. To receive these "
6384 "messages, the caller must register a progress callback. See L<guestfs(3)/"
6385 "guestfs_set_progress_callback>."
6389 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:3851
6390 #: ../src/guestfs-actions.pod:4987 ../src/guestfs-actions.pod:6609
6391 #: ../src/guestfs-actions.pod:6629 ../src/guestfs-actions.pod:6715
6392 msgid "(Added in 1.0.87)"
6396 #: ../src/guestfs-actions.pod:1117
6401 #: ../src/guestfs-actions.pod:1119
6405 " guestfs_cp (guestfs_h *g,\n"
6406 " const char *src,\n"
6407 " const char *dest);\n"
6412 #: ../src/guestfs-actions.pod:1124 ../fish/guestfish-actions.pod:759
6414 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6415 "destination filename or destination directory."
6419 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143
6420 #: ../src/guestfs-actions.pod:1215 ../src/guestfs-actions.pod:1289
6421 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:4454
6422 #: ../src/guestfs-actions.pod:4831
6423 msgid "(Added in 1.0.18)"
6427 #: ../src/guestfs-actions.pod:1131
6428 msgid "guestfs_cp_a"
6432 #: ../src/guestfs-actions.pod:1133
6436 " guestfs_cp_a (guestfs_h *g,\n"
6437 " const char *src,\n"
6438 " const char *dest);\n"
6443 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:766
6445 "This copies a file or directory from C<src> to C<dest> recursively using the "
6450 #: ../src/guestfs-actions.pod:1145
6455 #: ../src/guestfs-actions.pod:1147
6459 " guestfs_dd (guestfs_h *g,\n"
6460 " const char *src,\n"
6461 " const char *dest);\n"
6466 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:773
6468 "This command copies from one source device or file C<src> to another "
6469 "destination device or file C<dest>. Normally you would use this to copy to "
6470 "or from a device or partition, for example to duplicate a filesystem."
6474 #: ../src/guestfs-actions.pod:1157
6476 "If the destination is a device, it must be as large or larger than the "
6477 "source file or device, otherwise the copy will fail. This command cannot do "
6478 "partial copies (see C<guestfs_copy_size>)."
6482 #: ../src/guestfs-actions.pod:1165
6487 #: ../src/guestfs-actions.pod:1167
6491 " guestfs_df (guestfs_h *g);\n"
6496 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:786
6497 msgid "This command runs the C<df> command to report disk space used."
6501 #: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:1189
6502 #: ../fish/guestfish-actions.pod:788 ../fish/guestfish-actions.pod:799
6504 "This command is mostly useful for interactive sessions. It is I<not> "
6505 "intended that you try to parse the output string. Use C<statvfs> from "
6510 #: ../src/guestfs-actions.pod:1179 ../src/guestfs-actions.pod:1196
6511 #: ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:2233
6512 #: ../src/guestfs-actions.pod:2257 ../src/guestfs-actions.pod:2325
6513 #: ../src/guestfs-actions.pod:3961 ../src/guestfs-actions.pod:4354
6514 #: ../src/guestfs-actions.pod:6116 ../src/guestfs-actions.pod:6140
6515 #: ../src/guestfs-actions.pod:6748 ../src/guestfs-actions.pod:6761
6516 #: ../src/guestfs-actions.pod:6774
6517 msgid "(Added in 1.0.54)"
6521 #: ../src/guestfs-actions.pod:1181
6522 msgid "guestfs_df_h"
6526 #: ../src/guestfs-actions.pod:1183
6530 " guestfs_df_h (guestfs_h *g);\n"
6535 #: ../src/guestfs-actions.pod:1186 ../fish/guestfish-actions.pod:796
6537 "This command runs the C<df -h> command to report disk space used in human-"
6542 #: ../src/guestfs-actions.pod:1198
6543 msgid "guestfs_dmesg"
6547 #: ../src/guestfs-actions.pod:1200
6551 " guestfs_dmesg (guestfs_h *g);\n"
6556 #: ../src/guestfs-actions.pod:1203 ../fish/guestfish-actions.pod:807
6558 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
6559 "This is sometimes useful for extended debugging of problems."
6563 #: ../src/guestfs-actions.pod:1207
6565 "Another way to get the same information is to enable verbose messages with "
6566 "C<guestfs_set_verbose> or by setting the environment variable "
6567 "C<LIBGUESTFS_DEBUG=1> before running the program."
6571 #: ../src/guestfs-actions.pod:1217
6572 msgid "guestfs_download"
6576 #: ../src/guestfs-actions.pod:1219
6580 " guestfs_download (guestfs_h *g,\n"
6581 " const char *remotefilename,\n"
6582 " const char *filename);\n"
6587 #: ../src/guestfs-actions.pod:1224 ../src/guestfs-actions.pod:1249
6588 #: ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:833
6590 "Download file C<remotefilename> and save it as C<filename> on the local "
6595 #: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:6372
6596 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:4273
6597 msgid "C<filename> can also be a named pipe."
6601 #: ../src/guestfs-actions.pod:1229
6602 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
6606 #: ../src/guestfs-actions.pod:1240
6607 msgid "guestfs_download_offset"
6611 #: ../src/guestfs-actions.pod:1242
6615 " guestfs_download_offset (guestfs_h *g,\n"
6616 " const char *remotefilename,\n"
6617 " const char *filename,\n"
6618 " int64_t offset,\n"
6624 #: ../src/guestfs-actions.pod:1252 ../fish/guestfish-actions.pod:836
6626 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6627 "region must be within the file or device)."
6631 #: ../src/guestfs-actions.pod:1255
6633 "Note that there is no limit on the amount of data that can be downloaded "
6634 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
6635 "full amount unless an error occurs."
6639 #: ../src/guestfs-actions.pod:1260
6640 msgid "See also C<guestfs_download>, C<guestfs_pread>."
6644 #: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:6407
6645 msgid "(Added in 1.5.17)"
6649 #: ../src/guestfs-actions.pod:1271
6650 msgid "guestfs_drop_caches"
6654 #: ../src/guestfs-actions.pod:1273
6658 " guestfs_drop_caches (guestfs_h *g,\n"
6659 " int whattodrop);\n"
6664 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:852
6666 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6667 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6668 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6672 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:857
6673 msgid "Setting C<whattodrop> to 3 should drop everything."
6677 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:859
6679 "This automatically calls L<sync(2)> before the operation, so that the "
6680 "maximum guest memory is freed."
6684 #: ../src/guestfs-actions.pod:1291
6689 #: ../src/guestfs-actions.pod:1293
6693 " guestfs_du (guestfs_h *g,\n"
6694 " const char *path);\n"
6699 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:866
6701 "This command runs the C<du -s> command to estimate file space usage for "
6706 #: ../src/guestfs-actions.pod:1300 ../fish/guestfish-actions.pod:869
6708 "C<path> can be a file or a directory. If C<path> is a directory then the "
6709 "estimate includes the contents of the directory and all subdirectories "
6714 #: ../src/guestfs-actions.pod:1304 ../fish/guestfish-actions.pod:873
6716 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6720 #: ../src/guestfs-actions.pod:1311
6721 msgid "guestfs_e2fsck_f"
6725 #: ../src/guestfs-actions.pod:1313
6729 " guestfs_e2fsck_f (guestfs_h *g,\n"
6730 " const char *device);\n"
6735 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:880
6737 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6738 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
6743 #: ../src/guestfs-actions.pod:1321
6745 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
6746 "Normally you should use C<guestfs_fsck>."
6750 #: ../src/guestfs-actions.pod:1326
6751 msgid "(Added in 1.0.29)"
6755 #: ../src/guestfs-actions.pod:1328
6756 msgid "guestfs_echo_daemon"
6760 #: ../src/guestfs-actions.pod:1330
6764 " guestfs_echo_daemon (guestfs_h *g,\n"
6765 " char *const *words);\n"
6770 #: ../src/guestfs-actions.pod:1334 ../fish/guestfish-actions.pod:891
6772 "This command concatenates the list of C<words> passed with single spaces "
6773 "between them and returns the resulting string."
6777 #: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:894
6778 msgid "You can use this command to test the connection through to the daemon."
6782 #: ../src/guestfs-actions.pod:1339
6783 msgid "See also C<guestfs_ping_daemon>."
6787 #: ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:2071
6788 #: ../src/guestfs-actions.pod:5620
6789 msgid "(Added in 1.0.69)"
6793 #: ../src/guestfs-actions.pod:1346
6794 msgid "guestfs_egrep"
6798 #: ../src/guestfs-actions.pod:1348
6802 " guestfs_egrep (guestfs_h *g,\n"
6803 " const char *regex,\n"
6804 " const char *path);\n"
6809 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:902
6811 "This calls the external C<egrep> program and returns the matching lines."
6815 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1382
6816 #: ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1485
6817 #: ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:2171
6818 #: ../src/guestfs-actions.pod:2190 ../src/guestfs-actions.pod:2346
6819 #: ../src/guestfs-actions.pod:2359 ../src/guestfs-actions.pod:2374
6820 #: ../src/guestfs-actions.pod:2420 ../src/guestfs-actions.pod:2442
6821 #: ../src/guestfs-actions.pod:2455 ../src/guestfs-actions.pod:3344
6822 #: ../src/guestfs-actions.pod:3358 ../src/guestfs-actions.pod:3371
6823 #: ../src/guestfs-actions.pod:3385 ../src/guestfs-actions.pod:4289
6824 #: ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5214
6825 #: ../src/guestfs-actions.pod:5984 ../src/guestfs-actions.pod:5996
6826 #: ../src/guestfs-actions.pod:6009 ../src/guestfs-actions.pod:6022
6827 #: ../src/guestfs-actions.pod:6044 ../src/guestfs-actions.pod:6057
6828 #: ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6083
6829 #: ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6863
6830 #: ../src/guestfs-actions.pod:6948 ../src/guestfs-actions.pod:6967
6831 #: ../src/guestfs-actions.pod:7013 ../src/guestfs-actions.pod:7032
6832 msgid "(Added in 1.0.66)"
6836 #: ../src/guestfs-actions.pod:1365
6837 msgid "guestfs_egrepi"
6841 #: ../src/guestfs-actions.pod:1367
6845 " guestfs_egrepi (guestfs_h *g,\n"
6846 " const char *regex,\n"
6847 " const char *path);\n"
6852 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
6854 "This calls the external C<egrep -i> program and returns the matching lines."
6858 #: ../src/guestfs-actions.pod:1384
6859 msgid "guestfs_equal"
6863 #: ../src/guestfs-actions.pod:1386
6867 " guestfs_equal (guestfs_h *g,\n"
6868 " const char *file1,\n"
6869 " const char *file2);\n"
6874 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
6876 "This compares the two files C<file1> and C<file2> and returns true if their "
6877 "content is exactly equal, or false otherwise."
6881 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:925
6882 msgid "The external L<cmp(1)> program is used for the comparison."
6886 #: ../src/guestfs-actions.pod:1400
6887 msgid "guestfs_exists"
6891 #: ../src/guestfs-actions.pod:1402
6895 " guestfs_exists (guestfs_h *g,\n"
6896 " const char *path);\n"
6901 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:931
6903 "This returns C<true> if and only if there is a file, directory (or anything) "
6904 "with the given C<path> name."
6908 #: ../src/guestfs-actions.pod:1409
6909 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6913 #: ../src/guestfs-actions.pod:1415
6914 msgid "guestfs_fallocate"
6918 #: ../src/guestfs-actions.pod:1417
6922 " guestfs_fallocate (guestfs_h *g,\n"
6923 " const char *path,\n"
6929 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1448
6930 #: ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:959
6932 "This command preallocates a file (containing zero bytes) named C<path> of "
6933 "size C<len> bytes. If the file exists already, it is overwritten."
6937 #: ../src/guestfs-actions.pod:1426 ../fish/guestfish-actions.pod:944
6939 "Do not confuse this with the guestfish-specific C<alloc> command which "
6940 "allocates a file in the host and attaches it as a device."
6944 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:948
6946 "This function is deprecated. In new code, use the C<fallocate64> call "
6951 #: ../src/guestfs-actions.pod:1441
6952 msgid "guestfs_fallocate64"
6956 #: ../src/guestfs-actions.pod:1443
6960 " guestfs_fallocate64 (guestfs_h *g,\n"
6961 " const char *path,\n"
6967 #: ../src/guestfs-actions.pod:1452
6969 "Note that this call allocates disk blocks for the file. To create a sparse "
6970 "file use C<guestfs_truncate_size> instead."
6974 #: ../src/guestfs-actions.pod:1455
6976 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6977 "oversight it only allowed 30 bit lengths to be specified, effectively "
6978 "limiting the maximum size of files created through that call to 1GB."
6982 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:971
6984 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6985 "commands which create a file in the host and attach it as a device."
6989 #: ../src/guestfs-actions.pod:1466
6990 msgid "(Added in 1.3.17)"
6994 #: ../src/guestfs-actions.pod:1468
6995 msgid "guestfs_fgrep"
6999 #: ../src/guestfs-actions.pod:1470
7003 " guestfs_fgrep (guestfs_h *g,\n"
7004 " const char *pattern,\n"
7005 " const char *path);\n"
7010 #: ../src/guestfs-actions.pod:1475 ../fish/guestfish-actions.pod:979
7012 "This calls the external C<fgrep> program and returns the matching lines."
7016 #: ../src/guestfs-actions.pod:1487
7017 msgid "guestfs_fgrepi"
7021 #: ../src/guestfs-actions.pod:1489
7025 " guestfs_fgrepi (guestfs_h *g,\n"
7026 " const char *pattern,\n"
7027 " const char *path);\n"
7032 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
7034 "This calls the external C<fgrep -i> program and returns the matching lines."
7038 #: ../src/guestfs-actions.pod:1506
7039 msgid "guestfs_file"
7043 #: ../src/guestfs-actions.pod:1508
7047 " guestfs_file (guestfs_h *g,\n"
7048 " const char *path);\n"
7053 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:999
7055 "This call uses the standard L<file(1)> command to determine the type or "
7056 "contents of the file."
7060 #: ../src/guestfs-actions.pod:1515 ../fish/guestfish-actions.pod:1002
7062 "This call will also transparently look inside various types of compressed "
7067 #: ../src/guestfs-actions.pod:1518 ../fish/guestfish-actions.pod:1005
7069 "The exact command which runs is C<file -zb path>. Note in particular that "
7070 "the filename is not prepended to the output (the C<-b> option)."
7074 #: ../src/guestfs-actions.pod:1522
7076 "This command can also be used on C</dev/> devices (and partitions, LV "
7077 "names). You can for example use this to determine if a device contains a "
7078 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
7082 #: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1014
7084 "If the C<path> does not begin with C</dev/> then this command only works for "
7085 "the content of regular files. For other file types (directory, symbolic "
7086 "link etc) it will just return the string C<directory> etc."
7090 #: ../src/guestfs-actions.pod:1537
7091 msgid "guestfs_file_architecture"
7095 #: ../src/guestfs-actions.pod:1539
7099 " guestfs_file_architecture (guestfs_h *g,\n"
7100 " const char *filename);\n"
7105 #: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1023
7107 "This detects the architecture of the binary C<filename>, and returns it if "
7112 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1026
7113 msgid "Currently defined architectures are:"
7117 #: ../src/guestfs-actions.pod:1550 ../fish/guestfish-actions.pod:1030
7122 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1032
7124 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
7125 "irrespective of the precise processor requirements of the binary."
7129 #: ../src/guestfs-actions.pod:1555 ../fish/guestfish-actions.pod:1035
7134 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1037
7135 msgid "64 bit x86-64."
7139 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1039
7144 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1041
7145 msgid "32 bit SPARC."
7149 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1043
7154 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1045
7155 msgid "64 bit SPARC V9 and above."
7159 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1047
7164 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1049
7165 msgid "Intel Itanium."
7169 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1051
7174 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1053
7175 msgid "32 bit Power PC."
7179 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1055
7184 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1057
7185 msgid "64 bit Power PC."
7189 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1061
7190 msgid "Libguestfs may return other architecture strings in future."
7194 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1063
7195 msgid "The function works on at least the following types of files:"
7199 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1069
7200 msgid "many types of Un*x and Linux binary"
7204 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1073
7205 msgid "many types of Un*x and Linux shared library"
7209 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1077
7210 msgid "Windows Win32 and Win64 binaries"
7214 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1081
7215 msgid "Windows Win32 and Win64 DLLs"
7219 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1083
7220 msgid "Win32 binaries and DLLs return C<i386>."
7224 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1085
7225 msgid "Win64 binaries and DLLs return C<x86_64>."
7229 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1089
7230 msgid "Linux kernel modules"
7234 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1093
7235 msgid "Linux new-style initrd images"
7239 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1097
7240 msgid "some non-x86 Linux vmlinuz kernels"
7244 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1101
7245 msgid "What it can't do currently:"
7249 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1107
7250 msgid "static libraries (libfoo.a)"
7254 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1111
7255 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7259 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1115
7260 msgid "x86 Linux vmlinuz kernels"
7264 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1117
7266 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7267 "compressed code, and are horribly hard to unpack. If you want to find the "
7268 "architecture of a kernel, use the architecture of the associated initrd or "
7269 "kernel module(s) instead."
7273 #: ../src/guestfs-actions.pod:1647 ../src/guestfs-actions.pod:1810
7274 #: ../src/guestfs-actions.pod:1827 ../src/guestfs-actions.pod:2478
7275 #: ../src/guestfs-actions.pod:2559 ../src/guestfs-actions.pod:2585
7276 #: ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2653
7277 #: ../src/guestfs-actions.pod:2686 ../src/guestfs-actions.pod:2766
7278 #: ../src/guestfs-actions.pod:2826 ../src/guestfs-actions.pod:2997
7279 #: ../src/guestfs-actions.pod:3129
7280 msgid "(Added in 1.5.3)"
7284 #: ../src/guestfs-actions.pod:1649
7285 msgid "guestfs_filesize"
7289 #: ../src/guestfs-actions.pod:1651
7293 " guestfs_filesize (guestfs_h *g,\n"
7294 " const char *file);\n"
7299 #: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1128
7300 msgid "This command returns the size of C<file> in bytes."
7304 #: ../src/guestfs-actions.pod:1657
7306 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
7307 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
7308 "devices, use C<guestfs_blockdev_getsize64>."
7312 #: ../src/guestfs-actions.pod:1663
7313 msgid "(Added in 1.0.82)"
7317 #: ../src/guestfs-actions.pod:1665
7318 msgid "guestfs_fill"
7322 #: ../src/guestfs-actions.pod:1667
7326 " guestfs_fill (guestfs_h *g,\n"
7329 " const char *path);\n"
7334 #: ../src/guestfs-actions.pod:1673 ../fish/guestfish-actions.pod:1138
7336 "This command creates a new file called C<path>. The initial content of the "
7337 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
7342 #: ../src/guestfs-actions.pod:1677
7344 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7345 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7346 "bytes use C<guestfs_fill_pattern>."
7350 #: ../src/guestfs-actions.pod:1689
7351 msgid "(Added in 1.0.79)"
7355 #: ../src/guestfs-actions.pod:1691
7356 msgid "guestfs_fill_pattern"
7360 #: ../src/guestfs-actions.pod:1693
7364 " guestfs_fill_pattern (guestfs_h *g,\n"
7365 " const char *pattern,\n"
7367 " const char *path);\n"
7372 #: ../src/guestfs-actions.pod:1699
7374 "This function is like C<guestfs_fill> except that it creates a new file of "
7375 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7376 "pattern is truncated if necessary to ensure the length of the file is "
7377 "exactly C<len> bytes."
7381 #: ../src/guestfs-actions.pod:1711
7382 msgid "(Added in 1.3.12)"
7386 #: ../src/guestfs-actions.pod:1713
7387 msgid "guestfs_find"
7391 #: ../src/guestfs-actions.pod:1715
7395 " guestfs_find (guestfs_h *g,\n"
7396 " const char *directory);\n"
7401 #: ../src/guestfs-actions.pod:1719 ../fish/guestfish-actions.pod:1160
7403 "This command lists out all files and directories, recursively, starting at "
7404 "C<directory>. It is essentially equivalent to running the shell command "
7405 "C<find directory -print> but some post-processing happens on the output, "
7410 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1165
7412 "This returns a list of strings I<without any prefix>. Thus if the directory "
7417 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1168
7427 #: ../src/guestfs-actions.pod:1731
7429 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7433 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1175
7444 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1180
7445 msgid "If C<directory> is not a directory, then this command returns an error."
7449 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1183
7450 msgid "The returned list is sorted."
7454 #: ../src/guestfs-actions.pod:1744
7455 msgid "See also C<guestfs_find0>."
7459 #: ../src/guestfs-actions.pod:1753 ../src/guestfs-actions.pod:3788
7460 #: ../src/guestfs-actions.pod:5249
7461 msgid "(Added in 1.0.27)"
7465 #: ../src/guestfs-actions.pod:1755
7466 msgid "guestfs_find0"
7470 #: ../src/guestfs-actions.pod:1757
7474 " guestfs_find0 (guestfs_h *g,\n"
7475 " const char *directory,\n"
7476 " const char *files);\n"
7481 #: ../src/guestfs-actions.pod:1762 ../fish/guestfish-actions.pod:1194
7483 "This command lists out all files and directories, recursively, starting at "
7484 "C<directory>, placing the resulting list in the external file called "
7489 #: ../src/guestfs-actions.pod:1766
7491 "This command works the same way as C<guestfs_find> with the following "
7496 #: ../src/guestfs-actions.pod:1773 ../fish/guestfish-actions.pod:1205
7497 msgid "The resulting list is written to an external file."
7501 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1209
7503 "Items (filenames) in the result are separated by C<\\0> characters. See "
7504 "L<find(1)> option I<-print0>."
7508 #: ../src/guestfs-actions.pod:1782 ../fish/guestfish-actions.pod:1214
7509 msgid "This command is not limited in the number of names that it can return."
7513 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1219
7514 msgid "The result list is not sorted."
7518 #: ../src/guestfs-actions.pod:1793
7519 msgid "(Added in 1.0.74)"
7523 #: ../src/guestfs-actions.pod:1795
7524 msgid "guestfs_findfs_label"
7528 #: ../src/guestfs-actions.pod:1797
7532 " guestfs_findfs_label (guestfs_h *g,\n"
7533 " const char *label);\n"
7538 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1229
7540 "This command searches the filesystems and returns the one which has the "
7541 "given label. An error is returned if no such filesystem can be found."
7545 #: ../src/guestfs-actions.pod:1805
7546 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
7550 #: ../src/guestfs-actions.pod:1812
7551 msgid "guestfs_findfs_uuid"
7555 #: ../src/guestfs-actions.pod:1814
7559 " guestfs_findfs_uuid (guestfs_h *g,\n"
7560 " const char *uuid);\n"
7565 #: ../src/guestfs-actions.pod:1818 ../fish/guestfish-actions.pod:1239
7567 "This command searches the filesystems and returns the one which has the "
7568 "given UUID. An error is returned if no such filesystem can be found."
7572 #: ../src/guestfs-actions.pod:1822
7573 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
7577 #: ../src/guestfs-actions.pod:1829
7578 msgid "guestfs_fsck"
7582 #: ../src/guestfs-actions.pod:1831
7586 " guestfs_fsck (guestfs_h *g,\n"
7587 " const char *fstype,\n"
7588 " const char *device);\n"
7593 #: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1249
7595 "This runs the filesystem checker (fsck) on C<device> which should have "
7596 "filesystem type C<fstype>."
7600 #: ../src/guestfs-actions.pod:1839 ../fish/guestfish-actions.pod:1252
7602 "The returned integer is the status. See L<fsck(8)> for the list of status "
7603 "codes from C<fsck>."
7607 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1261
7608 msgid "Multiple status codes can be summed together."
7612 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1265
7614 "A non-zero return code can mean \"success\", for example if errors have been "
7615 "corrected on the filesystem."
7619 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1270
7620 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
7624 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1275
7626 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
7630 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:6886
7631 msgid "(Added in 1.0.16)"
7635 #: ../src/guestfs-actions.pod:1868
7636 msgid "guestfs_get_append"
7640 #: ../src/guestfs-actions.pod:1870
7644 " guestfs_get_append (guestfs_h *g);\n"
7649 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1281
7651 "Return the additional kernel options which are added to the guest kernel "
7656 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1284
7657 msgid "If C<NULL> then no options are added."
7661 #: ../src/guestfs-actions.pod:1878
7663 "This function returns a string which may be NULL. There is no way to return "
7664 "an error from this function. The string is owned by the guest handle and "
7665 "must I<not> be freed."
7669 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:4927
7670 #: ../src/guestfs-actions.pod:5390 ../src/guestfs-actions.pod:5758
7671 #: ../src/guestfs-actions.pod:5777 ../src/guestfs-actions.pod:5793
7672 #: ../src/guestfs-actions.pod:5810 ../src/guestfs-actions.pod:6557
7673 #: ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:6929
7674 msgid "(Added in 1.0.26)"
7678 #: ../src/guestfs-actions.pod:1884
7679 msgid "guestfs_get_autosync"
7683 #: ../src/guestfs-actions.pod:1886
7687 " guestfs_get_autosync (guestfs_h *g);\n"
7692 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1290
7693 msgid "Get the autosync flag."
7697 #: ../src/guestfs-actions.pod:1895
7698 msgid "guestfs_get_direct"
7702 #: ../src/guestfs-actions.pod:1897
7706 " guestfs_get_direct (guestfs_h *g);\n"
7711 #: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1296
7712 msgid "Return the direct appliance mode flag."
7716 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:5431
7717 msgid "(Added in 1.0.72)"
7721 #: ../src/guestfs-actions.pod:1906
7722 msgid "guestfs_get_e2label"
7726 #: ../src/guestfs-actions.pod:1908
7730 " guestfs_get_e2label (guestfs_h *g,\n"
7731 " const char *device);\n"
7736 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1302
7738 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7742 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1305
7744 "This function is deprecated. In new code, use the C<vfs_label> call instead."
7748 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1946
7749 #: ../src/guestfs-actions.pod:5449 ../src/guestfs-actions.pod:5468
7750 msgid "(Added in 1.0.15)"
7754 #: ../src/guestfs-actions.pod:1927
7755 msgid "guestfs_get_e2uuid"
7759 #: ../src/guestfs-actions.pod:1929
7763 " guestfs_get_e2uuid (guestfs_h *g,\n"
7764 " const char *device);\n"
7769 #: ../src/guestfs-actions.pod:1933 ../fish/guestfish-actions.pod:1316
7771 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7775 #: ../src/guestfs-actions.pod:1939 ../fish/guestfish-actions.pod:1319
7777 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
7781 #: ../src/guestfs-actions.pod:1948
7782 msgid "guestfs_get_memsize"
7786 #: ../src/guestfs-actions.pod:1950
7790 " guestfs_get_memsize (guestfs_h *g);\n"
7795 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1330
7797 "This gets the memory size in megabytes allocated to the qemu subprocess."
7801 #: ../src/guestfs-actions.pod:1956
7803 "If C<guestfs_set_memsize> was not called on this handle, and if "
7804 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7805 "value for memsize."
7809 #: ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2041
7810 #: ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5591
7811 #: ../fish/guestfish-actions.pod:1337 ../fish/guestfish-actions.pod:1388
7812 #: ../fish/guestfish-actions.pod:3680 ../fish/guestfish-actions.pod:3767
7814 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7818 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:4079
7819 #: ../src/guestfs-actions.pod:4194 ../src/guestfs-actions.pod:4213
7820 #: ../src/guestfs-actions.pod:4232 ../src/guestfs-actions.pod:4244
7821 #: ../src/guestfs-actions.pod:4261 ../src/guestfs-actions.pod:4274
7822 #: ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5489
7823 #: ../src/guestfs-actions.pod:5732 ../src/guestfs-actions.pod:6333
7824 msgid "(Added in 1.0.55)"
7828 #: ../src/guestfs-actions.pod:1967
7829 msgid "guestfs_get_network"
7833 #: ../src/guestfs-actions.pod:1969
7837 " guestfs_get_network (guestfs_h *g);\n"
7842 #: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1344
7843 msgid "This returns the enable network flag."
7847 #: ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:5508
7848 msgid "(Added in 1.5.4)"
7852 #: ../src/guestfs-actions.pod:1978
7853 msgid "guestfs_get_path"
7857 #: ../src/guestfs-actions.pod:1980
7861 " guestfs_get_path (guestfs_h *g);\n"
7866 #: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1350
7867 msgid "Return the current search path."
7871 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1352
7873 "This is always non-NULL. If it wasn't set already, then this will return "
7878 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2017
7880 "This function returns a string, or NULL on error. The string is owned by "
7881 "the guest handle and must I<not> be freed."
7885 #: ../src/guestfs-actions.pod:1993
7886 msgid "guestfs_get_pid"
7890 #: ../src/guestfs-actions.pod:1995
7894 " guestfs_get_pid (guestfs_h *g);\n"
7899 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1361
7901 "Return the process ID of the qemu subprocess. If there is no qemu "
7902 "subprocess, then this will return an error."
7906 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1364
7907 msgid "This is an internal call used for debugging and testing."
7911 #: ../src/guestfs-actions.pod:2005
7912 msgid "(Added in 1.0.56)"
7916 #: ../src/guestfs-actions.pod:2007
7917 msgid "guestfs_get_qemu"
7921 #: ../src/guestfs-actions.pod:2009
7925 " guestfs_get_qemu (guestfs_h *g);\n"
7930 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1370
7931 msgid "Return the current qemu binary."
7935 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1372
7937 "This is always non-NULL. If it wasn't set already, then this will return "
7938 "the default qemu binary name."
7942 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5553
7943 msgid "(Added in 1.0.6)"
7947 #: ../src/guestfs-actions.pod:2022
7948 msgid "guestfs_get_recovery_proc"
7952 #: ../src/guestfs-actions.pod:2024
7956 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7961 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1379
7962 msgid "Return the recovery process enabled flag."
7966 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:3219
7967 #: ../src/guestfs-actions.pod:3486 ../src/guestfs-actions.pod:3886
7968 #: ../src/guestfs-actions.pod:3918 ../src/guestfs-actions.pod:4857
7969 #: ../src/guestfs-actions.pod:5200 ../src/guestfs-actions.pod:5577
7970 #: ../src/guestfs-actions.pod:6236 ../src/guestfs-actions.pod:6256
7971 #: ../src/guestfs-actions.pod:6438
7972 msgid "(Added in 1.0.77)"
7976 #: ../src/guestfs-actions.pod:2033
7977 msgid "guestfs_get_selinux"
7981 #: ../src/guestfs-actions.pod:2035
7985 " guestfs_get_selinux (guestfs_h *g);\n"
7990 #: ../src/guestfs-actions.pod:2038
7992 "This returns the current setting of the selinux flag which is passed to the "
7993 "appliance at boot time. See C<guestfs_set_selinux>."
7997 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2109
7998 #: ../src/guestfs-actions.pod:5596 ../src/guestfs-actions.pod:5650
7999 msgid "(Added in 1.0.67)"
8003 #: ../src/guestfs-actions.pod:2048
8004 msgid "guestfs_get_state"
8008 #: ../src/guestfs-actions.pod:2050
8012 " guestfs_get_state (guestfs_h *g);\n"
8017 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1395
8019 "This returns the current state as an opaque integer. This is only useful "
8020 "for printing debug and internal error messages."
8024 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:3022
8025 #: ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3112
8026 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:1398
8027 #: ../fish/guestfish-actions.pod:2113 ../fish/guestfish-actions.pod:2131
8028 #: ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2185
8029 msgid "For more information on states, see L<guestfs(3)>."
8033 #: ../src/guestfs-actions.pod:2062
8034 msgid "guestfs_get_trace"
8038 #: ../src/guestfs-actions.pod:2064
8042 " guestfs_get_trace (guestfs_h *g);\n"
8047 #: ../src/guestfs-actions.pod:2067 ../fish/guestfish-actions.pod:1404
8048 msgid "Return the command trace flag."
8052 #: ../src/guestfs-actions.pod:2073
8053 msgid "guestfs_get_umask"
8057 #: ../src/guestfs-actions.pod:2075
8061 " guestfs_get_umask (guestfs_h *g);\n"
8066 #: ../src/guestfs-actions.pod:2078
8068 "Return the current umask. By default the umask is C<022> unless it has been "
8069 "set by calling C<guestfs_umask>."
8073 #: ../src/guestfs-actions.pod:2085
8074 msgid "guestfs_get_verbose"
8078 #: ../src/guestfs-actions.pod:2087
8082 " guestfs_get_verbose (guestfs_h *g);\n"
8087 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1417
8088 msgid "This returns the verbose messages flag."
8092 #: ../src/guestfs-actions.pod:2096
8093 msgid "guestfs_getcon"
8097 #: ../src/guestfs-actions.pod:2098
8101 " guestfs_getcon (guestfs_h *g);\n"
8106 #: ../src/guestfs-actions.pod:2101 ../fish/guestfish-actions.pod:1423
8107 msgid "This gets the SELinux security context of the daemon."
8111 #: ../src/guestfs-actions.pod:2103
8113 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
8117 #: ../src/guestfs-actions.pod:2111
8118 msgid "guestfs_getxattrs"
8122 #: ../src/guestfs-actions.pod:2113
8125 " struct guestfs_xattr_list *\n"
8126 " guestfs_getxattrs (guestfs_h *g,\n"
8127 " const char *path);\n"
8132 #: ../src/guestfs-actions.pod:2117 ../fish/guestfish-actions.pod:1432
8134 "This call lists the extended attributes of the file or directory C<path>."
8138 #: ../src/guestfs-actions.pod:2120 ../fish/guestfish-actions.pod:1435
8140 "At the system call level, this is a combination of the L<listxattr(2)> and "
8141 "L<getxattr(2)> calls."
8145 #: ../src/guestfs-actions.pod:2123
8146 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
8150 #: ../src/guestfs-actions.pod:2125 ../src/guestfs-actions.pod:3231
8151 #: ../src/guestfs-actions.pod:3882
8153 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
8154 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
8158 #: ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:3235
8159 #: ../src/guestfs-actions.pod:3400 ../src/guestfs-actions.pod:3436
8160 #: ../src/guestfs-actions.pod:5230 ../src/guestfs-actions.pod:5669
8161 #: ../src/guestfs-actions.pod:6994
8162 msgid "(Added in 1.0.59)"
8166 #: ../src/guestfs-actions.pod:2131
8167 msgid "guestfs_glob_expand"
8171 #: ../src/guestfs-actions.pod:2133
8175 " guestfs_glob_expand (guestfs_h *g,\n"
8176 " const char *pattern);\n"
8181 #: ../src/guestfs-actions.pod:2137 ../fish/guestfish-actions.pod:1444
8183 "This command searches for all the pathnames matching C<pattern> according to "
8184 "the wildcard expansion rules used by the shell."
8188 #: ../src/guestfs-actions.pod:2141 ../fish/guestfish-actions.pod:1448
8190 "If no paths match, then this returns an empty list (note: not an error)."
8194 #: ../src/guestfs-actions.pod:2144 ../fish/guestfish-actions.pod:1451
8196 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
8197 "GLOB_BRACE>. See that manual page for more details."
8201 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:5834
8202 #: ../src/guestfs-actions.pod:5851
8203 msgid "(Added in 1.0.50)"
8207 #: ../src/guestfs-actions.pod:2154
8208 msgid "guestfs_grep"
8212 #: ../src/guestfs-actions.pod:2156
8216 " guestfs_grep (guestfs_h *g,\n"
8217 " const char *regex,\n"
8218 " const char *path);\n"
8223 #: ../src/guestfs-actions.pod:2161 ../fish/guestfish-actions.pod:1459
8224 msgid "This calls the external C<grep> program and returns the matching lines."
8228 #: ../src/guestfs-actions.pod:2173
8229 msgid "guestfs_grepi"
8233 #: ../src/guestfs-actions.pod:2175
8237 " guestfs_grepi (guestfs_h *g,\n"
8238 " const char *regex,\n"
8239 " const char *path);\n"
8244 #: ../src/guestfs-actions.pod:2180 ../fish/guestfish-actions.pod:1469
8246 "This calls the external C<grep -i> program and returns the matching lines."
8250 #: ../src/guestfs-actions.pod:2192
8251 msgid "guestfs_grub_install"
8255 #: ../src/guestfs-actions.pod:2194
8259 " guestfs_grub_install (guestfs_h *g,\n"
8260 " const char *root,\n"
8261 " const char *device);\n"
8266 #: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1479
8268 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
8269 "the root directory being C<root>."
8273 #: ../src/guestfs-actions.pod:2202 ../fish/guestfish-actions.pod:1482
8275 "Note: If grub-install reports the error \"No suitable drive was found in the "
8276 "generated device map.\" it may be that you need to create a C</boot/grub/"
8277 "device.map> file first that contains the mapping between grub device names "
8278 "and Linux device names. It is usually sufficient to create a file "
8283 #: ../src/guestfs-actions.pod:2209 ../fish/guestfish-actions.pod:1489
8291 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1491
8292 msgid "replacing C</dev/vda> with the name of the installation device."
8296 #: ../src/guestfs-actions.pod:2215
8297 msgid "(Added in 1.0.17)"
8301 #: ../src/guestfs-actions.pod:2217
8302 msgid "guestfs_head"
8306 #: ../src/guestfs-actions.pod:2219
8310 " guestfs_head (guestfs_h *g,\n"
8311 " const char *path);\n"
8316 #: ../src/guestfs-actions.pod:2223 ../fish/guestfish-actions.pod:1497
8318 "This command returns up to the first 10 lines of a file as a list of strings."
8322 #: ../src/guestfs-actions.pod:2235
8323 msgid "guestfs_head_n"
8327 #: ../src/guestfs-actions.pod:2237
8331 " guestfs_head_n (guestfs_h *g,\n"
8333 " const char *path);\n"
8338 #: ../src/guestfs-actions.pod:2242 ../fish/guestfish-actions.pod:1507
8340 "If the parameter C<nrlines> is a positive number, this returns the first "
8341 "C<nrlines> lines of the file C<path>."
8345 #: ../src/guestfs-actions.pod:2245 ../fish/guestfish-actions.pod:1510
8347 "If the parameter C<nrlines> is a negative number, this returns lines from "
8348 "the file C<path>, excluding the last C<nrlines> lines."
8352 #: ../src/guestfs-actions.pod:2248 ../src/guestfs-actions.pod:6131
8353 #: ../fish/guestfish-actions.pod:1513 ../fish/guestfish-actions.pod:4113
8354 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8358 #: ../src/guestfs-actions.pod:2259
8359 msgid "guestfs_hexdump"
8363 #: ../src/guestfs-actions.pod:2261
8367 " guestfs_hexdump (guestfs_h *g,\n"
8368 " const char *path);\n"
8373 #: ../src/guestfs-actions.pod:2265 ../fish/guestfish-actions.pod:1522
8375 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
8376 "readable, canonical hex dump of the file."
8380 #: ../src/guestfs-actions.pod:2274 ../src/guestfs-actions.pod:5915
8381 #: ../src/guestfs-actions.pod:5970
8382 msgid "(Added in 1.0.22)"
8386 #: ../src/guestfs-actions.pod:2276
8387 msgid "guestfs_initrd_cat"
8391 #: ../src/guestfs-actions.pod:2278
8395 " guestfs_initrd_cat (guestfs_h *g,\n"
8396 " const char *initrdpath,\n"
8397 " const char *filename,\n"
8398 " size_t *size_r);\n"
8403 #: ../src/guestfs-actions.pod:2284 ../fish/guestfish-actions.pod:1532
8405 "This command unpacks the file C<filename> from the initrd file called "
8406 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8411 #: ../src/guestfs-actions.pod:2288 ../fish/guestfish-actions.pod:1536
8413 "For example, in guestfish you could use the following command to examine the "
8414 "boot script (usually called C</init>) contained in a Linux initrd or "
8419 #: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1540
8422 " initrd-cat /boot/initrd-<version>.img init\n"
8427 #: ../src/guestfs-actions.pod:2294
8428 msgid "See also C<guestfs_initrd_list>."
8432 #: ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:4850
8433 #: ../src/guestfs-actions.pod:4876 ../src/guestfs-actions.pod:5057
8435 "This function returns a buffer, or NULL on error. The size of the returned "
8436 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8441 #: ../src/guestfs-actions.pod:2305
8442 msgid "guestfs_initrd_list"
8446 #: ../src/guestfs-actions.pod:2307
8450 " guestfs_initrd_list (guestfs_h *g,\n"
8451 " const char *path);\n"
8456 #: ../src/guestfs-actions.pod:2311 ../fish/guestfish-actions.pod:1551
8457 msgid "This command lists out files contained in an initrd."
8461 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1553
8463 "The files are listed without any initial C</> character. The files are "
8464 "listed in the order they appear (not necessarily alphabetical). Directory "
8465 "names are listed as separate items."
8469 #: ../src/guestfs-actions.pod:2317 ../fish/guestfish-actions.pod:1557
8471 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8472 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8477 #: ../src/guestfs-actions.pod:2327
8478 msgid "guestfs_inotify_add_watch"
8482 #: ../src/guestfs-actions.pod:2329
8486 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8487 " const char *path,\n"
8493 #: ../src/guestfs-actions.pod:2334 ../fish/guestfish-actions.pod:1565
8494 msgid "Watch C<path> for the events listed in C<mask>."
8498 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1567
8500 "Note that if C<path> is a directory then events within that directory are "
8501 "watched, but this does I<not> happen recursively (in subdirectories)."
8505 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1571
8507 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8508 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
8512 #: ../src/guestfs-actions.pod:2348
8513 msgid "guestfs_inotify_close"
8517 #: ../src/guestfs-actions.pod:2350
8521 " guestfs_inotify_close (guestfs_h *g);\n"
8526 #: ../src/guestfs-actions.pod:2353 ../fish/guestfish-actions.pod:1579
8528 "This closes the inotify handle which was previously opened by inotify_init. "
8529 "It removes all watches, throws away any pending events, and deallocates all "
8534 #: ../src/guestfs-actions.pod:2361
8535 msgid "guestfs_inotify_files"
8539 #: ../src/guestfs-actions.pod:2363
8543 " guestfs_inotify_files (guestfs_h *g);\n"
8548 #: ../src/guestfs-actions.pod:2366
8550 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
8551 "returns a list of pathnames of objects that were touched. The returned "
8552 "pathnames are sorted and deduplicated."
8556 #: ../src/guestfs-actions.pod:2376
8557 msgid "guestfs_inotify_init"
8561 #: ../src/guestfs-actions.pod:2378
8565 " guestfs_inotify_init (guestfs_h *g,\n"
8566 " int maxevents);\n"
8571 #: ../src/guestfs-actions.pod:2382 ../fish/guestfish-actions.pod:1595
8573 "This command creates a new inotify handle. The inotify subsystem can be "
8574 "used to notify events which happen to objects in the guest filesystem."
8578 #: ../src/guestfs-actions.pod:2386
8580 "C<maxevents> is the maximum number of events which will be queued up between "
8581 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
8582 "passed as C<0>, then the kernel (or previously set) default is used. For "
8583 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
8584 "throws away events, but records the fact that it threw them away by setting "
8585 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
8586 "C<guestfs_inotify_read>)."
8590 #: ../src/guestfs-actions.pod:2396
8592 "Before any events are generated, you have to add some watches to the "
8593 "internal watch list. See: C<guestfs_inotify_add_watch>, "
8594 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
8598 #: ../src/guestfs-actions.pod:2402
8600 "Queued up events should be read periodically by calling "
8601 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
8602 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
8603 "often enough then you risk the internal queue overflowing."
8607 #: ../src/guestfs-actions.pod:2409
8609 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
8610 "This also removes any watches automatically."
8614 #: ../src/guestfs-actions.pod:2413 ../fish/guestfish-actions.pod:1626
8616 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
8617 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
8618 "that there is one global inotify handle per libguestfs instance."
8622 #: ../src/guestfs-actions.pod:2422
8623 msgid "guestfs_inotify_read"
8627 #: ../src/guestfs-actions.pod:2424
8630 " struct guestfs_inotify_event_list *\n"
8631 " guestfs_inotify_read (guestfs_h *g);\n"
8636 #: ../src/guestfs-actions.pod:2427 ../fish/guestfish-actions.pod:1635
8638 "Return the complete queue of events that have happened since the previous "
8643 #: ../src/guestfs-actions.pod:2430 ../fish/guestfish-actions.pod:1638
8644 msgid "If no events have happened, this returns an empty list."
8648 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1640
8650 "I<Note>: In order to make sure that all events have been read, you must call "
8651 "this function repeatedly until it returns an empty list. The reason is that "
8652 "the call will read events up to the maximum appliance-to-host message size "
8653 "and leave remaining events in the queue."
8657 #: ../src/guestfs-actions.pod:2438
8659 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
8660 "there was an error. I<The caller must call "
8661 "C<guestfs_free_inotify_event_list> after use>."
8665 #: ../src/guestfs-actions.pod:2444
8666 msgid "guestfs_inotify_rm_watch"
8670 #: ../src/guestfs-actions.pod:2446
8674 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
8680 #: ../src/guestfs-actions.pod:2450
8682 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
8686 #: ../src/guestfs-actions.pod:2457
8687 msgid "guestfs_inspect_get_arch"
8691 #: ../src/guestfs-actions.pod:2459
8695 " guestfs_inspect_get_arch (guestfs_h *g,\n"
8696 " const char *root);\n"
8701 #: ../src/guestfs-actions.pod:2463 ../src/guestfs-actions.pod:2486
8702 #: ../src/guestfs-actions.pod:2567 ../src/guestfs-actions.pod:2593
8703 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2640
8704 #: ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2694
8705 #: ../src/guestfs-actions.pod:2721 ../src/guestfs-actions.pod:2750
8706 #: ../src/guestfs-actions.pod:2792 ../src/guestfs-actions.pod:2834
8707 #: ../src/guestfs-actions.pod:2857
8709 "This function should only be called with a root device string as returned by "
8710 "C<guestfs_inspect_os>."
8714 #: ../src/guestfs-actions.pod:2466
8716 "This returns the architecture of the inspected operating system. The "
8717 "possible return values are listed under C<guestfs_file_architecture>."
8721 #: ../src/guestfs-actions.pod:2470 ../fish/guestfish-actions.pod:1664
8723 "If the architecture could not be determined, then the string C<unknown> is "
8728 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2554
8729 #: ../src/guestfs-actions.pod:2602 ../src/guestfs-actions.pod:2628
8730 #: ../src/guestfs-actions.pod:2710 ../src/guestfs-actions.pod:2739
8731 #: ../src/guestfs-actions.pod:2761 ../src/guestfs-actions.pod:2780
8732 #: ../src/guestfs-actions.pod:2821 ../src/guestfs-actions.pod:2844
8733 #: ../src/guestfs-actions.pod:2950 ../src/guestfs-actions.pod:2989
8734 #: ../fish/guestfish-actions.pod:1667 ../fish/guestfish-actions.pod:1741
8735 #: ../fish/guestfish-actions.pod:1774 ../fish/guestfish-actions.pod:1795
8736 #: ../fish/guestfish-actions.pod:1855 ../fish/guestfish-actions.pod:1879
8737 #: ../fish/guestfish-actions.pod:1896 ../fish/guestfish-actions.pod:1909
8738 #: ../fish/guestfish-actions.pod:1944 ../fish/guestfish-actions.pod:1960
8739 #: ../fish/guestfish-actions.pod:2059 ../fish/guestfish-actions.pod:2093
8740 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
8744 #: ../src/guestfs-actions.pod:2480
8745 msgid "guestfs_inspect_get_distro"
8749 #: ../src/guestfs-actions.pod:2482
8753 " guestfs_inspect_get_distro (guestfs_h *g,\n"
8754 " const char *root);\n"
8759 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1676
8761 "This returns the distro (distribution) of the inspected operating system."
8765 #: ../src/guestfs-actions.pod:2492 ../fish/guestfish-actions.pod:1679
8766 msgid "Currently defined distros are:"
8770 #: ../src/guestfs-actions.pod:2496 ../fish/guestfish-actions.pod:1683
8771 msgid "\"archlinux\""
8775 #: ../src/guestfs-actions.pod:2498 ../fish/guestfish-actions.pod:1685
8780 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1687
8785 #: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1689
8790 #: ../src/guestfs-actions.pod:2504 ../fish/guestfish-actions.pod:1691
8795 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1693
8800 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1695
8805 #: ../src/guestfs-actions.pod:2510 ../fish/guestfish-actions.pod:1697
8810 #: ../src/guestfs-actions.pod:2512 ../fish/guestfish-actions.pod:1699
8811 msgid "\"linuxmint\""
8815 #: ../src/guestfs-actions.pod:2514 ../fish/guestfish-actions.pod:1701
8820 #: ../src/guestfs-actions.pod:2516 ../fish/guestfish-actions.pod:1703
8821 msgid "\"mandriva\""
8825 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1705
8830 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1707
8835 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1709
8840 #: ../src/guestfs-actions.pod:2524 ../fish/guestfish-actions.pod:1711
8845 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1713
8850 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1715
8851 msgid "\"redhat-based\""
8855 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1717
8856 msgid "Some Red Hat-derived distro."
8860 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1719
8865 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1721
8866 msgid "Red Hat Enterprise Linux and some derivatives."
8870 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1723
8875 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1725
8880 #: ../src/guestfs-actions.pod:2540 ../src/guestfs-actions.pod:2812
8881 #: ../fish/guestfish-actions.pod:1727 ../fish/guestfish-actions.pod:1935
8886 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1729
8887 msgid "The distro could not be determined."
8891 #: ../src/guestfs-actions.pod:2544 ../src/guestfs-actions.pod:2804
8892 #: ../fish/guestfish-actions.pod:1731 ../fish/guestfish-actions.pod:1927
8897 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1733
8899 "Windows does not have distributions. This string is returned if the OS type "
8904 #: ../src/guestfs-actions.pod:2551 ../src/guestfs-actions.pod:2818
8905 #: ../fish/guestfish-actions.pod:1738 ../fish/guestfish-actions.pod:1941
8907 "Future versions of libguestfs may return other strings here. The caller "
8908 "should be prepared to handle any string."
8912 #: ../src/guestfs-actions.pod:2561
8913 msgid "guestfs_inspect_get_filesystems"
8917 #: ../src/guestfs-actions.pod:2563
8921 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
8922 " const char *root);\n"
8927 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1750
8929 "This returns a list of all the filesystems that we think are associated with "
8930 "this operating system. This includes the root filesystem, other ordinary "
8931 "filesystems, and non-mounted devices like swap partitions."
8935 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1755
8937 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8938 "to be shared between operating systems."
8942 #: ../src/guestfs-actions.pod:2578
8944 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8945 "C<guestfs_inspect_get_mountpoints>."
8949 #: ../src/guestfs-actions.pod:2587
8950 msgid "guestfs_inspect_get_hostname"
8954 #: ../src/guestfs-actions.pod:2589
8958 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
8959 " const char *root);\n"
8964 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1768
8966 "This function returns the hostname of the operating system as found by "
8967 "inspection of the guest's configuration files."
8971 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1771
8973 "If the hostname could not be determined, then the string C<unknown> is "
8978 #: ../src/guestfs-actions.pod:2607
8979 msgid "guestfs_inspect_get_major_version"
8983 #: ../src/guestfs-actions.pod:2609
8987 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
8988 " const char *root);\n"
8993 #: ../src/guestfs-actions.pod:2616 ../fish/guestfish-actions.pod:1783
8995 "This returns the major version number of the inspected operating system."
8999 #: ../src/guestfs-actions.pod:2619 ../fish/guestfish-actions.pod:1786
9001 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
9002 "popular public names used by the operating system. Notably the operating "
9003 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
9004 "1). You can find out the real versions corresponding to releases of Windows "
9005 "by consulting Wikipedia or MSDN."
9009 #: ../src/guestfs-actions.pod:2626 ../src/guestfs-actions.pod:2646
9010 #: ../fish/guestfish-actions.pod:1793 ../fish/guestfish-actions.pod:1807
9011 msgid "If the version could not be determined, then C<0> is returned."
9015 #: ../src/guestfs-actions.pod:2634
9016 msgid "guestfs_inspect_get_minor_version"
9020 #: ../src/guestfs-actions.pod:2636
9024 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
9025 " const char *root);\n"
9030 #: ../src/guestfs-actions.pod:2643 ../fish/guestfish-actions.pod:1804
9032 "This returns the minor version number of the inspected operating system."
9036 #: ../src/guestfs-actions.pod:2648
9038 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9039 "C<guestfs_inspect_get_major_version>."
9043 #: ../src/guestfs-actions.pod:2655
9044 msgid "guestfs_inspect_get_mountpoints"
9048 #: ../src/guestfs-actions.pod:2657
9052 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
9053 " const char *root);\n"
9058 #: ../src/guestfs-actions.pod:2664 ../fish/guestfish-actions.pod:1819
9060 "This returns a hash of where we think the filesystems associated with this "
9061 "operating system should be mounted. Callers should note that this is at "
9062 "best an educated guess made by reading configuration files such as C</etc/"
9067 #: ../src/guestfs-actions.pod:2669 ../fish/guestfish-actions.pod:1824
9069 "Each element in the returned hashtable has a key which is the path of the "
9070 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
9071 "mounted there (eg. C</dev/sda1>)."
9075 #: ../src/guestfs-actions.pod:2674 ../fish/guestfish-actions.pod:1829
9077 "Non-mounted devices such as swap devices are I<not> returned in this list."
9081 #: ../src/guestfs-actions.pod:2677
9083 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9084 "C<guestfs_inspect_get_filesystems>."
9088 #: ../src/guestfs-actions.pod:2680 ../src/guestfs-actions.pod:3288
9089 #: ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:6272
9091 "This function returns a NULL-terminated array of strings, or NULL if there "
9092 "was an error. The array of strings will always have length C<2n+1>, where "
9093 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
9094 "caller must free the strings and the array after use>."
9098 #: ../src/guestfs-actions.pod:2688
9099 msgid "guestfs_inspect_get_package_format"
9103 #: ../src/guestfs-actions.pod:2690
9107 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
9108 " const char *root);\n"
9113 #: ../src/guestfs-actions.pod:2697
9115 "This function and C<guestfs_inspect_get_package_management> return the "
9116 "package format and package management tool used by the inspected operating "
9117 "system. For example for Fedora these functions would return C<rpm> (package "
9118 "format) and C<yum> (package management)."
9122 #: ../src/guestfs-actions.pod:2703 ../fish/guestfish-actions.pod:1848
9124 "This returns the string C<unknown> if we could not determine the package "
9125 "format I<or> if the operating system does not have a real packaging system "
9130 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1852
9132 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
9133 "Future versions of libguestfs may return other strings."
9137 #: ../src/guestfs-actions.pod:2715
9138 msgid "guestfs_inspect_get_package_management"
9142 #: ../src/guestfs-actions.pod:2717
9146 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
9147 " const char *root);\n"
9152 #: ../src/guestfs-actions.pod:2724
9154 "C<guestfs_inspect_get_package_format> and this function return the package "
9155 "format and package management tool used by the inspected operating system. "
9156 "For example for Fedora these functions would return C<rpm> (package format) "
9157 "and C<yum> (package management)."
9161 #: ../src/guestfs-actions.pod:2730 ../fish/guestfish-actions.pod:1870
9163 "This returns the string C<unknown> if we could not determine the package "
9164 "management tool I<or> if the operating system does not have a real packaging "
9165 "system (eg. Windows)."
9169 #: ../src/guestfs-actions.pod:2734 ../fish/guestfish-actions.pod:1874
9171 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
9172 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
9173 "libguestfs may return other strings."
9177 #: ../src/guestfs-actions.pod:2744
9178 msgid "guestfs_inspect_get_product_name"
9182 #: ../src/guestfs-actions.pod:2746
9186 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
9187 " const char *root);\n"
9192 #: ../src/guestfs-actions.pod:2753 ../fish/guestfish-actions.pod:1888
9194 "This returns the product name of the inspected operating system. The "
9195 "product name is generally some freeform string which can be displayed to the "
9196 "user, but should not be parsed by programs."
9200 #: ../src/guestfs-actions.pod:2758 ../fish/guestfish-actions.pod:1893
9202 "If the product name could not be determined, then the string C<unknown> is "
9207 #: ../src/guestfs-actions.pod:2768
9208 msgid "guestfs_inspect_get_roots"
9212 #: ../src/guestfs-actions.pod:2770
9216 " guestfs_inspect_get_roots (guestfs_h *g);\n"
9221 #: ../src/guestfs-actions.pod:2773
9223 "This function is a convenient way to get the list of root devices, as "
9224 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
9225 "the whole inspection process."
9229 #: ../src/guestfs-actions.pod:2777
9231 "This returns an empty list if either no root devices were found or the "
9232 "caller has not called C<guestfs_inspect_os>."
9236 #: ../src/guestfs-actions.pod:2786
9237 msgid "guestfs_inspect_get_type"
9241 #: ../src/guestfs-actions.pod:2788
9245 " guestfs_inspect_get_type (guestfs_h *g,\n"
9246 " const char *root);\n"
9251 #: ../src/guestfs-actions.pod:2795 ../fish/guestfish-actions.pod:1918
9253 "This returns the type of the inspected operating system. Currently defined "
9258 #: ../src/guestfs-actions.pod:2800 ../fish/guestfish-actions.pod:1923
9263 #: ../src/guestfs-actions.pod:2802 ../fish/guestfish-actions.pod:1925
9264 msgid "Any Linux-based operating system."
9268 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1929
9269 msgid "Any Microsoft Windows operating system."
9273 #: ../src/guestfs-actions.pod:2808 ../fish/guestfish-actions.pod:1931
9278 #: ../src/guestfs-actions.pod:2810 ../fish/guestfish-actions.pod:1933
9283 #: ../src/guestfs-actions.pod:2814 ../fish/guestfish-actions.pod:1937
9284 msgid "The operating system type could not be determined."
9288 #: ../src/guestfs-actions.pod:2828
9289 msgid "guestfs_inspect_get_windows_systemroot"
9293 #: ../src/guestfs-actions.pod:2830
9297 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
9298 " const char *root);\n"
9303 #: ../src/guestfs-actions.pod:2837 ../fish/guestfish-actions.pod:1953
9305 "This returns the Windows systemroot of the inspected guest. The systemroot "
9306 "is a directory path such as C</WINDOWS>."
9310 #: ../src/guestfs-actions.pod:2840 ../fish/guestfish-actions.pod:1956
9312 "This call assumes that the guest is Windows and that the systemroot could be "
9313 "determined by inspection. If this is not the case then an error is returned."
9317 #: ../src/guestfs-actions.pod:2849
9318 msgid "(Added in 1.5.25)"
9322 #: ../src/guestfs-actions.pod:2851
9323 msgid "guestfs_inspect_list_applications"
9327 #: ../src/guestfs-actions.pod:2853
9330 " struct guestfs_application_list *\n"
9331 " guestfs_inspect_list_applications (guestfs_h *g,\n"
9332 " const char *root);\n"
9337 #: ../src/guestfs-actions.pod:2860 ../fish/guestfish-actions.pod:1969
9338 msgid "Return the list of applications installed in the operating system."
9342 #: ../src/guestfs-actions.pod:2862
9344 "I<Note:> This call works differently from other parts of the inspection "
9345 "API. You have to call C<guestfs_inspect_os>, then "
9346 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
9347 "this. Listing applications is a significantly more difficult operation "
9348 "which requires access to the full filesystem. Also note that unlike the "
9349 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
9350 "the libguestfs handle, this call actually reads parts of the mounted "
9351 "filesystems during the call."
9355 #: ../src/guestfs-actions.pod:2872 ../fish/guestfish-actions.pod:1981
9357 "This returns an empty list if the inspection code was not able to determine "
9358 "the list of applications."
9362 #: ../src/guestfs-actions.pod:2875 ../fish/guestfish-actions.pod:1984
9363 msgid "The application structure contains the following fields:"
9367 #: ../src/guestfs-actions.pod:2879 ../fish/guestfish-actions.pod:1988
9372 #: ../src/guestfs-actions.pod:2881 ../fish/guestfish-actions.pod:1990
9374 "The name of the application. For Red Hat-derived and Debian-derived Linux "
9375 "guests, this is the package name."
9379 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1993
9380 msgid "C<app_display_name>"
9384 #: ../src/guestfs-actions.pod:2886 ../fish/guestfish-actions.pod:1995
9386 "The display name of the application, sometimes localized to the install "
9387 "language of the guest operating system."
9391 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1998
9393 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
9394 "to display something can use C<app_name> instead."
9398 #: ../src/guestfs-actions.pod:2892 ../fish/guestfish-actions.pod:2001
9399 msgid "C<app_epoch>"
9403 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:2003
9405 "For package managers which use epochs, this contains the epoch of the "
9406 "package (an integer). If unavailable, this is returned as C<0>."
9410 #: ../src/guestfs-actions.pod:2897 ../fish/guestfish-actions.pod:2006
9411 msgid "C<app_version>"
9415 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:2008
9417 "The version string of the application or package. If unavailable this is "
9418 "returned as an empty string C<\"\">."
9422 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:2011
9423 msgid "C<app_release>"
9427 #: ../src/guestfs-actions.pod:2904 ../fish/guestfish-actions.pod:2013
9429 "The release string of the application or package, for package managers that "
9430 "use this. If unavailable this is returned as an empty string C<\"\">."
9434 #: ../src/guestfs-actions.pod:2908 ../fish/guestfish-actions.pod:2017
9435 msgid "C<app_install_path>"
9439 #: ../src/guestfs-actions.pod:2910 ../fish/guestfish-actions.pod:2019
9441 "The installation path of the application (on operating systems such as "
9442 "Windows which use installation paths). This path is in the format used by "
9443 "the guest operating system, it is not a libguestfs path."
9447 #: ../src/guestfs-actions.pod:2915 ../fish/guestfish-actions.pod:2024
9448 msgid "If unavailable this is returned as an empty string C<\"\">."
9452 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:2026
9453 msgid "C<app_trans_path>"
9457 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2028
9459 "The install path translated into a libguestfs path. If unavailable this is "
9460 "returned as an empty string C<\"\">."
9464 #: ../src/guestfs-actions.pod:2922 ../fish/guestfish-actions.pod:2031
9465 msgid "C<app_publisher>"
9469 #: ../src/guestfs-actions.pod:2924 ../fish/guestfish-actions.pod:2033
9471 "The name of the publisher of the application, for package managers that use "
9472 "this. If unavailable this is returned as an empty string C<\"\">."
9476 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2037
9481 #: ../src/guestfs-actions.pod:2930 ../fish/guestfish-actions.pod:2039
9483 "The URL (eg. upstream URL) of the application. If unavailable this is "
9484 "returned as an empty string C<\"\">."
9488 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2042
9489 msgid "C<app_source_package>"
9493 #: ../src/guestfs-actions.pod:2935 ../fish/guestfish-actions.pod:2044
9495 "For packaging systems which support this, the name of the source package. "
9496 "If unavailable this is returned as an empty string C<\"\">."
9500 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2047
9501 msgid "C<app_summary>"
9505 #: ../src/guestfs-actions.pod:2940 ../fish/guestfish-actions.pod:2049
9507 "A short (usually one line) description of the application or package. If "
9508 "unavailable this is returned as an empty string C<\"\">."
9512 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2052
9513 msgid "C<app_description>"
9517 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2054
9519 "A longer description of the application or package. If unavailable this is "
9520 "returned as an empty string C<\"\">."
9524 #: ../src/guestfs-actions.pod:2952
9526 "This function returns a C<struct guestfs_application_list *>, or NULL if "
9527 "there was an error. I<The caller must call C<guestfs_free_application_list> "
9532 #: ../src/guestfs-actions.pod:2956
9533 msgid "guestfs_inspect_os"
9537 #: ../src/guestfs-actions.pod:2958
9541 " guestfs_inspect_os (guestfs_h *g);\n"
9546 #: ../src/guestfs-actions.pod:2961 ../fish/guestfish-actions.pod:2065
9548 "This function uses other libguestfs functions and certain heuristics to "
9549 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
9550 "for operating systems."
9554 #: ../src/guestfs-actions.pod:2965 ../fish/guestfish-actions.pod:2069
9555 msgid "The list returned is empty if no operating systems were found."
9559 #: ../src/guestfs-actions.pod:2967 ../fish/guestfish-actions.pod:2071
9561 "If one operating system was found, then this returns a list with a single "
9562 "element, which is the name of the root filesystem of this operating system. "
9563 "It is also possible for this function to return a list containing more than "
9564 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
9565 "element being the root filesystem of one of the operating systems."
9569 #: ../src/guestfs-actions.pod:2974
9571 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
9572 "functions in order to query further information about each operating system, "
9573 "such as the name and version."
9577 #: ../src/guestfs-actions.pod:2979
9579 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
9580 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
9581 "the contents. This should be called with no disks currently mounted. The "
9582 "function may also use Augeas, so any existing Augeas handle will be closed."
9586 #: ../src/guestfs-actions.pod:2985 ../fish/guestfish-actions.pod:2089
9588 "This function cannot decrypt encrypted disks. The caller must do that first "
9589 "(supplying the necessary keys) if the disk is encrypted."
9593 #: ../src/guestfs-actions.pod:2991 ../src/guestfs-actions.pod:3246
9594 #: ../src/guestfs-actions.pod:3308
9595 msgid "See also C<guestfs_list_filesystems>."
9599 #: ../src/guestfs-actions.pod:2999
9600 msgid "guestfs_is_blockdev"
9604 #: ../src/guestfs-actions.pod:3001
9608 " guestfs_is_blockdev (guestfs_h *g,\n"
9609 " const char *path);\n"
9614 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:2101
9616 "This returns C<true> if and only if there is a block device with the given "
9621 #: ../src/guestfs-actions.pod:3008 ../src/guestfs-actions.pod:3037
9622 #: ../src/guestfs-actions.pod:3067 ../src/guestfs-actions.pod:3082
9623 #: ../src/guestfs-actions.pod:3098 ../src/guestfs-actions.pod:3154
9624 #: ../src/guestfs-actions.pod:3169
9625 msgid "See also C<guestfs_stat>."
9629 #: ../src/guestfs-actions.pod:3012 ../src/guestfs-actions.pod:3041
9630 #: ../src/guestfs-actions.pod:3086 ../src/guestfs-actions.pod:3158
9631 #: ../src/guestfs-actions.pod:3173
9632 msgid "(Added in 1.5.10)"
9636 #: ../src/guestfs-actions.pod:3014
9637 msgid "guestfs_is_busy"
9641 #: ../src/guestfs-actions.pod:3016
9645 " guestfs_is_busy (guestfs_h *g);\n"
9650 #: ../src/guestfs-actions.pod:3019 ../fish/guestfish-actions.pod:2110
9652 "This returns true iff this handle is busy processing a command (in the "
9657 #: ../src/guestfs-actions.pod:3028
9658 msgid "guestfs_is_chardev"
9662 #: ../src/guestfs-actions.pod:3030
9666 " guestfs_is_chardev (guestfs_h *g,\n"
9667 " const char *path);\n"
9672 #: ../src/guestfs-actions.pod:3034 ../fish/guestfish-actions.pod:2119
9674 "This returns C<true> if and only if there is a character device with the "
9675 "given C<path> name."
9679 #: ../src/guestfs-actions.pod:3043
9680 msgid "guestfs_is_config"
9684 #: ../src/guestfs-actions.pod:3045
9688 " guestfs_is_config (guestfs_h *g);\n"
9693 #: ../src/guestfs-actions.pod:3048 ../fish/guestfish-actions.pod:2128
9695 "This returns true iff this handle is being configured (in the C<CONFIG> "
9700 #: ../src/guestfs-actions.pod:3057
9701 msgid "guestfs_is_dir"
9705 #: ../src/guestfs-actions.pod:3059
9709 " guestfs_is_dir (guestfs_h *g,\n"
9710 " const char *path);\n"
9715 #: ../src/guestfs-actions.pod:3063 ../fish/guestfish-actions.pod:2137
9717 "This returns C<true> if and only if there is a directory with the given "
9718 "C<path> name. Note that it returns false for other objects like files."
9722 #: ../src/guestfs-actions.pod:3073
9723 msgid "guestfs_is_fifo"
9727 #: ../src/guestfs-actions.pod:3075
9731 " guestfs_is_fifo (guestfs_h *g,\n"
9732 " const char *path);\n"
9737 #: ../src/guestfs-actions.pod:3079 ../fish/guestfish-actions.pod:2147
9739 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9740 "given C<path> name."
9744 #: ../src/guestfs-actions.pod:3088
9745 msgid "guestfs_is_file"
9749 #: ../src/guestfs-actions.pod:3090
9753 " guestfs_is_file (guestfs_h *g,\n"
9754 " const char *path);\n"
9759 #: ../src/guestfs-actions.pod:3094 ../fish/guestfish-actions.pod:2156
9761 "This returns C<true> if and only if there is a regular file with the given "
9762 "C<path> name. Note that it returns false for other objects like directories."
9766 #: ../src/guestfs-actions.pod:3104
9767 msgid "guestfs_is_launching"
9771 #: ../src/guestfs-actions.pod:3106
9775 " guestfs_is_launching (guestfs_h *g);\n"
9780 #: ../src/guestfs-actions.pod:3109 ../fish/guestfish-actions.pod:2166
9782 "This returns true iff this handle is launching the subprocess (in the "
9783 "C<LAUNCHING> state)."
9787 #: ../src/guestfs-actions.pod:3118
9788 msgid "guestfs_is_lv"
9792 #: ../src/guestfs-actions.pod:3120
9796 " guestfs_is_lv (guestfs_h *g,\n"
9797 " const char *device);\n"
9802 #: ../src/guestfs-actions.pod:3124 ../fish/guestfish-actions.pod:2175
9804 "This command tests whether C<device> is a logical volume, and returns true "
9805 "iff this is the case."
9809 #: ../src/guestfs-actions.pod:3131
9810 msgid "guestfs_is_ready"
9814 #: ../src/guestfs-actions.pod:3133
9818 " guestfs_is_ready (guestfs_h *g);\n"
9823 #: ../src/guestfs-actions.pod:3136 ../fish/guestfish-actions.pod:2182
9825 "This returns true iff this handle is ready to accept commands (in the "
9830 #: ../src/guestfs-actions.pod:3145
9831 msgid "guestfs_is_socket"
9835 #: ../src/guestfs-actions.pod:3147
9839 " guestfs_is_socket (guestfs_h *g,\n"
9840 " const char *path);\n"
9845 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2191
9847 "This returns C<true> if and only if there is a Unix domain socket with the "
9848 "given C<path> name."
9852 #: ../src/guestfs-actions.pod:3160
9853 msgid "guestfs_is_symlink"
9857 #: ../src/guestfs-actions.pod:3162
9861 " guestfs_is_symlink (guestfs_h *g,\n"
9862 " const char *path);\n"
9867 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2200
9869 "This returns C<true> if and only if there is a symbolic link with the given "
9874 #: ../src/guestfs-actions.pod:3175
9875 msgid "guestfs_kill_subprocess"
9879 #: ../src/guestfs-actions.pod:3177
9883 " guestfs_kill_subprocess (guestfs_h *g);\n"
9888 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2209
9889 msgid "This kills the qemu subprocess. You should never need to call this."
9893 #: ../src/guestfs-actions.pod:3186
9894 msgid "guestfs_launch"
9898 #: ../src/guestfs-actions.pod:3188
9902 " guestfs_launch (guestfs_h *g);\n"
9907 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2217
9909 "Internally libguestfs is implemented by running a virtual machine using "
9914 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2220
9916 "You should call this after configuring the handle (eg. adding drives) but "
9917 "before performing any actions."
9921 #: ../src/guestfs-actions.pod:3201
9922 msgid "guestfs_lchown"
9926 #: ../src/guestfs-actions.pod:3203
9930 " guestfs_lchown (guestfs_h *g,\n"
9933 " const char *path);\n"
9938 #: ../src/guestfs-actions.pod:3209
9940 "Change the file owner to C<owner> and group to C<group>. This is like "
9941 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
9942 "changed, not the target."
9946 #: ../src/guestfs-actions.pod:3221
9947 msgid "guestfs_lgetxattrs"
9951 #: ../src/guestfs-actions.pod:3223
9954 " struct guestfs_xattr_list *\n"
9955 " guestfs_lgetxattrs (guestfs_h *g,\n"
9956 " const char *path);\n"
9961 #: ../src/guestfs-actions.pod:3227
9963 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
9964 "then it returns the extended attributes of the link itself."
9968 #: ../src/guestfs-actions.pod:3237
9969 msgid "guestfs_list_devices"
9973 #: ../src/guestfs-actions.pod:3239
9977 " guestfs_list_devices (guestfs_h *g);\n"
9982 #: ../src/guestfs-actions.pod:3242 ../fish/guestfish-actions.pod:2247
9983 msgid "List all the block devices."
9987 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2249
9988 msgid "The full block device names are returned, eg. C</dev/sda>."
9992 #: ../src/guestfs-actions.pod:3254
9993 msgid "guestfs_list_filesystems"
9997 #: ../src/guestfs-actions.pod:3256
10001 " guestfs_list_filesystems (guestfs_h *g);\n"
10006 #: ../src/guestfs-actions.pod:3259 ../fish/guestfish-actions.pod:2257
10008 "This inspection command looks for filesystems on partitions, block devices "
10009 "and logical volumes, returning a list of devices containing filesystems and "
10014 #: ../src/guestfs-actions.pod:3263 ../fish/guestfish-actions.pod:2261
10016 "The return value is a hash, where the keys are the devices containing "
10017 "filesystems, and the values are the filesystem types. For example:"
10021 #: ../src/guestfs-actions.pod:3267 ../fish/guestfish-actions.pod:2265
10024 " \"/dev/sda1\" => \"ntfs\"\n"
10025 " \"/dev/sda2\" => \"ext2\"\n"
10026 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
10027 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
10032 #: ../src/guestfs-actions.pod:3272 ../fish/guestfish-actions.pod:2270
10034 "The value can have the special value \"unknown\", meaning the content of the "
10035 "device is undetermined or empty. \"swap\" means a Linux swap partition."
10039 #: ../src/guestfs-actions.pod:3276
10041 "This command runs other libguestfs commands, which might include "
10042 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
10043 "soon after launch and only when nothing is mounted."
10047 #: ../src/guestfs-actions.pod:3280
10049 "Not all of the filesystems returned will be mountable. In particular, swap "
10050 "partitions are returned in the list. Also this command does not check that "
10051 "each filesystem found is valid and mountable, and some filesystems might be "
10052 "mountable but require special options. Filesystems may not all belong to a "
10053 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
10057 #: ../src/guestfs-actions.pod:3294 ../src/guestfs-actions.pod:4817
10058 msgid "(Added in 1.5.15)"
10062 #: ../src/guestfs-actions.pod:3296
10063 msgid "guestfs_list_partitions"
10067 #: ../src/guestfs-actions.pod:3298
10071 " guestfs_list_partitions (guestfs_h *g);\n"
10076 #: ../src/guestfs-actions.pod:3301 ../fish/guestfish-actions.pod:2290
10077 msgid "List all the partitions detected on all block devices."
10081 #: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2292
10082 msgid "The full partition device names are returned, eg. C</dev/sda1>"
10086 #: ../src/guestfs-actions.pod:3305
10088 "This does not return logical volumes. For that you will need to call "
10093 #: ../src/guestfs-actions.pod:3316
10098 #: ../src/guestfs-actions.pod:3318
10102 " guestfs_ll (guestfs_h *g,\n"
10103 " const char *directory);\n"
10108 #: ../src/guestfs-actions.pod:3322 ../fish/guestfish-actions.pod:2303
10110 "List the files in C<directory> (relative to the root directory, there is no "
10111 "cwd) in the format of 'ls -la'."
10115 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2306
10117 "This command is mostly useful for interactive sessions. It is I<not> "
10118 "intended that you try to parse the output string."
10122 #: ../src/guestfs-actions.pod:3333
10127 #: ../src/guestfs-actions.pod:3335
10131 " guestfs_ln (guestfs_h *g,\n"
10132 " const char *target,\n"
10133 " const char *linkname);\n"
10138 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2313
10139 msgid "This command creates a hard link using the C<ln> command."
10143 #: ../src/guestfs-actions.pod:3346
10144 msgid "guestfs_ln_f"
10148 #: ../src/guestfs-actions.pod:3348
10152 " guestfs_ln_f (guestfs_h *g,\n"
10153 " const char *target,\n"
10154 " const char *linkname);\n"
10159 #: ../src/guestfs-actions.pod:3353 ../fish/guestfish-actions.pod:2319
10161 "This command creates a hard link using the C<ln -f> command. The C<-f> "
10162 "option removes the link (C<linkname>) if it exists already."
10166 #: ../src/guestfs-actions.pod:3360
10167 msgid "guestfs_ln_s"
10171 #: ../src/guestfs-actions.pod:3362
10175 " guestfs_ln_s (guestfs_h *g,\n"
10176 " const char *target,\n"
10177 " const char *linkname);\n"
10182 #: ../src/guestfs-actions.pod:3367 ../fish/guestfish-actions.pod:2326
10183 msgid "This command creates a symbolic link using the C<ln -s> command."
10187 #: ../src/guestfs-actions.pod:3373
10188 msgid "guestfs_ln_sf"
10192 #: ../src/guestfs-actions.pod:3375
10196 " guestfs_ln_sf (guestfs_h *g,\n"
10197 " const char *target,\n"
10198 " const char *linkname);\n"
10203 #: ../src/guestfs-actions.pod:3380 ../fish/guestfish-actions.pod:2332
10205 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
10206 "option removes the link (C<linkname>) if it exists already."
10210 #: ../src/guestfs-actions.pod:3387
10211 msgid "guestfs_lremovexattr"
10215 #: ../src/guestfs-actions.pod:3389
10219 " guestfs_lremovexattr (guestfs_h *g,\n"
10220 " const char *xattr,\n"
10221 " const char *path);\n"
10226 #: ../src/guestfs-actions.pod:3394
10228 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
10229 "link, then it removes an extended attribute of the link itself."
10233 #: ../src/guestfs-actions.pod:3402
10238 #: ../src/guestfs-actions.pod:3404
10242 " guestfs_ls (guestfs_h *g,\n"
10243 " const char *directory);\n"
10248 #: ../src/guestfs-actions.pod:3408 ../fish/guestfish-actions.pod:2347
10250 "List the files in C<directory> (relative to the root directory, there is no "
10251 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
10255 #: ../src/guestfs-actions.pod:3412
10257 "This command is mostly useful for interactive sessions. Programs should "
10258 "probably use C<guestfs_readdir> instead."
10262 #: ../src/guestfs-actions.pod:3421
10263 msgid "guestfs_lsetxattr"
10267 #: ../src/guestfs-actions.pod:3423
10271 " guestfs_lsetxattr (guestfs_h *g,\n"
10272 " const char *xattr,\n"
10273 " const char *val,\n"
10275 " const char *path);\n"
10280 #: ../src/guestfs-actions.pod:3430
10282 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
10283 "then it sets an extended attribute of the link itself."
10287 #: ../src/guestfs-actions.pod:3438
10288 msgid "guestfs_lstat"
10292 #: ../src/guestfs-actions.pod:3440
10295 " struct guestfs_stat *\n"
10296 " guestfs_lstat (guestfs_h *g,\n"
10297 " const char *path);\n"
10302 #: ../src/guestfs-actions.pod:3444 ../src/guestfs-actions.pod:5871
10303 #: ../fish/guestfish-actions.pod:2366 ../fish/guestfish-actions.pod:3948
10304 msgid "Returns file information for the given C<path>."
10308 #: ../src/guestfs-actions.pod:3446
10310 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
10311 "link, then the link is stat-ed, not the file it refers to."
10315 #: ../src/guestfs-actions.pod:3450 ../fish/guestfish-actions.pod:2372
10316 msgid "This is the same as the C<lstat(2)> system call."
10320 #: ../src/guestfs-actions.pod:3452 ../src/guestfs-actions.pod:5875
10322 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
10323 "error. I<The caller must call C<guestfs_free_stat> after use>."
10327 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:5879
10328 #: ../src/guestfs-actions.pod:5897 ../src/guestfs-actions.pod:6278
10329 msgid "(Added in 0.9.2)"
10333 #: ../src/guestfs-actions.pod:3458
10334 msgid "guestfs_lstatlist"
10338 #: ../src/guestfs-actions.pod:3460
10341 " struct guestfs_stat_list *\n"
10342 " guestfs_lstatlist (guestfs_h *g,\n"
10343 " const char *path,\n"
10344 " char *const *names);\n"
10349 #: ../src/guestfs-actions.pod:3465
10351 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
10352 "files, where all files are in the directory C<path>. C<names> is the list "
10353 "of files from this directory."
10357 #: ../src/guestfs-actions.pod:3469 ../fish/guestfish-actions.pod:2382
10359 "On return you get a list of stat structs, with a one-to-one correspondence "
10360 "to the C<names> list. If any name did not exist or could not be lstat'd, "
10361 "then the C<ino> field of that structure is set to C<-1>."
10365 #: ../src/guestfs-actions.pod:3474
10367 "This call is intended for programs that want to efficiently list a directory "
10368 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
10369 "for a similarly efficient call for getting extended attributes. Very long "
10370 "directory listings might cause the protocol message size to be exceeded, "
10371 "causing this call to fail. The caller must split up such requests into "
10372 "smaller groups of names."
10376 #: ../src/guestfs-actions.pod:3482
10378 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
10379 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
10383 #: ../src/guestfs-actions.pod:3488
10384 msgid "guestfs_luks_add_key"
10388 #: ../src/guestfs-actions.pod:3490
10392 " guestfs_luks_add_key (guestfs_h *g,\n"
10393 " const char *device,\n"
10394 " const char *key,\n"
10395 " const char *newkey,\n"
10401 #: ../src/guestfs-actions.pod:3497 ../fish/guestfish-actions.pod:2399
10403 "This command adds a new key on LUKS device C<device>. C<key> is any "
10404 "existing key, and is used to access the device. C<newkey> is the new key to "
10405 "add. C<keyslot> is the key slot that will be replaced."
10409 #: ../src/guestfs-actions.pod:3502
10411 "Note that if C<keyslot> already contains a key, then this command will "
10412 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
10416 #: ../src/guestfs-actions.pod:3508 ../src/guestfs-actions.pod:3548
10417 #: ../src/guestfs-actions.pod:3571 ../src/guestfs-actions.pod:3591
10418 #: ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3642
10420 "This function takes a key or passphrase parameter which could contain "
10421 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
10426 #: ../src/guestfs-actions.pod:3512 ../src/guestfs-actions.pod:3552
10427 #: ../src/guestfs-actions.pod:3575 ../src/guestfs-actions.pod:3595
10428 msgid "(Added in 1.5.2)"
10432 #: ../src/guestfs-actions.pod:3514
10433 msgid "guestfs_luks_close"
10437 #: ../src/guestfs-actions.pod:3516
10441 " guestfs_luks_close (guestfs_h *g,\n"
10442 " const char *device);\n"
10447 #: ../src/guestfs-actions.pod:3520
10449 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
10450 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
10451 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
10452 "underlying block device."
10456 #: ../src/guestfs-actions.pod:3528 ../src/guestfs-actions.pod:3627
10457 #: ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3696
10458 #: ../src/guestfs-actions.pod:3744
10459 msgid "(Added in 1.5.1)"
10463 #: ../src/guestfs-actions.pod:3530
10464 msgid "guestfs_luks_format"
10468 #: ../src/guestfs-actions.pod:3532
10472 " guestfs_luks_format (guestfs_h *g,\n"
10473 " const char *device,\n"
10474 " const char *key,\n"
10480 #: ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:2425
10482 "This command erases existing data on C<device> and formats the device as a "
10483 "LUKS encrypted device. C<key> is the initial key, which is added to key "
10484 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
10488 #: ../src/guestfs-actions.pod:3545 ../src/guestfs-actions.pod:3568
10489 #: ../src/guestfs-actions.pod:3708 ../src/guestfs-actions.pod:4568
10490 #: ../src/guestfs-actions.pod:5331 ../src/guestfs-actions.pod:5706
10491 #: ../src/guestfs-actions.pod:5729 ../src/guestfs-actions.pod:5755
10492 #: ../src/guestfs-actions.pod:6905 ../fish/guestfish-actions.pod:2433
10493 #: ../fish/guestfish-actions.pod:2446 ../fish/guestfish-actions.pod:2530
10494 #: ../fish/guestfish-actions.pod:3060 ../fish/guestfish-actions.pod:3567
10495 #: ../fish/guestfish-actions.pod:3847 ../fish/guestfish-actions.pod:3863
10496 #: ../fish/guestfish-actions.pod:3878 ../fish/guestfish-actions.pod:4593
10498 "B<This command is dangerous. Without careful use you can easily destroy all "
10503 #: ../src/guestfs-actions.pod:3554
10504 msgid "guestfs_luks_format_cipher"
10508 #: ../src/guestfs-actions.pod:3556
10512 " guestfs_luks_format_cipher (guestfs_h *g,\n"
10513 " const char *device,\n"
10514 " const char *key,\n"
10516 " const char *cipher);\n"
10521 #: ../src/guestfs-actions.pod:3563
10523 "This command is the same as C<guestfs_luks_format> but it also allows you to "
10524 "set the C<cipher> used."
10528 #: ../src/guestfs-actions.pod:3577
10529 msgid "guestfs_luks_kill_slot"
10533 #: ../src/guestfs-actions.pod:3579
10537 " guestfs_luks_kill_slot (guestfs_h *g,\n"
10538 " const char *device,\n"
10539 " const char *key,\n"
10545 #: ../src/guestfs-actions.pod:3585 ../fish/guestfish-actions.pod:2453
10547 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
10548 "device C<device>. C<key> must be one of the I<other> keys."
10552 #: ../src/guestfs-actions.pod:3597
10553 msgid "guestfs_luks_open"
10557 #: ../src/guestfs-actions.pod:3599
10561 " guestfs_luks_open (guestfs_h *g,\n"
10562 " const char *device,\n"
10563 " const char *key,\n"
10564 " const char *mapname);\n"
10569 #: ../src/guestfs-actions.pod:3605 ../fish/guestfish-actions.pod:2464
10571 "This command opens a block device which has been encrypted according to the "
10572 "Linux Unified Key Setup (LUKS) standard."
10576 #: ../src/guestfs-actions.pod:3608 ../fish/guestfish-actions.pod:2467
10577 msgid "C<device> is the encrypted block device or partition."
10581 #: ../src/guestfs-actions.pod:3610 ../fish/guestfish-actions.pod:2469
10583 "The caller must supply one of the keys associated with the LUKS block "
10584 "device, in the C<key> parameter."
10588 #: ../src/guestfs-actions.pod:3613 ../fish/guestfish-actions.pod:2472
10590 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
10591 "writes to this block device are decrypted from and encrypted to the "
10592 "underlying C<device> respectively."
10596 #: ../src/guestfs-actions.pod:3617
10598 "If this block device contains LVM volume groups, then calling "
10599 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
10604 #: ../src/guestfs-actions.pod:3629
10605 msgid "guestfs_luks_open_ro"
10609 #: ../src/guestfs-actions.pod:3631
10613 " guestfs_luks_open_ro (guestfs_h *g,\n"
10614 " const char *device,\n"
10615 " const char *key,\n"
10616 " const char *mapname);\n"
10621 #: ../src/guestfs-actions.pod:3637
10623 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
10628 #: ../src/guestfs-actions.pod:3648
10629 msgid "guestfs_lvcreate"
10633 #: ../src/guestfs-actions.pod:3650
10637 " guestfs_lvcreate (guestfs_h *g,\n"
10638 " const char *logvol,\n"
10639 " const char *volgroup,\n"
10645 #: ../src/guestfs-actions.pod:3656 ../fish/guestfish-actions.pod:2497
10647 "This creates an LVM logical volume called C<logvol> on the volume group "
10648 "C<volgroup>, with C<size> megabytes."
10652 #: ../src/guestfs-actions.pod:3663
10653 msgid "guestfs_lvm_canonical_lv_name"
10657 #: ../src/guestfs-actions.pod:3665
10661 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
10662 " const char *lvname);\n"
10667 #: ../src/guestfs-actions.pod:3669 ../fish/guestfish-actions.pod:2504
10669 "This converts alternative naming schemes for LVs that you might find to the "
10670 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
10675 #: ../src/guestfs-actions.pod:3673 ../fish/guestfish-actions.pod:2508
10677 "This command returns an error if the C<lvname> parameter does not refer to a "
10682 #: ../src/guestfs-actions.pod:3676
10683 msgid "See also C<guestfs_is_lv>."
10687 #: ../src/guestfs-actions.pod:3681
10688 msgid "(Added in 1.5.24)"
10692 #: ../src/guestfs-actions.pod:3683
10693 msgid "guestfs_lvm_clear_filter"
10697 #: ../src/guestfs-actions.pod:3685
10701 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
10706 #: ../src/guestfs-actions.pod:3688
10708 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
10709 "see every block device."
10713 #: ../src/guestfs-actions.pod:3691 ../src/guestfs-actions.pod:3733
10714 #: ../fish/guestfish-actions.pod:2520 ../fish/guestfish-actions.pod:2551
10716 "This command also clears the LVM cache and performs a volume group scan."
10720 #: ../src/guestfs-actions.pod:3698
10721 msgid "guestfs_lvm_remove_all"
10725 #: ../src/guestfs-actions.pod:3700
10729 " guestfs_lvm_remove_all (guestfs_h *g);\n"
10734 #: ../src/guestfs-actions.pod:3703 ../fish/guestfish-actions.pod:2527
10736 "This command removes all LVM logical volumes, volume groups and physical "
10741 #: ../src/guestfs-actions.pod:3713
10742 msgid "guestfs_lvm_set_filter"
10746 #: ../src/guestfs-actions.pod:3715
10750 " guestfs_lvm_set_filter (guestfs_h *g,\n"
10751 " char *const *devices);\n"
10756 #: ../src/guestfs-actions.pod:3719 ../fish/guestfish-actions.pod:2537
10758 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10759 "block devices in the list C<devices>, and will ignore all other attached "
10764 #: ../src/guestfs-actions.pod:3723 ../fish/guestfish-actions.pod:2541
10766 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10767 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10768 "there are two types of duplication possible: either cloned PVs/VGs which "
10769 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10770 "same name. In normal operation you cannot create this situation, but you "
10771 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10772 "inside the LVM metadata."
10776 #: ../src/guestfs-actions.pod:3736 ../fish/guestfish-actions.pod:2554
10777 msgid "You can filter whole block devices or individual partitions."
10781 #: ../src/guestfs-actions.pod:3738 ../fish/guestfish-actions.pod:2556
10783 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10784 "filesystem), even if you are not filtering out that VG."
10788 #: ../src/guestfs-actions.pod:3746
10789 msgid "guestfs_lvremove"
10793 #: ../src/guestfs-actions.pod:3748
10797 " guestfs_lvremove (guestfs_h *g,\n"
10798 " const char *device);\n"
10803 #: ../src/guestfs-actions.pod:3752 ../fish/guestfish-actions.pod:2564
10805 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10806 "LV, such as C</dev/VG/LV>."
10810 #: ../src/guestfs-actions.pod:3755 ../fish/guestfish-actions.pod:2567
10812 "You can also remove all LVs in a volume group by specifying the VG name, C</"
10817 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:4914
10818 #: ../src/guestfs-actions.pod:6644
10819 msgid "(Added in 1.0.13)"
10823 #: ../src/guestfs-actions.pod:3762
10824 msgid "guestfs_lvrename"
10828 #: ../src/guestfs-actions.pod:3764
10832 " guestfs_lvrename (guestfs_h *g,\n"
10833 " const char *logvol,\n"
10834 " const char *newlogvol);\n"
10839 #: ../src/guestfs-actions.pod:3769 ../fish/guestfish-actions.pod:2574
10840 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10844 #: ../src/guestfs-actions.pod:3773 ../src/guestfs-actions.pod:6657
10845 msgid "(Added in 1.0.83)"
10849 #: ../src/guestfs-actions.pod:3775
10850 msgid "guestfs_lvresize"
10854 #: ../src/guestfs-actions.pod:3777
10858 " guestfs_lvresize (guestfs_h *g,\n"
10859 " const char *device,\n"
10865 #: ../src/guestfs-actions.pod:3782 ../fish/guestfish-actions.pod:2580
10867 "This resizes (expands or shrinks) an existing LVM logical volume to "
10868 "C<mbytes>. When reducing, data in the reduced part is lost."
10872 #: ../src/guestfs-actions.pod:3790
10873 msgid "guestfs_lvresize_free"
10877 #: ../src/guestfs-actions.pod:3792
10881 " guestfs_lvresize_free (guestfs_h *g,\n"
10882 " const char *lv,\n"
10888 #: ../src/guestfs-actions.pod:3797 ../fish/guestfish-actions.pod:2588
10890 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10891 "remaining free space in the volume group. Commonly you would call this with "
10892 "pc = 100 which expands the logical volume as much as possible, using all "
10893 "remaining free space in the volume group."
10897 #: ../src/guestfs-actions.pod:3805
10898 msgid "(Added in 1.3.3)"
10902 #: ../src/guestfs-actions.pod:3807
10903 msgid "guestfs_lvs"
10907 #: ../src/guestfs-actions.pod:3809
10911 " guestfs_lvs (guestfs_h *g);\n"
10916 #: ../src/guestfs-actions.pod:3812 ../fish/guestfish-actions.pod:2598
10918 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10923 #: ../src/guestfs-actions.pod:3815 ../fish/guestfish-actions.pod:2601
10925 "This returns a list of the logical volume device names (eg. C</dev/"
10926 "VolGroup00/LogVol00>)."
10930 #: ../src/guestfs-actions.pod:3818
10931 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
10935 #: ../src/guestfs-actions.pod:3826
10936 msgid "guestfs_lvs_full"
10940 #: ../src/guestfs-actions.pod:3828
10943 " struct guestfs_lvm_lv_list *\n"
10944 " guestfs_lvs_full (guestfs_h *g);\n"
10949 #: ../src/guestfs-actions.pod:3831 ../fish/guestfish-actions.pod:2610
10951 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10952 "(8)> command. The \"full\" version includes all fields."
10956 #: ../src/guestfs-actions.pod:3834
10958 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
10959 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
10963 #: ../src/guestfs-actions.pod:3840
10964 msgid "guestfs_lvuuid"
10968 #: ../src/guestfs-actions.pod:3842
10972 " guestfs_lvuuid (guestfs_h *g,\n"
10973 " const char *device);\n"
10978 #: ../src/guestfs-actions.pod:3846 ../fish/guestfish-actions.pod:2617
10979 msgid "This command returns the UUID of the LVM LV C<device>."
10983 #: ../src/guestfs-actions.pod:3853
10984 msgid "guestfs_lxattrlist"
10988 #: ../src/guestfs-actions.pod:3855
10991 " struct guestfs_xattr_list *\n"
10992 " guestfs_lxattrlist (guestfs_h *g,\n"
10993 " const char *path,\n"
10994 " char *const *names);\n"
10999 #: ../src/guestfs-actions.pod:3860 ../fish/guestfish-actions.pod:2623
11001 "This call allows you to get the extended attributes of multiple files, where "
11002 "all files are in the directory C<path>. C<names> is the list of files from "
11007 #: ../src/guestfs-actions.pod:3864 ../fish/guestfish-actions.pod:2627
11009 "On return you get a flat list of xattr structs which must be interpreted "
11010 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
11011 "C<attrval> in this struct is zero-length to indicate there was an error "
11012 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
11013 "number (the number of following attributes for this file, which could be C<"
11014 "\"0\">). Then after the first xattr struct are the zero or more attributes "
11015 "for the first named file. This repeats for the second and subsequent files."
11019 #: ../src/guestfs-actions.pod:3874
11021 "This call is intended for programs that want to efficiently list a directory "
11022 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
11023 "a similarly efficient call for getting standard stats. Very long directory "
11024 "listings might cause the protocol message size to be exceeded, causing this "
11025 "call to fail. The caller must split up such requests into smaller groups of "
11030 #: ../src/guestfs-actions.pod:3888
11031 msgid "guestfs_mkdir"
11035 #: ../src/guestfs-actions.pod:3890
11039 " guestfs_mkdir (guestfs_h *g,\n"
11040 " const char *path);\n"
11045 #: ../src/guestfs-actions.pod:3894 ../fish/guestfish-actions.pod:2649
11046 msgid "Create a directory named C<path>."
11050 #: ../src/guestfs-actions.pod:3900
11051 msgid "guestfs_mkdir_mode"
11055 #: ../src/guestfs-actions.pod:3902
11059 " guestfs_mkdir_mode (guestfs_h *g,\n"
11060 " const char *path,\n"
11066 #: ../src/guestfs-actions.pod:3907 ../fish/guestfish-actions.pod:2655
11068 "This command creates a directory, setting the initial permissions of the "
11069 "directory to C<mode>."
11073 #: ../src/guestfs-actions.pod:3910 ../fish/guestfish-actions.pod:2658
11075 "For common Linux filesystems, the actual mode which is set will be C<mode & "
11076 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
11081 #: ../src/guestfs-actions.pod:3914
11082 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
11086 #: ../src/guestfs-actions.pod:3920
11087 msgid "guestfs_mkdir_p"
11091 #: ../src/guestfs-actions.pod:3922
11095 " guestfs_mkdir_p (guestfs_h *g,\n"
11096 " const char *path);\n"
11101 #: ../src/guestfs-actions.pod:3926 ../fish/guestfish-actions.pod:2668
11103 "Create a directory named C<path>, creating any parent directories as "
11104 "necessary. This is like the C<mkdir -p> shell command."
11108 #: ../src/guestfs-actions.pod:3933
11109 msgid "guestfs_mkdtemp"
11113 #: ../src/guestfs-actions.pod:3935
11117 " guestfs_mkdtemp (guestfs_h *g,\n"
11118 " const char *template);\n"
11123 #: ../src/guestfs-actions.pod:3939 ../fish/guestfish-actions.pod:2675
11125 "This command creates a temporary directory. The C<template> parameter "
11126 "should be a full pathname for the temporary directory name with the final "
11127 "six characters being \"XXXXXX\"."
11131 #: ../src/guestfs-actions.pod:3944 ../fish/guestfish-actions.pod:2680
11133 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
11134 "being suitable for Windows filesystems."
11138 #: ../src/guestfs-actions.pod:3947 ../fish/guestfish-actions.pod:2683
11139 msgid "The name of the temporary directory that was created is returned."
11143 #: ../src/guestfs-actions.pod:3950 ../fish/guestfish-actions.pod:2686
11144 msgid "The temporary directory is created with mode 0700 and is owned by root."
11148 #: ../src/guestfs-actions.pod:3953 ../fish/guestfish-actions.pod:2689
11150 "The caller is responsible for deleting the temporary directory and its "
11151 "contents after use."
11155 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2692
11156 msgid "See also: L<mkdtemp(3)>"
11160 #: ../src/guestfs-actions.pod:3963
11161 msgid "guestfs_mke2fs_J"
11165 #: ../src/guestfs-actions.pod:3965
11169 " guestfs_mke2fs_J (guestfs_h *g,\n"
11170 " const char *fstype,\n"
11171 " int blocksize,\n"
11172 " const char *device,\n"
11173 " const char *journal);\n"
11178 #: ../src/guestfs-actions.pod:3972 ../fish/guestfish-actions.pod:2698
11180 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11181 "C<journal>. It is equivalent to the command:"
11185 #: ../src/guestfs-actions.pod:3976 ../fish/guestfish-actions.pod:2702
11188 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
11193 #: ../src/guestfs-actions.pod:3978
11194 msgid "See also C<guestfs_mke2journal>."
11198 #: ../src/guestfs-actions.pod:3982 ../src/guestfs-actions.pod:4000
11199 #: ../src/guestfs-actions.pod:4018 ../src/guestfs-actions.pod:4034
11200 #: ../src/guestfs-actions.pod:4048 ../src/guestfs-actions.pod:4062
11201 #: ../src/guestfs-actions.pod:4114 ../src/guestfs-actions.pod:4304
11202 msgid "(Added in 1.0.68)"
11206 #: ../src/guestfs-actions.pod:3984
11207 msgid "guestfs_mke2fs_JL"
11211 #: ../src/guestfs-actions.pod:3986
11215 " guestfs_mke2fs_JL (guestfs_h *g,\n"
11216 " const char *fstype,\n"
11217 " int blocksize,\n"
11218 " const char *device,\n"
11219 " const char *label);\n"
11224 #: ../src/guestfs-actions.pod:3993 ../fish/guestfish-actions.pod:2710
11226 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11227 "the journal labeled C<label>."
11231 #: ../src/guestfs-actions.pod:3996
11232 msgid "See also C<guestfs_mke2journal_L>."
11236 #: ../src/guestfs-actions.pod:4002
11237 msgid "guestfs_mke2fs_JU"
11241 #: ../src/guestfs-actions.pod:4004
11245 " guestfs_mke2fs_JU (guestfs_h *g,\n"
11246 " const char *fstype,\n"
11247 " int blocksize,\n"
11248 " const char *device,\n"
11249 " const char *uuid);\n"
11254 #: ../src/guestfs-actions.pod:4011 ../fish/guestfish-actions.pod:2719
11256 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11257 "the journal with UUID C<uuid>."
11261 #: ../src/guestfs-actions.pod:4014
11262 msgid "See also C<guestfs_mke2journal_U>."
11266 #: ../src/guestfs-actions.pod:4020
11267 msgid "guestfs_mke2journal"
11271 #: ../src/guestfs-actions.pod:4022
11275 " guestfs_mke2journal (guestfs_h *g,\n"
11276 " int blocksize,\n"
11277 " const char *device);\n"
11282 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2728
11284 "This creates an ext2 external journal on C<device>. It is equivalent to the "
11289 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:2731
11292 " mke2fs -O journal_dev -b blocksize device\n"
11297 #: ../src/guestfs-actions.pod:4036
11298 msgid "guestfs_mke2journal_L"
11302 #: ../src/guestfs-actions.pod:4038
11306 " guestfs_mke2journal_L (guestfs_h *g,\n"
11307 " int blocksize,\n"
11308 " const char *label,\n"
11309 " const char *device);\n"
11314 #: ../src/guestfs-actions.pod:4044 ../fish/guestfish-actions.pod:2737
11315 msgid "This creates an ext2 external journal on C<device> with label C<label>."
11319 #: ../src/guestfs-actions.pod:4050
11320 msgid "guestfs_mke2journal_U"
11324 #: ../src/guestfs-actions.pod:4052
11328 " guestfs_mke2journal_U (guestfs_h *g,\n"
11329 " int blocksize,\n"
11330 " const char *uuid,\n"
11331 " const char *device);\n"
11336 #: ../src/guestfs-actions.pod:4058 ../fish/guestfish-actions.pod:2743
11337 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
11341 #: ../src/guestfs-actions.pod:4064
11342 msgid "guestfs_mkfifo"
11346 #: ../src/guestfs-actions.pod:4066
11350 " guestfs_mkfifo (guestfs_h *g,\n"
11352 " const char *path);\n"
11357 #: ../src/guestfs-actions.pod:4071
11359 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
11360 "is just a convenient wrapper around C<guestfs_mknod>."
11364 #: ../src/guestfs-actions.pod:4081
11365 msgid "guestfs_mkfs"
11369 #: ../src/guestfs-actions.pod:4083
11373 " guestfs_mkfs (guestfs_h *g,\n"
11374 " const char *fstype,\n"
11375 " const char *device);\n"
11380 #: ../src/guestfs-actions.pod:4088 ../fish/guestfish-actions.pod:2759
11382 "This creates a filesystem on C<device> (usually a partition or LVM logical "
11383 "volume). The filesystem type is C<fstype>, for example C<ext3>."
11387 #: ../src/guestfs-actions.pod:4096
11388 msgid "guestfs_mkfs_b"
11392 #: ../src/guestfs-actions.pod:4098
11396 " guestfs_mkfs_b (guestfs_h *g,\n"
11397 " const char *fstype,\n"
11398 " int blocksize,\n"
11399 " const char *device);\n"
11404 #: ../src/guestfs-actions.pod:4104
11406 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
11407 "block size of the resulting filesystem. Supported block sizes depend on the "
11408 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
11412 #: ../src/guestfs-actions.pod:4109 ../fish/guestfish-actions.pod:2772
11414 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
11419 #: ../src/guestfs-actions.pod:4116
11420 msgid "guestfs_mkmountpoint"
11424 #: ../src/guestfs-actions.pod:4118
11428 " guestfs_mkmountpoint (guestfs_h *g,\n"
11429 " const char *exemptpath);\n"
11434 #: ../src/guestfs-actions.pod:4122
11436 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
11437 "that can be used to create extra mountpoints before mounting the first "
11442 #: ../src/guestfs-actions.pod:4126 ../fish/guestfish-actions.pod:2783
11444 "These calls are I<only> necessary in some very limited circumstances, mainly "
11445 "the case where you want to mount a mix of unrelated and/or read-only "
11446 "filesystems together."
11450 #: ../src/guestfs-actions.pod:4130 ../fish/guestfish-actions.pod:2787
11452 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
11453 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
11454 "inside that. You can unpack this as follows in guestfish:"
11458 #: ../src/guestfs-actions.pod:4135 ../fish/guestfish-actions.pod:2792
11461 " add-ro Fedora-11-i686-Live.iso\n"
11463 " mkmountpoint /cd\n"
11464 " mkmountpoint /sqsh\n"
11465 " mkmountpoint /ext3fs\n"
11466 " mount /dev/sda /cd\n"
11467 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
11468 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
11473 #: ../src/guestfs-actions.pod:4144 ../fish/guestfish-actions.pod:2801
11474 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
11478 #: ../src/guestfs-actions.pod:4146
11480 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
11481 "may get unexpected errors if you try to mix these calls. It is safest to "
11482 "manually unmount filesystems and remove mountpoints after use."
11486 #: ../src/guestfs-actions.pod:4150
11488 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
11489 "first, so for this to work for manual mountpoints, you must ensure that the "
11490 "innermost mountpoints have the longest pathnames, as in the example code "
11495 #: ../src/guestfs-actions.pod:4155 ../fish/guestfish-actions.pod:2812
11497 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
11501 #: ../src/guestfs-actions.pod:4157
11503 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
11504 "means that C<guestfs_umount_all> is called when the handle is closed which "
11505 "can also trigger these issues."
11509 #: ../src/guestfs-actions.pod:4163 ../src/guestfs-actions.pod:4422
11510 #: ../src/guestfs-actions.pod:5315
11511 msgid "(Added in 1.0.62)"
11515 #: ../src/guestfs-actions.pod:4165
11516 msgid "guestfs_mknod"
11520 #: ../src/guestfs-actions.pod:4167
11524 " guestfs_mknod (guestfs_h *g,\n"
11528 " const char *path);\n"
11533 #: ../src/guestfs-actions.pod:4174 ../fish/guestfish-actions.pod:2822
11535 "This call creates block or character special devices, or named pipes (FIFOs)."
11539 #: ../src/guestfs-actions.pod:4177 ../fish/guestfish-actions.pod:2825
11541 "The C<mode> parameter should be the mode, using the standard constants. "
11542 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
11543 "used when creating block and character special devices."
11547 #: ../src/guestfs-actions.pod:4182
11549 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
11550 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
11551 "regular file). These constants are available in the standard Linux header "
11552 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
11553 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
11554 "the appropriate constant for you."
11558 #: ../src/guestfs-actions.pod:4196
11559 msgid "guestfs_mknod_b"
11563 #: ../src/guestfs-actions.pod:4198
11567 " guestfs_mknod_b (guestfs_h *g,\n"
11571 " const char *path);\n"
11576 #: ../src/guestfs-actions.pod:4205
11578 "This call creates a block device node called C<path> with mode C<mode> and "
11579 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11580 "wrapper around C<guestfs_mknod>."
11584 #: ../src/guestfs-actions.pod:4215
11585 msgid "guestfs_mknod_c"
11589 #: ../src/guestfs-actions.pod:4217
11593 " guestfs_mknod_c (guestfs_h *g,\n"
11597 " const char *path);\n"
11602 #: ../src/guestfs-actions.pod:4224
11604 "This call creates a char device node called C<path> with mode C<mode> and "
11605 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11606 "wrapper around C<guestfs_mknod>."
11610 #: ../src/guestfs-actions.pod:4234
11611 msgid "guestfs_mkswap"
11615 #: ../src/guestfs-actions.pod:4236
11619 " guestfs_mkswap (guestfs_h *g,\n"
11620 " const char *device);\n"
11625 #: ../src/guestfs-actions.pod:4240 ../fish/guestfish-actions.pod:2864
11626 msgid "Create a swap partition on C<device>."
11630 #: ../src/guestfs-actions.pod:4246
11631 msgid "guestfs_mkswap_L"
11635 #: ../src/guestfs-actions.pod:4248
11639 " guestfs_mkswap_L (guestfs_h *g,\n"
11640 " const char *label,\n"
11641 " const char *device);\n"
11646 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2870
11647 msgid "Create a swap partition on C<device> with label C<label>."
11651 #: ../src/guestfs-actions.pod:4255 ../fish/guestfish-actions.pod:2872
11653 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
11654 "sda>), just to a partition. This appears to be a limitation of the kernel "
11659 #: ../src/guestfs-actions.pod:4263
11660 msgid "guestfs_mkswap_U"
11664 #: ../src/guestfs-actions.pod:4265
11668 " guestfs_mkswap_U (guestfs_h *g,\n"
11669 " const char *uuid,\n"
11670 " const char *device);\n"
11675 #: ../src/guestfs-actions.pod:4270 ../fish/guestfish-actions.pod:2880
11676 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11680 #: ../src/guestfs-actions.pod:4276
11681 msgid "guestfs_mkswap_file"
11685 #: ../src/guestfs-actions.pod:4278
11689 " guestfs_mkswap_file (guestfs_h *g,\n"
11690 " const char *path);\n"
11695 #: ../src/guestfs-actions.pod:4282 ../fish/guestfish-actions.pod:2886
11696 msgid "Create a swap file."
11700 #: ../src/guestfs-actions.pod:4284
11702 "This command just writes a swap file signature to an existing file. To "
11703 "create the file itself, use something like C<guestfs_fallocate>."
11707 #: ../src/guestfs-actions.pod:4291
11708 msgid "guestfs_modprobe"
11712 #: ../src/guestfs-actions.pod:4293
11716 " guestfs_modprobe (guestfs_h *g,\n"
11717 " const char *modulename);\n"
11722 #: ../src/guestfs-actions.pod:4297 ../fish/guestfish-actions.pod:2895
11723 msgid "This loads a kernel module in the appliance."
11727 #: ../src/guestfs-actions.pod:4299 ../fish/guestfish-actions.pod:2897
11729 "The kernel module must have been whitelisted when libguestfs was built (see "
11730 "C<appliance/kmod.whitelist.in> in the source)."
11734 #: ../src/guestfs-actions.pod:4306
11735 msgid "guestfs_mount"
11739 #: ../src/guestfs-actions.pod:4308
11743 " guestfs_mount (guestfs_h *g,\n"
11744 " const char *device,\n"
11745 " const char *mountpoint);\n"
11750 #: ../src/guestfs-actions.pod:4313 ../fish/guestfish-actions.pod:2904
11752 "Mount a guest disk at a position in the filesystem. Block devices are named "
11753 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11754 "those block devices contain partitions, they will have the usual names (eg. "
11755 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11759 #: ../src/guestfs-actions.pod:4319 ../fish/guestfish-actions.pod:2910
11761 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11762 "mounted on C</> before others can be mounted. Other filesystems can only be "
11763 "mounted on directories which already exist."
11767 #: ../src/guestfs-actions.pod:4324 ../fish/guestfish-actions.pod:2915
11769 "The mounted filesystem is writable, if we have sufficient permissions on the "
11770 "underlying device."
11774 #: ../src/guestfs-actions.pod:4327
11776 "B<Important note:> When you use this call, the filesystem options C<sync> "
11777 "and C<noatime> are set implicitly. This was originally done because we "
11778 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11779 "very large negative performance impact and negligible effect on "
11780 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
11781 "in any code that needs performance, and instead use C<guestfs_mount_options> "
11782 "(use an empty string for the first parameter if you don't want any options)."
11786 #: ../src/guestfs-actions.pod:4341
11787 msgid "guestfs_mount_loop"
11791 #: ../src/guestfs-actions.pod:4343
11795 " guestfs_mount_loop (guestfs_h *g,\n"
11796 " const char *file,\n"
11797 " const char *mountpoint);\n"
11802 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2932
11804 "This command lets you mount C<file> (a filesystem image in a file) on a "
11805 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11810 #: ../src/guestfs-actions.pod:4356
11811 msgid "guestfs_mount_options"
11815 #: ../src/guestfs-actions.pod:4358
11819 " guestfs_mount_options (guestfs_h *g,\n"
11820 " const char *options,\n"
11821 " const char *device,\n"
11822 " const char *mountpoint);\n"
11827 #: ../src/guestfs-actions.pod:4364
11829 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11830 "the mount options as for the L<mount(8)> I<-o> flag."
11834 #: ../src/guestfs-actions.pod:4368 ../fish/guestfish-actions.pod:2944
11836 "If the C<options> parameter is an empty string, then no options are passed "
11837 "(all options default to whatever the filesystem uses)."
11841 #: ../src/guestfs-actions.pod:4374 ../src/guestfs-actions.pod:4388
11842 #: ../src/guestfs-actions.pod:4405
11843 msgid "(Added in 1.0.10)"
11847 #: ../src/guestfs-actions.pod:4376
11848 msgid "guestfs_mount_ro"
11852 #: ../src/guestfs-actions.pod:4378
11856 " guestfs_mount_ro (guestfs_h *g,\n"
11857 " const char *device,\n"
11858 " const char *mountpoint);\n"
11863 #: ../src/guestfs-actions.pod:4383
11865 "This is the same as the C<guestfs_mount> command, but it mounts the "
11866 "filesystem with the read-only (I<-o ro>) flag."
11870 #: ../src/guestfs-actions.pod:4390
11871 msgid "guestfs_mount_vfs"
11875 #: ../src/guestfs-actions.pod:4392
11879 " guestfs_mount_vfs (guestfs_h *g,\n"
11880 " const char *options,\n"
11881 " const char *vfstype,\n"
11882 " const char *device,\n"
11883 " const char *mountpoint);\n"
11888 #: ../src/guestfs-actions.pod:4399
11890 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11891 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
11896 #: ../src/guestfs-actions.pod:4407
11897 msgid "guestfs_mountpoints"
11901 #: ../src/guestfs-actions.pod:4409
11905 " guestfs_mountpoints (guestfs_h *g);\n"
11910 #: ../src/guestfs-actions.pod:4412
11912 "This call is similar to C<guestfs_mounts>. That call returns a list of "
11913 "devices. This one returns a hash table (map) of device name to directory "
11914 "where the device is mounted."
11918 #: ../src/guestfs-actions.pod:4424
11919 msgid "guestfs_mounts"
11923 #: ../src/guestfs-actions.pod:4426
11927 " guestfs_mounts (guestfs_h *g);\n"
11932 #: ../src/guestfs-actions.pod:4429 ../fish/guestfish-actions.pod:2975
11934 "This returns the list of currently mounted filesystems. It returns the list "
11935 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11939 #: ../src/guestfs-actions.pod:4432 ../fish/guestfish-actions.pod:2978
11940 msgid "Some internal mounts are not shown."
11944 #: ../src/guestfs-actions.pod:4434
11945 msgid "See also: C<guestfs_mountpoints>"
11949 #: ../src/guestfs-actions.pod:4442
11954 #: ../src/guestfs-actions.pod:4444
11958 " guestfs_mv (guestfs_h *g,\n"
11959 " const char *src,\n"
11960 " const char *dest);\n"
11965 #: ../src/guestfs-actions.pod:4449 ../fish/guestfish-actions.pod:2986
11967 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11968 "destination filename or destination directory."
11972 #: ../src/guestfs-actions.pod:4456
11973 msgid "guestfs_ntfs_3g_probe"
11977 #: ../src/guestfs-actions.pod:4458
11981 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
11983 " const char *device);\n"
11988 #: ../src/guestfs-actions.pod:4463 ../fish/guestfish-actions.pod:2993
11990 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11991 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
11992 "write, and some cannot be mounted at all)."
11996 #: ../src/guestfs-actions.pod:4467 ../fish/guestfish-actions.pod:2997
11998 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11999 "can be mounted read-write. Set it to false if you want to test if the "
12000 "volume can be mounted read-only."
12004 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3001
12006 "The return value is an integer which C<0> if the operation would succeed, or "
12007 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
12011 #: ../src/guestfs-actions.pod:4477
12012 msgid "(Added in 1.0.43)"
12016 #: ../src/guestfs-actions.pod:4479
12017 msgid "guestfs_ntfsresize"
12021 #: ../src/guestfs-actions.pod:4481
12025 " guestfs_ntfsresize (guestfs_h *g,\n"
12026 " const char *device);\n"
12031 #: ../src/guestfs-actions.pod:4485 ../fish/guestfish-actions.pod:3009
12033 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
12034 "size of the underlying device. See also L<ntfsresize(8)>."
12038 #: ../src/guestfs-actions.pod:4493
12039 msgid "guestfs_ntfsresize_size"
12043 #: ../src/guestfs-actions.pod:4495
12047 " guestfs_ntfsresize_size (guestfs_h *g,\n"
12048 " const char *device,\n"
12049 " int64_t size);\n"
12054 #: ../src/guestfs-actions.pod:4500
12056 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
12057 "to specify the new size (in bytes) explicitly."
12061 #: ../src/guestfs-actions.pod:4505 ../src/guestfs-actions.pod:4941
12062 #: ../src/guestfs-actions.pod:5014 ../src/guestfs-actions.pod:5263
12063 msgid "(Added in 1.3.14)"
12067 #: ../src/guestfs-actions.pod:4507
12068 msgid "guestfs_part_add"
12072 #: ../src/guestfs-actions.pod:4509
12076 " guestfs_part_add (guestfs_h *g,\n"
12077 " const char *device,\n"
12078 " const char *prlogex,\n"
12079 " int64_t startsect,\n"
12080 " int64_t endsect);\n"
12085 #: ../src/guestfs-actions.pod:4516
12087 "This command adds a partition to C<device>. If there is no partition table "
12088 "on the device, call C<guestfs_part_init> first."
12092 #: ../src/guestfs-actions.pod:4519 ../fish/guestfish-actions.pod:3027
12094 "The C<prlogex> parameter is the type of partition. Normally you should pass "
12095 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
12096 "C<logical>) and C<e> (or C<extended>) partition types."
12100 #: ../src/guestfs-actions.pod:4524 ../fish/guestfish-actions.pod:3032
12102 "C<startsect> and C<endsect> are the start and end of the partition in "
12103 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
12104 "from the end of the disk (C<-1> is the last sector)."
12108 #: ../src/guestfs-actions.pod:4528
12110 "Creating a partition which covers the whole disk is not so easy. Use "
12111 "C<guestfs_part_disk> to do that."
12115 #: ../src/guestfs-actions.pod:4533 ../src/guestfs-actions.pod:4571
12116 #: ../src/guestfs-actions.pod:4624 ../src/guestfs-actions.pod:4702
12117 #: ../src/guestfs-actions.pod:4740 ../src/guestfs-actions.pod:4759
12118 #: ../src/guestfs-actions.pod:4799
12119 msgid "(Added in 1.0.78)"
12123 #: ../src/guestfs-actions.pod:4535
12124 msgid "guestfs_part_del"
12128 #: ../src/guestfs-actions.pod:4537
12132 " guestfs_part_del (guestfs_h *g,\n"
12133 " const char *device,\n"
12139 #: ../src/guestfs-actions.pod:4542 ../fish/guestfish-actions.pod:3043
12140 msgid "This command deletes the partition numbered C<partnum> on C<device>."
12144 #: ../src/guestfs-actions.pod:4544 ../fish/guestfish-actions.pod:3045
12146 "Note that in the case of MBR partitioning, deleting an extended partition "
12147 "also deletes any logical partitions it contains."
12151 #: ../src/guestfs-actions.pod:4552
12152 msgid "guestfs_part_disk"
12156 #: ../src/guestfs-actions.pod:4554
12160 " guestfs_part_disk (guestfs_h *g,\n"
12161 " const char *device,\n"
12162 " const char *parttype);\n"
12167 #: ../src/guestfs-actions.pod:4559
12169 "This command is simply a combination of C<guestfs_part_init> followed by "
12170 "C<guestfs_part_add> to create a single primary partition covering the whole "
12175 #: ../src/guestfs-actions.pod:4563
12177 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
12178 "possible values are described in C<guestfs_part_init>."
12182 #: ../src/guestfs-actions.pod:4573
12183 msgid "guestfs_part_get_bootable"
12187 #: ../src/guestfs-actions.pod:4575
12191 " guestfs_part_get_bootable (guestfs_h *g,\n"
12192 " const char *device,\n"
12198 #: ../src/guestfs-actions.pod:4580 ../fish/guestfish-actions.pod:3067
12200 "This command returns true if the partition C<partnum> on C<device> has the "
12201 "bootable flag set."
12205 #: ../src/guestfs-actions.pod:4583
12206 msgid "See also C<guestfs_part_set_bootable>."
12210 #: ../src/guestfs-actions.pod:4589
12211 msgid "guestfs_part_get_mbr_id"
12215 #: ../src/guestfs-actions.pod:4591
12219 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
12220 " const char *device,\n"
12226 #: ../src/guestfs-actions.pod:4596 ../fish/guestfish-actions.pod:3076
12228 "Returns the MBR type byte (also known as the ID byte) from the numbered "
12229 "partition C<partnum>."
12233 #: ../src/guestfs-actions.pod:4599 ../src/guestfs-actions.pod:4775
12235 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
12236 "undefined results for other partition table types (see "
12237 "C<guestfs_part_get_parttype>)."
12241 #: ../src/guestfs-actions.pod:4607
12242 msgid "guestfs_part_get_parttype"
12246 #: ../src/guestfs-actions.pod:4609
12250 " guestfs_part_get_parttype (guestfs_h *g,\n"
12251 " const char *device);\n"
12256 #: ../src/guestfs-actions.pod:4613 ../fish/guestfish-actions.pod:3087
12258 "This command examines the partition table on C<device> and returns the "
12259 "partition table type (format) being used."
12263 #: ../src/guestfs-actions.pod:4616
12265 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
12266 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
12267 "possible, although unusual. See C<guestfs_part_init> for a full list."
12271 #: ../src/guestfs-actions.pod:4626
12272 msgid "guestfs_part_init"
12276 #: ../src/guestfs-actions.pod:4628
12280 " guestfs_part_init (guestfs_h *g,\n"
12281 " const char *device,\n"
12282 " const char *parttype);\n"
12287 #: ../src/guestfs-actions.pod:4633 ../fish/guestfish-actions.pod:3099
12289 "This creates an empty partition table on C<device> of one of the partition "
12290 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
12291 "(for large disks)."
12295 #: ../src/guestfs-actions.pod:4637
12297 "Initially there are no partitions. Following this, you should call "
12298 "C<guestfs_part_add> for each partition required."
12302 #: ../src/guestfs-actions.pod:4640 ../fish/guestfish-actions.pod:3106
12303 msgid "Possible values for C<parttype> are:"
12307 #: ../src/guestfs-actions.pod:4644 ../fish/guestfish-actions.pod:3110
12308 msgid "B<efi> | B<gpt>"
12312 #: ../src/guestfs-actions.pod:4646 ../fish/guestfish-actions.pod:3112
12313 msgid "Intel EFI / GPT partition table."
12317 #: ../src/guestfs-actions.pod:4648 ../fish/guestfish-actions.pod:3114
12319 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
12320 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
12321 "the C<mbr> format."
12325 #: ../src/guestfs-actions.pod:4652 ../fish/guestfish-actions.pod:3118
12326 msgid "B<mbr> | B<msdos>"
12330 #: ../src/guestfs-actions.pod:4654 ../fish/guestfish-actions.pod:3120
12332 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
12333 "Windows. This partition type will B<only> work for device sizes up to 2 "
12334 "TB. For large disks we recommend using C<gpt>."
12338 #: ../src/guestfs-actions.pod:4661 ../fish/guestfish-actions.pod:3127
12340 "Other partition table types that may work but are not supported include:"
12344 #: ../src/guestfs-actions.pod:4666 ../fish/guestfish-actions.pod:3132
12349 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3134
12350 msgid "AIX disk labels."
12354 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3136
12355 msgid "B<amiga> | B<rdb>"
12359 #: ../src/guestfs-actions.pod:4672 ../fish/guestfish-actions.pod:3138
12360 msgid "Amiga \"Rigid Disk Block\" format."
12364 #: ../src/guestfs-actions.pod:4674 ../fish/guestfish-actions.pod:3140
12369 #: ../src/guestfs-actions.pod:4676 ../fish/guestfish-actions.pod:3142
12370 msgid "BSD disk labels."
12374 #: ../src/guestfs-actions.pod:4678 ../fish/guestfish-actions.pod:3144
12379 #: ../src/guestfs-actions.pod:4680 ../fish/guestfish-actions.pod:3146
12380 msgid "DASD, used on IBM mainframes."
12384 #: ../src/guestfs-actions.pod:4682 ../fish/guestfish-actions.pod:3148
12389 #: ../src/guestfs-actions.pod:4684 ../fish/guestfish-actions.pod:3150
12390 msgid "MIPS/SGI volumes."
12394 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3152
12399 #: ../src/guestfs-actions.pod:4688 ../fish/guestfish-actions.pod:3154
12400 msgid "Old Mac partition format. Modern Macs use C<gpt>."
12404 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3156
12409 #: ../src/guestfs-actions.pod:4692 ../fish/guestfish-actions.pod:3158
12410 msgid "NEC PC-98 format, common in Japan apparently."
12414 #: ../src/guestfs-actions.pod:4694 ../fish/guestfish-actions.pod:3160
12419 #: ../src/guestfs-actions.pod:4696 ../fish/guestfish-actions.pod:3162
12420 msgid "Sun disk labels."
12424 #: ../src/guestfs-actions.pod:4704
12425 msgid "guestfs_part_list"
12429 #: ../src/guestfs-actions.pod:4706
12432 " struct guestfs_partition_list *\n"
12433 " guestfs_part_list (guestfs_h *g,\n"
12434 " const char *device);\n"
12439 #: ../src/guestfs-actions.pod:4710 ../fish/guestfish-actions.pod:3170
12441 "This command parses the partition table on C<device> and returns the list of "
12442 "partitions found."
12446 #: ../src/guestfs-actions.pod:4713 ../fish/guestfish-actions.pod:3173
12447 msgid "The fields in the returned structure are:"
12451 #: ../src/guestfs-actions.pod:4717 ../fish/guestfish-actions.pod:3177
12452 msgid "B<part_num>"
12456 #: ../src/guestfs-actions.pod:4719 ../fish/guestfish-actions.pod:3179
12457 msgid "Partition number, counting from 1."
12461 #: ../src/guestfs-actions.pod:4721 ../fish/guestfish-actions.pod:3181
12462 msgid "B<part_start>"
12466 #: ../src/guestfs-actions.pod:4723
12468 "Start of the partition I<in bytes>. To get sectors you have to divide by "
12469 "the device's sector size, see C<guestfs_blockdev_getss>."
12473 #: ../src/guestfs-actions.pod:4726 ../fish/guestfish-actions.pod:3186
12474 msgid "B<part_end>"
12478 #: ../src/guestfs-actions.pod:4728 ../fish/guestfish-actions.pod:3188
12479 msgid "End of the partition in bytes."
12483 #: ../src/guestfs-actions.pod:4730 ../fish/guestfish-actions.pod:3190
12484 msgid "B<part_size>"
12488 #: ../src/guestfs-actions.pod:4732 ../fish/guestfish-actions.pod:3192
12489 msgid "Size of the partition in bytes."
12493 #: ../src/guestfs-actions.pod:4736
12495 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
12496 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
12501 #: ../src/guestfs-actions.pod:4742
12502 msgid "guestfs_part_set_bootable"
12506 #: ../src/guestfs-actions.pod:4744
12510 " guestfs_part_set_bootable (guestfs_h *g,\n"
12511 " const char *device,\n"
12513 " int bootable);\n"
12518 #: ../src/guestfs-actions.pod:4750 ../fish/guestfish-actions.pod:3200
12520 "This sets the bootable flag on partition numbered C<partnum> on device "
12521 "C<device>. Note that partitions are numbered from 1."
12525 #: ../src/guestfs-actions.pod:4753 ../fish/guestfish-actions.pod:3203
12527 "The bootable flag is used by some operating systems (notably Windows) to "
12528 "determine which partition to boot from. It is by no means universally "
12533 #: ../src/guestfs-actions.pod:4761
12534 msgid "guestfs_part_set_mbr_id"
12538 #: ../src/guestfs-actions.pod:4763
12542 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
12543 " const char *device,\n"
12550 #: ../src/guestfs-actions.pod:4769 ../fish/guestfish-actions.pod:3211
12552 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
12553 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
12554 "documentation are in fact hexadecimal numbers, but usually documented "
12555 "without any leading \"0x\" which might be confusing."
12559 #: ../src/guestfs-actions.pod:4783
12560 msgid "guestfs_part_set_name"
12564 #: ../src/guestfs-actions.pod:4785
12568 " guestfs_part_set_name (guestfs_h *g,\n"
12569 " const char *device,\n"
12571 " const char *name);\n"
12576 #: ../src/guestfs-actions.pod:4791 ../fish/guestfish-actions.pod:3225
12578 "This sets the partition name on partition numbered C<partnum> on device "
12579 "C<device>. Note that partitions are numbered from 1."
12583 #: ../src/guestfs-actions.pod:4794 ../fish/guestfish-actions.pod:3228
12585 "The partition name can only be set on certain types of partition table. "
12586 "This works on C<gpt> but not on C<mbr> partitions."
12590 #: ../src/guestfs-actions.pod:4801
12591 msgid "guestfs_part_to_dev"
12595 #: ../src/guestfs-actions.pod:4803
12599 " guestfs_part_to_dev (guestfs_h *g,\n"
12600 " const char *partition);\n"
12605 #: ../src/guestfs-actions.pod:4807 ../fish/guestfish-actions.pod:3235
12607 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
12608 "partition number, returning the device name (eg. \"/dev/sdb\")."
12612 #: ../src/guestfs-actions.pod:4811
12614 "The named partition must exist, for example as a string returned from "
12615 "C<guestfs_list_partitions>."
12619 #: ../src/guestfs-actions.pod:4819
12620 msgid "guestfs_ping_daemon"
12624 #: ../src/guestfs-actions.pod:4821
12628 " guestfs_ping_daemon (guestfs_h *g);\n"
12633 #: ../src/guestfs-actions.pod:4824 ../fish/guestfish-actions.pod:3246
12635 "This is a test probe into the guestfs daemon running inside the qemu "
12636 "subprocess. Calling this function checks that the daemon responds to the "
12637 "ping message, without affecting the daemon or attached block device(s) in "
12642 #: ../src/guestfs-actions.pod:4833
12643 msgid "guestfs_pread"
12647 #: ../src/guestfs-actions.pod:4835
12651 " guestfs_pread (guestfs_h *g,\n"
12652 " const char *path,\n"
12654 " int64_t offset,\n"
12655 " size_t *size_r);\n"
12660 #: ../src/guestfs-actions.pod:4842 ../fish/guestfish-actions.pod:3255
12662 "This command lets you read part of a file. It reads C<count> bytes of the "
12663 "file, starting at C<offset>, from file C<path>."
12667 #: ../src/guestfs-actions.pod:4845 ../src/guestfs-actions.pod:4871
12668 #: ../fish/guestfish-actions.pod:3258 ../fish/guestfish-actions.pod:3273
12670 "This may read fewer bytes than requested. For further details see the "
12671 "L<pread(2)> system call."
12675 #: ../src/guestfs-actions.pod:4848
12676 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
12680 #: ../src/guestfs-actions.pod:4859
12681 msgid "guestfs_pread_device"
12685 #: ../src/guestfs-actions.pod:4861
12689 " guestfs_pread_device (guestfs_h *g,\n"
12690 " const char *device,\n"
12692 " int64_t offset,\n"
12693 " size_t *size_r);\n"
12698 #: ../src/guestfs-actions.pod:4868 ../fish/guestfish-actions.pod:3270
12700 "This command lets you read part of a file. It reads C<count> bytes of "
12701 "C<device>, starting at C<offset>."
12705 #: ../src/guestfs-actions.pod:4874
12706 msgid "See also C<guestfs_pread>."
12710 #: ../src/guestfs-actions.pod:4883
12711 msgid "(Added in 1.5.21)"
12715 #: ../src/guestfs-actions.pod:4885
12716 msgid "guestfs_pvcreate"
12720 #: ../src/guestfs-actions.pod:4887
12724 " guestfs_pvcreate (guestfs_h *g,\n"
12725 " const char *device);\n"
12730 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3285
12732 "This creates an LVM physical volume on the named C<device>, where C<device> "
12733 "should usually be a partition name such as C</dev/sda1>."
12737 #: ../src/guestfs-actions.pod:4899
12738 msgid "guestfs_pvremove"
12742 #: ../src/guestfs-actions.pod:4901
12746 " guestfs_pvremove (guestfs_h *g,\n"
12747 " const char *device);\n"
12752 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3293
12754 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12759 #: ../src/guestfs-actions.pod:4908 ../fish/guestfish-actions.pod:3296
12761 "The implementation uses the C<pvremove> command which refuses to wipe "
12762 "physical volumes that contain any volume groups, so you have to remove those "
12767 #: ../src/guestfs-actions.pod:4916
12768 msgid "guestfs_pvresize"
12772 #: ../src/guestfs-actions.pod:4918
12776 " guestfs_pvresize (guestfs_h *g,\n"
12777 " const char *device);\n"
12782 #: ../src/guestfs-actions.pod:4922 ../fish/guestfish-actions.pod:3304
12784 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12785 "the new size of the underlying device."
12789 #: ../src/guestfs-actions.pod:4929
12790 msgid "guestfs_pvresize_size"
12794 #: ../src/guestfs-actions.pod:4931
12798 " guestfs_pvresize_size (guestfs_h *g,\n"
12799 " const char *device,\n"
12800 " int64_t size);\n"
12805 #: ../src/guestfs-actions.pod:4936
12807 "This command is the same as C<guestfs_pvresize> except that it allows you to "
12808 "specify the new size (in bytes) explicitly."
12812 #: ../src/guestfs-actions.pod:4943
12813 msgid "guestfs_pvs"
12817 #: ../src/guestfs-actions.pod:4945
12821 " guestfs_pvs (guestfs_h *g);\n"
12826 #: ../src/guestfs-actions.pod:4948 ../fish/guestfish-actions.pod:3318
12828 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12833 #: ../src/guestfs-actions.pod:4951 ../fish/guestfish-actions.pod:3321
12835 "This returns a list of just the device names that contain PVs (eg. C</dev/"
12840 #: ../src/guestfs-actions.pod:4954
12841 msgid "See also C<guestfs_pvs_full>."
12845 #: ../src/guestfs-actions.pod:4962
12846 msgid "guestfs_pvs_full"
12850 #: ../src/guestfs-actions.pod:4964
12853 " struct guestfs_lvm_pv_list *\n"
12854 " guestfs_pvs_full (guestfs_h *g);\n"
12859 #: ../src/guestfs-actions.pod:4967 ../fish/guestfish-actions.pod:3330
12861 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12862 "(8)> command. The \"full\" version includes all fields."
12866 #: ../src/guestfs-actions.pod:4970
12868 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
12869 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
12873 #: ../src/guestfs-actions.pod:4976
12874 msgid "guestfs_pvuuid"
12878 #: ../src/guestfs-actions.pod:4978
12882 " guestfs_pvuuid (guestfs_h *g,\n"
12883 " const char *device);\n"
12888 #: ../src/guestfs-actions.pod:4982 ../fish/guestfish-actions.pod:3337
12889 msgid "This command returns the UUID of the LVM PV C<device>."
12893 #: ../src/guestfs-actions.pod:4989
12894 msgid "guestfs_pwrite"
12898 #: ../src/guestfs-actions.pod:4991
12902 " guestfs_pwrite (guestfs_h *g,\n"
12903 " const char *path,\n"
12904 " const char *content,\n"
12905 " size_t content_size,\n"
12906 " int64_t offset);\n"
12911 #: ../src/guestfs-actions.pod:4998 ../fish/guestfish-actions.pod:3343
12913 "This command writes to part of a file. It writes the data buffer C<content> "
12914 "to the file C<path> starting at offset C<offset>."
12918 #: ../src/guestfs-actions.pod:5001 ../fish/guestfish-actions.pod:3346
12920 "This command implements the L<pwrite(2)> system call, and like that system "
12921 "call it may not write the full data requested. The return value is the "
12922 "number of bytes that were actually written to the file. This could even be "
12923 "0, although short writes are unlikely for regular files in ordinary "
12928 #: ../src/guestfs-actions.pod:5007
12929 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
12933 #: ../src/guestfs-actions.pod:5016
12934 msgid "guestfs_pwrite_device"
12938 #: ../src/guestfs-actions.pod:5018
12942 " guestfs_pwrite_device (guestfs_h *g,\n"
12943 " const char *device,\n"
12944 " const char *content,\n"
12945 " size_t content_size,\n"
12946 " int64_t offset);\n"
12951 #: ../src/guestfs-actions.pod:5025 ../fish/guestfish-actions.pod:3361
12953 "This command writes to part of a device. It writes the data buffer "
12954 "C<content> to C<device> starting at offset C<offset>."
12958 #: ../src/guestfs-actions.pod:5028 ../fish/guestfish-actions.pod:3364
12960 "This command implements the L<pwrite(2)> system call, and like that system "
12961 "call it may not write the full data requested (although short writes to disk "
12962 "devices and partitions are probably impossible with standard Linux kernels)."
12966 #: ../src/guestfs-actions.pod:5033
12967 msgid "See also C<guestfs_pwrite>."
12971 #: ../src/guestfs-actions.pod:5040
12972 msgid "(Added in 1.5.20)"
12976 #: ../src/guestfs-actions.pod:5042
12977 msgid "guestfs_read_file"
12981 #: ../src/guestfs-actions.pod:5044
12985 " guestfs_read_file (guestfs_h *g,\n"
12986 " const char *path,\n"
12987 " size_t *size_r);\n"
12992 #: ../src/guestfs-actions.pod:5049 ../fish/guestfish-actions.pod:3378
12993 msgid "This calls returns the contents of the file C<path> as a buffer."
12997 #: ../src/guestfs-actions.pod:5052
12999 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
13000 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
13001 "function is limited in the total size of file that can be handled."
13005 #: ../src/guestfs-actions.pod:5064
13006 msgid "(Added in 1.0.63)"
13010 #: ../src/guestfs-actions.pod:5066
13011 msgid "guestfs_read_lines"
13015 #: ../src/guestfs-actions.pod:5068
13019 " guestfs_read_lines (guestfs_h *g,\n"
13020 " const char *path);\n"
13025 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3395
13027 "The file contents are returned as a list of lines. Trailing C<LF> and "
13028 "C<CRLF> character sequences are I<not> returned."
13032 #: ../src/guestfs-actions.pod:5077
13034 "Note that this function cannot correctly handle binary files (specifically, "
13035 "files containing C<\\0> character which is treated as end of line). For "
13036 "those you need to use the C<guestfs_read_file> function which has a more "
13037 "complex interface."
13041 #: ../src/guestfs-actions.pod:5088
13042 msgid "guestfs_readdir"
13046 #: ../src/guestfs-actions.pod:5090
13049 " struct guestfs_dirent_list *\n"
13050 " guestfs_readdir (guestfs_h *g,\n"
13051 " const char *dir);\n"
13056 #: ../src/guestfs-actions.pod:5094 ../fish/guestfish-actions.pod:3407
13057 msgid "This returns the list of directory entries in directory C<dir>."
13061 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3409
13063 "All entries in the directory are returned, including C<.> and C<..>. The "
13064 "entries are I<not> sorted, but returned in the same order as the underlying "
13069 #: ../src/guestfs-actions.pod:5100 ../fish/guestfish-actions.pod:3413
13071 "Also this call returns basic file type information about each file. The "
13072 "C<ftyp> field will contain one of the following characters:"
13076 #: ../src/guestfs-actions.pod:5105 ../fish/guestfish-actions.pod:3418
13081 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3420
13082 msgid "Block special"
13086 #: ../src/guestfs-actions.pod:5109 ../fish/guestfish-actions.pod:3422
13091 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3424
13092 msgid "Char special"
13096 #: ../src/guestfs-actions.pod:5113 ../fish/guestfish-actions.pod:3426
13101 #: ../src/guestfs-actions.pod:5115 ../fish/guestfish-actions.pod:3428
13106 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3430
13111 #: ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3432
13112 msgid "FIFO (named pipe)"
13116 #: ../src/guestfs-actions.pod:5121 ../fish/guestfish-actions.pod:3434
13121 #: ../src/guestfs-actions.pod:5123 ../fish/guestfish-actions.pod:3436
13122 msgid "Symbolic link"
13126 #: ../src/guestfs-actions.pod:5125 ../fish/guestfish-actions.pod:3438
13131 #: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3440
13132 msgid "Regular file"
13136 #: ../src/guestfs-actions.pod:5129 ../fish/guestfish-actions.pod:3442
13141 #: ../src/guestfs-actions.pod:5131 ../fish/guestfish-actions.pod:3444
13146 #: ../src/guestfs-actions.pod:5133 ../fish/guestfish-actions.pod:3446
13151 #: ../src/guestfs-actions.pod:5135 ../fish/guestfish-actions.pod:3448
13152 msgid "Unknown file type"
13156 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3450
13161 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3452
13163 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
13167 #: ../src/guestfs-actions.pod:5144
13169 "This function is primarily intended for use by programs. To get a simple "
13170 "list of names, use C<guestfs_ls>. To get a printable directory for human "
13171 "consumption, use C<guestfs_ll>."
13175 #: ../src/guestfs-actions.pod:5148
13177 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
13178 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
13182 #: ../src/guestfs-actions.pod:5154
13183 msgid "guestfs_readlink"
13187 #: ../src/guestfs-actions.pod:5156
13191 " guestfs_readlink (guestfs_h *g,\n"
13192 " const char *path);\n"
13197 #: ../src/guestfs-actions.pod:5160 ../fish/guestfish-actions.pod:3465
13198 msgid "This command reads the target of a symbolic link."
13202 #: ../src/guestfs-actions.pod:5167
13203 msgid "guestfs_readlinklist"
13207 #: ../src/guestfs-actions.pod:5169
13211 " guestfs_readlinklist (guestfs_h *g,\n"
13212 " const char *path,\n"
13213 " char *const *names);\n"
13218 #: ../src/guestfs-actions.pod:5174 ../fish/guestfish-actions.pod:3471
13220 "This call allows you to do a C<readlink> operation on multiple files, where "
13221 "all files are in the directory C<path>. C<names> is the list of files from "
13226 #: ../src/guestfs-actions.pod:5178 ../fish/guestfish-actions.pod:3475
13228 "On return you get a list of strings, with a one-to-one correspondence to the "
13229 "C<names> list. Each string is the value of the symbolic link."
13233 #: ../src/guestfs-actions.pod:5182 ../fish/guestfish-actions.pod:3479
13235 "If the C<readlink(2)> operation fails on any name, then the corresponding "
13236 "result string is the empty string C<\"\">. However the whole operation is "
13237 "completed even if there were C<readlink(2)> errors, and so you can call this "
13238 "function with names where you don't know if they are symbolic links already "
13239 "(albeit slightly less efficient)."
13243 #: ../src/guestfs-actions.pod:5189 ../fish/guestfish-actions.pod:3486
13245 "This call is intended for programs that want to efficiently list a directory "
13246 "contents without making many round-trips. Very long directory listings "
13247 "might cause the protocol message size to be exceeded, causing this call to "
13248 "fail. The caller must split up such requests into smaller groups of names."
13252 #: ../src/guestfs-actions.pod:5202
13253 msgid "guestfs_realpath"
13257 #: ../src/guestfs-actions.pod:5204
13261 " guestfs_realpath (guestfs_h *g,\n"
13262 " const char *path);\n"
13267 #: ../src/guestfs-actions.pod:5208 ../fish/guestfish-actions.pod:3497
13269 "Return the canonicalized absolute pathname of C<path>. The returned path "
13270 "has no C<.>, C<..> or symbolic link path elements."
13274 #: ../src/guestfs-actions.pod:5216
13275 msgid "guestfs_removexattr"
13279 #: ../src/guestfs-actions.pod:5218
13283 " guestfs_removexattr (guestfs_h *g,\n"
13284 " const char *xattr,\n"
13285 " const char *path);\n"
13290 #: ../src/guestfs-actions.pod:5223 ../fish/guestfish-actions.pod:3504
13292 "This call removes the extended attribute named C<xattr> of the file C<path>."
13296 #: ../src/guestfs-actions.pod:5226
13297 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
13301 #: ../src/guestfs-actions.pod:5232
13302 msgid "guestfs_resize2fs"
13306 #: ../src/guestfs-actions.pod:5234
13310 " guestfs_resize2fs (guestfs_h *g,\n"
13311 " const char *device);\n"
13316 #: ../src/guestfs-actions.pod:5238 ../fish/guestfish-actions.pod:3513
13318 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
13319 "underlying device."
13323 #: ../src/guestfs-actions.pod:5241
13325 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
13326 "C<device> before calling this command. For unknown reasons C<resize2fs> "
13327 "sometimes gives an error about this and sometimes not. In any case, it is "
13328 "always safe to call C<guestfs_e2fsck_f> before calling this function."
13332 #: ../src/guestfs-actions.pod:5251
13333 msgid "guestfs_resize2fs_size"
13337 #: ../src/guestfs-actions.pod:5253
13341 " guestfs_resize2fs_size (guestfs_h *g,\n"
13342 " const char *device,\n"
13343 " int64_t size);\n"
13348 #: ../src/guestfs-actions.pod:5258
13350 "This command is the same as C<guestfs_resize2fs> except that it allows you "
13351 "to specify the new size (in bytes) explicitly."
13355 #: ../src/guestfs-actions.pod:5265
13360 #: ../src/guestfs-actions.pod:5267
13364 " guestfs_rm (guestfs_h *g,\n"
13365 " const char *path);\n"
13370 #: ../src/guestfs-actions.pod:5271 ../fish/guestfish-actions.pod:3533
13371 msgid "Remove the single file C<path>."
13375 #: ../src/guestfs-actions.pod:5277
13376 msgid "guestfs_rm_rf"
13380 #: ../src/guestfs-actions.pod:5279
13384 " guestfs_rm_rf (guestfs_h *g,\n"
13385 " const char *path);\n"
13390 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3539
13392 "Remove the file or directory C<path>, recursively removing the contents if "
13393 "its a directory. This is like the C<rm -rf> shell command."
13397 #: ../src/guestfs-actions.pod:5291
13398 msgid "guestfs_rmdir"
13402 #: ../src/guestfs-actions.pod:5293
13406 " guestfs_rmdir (guestfs_h *g,\n"
13407 " const char *path);\n"
13412 #: ../src/guestfs-actions.pod:5297 ../fish/guestfish-actions.pod:3547
13413 msgid "Remove the single directory C<path>."
13417 #: ../src/guestfs-actions.pod:5303
13418 msgid "guestfs_rmmountpoint"
13422 #: ../src/guestfs-actions.pod:5305
13426 " guestfs_rmmountpoint (guestfs_h *g,\n"
13427 " const char *exemptpath);\n"
13432 #: ../src/guestfs-actions.pod:5309
13434 "This calls removes a mountpoint that was previously created with "
13435 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
13439 #: ../src/guestfs-actions.pod:5317
13440 msgid "guestfs_scrub_device"
13444 #: ../src/guestfs-actions.pod:5319
13448 " guestfs_scrub_device (guestfs_h *g,\n"
13449 " const char *device);\n"
13454 #: ../src/guestfs-actions.pod:5323 ../fish/guestfish-actions.pod:3561
13456 "This command writes patterns over C<device> to make data retrieval more "
13461 #: ../src/guestfs-actions.pod:5326 ../src/guestfs-actions.pod:5347
13462 #: ../src/guestfs-actions.pod:5366 ../fish/guestfish-actions.pod:3564
13463 #: ../fish/guestfish-actions.pod:3579 ../fish/guestfish-actions.pod:3592
13465 "It is an interface to the L<scrub(1)> program. See that manual page for "
13470 #: ../src/guestfs-actions.pod:5334 ../src/guestfs-actions.pod:5352
13471 #: ../src/guestfs-actions.pod:5371
13472 msgid "(Added in 1.0.52)"
13476 #: ../src/guestfs-actions.pod:5336
13477 msgid "guestfs_scrub_file"
13481 #: ../src/guestfs-actions.pod:5338
13485 " guestfs_scrub_file (guestfs_h *g,\n"
13486 " const char *file);\n"
13491 #: ../src/guestfs-actions.pod:5342 ../fish/guestfish-actions.pod:3574
13493 "This command writes patterns over a file to make data retrieval more "
13498 #: ../src/guestfs-actions.pod:5345 ../fish/guestfish-actions.pod:3577
13499 msgid "The file is I<removed> after scrubbing."
13503 #: ../src/guestfs-actions.pod:5354
13504 msgid "guestfs_scrub_freespace"
13508 #: ../src/guestfs-actions.pod:5356
13512 " guestfs_scrub_freespace (guestfs_h *g,\n"
13513 " const char *dir);\n"
13518 #: ../src/guestfs-actions.pod:5360
13520 "This command creates the directory C<dir> and then fills it with files until "
13521 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
13522 "and deletes them. The intention is to scrub any free space on the partition "
13523 "containing C<dir>."
13527 #: ../src/guestfs-actions.pod:5373
13528 msgid "guestfs_set_append"
13532 #: ../src/guestfs-actions.pod:5375
13536 " guestfs_set_append (guestfs_h *g,\n"
13537 " const char *append);\n"
13542 #: ../src/guestfs-actions.pod:5379 ../fish/guestfish-actions.pod:3601
13544 "This function is used to add additional options to the guest kernel command "
13549 #: ../src/guestfs-actions.pod:5382 ../fish/guestfish-actions.pod:3604
13551 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
13552 "environment variable."
13556 #: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3607
13558 "Setting C<append> to C<NULL> means I<no> additional options are passed "
13559 "(libguestfs always adds a few of its own)."
13563 #: ../src/guestfs-actions.pod:5392
13564 msgid "guestfs_set_autosync"
13568 #: ../src/guestfs-actions.pod:5394
13572 " guestfs_set_autosync (guestfs_h *g,\n"
13573 " int autosync);\n"
13578 #: ../src/guestfs-actions.pod:5398
13580 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
13581 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
13582 "the handle is closed (also if the program exits without closing handles)."
13586 #: ../src/guestfs-actions.pod:5403 ../fish/guestfish-actions.pod:3621
13588 "This is enabled by default (since libguestfs 1.5.24, previously it was "
13589 "disabled by default)."
13593 #: ../src/guestfs-actions.pod:5410
13594 msgid "guestfs_set_direct"
13598 #: ../src/guestfs-actions.pod:5412
13602 " guestfs_set_direct (guestfs_h *g,\n"
13608 #: ../src/guestfs-actions.pod:5416 ../fish/guestfish-actions.pod:3630
13610 "If the direct appliance mode flag is enabled, then stdin and stdout are "
13611 "passed directly through to the appliance once it is launched."
13615 #: ../src/guestfs-actions.pod:5420
13617 "One consequence of this is that log messages aren't caught by the library "
13618 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
13623 #: ../src/guestfs-actions.pod:5424 ../fish/guestfish-actions.pod:3638
13624 msgid "You probably don't want to use this unless you know what you are doing."
13628 #: ../src/guestfs-actions.pod:5427 ../fish/guestfish-actions.pod:3641
13629 msgid "The default is disabled."
13633 #: ../src/guestfs-actions.pod:5433
13634 msgid "guestfs_set_e2label"
13638 #: ../src/guestfs-actions.pod:5435
13642 " guestfs_set_e2label (guestfs_h *g,\n"
13643 " const char *device,\n"
13644 " const char *label);\n"
13649 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3647
13651 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
13652 "C<label>. Filesystem labels are limited to 16 characters."
13656 #: ../src/guestfs-actions.pod:5444
13658 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
13659 "the existing label on a filesystem."
13663 #: ../src/guestfs-actions.pod:5451
13664 msgid "guestfs_set_e2uuid"
13668 #: ../src/guestfs-actions.pod:5453
13672 " guestfs_set_e2uuid (guestfs_h *g,\n"
13673 " const char *device,\n"
13674 " const char *uuid);\n"
13679 #: ../src/guestfs-actions.pod:5458 ../fish/guestfish-actions.pod:3658
13681 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13682 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13683 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13687 #: ../src/guestfs-actions.pod:5463
13689 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
13690 "the existing UUID of a filesystem."
13694 #: ../src/guestfs-actions.pod:5470
13695 msgid "guestfs_set_memsize"
13699 #: ../src/guestfs-actions.pod:5472
13703 " guestfs_set_memsize (guestfs_h *g,\n"
13709 #: ../src/guestfs-actions.pod:5476
13711 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13712 "This only has any effect if called before C<guestfs_launch>."
13716 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:3676
13718 "You can also change this by setting the environment variable "
13719 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13723 #: ../src/guestfs-actions.pod:5491
13724 msgid "guestfs_set_network"
13728 #: ../src/guestfs-actions.pod:5493
13732 " guestfs_set_network (guestfs_h *g,\n"
13738 #: ../src/guestfs-actions.pod:5497 ../fish/guestfish-actions.pod:3689
13740 "If C<network> is true, then the network is enabled in the libguestfs "
13741 "appliance. The default is false."
13745 #: ../src/guestfs-actions.pod:5500 ../fish/guestfish-actions.pod:3692
13747 "This affects whether commands are able to access the network (see L<guestfs"
13748 "(3)/RUNNING COMMANDS>)."
13752 #: ../src/guestfs-actions.pod:5503
13754 "You must call this before calling C<guestfs_launch>, otherwise it has no "
13759 #: ../src/guestfs-actions.pod:5510
13760 msgid "guestfs_set_path"
13764 #: ../src/guestfs-actions.pod:5512
13768 " guestfs_set_path (guestfs_h *g,\n"
13769 " const char *searchpath);\n"
13774 #: ../src/guestfs-actions.pod:5516 ../fish/guestfish-actions.pod:3704
13775 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13779 #: ../src/guestfs-actions.pod:5518 ../fish/guestfish-actions.pod:3706
13781 "The default is C<$libdir/guestfs> unless overridden by setting "
13782 "C<LIBGUESTFS_PATH> environment variable."
13786 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3709
13787 msgid "Setting C<path> to C<NULL> restores the default path."
13791 #: ../src/guestfs-actions.pod:5527
13792 msgid "guestfs_set_qemu"
13796 #: ../src/guestfs-actions.pod:5529
13800 " guestfs_set_qemu (guestfs_h *g,\n"
13801 " const char *qemu);\n"
13806 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3717
13807 msgid "Set the qemu binary that we will use."
13811 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3719
13813 "The default is chosen when the library was compiled by the configure script."
13817 #: ../src/guestfs-actions.pod:5538 ../fish/guestfish-actions.pod:3722
13819 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13824 #: ../src/guestfs-actions.pod:5541 ../fish/guestfish-actions.pod:3725
13825 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13829 #: ../src/guestfs-actions.pod:5543 ../fish/guestfish-actions.pod:3727
13831 "Note that you should call this function as early as possible after creating "
13832 "the handle. This is because some pre-launch operations depend on testing "
13833 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13834 "don't retest features, and so you might see inconsistent results. Using the "
13835 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13836 "the qemu binary at the same time as the handle is created."
13840 #: ../src/guestfs-actions.pod:5555
13841 msgid "guestfs_set_recovery_proc"
13845 #: ../src/guestfs-actions.pod:5557
13849 " guestfs_set_recovery_proc (guestfs_h *g,\n"
13850 " int recoveryproc);\n"
13855 #: ../src/guestfs-actions.pod:5561
13857 "If this is called with the parameter C<false> then C<guestfs_launch> does "
13858 "not create a recovery process. The purpose of the recovery process is to "
13859 "stop runaway qemu processes in the case where the main program aborts "
13864 #: ../src/guestfs-actions.pod:5566
13866 "This only has any effect if called before C<guestfs_launch>, and the default "
13871 #: ../src/guestfs-actions.pod:5569 ../fish/guestfish-actions.pod:3749
13873 "About the only time when you would want to disable this is if the main "
13874 "process will fork itself into the background (\"daemonize\" itself). In "
13875 "this case the recovery process thinks that the main program has disappeared "
13876 "and so kills qemu, which is not very helpful."
13880 #: ../src/guestfs-actions.pod:5579
13881 msgid "guestfs_set_selinux"
13885 #: ../src/guestfs-actions.pod:5581
13889 " guestfs_set_selinux (guestfs_h *g,\n"
13895 #: ../src/guestfs-actions.pod:5585 ../fish/guestfish-actions.pod:3761
13897 "This sets the selinux flag that is passed to the appliance at boot time. "
13898 "The default is C<selinux=0> (disabled)."
13902 #: ../src/guestfs-actions.pod:5588 ../fish/guestfish-actions.pod:3764
13904 "Note that if SELinux is enabled, it is always in Permissive mode "
13905 "(C<enforcing=0>)."
13909 #: ../src/guestfs-actions.pod:5598
13910 msgid "guestfs_set_trace"
13914 #: ../src/guestfs-actions.pod:5600
13918 " guestfs_set_trace (guestfs_h *g,\n"
13924 #: ../src/guestfs-actions.pod:5604 ../fish/guestfish-actions.pod:3776
13926 "If the command trace flag is set to 1, then commands are printed on stderr "
13927 "before they are executed in a format which is very similar to the one used "
13928 "by guestfish. In other words, you can run a program with this enabled, and "
13929 "you will get out a script which you can feed to guestfish to perform the "
13930 "same set of actions."
13934 #: ../src/guestfs-actions.pod:5611 ../fish/guestfish-actions.pod:3783
13936 "If you want to trace C API calls into libguestfs (and other libraries) then "
13937 "possibly a better way is to use the external ltrace(1) command."
13941 #: ../src/guestfs-actions.pod:5615 ../fish/guestfish-actions.pod:3787
13943 "Command traces are disabled unless the environment variable "
13944 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13948 #: ../src/guestfs-actions.pod:5622
13949 msgid "guestfs_set_verbose"
13953 #: ../src/guestfs-actions.pod:5624
13957 " guestfs_set_verbose (guestfs_h *g,\n"
13963 #: ../src/guestfs-actions.pod:5628 ../fish/guestfish-actions.pod:3796
13964 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
13968 #: ../src/guestfs-actions.pod:5630 ../fish/guestfish-actions.pod:3798
13970 "Verbose messages are disabled unless the environment variable "
13971 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13975 #: ../src/guestfs-actions.pod:5637
13976 msgid "guestfs_setcon"
13980 #: ../src/guestfs-actions.pod:5639
13984 " guestfs_setcon (guestfs_h *g,\n"
13985 " const char *context);\n"
13990 #: ../src/guestfs-actions.pod:5643 ../fish/guestfish-actions.pod:3805
13992 "This sets the SELinux security context of the daemon to the string "
13997 #: ../src/guestfs-actions.pod:5646 ../fish/guestfish-actions.pod:3808
13998 msgid "See the documentation about SELINUX in L<guestfs(3)>."
14002 #: ../src/guestfs-actions.pod:5652
14003 msgid "guestfs_setxattr"
14007 #: ../src/guestfs-actions.pod:5654
14011 " guestfs_setxattr (guestfs_h *g,\n"
14012 " const char *xattr,\n"
14013 " const char *val,\n"
14015 " const char *path);\n"
14020 #: ../src/guestfs-actions.pod:5661 ../fish/guestfish-actions.pod:3814
14022 "This call sets the extended attribute named C<xattr> of the file C<path> to "
14023 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
14027 #: ../src/guestfs-actions.pod:5665
14028 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
14032 #: ../src/guestfs-actions.pod:5671
14033 msgid "guestfs_sfdisk"
14037 #: ../src/guestfs-actions.pod:5673
14041 " guestfs_sfdisk (guestfs_h *g,\n"
14042 " const char *device,\n"
14046 " char *const *lines);\n"
14051 #: ../src/guestfs-actions.pod:5681 ../fish/guestfish-actions.pod:3824
14053 "This is a direct interface to the L<sfdisk(8)> program for creating "
14054 "partitions on block devices."
14058 #: ../src/guestfs-actions.pod:5684 ../fish/guestfish-actions.pod:3827
14059 msgid "C<device> should be a block device, for example C</dev/sda>."
14063 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3829
14065 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
14066 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
14067 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
14068 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
14069 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
14070 "the kernel) cannot work out the right geometry and you will need to tell it."
14074 #: ../src/guestfs-actions.pod:5694 ../fish/guestfish-actions.pod:3837
14076 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
14077 "refer to the L<sfdisk(8)> manpage."
14081 #: ../src/guestfs-actions.pod:5697 ../fish/guestfish-actions.pod:3840
14083 "To create a single partition occupying the whole disk, you would pass "
14084 "C<lines> as a single element list, when the single element being the string "
14089 #: ../src/guestfs-actions.pod:5701
14091 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
14095 #: ../src/guestfs-actions.pod:5711
14096 msgid "guestfs_sfdiskM"
14100 #: ../src/guestfs-actions.pod:5713
14104 " guestfs_sfdiskM (guestfs_h *g,\n"
14105 " const char *device,\n"
14106 " char *const *lines);\n"
14111 #: ../src/guestfs-actions.pod:5718
14113 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
14114 "partition sizes are specified in megabytes only (rounded to the nearest "
14115 "cylinder) and you don't need to specify the cyls, heads and sectors "
14116 "parameters which were rarely if ever used anyway."
14120 #: ../src/guestfs-actions.pod:5724
14122 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
14123 "C<guestfs_part_disk>"
14127 #: ../src/guestfs-actions.pod:5734
14128 msgid "guestfs_sfdisk_N"
14132 #: ../src/guestfs-actions.pod:5736
14136 " guestfs_sfdisk_N (guestfs_h *g,\n"
14137 " const char *device,\n"
14142 " const char *line);\n"
14147 #: ../src/guestfs-actions.pod:5745 ../fish/guestfish-actions.pod:3870
14149 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
14150 "(note: C<n> counts from 1)."
14154 #: ../src/guestfs-actions.pod:5748
14156 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
14157 "for the cyls/heads/sectors parameters."
14161 #: ../src/guestfs-actions.pod:5751
14162 msgid "See also: C<guestfs_part_add>"
14166 #: ../src/guestfs-actions.pod:5760
14167 msgid "guestfs_sfdisk_disk_geometry"
14171 #: ../src/guestfs-actions.pod:5762
14175 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
14176 " const char *device);\n"
14181 #: ../src/guestfs-actions.pod:5766
14183 "This displays the disk geometry of C<device> read from the partition table. "
14184 "Especially in the case where the underlying block device has been resized, "
14185 "this can be different from the kernel's idea of the geometry (see "
14186 "C<guestfs_sfdisk_kernel_geometry>)."
14190 #: ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5787
14191 #: ../fish/guestfish-actions.pod:3890 ../fish/guestfish-actions.pod:3899
14192 msgid "The result is in human-readable format, and not designed to be parsed."
14196 #: ../src/guestfs-actions.pod:5779
14197 msgid "guestfs_sfdisk_kernel_geometry"
14201 #: ../src/guestfs-actions.pod:5781
14205 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
14206 " const char *device);\n"
14211 #: ../src/guestfs-actions.pod:5785 ../fish/guestfish-actions.pod:3897
14212 msgid "This displays the kernel's idea of the geometry of C<device>."
14216 #: ../src/guestfs-actions.pod:5795
14217 msgid "guestfs_sfdisk_l"
14221 #: ../src/guestfs-actions.pod:5797
14225 " guestfs_sfdisk_l (guestfs_h *g,\n"
14226 " const char *device);\n"
14231 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3906
14233 "This displays the partition table on C<device>, in the human-readable output "
14234 "of the L<sfdisk(8)> command. It is not intended to be parsed."
14238 #: ../src/guestfs-actions.pod:5805
14239 msgid "See also: C<guestfs_part_list>"
14243 #: ../src/guestfs-actions.pod:5812
14248 #: ../src/guestfs-actions.pod:5814
14252 " guestfs_sh (guestfs_h *g,\n"
14253 " const char *command);\n"
14258 #: ../src/guestfs-actions.pod:5818 ../fish/guestfish-actions.pod:3916
14260 "This call runs a command from the guest filesystem via the guest's C</bin/"
14265 #: ../src/guestfs-actions.pod:5821
14266 msgid "This is like C<guestfs_command>, but passes the command to:"
14270 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3921
14273 " /bin/sh -c \"command\"\n"
14278 #: ../src/guestfs-actions.pod:5825 ../fish/guestfish-actions.pod:3923
14280 "Depending on the guest's shell, this usually results in wildcards being "
14281 "expanded, shell expressions being interpolated and so on."
14285 #: ../src/guestfs-actions.pod:5829
14286 msgid "All the provisos about C<guestfs_command> apply to this call."
14290 #: ../src/guestfs-actions.pod:5836
14291 msgid "guestfs_sh_lines"
14295 #: ../src/guestfs-actions.pod:5838
14299 " guestfs_sh_lines (guestfs_h *g,\n"
14300 " const char *command);\n"
14305 #: ../src/guestfs-actions.pod:5842
14307 "This is the same as C<guestfs_sh>, but splits the result into a list of "
14312 #: ../src/guestfs-actions.pod:5845
14313 msgid "See also: C<guestfs_command_lines>"
14317 #: ../src/guestfs-actions.pod:5853
14318 msgid "guestfs_sleep"
14322 #: ../src/guestfs-actions.pod:5855
14326 " guestfs_sleep (guestfs_h *g,\n"
14332 #: ../src/guestfs-actions.pod:5859 ../fish/guestfish-actions.pod:3942
14333 msgid "Sleep for C<secs> seconds."
14337 #: ../src/guestfs-actions.pod:5863
14338 msgid "(Added in 1.0.41)"
14342 #: ../src/guestfs-actions.pod:5865 ../src/guestfs-structs.pod:109
14343 msgid "guestfs_stat"
14347 #: ../src/guestfs-actions.pod:5867
14350 " struct guestfs_stat *\n"
14351 " guestfs_stat (guestfs_h *g,\n"
14352 " const char *path);\n"
14357 #: ../src/guestfs-actions.pod:5873 ../fish/guestfish-actions.pod:3950
14358 msgid "This is the same as the C<stat(2)> system call."
14362 #: ../src/guestfs-actions.pod:5881 ../src/guestfs-structs.pod:135
14363 msgid "guestfs_statvfs"
14367 #: ../src/guestfs-actions.pod:5883
14370 " struct guestfs_statvfs *\n"
14371 " guestfs_statvfs (guestfs_h *g,\n"
14372 " const char *path);\n"
14377 #: ../src/guestfs-actions.pod:5887 ../fish/guestfish-actions.pod:3956
14379 "Returns file system statistics for any mounted file system. C<path> should "
14380 "be a file or directory in the mounted file system (typically it is the mount "
14381 "point itself, but it doesn't need to be)."
14385 #: ../src/guestfs-actions.pod:5891 ../fish/guestfish-actions.pod:3960
14386 msgid "This is the same as the C<statvfs(2)> system call."
14390 #: ../src/guestfs-actions.pod:5893
14392 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
14393 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
14397 #: ../src/guestfs-actions.pod:5899
14398 msgid "guestfs_strings"
14402 #: ../src/guestfs-actions.pod:5901
14406 " guestfs_strings (guestfs_h *g,\n"
14407 " const char *path);\n"
14412 #: ../src/guestfs-actions.pod:5905 ../fish/guestfish-actions.pod:3966
14414 "This runs the L<strings(1)> command on a file and returns the list of "
14415 "printable strings found."
14419 #: ../src/guestfs-actions.pod:5917
14420 msgid "guestfs_strings_e"
14424 #: ../src/guestfs-actions.pod:5919
14428 " guestfs_strings_e (guestfs_h *g,\n"
14429 " const char *encoding,\n"
14430 " const char *path);\n"
14435 #: ../src/guestfs-actions.pod:5924
14437 "This is like the C<guestfs_strings> command, but allows you to specify the "
14438 "encoding of strings that are looked for in the source file C<path>."
14442 #: ../src/guestfs-actions.pod:5928 ../fish/guestfish-actions.pod:3980
14443 msgid "Allowed encodings are:"
14447 #: ../src/guestfs-actions.pod:5932 ../fish/guestfish-actions.pod:3984
14452 #: ../src/guestfs-actions.pod:5934
14454 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
14455 "ISO-8859-X (this is what C<guestfs_strings> uses)."
14459 #: ../src/guestfs-actions.pod:5937 ../fish/guestfish-actions.pod:3989
14464 #: ../src/guestfs-actions.pod:5939 ../fish/guestfish-actions.pod:3991
14465 msgid "Single 8-bit-byte characters."
14469 #: ../src/guestfs-actions.pod:5941 ../fish/guestfish-actions.pod:3993
14474 #: ../src/guestfs-actions.pod:5943 ../fish/guestfish-actions.pod:3995
14475 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
14479 #: ../src/guestfs-actions.pod:5946 ../fish/guestfish-actions.pod:3998
14480 msgid "l (lower case letter L)"
14484 #: ../src/guestfs-actions.pod:5948 ../fish/guestfish-actions.pod:4000
14486 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
14487 "examining binaries in Windows guests."
14491 #: ../src/guestfs-actions.pod:5951 ../fish/guestfish-actions.pod:4003
14496 #: ../src/guestfs-actions.pod:5953 ../fish/guestfish-actions.pod:4005
14497 msgid "32-bit big endian such as UCS-4BE."
14501 #: ../src/guestfs-actions.pod:5955 ../fish/guestfish-actions.pod:4007
14506 #: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:4009
14507 msgid "32-bit little endian such as UCS-4LE."
14511 #: ../src/guestfs-actions.pod:5961 ../fish/guestfish-actions.pod:4013
14512 msgid "The returned strings are transcoded to UTF-8."
14516 #: ../src/guestfs-actions.pod:5972
14517 msgid "guestfs_swapoff_device"
14521 #: ../src/guestfs-actions.pod:5974
14525 " guestfs_swapoff_device (guestfs_h *g,\n"
14526 " const char *device);\n"
14531 #: ../src/guestfs-actions.pod:5978
14533 "This command disables the libguestfs appliance swap device or partition "
14534 "named C<device>. See C<guestfs_swapon_device>."
14538 #: ../src/guestfs-actions.pod:5986
14539 msgid "guestfs_swapoff_file"
14543 #: ../src/guestfs-actions.pod:5988
14547 " guestfs_swapoff_file (guestfs_h *g,\n"
14548 " const char *file);\n"
14553 #: ../src/guestfs-actions.pod:5992 ../fish/guestfish-actions.pod:4030
14554 msgid "This command disables the libguestfs appliance swap on file."
14558 #: ../src/guestfs-actions.pod:5998
14559 msgid "guestfs_swapoff_label"
14563 #: ../src/guestfs-actions.pod:6000
14567 " guestfs_swapoff_label (guestfs_h *g,\n"
14568 " const char *label);\n"
14573 #: ../src/guestfs-actions.pod:6004 ../fish/guestfish-actions.pod:4036
14575 "This command disables the libguestfs appliance swap on labeled swap "
14580 #: ../src/guestfs-actions.pod:6011
14581 msgid "guestfs_swapoff_uuid"
14585 #: ../src/guestfs-actions.pod:6013
14589 " guestfs_swapoff_uuid (guestfs_h *g,\n"
14590 " const char *uuid);\n"
14595 #: ../src/guestfs-actions.pod:6017 ../fish/guestfish-actions.pod:4043
14597 "This command disables the libguestfs appliance swap partition with the given "
14602 #: ../src/guestfs-actions.pod:6024
14603 msgid "guestfs_swapon_device"
14607 #: ../src/guestfs-actions.pod:6026
14611 " guestfs_swapon_device (guestfs_h *g,\n"
14612 " const char *device);\n"
14617 #: ../src/guestfs-actions.pod:6030
14619 "This command enables the libguestfs appliance to use the swap device or "
14620 "partition named C<device>. The increased memory is made available for all "
14621 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
14625 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4055
14627 "Note that you should not swap to existing guest swap partitions unless you "
14628 "know what you are doing. They may contain hibernation information, or other "
14629 "information that the guest doesn't want you to trash. You also risk leaking "
14630 "information about the host to the guest this way. Instead, attach a new "
14631 "host device to the guest and swap on that."
14635 #: ../src/guestfs-actions.pod:6046
14636 msgid "guestfs_swapon_file"
14640 #: ../src/guestfs-actions.pod:6048
14644 " guestfs_swapon_file (guestfs_h *g,\n"
14645 " const char *file);\n"
14650 #: ../src/guestfs-actions.pod:6052
14652 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
14657 #: ../src/guestfs-actions.pod:6059
14658 msgid "guestfs_swapon_label"
14662 #: ../src/guestfs-actions.pod:6061
14666 " guestfs_swapon_label (guestfs_h *g,\n"
14667 " const char *label);\n"
14672 #: ../src/guestfs-actions.pod:6065
14674 "This command enables swap to a labeled swap partition. See "
14675 "C<guestfs_swapon_device> for other notes."
14679 #: ../src/guestfs-actions.pod:6072
14680 msgid "guestfs_swapon_uuid"
14684 #: ../src/guestfs-actions.pod:6074
14688 " guestfs_swapon_uuid (guestfs_h *g,\n"
14689 " const char *uuid);\n"
14694 #: ../src/guestfs-actions.pod:6078
14696 "This command enables swap to a swap partition with the given UUID. See "
14697 "C<guestfs_swapon_device> for other notes."
14701 #: ../src/guestfs-actions.pod:6085
14702 msgid "guestfs_sync"
14706 #: ../src/guestfs-actions.pod:6087
14710 " guestfs_sync (guestfs_h *g);\n"
14715 #: ../src/guestfs-actions.pod:6090 ../fish/guestfish-actions.pod:4087
14717 "This syncs the disk, so that any writes are flushed through to the "
14718 "underlying disk image."
14722 #: ../src/guestfs-actions.pod:6093 ../fish/guestfish-actions.pod:4090
14724 "You should always call this if you have modified a disk image, before "
14725 "closing the handle."
14729 #: ../src/guestfs-actions.pod:6100
14730 msgid "guestfs_tail"
14734 #: ../src/guestfs-actions.pod:6102
14738 " guestfs_tail (guestfs_h *g,\n"
14739 " const char *path);\n"
14744 #: ../src/guestfs-actions.pod:6106 ../fish/guestfish-actions.pod:4097
14746 "This command returns up to the last 10 lines of a file as a list of strings."
14750 #: ../src/guestfs-actions.pod:6118
14751 msgid "guestfs_tail_n"
14755 #: ../src/guestfs-actions.pod:6120
14759 " guestfs_tail_n (guestfs_h *g,\n"
14761 " const char *path);\n"
14766 #: ../src/guestfs-actions.pod:6125 ../fish/guestfish-actions.pod:4107
14768 "If the parameter C<nrlines> is a positive number, this returns the last "
14769 "C<nrlines> lines of the file C<path>."
14773 #: ../src/guestfs-actions.pod:6128 ../fish/guestfish-actions.pod:4110
14775 "If the parameter C<nrlines> is a negative number, this returns lines from "
14776 "the file C<path>, starting with the C<-nrlines>th line."
14780 #: ../src/guestfs-actions.pod:6142
14781 msgid "guestfs_tar_in"
14785 #: ../src/guestfs-actions.pod:6144
14789 " guestfs_tar_in (guestfs_h *g,\n"
14790 " const char *tarfile,\n"
14791 " const char *directory);\n"
14796 #: ../src/guestfs-actions.pod:6149 ../fish/guestfish-actions.pod:4122
14798 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14799 "tar file) into C<directory>."
14803 #: ../src/guestfs-actions.pod:6152
14805 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
14809 #: ../src/guestfs-actions.pod:6157 ../src/guestfs-actions.pod:6174
14810 #: ../src/guestfs-actions.pod:6190 ../src/guestfs-actions.pod:6206
14811 msgid "(Added in 1.0.3)"
14815 #: ../src/guestfs-actions.pod:6159
14816 msgid "guestfs_tar_out"
14820 #: ../src/guestfs-actions.pod:6161
14824 " guestfs_tar_out (guestfs_h *g,\n"
14825 " const char *directory,\n"
14826 " const char *tarfile);\n"
14831 #: ../src/guestfs-actions.pod:6166 ../fish/guestfish-actions.pod:4134
14833 "This command packs the contents of C<directory> and downloads it to local "
14838 #: ../src/guestfs-actions.pod:6169
14840 "To download a compressed tarball, use C<guestfs_tgz_out> or "
14841 "C<guestfs_txz_out>."
14845 #: ../src/guestfs-actions.pod:6176
14846 msgid "guestfs_tgz_in"
14850 #: ../src/guestfs-actions.pod:6178
14854 " guestfs_tgz_in (guestfs_h *g,\n"
14855 " const char *tarball,\n"
14856 " const char *directory);\n"
14861 #: ../src/guestfs-actions.pod:6183 ../fish/guestfish-actions.pod:4146
14863 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14864 "tar file) into C<directory>."
14868 #: ../src/guestfs-actions.pod:6186
14869 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
14873 #: ../src/guestfs-actions.pod:6192
14874 msgid "guestfs_tgz_out"
14878 #: ../src/guestfs-actions.pod:6194
14882 " guestfs_tgz_out (guestfs_h *g,\n"
14883 " const char *directory,\n"
14884 " const char *tarball);\n"
14889 #: ../src/guestfs-actions.pod:6199 ../fish/guestfish-actions.pod:4157
14891 "This command packs the contents of C<directory> and downloads it to local "
14896 #: ../src/guestfs-actions.pod:6202
14897 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
14901 #: ../src/guestfs-actions.pod:6208
14902 msgid "guestfs_touch"
14906 #: ../src/guestfs-actions.pod:6210
14910 " guestfs_touch (guestfs_h *g,\n"
14911 " const char *path);\n"
14916 #: ../src/guestfs-actions.pod:6214 ../fish/guestfish-actions.pod:4168
14918 "Touch acts like the L<touch(1)> command. It can be used to update the "
14919 "timestamps on a file, or, if the file does not exist, to create a new zero-"
14924 #: ../src/guestfs-actions.pod:6218 ../fish/guestfish-actions.pod:4172
14926 "This command only works on regular files, and will fail on other file types "
14927 "such as directories, symbolic links, block special etc."
14931 #: ../src/guestfs-actions.pod:6225
14932 msgid "guestfs_truncate"
14936 #: ../src/guestfs-actions.pod:6227
14940 " guestfs_truncate (guestfs_h *g,\n"
14941 " const char *path);\n"
14946 #: ../src/guestfs-actions.pod:6231 ../fish/guestfish-actions.pod:4179
14948 "This command truncates C<path> to a zero-length file. The file must exist "
14953 #: ../src/guestfs-actions.pod:6238
14954 msgid "guestfs_truncate_size"
14958 #: ../src/guestfs-actions.pod:6240
14962 " guestfs_truncate_size (guestfs_h *g,\n"
14963 " const char *path,\n"
14964 " int64_t size);\n"
14969 #: ../src/guestfs-actions.pod:6245 ../fish/guestfish-actions.pod:4186
14971 "This command truncates C<path> to size C<size> bytes. The file must exist "
14976 #: ../src/guestfs-actions.pod:6248
14978 "If the current file size is less than C<size> then the file is extended to "
14979 "the required size with zero bytes. This creates a sparse file (ie. disk "
14980 "blocks are not allocated for the file until you write to it). To create a "
14981 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
14985 #: ../src/guestfs-actions.pod:6258
14986 msgid "guestfs_tune2fs_l"
14990 #: ../src/guestfs-actions.pod:6260
14994 " guestfs_tune2fs_l (guestfs_h *g,\n"
14995 " const char *device);\n"
15000 #: ../src/guestfs-actions.pod:6264 ../fish/guestfish-actions.pod:4199
15002 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
15007 #: ../src/guestfs-actions.pod:6267 ../fish/guestfish-actions.pod:4202
15009 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
15010 "for more details. The list of fields returned isn't clearly defined, and "
15011 "depends on both the version of C<tune2fs> that libguestfs was built against, "
15012 "and the filesystem itself."
15016 #: ../src/guestfs-actions.pod:6280
15017 msgid "guestfs_txz_in"
15021 #: ../src/guestfs-actions.pod:6282
15025 " guestfs_txz_in (guestfs_h *g,\n"
15026 " const char *tarball,\n"
15027 " const char *directory);\n"
15032 #: ../src/guestfs-actions.pod:6287 ../fish/guestfish-actions.pod:4211
15034 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
15035 "tar file) into C<directory>."
15039 #: ../src/guestfs-actions.pod:6294
15040 msgid "guestfs_txz_out"
15044 #: ../src/guestfs-actions.pod:6296
15048 " guestfs_txz_out (guestfs_h *g,\n"
15049 " const char *directory,\n"
15050 " const char *tarball);\n"
15055 #: ../src/guestfs-actions.pod:6301 ../fish/guestfish-actions.pod:4220
15057 "This command packs the contents of C<directory> and downloads it to local "
15058 "file C<tarball> (as an xz compressed tar archive)."
15062 #: ../src/guestfs-actions.pod:6308
15063 msgid "guestfs_umask"
15067 #: ../src/guestfs-actions.pod:6310
15071 " guestfs_umask (guestfs_h *g,\n"
15077 #: ../src/guestfs-actions.pod:6314 ../fish/guestfish-actions.pod:4229
15079 "This function sets the mask used for creating new files and device nodes to "
15084 #: ../src/guestfs-actions.pod:6317 ../fish/guestfish-actions.pod:4232
15086 "Typical umask values would be C<022> which creates new files with "
15087 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
15088 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
15092 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4237
15094 "The default umask is C<022>. This is important because it means that "
15095 "directories and device nodes will be created with C<0644> or C<0755> mode "
15096 "even if you specify C<0777>."
15100 #: ../src/guestfs-actions.pod:6326
15102 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
15103 "C<guestfs_mkdir>."
15107 #: ../src/guestfs-actions.pod:6329 ../fish/guestfish-actions.pod:4244
15108 msgid "This call returns the previous umask."
15112 #: ../src/guestfs-actions.pod:6335
15113 msgid "guestfs_umount"
15117 #: ../src/guestfs-actions.pod:6337
15121 " guestfs_umount (guestfs_h *g,\n"
15122 " const char *pathordevice);\n"
15127 #: ../src/guestfs-actions.pod:6341 ../fish/guestfish-actions.pod:4252
15129 "This unmounts the given filesystem. The filesystem may be specified either "
15130 "by its mountpoint (path) or the device which contains the filesystem."
15134 #: ../src/guestfs-actions.pod:6349
15135 msgid "guestfs_umount_all"
15139 #: ../src/guestfs-actions.pod:6351
15143 " guestfs_umount_all (guestfs_h *g);\n"
15148 #: ../src/guestfs-actions.pod:6354 ../fish/guestfish-actions.pod:4262
15149 msgid "This unmounts all mounted filesystems."
15153 #: ../src/guestfs-actions.pod:6356 ../fish/guestfish-actions.pod:4264
15154 msgid "Some internal mounts are not unmounted by this call."
15158 #: ../src/guestfs-actions.pod:6362
15159 msgid "guestfs_upload"
15163 #: ../src/guestfs-actions.pod:6364
15167 " guestfs_upload (guestfs_h *g,\n"
15168 " const char *filename,\n"
15169 " const char *remotefilename);\n"
15174 #: ../src/guestfs-actions.pod:6369 ../src/guestfs-actions.pod:6388
15175 #: ../fish/guestfish-actions.pod:4270 ../fish/guestfish-actions.pod:4283
15176 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
15180 #: ../src/guestfs-actions.pod:6374
15181 msgid "See also C<guestfs_download>."
15185 #: ../src/guestfs-actions.pod:6380
15186 msgid "guestfs_upload_offset"
15190 #: ../src/guestfs-actions.pod:6382
15194 " guestfs_upload_offset (guestfs_h *g,\n"
15195 " const char *filename,\n"
15196 " const char *remotefilename,\n"
15197 " int64_t offset);\n"
15202 #: ../src/guestfs-actions.pod:6391 ../fish/guestfish-actions.pod:4286
15204 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
15205 "The intention is to overwrite parts of existing files or devices, although "
15206 "if a non-existant file is specified then it is created with a \"hole\" "
15207 "before C<offset>. The size of the data written is implicit in the size of "
15208 "the source C<filename>."
15212 #: ../src/guestfs-actions.pod:6398
15214 "Note that there is no limit on the amount of data that can be uploaded with "
15215 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
15216 "full amount unless an error occurs."
15220 #: ../src/guestfs-actions.pod:6403
15221 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
15225 #: ../src/guestfs-actions.pod:6409
15226 msgid "guestfs_utimens"
15230 #: ../src/guestfs-actions.pod:6411
15234 " guestfs_utimens (guestfs_h *g,\n"
15235 " const char *path,\n"
15236 " int64_t atsecs,\n"
15237 " int64_t atnsecs,\n"
15238 " int64_t mtsecs,\n"
15239 " int64_t mtnsecs);\n"
15244 #: ../src/guestfs-actions.pod:6419 ../fish/guestfish-actions.pod:4306
15245 msgid "This command sets the timestamps of a file with nanosecond precision."
15249 #: ../src/guestfs-actions.pod:6422 ../fish/guestfish-actions.pod:4309
15251 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
15256 #: ../src/guestfs-actions.pod:6425 ../fish/guestfish-actions.pod:4312
15258 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
15259 "nanoseconds from the epoch."
15263 #: ../src/guestfs-actions.pod:6428 ../fish/guestfish-actions.pod:4315
15265 "If the C<*nsecs> field contains the special value C<-1> then the "
15266 "corresponding timestamp is set to the current time. (The C<*secs> field is "
15267 "ignored in this case)."
15271 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4319
15273 "If the C<*nsecs> field contains the special value C<-2> then the "
15274 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
15279 #: ../src/guestfs-actions.pod:6440 ../src/guestfs-structs.pod:175
15280 msgid "guestfs_version"
15284 #: ../src/guestfs-actions.pod:6442
15287 " struct guestfs_version *\n"
15288 " guestfs_version (guestfs_h *g);\n"
15293 #: ../src/guestfs-actions.pod:6445 ../fish/guestfish-actions.pod:4327
15295 "Return the libguestfs version number that the program is linked against."
15299 #: ../src/guestfs-actions.pod:6448 ../fish/guestfish-actions.pod:4330
15301 "Note that because of dynamic linking this is not necessarily the version of "
15302 "libguestfs that you compiled against. You can compile the program, and then "
15303 "at runtime dynamically link against a completely different C<libguestfs.so> "
15308 #: ../src/guestfs-actions.pod:6453 ../fish/guestfish-actions.pod:4335
15310 "This call was added in version C<1.0.58>. In previous versions of "
15311 "libguestfs there was no way to get the version number. From C code you can "
15312 "use dynamic linker functions to find out if this symbol exists (if it "
15313 "doesn't, then it's an earlier version)."
15317 #: ../src/guestfs-actions.pod:6459 ../fish/guestfish-actions.pod:4341
15319 "The call returns a structure with four elements. The first three (C<major>, "
15320 "C<minor> and C<release>) are numbers and correspond to the usual version "
15321 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
15322 "but may be used for distro-specific information."
15326 #: ../src/guestfs-actions.pod:6465 ../fish/guestfish-actions.pod:4347
15328 "To construct the original version string: C<$major.$minor.$release$extra>"
15332 #: ../src/guestfs-actions.pod:6468 ../fish/guestfish-actions.pod:4350
15333 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
15337 #: ../src/guestfs-actions.pod:6470
15339 "I<Note:> Don't use this call to test for availability of features. In "
15340 "enterprise distributions we backport features from later versions into "
15341 "earlier versions, making this an unreliable way to test for features. Use "
15342 "C<guestfs_available> instead."
15346 #: ../src/guestfs-actions.pod:6476
15348 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
15349 "error. I<The caller must call C<guestfs_free_version> after use>."
15353 #: ../src/guestfs-actions.pod:6480
15354 msgid "(Added in 1.0.58)"
15358 #: ../src/guestfs-actions.pod:6482
15359 msgid "guestfs_vfs_label"
15363 #: ../src/guestfs-actions.pod:6484
15367 " guestfs_vfs_label (guestfs_h *g,\n"
15368 " const char *device);\n"
15373 #: ../src/guestfs-actions.pod:6488 ../fish/guestfish-actions.pod:4362
15374 msgid "This returns the filesystem label of the filesystem on C<device>."
15378 #: ../src/guestfs-actions.pod:6491 ../fish/guestfish-actions.pod:4365
15379 msgid "If the filesystem is unlabeled, this returns the empty string."
15383 #: ../src/guestfs-actions.pod:6493
15384 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
15388 #: ../src/guestfs-actions.pod:6498 ../src/guestfs-actions.pod:6535
15389 msgid "(Added in 1.3.18)"
15393 #: ../src/guestfs-actions.pod:6500
15394 msgid "guestfs_vfs_type"
15398 #: ../src/guestfs-actions.pod:6502
15402 " guestfs_vfs_type (guestfs_h *g,\n"
15403 " const char *device);\n"
15408 #: ../src/guestfs-actions.pod:6506 ../fish/guestfish-actions.pod:4373
15410 "This command gets the filesystem type corresponding to the filesystem on "
15415 #: ../src/guestfs-actions.pod:6509 ../fish/guestfish-actions.pod:4376
15417 "For most filesystems, the result is the name of the Linux VFS module which "
15418 "would be used to mount this filesystem if you mounted it without specifying "
15419 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
15423 #: ../src/guestfs-actions.pod:6519
15424 msgid "guestfs_vfs_uuid"
15428 #: ../src/guestfs-actions.pod:6521
15432 " guestfs_vfs_uuid (guestfs_h *g,\n"
15433 " const char *device);\n"
15438 #: ../src/guestfs-actions.pod:6525 ../fish/guestfish-actions.pod:4385
15439 msgid "This returns the filesystem UUID of the filesystem on C<device>."
15443 #: ../src/guestfs-actions.pod:6528 ../fish/guestfish-actions.pod:4388
15444 msgid "If the filesystem does not have a UUID, this returns the empty string."
15448 #: ../src/guestfs-actions.pod:6530
15449 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
15453 #: ../src/guestfs-actions.pod:6537
15454 msgid "guestfs_vg_activate"
15458 #: ../src/guestfs-actions.pod:6539
15462 " guestfs_vg_activate (guestfs_h *g,\n"
15464 " char *const *volgroups);\n"
15469 #: ../src/guestfs-actions.pod:6544 ../fish/guestfish-actions.pod:4396
15471 "This command activates or (if C<activate> is false) deactivates all logical "
15472 "volumes in the listed volume groups C<volgroups>. If activated, then they "
15473 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
15474 "deactivated, then those devices disappear."
15478 #: ../src/guestfs-actions.pod:6550 ../fish/guestfish-actions.pod:4402
15479 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
15483 #: ../src/guestfs-actions.pod:6552 ../fish/guestfish-actions.pod:4404
15485 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
15486 "activated or deactivated."
15490 #: ../src/guestfs-actions.pod:6559
15491 msgid "guestfs_vg_activate_all"
15495 #: ../src/guestfs-actions.pod:6561
15499 " guestfs_vg_activate_all (guestfs_h *g,\n"
15500 " int activate);\n"
15505 #: ../src/guestfs-actions.pod:6565 ../fish/guestfish-actions.pod:4411
15507 "This command activates or (if C<activate> is false) deactivates all logical "
15508 "volumes in all volume groups. If activated, then they are made known to the "
15509 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
15510 "those devices disappear."
15514 #: ../src/guestfs-actions.pod:6571 ../fish/guestfish-actions.pod:4417
15515 msgid "This command is the same as running C<vgchange -a y|n>"
15519 #: ../src/guestfs-actions.pod:6577
15520 msgid "guestfs_vgcreate"
15524 #: ../src/guestfs-actions.pod:6579
15528 " guestfs_vgcreate (guestfs_h *g,\n"
15529 " const char *volgroup,\n"
15530 " char *const *physvols);\n"
15535 #: ../src/guestfs-actions.pod:6584 ../fish/guestfish-actions.pod:4423
15537 "This creates an LVM volume group called C<volgroup> from the non-empty list "
15538 "of physical volumes C<physvols>."
15542 #: ../src/guestfs-actions.pod:6591
15543 msgid "guestfs_vglvuuids"
15547 #: ../src/guestfs-actions.pod:6593
15551 " guestfs_vglvuuids (guestfs_h *g,\n"
15552 " const char *vgname);\n"
15557 #: ../src/guestfs-actions.pod:6597 ../fish/guestfish-actions.pod:4430
15559 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
15560 "volumes created in this volume group."
15564 #: ../src/guestfs-actions.pod:6600
15566 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
15567 "associate logical volumes and volume groups."
15571 #: ../src/guestfs-actions.pod:6603
15572 msgid "See also C<guestfs_vgpvuuids>."
15576 #: ../src/guestfs-actions.pod:6611
15577 msgid "guestfs_vgpvuuids"
15581 #: ../src/guestfs-actions.pod:6613
15585 " guestfs_vgpvuuids (guestfs_h *g,\n"
15586 " const char *vgname);\n"
15591 #: ../src/guestfs-actions.pod:6617 ../fish/guestfish-actions.pod:4442
15593 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
15594 "volumes that this volume group resides on."
15598 #: ../src/guestfs-actions.pod:6620
15600 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
15601 "associate physical volumes and volume groups."
15605 #: ../src/guestfs-actions.pod:6623
15606 msgid "See also C<guestfs_vglvuuids>."
15610 #: ../src/guestfs-actions.pod:6631
15611 msgid "guestfs_vgremove"
15615 #: ../src/guestfs-actions.pod:6633
15619 " guestfs_vgremove (guestfs_h *g,\n"
15620 " const char *vgname);\n"
15625 #: ../src/guestfs-actions.pod:6637 ../fish/guestfish-actions.pod:4454
15626 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
15630 #: ../src/guestfs-actions.pod:6639 ../fish/guestfish-actions.pod:4456
15632 "This also forcibly removes all logical volumes in the volume group (if any)."
15636 #: ../src/guestfs-actions.pod:6646
15637 msgid "guestfs_vgrename"
15641 #: ../src/guestfs-actions.pod:6648
15645 " guestfs_vgrename (guestfs_h *g,\n"
15646 " const char *volgroup,\n"
15647 " const char *newvolgroup);\n"
15652 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4463
15653 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
15657 #: ../src/guestfs-actions.pod:6659
15658 msgid "guestfs_vgs"
15662 #: ../src/guestfs-actions.pod:6661
15666 " guestfs_vgs (guestfs_h *g);\n"
15671 #: ../src/guestfs-actions.pod:6664 ../fish/guestfish-actions.pod:4469
15673 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15678 #: ../src/guestfs-actions.pod:6667 ../fish/guestfish-actions.pod:4472
15680 "This returns a list of just the volume group names that were detected (eg. "
15685 #: ../src/guestfs-actions.pod:6670
15686 msgid "See also C<guestfs_vgs_full>."
15690 #: ../src/guestfs-actions.pod:6678
15691 msgid "guestfs_vgs_full"
15695 #: ../src/guestfs-actions.pod:6680
15698 " struct guestfs_lvm_vg_list *\n"
15699 " guestfs_vgs_full (guestfs_h *g);\n"
15704 #: ../src/guestfs-actions.pod:6683 ../fish/guestfish-actions.pod:4481
15706 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15707 "> command. The \"full\" version includes all fields."
15711 #: ../src/guestfs-actions.pod:6686
15713 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
15714 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
15718 #: ../src/guestfs-actions.pod:6692
15719 msgid "guestfs_vgscan"
15723 #: ../src/guestfs-actions.pod:6694
15727 " guestfs_vgscan (guestfs_h *g);\n"
15732 #: ../src/guestfs-actions.pod:6697 ../fish/guestfish-actions.pod:4488
15734 "This rescans all block devices and rebuilds the list of LVM physical "
15735 "volumes, volume groups and logical volumes."
15739 #: ../src/guestfs-actions.pod:6704
15740 msgid "guestfs_vguuid"
15744 #: ../src/guestfs-actions.pod:6706
15748 " guestfs_vguuid (guestfs_h *g,\n"
15749 " const char *vgname);\n"
15754 #: ../src/guestfs-actions.pod:6710 ../fish/guestfish-actions.pod:4495
15755 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15759 #: ../src/guestfs-actions.pod:6717
15760 msgid "guestfs_wait_ready"
15764 #: ../src/guestfs-actions.pod:6719
15768 " guestfs_wait_ready (guestfs_h *g);\n"
15773 #: ../src/guestfs-actions.pod:6722
15774 msgid "This function is a no op."
15778 #: ../src/guestfs-actions.pod:6724
15780 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
15781 "calling C<guestfs_launch> to wait for the launch to complete. However this "
15782 "is no longer necessary because C<guestfs_launch> now does the waiting."
15786 #: ../src/guestfs-actions.pod:6729
15788 "If you see any calls to this function in code then you can just remove them, "
15789 "unless you want to retain compatibility with older versions of the API."
15793 #: ../src/guestfs-actions.pod:6737
15794 msgid "guestfs_wc_c"
15798 #: ../src/guestfs-actions.pod:6739
15802 " guestfs_wc_c (guestfs_h *g,\n"
15803 " const char *path);\n"
15808 #: ../src/guestfs-actions.pod:6743 ../fish/guestfish-actions.pod:4501
15810 "This command counts the characters in a file, using the C<wc -c> external "
15815 #: ../src/guestfs-actions.pod:6750
15816 msgid "guestfs_wc_l"
15820 #: ../src/guestfs-actions.pod:6752
15824 " guestfs_wc_l (guestfs_h *g,\n"
15825 " const char *path);\n"
15830 #: ../src/guestfs-actions.pod:6756 ../fish/guestfish-actions.pod:4508
15832 "This command counts the lines in a file, using the C<wc -l> external command."
15836 #: ../src/guestfs-actions.pod:6763
15837 msgid "guestfs_wc_w"
15841 #: ../src/guestfs-actions.pod:6765
15845 " guestfs_wc_w (guestfs_h *g,\n"
15846 " const char *path);\n"
15851 #: ../src/guestfs-actions.pod:6769 ../fish/guestfish-actions.pod:4515
15853 "This command counts the words in a file, using the C<wc -w> external command."
15857 #: ../src/guestfs-actions.pod:6776
15858 msgid "guestfs_write"
15862 #: ../src/guestfs-actions.pod:6778
15866 " guestfs_write (guestfs_h *g,\n"
15867 " const char *path,\n"
15868 " const char *content,\n"
15869 " size_t content_size);\n"
15874 #: ../src/guestfs-actions.pod:6784 ../fish/guestfish-actions.pod:4522
15876 "This call creates a file called C<path>. The content of the file is the "
15877 "string C<content> (which can contain any 8 bit data)."
15881 #: ../src/guestfs-actions.pod:6794
15882 msgid "guestfs_write_file"
15886 #: ../src/guestfs-actions.pod:6796
15890 " guestfs_write_file (guestfs_h *g,\n"
15891 " const char *path,\n"
15892 " const char *content,\n"
15898 #: ../src/guestfs-actions.pod:6802 ../fish/guestfish-actions.pod:4532
15900 "This call creates a file called C<path>. The contents of the file is the "
15901 "string C<content> (which can contain any 8 bit data), with length C<size>."
15905 #: ../src/guestfs-actions.pod:6806 ../fish/guestfish-actions.pod:4536
15907 "As a special case, if C<size> is C<0> then the length is calculated using "
15908 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15912 #: ../src/guestfs-actions.pod:6810 ../fish/guestfish-actions.pod:4540
15914 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15915 "I<not> work, even if the length is specified."
15919 #: ../src/guestfs-actions.pod:6818 ../fish/guestfish-actions.pod:4546
15921 "This function is deprecated. In new code, use the C<write> call instead."
15925 #: ../src/guestfs-actions.pod:6827
15926 msgid "guestfs_zegrep"
15930 #: ../src/guestfs-actions.pod:6829
15934 " guestfs_zegrep (guestfs_h *g,\n"
15935 " const char *regex,\n"
15936 " const char *path);\n"
15941 #: ../src/guestfs-actions.pod:6834 ../fish/guestfish-actions.pod:4557
15943 "This calls the external C<zegrep> program and returns the matching lines."
15947 #: ../src/guestfs-actions.pod:6846
15948 msgid "guestfs_zegrepi"
15952 #: ../src/guestfs-actions.pod:6848
15956 " guestfs_zegrepi (guestfs_h *g,\n"
15957 " const char *regex,\n"
15958 " const char *path);\n"
15963 #: ../src/guestfs-actions.pod:6853 ../fish/guestfish-actions.pod:4567
15965 "This calls the external C<zegrep -i> program and returns the matching lines."
15969 #: ../src/guestfs-actions.pod:6865
15970 msgid "guestfs_zero"
15974 #: ../src/guestfs-actions.pod:6867
15978 " guestfs_zero (guestfs_h *g,\n"
15979 " const char *device);\n"
15984 #: ../src/guestfs-actions.pod:6871 ../fish/guestfish-actions.pod:4577
15985 msgid "This command writes zeroes over the first few blocks of C<device>."
15989 #: ../src/guestfs-actions.pod:6873 ../fish/guestfish-actions.pod:4579
15991 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15992 "securely wipe the device). It should be sufficient to remove any partition "
15993 "tables, filesystem superblocks and so on."
15997 #: ../src/guestfs-actions.pod:6877
15998 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
16002 #: ../src/guestfs-actions.pod:6888
16003 msgid "guestfs_zero_device"
16007 #: ../src/guestfs-actions.pod:6890
16011 " guestfs_zero_device (guestfs_h *g,\n"
16012 " const char *device);\n"
16017 #: ../src/guestfs-actions.pod:6894
16019 "This command writes zeroes over the entire C<device>. Compare with "
16020 "C<guestfs_zero> which just zeroes the first few blocks of a device."
16024 #: ../src/guestfs-actions.pod:6908
16025 msgid "(Added in 1.3.1)"
16029 #: ../src/guestfs-actions.pod:6910
16030 msgid "guestfs_zerofree"
16034 #: ../src/guestfs-actions.pod:6912
16038 " guestfs_zerofree (guestfs_h *g,\n"
16039 " const char *device);\n"
16044 #: ../src/guestfs-actions.pod:6916 ../fish/guestfish-actions.pod:4600
16046 "This runs the I<zerofree> program on C<device>. This program claims to zero "
16047 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
16048 "possible to compress the filesystem more effectively."
16052 #: ../src/guestfs-actions.pod:6921 ../fish/guestfish-actions.pod:4605
16053 msgid "You should B<not> run this program if the filesystem is mounted."
16057 #: ../src/guestfs-actions.pod:6924 ../fish/guestfish-actions.pod:4608
16059 "It is possible that using this program can damage the filesystem or data on "
16064 #: ../src/guestfs-actions.pod:6931
16065 msgid "guestfs_zfgrep"
16069 #: ../src/guestfs-actions.pod:6933
16073 " guestfs_zfgrep (guestfs_h *g,\n"
16074 " const char *pattern,\n"
16075 " const char *path);\n"
16080 #: ../src/guestfs-actions.pod:6938 ../fish/guestfish-actions.pod:4615
16082 "This calls the external C<zfgrep> program and returns the matching lines."
16086 #: ../src/guestfs-actions.pod:6950
16087 msgid "guestfs_zfgrepi"
16091 #: ../src/guestfs-actions.pod:6952
16095 " guestfs_zfgrepi (guestfs_h *g,\n"
16096 " const char *pattern,\n"
16097 " const char *path);\n"
16102 #: ../src/guestfs-actions.pod:6957 ../fish/guestfish-actions.pod:4625
16104 "This calls the external C<zfgrep -i> program and returns the matching lines."
16108 #: ../src/guestfs-actions.pod:6969
16109 msgid "guestfs_zfile"
16113 #: ../src/guestfs-actions.pod:6971
16117 " guestfs_zfile (guestfs_h *g,\n"
16118 " const char *meth,\n"
16119 " const char *path);\n"
16124 #: ../src/guestfs-actions.pod:6976 ../fish/guestfish-actions.pod:4635
16126 "This command runs C<file> after first decompressing C<path> using C<method>."
16130 #: ../src/guestfs-actions.pod:6979 ../fish/guestfish-actions.pod:4638
16131 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
16135 #: ../src/guestfs-actions.pod:6981
16137 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
16142 #: ../src/guestfs-actions.pod:6987 ../fish/guestfish-actions.pod:4643
16144 "This function is deprecated. In new code, use the C<file> call instead."
16148 #: ../src/guestfs-actions.pod:6996
16149 msgid "guestfs_zgrep"
16153 #: ../src/guestfs-actions.pod:6998
16157 " guestfs_zgrep (guestfs_h *g,\n"
16158 " const char *regex,\n"
16159 " const char *path);\n"
16164 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4654
16166 "This calls the external C<zgrep> program and returns the matching lines."
16170 #: ../src/guestfs-actions.pod:7015
16171 msgid "guestfs_zgrepi"
16175 #: ../src/guestfs-actions.pod:7017
16179 " guestfs_zgrepi (guestfs_h *g,\n"
16180 " const char *regex,\n"
16181 " const char *path);\n"
16186 #: ../src/guestfs-actions.pod:7022 ../fish/guestfish-actions.pod:4664
16188 "This calls the external C<zgrep -i> program and returns the matching lines."
16192 #: ../src/guestfs-availability.pod:3
16197 #: ../src/guestfs-availability.pod:5
16199 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
16200 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
16201 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
16202 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
16203 "L</guestfs_aug_save> L</guestfs_aug_set>"
16207 #: ../src/guestfs-availability.pod:21
16212 #: ../src/guestfs-availability.pod:23
16214 "The following functions: L</guestfs_inotify_add_watch> L</"
16215 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
16216 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
16220 #: ../src/guestfs-availability.pod:31
16221 msgid "B<linuxfsuuid>"
16225 #: ../src/guestfs-availability.pod:33
16227 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
16228 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
16232 #: ../src/guestfs-availability.pod:40
16233 msgid "B<linuxmodules>"
16237 #: ../src/guestfs-availability.pod:42
16238 msgid "The following functions: L</guestfs_modprobe>"
16242 #: ../src/guestfs-availability.pod:45
16243 msgid "B<linuxxattrs>"
16247 #: ../src/guestfs-availability.pod:47
16249 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> L</"
16250 "guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</"
16251 "guestfs_removexattr> L</guestfs_setxattr>"
16255 #: ../src/guestfs-availability.pod:56
16260 #: ../src/guestfs-availability.pod:58
16262 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
16263 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
16264 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
16268 #: ../src/guestfs-availability.pod:67
16273 #: ../src/guestfs-availability.pod:69
16275 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
16276 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
16277 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
16278 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
16279 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
16280 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
16281 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
16285 #: ../src/guestfs-availability.pod:92
16290 #: ../src/guestfs-availability.pod:94
16292 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
16293 "guestfs_mknod_b> L</guestfs_mknod_c>"
16297 #: ../src/guestfs-availability.pod:100
16302 #: ../src/guestfs-availability.pod:102
16303 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
16307 #: ../src/guestfs-availability.pod:105
16308 msgid "B<ntfsprogs>"
16312 #: ../src/guestfs-availability.pod:107
16314 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
16318 #: ../src/guestfs-availability.pod:111
16319 msgid "B<realpath>"
16323 #: ../src/guestfs-availability.pod:113
16324 msgid "The following functions: L</guestfs_realpath>"
16328 #: ../src/guestfs-availability.pod:116
16333 #: ../src/guestfs-availability.pod:118
16335 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
16336 "guestfs_scrub_freespace>"
16340 #: ../src/guestfs-availability.pod:123
16345 #: ../src/guestfs-availability.pod:125
16346 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
16350 #: ../src/guestfs-availability.pod:129
16355 #: ../src/guestfs-availability.pod:131
16356 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
16360 #: ../src/guestfs-availability.pod:135
16361 msgid "B<zerofree>"
16365 #: ../src/guestfs-availability.pod:137
16366 msgid "The following functions: L</guestfs_zerofree>"
16370 #: ../src/guestfs-structs.pod:1
16371 msgid "guestfs_int_bool"
16375 #: ../src/guestfs-structs.pod:3
16378 " struct guestfs_int_bool {\n"
16386 #: ../src/guestfs-structs.pod:8
16389 " struct guestfs_int_bool_list {\n"
16390 " uint32_t len; /* Number of elements in list. */\n"
16391 " struct guestfs_int_bool *val; /* Elements. */\n"
16397 #: ../src/guestfs-structs.pod:13
16400 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
16401 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
16406 #: ../src/guestfs-structs.pod:16
16407 msgid "guestfs_lvm_pv"
16411 #: ../src/guestfs-structs.pod:18
16414 " struct guestfs_lvm_pv {\n"
16415 " char *pv_name;\n"
16416 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16417 " char pv_uuid[32];\n"
16419 " uint64_t pv_size;\n"
16420 " uint64_t dev_size;\n"
16421 " uint64_t pv_free;\n"
16422 " uint64_t pv_used;\n"
16423 " char *pv_attr;\n"
16424 " int64_t pv_pe_count;\n"
16425 " int64_t pv_pe_alloc_count;\n"
16426 " char *pv_tags;\n"
16427 " uint64_t pe_start;\n"
16428 " int64_t pv_mda_count;\n"
16429 " uint64_t pv_mda_free;\n"
16435 #: ../src/guestfs-structs.pod:36
16438 " struct guestfs_lvm_pv_list {\n"
16439 " uint32_t len; /* Number of elements in list. */\n"
16440 " struct guestfs_lvm_pv *val; /* Elements. */\n"
16446 #: ../src/guestfs-structs.pod:41
16449 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
16450 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
16455 #: ../src/guestfs-structs.pod:44
16456 msgid "guestfs_lvm_vg"
16460 #: ../src/guestfs-structs.pod:46
16463 " struct guestfs_lvm_vg {\n"
16464 " char *vg_name;\n"
16465 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16466 " char vg_uuid[32];\n"
16468 " char *vg_attr;\n"
16469 " uint64_t vg_size;\n"
16470 " uint64_t vg_free;\n"
16471 " char *vg_sysid;\n"
16472 " uint64_t vg_extent_size;\n"
16473 " int64_t vg_extent_count;\n"
16474 " int64_t vg_free_count;\n"
16475 " int64_t max_lv;\n"
16476 " int64_t max_pv;\n"
16477 " int64_t pv_count;\n"
16478 " int64_t lv_count;\n"
16479 " int64_t snap_count;\n"
16480 " int64_t vg_seqno;\n"
16481 " char *vg_tags;\n"
16482 " int64_t vg_mda_count;\n"
16483 " uint64_t vg_mda_free;\n"
16489 #: ../src/guestfs-structs.pod:69
16492 " struct guestfs_lvm_vg_list {\n"
16493 " uint32_t len; /* Number of elements in list. */\n"
16494 " struct guestfs_lvm_vg *val; /* Elements. */\n"
16500 #: ../src/guestfs-structs.pod:74
16503 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
16504 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
16509 #: ../src/guestfs-structs.pod:77
16510 msgid "guestfs_lvm_lv"
16514 #: ../src/guestfs-structs.pod:79
16517 " struct guestfs_lvm_lv {\n"
16518 " char *lv_name;\n"
16519 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16520 " char lv_uuid[32];\n"
16521 " char *lv_attr;\n"
16522 " int64_t lv_major;\n"
16523 " int64_t lv_minor;\n"
16524 " int64_t lv_kernel_major;\n"
16525 " int64_t lv_kernel_minor;\n"
16526 " uint64_t lv_size;\n"
16527 " int64_t seg_count;\n"
16529 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16530 " float snap_percent;\n"
16531 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16532 " float copy_percent;\n"
16533 " char *move_pv;\n"
16534 " char *lv_tags;\n"
16535 " char *mirror_log;\n"
16536 " char *modules;\n"
16542 #: ../src/guestfs-structs.pod:101
16545 " struct guestfs_lvm_lv_list {\n"
16546 " uint32_t len; /* Number of elements in list. */\n"
16547 " struct guestfs_lvm_lv *val; /* Elements. */\n"
16553 #: ../src/guestfs-structs.pod:106
16556 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
16557 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
16562 #: ../src/guestfs-structs.pod:111
16565 " struct guestfs_stat {\n"
16569 " int64_t nlink;\n"
16574 " int64_t blksize;\n"
16575 " int64_t blocks;\n"
16576 " int64_t atime;\n"
16577 " int64_t mtime;\n"
16578 " int64_t ctime;\n"
16584 #: ../src/guestfs-structs.pod:127
16587 " struct guestfs_stat_list {\n"
16588 " uint32_t len; /* Number of elements in list. */\n"
16589 " struct guestfs_stat *val; /* Elements. */\n"
16595 #: ../src/guestfs-structs.pod:132
16598 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
16599 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
16604 #: ../src/guestfs-structs.pod:137
16607 " struct guestfs_statvfs {\n"
16608 " int64_t bsize;\n"
16609 " int64_t frsize;\n"
16610 " int64_t blocks;\n"
16611 " int64_t bfree;\n"
16612 " int64_t bavail;\n"
16613 " int64_t files;\n"
16614 " int64_t ffree;\n"
16615 " int64_t favail;\n"
16618 " int64_t namemax;\n"
16624 #: ../src/guestfs-structs.pod:151
16627 " struct guestfs_statvfs_list {\n"
16628 " uint32_t len; /* Number of elements in list. */\n"
16629 " struct guestfs_statvfs *val; /* Elements. */\n"
16635 #: ../src/guestfs-structs.pod:156
16638 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
16639 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
16644 #: ../src/guestfs-structs.pod:159
16645 msgid "guestfs_dirent"
16649 #: ../src/guestfs-structs.pod:161
16652 " struct guestfs_dirent {\n"
16661 #: ../src/guestfs-structs.pod:167
16664 " struct guestfs_dirent_list {\n"
16665 " uint32_t len; /* Number of elements in list. */\n"
16666 " struct guestfs_dirent *val; /* Elements. */\n"
16672 #: ../src/guestfs-structs.pod:172
16675 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
16676 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
16681 #: ../src/guestfs-structs.pod:177
16684 " struct guestfs_version {\n"
16685 " int64_t major;\n"
16686 " int64_t minor;\n"
16687 " int64_t release;\n"
16694 #: ../src/guestfs-structs.pod:184
16697 " struct guestfs_version_list {\n"
16698 " uint32_t len; /* Number of elements in list. */\n"
16699 " struct guestfs_version *val; /* Elements. */\n"
16705 #: ../src/guestfs-structs.pod:189
16708 " void guestfs_free_version (struct guestfs_free_version *);\n"
16709 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
16714 #: ../src/guestfs-structs.pod:192
16715 msgid "guestfs_xattr"
16719 #: ../src/guestfs-structs.pod:194
16722 " struct guestfs_xattr {\n"
16723 " char *attrname;\n"
16724 " /* The next two fields describe a byte array. */\n"
16725 " uint32_t attrval_len;\n"
16726 " char *attrval;\n"
16732 #: ../src/guestfs-structs.pod:201
16735 " struct guestfs_xattr_list {\n"
16736 " uint32_t len; /* Number of elements in list. */\n"
16737 " struct guestfs_xattr *val; /* Elements. */\n"
16743 #: ../src/guestfs-structs.pod:206
16746 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
16747 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
16752 #: ../src/guestfs-structs.pod:209
16753 msgid "guestfs_inotify_event"
16757 #: ../src/guestfs-structs.pod:211
16760 " struct guestfs_inotify_event {\n"
16761 " int64_t in_wd;\n"
16762 " uint32_t in_mask;\n"
16763 " uint32_t in_cookie;\n"
16764 " char *in_name;\n"
16770 #: ../src/guestfs-structs.pod:218
16773 " struct guestfs_inotify_event_list {\n"
16774 " uint32_t len; /* Number of elements in list. */\n"
16775 " struct guestfs_inotify_event *val; /* Elements. */\n"
16781 #: ../src/guestfs-structs.pod:223
16784 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
16785 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
16790 #: ../src/guestfs-structs.pod:226
16791 msgid "guestfs_partition"
16795 #: ../src/guestfs-structs.pod:228
16798 " struct guestfs_partition {\n"
16799 " int32_t part_num;\n"
16800 " uint64_t part_start;\n"
16801 " uint64_t part_end;\n"
16802 " uint64_t part_size;\n"
16808 #: ../src/guestfs-structs.pod:235
16811 " struct guestfs_partition_list {\n"
16812 " uint32_t len; /* Number of elements in list. */\n"
16813 " struct guestfs_partition *val; /* Elements. */\n"
16819 #: ../src/guestfs-structs.pod:240
16822 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
16823 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
16828 #: ../src/guestfs-structs.pod:243
16829 msgid "guestfs_application"
16833 #: ../src/guestfs-structs.pod:245
16836 " struct guestfs_application {\n"
16837 " char *app_name;\n"
16838 " char *app_display_name;\n"
16839 " int32_t app_epoch;\n"
16840 " char *app_version;\n"
16841 " char *app_release;\n"
16842 " char *app_install_path;\n"
16843 " char *app_trans_path;\n"
16844 " char *app_publisher;\n"
16845 " char *app_url;\n"
16846 " char *app_source_package;\n"
16847 " char *app_summary;\n"
16848 " char *app_description;\n"
16854 #: ../src/guestfs-structs.pod:260
16857 " struct guestfs_application_list {\n"
16858 " uint32_t len; /* Number of elements in list. */\n"
16859 " struct guestfs_application *val; /* Elements. */\n"
16865 #: ../src/guestfs-structs.pod:265
16868 " void guestfs_free_application (struct guestfs_free_application *);\n"
16869 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
16874 #: ../fish/guestfish.pod:5
16875 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
16879 #: ../fish/guestfish.pod:9
16882 " guestfish [--options] [commands]\n"
16887 #: ../fish/guestfish.pod:11
16895 #: ../fish/guestfish.pod:13
16898 " guestfish [--ro|--rw] -a disk.img\n"
16903 #: ../fish/guestfish.pod:15
16906 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
16911 #: ../fish/guestfish.pod:17
16914 " guestfish -d libvirt-domain\n"
16919 #: ../fish/guestfish.pod:19
16922 " guestfish [--ro|--rw] -a disk.img -i\n"
16927 #: ../fish/guestfish.pod:21
16930 " guestfish -d libvirt-domain -i\n"
16935 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
16936 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
16937 #: ../tools/virt-rescue.pl:41
16942 #: ../fish/guestfish.pod:25
16944 "Using guestfish in read/write mode on live virtual machines can be "
16945 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16946 "option to use guestfish safely if the disk image or virtual machine might be "
16951 #: ../fish/guestfish.pod:32
16953 "Guestfish is a shell and command-line tool for examining and modifying "
16954 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16955 "functionality of the guestfs API, see L<guestfs(3)>."
16959 #: ../fish/guestfish.pod:36
16961 "Guestfish gives you structured access to the libguestfs API, from shell "
16962 "scripts or the command line or interactively. If you want to rescue a "
16963 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16968 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:846
16969 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58
16970 #: ../tools/virt-resize.pl:66 ../tools/virt-tar.pl:45
16975 #: ../fish/guestfish.pod:43
16976 msgid "As an interactive shell"
16980 #: ../fish/guestfish.pod:45
16988 #: ../fish/guestfish.pod:47
16991 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
16992 " editing virtual machine filesystems.\n"
16997 #: ../fish/guestfish.pod:50
17000 " Type: 'help' for a list of commands\n"
17001 " 'man' to read the manual\n"
17002 " 'quit' to quit the shell\n"
17007 #: ../fish/guestfish.pod:54
17010 " ><fs> add-ro disk.img\n"
17012 " ><fs> list-filesystems\n"
17013 " /dev/sda1: ext4\n"
17014 " /dev/vg_guest/lv_root: ext4\n"
17015 " /dev/vg_guest/lv_swap: swap\n"
17016 " ><fs> mount /dev/vg_guest/lv_root /\n"
17017 " ><fs> cat /etc/fstab\n"
17019 " # Created by anaconda\n"
17026 #: ../fish/guestfish.pod:67
17027 msgid "From shell scripts"
17031 #: ../fish/guestfish.pod:69
17032 msgid "Create a new C</etc/motd> file in a guest or disk image:"
17036 #: ../fish/guestfish.pod:71
17039 " guestfish <<_EOF_\n"
17042 " mount /dev/vg_guest/lv_root /\n"
17043 " write /etc/motd \"Welcome, new users\"\n"
17049 #: ../fish/guestfish.pod:78
17050 msgid "List the LVM logical volumes in a disk image:"
17054 #: ../fish/guestfish.pod:80
17057 " guestfish -a disk.img --ro <<_EOF_\n"
17065 #: ../fish/guestfish.pod:85
17066 msgid "List all the filesystems in a disk image:"
17070 #: ../fish/guestfish.pod:87
17073 " guestfish -a disk.img --ro <<_EOF_\n"
17075 " list-filesystems\n"
17081 #: ../fish/guestfish.pod:92
17082 msgid "On one command line"
17086 #: ../fish/guestfish.pod:94
17087 msgid "Update C</etc/resolv.conf> in a guest:"
17091 #: ../fish/guestfish.pod:96
17095 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
17096 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
17101 #: ../fish/guestfish.pod:100
17102 msgid "Edit C</boot/grub/grub.conf> interactively:"
17106 #: ../fish/guestfish.pod:102
17109 " guestfish --rw --add disk.img \\\n"
17110 " --mount /dev/vg_guest/lv_root \\\n"
17111 " --mount /dev/sda1:/boot \\\n"
17112 " edit /boot/grub/grub.conf\n"
17117 #: ../fish/guestfish.pod:107
17118 msgid "Mount disks automatically"
17122 #: ../fish/guestfish.pod:109
17124 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
17128 #: ../fish/guestfish.pod:112
17131 " guestfish --ro -a disk.img -i cat /etc/group\n"
17136 #: ../fish/guestfish.pod:114
17139 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
17144 #: ../fish/guestfish.pod:116
17145 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
17149 #: ../fish/guestfish.pod:118
17152 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
17157 #: ../fish/guestfish.pod:120
17158 msgid "As a script interpreter"
17162 #: ../fish/guestfish.pod:122
17163 msgid "Create a 100MB disk containing an ext2-formatted partition:"
17167 #: ../fish/guestfish.pod:124
17170 " #!/usr/bin/guestfish -f\n"
17171 " sparse test1.img 100M\n"
17173 " part-disk /dev/sda mbr\n"
17174 " mkfs ext2 /dev/sda1\n"
17179 #: ../fish/guestfish.pod:130
17180 msgid "Start with a prepared disk"
17184 #: ../fish/guestfish.pod:132
17186 "An alternate way to create a 100MB disk called C<test1.img> containing a "
17187 "single ext2-formatted partition:"
17191 #: ../fish/guestfish.pod:135
17194 " guestfish -N fs\n"
17199 #: ../fish/guestfish.pod:137
17200 msgid "To list what is available do:"
17204 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:837
17207 " guestfish -N help | less\n"
17212 #: ../fish/guestfish.pod:141
17213 msgid "Remote control"
17217 #: ../fish/guestfish.pod:143
17220 " eval \"`guestfish --listen`\"\n"
17221 " guestfish --remote add-ro disk.img\n"
17222 " guestfish --remote run\n"
17223 " guestfish --remote lvs\n"
17228 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
17229 #: ../fuse/guestmount.pod:73 ../inspector/virt-inspector.pl:68
17230 #: ../tools/virt-edit.pl:72 ../tools/virt-win-reg.pl:171
17231 #: ../tools/virt-df.pl:71 ../tools/virt-ls.pl:78 ../tools/virt-resize.pl:257
17232 #: ../tools/virt-list-filesystems.pl:50 ../tools/virt-tar.pl:98
17233 #: ../tools/virt-rescue.pl:103 ../tools/virt-make-fs.pl:153
17234 #: ../tools/virt-list-partitions.pl:51
17239 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
17240 #: ../inspector/virt-inspector.pl:76 ../tools/virt-edit.pl:80
17241 #: ../tools/virt-win-reg.pl:179 ../tools/virt-df.pl:79 ../tools/virt-ls.pl:86
17242 #: ../tools/virt-resize.pl:265 ../tools/virt-list-filesystems.pl:58
17243 #: ../tools/virt-tar.pl:106 ../tools/virt-rescue.pl:111
17244 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:59
17249 #: ../fish/guestfish.pod:154
17250 msgid "Displays general help on options."
17254 #: ../fish/guestfish.pod:156
17255 msgid "B<-h> | B<--cmd-help>"
17259 #: ../fish/guestfish.pod:158
17260 msgid "Lists all available guestfish commands."
17264 #: ../fish/guestfish.pod:160
17265 msgid "B<-h cmd> | B<--cmd-help cmd>"
17269 #: ../fish/guestfish.pod:162
17270 msgid "Displays detailed help on a single command C<cmd>."
17274 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
17275 msgid "B<-a image> | B<--add image>"
17279 #: ../fish/guestfish.pod:166
17280 msgid "Add a block device or virtual machine image to the shell."
17284 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
17286 "The format of the disk image is auto-detected. To override this and force a "
17287 "particular format use the I<--format=..> option."
17291 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
17292 msgid "B<-c URI> | B<--connect URI>"
17296 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
17298 "When used in conjunction with the I<-d> option, this specifies the libvirt "
17299 "URI to use. The default is to use the default libvirt connection."
17303 #: ../fish/guestfish.pod:177
17308 #: ../fish/guestfish.pod:179
17310 "If using the I<--listen> option and a csh-like shell, use this option. See "
17311 "section L</REMOTE CONTROL AND CSH> below."
17315 #: ../fish/guestfish.pod:182 ../fuse/guestmount.pod:90
17316 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
17320 #: ../fish/guestfish.pod:184 ../fuse/guestmount.pod:92
17322 "Add disks from the named libvirt domain. If the I<--ro> option is also "
17323 "used, then any libvirt domain can be used. However in write mode, only "
17324 "libvirt domains which are shut down can be named here."
17328 #: ../fish/guestfish.pod:188
17329 msgid "B<-D> | B<--no-dest-paths>"
17333 #: ../fish/guestfish.pod:190
17335 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
17336 "to hit the tab key to complete paths on the guest filesystem, but this "
17337 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
17338 "allow this feature to be disabled."
17342 #: ../fish/guestfish.pod:195 ../fuse/guestmount.pod:108
17343 msgid "B<--echo-keys>"
17347 #: ../fish/guestfish.pod:197 ../fuse/guestmount.pod:110
17349 "When prompting for keys and passphrases, guestfish normally turns echoing "
17350 "off so you cannot see what you are typing. If you are not worried about "
17351 "Tempest attacks and there is no one else in the room you can specify this "
17352 "flag to see what you are typing."
17356 #: ../fish/guestfish.pod:202
17357 msgid "B<-f file> | B<--file file>"
17361 #: ../fish/guestfish.pod:204
17362 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
17366 #: ../fish/guestfish.pod:207
17369 " #!/usr/bin/guestfish -f\n"
17374 #: ../fish/guestfish.pod:209 ../fuse/guestmount.pod:115
17375 msgid "B<--format=raw|qcow2|..> | B<--format>"
17379 #: ../fish/guestfish.pod:211 ../fuse/guestmount.pod:117
17381 "The default for the I<-a> option is to auto-detect the format of the disk "
17382 "image. Using this forces the disk format for I<-a> options which follow on "
17383 "the command line. Using I<--format> with no argument switches back to auto-"
17384 "detection for subsequent I<-a> options."
17388 #: ../fish/guestfish.pod:216 ../fish/guestfish.pod:543
17389 #: ../inspector/virt-inspector.pl:431
17390 msgid "For example:"
17394 #: ../fish/guestfish.pod:218
17397 " guestfish --format=raw -a disk.img\n"
17402 #: ../fish/guestfish.pod:220
17403 msgid "forces raw format (no auto-detection) for C<disk.img>."
17407 #: ../fish/guestfish.pod:222
17410 " guestfish --format=raw -a disk.img --format -a another.img\n"
17415 #: ../fish/guestfish.pod:224
17417 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
17418 "detection for C<another.img>."
17422 #: ../fish/guestfish.pod:227
17424 "If you have untrusted raw-format guest disk images, you should use this "
17425 "option to specify the disk format. This avoids a possible security problem "
17426 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
17430 #: ../fish/guestfish.pod:232 ../fuse/guestmount.pod:135
17431 msgid "B<-i> | B<--inspector>"
17435 #: ../fish/guestfish.pod:234 ../fuse/guestmount.pod:137
17437 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
17438 "system and mount filesystems as they would be mounted on the real virtual "
17443 #: ../fish/guestfish.pod:238
17444 msgid "Typical usage is either:"
17448 #: ../fish/guestfish.pod:240
17451 " guestfish -d myguest -i\n"
17456 #: ../fish/guestfish.pod:242
17457 msgid "(for an inactive libvirt domain called I<myguest>), or:"
17461 #: ../fish/guestfish.pod:244
17464 " guestfish --ro -d myguest -i\n"
17469 #: ../fish/guestfish.pod:246
17470 msgid "(for active domains, readonly), or specify the block device directly:"
17474 #: ../fish/guestfish.pod:248
17477 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
17482 #: ../fish/guestfish.pod:250
17484 "Note that the command line syntax changed slightly over older versions of "
17485 "guestfish. You can still use the old syntax:"
17489 #: ../fish/guestfish.pod:253
17492 " guestfish [--ro] -i disk.img\n"
17497 #: ../fish/guestfish.pod:255
17500 " guestfish [--ro] -i libvirt-domain\n"
17505 #: ../fish/guestfish.pod:257 ../fuse/guestmount.pod:141
17506 msgid "B<--keys-from-stdin>"
17510 #: ../fish/guestfish.pod:259 ../fuse/guestmount.pod:143
17512 "Read key or passphrase parameters from stdin. The default is to try to read "
17513 "passphrases from the user by opening C</dev/tty>."
17517 #: ../fish/guestfish.pod:262
17518 msgid "B<--listen>"
17522 #: ../fish/guestfish.pod:264
17524 "Fork into the background and listen for remote commands. See section L</"
17525 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
17529 #: ../fish/guestfish.pod:267
17530 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
17534 #: ../fish/guestfish.pod:269
17535 msgid "Mount the named partition or logical volume on the given mountpoint."
17539 #: ../fish/guestfish.pod:271
17540 msgid "If the mountpoint is omitted, it defaults to C</>."
17544 #: ../fish/guestfish.pod:273
17545 msgid "You have to mount something on C</> before most commands will work."
17549 #: ../fish/guestfish.pod:275
17551 "If any I<-m> or I<--mount> options are given, the guest is automatically "
17556 #: ../fish/guestfish.pod:278
17558 "If you don't know what filesystems a disk image contains, you can either run "
17559 "guestfish without this option, then list the partitions and LVs available "
17560 "(see L</list-partitions> and L</lvs> commands), or you can use the L<virt-"
17561 "list-filesystems(1)> program."
17565 #: ../fish/guestfish.pod:283 ../fuse/guestmount.pod:154
17566 msgid "B<-n> | B<--no-sync>"
17570 #: ../fish/guestfish.pod:285
17572 "Disable autosync. This is enabled by default. See the discussion of "
17573 "autosync in the L<guestfs(3)> manpage."
17577 #: ../fish/guestfish.pod:288
17578 msgid "B<-N type> | B<--new type> | B<-N help>"
17582 #: ../fish/guestfish.pod:290
17584 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
17585 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
17586 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
17591 #: ../fish/guestfish.pod:295
17592 msgid "B<--progress-bars>"
17596 #: ../fish/guestfish.pod:297
17597 msgid "Enable progress bars, even when guestfish is used non-interactively."
17601 #: ../fish/guestfish.pod:299
17603 "Progress bars are enabled by default when guestfish is used as an "
17604 "interactive shell."
17608 #: ../fish/guestfish.pod:302
17609 msgid "B<--no-progress-bars>"
17613 #: ../fish/guestfish.pod:304
17614 msgid "Disable progress bars."
17618 #: ../fish/guestfish.pod:306
17619 msgid "B<--remote[=pid]>"
17623 #: ../fish/guestfish.pod:308
17625 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
17626 "CONTROL GUESTFISH OVER A SOCKET> below."
17630 #: ../fish/guestfish.pod:311 ../fuse/guestmount.pod:196
17631 msgid "B<-r> | B<--ro>"
17635 #: ../fish/guestfish.pod:313
17637 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
17638 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
17642 #: ../fish/guestfish.pod:316 ../tools/virt-rescue.pl:187
17644 "The option must always be used if the disk image or virtual machine might be "
17645 "running, and is generally recommended in cases where you don't need write "
17646 "access to the disk."
17650 #: ../fish/guestfish.pod:320
17652 "Note that prepared disk images created with I<-N> are not affected by the "
17657 #: ../fish/guestfish.pod:323
17658 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
17662 #: ../fish/guestfish.pod:325 ../fuse/guestmount.pod:208
17663 #: ../tools/virt-rescue.pl:195
17664 msgid "B<--selinux>"
17668 #: ../fish/guestfish.pod:327
17669 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
17673 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:212
17674 msgid "B<-v> | B<--verbose>"
17678 #: ../fish/guestfish.pod:331
17680 "Enable very verbose messages. This is particularly useful if you find a bug."
17684 #: ../fish/guestfish.pod:334 ../fuse/guestmount.pod:216
17685 msgid "B<-V> | B<--version>"
17689 #: ../fish/guestfish.pod:336
17690 msgid "Display the guestfish / libguestfs version number and exit."
17694 #: ../fish/guestfish.pod:338 ../fuse/guestmount.pod:220
17695 msgid "B<-w> | B<--rw>"
17699 #: ../fish/guestfish.pod:340
17701 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
17706 #: ../fish/guestfish.pod:343
17711 #: ../fish/guestfish.pod:345
17712 msgid "Echo each command before executing it."
17716 #: ../fish/guestfish.pod:349
17717 msgid "COMMANDS ON COMMAND LINE"
17721 #: ../fish/guestfish.pod:351
17723 "Any additional (non-option) arguments are treated as commands to execute."
17727 #: ../fish/guestfish.pod:354
17729 "Commands to execute should be separated by a colon (C<:>), where the colon "
17730 "is a separate parameter. Thus:"
17734 #: ../fish/guestfish.pod:357
17737 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
17742 #: ../fish/guestfish.pod:359
17744 "If there are no additional arguments, then we enter a shell, either an "
17745 "interactive shell with a prompt (if the input is a terminal) or a non-"
17746 "interactive shell."
17750 #: ../fish/guestfish.pod:363
17752 "In either command line mode or non-interactive shell, the first command that "
17753 "gives an error causes the whole shell to exit. In interactive mode (with a "
17754 "prompt) if a command fails, you can continue to enter commands."
17758 #: ../fish/guestfish.pod:368
17759 msgid "USING launch (OR run)"
17763 #: ../fish/guestfish.pod:370
17765 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
17766 "then launch it, then mount any disks you need, and finally issue actions/"
17767 "commands. So the general order of the day is:"
17771 #: ../fish/guestfish.pod:378
17772 msgid "add or -a/--add"
17776 #: ../fish/guestfish.pod:382
17777 msgid "launch (aka run)"
17781 #: ../fish/guestfish.pod:386
17782 msgid "mount or -m/--mount"
17786 #: ../fish/guestfish.pod:390
17787 msgid "any other commands"
17791 #: ../fish/guestfish.pod:394
17793 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
17794 "guest before mounting or performing any other commands."
17798 #: ../fish/guestfish.pod:397
17800 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
17801 "I<--new> options were given then C<run> is done automatically, simply "
17802 "because guestfish can't perform the action you asked for without doing this."
17806 #: ../fish/guestfish.pod:402
17807 msgid "OPENING DISKS FOR READ AND WRITE"
17811 #: ../fish/guestfish.pod:404
17813 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
17814 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
17815 "open disk images read-only or for writing."
17819 #: ../fish/guestfish.pod:408
17821 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
17822 "disk images supplied on the command line for write. To open a disk image "
17823 "read-only you have to do I<-a image --ro>."
17827 #: ../fish/guestfish.pod:412
17829 "This matters: If you accidentally open a live VM disk image writable then "
17830 "you will cause irreversible disk corruption."
17834 #: ../fish/guestfish.pod:415
17836 "By libguestfs 1.8 we intend to change the default the other way. Disk "
17837 "images will be opened read-only. You will have to either specify "
17838 "I<guestfish --rw> or change a configuration file in order to get write "
17839 "access for disk images specified by those other command line options."
17843 #: ../fish/guestfish.pod:420
17845 "This version of guestfish has a I<--rw> option which does nothing (it is "
17846 "already the default). However it is highly recommended that you use this "
17847 "option to indicate that guestfish needs write access, and to prepare your "
17848 "scripts for the day when this option will be required for write access."
17852 #: ../fish/guestfish.pod:426
17854 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
17855 "other libguestfs program apart from guestfish and guestmount."
17859 #: ../fish/guestfish.pod:429
17864 #: ../fish/guestfish.pod:431
17866 "You can quote ordinary parameters using either single or double quotes. For "
17871 #: ../fish/guestfish.pod:434
17874 " add \"file with a space.img\"\n"
17879 #: ../fish/guestfish.pod:436
17882 " rm '/file name'\n"
17887 #: ../fish/guestfish.pod:438
17895 #: ../fish/guestfish.pod:440
17897 "A few commands require a list of strings to be passed. For these, use a "
17898 "whitespace-separated list, enclosed in quotes. Strings containing "
17899 "whitespace to be passed through must be enclosed in single quotes. A "
17900 "literal single quote must be escaped with a backslash."
17904 #: ../fish/guestfish.pod:445
17907 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17908 " command \"/bin/echo 'foo bar'\"\n"
17909 " command \"/bin/echo \\'foo\\'\"\n"
17914 #: ../fish/guestfish.pod:449
17915 msgid "OPTIONAL ARGUMENTS"
17919 #: ../fish/guestfish.pod:451
17921 "Some commands take optional arguments. These arguments appear in this "
17922 "documentation as C<[argname:..]>. You can use them as in these examples:"
17926 #: ../fish/guestfish.pod:455
17929 " add-drive-opts filename\n"
17934 #: ../fish/guestfish.pod:457
17937 " add-drive-opts filename readonly:true\n"
17942 #: ../fish/guestfish.pod:459
17945 " add-drive-opts filename format:qcow2 readonly:false\n"
17950 #: ../fish/guestfish.pod:461
17952 "Each optional argument can appear at most once. All optional arguments must "
17953 "appear after the required ones."
17957 #: ../fish/guestfish.pod:464
17962 #: ../fish/guestfish.pod:466
17964 "This section applies to all commands which can take integers as parameters."
17968 #: ../fish/guestfish.pod:469
17969 msgid "SIZE SUFFIX"
17973 #: ../fish/guestfish.pod:471
17975 "When the command takes a parameter measured in bytes, you can use one of the "
17976 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17980 #: ../fish/guestfish.pod:477
17981 msgid "B<k> or B<K> or B<KiB>"
17985 #: ../fish/guestfish.pod:479
17986 msgid "The size in kilobytes (multiplied by 1024)."
17990 #: ../fish/guestfish.pod:481
17995 #: ../fish/guestfish.pod:483
17996 msgid "The size in SI 1000 byte units."
18000 #: ../fish/guestfish.pod:485
18001 msgid "B<M> or B<MiB>"
18005 #: ../fish/guestfish.pod:487
18006 msgid "The size in megabytes (multiplied by 1048576)."
18010 #: ../fish/guestfish.pod:489
18015 #: ../fish/guestfish.pod:491
18016 msgid "The size in SI 1000000 byte units."
18020 #: ../fish/guestfish.pod:493
18021 msgid "B<G> or B<GiB>"
18025 #: ../fish/guestfish.pod:495
18026 msgid "The size in gigabytes (multiplied by 2**30)."
18030 #: ../fish/guestfish.pod:497
18035 #: ../fish/guestfish.pod:499
18036 msgid "The size in SI 10**9 byte units."
18040 #: ../fish/guestfish.pod:501
18041 msgid "B<T> or B<TiB>"
18045 #: ../fish/guestfish.pod:503
18046 msgid "The size in terabytes (multiplied by 2**40)."
18050 #: ../fish/guestfish.pod:505
18055 #: ../fish/guestfish.pod:507
18056 msgid "The size in SI 10**12 byte units."
18060 #: ../fish/guestfish.pod:509
18061 msgid "B<P> or B<PiB>"
18065 #: ../fish/guestfish.pod:511
18066 msgid "The size in petabytes (multiplied by 2**50)."
18070 #: ../fish/guestfish.pod:513
18075 #: ../fish/guestfish.pod:515
18076 msgid "The size in SI 10**15 byte units."
18080 #: ../fish/guestfish.pod:517
18081 msgid "B<E> or B<EiB>"
18085 #: ../fish/guestfish.pod:519
18086 msgid "The size in exabytes (multiplied by 2**60)."
18090 #: ../fish/guestfish.pod:521
18095 #: ../fish/guestfish.pod:523
18096 msgid "The size in SI 10**18 byte units."
18100 #: ../fish/guestfish.pod:525
18101 msgid "B<Z> or B<ZiB>"
18105 #: ../fish/guestfish.pod:527
18106 msgid "The size in zettabytes (multiplied by 2**70)."
18110 #: ../fish/guestfish.pod:529
18115 #: ../fish/guestfish.pod:531
18116 msgid "The size in SI 10**21 byte units."
18120 #: ../fish/guestfish.pod:533
18121 msgid "B<Y> or B<YiB>"
18125 #: ../fish/guestfish.pod:535
18126 msgid "The size in yottabytes (multiplied by 2**80)."
18130 #: ../fish/guestfish.pod:537
18135 #: ../fish/guestfish.pod:539
18136 msgid "The size in SI 10**24 byte units."
18140 #: ../fish/guestfish.pod:545
18143 " truncate-size /file 1G\n"
18148 #: ../fish/guestfish.pod:547
18149 msgid "would truncate the file to 1 gigabyte."
18153 #: ../fish/guestfish.pod:549
18155 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
18156 "the parameter to L</memsize> is specified in megabytes already). Adding a "
18157 "suffix will probably not do what you expect."
18161 #: ../fish/guestfish.pod:553
18162 msgid "OCTAL AND HEXADECIMAL NUMBERS"
18166 #: ../fish/guestfish.pod:555
18168 "For specifying the radix (base) use the C convention: C<0> to prefix an "
18169 "octal number or C<0x> to prefix a hexadecimal number. For example:"
18173 #: ../fish/guestfish.pod:558
18176 " 1234 decimal number 1234\n"
18177 " 02322 octal number, equivalent to decimal 1234\n"
18178 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
18183 #: ../fish/guestfish.pod:562
18185 "When using the C<chmod> command, you almost always want to specify an octal "
18186 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
18187 "L<chmod(1)> program):"
18191 #: ../fish/guestfish.pod:566
18194 " chmod 0777 /public # OK\n"
18195 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
18200 #: ../fish/guestfish.pod:569
18202 "Commands that return numbers usually print them in decimal, but some "
18203 "commands print numbers in other radices (eg. C<umask> prints the mode in "
18204 "octal, preceeded by C<0>)."
18208 #: ../fish/guestfish.pod:573
18209 msgid "WILDCARDS AND GLOBBING"
18213 #: ../fish/guestfish.pod:575
18215 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
18216 "(globbing) by default. So for example the following will not do what you "
18221 #: ../fish/guestfish.pod:579
18229 #: ../fish/guestfish.pod:581
18231 "Assuming you don't have a directory called literally C</home/*> then the "
18232 "above command will return an error."
18236 #: ../fish/guestfish.pod:584
18237 msgid "To perform wildcard expansion, use the C<glob> command."
18241 #: ../fish/guestfish.pod:586
18244 " glob rm-rf /home/*\n"
18249 #: ../fish/guestfish.pod:588
18251 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
18252 "many times), equivalent to:"
18256 #: ../fish/guestfish.pod:591
18259 " rm-rf /home/jim\n"
18260 " rm-rf /home/joe\n"
18261 " rm-rf /home/mary\n"
18266 #: ../fish/guestfish.pod:595
18267 msgid "C<glob> only works on simple guest paths and not on device names."
18271 #: ../fish/guestfish.pod:597
18273 "If you have several parameters, each containing a wildcard, then glob will "
18274 "perform a Cartesian product."
18278 #: ../fish/guestfish.pod:600
18283 #: ../fish/guestfish.pod:602
18285 "Any line which starts with a I<#> character is treated as a comment and "
18286 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
18287 "a command. For example:"
18291 #: ../fish/guestfish.pod:606
18294 " # this is a comment\n"
18295 " # this is a comment\n"
18296 " foo # NOT a comment\n"
18301 #: ../fish/guestfish.pod:610
18302 msgid "Blank lines are also ignored."
18306 #: ../fish/guestfish.pod:612
18307 msgid "RUNNING COMMANDS LOCALLY"
18311 #: ../fish/guestfish.pod:614
18313 "Any line which starts with a I<!> character is treated as a command sent to "
18314 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
18318 #: ../fish/guestfish.pod:618
18322 " tgz-out /remote local/remote-data.tar.gz\n"
18327 #: ../fish/guestfish.pod:621
18329 "will create a directory C<local> on the host, and then export the contents "
18330 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
18331 "(See C<tgz-out>)."
18335 #: ../fish/guestfish.pod:625
18337 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
18338 "effect, due to the way that subprocesses work in Unix."
18342 #: ../fish/guestfish.pod:628
18347 #: ../fish/guestfish.pod:630
18349 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
18350 "command (a guestfish command) to the second command (any host command). For "
18355 #: ../fish/guestfish.pod:634
18358 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
18363 #: ../fish/guestfish.pod:636
18365 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
18366 "program). The above command would list all accounts in the guest filesystem "
18367 "which have UID 0, ie. root accounts including backdoors. Other examples:"
18371 #: ../fish/guestfish.pod:641
18374 " hexdump /bin/ls | head\n"
18375 " list-devices | tail -1\n"
18376 " tgz-out / - | tar ztf -\n"
18381 #: ../fish/guestfish.pod:645
18383 "The space before the pipe symbol is required, any space after the pipe "
18384 "symbol is optional. Everything after the pipe symbol is just passed "
18385 "straight to the host shell, so it can contain redirections, globs and "
18386 "anything else that makes sense on the host side."
18390 #: ../fish/guestfish.pod:650
18392 "To use a literal argument which begins with a pipe symbol, you have to quote "
18397 #: ../fish/guestfish.pod:653
18405 #: ../fish/guestfish.pod:655
18406 msgid "HOME DIRECTORIES"
18410 #: ../fish/guestfish.pod:657
18412 "If a parameter starts with the character C<~> then the tilde may be expanded "
18413 "as a home directory path (either C<~> for the current user's home directory, "
18414 "or C<~user> for another user)."
18418 #: ../fish/guestfish.pod:661
18420 "Note that home directory expansion happens for users known I<on the host>, "
18421 "not in the guest filesystem."
18425 #: ../fish/guestfish.pod:664
18427 "To use a literal argument which begins with a tilde, you have to quote it, "
18432 #: ../fish/guestfish.pod:667
18440 #: ../fish/guestfish.pod:671
18442 "Libguestfs has some support for Linux guests encrypted according to the "
18443 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
18444 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
18445 "LUKS is supported."
18449 #: ../fish/guestfish.pod:676
18450 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
18454 #: ../fish/guestfish.pod:678
18457 " ><fs> vfs-type /dev/sda2\n"
18463 #: ../fish/guestfish.pod:681
18465 "Then open those devices using L</luks-open>. This creates a device-mapper "
18466 "device called C</dev/mapper/luksdev>."
18470 #: ../fish/guestfish.pod:684
18473 " ><fs> luks-open /dev/sda2 luksdev\n"
18474 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
18479 #: ../fish/guestfish.pod:687
18481 "Finally you have to tell LVM to scan for volume groups on the newly created "
18486 #: ../fish/guestfish.pod:690
18490 " vg-activate-all true\n"
18495 #: ../fish/guestfish.pod:693
18496 msgid "The logical volume(s) can now be mounted in the usual way."
18500 #: ../fish/guestfish.pod:695
18502 "Before closing a LUKS device you must unmount any logical volumes on it and "
18503 "deactivate the volume groups by calling C<vg-activate false VG> on each "
18504 "one. Then you can close the mapper device:"
18508 #: ../fish/guestfish.pod:699
18511 " vg-activate false /dev/VG\n"
18512 " luks-close /dev/mapper/luksdev\n"
18517 #: ../fish/guestfish.pod:702
18518 msgid "WINDOWS PATHS"
18522 #: ../fish/guestfish.pod:704
18524 "If a path is prefixed with C<win:> then you can use Windows-style paths "
18525 "(with some limitations). The following commands are equivalent:"
18529 #: ../fish/guestfish.pod:707
18532 " file /WINDOWS/system32/config/system.LOG\n"
18537 #: ../fish/guestfish.pod:709
18540 " file win:/windows/system32/config/system.log\n"
18545 #: ../fish/guestfish.pod:711
18548 " file win:\\windows\\system32\\config\\system.log\n"
18553 #: ../fish/guestfish.pod:713
18556 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
18561 #: ../fish/guestfish.pod:715
18563 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
18564 "handles case insensitivity like Windows would. This only works in argument "
18565 "positions that expect a path."
18569 #: ../fish/guestfish.pod:719
18570 msgid "UPLOADING AND DOWNLOADING FILES"
18574 #: ../fish/guestfish.pod:721
18576 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
18577 "others which upload from or download to a local file, you can use the "
18578 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
18582 #: ../fish/guestfish.pod:725
18590 #: ../fish/guestfish.pod:727
18592 "reads stdin and creates from that a file C</foo> in the disk image, and:"
18596 #: ../fish/guestfish.pod:730
18599 " tar-out /etc - | tar tf -\n"
18604 #: ../fish/guestfish.pod:732
18606 "writes the tarball to stdout and then pipes that into the external \"tar\" "
18607 "command (see L</PIPES>)."
18611 #: ../fish/guestfish.pod:735
18613 "When using C<-> to read from stdin, the input is read up to the end of "
18614 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
18615 "some arbitrary end marker:"
18619 #: ../fish/guestfish.pod:739
18622 " upload -<<END /foo\n"
18631 #: ../fish/guestfish.pod:745
18633 "Any string of characters can be used instead of C<END>. The end marker must "
18634 "appear on a line of its own, without any preceeding or following characters "
18635 "(not even spaces)."
18639 #: ../fish/guestfish.pod:749
18641 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
18642 "upload local files (so-called \"FileIn\" parameters in the generator)."
18646 #: ../fish/guestfish.pod:752
18647 msgid "EXIT ON ERROR BEHAVIOUR"
18651 #: ../fish/guestfish.pod:754
18653 "By default, guestfish will ignore any errors when in interactive mode (ie. "
18654 "taking commands from a human over a tty), and will exit on the first error "
18655 "in non-interactive mode (scripts, commands given on the command line)."
18659 #: ../fish/guestfish.pod:759
18661 "If you prefix a command with a I<-> character, then that command will not "
18662 "cause guestfish to exit, even if that (one) command returns an error."
18666 #: ../fish/guestfish.pod:763
18667 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
18671 #: ../fish/guestfish.pod:765
18673 "Guestfish can be remote-controlled over a socket. This is useful "
18674 "particularly in shell scripts where you want to make several different "
18675 "changes to a filesystem, but you don't want the overhead of starting up a "
18676 "guestfish process each time."
18680 #: ../fish/guestfish.pod:770
18681 msgid "Start a guestfish server process using:"
18685 #: ../fish/guestfish.pod:772
18688 " eval \"`guestfish --listen`\"\n"
18693 #: ../fish/guestfish.pod:774
18694 msgid "and then send it commands by doing:"
18698 #: ../fish/guestfish.pod:776
18701 " guestfish --remote cmd [...]\n"
18706 #: ../fish/guestfish.pod:778
18707 msgid "To cause the server to exit, send it the exit command:"
18711 #: ../fish/guestfish.pod:780
18714 " guestfish --remote exit\n"
18719 #: ../fish/guestfish.pod:782
18721 "Note that the server will normally exit if there is an error in a command. "
18722 "You can change this in the usual way. See section L</EXIT ON ERROR "
18727 #: ../fish/guestfish.pod:786
18728 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18732 #: ../fish/guestfish.pod:788
18734 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18735 "is how the I<--remote> option knows where to send the commands. You can "
18736 "have several guestfish listener processes running using:"
18740 #: ../fish/guestfish.pod:792
18743 " eval \"`guestfish --listen`\"\n"
18744 " pid1=$GUESTFISH_PID\n"
18745 " eval \"`guestfish --listen`\"\n"
18746 " pid2=$GUESTFISH_PID\n"
18748 " guestfish --remote=$pid1 cmd\n"
18749 " guestfish --remote=$pid2 cmd\n"
18754 #: ../fish/guestfish.pod:800
18755 msgid "REMOTE CONTROL AND CSH"
18759 #: ../fish/guestfish.pod:802
18761 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18766 #: ../fish/guestfish.pod:805
18769 " eval \"`guestfish --listen --csh`\"\n"
18774 #: ../fish/guestfish.pod:807
18775 msgid "REMOTE CONTROL DETAILS"
18779 #: ../fish/guestfish.pod:809
18781 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
18782 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
18783 "and C<$PID> is the process ID of the server."
18787 #: ../fish/guestfish.pod:813
18788 msgid "Guestfish client and server versions must match exactly."
18792 #: ../fish/guestfish.pod:815
18793 msgid "PREPARED DISK IMAGES"
18797 #: ../fish/guestfish.pod:817
18799 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18800 "preformatted disk images that guestfish can make for you to save typing. "
18801 "This is particularly useful for testing purposes. This option is used "
18802 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18803 "can be mixed with I<-a>)."
18807 #: ../fish/guestfish.pod:823
18809 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18810 "the second and so on. Existing files in the current directory are "
18815 #: ../fish/guestfish.pod:827
18817 "The type briefly describes how the disk should be sized, partitioned, how "
18818 "filesystem(s) should be created, and how content should be added. "
18819 "Optionally the type can be followed by extra parameters, separated by C<:> "
18820 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
18821 "allocated disk, containing a single partition, with the partition formatted "
18822 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
18827 #: ../fish/guestfish.pod:835
18828 msgid "To list the available types and any extra parameters they take, run:"
18832 #: ../fish/guestfish.pod:839
18834 "Note that the prepared filesystem is not mounted. You would usually have to "
18835 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18839 #: ../fish/guestfish.pod:843
18841 "If any I<-N> or I<--new> options are given, the guest is automatically "
18846 #: ../fish/guestfish.pod:848
18847 msgid "Create a 100MB disk with an ext4-formatted partition:"
18851 #: ../fish/guestfish.pod:850
18854 " guestfish -N fs:ext4\n"
18859 #: ../fish/guestfish.pod:852
18860 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18864 #: ../fish/guestfish.pod:854
18867 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18872 #: ../fish/guestfish.pod:856
18873 msgid "Create a blank 200MB disk:"
18877 #: ../fish/guestfish.pod:858
18880 " guestfish -N disk:200M\n"
18885 #: ../fish/guestfish.pod:860
18886 msgid "PROGRESS BARS"
18890 #: ../fish/guestfish.pod:862
18892 "Some (not all) long-running commands send progress notification messages as "
18893 "they are running. Guestfish turns these messages into progress bars."
18897 #: ../fish/guestfish.pod:866
18899 "When a command that supports progress bars takes longer than two seconds to "
18900 "run, and if progress bars are enabled, then you will see one appearing below "
18905 #: ../fish/guestfish.pod:870
18908 " ><fs> copy-size /large-file /another-file 2048M\n"
18909 " / 10% [#####-----------------------------------------] 00:30\n"
18914 #: ../fish/guestfish.pod:873
18916 "The spinner on the left hand side moves round once for every progress "
18917 "notification received from the backend. This is a (reasonably) golden "
18918 "assurance that the command is \"doing something\" even if the progress bar "
18919 "is not moving, because the command is able to send the progress "
18920 "notifications. When the bar reaches 100% and the command finishes, the "
18921 "spinner disappears."
18925 #: ../fish/guestfish.pod:880
18927 "Progress bars are enabled by default when guestfish is used interactively. "
18928 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18929 "and you can disable them completely using I<--no-progress-bars>."
18933 #: ../fish/guestfish.pod:885
18934 msgid "GUESTFISH COMMANDS"
18938 #: ../fish/guestfish.pod:887
18940 "The commands in this section are guestfish convenience commands, in other "
18941 "words, they are not part of the L<guestfs(3)> API."
18945 #: ../fish/guestfish.pod:890
18950 #: ../fish/guestfish.pod:892
18959 #: ../fish/guestfish.pod:895
18960 msgid "Without any parameter, this provides general help."
18964 #: ../fish/guestfish.pod:897
18965 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18969 #: ../fish/guestfish.pod:899
18970 msgid "quit | exit"
18974 #: ../fish/guestfish.pod:901
18975 msgid "This exits guestfish. You can also use C<^D> key."
18979 #: ../fish/guestfish.pod:903
18980 msgid "@FISH_COMMANDS@"
18984 #: ../fish/guestfish.pod:905
18989 #: ../fish/guestfish.pod:909 ../test-tool/libguestfs-test-tool.pod:83
18994 #: ../fish/guestfish.pod:911
18996 "guestfish returns 0 if the commands completed without error, or 1 if there "
19001 #: ../fish/guestfish.pod:918
19006 #: ../fish/guestfish.pod:920
19008 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
19013 #: ../fish/guestfish.pod:923
19014 msgid "GUESTFISH_PID"
19018 #: ../fish/guestfish.pod:925
19020 "Used with the I<--remote> option to specify the remote guestfish process to "
19021 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
19025 #: ../fish/guestfish.pod:929
19030 #: ../fish/guestfish.pod:931
19032 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
19033 "not specified, the external L<hexedit(1)> program is used."
19037 #: ../fish/guestfish.pod:935
19042 #: ../fish/guestfish.pod:937
19044 "If compiled with GNU readline support, various files in the home directory "
19045 "can be used. See L</FILES>."
19049 #: ../fish/guestfish.pod:946
19051 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
19052 "effect as using the B<-v> option."
19056 #: ../fish/guestfish.pod:958
19058 "Set the path that guestfish uses to search for kernel and initrd.img. See "
19059 "the discussion of paths in L<guestfs(3)>."
19063 #: ../fish/guestfish.pod:969
19064 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
19068 #: ../fish/guestfish.pod:971
19073 #: ../fish/guestfish.pod:973
19075 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
19080 #: ../fish/guestfish.pod:988 ../test-tool/libguestfs-test-tool.pod:88
19085 #: ../fish/guestfish.pod:992
19086 msgid "$HOME/.guestfish"
19090 #: ../fish/guestfish.pod:994
19092 "If compiled with GNU readline support, then the command history is saved in "
19097 #: ../fish/guestfish.pod:997
19098 msgid "$HOME/.inputrc"
19102 #: ../fish/guestfish.pod:999
19103 msgid "/etc/inputrc"
19107 #: ../fish/guestfish.pod:1001
19109 "If compiled with GNU readline support, then these files can be used to "
19110 "configure readline. For further information, please see L<readline(3)/"
19111 "INITIALIZATION FILE>."
19115 #: ../fish/guestfish.pod:1005
19116 msgid "To write rules which only apply to guestfish, use:"
19120 #: ../fish/guestfish.pod:1007
19130 #: ../fish/guestfish.pod:1011
19132 "Variables that you can set in inputrc that change the behaviour of guestfish "
19133 "in useful ways include:"
19137 #: ../fish/guestfish.pod:1016
19138 msgid "completion-ignore-case (default: on)"
19142 #: ../fish/guestfish.pod:1018
19144 "By default, guestfish will ignore case when tab-completing paths on the "
19149 #: ../fish/guestfish.pod:1021
19152 " set completion-ignore-case off\n"
19157 #: ../fish/guestfish.pod:1023
19158 msgid "to make guestfish case sensitive."
19162 #: ../fish/guestfish.pod:1027
19167 #: ../fish/guestfish.pod:1029
19168 msgid "test2.img (etc)"
19172 #: ../fish/guestfish.pod:1031
19174 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
19175 "will be created in the file C<test1.img> in the current directory. The "
19176 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
19177 "the same name will be overwritten."
19181 #: ../fish/guestfish.pod:1040
19183 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
19184 "L<virt-edit(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, "
19185 "L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, "
19186 "L<virt-tar(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
19190 #: ../fish/guestfish.pod:1064 ../test-tool/libguestfs-test-tool.pod:124
19191 #: ../fuse/guestmount.pod:253 ../inspector/virt-inspector.pl:480
19192 #: ../tools/virt-edit.pl:370 ../tools/virt-win-reg.pl:518
19193 #: ../tools/virt-df.pl:657 ../tools/virt-ls.pl:251
19194 #: ../tools/virt-resize.pl:1516 ../tools/virt-list-filesystems.pl:206
19195 #: ../tools/virt-tar.pl:300 ../tools/virt-rescue.pl:285
19196 #: ../tools/virt-make-fs.pl:567 ../tools/virt-list-partitions.pl:273
19198 "This program is free software; you can redistribute it and/or modify it "
19199 "under the terms of the GNU General Public License as published by the Free "
19200 "Software Foundation; either version 2 of the License, or (at your option) "
19201 "any later version."
19205 #: ../fish/guestfish.pod:1069 ../test-tool/libguestfs-test-tool.pod:129
19206 #: ../fuse/guestmount.pod:258 ../inspector/virt-inspector.pl:485
19207 #: ../tools/virt-edit.pl:375 ../tools/virt-win-reg.pl:523
19208 #: ../tools/virt-df.pl:662 ../tools/virt-ls.pl:256
19209 #: ../tools/virt-resize.pl:1521 ../tools/virt-list-filesystems.pl:211
19210 #: ../tools/virt-tar.pl:305 ../tools/virt-rescue.pl:290
19211 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:278
19213 "This program is distributed in the hope that it will be useful, but WITHOUT "
19214 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
19215 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
19220 #: ../fish/guestfish.pod:1074 ../test-tool/libguestfs-test-tool.pod:134
19221 #: ../fuse/guestmount.pod:263 ../inspector/virt-inspector.pl:490
19222 #: ../tools/virt-edit.pl:380 ../tools/virt-win-reg.pl:528
19223 #: ../tools/virt-df.pl:667 ../tools/virt-ls.pl:261
19224 #: ../tools/virt-resize.pl:1526 ../tools/virt-list-filesystems.pl:216
19225 #: ../tools/virt-tar.pl:310 ../tools/virt-rescue.pl:295
19226 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:283
19228 "You should have received a copy of the GNU General Public License along with "
19229 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
19230 "Ave, Cambridge, MA 02139, USA."
19234 #: ../fish/guestfish-actions.pod:1
19239 #: ../fish/guestfish-actions.pod:3
19242 " add-cdrom filename\n"
19247 #: ../fish/guestfish-actions.pod:15
19249 "This call checks for the existence of C<filename>. This stops you from "
19250 "specifying other types of drive which are supported by qemu such as C<nbd:> "
19251 "and C<http:> URLs. To specify those, use the general L</config> call "
19256 #: ../fish/guestfish-actions.pod:22
19258 "If you just want to add an ISO file (often you use this as an efficient way "
19259 "to transfer large files into the guest), then you should probably use L</add-"
19260 "drive-ro> instead."
19264 #: ../fish/guestfish-actions.pod:35
19269 #: ../fish/guestfish-actions.pod:37
19274 #: ../fish/guestfish-actions.pod:39
19277 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
19282 #: ../fish/guestfish-actions.pod:41
19284 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
19285 "It works by connecting to libvirt, requesting the domain and domain XML from "
19286 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
19290 #: ../fish/guestfish-actions.pod:58
19292 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
19293 "libvirt.org/uri.html>). If this is not set then we connect to the default "
19294 "libvirt URI (or one set through an environment variable, see the libvirt "
19295 "documentation for full details). If you are using the C API directly then "
19296 "it is more flexible to create the libvirt connection object yourself, get "
19297 "the domain object, and call L</add-libvirt-dom>."
19301 #: ../fish/guestfish-actions.pod:66
19303 "The other optional parameters are passed directly through to L</add-drive-"
19308 #: ../fish/guestfish-actions.pod:69 ../fish/guestfish-actions.pod:133
19310 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
19314 #: ../fish/guestfish-actions.pod:71
19319 #: ../fish/guestfish-actions.pod:73
19322 " add-drive filename\n"
19327 #: ../fish/guestfish-actions.pod:75
19329 "This function is the equivalent of calling L</add-drive-opts> with no "
19330 "optional parameters, so the disk is added writable, with the format being "
19331 "detected automatically."
19335 #: ../fish/guestfish-actions.pod:79
19337 "Automatic detection of the format opens you up to a potential security hole "
19338 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
19339 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
19340 "you should think about replacing calls to this function with calls to L</add-"
19341 "drive-opts>, and specifying the format."
19345 #: ../fish/guestfish-actions.pod:86
19346 msgid "add-drive-opts"
19350 #: ../fish/guestfish-actions.pod:88
19355 #: ../fish/guestfish-actions.pod:90
19358 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
19363 #: ../fish/guestfish-actions.pod:117
19365 "This forces the image format. If you omit this (or use L</add-drive> or L</"
19366 "add-drive-ro>) then the format is automatically detected. Possible formats "
19367 "include C<raw> and C<qcow2>."
19371 #: ../fish/guestfish-actions.pod:128
19373 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
19374 "add-drive-with-if> call (q.v.)"
19378 #: ../fish/guestfish-actions.pod:135
19379 msgid "add-drive-ro"
19383 #: ../fish/guestfish-actions.pod:137
19388 #: ../fish/guestfish-actions.pod:139
19391 " add-drive-ro filename\n"
19396 #: ../fish/guestfish-actions.pod:141
19398 "This function is the equivalent of calling L</add-drive-opts> with the "
19399 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
19400 "is added read-only, with the format being detected automatically."
19404 #: ../fish/guestfish-actions.pod:146
19405 msgid "add-drive-ro-with-if"
19409 #: ../fish/guestfish-actions.pod:148
19412 " add-drive-ro-with-if filename iface\n"
19417 #: ../fish/guestfish-actions.pod:150
19419 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
19420 "interface emulation to use at run time."
19424 #: ../fish/guestfish-actions.pod:160
19425 msgid "add-drive-with-if"
19429 #: ../fish/guestfish-actions.pod:162
19432 " add-drive-with-if filename iface\n"
19437 #: ../fish/guestfish-actions.pod:164
19439 "This is the same as L</add-drive> but it allows you to specify the QEMU "
19440 "interface emulation to use at run time."
19444 #: ../fish/guestfish-actions.pod:174
19449 #: ../fish/guestfish-actions.pod:176
19452 " aug-clear augpath\n"
19457 #: ../fish/guestfish-actions.pod:181
19462 #: ../fish/guestfish-actions.pod:183
19470 #: ../fish/guestfish-actions.pod:185
19472 "Close the current Augeas handle and free up any resources used by it. After "
19473 "calling this, you have to call L</aug-init> again before you can use any "
19474 "other Augeas functions."
19478 #: ../fish/guestfish-actions.pod:190
19479 msgid "aug-defnode"
19483 #: ../fish/guestfish-actions.pod:192
19486 " aug-defnode name expr val\n"
19491 #: ../fish/guestfish-actions.pod:197
19493 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
19494 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
19495 "containing that single node."
19499 #: ../fish/guestfish-actions.pod:205
19504 #: ../fish/guestfish-actions.pod:207
19507 " aug-defvar name expr\n"
19512 #: ../fish/guestfish-actions.pod:216
19517 #: ../fish/guestfish-actions.pod:218
19520 " aug-get augpath\n"
19525 #: ../fish/guestfish-actions.pod:223
19530 #: ../fish/guestfish-actions.pod:225
19533 " aug-init root flags\n"
19538 #: ../fish/guestfish-actions.pod:231
19539 msgid "You must call this before using any other L</aug-*> commands."
19543 #: ../fish/guestfish-actions.pod:266
19544 msgid "Do not load the tree in L</aug-init>."
19548 #: ../fish/guestfish-actions.pod:270
19549 msgid "To close the handle, you can call L</aug-close>."
19553 #: ../fish/guestfish-actions.pod:274
19558 #: ../fish/guestfish-actions.pod:276
19561 " aug-insert augpath label true|false\n"
19566 #: ../fish/guestfish-actions.pod:286
19571 #: ../fish/guestfish-actions.pod:288
19579 #: ../fish/guestfish-actions.pod:295
19584 #: ../fish/guestfish-actions.pod:297
19587 " aug-ls augpath\n"
19592 #: ../fish/guestfish-actions.pod:299
19594 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
19595 "resulting nodes into alphabetical order."
19599 #: ../fish/guestfish-actions.pod:302
19604 #: ../fish/guestfish-actions.pod:304
19607 " aug-match augpath\n"
19612 #: ../fish/guestfish-actions.pod:310
19617 #: ../fish/guestfish-actions.pod:312
19620 " aug-mv src dest\n"
19625 #: ../fish/guestfish-actions.pod:317
19630 #: ../fish/guestfish-actions.pod:319
19633 " aug-rm augpath\n"
19638 #: ../fish/guestfish-actions.pod:325
19643 #: ../fish/guestfish-actions.pod:327
19651 #: ../fish/guestfish-actions.pod:331
19653 "The flags which were passed to L</aug-init> affect exactly how files are "
19658 #: ../fish/guestfish-actions.pod:334
19663 #: ../fish/guestfish-actions.pod:336
19666 " aug-set augpath val\n"
19671 #: ../fish/guestfish-actions.pod:340
19673 "In the Augeas API, it is possible to clear a node by setting the value to "
19674 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
19675 "this call. Instead you must use the L</aug-clear> call."
19679 #: ../fish/guestfish-actions.pod:345
19684 #: ../fish/guestfish-actions.pod:347
19687 " available 'groups ...'\n"
19692 #: ../fish/guestfish-actions.pod:353
19694 "The libguestfs groups, and the functions that those groups correspond to, "
19695 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
19696 "runtime by calling L</available-all-groups>."
19700 #: ../fish/guestfish-actions.pod:377
19701 msgid "You must call L</launch> before calling this function."
19705 #: ../fish/guestfish-actions.pod:399
19707 "This call was added in version C<1.0.80>. In previous versions of "
19708 "libguestfs all you could do would be to speculatively execute a command to "
19709 "find out if the daemon implemented it. See also L</version>."
19713 #: ../fish/guestfish-actions.pod:406
19714 msgid "available-all-groups"
19718 #: ../fish/guestfish-actions.pod:408
19721 " available-all-groups\n"
19726 #: ../fish/guestfish-actions.pod:410
19728 "This command returns a list of all optional groups that this daemon knows "
19729 "about. Note this returns both supported and unsupported groups. To find "
19730 "out which ones the daemon can actually support you have to call L</"
19731 "available> on each member of the returned list."
19735 #: ../fish/guestfish-actions.pod:416
19736 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
19740 #: ../fish/guestfish-actions.pod:418
19745 #: ../fish/guestfish-actions.pod:420
19748 " base64-in (base64file|-) filename\n"
19753 #: ../fish/guestfish-actions.pod:425 ../fish/guestfish-actions.pod:434
19754 #: ../fish/guestfish-actions.pod:658 ../fish/guestfish-actions.pod:827
19755 #: ../fish/guestfish-actions.pod:846 ../fish/guestfish-actions.pod:1223
19756 #: ../fish/guestfish-actions.pod:4128 ../fish/guestfish-actions.pod:4140
19757 #: ../fish/guestfish-actions.pod:4151 ../fish/guestfish-actions.pod:4162
19758 #: ../fish/guestfish-actions.pod:4214 ../fish/guestfish-actions.pod:4223
19759 #: ../fish/guestfish-actions.pod:4277 ../fish/guestfish-actions.pod:4300
19760 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
19764 #: ../fish/guestfish-actions.pod:427
19769 #: ../fish/guestfish-actions.pod:429
19772 " base64-out filename (base64file|-)\n"
19777 #: ../fish/guestfish-actions.pod:436
19778 msgid "blockdev-flushbufs"
19782 #: ../fish/guestfish-actions.pod:438
19785 " blockdev-flushbufs device\n"
19790 #: ../fish/guestfish-actions.pod:445
19791 msgid "blockdev-getbsz"
19795 #: ../fish/guestfish-actions.pod:447
19798 " blockdev-getbsz device\n"
19803 #: ../fish/guestfish-actions.pod:456
19804 msgid "blockdev-getro"
19808 #: ../fish/guestfish-actions.pod:458
19811 " blockdev-getro device\n"
19816 #: ../fish/guestfish-actions.pod:465
19817 msgid "blockdev-getsize64"
19821 #: ../fish/guestfish-actions.pod:467
19824 " blockdev-getsize64 device\n"
19829 #: ../fish/guestfish-actions.pod:471
19830 msgid "See also L</blockdev-getsz>."
19834 #: ../fish/guestfish-actions.pod:475
19835 msgid "blockdev-getss"
19839 #: ../fish/guestfish-actions.pod:477
19842 " blockdev-getss device\n"
19847 #: ../fish/guestfish-actions.pod:482
19849 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
19853 #: ../fish/guestfish-actions.pod:487
19854 msgid "blockdev-getsz"
19858 #: ../fish/guestfish-actions.pod:489
19861 " blockdev-getsz device\n"
19866 #: ../fish/guestfish-actions.pod:494
19868 "See also L</blockdev-getss> for the real sector size of the device, and L</"
19869 "blockdev-getsize64> for the more useful I<size in bytes>."
19873 #: ../fish/guestfish-actions.pod:500
19874 msgid "blockdev-rereadpt"
19878 #: ../fish/guestfish-actions.pod:502
19881 " blockdev-rereadpt device\n"
19886 #: ../fish/guestfish-actions.pod:508
19887 msgid "blockdev-setbsz"
19891 #: ../fish/guestfish-actions.pod:510
19894 " blockdev-setbsz device blocksize\n"
19899 #: ../fish/guestfish-actions.pod:519
19900 msgid "blockdev-setro"
19904 #: ../fish/guestfish-actions.pod:521
19907 " blockdev-setro device\n"
19912 #: ../fish/guestfish-actions.pod:527
19913 msgid "blockdev-setrw"
19917 #: ../fish/guestfish-actions.pod:529
19920 " blockdev-setrw device\n"
19925 #: ../fish/guestfish-actions.pod:535
19926 msgid "case-sensitive-path"
19930 #: ../fish/guestfish-actions.pod:537
19933 " case-sensitive-path path\n"
19938 #: ../fish/guestfish-actions.pod:561
19940 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
19941 "WINDOWS/system32\"> (the exact return value would depend on details of how "
19942 "the directories were originally created under Windows)."
19946 #: ../fish/guestfish-actions.pod:569
19947 msgid "See also L</realpath>."
19951 #: ../fish/guestfish-actions.pod:571
19956 #: ../fish/guestfish-actions.pod:573
19964 #: ../fish/guestfish-actions.pod:577
19966 "Note that this function cannot correctly handle binary files (specifically, "
19967 "files containing C<\\0> character which is treated as end of string). For "
19968 "those you need to use the L</read-file> or L</download> functions which have "
19969 "a more complex interface."
19973 #: ../fish/guestfish-actions.pod:585
19978 #: ../fish/guestfish-actions.pod:587
19981 " checksum csumtype path\n"
19986 #: ../fish/guestfish-actions.pod:630
19987 msgid "To get the checksum for a device, use L</checksum-device>."
19991 #: ../fish/guestfish-actions.pod:632
19992 msgid "To get the checksums for many files, use L</checksums-out>."
19996 #: ../fish/guestfish-actions.pod:634
19997 msgid "checksum-device"
20001 #: ../fish/guestfish-actions.pod:636
20004 " checksum-device csumtype device\n"
20009 #: ../fish/guestfish-actions.pod:638
20011 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
20012 "device named C<device>. For the types of checksums supported see the L</"
20013 "checksum> command."
20017 #: ../fish/guestfish-actions.pod:642
20018 msgid "checksums-out"
20022 #: ../fish/guestfish-actions.pod:644
20025 " checksums-out csumtype directory (sumsfile|-)\n"
20030 #: ../fish/guestfish-actions.pod:660
20035 #: ../fish/guestfish-actions.pod:662
20038 " chmod mode path\n"
20043 #: ../fish/guestfish-actions.pod:673
20048 #: ../fish/guestfish-actions.pod:675
20051 " chown owner group path\n"
20056 #: ../fish/guestfish-actions.pod:683
20061 #: ../fish/guestfish-actions.pod:685
20064 " command 'arguments ...'\n"
20069 #: ../fish/guestfish-actions.pod:692
20071 "The single parameter is an argv-style list of arguments. The first element "
20072 "is the name of the program to run. Subsequent elements are parameters. The "
20073 "list must be non-empty (ie. must contain a program name). Note that the "
20074 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
20078 #: ../fish/guestfish-actions.pod:720
20079 msgid "command-lines"
20083 #: ../fish/guestfish-actions.pod:722
20086 " command-lines 'arguments ...'\n"
20091 #: ../fish/guestfish-actions.pod:724
20093 "This is the same as L</command>, but splits the result into a list of lines."
20097 #: ../fish/guestfish-actions.pod:727
20098 msgid "See also: L</sh-lines>"
20102 #: ../fish/guestfish-actions.pod:732
20107 #: ../fish/guestfish-actions.pod:734
20110 " config qemuparam qemuvalue\n"
20115 #: ../fish/guestfish-actions.pod:745
20120 #: ../fish/guestfish-actions.pod:747
20123 " copy-size src dest size\n"
20128 #: ../fish/guestfish-actions.pod:755
20133 #: ../fish/guestfish-actions.pod:757
20141 #: ../fish/guestfish-actions.pod:762
20146 #: ../fish/guestfish-actions.pod:764
20154 #: ../fish/guestfish-actions.pod:769
20159 #: ../fish/guestfish-actions.pod:771
20167 #: ../fish/guestfish-actions.pod:778
20169 "If the destination is a device, it must be as large or larger than the "
20170 "source file or device, otherwise the copy will fail. This command cannot do "
20171 "partial copies (see L</copy-size>)."
20175 #: ../fish/guestfish-actions.pod:782
20180 #: ../fish/guestfish-actions.pod:784
20188 #: ../fish/guestfish-actions.pod:792
20193 #: ../fish/guestfish-actions.pod:794
20201 #: ../fish/guestfish-actions.pod:803
20206 #: ../fish/guestfish-actions.pod:805
20214 #: ../fish/guestfish-actions.pod:811
20216 "Another way to get the same information is to enable verbose messages with "
20217 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
20218 "before running the program."
20222 #: ../fish/guestfish-actions.pod:816
20227 #: ../fish/guestfish-actions.pod:818
20230 " download remotefilename (filename|-)\n"
20235 #: ../fish/guestfish-actions.pod:825
20236 msgid "See also L</upload>, L</cat>."
20240 #: ../fish/guestfish-actions.pod:829
20241 msgid "download-offset"
20245 #: ../fish/guestfish-actions.pod:831
20248 " download-offset remotefilename (filename|-) offset size\n"
20253 #: ../fish/guestfish-actions.pod:839
20255 "Note that there is no limit on the amount of data that can be downloaded "
20256 "with this call, unlike with L</pread>, and this call always reads the full "
20257 "amount unless an error occurs."
20261 #: ../fish/guestfish-actions.pod:844
20262 msgid "See also L</download>, L</pread>."
20266 #: ../fish/guestfish-actions.pod:848
20267 msgid "drop-caches"
20271 #: ../fish/guestfish-actions.pod:850
20274 " drop-caches whattodrop\n"
20279 #: ../fish/guestfish-actions.pod:862
20284 #: ../fish/guestfish-actions.pod:864
20292 #: ../fish/guestfish-actions.pod:876
20297 #: ../fish/guestfish-actions.pod:878
20300 " e2fsck-f device\n"
20305 #: ../fish/guestfish-actions.pod:884
20307 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
20308 "should use L</fsck>."
20312 #: ../fish/guestfish-actions.pod:887
20313 msgid "echo-daemon"
20317 #: ../fish/guestfish-actions.pod:889
20320 " echo-daemon 'words ...'\n"
20325 #: ../fish/guestfish-actions.pod:896
20326 msgid "See also L</ping-daemon>."
20330 #: ../fish/guestfish-actions.pod:898
20335 #: ../fish/guestfish-actions.pod:900
20338 " egrep regex path\n"
20343 #: ../fish/guestfish-actions.pod:908
20348 #: ../fish/guestfish-actions.pod:910
20351 " egrepi regex path\n"
20356 #: ../fish/guestfish-actions.pod:918
20361 #: ../fish/guestfish-actions.pod:920
20364 " equal file1 file2\n"
20369 #: ../fish/guestfish-actions.pod:927
20374 #: ../fish/guestfish-actions.pod:929
20382 #: ../fish/guestfish-actions.pod:934
20383 msgid "See also L</is-file>, L</is-dir>, L</stat>."
20387 #: ../fish/guestfish-actions.pod:936
20392 #: ../fish/guestfish-actions.pod:938
20395 " fallocate path len\n"
20400 #: ../fish/guestfish-actions.pod:955
20401 msgid "fallocate64"
20405 #: ../fish/guestfish-actions.pod:957
20408 " fallocate64 path len\n"
20413 #: ../fish/guestfish-actions.pod:963
20415 "Note that this call allocates disk blocks for the file. To create a sparse "
20416 "file use L</truncate-size> instead."
20420 #: ../fish/guestfish-actions.pod:966
20422 "The deprecated call L</fallocate> does the same, but owing to an oversight "
20423 "it only allowed 30 bit lengths to be specified, effectively limiting the "
20424 "maximum size of files created through that call to 1GB."
20428 #: ../fish/guestfish-actions.pod:975
20433 #: ../fish/guestfish-actions.pod:977
20436 " fgrep pattern path\n"
20441 #: ../fish/guestfish-actions.pod:985
20446 #: ../fish/guestfish-actions.pod:987
20449 " fgrepi pattern path\n"
20454 #: ../fish/guestfish-actions.pod:995
20459 #: ../fish/guestfish-actions.pod:997
20467 #: ../fish/guestfish-actions.pod:1009
20469 "This command can also be used on C</dev/> devices (and partitions, LV "
20470 "names). You can for example use this to determine if a device contains a "
20471 "filesystem, although it's usually better to use L</vfs-type>."
20475 #: ../fish/guestfish-actions.pod:1019
20476 msgid "file-architecture"
20480 #: ../fish/guestfish-actions.pod:1021
20483 " file-architecture filename\n"
20488 #: ../fish/guestfish-actions.pod:1124
20493 #: ../fish/guestfish-actions.pod:1126
20501 #: ../fish/guestfish-actions.pod:1130
20503 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
20504 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
20508 #: ../fish/guestfish-actions.pod:1134
20513 #: ../fish/guestfish-actions.pod:1136
20516 " fill c len path\n"
20521 #: ../fish/guestfish-actions.pod:1142
20523 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
20524 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
20525 "L</fill-pattern>."
20529 #: ../fish/guestfish-actions.pod:1147
20530 msgid "fill-pattern"
20534 #: ../fish/guestfish-actions.pod:1149
20537 " fill-pattern pattern len path\n"
20542 #: ../fish/guestfish-actions.pod:1151
20544 "This function is like L</fill> except that it creates a new file of length "
20545 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
20546 "is truncated if necessary to ensure the length of the file is exactly C<len> "
20551 #: ../fish/guestfish-actions.pod:1156
20556 #: ../fish/guestfish-actions.pod:1158
20559 " find directory\n"
20564 #: ../fish/guestfish-actions.pod:1172
20565 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
20569 #: ../fish/guestfish-actions.pod:1185
20570 msgid "See also L</find0>."
20574 #: ../fish/guestfish-actions.pod:1190
20579 #: ../fish/guestfish-actions.pod:1192
20582 " find0 directory (files|-)\n"
20587 #: ../fish/guestfish-actions.pod:1198
20589 "This command works the same way as L</find> with the following exceptions:"
20593 #: ../fish/guestfish-actions.pod:1225
20594 msgid "findfs-label"
20598 #: ../fish/guestfish-actions.pod:1227
20601 " findfs-label label\n"
20606 #: ../fish/guestfish-actions.pod:1233
20607 msgid "To find the label of a filesystem, use L</vfs-label>."
20611 #: ../fish/guestfish-actions.pod:1235
20612 msgid "findfs-uuid"
20616 #: ../fish/guestfish-actions.pod:1237
20619 " findfs-uuid uuid\n"
20624 #: ../fish/guestfish-actions.pod:1243
20625 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
20629 #: ../fish/guestfish-actions.pod:1245
20634 #: ../fish/guestfish-actions.pod:1247
20637 " fsck fstype device\n"
20642 #: ../fish/guestfish-actions.pod:1277
20647 #: ../fish/guestfish-actions.pod:1279
20655 #: ../fish/guestfish-actions.pod:1286
20656 msgid "get-autosync"
20660 #: ../fish/guestfish-actions.pod:1288
20668 #: ../fish/guestfish-actions.pod:1292
20673 #: ../fish/guestfish-actions.pod:1294
20681 #: ../fish/guestfish-actions.pod:1298
20682 msgid "get-e2label"
20686 #: ../fish/guestfish-actions.pod:1300
20689 " get-e2label device\n"
20694 #: ../fish/guestfish-actions.pod:1312
20699 #: ../fish/guestfish-actions.pod:1314
20702 " get-e2uuid device\n"
20707 #: ../fish/guestfish-actions.pod:1326
20708 msgid "get-memsize"
20712 #: ../fish/guestfish-actions.pod:1328
20720 #: ../fish/guestfish-actions.pod:1333
20722 "If L</set-memsize> was not called on this handle, and if "
20723 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
20724 "value for memsize."
20728 #: ../fish/guestfish-actions.pod:1340
20729 msgid "get-network"
20733 #: ../fish/guestfish-actions.pod:1342
20741 #: ../fish/guestfish-actions.pod:1346
20746 #: ../fish/guestfish-actions.pod:1348
20754 #: ../fish/guestfish-actions.pod:1355
20759 #: ../fish/guestfish-actions.pod:1357
20764 #: ../fish/guestfish-actions.pod:1359
20772 #: ../fish/guestfish-actions.pod:1366
20777 #: ../fish/guestfish-actions.pod:1368
20785 #: ../fish/guestfish-actions.pod:1375
20786 msgid "get-recovery-proc"
20790 #: ../fish/guestfish-actions.pod:1377
20793 " get-recovery-proc\n"
20798 #: ../fish/guestfish-actions.pod:1381
20799 msgid "get-selinux"
20803 #: ../fish/guestfish-actions.pod:1383
20811 #: ../fish/guestfish-actions.pod:1385
20813 "This returns the current setting of the selinux flag which is passed to the "
20814 "appliance at boot time. See L</set-selinux>."
20818 #: ../fish/guestfish-actions.pod:1391
20823 #: ../fish/guestfish-actions.pod:1393
20831 #: ../fish/guestfish-actions.pod:1400
20836 #: ../fish/guestfish-actions.pod:1402
20844 #: ../fish/guestfish-actions.pod:1406
20849 #: ../fish/guestfish-actions.pod:1408
20857 #: ../fish/guestfish-actions.pod:1410
20859 "Return the current umask. By default the umask is C<022> unless it has been "
20860 "set by calling L</umask>."
20864 #: ../fish/guestfish-actions.pod:1413
20865 msgid "get-verbose"
20869 #: ../fish/guestfish-actions.pod:1415
20877 #: ../fish/guestfish-actions.pod:1419
20882 #: ../fish/guestfish-actions.pod:1421
20890 #: ../fish/guestfish-actions.pod:1425
20891 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
20895 #: ../fish/guestfish-actions.pod:1428
20900 #: ../fish/guestfish-actions.pod:1430
20903 " getxattrs path\n"
20908 #: ../fish/guestfish-actions.pod:1438
20909 msgid "See also: L</lgetxattrs>, L<attr(5)>."
20913 #: ../fish/guestfish-actions.pod:1440
20914 msgid "glob-expand"
20918 #: ../fish/guestfish-actions.pod:1442
20921 " glob-expand pattern\n"
20926 #: ../fish/guestfish-actions.pod:1455
20931 #: ../fish/guestfish-actions.pod:1457
20934 " grep regex path\n"
20939 #: ../fish/guestfish-actions.pod:1465
20944 #: ../fish/guestfish-actions.pod:1467
20947 " grepi regex path\n"
20952 #: ../fish/guestfish-actions.pod:1475
20953 msgid "grub-install"
20957 #: ../fish/guestfish-actions.pod:1477
20960 " grub-install root device\n"
20965 #: ../fish/guestfish-actions.pod:1493
20970 #: ../fish/guestfish-actions.pod:1495
20978 #: ../fish/guestfish-actions.pod:1503
20983 #: ../fish/guestfish-actions.pod:1505
20986 " head-n nrlines path\n"
20991 #: ../fish/guestfish-actions.pod:1518
20996 #: ../fish/guestfish-actions.pod:1520
21004 #: ../fish/guestfish-actions.pod:1528
21009 #: ../fish/guestfish-actions.pod:1530
21012 " initrd-cat initrdpath filename\n"
21017 #: ../fish/guestfish-actions.pod:1542
21018 msgid "See also L</initrd-list>."
21022 #: ../fish/guestfish-actions.pod:1547
21023 msgid "initrd-list"
21027 #: ../fish/guestfish-actions.pod:1549
21030 " initrd-list path\n"
21035 #: ../fish/guestfish-actions.pod:1561
21036 msgid "inotify-add-watch"
21040 #: ../fish/guestfish-actions.pod:1563
21043 " inotify-add-watch path mask\n"
21048 #: ../fish/guestfish-actions.pod:1575
21049 msgid "inotify-close"
21053 #: ../fish/guestfish-actions.pod:1577
21061 #: ../fish/guestfish-actions.pod:1583
21062 msgid "inotify-files"
21066 #: ../fish/guestfish-actions.pod:1585
21074 #: ../fish/guestfish-actions.pod:1587
21076 "This function is a helpful wrapper around L</inotify-read> which just "
21077 "returns a list of pathnames of objects that were touched. The returned "
21078 "pathnames are sorted and deduplicated."
21082 #: ../fish/guestfish-actions.pod:1591
21083 msgid "inotify-init"
21087 #: ../fish/guestfish-actions.pod:1593
21090 " inotify-init maxevents\n"
21095 #: ../fish/guestfish-actions.pod:1599
21097 "C<maxevents> is the maximum number of events which will be queued up between "
21098 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
21099 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
21100 "default was 16384 events. Beyond this limit, the kernel throws away events, "
21101 "but records the fact that it threw them away by setting a flag "
21102 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
21106 #: ../fish/guestfish-actions.pod:1609
21108 "Before any events are generated, you have to add some watches to the "
21109 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
21110 "L</inotify-watch-all>."
21114 #: ../fish/guestfish-actions.pod:1615
21116 "Queued up events should be read periodically by calling L</inotify-read> (or "
21117 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
21118 "If you don't read the events out often enough then you risk the internal "
21119 "queue overflowing."
21123 #: ../fish/guestfish-actions.pod:1622
21125 "The handle should be closed after use by calling L</inotify-close>. This "
21126 "also removes any watches automatically."
21130 #: ../fish/guestfish-actions.pod:1631
21131 msgid "inotify-read"
21135 #: ../fish/guestfish-actions.pod:1633
21143 #: ../fish/guestfish-actions.pod:1646
21144 msgid "inotify-rm-watch"
21148 #: ../fish/guestfish-actions.pod:1648
21151 " inotify-rm-watch wd\n"
21156 #: ../fish/guestfish-actions.pod:1650
21157 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
21161 #: ../fish/guestfish-actions.pod:1653
21162 msgid "inspect-get-arch"
21166 #: ../fish/guestfish-actions.pod:1655
21169 " inspect-get-arch root\n"
21174 #: ../fish/guestfish-actions.pod:1657 ../fish/guestfish-actions.pod:1673
21175 #: ../fish/guestfish-actions.pod:1747 ../fish/guestfish-actions.pod:1765
21176 #: ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1801
21177 #: ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1839
21178 #: ../fish/guestfish-actions.pod:1861 ../fish/guestfish-actions.pod:1885
21179 #: ../fish/guestfish-actions.pod:1915 ../fish/guestfish-actions.pod:1950
21180 #: ../fish/guestfish-actions.pod:1966
21182 "This function should only be called with a root device string as returned by "
21187 #: ../fish/guestfish-actions.pod:1660
21189 "This returns the architecture of the inspected operating system. The "
21190 "possible return values are listed under L</file-architecture>."
21194 #: ../fish/guestfish-actions.pod:1669
21195 msgid "inspect-get-distro"
21199 #: ../fish/guestfish-actions.pod:1671
21202 " inspect-get-distro root\n"
21207 #: ../fish/guestfish-actions.pod:1743
21208 msgid "inspect-get-filesystems"
21212 #: ../fish/guestfish-actions.pod:1745
21215 " inspect-get-filesystems root\n"
21220 #: ../fish/guestfish-actions.pod:1758
21222 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21223 "get-mountpoints>."
21227 #: ../fish/guestfish-actions.pod:1761
21228 msgid "inspect-get-hostname"
21232 #: ../fish/guestfish-actions.pod:1763
21235 " inspect-get-hostname root\n"
21240 #: ../fish/guestfish-actions.pod:1776
21241 msgid "inspect-get-major-version"
21245 #: ../fish/guestfish-actions.pod:1778
21248 " inspect-get-major-version root\n"
21253 #: ../fish/guestfish-actions.pod:1797
21254 msgid "inspect-get-minor-version"
21258 #: ../fish/guestfish-actions.pod:1799
21261 " inspect-get-minor-version root\n"
21266 #: ../fish/guestfish-actions.pod:1809
21268 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21269 "get-major-version>."
21273 #: ../fish/guestfish-actions.pod:1812
21274 msgid "inspect-get-mountpoints"
21278 #: ../fish/guestfish-actions.pod:1814
21281 " inspect-get-mountpoints root\n"
21286 #: ../fish/guestfish-actions.pod:1832
21288 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21289 "get-filesystems>."
21293 #: ../fish/guestfish-actions.pod:1835
21294 msgid "inspect-get-package-format"
21298 #: ../fish/guestfish-actions.pod:1837
21301 " inspect-get-package-format root\n"
21306 #: ../fish/guestfish-actions.pod:1842
21308 "This function and L</inspect-get-package-management> return the package "
21309 "format and package management tool used by the inspected operating system. "
21310 "For example for Fedora these functions would return C<rpm> (package format) "
21311 "and C<yum> (package management)."
21315 #: ../fish/guestfish-actions.pod:1857
21316 msgid "inspect-get-package-management"
21320 #: ../fish/guestfish-actions.pod:1859
21323 " inspect-get-package-management root\n"
21328 #: ../fish/guestfish-actions.pod:1864
21330 "L</inspect-get-package-format> and this function return the package format "
21331 "and package management tool used by the inspected operating system. For "
21332 "example for Fedora these functions would return C<rpm> (package format) and "
21333 "C<yum> (package management)."
21337 #: ../fish/guestfish-actions.pod:1881
21338 msgid "inspect-get-product-name"
21342 #: ../fish/guestfish-actions.pod:1883
21345 " inspect-get-product-name root\n"
21350 #: ../fish/guestfish-actions.pod:1898
21351 msgid "inspect-get-roots"
21355 #: ../fish/guestfish-actions.pod:1900
21358 " inspect-get-roots\n"
21363 #: ../fish/guestfish-actions.pod:1902
21365 "This function is a convenient way to get the list of root devices, as "
21366 "returned from a previous call to L</inspect-os>, but without redoing the "
21367 "whole inspection process."
21371 #: ../fish/guestfish-actions.pod:1906
21373 "This returns an empty list if either no root devices were found or the "
21374 "caller has not called L</inspect-os>."
21378 #: ../fish/guestfish-actions.pod:1911
21379 msgid "inspect-get-type"
21383 #: ../fish/guestfish-actions.pod:1913
21386 " inspect-get-type root\n"
21391 #: ../fish/guestfish-actions.pod:1946
21392 msgid "inspect-get-windows-systemroot"
21396 #: ../fish/guestfish-actions.pod:1948
21399 " inspect-get-windows-systemroot root\n"
21404 #: ../fish/guestfish-actions.pod:1962
21405 msgid "inspect-list-applications"
21409 #: ../fish/guestfish-actions.pod:1964
21412 " inspect-list-applications root\n"
21417 #: ../fish/guestfish-actions.pod:1971
21419 "I<Note:> This call works differently from other parts of the inspection "
21420 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
21421 "then mount up the disks, before calling this. Listing applications is a "
21422 "significantly more difficult operation which requires access to the full "
21423 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
21424 "are just returning data cached in the libguestfs handle, this call actually "
21425 "reads parts of the mounted filesystems during the call."
21429 #: ../fish/guestfish-actions.pod:2061
21434 #: ../fish/guestfish-actions.pod:2063
21442 #: ../fish/guestfish-actions.pod:2078
21444 "You can pass the root string(s) returned to other L</inspect-get-*> "
21445 "functions in order to query further information about each operating system, "
21446 "such as the name and version."
21450 #: ../fish/guestfish-actions.pod:2083
21452 "This function uses other libguestfs features such as L</mount-ro> and L</"
21453 "umount-all> in order to mount and unmount filesystems and look at the "
21454 "contents. This should be called with no disks currently mounted. The "
21455 "function may also use Augeas, so any existing Augeas handle will be closed."
21459 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2251
21460 #: ../fish/guestfish-actions.pod:2297
21461 msgid "See also L</list-filesystems>."
21465 #: ../fish/guestfish-actions.pod:2097
21466 msgid "is-blockdev"
21470 #: ../fish/guestfish-actions.pod:2099
21473 " is-blockdev path\n"
21478 #: ../fish/guestfish-actions.pod:2104 ../fish/guestfish-actions.pod:2122
21479 #: ../fish/guestfish-actions.pod:2141 ../fish/guestfish-actions.pod:2150
21480 #: ../fish/guestfish-actions.pod:2160 ../fish/guestfish-actions.pod:2194
21481 #: ../fish/guestfish-actions.pod:2203
21482 msgid "See also L</stat>."
21486 #: ../fish/guestfish-actions.pod:2106
21491 #: ../fish/guestfish-actions.pod:2108
21499 #: ../fish/guestfish-actions.pod:2115
21504 #: ../fish/guestfish-actions.pod:2117
21507 " is-chardev path\n"
21512 #: ../fish/guestfish-actions.pod:2124
21517 #: ../fish/guestfish-actions.pod:2126
21525 #: ../fish/guestfish-actions.pod:2133
21530 #: ../fish/guestfish-actions.pod:2135
21538 #: ../fish/guestfish-actions.pod:2143
21543 #: ../fish/guestfish-actions.pod:2145
21551 #: ../fish/guestfish-actions.pod:2152
21556 #: ../fish/guestfish-actions.pod:2154
21564 #: ../fish/guestfish-actions.pod:2162
21565 msgid "is-launching"
21569 #: ../fish/guestfish-actions.pod:2164
21577 #: ../fish/guestfish-actions.pod:2171
21582 #: ../fish/guestfish-actions.pod:2173
21590 #: ../fish/guestfish-actions.pod:2178
21595 #: ../fish/guestfish-actions.pod:2180
21603 #: ../fish/guestfish-actions.pod:2187
21608 #: ../fish/guestfish-actions.pod:2189
21611 " is-socket path\n"
21616 #: ../fish/guestfish-actions.pod:2196
21621 #: ../fish/guestfish-actions.pod:2198
21624 " is-symlink path\n"
21629 #: ../fish/guestfish-actions.pod:2205
21630 msgid "kill-subprocess"
21634 #: ../fish/guestfish-actions.pod:2207
21637 " kill-subprocess\n"
21642 #: ../fish/guestfish-actions.pod:2211
21647 #: ../fish/guestfish-actions.pod:2213
21652 #: ../fish/guestfish-actions.pod:2215
21660 #: ../fish/guestfish-actions.pod:2223
21665 #: ../fish/guestfish-actions.pod:2225
21668 " lchown owner group path\n"
21673 #: ../fish/guestfish-actions.pod:2227
21675 "Change the file owner to C<owner> and group to C<group>. This is like L</"
21676 "chown> but if C<path> is a symlink then the link itself is changed, not the "
21681 #: ../fish/guestfish-actions.pod:2235
21686 #: ../fish/guestfish-actions.pod:2237
21689 " lgetxattrs path\n"
21694 #: ../fish/guestfish-actions.pod:2239
21696 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
21697 "it returns the extended attributes of the link itself."
21701 #: ../fish/guestfish-actions.pod:2243
21702 msgid "list-devices"
21706 #: ../fish/guestfish-actions.pod:2245
21714 #: ../fish/guestfish-actions.pod:2253
21715 msgid "list-filesystems"
21719 #: ../fish/guestfish-actions.pod:2255
21722 " list-filesystems\n"
21727 #: ../fish/guestfish-actions.pod:2274
21729 "This command runs other libguestfs commands, which might include L</mount> "
21730 "and L</umount>, and therefore you should use this soon after launch and only "
21731 "when nothing is mounted."
21735 #: ../fish/guestfish-actions.pod:2278
21737 "Not all of the filesystems returned will be mountable. In particular, swap "
21738 "partitions are returned in the list. Also this command does not check that "
21739 "each filesystem found is valid and mountable, and some filesystems might be "
21740 "mountable but require special options. Filesystems may not all belong to a "
21741 "single logical operating system (use L</inspect-os> to look for OSes)."
21745 #: ../fish/guestfish-actions.pod:2286
21746 msgid "list-partitions"
21750 #: ../fish/guestfish-actions.pod:2288
21753 " list-partitions\n"
21758 #: ../fish/guestfish-actions.pod:2294
21760 "This does not return logical volumes. For that you will need to call L</"
21765 #: ../fish/guestfish-actions.pod:2299
21770 #: ../fish/guestfish-actions.pod:2301
21778 #: ../fish/guestfish-actions.pod:2309
21783 #: ../fish/guestfish-actions.pod:2311
21786 " ln target linkname\n"
21791 #: ../fish/guestfish-actions.pod:2315
21796 #: ../fish/guestfish-actions.pod:2317
21799 " ln-f target linkname\n"
21804 #: ../fish/guestfish-actions.pod:2322
21809 #: ../fish/guestfish-actions.pod:2324
21812 " ln-s target linkname\n"
21817 #: ../fish/guestfish-actions.pod:2328
21822 #: ../fish/guestfish-actions.pod:2330
21825 " ln-sf target linkname\n"
21830 #: ../fish/guestfish-actions.pod:2335
21831 msgid "lremovexattr"
21835 #: ../fish/guestfish-actions.pod:2337
21838 " lremovexattr xattr path\n"
21843 #: ../fish/guestfish-actions.pod:2339
21845 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
21846 "it removes an extended attribute of the link itself."
21850 #: ../fish/guestfish-actions.pod:2343
21855 #: ../fish/guestfish-actions.pod:2345
21863 #: ../fish/guestfish-actions.pod:2351
21865 "This command is mostly useful for interactive sessions. Programs should "
21866 "probably use L</readdir> instead."
21870 #: ../fish/guestfish-actions.pod:2354
21875 #: ../fish/guestfish-actions.pod:2356
21878 " lsetxattr xattr val vallen path\n"
21883 #: ../fish/guestfish-actions.pod:2358
21885 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
21886 "sets an extended attribute of the link itself."
21890 #: ../fish/guestfish-actions.pod:2362
21895 #: ../fish/guestfish-actions.pod:2364
21903 #: ../fish/guestfish-actions.pod:2368
21905 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
21906 "the link is stat-ed, not the file it refers to."
21910 #: ../fish/guestfish-actions.pod:2374
21915 #: ../fish/guestfish-actions.pod:2376
21918 " lstatlist path 'names ...'\n"
21923 #: ../fish/guestfish-actions.pod:2378
21925 "This call allows you to perform the L</lstat> operation on multiple files, "
21926 "where all files are in the directory C<path>. C<names> is the list of files "
21927 "from this directory."
21931 #: ../fish/guestfish-actions.pod:2387
21933 "This call is intended for programs that want to efficiently list a directory "
21934 "contents without making many round-trips. See also L</lxattrlist> for a "
21935 "similarly efficient call for getting extended attributes. Very long "
21936 "directory listings might cause the protocol message size to be exceeded, "
21937 "causing this call to fail. The caller must split up such requests into "
21938 "smaller groups of names."
21942 #: ../fish/guestfish-actions.pod:2395
21943 msgid "luks-add-key"
21947 #: ../fish/guestfish-actions.pod:2397
21950 " luks-add-key device keyslot\n"
21955 #: ../fish/guestfish-actions.pod:2404
21957 "Note that if C<keyslot> already contains a key, then this command will "
21958 "fail. You have to use L</luks-kill-slot> first to remove that key."
21962 #: ../fish/guestfish-actions.pod:2408 ../fish/guestfish-actions.pod:2430
21963 #: ../fish/guestfish-actions.pod:2443 ../fish/guestfish-actions.pod:2457
21964 #: ../fish/guestfish-actions.pod:2480 ../fish/guestfish-actions.pod:2490
21966 "This command has one or more key or passphrase parameters. Guestfish will "
21967 "prompt for these separately."
21971 #: ../fish/guestfish-actions.pod:2411
21976 #: ../fish/guestfish-actions.pod:2413
21979 " luks-close device\n"
21984 #: ../fish/guestfish-actions.pod:2415
21986 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
21987 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
21988 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
21993 #: ../fish/guestfish-actions.pod:2421
21994 msgid "luks-format"
21998 #: ../fish/guestfish-actions.pod:2423
22001 " luks-format device keyslot\n"
22006 #: ../fish/guestfish-actions.pod:2436
22007 msgid "luks-format-cipher"
22011 #: ../fish/guestfish-actions.pod:2438
22014 " luks-format-cipher device keyslot cipher\n"
22019 #: ../fish/guestfish-actions.pod:2440
22021 "This command is the same as L</luks-format> but it also allows you to set "
22022 "the C<cipher> used."
22026 #: ../fish/guestfish-actions.pod:2449
22027 msgid "luks-kill-slot"
22031 #: ../fish/guestfish-actions.pod:2451
22034 " luks-kill-slot device keyslot\n"
22039 #: ../fish/guestfish-actions.pod:2460
22044 #: ../fish/guestfish-actions.pod:2462
22047 " luks-open device mapname\n"
22052 #: ../fish/guestfish-actions.pod:2476
22054 "If this block device contains LVM volume groups, then calling L</vgscan> "
22055 "followed by L</vg-activate-all> will make them visible."
22059 #: ../fish/guestfish-actions.pod:2483
22060 msgid "luks-open-ro"
22064 #: ../fish/guestfish-actions.pod:2485
22067 " luks-open-ro device mapname\n"
22072 #: ../fish/guestfish-actions.pod:2487
22074 "This is the same as L</luks-open> except that a read-only mapping is created."
22078 #: ../fish/guestfish-actions.pod:2493
22083 #: ../fish/guestfish-actions.pod:2495
22086 " lvcreate logvol volgroup mbytes\n"
22091 #: ../fish/guestfish-actions.pod:2500
22092 msgid "lvm-canonical-lv-name"
22096 #: ../fish/guestfish-actions.pod:2502
22099 " lvm-canonical-lv-name lvname\n"
22104 #: ../fish/guestfish-actions.pod:2511
22105 msgid "See also L</is-lv>."
22109 #: ../fish/guestfish-actions.pod:2513
22110 msgid "lvm-clear-filter"
22114 #: ../fish/guestfish-actions.pod:2515
22117 " lvm-clear-filter\n"
22122 #: ../fish/guestfish-actions.pod:2517
22124 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
22129 #: ../fish/guestfish-actions.pod:2523
22130 msgid "lvm-remove-all"
22134 #: ../fish/guestfish-actions.pod:2525
22137 " lvm-remove-all\n"
22142 #: ../fish/guestfish-actions.pod:2533
22143 msgid "lvm-set-filter"
22147 #: ../fish/guestfish-actions.pod:2535
22150 " lvm-set-filter 'devices ...'\n"
22155 #: ../fish/guestfish-actions.pod:2560
22160 #: ../fish/guestfish-actions.pod:2562
22163 " lvremove device\n"
22168 #: ../fish/guestfish-actions.pod:2570
22173 #: ../fish/guestfish-actions.pod:2572
22176 " lvrename logvol newlogvol\n"
22181 #: ../fish/guestfish-actions.pod:2576
22186 #: ../fish/guestfish-actions.pod:2578
22189 " lvresize device mbytes\n"
22194 #: ../fish/guestfish-actions.pod:2584
22195 msgid "lvresize-free"
22199 #: ../fish/guestfish-actions.pod:2586
22202 " lvresize-free lv percent\n"
22207 #: ../fish/guestfish-actions.pod:2594
22212 #: ../fish/guestfish-actions.pod:2596
22220 #: ../fish/guestfish-actions.pod:2604
22221 msgid "See also L</lvs-full>, L</list-filesystems>."
22225 #: ../fish/guestfish-actions.pod:2606
22230 #: ../fish/guestfish-actions.pod:2608
22238 #: ../fish/guestfish-actions.pod:2613
22243 #: ../fish/guestfish-actions.pod:2615
22251 #: ../fish/guestfish-actions.pod:2619
22256 #: ../fish/guestfish-actions.pod:2621
22259 " lxattrlist path 'names ...'\n"
22264 #: ../fish/guestfish-actions.pod:2637
22266 "This call is intended for programs that want to efficiently list a directory "
22267 "contents without making many round-trips. See also L</lstatlist> for a "
22268 "similarly efficient call for getting standard stats. Very long directory "
22269 "listings might cause the protocol message size to be exceeded, causing this "
22270 "call to fail. The caller must split up such requests into smaller groups of "
22275 #: ../fish/guestfish-actions.pod:2645
22280 #: ../fish/guestfish-actions.pod:2647
22288 #: ../fish/guestfish-actions.pod:2651
22293 #: ../fish/guestfish-actions.pod:2653
22296 " mkdir-mode path mode\n"
22301 #: ../fish/guestfish-actions.pod:2662
22302 msgid "See also L</mkdir>, L</umask>"
22306 #: ../fish/guestfish-actions.pod:2664
22311 #: ../fish/guestfish-actions.pod:2666
22319 #: ../fish/guestfish-actions.pod:2671
22324 #: ../fish/guestfish-actions.pod:2673
22327 " mkdtemp template\n"
22332 #: ../fish/guestfish-actions.pod:2694
22337 #: ../fish/guestfish-actions.pod:2696
22340 " mke2fs-J fstype blocksize device journal\n"
22345 #: ../fish/guestfish-actions.pod:2704
22346 msgid "See also L</mke2journal>."
22350 #: ../fish/guestfish-actions.pod:2706
22355 #: ../fish/guestfish-actions.pod:2708
22358 " mke2fs-JL fstype blocksize device label\n"
22363 #: ../fish/guestfish-actions.pod:2713
22364 msgid "See also L</mke2journal-L>."
22368 #: ../fish/guestfish-actions.pod:2715
22373 #: ../fish/guestfish-actions.pod:2717
22376 " mke2fs-JU fstype blocksize device uuid\n"
22381 #: ../fish/guestfish-actions.pod:2722
22382 msgid "See also L</mke2journal-U>."
22386 #: ../fish/guestfish-actions.pod:2724
22387 msgid "mke2journal"
22391 #: ../fish/guestfish-actions.pod:2726
22394 " mke2journal blocksize device\n"
22399 #: ../fish/guestfish-actions.pod:2733
22400 msgid "mke2journal-L"
22404 #: ../fish/guestfish-actions.pod:2735
22407 " mke2journal-L blocksize label device\n"
22412 #: ../fish/guestfish-actions.pod:2739
22413 msgid "mke2journal-U"
22417 #: ../fish/guestfish-actions.pod:2741
22420 " mke2journal-U blocksize uuid device\n"
22425 #: ../fish/guestfish-actions.pod:2745
22430 #: ../fish/guestfish-actions.pod:2747
22433 " mkfifo mode path\n"
22438 #: ../fish/guestfish-actions.pod:2749
22440 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
22441 "is just a convenient wrapper around L</mknod>."
22445 #: ../fish/guestfish-actions.pod:2755
22450 #: ../fish/guestfish-actions.pod:2757
22453 " mkfs fstype device\n"
22458 #: ../fish/guestfish-actions.pod:2763
22463 #: ../fish/guestfish-actions.pod:2765
22466 " mkfs-b fstype blocksize device\n"
22471 #: ../fish/guestfish-actions.pod:2767
22473 "This call is similar to L</mkfs>, but it allows you to control the block "
22474 "size of the resulting filesystem. Supported block sizes depend on the "
22475 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
22479 #: ../fish/guestfish-actions.pod:2775
22480 msgid "mkmountpoint"
22484 #: ../fish/guestfish-actions.pod:2777
22487 " mkmountpoint exemptpath\n"
22492 #: ../fish/guestfish-actions.pod:2779
22494 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
22495 "to create extra mountpoints before mounting the first filesystem."
22499 #: ../fish/guestfish-actions.pod:2803
22501 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
22502 "unexpected errors if you try to mix these calls. It is safest to manually "
22503 "unmount filesystems and remove mountpoints after use."
22507 #: ../fish/guestfish-actions.pod:2807
22509 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
22510 "for this to work for manual mountpoints, you must ensure that the innermost "
22511 "mountpoints have the longest pathnames, as in the example code above."
22515 #: ../fish/guestfish-actions.pod:2814
22517 "Autosync [see L</set-autosync>, this is set by default on handles] means "
22518 "that L</umount-all> is called when the handle is closed which can also "
22519 "trigger these issues."
22523 #: ../fish/guestfish-actions.pod:2818
22528 #: ../fish/guestfish-actions.pod:2820
22531 " mknod mode devmajor devminor path\n"
22536 #: ../fish/guestfish-actions.pod:2830
22538 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
22539 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
22540 "regular file). These constants are available in the standard Linux header "
22541 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
22542 "wrappers around this command which bitwise OR in the appropriate constant "
22547 #: ../fish/guestfish-actions.pod:2840
22552 #: ../fish/guestfish-actions.pod:2842
22555 " mknod-b mode devmajor devminor path\n"
22560 #: ../fish/guestfish-actions.pod:2844
22562 "This call creates a block device node called C<path> with mode C<mode> and "
22563 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22564 "wrapper around L</mknod>."
22568 #: ../fish/guestfish-actions.pod:2850
22573 #: ../fish/guestfish-actions.pod:2852
22576 " mknod-c mode devmajor devminor path\n"
22581 #: ../fish/guestfish-actions.pod:2854
22583 "This call creates a char device node called C<path> with mode C<mode> and "
22584 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22585 "wrapper around L</mknod>."
22589 #: ../fish/guestfish-actions.pod:2860
22594 #: ../fish/guestfish-actions.pod:2862
22602 #: ../fish/guestfish-actions.pod:2866
22607 #: ../fish/guestfish-actions.pod:2868
22610 " mkswap-L label device\n"
22615 #: ../fish/guestfish-actions.pod:2876
22620 #: ../fish/guestfish-actions.pod:2878
22623 " mkswap-U uuid device\n"
22628 #: ../fish/guestfish-actions.pod:2882
22629 msgid "mkswap-file"
22633 #: ../fish/guestfish-actions.pod:2884
22636 " mkswap-file path\n"
22641 #: ../fish/guestfish-actions.pod:2888
22643 "This command just writes a swap file signature to an existing file. To "
22644 "create the file itself, use something like L</fallocate>."
22648 #: ../fish/guestfish-actions.pod:2891
22653 #: ../fish/guestfish-actions.pod:2893
22656 " modprobe modulename\n"
22661 #: ../fish/guestfish-actions.pod:2900
22666 #: ../fish/guestfish-actions.pod:2902
22669 " mount device mountpoint\n"
22674 #: ../fish/guestfish-actions.pod:2918
22676 "B<Important note:> When you use this call, the filesystem options C<sync> "
22677 "and C<noatime> are set implicitly. This was originally done because we "
22678 "thought it would improve reliability, but it turns out that I<-o sync> has a "
22679 "very large negative performance impact and negligible effect on "
22680 "reliability. Therefore we recommend that you avoid using L</mount> in any "
22681 "code that needs performance, and instead use L</mount-options> (use an empty "
22682 "string for the first parameter if you don't want any options)."
22686 #: ../fish/guestfish-actions.pod:2928
22691 #: ../fish/guestfish-actions.pod:2930
22694 " mount-loop file mountpoint\n"
22699 #: ../fish/guestfish-actions.pod:2936
22700 msgid "mount-options"
22704 #: ../fish/guestfish-actions.pod:2938
22707 " mount-options options device mountpoint\n"
22712 #: ../fish/guestfish-actions.pod:2940
22714 "This is the same as the L</mount> command, but it allows you to set the "
22715 "mount options as for the L<mount(8)> I<-o> flag."
22719 #: ../fish/guestfish-actions.pod:2948
22724 #: ../fish/guestfish-actions.pod:2950
22727 " mount-ro device mountpoint\n"
22732 #: ../fish/guestfish-actions.pod:2952
22734 "This is the same as the L</mount> command, but it mounts the filesystem with "
22735 "the read-only (I<-o ro>) flag."
22739 #: ../fish/guestfish-actions.pod:2955
22744 #: ../fish/guestfish-actions.pod:2957
22747 " mount-vfs options vfstype device mountpoint\n"
22752 #: ../fish/guestfish-actions.pod:2959
22754 "This is the same as the L</mount> command, but it allows you to set both the "
22755 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
22759 #: ../fish/guestfish-actions.pod:2963
22760 msgid "mountpoints"
22764 #: ../fish/guestfish-actions.pod:2965
22772 #: ../fish/guestfish-actions.pod:2967
22774 "This call is similar to L</mounts>. That call returns a list of devices. "
22775 "This one returns a hash table (map) of device name to directory where the "
22776 "device is mounted."
22780 #: ../fish/guestfish-actions.pod:2971
22785 #: ../fish/guestfish-actions.pod:2973
22793 #: ../fish/guestfish-actions.pod:2980
22794 msgid "See also: L</mountpoints>"
22798 #: ../fish/guestfish-actions.pod:2982
22803 #: ../fish/guestfish-actions.pod:2984
22811 #: ../fish/guestfish-actions.pod:2989
22812 msgid "ntfs-3g-probe"
22816 #: ../fish/guestfish-actions.pod:2991
22819 " ntfs-3g-probe true|false device\n"
22824 #: ../fish/guestfish-actions.pod:3005
22829 #: ../fish/guestfish-actions.pod:3007
22832 " ntfsresize device\n"
22837 #: ../fish/guestfish-actions.pod:3013
22838 msgid "ntfsresize-size"
22842 #: ../fish/guestfish-actions.pod:3015
22845 " ntfsresize-size device size\n"
22850 #: ../fish/guestfish-actions.pod:3017
22852 "This command is the same as L</ntfsresize> except that it allows you to "
22853 "specify the new size (in bytes) explicitly."
22857 #: ../fish/guestfish-actions.pod:3020
22862 #: ../fish/guestfish-actions.pod:3022
22865 " part-add device prlogex startsect endsect\n"
22870 #: ../fish/guestfish-actions.pod:3024
22872 "This command adds a partition to C<device>. If there is no partition table "
22873 "on the device, call L</part-init> first."
22877 #: ../fish/guestfish-actions.pod:3036
22879 "Creating a partition which covers the whole disk is not so easy. Use L</"
22880 "part-disk> to do that."
22884 #: ../fish/guestfish-actions.pod:3039
22889 #: ../fish/guestfish-actions.pod:3041
22892 " part-del device partnum\n"
22897 #: ../fish/guestfish-actions.pod:3049
22902 #: ../fish/guestfish-actions.pod:3051
22905 " part-disk device parttype\n"
22910 #: ../fish/guestfish-actions.pod:3053
22912 "This command is simply a combination of L</part-init> followed by L</part-"
22913 "add> to create a single primary partition covering the whole disk."
22917 #: ../fish/guestfish-actions.pod:3057
22919 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
22920 "possible values are described in L</part-init>."
22924 #: ../fish/guestfish-actions.pod:3063
22925 msgid "part-get-bootable"
22929 #: ../fish/guestfish-actions.pod:3065
22932 " part-get-bootable device partnum\n"
22937 #: ../fish/guestfish-actions.pod:3070
22938 msgid "See also L</part-set-bootable>."
22942 #: ../fish/guestfish-actions.pod:3072
22943 msgid "part-get-mbr-id"
22947 #: ../fish/guestfish-actions.pod:3074
22950 " part-get-mbr-id device partnum\n"
22955 #: ../fish/guestfish-actions.pod:3079 ../fish/guestfish-actions.pod:3217
22957 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
22958 "undefined results for other partition table types (see L</part-get-"
22963 #: ../fish/guestfish-actions.pod:3083
22964 msgid "part-get-parttype"
22968 #: ../fish/guestfish-actions.pod:3085
22971 " part-get-parttype device\n"
22976 #: ../fish/guestfish-actions.pod:3090
22978 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
22979 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
22980 "possible, although unusual. See L</part-init> for a full list."
22984 #: ../fish/guestfish-actions.pod:3095
22989 #: ../fish/guestfish-actions.pod:3097
22992 " part-init device parttype\n"
22997 #: ../fish/guestfish-actions.pod:3103
22999 "Initially there are no partitions. Following this, you should call L</part-"
23000 "add> for each partition required."
23004 #: ../fish/guestfish-actions.pod:3166
23009 #: ../fish/guestfish-actions.pod:3168
23012 " part-list device\n"
23017 #: ../fish/guestfish-actions.pod:3183
23019 "Start of the partition I<in bytes>. To get sectors you have to divide by "
23020 "the device's sector size, see L</blockdev-getss>."
23024 #: ../fish/guestfish-actions.pod:3196
23025 msgid "part-set-bootable"
23029 #: ../fish/guestfish-actions.pod:3198
23032 " part-set-bootable device partnum true|false\n"
23037 #: ../fish/guestfish-actions.pod:3207
23038 msgid "part-set-mbr-id"
23042 #: ../fish/guestfish-actions.pod:3209
23045 " part-set-mbr-id device partnum idbyte\n"
23050 #: ../fish/guestfish-actions.pod:3221
23051 msgid "part-set-name"
23055 #: ../fish/guestfish-actions.pod:3223
23058 " part-set-name device partnum name\n"
23063 #: ../fish/guestfish-actions.pod:3231
23064 msgid "part-to-dev"
23068 #: ../fish/guestfish-actions.pod:3233
23071 " part-to-dev partition\n"
23076 #: ../fish/guestfish-actions.pod:3239
23078 "The named partition must exist, for example as a string returned from L</"
23079 "list-partitions>."
23083 #: ../fish/guestfish-actions.pod:3242
23084 msgid "ping-daemon"
23088 #: ../fish/guestfish-actions.pod:3244
23096 #: ../fish/guestfish-actions.pod:3251
23101 #: ../fish/guestfish-actions.pod:3253
23104 " pread path count offset\n"
23109 #: ../fish/guestfish-actions.pod:3261
23110 msgid "See also L</pwrite>, L</pread-device>."
23114 #: ../fish/guestfish-actions.pod:3266
23115 msgid "pread-device"
23119 #: ../fish/guestfish-actions.pod:3268
23122 " pread-device device count offset\n"
23127 #: ../fish/guestfish-actions.pod:3276
23128 msgid "See also L</pread>."
23132 #: ../fish/guestfish-actions.pod:3281
23137 #: ../fish/guestfish-actions.pod:3283
23140 " pvcreate device\n"
23145 #: ../fish/guestfish-actions.pod:3289
23150 #: ../fish/guestfish-actions.pod:3291
23153 " pvremove device\n"
23158 #: ../fish/guestfish-actions.pod:3300
23163 #: ../fish/guestfish-actions.pod:3302
23166 " pvresize device\n"
23171 #: ../fish/guestfish-actions.pod:3307
23172 msgid "pvresize-size"
23176 #: ../fish/guestfish-actions.pod:3309
23179 " pvresize-size device size\n"
23184 #: ../fish/guestfish-actions.pod:3311
23186 "This command is the same as L</pvresize> except that it allows you to "
23187 "specify the new size (in bytes) explicitly."
23191 #: ../fish/guestfish-actions.pod:3314
23196 #: ../fish/guestfish-actions.pod:3316
23204 #: ../fish/guestfish-actions.pod:3324
23205 msgid "See also L</pvs-full>."
23209 #: ../fish/guestfish-actions.pod:3326
23214 #: ../fish/guestfish-actions.pod:3328
23222 #: ../fish/guestfish-actions.pod:3333
23227 #: ../fish/guestfish-actions.pod:3335
23235 #: ../fish/guestfish-actions.pod:3339
23240 #: ../fish/guestfish-actions.pod:3341
23243 " pwrite path content offset\n"
23248 #: ../fish/guestfish-actions.pod:3352
23249 msgid "See also L</pread>, L</pwrite-device>."
23253 #: ../fish/guestfish-actions.pod:3357
23254 msgid "pwrite-device"
23258 #: ../fish/guestfish-actions.pod:3359
23261 " pwrite-device device content offset\n"
23266 #: ../fish/guestfish-actions.pod:3369
23267 msgid "See also L</pwrite>."
23271 #: ../fish/guestfish-actions.pod:3374
23276 #: ../fish/guestfish-actions.pod:3376
23279 " read-file path\n"
23284 #: ../fish/guestfish-actions.pod:3381
23286 "Unlike L</cat>, this function can correctly handle files that contain "
23287 "embedded ASCII NUL characters. However unlike L</download>, this function "
23288 "is limited in the total size of file that can be handled."
23292 #: ../fish/guestfish-actions.pod:3389
23297 #: ../fish/guestfish-actions.pod:3391
23300 " read-lines path\n"
23305 #: ../fish/guestfish-actions.pod:3398
23307 "Note that this function cannot correctly handle binary files (specifically, "
23308 "files containing C<\\0> character which is treated as end of line). For "
23309 "those you need to use the L</read-file> function which has a more complex "
23314 #: ../fish/guestfish-actions.pod:3403
23319 #: ../fish/guestfish-actions.pod:3405
23327 #: ../fish/guestfish-actions.pod:3457
23329 "This function is primarily intended for use by programs. To get a simple "
23330 "list of names, use L</ls>. To get a printable directory for human "
23331 "consumption, use L</ll>."
23335 #: ../fish/guestfish-actions.pod:3461
23340 #: ../fish/guestfish-actions.pod:3463
23348 #: ../fish/guestfish-actions.pod:3467
23349 msgid "readlinklist"
23353 #: ../fish/guestfish-actions.pod:3469
23356 " readlinklist path 'names ...'\n"
23361 #: ../fish/guestfish-actions.pod:3493
23366 #: ../fish/guestfish-actions.pod:3495
23374 #: ../fish/guestfish-actions.pod:3500
23375 msgid "removexattr"
23379 #: ../fish/guestfish-actions.pod:3502
23382 " removexattr xattr path\n"
23387 #: ../fish/guestfish-actions.pod:3507
23388 msgid "See also: L</lremovexattr>, L<attr(5)>."
23392 #: ../fish/guestfish-actions.pod:3509
23397 #: ../fish/guestfish-actions.pod:3511
23400 " resize2fs device\n"
23405 #: ../fish/guestfish-actions.pod:3516
23407 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
23408 "before calling this command. For unknown reasons C<resize2fs> sometimes "
23409 "gives an error about this and sometimes not. In any case, it is always safe "
23410 "to call L</e2fsck-f> before calling this function."
23414 #: ../fish/guestfish-actions.pod:3522
23415 msgid "resize2fs-size"
23419 #: ../fish/guestfish-actions.pod:3524
23422 " resize2fs-size device size\n"
23427 #: ../fish/guestfish-actions.pod:3526
23429 "This command is the same as L</resize2fs> except that it allows you to "
23430 "specify the new size (in bytes) explicitly."
23434 #: ../fish/guestfish-actions.pod:3529
23439 #: ../fish/guestfish-actions.pod:3531
23447 #: ../fish/guestfish-actions.pod:3535
23452 #: ../fish/guestfish-actions.pod:3537
23460 #: ../fish/guestfish-actions.pod:3543
23465 #: ../fish/guestfish-actions.pod:3545
23473 #: ../fish/guestfish-actions.pod:3549
23474 msgid "rmmountpoint"
23478 #: ../fish/guestfish-actions.pod:3551
23481 " rmmountpoint exemptpath\n"
23486 #: ../fish/guestfish-actions.pod:3553
23488 "This calls removes a mountpoint that was previously created with L</"
23489 "mkmountpoint>. See L</mkmountpoint> for full details."
23493 #: ../fish/guestfish-actions.pod:3557
23494 msgid "scrub-device"
23498 #: ../fish/guestfish-actions.pod:3559
23501 " scrub-device device\n"
23506 #: ../fish/guestfish-actions.pod:3570
23511 #: ../fish/guestfish-actions.pod:3572
23514 " scrub-file file\n"
23519 #: ../fish/guestfish-actions.pod:3582
23520 msgid "scrub-freespace"
23524 #: ../fish/guestfish-actions.pod:3584
23527 " scrub-freespace dir\n"
23532 #: ../fish/guestfish-actions.pod:3586
23534 "This command creates the directory C<dir> and then fills it with files until "
23535 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
23536 "deletes them. The intention is to scrub any free space on the partition "
23537 "containing C<dir>."
23541 #: ../fish/guestfish-actions.pod:3595
23546 #: ../fish/guestfish-actions.pod:3597
23551 #: ../fish/guestfish-actions.pod:3599
23554 " set-append append\n"
23559 #: ../fish/guestfish-actions.pod:3610
23560 msgid "set-autosync"
23564 #: ../fish/guestfish-actions.pod:3612
23569 #: ../fish/guestfish-actions.pod:3614
23572 " set-autosync true|false\n"
23577 #: ../fish/guestfish-actions.pod:3616
23579 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
23580 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
23581 "closed (also if the program exits without closing handles)."
23585 #: ../fish/guestfish-actions.pod:3624
23590 #: ../fish/guestfish-actions.pod:3626
23595 #: ../fish/guestfish-actions.pod:3628
23598 " set-direct true|false\n"
23603 #: ../fish/guestfish-actions.pod:3634
23605 "One consequence of this is that log messages aren't caught by the library "
23606 "and handled by L</set-log-message-callback>, but go straight to stdout."
23610 #: ../fish/guestfish-actions.pod:3643
23611 msgid "set-e2label"
23615 #: ../fish/guestfish-actions.pod:3645
23618 " set-e2label device label\n"
23623 #: ../fish/guestfish-actions.pod:3651
23625 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
23626 "label on a filesystem."
23630 #: ../fish/guestfish-actions.pod:3654
23635 #: ../fish/guestfish-actions.pod:3656
23638 " set-e2uuid device uuid\n"
23643 #: ../fish/guestfish-actions.pod:3663
23645 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
23646 "UUID of a filesystem."
23650 #: ../fish/guestfish-actions.pod:3666
23651 msgid "set-memsize"
23655 #: ../fish/guestfish-actions.pod:3668
23660 #: ../fish/guestfish-actions.pod:3670
23663 " set-memsize memsize\n"
23668 #: ../fish/guestfish-actions.pod:3672
23670 "This sets the memory size in megabytes allocated to the qemu subprocess. "
23671 "This only has any effect if called before L</launch>."
23675 #: ../fish/guestfish-actions.pod:3683
23676 msgid "set-network"
23680 #: ../fish/guestfish-actions.pod:3685
23685 #: ../fish/guestfish-actions.pod:3687
23688 " set-network true|false\n"
23693 #: ../fish/guestfish-actions.pod:3695
23695 "You must call this before calling L</launch>, otherwise it has no effect."
23699 #: ../fish/guestfish-actions.pod:3698
23704 #: ../fish/guestfish-actions.pod:3700
23709 #: ../fish/guestfish-actions.pod:3702
23712 " set-path searchpath\n"
23717 #: ../fish/guestfish-actions.pod:3711
23722 #: ../fish/guestfish-actions.pod:3713
23727 #: ../fish/guestfish-actions.pod:3715
23735 #: ../fish/guestfish-actions.pod:3735
23736 msgid "set-recovery-proc"
23740 #: ../fish/guestfish-actions.pod:3737
23741 msgid "recovery-proc"
23745 #: ../fish/guestfish-actions.pod:3739
23748 " set-recovery-proc true|false\n"
23753 #: ../fish/guestfish-actions.pod:3741
23755 "If this is called with the parameter C<false> then L</launch> does not "
23756 "create a recovery process. The purpose of the recovery process is to stop "
23757 "runaway qemu processes in the case where the main program aborts abruptly."
23761 #: ../fish/guestfish-actions.pod:3746
23763 "This only has any effect if called before L</launch>, and the default is "
23768 #: ../fish/guestfish-actions.pod:3755
23769 msgid "set-selinux"
23773 #: ../fish/guestfish-actions.pod:3757
23778 #: ../fish/guestfish-actions.pod:3759
23781 " set-selinux true|false\n"
23786 #: ../fish/guestfish-actions.pod:3770
23791 #: ../fish/guestfish-actions.pod:3772
23796 #: ../fish/guestfish-actions.pod:3774
23799 " set-trace true|false\n"
23804 #: ../fish/guestfish-actions.pod:3790
23805 msgid "set-verbose"
23809 #: ../fish/guestfish-actions.pod:3792
23814 #: ../fish/guestfish-actions.pod:3794
23817 " set-verbose true|false\n"
23822 #: ../fish/guestfish-actions.pod:3801
23827 #: ../fish/guestfish-actions.pod:3803
23830 " setcon context\n"
23835 #: ../fish/guestfish-actions.pod:3810
23840 #: ../fish/guestfish-actions.pod:3812
23843 " setxattr xattr val vallen path\n"
23848 #: ../fish/guestfish-actions.pod:3818
23849 msgid "See also: L</lsetxattr>, L<attr(5)>."
23853 #: ../fish/guestfish-actions.pod:3820
23858 #: ../fish/guestfish-actions.pod:3822
23861 " sfdisk device cyls heads sectors 'lines ...'\n"
23866 #: ../fish/guestfish-actions.pod:3844
23867 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
23871 #: ../fish/guestfish-actions.pod:3850
23876 #: ../fish/guestfish-actions.pod:3852
23879 " sfdiskM device 'lines ...'\n"
23884 #: ../fish/guestfish-actions.pod:3854
23886 "This is a simplified interface to the L</sfdisk> command, where partition "
23887 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
23888 "you don't need to specify the cyls, heads and sectors parameters which were "
23889 "rarely if ever used anyway."
23893 #: ../fish/guestfish-actions.pod:3860
23894 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
23898 #: ../fish/guestfish-actions.pod:3866
23903 #: ../fish/guestfish-actions.pod:3868
23906 " sfdisk-N device partnum cyls heads sectors line\n"
23911 #: ../fish/guestfish-actions.pod:3873
23913 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
23914 "cyls/heads/sectors parameters."
23918 #: ../fish/guestfish-actions.pod:3876
23919 msgid "See also: L</part-add>"
23923 #: ../fish/guestfish-actions.pod:3881
23924 msgid "sfdisk-disk-geometry"
23928 #: ../fish/guestfish-actions.pod:3883
23931 " sfdisk-disk-geometry device\n"
23936 #: ../fish/guestfish-actions.pod:3885
23938 "This displays the disk geometry of C<device> read from the partition table. "
23939 "Especially in the case where the underlying block device has been resized, "
23940 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
23941 "kernel-geometry>)."
23945 #: ../fish/guestfish-actions.pod:3893
23946 msgid "sfdisk-kernel-geometry"
23950 #: ../fish/guestfish-actions.pod:3895
23953 " sfdisk-kernel-geometry device\n"
23958 #: ../fish/guestfish-actions.pod:3902
23963 #: ../fish/guestfish-actions.pod:3904
23966 " sfdisk-l device\n"
23971 #: ../fish/guestfish-actions.pod:3910
23972 msgid "See also: L</part-list>"
23976 #: ../fish/guestfish-actions.pod:3912
23981 #: ../fish/guestfish-actions.pod:3914
23989 #: ../fish/guestfish-actions.pod:3919
23990 msgid "This is like L</command>, but passes the command to:"
23994 #: ../fish/guestfish-actions.pod:3927
23995 msgid "All the provisos about L</command> apply to this call."
23999 #: ../fish/guestfish-actions.pod:3929
24004 #: ../fish/guestfish-actions.pod:3931
24007 " sh-lines command\n"
24012 #: ../fish/guestfish-actions.pod:3933
24013 msgid "This is the same as L</sh>, but splits the result into a list of lines."
24017 #: ../fish/guestfish-actions.pod:3936
24018 msgid "See also: L</command-lines>"
24022 #: ../fish/guestfish-actions.pod:3938
24027 #: ../fish/guestfish-actions.pod:3940
24035 #: ../fish/guestfish-actions.pod:3944
24040 #: ../fish/guestfish-actions.pod:3946
24048 #: ../fish/guestfish-actions.pod:3952
24053 #: ../fish/guestfish-actions.pod:3954
24061 #: ../fish/guestfish-actions.pod:3962
24066 #: ../fish/guestfish-actions.pod:3964
24074 #: ../fish/guestfish-actions.pod:3972
24079 #: ../fish/guestfish-actions.pod:3974
24082 " strings-e encoding path\n"
24087 #: ../fish/guestfish-actions.pod:3976
24089 "This is like the L</strings> command, but allows you to specify the encoding "
24090 "of strings that are looked for in the source file C<path>."
24094 #: ../fish/guestfish-actions.pod:3986
24096 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
24097 "ISO-8859-X (this is what L</strings> uses)."
24101 #: ../fish/guestfish-actions.pod:4018
24102 msgid "swapoff-device"
24106 #: ../fish/guestfish-actions.pod:4020
24109 " swapoff-device device\n"
24114 #: ../fish/guestfish-actions.pod:4022
24116 "This command disables the libguestfs appliance swap device or partition "
24117 "named C<device>. See L</swapon-device>."
24121 #: ../fish/guestfish-actions.pod:4026
24122 msgid "swapoff-file"
24126 #: ../fish/guestfish-actions.pod:4028
24129 " swapoff-file file\n"
24134 #: ../fish/guestfish-actions.pod:4032
24135 msgid "swapoff-label"
24139 #: ../fish/guestfish-actions.pod:4034
24142 " swapoff-label label\n"
24147 #: ../fish/guestfish-actions.pod:4039
24148 msgid "swapoff-uuid"
24152 #: ../fish/guestfish-actions.pod:4041
24155 " swapoff-uuid uuid\n"
24160 #: ../fish/guestfish-actions.pod:4046
24161 msgid "swapon-device"
24165 #: ../fish/guestfish-actions.pod:4048
24168 " swapon-device device\n"
24173 #: ../fish/guestfish-actions.pod:4050
24175 "This command enables the libguestfs appliance to use the swap device or "
24176 "partition named C<device>. The increased memory is made available for all "
24177 "commands, for example those run using L</command> or L</sh>."
24181 #: ../fish/guestfish-actions.pod:4062
24182 msgid "swapon-file"
24186 #: ../fish/guestfish-actions.pod:4064
24189 " swapon-file file\n"
24194 #: ../fish/guestfish-actions.pod:4066
24196 "This command enables swap to a file. See L</swapon-device> for other notes."
24200 #: ../fish/guestfish-actions.pod:4069
24201 msgid "swapon-label"
24205 #: ../fish/guestfish-actions.pod:4071
24208 " swapon-label label\n"
24213 #: ../fish/guestfish-actions.pod:4073
24215 "This command enables swap to a labeled swap partition. See L</swapon-"
24216 "device> for other notes."
24220 #: ../fish/guestfish-actions.pod:4076
24221 msgid "swapon-uuid"
24225 #: ../fish/guestfish-actions.pod:4078
24228 " swapon-uuid uuid\n"
24233 #: ../fish/guestfish-actions.pod:4080
24235 "This command enables swap to a swap partition with the given UUID. See L</"
24236 "swapon-device> for other notes."
24240 #: ../fish/guestfish-actions.pod:4083
24245 #: ../fish/guestfish-actions.pod:4085
24253 #: ../fish/guestfish-actions.pod:4093
24258 #: ../fish/guestfish-actions.pod:4095
24266 #: ../fish/guestfish-actions.pod:4103
24271 #: ../fish/guestfish-actions.pod:4105
24274 " tail-n nrlines path\n"
24279 #: ../fish/guestfish-actions.pod:4118
24284 #: ../fish/guestfish-actions.pod:4120
24287 " tar-in (tarfile|-) directory\n"
24292 #: ../fish/guestfish-actions.pod:4125
24293 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
24297 #: ../fish/guestfish-actions.pod:4130
24302 #: ../fish/guestfish-actions.pod:4132
24305 " tar-out directory (tarfile|-)\n"
24310 #: ../fish/guestfish-actions.pod:4137
24311 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
24315 #: ../fish/guestfish-actions.pod:4142
24320 #: ../fish/guestfish-actions.pod:4144
24323 " tgz-in (tarball|-) directory\n"
24328 #: ../fish/guestfish-actions.pod:4149
24329 msgid "To upload an uncompressed tarball, use L</tar-in>."
24333 #: ../fish/guestfish-actions.pod:4153
24338 #: ../fish/guestfish-actions.pod:4155
24341 " tgz-out directory (tarball|-)\n"
24346 #: ../fish/guestfish-actions.pod:4160
24347 msgid "To download an uncompressed tarball, use L</tar-out>."
24351 #: ../fish/guestfish-actions.pod:4164
24356 #: ../fish/guestfish-actions.pod:4166
24364 #: ../fish/guestfish-actions.pod:4175
24369 #: ../fish/guestfish-actions.pod:4177
24377 #: ../fish/guestfish-actions.pod:4182
24378 msgid "truncate-size"
24382 #: ../fish/guestfish-actions.pod:4184
24385 " truncate-size path size\n"
24390 #: ../fish/guestfish-actions.pod:4189
24392 "If the current file size is less than C<size> then the file is extended to "
24393 "the required size with zero bytes. This creates a sparse file (ie. disk "
24394 "blocks are not allocated for the file until you write to it). To create a "
24395 "non-sparse file of zeroes, use L</fallocate64> instead."
24399 #: ../fish/guestfish-actions.pod:4195
24404 #: ../fish/guestfish-actions.pod:4197
24407 " tune2fs-l device\n"
24412 #: ../fish/guestfish-actions.pod:4207
24417 #: ../fish/guestfish-actions.pod:4209
24420 " txz-in (tarball|-) directory\n"
24425 #: ../fish/guestfish-actions.pod:4216
24430 #: ../fish/guestfish-actions.pod:4218
24433 " txz-out directory (tarball|-)\n"
24438 #: ../fish/guestfish-actions.pod:4225
24443 #: ../fish/guestfish-actions.pod:4227
24451 #: ../fish/guestfish-actions.pod:4241
24452 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
24456 #: ../fish/guestfish-actions.pod:4246
24461 #: ../fish/guestfish-actions.pod:4248
24466 #: ../fish/guestfish-actions.pod:4250
24469 " umount pathordevice\n"
24474 #: ../fish/guestfish-actions.pod:4256
24479 #: ../fish/guestfish-actions.pod:4258
24480 msgid "unmount-all"
24484 #: ../fish/guestfish-actions.pod:4260
24492 #: ../fish/guestfish-actions.pod:4266
24497 #: ../fish/guestfish-actions.pod:4268
24500 " upload (filename|-) remotefilename\n"
24505 #: ../fish/guestfish-actions.pod:4275
24506 msgid "See also L</download>."
24510 #: ../fish/guestfish-actions.pod:4279
24511 msgid "upload-offset"
24515 #: ../fish/guestfish-actions.pod:4281
24518 " upload-offset (filename|-) remotefilename offset\n"
24523 #: ../fish/guestfish-actions.pod:4293
24525 "Note that there is no limit on the amount of data that can be uploaded with "
24526 "this call, unlike with L</pwrite>, and this call always writes the full "
24527 "amount unless an error occurs."
24531 #: ../fish/guestfish-actions.pod:4298
24532 msgid "See also L</upload>, L</pwrite>."
24536 #: ../fish/guestfish-actions.pod:4302
24541 #: ../fish/guestfish-actions.pod:4304
24544 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
24549 #: ../fish/guestfish-actions.pod:4323
24554 #: ../fish/guestfish-actions.pod:4325
24562 #: ../fish/guestfish-actions.pod:4352
24564 "I<Note:> Don't use this call to test for availability of features. In "
24565 "enterprise distributions we backport features from later versions into "
24566 "earlier versions, making this an unreliable way to test for features. Use "
24567 "L</available> instead."
24571 #: ../fish/guestfish-actions.pod:4358
24576 #: ../fish/guestfish-actions.pod:4360
24579 " vfs-label device\n"
24584 #: ../fish/guestfish-actions.pod:4367
24585 msgid "To find a filesystem from the label, use L</findfs-label>."
24589 #: ../fish/guestfish-actions.pod:4369
24594 #: ../fish/guestfish-actions.pod:4371
24597 " vfs-type device\n"
24602 #: ../fish/guestfish-actions.pod:4381
24607 #: ../fish/guestfish-actions.pod:4383
24610 " vfs-uuid device\n"
24615 #: ../fish/guestfish-actions.pod:4390
24616 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
24620 #: ../fish/guestfish-actions.pod:4392
24621 msgid "vg-activate"
24625 #: ../fish/guestfish-actions.pod:4394
24628 " vg-activate true|false 'volgroups ...'\n"
24633 #: ../fish/guestfish-actions.pod:4407
24634 msgid "vg-activate-all"
24638 #: ../fish/guestfish-actions.pod:4409
24641 " vg-activate-all true|false\n"
24646 #: ../fish/guestfish-actions.pod:4419
24651 #: ../fish/guestfish-actions.pod:4421
24654 " vgcreate volgroup 'physvols ...'\n"
24659 #: ../fish/guestfish-actions.pod:4426
24664 #: ../fish/guestfish-actions.pod:4428
24667 " vglvuuids vgname\n"
24672 #: ../fish/guestfish-actions.pod:4433
24674 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
24675 "logical volumes and volume groups."
24679 #: ../fish/guestfish-actions.pod:4436
24680 msgid "See also L</vgpvuuids>."
24684 #: ../fish/guestfish-actions.pod:4438
24689 #: ../fish/guestfish-actions.pod:4440
24692 " vgpvuuids vgname\n"
24697 #: ../fish/guestfish-actions.pod:4445
24699 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
24700 "physical volumes and volume groups."
24704 #: ../fish/guestfish-actions.pod:4448
24705 msgid "See also L</vglvuuids>."
24709 #: ../fish/guestfish-actions.pod:4450
24714 #: ../fish/guestfish-actions.pod:4452
24717 " vgremove vgname\n"
24722 #: ../fish/guestfish-actions.pod:4459
24727 #: ../fish/guestfish-actions.pod:4461
24730 " vgrename volgroup newvolgroup\n"
24735 #: ../fish/guestfish-actions.pod:4465
24740 #: ../fish/guestfish-actions.pod:4467
24748 #: ../fish/guestfish-actions.pod:4475
24749 msgid "See also L</vgs-full>."
24753 #: ../fish/guestfish-actions.pod:4477
24758 #: ../fish/guestfish-actions.pod:4479
24766 #: ../fish/guestfish-actions.pod:4484
24771 #: ../fish/guestfish-actions.pod:4486
24779 #: ../fish/guestfish-actions.pod:4491
24784 #: ../fish/guestfish-actions.pod:4493
24792 #: ../fish/guestfish-actions.pod:4497
24797 #: ../fish/guestfish-actions.pod:4499
24805 #: ../fish/guestfish-actions.pod:4504
24810 #: ../fish/guestfish-actions.pod:4506
24818 #: ../fish/guestfish-actions.pod:4511
24823 #: ../fish/guestfish-actions.pod:4513
24831 #: ../fish/guestfish-actions.pod:4518
24836 #: ../fish/guestfish-actions.pod:4520
24839 " write path content\n"
24844 #: ../fish/guestfish-actions.pod:4528
24849 #: ../fish/guestfish-actions.pod:4530
24852 " write-file path content size\n"
24857 #: ../fish/guestfish-actions.pod:4553
24862 #: ../fish/guestfish-actions.pod:4555
24865 " zegrep regex path\n"
24870 #: ../fish/guestfish-actions.pod:4563
24875 #: ../fish/guestfish-actions.pod:4565
24878 " zegrepi regex path\n"
24883 #: ../fish/guestfish-actions.pod:4573
24888 #: ../fish/guestfish-actions.pod:4575
24896 #: ../fish/guestfish-actions.pod:4583
24897 msgid "See also: L</zero-device>, L</scrub-device>."
24901 #: ../fish/guestfish-actions.pod:4585
24902 msgid "zero-device"
24906 #: ../fish/guestfish-actions.pod:4587
24909 " zero-device device\n"
24914 #: ../fish/guestfish-actions.pod:4589
24916 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
24917 "which just zeroes the first few blocks of a device."
24921 #: ../fish/guestfish-actions.pod:4596
24926 #: ../fish/guestfish-actions.pod:4598
24929 " zerofree device\n"
24934 #: ../fish/guestfish-actions.pod:4611
24939 #: ../fish/guestfish-actions.pod:4613
24942 " zfgrep pattern path\n"
24947 #: ../fish/guestfish-actions.pod:4621
24952 #: ../fish/guestfish-actions.pod:4623
24955 " zfgrepi pattern path\n"
24960 #: ../fish/guestfish-actions.pod:4631
24965 #: ../fish/guestfish-actions.pod:4633
24968 " zfile meth path\n"
24973 #: ../fish/guestfish-actions.pod:4640
24975 "Since 1.0.63, use L</file> instead which can now process compressed files."
24979 #: ../fish/guestfish-actions.pod:4650
24984 #: ../fish/guestfish-actions.pod:4652
24987 " zgrep regex path\n"
24992 #: ../fish/guestfish-actions.pod:4660
24997 #: ../fish/guestfish-actions.pod:4662
25000 " zgrepi regex path\n"
25005 #: ../fish/guestfish-commands.pod:1
25010 #: ../fish/guestfish-commands.pod:3
25015 #: ../fish/guestfish-commands.pod:5
25018 " alloc filename size\n"
25023 #: ../fish/guestfish-commands.pod:7
25025 "This creates an empty (zeroed) file of the given size, and then adds so it "
25026 "can be further examined."
25030 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
25031 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
25035 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
25036 msgid "Size can be specified using standard suffixes, eg. C<1M>."
25040 #: ../fish/guestfish-commands.pod:14
25042 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
25043 "image, see L</PREPARED DISK IMAGES>."
25047 #: ../fish/guestfish-commands.pod:17
25052 #: ../fish/guestfish-commands.pod:19
25055 " copy-in local [local ...] /remotedir\n"
25060 #: ../fish/guestfish-commands.pod:21
25062 "C<copy-in> copies local files or directories recursively into the disk "
25063 "image, placing them in the directory called C</remotedir> (which must "
25064 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
25065 "other commands as necessary."
25069 #: ../fish/guestfish-commands.pod:26
25071 "Multiple local files and directories can be specified, but the last "
25072 "parameter must always be a remote directory. Wildcards cannot be used."
25076 #: ../fish/guestfish-commands.pod:30
25081 #: ../fish/guestfish-commands.pod:32
25084 " copy-out remote [remote ...] localdir\n"
25089 #: ../fish/guestfish-commands.pod:34
25091 "C<copy-out> copies remote files or directories recursively out of the disk "
25092 "image, placing them on the host disk in a local directory called C<localdir> "
25093 "(which must exist). This guestfish meta-command turns into a sequence of L</"
25094 "download>, L</tar-out> and other commands as necessary."
25098 #: ../fish/guestfish-commands.pod:40
25100 "Multiple remote files and directories can be specified, but the last "
25101 "parameter must always be a local directory. To download to the current "
25102 "directory, use C<.> as in:"
25106 #: ../fish/guestfish-commands.pod:44
25109 " copy-out /home .\n"
25114 #: ../fish/guestfish-commands.pod:46
25116 "Wildcards cannot be used in the ordinary command, but you can use them with "
25117 "the help of L</glob> like this:"
25121 #: ../fish/guestfish-commands.pod:49
25124 " glob copy-out /home/* .\n"
25129 #: ../fish/guestfish-commands.pod:51
25134 #: ../fish/guestfish-commands.pod:53
25137 " echo [params ...]\n"
25142 #: ../fish/guestfish-commands.pod:55
25143 msgid "This echos the parameters to the terminal."
25147 #: ../fish/guestfish-commands.pod:57
25152 #: ../fish/guestfish-commands.pod:59
25157 #: ../fish/guestfish-commands.pod:61
25162 #: ../fish/guestfish-commands.pod:63
25170 #: ../fish/guestfish-commands.pod:65
25172 "This is used to edit a file. It downloads the file, edits it locally using "
25173 "your editor, then uploads the result."
25177 #: ../fish/guestfish-commands.pod:68
25179 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
25180 "or C<emacs> you will get those corresponding editors."
25184 #: ../fish/guestfish-commands.pod:72
25189 #: ../fish/guestfish-commands.pod:74
25192 " glob command args...\n"
25197 #: ../fish/guestfish-commands.pod:76
25199 "Expand wildcards in any paths in the args list, and run C<command> "
25200 "repeatedly on each matching path."
25204 #: ../fish/guestfish-commands.pod:79
25205 msgid "See L</WILDCARDS AND GLOBBING>."
25209 #: ../fish/guestfish-commands.pod:81
25214 #: ../fish/guestfish-commands.pod:83
25217 " hexedit <filename|device>\n"
25218 " hexedit <filename|device> <max>\n"
25219 " hexedit <filename|device> <start> <max>\n"
25224 #: ../fish/guestfish-commands.pod:87
25226 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
25231 #: ../fish/guestfish-commands.pod:90
25233 "This command works by downloading potentially the whole file or device, "
25234 "editing it locally, then uploading it. If the file or device is large, you "
25235 "have to specify which part you wish to edit by using C<max> and/or C<start> "
25236 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
25237 "usual modifiers allowed such as C<1M> (1 megabyte)."
25241 #: ../fish/guestfish-commands.pod:97
25242 msgid "For example to edit the first few sectors of a disk you might do:"
25246 #: ../fish/guestfish-commands.pod:100
25249 " hexedit /dev/sda 1M\n"
25254 #: ../fish/guestfish-commands.pod:102
25256 "which would allow you to edit anywhere within the first megabyte of the disk."
25260 #: ../fish/guestfish-commands.pod:105
25261 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
25265 #: ../fish/guestfish-commands.pod:107
25268 " hexedit /dev/sda1 0x400 0x400\n"
25273 #: ../fish/guestfish-commands.pod:109
25274 msgid "(assuming the superblock is in the standard location)."
25278 #: ../fish/guestfish-commands.pod:111
25280 "This command requires the external L<hexedit(1)> program. You can specify "
25281 "another program to use by setting the C<HEXEDITOR> environment variable."
25285 #: ../fish/guestfish-commands.pod:115
25286 msgid "See also L</hexdump>."
25290 #: ../fish/guestfish-commands.pod:117
25295 #: ../fish/guestfish-commands.pod:119
25303 #: ../fish/guestfish-commands.pod:121
25305 "Change the local directory, ie. the current directory of guestfish itself."
25309 #: ../fish/guestfish-commands.pod:124
25310 msgid "Note that C<!cd> won't do what you might expect."
25314 #: ../fish/guestfish-commands.pod:126
25319 #: ../fish/guestfish-commands.pod:128
25324 #: ../fish/guestfish-commands.pod:130
25332 #: ../fish/guestfish-commands.pod:132
25333 msgid "Opens the manual page for guestfish."
25337 #: ../fish/guestfish-commands.pod:134
25342 #: ../fish/guestfish-commands.pod:136
25347 #: ../fish/guestfish-commands.pod:138
25355 #: ../fish/guestfish-commands.pod:140
25363 #: ../fish/guestfish-commands.pod:142
25364 msgid "This is used to view a file."
25368 #: ../fish/guestfish-commands.pod:144
25370 "The default viewer is C<$PAGER>. However if you use the alternate command "
25371 "C<less> you will get the C<less> command specifically."
25375 #: ../fish/guestfish-commands.pod:147
25380 #: ../fish/guestfish-commands.pod:149
25388 #: ../fish/guestfish-commands.pod:151
25390 "Close and reopen the libguestfs handle. It is not necessary to use this "
25391 "normally, because the handle is closed properly when guestfish exits. "
25392 "However this is occasionally useful for testing."
25396 #: ../fish/guestfish-commands.pod:155
25401 #: ../fish/guestfish-commands.pod:157
25404 " sparse filename size\n"
25409 #: ../fish/guestfish-commands.pod:159
25411 "This creates an empty sparse file of the given size, and then adds so it can "
25412 "be further examined."
25416 #: ../fish/guestfish-commands.pod:162
25418 "In all respects it works the same as the L</alloc> command, except that the "
25419 "image file is allocated sparsely, which means that disk blocks are not "
25420 "assigned to the file until they are needed. Sparse disk files only use "
25421 "space when written to, but they are slower and there is a danger you could "
25422 "run out of real disk space during a write operation."
25426 #: ../fish/guestfish-commands.pod:172
25431 #: ../fish/guestfish-commands.pod:174
25439 #: ../fish/guestfish-commands.pod:176
25441 "This command returns a list of the optional groups known to the daemon, and "
25442 "indicates which ones are supported by this build of the libguestfs appliance."
25446 #: ../fish/guestfish-commands.pod:180
25447 msgid "See also L<guestfs(3)/AVAILABILITY>."
25451 #: ../fish/guestfish-commands.pod:182
25456 #: ../fish/guestfish-commands.pod:184
25459 " time command args...\n"
25464 #: ../fish/guestfish-commands.pod:186
25466 "Run the command as usual, but print the elapsed time afterwards. This can "
25467 "be useful for benchmarking operations."
25471 #: ../test-tool/libguestfs-test-tool.pod:5
25472 msgid "libguestfs-test-tool - End user tests for libguestfs"
25476 #: ../test-tool/libguestfs-test-tool.pod:9
25479 " libguestfs-test-tool [--options]\n"
25484 #: ../test-tool/libguestfs-test-tool.pod:13
25486 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
25487 "and developers, to allow them to check basic libguestfs functionality is "
25488 "working. This is needed because libguestfs occasionally breaks for reasons "
25489 "beyond our control: usually because of changes in the underlying qemu or "
25490 "kernel packages, or the host environment."
25494 #: ../test-tool/libguestfs-test-tool.pod:20
25495 msgid "If you suspect a problem in libguestfs, then just run:"
25499 #: ../test-tool/libguestfs-test-tool.pod:22
25502 " libguestfs-test-tool\n"
25507 #: ../test-tool/libguestfs-test-tool.pod:24
25508 msgid "It will print lots of diagnostic messages."
25512 #: ../test-tool/libguestfs-test-tool.pod:26
25513 msgid "If it runs to completion successfully, you will see this near the end:"
25517 #: ../test-tool/libguestfs-test-tool.pod:28
25520 " ===== TEST FINISHED OK =====\n"
25525 #: ../test-tool/libguestfs-test-tool.pod:30
25526 msgid "and the test tool will exit with code 0."
25530 #: ../test-tool/libguestfs-test-tool.pod:32
25532 "If it fails (and/or exits with non-zero error code), please paste the "
25533 "B<complete, unedited> output of the test tool into a bug report. More "
25534 "information about reporting bugs can be found on the L<http://libguestfs.org/"
25539 #: ../test-tool/libguestfs-test-tool.pod:41
25544 #: ../test-tool/libguestfs-test-tool.pod:43
25545 msgid "Display short usage information and exit."
25549 #: ../test-tool/libguestfs-test-tool.pod:45
25550 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
25554 #: ../test-tool/libguestfs-test-tool.pod:47
25556 "Pass an alternate name for the helper program. libguestfs-test-tool will "
25557 "normally look in the C<$libexec> directory that was configured when the tool "
25562 #: ../test-tool/libguestfs-test-tool.pod:51
25563 msgid "I<--qemu qemu_binary>"
25567 #: ../test-tool/libguestfs-test-tool.pod:53
25569 "If you have downloaded another qemu binary, point this option at the full "
25570 "path of the binary to try it."
25574 #: ../test-tool/libguestfs-test-tool.pod:56
25575 msgid "I<--qemudir qemu_source_dir>"
25579 #: ../test-tool/libguestfs-test-tool.pod:58
25581 "If you have compiled qemu from source, point this option at the source "
25582 "directory to try it."
25586 #: ../test-tool/libguestfs-test-tool.pod:61
25587 msgid "I<--timeout N>"
25591 #: ../test-tool/libguestfs-test-tool.pod:63
25593 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
25594 "does not usually need to be adjusted unless your machine is very slow."
25598 #: ../test-tool/libguestfs-test-tool.pod:69
25599 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
25603 #: ../test-tool/libguestfs-test-tool.pod:71
25605 "If you have compiled another version of qemu from source and would like to "
25606 "try that, then you can use the I<--qemudir> option to point to the qemu "
25607 "source directory."
25611 #: ../test-tool/libguestfs-test-tool.pod:75
25613 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
25614 "option to point to the binary."
25618 #: ../test-tool/libguestfs-test-tool.pod:78
25620 "When using an alternate qemu with libguestfs, usually you would need to "
25621 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
25622 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
25623 "use either of the I<--qemudir> or I<--qemu> options."
25627 #: ../test-tool/libguestfs-test-tool.pod:85
25629 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
25630 "I<1> if there was an error."
25634 #: ../test-tool/libguestfs-test-tool.pod:92
25635 msgid "/usr/libexec/libguestfs-test-tool-helper"
25639 #: ../test-tool/libguestfs-test-tool.pod:94
25641 "This helper program is run inside the appliance and provides additional "
25646 #: ../test-tool/libguestfs-test-tool.pod:97
25647 msgid "/usr/bin/mkisofs"
25651 #: ../test-tool/libguestfs-test-tool.pod:99
25653 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
25654 "which is used as part of the tests."
25658 #: ../test-tool/libguestfs-test-tool.pod:106
25660 "For the full list of environment variables which may affect libguestfs, "
25661 "please see the L<guestfs(3)> manual page."
25665 #: ../test-tool/libguestfs-test-tool.pod:111
25666 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
25670 #: ../test-tool/libguestfs-test-tool.pod:121
25671 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
25675 #: ../fuse/guestmount.pod:5
25677 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
25681 #: ../fuse/guestmount.pod:9
25684 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
25689 #: ../fuse/guestmount.pod:11
25692 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
25697 #: ../fuse/guestmount.pod:13
25700 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
25705 #: ../fuse/guestmount.pod:17
25707 "You must I<not> use C<guestmount> in read-write mode on live virtual "
25708 "machines. If you do this, you risk disk corruption in the VM."
25712 #: ../fuse/guestmount.pod:22
25714 "The guestmount program can be used to mount virtual machine filesystems and "
25715 "other disk images on the host. It uses libguestfs for access to the guest "
25716 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
25717 "a mountable device."
25721 #: ../fuse/guestmount.pod:27
25723 "Along with other options, you have to give at least one device (I<-a> "
25724 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
25725 "option) or use the I<-i> inspection option. How this works is better "
25726 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
25731 #: ../fuse/guestmount.pod:33
25733 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
25734 "by you, and the filesystem will not be visible to any other users unless you "
25735 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
25736 "the filesystem, use the C<fusermount -u> command."
25740 #: ../fuse/guestmount.pod:41
25742 "For a typical Windows guest which has its main filesystem on the first "
25747 #: ../fuse/guestmount.pod:44
25750 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
25755 #: ../fuse/guestmount.pod:46
25757 "For a typical Linux guest which has a /boot filesystem on the first "
25758 "partition, and the root filesystem on a logical volume:"
25762 #: ../fuse/guestmount.pod:49
25765 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
25770 #: ../fuse/guestmount.pod:51
25771 msgid "To get libguestfs to detect guest mountpoints for you:"
25775 #: ../fuse/guestmount.pod:53
25778 " guestmount -a guest.img -i --ro /mnt\n"
25783 #: ../fuse/guestmount.pod:55
25784 msgid "For a libvirt guest called \"Guest\" you could do:"
25788 #: ../fuse/guestmount.pod:57
25791 " guestmount -d Guest -i --ro /mnt\n"
25796 #: ../fuse/guestmount.pod:59
25798 "If you don't know what filesystems are contained in a guest or disk image, "
25799 "use L<virt-list-filesystems(1)> first:"
25803 #: ../fuse/guestmount.pod:62
25806 " virt-list-filesystems MyGuest\n"
25811 #: ../fuse/guestmount.pod:64
25813 "If you want to trace the libguestfs calls but without excessive debugging "
25814 "information, we recommend:"
25818 #: ../fuse/guestmount.pod:67
25821 " guestmount [...] --trace /mnt\n"
25826 #: ../fuse/guestmount.pod:69
25827 msgid "If you want to debug the program, we recommend:"
25831 #: ../fuse/guestmount.pod:71
25834 " guestmount [...] --trace --verbose /mnt\n"
25839 #: ../fuse/guestmount.pod:79
25840 msgid "Add a block device or virtual machine image."
25844 #: ../fuse/guestmount.pod:96
25845 msgid "B<--dir-cache-timeout N>"
25849 #: ../fuse/guestmount.pod:98
25851 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
25852 "seconds. The readdir cache [actually, there are several semi-independent "
25853 "caches] is populated after a readdir(2) call with the stat and extended "
25854 "attributes of the files in the directory, in anticipation that they will be "
25855 "requested soon after."
25859 #: ../fuse/guestmount.pod:104
25861 "There is also a different attribute cache implemented by FUSE (see the FUSE "
25862 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
25863 "requests, only cache existing ones."
25867 #: ../fuse/guestmount.pod:122
25869 "If you have untrusted raw-format guest disk images, you should use this "
25870 "option to specify the disk format. This avoids a possible security problem "
25871 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
25872 "guestfs_add_drive_opts>."
25876 #: ../fuse/guestmount.pod:127
25877 msgid "B<--fuse-help>"
25881 #: ../fuse/guestmount.pod:129
25882 msgid "Display help on special FUSE options (see I<-o> below)."
25886 #: ../fuse/guestmount.pod:133
25887 msgid "Display brief help and exit."
25891 #: ../fuse/guestmount.pod:146
25892 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
25896 #: ../fuse/guestmount.pod:148
25898 "Mount the named partition or logical volume on the given mountpoint B<in the "
25899 "guest> (this has nothing to do with mountpoints in the host)."
25903 #: ../fuse/guestmount.pod:151
25905 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
25906 "something on C</>."
25910 #: ../fuse/guestmount.pod:156
25912 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
25913 "unmounted. If you specify this option, then we don't attempt to sync the "
25914 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
25918 #: ../fuse/guestmount.pod:161
25919 msgid "B<-o option> | B<--option option>"
25923 #: ../fuse/guestmount.pod:163
25924 msgid "Pass extra options to FUSE."
25928 #: ../fuse/guestmount.pod:165
25930 "To get a list of all the extra options supported by FUSE, use the command "
25931 "below. Note that only the FUSE I<-o> options can be passed, and only some "
25932 "of them are a good idea."
25936 #: ../fuse/guestmount.pod:169
25939 " guestmount --fuse-help\n"
25944 #: ../fuse/guestmount.pod:171
25945 msgid "Some potentially useful FUSE options:"
25949 #: ../fuse/guestmount.pod:175
25950 msgid "B<-o allow_other>"
25954 #: ../fuse/guestmount.pod:177
25955 msgid "Allow other users to see the filesystem."
25959 #: ../fuse/guestmount.pod:179
25960 msgid "B<-o attr_timeout=N>"
25964 #: ../fuse/guestmount.pod:181
25965 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
25969 #: ../fuse/guestmount.pod:183
25970 msgid "B<-o kernel_cache>"
25974 #: ../fuse/guestmount.pod:185
25976 "Allow the kernel to cache files (reduces the number of reads that have to go "
25977 "through the L<guestfs(3)> API). This is generally a good idea if you can "
25978 "afford the extra memory usage."
25982 #: ../fuse/guestmount.pod:189
25983 msgid "B<-o uid=N> B<-o gid=N>"
25987 #: ../fuse/guestmount.pod:191
25989 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
25990 "the chosen values."
25994 #: ../fuse/guestmount.pod:198
25996 "Add devices and mount everything read-only. Also disallow writes and make "
25997 "the disk appear read-only to FUSE."
26001 #: ../fuse/guestmount.pod:201
26003 "This is highly recommended if you are not going to edit the guest disk. If "
26004 "the guest is running and this option is I<not> supplied, then there is a "
26005 "strong risk of disk corruption in the guest. We try to prevent this from "
26006 "happening, but it is not always possible."
26010 #: ../fuse/guestmount.pod:206
26011 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
26015 #: ../fuse/guestmount.pod:210
26016 msgid "Enable SELinux support for the guest."
26020 #: ../fuse/guestmount.pod:214
26021 msgid "Enable verbose messages from underlying libguestfs."
26025 #: ../fuse/guestmount.pod:218
26026 msgid "Display the program version and exit."
26030 #: ../fuse/guestmount.pod:222
26032 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
26033 "FOR READ AND WRITE>."
26037 #: ../fuse/guestmount.pod:225
26038 msgid "B<-x> | B<--trace>"
26042 #: ../fuse/guestmount.pod:227
26043 msgid "Trace libguestfs calls."
26047 #: ../fuse/guestmount.pod:229
26048 msgid "This also stops the daemon from forking into the background."
26052 #: ../fuse/guestmount.pod:235
26054 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
26055 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
26060 #: ../inspector/virt-inspector.pl:35
26062 "virt-inspector - Display operating system version and other information "
26063 "about a virtual machine"
26067 #: ../inspector/virt-inspector.pl:39
26070 " virt-inspector [--connect URI] domname\n"
26075 #: ../inspector/virt-inspector.pl:41
26078 " virt-inspector guest.img [guest.img ...]\n"
26083 #: ../inspector/virt-inspector.pl:45
26085 "B<virt-inspector> examines a virtual machine or disk image and tries to "
26086 "determine the version of the operating system and other information about "
26087 "the virtual machine."
26091 #: ../inspector/virt-inspector.pl:49
26092 msgid "Virt-inspector produces XML output for feeding into other programs."
26096 #: ../inspector/virt-inspector.pl:51
26098 "In the normal usage, use C<virt-inspector domname> where C<domname> is the "
26099 "libvirt domain (see: C<virsh list --all>)."
26103 #: ../inspector/virt-inspector.pl:54
26105 "You can also run virt-inspector directly on disk images from a single "
26106 "virtual machine. Use C<virt-inspector guest.img>. In rare cases a domain "
26107 "has several block devices, in which case you should list them one after "
26108 "another, with the first corresponding to the guest's C</dev/sda>, the second "
26109 "to the guest's C</dev/sdb> and so on."
26113 #: ../inspector/virt-inspector.pl:60
26115 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
26116 "inspect several virtual machines, you have to run virt-inspector several "
26117 "times (for example, from a shell script for-loop)."
26121 #: ../inspector/virt-inspector.pl:65
26123 "Because virt-inspector needs direct access to guest images, it won't "
26124 "normally work over remote libvirt connections."
26128 #: ../inspector/virt-inspector.pl:78 ../tools/virt-edit.pl:82
26129 #: ../tools/virt-win-reg.pl:181 ../tools/virt-df.pl:81 ../tools/virt-ls.pl:88
26130 #: ../tools/virt-list-filesystems.pl:60 ../tools/virt-tar.pl:108
26131 #: ../tools/virt-rescue.pl:113 ../tools/virt-make-fs.pl:163
26132 #: ../tools/virt-list-partitions.pl:61
26133 msgid "Display brief help."
26137 #: ../inspector/virt-inspector.pl:84 ../tools/virt-edit.pl:88
26138 #: ../tools/virt-win-reg.pl:187 ../tools/virt-df.pl:87 ../tools/virt-ls.pl:94
26139 #: ../tools/virt-resize.pl:273 ../tools/virt-list-filesystems.pl:66
26140 #: ../tools/virt-tar.pl:114 ../tools/virt-rescue.pl:119
26141 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:67
26142 msgid "B<--version>"
26146 #: ../inspector/virt-inspector.pl:86 ../tools/virt-edit.pl:90
26147 #: ../tools/virt-win-reg.pl:189 ../tools/virt-df.pl:89 ../tools/virt-ls.pl:96
26148 #: ../tools/virt-resize.pl:275 ../tools/virt-list-filesystems.pl:68
26149 #: ../tools/virt-tar.pl:116 ../tools/virt-rescue.pl:121
26150 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:69
26151 msgid "Display version number and exit."
26155 #: ../inspector/virt-inspector.pl:92 ../tools/virt-edit.pl:112
26156 #: ../tools/virt-win-reg.pl:203 ../tools/virt-df.pl:95 ../tools/virt-ls.pl:102
26157 #: ../tools/virt-list-filesystems.pl:74 ../tools/virt-tar.pl:122
26158 #: ../tools/virt-rescue.pl:135 ../tools/virt-list-partitions.pl:75
26159 msgid "B<--connect URI> | B<-c URI>"
26163 #: ../inspector/virt-inspector.pl:94 ../tools/virt-edit.pl:114
26164 #: ../tools/virt-win-reg.pl:205 ../tools/virt-df.pl:97 ../tools/virt-ls.pl:104
26165 #: ../tools/virt-list-filesystems.pl:76 ../tools/virt-tar.pl:124
26166 #: ../tools/virt-rescue.pl:137 ../tools/virt-list-partitions.pl:77
26168 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
26169 "to the default libvirt hypervisor."
26173 #: ../inspector/virt-inspector.pl:97
26175 "Libvirt is only used if you specify a C<domname> on the command line. If "
26176 "you specify guest block devices directly, then libvirt is not used at all."
26180 #: ../inspector/virt-inspector.pl:105 ../tools/virt-edit.pl:124
26181 #: ../tools/virt-win-reg.pl:215 ../tools/virt-df.pl:117
26182 #: ../tools/virt-ls.pl:114 ../tools/virt-resize.pl:523
26183 #: ../tools/virt-list-filesystems.pl:86 ../tools/virt-tar.pl:134
26184 #: ../tools/virt-rescue.pl:147 ../tools/virt-list-partitions.pl:87
26185 msgid "B<--format> raw"
26189 #: ../inspector/virt-inspector.pl:107 ../tools/virt-edit.pl:126
26190 #: ../tools/virt-win-reg.pl:217 ../tools/virt-df.pl:119
26191 #: ../tools/virt-ls.pl:116 ../tools/virt-list-filesystems.pl:88
26192 #: ../tools/virt-tar.pl:136 ../tools/virt-rescue.pl:149
26193 #: ../tools/virt-list-partitions.pl:89
26195 "Specify the format of disk images given on the command line. If this is "
26196 "omitted then the format is autodetected from the content of the disk image."
26200 #: ../inspector/virt-inspector.pl:111 ../tools/virt-edit.pl:130
26201 #: ../tools/virt-win-reg.pl:221 ../tools/virt-df.pl:123
26202 #: ../tools/virt-ls.pl:120 ../tools/virt-list-filesystems.pl:92
26203 #: ../tools/virt-tar.pl:140 ../tools/virt-rescue.pl:153
26204 #: ../tools/virt-list-partitions.pl:93
26206 "If disk images are requested from libvirt, then this program asks libvirt "
26207 "for this information. In this case, the value of the format parameter is "
26212 #: ../inspector/virt-inspector.pl:115 ../tools/virt-edit.pl:134
26213 #: ../tools/virt-win-reg.pl:225 ../tools/virt-df.pl:127
26214 #: ../tools/virt-ls.pl:124 ../tools/virt-resize.pl:528
26215 #: ../tools/virt-resize.pl:543 ../tools/virt-list-filesystems.pl:96
26216 #: ../tools/virt-tar.pl:144 ../tools/virt-rescue.pl:157
26217 #: ../tools/virt-list-partitions.pl:97
26219 "If working with untrusted raw-format guest disk images, you should ensure "
26220 "the format is always specified."
26224 #: ../inspector/virt-inspector.pl:149
26229 #: ../inspector/virt-inspector.pl:151
26231 "The virt-inspector XML is described precisely in a RELAX NG schema which is "
26232 "supplied with libguestfs. This section is just an overview."
26236 #: ../inspector/virt-inspector.pl:154
26238 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
26239 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
26240 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
26241 "which is vanishingly rare in real world VMs."
26245 #: ../inspector/virt-inspector.pl:159
26246 msgid "E<lt>operatingsystemE<gt>"
26250 #: ../inspector/virt-inspector.pl:161
26252 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
26253 "describe the operating system, its architecture, the descriptive \"product "
26254 "name\" string, the type of OS and so on, as in this example:"
26258 #: ../inspector/virt-inspector.pl:165
26261 " <operatingsystems>\n"
26262 " <operatingsystem>\n"
26263 " <root>/dev/sda2</root>\n"
26264 " <name>windows</name>\n"
26265 " <arch>i386</arch>\n"
26266 " <distro>windows</distro>\n"
26267 " <product_name>Windows 7 Enterprise</product_name>\n"
26268 " <major_version>6</major_version>\n"
26269 " <minor_version>1</minor_version>\n"
26270 " <windows_systemroot>/Windows</windows_systemroot>\n"
26275 #: ../inspector/virt-inspector.pl:176
26277 "These fields are derived from the libguestfs inspection API, and you can "
26278 "find more details in L<guestfs(3)/INSPECTION>."
26282 #: ../inspector/virt-inspector.pl:179
26284 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
26285 "of view of libguestfs (block devices may have completely different names "
26286 "inside the VM itself)."
26290 #: ../inspector/virt-inspector.pl:246
26291 msgid "E<lt>mountpointsE<gt>"
26295 #: ../inspector/virt-inspector.pl:248
26297 "Un*x-like guests typically have multiple filesystems which are mounted at "
26298 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
26299 "element which looks like this:"
26303 #: ../inspector/virt-inspector.pl:252
26306 " <operatingsystems>\n"
26307 " <operatingsystem>\n"
26310 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
26311 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
26312 " </mountpoints>\n"
26317 #: ../inspector/virt-inspector.pl:260
26319 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
26320 "and may have completely different names inside the guest. Only mountable "
26321 "filesystems appear in this list, not things like swap devices."
26325 #: ../inspector/virt-inspector.pl:282
26326 msgid "E<lt>filesystemsE<gt>"
26330 #: ../inspector/virt-inspector.pl:284
26332 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
26333 "filesystems belonging to the guest, including swap and empty partitions. "
26334 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
26335 "this OS or shared by this OS and other OSes)."
26339 #: ../inspector/virt-inspector.pl:289
26340 msgid "You might see something like this:"
26344 #: ../inspector/virt-inspector.pl:291
26347 " <operatingsystems>\n"
26348 " <operatingsystem>\n"
26351 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
26352 " <type>ext4</type>\n"
26353 " <label>Fedora-13-x86_64</label>\n"
26354 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
26360 #: ../inspector/virt-inspector.pl:301
26362 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
26363 "the label, and the UUID."
26367 #: ../inspector/virt-inspector.pl:343
26368 msgid "E<lt>applicationsE<gt>"
26372 #: ../inspector/virt-inspector.pl:345
26374 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
26375 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
26376 "machine. At the moment we are only able to list RPMs and Debian packages "
26377 "installed, but in future we will support other Linux distros and Windows."
26381 #: ../inspector/virt-inspector.pl:351
26383 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
26384 "Typical values would be C<rpm> and C<deb>."
26388 #: ../inspector/virt-inspector.pl:354
26390 "E<lt>package_managementE<gt>, if present, describes the package manager. "
26391 "Typical values include C<yum>, C<up2date> and C<apt>"
26395 #: ../inspector/virt-inspector.pl:357
26396 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
26400 #: ../inspector/virt-inspector.pl:360
26403 " <operatingsystems>\n"
26404 " <operatingsystem>\n"
26406 " <applications>\n"
26408 " <name>coreutils</name>\n"
26409 " <version>8.5</version>\n"
26410 " <release>1</release>\n"
26411 " </application>\n"
26416 #: ../inspector/virt-inspector.pl:370
26418 "The version and release fields may not be available for some types guests. "
26419 "Other fields are possible, see L<guestfs(3)/"
26420 "guestfs_inspect_list_applications>."
26424 #: ../inspector/virt-inspector.pl:426
26425 msgid "USING XPATH"
26429 #: ../inspector/virt-inspector.pl:428
26431 "You can use the XPath query language, and/or the xpath tool, in order to "
26432 "select parts of the XML."
26436 #: ../inspector/virt-inspector.pl:433
26439 " $ virt-inspector Guest | xpath //filesystems\n"
26440 " Found 1 nodes:\n"
26443 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
26444 " <type>ext4</type>\n"
26450 #: ../inspector/virt-inspector.pl:441
26453 " $ virt-inspector Guest | \\\n"
26454 " xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
26455 " Query didn't return a nodeset. Value: ext4\n"
26460 #: ../inspector/virt-inspector.pl:445 ../tools/virt-edit.pl:343
26461 #: ../tools/virt-win-reg.pl:141 ../tools/virt-win-reg.pl:477
26462 #: ../tools/virt-df.pl:633 ../tools/virt-ls.pl:225
26463 #: ../tools/virt-resize.pl:1479 ../tools/virt-list-filesystems.pl:179
26464 #: ../tools/virt-tar.pl:274 ../tools/virt-rescue.pl:260
26465 #: ../tools/virt-make-fs.pl:527 ../tools/virt-list-partitions.pl:247
26466 msgid "SHELL QUOTING"
26470 #: ../inspector/virt-inspector.pl:447 ../tools/virt-edit.pl:345
26471 #: ../tools/virt-win-reg.pl:479 ../tools/virt-df.pl:635
26472 #: ../tools/virt-ls.pl:227 ../tools/virt-resize.pl:1481
26473 #: ../tools/virt-list-filesystems.pl:181 ../tools/virt-tar.pl:276
26474 #: ../tools/virt-rescue.pl:262 ../tools/virt-make-fs.pl:529
26475 #: ../tools/virt-list-partitions.pl:249
26477 "Libvirt guest names can contain arbitrary characters, some of which have "
26478 "meaning to the shell such as C<#> and space. You may need to quote or "
26479 "escape these characters on the command line. See the shell manual page L<sh"
26480 "(1)> for details."
26484 #: ../inspector/virt-inspector.pl:454
26486 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
26487 "L<Sys::Virt(3)>, L<http://www.w3.org/TR/xpath/>, L<http://libguestfs.org/>."
26491 #: ../inspector/virt-inspector.pl:468 ../tools/virt-edit.pl:364
26492 #: ../tools/virt-win-reg.pl:512 ../tools/virt-df.pl:651
26493 #: ../tools/virt-ls.pl:245 ../tools/virt-resize.pl:1510
26494 #: ../tools/virt-list-filesystems.pl:200 ../tools/virt-tar.pl:294
26495 #: ../tools/virt-rescue.pl:279 ../tools/virt-make-fs.pl:561
26496 #: ../tools/virt-list-partitions.pl:267
26497 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
26501 #: ../inspector/virt-inspector.pl:472
26502 msgid "Matthew Booth L<mbooth@redhat.com>"
26506 #: ../inspector/virt-inspector.pl:478 ../tools/virt-win-reg.pl:516
26507 #: ../tools/virt-resize.pl:1514 ../tools/virt-make-fs.pl:565
26508 msgid "Copyright (C) 2010 Red Hat Inc."
26512 #: ../tools/virt-edit.pl:34
26513 msgid "virt-edit - Edit a file in a virtual machine"
26517 #: ../tools/virt-edit.pl:38
26520 " virt-edit [--options] domname file\n"
26525 #: ../tools/virt-edit.pl:40
26528 " virt-edit [--options] disk.img [disk.img ...] file\n"
26533 #: ../tools/virt-edit.pl:42
26536 " virt-edit [domname|disk.img] file -e 'expr'\n"
26541 #: ../tools/virt-edit.pl:46
26543 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
26544 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
26545 "doing this, but doesn't catch all cases."
26549 #: ../tools/virt-edit.pl:52
26551 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
26552 "the named virtual machine (or disk image)."
26556 #: ../tools/virt-edit.pl:55
26558 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
26559 "you should look at the L<guestfish(1)> tool."
26563 #: ../tools/virt-edit.pl:60
26564 msgid "Edit the named files interactively:"
26568 #: ../tools/virt-edit.pl:62
26571 " virt-edit mydomain /boot/grub/grub.conf\n"
26576 #: ../tools/virt-edit.pl:64
26579 " virt-edit mydomain /etc/passwd\n"
26584 #: ../tools/virt-edit.pl:66
26586 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
26587 "below). To change the init default level to 5:"
26591 #: ../tools/virt-edit.pl:70
26594 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
26599 #: ../tools/virt-edit.pl:96
26600 msgid "B<--backup extension> | B<-b extension>"
26604 #: ../tools/virt-edit.pl:98
26606 "Create a backup of the original file I<in the guest disk image>. The backup "
26607 "has the original filename with C<extension> added."
26611 #: ../tools/virt-edit.pl:101
26613 "Usually the first character of C<extension> would be a dot C<.> so you would "
26618 #: ../tools/virt-edit.pl:104
26621 " virt-edit -b .orig [etc]\n"
26626 #: ../tools/virt-edit.pl:106
26627 msgid "By default, no backup file is made."
26631 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:208
26632 #: ../tools/virt-df.pl:100 ../tools/virt-ls.pl:107
26633 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:127
26634 #: ../tools/virt-rescue.pl:140 ../tools/virt-list-partitions.pl:80
26636 "If you specify guest block devices directly, then libvirt is not used at all."
26640 #: ../tools/virt-edit.pl:141
26641 msgid "B<--expr EXPR> | B<-e EXPR>"
26645 #: ../tools/virt-edit.pl:143
26647 "Instead of launching the external editor, non-interactively apply the Perl "
26648 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
26653 #: ../tools/virt-edit.pl:147
26655 "Be careful to properly quote the expression to prevent it from being altered "
26660 #: ../tools/virt-edit.pl:268
26661 msgid "NON-INTERACTIVE EDITING"
26665 #: ../tools/virt-edit.pl:270
26667 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
26668 "administrator can interactively edit the file."
26672 #: ../tools/virt-edit.pl:273
26674 "There are two ways also to use C<virt-edit> from scripts in order to make "
26675 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
26676 "like this, it's less error-prone to write scripts directly using the "
26677 "libguestfs API and Augeas for configuration file editing.)"
26681 #: ../tools/virt-edit.pl:279
26683 "The first method is to temporarily set C<$EDITOR> to any script or program "
26684 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
26685 "update C<tmpfile> in place however it likes."
26689 #: ../tools/virt-edit.pl:283
26691 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
26692 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
26693 "instances of C<foo> with C<bar> in a file:"
26697 #: ../tools/virt-edit.pl:287
26700 " virt-edit domname filename -e 's/foo/bar/'\n"
26705 #: ../tools/virt-edit.pl:289
26707 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
26708 "For example to delete root's password you could do:"
26712 #: ../tools/virt-edit.pl:292
26715 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
26720 #: ../tools/virt-edit.pl:294
26722 "What really happens is that the snippet is evaluated as a Perl expression "
26723 "for each line of the file. The line, including the final C<\\n>, is passed "
26724 "in C<$_> and the expression should update C<$_> or leave it unchanged."
26728 #: ../tools/virt-edit.pl:299
26730 "To delete a line, set C<$_> to the empty string. For example, to delete the "
26731 "C<apache> user account from the password file you can do:"
26735 #: ../tools/virt-edit.pl:302
26738 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
26743 #: ../tools/virt-edit.pl:304
26745 "To insert a line, prepend or append it to C<$_>. However appending lines to "
26746 "the end of the file is rather difficult this way since there is no concept "
26747 "of \"last line of the file\" - your expression just doesn't get called "
26748 "again. You might want to use the first method (setting C<$EDITOR>) if you "
26753 #: ../tools/virt-edit.pl:310
26755 "The variable C<$lineno> contains the current line number. As is "
26756 "traditional, the first line in the file is number C<1>."
26760 #: ../tools/virt-edit.pl:313
26762 "The return value from the expression is ignored, but the expression may call "
26763 "C<die> in order to abort the whole program, leaving the original file "
26768 #: ../tools/virt-edit.pl:317
26770 "Remember when matching the end of a line that C<$_> may contain the final C<"
26771 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
26772 "newline then neither of these. Thus to match or substitute some text at the "
26773 "end of a line, use this regular expression:"
26777 #: ../tools/virt-edit.pl:322
26780 " /some text(\\r?\\n)?$/\n"
26785 #: ../tools/virt-edit.pl:324
26787 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
26788 "$_> itself (since that would remove all newlines from the file):"
26792 #: ../tools/virt-edit.pl:328
26795 " my $m = $_; chomp $m; $m =~ /some text$/\n"
26800 #: ../tools/virt-edit.pl:334
26805 #: ../tools/virt-edit.pl:336
26807 "If set, this string is used as the editor. It may contain arguments, eg. C<"
26812 #: ../tools/virt-edit.pl:339
26813 msgid "If not set, C<vi> is used."
26817 #: ../tools/virt-edit.pl:352
26819 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
26820 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, "
26825 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:510
26826 #: ../tools/virt-df.pl:649 ../tools/virt-ls.pl:243
26827 #: ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:198
26828 #: ../tools/virt-tar.pl:292 ../tools/virt-rescue.pl:277
26829 #: ../tools/virt-make-fs.pl:559 ../tools/virt-list-partitions.pl:265
26834 #: ../tools/virt-edit.pl:368 ../tools/virt-df.pl:655
26835 #: ../tools/virt-rescue.pl:283 ../tools/virt-list-partitions.pl:271
26836 msgid "Copyright (C) 2009-2010 Red Hat Inc."
26840 #: ../tools/virt-win-reg.pl:37
26842 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
26846 #: ../tools/virt-win-reg.pl:41
26849 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
26854 #: ../tools/virt-win-reg.pl:43
26857 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
26862 #: ../tools/virt-win-reg.pl:45
26865 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
26870 #: ../tools/virt-win-reg.pl:47
26873 " virt-win-reg --merge domname [input.reg ...]\n"
26878 #: ../tools/virt-win-reg.pl:49
26881 " virt-win-reg [--options] disk.img ... # instead of domname\n"
26886 #: ../tools/virt-win-reg.pl:53
26888 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
26889 "virtual machines. If you do this, you I<will> get irreversible disk "
26890 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
26891 "but doesn't catch all cases."
26895 #: ../tools/virt-win-reg.pl:58
26897 "Modifying the Windows Registry is an inherently risky operation. The format "
26898 "is deliberately obscure and undocumented, and Registry changes can leave the "
26899 "system unbootable. Therefore when using the C<--merge> option, make sure "
26900 "you have a reliable backup first."
26904 #: ../tools/virt-win-reg.pl:65
26906 "This program can export and merge Windows Registry entries from a Windows "
26911 #: ../tools/virt-win-reg.pl:68
26913 "The first parameter is the libvirt guest name or the raw disk image of a "
26918 #: ../tools/virt-win-reg.pl:71
26920 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
26921 "exported (recursively). For example:"
26925 #: ../tools/virt-win-reg.pl:74
26928 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
26933 #: ../tools/virt-win-reg.pl:76
26935 "You can also display single values from within registry keys, for example:"
26939 #: ../tools/virt-win-reg.pl:79
26942 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
26943 " $ virt-win-reg Windows7 $cvkey ProductName\n"
26944 " Windows 7 Enterprise\n"
26949 #: ../tools/virt-win-reg.pl:83
26951 "With C<--merge>, you can merge a textual regedit file into the Windows "
26956 #: ../tools/virt-win-reg.pl:86
26959 " $ virt-win-reg --merge Windows7 changes.reg\n"
26964 #: ../tools/virt-win-reg.pl:88
26965 msgid "SUPPORTED SYSTEMS"
26969 #: ../tools/virt-win-reg.pl:90
26971 "The program currently supports Windows NT-derived guests starting with "
26972 "Windows XP through to at least Windows 7."
26976 #: ../tools/virt-win-reg.pl:93
26978 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
26979 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
26980 "and C<HKEY_USERS\\.DEFAULT>."
26984 #: ../tools/virt-win-reg.pl:97
26986 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
26991 #: ../tools/virt-win-reg.pl:100
26993 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
26998 #: ../tools/virt-win-reg.pl:103
27003 #: ../tools/virt-win-reg.pl:105
27005 "This program is only meant for simple access to the registry. If you want "
27006 "to do complicated things with the registry, we suggest you download the "
27007 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
27008 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
27009 "L<hivexregedit(1)>."
27013 #: ../tools/virt-win-reg.pl:111
27018 #: ../tools/virt-win-reg.pl:113
27020 "C<virt-win-reg> expects that regedit files have already been reencoded in "
27021 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
27022 "style line endings. Since Windows regedit files are often in UTF-16LE with "
27023 "Windows-style line endings, you may need to reencode the whole file before "
27024 "or after processing."
27028 #: ../tools/virt-win-reg.pl:119
27030 "To reencode a file from Windows format to Linux (before processing it with "
27031 "the C<--merge> option), you would do something like this:"
27035 #: ../tools/virt-win-reg.pl:122
27038 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
27043 #: ../tools/virt-win-reg.pl:124
27045 "To go in the opposite direction, after exporting and before sending the file "
27046 "to a Windows user, do something like this:"
27050 #: ../tools/virt-win-reg.pl:127
27053 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
27058 #: ../tools/virt-win-reg.pl:129
27059 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
27063 #: ../tools/virt-win-reg.pl:131
27065 "If you are unsure about the current encoding, use the L<file(1)> command. "
27066 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
27067 "style (CRLF) line endings, like this:"
27071 #: ../tools/virt-win-reg.pl:135
27074 " $ file software.reg\n"
27075 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
27076 " with CRLF line terminators\n"
27081 #: ../tools/virt-win-reg.pl:139
27082 msgid "This file would need conversion before you could C<--merge> it."
27086 #: ../tools/virt-win-reg.pl:143
27088 "Be careful when passing parameters containing C<\\> (backslash) in the "
27089 "shell. Usually you will have to use 'single quotes' or double backslashes "
27090 "(but not both) to protect them from the shell."
27094 #: ../tools/virt-win-reg.pl:147
27095 msgid "Paths and value names are case-insensitive."
27099 #: ../tools/virt-win-reg.pl:149
27100 msgid "CurrentControlSet etc."
27104 #: ../tools/virt-win-reg.pl:151
27106 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
27107 "Registry at the level of the hive file, and therefore you cannot modify "
27112 #: ../tools/virt-win-reg.pl:155
27114 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
27115 "circumstances it might refer to another control set. The way to find out is "
27116 "to look at the C<HKLM\\SYSTEM\\Select> key:"
27120 #: ../tools/virt-win-reg.pl:159
27123 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
27124 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
27125 " \"Current\"=dword:00000001\n"
27126 " \"Default\"=dword:00000001\n"
27127 " \"Failed\"=dword:00000000\n"
27128 " \"LastKnownGood\"=dword:00000002\n"
27133 #: ../tools/virt-win-reg.pl:166
27134 msgid "\"Current\" is the one which Windows will choose when it boots."
27138 #: ../tools/virt-win-reg.pl:168
27140 "Similarly, other C<Current...> keys in the path may need to be replaced."
27144 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
27149 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:501
27150 msgid "Enable debugging messages."
27154 #: ../tools/virt-win-reg.pl:232
27159 #: ../tools/virt-win-reg.pl:234
27161 "In merge mode, this merges a textual regedit file into the Windows Registry "
27162 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
27163 "displays or exports Registry entries instead."
27167 #: ../tools/virt-win-reg.pl:238
27169 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
27170 "result in disk corruption. However exporting (without this flag) is always "
27175 #: ../tools/virt-win-reg.pl:246
27176 msgid "B<--encoding> UTF-16LE|ASCII"
27180 #: ../tools/virt-win-reg.pl:248
27182 "When merging (only), you may need to specify the encoding for strings to be "
27183 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
27184 "(3)/ENCODING STRINGS>."
27188 #: ../tools/virt-win-reg.pl:252
27190 "The default is to use UTF-16LE, which should work with recent versions of "
27195 #: ../tools/virt-win-reg.pl:486
27197 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
27198 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
27199 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27203 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
27205 "When reporting bugs, please enable debugging and capture the I<complete> "
27210 #: ../tools/virt-win-reg.pl:504
27213 " export LIBGUESTFS_DEBUG=1\n"
27214 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
27219 #: ../tools/virt-win-reg.pl:507
27221 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
27226 #: ../tools/virt-df.pl:36
27227 msgid "virt-df - Display free space on virtual filesystems"
27231 #: ../tools/virt-df.pl:40
27234 " virt-df [--options]\n"
27239 #: ../tools/virt-df.pl:42
27242 " virt-df [--options] domname\n"
27247 #: ../tools/virt-df.pl:44
27250 " virt-df [--options] disk.img [disk.img ...]\n"
27255 #: ../tools/virt-df.pl:48
27257 "C<virt-df> is a command line tool to display free space on virtual machine "
27258 "filesystems. Unlike other tools, it doesn't just display the amount of "
27259 "space allocated to a virtual machine, but can look inside the virtual "
27260 "machine to see how much space is really being used."
27264 #: ../tools/virt-df.pl:53
27266 "It is like the L<df(1)> command, but for virtual machines, except that it "
27267 "also works for Windows virtual machines."
27271 #: ../tools/virt-df.pl:56
27273 "If used without any arguments, C<virt-df> checks with libvirt to get a list "
27274 "of all active and inactive guests, and performs a C<df>-type operation on "
27275 "each one in turn, printing out the results."
27279 #: ../tools/virt-df.pl:60
27281 "If used with any argument(s), C<virt-df> performs a C<df>-type operation on "
27282 "either the single named libvirt domain, or on the disk image(s) listed on "
27283 "the command line (which must all belong to a single VM). In this mode (with "
27284 "arguments), C<virt-df> will I<only work for a single guest>. If you want to "
27285 "run on multiple guests, then you have to invoke C<virt-df> multiple times."
27289 #: ../tools/virt-df.pl:67
27291 "Use the C<--csv> option to get a format which can be easily parsed by other "
27292 "programs. Other options are mostly similar to standard C<df> options. See "
27293 "below for the complete list."
27297 #: ../tools/virt-df.pl:107
27302 #: ../tools/virt-df.pl:109
27304 "Write out the results in CSV format (comma-separated values). This format "
27305 "can be imported easily into databases and spreadsheets, but read L</NOTE "
27306 "ABOUT CSV FORMAT> below."
27310 #: ../tools/virt-df.pl:134
27311 msgid "B<--human-readable> | B<-h>"
27315 #: ../tools/virt-df.pl:136
27316 msgid "Print sizes in human-readable format."
27320 #: ../tools/virt-df.pl:138
27321 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
27325 #: ../tools/virt-df.pl:144
27326 msgid "B<--inodes> | B<-i>"
27330 #: ../tools/virt-df.pl:146
27331 msgid "Print inodes instead of blocks."
27335 #: ../tools/virt-df.pl:152
27336 msgid "B<--one-per-guest>"
27340 #: ../tools/virt-df.pl:154
27342 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
27343 "disks from several guests to a single libguestfs appliance."
27347 #: ../tools/virt-df.pl:157
27348 msgid "You might use this option in the following circumstances:"
27352 #: ../tools/virt-df.pl:163
27354 "If you think an untrusted guest might actively try to exploit the libguestfs "
27355 "appliance kernel, then this prevents one guest from interfering with the "
27356 "stats printed for another guest."
27360 #: ../tools/virt-df.pl:169
27362 "If the kernel has a bug which stops it from accessing a filesystem in one "
27363 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
27364 "and report stats for further guests."
27368 #: ../tools/virt-df.pl:180
27373 #: ../tools/virt-df.pl:182
27375 "Print UUIDs instead of names. This is useful for following a guest even "
27376 "when the guest is migrated or renamed, or when two guests happen to have the "
27381 #: ../tools/virt-df.pl:186
27383 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
27384 "images, we still print the disk image name even when this option is "
27389 #: ../tools/virt-df.pl:609
27390 msgid "NOTE ABOUT CSV FORMAT"
27394 #: ../tools/virt-df.pl:611
27396 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
27397 "should be easy to parse, but it is definitely not easy to parse."
27401 #: ../tools/virt-df.pl:614
27403 "Myth: Just split fields at commas. Reality: This does I<not> work "
27404 "reliably. This example has two columns:"
27408 #: ../tools/virt-df.pl:617
27411 " \"foo,bar\",baz\n"
27416 #: ../tools/virt-df.pl:619
27418 "Myth: Read the file one line at a time. Reality: This does I<not> work "
27419 "reliably. This example has one row:"
27423 #: ../tools/virt-df.pl:622
27432 #: ../tools/virt-df.pl:625
27434 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
27435 "packaged in major Linux distributions)."
27439 #: ../tools/virt-df.pl:628
27441 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
27442 "or Python's built-in csv library)."
27446 #: ../tools/virt-df.pl:631
27447 msgid "Most spreadsheets and databases can import CSV directly."
27451 #: ../tools/virt-df.pl:642
27453 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
27454 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27458 #: ../tools/virt-ls.pl:34
27459 msgid "virt-ls - List files in a virtual machine"
27463 #: ../tools/virt-ls.pl:38
27466 " virt-ls [--options] domname directory\n"
27471 #: ../tools/virt-ls.pl:40
27474 " virt-ls [--options] disk.img [disk.img ...] directory\n"
27479 #: ../tools/virt-ls.pl:44
27481 "C<virt-ls> is a command line tool to list the names of files in a directory "
27482 "inside a virtual machine or disk image."
27486 #: ../tools/virt-ls.pl:47
27488 "C<virt-ls> is just a simple wrapper around L<libguestfs(3)> functionality. "
27489 "For more complex cases you should look at the L<guestfish(1)> tool."
27493 #: ../tools/virt-ls.pl:51
27495 "C<virt-ls> can be used in one of three modes: simple, long and recursive. A "
27496 "simple listing is like the ordinary L<ls(1)> command:"
27500 #: ../tools/virt-ls.pl:54
27503 " $ virt-ls myguest /\n"
27511 #: ../tools/virt-ls.pl:59
27512 msgid "With the C<-l> (C<--long>) option, C<virt-ls> shows more detail:"
27516 #: ../tools/virt-ls.pl:61
27519 " $ virt-ls -l myguest /\n"
27521 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
27522 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
27528 #: ../tools/virt-ls.pl:67
27530 "With the C<-R> (C<--recursive>) option, C<virt-ls> lists the names of files "
27531 "and directories recursively:"
27535 #: ../tools/virt-ls.pl:70
27538 " $ virt-ls -R myguest /tmp\n"
27546 #: ../tools/virt-ls.pl:75
27548 "You I<cannot> combine these options. To do more complicated things, use "
27553 #: ../tools/virt-ls.pl:131 ../tools/virt-list-filesystems.pl:103
27554 #: ../tools/virt-list-partitions.pl:112
27555 msgid "B<-l> | B<--long>"
27559 #: ../tools/virt-ls.pl:133
27560 msgid "B<-R> | B<--recursive>"
27564 #: ../tools/virt-ls.pl:135
27566 "Select the mode. With neither of these options, C<virt-ls> produces a "
27567 "simple, flat list of the files in the named directory."
27571 #: ../tools/virt-ls.pl:138
27573 "C<virt-ls -l> produces a \"long listing\", which shows more detail (just "
27574 "like the plain C<ls -l> command)."
27578 #: ../tools/virt-ls.pl:141
27580 "C<virt-ls -R> produces a recursive list of files starting at the named "
27581 "directory. See the documentation for L<guestfs(3)/guestfs_find> for precise "
27586 #: ../tools/virt-ls.pl:145
27587 msgid "You cannot combine these options."
27591 #: ../tools/virt-ls.pl:234
27593 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<Sys::"
27594 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
27599 #: ../tools/virt-ls.pl:249 ../tools/virt-list-filesystems.pl:204
27600 #: ../tools/virt-tar.pl:298
27601 msgid "Copyright (C) 2009 Red Hat Inc."
27605 #: ../tools/virt-resize.pl:42
27606 msgid "virt-resize - Resize a virtual machine disk"
27610 #: ../tools/virt-resize.pl:46
27613 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
27614 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
27615 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
27620 #: ../tools/virt-resize.pl:52
27622 "Virt-resize is a tool which can resize a virtual machine disk, making it "
27623 "larger or smaller overall, and resizing or deleting any partitions contained "
27628 #: ../tools/virt-resize.pl:56
27630 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
27631 "not> be used on live virtual machines - for consistent results, shut the "
27632 "virtual machine down before resizing it."
27636 #: ../tools/virt-resize.pl:60
27638 "If you are not familiar with the associated tools: L<virt-list-partitions(1)"
27639 ">, L<virt-list-filesystems(1)> and L<virt-df(1)>, we recommend you go and "
27640 "read those manual pages first."
27644 #: ../tools/virt-resize.pl:68
27646 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
27647 "fill the extra 5GB of space."
27651 #: ../tools/virt-resize.pl:71
27654 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
27655 " virt-list-partitions -lht olddisk\n"
27656 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
27657 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
27662 #: ../tools/virt-resize.pl:76
27664 "As above, but make the /boot partition 200MB bigger, while giving the "
27665 "remaining space to /dev/sda2:"
27669 #: ../tools/virt-resize.pl:79
27672 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
27677 #: ../tools/virt-resize.pl:81
27678 msgid "As above, but the output format will be uncompressed qcow2:"
27682 #: ../tools/virt-resize.pl:83
27685 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
27686 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
27691 #: ../tools/virt-resize.pl:86
27692 msgid "DETAILED USAGE"
27696 #: ../tools/virt-resize.pl:88
27697 msgid "EXPANDING A VIRTUAL MACHINE DISK"
27701 #: ../tools/virt-resize.pl:92
27702 msgid "1. Shut down the virtual machine"
27706 #: ../tools/virt-resize.pl:94
27707 msgid "2. Locate input disk image"
27711 #: ../tools/virt-resize.pl:96
27713 "Locate the input disk image (ie. the file or device on the host containing "
27714 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
27715 "dumpxml> like this to find the disk image name:"
27719 #: ../tools/virt-resize.pl:100
27722 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
27723 " Found 1 nodes:\n"
27725 " <source dev=\"/dev/vg/lv_guest\" />\n"
27730 #: ../tools/virt-resize.pl:105
27731 msgid "3. Look at current sizing"
27735 #: ../tools/virt-resize.pl:107
27737 "Use L<virt-list-partitions(1)> to display the current partitions and sizes:"
27741 #: ../tools/virt-resize.pl:110
27744 " # virt-list-partitions -lht /dev/vg/lv_guest\n"
27745 " /dev/sda1 ext3 101.9M\n"
27746 " /dev/sda2 pv 7.9G\n"
27747 " /dev/sda device 8.0G\n"
27752 #: ../tools/virt-resize.pl:115
27754 "(This example is a virtual machine with an 8 GB disk which we would like to "
27755 "expand up to 10 GB)."
27759 #: ../tools/virt-resize.pl:118
27760 msgid "4. Create output disk"
27764 #: ../tools/virt-resize.pl:120
27766 "Virt-resize cannot do in-place disk modifications. You have to have space "
27767 "to store the resized output disk."
27771 #: ../tools/virt-resize.pl:123
27773 "To store the resized disk image in a file, create a file of a suitable size:"
27777 #: ../tools/virt-resize.pl:126
27780 " # rm -f outdisk\n"
27781 " # truncate -s 10G outdisk\n"
27786 #: ../tools/virt-resize.pl:129
27787 msgid "Or use L<lvcreate(1)> to create a logical volume:"
27791 #: ../tools/virt-resize.pl:131
27794 " # lvcreate -L 10G -n lv_name vg_name\n"
27799 #: ../tools/virt-resize.pl:133
27800 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
27804 #: ../tools/virt-resize.pl:135
27807 " # virsh pool-list\n"
27808 " # virsh vol-create-as poolname newvol 10G\n"
27813 #: ../tools/virt-resize.pl:138
27818 #: ../tools/virt-resize.pl:140
27820 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
27821 "file) and the output disk. The output disk is the one created in the "
27826 #: ../tools/virt-resize.pl:144
27829 " # virt-resize indisk outdisk\n"
27834 #: ../tools/virt-resize.pl:146
27836 "This command just copies disk image C<indisk> to disk image C<outdisk> "
27837 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
27838 "larger, then an extra, empty partition is created at the end of the disk "
27839 "covering the extra space. If C<outdisk> is smaller, then it will give an "
27844 #: ../tools/virt-resize.pl:152
27846 "More realistically you'd want to expand existing partitions in the disk "
27847 "image by passing extra options (for the full list see the L</OPTIONS> "
27852 #: ../tools/virt-resize.pl:156
27854 "L</--expand> is the most useful option. It expands the named partition "
27855 "within the disk to fill any extra space:"
27859 #: ../tools/virt-resize.pl:159
27862 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
27867 #: ../tools/virt-resize.pl:161
27869 "(In this case, an extra partition is I<not> created at the end of the disk, "
27870 "because there will be no unused space)."
27874 #: ../tools/virt-resize.pl:164
27876 "L</--resize> is the other commonly used option. The following would "
27877 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
27878 "rest of the available space:"
27882 #: ../tools/virt-resize.pl:168
27885 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
27886 " indisk outdisk\n"
27891 #: ../tools/virt-resize.pl:171
27893 "If the expanded partition in the image contains a filesystem or LVM PV, then "
27894 "if virt-resize knows how, it will resize the contents, the equivalent of "
27895 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
27896 ">. However virt-resize does not know how to resize some filesystems, so you "
27897 "would have to online resize them after booting the guest. And virt-resize "
27898 "also does not resize anything inside an LVM PV, it just resizes the PV "
27899 "itself and leaves the user to resize any LVs inside that PV as desired."
27903 #: ../tools/virt-resize.pl:180
27904 msgid "Other options are covered below."
27908 #: ../tools/virt-resize.pl:182
27913 #: ../tools/virt-resize.pl:184
27914 msgid "Thoroughly test the new disk image I<before> discarding the old one."
27918 #: ../tools/virt-resize.pl:186
27919 msgid "If you are using libvirt, edit the XML to point at the new disk:"
27923 #: ../tools/virt-resize.pl:188
27926 " # virsh edit guestname\n"
27931 #: ../tools/virt-resize.pl:190
27933 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
27934 "html#elementsDisks>"
27938 #: ../tools/virt-resize.pl:193
27939 msgid "Then start up the domain with the new, resized disk:"
27943 #: ../tools/virt-resize.pl:195
27946 " # virsh start guestname\n"
27951 #: ../tools/virt-resize.pl:197
27953 "and check that it still works. See also the L</NOTES> section below for "
27954 "additional information."
27958 #: ../tools/virt-resize.pl:200
27959 msgid "7. Resize LVs etc inside the guest"
27963 #: ../tools/virt-resize.pl:202
27964 msgid "(This can also be done offline using L<guestfish(1)>)"
27968 #: ../tools/virt-resize.pl:204
27970 "Once the guest has booted you should see the new space available, at least "
27971 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
27972 "may need to resize LVs inside PVs, and also resize filesystem types that "
27973 "virt-resize does not know how to expand."
27977 #: ../tools/virt-resize.pl:211
27978 msgid "SHRINKING A VIRTUAL MACHINE DISK"
27982 #: ../tools/virt-resize.pl:213
27984 "Shrinking is somewhat more complex than expanding, and only an overview is "
27989 #: ../tools/virt-resize.pl:216
27991 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
27992 "filesystems). The user has to shrink content before passing the disk image "
27993 "to virt-resize, and virt-resize will check that the content has been shrunk "
27998 #: ../tools/virt-resize.pl:221
27999 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
28003 #: ../tools/virt-resize.pl:223
28005 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
28006 "steps 3 and 4 above to allocate a new disk image."
28010 #: ../tools/virt-resize.pl:226
28012 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
28016 #: ../tools/virt-resize.pl:229
28017 msgid "IGNORING OR DELETING PARTITIONS"
28021 #: ../tools/virt-resize.pl:231
28023 "virt-resize also gives a convenient way to ignore or delete partitions when "
28024 "copying from the input disk to the output disk. Ignoring a partition speeds "
28025 "up the copy where you don't care about the existing contents of a "
28026 "partition. Deleting a partition removes it completely, but note that it "
28027 "also renumbers any partitions after the one which is deleted, which can "
28028 "leave some guests unbootable."
28032 #: ../tools/virt-resize.pl:238
28033 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
28037 #: ../tools/virt-resize.pl:240
28039 "If the input disk is in qcow2 format, then you may prefer that the output is "
28040 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
28041 "the fly. The output format is simply determined by the format of the empty "
28042 "output container that you provide. Thus to create qcow2 output, use:"
28046 #: ../tools/virt-resize.pl:246
28049 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
28054 #: ../tools/virt-resize.pl:248
28055 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
28059 #: ../tools/virt-resize.pl:250
28060 msgid "Similarly, to get non-sparse raw output use:"
28064 #: ../tools/virt-resize.pl:252
28067 " fallocate -l size outdisk\n"
28072 #: ../tools/virt-resize.pl:254
28074 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
28075 "dev/zero of=outdisk bs=1M count=..>)"
28079 #: ../tools/virt-resize.pl:267
28080 msgid "Display help."
28084 #: ../tools/virt-resize.pl:281
28085 msgid "B<--resize part=size>"
28089 #: ../tools/virt-resize.pl:283
28091 "Resize the named partition (expanding or shrinking it) so that it has the "
28096 #: ../tools/virt-resize.pl:286
28098 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
28099 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
28100 "Exabytes; or as a percentage of the current size; or as a relative number or "
28101 "percentage. For example:"
28105 #: ../tools/virt-resize.pl:291
28108 " --resize /dev/sda2=10G\n"
28113 #: ../tools/virt-resize.pl:293
28116 " --resize /dev/sda4=90%\n"
28121 #: ../tools/virt-resize.pl:295
28124 " --resize /dev/sda2=+1G\n"
28129 #: ../tools/virt-resize.pl:297
28132 " --resize /dev/sda2=-200M\n"
28137 #: ../tools/virt-resize.pl:299
28140 " --resize /dev/sda1=+128K\n"
28145 #: ../tools/virt-resize.pl:301
28148 " --resize /dev/sda1=+10%\n"
28153 #: ../tools/virt-resize.pl:303
28156 " --resize /dev/sda1=-10%\n"
28161 #: ../tools/virt-resize.pl:305
28163 "You can increase the size of any partition. Virt-resize will expand the "
28164 "direct content of the partition if it knows how (see C<--expand> below)."
28168 #: ../tools/virt-resize.pl:309
28170 "You can only I<decrease> the size of partitions that contain filesystems or "
28171 "PVs which have already been shrunk. Virt-resize will check this has been "
28172 "done before proceeding, or else will print an error (see also C<--resize-"
28177 #: ../tools/virt-resize.pl:314 ../tools/virt-resize.pl:406
28178 #: ../tools/virt-resize.pl:423
28179 msgid "You can give this option multiple times."
28183 #: ../tools/virt-resize.pl:320
28184 msgid "B<--resize-force part=size>"
28188 #: ../tools/virt-resize.pl:322
28190 "This is the same as C<--resize> except that it will let you decrease the "
28191 "size of any partition. Generally this means you will lose any data which "
28192 "was at the end of the partition you shrink, but you may not care about that "
28193 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
28194 "as a swap partition)."
28198 #: ../tools/virt-resize.pl:328
28199 msgid "See also the C<--ignore> option."
28203 #: ../tools/virt-resize.pl:334
28204 msgid "B<--expand part>"
28208 #: ../tools/virt-resize.pl:336
28210 "Expand the named partition so it uses up all extra space (space left over "
28211 "after any other resize changes that you request have been done)."
28215 #: ../tools/virt-resize.pl:339
28217 "If virt-resize knows how, it will expand the direct content of the "
28218 "partition. For example, if the partition is an LVM PV, it will expand the "
28219 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
28220 "content it doesn't know about alone."
28224 #: ../tools/virt-resize.pl:344
28225 msgid "Currently virt-resize can resize:"
28229 #: ../tools/virt-resize.pl:350
28231 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
28236 #: ../tools/virt-resize.pl:355
28238 "NTFS filesystems contained directly in a partition, if libguestfs was "
28239 "compiled with support for NTFS."
28243 #: ../tools/virt-resize.pl:358
28245 "The filesystem must have been shut down consistently last time it was used. "
28246 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
28247 "consistency check, so at the first boot after resizing Windows will check "
28252 #: ../tools/virt-resize.pl:365
28254 "LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
28255 "inside the PV. The user will have to resize LVs as desired."
28259 #: ../tools/virt-resize.pl:371 ../tools/virt-resize.pl:393
28260 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
28264 #: ../tools/virt-resize.pl:377
28265 msgid "B<--shrink part>"
28269 #: ../tools/virt-resize.pl:379
28271 "Shrink the named partition until the overall disk image fits in the "
28272 "destination. The named partition B<must> contain a filesystem or PV which "
28273 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
28274 "online tools). Virt-resize will check this and give an error if it has not "
28279 #: ../tools/virt-resize.pl:385
28281 "The amount by which the overall disk must be shrunk (after carrying out all "
28282 "other operations requested by the user) is called the \"deficit\". For "
28283 "example, a straight copy (assume no other operations) from a 5GB disk image "
28284 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
28285 "would give an error unless the user specified a partition to shrink and that "
28286 "partition had more than a gigabyte of free space."
28290 #: ../tools/virt-resize.pl:399
28291 msgid "B<--ignore part>"
28295 #: ../tools/virt-resize.pl:401
28297 "Ignore the named partition. Effectively this means the partition is "
28298 "allocated on the destination disk, but the content is not copied across from "
28299 "the source disk. The content of the partition will be blank (all zero "
28304 #: ../tools/virt-resize.pl:412
28305 msgid "B<--delete part>"
28309 #: ../tools/virt-resize.pl:414
28311 "Delete the named partition. It would be more accurate to describe this as "
28312 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
28313 "the original disk image is left intact."
28317 #: ../tools/virt-resize.pl:418
28319 "Note that when you delete a partition, then anything contained in the "
28320 "partition is also deleted. Furthermore, this causes any partitions that "
28321 "come after to be I<renumbered>, which can easily make your guest unbootable."
28325 #: ../tools/virt-resize.pl:429
28326 msgid "B<--LV-expand logvol>"
28330 #: ../tools/virt-resize.pl:431
28332 "This takes the logical volume and, as a final step, expands it to fill all "
28333 "the space available in its volume group. A typical usage, assuming a Linux "
28334 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
28335 "lv_root> would be:"
28339 #: ../tools/virt-resize.pl:436
28342 " virt-resize indisk outdisk \\\n"
28343 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
28348 #: ../tools/virt-resize.pl:439
28350 "This would first expand the partition (and PV), and then expand the root "
28351 "device to fill the extra space in the PV."
28355 #: ../tools/virt-resize.pl:442
28357 "The contents of the LV are also resized if virt-resize knows how to do "
28358 "that. You can stop virt-resize from trying to expand the content by using "
28359 "the option C<--no-expand-content>."
28363 #: ../tools/virt-resize.pl:446
28364 msgid "Use L<virt-list-filesystems(1)> to list the filesystems in the guest."
28368 #: ../tools/virt-resize.pl:449
28370 "You can give this option multiple times, I<but> it doesn't make sense to do "
28371 "this unless the logical volumes you specify are all in different volume "
28376 #: ../tools/virt-resize.pl:457
28377 msgid "B<--no-copy-boot-loader>"
28381 #: ../tools/virt-resize.pl:459
28383 "By default, virt-resize copies over some sectors at the start of the disk "
28384 "(up to the beginning of the first partition). Commonly these sectors "
28385 "contain the Master Boot Record (MBR) and the boot loader, and are required "
28386 "in order for the guest to boot correctly."
28390 #: ../tools/virt-resize.pl:464
28392 "If you specify this flag, then this initial copy is not done. You may need "
28393 "to reinstall the boot loader in this case."
28397 #: ../tools/virt-resize.pl:472
28398 msgid "B<--no-extra-partition>"
28402 #: ../tools/virt-resize.pl:474
28404 "By default, virt-resize creates an extra partition if there is any extra, "
28405 "unused space after all resizing has happened. Use this option to prevent "
28406 "the extra partition from being created. If you do this then the extra space "
28407 "will be inaccessible until you run fdisk, parted, or some other partitioning "
28408 "tool in the guest."
28412 #: ../tools/virt-resize.pl:480
28414 "Note that if the surplus space is smaller than 10 MB, no extra partition "
28419 #: ../tools/virt-resize.pl:487
28420 msgid "B<--no-expand-content>"
28424 #: ../tools/virt-resize.pl:489
28426 "By default, virt-resize will try to expand the direct contents of "
28427 "partitions, if it knows how (see C<--expand> option above)."
28431 #: ../tools/virt-resize.pl:492
28433 "If you give the C<--no-expand-content> option then virt-resize will not "
28438 #: ../tools/virt-resize.pl:499
28439 msgid "B<-d> | B<--debug>"
28443 #: ../tools/virt-resize.pl:507
28444 msgid "B<-n> | B<--dryrun>"
28448 #: ../tools/virt-resize.pl:509
28449 msgid "Print a summary of what would be done, but don't do anything."
28453 #: ../tools/virt-resize.pl:515
28454 msgid "B<-q> | B<--quiet>"
28458 #: ../tools/virt-resize.pl:517
28459 msgid "Don't print the summary."
28463 #: ../tools/virt-resize.pl:525
28465 "Specify the format of the input disk image. If this flag is not given then "
28466 "it is auto-detected from the image itself."
28470 #: ../tools/virt-resize.pl:531
28472 "Note that this option I<does not> affect the output format. See L</QCOW2 "
28473 "AND NON-SPARSE RAW FORMATS>."
28477 #: ../tools/virt-resize.pl:538
28478 msgid "B<--output-format> raw"
28482 #: ../tools/virt-resize.pl:540
28484 "Specify the format of the output disk image. If this flag is not given then "
28485 "it is auto-detected from the image itself."
28489 #: ../tools/virt-resize.pl:546
28491 "Note that you still need to create the output disk with the right format. "
28492 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
28496 #: ../tools/virt-resize.pl:1422 ../tools/virt-rescue.pl:90
28501 #: ../tools/virt-resize.pl:1424
28502 msgid "\"Partition 1 does not end on cylinder boundary.\""
28506 #: ../tools/virt-resize.pl:1426
28508 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
28509 "means the partitions will not be aligned to the ancient CHS geometry. "
28510 "However CHS geometry is meaningless for disks manufactured since the early "
28511 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
28512 "cylinders is not required by any modern operating system."
28516 #: ../tools/virt-resize.pl:1433
28517 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
28521 #: ../tools/virt-resize.pl:1435
28523 "In Windows Vista and later versions, Microsoft switched to using a separate "
28524 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
28525 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
28526 "the boot partition. Doing so seems to break the guest completely. However "
28527 "expanding the second partition (ie. C: drive) should work."
28531 #: ../tools/virt-resize.pl:1442
28533 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
28534 "NTFS partitions have been expanded. This is just a safety check and (unless "
28535 "it find errors) is nothing to worry about."
28539 #: ../tools/virt-resize.pl:1446
28540 msgid "GUEST BOOT STUCK AT \"GRUB\""
28544 #: ../tools/virt-resize.pl:1448
28546 "If a Linux guest does not boot after resizing, and the boot is stuck after "
28547 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
28548 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
28549 "although we think is to do with partition alignment."
28553 #: ../tools/virt-resize.pl:1453
28556 " guestfish -i -a newdisk\n"
28557 " ><fs> cat /boot/grub/device.map\n"
28558 " # check the contents of this file are sensible or\n"
28559 " # edit the file if necessary\n"
28560 " ><fs> grub-install / /dev/vda\n"
28566 #: ../tools/virt-resize.pl:1460
28568 "For more flexible guest reconfiguration, including if you need to specify "
28569 "other parameters to grub-install, use L<virt-rescue(1)>."
28573 #: ../tools/virt-resize.pl:1463
28574 msgid "ALTERNATIVE TOOLS"
28578 #: ../tools/virt-resize.pl:1465
28580 "There are several proprietary tools for resizing partitions. We won't "
28581 "mention any here."
28585 #: ../tools/virt-resize.pl:1468
28587 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
28588 "operations on disk images. They can resize and move partitions, but I don't "
28589 "think they can do anything with the contents, and they certainly don't "
28594 #: ../tools/virt-resize.pl:1473
28596 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
28597 "but at a much lower level. You will probably end up hand-calculating sector "
28598 "offsets, which is something that virt-resize was designed to avoid. If you "
28599 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
28604 #: ../tools/virt-resize.pl:1488
28606 "L<virt-list-partitions(1)>, L<virt-list-filesystems(1)>, L<virt-df(1)>, "
28607 "L<guestfs(3)>, L<guestfish(1)>, L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, "
28608 "L<resize2fs(8)>, L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)"
28609 ">, L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
28610 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28614 #: ../tools/virt-list-filesystems.pl:32
28616 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
28620 #: ../tools/virt-list-filesystems.pl:36
28623 " virt-list-filesystems [--options] domname\n"
28628 #: ../tools/virt-list-filesystems.pl:38
28631 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
28636 #: ../tools/virt-list-filesystems.pl:42
28638 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
28639 "are contained in a virtual machine or disk image."
28643 #: ../tools/virt-list-filesystems.pl:46
28645 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
28646 "functionality. For more complex cases you should look at the L<guestfish(1)"
28651 #: ../tools/virt-list-filesystems.pl:105
28653 "With this option, C<virt-list-filesystems> displays the type of each "
28654 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
28658 #: ../tools/virt-list-filesystems.pl:112
28659 msgid "B<-a> | B<--all>"
28663 #: ../tools/virt-list-filesystems.pl:114
28665 "Normally we only show mountable filesystems. If this option is given then "
28666 "swap devices are shown too."
28670 #: ../tools/virt-list-filesystems.pl:188
28672 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-list-"
28673 "partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)"
28674 ">, L<http://libguestfs.org/>."
28678 #: ../tools/virt-tar.pl:33
28679 msgid "virt-tar - Extract or upload files to a virtual machine"
28683 #: ../tools/virt-tar.pl:37
28686 " virt-tar [--options] -x domname directory tarball\n"
28691 #: ../tools/virt-tar.pl:39
28694 " virt-tar [--options] -u domname tarball directory\n"
28699 #: ../tools/virt-tar.pl:41
28702 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
28707 #: ../tools/virt-tar.pl:43
28710 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
28715 #: ../tools/virt-tar.pl:47
28716 msgid "Download C</home> from the VM into a local tarball:"
28720 #: ../tools/virt-tar.pl:49
28723 " virt-tar -x domname /home home.tar\n"
28728 #: ../tools/virt-tar.pl:51
28731 " virt-tar -zx domname /home home.tar.gz\n"
28736 #: ../tools/virt-tar.pl:53
28737 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
28741 #: ../tools/virt-tar.pl:55
28744 " virt-tar -u domname uploadstuff.tar /tmp\n"
28749 #: ../tools/virt-tar.pl:57
28752 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
28757 #: ../tools/virt-tar.pl:61
28759 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
28760 "virtual machines. If you do this, you risk disk corruption in the VM. "
28761 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
28765 #: ../tools/virt-tar.pl:66
28767 "You can use C<-x> (extract) on live virtual machines, but you might get "
28768 "inconsistent results or errors if there is filesystem activity inside the "
28769 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
28770 "work, but the only way to guarantee consistent results is if the virtual "
28771 "machine is shut down."
28775 #: ../tools/virt-tar.pl:74
28777 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
28778 "parts of a guest filesystem. There are many possibilities: making backups, "
28779 "uploading data files, snooping on guest activity, fixing or customizing "
28784 #: ../tools/virt-tar.pl:79
28786 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
28787 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
28788 "should look at the L<guestfish(1)> tool."
28792 #: ../tools/virt-tar.pl:83
28794 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
28795 "its contents (recursively) from the virtual machine into a local tarball. "
28796 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
28797 "virtual machine. You cannot use these two options together."
28801 #: ../tools/virt-tar.pl:89
28803 "In addition, you may need to use the C<-z> (gZip) option to enable "
28804 "compression. When uploading, you have to specify C<-z> if the upload file "
28805 "is compressed because virt-tar won't detect this on its own."
28809 #: ../tools/virt-tar.pl:93
28811 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
28812 "example it cannot do PKZip files or bzip2 compression. If you want that "
28813 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
28814 "the L<libguestfs(3)> API)."
28818 #: ../tools/virt-tar.pl:151
28819 msgid "B<-x> | B<--extract> | B<--download>"
28823 #: ../tools/virt-tar.pl:153
28824 msgid "B<-u> | B<--upload>"
28828 #: ../tools/virt-tar.pl:155
28830 "Use C<-x> to extract (download) a directory from a virtual machine to a "
28835 #: ../tools/virt-tar.pl:158
28837 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
28838 "Please read the L</WARNING> section above before using this option."
28842 #: ../tools/virt-tar.pl:162
28843 msgid "You must specify exactly one of these options."
28847 #: ../tools/virt-tar.pl:168
28848 msgid "B<-z> | B<--gzip>"
28852 #: ../tools/virt-tar.pl:170
28853 msgid "Specify that the input or output tarball is gzip-compressed."
28857 #: ../tools/virt-tar.pl:283
28859 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<Sys::"
28860 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
28865 #: ../tools/virt-rescue.pl:33
28866 msgid "virt-rescue - Run a rescue shell on a virtual machine"
28870 #: ../tools/virt-rescue.pl:37
28873 " virt-rescue [--options] domname\n"
28878 #: ../tools/virt-rescue.pl:39
28881 " virt-rescue [--options] disk.img [disk.img ...]\n"
28886 #: ../tools/virt-rescue.pl:43
28888 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
28889 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
28890 "you from doing this, but doesn't catch all cases."
28894 #: ../tools/virt-rescue.pl:47
28896 "However if you use the I<--ro> (read only) option, then you can attach a "
28897 "shell to a live virtual machine. The results might be strange or "
28898 "inconsistent at times but you won't get disk corruption."
28902 #: ../tools/virt-rescue.pl:53
28904 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
28905 "need for a CD. virt-rescue gives you a rescue shell and some simple "
28906 "recovery tools which you can use to examine or rescue a virtual machine or "
28911 #: ../tools/virt-rescue.pl:58
28913 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
28914 "on disk image(s):"
28918 #: ../tools/virt-rescue.pl:61
28921 " virt-rescue GuestName\n"
28926 #: ../tools/virt-rescue.pl:63
28929 " virt-rescue --ro /path/to/disk.img\n"
28934 #: ../tools/virt-rescue.pl:65
28937 " virt-rescue /dev/sdc\n"
28942 #: ../tools/virt-rescue.pl:67
28943 msgid "For live VMs you I<must> use the --ro option."
28947 #: ../tools/virt-rescue.pl:69
28949 "When you run virt-rescue on a virtual machine or disk image, you are placed "
28950 "in an interactive bash shell where you can use many ordinary Linux "
28951 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
28952 "appliance. You must mount the virtual machine's filesystems by hand. There "
28953 "is an empty directory called C</sysroot> where you can mount filesystems."
28957 #: ../tools/virt-rescue.pl:76
28959 "In the example below, we list logical volumes, then choose one to mount "
28960 "under C</sysroot>:"
28964 #: ../tools/virt-rescue.pl:79
28968 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
28969 " lv_root vg_f11x64 -wi-a- 8.83G\n"
28970 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
28971 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
28972 " ><rescue> ls /sysroot\n"
28977 #: ../tools/virt-rescue.pl:86
28979 "If you don't know what filesystems are available on the virtual machine then "
28980 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
28984 #: ../tools/virt-rescue.pl:92
28986 "Virt-rescue can be used on I<any> disk image file or device, not just a "
28987 "virtual machine. For example you can use it on a blank file if you want to "
28988 "partition that file (although we would recommend using L<guestfish(1)> "
28989 "instead as it is more suitable for this purpose). You can even use virt-"
28990 "rescue on things like SD cards."
28994 #: ../tools/virt-rescue.pl:98
28996 "This tool is just designed for quick interactive hacking on a virtual "
28997 "machine. For more structured access to a virtual machine disk image, you "
28998 "should use L<guestfs(3)>. To get a structured shell that you can use to "
28999 "make scripted changes to guests, use L<guestfish(1)>."
29003 #: ../tools/virt-rescue.pl:127
29004 msgid "B<--append kernelopts>"
29008 #: ../tools/virt-rescue.pl:129
29009 msgid "Pass additional options to the rescue kernel."
29013 #: ../tools/virt-rescue.pl:164
29014 msgid "B<--memsize MB> | B<-m MB>"
29018 #: ../tools/virt-rescue.pl:166
29020 "Change the amount of memory allocated to the rescue system. The default is "
29021 "set by libguestfs and is small but adequate for running system tools. The "
29022 "occasional program might need more memory. The parameter is specified in "
29027 #: ../tools/virt-rescue.pl:175
29028 msgid "B<--network MB>"
29032 #: ../tools/virt-rescue.pl:177
29033 msgid "Enable QEMU user networking in the guest."
29037 #: ../tools/virt-rescue.pl:183
29038 msgid "B<--ro> | B<-r>"
29042 #: ../tools/virt-rescue.pl:185
29043 msgid "Open the image read-only."
29047 #: ../tools/virt-rescue.pl:197
29049 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
29050 "SELINUX> before using this option."
29054 #: ../tools/virt-rescue.pl:257
29056 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
29057 "ENVIRONMENT VARIABLES> for the complete list."
29061 #: ../tools/virt-rescue.pl:269
29063 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
29064 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29068 #: ../tools/virt-make-fs.pl:37
29069 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
29073 #: ../tools/virt-make-fs.pl:41
29076 " virt-make-fs [--options] input.tar output.img\n"
29081 #: ../tools/virt-make-fs.pl:43
29084 " virt-make-fs [--options] input.tar.gz output.img\n"
29089 #: ../tools/virt-make-fs.pl:45
29092 " virt-make-fs [--options] directory output.img\n"
29097 #: ../tools/virt-make-fs.pl:49
29099 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
29100 "archive or some files in a directory. It is similar to tools like L<mkisofs"
29101 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
29102 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
29103 "you want to attach these filesystems to existing virtual machines (eg. to "
29104 "import large amounts of read-only data to a VM)."
29108 #: ../tools/virt-make-fs.pl:57
29109 msgid "Basic usage is:"
29113 #: ../tools/virt-make-fs.pl:59
29116 " virt-make-fs input output\n"
29121 #: ../tools/virt-make-fs.pl:61
29123 "where C<input> is either a directory containing files that you want to add, "
29124 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
29125 "C<output> is a disk image. The input type is detected automatically. The "
29126 "output disk image defaults to a raw ext2 image unless you specify extra "
29127 "flags (see L</OPTIONS> below)."
29131 #: ../tools/virt-make-fs.pl:67
29132 msgid "EXTRA SPACE"
29136 #: ../tools/virt-make-fs.pl:69
29138 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
29139 "the files that it contains, but might have extra space. Depending on how "
29140 "you are going to use the output, you might think this extra space is wasted "
29141 "and want to minimize it, or you might want to leave space so that more files "
29142 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
29143 "but you can use the C<--size> flag to leave space in the filesystem if you "
29148 #: ../tools/virt-make-fs.pl:77
29150 "An alternative way to leave extra space but not make the output image any "
29151 "bigger is to use an alternative disk image format (instead of the default "
29152 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
29153 "image format (check your hypervisor supports this before using it). This "
29154 "allows you to choose a large C<--size> but the extra space won't actually be "
29155 "allocated in the image until you try to store something in it."
29159 #: ../tools/virt-make-fs.pl:85
29161 "Don't forget that you can also use local commands including L<resize2fs(8)> "
29162 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-"
29163 "resize to build another image from scratch."
29167 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
29168 #: ../tools/virt-make-fs.pl:142
29173 #: ../tools/virt-make-fs.pl:91
29176 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
29181 #: ../tools/virt-make-fs.pl:93
29182 msgid "FILESYSTEM TYPE"
29186 #: ../tools/virt-make-fs.pl:95
29188 "The default filesystem type is C<ext2>. Just about any filesystem type that "
29189 "libguestfs supports can be used (but I<not> read-only formats like "
29190 "ISO9660). Here are some of the more common choices:"
29194 #: ../tools/virt-make-fs.pl:101
29199 #: ../tools/virt-make-fs.pl:103
29201 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
29202 "you are not going to use the filesystem in a way that requires the journal, "
29203 "then this is just wasted overhead."
29207 #: ../tools/virt-make-fs.pl:107
29208 msgid "I<ntfs> or I<vfat>"
29212 #: ../tools/virt-make-fs.pl:109
29213 msgid "Useful if exporting data to a Windows guest."
29217 #: ../tools/virt-make-fs.pl:111
29219 "I<Note for vfat>: The tar archive or local directory must only contain files "
29220 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
29221 "program running within libguestfs is unable to change the ownership of non-"
29222 "root files, since vfat itself does not support this."
29226 #: ../tools/virt-make-fs.pl:116
29231 #: ../tools/virt-make-fs.pl:118
29233 "Lower overhead than C<ext2>, but certain limitations on filename length and "
29234 "total filesystem size."
29238 #: ../tools/virt-make-fs.pl:125
29241 " virt-make-fs --type=minix input minixfs.img\n"
29246 #: ../tools/virt-make-fs.pl:127
29247 msgid "TO PARTITION OR NOT TO PARTITION"
29251 #: ../tools/virt-make-fs.pl:129
29252 msgid "Optionally virt-make-fs can add a partition table to the output disk."
29256 #: ../tools/virt-make-fs.pl:131
29258 "Adding a partition can make the disk image more compatible with certain "
29259 "virtualized operating systems which don't expect to see a filesystem "
29260 "directly located on a block device (Linux doesn't care and will happily "
29261 "handle both types)."
29265 #: ../tools/virt-make-fs.pl:136
29267 "On the other hand, if you have a partition table then the output image is no "
29268 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
29269 "directly on a partitioned disk image. (However libguestfs tools such as "
29270 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
29274 #: ../tools/virt-make-fs.pl:144
29275 msgid "Add an MBR partition:"
29279 #: ../tools/virt-make-fs.pl:146
29282 " virt-make-fs --partition -- input disk.img\n"
29287 #: ../tools/virt-make-fs.pl:148
29289 "If the output disk image could be terabyte-sized or larger, it's better to "
29290 "use an EFI/GPT-compatible partition table:"
29294 #: ../tools/virt-make-fs.pl:151
29297 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
29302 #: ../tools/virt-make-fs.pl:179
29303 msgid "Enable debugging information."
29307 #: ../tools/virt-make-fs.pl:185
29308 msgid "B<--size=E<lt>NE<gt>>"
29312 #: ../tools/virt-make-fs.pl:187
29313 msgid "B<--size=+E<lt>NE<gt>>"
29317 #: ../tools/virt-make-fs.pl:189
29318 msgid "B<-s E<lt>NE<gt>>"
29322 #: ../tools/virt-make-fs.pl:191
29323 msgid "B<-s +E<lt>NE<gt>>"
29327 #: ../tools/virt-make-fs.pl:193
29329 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
29333 #: ../tools/virt-make-fs.pl:196
29335 "If this option is I<not> given, then the output image will be just large "
29336 "enough to contain all the files, with not much wasted space."
29340 #: ../tools/virt-make-fs.pl:199
29342 "To choose a fixed size output disk, specify an absolute number followed by b/"
29343 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29344 "Petabytes or Exabytes. This must be large enough to contain all the input "
29345 "files, else you will get an error."
29349 #: ../tools/virt-make-fs.pl:204
29351 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
29352 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29353 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
29354 "the input files, and (approximately) an extra 200 MB free space."
29358 #: ../tools/virt-make-fs.pl:210
29360 "Note that virt-make-fs estimates free space, and therefore will not produce "
29361 "filesystems containing precisely the free space requested. (It is much more "
29362 "expensive and time-consuming to produce a filesystem which has precisely the "
29363 "desired free space)."
29367 #: ../tools/virt-make-fs.pl:219
29368 msgid "B<--format=E<lt>fmtE<gt>>"
29372 #: ../tools/virt-make-fs.pl:221
29373 msgid "B<-F E<lt>fmtE<gt>>"
29377 #: ../tools/virt-make-fs.pl:223
29378 msgid "Choose the output disk image format."
29382 #: ../tools/virt-make-fs.pl:225
29383 msgid "The default is C<raw> (raw disk image)."
29387 #: ../tools/virt-make-fs.pl:227
29389 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
29390 "that would really make sense here is C<qcow2>."
29394 #: ../tools/virt-make-fs.pl:234
29395 msgid "B<--type=E<lt>fsE<gt>>"
29399 #: ../tools/virt-make-fs.pl:236
29400 msgid "B<-t E<lt>fsE<gt>>"
29404 #: ../tools/virt-make-fs.pl:238
29405 msgid "Choose the output filesystem type."
29409 #: ../tools/virt-make-fs.pl:240
29410 msgid "The default is C<ext2>."
29414 #: ../tools/virt-make-fs.pl:242
29416 "Any filesystem which is supported read-write by libguestfs can be used here."
29420 #: ../tools/virt-make-fs.pl:249
29421 msgid "B<--partition>"
29425 #: ../tools/virt-make-fs.pl:251
29426 msgid "B<--partition=E<lt>parttypeE<gt>>"
29430 #: ../tools/virt-make-fs.pl:253
29432 "If specified, this flag adds an MBR partition table to the output disk image."
29436 #: ../tools/virt-make-fs.pl:256
29438 "You can change the partition table type, eg. C<--partition=gpt> for large "
29443 #: ../tools/virt-make-fs.pl:259
29445 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
29446 "might consider the next parameter to be the partition type. For example:"
29450 #: ../tools/virt-make-fs.pl:263
29453 " virt-make-fs --partition input.tar ...\n"
29458 #: ../tools/virt-make-fs.pl:265
29460 "would cause virt-make-fs to think you wanted to use a partition type of "
29461 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
29462 "dash) between options and the input file argument:"
29466 #: ../tools/virt-make-fs.pl:269
29469 " virt-make-fs --partition -- input.tar ...\n"
29474 #: ../tools/virt-make-fs.pl:536
29476 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
29477 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
29478 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
29482 #: ../tools/virt-make-fs.pl:553
29485 " export LIBGUESTFS_DEBUG=1\n"
29486 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
29491 #: ../tools/virt-make-fs.pl:556
29493 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
29498 #: ../tools/virt-list-partitions.pl:32
29500 "virt-list-partitions - List partitions in a virtual machine or disk image"
29504 #: ../tools/virt-list-partitions.pl:36
29507 " virt-list-partitions [--options] domname\n"
29512 #: ../tools/virt-list-partitions.pl:38
29515 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
29520 #: ../tools/virt-list-partitions.pl:42
29522 "C<virt-list-partitions> is a command line tool to list the partitions that "
29523 "are contained in a virtual machine or disk image. It is mainly useful as a "
29524 "first step to using L<virt-resize(1)>."
29528 #: ../tools/virt-list-partitions.pl:47
29530 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
29531 "functionality. For more complex cases you should look at the L<guestfish(1)"
29536 #: ../tools/virt-list-partitions.pl:104
29537 msgid "B<-h> | B<--human-readable>"
29541 #: ../tools/virt-list-partitions.pl:106
29542 msgid "Show sizes in human-readable form (eg. \"1G\")."
29546 #: ../tools/virt-list-partitions.pl:114
29548 "With this option, C<virt-list-partitions> displays the type and size of each "
29549 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
29553 #: ../tools/virt-list-partitions.pl:121
29554 msgid "B<-t> | B<--total>"
29558 #: ../tools/virt-list-partitions.pl:123
29560 "Display the total size of each block device (as a separate row or rows)."
29564 #: ../tools/virt-list-partitions.pl:256
29566 "L<guestfs(3)>, L<guestfish(1)>, L<virt-list-filesystems(1)>, L<virt-resize(1)"
29567 ">, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://"
29568 "libguestfs.org/>."