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-05 12:18+0000\n"
11 "PO-Revision-Date: 2010-09-02 14:46+0100\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
20 #: ../src/guestfs.pod:1 ../fish/guestfish.pod:1
21 #: ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1
22 #: ../inspector/virt-inspector.pl:31 ../tools/virt-edit.pl:30
23 #: ../tools/virt-win-reg.pl:33 ../tools/virt-df.pl:32 ../tools/virt-ls.pl:30
24 #: ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28
25 #: ../tools/virt-cat.pl:29 ../tools/virt-tar.pl:29 ../tools/virt-rescue.pl:29
26 #: ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28
31 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
32 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
33 #: ../inspector/virt-inspector.pl:33 ../tools/virt-edit.pl:32
34 #: ../tools/virt-win-reg.pl:35 ../tools/virt-df.pl:34 ../tools/virt-ls.pl:32
35 #: ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30
36 #: ../tools/virt-cat.pl:31 ../tools/virt-tar.pl:31 ../tools/virt-rescue.pl:31
37 #: ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
42 #: ../src/guestfs.pod:5
43 msgid "guestfs - Library for accessing and modifying virtual machine images"
47 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
48 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
49 #: ../inspector/virt-inspector.pl:37 ../tools/virt-edit.pl:36
50 #: ../tools/virt-win-reg.pl:39 ../tools/virt-df.pl:38 ../tools/virt-ls.pl:36
51 #: ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34
52 #: ../tools/virt-cat.pl:35 ../tools/virt-tar.pl:35 ../tools/virt-rescue.pl:35
53 #: ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
58 #: ../src/guestfs.pod:9
61 " #include <guestfs.h>\n"
66 #: ../src/guestfs.pod:11
69 " guestfs_h *g = guestfs_create ();\n"
70 " guestfs_add_drive (g, \"guest.img\");\n"
71 " guestfs_launch (g);\n"
72 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
73 " guestfs_touch (g, \"/hello\");\n"
74 " guestfs_umount (g, \"/\");\n"
75 " guestfs_sync (g);\n"
76 " guestfs_close (g);\n"
81 #: ../src/guestfs.pod:20
84 " cc prog.c -o prog -lguestfs\n"
86 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
91 #: ../src/guestfs.pod:24 ../fish/guestfish.pod:30
92 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
93 #: ../inspector/virt-inspector.pl:43 ../tools/virt-edit.pl:50
94 #: ../tools/virt-win-reg.pl:63 ../tools/virt-df.pl:46 ../tools/virt-ls.pl:42
95 #: ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40
96 #: ../tools/virt-cat.pl:41 ../tools/virt-tar.pl:72 ../tools/virt-rescue.pl:51
97 #: ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
102 #: ../src/guestfs.pod:26
104 "Libguestfs is a library for accessing and modifying guest disk images. "
105 "Amongst the things this is good for: making batch configuration changes to "
106 "guests, getting disk used/free statistics (see also: virt-df), migrating "
107 "between virtualization systems (see also: virt-p2v), performing partial "
108 "backups, performing partial guest clones, cloning guests and changing "
109 "registry/UUID/hostname info, and much else besides."
113 #: ../src/guestfs.pod:34
115 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
116 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
117 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
122 #: ../src/guestfs.pod:39
124 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
125 "what filesystem is in each LV, etc.). It can also run commands in the "
126 "context of the guest. Also you can access filesystems over FUSE."
130 #: ../src/guestfs.pod:44
132 "Libguestfs is a library that can be linked with C and C++ management "
133 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
134 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
139 #: ../src/guestfs.pod:49
141 "You don't need to be root to use libguestfs, although obviously you do need "
142 "enough permissions to access the disk images."
146 #: ../src/guestfs.pod:52
148 "Libguestfs is a large API because it can do many things. For a gentle "
149 "introduction, please read the L</API OVERVIEW> section next."
153 #: ../src/guestfs.pod:55
158 #: ../src/guestfs.pod:57
160 "This section provides a gentler overview of the libguestfs API. We also try "
161 "to group API calls together, where that may not be obvious from reading "
162 "about the individual calls in the main section of this manual."
166 #: ../src/guestfs.pod:62
171 #: ../src/guestfs.pod:64
173 "Before you can use libguestfs calls, you have to create a handle. Then you "
174 "must add at least one disk image to the handle, followed by launching the "
175 "handle, then performing whatever operations you want, and finally closing "
176 "the handle. By convention we use the single letter C<g> for the name of the "
177 "handle variable, although of course you can use any name you want."
181 #: ../src/guestfs.pod:71
182 msgid "The general structure of all libguestfs-using programs looks like this:"
186 #: ../src/guestfs.pod:74
189 " guestfs_h *g = guestfs_create ();\n"
194 #: ../src/guestfs.pod:76
197 " /* Call guestfs_add_drive additional times if there are\n"
198 " * multiple disk images.\n"
200 " guestfs_add_drive (g, \"guest.img\");\n"
205 #: ../src/guestfs.pod:81
208 " /* Most manipulation calls won't work until you've launched\n"
209 " * the handle 'g'. You have to do this _after_ adding drives\n"
210 " * and _before_ other commands.\n"
212 " guestfs_launch (g);\n"
217 #: ../src/guestfs.pod:87
220 " /* Now you can examine what partitions, LVs etc are available.\n"
222 " char **partitions = guestfs_list_partitions (g);\n"
223 " char **logvols = guestfs_lvs (g);\n"
228 #: ../src/guestfs.pod:92
231 " /* To access a filesystem in the image, you must mount it.\n"
233 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
238 #: ../src/guestfs.pod:96
241 " /* Now you can perform filesystem actions on the guest\n"
244 " guestfs_touch (g, \"/hello\");\n"
249 #: ../src/guestfs.pod:101
252 " /* You only need to call guestfs_sync if you have made\n"
253 " * changes to the guest image. (But if you've made changes\n"
254 " * then you *must* sync). See also: guestfs_umount and\n"
255 " * guestfs_umount_all calls.\n"
257 " guestfs_sync (g);\n"
262 #: ../src/guestfs.pod:108
265 " /* Close the handle 'g'. */\n"
266 " guestfs_close (g);\n"
271 #: ../src/guestfs.pod:111
273 "The code above doesn't include any error checking. In real code you should "
274 "check return values carefully for errors. In general all functions that "
275 "return integers return C<-1> on error, and all functions that return "
276 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
277 "how to handle errors, and consult the documentation for each function call "
278 "below to see precisely how they return error indications."
282 #: ../src/guestfs.pod:119
287 #: ../src/guestfs.pod:121
289 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
290 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
291 "actual block device, or simply an empty file of zeroes that you have created "
292 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
297 #: ../src/guestfs.pod:127
299 "The call you should use in modern code for adding drives is L</"
300 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
301 "specifying that the format is raw, do:"
305 #: ../src/guestfs.pod:131
308 " guestfs_add_drive_opts (g, filename,\n"
309 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
315 #: ../src/guestfs.pod:135
316 msgid "You can add a disk read-only using:"
320 #: ../src/guestfs.pod:137
323 " guestfs_add_drive_opts (g, filename,\n"
324 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
325 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
331 #: ../src/guestfs.pod:142
333 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
334 "libguestfs won't modify the file."
338 #: ../src/guestfs.pod:145
340 "Be extremely cautious if the disk image is in use, eg. if it is being used "
341 "by a virtual machine. Adding it read-write will almost certainly cause disk "
342 "corruption, but adding it read-only is safe."
346 #: ../src/guestfs.pod:149
348 "You must add at least one disk image, and you may add multiple disk images. "
349 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
350 "first one you added), C</dev/sdb> (for the second one you added), etc."
354 #: ../src/guestfs.pod:154
356 "Once L</guestfs_launch> has been called you cannot add any more images. You "
357 "can call L</guestfs_list_devices> to get a list of the device names, in the "
358 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
362 #: ../src/guestfs.pod:159
367 #: ../src/guestfs.pod:161
369 "Before you can read or write files, create directories and so on in a disk "
370 "image that contains filesystems, you have to mount those filesystems using "
371 "L</guestfs_mount>. If you already know that a disk image contains (for "
372 "example) one partition with a filesystem on that partition, then you can "
377 #: ../src/guestfs.pod:167
380 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
385 #: ../src/guestfs.pod:169
387 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
388 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
389 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>)."
393 #: ../src/guestfs.pod:173
395 "If you are given a disk image and you don't know what it contains then you "
396 "have to find out. Libguestfs can do that too: use L</"
397 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
398 "LVs, and either try mounting each to see what is mountable, or else examine "
399 "them with L</guestfs_vfs_type> or L</guestfs_file>. Libguestfs also has a "
400 "set of APIs for inspection of disk images (see L</INSPECTION> below). But "
401 "you might find it easier to look at higher level programs built on top of "
402 "libguestfs, in particular L<virt-inspector(1)>."
406 #: ../src/guestfs.pod:183
408 "To mount a disk image read-only, use L</guestfs_mount_ro>. There are "
409 "several other variations of the C<guestfs_mount_*> call."
413 #: ../src/guestfs.pod:186
414 msgid "FILESYSTEM ACCESS AND MODIFICATION"
418 #: ../src/guestfs.pod:188
420 "The majority of the libguestfs API consists of fairly low-level calls for "
421 "accessing and modifying the files, directories, symlinks etc on mounted "
422 "filesystems. There are over a hundred such calls which you can find listed "
423 "in detail below in this man page, and we don't even pretend to cover them "
424 "all in this overview."
428 #: ../src/guestfs.pod:194
430 "Specify filenames as full paths, starting with C<\"/\"> and including the "
435 #: ../src/guestfs.pod:197
437 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
438 "the file called C<\"etc/passwd\"> then you could do:"
442 #: ../src/guestfs.pod:200
445 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
450 #: ../src/guestfs.pod:202
452 "This would return C<data> as a newly allocated buffer containing the full "
453 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
454 "or C<NULL> if there was an error."
458 #: ../src/guestfs.pod:206
460 "As another example, to create a top-level directory on that filesystem "
461 "called C<\"var\"> you would do:"
465 #: ../src/guestfs.pod:209
468 " guestfs_mkdir (g, \"/var\");\n"
473 #: ../src/guestfs.pod:211
474 msgid "To create a symlink you could do:"
478 #: ../src/guestfs.pod:213
481 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
482 " \"/etc/rc3.d/S30portmap\");\n"
487 #: ../src/guestfs.pod:216
489 "Libguestfs will reject attempts to use relative paths and there is no "
490 "concept of a current working directory."
494 #: ../src/guestfs.pod:219
496 "Libguestfs can return errors in many situations: for example if the "
497 "filesystem isn't writable, or if a file or directory that you requested "
498 "doesn't exist. If you are using the C API (documented here) you have to "
499 "check for those error conditions after each call. (Other language bindings "
500 "turn these errors into exceptions)."
504 #: ../src/guestfs.pod:225
506 "File writes are affected by the per-handle umask, set by calling L</"
507 "guestfs_umask> and defaulting to 022. See L</UMASK>."
511 #: ../src/guestfs.pod:228
516 #: ../src/guestfs.pod:230
518 "Libguestfs contains API calls to read, create and modify partition tables on "
523 #: ../src/guestfs.pod:233
525 "In the common case where you want to create a single partition covering the "
526 "whole disk, you should use the L</guestfs_part_disk> call:"
530 #: ../src/guestfs.pod:237
533 " const char *parttype = \"mbr\";\n"
534 " if (disk_is_larger_than_2TB)\n"
535 " parttype = \"gpt\";\n"
536 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
541 #: ../src/guestfs.pod:242
543 "Obviously this effectively wipes anything that was on that disk image before."
547 #: ../src/guestfs.pod:245
552 #: ../src/guestfs.pod:247
554 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
555 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
556 "you familiarize yourself with the concepts of physical volumes, volume "
557 "groups and logical volumes."
561 #: ../src/guestfs.pod:252
563 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
564 "tldp.org/HOWTO/LVM-HOWTO/>."
568 #: ../src/guestfs.pod:255
573 #: ../src/guestfs.pod:257
575 "Use L</guestfs_cat> to download small, text only files. This call is "
576 "limited to files which are less than 2 MB and which cannot contain any ASCII "
577 "NUL (C<\\0>) characters. However it has a very simple to use API."
581 #: ../src/guestfs.pod:262
583 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
584 "bit data, since it returns a (pointer, size) pair. However it is still "
585 "limited to \"small\" files, less than 2 MB."
589 #: ../src/guestfs.pod:266
591 "L</guestfs_download> can be used to download any file, with no limits on "
592 "content or size (even files larger than 4 GB)."
596 #: ../src/guestfs.pod:269
598 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
602 #: ../src/guestfs.pod:272
607 #: ../src/guestfs.pod:274
609 "It's often the case that you want to write a file or files to the disk image."
613 #: ../src/guestfs.pod:277
615 "To write a small file with fixed content, use L</guestfs_write>. To create "
616 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
617 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
618 "of other functions for creating test files, for example L</guestfs_fill> and "
619 "L</guestfs_fill_pattern>."
623 #: ../src/guestfs.pod:283
625 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
626 "file content or size (even files larger than 4 GB)."
630 #: ../src/guestfs.pod:286
632 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
636 #: ../src/guestfs.pod:288
638 "However the fastest way to upload I<large numbers of arbitrary files> is to "
639 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
640 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
641 "in a predictable way (eg. adding it last after all other drives) then you "
642 "can get the device name from L</guestfs_list_devices> and mount it directly "
643 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
644 "portable between kernel versions, and they don't support labels or UUIDs. "
645 "If you want to pre-build an image or you need to mount it using a label or "
646 "UUID, use an ISO image instead."
650 #: ../src/guestfs.pod:299
655 #: ../src/guestfs.pod:301
657 "There are various different commands for copying between files and devices "
658 "and in and out of the guest filesystem. These are summarised in the table "
663 #: ../src/guestfs.pod:307
664 msgid "B<file> to B<file>"
668 #: ../src/guestfs.pod:309
670 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
671 "directories recursively."
675 #: ../src/guestfs.pod:312
676 msgid "B<file or device> to B<file or device>"
680 #: ../src/guestfs.pod:314
682 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
683 "devices in the guest."
687 #: ../src/guestfs.pod:317
688 msgid "Example: duplicate the contents of an LV:"
692 #: ../src/guestfs.pod:319
695 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
700 #: ../src/guestfs.pod:321
702 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
703 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
704 "guestfs_copy_size>."
708 #: ../src/guestfs.pod:325
709 msgid "B<file on the host> to B<file or device>"
713 #: ../src/guestfs.pod:327
714 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
718 #: ../src/guestfs.pod:329
719 msgid "B<file or device> to B<file on the host>"
723 #: ../src/guestfs.pod:331
724 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
728 #: ../src/guestfs.pod:335
729 msgid "LISTING FILES"
733 #: ../src/guestfs.pod:337
735 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
736 "L<guestfish(1)>-equivalent command C<ll>)."
740 #: ../src/guestfs.pod:340
742 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
743 "programs, as a flat list of strings."
747 #: ../src/guestfs.pod:343
749 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
750 "directory, plus additional information about each one. It is more "
751 "equivalent to using the L<readdir(3)> call on a local filesystem."
755 #: ../src/guestfs.pod:347
757 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
761 #: ../src/guestfs.pod:350
762 msgid "RUNNING COMMANDS"
766 #: ../src/guestfs.pod:352
768 "Although libguestfs is primarily an API for manipulating files inside guest "
769 "images, we also provide some limited facilities for running commands inside "
774 #: ../src/guestfs.pod:356
775 msgid "There are many limitations to this:"
779 #: ../src/guestfs.pod:360 ../src/guestfs.pod:365 ../src/guestfs.pod:370
780 #: ../src/guestfs.pod:374 ../src/guestfs.pod:379 ../src/guestfs.pod:383
781 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:1224
782 #: ../src/guestfs.pod:1229 ../src/guestfs.pod:1233 ../src/guestfs.pod:1449
783 #: ../src/guestfs.pod:1454 ../src/guestfs.pod:1458 ../src/guestfs.pod:1560
784 #: ../src/guestfs.pod:1564 ../src/guestfs.pod:1568 ../src/guestfs.pod:1573
785 #: ../src/guestfs.pod:1581 ../src/guestfs.pod:1600 ../src/guestfs.pod:1608
786 #: ../src/guestfs.pod:1838 ../src/guestfs.pod:1844 ../src/guestfs.pod:1849
787 #: ../src/guestfs.pod:1855 ../src/guestfs.pod:1962 ../src/guestfs.pod:1966
788 #: ../src/guestfs.pod:1970 ../src/guestfs.pod:1974
789 #: ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22
790 #: ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:509
791 #: ../src/guestfs-actions.pod:516 ../src/guestfs-actions.pod:523
792 #: ../src/guestfs-actions.pod:1558 ../src/guestfs-actions.pod:1562
793 #: ../src/guestfs-actions.pod:1566 ../src/guestfs-actions.pod:1570
794 #: ../src/guestfs-actions.pod:1578 ../src/guestfs-actions.pod:1582
795 #: ../src/guestfs-actions.pod:1586 ../src/guestfs-actions.pod:1596
796 #: ../src/guestfs-actions.pod:1600 ../src/guestfs-actions.pod:1604
797 #: ../src/guestfs-actions.pod:1742 ../src/guestfs-actions.pod:1746
798 #: ../src/guestfs-actions.pod:1751 ../src/guestfs-actions.pod:1756
799 #: ../src/guestfs-actions.pod:1817 ../src/guestfs-actions.pod:1821
800 #: ../src/guestfs-actions.pod:1826 ../fish/guestfish.pod:364
801 #: ../fish/guestfish.pod:368 ../fish/guestfish.pod:372
802 #: ../fish/guestfish.pod:376 ../fish/guestfish-actions.pod:13
803 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:339
804 #: ../fish/guestfish-actions.pod:347 ../fish/guestfish-actions.pod:354
805 #: ../fish/guestfish-actions.pod:361 ../fish/guestfish-actions.pod:1056
806 #: ../fish/guestfish-actions.pod:1060 ../fish/guestfish-actions.pod:1064
807 #: ../fish/guestfish-actions.pod:1068 ../fish/guestfish-actions.pod:1076
808 #: ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084
809 #: ../fish/guestfish-actions.pod:1094 ../fish/guestfish-actions.pod:1098
810 #: ../fish/guestfish-actions.pod:1102 ../fish/guestfish-actions.pod:1192
811 #: ../fish/guestfish-actions.pod:1196 ../fish/guestfish-actions.pod:1201
812 #: ../fish/guestfish-actions.pod:1206 ../fish/guestfish-actions.pod:1248
813 #: ../fish/guestfish-actions.pod:1252 ../fish/guestfish-actions.pod:1257
814 #: ../inspector/virt-inspector.pl:584 ../inspector/virt-inspector.pl:588
815 #: ../tools/virt-df.pl:161 ../tools/virt-df.pl:167 ../tools/virt-resize.pl:348
816 #: ../tools/virt-resize.pl:353 ../tools/virt-resize.pl:363
821 #: ../src/guestfs.pod:362
823 "The kernel version that the command runs under will be different from what "
828 #: ../src/guestfs.pod:367
830 "If the command needs to communicate with daemons, then most likely they "
835 #: ../src/guestfs.pod:372
836 msgid "The command will be running in limited memory."
840 #: ../src/guestfs.pod:376
842 "The network may not be available unless you enable it (see L</"
843 "guestfs_set_network>)."
847 #: ../src/guestfs.pod:381
848 msgid "Only supports Linux guests (not Windows, BSD, etc)."
852 #: ../src/guestfs.pod:385
854 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
858 #: ../src/guestfs.pod:390
860 "For SELinux guests, you may need to enable SELinux and load policy first. "
861 "See L</SELINUX> in this manpage."
865 #: ../src/guestfs.pod:395
867 "I<Security:> It is not safe to run commands from untrusted, possibly "
868 "malicious guests. These commands may attempt to exploit your program by "
869 "sending unexpected output. They could also try to exploit the Linux kernel "
870 "or qemu provided by the libguestfs appliance. They could use the network "
871 "provided by the libguestfs appliance to bypass ordinary network partitions "
872 "and firewalls. They could use the elevated privileges or different SELinux "
873 "context of your program to their advantage."
877 #: ../src/guestfs.pod:404
879 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
880 "(a script which runs when the guest next boots normally), and to have this "
881 "script run the commands you want in the normal context of the running guest, "
882 "network security and so on."
886 #: ../src/guestfs.pod:411
888 "The two main API calls to run commands are L</guestfs_command> and L</"
889 "guestfs_sh> (there are also variations)."
893 #: ../src/guestfs.pod:414
895 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
896 "shell globs, redirections, etc will work."
900 #: ../src/guestfs.pod:417
901 msgid "CONFIGURATION FILES"
905 #: ../src/guestfs.pod:419
907 "To read and write configuration files in Linux guest filesystems, we "
908 "strongly recommend using Augeas. For example, Augeas understands how to "
909 "read and write, say, a Linux shadow password file or X.org configuration "
910 "file, and so avoids you having to write that code."
914 #: ../src/guestfs.pod:424
916 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
917 "document Augeas itself here because there is excellent documentation on the "
918 "L<http://augeas.net/> website."
922 #: ../src/guestfs.pod:428
924 "If you don't want to use Augeas (you fool!) then try calling L</"
925 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
930 #: ../src/guestfs.pod:432
935 #: ../src/guestfs.pod:434
937 "We support SELinux guests. To ensure that labeling happens correctly in "
938 "SELinux guests, you need to enable SELinux and load the guest's policy:"
942 #: ../src/guestfs.pod:440 ../src/guestfs.pod:953
947 #: ../src/guestfs.pod:442
948 msgid "Before launching, do:"
952 #: ../src/guestfs.pod:444
955 " guestfs_set_selinux (g, 1);\n"
960 #: ../src/guestfs.pod:446 ../src/guestfs.pod:957
965 #: ../src/guestfs.pod:448
967 "After mounting the guest's filesystem(s), load the policy. This is best "
968 "done by running the L<load_policy(8)> command in the guest itself:"
972 #: ../src/guestfs.pod:452
975 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
980 #: ../src/guestfs.pod:454
982 "(Older versions of C<load_policy> require you to specify the name of the "
987 #: ../src/guestfs.pod:457 ../src/guestfs.pod:963
992 #: ../src/guestfs.pod:459
994 "Optionally, set the security context for the API. The correct security "
995 "context to use can only be known by inspecting the guest. As an example:"
999 #: ../src/guestfs.pod:463
1002 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1007 #: ../src/guestfs.pod:467
1008 msgid "This will work for running commands and editing existing files."
1012 #: ../src/guestfs.pod:469
1014 "When new files are created, you may need to label them explicitly, for "
1015 "example by running the external command C<restorecon pathname>."
1019 #: ../src/guestfs.pod:473
1024 #: ../src/guestfs.pod:475
1026 "Certain calls are affected by the current file mode creation mask (the "
1027 "\"umask\"). In particular ones which create files or directories, such as "
1028 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1029 "either the default mode that the file is created with or modifies the mode "
1034 #: ../src/guestfs.pod:481
1036 "The default umask is C<022>, so files are created with modes such as C<0644> "
1037 "and directories with C<0755>."
1041 #: ../src/guestfs.pod:484
1043 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1044 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1045 "guestfs_chmod> after creating each file or directory."
1049 #: ../src/guestfs.pod:488
1050 msgid "For more information about umask, see L<umask(2)>."
1054 #: ../src/guestfs.pod:490 ../fish/guestfish.pod:630
1055 msgid "ENCRYPTED DISKS"
1059 #: ../src/guestfs.pod:492
1061 "Libguestfs allows you to access Linux guests which have been encrypted using "
1062 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1063 "standard. This includes nearly all whole disk encryption systems used by "
1064 "modern Linux guests."
1068 #: ../src/guestfs.pod:498
1070 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1071 "returns the string C<crypto_LUKS>)."
1075 #: ../src/guestfs.pod:501
1077 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1078 "will require the passphrase!"
1082 #: ../src/guestfs.pod:504
1084 "Opening a LUKS device creates a new device mapper device called C</dev/"
1085 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1086 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1087 "from and encrypted to the underlying block device respectively."
1091 #: ../src/guestfs.pod:510
1093 "LVM volume groups on the device can be made visible by calling L</"
1094 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1095 "(s) can now be mounted in the usual way."
1099 #: ../src/guestfs.pod:514
1101 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1102 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1103 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1104 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1105 "underlying encrypted block device)."
1109 #: ../src/guestfs.pod:521
1114 #: ../src/guestfs.pod:523
1116 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1117 "contains operating systems. (These APIs used to be in a separate Perl-only "
1118 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1119 "frequently used part of this library has been rewritten in C and moved into "
1124 #: ../src/guestfs.pod:529
1126 "Add all disks belonging to the unknown virtual machine and call L</"
1127 "guestfs_launch> in the usual way."
1131 #: ../src/guestfs.pod:532
1133 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1134 "and certain heuristics, and returns a list of operating systems that were "
1135 "found. An empty list means none were found. A single element is the root "
1136 "filesystem of the operating system. For dual- or multi-boot guests, "
1137 "multiple roots can be returned, each one corresponding to a separate "
1138 "operating system. (Multi-boot virtual machines are extremely rare in the "
1139 "world of virtualization, but since this scenario can happen, we have built "
1140 "libguestfs to deal with it.)"
1144 #: ../src/guestfs.pod:541
1146 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1147 "to get additional details about that operating system. For example, call L</"
1148 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1149 "Windows and Linux-based operating systems respectively."
1153 #: ../src/guestfs.pod:547
1155 "Un*x-like and Linux-based operating systems usually consist of several "
1156 "filesystems which are mounted at boot time (for example, a separate boot "
1157 "partition mounted on C</boot>). The inspection rules are able to detect how "
1158 "filesystems correspond to mount points. Call "
1159 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1160 "hash table like this example:"
1164 #: ../src/guestfs.pod:554
1167 " /boot => /dev/sda1\n"
1168 " / => /dev/vg_guest/lv_root\n"
1169 " /usr => /dev/vg_guest/lv_usr\n"
1174 #: ../src/guestfs.pod:558
1176 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1177 "filesystems as suggested."
1181 #: ../src/guestfs.pod:561
1183 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1184 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1188 #: ../src/guestfs.pod:565
1190 "Inspection currently only works for some common operating systems. "
1191 "Contributors are welcome to send patches for other operating systems that we "
1192 "currently cannot detect."
1196 #: ../src/guestfs.pod:569
1198 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1199 "for more details. The L</guestfs_inspect_os> function just ignores any "
1200 "encrypted devices."
1204 #: ../src/guestfs.pod:573
1206 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1207 "inspection and caches the results in the guest handle. Subsequent calls to "
1208 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1209 "read the disks. If you change the content of the guest disks, you can redo "
1210 "inspection by calling L</guestfs_inspect_os> again."
1214 #: ../src/guestfs.pod:580
1215 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1219 #: ../src/guestfs.pod:582
1221 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1222 "ntfs-3g.org/> driver."
1226 #: ../src/guestfs.pod:585
1228 "DOS and Windows still use drive letters, and the filesystems are always "
1229 "treated as case insensitive by Windows itself, and therefore you might find "
1230 "a Windows configuration file referring to a path like C<c:\\windows"
1231 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1232 "might be referred to as C</WINDOWS/System32>."
1236 #: ../src/guestfs.pod:591
1238 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1239 "libguestfs to read the appropriate Windows Registry and configuration files, "
1240 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1245 #: ../src/guestfs.pod:596
1247 "Replacing backslash characters with forward slash characters is also outside "
1248 "the scope of libguestfs, but something that you can easily do."
1252 #: ../src/guestfs.pod:599
1254 "Where we can help is in resolving the case insensitivity of paths. For "
1255 "this, call L</guestfs_case_sensitive_path>."
1259 #: ../src/guestfs.pod:602
1261 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1262 "files, through the library C<hivex> which is part of the libguestfs project "
1263 "although ships as a separate tarball. You have to locate and download the "
1264 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1265 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1266 "reg(1)> for more help on this issue."
1270 #: ../src/guestfs.pod:610
1271 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1275 #: ../src/guestfs.pod:612
1277 "Although we don't want to discourage you from using the C API, we will "
1278 "mention here that the same API is also available in other languages."
1282 #: ../src/guestfs.pod:615
1284 "The API is broadly identical in all supported languages. This means that "
1285 "the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, C<g."
1286 "mount(path)> in Python, and C<Guestfs.mount g path> in OCaml. In other "
1287 "words, a straightforward, predictable isomorphism between each language."
1291 #: ../src/guestfs.pod:621
1293 "Error messages are automatically transformed into exceptions if the language "
1298 #: ../src/guestfs.pod:624
1300 "We don't try to \"object orientify\" parts of the API in OO languages, "
1301 "although contributors are welcome to write higher level APIs above what we "
1302 "provide in their favourite languages if they wish."
1306 #: ../src/guestfs.pod:630
1311 #: ../src/guestfs.pod:632
1313 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1314 "identical to the C API. C++ classes and exceptions are not used."
1318 #: ../src/guestfs.pod:636
1323 #: ../src/guestfs.pod:638
1325 "The C# bindings are highly experimental. Please read the warnings at the "
1326 "top of C<csharp/Libguestfs.cs>."
1330 #: ../src/guestfs.pod:641
1335 #: ../src/guestfs.pod:643
1337 "This is the only language binding that is working but incomplete. Only "
1338 "calls which return simple integers have been bound in Haskell, and we are "
1339 "looking for help to complete this binding."
1343 #: ../src/guestfs.pod:647
1348 #: ../src/guestfs.pod:649
1350 "Full documentation is contained in the Javadoc which is distributed with "
1355 #: ../src/guestfs.pod:652
1360 #: ../src/guestfs.pod:654
1361 msgid "For documentation see the file C<guestfs.mli>."
1365 #: ../src/guestfs.pod:656
1370 #: ../src/guestfs.pod:658
1371 msgid "For documentation see L<Sys::Guestfs(3)>."
1375 #: ../src/guestfs.pod:660
1380 #: ../src/guestfs.pod:662
1382 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1383 "the php-libguestfs package for your distribution."
1387 #: ../src/guestfs.pod:665
1388 msgid "The PHP binding only works correctly on 64 bit machines."
1392 #: ../src/guestfs.pod:667
1397 #: ../src/guestfs.pod:669
1398 msgid "For documentation do:"
1402 #: ../src/guestfs.pod:671
1406 " >>> import guestfs\n"
1407 " >>> help (guestfs)\n"
1412 #: ../src/guestfs.pod:675
1417 #: ../src/guestfs.pod:677
1419 "Use the Guestfs module. There is no Ruby-specific documentation, but you "
1420 "can find examples written in Ruby in the libguestfs source."
1424 #: ../src/guestfs.pod:680
1425 msgid "B<shell scripts>"
1429 #: ../src/guestfs.pod:682
1430 msgid "For documentation see L<guestfish(1)>."
1434 #: ../src/guestfs.pod:686
1435 msgid "LIBGUESTFS GOTCHAS"
1439 #: ../src/guestfs.pod:688
1441 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1442 "system [...] that works in the way it is documented but is counterintuitive "
1443 "and almost invites mistakes.\""
1447 #: ../src/guestfs.pod:692
1449 "Since we developed libguestfs and the associated tools, there are several "
1450 "things we would have designed differently, but are now stuck with for "
1451 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1452 "release, you can expect these to change. Beware of them."
1456 #: ../src/guestfs.pod:700
1457 msgid "Autosync / forgetting to sync."
1461 #: ../src/guestfs.pod:702
1463 "When modifying a filesystem from C or another language, you B<must> unmount "
1464 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1465 "libguestfs handle. You can also call:"
1469 #: ../src/guestfs.pod:706
1472 " guestfs_set_autosync (g, 1);\n"
1477 #: ../src/guestfs.pod:708
1479 "to have the unmount/sync done automatically for you when the handle 'g' is "
1480 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1484 #: ../src/guestfs.pod:712
1486 "If you forget to do this, then it is entirely possible that your changes "
1487 "won't be written out, or will be partially written, or (very rarely) that "
1488 "you'll get disk corruption."
1492 #: ../src/guestfs.pod:716
1494 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1495 "guestfish scripts that forget to sync will work just fine, which can make "
1496 "this very puzzling if you are trying to debug a problem."
1500 #: ../src/guestfs.pod:720
1502 "Update: Autosync is enabled by default for all API users starting from "
1503 "libguestfs 1.5.24."
1507 #: ../src/guestfs.pod:723
1508 msgid "Mount option C<-o sync> should not be the default."
1512 #: ../src/guestfs.pod:725
1514 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1515 "However C<-o sync> does not add any reliability benefit, but does have a "
1516 "very large performance impact."
1520 #: ../src/guestfs.pod:729
1522 "The work around is to use L</guestfs_mount_options> and set the mount "
1523 "options that you actually want to use."
1527 #: ../src/guestfs.pod:732
1528 msgid "Read-only should be the default."
1532 #: ../src/guestfs.pod:734
1534 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1535 "specify I<--rw> if you want to make changes to the image."
1539 #: ../src/guestfs.pod:737
1540 msgid "This would reduce the potential to corrupt live VM images."
1544 #: ../src/guestfs.pod:739
1546 "Note that many filesystems change the disk when you just mount and unmount, "
1547 "even if you didn't perform any writes. You need to use L</"
1548 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1552 #: ../src/guestfs.pod:743
1553 msgid "guestfish command line is hard to use."
1557 #: ../src/guestfs.pod:745
1559 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1560 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1561 "exist, so it fails. In earlier versions of guestfish the error message was "
1562 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1563 "we should have used C<guestfish -c command> to run commands."
1567 #: ../src/guestfs.pod:752
1568 msgid "guestfish megabyte modifiers don't work right on all commands"
1572 #: ../src/guestfs.pod:754
1574 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1575 "other modifiers). What guestfish actually does is to multiply the number "
1576 "part by the modifier part and pass the result to the C API. However this "
1577 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1578 "expecting some other unit (eg. megabytes)."
1582 #: ../src/guestfs.pod:761
1583 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1587 #: ../src/guestfs.pod:763
1590 " lvcreate LV VG 100M\n"
1595 #: ../src/guestfs.pod:765
1597 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1598 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1599 "megabytes * megabytes) logical volume. The error message you get from this "
1600 "is also a little obscure."
1604 #: ../src/guestfs.pod:770
1606 "This could be fixed in the generator by specially marking parameters and "
1607 "return values which take bytes or other units."
1611 #: ../src/guestfs.pod:773
1612 msgid "Ambiguity between devices and paths"
1616 #: ../src/guestfs.pod:775
1618 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1619 "sdb2>) and a similar pathname. A file might just happen to be called "
1620 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1624 #: ../src/guestfs.pod:780
1626 "In the current API we usually resolve this ambiguity by having two separate "
1627 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1628 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1629 "detecting if the path supplied begins with C</dev/>."
1633 #: ../src/guestfs.pod:786
1635 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1636 "make paths/devices into structured names. One way to do this would be to "
1637 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1638 "aspect of grub. Another way would be to use a structured type, equivalent "
1639 "to this OCaml type:"
1643 #: ../src/guestfs.pod:792
1646 " type path = Path of string | Device of int | Partition of int * int\n"
1651 #: ../src/guestfs.pod:794
1652 msgid "which would allow you to pass arguments like:"
1656 #: ../src/guestfs.pod:796
1659 " Path \"/foo/bar\"\n"
1660 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1661 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1662 " Path \"/dev/sdb2\" (* not a device *)\n"
1667 #: ../src/guestfs.pod:801
1669 "As you can see there are still problems to resolve even with this "
1670 "representation. Also consider how it might work in guestfish."
1674 #: ../src/guestfs.pod:806
1675 msgid "PROTOCOL LIMITS"
1679 #: ../src/guestfs.pod:808
1681 "Internally libguestfs uses a message-based protocol to pass API calls and "
1682 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1683 "plenty more detail about this). The maximum message size used by the "
1684 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1685 "aware of this limit. The API calls which may be affected are individually "
1686 "documented, with a link back to this section of the documentation."
1690 #: ../src/guestfs.pod:816
1692 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1693 "a simple string. Because this string is at some point internally encoded as "
1694 "a message, the maximum size that it can return is slightly under 4 MB. If "
1695 "the requested file is larger than this then you will get an error."
1699 #: ../src/guestfs.pod:822
1701 "In order to transfer large files into and out of the guest filesystem, you "
1702 "need to use particular calls that support this. The sections L</UPLOADING> "
1703 "and L</DOWNLOADING> document how to do this."
1707 #: ../src/guestfs.pod:826
1709 "You might also consider mounting the disk image using our FUSE filesystem "
1710 "support (L<guestmount(1)>)."
1714 #: ../src/guestfs.pod:829
1715 msgid "KEYS AND PASSPHRASES"
1719 #: ../src/guestfs.pod:831
1721 "Certain libguestfs calls take a parameter that contains sensitive key "
1722 "material, passed in as a C string."
1726 #: ../src/guestfs.pod:834
1728 "In the future we would hope to change the libguestfs implementation so that "
1729 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1730 "swap. However this is I<not> done at the moment, because of the complexity "
1731 "of such an implementation."
1735 #: ../src/guestfs.pod:839
1737 "Therefore you should be aware that any key parameter you pass to libguestfs "
1738 "might end up being written out to the swap partition. If this is a concern, "
1739 "scrub the swap partition or don't use libguestfs on encrypted devices."
1743 #: ../src/guestfs.pod:844
1744 msgid "CONNECTION MANAGEMENT"
1748 #: ../src/guestfs.pod:846
1753 #: ../src/guestfs.pod:848
1755 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
1756 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
1757 "handle and release all resources used."
1761 #: ../src/guestfs.pod:852
1763 "For information on using multiple handles and threads, see the section L</"
1764 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
1768 #: ../src/guestfs.pod:855
1769 msgid "guestfs_create"
1773 #: ../src/guestfs.pod:857
1776 " guestfs_h *guestfs_create (void);\n"
1781 #: ../src/guestfs.pod:859
1782 msgid "Create a connection handle."
1786 #: ../src/guestfs.pod:861
1788 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
1789 "on the handle at least once."
1793 #: ../src/guestfs.pod:864
1795 "This function returns a non-NULL pointer to a handle on success or NULL on "
1800 #: ../src/guestfs.pod:867
1801 msgid "After configuring the handle, you have to call L</guestfs_launch>."
1805 #: ../src/guestfs.pod:869
1807 "You may also want to configure error handling for the handle. See L</ERROR "
1808 "HANDLING> section below."
1812 #: ../src/guestfs.pod:872
1813 msgid "guestfs_close"
1817 #: ../src/guestfs.pod:874
1820 " void guestfs_close (guestfs_h *g);\n"
1825 #: ../src/guestfs.pod:876
1826 msgid "This closes the connection handle and frees up all resources used."
1830 #: ../src/guestfs.pod:878
1831 msgid "ERROR HANDLING"
1835 #: ../src/guestfs.pod:880
1837 "API functions can return errors. For example, almost all functions that "
1838 "return C<int> will return C<-1> to indicate an error."
1842 #: ../src/guestfs.pod:883
1844 "Additional information is available for errors: an error message string and "
1845 "optionally an error number (errno) if the thing that failed was a system "
1850 #: ../src/guestfs.pod:887
1852 "You can get at the additional information about the last error on the handle "
1853 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
1854 "up an error handler with L</guestfs_set_error_handler>."
1858 #: ../src/guestfs.pod:892
1860 "When the handle is created, a default error handler is installed which "
1861 "prints the error message string to C<stderr>. For small short-running "
1862 "command line programs it is sufficient to do:"
1866 #: ../src/guestfs.pod:896
1869 " if (guestfs_launch (g) == -1)\n"
1870 " exit (EXIT_FAILURE);\n"
1875 #: ../src/guestfs.pod:899
1877 "since the default error handler will ensure that an error message has been "
1878 "printed to C<stderr> before the program exits."
1882 #: ../src/guestfs.pod:902
1884 "For other programs the caller will almost certainly want to install an "
1885 "alternate error handler or do error handling in-line like this:"
1889 #: ../src/guestfs.pod:905
1892 " g = guestfs_create ();\n"
1897 #: ../src/guestfs.pod:907
1900 " /* This disables the default behaviour of printing errors\n"
1902 " guestfs_set_error_handler (g, NULL, NULL);\n"
1907 #: ../src/guestfs.pod:911
1910 " if (guestfs_launch (g) == -1) {\n"
1911 " /* Examine the error message and print it etc. */\n"
1912 " char *msg = guestfs_last_error (g);\n"
1913 " int errnum = guestfs_last_errno (g);\n"
1914 " fprintf (stderr, \"%s\\n\", msg);\n"
1921 #: ../src/guestfs.pod:919
1923 "Out of memory errors are handled differently. The default action is to call "
1924 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
1925 "guestfs_set_out_of_memory_handler>."
1929 #: ../src/guestfs.pod:923
1931 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
1932 "because there is no handle if this happens there is no way to get additional "
1933 "error information. However L</guestfs_create> is supposed to be a "
1934 "lightweight operation which can only fail because of insufficient memory (it "
1935 "returns NULL in this case)."
1939 #: ../src/guestfs.pod:929
1940 msgid "guestfs_last_error"
1944 #: ../src/guestfs.pod:931
1947 " const char *guestfs_last_error (guestfs_h *g);\n"
1952 #: ../src/guestfs.pod:933
1954 "This returns the last error message that happened on C<g>. If there has not "
1955 "been an error since the handle was created, then this returns C<NULL>."
1959 #: ../src/guestfs.pod:937
1961 "The lifetime of the returned string is until the next error occurs, or L</"
1962 "guestfs_close> is called."
1966 #: ../src/guestfs.pod:940
1967 msgid "guestfs_last_errno"
1971 #: ../src/guestfs.pod:942
1974 " int guestfs_last_errno (guestfs_h *g);\n"
1979 #: ../src/guestfs.pod:944
1980 msgid "This returns the last error number (errno) that happened on C<g>."
1984 #: ../src/guestfs.pod:946
1985 msgid "If successful, an errno integer not equal to zero is returned."
1989 #: ../src/guestfs.pod:948
1991 "If no error, this returns 0. This call can return 0 in three situations:"
1995 #: ../src/guestfs.pod:955
1996 msgid "There has not been any error on the handle."
2000 #: ../src/guestfs.pod:959
2002 "There has been an error but the errno was meaningless. This corresponds to "
2003 "the case where the error did not come from a failed system call, but for "
2004 "some other reason."
2008 #: ../src/guestfs.pod:965
2010 "There was an error from a failed system call, but for some reason the errno "
2011 "was not captured and returned. This usually indicates a bug in libguestfs."
2015 #: ../src/guestfs.pod:971
2017 "Libguestfs tries to convert the errno from inside the applicance into a "
2018 "corresponding errno for the caller (not entirely trivial: the appliance "
2019 "might be running a completely different operating system from the library "
2020 "and error numbers are not standardized across Un*xen). If this could not be "
2021 "done, then the error is translated to C<EINVAL>. In practice this should "
2022 "only happen in very rare circumstances."
2026 #: ../src/guestfs.pod:979
2027 msgid "guestfs_set_error_handler"
2031 #: ../src/guestfs.pod:981
2034 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2036 " const char *msg);\n"
2037 " void guestfs_set_error_handler (guestfs_h *g,\n"
2038 " guestfs_error_handler_cb cb,\n"
2044 #: ../src/guestfs.pod:988
2046 "The callback C<cb> will be called if there is an error. The parameters "
2047 "passed to the callback are an opaque data pointer and the error message "
2052 #: ../src/guestfs.pod:992
2054 "C<errno> is not passed to the callback. To get that the callback must call "
2055 "L</guestfs_last_errno>."
2059 #: ../src/guestfs.pod:995
2061 "Note that the message string C<msg> is freed as soon as the callback "
2062 "function returns, so if you want to stash it somewhere you must make your "
2067 #: ../src/guestfs.pod:999
2068 msgid "The default handler prints messages on C<stderr>."
2072 #: ../src/guestfs.pod:1001
2073 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2077 #: ../src/guestfs.pod:1003
2078 msgid "guestfs_get_error_handler"
2082 #: ../src/guestfs.pod:1005
2085 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2086 " void **opaque_rtn);\n"
2091 #: ../src/guestfs.pod:1008
2092 msgid "Returns the current error handler callback."
2096 #: ../src/guestfs.pod:1010
2097 msgid "guestfs_set_out_of_memory_handler"
2101 #: ../src/guestfs.pod:1012
2104 " typedef void (*guestfs_abort_cb) (void);\n"
2105 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2106 " guestfs_abort_cb);\n"
2111 #: ../src/guestfs.pod:1016
2113 "The callback C<cb> will be called if there is an out of memory situation. "
2114 "I<Note this callback must not return>."
2118 #: ../src/guestfs.pod:1019
2119 msgid "The default is to call L<abort(3)>."
2123 #: ../src/guestfs.pod:1021
2125 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2129 #: ../src/guestfs.pod:1024
2130 msgid "guestfs_get_out_of_memory_handler"
2134 #: ../src/guestfs.pod:1026
2137 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2142 #: ../src/guestfs.pod:1028
2143 msgid "This returns the current out of memory handler."
2147 #: ../src/guestfs.pod:1030
2152 #: ../src/guestfs.pod:1032
2154 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
2159 #: ../src/guestfs.pod:1035
2161 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
2162 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2166 #: ../src/guestfs.pod:1038
2168 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2169 "to change the directories that libguestfs will search in. The value is a "
2170 "colon-separated list of paths. The current directory is I<not> searched "
2171 "unless the path contains an empty element or C<.>. For example "
2172 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2173 "then C</usr/lib/guestfs>."
2177 #: ../src/guestfs.pod:1045
2178 msgid "HIGH-LEVEL API ACTIONS"
2182 #: ../src/guestfs.pod:1047
2183 msgid "ABI GUARANTEE"
2187 #: ../src/guestfs.pod:1049
2189 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2190 "actions as outlined in this section. Although we will deprecate some "
2191 "actions, for example if they get replaced by newer calls, we will keep the "
2192 "old actions forever. This allows you the developer to program in confidence "
2193 "against the libguestfs API."
2197 #: ../src/guestfs.pod:1055 ../fish/guestfish.pod:861
2202 #: ../src/guestfs.pod:1057
2207 #: ../src/guestfs.pod:1059
2212 #: ../src/guestfs.pod:1061
2213 msgid "AVAILABILITY"
2217 #: ../src/guestfs.pod:1063
2218 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2222 #: ../src/guestfs.pod:1065
2224 "Using L</guestfs_available> you can test availability of the following "
2225 "groups of functions. This test queries the appliance to see if the "
2226 "appliance you are currently using supports the functionality."
2230 #: ../src/guestfs.pod:1070
2231 msgid "@AVAILABILITY@"
2235 #: ../src/guestfs.pod:1072
2236 msgid "GUESTFISH supported COMMAND"
2240 #: ../src/guestfs.pod:1074
2242 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2243 "prints out the available groups and whether they are supported by this build "
2244 "of libguestfs. Note however that you have to do C<run> first."
2248 #: ../src/guestfs.pod:1079
2249 msgid "SINGLE CALLS AT COMPILE TIME"
2253 #: ../src/guestfs.pod:1081
2255 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2256 "function, such as:"
2260 #: ../src/guestfs.pod:1084
2263 " #define LIBGUESTFS_HAVE_DD 1\n"
2268 #: ../src/guestfs.pod:1086
2269 msgid "if L</guestfs_dd> is available."
2273 #: ../src/guestfs.pod:1088
2275 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2276 "function is available at compile time, we recommended using build tools such "
2277 "as autoconf or cmake. For example in autotools you could use:"
2281 #: ../src/guestfs.pod:1093
2284 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2285 " AC_CHECK_FUNCS([guestfs_dd])\n"
2290 #: ../src/guestfs.pod:1096
2292 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2297 #: ../src/guestfs.pod:1099
2298 msgid "SINGLE CALLS AT RUN TIME"
2302 #: ../src/guestfs.pod:1101
2304 "Testing at compile time doesn't guarantee that a function really exists in "
2305 "the library. The reason is that you might be dynamically linked against a "
2306 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2307 "This situation unfortunately results in a segmentation fault, which is a "
2308 "shortcoming of the C dynamic linking system itself."
2312 #: ../src/guestfs.pod:1108
2314 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2315 "in this example program (note that you still need the compile time check as "
2320 #: ../src/guestfs.pod:1112
2323 " #include <stdio.h>\n"
2324 " #include <stdlib.h>\n"
2325 " #include <unistd.h>\n"
2326 " #include <dlfcn.h>\n"
2327 " #include <guestfs.h>\n"
2332 #: ../src/guestfs.pod:1118
2337 " #ifdef LIBGUESTFS_HAVE_DD\n"
2339 " int has_function;\n"
2344 #: ../src/guestfs.pod:1124
2347 " /* Test if the function guestfs_dd is really available. */\n"
2348 " dl = dlopen (NULL, RTLD_LAZY);\n"
2350 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2351 " exit (EXIT_FAILURE);\n"
2353 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2359 #: ../src/guestfs.pod:1133
2362 " if (!has_function)\n"
2363 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2365 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2366 " /* Now it's safe to call\n"
2367 " guestfs_dd (g, \"foo\", \"bar\");\n"
2371 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2378 #: ../src/guestfs.pod:1146
2380 "You may think the above is an awful lot of hassle, and it is. There are "
2381 "other ways outside of the C linking system to ensure that this kind of "
2382 "incompatibility never arises, such as using package versioning:"
2386 #: ../src/guestfs.pod:1151
2389 " Requires: libguestfs >= 1.0.80\n"
2394 #: ../src/guestfs.pod:1153
2395 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2399 #: ../src/guestfs.pod:1155
2401 "A recent feature of the API is the introduction of calls which take optional "
2402 "arguments. In C these are declared 3 ways. The main way is as a call which "
2403 "takes variable arguments (ie. C<...>), as in this example:"
2407 #: ../src/guestfs.pod:1160
2410 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2415 #: ../src/guestfs.pod:1162
2417 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2418 "call with no optional arguments specified:"
2422 #: ../src/guestfs.pod:1165
2425 " guestfs_add_drive_opts (g, filename, -1);\n"
2430 #: ../src/guestfs.pod:1167
2431 msgid "With a single optional argument:"
2435 #: ../src/guestfs.pod:1169
2438 " guestfs_add_drive_opts (g, filename,\n"
2439 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2445 #: ../src/guestfs.pod:1173
2450 #: ../src/guestfs.pod:1175
2453 " guestfs_add_drive_opts (g, filename,\n"
2454 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2455 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
2461 #: ../src/guestfs.pod:1180
2463 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
2468 #: ../src/guestfs.pod:1183
2469 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
2473 #: ../src/guestfs.pod:1185
2475 "The second variant has the same name with the suffix C<_va>, which works the "
2476 "same way but takes a C<va_list>. See the C manual for details. For the "
2477 "example function, this is declared:"
2481 #: ../src/guestfs.pod:1189
2484 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
2490 #: ../src/guestfs.pod:1192
2491 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
2495 #: ../src/guestfs.pod:1194
2497 "The third variant is useful where you need to construct these calls. You "
2498 "pass in a structure where you fill in the optional fields. The structure "
2499 "has a bitmask as the first element which you must set to indicate which "
2500 "fields you have filled in. For our example function the structure and call "
2505 #: ../src/guestfs.pod:1200
2508 " struct guestfs_add_drive_opts_argv {\n"
2509 " uint64_t bitmask;\n"
2511 " const char *format;\n"
2514 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
2515 " const struct guestfs_add_drive_opts_argv *optargs);\n"
2520 #: ../src/guestfs.pod:1209
2521 msgid "You could call it like this:"
2525 #: ../src/guestfs.pod:1211
2528 " struct guestfs_add_drive_opts_argv optargs = {\n"
2529 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
2530 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
2532 " .format = \"qcow2\"\n"
2538 #: ../src/guestfs.pod:1218
2541 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
2546 #: ../src/guestfs.pod:1220 ../src/guestfs-actions.pod:11
2547 #: ../src/guestfs-actions.pod:1813 ../fish/guestfish-actions.pod:9
2548 #: ../fish/guestfish-actions.pod:1244
2553 #: ../src/guestfs.pod:1226
2554 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
2558 #: ../src/guestfs.pod:1231
2559 msgid "You do not need to fill in all fields of the structure."
2563 #: ../src/guestfs.pod:1235
2565 "There must be a one-to-one correspondence between fields of the structure "
2566 "that are filled in, and bits set in the bitmask."
2570 #: ../src/guestfs.pod:1240
2571 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
2575 #: ../src/guestfs.pod:1242
2577 "In other languages, optional arguments are expressed in the way that is "
2578 "natural for that language. We refer you to the language-specific "
2579 "documentation for more details on that."
2583 #: ../src/guestfs.pod:1246
2584 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
2588 #: ../src/guestfs.pod:1248 ../src/guestfs.pod:1253
2593 #: ../src/guestfs.pod:1250
2595 "<!-- old anchor for the next section --> <a name="
2596 "\"state_machine_and_low_level_event_api\"/>"
2600 #: ../src/guestfs.pod:1255
2601 msgid "ARCHITECTURE"
2605 #: ../src/guestfs.pod:1257
2607 "Internally, libguestfs is implemented by running an appliance (a special "
2608 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
2609 "process of the main program."
2613 #: ../src/guestfs.pod:1261
2616 " ___________________\n"
2618 " | main program |\n"
2620 " | | child process / appliance\n"
2621 " | | __________________________\n"
2623 " +-------------------+ RPC | +-----------------+ |\n"
2624 " | libguestfs <--------------------> guestfsd | |\n"
2625 " | | | +-----------------+ |\n"
2626 " \\___________________/ | | Linux kernel | |\n"
2627 " | +--^--------------+ |\n"
2628 " \\_________|________________/\n"
2634 " \\______________/\n"
2639 #: ../src/guestfs.pod:1281
2641 "The library, linked to the main program, creates the child process and hence "
2642 "the appliance in the L</guestfs_launch> function."
2646 #: ../src/guestfs.pod:1284
2648 "Inside the appliance is a Linux kernel and a complete stack of userspace "
2649 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
2650 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
2651 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
2652 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
2653 "attached to the qemu process which translates device access by the "
2654 "appliance's Linux kernel into accesses to the image."
2658 #: ../src/guestfs.pod:1293
2660 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
2661 "Although the disk image you are attached to might also be used by some "
2662 "virtual machine, libguestfs doesn't know or care about this. (But you will "
2663 "care if both libguestfs's qemu process and your virtual machine are trying "
2664 "to update the disk image at the same time, since these usually results in "
2665 "massive disk corruption)."
2669 #: ../src/guestfs.pod:1300
2670 msgid "STATE MACHINE"
2674 #: ../src/guestfs.pod:1302
2675 msgid "libguestfs uses a state machine to model the child process:"
2679 #: ../src/guestfs.pod:1304
2691 " / | \\ \\ guestfs_launch\n"
2692 " / | _\\__V______\n"
2694 " / | | LAUNCHING |\n"
2695 " / | \\___________/\n"
2697 " / | guestfs_launch\n"
2699 " ______ / __|____V\n"
2700 " / \\ ------> / \\\n"
2701 " | BUSY | | READY |\n"
2702 " \\______/ <------ \\________/\n"
2707 #: ../src/guestfs.pod:1326
2709 "The normal transitions are (1) CONFIG (when the handle is created, but there "
2710 "is no child process), (2) LAUNCHING (when the child process is booting up), "
2711 "(3) alternating between READY and BUSY as commands are issued to, and "
2712 "carried out by, the child process."
2716 #: ../src/guestfs.pod:1331
2718 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
2719 "asynchronously at any time (eg. due to some internal error), and that causes "
2720 "the state to transition back to CONFIG."
2724 #: ../src/guestfs.pod:1335
2726 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
2727 "issued when in the CONFIG state."
2731 #: ../src/guestfs.pod:1338
2733 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
2734 "L</guestfs_launch> blocks until the child process is READY to accept "
2735 "commands (or until some failure or timeout). L</guestfs_launch> internally "
2736 "moves the state from CONFIG to LAUNCHING while it is running."
2740 #: ../src/guestfs.pod:1344
2742 "API actions such as L</guestfs_mount> can only be issued when in the READY "
2743 "state. These API calls block waiting for the command to be carried out (ie. "
2744 "the state to transition to BUSY and then back to READY). There are no non-"
2745 "blocking versions, and no way to issue more than one command per handle at "
2750 #: ../src/guestfs.pod:1350
2752 "Finally, the child process sends asynchronous messages back to the main "
2753 "program, such as kernel log messages. You can register a callback to "
2754 "receive these messages."
2758 #: ../src/guestfs.pod:1354
2759 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
2763 #: ../src/guestfs.pod:1356
2765 "The child process generates events in some situations. Current events "
2766 "include: receiving a log message, the child process exits."
2770 #: ../src/guestfs.pod:1359
2772 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
2777 #: ../src/guestfs.pod:1362
2779 "Only I<one callback of each type> can be registered for each handle. "
2780 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
2781 "that type. Cancel all callbacks of this type by calling this function with "
2782 "C<cb> set to C<NULL>."
2786 #: ../src/guestfs.pod:1367
2787 msgid "guestfs_set_log_message_callback"
2791 #: ../src/guestfs.pod:1369
2794 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
2795 " char *buf, int len);\n"
2796 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
2797 " guestfs_log_message_cb cb,\n"
2803 #: ../src/guestfs.pod:1375
2805 "The callback function C<cb> will be called whenever qemu or the guest writes "
2806 "anything to the console."
2810 #: ../src/guestfs.pod:1378
2811 msgid "Use this function to capture kernel messages and similar."
2815 #: ../src/guestfs.pod:1380
2817 "Normally there is no log message handler, and log messages are just "
2822 #: ../src/guestfs.pod:1383
2823 msgid "guestfs_set_subprocess_quit_callback"
2827 #: ../src/guestfs.pod:1385
2830 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
2831 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
2832 " guestfs_subprocess_quit_cb cb,\n"
2838 #: ../src/guestfs.pod:1390
2840 "The callback function C<cb> will be called when the child process quits, "
2841 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
2842 "corresponds to a transition from any state to the CONFIG state)."
2846 #: ../src/guestfs.pod:1395
2847 msgid "guestfs_set_launch_done_callback"
2851 #: ../src/guestfs.pod:1397
2854 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
2855 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
2856 " guestfs_launch_done_cb cb,\n"
2862 #: ../src/guestfs.pod:1402
2864 "The callback function C<cb> will be called when the child process becomes "
2865 "ready first time after it has been launched. (This corresponds to a "
2866 "transition from LAUNCHING to the READY state)."
2870 #: ../src/guestfs.pod:1406
2871 msgid "guestfs_set_close_callback"
2875 #: ../src/guestfs.pod:1408
2878 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
2879 " void guestfs_set_close_callback (guestfs_h *g,\n"
2880 " guestfs_close_cb cb,\n"
2886 #: ../src/guestfs.pod:1413
2888 "The callback function C<cb> will be called while the handle is being closed "
2889 "(synchronously from L</guestfs_close>)."
2893 #: ../src/guestfs.pod:1416
2895 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
2896 "handles that are open when the program exits. This means that this callback "
2897 "might be called indirectly from L<exit(3)>, which can cause unexpected "
2898 "problems in higher-level languages (eg. if your HLL interpreter has already "
2899 "been cleaned up by the time this is called, and if your callback then jumps "
2900 "into some HLL function)."
2904 #: ../src/guestfs.pod:1424
2905 msgid "guestfs_set_progress_callback"
2909 #: ../src/guestfs.pod:1426
2912 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
2913 " int proc_nr, int serial,\n"
2914 " uint64_t position, uint64_t total);\n"
2915 " void guestfs_set_progress_callback (guestfs_h *g,\n"
2916 " guestfs_progress_cb cb,\n"
2922 #: ../src/guestfs.pod:1433
2924 "Some long-running operations can generate progress messages. If this "
2925 "callback is registered, then it will be called each time a progress message "
2926 "is generated (usually two seconds after the operation started, and three "
2927 "times per second thereafter until it completes, although the frequency may "
2928 "change in future versions)."
2932 #: ../src/guestfs.pod:1439
2934 "The callback receives two numbers: C<position> and C<total>. The units of "
2935 "C<total> are not defined, although for some operations C<total> may relate "
2936 "in some way to the amount of data to be transferred (eg. in bytes or "
2937 "megabytes), and C<position> may be the portion which has been transferred."
2941 #: ../src/guestfs.pod:1445
2942 msgid "The only defined and stable parts of the API are:"
2946 #: ../src/guestfs.pod:1451
2948 "The callback can display to the user some type of progress bar or indicator "
2949 "which shows the ratio of C<position>:C<total>."
2953 #: ../src/guestfs.pod:1456
2954 msgid "0 E<lt>= C<position> E<lt>= C<total>"
2958 #: ../src/guestfs.pod:1460
2960 "If any progress notification is sent during a call, then a final progress "
2961 "notification is always sent when C<position> = C<total>."
2965 #: ../src/guestfs.pod:1463
2967 "This is to simplify caller code, so callers can easily set the progress "
2968 "indicator to \"100%\" at the end of the operation, without requiring special "
2969 "code to detect this case."
2973 #: ../src/guestfs.pod:1469
2975 "The callback also receives the procedure number and serial number of the "
2976 "call. These are only useful for debugging protocol issues, and the callback "
2977 "can normally ignore them. The callback may want to print these numbers in "
2978 "error messages or debugging messages."
2982 #: ../src/guestfs.pod:1474
2983 msgid "PRIVATE DATA AREA"
2987 #: ../src/guestfs.pod:1476
2989 "You can attach named pieces of private data to the libguestfs handle, and "
2990 "fetch them by name for the lifetime of the handle. This is called the "
2991 "private data area and is only available from the C API."
2995 #: ../src/guestfs.pod:1480
2996 msgid "To attach a named piece of data, use the following call:"
3000 #: ../src/guestfs.pod:1482
3003 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3008 #: ../src/guestfs.pod:1484
3010 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3011 "pointer (which can be C<NULL>). Any previous item with the same name is "
3016 #: ../src/guestfs.pod:1488
3018 "You can use any C<key> you want, but names beginning with an underscore "
3019 "character are reserved for internal libguestfs purposes (for implementing "
3020 "language bindings). It is recommended to prefix the name with some unique "
3021 "string to avoid collisions with other users."
3025 #: ../src/guestfs.pod:1493
3026 msgid "To retrieve the pointer, use:"
3030 #: ../src/guestfs.pod:1495
3033 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3038 #: ../src/guestfs.pod:1497
3040 "This function returns C<NULL> if either no data is found associated with "
3041 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3046 #: ../src/guestfs.pod:1501
3048 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3049 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3050 "all. In particular, libguestfs does I<not> try to free the data when the "
3051 "handle is closed. If the data must be freed, then the caller must either "
3052 "free it before calling L</guestfs_close> or must set up a close callback to "
3053 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3054 "can be registered for a handle)."
3058 #: ../src/guestfs.pod:1509
3060 "The private data area is implemented using a hash table, and should be "
3061 "reasonably efficient for moderate numbers of keys."
3065 #: ../src/guestfs.pod:1512
3066 msgid "BLOCK DEVICE NAMING"
3070 #: ../src/guestfs.pod:1514
3072 "In the kernel there is now quite a profusion of schemata for naming block "
3073 "devices (in this context, by I<block device> I mean a physical or virtual "
3074 "hard drive). The original Linux IDE driver used names starting with C</dev/"
3075 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
3076 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
3077 "for the old IDE driver (particularly for SATA devices) those devices also "
3078 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
3079 "paravirtualized drivers. This has created several different naming systems, "
3080 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
3084 #: ../src/guestfs.pod:1526
3086 "As discussed above, libguestfs uses a qemu appliance running an embedded "
3087 "Linux kernel to access block devices. We can run a variety of appliances "
3088 "based on a variety of Linux kernels."
3092 #: ../src/guestfs.pod:1530
3094 "This causes a problem for libguestfs because many API calls use device or "
3095 "partition names. Working scripts and the recipe (example) scripts that we "
3096 "make available over the internet could fail if the naming scheme changes."
3100 #: ../src/guestfs.pod:1535
3102 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
3103 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
3104 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
3105 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
3109 #: ../src/guestfs.pod:1541
3111 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
3112 "L</guestfs_list_partitions> and similar calls return the true names of the "
3113 "devices and partitions as known to the appliance."
3117 #: ../src/guestfs.pod:1546
3118 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
3122 #: ../src/guestfs.pod:1548
3124 "Usually this translation is transparent. However in some (very rare) cases "
3125 "you may need to know the exact algorithm. Such cases include where you use "
3126 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
3127 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
3131 #: ../src/guestfs.pod:1554
3133 "The algorithm is applied only to I<parameters> which are known to be either "
3134 "device or partition names. Return values from functions such as L</"
3135 "guestfs_list_devices> are never changed."
3139 #: ../src/guestfs.pod:1562
3140 msgid "Is the string a parameter which is a device or partition name?"
3144 #: ../src/guestfs.pod:1566
3145 msgid "Does the string begin with C</dev/sd>?"
3149 #: ../src/guestfs.pod:1570
3151 "Does the named device exist? If so, we use that device. However if I<not> "
3152 "then we continue with this algorithm."
3156 #: ../src/guestfs.pod:1575
3157 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
3161 #: ../src/guestfs.pod:1577
3162 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
3166 #: ../src/guestfs.pod:1579
3167 msgid "If that named device exists, use it. If not, continue."
3171 #: ../src/guestfs.pod:1583
3172 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
3176 #: ../src/guestfs.pod:1585
3177 msgid "If that named device exists, use it. If not, return an error."
3181 #: ../src/guestfs.pod:1589
3182 msgid "PORTABILITY CONCERNS"
3186 #: ../src/guestfs.pod:1591
3188 "Although the standard naming scheme and automatic translation is useful for "
3189 "simple programs and guestfish scripts, for larger programs it is best not to "
3190 "rely on this mechanism."
3194 #: ../src/guestfs.pod:1595
3196 "Where possible for maximum future portability programs using libguestfs "
3197 "should use these future-proof techniques:"
3201 #: ../src/guestfs.pod:1602
3203 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
3204 "device names, and then use those names directly."
3208 #: ../src/guestfs.pod:1605
3210 "Since those device names exist by definition, they will never be translated."
3214 #: ../src/guestfs.pod:1610
3216 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
3217 "filesystem labels."
3221 #: ../src/guestfs.pod:1615
3226 #: ../src/guestfs.pod:1617
3227 msgid "COMMUNICATION PROTOCOL"
3231 #: ../src/guestfs.pod:1619
3233 "Don't rely on using this protocol directly. This section documents how it "
3234 "currently works, but it may change at any time."
3238 #: ../src/guestfs.pod:1622
3240 "The protocol used to talk between the library and the daemon running inside "
3241 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3242 "1014, RFC 1832, RFC 4506)."
3246 #: ../src/guestfs.pod:1626
3248 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3249 "this file is automatically generated)."
3253 #: ../src/guestfs.pod:1629
3255 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3256 "and C<FileOut> parameters, which are handled with very simple request/reply "
3257 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3258 "parameters, which use the same request and reply messages, but they may also "
3259 "be followed by files sent using a chunked encoding."
3263 #: ../src/guestfs.pod:1636
3264 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3268 #: ../src/guestfs.pod:1638
3269 msgid "For ordinary functions, the request message is:"
3273 #: ../src/guestfs.pod:1640
3276 " total length (header + arguments,\n"
3277 " but not including the length word itself)\n"
3278 " struct guestfs_message_header (encoded as XDR)\n"
3279 " struct guestfs_<foo>_args (encoded as XDR)\n"
3284 #: ../src/guestfs.pod:1645
3286 "The total length field allows the daemon to allocate a fixed size buffer "
3287 "into which it slurps the rest of the message. As a result, the total length "
3288 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3289 "effective size of any request is limited to somewhere under this size."
3293 #: ../src/guestfs.pod:1651
3295 "Note also that many functions don't take any arguments, in which case the "
3296 "C<guestfs_I<foo>_args> is completely omitted."
3300 #: ../src/guestfs.pod:1654
3302 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3303 "receiver knows what type of args structure to expect, or none at all."
3307 #: ../src/guestfs.pod:1658
3308 msgid "The reply message for ordinary functions is:"
3312 #: ../src/guestfs.pod:1660
3315 " total length (header + ret,\n"
3316 " but not including the length word itself)\n"
3317 " struct guestfs_message_header (encoded as XDR)\n"
3318 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3323 #: ../src/guestfs.pod:1665
3325 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3326 "functions that return no formal return values."
3330 #: ../src/guestfs.pod:1668
3332 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3336 #: ../src/guestfs.pod:1671
3338 "In the case of an error, a flag is set in the header, and the reply message "
3339 "is slightly changed:"
3343 #: ../src/guestfs.pod:1674
3346 " total length (header + error,\n"
3347 " but not including the length word itself)\n"
3348 " struct guestfs_message_header (encoded as XDR)\n"
3349 " struct guestfs_message_error (encoded as XDR)\n"
3354 #: ../src/guestfs.pod:1679
3356 "The C<guestfs_message_error> structure contains the error message as a "
3361 #: ../src/guestfs.pod:1682
3362 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3366 #: ../src/guestfs.pod:1684
3368 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3369 "The normal request message is sent (see above). However this is followed by "
3370 "a sequence of file chunks."
3374 #: ../src/guestfs.pod:1688
3377 " total length (header + arguments,\n"
3378 " but not including the length word itself,\n"
3379 " and not including the chunks)\n"
3380 " struct guestfs_message_header (encoded as XDR)\n"
3381 " struct guestfs_<foo>_args (encoded as XDR)\n"
3382 " sequence of chunks for FileIn param #0\n"
3383 " sequence of chunks for FileIn param #1 etc.\n"
3388 #: ../src/guestfs.pod:1696
3389 msgid "The \"sequence of chunks\" is:"
3393 #: ../src/guestfs.pod:1698
3396 " length of chunk (not including length word itself)\n"
3397 " struct guestfs_chunk (encoded as XDR)\n"
3398 " length of chunk\n"
3399 " struct guestfs_chunk (encoded as XDR)\n"
3401 " length of chunk\n"
3402 " struct guestfs_chunk (with data.data_len == 0)\n"
3407 #: ../src/guestfs.pod:1706
3409 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3410 "is set in the final chunk to indicate either successful completion or early "
3415 #: ../src/guestfs.pod:1710
3417 "At time of writing there are no functions that have more than one FileIn "
3418 "parameter. However this is (theoretically) supported, by sending the "
3419 "sequence of chunks for each FileIn parameter one after another (from left to "
3424 #: ../src/guestfs.pod:1715
3426 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3427 "transfer. The library does this by sending a chunk with a special flag set "
3428 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3429 "RPC, does I<not> send any reply, and goes back to reading the next request."
3433 #: ../src/guestfs.pod:1721
3435 "The daemon may also cancel. It does this by writing a special word "
3436 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3437 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3438 "cancel chunk). The special word is chosen so that even if cancellation "
3439 "happens right at the end of the transfer (after the library has finished "
3440 "writing and has started listening for the reply), the \"spurious\" cancel "
3441 "flag will not be confused with the reply message."
3445 #: ../src/guestfs.pod:1730
3447 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3448 "limit), and also files where the size is not known in advance (eg. from "
3449 "pipes or sockets). However the chunks are rather small "
3450 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3451 "to keep much in memory."
3455 #: ../src/guestfs.pod:1736
3456 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3460 #: ../src/guestfs.pod:1738
3462 "The protocol for FileOut parameters is exactly the same as for FileIn "
3463 "parameters, but with the roles of daemon and library reversed."
3467 #: ../src/guestfs.pod:1741
3470 " total length (header + ret,\n"
3471 " but not including the length word itself,\n"
3472 " and not including the chunks)\n"
3473 " struct guestfs_message_header (encoded as XDR)\n"
3474 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3475 " sequence of chunks for FileOut param #0\n"
3476 " sequence of chunks for FileOut param #1 etc.\n"
3481 #: ../src/guestfs.pod:1749
3482 msgid "INITIAL MESSAGE"
3486 #: ../src/guestfs.pod:1751
3488 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3489 "which indicates that the guest and daemon is alive. This is what L</"
3490 "guestfs_launch> waits for."
3494 #: ../src/guestfs.pod:1755
3495 msgid "PROGRESS NOTIFICATION MESSAGES"
3499 #: ../src/guestfs.pod:1757
3501 "The daemon may send progress notification messages at any time. These are "
3502 "distinguished by the normal length word being replaced by "
3503 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3507 #: ../src/guestfs.pod:1761
3509 "The library turns them into progress callbacks (see "
3510 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3511 "discards them if not."
3515 #: ../src/guestfs.pod:1765
3517 "The daemon self-limits the frequency of progress messages it sends (see "
3518 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3523 #: ../src/guestfs.pod:1769
3524 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
3528 #: ../src/guestfs.pod:1771
3530 "All high-level libguestfs actions are synchronous. If you want to use "
3531 "libguestfs asynchronously then you must create a thread."
3535 #: ../src/guestfs.pod:1774
3537 "Only use the handle from a single thread. Either use the handle exclusively "
3538 "from one thread, or provide your own mutex so that two threads cannot issue "
3539 "calls on the same handle at the same time."
3543 #: ../src/guestfs.pod:1778
3545 "See the graphical program guestfs-browser for one possible architecture for "
3546 "multithreaded programs using libvirt and libguestfs."
3550 #: ../src/guestfs.pod:1781
3551 msgid "QEMU WRAPPERS"
3555 #: ../src/guestfs.pod:1783
3557 "If you want to compile your own qemu, run qemu from a non-standard location, "
3558 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
3563 #: ../src/guestfs.pod:1787
3565 "There is one important rule to remember: you I<must C<exec qemu>> as the "
3566 "last command in the shell script (so that qemu replaces the shell and "
3567 "becomes the direct child of the libguestfs-using program). If you don't do "
3568 "this, then the qemu process won't be cleaned up correctly."
3572 #: ../src/guestfs.pod:1792
3574 "Here is an example of a wrapper, where I have built my own copy of qemu from "
3579 #: ../src/guestfs.pod:1795
3583 " qemudir=/home/rjones/d/qemu\n"
3584 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
3589 #: ../src/guestfs.pod:1799
3591 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
3592 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
3597 #: ../src/guestfs.pod:1803
3600 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
3605 #: ../src/guestfs.pod:1805
3607 "Note that libguestfs also calls qemu with the -help and -version options in "
3608 "order to determine features."
3612 #: ../src/guestfs.pod:1808
3613 msgid "LIBGUESTFS VERSION NUMBERS"
3617 #: ../src/guestfs.pod:1810
3619 "Since April 2010, libguestfs has started to make separate development and "
3620 "stable releases, along with corresponding branches in our git repository. "
3621 "These separate releases can be identified by version number:"
3625 #: ../src/guestfs.pod:1815
3628 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3629 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3635 " | `-------- sub-version\n"
3637 " `------ always '1' because we don't change the ABI\n"
3642 #: ../src/guestfs.pod:1826
3643 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3647 #: ../src/guestfs.pod:1828
3649 "As time passes we cherry pick fixes from the development branch and backport "
3650 "those into the stable branch, the effect being that the stable branch should "
3651 "get more stable and less buggy over time. So the stable releases are ideal "
3652 "for people who don't need new features but would just like the software to "
3657 #: ../src/guestfs.pod:1834
3658 msgid "Our criteria for backporting changes are:"
3662 #: ../src/guestfs.pod:1840
3664 "Documentation changes which don't affect any code are backported unless the "
3665 "documentation refers to a future feature which is not in stable."
3669 #: ../src/guestfs.pod:1846
3671 "Bug fixes which are not controversial, fix obvious problems, and have been "
3672 "well tested are backported."
3676 #: ../src/guestfs.pod:1851
3678 "Simple rearrangements of code which shouldn't affect how it works get "
3679 "backported. This is so that the code in the two branches doesn't get too "
3680 "far out of step, allowing us to backport future fixes more easily."
3684 #: ../src/guestfs.pod:1857
3686 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3687 "exceptional case: the new feature is required in order to implement an "
3688 "important bug fix."
3692 #: ../src/guestfs.pod:1863
3694 "A new stable branch starts when we think the new features in development are "
3695 "substantial and compelling enough over the current stable branch to warrant "
3696 "it. When that happens we create new stable and development versions 1.N.0 "
3697 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
3698 "stable at this point, but by backporting fixes from development, that branch "
3699 "will stabilize over time."
3703 #: ../src/guestfs.pod:1871 ../fish/guestfish.pod:868
3704 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
3705 #: ../tools/virt-rescue.pl:255
3706 msgid "ENVIRONMENT VARIABLES"
3710 #: ../src/guestfs.pod:1875 ../fish/guestfish.pod:894
3711 msgid "LIBGUESTFS_APPEND"
3715 #: ../src/guestfs.pod:1877 ../fish/guestfish.pod:896
3716 msgid "Pass additional options to the guest kernel."
3720 #: ../src/guestfs.pod:1879 ../fish/guestfish.pod:898
3721 msgid "LIBGUESTFS_DEBUG"
3725 #: ../src/guestfs.pod:1881
3727 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
3728 "effect as calling C<guestfs_set_verbose (g, 1)>."
3732 #: ../src/guestfs.pod:1884 ../fish/guestfish.pod:903
3733 msgid "LIBGUESTFS_MEMSIZE"
3737 #: ../src/guestfs.pod:1886 ../fish/guestfish.pod:905
3739 "Set the memory allocated to the qemu process, in megabytes. For example:"
3743 #: ../src/guestfs.pod:1889 ../fish/guestfish.pod:908
3746 " LIBGUESTFS_MEMSIZE=700\n"
3751 #: ../src/guestfs.pod:1891 ../fish/guestfish.pod:910
3752 msgid "LIBGUESTFS_PATH"
3756 #: ../src/guestfs.pod:1893
3758 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
3759 "the discussion of paths in section PATH above."
3763 #: ../src/guestfs.pod:1896 ../fish/guestfish.pod:915
3764 msgid "LIBGUESTFS_QEMU"
3768 #: ../src/guestfs.pod:1898 ../fish/guestfish.pod:917
3770 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
3771 "which was found at compile time by the configure script is used."
3775 #: ../src/guestfs.pod:1902
3776 msgid "See also L</QEMU WRAPPERS> above."
3780 #: ../src/guestfs.pod:1904 ../fish/guestfish.pod:921
3781 msgid "LIBGUESTFS_TRACE"
3785 #: ../src/guestfs.pod:1906
3787 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
3788 "effect as calling C<guestfs_set_trace (g, 1)>."
3792 #: ../src/guestfs.pod:1909 ../fish/guestfish.pod:930
3797 #: ../src/guestfs.pod:1911 ../fish/guestfish.pod:932
3798 msgid "Location of temporary directory, defaults to C</tmp>."
3802 #: ../src/guestfs.pod:1913 ../fish/guestfish.pod:934
3804 "If libguestfs was compiled to use the supermin appliance then the real "
3805 "appliance is cached in this directory, shared between all handles belonging "
3806 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
3807 "use in case C</tmp> is not large enough."
3811 #: ../src/guestfs.pod:1921 ../fish/guestfish.pod:992
3812 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:226
3813 #: ../inspector/virt-inspector.pl:570 ../tools/virt-edit.pl:350
3814 #: ../tools/virt-win-reg.pl:484 ../tools/virt-df.pl:640
3815 #: ../tools/virt-ls.pl:232 ../tools/virt-resize.pl:1486
3816 #: ../tools/virt-list-filesystems.pl:186 ../tools/virt-cat.pl:185
3817 #: ../tools/virt-tar.pl:281 ../tools/virt-rescue.pl:267
3818 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:254
3823 #: ../src/guestfs.pod:1923
3825 "L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, L<virt-edit"
3826 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
3827 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
3828 "tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
3829 "L<http://libguestfs.org/>."
3833 #: ../src/guestfs.pod:1941
3835 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
3836 "(8)>, L<disktype(1)>."
3840 #: ../src/guestfs.pod:1948 ../tools/virt-win-reg.pl:499
3841 #: ../tools/virt-make-fs.pl:548
3846 #: ../src/guestfs.pod:1950
3847 msgid "To get a list of bugs against libguestfs use this link:"
3851 #: ../src/guestfs.pod:1952
3853 "L<https://bugzilla.redhat.com/buglist.cgi?"
3854 "component=libguestfs&product=Virtualization+Tools>"
3858 #: ../src/guestfs.pod:1954
3859 msgid "To report a new bug against libguestfs use this link:"
3863 #: ../src/guestfs.pod:1956
3865 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
3866 "component=libguestfs&product=Virtualization+Tools>"
3870 #: ../src/guestfs.pod:1958
3871 msgid "When reporting a bug, please check:"
3875 #: ../src/guestfs.pod:1964
3876 msgid "That the bug hasn't been reported already."
3880 #: ../src/guestfs.pod:1968
3881 msgid "That you are testing a recent version."
3885 #: ../src/guestfs.pod:1972
3886 msgid "Describe the bug accurately, and give a way to reproduce it."
3890 #: ../src/guestfs.pod:1976
3892 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
3897 #: ../src/guestfs.pod:1981 ../fish/guestfish.pod:1009
3898 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:237
3899 #: ../inspector/virt-inspector.pl:580
3904 #: ../src/guestfs.pod:1983 ../fish/guestfish.pod:1011
3905 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:239
3906 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
3910 #: ../src/guestfs.pod:1985 ../fish/guestfish.pod:1013
3911 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:241
3912 #: ../inspector/virt-inspector.pl:594 ../tools/virt-edit.pl:366
3913 #: ../tools/virt-win-reg.pl:514 ../tools/virt-df.pl:653
3914 #: ../tools/virt-ls.pl:247 ../tools/virt-resize.pl:1512
3915 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-cat.pl:199
3916 #: ../tools/virt-tar.pl:296 ../tools/virt-rescue.pl:281
3917 #: ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:269
3922 #: ../src/guestfs.pod:1987 ../fish/guestfish.pod:1015
3923 #: ../fuse/guestmount.pod:243
3924 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
3928 #: ../src/guestfs.pod:1990
3930 "This library is free software; you can redistribute it and/or modify it "
3931 "under the terms of the GNU Lesser General Public License as published by the "
3932 "Free Software Foundation; either version 2 of the License, or (at your "
3933 "option) any later version."
3937 #: ../src/guestfs.pod:1995
3939 "This library is distributed in the hope that it will be useful, but WITHOUT "
3940 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
3941 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
3946 #: ../src/guestfs.pod:2000
3948 "You should have received a copy of the GNU Lesser General Public License "
3949 "along with this library; if not, write to the Free Software Foundation, "
3950 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
3954 #: ../src/guestfs-actions.pod:1
3955 msgid "guestfs_add_cdrom"
3959 #: ../src/guestfs-actions.pod:3
3963 " guestfs_add_cdrom (guestfs_h *g,\n"
3964 " const char *filename);\n"
3969 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
3970 msgid "This function adds a virtual CD-ROM disk image to the guest."
3974 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
3975 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
3979 #: ../src/guestfs-actions.pod:17
3981 "This call checks for the existence of C<filename>. This stops you from "
3982 "specifying other types of drive which are supported by qemu such as C<nbd:> "
3983 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
3988 #: ../src/guestfs-actions.pod:24
3990 "If you just want to add an ISO file (often you use this as an efficient way "
3991 "to transfer large files into the guest), then you should probably use "
3992 "C<guestfs_add_drive_ro> instead."
3996 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:58
3997 #: ../src/guestfs-actions.pod:119 ../src/guestfs-actions.pod:156
3998 #: ../src/guestfs-actions.pod:170 ../src/guestfs-actions.pod:191
3999 #: ../src/guestfs-actions.pod:211 ../src/guestfs-actions.pod:225
4000 #: ../src/guestfs-actions.pod:340 ../src/guestfs-actions.pod:360
4001 #: ../src/guestfs-actions.pod:374 ../src/guestfs-actions.pod:419
4002 #: ../src/guestfs-actions.pod:447 ../src/guestfs-actions.pod:465
4003 #: ../src/guestfs-actions.pod:532 ../src/guestfs-actions.pod:565
4004 #: ../src/guestfs-actions.pod:579 ../src/guestfs-actions.pod:594
4005 #: ../src/guestfs-actions.pod:693 ../src/guestfs-actions.pod:711
4006 #: ../src/guestfs-actions.pod:725 ../src/guestfs-actions.pod:739
4007 #: ../src/guestfs-actions.pod:900 ../src/guestfs-actions.pod:920
4008 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1022
4009 #: ../src/guestfs-actions.pod:1040 ../src/guestfs-actions.pod:1059
4010 #: ../src/guestfs-actions.pod:1073 ../src/guestfs-actions.pod:1093
4011 #: ../src/guestfs-actions.pod:1132 ../src/guestfs-actions.pod:1202
4012 #: ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1258
4013 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1401
4014 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1653
4015 #: ../src/guestfs-actions.pod:1675 ../src/guestfs-actions.pod:1762
4016 #: ../src/guestfs-actions.pod:2185 ../src/guestfs-actions.pod:2329
4017 #: ../src/guestfs-actions.pod:2390 ../src/guestfs-actions.pod:2426
4018 #: ../src/guestfs-actions.pod:2944 ../src/guestfs-actions.pod:2959
4019 #: ../src/guestfs-actions.pod:2979 ../src/guestfs-actions.pod:3105
4020 #: ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3132
4021 #: ../src/guestfs-actions.pod:3146 ../src/guestfs-actions.pod:3161
4022 #: ../src/guestfs-actions.pod:3197 ../src/guestfs-actions.pod:3270
4023 #: ../src/guestfs-actions.pod:3290 ../src/guestfs-actions.pod:3307
4024 #: ../src/guestfs-actions.pod:3330 ../src/guestfs-actions.pod:3353
4025 #: ../src/guestfs-actions.pod:3385 ../src/guestfs-actions.pod:3404
4026 #: ../src/guestfs-actions.pod:3423 ../src/guestfs-actions.pod:3458
4027 #: ../src/guestfs-actions.pod:3470 ../src/guestfs-actions.pod:3506
4028 #: ../src/guestfs-actions.pod:3522 ../src/guestfs-actions.pod:3535
4029 #: ../src/guestfs-actions.pod:3550 ../src/guestfs-actions.pod:3567
4030 #: ../src/guestfs-actions.pod:3662 ../src/guestfs-actions.pod:3682
4031 #: ../src/guestfs-actions.pod:3695 ../src/guestfs-actions.pod:3746
4032 #: ../src/guestfs-actions.pod:3764 ../src/guestfs-actions.pod:3782
4033 #: ../src/guestfs-actions.pod:3798 ../src/guestfs-actions.pod:3812
4034 #: ../src/guestfs-actions.pod:3826 ../src/guestfs-actions.pod:3843
4035 #: ../src/guestfs-actions.pod:3858 ../src/guestfs-actions.pod:3878
4036 #: ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:3958
4037 #: ../src/guestfs-actions.pod:3977 ../src/guestfs-actions.pod:3996
4038 #: ../src/guestfs-actions.pod:4008 ../src/guestfs-actions.pod:4025
4039 #: ../src/guestfs-actions.pod:4038 ../src/guestfs-actions.pod:4053
4040 #: ../src/guestfs-actions.pod:4068 ../src/guestfs-actions.pod:4103
4041 #: ../src/guestfs-actions.pod:4118 ../src/guestfs-actions.pod:4138
4042 #: ../src/guestfs-actions.pod:4152 ../src/guestfs-actions.pod:4169
4043 #: ../src/guestfs-actions.pod:4218 ../src/guestfs-actions.pod:4255
4044 #: ../src/guestfs-actions.pod:4269 ../src/guestfs-actions.pod:4297
4045 #: ../src/guestfs-actions.pod:4314 ../src/guestfs-actions.pod:4332
4046 #: ../src/guestfs-actions.pod:4466 ../src/guestfs-actions.pod:4524
4047 #: ../src/guestfs-actions.pod:4546 ../src/guestfs-actions.pod:4564
4048 #: ../src/guestfs-actions.pod:4596 ../src/guestfs-actions.pod:4662
4049 #: ../src/guestfs-actions.pod:4679 ../src/guestfs-actions.pod:4692
4050 #: ../src/guestfs-actions.pod:4706 ../src/guestfs-actions.pod:4997
4051 #: ../src/guestfs-actions.pod:5016 ../src/guestfs-actions.pod:5030
4052 #: ../src/guestfs-actions.pod:5042 ../src/guestfs-actions.pod:5056
4053 #: ../src/guestfs-actions.pod:5068 ../src/guestfs-actions.pod:5082
4054 #: ../src/guestfs-actions.pod:5098 ../src/guestfs-actions.pod:5119
4055 #: ../src/guestfs-actions.pod:5138 ../src/guestfs-actions.pod:5157
4056 #: ../src/guestfs-actions.pod:5175 ../src/guestfs-actions.pod:5198
4057 #: ../src/guestfs-actions.pod:5216 ../src/guestfs-actions.pod:5235
4058 #: ../src/guestfs-actions.pod:5256 ../src/guestfs-actions.pod:5275
4059 #: ../src/guestfs-actions.pod:5292 ../src/guestfs-actions.pod:5320
4060 #: ../src/guestfs-actions.pod:5344 ../src/guestfs-actions.pod:5363
4061 #: ../src/guestfs-actions.pod:5387 ../src/guestfs-actions.pod:5402
4062 #: ../src/guestfs-actions.pod:5417 ../src/guestfs-actions.pod:5436
4063 #: ../src/guestfs-actions.pod:5473 ../src/guestfs-actions.pod:5496
4064 #: ../src/guestfs-actions.pod:5522 ../src/guestfs-actions.pod:5630
4065 #: ../src/guestfs-actions.pod:5751 ../src/guestfs-actions.pod:5763
4066 #: ../src/guestfs-actions.pod:5776 ../src/guestfs-actions.pod:5789
4067 #: ../src/guestfs-actions.pod:5811 ../src/guestfs-actions.pod:5824
4068 #: ../src/guestfs-actions.pod:5837 ../src/guestfs-actions.pod:5850
4069 #: ../src/guestfs-actions.pod:5865 ../src/guestfs-actions.pod:5924
4070 #: ../src/guestfs-actions.pod:5941 ../src/guestfs-actions.pod:5957
4071 #: ../src/guestfs-actions.pod:5973 ../src/guestfs-actions.pod:5990
4072 #: ../src/guestfs-actions.pod:6003 ../src/guestfs-actions.pod:6023
4073 #: ../src/guestfs-actions.pod:6059 ../src/guestfs-actions.pod:6073
4074 #: ../src/guestfs-actions.pod:6114 ../src/guestfs-actions.pod:6127
4075 #: ../src/guestfs-actions.pod:6145 ../src/guestfs-actions.pod:6174
4076 #: ../src/guestfs-actions.pod:6205 ../src/guestfs-actions.pod:6324
4077 #: ../src/guestfs-actions.pod:6342 ../src/guestfs-actions.pod:6356
4078 #: ../src/guestfs-actions.pod:6411 ../src/guestfs-actions.pod:6424
4079 #: ../src/guestfs-actions.pod:6470 ../src/guestfs-actions.pod:6503
4080 #: ../src/guestfs-actions.pod:6557 ../src/guestfs-actions.pod:6583
4081 #: ../src/guestfs-actions.pod:6649 ../src/guestfs-actions.pod:6668
4082 #: ../src/guestfs-actions.pod:6697
4083 msgid "This function returns 0 on success or -1 on error."
4087 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:172
4088 #: ../src/guestfs-actions.pod:193 ../fish/guestfish-actions.pod:28
4089 #: ../fish/guestfish-actions.pod:117 ../fish/guestfish-actions.pod:131
4091 "This function is deprecated. In new code, use the C<add_drive_opts> call "
4096 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:175
4097 #: ../src/guestfs-actions.pod:196 ../src/guestfs-actions.pod:1406
4098 #: ../src/guestfs-actions.pod:1892 ../src/guestfs-actions.pod:1913
4099 #: ../src/guestfs-actions.pod:6591 ../src/guestfs-actions.pod:6760
4100 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:120
4101 #: ../fish/guestfish-actions.pod:134 ../fish/guestfish-actions.pod:940
4102 #: ../fish/guestfish-actions.pod:1297 ../fish/guestfish-actions.pod:1311
4103 #: ../fish/guestfish-actions.pod:4353 ../fish/guestfish-actions.pod:4450
4105 "Deprecated functions will not be removed from the API, but the fact that "
4106 "they are deprecated indicates that there are problems with correct use of "
4111 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:60
4112 #: ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:1864
4113 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:2065
4114 #: ../src/guestfs-actions.pod:2946 ../src/guestfs-actions.pod:2961
4115 #: ../src/guestfs-actions.pod:4105 ../src/guestfs-actions.pod:5177
4116 #: ../src/guestfs-actions.pod:5294 ../src/guestfs-actions.pod:5404
4117 #: ../src/guestfs-actions.pod:5867 ../src/guestfs-actions.pod:5992
4118 #: ../src/guestfs-actions.pod:6505
4119 msgid "(Added in 0.3)"
4123 #: ../src/guestfs-actions.pod:41
4124 msgid "guestfs_add_drive"
4128 #: ../src/guestfs-actions.pod:43
4132 " guestfs_add_drive (guestfs_h *g,\n"
4133 " const char *filename);\n"
4138 #: ../src/guestfs-actions.pod:47
4140 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
4141 "optional parameters, so the disk is added writable, with the format being "
4142 "detected automatically."
4146 #: ../src/guestfs-actions.pod:51
4148 "Automatic detection of the format opens you up to a potential security hole "
4149 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4150 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4151 "you should think about replacing calls to this function with calls to "
4152 "C<guestfs_add_drive_opts>, and specifying the format."
4156 #: ../src/guestfs-actions.pod:62
4157 msgid "guestfs_add_drive_opts"
4161 #: ../src/guestfs-actions.pod:64
4165 " guestfs_add_drive_opts (guestfs_h *g,\n"
4166 " const char *filename,\n"
4172 #: ../src/guestfs-actions.pod:69
4174 "You may supply a list of optional arguments to this call. Use zero or more "
4175 "of the following pairs of parameters, and terminate the list with C<-1> on "
4176 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
4180 #: ../src/guestfs-actions.pod:74
4183 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
4184 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
4185 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
4190 #: ../src/guestfs-actions.pod:78 ../fish/guestfish-actions.pod:56
4192 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4193 "The first time you call this function, the disk appears as C</dev/sda>, the "
4194 "second time as C</dev/sdb>, and so on."
4198 #: ../src/guestfs-actions.pod:83 ../fish/guestfish-actions.pod:61
4200 "You don't necessarily need to be root when using libguestfs. However you "
4201 "obviously do need sufficient permissions to access the filename for whatever "
4202 "operations you want to perform (ie. read access if you just want to read the "
4203 "image or write access if you want to modify the image)."
4207 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:67
4208 msgid "This call checks that C<filename> exists."
4212 #: ../src/guestfs-actions.pod:91 ../fish/guestfish-actions.pod:69
4213 msgid "The optional arguments are:"
4217 #: ../src/guestfs-actions.pod:95 ../fish/guestfish-actions.pod:73
4222 #: ../src/guestfs-actions.pod:97 ../fish/guestfish-actions.pod:75
4224 "If true then the image is treated as read-only. Writes are still allowed, "
4225 "but they are stored in a temporary snapshot overlay which is discarded at "
4226 "the end. The disk that you add is not modified."
4230 #: ../src/guestfs-actions.pod:101 ../fish/guestfish-actions.pod:79
4235 #: ../src/guestfs-actions.pod:103
4237 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4238 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4239 "Possible formats include C<raw> and C<qcow2>."
4243 #: ../src/guestfs-actions.pod:107 ../fish/guestfish-actions.pod:85
4245 "Automatic detection of the format opens you up to a potential security hole "
4246 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4247 "RHBZ#642934. Specifying the format closes this security hole."
4251 #: ../src/guestfs-actions.pod:112 ../fish/guestfish-actions.pod:90
4256 #: ../src/guestfs-actions.pod:114
4258 "This rarely-used option lets you emulate the behaviour of the deprecated "
4259 "C<guestfs_add_drive_with_if> call (q.v.)"
4263 #: ../src/guestfs-actions.pod:121
4264 msgid "(Added in 1.5.23)"
4268 #: ../src/guestfs-actions.pod:123
4269 msgid "guestfs_add_drive_opts_va"
4273 #: ../src/guestfs-actions.pod:125
4277 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
4278 " const char *filename,\n"
4284 #: ../src/guestfs-actions.pod:130
4285 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4289 #: ../src/guestfs-actions.pod:132 ../src/guestfs-actions.pod:143
4290 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4294 #: ../src/guestfs-actions.pod:134
4295 msgid "guestfs_add_drive_opts_argv"
4299 #: ../src/guestfs-actions.pod:136
4303 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4304 " const char *filename,\n"
4305 " const struct guestfs_add_drive_opts_argv *optargs);\n"
4310 #: ../src/guestfs-actions.pod:141
4311 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4315 #: ../src/guestfs-actions.pod:145
4316 msgid "guestfs_add_drive_ro"
4320 #: ../src/guestfs-actions.pod:147
4324 " guestfs_add_drive_ro (guestfs_h *g,\n"
4325 " const char *filename);\n"
4330 #: ../src/guestfs-actions.pod:151
4332 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4333 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4334 "disk is added read-only, with the format being detected automatically."
4338 #: ../src/guestfs-actions.pod:158
4339 msgid "(Added in 1.0.38)"
4343 #: ../src/guestfs-actions.pod:160
4344 msgid "guestfs_add_drive_ro_with_if"
4348 #: ../src/guestfs-actions.pod:162
4352 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4353 " const char *filename,\n"
4354 " const char *iface);\n"
4359 #: ../src/guestfs-actions.pod:167
4361 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4362 "QEMU interface emulation to use at run time."
4366 #: ../src/guestfs-actions.pod:179 ../src/guestfs-actions.pod:200
4367 #: ../src/guestfs-actions.pod:2275
4368 msgid "(Added in 1.0.84)"
4372 #: ../src/guestfs-actions.pod:181
4373 msgid "guestfs_add_drive_with_if"
4377 #: ../src/guestfs-actions.pod:183
4381 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4382 " const char *filename,\n"
4383 " const char *iface);\n"
4388 #: ../src/guestfs-actions.pod:188
4390 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4391 "QEMU interface emulation to use at run time."
4395 #: ../src/guestfs-actions.pod:202
4396 msgid "guestfs_aug_clear"
4400 #: ../src/guestfs-actions.pod:204
4404 " guestfs_aug_clear (guestfs_h *g,\n"
4405 " const char *augpath);\n"
4410 #: ../src/guestfs-actions.pod:208 ../fish/guestfish-actions.pod:142
4412 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4413 "L<augtool(1)> C<clear> command."
4417 #: ../src/guestfs-actions.pod:213 ../src/guestfs-actions.pod:2054
4418 msgid "(Added in 1.3.4)"
4422 #: ../src/guestfs-actions.pod:215
4423 msgid "guestfs_aug_close"
4427 #: ../src/guestfs-actions.pod:217
4431 " guestfs_aug_close (guestfs_h *g);\n"
4436 #: ../src/guestfs-actions.pod:220
4438 "Close the current Augeas handle and free up any resources used by it. After "
4439 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4440 "any other Augeas functions."
4444 #: ../src/guestfs-actions.pod:227 ../src/guestfs-actions.pod:252
4445 #: ../src/guestfs-actions.pod:270 ../src/guestfs-actions.pod:284
4446 #: ../src/guestfs-actions.pod:342 ../src/guestfs-actions.pod:362
4447 #: ../src/guestfs-actions.pod:376 ../src/guestfs-actions.pod:407
4448 #: ../src/guestfs-actions.pod:421 ../src/guestfs-actions.pod:435
4449 #: ../src/guestfs-actions.pod:449 ../src/guestfs-actions.pod:467
4450 #: ../src/guestfs-actions.pod:4854
4451 msgid "(Added in 0.7)"
4455 #: ../src/guestfs-actions.pod:229
4456 msgid "guestfs_aug_defnode"
4460 #: ../src/guestfs-actions.pod:231
4463 " struct guestfs_int_bool *\n"
4464 " guestfs_aug_defnode (guestfs_h *g,\n"
4465 " const char *name,\n"
4466 " const char *expr,\n"
4467 " const char *val);\n"
4472 #: ../src/guestfs-actions.pod:237 ../fish/guestfish-actions.pod:158
4474 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4478 #: ../src/guestfs-actions.pod:240
4480 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4481 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4482 "containing that single node."
4486 #: ../src/guestfs-actions.pod:244 ../fish/guestfish-actions.pod:165
4488 "On success this returns a pair containing the number of nodes in the "
4489 "nodeset, and a boolean flag if a node was created."
4493 #: ../src/guestfs-actions.pod:248
4495 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4496 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4500 #: ../src/guestfs-actions.pod:254
4501 msgid "guestfs_aug_defvar"
4505 #: ../src/guestfs-actions.pod:256
4509 " guestfs_aug_defvar (guestfs_h *g,\n"
4510 " const char *name,\n"
4511 " const char *expr);\n"
4516 #: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:173
4518 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4519 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4523 #: ../src/guestfs-actions.pod:265 ../fish/guestfish-actions.pod:177
4525 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4526 "evaluates to something which is not a nodeset."
4530 #: ../src/guestfs-actions.pod:268 ../src/guestfs-actions.pod:433
4531 #: ../src/guestfs-actions.pod:611 ../src/guestfs-actions.pod:642
4532 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:679
4533 #: ../src/guestfs-actions.pod:1278 ../src/guestfs-actions.pod:1632
4534 #: ../src/guestfs-actions.pod:1835 ../src/guestfs-actions.pod:1934
4535 #: ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:2029
4536 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2316
4537 #: ../src/guestfs-actions.pod:2575 ../src/guestfs-actions.pod:2596
4538 #: ../src/guestfs-actions.pod:4241 ../src/guestfs-actions.pod:4369
4539 #: ../src/guestfs-actions.pod:4777 ../src/guestfs-actions.pod:4803
4540 #: ../src/guestfs-actions.pod:6100 ../src/guestfs-actions.pod:6516
4541 #: ../src/guestfs-actions.pod:6529 ../src/guestfs-actions.pod:6542
4542 msgid "On error this function returns -1."
4546 #: ../src/guestfs-actions.pod:272
4547 msgid "guestfs_aug_get"
4551 #: ../src/guestfs-actions.pod:274
4555 " guestfs_aug_get (guestfs_h *g,\n"
4556 " const char *augpath);\n"
4561 #: ../src/guestfs-actions.pod:278 ../fish/guestfish-actions.pod:184
4563 "Look up the value associated with C<path>. If C<path> matches exactly one "
4564 "node, the C<value> is returned."
4568 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:781
4569 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:859
4570 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:978
4571 #: ../src/guestfs-actions.pod:1112 ../src/guestfs-actions.pod:1147
4572 #: ../src/guestfs-actions.pod:1164 ../src/guestfs-actions.pod:1183
4573 #: ../src/guestfs-actions.pod:1312 ../src/guestfs-actions.pod:1503
4574 #: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1778
4575 #: ../src/guestfs-actions.pod:1795 ../src/guestfs-actions.pod:1886
4576 #: ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:2077
4577 #: ../src/guestfs-actions.pod:2240 ../src/guestfs-actions.pod:2448
4578 #: ../src/guestfs-actions.pod:2521 ../src/guestfs-actions.pod:2652
4579 #: ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2713
4580 #: ../src/guestfs-actions.pod:3091 ../src/guestfs-actions.pod:3442
4581 #: ../src/guestfs-actions.pod:3613 ../src/guestfs-actions.pod:3724
4582 #: ../src/guestfs-actions.pod:4387 ../src/guestfs-actions.pod:4581
4583 #: ../src/guestfs-actions.pod:4752 ../src/guestfs-actions.pod:4931
4584 #: ../src/guestfs-actions.pod:4980 ../src/guestfs-actions.pod:5543
4585 #: ../src/guestfs-actions.pod:5559 ../src/guestfs-actions.pod:5576
4586 #: ../src/guestfs-actions.pod:5600 ../src/guestfs-actions.pod:6264
4587 #: ../src/guestfs-actions.pod:6283 ../src/guestfs-actions.pod:6301
4588 #: ../src/guestfs-actions.pod:6482 ../src/guestfs-actions.pod:6754
4590 "This function returns a string, or NULL on error. I<The caller must free "
4591 "the returned string after use>."
4595 #: ../src/guestfs-actions.pod:286
4596 msgid "guestfs_aug_init"
4600 #: ../src/guestfs-actions.pod:288
4604 " guestfs_aug_init (guestfs_h *g,\n"
4605 " const char *root,\n"
4611 #: ../src/guestfs-actions.pod:293 ../fish/guestfish-actions.pod:191
4613 "Create a new Augeas handle for editing configuration files. If there was "
4614 "any previous Augeas handle associated with this guestfs session, then it is "
4619 #: ../src/guestfs-actions.pod:297
4620 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4624 #: ../src/guestfs-actions.pod:300 ../fish/guestfish-actions.pod:198
4626 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4630 #: ../src/guestfs-actions.pod:303 ../fish/guestfish-actions.pod:201
4632 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4633 "logical I<or> of the following integers:"
4637 #: ../src/guestfs-actions.pod:309 ../fish/guestfish-actions.pod:207
4638 msgid "C<AUG_SAVE_BACKUP> = 1"
4642 #: ../src/guestfs-actions.pod:311 ../fish/guestfish-actions.pod:209
4643 msgid "Keep the original file with a C<.augsave> extension."
4647 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:211
4648 msgid "C<AUG_SAVE_NEWFILE> = 2"
4652 #: ../src/guestfs-actions.pod:315 ../fish/guestfish-actions.pod:213
4654 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4655 "original. Overrides C<AUG_SAVE_BACKUP>."
4659 #: ../src/guestfs-actions.pod:318 ../fish/guestfish-actions.pod:216
4660 msgid "C<AUG_TYPE_CHECK> = 4"
4664 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:218
4665 msgid "Typecheck lenses (can be expensive)."
4669 #: ../src/guestfs-actions.pod:322 ../fish/guestfish-actions.pod:220
4670 msgid "C<AUG_NO_STDINC> = 8"
4674 #: ../src/guestfs-actions.pod:324 ../fish/guestfish-actions.pod:222
4675 msgid "Do not use standard load path for modules."
4679 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:224
4680 msgid "C<AUG_SAVE_NOOP> = 16"
4684 #: ../src/guestfs-actions.pod:328 ../fish/guestfish-actions.pod:226
4685 msgid "Make save a no-op, just record what would have been changed."
4689 #: ../src/guestfs-actions.pod:330 ../fish/guestfish-actions.pod:228
4690 msgid "C<AUG_NO_LOAD> = 32"
4694 #: ../src/guestfs-actions.pod:332
4695 msgid "Do not load the tree in C<guestfs_aug_init>."
4699 #: ../src/guestfs-actions.pod:336
4700 msgid "To close the handle, you can call C<guestfs_aug_close>."
4704 #: ../src/guestfs-actions.pod:338 ../fish/guestfish-actions.pod:236
4705 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4709 #: ../src/guestfs-actions.pod:344
4710 msgid "guestfs_aug_insert"
4714 #: ../src/guestfs-actions.pod:346
4718 " guestfs_aug_insert (guestfs_h *g,\n"
4719 " const char *augpath,\n"
4720 " const char *label,\n"
4726 #: ../src/guestfs-actions.pod:352 ../fish/guestfish-actions.pod:242
4728 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4729 "or after C<path> (depending on the boolean flag C<before>)."
4733 #: ../src/guestfs-actions.pod:356 ../fish/guestfish-actions.pod:246
4735 "C<path> must match exactly one existing node in the tree, and C<label> must "
4736 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4740 #: ../src/guestfs-actions.pod:364
4741 msgid "guestfs_aug_load"
4745 #: ../src/guestfs-actions.pod:366
4749 " guestfs_aug_load (guestfs_h *g);\n"
4754 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:254
4755 msgid "Load files into the tree."
4759 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:256
4760 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4764 #: ../src/guestfs-actions.pod:378
4765 msgid "guestfs_aug_ls"
4769 #: ../src/guestfs-actions.pod:380
4773 " guestfs_aug_ls (guestfs_h *g,\n"
4774 " const char *augpath);\n"
4779 #: ../src/guestfs-actions.pod:384
4781 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
4782 "sorting the resulting nodes into alphabetical order."
4786 #: ../src/guestfs-actions.pod:387 ../src/guestfs-actions.pod:403
4787 #: ../src/guestfs-actions.pod:549 ../src/guestfs-actions.pod:997
4788 #: ../src/guestfs-actions.pod:1327 ../src/guestfs-actions.pod:1346
4789 #: ../src/guestfs-actions.pod:1449 ../src/guestfs-actions.pod:1468
4790 #: ../src/guestfs-actions.pod:1717 ../src/guestfs-actions.pod:2120
4791 #: ../src/guestfs-actions.pod:2136 ../src/guestfs-actions.pod:2155
4792 #: ../src/guestfs-actions.pod:2198 ../src/guestfs-actions.pod:2222
4793 #: ../src/guestfs-actions.pod:2293 ../src/guestfs-actions.pod:2342
4794 #: ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:2755
4795 #: ../src/guestfs-actions.pod:3011 ../src/guestfs-actions.pod:3073
4796 #: ../src/guestfs-actions.pod:3178 ../src/guestfs-actions.pod:3584
4797 #: ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:4723
4798 #: ../src/guestfs-actions.pod:4850 ../src/guestfs-actions.pod:4965
4799 #: ../src/guestfs-actions.pod:5616 ../src/guestfs-actions.pod:5677
4800 #: ../src/guestfs-actions.pod:5732 ../src/guestfs-actions.pod:5878
4801 #: ../src/guestfs-actions.pod:5902 ../src/guestfs-actions.pod:6374
4802 #: ../src/guestfs-actions.pod:6394 ../src/guestfs-actions.pod:6441
4803 #: ../src/guestfs-actions.pod:6607 ../src/guestfs-actions.pod:6626
4804 #: ../src/guestfs-actions.pod:6711 ../src/guestfs-actions.pod:6730
4805 #: ../src/guestfs-actions.pod:6776 ../src/guestfs-actions.pod:6795
4807 "This function returns a NULL-terminated array of strings (like L<environ(3)"
4808 ">), or NULL if there was an error. I<The caller must free the strings and "
4809 "the array after use>."
4813 #: ../src/guestfs-actions.pod:391 ../src/guestfs-actions.pod:922
4814 #: ../src/guestfs-actions.pod:940 ../src/guestfs-actions.pod:1384
4815 #: ../src/guestfs-actions.pod:2833 ../src/guestfs-actions.pod:2864
4816 #: ../src/guestfs-actions.pod:3425 ../src/guestfs-actions.pod:3475
4817 #: ../src/guestfs-actions.pod:3664 ../src/guestfs-actions.pod:3697
4818 #: ../src/guestfs-actions.pod:3860 ../src/guestfs-actions.pod:4206
4819 #: ../src/guestfs-actions.pod:4664 ../src/guestfs-actions.pod:5044
4820 #: ../src/guestfs-actions.pod:5058 ../src/guestfs-actions.pod:5070
4821 #: ../src/guestfs-actions.pod:5478 ../src/guestfs-actions.pod:6116
4822 #: ../src/guestfs-actions.pod:6129 ../src/guestfs-actions.pod:6358
4823 #: ../src/guestfs-actions.pod:6562 ../src/guestfs-actions.pod:6595
4824 msgid "(Added in 0.8)"
4828 #: ../src/guestfs-actions.pod:393
4829 msgid "guestfs_aug_match"
4833 #: ../src/guestfs-actions.pod:395
4837 " guestfs_aug_match (guestfs_h *g,\n"
4838 " const char *augpath);\n"
4843 #: ../src/guestfs-actions.pod:399 ../fish/guestfish-actions.pod:270
4845 "Returns a list of paths which match the path expression C<path>. The "
4846 "returned paths are sufficiently qualified so that they match exactly one "
4847 "node in the current tree."
4851 #: ../src/guestfs-actions.pod:409
4852 msgid "guestfs_aug_mv"
4856 #: ../src/guestfs-actions.pod:411
4860 " guestfs_aug_mv (guestfs_h *g,\n"
4861 " const char *src,\n"
4862 " const char *dest);\n"
4867 #: ../src/guestfs-actions.pod:416 ../fish/guestfish-actions.pod:278
4869 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4870 "C<dest> is overwritten if it exists."
4874 #: ../src/guestfs-actions.pod:423
4875 msgid "guestfs_aug_rm"
4879 #: ../src/guestfs-actions.pod:425
4883 " guestfs_aug_rm (guestfs_h *g,\n"
4884 " const char *augpath);\n"
4889 #: ../src/guestfs-actions.pod:429 ../fish/guestfish-actions.pod:285
4890 msgid "Remove C<path> and all of its children."
4894 #: ../src/guestfs-actions.pod:431 ../fish/guestfish-actions.pod:287
4895 msgid "On success this returns the number of entries which were removed."
4899 #: ../src/guestfs-actions.pod:437
4900 msgid "guestfs_aug_save"
4904 #: ../src/guestfs-actions.pod:439
4908 " guestfs_aug_save (guestfs_h *g);\n"
4913 #: ../src/guestfs-actions.pod:442 ../fish/guestfish-actions.pod:293
4914 msgid "This writes all pending changes to disk."
4918 #: ../src/guestfs-actions.pod:444
4920 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
4925 #: ../src/guestfs-actions.pod:451
4926 msgid "guestfs_aug_set"
4930 #: ../src/guestfs-actions.pod:453
4934 " guestfs_aug_set (guestfs_h *g,\n"
4935 " const char *augpath,\n"
4936 " const char *val);\n"
4941 #: ../src/guestfs-actions.pod:458 ../fish/guestfish-actions.pod:302
4942 msgid "Set the value associated with C<path> to C<val>."
4946 #: ../src/guestfs-actions.pod:460
4948 "In the Augeas API, it is possible to clear a node by setting the value to "
4949 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
4950 "this call. Instead you must use the C<guestfs_aug_clear> call."
4954 #: ../src/guestfs-actions.pod:469
4955 msgid "guestfs_available"
4959 #: ../src/guestfs-actions.pod:471
4963 " guestfs_available (guestfs_h *g,\n"
4964 " char *const *groups);\n"
4969 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:313
4971 "This command is used to check the availability of some groups of "
4972 "functionality in the appliance, which not all builds of the libguestfs "
4973 "appliance will be able to provide."
4977 #: ../src/guestfs-actions.pod:479
4979 "The libguestfs groups, and the functions that those groups correspond to, "
4980 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
4981 "runtime by calling C<guestfs_available_all_groups>."
4985 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:322
4987 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
4988 "\"]> would check for the availability of the Linux inotify functions and "
4989 "Augeas (configuration file editing) functions."
4993 #: ../src/guestfs-actions.pod:489 ../fish/guestfish-actions.pod:327
4994 msgid "The command returns no error if I<all> requested groups are available."
4998 #: ../src/guestfs-actions.pod:491 ../fish/guestfish-actions.pod:329
5000 "It fails with an error if one or more of the requested groups is unavailable "
5005 #: ../src/guestfs-actions.pod:494 ../fish/guestfish-actions.pod:332
5007 "If an unknown group name is included in the list of groups then an error is "
5012 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:335
5017 #: ../src/guestfs-actions.pod:503
5018 msgid "You must call C<guestfs_launch> before calling this function."
5022 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:343
5024 "The reason is because we don't know what groups are supported by the "
5025 "appliance/daemon until it is running and can be queried."
5029 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:349
5031 "If a group of functions is available, this does not necessarily mean that "
5032 "they will work. You still have to check for errors when calling individual "
5033 "API functions even if they are available."
5037 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:356
5039 "It is usually the job of distro packagers to build complete functionality "
5040 "into the libguestfs appliance. Upstream libguestfs, if built from source "
5041 "with all requirements satisfied, will support everything."
5045 #: ../src/guestfs-actions.pod:525
5047 "This call was added in version C<1.0.80>. In previous versions of "
5048 "libguestfs all you could do would be to speculatively execute a command to "
5049 "find out if the daemon implemented it. See also C<guestfs_version>."
5053 #: ../src/guestfs-actions.pod:534 ../src/guestfs-actions.pod:1095
5054 msgid "(Added in 1.0.80)"
5058 #: ../src/guestfs-actions.pod:536
5059 msgid "guestfs_available_all_groups"
5063 #: ../src/guestfs-actions.pod:538
5067 " guestfs_available_all_groups (guestfs_h *g);\n"
5072 #: ../src/guestfs-actions.pod:541
5074 "This command returns a list of all optional groups that this daemon knows "
5075 "about. Note this returns both supported and unsupported groups. To find "
5076 "out which ones the daemon can actually support you have to call "
5077 "C<guestfs_available> on each member of the returned list."
5081 #: ../src/guestfs-actions.pod:547
5082 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
5086 #: ../src/guestfs-actions.pod:553
5087 msgid "(Added in 1.3.15)"
5091 #: ../src/guestfs-actions.pod:555
5092 msgid "guestfs_base64_in"
5096 #: ../src/guestfs-actions.pod:557
5100 " guestfs_base64_in (guestfs_h *g,\n"
5101 " const char *base64file,\n"
5102 " const char *filename);\n"
5107 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:386
5109 "This command uploads base64-encoded data from C<base64file> to C<filename>."
5113 #: ../src/guestfs-actions.pod:567 ../src/guestfs-actions.pod:581
5114 #: ../src/guestfs-actions.pod:1134
5115 msgid "(Added in 1.3.5)"
5119 #: ../src/guestfs-actions.pod:569
5120 msgid "guestfs_base64_out"
5124 #: ../src/guestfs-actions.pod:571
5128 " guestfs_base64_out (guestfs_h *g,\n"
5129 " const char *filename,\n"
5130 " const char *base64file);\n"
5135 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:395
5137 "This command downloads the contents of C<filename>, writing it out to local "
5138 "file C<base64file> encoded as base64."
5142 #: ../src/guestfs-actions.pod:583
5143 msgid "guestfs_blockdev_flushbufs"
5147 #: ../src/guestfs-actions.pod:585
5151 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
5152 " const char *device);\n"
5157 #: ../src/guestfs-actions.pod:589 ../fish/guestfish-actions.pod:404
5159 "This tells the kernel to flush internal buffers associated with C<device>."
5163 #: ../src/guestfs-actions.pod:592 ../src/guestfs-actions.pod:609
5164 #: ../src/guestfs-actions.pod:624 ../src/guestfs-actions.pod:640
5165 #: ../src/guestfs-actions.pod:658 ../src/guestfs-actions.pod:677
5166 #: ../src/guestfs-actions.pod:691 ../src/guestfs-actions.pod:709
5167 #: ../src/guestfs-actions.pod:723 ../src/guestfs-actions.pod:737
5168 #: ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:418
5169 #: ../fish/guestfish-actions.pod:427 ../fish/guestfish-actions.pod:437
5170 #: ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:462
5171 #: ../fish/guestfish-actions.pod:470 ../fish/guestfish-actions.pod:481
5172 #: ../fish/guestfish-actions.pod:489 ../fish/guestfish-actions.pod:497
5173 msgid "This uses the L<blockdev(8)> command."
5177 #: ../src/guestfs-actions.pod:596 ../src/guestfs-actions.pod:613
5178 #: ../src/guestfs-actions.pod:628 ../src/guestfs-actions.pod:644
5179 #: ../src/guestfs-actions.pod:662 ../src/guestfs-actions.pod:681
5180 #: ../src/guestfs-actions.pod:695 ../src/guestfs-actions.pod:713
5181 #: ../src/guestfs-actions.pod:727 ../src/guestfs-actions.pod:741
5182 msgid "(Added in 0.9.3)"
5186 #: ../src/guestfs-actions.pod:598
5187 msgid "guestfs_blockdev_getbsz"
5191 #: ../src/guestfs-actions.pod:600
5195 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
5196 " const char *device);\n"
5201 #: ../src/guestfs-actions.pod:604 ../fish/guestfish-actions.pod:413
5202 msgid "This returns the block size of a device."
5206 #: ../src/guestfs-actions.pod:606 ../src/guestfs-actions.pod:706
5207 #: ../fish/guestfish-actions.pod:415 ../fish/guestfish-actions.pod:478
5209 "(Note this is different from both I<size in blocks> and I<filesystem block "
5214 #: ../src/guestfs-actions.pod:615
5215 msgid "guestfs_blockdev_getro"
5219 #: ../src/guestfs-actions.pod:617
5223 " guestfs_blockdev_getro (guestfs_h *g,\n"
5224 " const char *device);\n"
5229 #: ../src/guestfs-actions.pod:621 ../fish/guestfish-actions.pod:424
5231 "Returns a boolean indicating if the block device is read-only (true if read-"
5232 "only, false if not)."
5236 #: ../src/guestfs-actions.pod:626 ../src/guestfs-actions.pod:1367
5237 #: ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1862
5238 #: ../src/guestfs-actions.pod:1873 ../src/guestfs-actions.pod:1945
5239 #: ../src/guestfs-actions.pod:2000 ../src/guestfs-actions.pod:2015
5240 #: ../src/guestfs-actions.pod:2040 ../src/guestfs-actions.pod:2063
5241 #: ../src/guestfs-actions.pod:2772 ../src/guestfs-actions.pod:2786
5242 #: ../src/guestfs-actions.pod:2801 ../src/guestfs-actions.pod:2815
5243 #: ../src/guestfs-actions.pod:2831 ../src/guestfs-actions.pod:2846
5244 #: ../src/guestfs-actions.pod:2862 ../src/guestfs-actions.pod:2876
5245 #: ../src/guestfs-actions.pod:2889 ../src/guestfs-actions.pod:2903
5246 #: ../src/guestfs-actions.pod:2918 ../src/guestfs-actions.pod:2933
5247 #: ../src/guestfs-actions.pod:4351
5248 msgid "This function returns a C truth value on success or -1 on error."
5252 #: ../src/guestfs-actions.pod:630
5253 msgid "guestfs_blockdev_getsize64"
5257 #: ../src/guestfs-actions.pod:632
5261 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
5262 " const char *device);\n"
5267 #: ../src/guestfs-actions.pod:636 ../fish/guestfish-actions.pod:433
5268 msgid "This returns the size of the device in bytes."
5272 #: ../src/guestfs-actions.pod:638
5273 msgid "See also C<guestfs_blockdev_getsz>."
5277 #: ../src/guestfs-actions.pod:646
5278 msgid "guestfs_blockdev_getss"
5282 #: ../src/guestfs-actions.pod:648
5286 " guestfs_blockdev_getss (guestfs_h *g,\n"
5287 " const char *device);\n"
5292 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:443
5294 "This returns the size of sectors on a block device. Usually 512, but can be "
5295 "larger for modern devices."
5299 #: ../src/guestfs-actions.pod:655
5301 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
5306 #: ../src/guestfs-actions.pod:664
5307 msgid "guestfs_blockdev_getsz"
5311 #: ../src/guestfs-actions.pod:666
5315 " guestfs_blockdev_getsz (guestfs_h *g,\n"
5316 " const char *device);\n"
5321 #: ../src/guestfs-actions.pod:670 ../fish/guestfish-actions.pod:455
5323 "This returns the size of the device in units of 512-byte sectors (even if "
5324 "the sectorsize isn't 512 bytes ... weird)."
5328 #: ../src/guestfs-actions.pod:673
5330 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
5331 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
5335 #: ../src/guestfs-actions.pod:683
5336 msgid "guestfs_blockdev_rereadpt"
5340 #: ../src/guestfs-actions.pod:685
5344 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5345 " const char *device);\n"
5350 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:468
5351 msgid "Reread the partition table on C<device>."
5355 #: ../src/guestfs-actions.pod:697
5356 msgid "guestfs_blockdev_setbsz"
5360 #: ../src/guestfs-actions.pod:699
5364 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5365 " const char *device,\n"
5366 " int blocksize);\n"
5371 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:476
5372 msgid "This sets the block size of a device."
5376 #: ../src/guestfs-actions.pod:715
5377 msgid "guestfs_blockdev_setro"
5381 #: ../src/guestfs-actions.pod:717
5385 " guestfs_blockdev_setro (guestfs_h *g,\n"
5386 " const char *device);\n"
5391 #: ../src/guestfs-actions.pod:721 ../fish/guestfish-actions.pod:487
5392 msgid "Sets the block device named C<device> to read-only."
5396 #: ../src/guestfs-actions.pod:729
5397 msgid "guestfs_blockdev_setrw"
5401 #: ../src/guestfs-actions.pod:731
5405 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5406 " const char *device);\n"
5411 #: ../src/guestfs-actions.pod:735 ../fish/guestfish-actions.pod:495
5412 msgid "Sets the block device named C<device> to read-write."
5416 #: ../src/guestfs-actions.pod:743
5417 msgid "guestfs_case_sensitive_path"
5421 #: ../src/guestfs-actions.pod:745
5425 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5426 " const char *path);\n"
5431 #: ../src/guestfs-actions.pod:749 ../fish/guestfish-actions.pod:503
5433 "This can be used to resolve case insensitive paths on a filesystem which is "
5434 "case sensitive. The use case is to resolve paths which you have read from "
5435 "Windows configuration files or the Windows Registry, to the true path."
5439 #: ../src/guestfs-actions.pod:754 ../fish/guestfish-actions.pod:508
5441 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5442 "(and probably others), which is that although the underlying filesystem is "
5443 "case-insensitive, the driver exports the filesystem to Linux as case-"
5448 #: ../src/guestfs-actions.pod:759 ../fish/guestfish-actions.pod:513
5450 "One consequence of this is that special directories such as C<c:\\windows> "
5451 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5452 "precise details of how they were created. In Windows itself this would not "
5457 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:519
5459 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
5464 #: ../src/guestfs-actions.pod:768 ../fish/guestfish-actions.pod:522
5466 "This function resolves the true case of each element in the path and returns "
5467 "the case-sensitive path."
5471 #: ../src/guestfs-actions.pod:771
5473 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
5474 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5475 "how the directories were originally created under Windows)."
5479 #: ../src/guestfs-actions.pod:776 ../fish/guestfish-actions.pod:530
5480 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5484 #: ../src/guestfs-actions.pod:779
5485 msgid "See also C<guestfs_realpath>."
5489 #: ../src/guestfs-actions.pod:784 ../src/guestfs-actions.pod:6286
5490 msgid "(Added in 1.0.75)"
5494 #: ../src/guestfs-actions.pod:786
5499 #: ../src/guestfs-actions.pod:788
5503 " guestfs_cat (guestfs_h *g,\n"
5504 " const char *path);\n"
5509 #: ../src/guestfs-actions.pod:792 ../src/guestfs-actions.pod:4840
5510 #: ../fish/guestfish-actions.pod:539 ../fish/guestfish-actions.pod:3197
5511 msgid "Return the contents of the file named C<path>."
5515 #: ../src/guestfs-actions.pod:794
5517 "Note that this function cannot correctly handle binary files (specifically, "
5518 "files containing C<\\0> character which is treated as end of string). For "
5519 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5520 "functions which have a more complex interface."
5524 #: ../src/guestfs-actions.pod:802 ../src/guestfs-actions.pod:981
5525 #: ../src/guestfs-actions.pod:1001 ../src/guestfs-actions.pod:1331
5526 #: ../src/guestfs-actions.pod:1350 ../src/guestfs-actions.pod:1453
5527 #: ../src/guestfs-actions.pod:1472 ../src/guestfs-actions.pod:1721
5528 #: ../src/guestfs-actions.pod:2140 ../src/guestfs-actions.pod:2159
5529 #: ../src/guestfs-actions.pod:2202 ../src/guestfs-actions.pod:2226
5530 #: ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2272
5531 #: ../src/guestfs-actions.pod:4621 ../src/guestfs-actions.pod:4647
5532 #: ../src/guestfs-actions.pod:4779 ../src/guestfs-actions.pod:4805
5533 #: ../src/guestfs-actions.pod:4829 ../src/guestfs-actions.pod:5681
5534 #: ../src/guestfs-actions.pod:5736 ../src/guestfs-actions.pod:5882
5535 #: ../src/guestfs-actions.pod:5906 ../src/guestfs-actions.pod:6559
5536 #: ../src/guestfs-actions.pod:6585 ../src/guestfs-actions.pod:6611
5537 #: ../src/guestfs-actions.pod:6630 ../src/guestfs-actions.pod:6715
5538 #: ../src/guestfs-actions.pod:6734 ../src/guestfs-actions.pod:6780
5539 #: ../src/guestfs-actions.pod:6799 ../fish/guestfish-actions.pod:546
5540 #: ../fish/guestfish-actions.pod:681 ../fish/guestfish-actions.pod:693
5541 #: ../fish/guestfish-actions.pod:894 ../fish/guestfish-actions.pod:904
5542 #: ../fish/guestfish-actions.pod:971 ../fish/guestfish-actions.pod:981
5543 #: ../fish/guestfish-actions.pod:1176 ../fish/guestfish-actions.pod:1451
5544 #: ../fish/guestfish-actions.pod:1461 ../fish/guestfish-actions.pod:1489
5545 #: ../fish/guestfish-actions.pod:1504 ../fish/guestfish-actions.pod:1514
5546 #: ../fish/guestfish-actions.pod:1533 ../fish/guestfish-actions.pod:3067
5547 #: ../fish/guestfish-actions.pod:3082 ../fish/guestfish-actions.pod:3158
5548 #: ../fish/guestfish-actions.pod:3175 ../fish/guestfish-actions.pod:3190
5549 #: ../fish/guestfish-actions.pod:3773 ../fish/guestfish-actions.pod:3819
5550 #: ../fish/guestfish-actions.pod:3904 ../fish/guestfish-actions.pod:3919
5551 #: ../fish/guestfish-actions.pod:4329 ../fish/guestfish-actions.pod:4347
5552 #: ../fish/guestfish-actions.pod:4364 ../fish/guestfish-actions.pod:4374
5553 #: ../fish/guestfish-actions.pod:4422 ../fish/guestfish-actions.pod:4432
5554 #: ../fish/guestfish-actions.pod:4461 ../fish/guestfish-actions.pod:4471
5556 "Because of the message protocol, there is a transfer limit of somewhere "
5557 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5561 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:3015
5562 #: ../src/guestfs-actions.pod:3077 ../src/guestfs-actions.pod:3094
5563 #: ../src/guestfs-actions.pod:3182 ../src/guestfs-actions.pod:3588
5564 #: ../src/guestfs-actions.pod:3603 ../src/guestfs-actions.pod:4727
5565 #: ../src/guestfs-actions.pod:4742 ../src/guestfs-actions.pod:6445
5566 #: ../src/guestfs-actions.pod:6460
5567 msgid "(Added in 0.4)"
5571 #: ../src/guestfs-actions.pod:807
5572 msgid "guestfs_checksum"
5576 #: ../src/guestfs-actions.pod:809
5580 " guestfs_checksum (guestfs_h *g,\n"
5581 " const char *csumtype,\n"
5582 " const char *path);\n"
5587 #: ../src/guestfs-actions.pod:814 ../fish/guestfish-actions.pod:553
5589 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5593 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:556
5595 "The type of checksum to compute is given by the C<csumtype> parameter which "
5596 "must have one of the following values:"
5600 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:561
5605 #: ../src/guestfs-actions.pod:824 ../fish/guestfish-actions.pod:563
5607 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5612 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:566
5617 #: ../src/guestfs-actions.pod:829 ../fish/guestfish-actions.pod:568
5618 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5622 #: ../src/guestfs-actions.pod:831 ../fish/guestfish-actions.pod:570
5627 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:572
5628 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5632 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:574
5637 #: ../src/guestfs-actions.pod:837 ../fish/guestfish-actions.pod:576
5638 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5642 #: ../src/guestfs-actions.pod:839 ../fish/guestfish-actions.pod:578
5647 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:580
5648 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5652 #: ../src/guestfs-actions.pod:843 ../fish/guestfish-actions.pod:582
5657 #: ../src/guestfs-actions.pod:845 ../fish/guestfish-actions.pod:584
5658 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5662 #: ../src/guestfs-actions.pod:847 ../fish/guestfish-actions.pod:586
5667 #: ../src/guestfs-actions.pod:849 ../fish/guestfish-actions.pod:588
5668 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5672 #: ../src/guestfs-actions.pod:853 ../fish/guestfish-actions.pod:592
5673 msgid "The checksum is returned as a printable string."
5677 #: ../src/guestfs-actions.pod:855
5678 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
5682 #: ../src/guestfs-actions.pod:857
5683 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
5687 #: ../src/guestfs-actions.pod:862 ../src/guestfs-actions.pod:1209
5688 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:2788
5689 #: ../src/guestfs-actions.pod:2817 ../src/guestfs-actions.pod:2878
5690 #: ../src/guestfs-actions.pod:2905 ../src/guestfs-actions.pod:6147
5691 msgid "(Added in 1.0.2)"
5695 #: ../src/guestfs-actions.pod:864
5696 msgid "guestfs_checksum_device"
5700 #: ../src/guestfs-actions.pod:866
5704 " guestfs_checksum_device (guestfs_h *g,\n"
5705 " const char *csumtype,\n"
5706 " const char *device);\n"
5711 #: ../src/guestfs-actions.pod:871
5713 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5714 "device named C<device>. For the types of checksums supported see the "
5715 "C<guestfs_checksum> command."
5719 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:4257
5720 #: ../src/guestfs-actions.pod:4316 ../src/guestfs-actions.pod:4353
5721 #: ../src/guestfs-actions.pod:4371 ../src/guestfs-actions.pod:4548
5722 #: ../src/guestfs-actions.pod:6061 ../src/guestfs-actions.pod:6075
5723 #: ../src/guestfs-actions.pod:6472
5724 msgid "(Added in 1.3.2)"
5728 #: ../src/guestfs-actions.pod:880
5729 msgid "guestfs_checksums_out"
5733 #: ../src/guestfs-actions.pod:882
5737 " guestfs_checksums_out (guestfs_h *g,\n"
5738 " const char *csumtype,\n"
5739 " const char *directory,\n"
5740 " const char *sumsfile);\n"
5745 #: ../src/guestfs-actions.pod:888 ../fish/guestfish-actions.pod:610
5747 "This command computes the checksums of all regular files in C<directory> and "
5748 "then emits a list of those checksums to the local output file C<sumsfile>."
5752 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:614
5754 "This can be used for verifying the integrity of a virtual machine. However "
5755 "to be properly secure you should pay attention to the output of the checksum "
5756 "command (it uses the ones from GNU coreutils). In particular when the "
5757 "filename is not printable, coreutils uses a special backslash syntax. For "
5758 "more information, see the GNU coreutils info file."
5762 #: ../src/guestfs-actions.pod:902
5763 msgid "(Added in 1.3.7)"
5767 #: ../src/guestfs-actions.pod:904
5768 msgid "guestfs_chmod"
5772 #: ../src/guestfs-actions.pod:906
5776 " guestfs_chmod (guestfs_h *g,\n"
5778 " const char *path);\n"
5783 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:628
5785 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5790 #: ../src/guestfs-actions.pod:914 ../fish/guestfish-actions.pod:631
5792 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5793 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5798 #: ../src/guestfs-actions.pod:918 ../src/guestfs-actions.pod:3841
5799 #: ../src/guestfs-actions.pod:3956 ../src/guestfs-actions.pod:3975
5800 #: ../src/guestfs-actions.pod:3994 ../fish/guestfish-actions.pod:635
5801 #: ../fish/guestfish-actions.pod:2557 ../fish/guestfish-actions.pod:2642
5802 #: ../fish/guestfish-actions.pod:2652 ../fish/guestfish-actions.pod:2662
5803 msgid "The mode actually set is affected by the umask."
5807 #: ../src/guestfs-actions.pod:924
5808 msgid "guestfs_chown"
5812 #: ../src/guestfs-actions.pod:926
5816 " guestfs_chown (guestfs_h *g,\n"
5819 " const char *path);\n"
5824 #: ../src/guestfs-actions.pod:932 ../fish/guestfish-actions.pod:641
5825 msgid "Change the file owner to C<owner> and group to C<group>."
5829 #: ../src/guestfs-actions.pod:934 ../src/guestfs-actions.pod:2975
5830 #: ../fish/guestfish-actions.pod:643 ../fish/guestfish-actions.pod:2035
5832 "Only numeric uid and gid are supported. If you want to use names, you will "
5833 "need to locate and parse the password file yourself (Augeas support makes "
5834 "this relatively easy)."
5838 #: ../src/guestfs-actions.pod:942
5839 msgid "guestfs_command"
5843 #: ../src/guestfs-actions.pod:944
5847 " guestfs_command (guestfs_h *g,\n"
5848 " char *const *arguments);\n"
5853 #: ../src/guestfs-actions.pod:948 ../fish/guestfish-actions.pod:651
5855 "This call runs a command from the guest filesystem. The filesystem must be "
5856 "mounted, and must contain a compatible operating system (ie. something "
5857 "Linux, with the same or compatible processor architecture)."
5861 #: ../src/guestfs-actions.pod:953
5863 "The single parameter is an argv-style list of arguments. The first element "
5864 "is the name of the program to run. Subsequent elements are parameters. The "
5865 "list must be non-empty (ie. must contain a program name). Note that the "
5866 "command runs directly, and is I<not> invoked via the shell (see "
5871 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:663
5872 msgid "The return value is anything printed to I<stdout> by the command."
5876 #: ../src/guestfs-actions.pod:963 ../fish/guestfish-actions.pod:666
5878 "If the command returns a non-zero exit status, then this function returns an "
5879 "error message. The error message string is the content of I<stderr> from "
5884 #: ../src/guestfs-actions.pod:967 ../fish/guestfish-actions.pod:670
5886 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
5887 "bin>. If you require a program from another location, you should provide "
5888 "the full path in the first parameter."
5892 #: ../src/guestfs-actions.pod:972 ../fish/guestfish-actions.pod:675
5894 "Shared libraries and data files required by the program must be available on "
5895 "filesystems which are mounted in the correct places. It is the caller's "
5896 "responsibility to ensure all filesystems that are needed are mounted at the "
5901 #: ../src/guestfs-actions.pod:984 ../src/guestfs-actions.pod:1004
5902 #: ../src/guestfs-actions.pod:1506
5903 msgid "(Added in 0.9.1)"
5907 #: ../src/guestfs-actions.pod:986
5908 msgid "guestfs_command_lines"
5912 #: ../src/guestfs-actions.pod:988
5916 " guestfs_command_lines (guestfs_h *g,\n"
5917 " char *const *arguments);\n"
5922 #: ../src/guestfs-actions.pod:992
5924 "This is the same as C<guestfs_command>, but splits the result into a list of "
5929 #: ../src/guestfs-actions.pod:995
5930 msgid "See also: C<guestfs_sh_lines>"
5934 #: ../src/guestfs-actions.pod:1006
5935 msgid "guestfs_config"
5939 #: ../src/guestfs-actions.pod:1008
5943 " guestfs_config (guestfs_h *g,\n"
5944 " const char *qemuparam,\n"
5945 " const char *qemuvalue);\n"
5950 #: ../src/guestfs-actions.pod:1013 ../fish/guestfish-actions.pod:700
5952 "This can be used to add arbitrary qemu command line parameters of the form "
5953 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
5954 "setting some parameters which would interfere with parameters that we use."
5958 #: ../src/guestfs-actions.pod:1018 ../fish/guestfish-actions.pod:705
5959 msgid "The first character of C<param> string must be a C<-> (dash)."
5963 #: ../src/guestfs-actions.pod:1020 ../fish/guestfish-actions.pod:707
5964 msgid "C<value> can be NULL."
5968 #: ../src/guestfs-actions.pod:1026
5969 msgid "guestfs_copy_size"
5973 #: ../src/guestfs-actions.pod:1028
5977 " guestfs_copy_size (guestfs_h *g,\n"
5978 " const char *src,\n"
5979 " const char *dest,\n"
5985 #: ../src/guestfs-actions.pod:1034 ../fish/guestfish-actions.pod:713
5987 "This command copies exactly C<size> bytes from one source device or file "
5988 "C<src> to another destination device or file C<dest>."
5992 #: ../src/guestfs-actions.pod:1037 ../fish/guestfish-actions.pod:716
5994 "Note this will fail if the source is too short or if the destination is not "
5999 #: ../src/guestfs-actions.pod:1042 ../src/guestfs-actions.pod:1204
6000 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:1655
6001 #: ../src/guestfs-actions.pod:1677 ../src/guestfs-actions.pod:6651
6002 #: ../src/guestfs-actions.pod:6670
6004 "This long-running command can generate progress notification messages so "
6005 "that the caller can display a progress bar or indicator. To receive these "
6006 "messages, the caller must register a progress callback. See L<guestfs(3)/"
6007 "guestfs_set_progress_callback>."
6011 #: ../src/guestfs-actions.pod:1047 ../src/guestfs-actions.pod:3616
6012 #: ../src/guestfs-actions.pod:4755 ../src/guestfs-actions.pod:6378
6013 #: ../src/guestfs-actions.pod:6398 ../src/guestfs-actions.pod:6485
6014 msgid "(Added in 1.0.87)"
6018 #: ../src/guestfs-actions.pod:1049
6023 #: ../src/guestfs-actions.pod:1051
6027 " guestfs_cp (guestfs_h *g,\n"
6028 " const char *src,\n"
6029 " const char *dest);\n"
6034 #: ../src/guestfs-actions.pod:1056 ../fish/guestfish-actions.pod:723
6036 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6037 "destination filename or destination directory."
6041 #: ../src/guestfs-actions.pod:1061 ../src/guestfs-actions.pod:1075
6042 #: ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:1260
6043 #: ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:4220
6044 #: ../src/guestfs-actions.pod:4598
6045 msgid "(Added in 1.0.18)"
6049 #: ../src/guestfs-actions.pod:1063
6050 msgid "guestfs_cp_a"
6054 #: ../src/guestfs-actions.pod:1065
6058 " guestfs_cp_a (guestfs_h *g,\n"
6059 " const char *src,\n"
6060 " const char *dest);\n"
6065 #: ../src/guestfs-actions.pod:1070 ../fish/guestfish-actions.pod:730
6067 "This copies a file or directory from C<src> to C<dest> recursively using the "
6072 #: ../src/guestfs-actions.pod:1077
6077 #: ../src/guestfs-actions.pod:1079
6081 " guestfs_dd (guestfs_h *g,\n"
6082 " const char *src,\n"
6083 " const char *dest);\n"
6088 #: ../src/guestfs-actions.pod:1084 ../fish/guestfish-actions.pod:737
6090 "This command copies from one source device or file C<src> to another "
6091 "destination device or file C<dest>. Normally you would use this to copy to "
6092 "or from a device or partition, for example to duplicate a filesystem."
6096 #: ../src/guestfs-actions.pod:1089
6098 "If the destination is a device, it must be as large or larger than the "
6099 "source file or device, otherwise the copy will fail. This command cannot do "
6100 "partial copies (see C<guestfs_copy_size>)."
6104 #: ../src/guestfs-actions.pod:1097
6105 msgid "guestfs_debug"
6109 #: ../src/guestfs-actions.pod:1099
6113 " guestfs_debug (guestfs_h *g,\n"
6114 " const char *subcmd,\n"
6115 " char *const *extraargs);\n"
6120 #: ../src/guestfs-actions.pod:1104
6122 "The C<guestfs_debug> command exposes some internals of C<guestfsd> (the "
6123 "guestfs daemon) that runs inside the qemu subprocess."
6127 #: ../src/guestfs-actions.pod:1108 ../fish/guestfish-actions.pod:754
6129 "There is no comprehensive help for this command. You have to look at the "
6130 "file C<daemon/debug.c> in the libguestfs source to find out what you can do."
6134 #: ../src/guestfs-actions.pod:1115
6135 msgid "(Added in 1.0.11)"
6139 #: ../src/guestfs-actions.pod:1117
6140 msgid "guestfs_debug_upload"
6144 #: ../src/guestfs-actions.pod:1119
6148 " guestfs_debug_upload (guestfs_h *g,\n"
6149 " const char *filename,\n"
6150 " const char *tmpname,\n"
6156 #: ../src/guestfs-actions.pod:1125
6158 "The C<guestfs_debug_upload> command uploads a file to the libguestfs "
6163 #: ../src/guestfs-actions.pod:1128 ../fish/guestfish-actions.pod:765
6165 "There is no comprehensive help for this command. You have to look at the "
6166 "file C<daemon/debug.c> in the libguestfs source to find out what it is for."
6170 #: ../src/guestfs-actions.pod:1136
6175 #: ../src/guestfs-actions.pod:1138
6179 " guestfs_df (guestfs_h *g);\n"
6184 #: ../src/guestfs-actions.pod:1141 ../fish/guestfish-actions.pod:775
6185 msgid "This command runs the C<df> command to report disk space used."
6189 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1160
6190 #: ../fish/guestfish-actions.pod:777 ../fish/guestfish-actions.pod:788
6192 "This command is mostly useful for interactive sessions. It is I<not> "
6193 "intended that you try to parse the output string. Use C<statvfs> from "
6198 #: ../src/guestfs-actions.pod:1150 ../src/guestfs-actions.pod:1167
6199 #: ../src/guestfs-actions.pod:1280 ../src/guestfs-actions.pod:2205
6200 #: ../src/guestfs-actions.pod:2229 ../src/guestfs-actions.pod:2297
6201 #: ../src/guestfs-actions.pod:3727 ../src/guestfs-actions.pod:4120
6202 #: ../src/guestfs-actions.pod:5885 ../src/guestfs-actions.pod:5909
6203 #: ../src/guestfs-actions.pod:6518 ../src/guestfs-actions.pod:6531
6204 #: ../src/guestfs-actions.pod:6544
6205 msgid "(Added in 1.0.54)"
6209 #: ../src/guestfs-actions.pod:1152
6210 msgid "guestfs_df_h"
6214 #: ../src/guestfs-actions.pod:1154
6218 " guestfs_df_h (guestfs_h *g);\n"
6223 #: ../src/guestfs-actions.pod:1157 ../fish/guestfish-actions.pod:785
6225 "This command runs the C<df -h> command to report disk space used in human-"
6230 #: ../src/guestfs-actions.pod:1169
6231 msgid "guestfs_dmesg"
6235 #: ../src/guestfs-actions.pod:1171
6239 " guestfs_dmesg (guestfs_h *g);\n"
6244 #: ../src/guestfs-actions.pod:1174 ../fish/guestfish-actions.pod:796
6246 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
6247 "This is sometimes useful for extended debugging of problems."
6251 #: ../src/guestfs-actions.pod:1178
6253 "Another way to get the same information is to enable verbose messages with "
6254 "C<guestfs_set_verbose> or by setting the environment variable "
6255 "C<LIBGUESTFS_DEBUG=1> before running the program."
6259 #: ../src/guestfs-actions.pod:1188
6260 msgid "guestfs_download"
6264 #: ../src/guestfs-actions.pod:1190
6268 " guestfs_download (guestfs_h *g,\n"
6269 " const char *remotefilename,\n"
6270 " const char *filename);\n"
6275 #: ../src/guestfs-actions.pod:1195 ../src/guestfs-actions.pod:1220
6276 #: ../fish/guestfish-actions.pod:809 ../fish/guestfish-actions.pod:822
6278 "Download file C<remotefilename> and save it as C<filename> on the local "
6283 #: ../src/guestfs-actions.pod:1198 ../src/guestfs-actions.pod:6141
6284 #: ../fish/guestfish-actions.pod:812 ../fish/guestfish-actions.pod:4077
6285 msgid "C<filename> can also be a named pipe."
6289 #: ../src/guestfs-actions.pod:1200
6290 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
6294 #: ../src/guestfs-actions.pod:1211
6295 msgid "guestfs_download_offset"
6299 #: ../src/guestfs-actions.pod:1213
6303 " guestfs_download_offset (guestfs_h *g,\n"
6304 " const char *remotefilename,\n"
6305 " const char *filename,\n"
6306 " int64_t offset,\n"
6312 #: ../src/guestfs-actions.pod:1223 ../fish/guestfish-actions.pod:825
6314 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6315 "region must be within the file or device)."
6319 #: ../src/guestfs-actions.pod:1226
6321 "Note that there is no limit on the amount of data that can be downloaded "
6322 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
6323 "full amount unless an error occurs."
6327 #: ../src/guestfs-actions.pod:1231
6328 msgid "See also C<guestfs_download>, C<guestfs_pread>."
6332 #: ../src/guestfs-actions.pod:1240 ../src/guestfs-actions.pod:6176
6333 msgid "(Added in 1.5.17)"
6337 #: ../src/guestfs-actions.pod:1242
6338 msgid "guestfs_drop_caches"
6342 #: ../src/guestfs-actions.pod:1244
6346 " guestfs_drop_caches (guestfs_h *g,\n"
6347 " int whattodrop);\n"
6352 #: ../src/guestfs-actions.pod:1248 ../fish/guestfish-actions.pod:841
6354 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6355 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6356 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6360 #: ../src/guestfs-actions.pod:1253 ../fish/guestfish-actions.pod:846
6361 msgid "Setting C<whattodrop> to 3 should drop everything."
6365 #: ../src/guestfs-actions.pod:1255 ../fish/guestfish-actions.pod:848
6367 "This automatically calls L<sync(2)> before the operation, so that the "
6368 "maximum guest memory is freed."
6372 #: ../src/guestfs-actions.pod:1262
6377 #: ../src/guestfs-actions.pod:1264
6381 " guestfs_du (guestfs_h *g,\n"
6382 " const char *path);\n"
6387 #: ../src/guestfs-actions.pod:1268 ../fish/guestfish-actions.pod:855
6389 "This command runs the C<du -s> command to estimate file space usage for "
6394 #: ../src/guestfs-actions.pod:1271 ../fish/guestfish-actions.pod:858
6396 "C<path> can be a file or a directory. If C<path> is a directory then the "
6397 "estimate includes the contents of the directory and all subdirectories "
6402 #: ../src/guestfs-actions.pod:1275 ../fish/guestfish-actions.pod:862
6404 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6408 #: ../src/guestfs-actions.pod:1282
6409 msgid "guestfs_e2fsck_f"
6413 #: ../src/guestfs-actions.pod:1284
6417 " guestfs_e2fsck_f (guestfs_h *g,\n"
6418 " const char *device);\n"
6423 #: ../src/guestfs-actions.pod:1288 ../fish/guestfish-actions.pod:869
6425 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6426 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
6431 #: ../src/guestfs-actions.pod:1292
6433 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
6434 "Normally you should use C<guestfs_fsck>."
6438 #: ../src/guestfs-actions.pod:1297
6439 msgid "(Added in 1.0.29)"
6443 #: ../src/guestfs-actions.pod:1299
6444 msgid "guestfs_echo_daemon"
6448 #: ../src/guestfs-actions.pod:1301
6452 " guestfs_echo_daemon (guestfs_h *g,\n"
6453 " char *const *words);\n"
6458 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:880
6460 "This command concatenates the list of C<words> passed with single spaces "
6461 "between them and returns the resulting string."
6465 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:883
6466 msgid "You can use this command to test the connection through to the daemon."
6470 #: ../src/guestfs-actions.pod:1310
6471 msgid "See also C<guestfs_ping_daemon>."
6475 #: ../src/guestfs-actions.pod:1315 ../src/guestfs-actions.pod:2042
6476 #: ../src/guestfs-actions.pod:5389
6477 msgid "(Added in 1.0.69)"
6481 #: ../src/guestfs-actions.pod:1317
6482 msgid "guestfs_egrep"
6486 #: ../src/guestfs-actions.pod:1319
6490 " guestfs_egrep (guestfs_h *g,\n"
6491 " const char *regex,\n"
6492 " const char *path);\n"
6497 #: ../src/guestfs-actions.pod:1324 ../fish/guestfish-actions.pod:891
6499 "This calls the external C<egrep> program and returns the matching lines."
6503 #: ../src/guestfs-actions.pod:1334 ../src/guestfs-actions.pod:1353
6504 #: ../src/guestfs-actions.pod:1410 ../src/guestfs-actions.pod:1456
6505 #: ../src/guestfs-actions.pod:1475 ../src/guestfs-actions.pod:2143
6506 #: ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:2318
6507 #: ../src/guestfs-actions.pod:2331 ../src/guestfs-actions.pod:2346
6508 #: ../src/guestfs-actions.pod:2392 ../src/guestfs-actions.pod:2415
6509 #: ../src/guestfs-actions.pod:2428 ../src/guestfs-actions.pod:3107
6510 #: ../src/guestfs-actions.pod:3121 ../src/guestfs-actions.pod:3134
6511 #: ../src/guestfs-actions.pod:3148 ../src/guestfs-actions.pod:4055
6512 #: ../src/guestfs-actions.pod:4934 ../src/guestfs-actions.pod:4983
6513 #: ../src/guestfs-actions.pod:5753 ../src/guestfs-actions.pod:5765
6514 #: ../src/guestfs-actions.pod:5778 ../src/guestfs-actions.pod:5791
6515 #: ../src/guestfs-actions.pod:5813 ../src/guestfs-actions.pod:5826
6516 #: ../src/guestfs-actions.pod:5839 ../src/guestfs-actions.pod:5852
6517 #: ../src/guestfs-actions.pod:6614 ../src/guestfs-actions.pod:6633
6518 #: ../src/guestfs-actions.pod:6718 ../src/guestfs-actions.pod:6737
6519 #: ../src/guestfs-actions.pod:6783 ../src/guestfs-actions.pod:6802
6520 msgid "(Added in 1.0.66)"
6524 #: ../src/guestfs-actions.pod:1336
6525 msgid "guestfs_egrepi"
6529 #: ../src/guestfs-actions.pod:1338
6533 " guestfs_egrepi (guestfs_h *g,\n"
6534 " const char *regex,\n"
6535 " const char *path);\n"
6540 #: ../src/guestfs-actions.pod:1343 ../fish/guestfish-actions.pod:901
6542 "This calls the external C<egrep -i> program and returns the matching lines."
6546 #: ../src/guestfs-actions.pod:1355
6547 msgid "guestfs_equal"
6551 #: ../src/guestfs-actions.pod:1357
6555 " guestfs_equal (guestfs_h *g,\n"
6556 " const char *file1,\n"
6557 " const char *file2);\n"
6562 #: ../src/guestfs-actions.pod:1362 ../fish/guestfish-actions.pod:911
6564 "This compares the two files C<file1> and C<file2> and returns true if their "
6565 "content is exactly equal, or false otherwise."
6569 #: ../src/guestfs-actions.pod:1365 ../fish/guestfish-actions.pod:914
6570 msgid "The external L<cmp(1)> program is used for the comparison."
6574 #: ../src/guestfs-actions.pod:1371
6575 msgid "guestfs_exists"
6579 #: ../src/guestfs-actions.pod:1373
6583 " guestfs_exists (guestfs_h *g,\n"
6584 " const char *path);\n"
6589 #: ../src/guestfs-actions.pod:1377 ../fish/guestfish-actions.pod:920
6591 "This returns C<true> if and only if there is a file, directory (or anything) "
6592 "with the given C<path> name."
6596 #: ../src/guestfs-actions.pod:1380
6597 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6601 #: ../src/guestfs-actions.pod:1386
6602 msgid "guestfs_fallocate"
6606 #: ../src/guestfs-actions.pod:1388
6610 " guestfs_fallocate (guestfs_h *g,\n"
6611 " const char *path,\n"
6617 #: ../src/guestfs-actions.pod:1393 ../src/guestfs-actions.pod:1419
6618 #: ../fish/guestfish-actions.pod:929 ../fish/guestfish-actions.pod:948
6620 "This command preallocates a file (containing zero bytes) named C<path> of "
6621 "size C<len> bytes. If the file exists already, it is overwritten."
6625 #: ../src/guestfs-actions.pod:1397 ../fish/guestfish-actions.pod:933
6627 "Do not confuse this with the guestfish-specific C<alloc> command which "
6628 "allocates a file in the host and attaches it as a device."
6632 #: ../src/guestfs-actions.pod:1403 ../fish/guestfish-actions.pod:937
6634 "This function is deprecated. In new code, use the C<fallocate64> call "
6639 #: ../src/guestfs-actions.pod:1412
6640 msgid "guestfs_fallocate64"
6644 #: ../src/guestfs-actions.pod:1414
6648 " guestfs_fallocate64 (guestfs_h *g,\n"
6649 " const char *path,\n"
6655 #: ../src/guestfs-actions.pod:1423
6657 "Note that this call allocates disk blocks for the file. To create a sparse "
6658 "file use C<guestfs_truncate_size> instead."
6662 #: ../src/guestfs-actions.pod:1426
6664 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6665 "oversight it only allowed 30 bit lengths to be specified, effectively "
6666 "limiting the maximum size of files created through that call to 1GB."
6670 #: ../src/guestfs-actions.pod:1431 ../fish/guestfish-actions.pod:960
6672 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6673 "commands which create a file in the host and attach it as a device."
6677 #: ../src/guestfs-actions.pod:1437
6678 msgid "(Added in 1.3.17)"
6682 #: ../src/guestfs-actions.pod:1439
6683 msgid "guestfs_fgrep"
6687 #: ../src/guestfs-actions.pod:1441
6691 " guestfs_fgrep (guestfs_h *g,\n"
6692 " const char *pattern,\n"
6693 " const char *path);\n"
6698 #: ../src/guestfs-actions.pod:1446 ../fish/guestfish-actions.pod:968
6700 "This calls the external C<fgrep> program and returns the matching lines."
6704 #: ../src/guestfs-actions.pod:1458
6705 msgid "guestfs_fgrepi"
6709 #: ../src/guestfs-actions.pod:1460
6713 " guestfs_fgrepi (guestfs_h *g,\n"
6714 " const char *pattern,\n"
6715 " const char *path);\n"
6720 #: ../src/guestfs-actions.pod:1465 ../fish/guestfish-actions.pod:978
6722 "This calls the external C<fgrep -i> program and returns the matching lines."
6726 #: ../src/guestfs-actions.pod:1477
6727 msgid "guestfs_file"
6731 #: ../src/guestfs-actions.pod:1479
6735 " guestfs_file (guestfs_h *g,\n"
6736 " const char *path);\n"
6741 #: ../src/guestfs-actions.pod:1483 ../fish/guestfish-actions.pod:988
6743 "This call uses the standard L<file(1)> command to determine the type or "
6744 "contents of the file."
6748 #: ../src/guestfs-actions.pod:1486 ../fish/guestfish-actions.pod:991
6750 "This call will also transparently look inside various types of compressed "
6755 #: ../src/guestfs-actions.pod:1489 ../fish/guestfish-actions.pod:994
6757 "The exact command which runs is C<file -zb path>. Note in particular that "
6758 "the filename is not prepended to the output (the C<-b> option)."
6762 #: ../src/guestfs-actions.pod:1493
6764 "This command can also be used on C</dev/> devices (and partitions, LV "
6765 "names). You can for example use this to determine if a device contains a "
6766 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
6770 #: ../src/guestfs-actions.pod:1498 ../fish/guestfish-actions.pod:1003
6772 "If the C<path> does not begin with C</dev/> then this command only works for "
6773 "the content of regular files. For other file types (directory, symbolic "
6774 "link etc) it will just return the string C<directory> etc."
6778 #: ../src/guestfs-actions.pod:1508
6779 msgid "guestfs_file_architecture"
6783 #: ../src/guestfs-actions.pod:1510
6787 " guestfs_file_architecture (guestfs_h *g,\n"
6788 " const char *filename);\n"
6793 #: ../src/guestfs-actions.pod:1514 ../fish/guestfish-actions.pod:1012
6795 "This detects the architecture of the binary C<filename>, and returns it if "
6800 #: ../src/guestfs-actions.pod:1517 ../fish/guestfish-actions.pod:1015
6801 msgid "Currently defined architectures are:"
6805 #: ../src/guestfs-actions.pod:1521 ../fish/guestfish-actions.pod:1019
6810 #: ../src/guestfs-actions.pod:1523 ../fish/guestfish-actions.pod:1021
6812 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6813 "irrespective of the precise processor requirements of the binary."
6817 #: ../src/guestfs-actions.pod:1526 ../fish/guestfish-actions.pod:1024
6822 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1026
6823 msgid "64 bit x86-64."
6827 #: ../src/guestfs-actions.pod:1530 ../fish/guestfish-actions.pod:1028
6832 #: ../src/guestfs-actions.pod:1532 ../fish/guestfish-actions.pod:1030
6833 msgid "32 bit SPARC."
6837 #: ../src/guestfs-actions.pod:1534 ../fish/guestfish-actions.pod:1032
6842 #: ../src/guestfs-actions.pod:1536 ../fish/guestfish-actions.pod:1034
6843 msgid "64 bit SPARC V9 and above."
6847 #: ../src/guestfs-actions.pod:1538 ../fish/guestfish-actions.pod:1036
6852 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1038
6853 msgid "Intel Itanium."
6857 #: ../src/guestfs-actions.pod:1542 ../fish/guestfish-actions.pod:1040
6862 #: ../src/guestfs-actions.pod:1544 ../fish/guestfish-actions.pod:1042
6863 msgid "32 bit Power PC."
6867 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1044
6872 #: ../src/guestfs-actions.pod:1548 ../fish/guestfish-actions.pod:1046
6873 msgid "64 bit Power PC."
6877 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1050
6878 msgid "Libguestfs may return other architecture strings in future."
6882 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1052
6883 msgid "The function works on at least the following types of files:"
6887 #: ../src/guestfs-actions.pod:1560 ../fish/guestfish-actions.pod:1058
6888 msgid "many types of Un*x and Linux binary"
6892 #: ../src/guestfs-actions.pod:1564 ../fish/guestfish-actions.pod:1062
6893 msgid "many types of Un*x and Linux shared library"
6897 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1066
6898 msgid "Windows Win32 and Win64 binaries"
6902 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1070
6903 msgid "Windows Win32 and Win64 DLLs"
6907 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1072
6908 msgid "Win32 binaries and DLLs return C<i386>."
6912 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1074
6913 msgid "Win64 binaries and DLLs return C<x86_64>."
6917 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1078
6918 msgid "Linux kernel modules"
6922 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1082
6923 msgid "Linux new-style initrd images"
6927 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1086
6928 msgid "some non-x86 Linux vmlinuz kernels"
6932 #: ../src/guestfs-actions.pod:1592 ../fish/guestfish-actions.pod:1090
6933 msgid "What it can't do currently:"
6937 #: ../src/guestfs-actions.pod:1598 ../fish/guestfish-actions.pod:1096
6938 msgid "static libraries (libfoo.a)"
6942 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1100
6943 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6947 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1104
6948 msgid "x86 Linux vmlinuz kernels"
6952 #: ../src/guestfs-actions.pod:1608 ../fish/guestfish-actions.pod:1106
6954 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6955 "compressed code, and are horribly hard to unpack. If you want to find the "
6956 "architecture of a kernel, use the architecture of the associated initrd or "
6957 "kernel module(s) instead."
6961 #: ../src/guestfs-actions.pod:1618 ../src/guestfs-actions.pod:1781
6962 #: ../src/guestfs-actions.pod:1798 ../src/guestfs-actions.pod:2451
6963 #: ../src/guestfs-actions.pod:2524 ../src/guestfs-actions.pod:2550
6964 #: ../src/guestfs-actions.pod:2577 ../src/guestfs-actions.pod:2598
6965 #: ../src/guestfs-actions.pod:2631 ../src/guestfs-actions.pod:2655
6966 #: ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2759
6967 #: ../src/guestfs-actions.pod:2891
6968 msgid "(Added in 1.5.3)"
6972 #: ../src/guestfs-actions.pod:1620
6973 msgid "guestfs_filesize"
6977 #: ../src/guestfs-actions.pod:1622
6981 " guestfs_filesize (guestfs_h *g,\n"
6982 " const char *file);\n"
6987 #: ../src/guestfs-actions.pod:1626 ../fish/guestfish-actions.pod:1117
6988 msgid "This command returns the size of C<file> in bytes."
6992 #: ../src/guestfs-actions.pod:1628
6994 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
6995 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
6996 "devices, use C<guestfs_blockdev_getsize64>."
7000 #: ../src/guestfs-actions.pod:1634
7001 msgid "(Added in 1.0.82)"
7005 #: ../src/guestfs-actions.pod:1636
7006 msgid "guestfs_fill"
7010 #: ../src/guestfs-actions.pod:1638
7014 " guestfs_fill (guestfs_h *g,\n"
7017 " const char *path);\n"
7022 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1127
7024 "This command creates a new file called C<path>. The initial content of the "
7025 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
7030 #: ../src/guestfs-actions.pod:1648
7032 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7033 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7034 "bytes use C<guestfs_fill_pattern>."
7038 #: ../src/guestfs-actions.pod:1660
7039 msgid "(Added in 1.0.79)"
7043 #: ../src/guestfs-actions.pod:1662
7044 msgid "guestfs_fill_pattern"
7048 #: ../src/guestfs-actions.pod:1664
7052 " guestfs_fill_pattern (guestfs_h *g,\n"
7053 " const char *pattern,\n"
7055 " const char *path);\n"
7060 #: ../src/guestfs-actions.pod:1670
7062 "This function is like C<guestfs_fill> except that it creates a new file of "
7063 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7064 "pattern is truncated if necessary to ensure the length of the file is "
7065 "exactly C<len> bytes."
7069 #: ../src/guestfs-actions.pod:1682
7070 msgid "(Added in 1.3.12)"
7074 #: ../src/guestfs-actions.pod:1684
7075 msgid "guestfs_find"
7079 #: ../src/guestfs-actions.pod:1686
7083 " guestfs_find (guestfs_h *g,\n"
7084 " const char *directory);\n"
7089 #: ../src/guestfs-actions.pod:1690 ../fish/guestfish-actions.pod:1149
7091 "This command lists out all files and directories, recursively, starting at "
7092 "C<directory>. It is essentially equivalent to running the shell command "
7093 "C<find directory -print> but some post-processing happens on the output, "
7098 #: ../src/guestfs-actions.pod:1695 ../fish/guestfish-actions.pod:1154
7100 "This returns a list of strings I<without any prefix>. Thus if the directory "
7105 #: ../src/guestfs-actions.pod:1698 ../fish/guestfish-actions.pod:1157
7115 #: ../src/guestfs-actions.pod:1702
7117 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7121 #: ../src/guestfs-actions.pod:1705 ../fish/guestfish-actions.pod:1164
7132 #: ../src/guestfs-actions.pod:1710 ../fish/guestfish-actions.pod:1169
7133 msgid "If C<directory> is not a directory, then this command returns an error."
7137 #: ../src/guestfs-actions.pod:1713 ../fish/guestfish-actions.pod:1172
7138 msgid "The returned list is sorted."
7142 #: ../src/guestfs-actions.pod:1715
7143 msgid "See also C<guestfs_find0>."
7147 #: ../src/guestfs-actions.pod:1724 ../src/guestfs-actions.pod:3552
7148 #: ../src/guestfs-actions.pod:5018
7149 msgid "(Added in 1.0.27)"
7153 #: ../src/guestfs-actions.pod:1726
7154 msgid "guestfs_find0"
7158 #: ../src/guestfs-actions.pod:1728
7162 " guestfs_find0 (guestfs_h *g,\n"
7163 " const char *directory,\n"
7164 " const char *files);\n"
7169 #: ../src/guestfs-actions.pod:1733 ../fish/guestfish-actions.pod:1183
7171 "This command lists out all files and directories, recursively, starting at "
7172 "C<directory>, placing the resulting list in the external file called "
7177 #: ../src/guestfs-actions.pod:1737
7179 "This command works the same way as C<guestfs_find> with the following "
7184 #: ../src/guestfs-actions.pod:1744 ../fish/guestfish-actions.pod:1194
7185 msgid "The resulting list is written to an external file."
7189 #: ../src/guestfs-actions.pod:1748 ../fish/guestfish-actions.pod:1198
7191 "Items (filenames) in the result are separated by C<\\0> characters. See "
7192 "L<find(1)> option I<-print0>."
7196 #: ../src/guestfs-actions.pod:1753 ../fish/guestfish-actions.pod:1203
7197 msgid "This command is not limited in the number of names that it can return."
7201 #: ../src/guestfs-actions.pod:1758 ../fish/guestfish-actions.pod:1208
7202 msgid "The result list is not sorted."
7206 #: ../src/guestfs-actions.pod:1764
7207 msgid "(Added in 1.0.74)"
7211 #: ../src/guestfs-actions.pod:1766
7212 msgid "guestfs_findfs_label"
7216 #: ../src/guestfs-actions.pod:1768
7220 " guestfs_findfs_label (guestfs_h *g,\n"
7221 " const char *label);\n"
7226 #: ../src/guestfs-actions.pod:1772 ../fish/guestfish-actions.pod:1218
7228 "This command searches the filesystems and returns the one which has the "
7229 "given label. An error is returned if no such filesystem can be found."
7233 #: ../src/guestfs-actions.pod:1776
7234 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
7238 #: ../src/guestfs-actions.pod:1783
7239 msgid "guestfs_findfs_uuid"
7243 #: ../src/guestfs-actions.pod:1785
7247 " guestfs_findfs_uuid (guestfs_h *g,\n"
7248 " const char *uuid);\n"
7253 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1228
7255 "This command searches the filesystems and returns the one which has the "
7256 "given UUID. An error is returned if no such filesystem can be found."
7260 #: ../src/guestfs-actions.pod:1793
7261 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
7265 #: ../src/guestfs-actions.pod:1800
7266 msgid "guestfs_fsck"
7270 #: ../src/guestfs-actions.pod:1802
7274 " guestfs_fsck (guestfs_h *g,\n"
7275 " const char *fstype,\n"
7276 " const char *device);\n"
7281 #: ../src/guestfs-actions.pod:1807 ../fish/guestfish-actions.pod:1238
7283 "This runs the filesystem checker (fsck) on C<device> which should have "
7284 "filesystem type C<fstype>."
7288 #: ../src/guestfs-actions.pod:1810 ../fish/guestfish-actions.pod:1241
7290 "The returned integer is the status. See L<fsck(8)> for the list of status "
7291 "codes from C<fsck>."
7295 #: ../src/guestfs-actions.pod:1819 ../fish/guestfish-actions.pod:1250
7296 msgid "Multiple status codes can be summed together."
7300 #: ../src/guestfs-actions.pod:1823 ../fish/guestfish-actions.pod:1254
7302 "A non-zero return code can mean \"success\", for example if errors have been "
7303 "corrected on the filesystem."
7307 #: ../src/guestfs-actions.pod:1828 ../fish/guestfish-actions.pod:1259
7308 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
7312 #: ../src/guestfs-actions.pod:1833 ../fish/guestfish-actions.pod:1264
7314 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
7318 #: ../src/guestfs-actions.pod:1837 ../src/guestfs-actions.pod:6656
7319 msgid "(Added in 1.0.16)"
7323 #: ../src/guestfs-actions.pod:1839
7324 msgid "guestfs_get_append"
7328 #: ../src/guestfs-actions.pod:1841
7332 " guestfs_get_append (guestfs_h *g);\n"
7337 #: ../src/guestfs-actions.pod:1844 ../fish/guestfish-actions.pod:1270
7339 "Return the additional kernel options which are added to the guest kernel "
7344 #: ../src/guestfs-actions.pod:1847 ../fish/guestfish-actions.pod:1273
7345 msgid "If C<NULL> then no options are added."
7349 #: ../src/guestfs-actions.pod:1849
7351 "This function returns a string which may be NULL. There is no way to return "
7352 "an error from this function. The string is owned by the guest handle and "
7353 "must I<not> be freed."
7357 #: ../src/guestfs-actions.pod:1853 ../src/guestfs-actions.pod:4694
7358 #: ../src/guestfs-actions.pod:5159 ../src/guestfs-actions.pod:5527
7359 #: ../src/guestfs-actions.pod:5546 ../src/guestfs-actions.pod:5562
7360 #: ../src/guestfs-actions.pod:5579 ../src/guestfs-actions.pod:6326
7361 #: ../src/guestfs-actions.pod:6344 ../src/guestfs-actions.pod:6699
7362 msgid "(Added in 1.0.26)"
7366 #: ../src/guestfs-actions.pod:1855
7367 msgid "guestfs_get_autosync"
7371 #: ../src/guestfs-actions.pod:1857
7375 " guestfs_get_autosync (guestfs_h *g);\n"
7380 #: ../src/guestfs-actions.pod:1860 ../fish/guestfish-actions.pod:1279
7381 msgid "Get the autosync flag."
7385 #: ../src/guestfs-actions.pod:1866
7386 msgid "guestfs_get_direct"
7390 #: ../src/guestfs-actions.pod:1868
7394 " guestfs_get_direct (guestfs_h *g);\n"
7399 #: ../src/guestfs-actions.pod:1871 ../fish/guestfish-actions.pod:1285
7400 msgid "Return the direct appliance mode flag."
7404 #: ../src/guestfs-actions.pod:1875 ../src/guestfs-actions.pod:5200
7405 msgid "(Added in 1.0.72)"
7409 #: ../src/guestfs-actions.pod:1877
7410 msgid "guestfs_get_e2label"
7414 #: ../src/guestfs-actions.pod:1879
7418 " guestfs_get_e2label (guestfs_h *g,\n"
7419 " const char *device);\n"
7424 #: ../src/guestfs-actions.pod:1883 ../fish/guestfish-actions.pod:1291
7426 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7430 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1294
7432 "This function is deprecated. In new code, use the C<vfs_label> call instead."
7436 #: ../src/guestfs-actions.pod:1896 ../src/guestfs-actions.pod:1917
7437 #: ../src/guestfs-actions.pod:5218 ../src/guestfs-actions.pod:5237
7438 msgid "(Added in 1.0.15)"
7442 #: ../src/guestfs-actions.pod:1898
7443 msgid "guestfs_get_e2uuid"
7447 #: ../src/guestfs-actions.pod:1900
7451 " guestfs_get_e2uuid (guestfs_h *g,\n"
7452 " const char *device);\n"
7457 #: ../src/guestfs-actions.pod:1904 ../fish/guestfish-actions.pod:1305
7459 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7463 #: ../src/guestfs-actions.pod:1910 ../fish/guestfish-actions.pod:1308
7465 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
7469 #: ../src/guestfs-actions.pod:1919
7470 msgid "guestfs_get_memsize"
7474 #: ../src/guestfs-actions.pod:1921
7478 " guestfs_get_memsize (guestfs_h *g);\n"
7483 #: ../src/guestfs-actions.pod:1924 ../fish/guestfish-actions.pod:1319
7485 "This gets the memory size in megabytes allocated to the qemu subprocess."
7489 #: ../src/guestfs-actions.pod:1927
7491 "If C<guestfs_set_memsize> was not called on this handle, and if "
7492 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7493 "value for memsize."
7497 #: ../src/guestfs-actions.pod:1931 ../src/guestfs-actions.pod:2012
7498 #: ../src/guestfs-actions.pod:5253 ../src/guestfs-actions.pod:5360
7499 #: ../fish/guestfish-actions.pod:1326 ../fish/guestfish-actions.pod:1377
7500 #: ../fish/guestfish-actions.pod:3484 ../fish/guestfish-actions.pod:3571
7502 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7506 #: ../src/guestfs-actions.pod:1936 ../src/guestfs-actions.pod:3845
7507 #: ../src/guestfs-actions.pod:3960 ../src/guestfs-actions.pod:3979
7508 #: ../src/guestfs-actions.pod:3998 ../src/guestfs-actions.pod:4010
7509 #: ../src/guestfs-actions.pod:4027 ../src/guestfs-actions.pod:4040
7510 #: ../src/guestfs-actions.pod:4921 ../src/guestfs-actions.pod:5258
7511 #: ../src/guestfs-actions.pod:5501 ../src/guestfs-actions.pod:6102
7512 msgid "(Added in 1.0.55)"
7516 #: ../src/guestfs-actions.pod:1938
7517 msgid "guestfs_get_network"
7521 #: ../src/guestfs-actions.pod:1940
7525 " guestfs_get_network (guestfs_h *g);\n"
7530 #: ../src/guestfs-actions.pod:1943 ../fish/guestfish-actions.pod:1333
7531 msgid "This returns the enable network flag."
7535 #: ../src/guestfs-actions.pod:1947 ../src/guestfs-actions.pod:5277
7536 msgid "(Added in 1.5.4)"
7540 #: ../src/guestfs-actions.pod:1949
7541 msgid "guestfs_get_path"
7545 #: ../src/guestfs-actions.pod:1951
7549 " guestfs_get_path (guestfs_h *g);\n"
7554 #: ../src/guestfs-actions.pod:1954 ../fish/guestfish-actions.pod:1339
7555 msgid "Return the current search path."
7559 #: ../src/guestfs-actions.pod:1956 ../fish/guestfish-actions.pod:1341
7561 "This is always non-NULL. If it wasn't set already, then this will return "
7566 #: ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:1988
7568 "This function returns a string, or NULL on error. The string is owned by "
7569 "the guest handle and must I<not> be freed."
7573 #: ../src/guestfs-actions.pod:1964
7574 msgid "guestfs_get_pid"
7578 #: ../src/guestfs-actions.pod:1966
7582 " guestfs_get_pid (guestfs_h *g);\n"
7587 #: ../src/guestfs-actions.pod:1969 ../fish/guestfish-actions.pod:1350
7589 "Return the process ID of the qemu subprocess. If there is no qemu "
7590 "subprocess, then this will return an error."
7594 #: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1353
7595 msgid "This is an internal call used for debugging and testing."
7599 #: ../src/guestfs-actions.pod:1976
7600 msgid "(Added in 1.0.56)"
7604 #: ../src/guestfs-actions.pod:1978
7605 msgid "guestfs_get_qemu"
7609 #: ../src/guestfs-actions.pod:1980
7613 " guestfs_get_qemu (guestfs_h *g);\n"
7618 #: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1359
7619 msgid "Return the current qemu binary."
7623 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1361
7625 "This is always non-NULL. If it wasn't set already, then this will return "
7626 "the default qemu binary name."
7630 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:5322
7631 msgid "(Added in 1.0.6)"
7635 #: ../src/guestfs-actions.pod:1993
7636 msgid "guestfs_get_recovery_proc"
7640 #: ../src/guestfs-actions.pod:1995
7644 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7649 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1368
7650 msgid "Return the recovery process enabled flag."
7654 #: ../src/guestfs-actions.pod:2002 ../src/guestfs-actions.pod:2981
7655 #: ../src/guestfs-actions.pod:3250 ../src/guestfs-actions.pod:3652
7656 #: ../src/guestfs-actions.pod:3684 ../src/guestfs-actions.pod:4624
7657 #: ../src/guestfs-actions.pod:4969 ../src/guestfs-actions.pod:5346
7658 #: ../src/guestfs-actions.pod:6005 ../src/guestfs-actions.pod:6025
7659 #: ../src/guestfs-actions.pod:6207
7660 msgid "(Added in 1.0.77)"
7664 #: ../src/guestfs-actions.pod:2004
7665 msgid "guestfs_get_selinux"
7669 #: ../src/guestfs-actions.pod:2006
7673 " guestfs_get_selinux (guestfs_h *g);\n"
7678 #: ../src/guestfs-actions.pod:2009
7680 "This returns the current setting of the selinux flag which is passed to the "
7681 "appliance at boot time. See C<guestfs_set_selinux>."
7685 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2080
7686 #: ../src/guestfs-actions.pod:5365 ../src/guestfs-actions.pod:5419
7687 msgid "(Added in 1.0.67)"
7691 #: ../src/guestfs-actions.pod:2019
7692 msgid "guestfs_get_state"
7696 #: ../src/guestfs-actions.pod:2021
7700 " guestfs_get_state (guestfs_h *g);\n"
7705 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1384
7707 "This returns the current state as an opaque integer. This is only useful "
7708 "for printing debug and internal error messages."
7712 #: ../src/guestfs-actions.pod:2027 ../src/guestfs-actions.pod:2784
7713 #: ../src/guestfs-actions.pod:2813 ../src/guestfs-actions.pod:2874
7714 #: ../src/guestfs-actions.pod:2901 ../fish/guestfish-actions.pod:1387
7715 #: ../fish/guestfish-actions.pod:1917 ../fish/guestfish-actions.pod:1935
7716 #: ../fish/guestfish-actions.pod:1973 ../fish/guestfish-actions.pod:1989
7717 msgid "For more information on states, see L<guestfs(3)>."
7721 #: ../src/guestfs-actions.pod:2033
7722 msgid "guestfs_get_trace"
7726 #: ../src/guestfs-actions.pod:2035
7730 " guestfs_get_trace (guestfs_h *g);\n"
7735 #: ../src/guestfs-actions.pod:2038 ../fish/guestfish-actions.pod:1393
7736 msgid "Return the command trace flag."
7740 #: ../src/guestfs-actions.pod:2044
7741 msgid "guestfs_get_umask"
7745 #: ../src/guestfs-actions.pod:2046
7749 " guestfs_get_umask (guestfs_h *g);\n"
7754 #: ../src/guestfs-actions.pod:2049
7756 "Return the current umask. By default the umask is C<022> unless it has been "
7757 "set by calling C<guestfs_umask>."
7761 #: ../src/guestfs-actions.pod:2056
7762 msgid "guestfs_get_verbose"
7766 #: ../src/guestfs-actions.pod:2058
7770 " guestfs_get_verbose (guestfs_h *g);\n"
7775 #: ../src/guestfs-actions.pod:2061 ../fish/guestfish-actions.pod:1406
7776 msgid "This returns the verbose messages flag."
7780 #: ../src/guestfs-actions.pod:2067
7781 msgid "guestfs_getcon"
7785 #: ../src/guestfs-actions.pod:2069
7789 " guestfs_getcon (guestfs_h *g);\n"
7794 #: ../src/guestfs-actions.pod:2072 ../fish/guestfish-actions.pod:1412
7795 msgid "This gets the SELinux security context of the daemon."
7799 #: ../src/guestfs-actions.pod:2074
7801 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
7805 #: ../src/guestfs-actions.pod:2082
7806 msgid "guestfs_getxattrs"
7810 #: ../src/guestfs-actions.pod:2084
7813 " struct guestfs_xattr_list *\n"
7814 " guestfs_getxattrs (guestfs_h *g,\n"
7815 " const char *path);\n"
7820 #: ../src/guestfs-actions.pod:2088 ../fish/guestfish-actions.pod:1421
7822 "This call lists the extended attributes of the file or directory C<path>."
7826 #: ../src/guestfs-actions.pod:2091 ../fish/guestfish-actions.pod:1424
7828 "At the system call level, this is a combination of the L<listxattr(2)> and "
7829 "L<getxattr(2)> calls."
7833 #: ../src/guestfs-actions.pod:2094
7834 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
7838 #: ../src/guestfs-actions.pod:2096 ../src/guestfs-actions.pod:2993
7839 #: ../src/guestfs-actions.pod:3647
7841 "This function returns a C<struct guestfs_xattr_list *> (see E<lt>guestfs-"
7842 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
7843 "C<guestfs_free_xattr_list> after use>."
7847 #: ../src/guestfs-actions.pod:2101 ../src/guestfs-actions.pod:2998
7848 #: ../src/guestfs-actions.pod:3163 ../src/guestfs-actions.pod:3199
7849 #: ../src/guestfs-actions.pod:4999 ../src/guestfs-actions.pod:5438
7850 #: ../src/guestfs-actions.pod:6764
7851 msgid "(Added in 1.0.59)"
7855 #: ../src/guestfs-actions.pod:2103
7856 msgid "guestfs_glob_expand"
7860 #: ../src/guestfs-actions.pod:2105
7864 " guestfs_glob_expand (guestfs_h *g,\n"
7865 " const char *pattern);\n"
7870 #: ../src/guestfs-actions.pod:2109 ../fish/guestfish-actions.pod:1433
7872 "This command searches for all the pathnames matching C<pattern> according to "
7873 "the wildcard expansion rules used by the shell."
7877 #: ../src/guestfs-actions.pod:2113 ../fish/guestfish-actions.pod:1437
7879 "If no paths match, then this returns an empty list (note: not an error)."
7883 #: ../src/guestfs-actions.pod:2116 ../fish/guestfish-actions.pod:1440
7885 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
7886 "GLOB_BRACE>. See that manual page for more details."
7890 #: ../src/guestfs-actions.pod:2124 ../src/guestfs-actions.pod:5603
7891 #: ../src/guestfs-actions.pod:5620
7892 msgid "(Added in 1.0.50)"
7896 #: ../src/guestfs-actions.pod:2126
7897 msgid "guestfs_grep"
7901 #: ../src/guestfs-actions.pod:2128
7905 " guestfs_grep (guestfs_h *g,\n"
7906 " const char *regex,\n"
7907 " const char *path);\n"
7912 #: ../src/guestfs-actions.pod:2133 ../fish/guestfish-actions.pod:1448
7913 msgid "This calls the external C<grep> program and returns the matching lines."
7917 #: ../src/guestfs-actions.pod:2145
7918 msgid "guestfs_grepi"
7922 #: ../src/guestfs-actions.pod:2147
7926 " guestfs_grepi (guestfs_h *g,\n"
7927 " const char *regex,\n"
7928 " const char *path);\n"
7933 #: ../src/guestfs-actions.pod:2152 ../fish/guestfish-actions.pod:1458
7935 "This calls the external C<grep -i> program and returns the matching lines."
7939 #: ../src/guestfs-actions.pod:2164
7940 msgid "guestfs_grub_install"
7944 #: ../src/guestfs-actions.pod:2166
7948 " guestfs_grub_install (guestfs_h *g,\n"
7949 " const char *root,\n"
7950 " const char *device);\n"
7955 #: ../src/guestfs-actions.pod:2171 ../fish/guestfish-actions.pod:1468
7957 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
7958 "the root directory being C<root>."
7962 #: ../src/guestfs-actions.pod:2174 ../fish/guestfish-actions.pod:1471
7964 "Note: If grub-install reports the error \"No suitable drive was found in the "
7965 "generated device map.\" it may be that you need to create a C</boot/grub/"
7966 "device.map> file first that contains the mapping between grub device names "
7967 "and Linux device names. It is usually sufficient to create a file "
7972 #: ../src/guestfs-actions.pod:2181 ../fish/guestfish-actions.pod:1478
7980 #: ../src/guestfs-actions.pod:2183 ../fish/guestfish-actions.pod:1480
7981 msgid "replacing C</dev/vda> with the name of the installation device."
7985 #: ../src/guestfs-actions.pod:2187
7986 msgid "(Added in 1.0.17)"
7990 #: ../src/guestfs-actions.pod:2189
7991 msgid "guestfs_head"
7995 #: ../src/guestfs-actions.pod:2191
7999 " guestfs_head (guestfs_h *g,\n"
8000 " const char *path);\n"
8005 #: ../src/guestfs-actions.pod:2195 ../fish/guestfish-actions.pod:1486
8007 "This command returns up to the first 10 lines of a file as a list of strings."
8011 #: ../src/guestfs-actions.pod:2207
8012 msgid "guestfs_head_n"
8016 #: ../src/guestfs-actions.pod:2209
8020 " guestfs_head_n (guestfs_h *g,\n"
8022 " const char *path);\n"
8027 #: ../src/guestfs-actions.pod:2214 ../fish/guestfish-actions.pod:1496
8029 "If the parameter C<nrlines> is a positive number, this returns the first "
8030 "C<nrlines> lines of the file C<path>."
8034 #: ../src/guestfs-actions.pod:2217 ../fish/guestfish-actions.pod:1499
8036 "If the parameter C<nrlines> is a negative number, this returns lines from "
8037 "the file C<path>, excluding the last C<nrlines> lines."
8041 #: ../src/guestfs-actions.pod:2220 ../src/guestfs-actions.pod:5900
8042 #: ../fish/guestfish-actions.pod:1502 ../fish/guestfish-actions.pod:3917
8043 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8047 #: ../src/guestfs-actions.pod:2231
8048 msgid "guestfs_hexdump"
8052 #: ../src/guestfs-actions.pod:2233
8056 " guestfs_hexdump (guestfs_h *g,\n"
8057 " const char *path);\n"
8062 #: ../src/guestfs-actions.pod:2237 ../fish/guestfish-actions.pod:1511
8064 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
8065 "readable, canonical hex dump of the file."
8069 #: ../src/guestfs-actions.pod:2246 ../src/guestfs-actions.pod:5684
8070 #: ../src/guestfs-actions.pod:5739
8071 msgid "(Added in 1.0.22)"
8075 #: ../src/guestfs-actions.pod:2248
8076 msgid "guestfs_initrd_cat"
8080 #: ../src/guestfs-actions.pod:2250
8084 " guestfs_initrd_cat (guestfs_h *g,\n"
8085 " const char *initrdpath,\n"
8086 " const char *filename,\n"
8087 " size_t *size_r);\n"
8092 #: ../src/guestfs-actions.pod:2256 ../fish/guestfish-actions.pod:1521
8094 "This command unpacks the file C<filename> from the initrd file called "
8095 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8100 #: ../src/guestfs-actions.pod:2260 ../fish/guestfish-actions.pod:1525
8102 "For example, in guestfish you could use the following command to examine the "
8103 "boot script (usually called C</init>) contained in a Linux initrd or "
8108 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1529
8111 " initrd-cat /boot/initrd-<version>.img init\n"
8116 #: ../src/guestfs-actions.pod:2266
8117 msgid "See also C<guestfs_initrd_list>."
8121 #: ../src/guestfs-actions.pod:2268 ../src/guestfs-actions.pod:4617
8122 #: ../src/guestfs-actions.pod:4643 ../src/guestfs-actions.pod:4825
8124 "This function returns a buffer, or NULL on error. The size of the returned "
8125 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8130 #: ../src/guestfs-actions.pod:2277
8131 msgid "guestfs_initrd_list"
8135 #: ../src/guestfs-actions.pod:2279
8139 " guestfs_initrd_list (guestfs_h *g,\n"
8140 " const char *path);\n"
8145 #: ../src/guestfs-actions.pod:2283 ../fish/guestfish-actions.pod:1540
8146 msgid "This command lists out files contained in an initrd."
8150 #: ../src/guestfs-actions.pod:2285 ../fish/guestfish-actions.pod:1542
8152 "The files are listed without any initial C</> character. The files are "
8153 "listed in the order they appear (not necessarily alphabetical). Directory "
8154 "names are listed as separate items."
8158 #: ../src/guestfs-actions.pod:2289 ../fish/guestfish-actions.pod:1546
8160 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8161 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8166 #: ../src/guestfs-actions.pod:2299
8167 msgid "guestfs_inotify_add_watch"
8171 #: ../src/guestfs-actions.pod:2301
8175 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8176 " const char *path,\n"
8182 #: ../src/guestfs-actions.pod:2306 ../fish/guestfish-actions.pod:1554
8183 msgid "Watch C<path> for the events listed in C<mask>."
8187 #: ../src/guestfs-actions.pod:2308 ../fish/guestfish-actions.pod:1556
8189 "Note that if C<path> is a directory then events within that directory are "
8190 "watched, but this does I<not> happen recursively (in subdirectories)."
8194 #: ../src/guestfs-actions.pod:2312 ../fish/guestfish-actions.pod:1560
8196 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8197 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
8201 #: ../src/guestfs-actions.pod:2320
8202 msgid "guestfs_inotify_close"
8206 #: ../src/guestfs-actions.pod:2322
8210 " guestfs_inotify_close (guestfs_h *g);\n"
8215 #: ../src/guestfs-actions.pod:2325 ../fish/guestfish-actions.pod:1568
8217 "This closes the inotify handle which was previously opened by inotify_init. "
8218 "It removes all watches, throws away any pending events, and deallocates all "
8223 #: ../src/guestfs-actions.pod:2333
8224 msgid "guestfs_inotify_files"
8228 #: ../src/guestfs-actions.pod:2335
8232 " guestfs_inotify_files (guestfs_h *g);\n"
8237 #: ../src/guestfs-actions.pod:2338
8239 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
8240 "returns a list of pathnames of objects that were touched. The returned "
8241 "pathnames are sorted and deduplicated."
8245 #: ../src/guestfs-actions.pod:2348
8246 msgid "guestfs_inotify_init"
8250 #: ../src/guestfs-actions.pod:2350
8254 " guestfs_inotify_init (guestfs_h *g,\n"
8255 " int maxevents);\n"
8260 #: ../src/guestfs-actions.pod:2354 ../fish/guestfish-actions.pod:1584
8262 "This command creates a new inotify handle. The inotify subsystem can be "
8263 "used to notify events which happen to objects in the guest filesystem."
8267 #: ../src/guestfs-actions.pod:2358
8269 "C<maxevents> is the maximum number of events which will be queued up between "
8270 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
8271 "passed as C<0>, then the kernel (or previously set) default is used. For "
8272 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
8273 "throws away events, but records the fact that it threw them away by setting "
8274 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
8275 "C<guestfs_inotify_read>)."
8279 #: ../src/guestfs-actions.pod:2368
8281 "Before any events are generated, you have to add some watches to the "
8282 "internal watch list. See: C<guestfs_inotify_add_watch>, "
8283 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
8287 #: ../src/guestfs-actions.pod:2374
8289 "Queued up events should be read periodically by calling "
8290 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
8291 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
8292 "often enough then you risk the internal queue overflowing."
8296 #: ../src/guestfs-actions.pod:2381
8298 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
8299 "This also removes any watches automatically."
8303 #: ../src/guestfs-actions.pod:2385 ../fish/guestfish-actions.pod:1615
8305 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
8306 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
8307 "that there is one global inotify handle per libguestfs instance."
8311 #: ../src/guestfs-actions.pod:2394
8312 msgid "guestfs_inotify_read"
8316 #: ../src/guestfs-actions.pod:2396
8319 " struct guestfs_inotify_event_list *\n"
8320 " guestfs_inotify_read (guestfs_h *g);\n"
8325 #: ../src/guestfs-actions.pod:2399 ../fish/guestfish-actions.pod:1624
8327 "Return the complete queue of events that have happened since the previous "
8332 #: ../src/guestfs-actions.pod:2402 ../fish/guestfish-actions.pod:1627
8333 msgid "If no events have happened, this returns an empty list."
8337 #: ../src/guestfs-actions.pod:2404 ../fish/guestfish-actions.pod:1629
8339 "I<Note>: In order to make sure that all events have been read, you must call "
8340 "this function repeatedly until it returns an empty list. The reason is that "
8341 "the call will read events up to the maximum appliance-to-host message size "
8342 "and leave remaining events in the queue."
8346 #: ../src/guestfs-actions.pod:2410
8348 "This function returns a C<struct guestfs_inotify_event_list *> (see "
8349 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
8350 "must call C<guestfs_free_inotify_event_list> after use>."
8354 #: ../src/guestfs-actions.pod:2417
8355 msgid "guestfs_inotify_rm_watch"
8359 #: ../src/guestfs-actions.pod:2419
8363 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
8369 #: ../src/guestfs-actions.pod:2423
8371 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
8375 #: ../src/guestfs-actions.pod:2430
8376 msgid "guestfs_inspect_get_arch"
8380 #: ../src/guestfs-actions.pod:2432
8384 " guestfs_inspect_get_arch (guestfs_h *g,\n"
8385 " const char *root);\n"
8390 #: ../src/guestfs-actions.pod:2436 ../src/guestfs-actions.pod:2459
8391 #: ../src/guestfs-actions.pod:2532 ../src/guestfs-actions.pod:2558
8392 #: ../src/guestfs-actions.pod:2585 ../src/guestfs-actions.pod:2606
8393 #: ../src/guestfs-actions.pod:2639 ../src/guestfs-actions.pod:2663
8394 #: ../src/guestfs-actions.pod:2701
8396 "This function should only be called with a root device string as returned by "
8397 "C<guestfs_inspect_os>."
8401 #: ../src/guestfs-actions.pod:2439
8403 "This returns the architecture of the inspected operating system. The "
8404 "possible return values are listed under C<guestfs_file_architecture>."
8408 #: ../src/guestfs-actions.pod:2443 ../fish/guestfish-actions.pod:1653
8410 "If the architecture could not be determined, then the string C<unknown> is "
8415 #: ../src/guestfs-actions.pod:2446 ../src/guestfs-actions.pod:2519
8416 #: ../src/guestfs-actions.pod:2573 ../src/guestfs-actions.pod:2650
8417 #: ../src/guestfs-actions.pod:2688 ../src/guestfs-actions.pod:2711
8418 #: ../src/guestfs-actions.pod:2751 ../fish/guestfish-actions.pod:1656
8419 #: ../fish/guestfish-actions.pod:1722 ../fish/guestfish-actions.pod:1761
8420 #: ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1847
8421 #: ../fish/guestfish-actions.pod:1863 ../fish/guestfish-actions.pod:1897
8422 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
8426 #: ../src/guestfs-actions.pod:2453
8427 msgid "guestfs_inspect_get_distro"
8431 #: ../src/guestfs-actions.pod:2455
8435 " guestfs_inspect_get_distro (guestfs_h *g,\n"
8436 " const char *root);\n"
8441 #: ../src/guestfs-actions.pod:2462 ../fish/guestfish-actions.pod:1665
8443 "This returns the distro (distribution) of the inspected operating system."
8447 #: ../src/guestfs-actions.pod:2465 ../fish/guestfish-actions.pod:1668
8448 msgid "Currently defined distros are:"
8452 #: ../src/guestfs-actions.pod:2469 ../fish/guestfish-actions.pod:1672
8453 msgid "\"archlinux\""
8457 #: ../src/guestfs-actions.pod:2471 ../fish/guestfish-actions.pod:1674
8462 #: ../src/guestfs-actions.pod:2473 ../fish/guestfish-actions.pod:1676
8467 #: ../src/guestfs-actions.pod:2475 ../fish/guestfish-actions.pod:1678
8468 msgid "Debian or a Debian-derived distro such as Ubuntu."
8472 #: ../src/guestfs-actions.pod:2477 ../fish/guestfish-actions.pod:1680
8477 #: ../src/guestfs-actions.pod:2479 ../fish/guestfish-actions.pod:1682
8482 #: ../src/guestfs-actions.pod:2481 ../fish/guestfish-actions.pod:1684
8487 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1686
8492 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1688
8497 #: ../src/guestfs-actions.pod:2487 ../fish/guestfish-actions.pod:1690
8502 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1692
8507 #: ../src/guestfs-actions.pod:2491 ../fish/guestfish-actions.pod:1694
8512 #: ../src/guestfs-actions.pod:2493 ../fish/guestfish-actions.pod:1696
8513 msgid "\"redhat-based\""
8517 #: ../src/guestfs-actions.pod:2495 ../fish/guestfish-actions.pod:1698
8518 msgid "Some Red Hat-derived distro."
8522 #: ../src/guestfs-actions.pod:2497 ../fish/guestfish-actions.pod:1700
8527 #: ../src/guestfs-actions.pod:2499 ../fish/guestfish-actions.pod:1702
8528 msgid "Red Hat Enterprise Linux and some derivatives."
8532 #: ../src/guestfs-actions.pod:2501 ../src/guestfs-actions.pod:2675
8533 #: ../fish/guestfish-actions.pod:1704 ../fish/guestfish-actions.pod:1834
8538 #: ../src/guestfs-actions.pod:2503 ../fish/guestfish-actions.pod:1706
8540 "Windows does not have distributions. This string is returned if the OS type "
8545 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1709
8550 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1711
8555 #: ../src/guestfs-actions.pod:2510 ../src/guestfs-actions.pod:2679
8556 #: ../fish/guestfish-actions.pod:1713 ../fish/guestfish-actions.pod:1838
8561 #: ../src/guestfs-actions.pod:2512 ../fish/guestfish-actions.pod:1715
8562 msgid "The distro could not be determined."
8566 #: ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2685
8567 #: ../fish/guestfish-actions.pod:1719 ../fish/guestfish-actions.pod:1844
8569 "Future versions of libguestfs may return other strings here. The caller "
8570 "should be prepared to handle any string."
8574 #: ../src/guestfs-actions.pod:2526
8575 msgid "guestfs_inspect_get_filesystems"
8579 #: ../src/guestfs-actions.pod:2528
8583 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
8584 " const char *root);\n"
8589 #: ../src/guestfs-actions.pod:2535 ../fish/guestfish-actions.pod:1731
8591 "This returns a list of all the filesystems that we think are associated with "
8592 "this operating system. This includes the root filesystem, other ordinary "
8593 "filesystems, and non-mounted devices like swap partitions."
8597 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1736
8599 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8600 "to be shared between operating systems."
8604 #: ../src/guestfs-actions.pod:2543
8606 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8607 "C<guestfs_inspect_get_mountpoints>."
8611 #: ../src/guestfs-actions.pod:2552
8612 msgid "guestfs_inspect_get_major_version"
8616 #: ../src/guestfs-actions.pod:2554
8620 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
8621 " const char *root);\n"
8626 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1749
8628 "This returns the major version number of the inspected operating system."
8632 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1752
8634 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8635 "popular public names used by the operating system. Notably the operating "
8636 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8637 "1). You can find out the real versions corresponding to releases of Windows "
8638 "by consulting Wikipedia or MSDN."
8642 #: ../src/guestfs-actions.pod:2571 ../src/guestfs-actions.pod:2591
8643 #: ../fish/guestfish-actions.pod:1759 ../fish/guestfish-actions.pod:1773
8644 msgid "If the version could not be determined, then C<0> is returned."
8648 #: ../src/guestfs-actions.pod:2579
8649 msgid "guestfs_inspect_get_minor_version"
8653 #: ../src/guestfs-actions.pod:2581
8657 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
8658 " const char *root);\n"
8663 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1770
8665 "This returns the minor version number of the inspected operating system."
8669 #: ../src/guestfs-actions.pod:2593
8671 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8672 "C<guestfs_inspect_get_major_version>."
8676 #: ../src/guestfs-actions.pod:2600
8677 msgid "guestfs_inspect_get_mountpoints"
8681 #: ../src/guestfs-actions.pod:2602
8685 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
8686 " const char *root);\n"
8691 #: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:1785
8693 "This returns a hash of where we think the filesystems associated with this "
8694 "operating system should be mounted. Callers should note that this is at "
8695 "best an educated guess made by reading configuration files such as C</etc/"
8700 #: ../src/guestfs-actions.pod:2614 ../fish/guestfish-actions.pod:1790
8702 "Each element in the returned hashtable has a key which is the path of the "
8703 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8704 "mounted there (eg. C</dev/sda1>)."
8708 #: ../src/guestfs-actions.pod:2619 ../fish/guestfish-actions.pod:1795
8710 "Non-mounted devices such as swap devices are I<not> returned in this list."
8714 #: ../src/guestfs-actions.pod:2622
8716 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8717 "C<guestfs_inspect_get_filesystems>."
8721 #: ../src/guestfs-actions.pod:2625 ../src/guestfs-actions.pod:3051
8722 #: ../src/guestfs-actions.pod:4182 ../src/guestfs-actions.pod:6041
8724 "This function returns a NULL-terminated array of strings, or NULL if there "
8725 "was an error. The array of strings will always have length C<2n+1>, where "
8726 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
8727 "caller must free the strings and the array after use>."
8731 #: ../src/guestfs-actions.pod:2633
8732 msgid "guestfs_inspect_get_product_name"
8736 #: ../src/guestfs-actions.pod:2635
8740 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
8741 " const char *root);\n"
8746 #: ../src/guestfs-actions.pod:2642 ../fish/guestfish-actions.pod:1808
8748 "This returns the product name of the inspected operating system. The "
8749 "product name is generally some freeform string which can be displayed to the "
8750 "user, but should not be parsed by programs."
8754 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1813
8756 "If the product name could not be determined, then the string C<unknown> is "
8761 #: ../src/guestfs-actions.pod:2657
8762 msgid "guestfs_inspect_get_type"
8766 #: ../src/guestfs-actions.pod:2659
8770 " guestfs_inspect_get_type (guestfs_h *g,\n"
8771 " const char *root);\n"
8776 #: ../src/guestfs-actions.pod:2666 ../fish/guestfish-actions.pod:1825
8778 "This returns the type of the inspected operating system. Currently defined "
8783 #: ../src/guestfs-actions.pod:2671 ../fish/guestfish-actions.pod:1830
8788 #: ../src/guestfs-actions.pod:2673 ../fish/guestfish-actions.pod:1832
8789 msgid "Any Linux-based operating system."
8793 #: ../src/guestfs-actions.pod:2677 ../fish/guestfish-actions.pod:1836
8794 msgid "Any Microsoft Windows operating system."
8798 #: ../src/guestfs-actions.pod:2681 ../fish/guestfish-actions.pod:1840
8799 msgid "The operating system type could not be determined."
8803 #: ../src/guestfs-actions.pod:2695
8804 msgid "guestfs_inspect_get_windows_systemroot"
8808 #: ../src/guestfs-actions.pod:2697
8812 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
8813 " const char *root);\n"
8818 #: ../src/guestfs-actions.pod:2704 ../fish/guestfish-actions.pod:1856
8820 "This returns the Windows systemroot of the inspected guest. The systemroot "
8821 "is a directory path such as C</WINDOWS>."
8825 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1859
8827 "This call assumes that the guest is Windows and that the systemroot could be "
8828 "determined by inspection. If this is not the case then an error is returned."
8832 #: ../src/guestfs-actions.pod:2716
8833 msgid "(Added in 1.5.25)"
8837 #: ../src/guestfs-actions.pod:2718
8838 msgid "guestfs_inspect_os"
8842 #: ../src/guestfs-actions.pod:2720
8846 " guestfs_inspect_os (guestfs_h *g);\n"
8851 #: ../src/guestfs-actions.pod:2723 ../fish/guestfish-actions.pod:1869
8853 "This function uses other libguestfs functions and certain heuristics to "
8854 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
8855 "for operating systems."
8859 #: ../src/guestfs-actions.pod:2727 ../fish/guestfish-actions.pod:1873
8860 msgid "The list returned is empty if no operating systems were found."
8864 #: ../src/guestfs-actions.pod:2729 ../fish/guestfish-actions.pod:1875
8866 "If one operating system was found, then this returns a list with a single "
8867 "element, which is the name of the root filesystem of this operating system. "
8868 "It is also possible for this function to return a list containing more than "
8869 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
8870 "element being the root filesystem of one of the operating systems."
8874 #: ../src/guestfs-actions.pod:2736
8876 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
8877 "functions in order to query further information about each operating system, "
8878 "such as the name and version."
8882 #: ../src/guestfs-actions.pod:2741
8884 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
8885 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
8886 "the contents. This should be called with no disks currently mounted. The "
8887 "function may also use Augeas, so any existing Augeas handle will be closed."
8891 #: ../src/guestfs-actions.pod:2747 ../fish/guestfish-actions.pod:1893
8893 "This function cannot decrypt encrypted disks. The caller must do that first "
8894 "(supplying the necessary keys) if the disk is encrypted."
8898 #: ../src/guestfs-actions.pod:2753 ../src/guestfs-actions.pod:3009
8899 #: ../src/guestfs-actions.pod:3071
8900 msgid "See also C<guestfs_list_filesystems>."
8904 #: ../src/guestfs-actions.pod:2761
8905 msgid "guestfs_is_blockdev"
8909 #: ../src/guestfs-actions.pod:2763
8913 " guestfs_is_blockdev (guestfs_h *g,\n"
8914 " const char *path);\n"
8919 #: ../src/guestfs-actions.pod:2767 ../fish/guestfish-actions.pod:1905
8921 "This returns C<true> if and only if there is a block device with the given "
8926 #: ../src/guestfs-actions.pod:2770 ../src/guestfs-actions.pod:2799
8927 #: ../src/guestfs-actions.pod:2829 ../src/guestfs-actions.pod:2844
8928 #: ../src/guestfs-actions.pod:2860 ../src/guestfs-actions.pod:2916
8929 #: ../src/guestfs-actions.pod:2931
8930 msgid "See also C<guestfs_stat>."
8934 #: ../src/guestfs-actions.pod:2774 ../src/guestfs-actions.pod:2803
8935 #: ../src/guestfs-actions.pod:2848 ../src/guestfs-actions.pod:2920
8936 #: ../src/guestfs-actions.pod:2935
8937 msgid "(Added in 1.5.10)"
8941 #: ../src/guestfs-actions.pod:2776
8942 msgid "guestfs_is_busy"
8946 #: ../src/guestfs-actions.pod:2778
8950 " guestfs_is_busy (guestfs_h *g);\n"
8955 #: ../src/guestfs-actions.pod:2781 ../fish/guestfish-actions.pod:1914
8957 "This returns true iff this handle is busy processing a command (in the "
8962 #: ../src/guestfs-actions.pod:2790
8963 msgid "guestfs_is_chardev"
8967 #: ../src/guestfs-actions.pod:2792
8971 " guestfs_is_chardev (guestfs_h *g,\n"
8972 " const char *path);\n"
8977 #: ../src/guestfs-actions.pod:2796 ../fish/guestfish-actions.pod:1923
8979 "This returns C<true> if and only if there is a character device with the "
8980 "given C<path> name."
8984 #: ../src/guestfs-actions.pod:2805
8985 msgid "guestfs_is_config"
8989 #: ../src/guestfs-actions.pod:2807
8993 " guestfs_is_config (guestfs_h *g);\n"
8998 #: ../src/guestfs-actions.pod:2810 ../fish/guestfish-actions.pod:1932
9000 "This returns true iff this handle is being configured (in the C<CONFIG> "
9005 #: ../src/guestfs-actions.pod:2819
9006 msgid "guestfs_is_dir"
9010 #: ../src/guestfs-actions.pod:2821
9014 " guestfs_is_dir (guestfs_h *g,\n"
9015 " const char *path);\n"
9020 #: ../src/guestfs-actions.pod:2825 ../fish/guestfish-actions.pod:1941
9022 "This returns C<true> if and only if there is a directory with the given "
9023 "C<path> name. Note that it returns false for other objects like files."
9027 #: ../src/guestfs-actions.pod:2835
9028 msgid "guestfs_is_fifo"
9032 #: ../src/guestfs-actions.pod:2837
9036 " guestfs_is_fifo (guestfs_h *g,\n"
9037 " const char *path);\n"
9042 #: ../src/guestfs-actions.pod:2841 ../fish/guestfish-actions.pod:1951
9044 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9045 "given C<path> name."
9049 #: ../src/guestfs-actions.pod:2850
9050 msgid "guestfs_is_file"
9054 #: ../src/guestfs-actions.pod:2852
9058 " guestfs_is_file (guestfs_h *g,\n"
9059 " const char *path);\n"
9064 #: ../src/guestfs-actions.pod:2856 ../fish/guestfish-actions.pod:1960
9066 "This returns C<true> if and only if there is a regular file with the given "
9067 "C<path> name. Note that it returns false for other objects like directories."
9071 #: ../src/guestfs-actions.pod:2866
9072 msgid "guestfs_is_launching"
9076 #: ../src/guestfs-actions.pod:2868
9080 " guestfs_is_launching (guestfs_h *g);\n"
9085 #: ../src/guestfs-actions.pod:2871 ../fish/guestfish-actions.pod:1970
9087 "This returns true iff this handle is launching the subprocess (in the "
9088 "C<LAUNCHING> state)."
9092 #: ../src/guestfs-actions.pod:2880
9093 msgid "guestfs_is_lv"
9097 #: ../src/guestfs-actions.pod:2882
9101 " guestfs_is_lv (guestfs_h *g,\n"
9102 " const char *device);\n"
9107 #: ../src/guestfs-actions.pod:2886 ../fish/guestfish-actions.pod:1979
9109 "This command tests whether C<device> is a logical volume, and returns true "
9110 "iff this is the case."
9114 #: ../src/guestfs-actions.pod:2893
9115 msgid "guestfs_is_ready"
9119 #: ../src/guestfs-actions.pod:2895
9123 " guestfs_is_ready (guestfs_h *g);\n"
9128 #: ../src/guestfs-actions.pod:2898 ../fish/guestfish-actions.pod:1986
9130 "This returns true iff this handle is ready to accept commands (in the "
9135 #: ../src/guestfs-actions.pod:2907
9136 msgid "guestfs_is_socket"
9140 #: ../src/guestfs-actions.pod:2909
9144 " guestfs_is_socket (guestfs_h *g,\n"
9145 " const char *path);\n"
9150 #: ../src/guestfs-actions.pod:2913 ../fish/guestfish-actions.pod:1995
9152 "This returns C<true> if and only if there is a Unix domain socket with the "
9153 "given C<path> name."
9157 #: ../src/guestfs-actions.pod:2922
9158 msgid "guestfs_is_symlink"
9162 #: ../src/guestfs-actions.pod:2924
9166 " guestfs_is_symlink (guestfs_h *g,\n"
9167 " const char *path);\n"
9172 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2004
9174 "This returns C<true> if and only if there is a symbolic link with the given "
9179 #: ../src/guestfs-actions.pod:2937
9180 msgid "guestfs_kill_subprocess"
9184 #: ../src/guestfs-actions.pod:2939
9188 " guestfs_kill_subprocess (guestfs_h *g);\n"
9193 #: ../src/guestfs-actions.pod:2942 ../fish/guestfish-actions.pod:2013
9194 msgid "This kills the qemu subprocess. You should never need to call this."
9198 #: ../src/guestfs-actions.pod:2948
9199 msgid "guestfs_launch"
9203 #: ../src/guestfs-actions.pod:2950
9207 " guestfs_launch (guestfs_h *g);\n"
9212 #: ../src/guestfs-actions.pod:2953 ../fish/guestfish-actions.pod:2021
9214 "Internally libguestfs is implemented by running a virtual machine using "
9219 #: ../src/guestfs-actions.pod:2956 ../fish/guestfish-actions.pod:2024
9221 "You should call this after configuring the handle (eg. adding drives) but "
9222 "before performing any actions."
9226 #: ../src/guestfs-actions.pod:2963
9227 msgid "guestfs_lchown"
9231 #: ../src/guestfs-actions.pod:2965
9235 " guestfs_lchown (guestfs_h *g,\n"
9238 " const char *path);\n"
9243 #: ../src/guestfs-actions.pod:2971
9245 "Change the file owner to C<owner> and group to C<group>. This is like "
9246 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
9247 "changed, not the target."
9251 #: ../src/guestfs-actions.pod:2983
9252 msgid "guestfs_lgetxattrs"
9256 #: ../src/guestfs-actions.pod:2985
9259 " struct guestfs_xattr_list *\n"
9260 " guestfs_lgetxattrs (guestfs_h *g,\n"
9261 " const char *path);\n"
9266 #: ../src/guestfs-actions.pod:2989
9268 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
9269 "then it returns the extended attributes of the link itself."
9273 #: ../src/guestfs-actions.pod:3000
9274 msgid "guestfs_list_devices"
9278 #: ../src/guestfs-actions.pod:3002
9282 " guestfs_list_devices (guestfs_h *g);\n"
9287 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:2051
9288 msgid "List all the block devices."
9292 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2053
9293 msgid "The full block device names are returned, eg. C</dev/sda>."
9297 #: ../src/guestfs-actions.pod:3017
9298 msgid "guestfs_list_filesystems"
9302 #: ../src/guestfs-actions.pod:3019
9306 " guestfs_list_filesystems (guestfs_h *g);\n"
9311 #: ../src/guestfs-actions.pod:3022 ../fish/guestfish-actions.pod:2061
9313 "This inspection command looks for filesystems on partitions, block devices "
9314 "and logical volumes, returning a list of devices containing filesystems and "
9319 #: ../src/guestfs-actions.pod:3026 ../fish/guestfish-actions.pod:2065
9321 "The return value is a hash, where the keys are the devices containing "
9322 "filesystems, and the values are the filesystem types. For example:"
9326 #: ../src/guestfs-actions.pod:3030 ../fish/guestfish-actions.pod:2069
9329 " \"/dev/sda1\" => \"ntfs\"\n"
9330 " \"/dev/sda2\" => \"ext2\"\n"
9331 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9332 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9337 #: ../src/guestfs-actions.pod:3035 ../fish/guestfish-actions.pod:2074
9339 "The value can have the special value \"unknown\", meaning the content of the "
9340 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9344 #: ../src/guestfs-actions.pod:3039
9346 "This command runs other libguestfs commands, which might include "
9347 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
9348 "soon after launch and only when nothing is mounted."
9352 #: ../src/guestfs-actions.pod:3043
9354 "Not all of the filesystems returned will be mountable. In particular, swap "
9355 "partitions are returned in the list. Also this command does not check that "
9356 "each filesystem found is valid and mountable, and some filesystems might be "
9357 "mountable but require special options. Filesystems may not all belong to a "
9358 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
9362 #: ../src/guestfs-actions.pod:3057 ../src/guestfs-actions.pod:4584
9363 msgid "(Added in 1.5.15)"
9367 #: ../src/guestfs-actions.pod:3059
9368 msgid "guestfs_list_partitions"
9372 #: ../src/guestfs-actions.pod:3061
9376 " guestfs_list_partitions (guestfs_h *g);\n"
9381 #: ../src/guestfs-actions.pod:3064 ../fish/guestfish-actions.pod:2094
9382 msgid "List all the partitions detected on all block devices."
9386 #: ../src/guestfs-actions.pod:3066 ../fish/guestfish-actions.pod:2096
9387 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9391 #: ../src/guestfs-actions.pod:3068
9393 "This does not return logical volumes. For that you will need to call "
9398 #: ../src/guestfs-actions.pod:3079
9403 #: ../src/guestfs-actions.pod:3081
9407 " guestfs_ll (guestfs_h *g,\n"
9408 " const char *directory);\n"
9413 #: ../src/guestfs-actions.pod:3085 ../fish/guestfish-actions.pod:2107
9415 "List the files in C<directory> (relative to the root directory, there is no "
9416 "cwd) in the format of 'ls -la'."
9420 #: ../src/guestfs-actions.pod:3088 ../fish/guestfish-actions.pod:2110
9422 "This command is mostly useful for interactive sessions. It is I<not> "
9423 "intended that you try to parse the output string."
9427 #: ../src/guestfs-actions.pod:3096
9432 #: ../src/guestfs-actions.pod:3098
9436 " guestfs_ln (guestfs_h *g,\n"
9437 " const char *target,\n"
9438 " const char *linkname);\n"
9443 #: ../src/guestfs-actions.pod:3103 ../fish/guestfish-actions.pod:2117
9444 msgid "This command creates a hard link using the C<ln> command."
9448 #: ../src/guestfs-actions.pod:3109
9449 msgid "guestfs_ln_f"
9453 #: ../src/guestfs-actions.pod:3111
9457 " guestfs_ln_f (guestfs_h *g,\n"
9458 " const char *target,\n"
9459 " const char *linkname);\n"
9464 #: ../src/guestfs-actions.pod:3116 ../fish/guestfish-actions.pod:2123
9466 "This command creates a hard link using the C<ln -f> command. The C<-f> "
9467 "option removes the link (C<linkname>) if it exists already."
9471 #: ../src/guestfs-actions.pod:3123
9472 msgid "guestfs_ln_s"
9476 #: ../src/guestfs-actions.pod:3125
9480 " guestfs_ln_s (guestfs_h *g,\n"
9481 " const char *target,\n"
9482 " const char *linkname);\n"
9487 #: ../src/guestfs-actions.pod:3130 ../fish/guestfish-actions.pod:2130
9488 msgid "This command creates a symbolic link using the C<ln -s> command."
9492 #: ../src/guestfs-actions.pod:3136
9493 msgid "guestfs_ln_sf"
9497 #: ../src/guestfs-actions.pod:3138
9501 " guestfs_ln_sf (guestfs_h *g,\n"
9502 " const char *target,\n"
9503 " const char *linkname);\n"
9508 #: ../src/guestfs-actions.pod:3143 ../fish/guestfish-actions.pod:2136
9510 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
9511 "option removes the link (C<linkname>) if it exists already."
9515 #: ../src/guestfs-actions.pod:3150
9516 msgid "guestfs_lremovexattr"
9520 #: ../src/guestfs-actions.pod:3152
9524 " guestfs_lremovexattr (guestfs_h *g,\n"
9525 " const char *xattr,\n"
9526 " const char *path);\n"
9531 #: ../src/guestfs-actions.pod:3157
9533 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
9534 "link, then it removes an extended attribute of the link itself."
9538 #: ../src/guestfs-actions.pod:3165
9543 #: ../src/guestfs-actions.pod:3167
9547 " guestfs_ls (guestfs_h *g,\n"
9548 " const char *directory);\n"
9553 #: ../src/guestfs-actions.pod:3171 ../fish/guestfish-actions.pod:2151
9555 "List the files in C<directory> (relative to the root directory, there is no "
9556 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
9560 #: ../src/guestfs-actions.pod:3175
9562 "This command is mostly useful for interactive sessions. Programs should "
9563 "probably use C<guestfs_readdir> instead."
9567 #: ../src/guestfs-actions.pod:3184
9568 msgid "guestfs_lsetxattr"
9572 #: ../src/guestfs-actions.pod:3186
9576 " guestfs_lsetxattr (guestfs_h *g,\n"
9577 " const char *xattr,\n"
9578 " const char *val,\n"
9580 " const char *path);\n"
9585 #: ../src/guestfs-actions.pod:3193
9587 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
9588 "then it sets an extended attribute of the link itself."
9592 #: ../src/guestfs-actions.pod:3201
9593 msgid "guestfs_lstat"
9597 #: ../src/guestfs-actions.pod:3203
9600 " struct guestfs_stat *\n"
9601 " guestfs_lstat (guestfs_h *g,\n"
9602 " const char *path);\n"
9607 #: ../src/guestfs-actions.pod:3207 ../src/guestfs-actions.pod:5640
9608 #: ../fish/guestfish-actions.pod:2170 ../fish/guestfish-actions.pod:3752
9609 msgid "Returns file information for the given C<path>."
9613 #: ../src/guestfs-actions.pod:3209
9615 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
9616 "link, then the link is stat-ed, not the file it refers to."
9620 #: ../src/guestfs-actions.pod:3213 ../fish/guestfish-actions.pod:2176
9621 msgid "This is the same as the C<lstat(2)> system call."
9625 #: ../src/guestfs-actions.pod:3215 ../src/guestfs-actions.pod:5644
9627 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
9628 "error. I<The caller must call C<guestfs_free_stat> after use>."
9632 #: ../src/guestfs-actions.pod:3219 ../src/guestfs-actions.pod:5648
9633 #: ../src/guestfs-actions.pod:5666 ../src/guestfs-actions.pod:6047
9634 msgid "(Added in 0.9.2)"
9638 #: ../src/guestfs-actions.pod:3221
9639 msgid "guestfs_lstatlist"
9643 #: ../src/guestfs-actions.pod:3223
9646 " struct guestfs_stat_list *\n"
9647 " guestfs_lstatlist (guestfs_h *g,\n"
9648 " const char *path,\n"
9649 " char *const *names);\n"
9654 #: ../src/guestfs-actions.pod:3228
9656 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
9657 "files, where all files are in the directory C<path>. C<names> is the list "
9658 "of files from this directory."
9662 #: ../src/guestfs-actions.pod:3232 ../fish/guestfish-actions.pod:2186
9664 "On return you get a list of stat structs, with a one-to-one correspondence "
9665 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9666 "then the C<ino> field of that structure is set to C<-1>."
9670 #: ../src/guestfs-actions.pod:3237
9672 "This call is intended for programs that want to efficiently list a directory "
9673 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
9674 "for a similarly efficient call for getting extended attributes. Very long "
9675 "directory listings might cause the protocol message size to be exceeded, "
9676 "causing this call to fail. The caller must split up such requests into "
9677 "smaller groups of names."
9681 #: ../src/guestfs-actions.pod:3245
9683 "This function returns a C<struct guestfs_stat_list *> (see E<lt>guestfs-"
9684 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
9685 "C<guestfs_free_stat_list> after use>."
9689 #: ../src/guestfs-actions.pod:3252
9690 msgid "guestfs_luks_add_key"
9694 #: ../src/guestfs-actions.pod:3254
9698 " guestfs_luks_add_key (guestfs_h *g,\n"
9699 " const char *device,\n"
9700 " const char *key,\n"
9701 " const char *newkey,\n"
9707 #: ../src/guestfs-actions.pod:3261 ../fish/guestfish-actions.pod:2203
9709 "This command adds a new key on LUKS device C<device>. C<key> is any "
9710 "existing key, and is used to access the device. C<newkey> is the new key to "
9711 "add. C<keyslot> is the key slot that will be replaced."
9715 #: ../src/guestfs-actions.pod:3266
9717 "Note that if C<keyslot> already contains a key, then this command will "
9718 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
9722 #: ../src/guestfs-actions.pod:3272 ../src/guestfs-actions.pod:3312
9723 #: ../src/guestfs-actions.pod:3335 ../src/guestfs-actions.pod:3355
9724 #: ../src/guestfs-actions.pod:3387 ../src/guestfs-actions.pod:3406
9726 "This function takes a key or passphrase parameter which could contain "
9727 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
9732 #: ../src/guestfs-actions.pod:3276 ../src/guestfs-actions.pod:3316
9733 #: ../src/guestfs-actions.pod:3339 ../src/guestfs-actions.pod:3359
9734 msgid "(Added in 1.5.2)"
9738 #: ../src/guestfs-actions.pod:3278
9739 msgid "guestfs_luks_close"
9743 #: ../src/guestfs-actions.pod:3280
9747 " guestfs_luks_close (guestfs_h *g,\n"
9748 " const char *device);\n"
9753 #: ../src/guestfs-actions.pod:3284
9755 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
9756 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
9757 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
9758 "underlying block device."
9762 #: ../src/guestfs-actions.pod:3292 ../src/guestfs-actions.pod:3391
9763 #: ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3460
9764 #: ../src/guestfs-actions.pod:3508
9765 msgid "(Added in 1.5.1)"
9769 #: ../src/guestfs-actions.pod:3294
9770 msgid "guestfs_luks_format"
9774 #: ../src/guestfs-actions.pod:3296
9778 " guestfs_luks_format (guestfs_h *g,\n"
9779 " const char *device,\n"
9780 " const char *key,\n"
9786 #: ../src/guestfs-actions.pod:3302 ../fish/guestfish-actions.pod:2229
9788 "This command erases existing data on C<device> and formats the device as a "
9789 "LUKS encrypted device. C<key> is the initial key, which is added to key "
9790 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
9794 #: ../src/guestfs-actions.pod:3309 ../src/guestfs-actions.pod:3332
9795 #: ../src/guestfs-actions.pod:3472 ../src/guestfs-actions.pod:4334
9796 #: ../src/guestfs-actions.pod:5100 ../src/guestfs-actions.pod:5475
9797 #: ../src/guestfs-actions.pod:5498 ../src/guestfs-actions.pod:5524
9798 #: ../src/guestfs-actions.pod:6675 ../fish/guestfish-actions.pod:2237
9799 #: ../fish/guestfish-actions.pod:2250 ../fish/guestfish-actions.pod:2334
9800 #: ../fish/guestfish-actions.pod:2864 ../fish/guestfish-actions.pod:3371
9801 #: ../fish/guestfish-actions.pod:3651 ../fish/guestfish-actions.pod:3667
9802 #: ../fish/guestfish-actions.pod:3682 ../fish/guestfish-actions.pod:4397
9804 "B<This command is dangerous. Without careful use you can easily destroy all "
9809 #: ../src/guestfs-actions.pod:3318
9810 msgid "guestfs_luks_format_cipher"
9814 #: ../src/guestfs-actions.pod:3320
9818 " guestfs_luks_format_cipher (guestfs_h *g,\n"
9819 " const char *device,\n"
9820 " const char *key,\n"
9822 " const char *cipher);\n"
9827 #: ../src/guestfs-actions.pod:3327
9829 "This command is the same as C<guestfs_luks_format> but it also allows you to "
9830 "set the C<cipher> used."
9834 #: ../src/guestfs-actions.pod:3341
9835 msgid "guestfs_luks_kill_slot"
9839 #: ../src/guestfs-actions.pod:3343
9843 " guestfs_luks_kill_slot (guestfs_h *g,\n"
9844 " const char *device,\n"
9845 " const char *key,\n"
9851 #: ../src/guestfs-actions.pod:3349 ../fish/guestfish-actions.pod:2257
9853 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
9854 "device C<device>. C<key> must be one of the I<other> keys."
9858 #: ../src/guestfs-actions.pod:3361
9859 msgid "guestfs_luks_open"
9863 #: ../src/guestfs-actions.pod:3363
9867 " guestfs_luks_open (guestfs_h *g,\n"
9868 " const char *device,\n"
9869 " const char *key,\n"
9870 " const char *mapname);\n"
9875 #: ../src/guestfs-actions.pod:3369 ../fish/guestfish-actions.pod:2268
9877 "This command opens a block device which has been encrypted according to the "
9878 "Linux Unified Key Setup (LUKS) standard."
9882 #: ../src/guestfs-actions.pod:3372 ../fish/guestfish-actions.pod:2271
9883 msgid "C<device> is the encrypted block device or partition."
9887 #: ../src/guestfs-actions.pod:3374 ../fish/guestfish-actions.pod:2273
9889 "The caller must supply one of the keys associated with the LUKS block "
9890 "device, in the C<key> parameter."
9894 #: ../src/guestfs-actions.pod:3377 ../fish/guestfish-actions.pod:2276
9896 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
9897 "writes to this block device are decrypted from and encrypted to the "
9898 "underlying C<device> respectively."
9902 #: ../src/guestfs-actions.pod:3381
9904 "If this block device contains LVM volume groups, then calling "
9905 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
9910 #: ../src/guestfs-actions.pod:3393
9911 msgid "guestfs_luks_open_ro"
9915 #: ../src/guestfs-actions.pod:3395
9919 " guestfs_luks_open_ro (guestfs_h *g,\n"
9920 " const char *device,\n"
9921 " const char *key,\n"
9922 " const char *mapname);\n"
9927 #: ../src/guestfs-actions.pod:3401
9929 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
9934 #: ../src/guestfs-actions.pod:3412
9935 msgid "guestfs_lvcreate"
9939 #: ../src/guestfs-actions.pod:3414
9943 " guestfs_lvcreate (guestfs_h *g,\n"
9944 " const char *logvol,\n"
9945 " const char *volgroup,\n"
9951 #: ../src/guestfs-actions.pod:3420 ../fish/guestfish-actions.pod:2301
9953 "This creates an LVM logical volume called C<logvol> on the volume group "
9954 "C<volgroup>, with C<size> megabytes."
9958 #: ../src/guestfs-actions.pod:3427
9959 msgid "guestfs_lvm_canonical_lv_name"
9963 #: ../src/guestfs-actions.pod:3429
9967 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
9968 " const char *lvname);\n"
9973 #: ../src/guestfs-actions.pod:3433 ../fish/guestfish-actions.pod:2308
9975 "This converts alternative naming schemes for LVs that you might find to the "
9976 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
9981 #: ../src/guestfs-actions.pod:3437 ../fish/guestfish-actions.pod:2312
9983 "This command returns an error if the C<lvname> parameter does not refer to a "
9988 #: ../src/guestfs-actions.pod:3440
9989 msgid "See also C<guestfs_is_lv>."
9993 #: ../src/guestfs-actions.pod:3445
9994 msgid "(Added in 1.5.24)"
9998 #: ../src/guestfs-actions.pod:3447
9999 msgid "guestfs_lvm_clear_filter"
10003 #: ../src/guestfs-actions.pod:3449
10007 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
10012 #: ../src/guestfs-actions.pod:3452
10014 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
10015 "see every block device."
10019 #: ../src/guestfs-actions.pod:3455 ../src/guestfs-actions.pod:3497
10020 #: ../fish/guestfish-actions.pod:2324 ../fish/guestfish-actions.pod:2355
10022 "This command also clears the LVM cache and performs a volume group scan."
10026 #: ../src/guestfs-actions.pod:3462
10027 msgid "guestfs_lvm_remove_all"
10031 #: ../src/guestfs-actions.pod:3464
10035 " guestfs_lvm_remove_all (guestfs_h *g);\n"
10040 #: ../src/guestfs-actions.pod:3467 ../fish/guestfish-actions.pod:2331
10042 "This command removes all LVM logical volumes, volume groups and physical "
10047 #: ../src/guestfs-actions.pod:3477
10048 msgid "guestfs_lvm_set_filter"
10052 #: ../src/guestfs-actions.pod:3479
10056 " guestfs_lvm_set_filter (guestfs_h *g,\n"
10057 " char *const *devices);\n"
10062 #: ../src/guestfs-actions.pod:3483 ../fish/guestfish-actions.pod:2341
10064 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10065 "block devices in the list C<devices>, and will ignore all other attached "
10070 #: ../src/guestfs-actions.pod:3487 ../fish/guestfish-actions.pod:2345
10072 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10073 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10074 "there are two types of duplication possible: either cloned PVs/VGs which "
10075 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10076 "same name. In normal operation you cannot create this situation, but you "
10077 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10078 "inside the LVM metadata."
10082 #: ../src/guestfs-actions.pod:3500 ../fish/guestfish-actions.pod:2358
10083 msgid "You can filter whole block devices or individual partitions."
10087 #: ../src/guestfs-actions.pod:3502 ../fish/guestfish-actions.pod:2360
10089 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10090 "filesystem), even if you are not filtering out that VG."
10094 #: ../src/guestfs-actions.pod:3510
10095 msgid "guestfs_lvremove"
10099 #: ../src/guestfs-actions.pod:3512
10103 " guestfs_lvremove (guestfs_h *g,\n"
10104 " const char *device);\n"
10109 #: ../src/guestfs-actions.pod:3516 ../fish/guestfish-actions.pod:2368
10111 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10112 "LV, such as C</dev/VG/LV>."
10116 #: ../src/guestfs-actions.pod:3519 ../fish/guestfish-actions.pod:2371
10118 "You can also remove all LVs in a volume group by specifying the VG name, C</"
10123 #: ../src/guestfs-actions.pod:3524 ../src/guestfs-actions.pod:4681
10124 #: ../src/guestfs-actions.pod:6413
10125 msgid "(Added in 1.0.13)"
10129 #: ../src/guestfs-actions.pod:3526
10130 msgid "guestfs_lvrename"
10134 #: ../src/guestfs-actions.pod:3528
10138 " guestfs_lvrename (guestfs_h *g,\n"
10139 " const char *logvol,\n"
10140 " const char *newlogvol);\n"
10145 #: ../src/guestfs-actions.pod:3533 ../fish/guestfish-actions.pod:2378
10146 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10150 #: ../src/guestfs-actions.pod:3537 ../src/guestfs-actions.pod:6426
10151 msgid "(Added in 1.0.83)"
10155 #: ../src/guestfs-actions.pod:3539
10156 msgid "guestfs_lvresize"
10160 #: ../src/guestfs-actions.pod:3541
10164 " guestfs_lvresize (guestfs_h *g,\n"
10165 " const char *device,\n"
10171 #: ../src/guestfs-actions.pod:3546 ../fish/guestfish-actions.pod:2384
10173 "This resizes (expands or shrinks) an existing LVM logical volume to "
10174 "C<mbytes>. When reducing, data in the reduced part is lost."
10178 #: ../src/guestfs-actions.pod:3554
10179 msgid "guestfs_lvresize_free"
10183 #: ../src/guestfs-actions.pod:3556
10187 " guestfs_lvresize_free (guestfs_h *g,\n"
10188 " const char *lv,\n"
10194 #: ../src/guestfs-actions.pod:3561 ../fish/guestfish-actions.pod:2392
10196 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10197 "remaining free space in the volume group. Commonly you would call this with "
10198 "pc = 100 which expands the logical volume as much as possible, using all "
10199 "remaining free space in the volume group."
10203 #: ../src/guestfs-actions.pod:3569
10204 msgid "(Added in 1.3.3)"
10208 #: ../src/guestfs-actions.pod:3571
10209 msgid "guestfs_lvs"
10213 #: ../src/guestfs-actions.pod:3573
10217 " guestfs_lvs (guestfs_h *g);\n"
10222 #: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2402
10224 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10229 #: ../src/guestfs-actions.pod:3579 ../fish/guestfish-actions.pod:2405
10231 "This returns a list of the logical volume device names (eg. C</dev/"
10232 "VolGroup00/LogVol00>)."
10236 #: ../src/guestfs-actions.pod:3582
10237 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
10241 #: ../src/guestfs-actions.pod:3590
10242 msgid "guestfs_lvs_full"
10246 #: ../src/guestfs-actions.pod:3592
10249 " struct guestfs_lvm_lv_list *\n"
10250 " guestfs_lvs_full (guestfs_h *g);\n"
10255 #: ../src/guestfs-actions.pod:3595 ../fish/guestfish-actions.pod:2414
10257 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10258 "(8)> command. The \"full\" version includes all fields."
10262 #: ../src/guestfs-actions.pod:3598
10264 "This function returns a C<struct guestfs_lvm_lv_list *> (see E<lt>guestfs-"
10265 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
10266 "C<guestfs_free_lvm_lv_list> after use>."
10270 #: ../src/guestfs-actions.pod:3605
10271 msgid "guestfs_lvuuid"
10275 #: ../src/guestfs-actions.pod:3607
10279 " guestfs_lvuuid (guestfs_h *g,\n"
10280 " const char *device);\n"
10285 #: ../src/guestfs-actions.pod:3611 ../fish/guestfish-actions.pod:2421
10286 msgid "This command returns the UUID of the LVM LV C<device>."
10290 #: ../src/guestfs-actions.pod:3618
10291 msgid "guestfs_lxattrlist"
10295 #: ../src/guestfs-actions.pod:3620
10298 " struct guestfs_xattr_list *\n"
10299 " guestfs_lxattrlist (guestfs_h *g,\n"
10300 " const char *path,\n"
10301 " char *const *names);\n"
10306 #: ../src/guestfs-actions.pod:3625 ../fish/guestfish-actions.pod:2427
10308 "This call allows you to get the extended attributes of multiple files, where "
10309 "all files are in the directory C<path>. C<names> is the list of files from "
10314 #: ../src/guestfs-actions.pod:3629 ../fish/guestfish-actions.pod:2431
10316 "On return you get a flat list of xattr structs which must be interpreted "
10317 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10318 "C<attrval> in this struct is zero-length to indicate there was an error "
10319 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10320 "number (the number of following attributes for this file, which could be C<"
10321 "\"0\">). Then after the first xattr struct are the zero or more attributes "
10322 "for the first named file. This repeats for the second and subsequent files."
10326 #: ../src/guestfs-actions.pod:3639
10328 "This call is intended for programs that want to efficiently list a directory "
10329 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
10330 "a similarly efficient call for getting standard stats. Very long directory "
10331 "listings might cause the protocol message size to be exceeded, causing this "
10332 "call to fail. The caller must split up such requests into smaller groups of "
10337 #: ../src/guestfs-actions.pod:3654
10338 msgid "guestfs_mkdir"
10342 #: ../src/guestfs-actions.pod:3656
10346 " guestfs_mkdir (guestfs_h *g,\n"
10347 " const char *path);\n"
10352 #: ../src/guestfs-actions.pod:3660 ../fish/guestfish-actions.pod:2453
10353 msgid "Create a directory named C<path>."
10357 #: ../src/guestfs-actions.pod:3666
10358 msgid "guestfs_mkdir_mode"
10362 #: ../src/guestfs-actions.pod:3668
10366 " guestfs_mkdir_mode (guestfs_h *g,\n"
10367 " const char *path,\n"
10373 #: ../src/guestfs-actions.pod:3673 ../fish/guestfish-actions.pod:2459
10375 "This command creates a directory, setting the initial permissions of the "
10376 "directory to C<mode>."
10380 #: ../src/guestfs-actions.pod:3676 ../fish/guestfish-actions.pod:2462
10382 "For common Linux filesystems, the actual mode which is set will be C<mode & "
10383 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
10388 #: ../src/guestfs-actions.pod:3680
10389 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
10393 #: ../src/guestfs-actions.pod:3686
10394 msgid "guestfs_mkdir_p"
10398 #: ../src/guestfs-actions.pod:3688
10402 " guestfs_mkdir_p (guestfs_h *g,\n"
10403 " const char *path);\n"
10408 #: ../src/guestfs-actions.pod:3692 ../fish/guestfish-actions.pod:2472
10410 "Create a directory named C<path>, creating any parent directories as "
10411 "necessary. This is like the C<mkdir -p> shell command."
10415 #: ../src/guestfs-actions.pod:3699
10416 msgid "guestfs_mkdtemp"
10420 #: ../src/guestfs-actions.pod:3701
10424 " guestfs_mkdtemp (guestfs_h *g,\n"
10425 " const char *template);\n"
10430 #: ../src/guestfs-actions.pod:3705 ../fish/guestfish-actions.pod:2479
10432 "This command creates a temporary directory. The C<template> parameter "
10433 "should be a full pathname for the temporary directory name with the final "
10434 "six characters being \"XXXXXX\"."
10438 #: ../src/guestfs-actions.pod:3710 ../fish/guestfish-actions.pod:2484
10440 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10441 "being suitable for Windows filesystems."
10445 #: ../src/guestfs-actions.pod:3713 ../fish/guestfish-actions.pod:2487
10446 msgid "The name of the temporary directory that was created is returned."
10450 #: ../src/guestfs-actions.pod:3716 ../fish/guestfish-actions.pod:2490
10451 msgid "The temporary directory is created with mode 0700 and is owned by root."
10455 #: ../src/guestfs-actions.pod:3719 ../fish/guestfish-actions.pod:2493
10457 "The caller is responsible for deleting the temporary directory and its "
10458 "contents after use."
10462 #: ../src/guestfs-actions.pod:3722 ../fish/guestfish-actions.pod:2496
10463 msgid "See also: L<mkdtemp(3)>"
10467 #: ../src/guestfs-actions.pod:3729
10468 msgid "guestfs_mke2fs_J"
10472 #: ../src/guestfs-actions.pod:3731
10476 " guestfs_mke2fs_J (guestfs_h *g,\n"
10477 " const char *fstype,\n"
10478 " int blocksize,\n"
10479 " const char *device,\n"
10480 " const char *journal);\n"
10485 #: ../src/guestfs-actions.pod:3738 ../fish/guestfish-actions.pod:2502
10487 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10488 "C<journal>. It is equivalent to the command:"
10492 #: ../src/guestfs-actions.pod:3742 ../fish/guestfish-actions.pod:2506
10495 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10500 #: ../src/guestfs-actions.pod:3744
10501 msgid "See also C<guestfs_mke2journal>."
10505 #: ../src/guestfs-actions.pod:3748 ../src/guestfs-actions.pod:3766
10506 #: ../src/guestfs-actions.pod:3784 ../src/guestfs-actions.pod:3800
10507 #: ../src/guestfs-actions.pod:3814 ../src/guestfs-actions.pod:3828
10508 #: ../src/guestfs-actions.pod:3880 ../src/guestfs-actions.pod:4070
10509 msgid "(Added in 1.0.68)"
10513 #: ../src/guestfs-actions.pod:3750
10514 msgid "guestfs_mke2fs_JL"
10518 #: ../src/guestfs-actions.pod:3752
10522 " guestfs_mke2fs_JL (guestfs_h *g,\n"
10523 " const char *fstype,\n"
10524 " int blocksize,\n"
10525 " const char *device,\n"
10526 " const char *label);\n"
10531 #: ../src/guestfs-actions.pod:3759 ../fish/guestfish-actions.pod:2514
10533 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10534 "the journal labeled C<label>."
10538 #: ../src/guestfs-actions.pod:3762
10539 msgid "See also C<guestfs_mke2journal_L>."
10543 #: ../src/guestfs-actions.pod:3768
10544 msgid "guestfs_mke2fs_JU"
10548 #: ../src/guestfs-actions.pod:3770
10552 " guestfs_mke2fs_JU (guestfs_h *g,\n"
10553 " const char *fstype,\n"
10554 " int blocksize,\n"
10555 " const char *device,\n"
10556 " const char *uuid);\n"
10561 #: ../src/guestfs-actions.pod:3777 ../fish/guestfish-actions.pod:2523
10563 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10564 "the journal with UUID C<uuid>."
10568 #: ../src/guestfs-actions.pod:3780
10569 msgid "See also C<guestfs_mke2journal_U>."
10573 #: ../src/guestfs-actions.pod:3786
10574 msgid "guestfs_mke2journal"
10578 #: ../src/guestfs-actions.pod:3788
10582 " guestfs_mke2journal (guestfs_h *g,\n"
10583 " int blocksize,\n"
10584 " const char *device);\n"
10589 #: ../src/guestfs-actions.pod:3793 ../fish/guestfish-actions.pod:2532
10591 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10596 #: ../src/guestfs-actions.pod:3796 ../fish/guestfish-actions.pod:2535
10599 " mke2fs -O journal_dev -b blocksize device\n"
10604 #: ../src/guestfs-actions.pod:3802
10605 msgid "guestfs_mke2journal_L"
10609 #: ../src/guestfs-actions.pod:3804
10613 " guestfs_mke2journal_L (guestfs_h *g,\n"
10614 " int blocksize,\n"
10615 " const char *label,\n"
10616 " const char *device);\n"
10621 #: ../src/guestfs-actions.pod:3810 ../fish/guestfish-actions.pod:2541
10622 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10626 #: ../src/guestfs-actions.pod:3816
10627 msgid "guestfs_mke2journal_U"
10631 #: ../src/guestfs-actions.pod:3818
10635 " guestfs_mke2journal_U (guestfs_h *g,\n"
10636 " int blocksize,\n"
10637 " const char *uuid,\n"
10638 " const char *device);\n"
10643 #: ../src/guestfs-actions.pod:3824 ../fish/guestfish-actions.pod:2547
10644 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10648 #: ../src/guestfs-actions.pod:3830
10649 msgid "guestfs_mkfifo"
10653 #: ../src/guestfs-actions.pod:3832
10657 " guestfs_mkfifo (guestfs_h *g,\n"
10659 " const char *path);\n"
10664 #: ../src/guestfs-actions.pod:3837
10666 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10667 "is just a convenient wrapper around C<guestfs_mknod>."
10671 #: ../src/guestfs-actions.pod:3847
10672 msgid "guestfs_mkfs"
10676 #: ../src/guestfs-actions.pod:3849
10680 " guestfs_mkfs (guestfs_h *g,\n"
10681 " const char *fstype,\n"
10682 " const char *device);\n"
10687 #: ../src/guestfs-actions.pod:3854 ../fish/guestfish-actions.pod:2563
10689 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10690 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10694 #: ../src/guestfs-actions.pod:3862
10695 msgid "guestfs_mkfs_b"
10699 #: ../src/guestfs-actions.pod:3864
10703 " guestfs_mkfs_b (guestfs_h *g,\n"
10704 " const char *fstype,\n"
10705 " int blocksize,\n"
10706 " const char *device);\n"
10711 #: ../src/guestfs-actions.pod:3870
10713 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
10714 "block size of the resulting filesystem. Supported block sizes depend on the "
10715 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10719 #: ../src/guestfs-actions.pod:3875 ../fish/guestfish-actions.pod:2576
10721 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10726 #: ../src/guestfs-actions.pod:3882
10727 msgid "guestfs_mkmountpoint"
10731 #: ../src/guestfs-actions.pod:3884
10735 " guestfs_mkmountpoint (guestfs_h *g,\n"
10736 " const char *exemptpath);\n"
10741 #: ../src/guestfs-actions.pod:3888
10743 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
10744 "that can be used to create extra mountpoints before mounting the first "
10749 #: ../src/guestfs-actions.pod:3892 ../fish/guestfish-actions.pod:2587
10751 "These calls are I<only> necessary in some very limited circumstances, mainly "
10752 "the case where you want to mount a mix of unrelated and/or read-only "
10753 "filesystems together."
10757 #: ../src/guestfs-actions.pod:3896 ../fish/guestfish-actions.pod:2591
10759 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10760 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10761 "inside that. You can unpack this as follows in guestfish:"
10765 #: ../src/guestfs-actions.pod:3901 ../fish/guestfish-actions.pod:2596
10768 " add-ro Fedora-11-i686-Live.iso\n"
10770 " mkmountpoint /cd\n"
10771 " mkmountpoint /sqsh\n"
10772 " mkmountpoint /ext3fs\n"
10773 " mount /dev/sda /cd\n"
10774 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10775 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10780 #: ../src/guestfs-actions.pod:3910 ../fish/guestfish-actions.pod:2605
10781 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
10785 #: ../src/guestfs-actions.pod:3912
10787 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
10788 "may get unexpected errors if you try to mix these calls. It is safest to "
10789 "manually unmount filesystems and remove mountpoints after use."
10793 #: ../src/guestfs-actions.pod:3916
10795 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
10796 "first, so for this to work for manual mountpoints, you must ensure that the "
10797 "innermost mountpoints have the longest pathnames, as in the example code "
10802 #: ../src/guestfs-actions.pod:3921 ../fish/guestfish-actions.pod:2616
10804 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
10808 #: ../src/guestfs-actions.pod:3923
10810 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
10811 "means that C<guestfs_umount_all> is called when the handle is closed which "
10812 "can also trigger these issues."
10816 #: ../src/guestfs-actions.pod:3929 ../src/guestfs-actions.pod:4188
10817 #: ../src/guestfs-actions.pod:5084
10818 msgid "(Added in 1.0.62)"
10822 #: ../src/guestfs-actions.pod:3931
10823 msgid "guestfs_mknod"
10827 #: ../src/guestfs-actions.pod:3933
10831 " guestfs_mknod (guestfs_h *g,\n"
10835 " const char *path);\n"
10840 #: ../src/guestfs-actions.pod:3940 ../fish/guestfish-actions.pod:2626
10842 "This call creates block or character special devices, or named pipes (FIFOs)."
10846 #: ../src/guestfs-actions.pod:3943 ../fish/guestfish-actions.pod:2629
10848 "The C<mode> parameter should be the mode, using the standard constants. "
10849 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
10850 "used when creating block and character special devices."
10854 #: ../src/guestfs-actions.pod:3948
10856 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
10857 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
10858 "regular file). These constants are available in the standard Linux header "
10859 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
10860 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
10861 "the appropriate constant for you."
10865 #: ../src/guestfs-actions.pod:3962
10866 msgid "guestfs_mknod_b"
10870 #: ../src/guestfs-actions.pod:3964
10874 " guestfs_mknod_b (guestfs_h *g,\n"
10878 " const char *path);\n"
10883 #: ../src/guestfs-actions.pod:3971
10885 "This call creates a block device node called C<path> with mode C<mode> and "
10886 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10887 "wrapper around C<guestfs_mknod>."
10891 #: ../src/guestfs-actions.pod:3981
10892 msgid "guestfs_mknod_c"
10896 #: ../src/guestfs-actions.pod:3983
10900 " guestfs_mknod_c (guestfs_h *g,\n"
10904 " const char *path);\n"
10909 #: ../src/guestfs-actions.pod:3990
10911 "This call creates a char device node called C<path> with mode C<mode> and "
10912 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10913 "wrapper around C<guestfs_mknod>."
10917 #: ../src/guestfs-actions.pod:4000
10918 msgid "guestfs_mkswap"
10922 #: ../src/guestfs-actions.pod:4002
10926 " guestfs_mkswap (guestfs_h *g,\n"
10927 " const char *device);\n"
10932 #: ../src/guestfs-actions.pod:4006 ../fish/guestfish-actions.pod:2668
10933 msgid "Create a swap partition on C<device>."
10937 #: ../src/guestfs-actions.pod:4012
10938 msgid "guestfs_mkswap_L"
10942 #: ../src/guestfs-actions.pod:4014
10946 " guestfs_mkswap_L (guestfs_h *g,\n"
10947 " const char *label,\n"
10948 " const char *device);\n"
10953 #: ../src/guestfs-actions.pod:4019 ../fish/guestfish-actions.pod:2674
10954 msgid "Create a swap partition on C<device> with label C<label>."
10958 #: ../src/guestfs-actions.pod:4021 ../fish/guestfish-actions.pod:2676
10960 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
10961 "sda>), just to a partition. This appears to be a limitation of the kernel "
10966 #: ../src/guestfs-actions.pod:4029
10967 msgid "guestfs_mkswap_U"
10971 #: ../src/guestfs-actions.pod:4031
10975 " guestfs_mkswap_U (guestfs_h *g,\n"
10976 " const char *uuid,\n"
10977 " const char *device);\n"
10982 #: ../src/guestfs-actions.pod:4036 ../fish/guestfish-actions.pod:2684
10983 msgid "Create a swap partition on C<device> with UUID C<uuid>."
10987 #: ../src/guestfs-actions.pod:4042
10988 msgid "guestfs_mkswap_file"
10992 #: ../src/guestfs-actions.pod:4044
10996 " guestfs_mkswap_file (guestfs_h *g,\n"
10997 " const char *path);\n"
11002 #: ../src/guestfs-actions.pod:4048 ../fish/guestfish-actions.pod:2690
11003 msgid "Create a swap file."
11007 #: ../src/guestfs-actions.pod:4050
11009 "This command just writes a swap file signature to an existing file. To "
11010 "create the file itself, use something like C<guestfs_fallocate>."
11014 #: ../src/guestfs-actions.pod:4057
11015 msgid "guestfs_modprobe"
11019 #: ../src/guestfs-actions.pod:4059
11023 " guestfs_modprobe (guestfs_h *g,\n"
11024 " const char *modulename);\n"
11029 #: ../src/guestfs-actions.pod:4063 ../fish/guestfish-actions.pod:2699
11030 msgid "This loads a kernel module in the appliance."
11034 #: ../src/guestfs-actions.pod:4065 ../fish/guestfish-actions.pod:2701
11036 "The kernel module must have been whitelisted when libguestfs was built (see "
11037 "C<appliance/kmod.whitelist.in> in the source)."
11041 #: ../src/guestfs-actions.pod:4072
11042 msgid "guestfs_mount"
11046 #: ../src/guestfs-actions.pod:4074
11050 " guestfs_mount (guestfs_h *g,\n"
11051 " const char *device,\n"
11052 " const char *mountpoint);\n"
11057 #: ../src/guestfs-actions.pod:4079 ../fish/guestfish-actions.pod:2708
11059 "Mount a guest disk at a position in the filesystem. Block devices are named "
11060 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11061 "those block devices contain partitions, they will have the usual names (eg. "
11062 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11066 #: ../src/guestfs-actions.pod:4085 ../fish/guestfish-actions.pod:2714
11068 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11069 "mounted on C</> before others can be mounted. Other filesystems can only be "
11070 "mounted on directories which already exist."
11074 #: ../src/guestfs-actions.pod:4090 ../fish/guestfish-actions.pod:2719
11076 "The mounted filesystem is writable, if we have sufficient permissions on the "
11077 "underlying device."
11081 #: ../src/guestfs-actions.pod:4093
11083 "B<Important note:> When you use this call, the filesystem options C<sync> "
11084 "and C<noatime> are set implicitly. This was originally done because we "
11085 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11086 "very large negative performance impact and negligible effect on "
11087 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
11088 "in any code that needs performance, and instead use C<guestfs_mount_options> "
11089 "(use an empty string for the first parameter if you don't want any options)."
11093 #: ../src/guestfs-actions.pod:4107
11094 msgid "guestfs_mount_loop"
11098 #: ../src/guestfs-actions.pod:4109
11102 " guestfs_mount_loop (guestfs_h *g,\n"
11103 " const char *file,\n"
11104 " const char *mountpoint);\n"
11109 #: ../src/guestfs-actions.pod:4114 ../fish/guestfish-actions.pod:2736
11111 "This command lets you mount C<file> (a filesystem image in a file) on a "
11112 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11117 #: ../src/guestfs-actions.pod:4122
11118 msgid "guestfs_mount_options"
11122 #: ../src/guestfs-actions.pod:4124
11126 " guestfs_mount_options (guestfs_h *g,\n"
11127 " const char *options,\n"
11128 " const char *device,\n"
11129 " const char *mountpoint);\n"
11134 #: ../src/guestfs-actions.pod:4130
11136 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11137 "the mount options as for the L<mount(8)> I<-o> flag."
11141 #: ../src/guestfs-actions.pod:4134 ../fish/guestfish-actions.pod:2748
11143 "If the C<options> parameter is an empty string, then no options are passed "
11144 "(all options default to whatever the filesystem uses)."
11148 #: ../src/guestfs-actions.pod:4140 ../src/guestfs-actions.pod:4154
11149 #: ../src/guestfs-actions.pod:4171
11150 msgid "(Added in 1.0.10)"
11154 #: ../src/guestfs-actions.pod:4142
11155 msgid "guestfs_mount_ro"
11159 #: ../src/guestfs-actions.pod:4144
11163 " guestfs_mount_ro (guestfs_h *g,\n"
11164 " const char *device,\n"
11165 " const char *mountpoint);\n"
11170 #: ../src/guestfs-actions.pod:4149
11172 "This is the same as the C<guestfs_mount> command, but it mounts the "
11173 "filesystem with the read-only (I<-o ro>) flag."
11177 #: ../src/guestfs-actions.pod:4156
11178 msgid "guestfs_mount_vfs"
11182 #: ../src/guestfs-actions.pod:4158
11186 " guestfs_mount_vfs (guestfs_h *g,\n"
11187 " const char *options,\n"
11188 " const char *vfstype,\n"
11189 " const char *device,\n"
11190 " const char *mountpoint);\n"
11195 #: ../src/guestfs-actions.pod:4165
11197 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11198 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
11203 #: ../src/guestfs-actions.pod:4173
11204 msgid "guestfs_mountpoints"
11208 #: ../src/guestfs-actions.pod:4175
11212 " guestfs_mountpoints (guestfs_h *g);\n"
11217 #: ../src/guestfs-actions.pod:4178
11219 "This call is similar to C<guestfs_mounts>. That call returns a list of "
11220 "devices. This one returns a hash table (map) of device name to directory "
11221 "where the device is mounted."
11225 #: ../src/guestfs-actions.pod:4190
11226 msgid "guestfs_mounts"
11230 #: ../src/guestfs-actions.pod:4192
11234 " guestfs_mounts (guestfs_h *g);\n"
11239 #: ../src/guestfs-actions.pod:4195 ../fish/guestfish-actions.pod:2779
11241 "This returns the list of currently mounted filesystems. It returns the list "
11242 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11246 #: ../src/guestfs-actions.pod:4198 ../fish/guestfish-actions.pod:2782
11247 msgid "Some internal mounts are not shown."
11251 #: ../src/guestfs-actions.pod:4200
11252 msgid "See also: C<guestfs_mountpoints>"
11256 #: ../src/guestfs-actions.pod:4208
11261 #: ../src/guestfs-actions.pod:4210
11265 " guestfs_mv (guestfs_h *g,\n"
11266 " const char *src,\n"
11267 " const char *dest);\n"
11272 #: ../src/guestfs-actions.pod:4215 ../fish/guestfish-actions.pod:2790
11274 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11275 "destination filename or destination directory."
11279 #: ../src/guestfs-actions.pod:4222
11280 msgid "guestfs_ntfs_3g_probe"
11284 #: ../src/guestfs-actions.pod:4224
11288 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
11290 " const char *device);\n"
11295 #: ../src/guestfs-actions.pod:4229 ../fish/guestfish-actions.pod:2797
11297 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11298 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
11299 "write, and some cannot be mounted at all)."
11303 #: ../src/guestfs-actions.pod:4233 ../fish/guestfish-actions.pod:2801
11305 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11306 "can be mounted read-write. Set it to false if you want to test if the "
11307 "volume can be mounted read-only."
11311 #: ../src/guestfs-actions.pod:4237 ../fish/guestfish-actions.pod:2805
11313 "The return value is an integer which C<0> if the operation would succeed, or "
11314 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11318 #: ../src/guestfs-actions.pod:4243
11319 msgid "(Added in 1.0.43)"
11323 #: ../src/guestfs-actions.pod:4245
11324 msgid "guestfs_ntfsresize"
11328 #: ../src/guestfs-actions.pod:4247
11332 " guestfs_ntfsresize (guestfs_h *g,\n"
11333 " const char *device);\n"
11338 #: ../src/guestfs-actions.pod:4251 ../fish/guestfish-actions.pod:2813
11340 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
11341 "size of the underlying device. See also L<ntfsresize(8)>."
11345 #: ../src/guestfs-actions.pod:4259
11346 msgid "guestfs_ntfsresize_size"
11350 #: ../src/guestfs-actions.pod:4261
11354 " guestfs_ntfsresize_size (guestfs_h *g,\n"
11355 " const char *device,\n"
11356 " int64_t size);\n"
11361 #: ../src/guestfs-actions.pod:4266
11363 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
11364 "to specify the new size (in bytes) explicitly."
11368 #: ../src/guestfs-actions.pod:4271 ../src/guestfs-actions.pod:4708
11369 #: ../src/guestfs-actions.pod:4782 ../src/guestfs-actions.pod:5032
11370 msgid "(Added in 1.3.14)"
11374 #: ../src/guestfs-actions.pod:4273
11375 msgid "guestfs_part_add"
11379 #: ../src/guestfs-actions.pod:4275
11383 " guestfs_part_add (guestfs_h *g,\n"
11384 " const char *device,\n"
11385 " const char *prlogex,\n"
11386 " int64_t startsect,\n"
11387 " int64_t endsect);\n"
11392 #: ../src/guestfs-actions.pod:4282
11394 "This command adds a partition to C<device>. If there is no partition table "
11395 "on the device, call C<guestfs_part_init> first."
11399 #: ../src/guestfs-actions.pod:4285 ../fish/guestfish-actions.pod:2831
11401 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11402 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11403 "C<logical>) and C<e> (or C<extended>) partition types."
11407 #: ../src/guestfs-actions.pod:4290 ../fish/guestfish-actions.pod:2836
11409 "C<startsect> and C<endsect> are the start and end of the partition in "
11410 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11411 "from the end of the disk (C<-1> is the last sector)."
11415 #: ../src/guestfs-actions.pod:4294
11417 "Creating a partition which covers the whole disk is not so easy. Use "
11418 "C<guestfs_part_disk> to do that."
11422 #: ../src/guestfs-actions.pod:4299 ../src/guestfs-actions.pod:4337
11423 #: ../src/guestfs-actions.pod:4390 ../src/guestfs-actions.pod:4468
11424 #: ../src/guestfs-actions.pod:4507 ../src/guestfs-actions.pod:4526
11425 #: ../src/guestfs-actions.pod:4566
11426 msgid "(Added in 1.0.78)"
11430 #: ../src/guestfs-actions.pod:4301
11431 msgid "guestfs_part_del"
11435 #: ../src/guestfs-actions.pod:4303
11439 " guestfs_part_del (guestfs_h *g,\n"
11440 " const char *device,\n"
11446 #: ../src/guestfs-actions.pod:4308 ../fish/guestfish-actions.pod:2847
11447 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11451 #: ../src/guestfs-actions.pod:4310 ../fish/guestfish-actions.pod:2849
11453 "Note that in the case of MBR partitioning, deleting an extended partition "
11454 "also deletes any logical partitions it contains."
11458 #: ../src/guestfs-actions.pod:4318
11459 msgid "guestfs_part_disk"
11463 #: ../src/guestfs-actions.pod:4320
11467 " guestfs_part_disk (guestfs_h *g,\n"
11468 " const char *device,\n"
11469 " const char *parttype);\n"
11474 #: ../src/guestfs-actions.pod:4325
11476 "This command is simply a combination of C<guestfs_part_init> followed by "
11477 "C<guestfs_part_add> to create a single primary partition covering the whole "
11482 #: ../src/guestfs-actions.pod:4329
11484 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11485 "possible values are described in C<guestfs_part_init>."
11489 #: ../src/guestfs-actions.pod:4339
11490 msgid "guestfs_part_get_bootable"
11494 #: ../src/guestfs-actions.pod:4341
11498 " guestfs_part_get_bootable (guestfs_h *g,\n"
11499 " const char *device,\n"
11505 #: ../src/guestfs-actions.pod:4346 ../fish/guestfish-actions.pod:2871
11507 "This command returns true if the partition C<partnum> on C<device> has the "
11508 "bootable flag set."
11512 #: ../src/guestfs-actions.pod:4349
11513 msgid "See also C<guestfs_part_set_bootable>."
11517 #: ../src/guestfs-actions.pod:4355
11518 msgid "guestfs_part_get_mbr_id"
11522 #: ../src/guestfs-actions.pod:4357
11526 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
11527 " const char *device,\n"
11533 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2880
11535 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11536 "partition C<partnum>."
11540 #: ../src/guestfs-actions.pod:4365 ../src/guestfs-actions.pod:4542
11542 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11543 "undefined results for other partition table types (see "
11544 "C<guestfs_part_get_parttype>)."
11548 #: ../src/guestfs-actions.pod:4373
11549 msgid "guestfs_part_get_parttype"
11553 #: ../src/guestfs-actions.pod:4375
11557 " guestfs_part_get_parttype (guestfs_h *g,\n"
11558 " const char *device);\n"
11563 #: ../src/guestfs-actions.pod:4379 ../fish/guestfish-actions.pod:2891
11565 "This command examines the partition table on C<device> and returns the "
11566 "partition table type (format) being used."
11570 #: ../src/guestfs-actions.pod:4382
11572 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11573 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11574 "possible, although unusual. See C<guestfs_part_init> for a full list."
11578 #: ../src/guestfs-actions.pod:4392
11579 msgid "guestfs_part_init"
11583 #: ../src/guestfs-actions.pod:4394
11587 " guestfs_part_init (guestfs_h *g,\n"
11588 " const char *device,\n"
11589 " const char *parttype);\n"
11594 #: ../src/guestfs-actions.pod:4399 ../fish/guestfish-actions.pod:2903
11596 "This creates an empty partition table on C<device> of one of the partition "
11597 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11598 "(for large disks)."
11602 #: ../src/guestfs-actions.pod:4403
11604 "Initially there are no partitions. Following this, you should call "
11605 "C<guestfs_part_add> for each partition required."
11609 #: ../src/guestfs-actions.pod:4406 ../fish/guestfish-actions.pod:2910
11610 msgid "Possible values for C<parttype> are:"
11614 #: ../src/guestfs-actions.pod:4410 ../fish/guestfish-actions.pod:2914
11615 msgid "B<efi> | B<gpt>"
11619 #: ../src/guestfs-actions.pod:4412 ../fish/guestfish-actions.pod:2916
11620 msgid "Intel EFI / GPT partition table."
11624 #: ../src/guestfs-actions.pod:4414 ../fish/guestfish-actions.pod:2918
11626 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11627 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11628 "the C<mbr> format."
11632 #: ../src/guestfs-actions.pod:4418 ../fish/guestfish-actions.pod:2922
11633 msgid "B<mbr> | B<msdos>"
11637 #: ../src/guestfs-actions.pod:4420 ../fish/guestfish-actions.pod:2924
11639 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11640 "Windows. This partition type will B<only> work for device sizes up to 2 "
11641 "TB. For large disks we recommend using C<gpt>."
11645 #: ../src/guestfs-actions.pod:4427 ../fish/guestfish-actions.pod:2931
11647 "Other partition table types that may work but are not supported include:"
11651 #: ../src/guestfs-actions.pod:4432 ../fish/guestfish-actions.pod:2936
11656 #: ../src/guestfs-actions.pod:4434 ../fish/guestfish-actions.pod:2938
11657 msgid "AIX disk labels."
11661 #: ../src/guestfs-actions.pod:4436 ../fish/guestfish-actions.pod:2940
11662 msgid "B<amiga> | B<rdb>"
11666 #: ../src/guestfs-actions.pod:4438 ../fish/guestfish-actions.pod:2942
11667 msgid "Amiga \"Rigid Disk Block\" format."
11671 #: ../src/guestfs-actions.pod:4440 ../fish/guestfish-actions.pod:2944
11676 #: ../src/guestfs-actions.pod:4442 ../fish/guestfish-actions.pod:2946
11677 msgid "BSD disk labels."
11681 #: ../src/guestfs-actions.pod:4444 ../fish/guestfish-actions.pod:2948
11686 #: ../src/guestfs-actions.pod:4446 ../fish/guestfish-actions.pod:2950
11687 msgid "DASD, used on IBM mainframes."
11691 #: ../src/guestfs-actions.pod:4448 ../fish/guestfish-actions.pod:2952
11696 #: ../src/guestfs-actions.pod:4450 ../fish/guestfish-actions.pod:2954
11697 msgid "MIPS/SGI volumes."
11701 #: ../src/guestfs-actions.pod:4452 ../fish/guestfish-actions.pod:2956
11706 #: ../src/guestfs-actions.pod:4454 ../fish/guestfish-actions.pod:2958
11707 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11711 #: ../src/guestfs-actions.pod:4456 ../fish/guestfish-actions.pod:2960
11716 #: ../src/guestfs-actions.pod:4458 ../fish/guestfish-actions.pod:2962
11717 msgid "NEC PC-98 format, common in Japan apparently."
11721 #: ../src/guestfs-actions.pod:4460 ../fish/guestfish-actions.pod:2964
11726 #: ../src/guestfs-actions.pod:4462 ../fish/guestfish-actions.pod:2966
11727 msgid "Sun disk labels."
11731 #: ../src/guestfs-actions.pod:4470
11732 msgid "guestfs_part_list"
11736 #: ../src/guestfs-actions.pod:4472
11739 " struct guestfs_partition_list *\n"
11740 " guestfs_part_list (guestfs_h *g,\n"
11741 " const char *device);\n"
11746 #: ../src/guestfs-actions.pod:4476 ../fish/guestfish-actions.pod:2974
11748 "This command parses the partition table on C<device> and returns the list of "
11749 "partitions found."
11753 #: ../src/guestfs-actions.pod:4479 ../fish/guestfish-actions.pod:2977
11754 msgid "The fields in the returned structure are:"
11758 #: ../src/guestfs-actions.pod:4483 ../fish/guestfish-actions.pod:2981
11759 msgid "B<part_num>"
11763 #: ../src/guestfs-actions.pod:4485 ../fish/guestfish-actions.pod:2983
11764 msgid "Partition number, counting from 1."
11768 #: ../src/guestfs-actions.pod:4487 ../fish/guestfish-actions.pod:2985
11769 msgid "B<part_start>"
11773 #: ../src/guestfs-actions.pod:4489
11775 "Start of the partition I<in bytes>. To get sectors you have to divide by "
11776 "the device's sector size, see C<guestfs_blockdev_getss>."
11780 #: ../src/guestfs-actions.pod:4492 ../fish/guestfish-actions.pod:2990
11781 msgid "B<part_end>"
11785 #: ../src/guestfs-actions.pod:4494 ../fish/guestfish-actions.pod:2992
11786 msgid "End of the partition in bytes."
11790 #: ../src/guestfs-actions.pod:4496 ../fish/guestfish-actions.pod:2994
11791 msgid "B<part_size>"
11795 #: ../src/guestfs-actions.pod:4498 ../fish/guestfish-actions.pod:2996
11796 msgid "Size of the partition in bytes."
11800 #: ../src/guestfs-actions.pod:4502
11802 "This function returns a C<struct guestfs_partition_list *> (see E<lt>guestfs-"
11803 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
11804 "C<guestfs_free_partition_list> after use>."
11808 #: ../src/guestfs-actions.pod:4509
11809 msgid "guestfs_part_set_bootable"
11813 #: ../src/guestfs-actions.pod:4511
11817 " guestfs_part_set_bootable (guestfs_h *g,\n"
11818 " const char *device,\n"
11820 " int bootable);\n"
11825 #: ../src/guestfs-actions.pod:4517 ../fish/guestfish-actions.pod:3004
11827 "This sets the bootable flag on partition numbered C<partnum> on device "
11828 "C<device>. Note that partitions are numbered from 1."
11832 #: ../src/guestfs-actions.pod:4520 ../fish/guestfish-actions.pod:3007
11834 "The bootable flag is used by some operating systems (notably Windows) to "
11835 "determine which partition to boot from. It is by no means universally "
11840 #: ../src/guestfs-actions.pod:4528
11841 msgid "guestfs_part_set_mbr_id"
11845 #: ../src/guestfs-actions.pod:4530
11849 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
11850 " const char *device,\n"
11857 #: ../src/guestfs-actions.pod:4536 ../fish/guestfish-actions.pod:3015
11859 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
11860 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
11861 "documentation are in fact hexadecimal numbers, but usually documented "
11862 "without any leading \"0x\" which might be confusing."
11866 #: ../src/guestfs-actions.pod:4550
11867 msgid "guestfs_part_set_name"
11871 #: ../src/guestfs-actions.pod:4552
11875 " guestfs_part_set_name (guestfs_h *g,\n"
11876 " const char *device,\n"
11878 " const char *name);\n"
11883 #: ../src/guestfs-actions.pod:4558 ../fish/guestfish-actions.pod:3029
11885 "This sets the partition name on partition numbered C<partnum> on device "
11886 "C<device>. Note that partitions are numbered from 1."
11890 #: ../src/guestfs-actions.pod:4561 ../fish/guestfish-actions.pod:3032
11892 "The partition name can only be set on certain types of partition table. "
11893 "This works on C<gpt> but not on C<mbr> partitions."
11897 #: ../src/guestfs-actions.pod:4568
11898 msgid "guestfs_part_to_dev"
11902 #: ../src/guestfs-actions.pod:4570
11906 " guestfs_part_to_dev (guestfs_h *g,\n"
11907 " const char *partition);\n"
11912 #: ../src/guestfs-actions.pod:4574 ../fish/guestfish-actions.pod:3039
11914 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
11915 "partition number, returning the device name (eg. \"/dev/sdb\")."
11919 #: ../src/guestfs-actions.pod:4578
11921 "The named partition must exist, for example as a string returned from "
11922 "C<guestfs_list_partitions>."
11926 #: ../src/guestfs-actions.pod:4586
11927 msgid "guestfs_ping_daemon"
11931 #: ../src/guestfs-actions.pod:4588
11935 " guestfs_ping_daemon (guestfs_h *g);\n"
11940 #: ../src/guestfs-actions.pod:4591 ../fish/guestfish-actions.pod:3050
11942 "This is a test probe into the guestfs daemon running inside the qemu "
11943 "subprocess. Calling this function checks that the daemon responds to the "
11944 "ping message, without affecting the daemon or attached block device(s) in "
11949 #: ../src/guestfs-actions.pod:4600
11950 msgid "guestfs_pread"
11954 #: ../src/guestfs-actions.pod:4602
11958 " guestfs_pread (guestfs_h *g,\n"
11959 " const char *path,\n"
11961 " int64_t offset,\n"
11962 " size_t *size_r);\n"
11967 #: ../src/guestfs-actions.pod:4609 ../fish/guestfish-actions.pod:3059
11969 "This command lets you read part of a file. It reads C<count> bytes of the "
11970 "file, starting at C<offset>, from file C<path>."
11974 #: ../src/guestfs-actions.pod:4612 ../src/guestfs-actions.pod:4638
11975 #: ../fish/guestfish-actions.pod:3062 ../fish/guestfish-actions.pod:3077
11977 "This may read fewer bytes than requested. For further details see the "
11978 "L<pread(2)> system call."
11982 #: ../src/guestfs-actions.pod:4615
11983 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
11987 #: ../src/guestfs-actions.pod:4626
11988 msgid "guestfs_pread_device"
11992 #: ../src/guestfs-actions.pod:4628
11996 " guestfs_pread_device (guestfs_h *g,\n"
11997 " const char *device,\n"
11999 " int64_t offset,\n"
12000 " size_t *size_r);\n"
12005 #: ../src/guestfs-actions.pod:4635 ../fish/guestfish-actions.pod:3074
12007 "This command lets you read part of a file. It reads C<count> bytes of "
12008 "C<device>, starting at C<offset>."
12012 #: ../src/guestfs-actions.pod:4641
12013 msgid "See also C<guestfs_pread>."
12017 #: ../src/guestfs-actions.pod:4650
12018 msgid "(Added in 1.5.21)"
12022 #: ../src/guestfs-actions.pod:4652
12023 msgid "guestfs_pvcreate"
12027 #: ../src/guestfs-actions.pod:4654
12031 " guestfs_pvcreate (guestfs_h *g,\n"
12032 " const char *device);\n"
12037 #: ../src/guestfs-actions.pod:4658 ../fish/guestfish-actions.pod:3089
12039 "This creates an LVM physical volume on the named C<device>, where C<device> "
12040 "should usually be a partition name such as C</dev/sda1>."
12044 #: ../src/guestfs-actions.pod:4666
12045 msgid "guestfs_pvremove"
12049 #: ../src/guestfs-actions.pod:4668
12053 " guestfs_pvremove (guestfs_h *g,\n"
12054 " const char *device);\n"
12059 #: ../src/guestfs-actions.pod:4672 ../fish/guestfish-actions.pod:3097
12061 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12066 #: ../src/guestfs-actions.pod:4675 ../fish/guestfish-actions.pod:3100
12068 "The implementation uses the C<pvremove> command which refuses to wipe "
12069 "physical volumes that contain any volume groups, so you have to remove those "
12074 #: ../src/guestfs-actions.pod:4683
12075 msgid "guestfs_pvresize"
12079 #: ../src/guestfs-actions.pod:4685
12083 " guestfs_pvresize (guestfs_h *g,\n"
12084 " const char *device);\n"
12089 #: ../src/guestfs-actions.pod:4689 ../fish/guestfish-actions.pod:3108
12091 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12092 "the new size of the underlying device."
12096 #: ../src/guestfs-actions.pod:4696
12097 msgid "guestfs_pvresize_size"
12101 #: ../src/guestfs-actions.pod:4698
12105 " guestfs_pvresize_size (guestfs_h *g,\n"
12106 " const char *device,\n"
12107 " int64_t size);\n"
12112 #: ../src/guestfs-actions.pod:4703
12114 "This command is the same as C<guestfs_pvresize> except that it allows you to "
12115 "specify the new size (in bytes) explicitly."
12119 #: ../src/guestfs-actions.pod:4710
12120 msgid "guestfs_pvs"
12124 #: ../src/guestfs-actions.pod:4712
12128 " guestfs_pvs (guestfs_h *g);\n"
12133 #: ../src/guestfs-actions.pod:4715 ../fish/guestfish-actions.pod:3122
12135 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12140 #: ../src/guestfs-actions.pod:4718 ../fish/guestfish-actions.pod:3125
12142 "This returns a list of just the device names that contain PVs (eg. C</dev/"
12147 #: ../src/guestfs-actions.pod:4721
12148 msgid "See also C<guestfs_pvs_full>."
12152 #: ../src/guestfs-actions.pod:4729
12153 msgid "guestfs_pvs_full"
12157 #: ../src/guestfs-actions.pod:4731
12160 " struct guestfs_lvm_pv_list *\n"
12161 " guestfs_pvs_full (guestfs_h *g);\n"
12166 #: ../src/guestfs-actions.pod:4734 ../fish/guestfish-actions.pod:3134
12168 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12169 "(8)> command. The \"full\" version includes all fields."
12173 #: ../src/guestfs-actions.pod:4737
12175 "This function returns a C<struct guestfs_lvm_pv_list *> (see E<lt>guestfs-"
12176 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
12177 "C<guestfs_free_lvm_pv_list> after use>."
12181 #: ../src/guestfs-actions.pod:4744
12182 msgid "guestfs_pvuuid"
12186 #: ../src/guestfs-actions.pod:4746
12190 " guestfs_pvuuid (guestfs_h *g,\n"
12191 " const char *device);\n"
12196 #: ../src/guestfs-actions.pod:4750 ../fish/guestfish-actions.pod:3141
12197 msgid "This command returns the UUID of the LVM PV C<device>."
12201 #: ../src/guestfs-actions.pod:4757
12202 msgid "guestfs_pwrite"
12206 #: ../src/guestfs-actions.pod:4759
12210 " guestfs_pwrite (guestfs_h *g,\n"
12211 " const char *path,\n"
12212 " const char *content,\n"
12213 " size_t content_size,\n"
12214 " int64_t offset);\n"
12219 #: ../src/guestfs-actions.pod:4766 ../fish/guestfish-actions.pod:3147
12221 "This command writes to part of a file. It writes the data buffer C<content> "
12222 "to the file C<path> starting at offset C<offset>."
12226 #: ../src/guestfs-actions.pod:4769 ../fish/guestfish-actions.pod:3150
12228 "This command implements the L<pwrite(2)> system call, and like that system "
12229 "call it may not write the full data requested. The return value is the "
12230 "number of bytes that were actually written to the file. This could even be "
12231 "0, although short writes are unlikely for regular files in ordinary "
12236 #: ../src/guestfs-actions.pod:4775
12237 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
12241 #: ../src/guestfs-actions.pod:4784
12242 msgid "guestfs_pwrite_device"
12246 #: ../src/guestfs-actions.pod:4786
12250 " guestfs_pwrite_device (guestfs_h *g,\n"
12251 " const char *device,\n"
12252 " const char *content,\n"
12253 " size_t content_size,\n"
12254 " int64_t offset);\n"
12259 #: ../src/guestfs-actions.pod:4793 ../fish/guestfish-actions.pod:3165
12261 "This command writes to part of a device. It writes the data buffer "
12262 "C<content> to C<device> starting at offset C<offset>."
12266 #: ../src/guestfs-actions.pod:4796 ../fish/guestfish-actions.pod:3168
12268 "This command implements the L<pwrite(2)> system call, and like that system "
12269 "call it may not write the full data requested (although short writes to disk "
12270 "devices and partitions are probably impossible with standard Linux kernels)."
12274 #: ../src/guestfs-actions.pod:4801
12275 msgid "See also C<guestfs_pwrite>."
12279 #: ../src/guestfs-actions.pod:4808
12280 msgid "(Added in 1.5.20)"
12284 #: ../src/guestfs-actions.pod:4810
12285 msgid "guestfs_read_file"
12289 #: ../src/guestfs-actions.pod:4812
12293 " guestfs_read_file (guestfs_h *g,\n"
12294 " const char *path,\n"
12295 " size_t *size_r);\n"
12300 #: ../src/guestfs-actions.pod:4817 ../fish/guestfish-actions.pod:3182
12301 msgid "This calls returns the contents of the file C<path> as a buffer."
12305 #: ../src/guestfs-actions.pod:4820
12307 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
12308 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
12309 "function is limited in the total size of file that can be handled."
12313 #: ../src/guestfs-actions.pod:4832
12314 msgid "(Added in 1.0.63)"
12318 #: ../src/guestfs-actions.pod:4834
12319 msgid "guestfs_read_lines"
12323 #: ../src/guestfs-actions.pod:4836
12327 " guestfs_read_lines (guestfs_h *g,\n"
12328 " const char *path);\n"
12333 #: ../src/guestfs-actions.pod:4842 ../fish/guestfish-actions.pod:3199
12335 "The file contents are returned as a list of lines. Trailing C<LF> and "
12336 "C<CRLF> character sequences are I<not> returned."
12340 #: ../src/guestfs-actions.pod:4845
12342 "Note that this function cannot correctly handle binary files (specifically, "
12343 "files containing C<\\0> character which is treated as end of line). For "
12344 "those you need to use the C<guestfs_read_file> function which has a more "
12345 "complex interface."
12349 #: ../src/guestfs-actions.pod:4856
12350 msgid "guestfs_readdir"
12354 #: ../src/guestfs-actions.pod:4858
12357 " struct guestfs_dirent_list *\n"
12358 " guestfs_readdir (guestfs_h *g,\n"
12359 " const char *dir);\n"
12364 #: ../src/guestfs-actions.pod:4862 ../fish/guestfish-actions.pod:3211
12365 msgid "This returns the list of directory entries in directory C<dir>."
12369 #: ../src/guestfs-actions.pod:4864 ../fish/guestfish-actions.pod:3213
12371 "All entries in the directory are returned, including C<.> and C<..>. The "
12372 "entries are I<not> sorted, but returned in the same order as the underlying "
12377 #: ../src/guestfs-actions.pod:4868 ../fish/guestfish-actions.pod:3217
12379 "Also this call returns basic file type information about each file. The "
12380 "C<ftyp> field will contain one of the following characters:"
12384 #: ../src/guestfs-actions.pod:4873 ../fish/guestfish-actions.pod:3222
12389 #: ../src/guestfs-actions.pod:4875 ../fish/guestfish-actions.pod:3224
12390 msgid "Block special"
12394 #: ../src/guestfs-actions.pod:4877 ../fish/guestfish-actions.pod:3226
12399 #: ../src/guestfs-actions.pod:4879 ../fish/guestfish-actions.pod:3228
12400 msgid "Char special"
12404 #: ../src/guestfs-actions.pod:4881 ../fish/guestfish-actions.pod:3230
12409 #: ../src/guestfs-actions.pod:4883 ../fish/guestfish-actions.pod:3232
12414 #: ../src/guestfs-actions.pod:4885 ../fish/guestfish-actions.pod:3234
12419 #: ../src/guestfs-actions.pod:4887 ../fish/guestfish-actions.pod:3236
12420 msgid "FIFO (named pipe)"
12424 #: ../src/guestfs-actions.pod:4889 ../fish/guestfish-actions.pod:3238
12429 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3240
12430 msgid "Symbolic link"
12434 #: ../src/guestfs-actions.pod:4893 ../fish/guestfish-actions.pod:3242
12439 #: ../src/guestfs-actions.pod:4895 ../fish/guestfish-actions.pod:3244
12440 msgid "Regular file"
12444 #: ../src/guestfs-actions.pod:4897 ../fish/guestfish-actions.pod:3246
12449 #: ../src/guestfs-actions.pod:4899 ../fish/guestfish-actions.pod:3248
12454 #: ../src/guestfs-actions.pod:4901 ../fish/guestfish-actions.pod:3250
12459 #: ../src/guestfs-actions.pod:4903 ../fish/guestfish-actions.pod:3252
12460 msgid "Unknown file type"
12464 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3254
12469 #: ../src/guestfs-actions.pod:4907 ../fish/guestfish-actions.pod:3256
12471 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12475 #: ../src/guestfs-actions.pod:4912
12477 "This function is primarily intended for use by programs. To get a simple "
12478 "list of names, use C<guestfs_ls>. To get a printable directory for human "
12479 "consumption, use C<guestfs_ll>."
12483 #: ../src/guestfs-actions.pod:4916
12485 "This function returns a C<struct guestfs_dirent_list *> (see E<lt>guestfs-"
12486 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
12487 "C<guestfs_free_dirent_list> after use>."
12491 #: ../src/guestfs-actions.pod:4923
12492 msgid "guestfs_readlink"
12496 #: ../src/guestfs-actions.pod:4925
12500 " guestfs_readlink (guestfs_h *g,\n"
12501 " const char *path);\n"
12506 #: ../src/guestfs-actions.pod:4929 ../fish/guestfish-actions.pod:3269
12507 msgid "This command reads the target of a symbolic link."
12511 #: ../src/guestfs-actions.pod:4936
12512 msgid "guestfs_readlinklist"
12516 #: ../src/guestfs-actions.pod:4938
12520 " guestfs_readlinklist (guestfs_h *g,\n"
12521 " const char *path,\n"
12522 " char *const *names);\n"
12527 #: ../src/guestfs-actions.pod:4943 ../fish/guestfish-actions.pod:3275
12529 "This call allows you to do a C<readlink> operation on multiple files, where "
12530 "all files are in the directory C<path>. C<names> is the list of files from "
12535 #: ../src/guestfs-actions.pod:4947 ../fish/guestfish-actions.pod:3279
12537 "On return you get a list of strings, with a one-to-one correspondence to the "
12538 "C<names> list. Each string is the value of the symbolic link."
12542 #: ../src/guestfs-actions.pod:4951 ../fish/guestfish-actions.pod:3283
12544 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12545 "result string is the empty string C<\"\">. However the whole operation is "
12546 "completed even if there were C<readlink(2)> errors, and so you can call this "
12547 "function with names where you don't know if they are symbolic links already "
12548 "(albeit slightly less efficient)."
12552 #: ../src/guestfs-actions.pod:4958 ../fish/guestfish-actions.pod:3290
12554 "This call is intended for programs that want to efficiently list a directory "
12555 "contents without making many round-trips. Very long directory listings "
12556 "might cause the protocol message size to be exceeded, causing this call to "
12557 "fail. The caller must split up such requests into smaller groups of names."
12561 #: ../src/guestfs-actions.pod:4971
12562 msgid "guestfs_realpath"
12566 #: ../src/guestfs-actions.pod:4973
12570 " guestfs_realpath (guestfs_h *g,\n"
12571 " const char *path);\n"
12576 #: ../src/guestfs-actions.pod:4977 ../fish/guestfish-actions.pod:3301
12578 "Return the canonicalized absolute pathname of C<path>. The returned path "
12579 "has no C<.>, C<..> or symbolic link path elements."
12583 #: ../src/guestfs-actions.pod:4985
12584 msgid "guestfs_removexattr"
12588 #: ../src/guestfs-actions.pod:4987
12592 " guestfs_removexattr (guestfs_h *g,\n"
12593 " const char *xattr,\n"
12594 " const char *path);\n"
12599 #: ../src/guestfs-actions.pod:4992 ../fish/guestfish-actions.pod:3308
12601 "This call removes the extended attribute named C<xattr> of the file C<path>."
12605 #: ../src/guestfs-actions.pod:4995
12606 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
12610 #: ../src/guestfs-actions.pod:5001
12611 msgid "guestfs_resize2fs"
12615 #: ../src/guestfs-actions.pod:5003
12619 " guestfs_resize2fs (guestfs_h *g,\n"
12620 " const char *device);\n"
12625 #: ../src/guestfs-actions.pod:5007 ../fish/guestfish-actions.pod:3317
12627 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12628 "underlying device."
12632 #: ../src/guestfs-actions.pod:5010
12634 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
12635 "C<device> before calling this command. For unknown reasons C<resize2fs> "
12636 "sometimes gives an error about this and sometimes not. In any case, it is "
12637 "always safe to call C<guestfs_e2fsck_f> before calling this function."
12641 #: ../src/guestfs-actions.pod:5020
12642 msgid "guestfs_resize2fs_size"
12646 #: ../src/guestfs-actions.pod:5022
12650 " guestfs_resize2fs_size (guestfs_h *g,\n"
12651 " const char *device,\n"
12652 " int64_t size);\n"
12657 #: ../src/guestfs-actions.pod:5027
12659 "This command is the same as C<guestfs_resize2fs> except that it allows you "
12660 "to specify the new size (in bytes) explicitly."
12664 #: ../src/guestfs-actions.pod:5034
12669 #: ../src/guestfs-actions.pod:5036
12673 " guestfs_rm (guestfs_h *g,\n"
12674 " const char *path);\n"
12679 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3337
12680 msgid "Remove the single file C<path>."
12684 #: ../src/guestfs-actions.pod:5046
12685 msgid "guestfs_rm_rf"
12689 #: ../src/guestfs-actions.pod:5048
12693 " guestfs_rm_rf (guestfs_h *g,\n"
12694 " const char *path);\n"
12699 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3343
12701 "Remove the file or directory C<path>, recursively removing the contents if "
12702 "its a directory. This is like the C<rm -rf> shell command."
12706 #: ../src/guestfs-actions.pod:5060
12707 msgid "guestfs_rmdir"
12711 #: ../src/guestfs-actions.pod:5062
12715 " guestfs_rmdir (guestfs_h *g,\n"
12716 " const char *path);\n"
12721 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3351
12722 msgid "Remove the single directory C<path>."
12726 #: ../src/guestfs-actions.pod:5072
12727 msgid "guestfs_rmmountpoint"
12731 #: ../src/guestfs-actions.pod:5074
12735 " guestfs_rmmountpoint (guestfs_h *g,\n"
12736 " const char *exemptpath);\n"
12741 #: ../src/guestfs-actions.pod:5078
12743 "This calls removes a mountpoint that was previously created with "
12744 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
12748 #: ../src/guestfs-actions.pod:5086
12749 msgid "guestfs_scrub_device"
12753 #: ../src/guestfs-actions.pod:5088
12757 " guestfs_scrub_device (guestfs_h *g,\n"
12758 " const char *device);\n"
12763 #: ../src/guestfs-actions.pod:5092 ../fish/guestfish-actions.pod:3365
12765 "This command writes patterns over C<device> to make data retrieval more "
12770 #: ../src/guestfs-actions.pod:5095 ../src/guestfs-actions.pod:5116
12771 #: ../src/guestfs-actions.pod:5135 ../fish/guestfish-actions.pod:3368
12772 #: ../fish/guestfish-actions.pod:3383 ../fish/guestfish-actions.pod:3396
12774 "It is an interface to the L<scrub(1)> program. See that manual page for "
12779 #: ../src/guestfs-actions.pod:5103 ../src/guestfs-actions.pod:5121
12780 #: ../src/guestfs-actions.pod:5140
12781 msgid "(Added in 1.0.52)"
12785 #: ../src/guestfs-actions.pod:5105
12786 msgid "guestfs_scrub_file"
12790 #: ../src/guestfs-actions.pod:5107
12794 " guestfs_scrub_file (guestfs_h *g,\n"
12795 " const char *file);\n"
12800 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3378
12802 "This command writes patterns over a file to make data retrieval more "
12807 #: ../src/guestfs-actions.pod:5114 ../fish/guestfish-actions.pod:3381
12808 msgid "The file is I<removed> after scrubbing."
12812 #: ../src/guestfs-actions.pod:5123
12813 msgid "guestfs_scrub_freespace"
12817 #: ../src/guestfs-actions.pod:5125
12821 " guestfs_scrub_freespace (guestfs_h *g,\n"
12822 " const char *dir);\n"
12827 #: ../src/guestfs-actions.pod:5129
12829 "This command creates the directory C<dir> and then fills it with files until "
12830 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
12831 "and deletes them. The intention is to scrub any free space on the partition "
12832 "containing C<dir>."
12836 #: ../src/guestfs-actions.pod:5142
12837 msgid "guestfs_set_append"
12841 #: ../src/guestfs-actions.pod:5144
12845 " guestfs_set_append (guestfs_h *g,\n"
12846 " const char *append);\n"
12851 #: ../src/guestfs-actions.pod:5148 ../fish/guestfish-actions.pod:3405
12853 "This function is used to add additional options to the guest kernel command "
12858 #: ../src/guestfs-actions.pod:5151 ../fish/guestfish-actions.pod:3408
12860 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
12861 "environment variable."
12865 #: ../src/guestfs-actions.pod:5154 ../fish/guestfish-actions.pod:3411
12867 "Setting C<append> to C<NULL> means I<no> additional options are passed "
12868 "(libguestfs always adds a few of its own)."
12872 #: ../src/guestfs-actions.pod:5161
12873 msgid "guestfs_set_autosync"
12877 #: ../src/guestfs-actions.pod:5163
12881 " guestfs_set_autosync (guestfs_h *g,\n"
12882 " int autosync);\n"
12887 #: ../src/guestfs-actions.pod:5167
12889 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
12890 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
12891 "the handle is closed (also if the program exits without closing handles)."
12895 #: ../src/guestfs-actions.pod:5172 ../fish/guestfish-actions.pod:3425
12897 "This is enabled by default (since libguestfs 1.5.24, previously it was "
12898 "disabled by default)."
12902 #: ../src/guestfs-actions.pod:5179
12903 msgid "guestfs_set_direct"
12907 #: ../src/guestfs-actions.pod:5181
12911 " guestfs_set_direct (guestfs_h *g,\n"
12917 #: ../src/guestfs-actions.pod:5185 ../fish/guestfish-actions.pod:3434
12919 "If the direct appliance mode flag is enabled, then stdin and stdout are "
12920 "passed directly through to the appliance once it is launched."
12924 #: ../src/guestfs-actions.pod:5189
12926 "One consequence of this is that log messages aren't caught by the library "
12927 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
12932 #: ../src/guestfs-actions.pod:5193 ../fish/guestfish-actions.pod:3442
12933 msgid "You probably don't want to use this unless you know what you are doing."
12937 #: ../src/guestfs-actions.pod:5196 ../fish/guestfish-actions.pod:3445
12938 msgid "The default is disabled."
12942 #: ../src/guestfs-actions.pod:5202
12943 msgid "guestfs_set_e2label"
12947 #: ../src/guestfs-actions.pod:5204
12951 " guestfs_set_e2label (guestfs_h *g,\n"
12952 " const char *device,\n"
12953 " const char *label);\n"
12958 #: ../src/guestfs-actions.pod:5209 ../fish/guestfish-actions.pod:3451
12960 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
12961 "C<label>. Filesystem labels are limited to 16 characters."
12965 #: ../src/guestfs-actions.pod:5213
12967 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
12968 "the existing label on a filesystem."
12972 #: ../src/guestfs-actions.pod:5220
12973 msgid "guestfs_set_e2uuid"
12977 #: ../src/guestfs-actions.pod:5222
12981 " guestfs_set_e2uuid (guestfs_h *g,\n"
12982 " const char *device,\n"
12983 " const char *uuid);\n"
12988 #: ../src/guestfs-actions.pod:5227 ../fish/guestfish-actions.pod:3462
12990 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
12991 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
12992 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
12996 #: ../src/guestfs-actions.pod:5232
12998 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
12999 "the existing UUID of a filesystem."
13003 #: ../src/guestfs-actions.pod:5239
13004 msgid "guestfs_set_memsize"
13008 #: ../src/guestfs-actions.pod:5241
13012 " guestfs_set_memsize (guestfs_h *g,\n"
13018 #: ../src/guestfs-actions.pod:5245
13020 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13021 "This only has any effect if called before C<guestfs_launch>."
13025 #: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3480
13027 "You can also change this by setting the environment variable "
13028 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13032 #: ../src/guestfs-actions.pod:5260
13033 msgid "guestfs_set_network"
13037 #: ../src/guestfs-actions.pod:5262
13041 " guestfs_set_network (guestfs_h *g,\n"
13047 #: ../src/guestfs-actions.pod:5266 ../fish/guestfish-actions.pod:3493
13049 "If C<network> is true, then the network is enabled in the libguestfs "
13050 "appliance. The default is false."
13054 #: ../src/guestfs-actions.pod:5269 ../fish/guestfish-actions.pod:3496
13056 "This affects whether commands are able to access the network (see L<guestfs"
13057 "(3)/RUNNING COMMANDS>)."
13061 #: ../src/guestfs-actions.pod:5272
13063 "You must call this before calling C<guestfs_launch>, otherwise it has no "
13068 #: ../src/guestfs-actions.pod:5279
13069 msgid "guestfs_set_path"
13073 #: ../src/guestfs-actions.pod:5281
13077 " guestfs_set_path (guestfs_h *g,\n"
13078 " const char *searchpath);\n"
13083 #: ../src/guestfs-actions.pod:5285 ../fish/guestfish-actions.pod:3508
13084 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13088 #: ../src/guestfs-actions.pod:5287 ../fish/guestfish-actions.pod:3510
13090 "The default is C<$libdir/guestfs> unless overridden by setting "
13091 "C<LIBGUESTFS_PATH> environment variable."
13095 #: ../src/guestfs-actions.pod:5290 ../fish/guestfish-actions.pod:3513
13096 msgid "Setting C<path> to C<NULL> restores the default path."
13100 #: ../src/guestfs-actions.pod:5296
13101 msgid "guestfs_set_qemu"
13105 #: ../src/guestfs-actions.pod:5298
13109 " guestfs_set_qemu (guestfs_h *g,\n"
13110 " const char *qemu);\n"
13115 #: ../src/guestfs-actions.pod:5302 ../fish/guestfish-actions.pod:3521
13116 msgid "Set the qemu binary that we will use."
13120 #: ../src/guestfs-actions.pod:5304 ../fish/guestfish-actions.pod:3523
13122 "The default is chosen when the library was compiled by the configure script."
13126 #: ../src/guestfs-actions.pod:5307 ../fish/guestfish-actions.pod:3526
13128 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13133 #: ../src/guestfs-actions.pod:5310 ../fish/guestfish-actions.pod:3529
13134 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13138 #: ../src/guestfs-actions.pod:5312 ../fish/guestfish-actions.pod:3531
13140 "Note that you should call this function as early as possible after creating "
13141 "the handle. This is because some pre-launch operations depend on testing "
13142 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13143 "don't retest features, and so you might see inconsistent results. Using the "
13144 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13145 "the qemu binary at the same time as the handle is created."
13149 #: ../src/guestfs-actions.pod:5324
13150 msgid "guestfs_set_recovery_proc"
13154 #: ../src/guestfs-actions.pod:5326
13158 " guestfs_set_recovery_proc (guestfs_h *g,\n"
13159 " int recoveryproc);\n"
13164 #: ../src/guestfs-actions.pod:5330
13166 "If this is called with the parameter C<false> then C<guestfs_launch> does "
13167 "not create a recovery process. The purpose of the recovery process is to "
13168 "stop runaway qemu processes in the case where the main program aborts "
13173 #: ../src/guestfs-actions.pod:5335
13175 "This only has any effect if called before C<guestfs_launch>, and the default "
13180 #: ../src/guestfs-actions.pod:5338 ../fish/guestfish-actions.pod:3553
13182 "About the only time when you would want to disable this is if the main "
13183 "process will fork itself into the background (\"daemonize\" itself). In "
13184 "this case the recovery process thinks that the main program has disappeared "
13185 "and so kills qemu, which is not very helpful."
13189 #: ../src/guestfs-actions.pod:5348
13190 msgid "guestfs_set_selinux"
13194 #: ../src/guestfs-actions.pod:5350
13198 " guestfs_set_selinux (guestfs_h *g,\n"
13204 #: ../src/guestfs-actions.pod:5354 ../fish/guestfish-actions.pod:3565
13206 "This sets the selinux flag that is passed to the appliance at boot time. "
13207 "The default is C<selinux=0> (disabled)."
13211 #: ../src/guestfs-actions.pod:5357 ../fish/guestfish-actions.pod:3568
13213 "Note that if SELinux is enabled, it is always in Permissive mode "
13214 "(C<enforcing=0>)."
13218 #: ../src/guestfs-actions.pod:5367
13219 msgid "guestfs_set_trace"
13223 #: ../src/guestfs-actions.pod:5369
13227 " guestfs_set_trace (guestfs_h *g,\n"
13233 #: ../src/guestfs-actions.pod:5373 ../fish/guestfish-actions.pod:3580
13235 "If the command trace flag is set to 1, then commands are printed on stderr "
13236 "before they are executed in a format which is very similar to the one used "
13237 "by guestfish. In other words, you can run a program with this enabled, and "
13238 "you will get out a script which you can feed to guestfish to perform the "
13239 "same set of actions."
13243 #: ../src/guestfs-actions.pod:5380 ../fish/guestfish-actions.pod:3587
13245 "If you want to trace C API calls into libguestfs (and other libraries) then "
13246 "possibly a better way is to use the external ltrace(1) command."
13250 #: ../src/guestfs-actions.pod:5384 ../fish/guestfish-actions.pod:3591
13252 "Command traces are disabled unless the environment variable "
13253 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13257 #: ../src/guestfs-actions.pod:5391
13258 msgid "guestfs_set_verbose"
13262 #: ../src/guestfs-actions.pod:5393
13266 " guestfs_set_verbose (guestfs_h *g,\n"
13272 #: ../src/guestfs-actions.pod:5397 ../fish/guestfish-actions.pod:3600
13273 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
13277 #: ../src/guestfs-actions.pod:5399 ../fish/guestfish-actions.pod:3602
13279 "Verbose messages are disabled unless the environment variable "
13280 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13284 #: ../src/guestfs-actions.pod:5406
13285 msgid "guestfs_setcon"
13289 #: ../src/guestfs-actions.pod:5408
13293 " guestfs_setcon (guestfs_h *g,\n"
13294 " const char *context);\n"
13299 #: ../src/guestfs-actions.pod:5412 ../fish/guestfish-actions.pod:3609
13301 "This sets the SELinux security context of the daemon to the string "
13306 #: ../src/guestfs-actions.pod:5415 ../fish/guestfish-actions.pod:3612
13307 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13311 #: ../src/guestfs-actions.pod:5421
13312 msgid "guestfs_setxattr"
13316 #: ../src/guestfs-actions.pod:5423
13320 " guestfs_setxattr (guestfs_h *g,\n"
13321 " const char *xattr,\n"
13322 " const char *val,\n"
13324 " const char *path);\n"
13329 #: ../src/guestfs-actions.pod:5430 ../fish/guestfish-actions.pod:3618
13331 "This call sets the extended attribute named C<xattr> of the file C<path> to "
13332 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
13336 #: ../src/guestfs-actions.pod:5434
13337 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
13341 #: ../src/guestfs-actions.pod:5440
13342 msgid "guestfs_sfdisk"
13346 #: ../src/guestfs-actions.pod:5442
13350 " guestfs_sfdisk (guestfs_h *g,\n"
13351 " const char *device,\n"
13355 " char *const *lines);\n"
13360 #: ../src/guestfs-actions.pod:5450 ../fish/guestfish-actions.pod:3628
13362 "This is a direct interface to the L<sfdisk(8)> program for creating "
13363 "partitions on block devices."
13367 #: ../src/guestfs-actions.pod:5453 ../fish/guestfish-actions.pod:3631
13368 msgid "C<device> should be a block device, for example C</dev/sda>."
13372 #: ../src/guestfs-actions.pod:5455 ../fish/guestfish-actions.pod:3633
13374 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
13375 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
13376 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
13377 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
13378 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
13379 "the kernel) cannot work out the right geometry and you will need to tell it."
13383 #: ../src/guestfs-actions.pod:5463 ../fish/guestfish-actions.pod:3641
13385 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
13386 "refer to the L<sfdisk(8)> manpage."
13390 #: ../src/guestfs-actions.pod:5466 ../fish/guestfish-actions.pod:3644
13392 "To create a single partition occupying the whole disk, you would pass "
13393 "C<lines> as a single element list, when the single element being the string "
13398 #: ../src/guestfs-actions.pod:5470
13400 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
13404 #: ../src/guestfs-actions.pod:5480
13405 msgid "guestfs_sfdiskM"
13409 #: ../src/guestfs-actions.pod:5482
13413 " guestfs_sfdiskM (guestfs_h *g,\n"
13414 " const char *device,\n"
13415 " char *const *lines);\n"
13420 #: ../src/guestfs-actions.pod:5487
13422 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
13423 "partition sizes are specified in megabytes only (rounded to the nearest "
13424 "cylinder) and you don't need to specify the cyls, heads and sectors "
13425 "parameters which were rarely if ever used anyway."
13429 #: ../src/guestfs-actions.pod:5493
13431 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
13432 "C<guestfs_part_disk>"
13436 #: ../src/guestfs-actions.pod:5503
13437 msgid "guestfs_sfdisk_N"
13441 #: ../src/guestfs-actions.pod:5505
13445 " guestfs_sfdisk_N (guestfs_h *g,\n"
13446 " const char *device,\n"
13451 " const char *line);\n"
13456 #: ../src/guestfs-actions.pod:5514 ../fish/guestfish-actions.pod:3674
13458 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13459 "(note: C<n> counts from 1)."
13463 #: ../src/guestfs-actions.pod:5517
13465 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
13466 "for the cyls/heads/sectors parameters."
13470 #: ../src/guestfs-actions.pod:5520
13471 msgid "See also: C<guestfs_part_add>"
13475 #: ../src/guestfs-actions.pod:5529
13476 msgid "guestfs_sfdisk_disk_geometry"
13480 #: ../src/guestfs-actions.pod:5531
13484 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
13485 " const char *device);\n"
13490 #: ../src/guestfs-actions.pod:5535
13492 "This displays the disk geometry of C<device> read from the partition table. "
13493 "Especially in the case where the underlying block device has been resized, "
13494 "this can be different from the kernel's idea of the geometry (see "
13495 "C<guestfs_sfdisk_kernel_geometry>)."
13499 #: ../src/guestfs-actions.pod:5540 ../src/guestfs-actions.pod:5556
13500 #: ../fish/guestfish-actions.pod:3694 ../fish/guestfish-actions.pod:3703
13501 msgid "The result is in human-readable format, and not designed to be parsed."
13505 #: ../src/guestfs-actions.pod:5548
13506 msgid "guestfs_sfdisk_kernel_geometry"
13510 #: ../src/guestfs-actions.pod:5550
13514 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
13515 " const char *device);\n"
13520 #: ../src/guestfs-actions.pod:5554 ../fish/guestfish-actions.pod:3701
13521 msgid "This displays the kernel's idea of the geometry of C<device>."
13525 #: ../src/guestfs-actions.pod:5564
13526 msgid "guestfs_sfdisk_l"
13530 #: ../src/guestfs-actions.pod:5566
13534 " guestfs_sfdisk_l (guestfs_h *g,\n"
13535 " const char *device);\n"
13540 #: ../src/guestfs-actions.pod:5570 ../fish/guestfish-actions.pod:3710
13542 "This displays the partition table on C<device>, in the human-readable output "
13543 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13547 #: ../src/guestfs-actions.pod:5574
13548 msgid "See also: C<guestfs_part_list>"
13552 #: ../src/guestfs-actions.pod:5581
13557 #: ../src/guestfs-actions.pod:5583
13561 " guestfs_sh (guestfs_h *g,\n"
13562 " const char *command);\n"
13567 #: ../src/guestfs-actions.pod:5587 ../fish/guestfish-actions.pod:3720
13569 "This call runs a command from the guest filesystem via the guest's C</bin/"
13574 #: ../src/guestfs-actions.pod:5590
13575 msgid "This is like C<guestfs_command>, but passes the command to:"
13579 #: ../src/guestfs-actions.pod:5592 ../fish/guestfish-actions.pod:3725
13582 " /bin/sh -c \"command\"\n"
13587 #: ../src/guestfs-actions.pod:5594 ../fish/guestfish-actions.pod:3727
13589 "Depending on the guest's shell, this usually results in wildcards being "
13590 "expanded, shell expressions being interpolated and so on."
13594 #: ../src/guestfs-actions.pod:5598
13595 msgid "All the provisos about C<guestfs_command> apply to this call."
13599 #: ../src/guestfs-actions.pod:5605
13600 msgid "guestfs_sh_lines"
13604 #: ../src/guestfs-actions.pod:5607
13608 " guestfs_sh_lines (guestfs_h *g,\n"
13609 " const char *command);\n"
13614 #: ../src/guestfs-actions.pod:5611
13616 "This is the same as C<guestfs_sh>, but splits the result into a list of "
13621 #: ../src/guestfs-actions.pod:5614
13622 msgid "See also: C<guestfs_command_lines>"
13626 #: ../src/guestfs-actions.pod:5622
13627 msgid "guestfs_sleep"
13631 #: ../src/guestfs-actions.pod:5624
13635 " guestfs_sleep (guestfs_h *g,\n"
13641 #: ../src/guestfs-actions.pod:5628 ../fish/guestfish-actions.pod:3746
13642 msgid "Sleep for C<secs> seconds."
13646 #: ../src/guestfs-actions.pod:5632
13647 msgid "(Added in 1.0.41)"
13651 #: ../src/guestfs-actions.pod:5634 ../src/guestfs-structs.pod:109
13652 msgid "guestfs_stat"
13656 #: ../src/guestfs-actions.pod:5636
13659 " struct guestfs_stat *\n"
13660 " guestfs_stat (guestfs_h *g,\n"
13661 " const char *path);\n"
13666 #: ../src/guestfs-actions.pod:5642 ../fish/guestfish-actions.pod:3754
13667 msgid "This is the same as the C<stat(2)> system call."
13671 #: ../src/guestfs-actions.pod:5650 ../src/guestfs-structs.pod:135
13672 msgid "guestfs_statvfs"
13676 #: ../src/guestfs-actions.pod:5652
13679 " struct guestfs_statvfs *\n"
13680 " guestfs_statvfs (guestfs_h *g,\n"
13681 " const char *path);\n"
13686 #: ../src/guestfs-actions.pod:5656 ../fish/guestfish-actions.pod:3760
13688 "Returns file system statistics for any mounted file system. C<path> should "
13689 "be a file or directory in the mounted file system (typically it is the mount "
13690 "point itself, but it doesn't need to be)."
13694 #: ../src/guestfs-actions.pod:5660 ../fish/guestfish-actions.pod:3764
13695 msgid "This is the same as the C<statvfs(2)> system call."
13699 #: ../src/guestfs-actions.pod:5662
13701 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
13702 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
13706 #: ../src/guestfs-actions.pod:5668
13707 msgid "guestfs_strings"
13711 #: ../src/guestfs-actions.pod:5670
13715 " guestfs_strings (guestfs_h *g,\n"
13716 " const char *path);\n"
13721 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3770
13723 "This runs the L<strings(1)> command on a file and returns the list of "
13724 "printable strings found."
13728 #: ../src/guestfs-actions.pod:5686
13729 msgid "guestfs_strings_e"
13733 #: ../src/guestfs-actions.pod:5688
13737 " guestfs_strings_e (guestfs_h *g,\n"
13738 " const char *encoding,\n"
13739 " const char *path);\n"
13744 #: ../src/guestfs-actions.pod:5693
13746 "This is like the C<guestfs_strings> command, but allows you to specify the "
13747 "encoding of strings that are looked for in the source file C<path>."
13751 #: ../src/guestfs-actions.pod:5697 ../fish/guestfish-actions.pod:3784
13752 msgid "Allowed encodings are:"
13756 #: ../src/guestfs-actions.pod:5701 ../fish/guestfish-actions.pod:3788
13761 #: ../src/guestfs-actions.pod:5703
13763 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13764 "ISO-8859-X (this is what C<guestfs_strings> uses)."
13768 #: ../src/guestfs-actions.pod:5706 ../fish/guestfish-actions.pod:3793
13773 #: ../src/guestfs-actions.pod:5708 ../fish/guestfish-actions.pod:3795
13774 msgid "Single 8-bit-byte characters."
13778 #: ../src/guestfs-actions.pod:5710 ../fish/guestfish-actions.pod:3797
13783 #: ../src/guestfs-actions.pod:5712 ../fish/guestfish-actions.pod:3799
13784 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13788 #: ../src/guestfs-actions.pod:5715 ../fish/guestfish-actions.pod:3802
13789 msgid "l (lower case letter L)"
13793 #: ../src/guestfs-actions.pod:5717 ../fish/guestfish-actions.pod:3804
13795 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
13796 "examining binaries in Windows guests."
13800 #: ../src/guestfs-actions.pod:5720 ../fish/guestfish-actions.pod:3807
13805 #: ../src/guestfs-actions.pod:5722 ../fish/guestfish-actions.pod:3809
13806 msgid "32-bit big endian such as UCS-4BE."
13810 #: ../src/guestfs-actions.pod:5724 ../fish/guestfish-actions.pod:3811
13815 #: ../src/guestfs-actions.pod:5726 ../fish/guestfish-actions.pod:3813
13816 msgid "32-bit little endian such as UCS-4LE."
13820 #: ../src/guestfs-actions.pod:5730 ../fish/guestfish-actions.pod:3817
13821 msgid "The returned strings are transcoded to UTF-8."
13825 #: ../src/guestfs-actions.pod:5741
13826 msgid "guestfs_swapoff_device"
13830 #: ../src/guestfs-actions.pod:5743
13834 " guestfs_swapoff_device (guestfs_h *g,\n"
13835 " const char *device);\n"
13840 #: ../src/guestfs-actions.pod:5747
13842 "This command disables the libguestfs appliance swap device or partition "
13843 "named C<device>. See C<guestfs_swapon_device>."
13847 #: ../src/guestfs-actions.pod:5755
13848 msgid "guestfs_swapoff_file"
13852 #: ../src/guestfs-actions.pod:5757
13856 " guestfs_swapoff_file (guestfs_h *g,\n"
13857 " const char *file);\n"
13862 #: ../src/guestfs-actions.pod:5761 ../fish/guestfish-actions.pod:3834
13863 msgid "This command disables the libguestfs appliance swap on file."
13867 #: ../src/guestfs-actions.pod:5767
13868 msgid "guestfs_swapoff_label"
13872 #: ../src/guestfs-actions.pod:5769
13876 " guestfs_swapoff_label (guestfs_h *g,\n"
13877 " const char *label);\n"
13882 #: ../src/guestfs-actions.pod:5773 ../fish/guestfish-actions.pod:3840
13884 "This command disables the libguestfs appliance swap on labeled swap "
13889 #: ../src/guestfs-actions.pod:5780
13890 msgid "guestfs_swapoff_uuid"
13894 #: ../src/guestfs-actions.pod:5782
13898 " guestfs_swapoff_uuid (guestfs_h *g,\n"
13899 " const char *uuid);\n"
13904 #: ../src/guestfs-actions.pod:5786 ../fish/guestfish-actions.pod:3847
13906 "This command disables the libguestfs appliance swap partition with the given "
13911 #: ../src/guestfs-actions.pod:5793
13912 msgid "guestfs_swapon_device"
13916 #: ../src/guestfs-actions.pod:5795
13920 " guestfs_swapon_device (guestfs_h *g,\n"
13921 " const char *device);\n"
13926 #: ../src/guestfs-actions.pod:5799
13928 "This command enables the libguestfs appliance to use the swap device or "
13929 "partition named C<device>. The increased memory is made available for all "
13930 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
13934 #: ../src/guestfs-actions.pod:5804 ../fish/guestfish-actions.pod:3859
13936 "Note that you should not swap to existing guest swap partitions unless you "
13937 "know what you are doing. They may contain hibernation information, or other "
13938 "information that the guest doesn't want you to trash. You also risk leaking "
13939 "information about the host to the guest this way. Instead, attach a new "
13940 "host device to the guest and swap on that."
13944 #: ../src/guestfs-actions.pod:5815
13945 msgid "guestfs_swapon_file"
13949 #: ../src/guestfs-actions.pod:5817
13953 " guestfs_swapon_file (guestfs_h *g,\n"
13954 " const char *file);\n"
13959 #: ../src/guestfs-actions.pod:5821
13961 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
13966 #: ../src/guestfs-actions.pod:5828
13967 msgid "guestfs_swapon_label"
13971 #: ../src/guestfs-actions.pod:5830
13975 " guestfs_swapon_label (guestfs_h *g,\n"
13976 " const char *label);\n"
13981 #: ../src/guestfs-actions.pod:5834
13983 "This command enables swap to a labeled swap partition. See "
13984 "C<guestfs_swapon_device> for other notes."
13988 #: ../src/guestfs-actions.pod:5841
13989 msgid "guestfs_swapon_uuid"
13993 #: ../src/guestfs-actions.pod:5843
13997 " guestfs_swapon_uuid (guestfs_h *g,\n"
13998 " const char *uuid);\n"
14003 #: ../src/guestfs-actions.pod:5847
14005 "This command enables swap to a swap partition with the given UUID. See "
14006 "C<guestfs_swapon_device> for other notes."
14010 #: ../src/guestfs-actions.pod:5854
14011 msgid "guestfs_sync"
14015 #: ../src/guestfs-actions.pod:5856
14019 " guestfs_sync (guestfs_h *g);\n"
14024 #: ../src/guestfs-actions.pod:5859 ../fish/guestfish-actions.pod:3891
14026 "This syncs the disk, so that any writes are flushed through to the "
14027 "underlying disk image."
14031 #: ../src/guestfs-actions.pod:5862 ../fish/guestfish-actions.pod:3894
14033 "You should always call this if you have modified a disk image, before "
14034 "closing the handle."
14038 #: ../src/guestfs-actions.pod:5869
14039 msgid "guestfs_tail"
14043 #: ../src/guestfs-actions.pod:5871
14047 " guestfs_tail (guestfs_h *g,\n"
14048 " const char *path);\n"
14053 #: ../src/guestfs-actions.pod:5875 ../fish/guestfish-actions.pod:3901
14055 "This command returns up to the last 10 lines of a file as a list of strings."
14059 #: ../src/guestfs-actions.pod:5887
14060 msgid "guestfs_tail_n"
14064 #: ../src/guestfs-actions.pod:5889
14068 " guestfs_tail_n (guestfs_h *g,\n"
14070 " const char *path);\n"
14075 #: ../src/guestfs-actions.pod:5894 ../fish/guestfish-actions.pod:3911
14077 "If the parameter C<nrlines> is a positive number, this returns the last "
14078 "C<nrlines> lines of the file C<path>."
14082 #: ../src/guestfs-actions.pod:5897 ../fish/guestfish-actions.pod:3914
14084 "If the parameter C<nrlines> is a negative number, this returns lines from "
14085 "the file C<path>, starting with the C<-nrlines>th line."
14089 #: ../src/guestfs-actions.pod:5911
14090 msgid "guestfs_tar_in"
14094 #: ../src/guestfs-actions.pod:5913
14098 " guestfs_tar_in (guestfs_h *g,\n"
14099 " const char *tarfile,\n"
14100 " const char *directory);\n"
14105 #: ../src/guestfs-actions.pod:5918 ../fish/guestfish-actions.pod:3926
14107 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14108 "tar file) into C<directory>."
14112 #: ../src/guestfs-actions.pod:5921
14114 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
14118 #: ../src/guestfs-actions.pod:5926 ../src/guestfs-actions.pod:5943
14119 #: ../src/guestfs-actions.pod:5959 ../src/guestfs-actions.pod:5975
14120 msgid "(Added in 1.0.3)"
14124 #: ../src/guestfs-actions.pod:5928
14125 msgid "guestfs_tar_out"
14129 #: ../src/guestfs-actions.pod:5930
14133 " guestfs_tar_out (guestfs_h *g,\n"
14134 " const char *directory,\n"
14135 " const char *tarfile);\n"
14140 #: ../src/guestfs-actions.pod:5935 ../fish/guestfish-actions.pod:3938
14142 "This command packs the contents of C<directory> and downloads it to local "
14147 #: ../src/guestfs-actions.pod:5938
14149 "To download a compressed tarball, use C<guestfs_tgz_out> or "
14150 "C<guestfs_txz_out>."
14154 #: ../src/guestfs-actions.pod:5945
14155 msgid "guestfs_tgz_in"
14159 #: ../src/guestfs-actions.pod:5947
14163 " guestfs_tgz_in (guestfs_h *g,\n"
14164 " const char *tarball,\n"
14165 " const char *directory);\n"
14170 #: ../src/guestfs-actions.pod:5952 ../fish/guestfish-actions.pod:3950
14172 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14173 "tar file) into C<directory>."
14177 #: ../src/guestfs-actions.pod:5955
14178 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
14182 #: ../src/guestfs-actions.pod:5961
14183 msgid "guestfs_tgz_out"
14187 #: ../src/guestfs-actions.pod:5963
14191 " guestfs_tgz_out (guestfs_h *g,\n"
14192 " const char *directory,\n"
14193 " const char *tarball);\n"
14198 #: ../src/guestfs-actions.pod:5968 ../fish/guestfish-actions.pod:3961
14200 "This command packs the contents of C<directory> and downloads it to local "
14205 #: ../src/guestfs-actions.pod:5971
14206 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
14210 #: ../src/guestfs-actions.pod:5977
14211 msgid "guestfs_touch"
14215 #: ../src/guestfs-actions.pod:5979
14219 " guestfs_touch (guestfs_h *g,\n"
14220 " const char *path);\n"
14225 #: ../src/guestfs-actions.pod:5983 ../fish/guestfish-actions.pod:3972
14227 "Touch acts like the L<touch(1)> command. It can be used to update the "
14228 "timestamps on a file, or, if the file does not exist, to create a new zero-"
14233 #: ../src/guestfs-actions.pod:5987 ../fish/guestfish-actions.pod:3976
14235 "This command only works on regular files, and will fail on other file types "
14236 "such as directories, symbolic links, block special etc."
14240 #: ../src/guestfs-actions.pod:5994
14241 msgid "guestfs_truncate"
14245 #: ../src/guestfs-actions.pod:5996
14249 " guestfs_truncate (guestfs_h *g,\n"
14250 " const char *path);\n"
14255 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:3983
14257 "This command truncates C<path> to a zero-length file. The file must exist "
14262 #: ../src/guestfs-actions.pod:6007
14263 msgid "guestfs_truncate_size"
14267 #: ../src/guestfs-actions.pod:6009
14271 " guestfs_truncate_size (guestfs_h *g,\n"
14272 " const char *path,\n"
14273 " int64_t size);\n"
14278 #: ../src/guestfs-actions.pod:6014 ../fish/guestfish-actions.pod:3990
14280 "This command truncates C<path> to size C<size> bytes. The file must exist "
14285 #: ../src/guestfs-actions.pod:6017
14287 "If the current file size is less than C<size> then the file is extended to "
14288 "the required size with zero bytes. This creates a sparse file (ie. disk "
14289 "blocks are not allocated for the file until you write to it). To create a "
14290 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
14294 #: ../src/guestfs-actions.pod:6027
14295 msgid "guestfs_tune2fs_l"
14299 #: ../src/guestfs-actions.pod:6029
14303 " guestfs_tune2fs_l (guestfs_h *g,\n"
14304 " const char *device);\n"
14309 #: ../src/guestfs-actions.pod:6033 ../fish/guestfish-actions.pod:4003
14311 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14316 #: ../src/guestfs-actions.pod:6036 ../fish/guestfish-actions.pod:4006
14318 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
14319 "for more details. The list of fields returned isn't clearly defined, and "
14320 "depends on both the version of C<tune2fs> that libguestfs was built against, "
14321 "and the filesystem itself."
14325 #: ../src/guestfs-actions.pod:6049
14326 msgid "guestfs_txz_in"
14330 #: ../src/guestfs-actions.pod:6051
14334 " guestfs_txz_in (guestfs_h *g,\n"
14335 " const char *tarball,\n"
14336 " const char *directory);\n"
14341 #: ../src/guestfs-actions.pod:6056 ../fish/guestfish-actions.pod:4015
14343 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
14344 "tar file) into C<directory>."
14348 #: ../src/guestfs-actions.pod:6063
14349 msgid "guestfs_txz_out"
14353 #: ../src/guestfs-actions.pod:6065
14357 " guestfs_txz_out (guestfs_h *g,\n"
14358 " const char *directory,\n"
14359 " const char *tarball);\n"
14364 #: ../src/guestfs-actions.pod:6070 ../fish/guestfish-actions.pod:4024
14366 "This command packs the contents of C<directory> and downloads it to local "
14367 "file C<tarball> (as an xz compressed tar archive)."
14371 #: ../src/guestfs-actions.pod:6077
14372 msgid "guestfs_umask"
14376 #: ../src/guestfs-actions.pod:6079
14380 " guestfs_umask (guestfs_h *g,\n"
14386 #: ../src/guestfs-actions.pod:6083 ../fish/guestfish-actions.pod:4033
14388 "This function sets the mask used for creating new files and device nodes to "
14393 #: ../src/guestfs-actions.pod:6086 ../fish/guestfish-actions.pod:4036
14395 "Typical umask values would be C<022> which creates new files with "
14396 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
14397 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
14401 #: ../src/guestfs-actions.pod:6091 ../fish/guestfish-actions.pod:4041
14403 "The default umask is C<022>. This is important because it means that "
14404 "directories and device nodes will be created with C<0644> or C<0755> mode "
14405 "even if you specify C<0777>."
14409 #: ../src/guestfs-actions.pod:6095
14411 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
14412 "C<guestfs_mkdir>."
14416 #: ../src/guestfs-actions.pod:6098 ../fish/guestfish-actions.pod:4048
14417 msgid "This call returns the previous umask."
14421 #: ../src/guestfs-actions.pod:6104
14422 msgid "guestfs_umount"
14426 #: ../src/guestfs-actions.pod:6106
14430 " guestfs_umount (guestfs_h *g,\n"
14431 " const char *pathordevice);\n"
14436 #: ../src/guestfs-actions.pod:6110 ../fish/guestfish-actions.pod:4056
14438 "This unmounts the given filesystem. The filesystem may be specified either "
14439 "by its mountpoint (path) or the device which contains the filesystem."
14443 #: ../src/guestfs-actions.pod:6118
14444 msgid "guestfs_umount_all"
14448 #: ../src/guestfs-actions.pod:6120
14452 " guestfs_umount_all (guestfs_h *g);\n"
14457 #: ../src/guestfs-actions.pod:6123 ../fish/guestfish-actions.pod:4066
14458 msgid "This unmounts all mounted filesystems."
14462 #: ../src/guestfs-actions.pod:6125 ../fish/guestfish-actions.pod:4068
14463 msgid "Some internal mounts are not unmounted by this call."
14467 #: ../src/guestfs-actions.pod:6131
14468 msgid "guestfs_upload"
14472 #: ../src/guestfs-actions.pod:6133
14476 " guestfs_upload (guestfs_h *g,\n"
14477 " const char *filename,\n"
14478 " const char *remotefilename);\n"
14483 #: ../src/guestfs-actions.pod:6138 ../src/guestfs-actions.pod:6157
14484 #: ../fish/guestfish-actions.pod:4074 ../fish/guestfish-actions.pod:4087
14485 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14489 #: ../src/guestfs-actions.pod:6143
14490 msgid "See also C<guestfs_download>."
14494 #: ../src/guestfs-actions.pod:6149
14495 msgid "guestfs_upload_offset"
14499 #: ../src/guestfs-actions.pod:6151
14503 " guestfs_upload_offset (guestfs_h *g,\n"
14504 " const char *filename,\n"
14505 " const char *remotefilename,\n"
14506 " int64_t offset);\n"
14511 #: ../src/guestfs-actions.pod:6160 ../fish/guestfish-actions.pod:4090
14513 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14514 "The intention is to overwrite parts of existing files or devices, although "
14515 "if a non-existant file is specified then it is created with a \"hole\" "
14516 "before C<offset>. The size of the data written is implicit in the size of "
14517 "the source C<filename>."
14521 #: ../src/guestfs-actions.pod:6167
14523 "Note that there is no limit on the amount of data that can be uploaded with "
14524 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
14525 "full amount unless an error occurs."
14529 #: ../src/guestfs-actions.pod:6172
14530 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
14534 #: ../src/guestfs-actions.pod:6178
14535 msgid "guestfs_utimens"
14539 #: ../src/guestfs-actions.pod:6180
14543 " guestfs_utimens (guestfs_h *g,\n"
14544 " const char *path,\n"
14545 " int64_t atsecs,\n"
14546 " int64_t atnsecs,\n"
14547 " int64_t mtsecs,\n"
14548 " int64_t mtnsecs);\n"
14553 #: ../src/guestfs-actions.pod:6188 ../fish/guestfish-actions.pod:4110
14554 msgid "This command sets the timestamps of a file with nanosecond precision."
14558 #: ../src/guestfs-actions.pod:6191 ../fish/guestfish-actions.pod:4113
14560 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14565 #: ../src/guestfs-actions.pod:6194 ../fish/guestfish-actions.pod:4116
14567 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14568 "nanoseconds from the epoch."
14572 #: ../src/guestfs-actions.pod:6197 ../fish/guestfish-actions.pod:4119
14574 "If the C<*nsecs> field contains the special value C<-1> then the "
14575 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14576 "ignored in this case)."
14580 #: ../src/guestfs-actions.pod:6201 ../fish/guestfish-actions.pod:4123
14582 "If the C<*nsecs> field contains the special value C<-2> then the "
14583 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14588 #: ../src/guestfs-actions.pod:6209 ../src/guestfs-structs.pod:175
14589 msgid "guestfs_version"
14593 #: ../src/guestfs-actions.pod:6211
14596 " struct guestfs_version *\n"
14597 " guestfs_version (guestfs_h *g);\n"
14602 #: ../src/guestfs-actions.pod:6214 ../fish/guestfish-actions.pod:4131
14604 "Return the libguestfs version number that the program is linked against."
14608 #: ../src/guestfs-actions.pod:6217 ../fish/guestfish-actions.pod:4134
14610 "Note that because of dynamic linking this is not necessarily the version of "
14611 "libguestfs that you compiled against. You can compile the program, and then "
14612 "at runtime dynamically link against a completely different C<libguestfs.so> "
14617 #: ../src/guestfs-actions.pod:6222 ../fish/guestfish-actions.pod:4139
14619 "This call was added in version C<1.0.58>. In previous versions of "
14620 "libguestfs there was no way to get the version number. From C code you can "
14621 "use dynamic linker functions to find out if this symbol exists (if it "
14622 "doesn't, then it's an earlier version)."
14626 #: ../src/guestfs-actions.pod:6228 ../fish/guestfish-actions.pod:4145
14628 "The call returns a structure with four elements. The first three (C<major>, "
14629 "C<minor> and C<release>) are numbers and correspond to the usual version "
14630 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14631 "but may be used for distro-specific information."
14635 #: ../src/guestfs-actions.pod:6234 ../fish/guestfish-actions.pod:4151
14637 "To construct the original version string: C<$major.$minor.$release$extra>"
14641 #: ../src/guestfs-actions.pod:6237 ../fish/guestfish-actions.pod:4154
14642 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14646 #: ../src/guestfs-actions.pod:6239
14648 "I<Note:> Don't use this call to test for availability of features. In "
14649 "enterprise distributions we backport features from later versions into "
14650 "earlier versions, making this an unreliable way to test for features. Use "
14651 "C<guestfs_available> instead."
14655 #: ../src/guestfs-actions.pod:6245
14657 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
14658 "error. I<The caller must call C<guestfs_free_version> after use>."
14662 #: ../src/guestfs-actions.pod:6249
14663 msgid "(Added in 1.0.58)"
14667 #: ../src/guestfs-actions.pod:6251
14668 msgid "guestfs_vfs_label"
14672 #: ../src/guestfs-actions.pod:6253
14676 " guestfs_vfs_label (guestfs_h *g,\n"
14677 " const char *device);\n"
14682 #: ../src/guestfs-actions.pod:6257 ../fish/guestfish-actions.pod:4166
14683 msgid "This returns the filesystem label of the filesystem on C<device>."
14687 #: ../src/guestfs-actions.pod:6260 ../fish/guestfish-actions.pod:4169
14688 msgid "If the filesystem is unlabeled, this returns the empty string."
14692 #: ../src/guestfs-actions.pod:6262
14693 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
14697 #: ../src/guestfs-actions.pod:6267 ../src/guestfs-actions.pod:6304
14698 msgid "(Added in 1.3.18)"
14702 #: ../src/guestfs-actions.pod:6269
14703 msgid "guestfs_vfs_type"
14707 #: ../src/guestfs-actions.pod:6271
14711 " guestfs_vfs_type (guestfs_h *g,\n"
14712 " const char *device);\n"
14717 #: ../src/guestfs-actions.pod:6275 ../fish/guestfish-actions.pod:4177
14719 "This command gets the filesystem type corresponding to the filesystem on "
14724 #: ../src/guestfs-actions.pod:6278 ../fish/guestfish-actions.pod:4180
14726 "For most filesystems, the result is the name of the Linux VFS module which "
14727 "would be used to mount this filesystem if you mounted it without specifying "
14728 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14732 #: ../src/guestfs-actions.pod:6288
14733 msgid "guestfs_vfs_uuid"
14737 #: ../src/guestfs-actions.pod:6290
14741 " guestfs_vfs_uuid (guestfs_h *g,\n"
14742 " const char *device);\n"
14747 #: ../src/guestfs-actions.pod:6294 ../fish/guestfish-actions.pod:4189
14748 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14752 #: ../src/guestfs-actions.pod:6297 ../fish/guestfish-actions.pod:4192
14753 msgid "If the filesystem does not have a UUID, this returns the empty string."
14757 #: ../src/guestfs-actions.pod:6299
14758 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
14762 #: ../src/guestfs-actions.pod:6306
14763 msgid "guestfs_vg_activate"
14767 #: ../src/guestfs-actions.pod:6308
14771 " guestfs_vg_activate (guestfs_h *g,\n"
14773 " char *const *volgroups);\n"
14778 #: ../src/guestfs-actions.pod:6313 ../fish/guestfish-actions.pod:4200
14780 "This command activates or (if C<activate> is false) deactivates all logical "
14781 "volumes in the listed volume groups C<volgroups>. If activated, then they "
14782 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
14783 "deactivated, then those devices disappear."
14787 #: ../src/guestfs-actions.pod:6319 ../fish/guestfish-actions.pod:4206
14788 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14792 #: ../src/guestfs-actions.pod:6321 ../fish/guestfish-actions.pod:4208
14794 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14795 "activated or deactivated."
14799 #: ../src/guestfs-actions.pod:6328
14800 msgid "guestfs_vg_activate_all"
14804 #: ../src/guestfs-actions.pod:6330
14808 " guestfs_vg_activate_all (guestfs_h *g,\n"
14809 " int activate);\n"
14814 #: ../src/guestfs-actions.pod:6334 ../fish/guestfish-actions.pod:4215
14816 "This command activates or (if C<activate> is false) deactivates all logical "
14817 "volumes in all volume groups. If activated, then they are made known to the "
14818 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
14819 "those devices disappear."
14823 #: ../src/guestfs-actions.pod:6340 ../fish/guestfish-actions.pod:4221
14824 msgid "This command is the same as running C<vgchange -a y|n>"
14828 #: ../src/guestfs-actions.pod:6346
14829 msgid "guestfs_vgcreate"
14833 #: ../src/guestfs-actions.pod:6348
14837 " guestfs_vgcreate (guestfs_h *g,\n"
14838 " const char *volgroup,\n"
14839 " char *const *physvols);\n"
14844 #: ../src/guestfs-actions.pod:6353 ../fish/guestfish-actions.pod:4227
14846 "This creates an LVM volume group called C<volgroup> from the non-empty list "
14847 "of physical volumes C<physvols>."
14851 #: ../src/guestfs-actions.pod:6360
14852 msgid "guestfs_vglvuuids"
14856 #: ../src/guestfs-actions.pod:6362
14860 " guestfs_vglvuuids (guestfs_h *g,\n"
14861 " const char *vgname);\n"
14866 #: ../src/guestfs-actions.pod:6366 ../fish/guestfish-actions.pod:4234
14868 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
14869 "volumes created in this volume group."
14873 #: ../src/guestfs-actions.pod:6369
14875 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
14876 "associate logical volumes and volume groups."
14880 #: ../src/guestfs-actions.pod:6372
14881 msgid "See also C<guestfs_vgpvuuids>."
14885 #: ../src/guestfs-actions.pod:6380
14886 msgid "guestfs_vgpvuuids"
14890 #: ../src/guestfs-actions.pod:6382
14894 " guestfs_vgpvuuids (guestfs_h *g,\n"
14895 " const char *vgname);\n"
14900 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4246
14902 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
14903 "volumes that this volume group resides on."
14907 #: ../src/guestfs-actions.pod:6389
14909 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
14910 "associate physical volumes and volume groups."
14914 #: ../src/guestfs-actions.pod:6392
14915 msgid "See also C<guestfs_vglvuuids>."
14919 #: ../src/guestfs-actions.pod:6400
14920 msgid "guestfs_vgremove"
14924 #: ../src/guestfs-actions.pod:6402
14928 " guestfs_vgremove (guestfs_h *g,\n"
14929 " const char *vgname);\n"
14934 #: ../src/guestfs-actions.pod:6406 ../fish/guestfish-actions.pod:4258
14935 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
14939 #: ../src/guestfs-actions.pod:6408 ../fish/guestfish-actions.pod:4260
14941 "This also forcibly removes all logical volumes in the volume group (if any)."
14945 #: ../src/guestfs-actions.pod:6415
14946 msgid "guestfs_vgrename"
14950 #: ../src/guestfs-actions.pod:6417
14954 " guestfs_vgrename (guestfs_h *g,\n"
14955 " const char *volgroup,\n"
14956 " const char *newvolgroup);\n"
14961 #: ../src/guestfs-actions.pod:6422 ../fish/guestfish-actions.pod:4267
14962 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
14966 #: ../src/guestfs-actions.pod:6428
14967 msgid "guestfs_vgs"
14971 #: ../src/guestfs-actions.pod:6430
14975 " guestfs_vgs (guestfs_h *g);\n"
14980 #: ../src/guestfs-actions.pod:6433 ../fish/guestfish-actions.pod:4273
14982 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
14987 #: ../src/guestfs-actions.pod:6436 ../fish/guestfish-actions.pod:4276
14989 "This returns a list of just the volume group names that were detected (eg. "
14994 #: ../src/guestfs-actions.pod:6439
14995 msgid "See also C<guestfs_vgs_full>."
14999 #: ../src/guestfs-actions.pod:6447
15000 msgid "guestfs_vgs_full"
15004 #: ../src/guestfs-actions.pod:6449
15007 " struct guestfs_lvm_vg_list *\n"
15008 " guestfs_vgs_full (guestfs_h *g);\n"
15013 #: ../src/guestfs-actions.pod:6452 ../fish/guestfish-actions.pod:4285
15015 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15016 "> command. The \"full\" version includes all fields."
15020 #: ../src/guestfs-actions.pod:6455
15022 "This function returns a C<struct guestfs_lvm_vg_list *> (see E<lt>guestfs-"
15023 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
15024 "C<guestfs_free_lvm_vg_list> after use>."
15028 #: ../src/guestfs-actions.pod:6462
15029 msgid "guestfs_vgscan"
15033 #: ../src/guestfs-actions.pod:6464
15037 " guestfs_vgscan (guestfs_h *g);\n"
15042 #: ../src/guestfs-actions.pod:6467 ../fish/guestfish-actions.pod:4292
15044 "This rescans all block devices and rebuilds the list of LVM physical "
15045 "volumes, volume groups and logical volumes."
15049 #: ../src/guestfs-actions.pod:6474
15050 msgid "guestfs_vguuid"
15054 #: ../src/guestfs-actions.pod:6476
15058 " guestfs_vguuid (guestfs_h *g,\n"
15059 " const char *vgname);\n"
15064 #: ../src/guestfs-actions.pod:6480 ../fish/guestfish-actions.pod:4299
15065 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15069 #: ../src/guestfs-actions.pod:6487
15070 msgid "guestfs_wait_ready"
15074 #: ../src/guestfs-actions.pod:6489
15078 " guestfs_wait_ready (guestfs_h *g);\n"
15083 #: ../src/guestfs-actions.pod:6492
15084 msgid "This function is a no op."
15088 #: ../src/guestfs-actions.pod:6494
15090 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
15091 "calling C<guestfs_launch> to wait for the launch to complete. However this "
15092 "is no longer necessary because C<guestfs_launch> now does the waiting."
15096 #: ../src/guestfs-actions.pod:6499
15098 "If you see any calls to this function in code then you can just remove them, "
15099 "unless you want to retain compatibility with older versions of the API."
15103 #: ../src/guestfs-actions.pod:6507
15104 msgid "guestfs_wc_c"
15108 #: ../src/guestfs-actions.pod:6509
15112 " guestfs_wc_c (guestfs_h *g,\n"
15113 " const char *path);\n"
15118 #: ../src/guestfs-actions.pod:6513 ../fish/guestfish-actions.pod:4305
15120 "This command counts the characters in a file, using the C<wc -c> external "
15125 #: ../src/guestfs-actions.pod:6520
15126 msgid "guestfs_wc_l"
15130 #: ../src/guestfs-actions.pod:6522
15134 " guestfs_wc_l (guestfs_h *g,\n"
15135 " const char *path);\n"
15140 #: ../src/guestfs-actions.pod:6526 ../fish/guestfish-actions.pod:4312
15142 "This command counts the lines in a file, using the C<wc -l> external command."
15146 #: ../src/guestfs-actions.pod:6533
15147 msgid "guestfs_wc_w"
15151 #: ../src/guestfs-actions.pod:6535
15155 " guestfs_wc_w (guestfs_h *g,\n"
15156 " const char *path);\n"
15161 #: ../src/guestfs-actions.pod:6539 ../fish/guestfish-actions.pod:4319
15163 "This command counts the words in a file, using the C<wc -w> external command."
15167 #: ../src/guestfs-actions.pod:6546
15168 msgid "guestfs_write"
15172 #: ../src/guestfs-actions.pod:6548
15176 " guestfs_write (guestfs_h *g,\n"
15177 " const char *path,\n"
15178 " const char *content,\n"
15179 " size_t content_size);\n"
15184 #: ../src/guestfs-actions.pod:6554 ../fish/guestfish-actions.pod:4326
15186 "This call creates a file called C<path>. The content of the file is the "
15187 "string C<content> (which can contain any 8 bit data)."
15191 #: ../src/guestfs-actions.pod:6564
15192 msgid "guestfs_write_file"
15196 #: ../src/guestfs-actions.pod:6566
15200 " guestfs_write_file (guestfs_h *g,\n"
15201 " const char *path,\n"
15202 " const char *content,\n"
15208 #: ../src/guestfs-actions.pod:6572 ../fish/guestfish-actions.pod:4336
15210 "This call creates a file called C<path>. The contents of the file is the "
15211 "string C<content> (which can contain any 8 bit data), with length C<size>."
15215 #: ../src/guestfs-actions.pod:6576 ../fish/guestfish-actions.pod:4340
15217 "As a special case, if C<size> is C<0> then the length is calculated using "
15218 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15222 #: ../src/guestfs-actions.pod:6580 ../fish/guestfish-actions.pod:4344
15224 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15225 "I<not> work, even if the length is specified."
15229 #: ../src/guestfs-actions.pod:6588 ../fish/guestfish-actions.pod:4350
15231 "This function is deprecated. In new code, use the C<write> call instead."
15235 #: ../src/guestfs-actions.pod:6597
15236 msgid "guestfs_zegrep"
15240 #: ../src/guestfs-actions.pod:6599
15244 " guestfs_zegrep (guestfs_h *g,\n"
15245 " const char *regex,\n"
15246 " const char *path);\n"
15251 #: ../src/guestfs-actions.pod:6604 ../fish/guestfish-actions.pod:4361
15253 "This calls the external C<zegrep> program and returns the matching lines."
15257 #: ../src/guestfs-actions.pod:6616
15258 msgid "guestfs_zegrepi"
15262 #: ../src/guestfs-actions.pod:6618
15266 " guestfs_zegrepi (guestfs_h *g,\n"
15267 " const char *regex,\n"
15268 " const char *path);\n"
15273 #: ../src/guestfs-actions.pod:6623 ../fish/guestfish-actions.pod:4371
15275 "This calls the external C<zegrep -i> program and returns the matching lines."
15279 #: ../src/guestfs-actions.pod:6635
15280 msgid "guestfs_zero"
15284 #: ../src/guestfs-actions.pod:6637
15288 " guestfs_zero (guestfs_h *g,\n"
15289 " const char *device);\n"
15294 #: ../src/guestfs-actions.pod:6641 ../fish/guestfish-actions.pod:4381
15295 msgid "This command writes zeroes over the first few blocks of C<device>."
15299 #: ../src/guestfs-actions.pod:6643 ../fish/guestfish-actions.pod:4383
15301 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15302 "securely wipe the device). It should be sufficient to remove any partition "
15303 "tables, filesystem superblocks and so on."
15307 #: ../src/guestfs-actions.pod:6647
15308 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
15312 #: ../src/guestfs-actions.pod:6658
15313 msgid "guestfs_zero_device"
15317 #: ../src/guestfs-actions.pod:6660
15321 " guestfs_zero_device (guestfs_h *g,\n"
15322 " const char *device);\n"
15327 #: ../src/guestfs-actions.pod:6664
15329 "This command writes zeroes over the entire C<device>. Compare with "
15330 "C<guestfs_zero> which just zeroes the first few blocks of a device."
15334 #: ../src/guestfs-actions.pod:6678
15335 msgid "(Added in 1.3.1)"
15339 #: ../src/guestfs-actions.pod:6680
15340 msgid "guestfs_zerofree"
15344 #: ../src/guestfs-actions.pod:6682
15348 " guestfs_zerofree (guestfs_h *g,\n"
15349 " const char *device);\n"
15354 #: ../src/guestfs-actions.pod:6686 ../fish/guestfish-actions.pod:4404
15356 "This runs the I<zerofree> program on C<device>. This program claims to zero "
15357 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
15358 "possible to compress the filesystem more effectively."
15362 #: ../src/guestfs-actions.pod:6691 ../fish/guestfish-actions.pod:4409
15363 msgid "You should B<not> run this program if the filesystem is mounted."
15367 #: ../src/guestfs-actions.pod:6694 ../fish/guestfish-actions.pod:4412
15369 "It is possible that using this program can damage the filesystem or data on "
15374 #: ../src/guestfs-actions.pod:6701
15375 msgid "guestfs_zfgrep"
15379 #: ../src/guestfs-actions.pod:6703
15383 " guestfs_zfgrep (guestfs_h *g,\n"
15384 " const char *pattern,\n"
15385 " const char *path);\n"
15390 #: ../src/guestfs-actions.pod:6708 ../fish/guestfish-actions.pod:4419
15392 "This calls the external C<zfgrep> program and returns the matching lines."
15396 #: ../src/guestfs-actions.pod:6720
15397 msgid "guestfs_zfgrepi"
15401 #: ../src/guestfs-actions.pod:6722
15405 " guestfs_zfgrepi (guestfs_h *g,\n"
15406 " const char *pattern,\n"
15407 " const char *path);\n"
15412 #: ../src/guestfs-actions.pod:6727 ../fish/guestfish-actions.pod:4429
15414 "This calls the external C<zfgrep -i> program and returns the matching lines."
15418 #: ../src/guestfs-actions.pod:6739
15419 msgid "guestfs_zfile"
15423 #: ../src/guestfs-actions.pod:6741
15427 " guestfs_zfile (guestfs_h *g,\n"
15428 " const char *meth,\n"
15429 " const char *path);\n"
15434 #: ../src/guestfs-actions.pod:6746 ../fish/guestfish-actions.pod:4439
15436 "This command runs C<file> after first decompressing C<path> using C<method>."
15440 #: ../src/guestfs-actions.pod:6749 ../fish/guestfish-actions.pod:4442
15441 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
15445 #: ../src/guestfs-actions.pod:6751
15447 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
15452 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4447
15454 "This function is deprecated. In new code, use the C<file> call instead."
15458 #: ../src/guestfs-actions.pod:6766
15459 msgid "guestfs_zgrep"
15463 #: ../src/guestfs-actions.pod:6768
15467 " guestfs_zgrep (guestfs_h *g,\n"
15468 " const char *regex,\n"
15469 " const char *path);\n"
15474 #: ../src/guestfs-actions.pod:6773 ../fish/guestfish-actions.pod:4458
15476 "This calls the external C<zgrep> program and returns the matching lines."
15480 #: ../src/guestfs-actions.pod:6785
15481 msgid "guestfs_zgrepi"
15485 #: ../src/guestfs-actions.pod:6787
15489 " guestfs_zgrepi (guestfs_h *g,\n"
15490 " const char *regex,\n"
15491 " const char *path);\n"
15496 #: ../src/guestfs-actions.pod:6792 ../fish/guestfish-actions.pod:4468
15498 "This calls the external C<zgrep -i> program and returns the matching lines."
15502 #: ../src/guestfs-availability.pod:3
15507 #: ../src/guestfs-availability.pod:5
15509 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
15510 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
15511 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
15512 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
15513 "L</guestfs_aug_save> L</guestfs_aug_set>"
15517 #: ../src/guestfs-availability.pod:21
15522 #: ../src/guestfs-availability.pod:23
15524 "The following functions: L</guestfs_inotify_add_watch> L</"
15525 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
15526 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
15530 #: ../src/guestfs-availability.pod:31
15531 msgid "B<linuxfsuuid>"
15535 #: ../src/guestfs-availability.pod:33
15537 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
15538 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
15542 #: ../src/guestfs-availability.pod:40
15543 msgid "B<linuxmodules>"
15547 #: ../src/guestfs-availability.pod:42
15548 msgid "The following functions: L</guestfs_modprobe>"
15552 #: ../src/guestfs-availability.pod:45
15553 msgid "B<linuxxattrs>"
15557 #: ../src/guestfs-availability.pod:47
15559 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> L</"
15560 "guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</"
15561 "guestfs_removexattr> L</guestfs_setxattr>"
15565 #: ../src/guestfs-availability.pod:56
15570 #: ../src/guestfs-availability.pod:58
15572 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
15573 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
15574 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
15578 #: ../src/guestfs-availability.pod:67
15583 #: ../src/guestfs-availability.pod:69
15585 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
15586 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
15587 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
15588 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
15589 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
15590 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
15591 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
15595 #: ../src/guestfs-availability.pod:92
15600 #: ../src/guestfs-availability.pod:94
15602 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
15603 "guestfs_mknod_b> L</guestfs_mknod_c>"
15607 #: ../src/guestfs-availability.pod:100
15612 #: ../src/guestfs-availability.pod:102
15613 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
15617 #: ../src/guestfs-availability.pod:105
15618 msgid "B<ntfsprogs>"
15622 #: ../src/guestfs-availability.pod:107
15624 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
15628 #: ../src/guestfs-availability.pod:111
15629 msgid "B<realpath>"
15633 #: ../src/guestfs-availability.pod:113
15634 msgid "The following functions: L</guestfs_realpath>"
15638 #: ../src/guestfs-availability.pod:116
15643 #: ../src/guestfs-availability.pod:118
15645 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
15646 "guestfs_scrub_freespace>"
15650 #: ../src/guestfs-availability.pod:123
15655 #: ../src/guestfs-availability.pod:125
15656 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
15660 #: ../src/guestfs-availability.pod:129
15665 #: ../src/guestfs-availability.pod:131
15666 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
15670 #: ../src/guestfs-availability.pod:135
15671 msgid "B<zerofree>"
15675 #: ../src/guestfs-availability.pod:137
15676 msgid "The following functions: L</guestfs_zerofree>"
15680 #: ../src/guestfs-structs.pod:1
15681 msgid "guestfs_int_bool"
15685 #: ../src/guestfs-structs.pod:3
15688 " struct guestfs_int_bool {\n"
15696 #: ../src/guestfs-structs.pod:8
15699 " struct guestfs_int_bool_list {\n"
15700 " uint32_t len; /* Number of elements in list. */\n"
15701 " struct guestfs_int_bool *val; /* Elements. */\n"
15707 #: ../src/guestfs-structs.pod:13
15710 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
15711 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
15716 #: ../src/guestfs-structs.pod:16
15717 msgid "guestfs_lvm_pv"
15721 #: ../src/guestfs-structs.pod:18
15724 " struct guestfs_lvm_pv {\n"
15725 " char *pv_name;\n"
15726 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
15727 " char pv_uuid[32];\n"
15729 " uint64_t pv_size;\n"
15730 " uint64_t dev_size;\n"
15731 " uint64_t pv_free;\n"
15732 " uint64_t pv_used;\n"
15733 " char *pv_attr;\n"
15734 " int64_t pv_pe_count;\n"
15735 " int64_t pv_pe_alloc_count;\n"
15736 " char *pv_tags;\n"
15737 " uint64_t pe_start;\n"
15738 " int64_t pv_mda_count;\n"
15739 " uint64_t pv_mda_free;\n"
15745 #: ../src/guestfs-structs.pod:36
15748 " struct guestfs_lvm_pv_list {\n"
15749 " uint32_t len; /* Number of elements in list. */\n"
15750 " struct guestfs_lvm_pv *val; /* Elements. */\n"
15756 #: ../src/guestfs-structs.pod:41
15759 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
15760 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
15765 #: ../src/guestfs-structs.pod:44
15766 msgid "guestfs_lvm_vg"
15770 #: ../src/guestfs-structs.pod:46
15773 " struct guestfs_lvm_vg {\n"
15774 " char *vg_name;\n"
15775 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
15776 " char vg_uuid[32];\n"
15778 " char *vg_attr;\n"
15779 " uint64_t vg_size;\n"
15780 " uint64_t vg_free;\n"
15781 " char *vg_sysid;\n"
15782 " uint64_t vg_extent_size;\n"
15783 " int64_t vg_extent_count;\n"
15784 " int64_t vg_free_count;\n"
15785 " int64_t max_lv;\n"
15786 " int64_t max_pv;\n"
15787 " int64_t pv_count;\n"
15788 " int64_t lv_count;\n"
15789 " int64_t snap_count;\n"
15790 " int64_t vg_seqno;\n"
15791 " char *vg_tags;\n"
15792 " int64_t vg_mda_count;\n"
15793 " uint64_t vg_mda_free;\n"
15799 #: ../src/guestfs-structs.pod:69
15802 " struct guestfs_lvm_vg_list {\n"
15803 " uint32_t len; /* Number of elements in list. */\n"
15804 " struct guestfs_lvm_vg *val; /* Elements. */\n"
15810 #: ../src/guestfs-structs.pod:74
15813 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
15814 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
15819 #: ../src/guestfs-structs.pod:77
15820 msgid "guestfs_lvm_lv"
15824 #: ../src/guestfs-structs.pod:79
15827 " struct guestfs_lvm_lv {\n"
15828 " char *lv_name;\n"
15829 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
15830 " char lv_uuid[32];\n"
15831 " char *lv_attr;\n"
15832 " int64_t lv_major;\n"
15833 " int64_t lv_minor;\n"
15834 " int64_t lv_kernel_major;\n"
15835 " int64_t lv_kernel_minor;\n"
15836 " uint64_t lv_size;\n"
15837 " int64_t seg_count;\n"
15839 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
15840 " float snap_percent;\n"
15841 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
15842 " float copy_percent;\n"
15843 " char *move_pv;\n"
15844 " char *lv_tags;\n"
15845 " char *mirror_log;\n"
15846 " char *modules;\n"
15852 #: ../src/guestfs-structs.pod:101
15855 " struct guestfs_lvm_lv_list {\n"
15856 " uint32_t len; /* Number of elements in list. */\n"
15857 " struct guestfs_lvm_lv *val; /* Elements. */\n"
15863 #: ../src/guestfs-structs.pod:106
15866 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
15867 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
15872 #: ../src/guestfs-structs.pod:111
15875 " struct guestfs_stat {\n"
15879 " int64_t nlink;\n"
15884 " int64_t blksize;\n"
15885 " int64_t blocks;\n"
15886 " int64_t atime;\n"
15887 " int64_t mtime;\n"
15888 " int64_t ctime;\n"
15894 #: ../src/guestfs-structs.pod:127
15897 " struct guestfs_stat_list {\n"
15898 " uint32_t len; /* Number of elements in list. */\n"
15899 " struct guestfs_stat *val; /* Elements. */\n"
15905 #: ../src/guestfs-structs.pod:132
15908 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
15909 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
15914 #: ../src/guestfs-structs.pod:137
15917 " struct guestfs_statvfs {\n"
15918 " int64_t bsize;\n"
15919 " int64_t frsize;\n"
15920 " int64_t blocks;\n"
15921 " int64_t bfree;\n"
15922 " int64_t bavail;\n"
15923 " int64_t files;\n"
15924 " int64_t ffree;\n"
15925 " int64_t favail;\n"
15928 " int64_t namemax;\n"
15934 #: ../src/guestfs-structs.pod:151
15937 " struct guestfs_statvfs_list {\n"
15938 " uint32_t len; /* Number of elements in list. */\n"
15939 " struct guestfs_statvfs *val; /* Elements. */\n"
15945 #: ../src/guestfs-structs.pod:156
15948 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
15949 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
15954 #: ../src/guestfs-structs.pod:159
15955 msgid "guestfs_dirent"
15959 #: ../src/guestfs-structs.pod:161
15962 " struct guestfs_dirent {\n"
15971 #: ../src/guestfs-structs.pod:167
15974 " struct guestfs_dirent_list {\n"
15975 " uint32_t len; /* Number of elements in list. */\n"
15976 " struct guestfs_dirent *val; /* Elements. */\n"
15982 #: ../src/guestfs-structs.pod:172
15985 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
15986 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
15991 #: ../src/guestfs-structs.pod:177
15994 " struct guestfs_version {\n"
15995 " int64_t major;\n"
15996 " int64_t minor;\n"
15997 " int64_t release;\n"
16004 #: ../src/guestfs-structs.pod:184
16007 " struct guestfs_version_list {\n"
16008 " uint32_t len; /* Number of elements in list. */\n"
16009 " struct guestfs_version *val; /* Elements. */\n"
16015 #: ../src/guestfs-structs.pod:189
16018 " void guestfs_free_version (struct guestfs_free_version *);\n"
16019 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
16024 #: ../src/guestfs-structs.pod:192
16025 msgid "guestfs_xattr"
16029 #: ../src/guestfs-structs.pod:194
16032 " struct guestfs_xattr {\n"
16033 " char *attrname;\n"
16034 " /* The next two fields describe a byte array. */\n"
16035 " uint32_t attrval_len;\n"
16036 " char *attrval;\n"
16042 #: ../src/guestfs-structs.pod:201
16045 " struct guestfs_xattr_list {\n"
16046 " uint32_t len; /* Number of elements in list. */\n"
16047 " struct guestfs_xattr *val; /* Elements. */\n"
16053 #: ../src/guestfs-structs.pod:206
16056 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
16057 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
16062 #: ../src/guestfs-structs.pod:209
16063 msgid "guestfs_inotify_event"
16067 #: ../src/guestfs-structs.pod:211
16070 " struct guestfs_inotify_event {\n"
16071 " int64_t in_wd;\n"
16072 " uint32_t in_mask;\n"
16073 " uint32_t in_cookie;\n"
16074 " char *in_name;\n"
16080 #: ../src/guestfs-structs.pod:218
16083 " struct guestfs_inotify_event_list {\n"
16084 " uint32_t len; /* Number of elements in list. */\n"
16085 " struct guestfs_inotify_event *val; /* Elements. */\n"
16091 #: ../src/guestfs-structs.pod:223
16094 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
16095 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
16100 #: ../src/guestfs-structs.pod:226
16101 msgid "guestfs_partition"
16105 #: ../src/guestfs-structs.pod:228
16108 " struct guestfs_partition {\n"
16109 " int32_t part_num;\n"
16110 " uint64_t part_start;\n"
16111 " uint64_t part_end;\n"
16112 " uint64_t part_size;\n"
16118 #: ../src/guestfs-structs.pod:235
16121 " struct guestfs_partition_list {\n"
16122 " uint32_t len; /* Number of elements in list. */\n"
16123 " struct guestfs_partition *val; /* Elements. */\n"
16129 #: ../src/guestfs-structs.pod:240
16132 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
16133 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
16138 #: ../fish/guestfish.pod:5
16139 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
16143 #: ../fish/guestfish.pod:9
16146 " guestfish [--options] [commands]\n"
16151 #: ../fish/guestfish.pod:11
16159 #: ../fish/guestfish.pod:13
16162 " guestfish -a disk.img\n"
16167 #: ../fish/guestfish.pod:15
16170 " guestfish -a disk.img -m dev[:mountpoint]\n"
16175 #: ../fish/guestfish.pod:17
16178 " guestfish -d libvirt-domain\n"
16183 #: ../fish/guestfish.pod:19
16186 " guestfish -a disk.img -i\n"
16191 #: ../fish/guestfish.pod:21
16194 " guestfish -d libvirt-domain -i\n"
16199 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
16200 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
16201 #: ../tools/virt-rescue.pl:41
16206 #: ../fish/guestfish.pod:25
16208 "Using guestfish in read/write mode on live virtual machines can be "
16209 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16210 "option to use guestfish safely if the disk image or virtual machine might be "
16215 #: ../fish/guestfish.pod:32
16217 "Guestfish is a shell and command-line tool for examining and modifying "
16218 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16219 "functionality of the guestfs API, see L<guestfs(3)>."
16223 #: ../fish/guestfish.pod:36
16225 "Guestfish gives you structured access to the libguestfs API, from shell "
16226 "scripts or the command line or interactively. If you want to rescue a "
16227 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16232 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:800
16233 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58
16234 #: ../tools/virt-resize.pl:66 ../tools/virt-cat.pl:50 ../tools/virt-tar.pl:45
16239 #: ../fish/guestfish.pod:43
16240 msgid "As an interactive shell"
16244 #: ../fish/guestfish.pod:45
16252 #: ../fish/guestfish.pod:47
16255 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
16256 " editing virtual machine filesystems.\n"
16261 #: ../fish/guestfish.pod:50
16264 " Type: 'help' for a list of commands\n"
16265 " 'man' to read the manual\n"
16266 " 'quit' to quit the shell\n"
16271 #: ../fish/guestfish.pod:54
16274 " ><fs> add-ro disk.img\n"
16276 " ><fs> list-filesystems\n"
16277 " /dev/sda1: ext4\n"
16278 " /dev/vg_guest/lv_root: ext4\n"
16279 " /dev/vg_guest/lv_swap: swap\n"
16280 " ><fs> mount /dev/vg_guest/lv_root /\n"
16281 " ><fs> cat /etc/fstab\n"
16283 " # Created by anaconda\n"
16290 #: ../fish/guestfish.pod:67
16291 msgid "From shell scripts"
16295 #: ../fish/guestfish.pod:69
16296 msgid "Create a new C</etc/motd> file in a guest or disk image:"
16300 #: ../fish/guestfish.pod:71
16303 " guestfish <<_EOF_\n"
16306 " mount /dev/vg_guest/lv_root /\n"
16307 " write /etc/motd \"Welcome, new users\"\n"
16313 #: ../fish/guestfish.pod:78
16314 msgid "List the LVM logical volumes in a disk image:"
16318 #: ../fish/guestfish.pod:80
16321 " guestfish -a disk.img --ro <<_EOF_\n"
16329 #: ../fish/guestfish.pod:85
16330 msgid "List all the filesystems in a disk image:"
16334 #: ../fish/guestfish.pod:87
16337 " guestfish -a disk.img --ro <<_EOF_\n"
16339 " list-filesystems\n"
16345 #: ../fish/guestfish.pod:92
16346 msgid "On one command line"
16350 #: ../fish/guestfish.pod:94
16351 msgid "Update C</etc/resolv.conf> in a guest:"
16355 #: ../fish/guestfish.pod:96
16359 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
16360 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
16365 #: ../fish/guestfish.pod:100
16366 msgid "Edit C</boot/grub/grub.conf> interactively:"
16370 #: ../fish/guestfish.pod:102
16373 " guestfish --add disk.img \\\n"
16374 " --mount /dev/vg_guest/lv_root \\\n"
16375 " --mount /dev/sda1:/boot \\\n"
16376 " edit /boot/grub/grub.conf\n"
16381 #: ../fish/guestfish.pod:107
16382 msgid "Mount disks automatically"
16386 #: ../fish/guestfish.pod:109
16388 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
16392 #: ../fish/guestfish.pod:112
16395 " guestfish --ro -a disk.img -i cat /etc/group\n"
16400 #: ../fish/guestfish.pod:114
16403 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
16408 #: ../fish/guestfish.pod:116
16409 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
16413 #: ../fish/guestfish.pod:118
16416 " guestfish -a disk.img -i edit /boot/grub/grub.conf\n"
16421 #: ../fish/guestfish.pod:120
16422 msgid "As a script interpreter"
16426 #: ../fish/guestfish.pod:122
16427 msgid "Create a 100MB disk containing an ext2-formatted partition:"
16431 #: ../fish/guestfish.pod:124
16434 " #!/usr/bin/guestfish -f\n"
16435 " sparse test1.img 100M\n"
16437 " part-disk /dev/sda mbr\n"
16438 " mkfs ext2 /dev/sda1\n"
16443 #: ../fish/guestfish.pod:130
16444 msgid "Start with a prepared disk"
16448 #: ../fish/guestfish.pod:132
16450 "An alternate way to create a 100MB disk called C<test1.img> containing a "
16451 "single ext2-formatted partition:"
16455 #: ../fish/guestfish.pod:135
16458 " guestfish -N fs\n"
16463 #: ../fish/guestfish.pod:137
16464 msgid "To list what is available do:"
16468 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:791
16471 " guestfish -N help | less\n"
16476 #: ../fish/guestfish.pod:141
16477 msgid "Remote control"
16481 #: ../fish/guestfish.pod:143
16484 " eval `guestfish --listen`\n"
16485 " guestfish --remote add-ro disk.img\n"
16486 " guestfish --remote run\n"
16487 " guestfish --remote lvs\n"
16492 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
16493 #: ../fuse/guestmount.pod:73 ../inspector/virt-inspector.pl:68
16494 #: ../tools/virt-edit.pl:72 ../tools/virt-win-reg.pl:171
16495 #: ../tools/virt-df.pl:71 ../tools/virt-ls.pl:78 ../tools/virt-resize.pl:257
16496 #: ../tools/virt-list-filesystems.pl:50 ../tools/virt-cat.pl:79
16497 #: ../tools/virt-tar.pl:98 ../tools/virt-rescue.pl:103
16498 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:51
16503 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
16504 #: ../inspector/virt-inspector.pl:76 ../tools/virt-edit.pl:80
16505 #: ../tools/virt-win-reg.pl:179 ../tools/virt-df.pl:79 ../tools/virt-ls.pl:86
16506 #: ../tools/virt-resize.pl:265 ../tools/virt-list-filesystems.pl:58
16507 #: ../tools/virt-cat.pl:87 ../tools/virt-tar.pl:106
16508 #: ../tools/virt-rescue.pl:111 ../tools/virt-make-fs.pl:161
16509 #: ../tools/virt-list-partitions.pl:59
16514 #: ../fish/guestfish.pod:154
16515 msgid "Displays general help on options."
16519 #: ../fish/guestfish.pod:156
16520 msgid "B<-h> | B<--cmd-help>"
16524 #: ../fish/guestfish.pod:158
16525 msgid "Lists all available guestfish commands."
16529 #: ../fish/guestfish.pod:160
16530 msgid "B<-h cmd> | B<--cmd-help cmd>"
16534 #: ../fish/guestfish.pod:162
16535 msgid "Displays detailed help on a single command C<cmd>."
16539 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
16540 msgid "B<-a image> | B<--add image>"
16544 #: ../fish/guestfish.pod:166
16545 msgid "Add a block device or virtual machine image to the shell."
16549 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
16551 "The format of the disk image is auto-detected. To override this and force a "
16552 "particular format use the I<--format=..> option."
16556 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
16557 msgid "B<-c URI> | B<--connect URI>"
16561 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
16563 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16564 "URI to use. The default is to use the default libvirt connection."
16568 #: ../fish/guestfish.pod:177 ../fuse/guestmount.pod:90
16569 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
16573 #: ../fish/guestfish.pod:179 ../fuse/guestmount.pod:92
16575 "Add disks from the named libvirt domain. If the I<--ro> option is also "
16576 "used, then any libvirt domain can be used. However in write mode, only "
16577 "libvirt domains which are shut down can be named here."
16581 #: ../fish/guestfish.pod:183
16582 msgid "B<-D> | B<--no-dest-paths>"
16586 #: ../fish/guestfish.pod:185
16588 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
16589 "to hit the tab key to complete paths on the guest filesystem, but this "
16590 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
16591 "allow this feature to be disabled."
16595 #: ../fish/guestfish.pod:190 ../fuse/guestmount.pod:108
16596 msgid "B<--echo-keys>"
16600 #: ../fish/guestfish.pod:192 ../fuse/guestmount.pod:110
16602 "When prompting for keys and passphrases, guestfish normally turns echoing "
16603 "off so you cannot see what you are typing. If you are not worried about "
16604 "Tempest attacks and there is no one else in the room you can specify this "
16605 "flag to see what you are typing."
16609 #: ../fish/guestfish.pod:197
16610 msgid "B<-f file> | B<--file file>"
16614 #: ../fish/guestfish.pod:199
16615 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
16619 #: ../fish/guestfish.pod:202
16622 " #!/usr/bin/guestfish -f\n"
16627 #: ../fish/guestfish.pod:204 ../fuse/guestmount.pod:115
16628 msgid "B<--format=raw|qcow2|..> | B<--format>"
16632 #: ../fish/guestfish.pod:206 ../fuse/guestmount.pod:117
16634 "The default for the I<-a> option is to auto-detect the format of the disk "
16635 "image. Using this forces the disk format for I<-a> options which follow on "
16636 "the command line. Using I<--format> with no argument switches back to auto-"
16637 "detection for subsequent I<-a> options."
16641 #: ../fish/guestfish.pod:211 ../fish/guestfish.pod:504
16642 #: ../inspector/virt-inspector.pl:549
16643 msgid "For example:"
16647 #: ../fish/guestfish.pod:213
16650 " guestfish --format=raw -a disk.img\n"
16655 #: ../fish/guestfish.pod:215
16656 msgid "forces raw format (no auto-detection) for C<disk.img>."
16660 #: ../fish/guestfish.pod:217
16663 " guestfish --format=raw -a disk.img --format -a another.img\n"
16668 #: ../fish/guestfish.pod:219
16670 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
16671 "detection for C<another.img>."
16675 #: ../fish/guestfish.pod:222
16677 "If you have untrusted raw-format guest disk images, you should use this "
16678 "option to specify the disk format. This avoids a possible security problem "
16679 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
16683 #: ../fish/guestfish.pod:227 ../fuse/guestmount.pod:135
16684 msgid "B<-i> | B<--inspector>"
16688 #: ../fish/guestfish.pod:229 ../fuse/guestmount.pod:137
16690 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
16691 "system and mount filesystems as they would be mounted on the real virtual "
16696 #: ../fish/guestfish.pod:233
16697 msgid "Typical usage is either:"
16701 #: ../fish/guestfish.pod:235
16704 " guestfish -d myguest -i\n"
16709 #: ../fish/guestfish.pod:237
16710 msgid "(for an inactive libvirt domain called I<myguest>), or:"
16714 #: ../fish/guestfish.pod:239
16717 " guestfish --ro -d myguest -i\n"
16722 #: ../fish/guestfish.pod:241
16723 msgid "(for active domains, readonly), or specify the block device directly:"
16727 #: ../fish/guestfish.pod:243
16730 " guestfish -a /dev/Guests/MyGuest -i\n"
16735 #: ../fish/guestfish.pod:245
16737 "Note that the command line syntax changed slightly over older versions of "
16738 "guestfish. You can still use the old syntax:"
16742 #: ../fish/guestfish.pod:248
16745 " guestfish [--ro] -i disk.img\n"
16750 #: ../fish/guestfish.pod:250
16753 " guestfish [--ro] -i libvirt-domain\n"
16758 #: ../fish/guestfish.pod:252 ../fuse/guestmount.pod:141
16759 msgid "B<--keys-from-stdin>"
16763 #: ../fish/guestfish.pod:254 ../fuse/guestmount.pod:143
16765 "Read key or passphrase parameters from stdin. The default is to try to read "
16766 "passphrases from the user by opening C</dev/tty>."
16770 #: ../fish/guestfish.pod:257
16771 msgid "B<--listen>"
16775 #: ../fish/guestfish.pod:259
16777 "Fork into the background and listen for remote commands. See section L</"
16778 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
16782 #: ../fish/guestfish.pod:262
16783 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
16787 #: ../fish/guestfish.pod:264
16788 msgid "Mount the named partition or logical volume on the given mountpoint."
16792 #: ../fish/guestfish.pod:266
16793 msgid "If the mountpoint is omitted, it defaults to C</>."
16797 #: ../fish/guestfish.pod:268
16798 msgid "You have to mount something on C</> before most commands will work."
16802 #: ../fish/guestfish.pod:270
16804 "If any I<-m> or I<--mount> options are given, the guest is automatically "
16809 #: ../fish/guestfish.pod:273
16811 "If you don't know what filesystems a disk image contains, you can either run "
16812 "guestfish without this option, then list the partitions and LVs available "
16813 "(see L</list-partitions> and L</lvs> commands), or you can use the L<virt-"
16814 "list-filesystems(1)> program."
16818 #: ../fish/guestfish.pod:278 ../fuse/guestmount.pod:154
16819 msgid "B<-n> | B<--no-sync>"
16823 #: ../fish/guestfish.pod:280
16825 "Disable autosync. This is enabled by default. See the discussion of "
16826 "autosync in the L<guestfs(3)> manpage."
16830 #: ../fish/guestfish.pod:283
16831 msgid "B<-N type> | B<--new type> | B<-N help>"
16835 #: ../fish/guestfish.pod:285
16837 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
16838 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
16839 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
16844 #: ../fish/guestfish.pod:290
16845 msgid "B<--progress-bars>"
16849 #: ../fish/guestfish.pod:292
16850 msgid "Enable progress bars, even when guestfish is used non-interactively."
16854 #: ../fish/guestfish.pod:294
16856 "Progress bars are enabled by default when guestfish is used as an "
16857 "interactive shell."
16861 #: ../fish/guestfish.pod:297
16862 msgid "B<--no-progress-bars>"
16866 #: ../fish/guestfish.pod:299
16867 msgid "Disable progress bars."
16871 #: ../fish/guestfish.pod:301
16872 msgid "B<--remote[=pid]>"
16876 #: ../fish/guestfish.pod:303
16878 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
16879 "CONTROL GUESTFISH OVER A SOCKET> below."
16883 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:196
16884 msgid "B<-r> | B<--ro>"
16888 #: ../fish/guestfish.pod:308
16890 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
16891 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
16895 #: ../fish/guestfish.pod:311 ../tools/virt-rescue.pl:187
16897 "The option must always be used if the disk image or virtual machine might be "
16898 "running, and is generally recommended in cases where you don't need write "
16899 "access to the disk."
16903 #: ../fish/guestfish.pod:315
16905 "Note that prepared disk images created with I<-N> are not affected by the "
16910 #: ../fish/guestfish.pod:318 ../fuse/guestmount.pod:206
16911 #: ../tools/virt-rescue.pl:195
16912 msgid "B<--selinux>"
16916 #: ../fish/guestfish.pod:320
16917 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
16921 #: ../fish/guestfish.pod:322 ../fuse/guestmount.pod:210
16922 msgid "B<-v> | B<--verbose>"
16926 #: ../fish/guestfish.pod:324
16928 "Enable very verbose messages. This is particularly useful if you find a bug."
16932 #: ../fish/guestfish.pod:327 ../fuse/guestmount.pod:214
16933 msgid "B<-V> | B<--version>"
16937 #: ../fish/guestfish.pod:329
16938 msgid "Display the guestfish / libguestfs version number and exit."
16942 #: ../fish/guestfish.pod:331
16947 #: ../fish/guestfish.pod:333
16948 msgid "Echo each command before executing it."
16952 #: ../fish/guestfish.pod:337
16953 msgid "COMMANDS ON COMMAND LINE"
16957 #: ../fish/guestfish.pod:339
16959 "Any additional (non-option) arguments are treated as commands to execute."
16963 #: ../fish/guestfish.pod:342
16965 "Commands to execute should be separated by a colon (C<:>), where the colon "
16966 "is a separate parameter. Thus:"
16970 #: ../fish/guestfish.pod:345
16973 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
16978 #: ../fish/guestfish.pod:347
16980 "If there are no additional arguments, then we enter a shell, either an "
16981 "interactive shell with a prompt (if the input is a terminal) or a non-"
16982 "interactive shell."
16986 #: ../fish/guestfish.pod:351
16988 "In either command line mode or non-interactive shell, the first command that "
16989 "gives an error causes the whole shell to exit. In interactive mode (with a "
16990 "prompt) if a command fails, you can continue to enter commands."
16994 #: ../fish/guestfish.pod:356
16995 msgid "USING launch (OR run)"
16999 #: ../fish/guestfish.pod:358
17001 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
17002 "then launch it, then mount any disks you need, and finally issue actions/"
17003 "commands. So the general order of the day is:"
17007 #: ../fish/guestfish.pod:366
17008 msgid "add or -a/--add"
17012 #: ../fish/guestfish.pod:370
17013 msgid "launch (aka run)"
17017 #: ../fish/guestfish.pod:374
17018 msgid "mount or -m/--mount"
17022 #: ../fish/guestfish.pod:378
17023 msgid "any other commands"
17027 #: ../fish/guestfish.pod:382
17029 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
17030 "guest before mounting or performing any other commands."
17034 #: ../fish/guestfish.pod:385
17036 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
17037 "I<--new> options were given then C<run> is done automatically, simply "
17038 "because guestfish can't perform the action you asked for without doing this."
17042 #: ../fish/guestfish.pod:390
17047 #: ../fish/guestfish.pod:392
17049 "You can quote ordinary parameters using either single or double quotes. For "
17054 #: ../fish/guestfish.pod:395
17057 " add \"file with a space.img\"\n"
17062 #: ../fish/guestfish.pod:397
17065 " rm '/file name'\n"
17070 #: ../fish/guestfish.pod:399
17078 #: ../fish/guestfish.pod:401
17080 "A few commands require a list of strings to be passed. For these, use a "
17081 "whitespace-separated list, enclosed in quotes. Strings containing "
17082 "whitespace to be passed through must be enclosed in single quotes. A "
17083 "literal single quote must be escaped with a backslash."
17087 #: ../fish/guestfish.pod:406
17090 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17091 " command \"/bin/echo 'foo bar'\"\n"
17092 " command \"/bin/echo \\'foo\\'\"\n"
17097 #: ../fish/guestfish.pod:410
17098 msgid "OPTIONAL ARGUMENTS"
17102 #: ../fish/guestfish.pod:412
17104 "Some commands take optional arguments. These arguments appear in this "
17105 "documentation as C<[argname:..]>. You can use them as in these examples:"
17109 #: ../fish/guestfish.pod:416
17112 " add-drive-opts filename\n"
17117 #: ../fish/guestfish.pod:418
17120 " add-drive-opts filename readonly:true\n"
17125 #: ../fish/guestfish.pod:420
17128 " add-drive-opts filename format:qcow2 readonly:false\n"
17133 #: ../fish/guestfish.pod:422
17135 "Each optional argument can appear at most once. All optional arguments must "
17136 "appear after the required ones."
17140 #: ../fish/guestfish.pod:425
17145 #: ../fish/guestfish.pod:427
17147 "This section applies to all commands which can take integers as parameters."
17151 #: ../fish/guestfish.pod:430
17152 msgid "SIZE SUFFIX"
17156 #: ../fish/guestfish.pod:432
17158 "When the command takes a parameter measured in bytes, you can use one of the "
17159 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17163 #: ../fish/guestfish.pod:438
17164 msgid "B<k> or B<K> or B<KiB>"
17168 #: ../fish/guestfish.pod:440
17169 msgid "The size in kilobytes (multiplied by 1024)."
17173 #: ../fish/guestfish.pod:442
17178 #: ../fish/guestfish.pod:444
17179 msgid "The size in SI 1000 byte units."
17183 #: ../fish/guestfish.pod:446
17184 msgid "B<M> or B<MiB>"
17188 #: ../fish/guestfish.pod:448
17189 msgid "The size in megabytes (multiplied by 1048576)."
17193 #: ../fish/guestfish.pod:450
17198 #: ../fish/guestfish.pod:452
17199 msgid "The size in SI 1000000 byte units."
17203 #: ../fish/guestfish.pod:454
17204 msgid "B<G> or B<GiB>"
17208 #: ../fish/guestfish.pod:456
17209 msgid "The size in gigabytes (multiplied by 2**30)."
17213 #: ../fish/guestfish.pod:458
17218 #: ../fish/guestfish.pod:460
17219 msgid "The size in SI 10**9 byte units."
17223 #: ../fish/guestfish.pod:462
17224 msgid "B<T> or B<TiB>"
17228 #: ../fish/guestfish.pod:464
17229 msgid "The size in terabytes (multiplied by 2**40)."
17233 #: ../fish/guestfish.pod:466
17238 #: ../fish/guestfish.pod:468
17239 msgid "The size in SI 10**12 byte units."
17243 #: ../fish/guestfish.pod:470
17244 msgid "B<P> or B<PiB>"
17248 #: ../fish/guestfish.pod:472
17249 msgid "The size in petabytes (multiplied by 2**50)."
17253 #: ../fish/guestfish.pod:474
17258 #: ../fish/guestfish.pod:476
17259 msgid "The size in SI 10**15 byte units."
17263 #: ../fish/guestfish.pod:478
17264 msgid "B<E> or B<EiB>"
17268 #: ../fish/guestfish.pod:480
17269 msgid "The size in exabytes (multiplied by 2**60)."
17273 #: ../fish/guestfish.pod:482
17278 #: ../fish/guestfish.pod:484
17279 msgid "The size in SI 10**18 byte units."
17283 #: ../fish/guestfish.pod:486
17284 msgid "B<Z> or B<ZiB>"
17288 #: ../fish/guestfish.pod:488
17289 msgid "The size in zettabytes (multiplied by 2**70)."
17293 #: ../fish/guestfish.pod:490
17298 #: ../fish/guestfish.pod:492
17299 msgid "The size in SI 10**21 byte units."
17303 #: ../fish/guestfish.pod:494
17304 msgid "B<Y> or B<YiB>"
17308 #: ../fish/guestfish.pod:496
17309 msgid "The size in yottabytes (multiplied by 2**80)."
17313 #: ../fish/guestfish.pod:498
17318 #: ../fish/guestfish.pod:500
17319 msgid "The size in SI 10**24 byte units."
17323 #: ../fish/guestfish.pod:506
17326 " truncate-size /file 1G\n"
17331 #: ../fish/guestfish.pod:508
17332 msgid "would truncate the file to 1 gigabyte."
17336 #: ../fish/guestfish.pod:510
17338 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
17339 "the parameter to L</memsize> is specified in megabytes already). Adding a "
17340 "suffix will probably not do what you expect."
17344 #: ../fish/guestfish.pod:514
17345 msgid "OCTAL AND HEXADECIMAL NUMBERS"
17349 #: ../fish/guestfish.pod:516
17351 "For specifying the radix (base) use the C convention: C<0> to prefix an "
17352 "octal number or C<0x> to prefix a hexadecimal number. For example:"
17356 #: ../fish/guestfish.pod:519
17359 " 1234 decimal number 1234\n"
17360 " 02322 octal number, equivalent to decimal 1234\n"
17361 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
17366 #: ../fish/guestfish.pod:523
17368 "When using the C<chmod> command, you almost always want to specify an octal "
17369 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
17370 "L<chmod(1)> program):"
17374 #: ../fish/guestfish.pod:527
17377 " chmod 0777 /public # OK\n"
17378 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
17383 #: ../fish/guestfish.pod:530
17385 "Commands that return numbers usually print them in decimal, but some "
17386 "commands print numbers in other radices (eg. C<umask> prints the mode in "
17387 "octal, preceeded by C<0>)."
17391 #: ../fish/guestfish.pod:534
17392 msgid "WILDCARDS AND GLOBBING"
17396 #: ../fish/guestfish.pod:536
17398 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
17399 "(globbing) by default. So for example the following will not do what you "
17404 #: ../fish/guestfish.pod:540
17412 #: ../fish/guestfish.pod:542
17414 "Assuming you don't have a directory called literally C</home/*> then the "
17415 "above command will return an error."
17419 #: ../fish/guestfish.pod:545
17420 msgid "To perform wildcard expansion, use the C<glob> command."
17424 #: ../fish/guestfish.pod:547
17427 " glob rm-rf /home/*\n"
17432 #: ../fish/guestfish.pod:549
17434 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
17435 "many times), equivalent to:"
17439 #: ../fish/guestfish.pod:552
17442 " rm-rf /home/jim\n"
17443 " rm-rf /home/joe\n"
17444 " rm-rf /home/mary\n"
17449 #: ../fish/guestfish.pod:556
17450 msgid "C<glob> only works on simple guest paths and not on device names."
17454 #: ../fish/guestfish.pod:558
17456 "If you have several parameters, each containing a wildcard, then glob will "
17457 "perform a Cartesian product."
17461 #: ../fish/guestfish.pod:561
17466 #: ../fish/guestfish.pod:563
17468 "Any line which starts with a I<#> character is treated as a comment and "
17469 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
17470 "a command. For example:"
17474 #: ../fish/guestfish.pod:567
17477 " # this is a comment\n"
17478 " # this is a comment\n"
17479 " foo # NOT a comment\n"
17484 #: ../fish/guestfish.pod:571
17485 msgid "Blank lines are also ignored."
17489 #: ../fish/guestfish.pod:573
17490 msgid "RUNNING COMMANDS LOCALLY"
17494 #: ../fish/guestfish.pod:575
17496 "Any line which starts with a I<!> character is treated as a command sent to "
17497 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
17501 #: ../fish/guestfish.pod:579
17505 " tgz-out /remote local/remote-data.tar.gz\n"
17510 #: ../fish/guestfish.pod:582
17512 "will create a directory C<local> on the host, and then export the contents "
17513 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17514 "(See C<tgz-out>)."
17518 #: ../fish/guestfish.pod:586
17520 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17521 "effect, due to the way that subprocesses work in Unix."
17525 #: ../fish/guestfish.pod:589
17530 #: ../fish/guestfish.pod:591
17532 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17533 "command (a guestfish command) to the second command (any host command). For "
17538 #: ../fish/guestfish.pod:595
17541 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17546 #: ../fish/guestfish.pod:597
17548 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17549 "program). The above command would list all accounts in the guest filesystem "
17550 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17554 #: ../fish/guestfish.pod:602
17557 " hexdump /bin/ls | head\n"
17558 " list-devices | tail -1\n"
17559 " tgz-out / - | tar ztf -\n"
17564 #: ../fish/guestfish.pod:606
17566 "The space before the pipe symbol is required, any space after the pipe "
17567 "symbol is optional. Everything after the pipe symbol is just passed "
17568 "straight to the host shell, so it can contain redirections, globs and "
17569 "anything else that makes sense on the host side."
17573 #: ../fish/guestfish.pod:611
17575 "To use a literal argument which begins with a pipe symbol, you have to quote "
17580 #: ../fish/guestfish.pod:614
17588 #: ../fish/guestfish.pod:616
17589 msgid "HOME DIRECTORIES"
17593 #: ../fish/guestfish.pod:618
17595 "If a parameter starts with the character C<~> then the tilde may be expanded "
17596 "as a home directory path (either C<~> for the current user's home directory, "
17597 "or C<~user> for another user)."
17601 #: ../fish/guestfish.pod:622
17603 "Note that home directory expansion happens for users known I<on the host>, "
17604 "not in the guest filesystem."
17608 #: ../fish/guestfish.pod:625
17610 "To use a literal argument which begins with a tilde, you have to quote it, "
17615 #: ../fish/guestfish.pod:628
17623 #: ../fish/guestfish.pod:632
17625 "Libguestfs has some support for Linux guests encrypted according to the "
17626 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17627 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
17628 "LUKS is supported."
17632 #: ../fish/guestfish.pod:637
17633 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17637 #: ../fish/guestfish.pod:639
17640 " ><fs> vfs-type /dev/sda2\n"
17646 #: ../fish/guestfish.pod:642
17648 "Then open those devices using L</luks-open>. This creates a device-mapper "
17649 "device called C</dev/mapper/luksdev>."
17653 #: ../fish/guestfish.pod:645
17656 " ><fs> luks-open /dev/sda2 luksdev\n"
17657 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17662 #: ../fish/guestfish.pod:648
17664 "Finally you have to tell LVM to scan for volume groups on the newly created "
17669 #: ../fish/guestfish.pod:651
17673 " vg-activate-all true\n"
17678 #: ../fish/guestfish.pod:654
17679 msgid "The logical volume(s) can now be mounted in the usual way."
17683 #: ../fish/guestfish.pod:656
17685 "Before closing a LUKS device you must unmount any logical volumes on it and "
17686 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17687 "one. Then you can close the mapper device:"
17691 #: ../fish/guestfish.pod:660
17694 " vg-activate false /dev/VG\n"
17695 " luks-close /dev/mapper/luksdev\n"
17700 #: ../fish/guestfish.pod:663
17701 msgid "WINDOWS PATHS"
17705 #: ../fish/guestfish.pod:665
17707 "If a path is prefixed with C<win:> then you can use Windows-style paths "
17708 "(with some limitations). The following commands are equivalent:"
17712 #: ../fish/guestfish.pod:668
17715 " file /WINDOWS/system32/config/system.LOG\n"
17720 #: ../fish/guestfish.pod:670
17723 " file win:/windows/system32/config/system.log\n"
17728 #: ../fish/guestfish.pod:672
17731 " file win:\\windows\\system32\\config\\system.log\n"
17736 #: ../fish/guestfish.pod:674
17739 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
17744 #: ../fish/guestfish.pod:676
17746 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
17747 "handles case insensitivity like Windows would. This only works in argument "
17748 "positions that expect a path."
17752 #: ../fish/guestfish.pod:680
17753 msgid "UPLOADING AND DOWNLOADING FILES"
17757 #: ../fish/guestfish.pod:682
17759 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
17760 "others which upload from or download to a local file, you can use the "
17761 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
17765 #: ../fish/guestfish.pod:686
17773 #: ../fish/guestfish.pod:688
17775 "reads stdin and creates from that a file C</foo> in the disk image, and:"
17779 #: ../fish/guestfish.pod:691
17782 " tar-out /etc - | tar tf -\n"
17787 #: ../fish/guestfish.pod:693
17789 "writes the tarball to stdout and then pipes that into the external \"tar\" "
17790 "command (see L</PIPES>)."
17794 #: ../fish/guestfish.pod:696
17796 "When using C<-> to read from stdin, the input is read up to the end of "
17797 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
17798 "some arbitrary end marker:"
17802 #: ../fish/guestfish.pod:700
17805 " upload -<<END /foo\n"
17814 #: ../fish/guestfish.pod:706
17816 "Any string of characters can be used instead of C<END>. The end marker must "
17817 "appear on a line of its own, without any preceeding or following characters "
17818 "(not even spaces)."
17822 #: ../fish/guestfish.pod:710
17824 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
17825 "upload local files (so-called \"FileIn\" parameters in the generator)."
17829 #: ../fish/guestfish.pod:713
17830 msgid "EXIT ON ERROR BEHAVIOUR"
17834 #: ../fish/guestfish.pod:715
17836 "By default, guestfish will ignore any errors when in interactive mode (ie. "
17837 "taking commands from a human over a tty), and will exit on the first error "
17838 "in non-interactive mode (scripts, commands given on the command line)."
17842 #: ../fish/guestfish.pod:720
17844 "If you prefix a command with a I<-> character, then that command will not "
17845 "cause guestfish to exit, even if that (one) command returns an error."
17849 #: ../fish/guestfish.pod:724
17850 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
17854 #: ../fish/guestfish.pod:726
17856 "Guestfish can be remote-controlled over a socket. This is useful "
17857 "particularly in shell scripts where you want to make several different "
17858 "changes to a filesystem, but you don't want the overhead of starting up a "
17859 "guestfish process each time."
17863 #: ../fish/guestfish.pod:731
17864 msgid "Start a guestfish server process using:"
17868 #: ../fish/guestfish.pod:733
17871 " eval `guestfish --listen`\n"
17876 #: ../fish/guestfish.pod:735
17877 msgid "and then send it commands by doing:"
17881 #: ../fish/guestfish.pod:737
17884 " guestfish --remote cmd [...]\n"
17889 #: ../fish/guestfish.pod:739
17890 msgid "To cause the server to exit, send it the exit command:"
17894 #: ../fish/guestfish.pod:741
17897 " guestfish --remote exit\n"
17902 #: ../fish/guestfish.pod:743
17904 "Note that the server will normally exit if there is an error in a command. "
17905 "You can change this in the usual way. See section L</EXIT ON ERROR "
17910 #: ../fish/guestfish.pod:747
17911 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
17915 #: ../fish/guestfish.pod:749
17917 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
17918 "is how the I<--remote> option knows where to send the commands. You can "
17919 "have several guestfish listener processes running using:"
17923 #: ../fish/guestfish.pod:753
17926 " eval `guestfish --listen`\n"
17927 " pid1=$GUESTFISH_PID\n"
17928 " eval `guestfish --listen`\n"
17929 " pid2=$GUESTFISH_PID\n"
17931 " guestfish --remote=$pid1 cmd\n"
17932 " guestfish --remote=$pid2 cmd\n"
17937 #: ../fish/guestfish.pod:761
17938 msgid "REMOTE CONTROL DETAILS"
17942 #: ../fish/guestfish.pod:763
17944 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
17945 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
17946 "and C<$PID> is the process ID of the server."
17950 #: ../fish/guestfish.pod:767
17951 msgid "Guestfish client and server versions must match exactly."
17955 #: ../fish/guestfish.pod:769
17956 msgid "PREPARED DISK IMAGES"
17960 #: ../fish/guestfish.pod:771
17962 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
17963 "preformatted disk images that guestfish can make for you to save typing. "
17964 "This is particularly useful for testing purposes. This option is used "
17965 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
17966 "can be mixed with I<-a>)."
17970 #: ../fish/guestfish.pod:777
17972 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
17973 "the second and so on. Existing files in the current directory are "
17978 #: ../fish/guestfish.pod:781
17980 "The type briefly describes how the disk should be sized, partitioned, how "
17981 "filesystem(s) should be created, and how content should be added. "
17982 "Optionally the type can be followed by extra parameters, separated by C<:> "
17983 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
17984 "allocated disk, containing a single partition, with the partition formatted "
17985 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
17990 #: ../fish/guestfish.pod:789
17991 msgid "To list the available types and any extra parameters they take, run:"
17995 #: ../fish/guestfish.pod:793
17997 "Note that the prepared filesystem is not mounted. You would usually have to "
17998 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18002 #: ../fish/guestfish.pod:797
18004 "If any I<-N> or I<--new> options are given, the guest is automatically "
18009 #: ../fish/guestfish.pod:802
18010 msgid "Create a 100MB disk with an ext4-formatted partition:"
18014 #: ../fish/guestfish.pod:804
18017 " guestfish -N fs:ext4\n"
18022 #: ../fish/guestfish.pod:806
18023 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18027 #: ../fish/guestfish.pod:808
18030 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18035 #: ../fish/guestfish.pod:810
18036 msgid "Create a blank 200MB disk:"
18040 #: ../fish/guestfish.pod:812
18043 " guestfish -N disk:200M\n"
18048 #: ../fish/guestfish.pod:814
18049 msgid "PROGRESS BARS"
18053 #: ../fish/guestfish.pod:816
18055 "Some (not all) long-running commands send progress notification messages as "
18056 "they are running. Guestfish turns these messages into progress bars."
18060 #: ../fish/guestfish.pod:820
18062 "When a command that supports progress bars takes longer than two seconds to "
18063 "run, and if progress bars are enabled, then you will see one appearing below "
18068 #: ../fish/guestfish.pod:824
18071 " ><fs> copy-size /large-file /another-file 2048M\n"
18072 " / 10% [#####-----------------------------------------] 00:30\n"
18077 #: ../fish/guestfish.pod:827
18079 "The spinner on the left hand side moves round once for every progress "
18080 "notification received from the backend. This is a (reasonably) golden "
18081 "assurance that the command is \"doing something\" even if the progress bar "
18082 "is not moving, because the command is able to send the progress "
18083 "notifications. When the bar reaches 100% and the command finishes, the "
18084 "spinner disappears."
18088 #: ../fish/guestfish.pod:834
18090 "Progress bars are enabled by default when guestfish is used interactively. "
18091 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18092 "and you can disable them completely using I<--no-progress-bars>."
18096 #: ../fish/guestfish.pod:839
18097 msgid "GUESTFISH COMMANDS"
18101 #: ../fish/guestfish.pod:841
18103 "The commands in this section are guestfish convenience commands, in other "
18104 "words, they are not part of the L<guestfs(3)> API."
18108 #: ../fish/guestfish.pod:844
18113 #: ../fish/guestfish.pod:846
18122 #: ../fish/guestfish.pod:849
18123 msgid "Without any parameter, this provides general help."
18127 #: ../fish/guestfish.pod:851
18128 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18132 #: ../fish/guestfish.pod:853
18133 msgid "quit | exit"
18137 #: ../fish/guestfish.pod:855
18138 msgid "This exits guestfish. You can also use C<^D> key."
18142 #: ../fish/guestfish.pod:857
18143 msgid "@FISH_COMMANDS@"
18147 #: ../fish/guestfish.pod:859
18152 #: ../fish/guestfish.pod:863 ../test-tool/libguestfs-test-tool.pod:83
18157 #: ../fish/guestfish.pod:865
18159 "guestfish returns 0 if the commands completed without error, or 1 if there "
18164 #: ../fish/guestfish.pod:872
18169 #: ../fish/guestfish.pod:874
18171 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
18176 #: ../fish/guestfish.pod:877
18177 msgid "GUESTFISH_PID"
18181 #: ../fish/guestfish.pod:879
18183 "Used with the I<--remote> option to specify the remote guestfish process to "
18184 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
18188 #: ../fish/guestfish.pod:883
18193 #: ../fish/guestfish.pod:885
18195 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
18196 "not specified, the external L<hexedit(1)> program is used."
18200 #: ../fish/guestfish.pod:889
18205 #: ../fish/guestfish.pod:891
18207 "If compiled with GNU readline support, various files in the home directory "
18208 "can be used. See L</FILES>."
18212 #: ../fish/guestfish.pod:900
18214 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
18215 "effect as using the B<-v> option."
18219 #: ../fish/guestfish.pod:912
18221 "Set the path that guestfish uses to search for kernel and initrd.img. See "
18222 "the discussion of paths in L<guestfs(3)>."
18226 #: ../fish/guestfish.pod:923
18227 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
18231 #: ../fish/guestfish.pod:925
18236 #: ../fish/guestfish.pod:927
18238 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
18243 #: ../fish/guestfish.pod:942 ../test-tool/libguestfs-test-tool.pod:88
18248 #: ../fish/guestfish.pod:946
18249 msgid "$HOME/.guestfish"
18253 #: ../fish/guestfish.pod:948
18255 "If compiled with GNU readline support, then the command history is saved in "
18260 #: ../fish/guestfish.pod:951
18261 msgid "$HOME/.inputrc"
18265 #: ../fish/guestfish.pod:953
18266 msgid "/etc/inputrc"
18270 #: ../fish/guestfish.pod:955
18272 "If compiled with GNU readline support, then these files can be used to "
18273 "configure readline. For further information, please see L<readline(3)/"
18274 "INITIALIZATION FILE>."
18278 #: ../fish/guestfish.pod:959
18279 msgid "To write rules which only apply to guestfish, use:"
18283 #: ../fish/guestfish.pod:961
18293 #: ../fish/guestfish.pod:965
18295 "Variables that you can set in inputrc that change the behaviour of guestfish "
18296 "in useful ways include:"
18300 #: ../fish/guestfish.pod:970
18301 msgid "completion-ignore-case (default: on)"
18305 #: ../fish/guestfish.pod:972
18307 "By default, guestfish will ignore case when tab-completing paths on the "
18312 #: ../fish/guestfish.pod:975
18315 " set completion-ignore-case off\n"
18320 #: ../fish/guestfish.pod:977
18321 msgid "to make guestfish case sensitive."
18325 #: ../fish/guestfish.pod:981
18330 #: ../fish/guestfish.pod:983
18331 msgid "test2.img (etc)"
18335 #: ../fish/guestfish.pod:985
18337 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
18338 "will be created in the file C<test1.img> in the current directory. The "
18339 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
18340 "the same name will be overwritten."
18344 #: ../fish/guestfish.pod:994
18346 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
18347 "L<virt-edit(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, "
18348 "L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, "
18349 "L<virt-tar(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
18353 #: ../fish/guestfish.pod:1018 ../test-tool/libguestfs-test-tool.pod:124
18354 #: ../fuse/guestmount.pod:246 ../inspector/virt-inspector.pl:598
18355 #: ../tools/virt-edit.pl:370 ../tools/virt-win-reg.pl:518
18356 #: ../tools/virt-df.pl:657 ../tools/virt-ls.pl:251
18357 #: ../tools/virt-resize.pl:1516 ../tools/virt-list-filesystems.pl:206
18358 #: ../tools/virt-cat.pl:203 ../tools/virt-tar.pl:300
18359 #: ../tools/virt-rescue.pl:285 ../tools/virt-make-fs.pl:567
18360 #: ../tools/virt-list-partitions.pl:273
18362 "This program is free software; you can redistribute it and/or modify it "
18363 "under the terms of the GNU General Public License as published by the Free "
18364 "Software Foundation; either version 2 of the License, or (at your option) "
18365 "any later version."
18369 #: ../fish/guestfish.pod:1023 ../test-tool/libguestfs-test-tool.pod:129
18370 #: ../fuse/guestmount.pod:251 ../inspector/virt-inspector.pl:603
18371 #: ../tools/virt-edit.pl:375 ../tools/virt-win-reg.pl:523
18372 #: ../tools/virt-df.pl:662 ../tools/virt-ls.pl:256
18373 #: ../tools/virt-resize.pl:1521 ../tools/virt-list-filesystems.pl:211
18374 #: ../tools/virt-cat.pl:208 ../tools/virt-tar.pl:305
18375 #: ../tools/virt-rescue.pl:290 ../tools/virt-make-fs.pl:572
18376 #: ../tools/virt-list-partitions.pl:278
18378 "This program is distributed in the hope that it will be useful, but WITHOUT "
18379 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
18380 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
18385 #: ../fish/guestfish.pod:1028 ../test-tool/libguestfs-test-tool.pod:134
18386 #: ../fuse/guestmount.pod:256 ../inspector/virt-inspector.pl:608
18387 #: ../tools/virt-edit.pl:380 ../tools/virt-win-reg.pl:528
18388 #: ../tools/virt-df.pl:667 ../tools/virt-ls.pl:261
18389 #: ../tools/virt-resize.pl:1526 ../tools/virt-list-filesystems.pl:216
18390 #: ../tools/virt-cat.pl:213 ../tools/virt-tar.pl:310
18391 #: ../tools/virt-rescue.pl:295 ../tools/virt-make-fs.pl:577
18392 #: ../tools/virt-list-partitions.pl:283
18394 "You should have received a copy of the GNU General Public License along with "
18395 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
18396 "Ave, Cambridge, MA 02139, USA."
18400 #: ../fish/guestfish-actions.pod:1
18405 #: ../fish/guestfish-actions.pod:3
18408 " add-cdrom filename\n"
18413 #: ../fish/guestfish-actions.pod:15
18415 "This call checks for the existence of C<filename>. This stops you from "
18416 "specifying other types of drive which are supported by qemu such as C<nbd:> "
18417 "and C<http:> URLs. To specify those, use the general L</config> call "
18422 #: ../fish/guestfish-actions.pod:22
18424 "If you just want to add an ISO file (often you use this as an efficient way "
18425 "to transfer large files into the guest), then you should probably use L</add-"
18426 "drive-ro> instead."
18430 #: ../fish/guestfish-actions.pod:35
18435 #: ../fish/guestfish-actions.pod:37
18438 " add-drive filename\n"
18443 #: ../fish/guestfish-actions.pod:39
18445 "This function is the equivalent of calling L</add-drive-opts> with no "
18446 "optional parameters, so the disk is added writable, with the format being "
18447 "detected automatically."
18451 #: ../fish/guestfish-actions.pod:43
18453 "Automatic detection of the format opens you up to a potential security hole "
18454 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
18455 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
18456 "you should think about replacing calls to this function with calls to L</add-"
18457 "drive-opts>, and specifying the format."
18461 #: ../fish/guestfish-actions.pod:50
18462 msgid "add-drive-opts"
18466 #: ../fish/guestfish-actions.pod:52
18471 #: ../fish/guestfish-actions.pod:54
18474 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
18479 #: ../fish/guestfish-actions.pod:81
18481 "This forces the image format. If you omit this (or use L</add-drive> or L</"
18482 "add-drive-ro>) then the format is automatically detected. Possible formats "
18483 "include C<raw> and C<qcow2>."
18487 #: ../fish/guestfish-actions.pod:92
18489 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
18490 "add-drive-with-if> call (q.v.)"
18494 #: ../fish/guestfish-actions.pod:97
18496 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
18500 #: ../fish/guestfish-actions.pod:99
18501 msgid "add-drive-ro"
18505 #: ../fish/guestfish-actions.pod:101
18510 #: ../fish/guestfish-actions.pod:103
18513 " add-drive-ro filename\n"
18518 #: ../fish/guestfish-actions.pod:105
18520 "This function is the equivalent of calling L</add-drive-opts> with the "
18521 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
18522 "is added read-only, with the format being detected automatically."
18526 #: ../fish/guestfish-actions.pod:110
18527 msgid "add-drive-ro-with-if"
18531 #: ../fish/guestfish-actions.pod:112
18534 " add-drive-ro-with-if filename iface\n"
18539 #: ../fish/guestfish-actions.pod:114
18541 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
18542 "interface emulation to use at run time."
18546 #: ../fish/guestfish-actions.pod:124
18547 msgid "add-drive-with-if"
18551 #: ../fish/guestfish-actions.pod:126
18554 " add-drive-with-if filename iface\n"
18559 #: ../fish/guestfish-actions.pod:128
18561 "This is the same as L</add-drive> but it allows you to specify the QEMU "
18562 "interface emulation to use at run time."
18566 #: ../fish/guestfish-actions.pod:138
18571 #: ../fish/guestfish-actions.pod:140
18574 " aug-clear augpath\n"
18579 #: ../fish/guestfish-actions.pod:145
18584 #: ../fish/guestfish-actions.pod:147
18592 #: ../fish/guestfish-actions.pod:149
18594 "Close the current Augeas handle and free up any resources used by it. After "
18595 "calling this, you have to call L</aug-init> again before you can use any "
18596 "other Augeas functions."
18600 #: ../fish/guestfish-actions.pod:154
18601 msgid "aug-defnode"
18605 #: ../fish/guestfish-actions.pod:156
18608 " aug-defnode name expr val\n"
18613 #: ../fish/guestfish-actions.pod:161
18615 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
18616 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
18617 "containing that single node."
18621 #: ../fish/guestfish-actions.pod:169
18626 #: ../fish/guestfish-actions.pod:171
18629 " aug-defvar name expr\n"
18634 #: ../fish/guestfish-actions.pod:180
18639 #: ../fish/guestfish-actions.pod:182
18642 " aug-get augpath\n"
18647 #: ../fish/guestfish-actions.pod:187
18652 #: ../fish/guestfish-actions.pod:189
18655 " aug-init root flags\n"
18660 #: ../fish/guestfish-actions.pod:195
18661 msgid "You must call this before using any other L</aug-*> commands."
18665 #: ../fish/guestfish-actions.pod:230
18666 msgid "Do not load the tree in L</aug-init>."
18670 #: ../fish/guestfish-actions.pod:234
18671 msgid "To close the handle, you can call L</aug-close>."
18675 #: ../fish/guestfish-actions.pod:238
18680 #: ../fish/guestfish-actions.pod:240
18683 " aug-insert augpath label true|false\n"
18688 #: ../fish/guestfish-actions.pod:250
18693 #: ../fish/guestfish-actions.pod:252
18701 #: ../fish/guestfish-actions.pod:259
18706 #: ../fish/guestfish-actions.pod:261
18709 " aug-ls augpath\n"
18714 #: ../fish/guestfish-actions.pod:263
18716 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
18717 "resulting nodes into alphabetical order."
18721 #: ../fish/guestfish-actions.pod:266
18726 #: ../fish/guestfish-actions.pod:268
18729 " aug-match augpath\n"
18734 #: ../fish/guestfish-actions.pod:274
18739 #: ../fish/guestfish-actions.pod:276
18742 " aug-mv src dest\n"
18747 #: ../fish/guestfish-actions.pod:281
18752 #: ../fish/guestfish-actions.pod:283
18755 " aug-rm augpath\n"
18760 #: ../fish/guestfish-actions.pod:289
18765 #: ../fish/guestfish-actions.pod:291
18773 #: ../fish/guestfish-actions.pod:295
18775 "The flags which were passed to L</aug-init> affect exactly how files are "
18780 #: ../fish/guestfish-actions.pod:298
18785 #: ../fish/guestfish-actions.pod:300
18788 " aug-set augpath val\n"
18793 #: ../fish/guestfish-actions.pod:304
18795 "In the Augeas API, it is possible to clear a node by setting the value to "
18796 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
18797 "this call. Instead you must use the L</aug-clear> call."
18801 #: ../fish/guestfish-actions.pod:309
18806 #: ../fish/guestfish-actions.pod:311
18809 " available 'groups ...'\n"
18814 #: ../fish/guestfish-actions.pod:317
18816 "The libguestfs groups, and the functions that those groups correspond to, "
18817 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
18818 "runtime by calling L</available-all-groups>."
18822 #: ../fish/guestfish-actions.pod:341
18823 msgid "You must call L</launch> before calling this function."
18827 #: ../fish/guestfish-actions.pod:363
18829 "This call was added in version C<1.0.80>. In previous versions of "
18830 "libguestfs all you could do would be to speculatively execute a command to "
18831 "find out if the daemon implemented it. See also L</version>."
18835 #: ../fish/guestfish-actions.pod:370
18836 msgid "available-all-groups"
18840 #: ../fish/guestfish-actions.pod:372
18843 " available-all-groups\n"
18848 #: ../fish/guestfish-actions.pod:374
18850 "This command returns a list of all optional groups that this daemon knows "
18851 "about. Note this returns both supported and unsupported groups. To find "
18852 "out which ones the daemon can actually support you have to call L</"
18853 "available> on each member of the returned list."
18857 #: ../fish/guestfish-actions.pod:380
18858 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
18862 #: ../fish/guestfish-actions.pod:382
18867 #: ../fish/guestfish-actions.pod:384
18870 " base64-in (base64file|-) filename\n"
18875 #: ../fish/guestfish-actions.pod:389 ../fish/guestfish-actions.pod:398
18876 #: ../fish/guestfish-actions.pod:622 ../fish/guestfish-actions.pod:769
18877 #: ../fish/guestfish-actions.pod:816 ../fish/guestfish-actions.pod:835
18878 #: ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:3932
18879 #: ../fish/guestfish-actions.pod:3944 ../fish/guestfish-actions.pod:3955
18880 #: ../fish/guestfish-actions.pod:3966 ../fish/guestfish-actions.pod:4018
18881 #: ../fish/guestfish-actions.pod:4027 ../fish/guestfish-actions.pod:4081
18882 #: ../fish/guestfish-actions.pod:4104
18883 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
18887 #: ../fish/guestfish-actions.pod:391
18892 #: ../fish/guestfish-actions.pod:393
18895 " base64-out filename (base64file|-)\n"
18900 #: ../fish/guestfish-actions.pod:400
18901 msgid "blockdev-flushbufs"
18905 #: ../fish/guestfish-actions.pod:402
18908 " blockdev-flushbufs device\n"
18913 #: ../fish/guestfish-actions.pod:409
18914 msgid "blockdev-getbsz"
18918 #: ../fish/guestfish-actions.pod:411
18921 " blockdev-getbsz device\n"
18926 #: ../fish/guestfish-actions.pod:420
18927 msgid "blockdev-getro"
18931 #: ../fish/guestfish-actions.pod:422
18934 " blockdev-getro device\n"
18939 #: ../fish/guestfish-actions.pod:429
18940 msgid "blockdev-getsize64"
18944 #: ../fish/guestfish-actions.pod:431
18947 " blockdev-getsize64 device\n"
18952 #: ../fish/guestfish-actions.pod:435
18953 msgid "See also L</blockdev-getsz>."
18957 #: ../fish/guestfish-actions.pod:439
18958 msgid "blockdev-getss"
18962 #: ../fish/guestfish-actions.pod:441
18965 " blockdev-getss device\n"
18970 #: ../fish/guestfish-actions.pod:446
18972 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
18976 #: ../fish/guestfish-actions.pod:451
18977 msgid "blockdev-getsz"
18981 #: ../fish/guestfish-actions.pod:453
18984 " blockdev-getsz device\n"
18989 #: ../fish/guestfish-actions.pod:458
18991 "See also L</blockdev-getss> for the real sector size of the device, and L</"
18992 "blockdev-getsize64> for the more useful I<size in bytes>."
18996 #: ../fish/guestfish-actions.pod:464
18997 msgid "blockdev-rereadpt"
19001 #: ../fish/guestfish-actions.pod:466
19004 " blockdev-rereadpt device\n"
19009 #: ../fish/guestfish-actions.pod:472
19010 msgid "blockdev-setbsz"
19014 #: ../fish/guestfish-actions.pod:474
19017 " blockdev-setbsz device blocksize\n"
19022 #: ../fish/guestfish-actions.pod:483
19023 msgid "blockdev-setro"
19027 #: ../fish/guestfish-actions.pod:485
19030 " blockdev-setro device\n"
19035 #: ../fish/guestfish-actions.pod:491
19036 msgid "blockdev-setrw"
19040 #: ../fish/guestfish-actions.pod:493
19043 " blockdev-setrw device\n"
19048 #: ../fish/guestfish-actions.pod:499
19049 msgid "case-sensitive-path"
19053 #: ../fish/guestfish-actions.pod:501
19056 " case-sensitive-path path\n"
19061 #: ../fish/guestfish-actions.pod:525
19063 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
19064 "WINDOWS/system32\"> (the exact return value would depend on details of how "
19065 "the directories were originally created under Windows)."
19069 #: ../fish/guestfish-actions.pod:533
19070 msgid "See also L</realpath>."
19074 #: ../fish/guestfish-actions.pod:535
19079 #: ../fish/guestfish-actions.pod:537
19087 #: ../fish/guestfish-actions.pod:541
19089 "Note that this function cannot correctly handle binary files (specifically, "
19090 "files containing C<\\0> character which is treated as end of string). For "
19091 "those you need to use the L</read-file> or L</download> functions which have "
19092 "a more complex interface."
19096 #: ../fish/guestfish-actions.pod:549
19101 #: ../fish/guestfish-actions.pod:551
19104 " checksum csumtype path\n"
19109 #: ../fish/guestfish-actions.pod:594
19110 msgid "To get the checksum for a device, use L</checksum-device>."
19114 #: ../fish/guestfish-actions.pod:596
19115 msgid "To get the checksums for many files, use L</checksums-out>."
19119 #: ../fish/guestfish-actions.pod:598
19120 msgid "checksum-device"
19124 #: ../fish/guestfish-actions.pod:600
19127 " checksum-device csumtype device\n"
19132 #: ../fish/guestfish-actions.pod:602
19134 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
19135 "device named C<device>. For the types of checksums supported see the L</"
19136 "checksum> command."
19140 #: ../fish/guestfish-actions.pod:606
19141 msgid "checksums-out"
19145 #: ../fish/guestfish-actions.pod:608
19148 " checksums-out csumtype directory (sumsfile|-)\n"
19153 #: ../fish/guestfish-actions.pod:624
19158 #: ../fish/guestfish-actions.pod:626
19161 " chmod mode path\n"
19166 #: ../fish/guestfish-actions.pod:637
19171 #: ../fish/guestfish-actions.pod:639
19174 " chown owner group path\n"
19179 #: ../fish/guestfish-actions.pod:647
19184 #: ../fish/guestfish-actions.pod:649
19187 " command 'arguments ...'\n"
19192 #: ../fish/guestfish-actions.pod:656
19194 "The single parameter is an argv-style list of arguments. The first element "
19195 "is the name of the program to run. Subsequent elements are parameters. The "
19196 "list must be non-empty (ie. must contain a program name). Note that the "
19197 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
19201 #: ../fish/guestfish-actions.pod:684
19202 msgid "command-lines"
19206 #: ../fish/guestfish-actions.pod:686
19209 " command-lines 'arguments ...'\n"
19214 #: ../fish/guestfish-actions.pod:688
19216 "This is the same as L</command>, but splits the result into a list of lines."
19220 #: ../fish/guestfish-actions.pod:691
19221 msgid "See also: L</sh-lines>"
19225 #: ../fish/guestfish-actions.pod:696
19230 #: ../fish/guestfish-actions.pod:698
19233 " config qemuparam qemuvalue\n"
19238 #: ../fish/guestfish-actions.pod:709
19243 #: ../fish/guestfish-actions.pod:711
19246 " copy-size src dest size\n"
19251 #: ../fish/guestfish-actions.pod:719
19256 #: ../fish/guestfish-actions.pod:721
19264 #: ../fish/guestfish-actions.pod:726
19269 #: ../fish/guestfish-actions.pod:728
19277 #: ../fish/guestfish-actions.pod:733
19282 #: ../fish/guestfish-actions.pod:735
19290 #: ../fish/guestfish-actions.pod:742
19292 "If the destination is a device, it must be as large or larger than the "
19293 "source file or device, otherwise the copy will fail. This command cannot do "
19294 "partial copies (see L</copy-size>)."
19298 #: ../fish/guestfish-actions.pod:746
19303 #: ../fish/guestfish-actions.pod:748
19306 " debug subcmd 'extraargs ...'\n"
19311 #: ../fish/guestfish-actions.pod:750
19313 "The L</debug> command exposes some internals of C<guestfsd> (the guestfs "
19314 "daemon) that runs inside the qemu subprocess."
19318 #: ../fish/guestfish-actions.pod:758
19319 msgid "debug-upload"
19323 #: ../fish/guestfish-actions.pod:760
19326 " debug-upload (filename|-) tmpname mode\n"
19331 #: ../fish/guestfish-actions.pod:762
19333 "The L</debug-upload> command uploads a file to the libguestfs appliance."
19337 #: ../fish/guestfish-actions.pod:771
19342 #: ../fish/guestfish-actions.pod:773
19350 #: ../fish/guestfish-actions.pod:781
19355 #: ../fish/guestfish-actions.pod:783
19363 #: ../fish/guestfish-actions.pod:792
19368 #: ../fish/guestfish-actions.pod:794
19376 #: ../fish/guestfish-actions.pod:800
19378 "Another way to get the same information is to enable verbose messages with "
19379 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
19380 "before running the program."
19384 #: ../fish/guestfish-actions.pod:805
19389 #: ../fish/guestfish-actions.pod:807
19392 " download remotefilename (filename|-)\n"
19397 #: ../fish/guestfish-actions.pod:814
19398 msgid "See also L</upload>, L</cat>."
19402 #: ../fish/guestfish-actions.pod:818
19403 msgid "download-offset"
19407 #: ../fish/guestfish-actions.pod:820
19410 " download-offset remotefilename (filename|-) offset size\n"
19415 #: ../fish/guestfish-actions.pod:828
19417 "Note that there is no limit on the amount of data that can be downloaded "
19418 "with this call, unlike with L</pread>, and this call always reads the full "
19419 "amount unless an error occurs."
19423 #: ../fish/guestfish-actions.pod:833
19424 msgid "See also L</download>, L</pread>."
19428 #: ../fish/guestfish-actions.pod:837
19429 msgid "drop-caches"
19433 #: ../fish/guestfish-actions.pod:839
19436 " drop-caches whattodrop\n"
19441 #: ../fish/guestfish-actions.pod:851
19446 #: ../fish/guestfish-actions.pod:853
19454 #: ../fish/guestfish-actions.pod:865
19459 #: ../fish/guestfish-actions.pod:867
19462 " e2fsck-f device\n"
19467 #: ../fish/guestfish-actions.pod:873
19469 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
19470 "should use L</fsck>."
19474 #: ../fish/guestfish-actions.pod:876
19475 msgid "echo-daemon"
19479 #: ../fish/guestfish-actions.pod:878
19482 " echo-daemon 'words ...'\n"
19487 #: ../fish/guestfish-actions.pod:885
19488 msgid "See also L</ping-daemon>."
19492 #: ../fish/guestfish-actions.pod:887
19497 #: ../fish/guestfish-actions.pod:889
19500 " egrep regex path\n"
19505 #: ../fish/guestfish-actions.pod:897
19510 #: ../fish/guestfish-actions.pod:899
19513 " egrepi regex path\n"
19518 #: ../fish/guestfish-actions.pod:907
19523 #: ../fish/guestfish-actions.pod:909
19526 " equal file1 file2\n"
19531 #: ../fish/guestfish-actions.pod:916
19536 #: ../fish/guestfish-actions.pod:918
19544 #: ../fish/guestfish-actions.pod:923
19545 msgid "See also L</is-file>, L</is-dir>, L</stat>."
19549 #: ../fish/guestfish-actions.pod:925
19554 #: ../fish/guestfish-actions.pod:927
19557 " fallocate path len\n"
19562 #: ../fish/guestfish-actions.pod:944
19563 msgid "fallocate64"
19567 #: ../fish/guestfish-actions.pod:946
19570 " fallocate64 path len\n"
19575 #: ../fish/guestfish-actions.pod:952
19577 "Note that this call allocates disk blocks for the file. To create a sparse "
19578 "file use L</truncate-size> instead."
19582 #: ../fish/guestfish-actions.pod:955
19584 "The deprecated call L</fallocate> does the same, but owing to an oversight "
19585 "it only allowed 30 bit lengths to be specified, effectively limiting the "
19586 "maximum size of files created through that call to 1GB."
19590 #: ../fish/guestfish-actions.pod:964
19595 #: ../fish/guestfish-actions.pod:966
19598 " fgrep pattern path\n"
19603 #: ../fish/guestfish-actions.pod:974
19608 #: ../fish/guestfish-actions.pod:976
19611 " fgrepi pattern path\n"
19616 #: ../fish/guestfish-actions.pod:984
19621 #: ../fish/guestfish-actions.pod:986
19629 #: ../fish/guestfish-actions.pod:998
19631 "This command can also be used on C</dev/> devices (and partitions, LV "
19632 "names). You can for example use this to determine if a device contains a "
19633 "filesystem, although it's usually better to use L</vfs-type>."
19637 #: ../fish/guestfish-actions.pod:1008
19638 msgid "file-architecture"
19642 #: ../fish/guestfish-actions.pod:1010
19645 " file-architecture filename\n"
19650 #: ../fish/guestfish-actions.pod:1113
19655 #: ../fish/guestfish-actions.pod:1115
19663 #: ../fish/guestfish-actions.pod:1119
19665 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
19666 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
19670 #: ../fish/guestfish-actions.pod:1123
19675 #: ../fish/guestfish-actions.pod:1125
19678 " fill c len path\n"
19683 #: ../fish/guestfish-actions.pod:1131
19685 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
19686 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
19687 "L</fill-pattern>."
19691 #: ../fish/guestfish-actions.pod:1136
19692 msgid "fill-pattern"
19696 #: ../fish/guestfish-actions.pod:1138
19699 " fill-pattern pattern len path\n"
19704 #: ../fish/guestfish-actions.pod:1140
19706 "This function is like L</fill> except that it creates a new file of length "
19707 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
19708 "is truncated if necessary to ensure the length of the file is exactly C<len> "
19713 #: ../fish/guestfish-actions.pod:1145
19718 #: ../fish/guestfish-actions.pod:1147
19721 " find directory\n"
19726 #: ../fish/guestfish-actions.pod:1161
19727 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
19731 #: ../fish/guestfish-actions.pod:1174
19732 msgid "See also L</find0>."
19736 #: ../fish/guestfish-actions.pod:1179
19741 #: ../fish/guestfish-actions.pod:1181
19744 " find0 directory (files|-)\n"
19749 #: ../fish/guestfish-actions.pod:1187
19751 "This command works the same way as L</find> with the following exceptions:"
19755 #: ../fish/guestfish-actions.pod:1214
19756 msgid "findfs-label"
19760 #: ../fish/guestfish-actions.pod:1216
19763 " findfs-label label\n"
19768 #: ../fish/guestfish-actions.pod:1222
19769 msgid "To find the label of a filesystem, use L</vfs-label>."
19773 #: ../fish/guestfish-actions.pod:1224
19774 msgid "findfs-uuid"
19778 #: ../fish/guestfish-actions.pod:1226
19781 " findfs-uuid uuid\n"
19786 #: ../fish/guestfish-actions.pod:1232
19787 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
19791 #: ../fish/guestfish-actions.pod:1234
19796 #: ../fish/guestfish-actions.pod:1236
19799 " fsck fstype device\n"
19804 #: ../fish/guestfish-actions.pod:1266
19809 #: ../fish/guestfish-actions.pod:1268
19817 #: ../fish/guestfish-actions.pod:1275
19818 msgid "get-autosync"
19822 #: ../fish/guestfish-actions.pod:1277
19830 #: ../fish/guestfish-actions.pod:1281
19835 #: ../fish/guestfish-actions.pod:1283
19843 #: ../fish/guestfish-actions.pod:1287
19844 msgid "get-e2label"
19848 #: ../fish/guestfish-actions.pod:1289
19851 " get-e2label device\n"
19856 #: ../fish/guestfish-actions.pod:1301
19861 #: ../fish/guestfish-actions.pod:1303
19864 " get-e2uuid device\n"
19869 #: ../fish/guestfish-actions.pod:1315
19870 msgid "get-memsize"
19874 #: ../fish/guestfish-actions.pod:1317
19882 #: ../fish/guestfish-actions.pod:1322
19884 "If L</set-memsize> was not called on this handle, and if "
19885 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
19886 "value for memsize."
19890 #: ../fish/guestfish-actions.pod:1329
19891 msgid "get-network"
19895 #: ../fish/guestfish-actions.pod:1331
19903 #: ../fish/guestfish-actions.pod:1335
19908 #: ../fish/guestfish-actions.pod:1337
19916 #: ../fish/guestfish-actions.pod:1344
19921 #: ../fish/guestfish-actions.pod:1346
19926 #: ../fish/guestfish-actions.pod:1348
19934 #: ../fish/guestfish-actions.pod:1355
19939 #: ../fish/guestfish-actions.pod:1357
19947 #: ../fish/guestfish-actions.pod:1364
19948 msgid "get-recovery-proc"
19952 #: ../fish/guestfish-actions.pod:1366
19955 " get-recovery-proc\n"
19960 #: ../fish/guestfish-actions.pod:1370
19961 msgid "get-selinux"
19965 #: ../fish/guestfish-actions.pod:1372
19973 #: ../fish/guestfish-actions.pod:1374
19975 "This returns the current setting of the selinux flag which is passed to the "
19976 "appliance at boot time. See L</set-selinux>."
19980 #: ../fish/guestfish-actions.pod:1380
19985 #: ../fish/guestfish-actions.pod:1382
19993 #: ../fish/guestfish-actions.pod:1389
19998 #: ../fish/guestfish-actions.pod:1391
20006 #: ../fish/guestfish-actions.pod:1395
20011 #: ../fish/guestfish-actions.pod:1397
20019 #: ../fish/guestfish-actions.pod:1399
20021 "Return the current umask. By default the umask is C<022> unless it has been "
20022 "set by calling L</umask>."
20026 #: ../fish/guestfish-actions.pod:1402
20027 msgid "get-verbose"
20031 #: ../fish/guestfish-actions.pod:1404
20039 #: ../fish/guestfish-actions.pod:1408
20044 #: ../fish/guestfish-actions.pod:1410
20052 #: ../fish/guestfish-actions.pod:1414
20053 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
20057 #: ../fish/guestfish-actions.pod:1417
20062 #: ../fish/guestfish-actions.pod:1419
20065 " getxattrs path\n"
20070 #: ../fish/guestfish-actions.pod:1427
20071 msgid "See also: L</lgetxattrs>, L<attr(5)>."
20075 #: ../fish/guestfish-actions.pod:1429
20076 msgid "glob-expand"
20080 #: ../fish/guestfish-actions.pod:1431
20083 " glob-expand pattern\n"
20088 #: ../fish/guestfish-actions.pod:1444
20093 #: ../fish/guestfish-actions.pod:1446
20096 " grep regex path\n"
20101 #: ../fish/guestfish-actions.pod:1454
20106 #: ../fish/guestfish-actions.pod:1456
20109 " grepi regex path\n"
20114 #: ../fish/guestfish-actions.pod:1464
20115 msgid "grub-install"
20119 #: ../fish/guestfish-actions.pod:1466
20122 " grub-install root device\n"
20127 #: ../fish/guestfish-actions.pod:1482
20132 #: ../fish/guestfish-actions.pod:1484
20140 #: ../fish/guestfish-actions.pod:1492
20145 #: ../fish/guestfish-actions.pod:1494
20148 " head-n nrlines path\n"
20153 #: ../fish/guestfish-actions.pod:1507
20158 #: ../fish/guestfish-actions.pod:1509
20166 #: ../fish/guestfish-actions.pod:1517
20171 #: ../fish/guestfish-actions.pod:1519
20174 " initrd-cat initrdpath filename\n"
20179 #: ../fish/guestfish-actions.pod:1531
20180 msgid "See also L</initrd-list>."
20184 #: ../fish/guestfish-actions.pod:1536
20185 msgid "initrd-list"
20189 #: ../fish/guestfish-actions.pod:1538
20192 " initrd-list path\n"
20197 #: ../fish/guestfish-actions.pod:1550
20198 msgid "inotify-add-watch"
20202 #: ../fish/guestfish-actions.pod:1552
20205 " inotify-add-watch path mask\n"
20210 #: ../fish/guestfish-actions.pod:1564
20211 msgid "inotify-close"
20215 #: ../fish/guestfish-actions.pod:1566
20223 #: ../fish/guestfish-actions.pod:1572
20224 msgid "inotify-files"
20228 #: ../fish/guestfish-actions.pod:1574
20236 #: ../fish/guestfish-actions.pod:1576
20238 "This function is a helpful wrapper around L</inotify-read> which just "
20239 "returns a list of pathnames of objects that were touched. The returned "
20240 "pathnames are sorted and deduplicated."
20244 #: ../fish/guestfish-actions.pod:1580
20245 msgid "inotify-init"
20249 #: ../fish/guestfish-actions.pod:1582
20252 " inotify-init maxevents\n"
20257 #: ../fish/guestfish-actions.pod:1588
20259 "C<maxevents> is the maximum number of events which will be queued up between "
20260 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
20261 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
20262 "default was 16384 events. Beyond this limit, the kernel throws away events, "
20263 "but records the fact that it threw them away by setting a flag "
20264 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
20268 #: ../fish/guestfish-actions.pod:1598
20270 "Before any events are generated, you have to add some watches to the "
20271 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
20272 "L</inotify-watch-all>."
20276 #: ../fish/guestfish-actions.pod:1604
20278 "Queued up events should be read periodically by calling L</inotify-read> (or "
20279 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
20280 "If you don't read the events out often enough then you risk the internal "
20281 "queue overflowing."
20285 #: ../fish/guestfish-actions.pod:1611
20287 "The handle should be closed after use by calling L</inotify-close>. This "
20288 "also removes any watches automatically."
20292 #: ../fish/guestfish-actions.pod:1620
20293 msgid "inotify-read"
20297 #: ../fish/guestfish-actions.pod:1622
20305 #: ../fish/guestfish-actions.pod:1635
20306 msgid "inotify-rm-watch"
20310 #: ../fish/guestfish-actions.pod:1637
20313 " inotify-rm-watch wd\n"
20318 #: ../fish/guestfish-actions.pod:1639
20319 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
20323 #: ../fish/guestfish-actions.pod:1642
20324 msgid "inspect-get-arch"
20328 #: ../fish/guestfish-actions.pod:1644
20331 " inspect-get-arch root\n"
20336 #: ../fish/guestfish-actions.pod:1646 ../fish/guestfish-actions.pod:1662
20337 #: ../fish/guestfish-actions.pod:1728 ../fish/guestfish-actions.pod:1746
20338 #: ../fish/guestfish-actions.pod:1767 ../fish/guestfish-actions.pod:1782
20339 #: ../fish/guestfish-actions.pod:1805 ../fish/guestfish-actions.pod:1822
20340 #: ../fish/guestfish-actions.pod:1853
20342 "This function should only be called with a root device string as returned by "
20347 #: ../fish/guestfish-actions.pod:1649
20349 "This returns the architecture of the inspected operating system. The "
20350 "possible return values are listed under L</file-architecture>."
20354 #: ../fish/guestfish-actions.pod:1658
20355 msgid "inspect-get-distro"
20359 #: ../fish/guestfish-actions.pod:1660
20362 " inspect-get-distro root\n"
20367 #: ../fish/guestfish-actions.pod:1724
20368 msgid "inspect-get-filesystems"
20372 #: ../fish/guestfish-actions.pod:1726
20375 " inspect-get-filesystems root\n"
20380 #: ../fish/guestfish-actions.pod:1739
20382 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
20383 "get-mountpoints>."
20387 #: ../fish/guestfish-actions.pod:1742
20388 msgid "inspect-get-major-version"
20392 #: ../fish/guestfish-actions.pod:1744
20395 " inspect-get-major-version root\n"
20400 #: ../fish/guestfish-actions.pod:1763
20401 msgid "inspect-get-minor-version"
20405 #: ../fish/guestfish-actions.pod:1765
20408 " inspect-get-minor-version root\n"
20413 #: ../fish/guestfish-actions.pod:1775
20415 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
20416 "get-major-version>."
20420 #: ../fish/guestfish-actions.pod:1778
20421 msgid "inspect-get-mountpoints"
20425 #: ../fish/guestfish-actions.pod:1780
20428 " inspect-get-mountpoints root\n"
20433 #: ../fish/guestfish-actions.pod:1798
20435 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
20436 "get-filesystems>."
20440 #: ../fish/guestfish-actions.pod:1801
20441 msgid "inspect-get-product-name"
20445 #: ../fish/guestfish-actions.pod:1803
20448 " inspect-get-product-name root\n"
20453 #: ../fish/guestfish-actions.pod:1818
20454 msgid "inspect-get-type"
20458 #: ../fish/guestfish-actions.pod:1820
20461 " inspect-get-type root\n"
20466 #: ../fish/guestfish-actions.pod:1849
20467 msgid "inspect-get-windows-systemroot"
20471 #: ../fish/guestfish-actions.pod:1851
20474 " inspect-get-windows-systemroot root\n"
20479 #: ../fish/guestfish-actions.pod:1865
20484 #: ../fish/guestfish-actions.pod:1867
20492 #: ../fish/guestfish-actions.pod:1882
20494 "You can pass the root string(s) returned to other L</inspect-get-*> "
20495 "functions in order to query further information about each operating system, "
20496 "such as the name and version."
20500 #: ../fish/guestfish-actions.pod:1887
20502 "This function uses other libguestfs features such as L</mount-ro> and L</"
20503 "umount-all> in order to mount and unmount filesystems and look at the "
20504 "contents. This should be called with no disks currently mounted. The "
20505 "function may also use Augeas, so any existing Augeas handle will be closed."
20509 #: ../fish/guestfish-actions.pod:1899 ../fish/guestfish-actions.pod:2055
20510 #: ../fish/guestfish-actions.pod:2101
20511 msgid "See also L</list-filesystems>."
20515 #: ../fish/guestfish-actions.pod:1901
20516 msgid "is-blockdev"
20520 #: ../fish/guestfish-actions.pod:1903
20523 " is-blockdev path\n"
20528 #: ../fish/guestfish-actions.pod:1908 ../fish/guestfish-actions.pod:1926
20529 #: ../fish/guestfish-actions.pod:1945 ../fish/guestfish-actions.pod:1954
20530 #: ../fish/guestfish-actions.pod:1964 ../fish/guestfish-actions.pod:1998
20531 #: ../fish/guestfish-actions.pod:2007
20532 msgid "See also L</stat>."
20536 #: ../fish/guestfish-actions.pod:1910
20541 #: ../fish/guestfish-actions.pod:1912
20549 #: ../fish/guestfish-actions.pod:1919
20554 #: ../fish/guestfish-actions.pod:1921
20557 " is-chardev path\n"
20562 #: ../fish/guestfish-actions.pod:1928
20567 #: ../fish/guestfish-actions.pod:1930
20575 #: ../fish/guestfish-actions.pod:1937
20580 #: ../fish/guestfish-actions.pod:1939
20588 #: ../fish/guestfish-actions.pod:1947
20593 #: ../fish/guestfish-actions.pod:1949
20601 #: ../fish/guestfish-actions.pod:1956
20606 #: ../fish/guestfish-actions.pod:1958
20614 #: ../fish/guestfish-actions.pod:1966
20615 msgid "is-launching"
20619 #: ../fish/guestfish-actions.pod:1968
20627 #: ../fish/guestfish-actions.pod:1975
20632 #: ../fish/guestfish-actions.pod:1977
20640 #: ../fish/guestfish-actions.pod:1982
20645 #: ../fish/guestfish-actions.pod:1984
20653 #: ../fish/guestfish-actions.pod:1991
20658 #: ../fish/guestfish-actions.pod:1993
20661 " is-socket path\n"
20666 #: ../fish/guestfish-actions.pod:2000
20671 #: ../fish/guestfish-actions.pod:2002
20674 " is-symlink path\n"
20679 #: ../fish/guestfish-actions.pod:2009
20680 msgid "kill-subprocess"
20684 #: ../fish/guestfish-actions.pod:2011
20687 " kill-subprocess\n"
20692 #: ../fish/guestfish-actions.pod:2015
20697 #: ../fish/guestfish-actions.pod:2017
20702 #: ../fish/guestfish-actions.pod:2019
20710 #: ../fish/guestfish-actions.pod:2027
20715 #: ../fish/guestfish-actions.pod:2029
20718 " lchown owner group path\n"
20723 #: ../fish/guestfish-actions.pod:2031
20725 "Change the file owner to C<owner> and group to C<group>. This is like L</"
20726 "chown> but if C<path> is a symlink then the link itself is changed, not the "
20731 #: ../fish/guestfish-actions.pod:2039
20736 #: ../fish/guestfish-actions.pod:2041
20739 " lgetxattrs path\n"
20744 #: ../fish/guestfish-actions.pod:2043
20746 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
20747 "it returns the extended attributes of the link itself."
20751 #: ../fish/guestfish-actions.pod:2047
20752 msgid "list-devices"
20756 #: ../fish/guestfish-actions.pod:2049
20764 #: ../fish/guestfish-actions.pod:2057
20765 msgid "list-filesystems"
20769 #: ../fish/guestfish-actions.pod:2059
20772 " list-filesystems\n"
20777 #: ../fish/guestfish-actions.pod:2078
20779 "This command runs other libguestfs commands, which might include L</mount> "
20780 "and L</umount>, and therefore you should use this soon after launch and only "
20781 "when nothing is mounted."
20785 #: ../fish/guestfish-actions.pod:2082
20787 "Not all of the filesystems returned will be mountable. In particular, swap "
20788 "partitions are returned in the list. Also this command does not check that "
20789 "each filesystem found is valid and mountable, and some filesystems might be "
20790 "mountable but require special options. Filesystems may not all belong to a "
20791 "single logical operating system (use L</inspect-os> to look for OSes)."
20795 #: ../fish/guestfish-actions.pod:2090
20796 msgid "list-partitions"
20800 #: ../fish/guestfish-actions.pod:2092
20803 " list-partitions\n"
20808 #: ../fish/guestfish-actions.pod:2098
20810 "This does not return logical volumes. For that you will need to call L</"
20815 #: ../fish/guestfish-actions.pod:2103
20820 #: ../fish/guestfish-actions.pod:2105
20828 #: ../fish/guestfish-actions.pod:2113
20833 #: ../fish/guestfish-actions.pod:2115
20836 " ln target linkname\n"
20841 #: ../fish/guestfish-actions.pod:2119
20846 #: ../fish/guestfish-actions.pod:2121
20849 " ln-f target linkname\n"
20854 #: ../fish/guestfish-actions.pod:2126
20859 #: ../fish/guestfish-actions.pod:2128
20862 " ln-s target linkname\n"
20867 #: ../fish/guestfish-actions.pod:2132
20872 #: ../fish/guestfish-actions.pod:2134
20875 " ln-sf target linkname\n"
20880 #: ../fish/guestfish-actions.pod:2139
20881 msgid "lremovexattr"
20885 #: ../fish/guestfish-actions.pod:2141
20888 " lremovexattr xattr path\n"
20893 #: ../fish/guestfish-actions.pod:2143
20895 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
20896 "it removes an extended attribute of the link itself."
20900 #: ../fish/guestfish-actions.pod:2147
20905 #: ../fish/guestfish-actions.pod:2149
20913 #: ../fish/guestfish-actions.pod:2155
20915 "This command is mostly useful for interactive sessions. Programs should "
20916 "probably use L</readdir> instead."
20920 #: ../fish/guestfish-actions.pod:2158
20925 #: ../fish/guestfish-actions.pod:2160
20928 " lsetxattr xattr val vallen path\n"
20933 #: ../fish/guestfish-actions.pod:2162
20935 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
20936 "sets an extended attribute of the link itself."
20940 #: ../fish/guestfish-actions.pod:2166
20945 #: ../fish/guestfish-actions.pod:2168
20953 #: ../fish/guestfish-actions.pod:2172
20955 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
20956 "the link is stat-ed, not the file it refers to."
20960 #: ../fish/guestfish-actions.pod:2178
20965 #: ../fish/guestfish-actions.pod:2180
20968 " lstatlist path 'names ...'\n"
20973 #: ../fish/guestfish-actions.pod:2182
20975 "This call allows you to perform the L</lstat> operation on multiple files, "
20976 "where all files are in the directory C<path>. C<names> is the list of files "
20977 "from this directory."
20981 #: ../fish/guestfish-actions.pod:2191
20983 "This call is intended for programs that want to efficiently list a directory "
20984 "contents without making many round-trips. See also L</lxattrlist> for a "
20985 "similarly efficient call for getting extended attributes. Very long "
20986 "directory listings might cause the protocol message size to be exceeded, "
20987 "causing this call to fail. The caller must split up such requests into "
20988 "smaller groups of names."
20992 #: ../fish/guestfish-actions.pod:2199
20993 msgid "luks-add-key"
20997 #: ../fish/guestfish-actions.pod:2201
21000 " luks-add-key device keyslot\n"
21005 #: ../fish/guestfish-actions.pod:2208
21007 "Note that if C<keyslot> already contains a key, then this command will "
21008 "fail. You have to use L</luks-kill-slot> first to remove that key."
21012 #: ../fish/guestfish-actions.pod:2212 ../fish/guestfish-actions.pod:2234
21013 #: ../fish/guestfish-actions.pod:2247 ../fish/guestfish-actions.pod:2261
21014 #: ../fish/guestfish-actions.pod:2284 ../fish/guestfish-actions.pod:2294
21016 "This command has one or more key or passphrase parameters. Guestfish will "
21017 "prompt for these separately."
21021 #: ../fish/guestfish-actions.pod:2215
21026 #: ../fish/guestfish-actions.pod:2217
21029 " luks-close device\n"
21034 #: ../fish/guestfish-actions.pod:2219
21036 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
21037 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
21038 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
21043 #: ../fish/guestfish-actions.pod:2225
21044 msgid "luks-format"
21048 #: ../fish/guestfish-actions.pod:2227
21051 " luks-format device keyslot\n"
21056 #: ../fish/guestfish-actions.pod:2240
21057 msgid "luks-format-cipher"
21061 #: ../fish/guestfish-actions.pod:2242
21064 " luks-format-cipher device keyslot cipher\n"
21069 #: ../fish/guestfish-actions.pod:2244
21071 "This command is the same as L</luks-format> but it also allows you to set "
21072 "the C<cipher> used."
21076 #: ../fish/guestfish-actions.pod:2253
21077 msgid "luks-kill-slot"
21081 #: ../fish/guestfish-actions.pod:2255
21084 " luks-kill-slot device keyslot\n"
21089 #: ../fish/guestfish-actions.pod:2264
21094 #: ../fish/guestfish-actions.pod:2266
21097 " luks-open device mapname\n"
21102 #: ../fish/guestfish-actions.pod:2280
21104 "If this block device contains LVM volume groups, then calling L</vgscan> "
21105 "followed by L</vg-activate-all> will make them visible."
21109 #: ../fish/guestfish-actions.pod:2287
21110 msgid "luks-open-ro"
21114 #: ../fish/guestfish-actions.pod:2289
21117 " luks-open-ro device mapname\n"
21122 #: ../fish/guestfish-actions.pod:2291
21124 "This is the same as L</luks-open> except that a read-only mapping is created."
21128 #: ../fish/guestfish-actions.pod:2297
21133 #: ../fish/guestfish-actions.pod:2299
21136 " lvcreate logvol volgroup mbytes\n"
21141 #: ../fish/guestfish-actions.pod:2304
21142 msgid "lvm-canonical-lv-name"
21146 #: ../fish/guestfish-actions.pod:2306
21149 " lvm-canonical-lv-name lvname\n"
21154 #: ../fish/guestfish-actions.pod:2315
21155 msgid "See also L</is-lv>."
21159 #: ../fish/guestfish-actions.pod:2317
21160 msgid "lvm-clear-filter"
21164 #: ../fish/guestfish-actions.pod:2319
21167 " lvm-clear-filter\n"
21172 #: ../fish/guestfish-actions.pod:2321
21174 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
21179 #: ../fish/guestfish-actions.pod:2327
21180 msgid "lvm-remove-all"
21184 #: ../fish/guestfish-actions.pod:2329
21187 " lvm-remove-all\n"
21192 #: ../fish/guestfish-actions.pod:2337
21193 msgid "lvm-set-filter"
21197 #: ../fish/guestfish-actions.pod:2339
21200 " lvm-set-filter 'devices ...'\n"
21205 #: ../fish/guestfish-actions.pod:2364
21210 #: ../fish/guestfish-actions.pod:2366
21213 " lvremove device\n"
21218 #: ../fish/guestfish-actions.pod:2374
21223 #: ../fish/guestfish-actions.pod:2376
21226 " lvrename logvol newlogvol\n"
21231 #: ../fish/guestfish-actions.pod:2380
21236 #: ../fish/guestfish-actions.pod:2382
21239 " lvresize device mbytes\n"
21244 #: ../fish/guestfish-actions.pod:2388
21245 msgid "lvresize-free"
21249 #: ../fish/guestfish-actions.pod:2390
21252 " lvresize-free lv percent\n"
21257 #: ../fish/guestfish-actions.pod:2398
21262 #: ../fish/guestfish-actions.pod:2400
21270 #: ../fish/guestfish-actions.pod:2408
21271 msgid "See also L</lvs-full>, L</list-filesystems>."
21275 #: ../fish/guestfish-actions.pod:2410
21280 #: ../fish/guestfish-actions.pod:2412
21288 #: ../fish/guestfish-actions.pod:2417
21293 #: ../fish/guestfish-actions.pod:2419
21301 #: ../fish/guestfish-actions.pod:2423
21306 #: ../fish/guestfish-actions.pod:2425
21309 " lxattrlist path 'names ...'\n"
21314 #: ../fish/guestfish-actions.pod:2441
21316 "This call is intended for programs that want to efficiently list a directory "
21317 "contents without making many round-trips. See also L</lstatlist> for a "
21318 "similarly efficient call for getting standard stats. Very long directory "
21319 "listings might cause the protocol message size to be exceeded, causing this "
21320 "call to fail. The caller must split up such requests into smaller groups of "
21325 #: ../fish/guestfish-actions.pod:2449
21330 #: ../fish/guestfish-actions.pod:2451
21338 #: ../fish/guestfish-actions.pod:2455
21343 #: ../fish/guestfish-actions.pod:2457
21346 " mkdir-mode path mode\n"
21351 #: ../fish/guestfish-actions.pod:2466
21352 msgid "See also L</mkdir>, L</umask>"
21356 #: ../fish/guestfish-actions.pod:2468
21361 #: ../fish/guestfish-actions.pod:2470
21369 #: ../fish/guestfish-actions.pod:2475
21374 #: ../fish/guestfish-actions.pod:2477
21377 " mkdtemp template\n"
21382 #: ../fish/guestfish-actions.pod:2498
21387 #: ../fish/guestfish-actions.pod:2500
21390 " mke2fs-J fstype blocksize device journal\n"
21395 #: ../fish/guestfish-actions.pod:2508
21396 msgid "See also L</mke2journal>."
21400 #: ../fish/guestfish-actions.pod:2510
21405 #: ../fish/guestfish-actions.pod:2512
21408 " mke2fs-JL fstype blocksize device label\n"
21413 #: ../fish/guestfish-actions.pod:2517
21414 msgid "See also L</mke2journal-L>."
21418 #: ../fish/guestfish-actions.pod:2519
21423 #: ../fish/guestfish-actions.pod:2521
21426 " mke2fs-JU fstype blocksize device uuid\n"
21431 #: ../fish/guestfish-actions.pod:2526
21432 msgid "See also L</mke2journal-U>."
21436 #: ../fish/guestfish-actions.pod:2528
21437 msgid "mke2journal"
21441 #: ../fish/guestfish-actions.pod:2530
21444 " mke2journal blocksize device\n"
21449 #: ../fish/guestfish-actions.pod:2537
21450 msgid "mke2journal-L"
21454 #: ../fish/guestfish-actions.pod:2539
21457 " mke2journal-L blocksize label device\n"
21462 #: ../fish/guestfish-actions.pod:2543
21463 msgid "mke2journal-U"
21467 #: ../fish/guestfish-actions.pod:2545
21470 " mke2journal-U blocksize uuid device\n"
21475 #: ../fish/guestfish-actions.pod:2549
21480 #: ../fish/guestfish-actions.pod:2551
21483 " mkfifo mode path\n"
21488 #: ../fish/guestfish-actions.pod:2553
21490 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
21491 "is just a convenient wrapper around L</mknod>."
21495 #: ../fish/guestfish-actions.pod:2559
21500 #: ../fish/guestfish-actions.pod:2561
21503 " mkfs fstype device\n"
21508 #: ../fish/guestfish-actions.pod:2567
21513 #: ../fish/guestfish-actions.pod:2569
21516 " mkfs-b fstype blocksize device\n"
21521 #: ../fish/guestfish-actions.pod:2571
21523 "This call is similar to L</mkfs>, but it allows you to control the block "
21524 "size of the resulting filesystem. Supported block sizes depend on the "
21525 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
21529 #: ../fish/guestfish-actions.pod:2579
21530 msgid "mkmountpoint"
21534 #: ../fish/guestfish-actions.pod:2581
21537 " mkmountpoint exemptpath\n"
21542 #: ../fish/guestfish-actions.pod:2583
21544 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
21545 "to create extra mountpoints before mounting the first filesystem."
21549 #: ../fish/guestfish-actions.pod:2607
21551 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
21552 "unexpected errors if you try to mix these calls. It is safest to manually "
21553 "unmount filesystems and remove mountpoints after use."
21557 #: ../fish/guestfish-actions.pod:2611
21559 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
21560 "for this to work for manual mountpoints, you must ensure that the innermost "
21561 "mountpoints have the longest pathnames, as in the example code above."
21565 #: ../fish/guestfish-actions.pod:2618
21567 "Autosync [see L</set-autosync>, this is set by default on handles] means "
21568 "that L</umount-all> is called when the handle is closed which can also "
21569 "trigger these issues."
21573 #: ../fish/guestfish-actions.pod:2622
21578 #: ../fish/guestfish-actions.pod:2624
21581 " mknod mode devmajor devminor path\n"
21586 #: ../fish/guestfish-actions.pod:2634
21588 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
21589 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
21590 "regular file). These constants are available in the standard Linux header "
21591 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
21592 "wrappers around this command which bitwise OR in the appropriate constant "
21597 #: ../fish/guestfish-actions.pod:2644
21602 #: ../fish/guestfish-actions.pod:2646
21605 " mknod-b mode devmajor devminor path\n"
21610 #: ../fish/guestfish-actions.pod:2648
21612 "This call creates a block device node called C<path> with mode C<mode> and "
21613 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
21614 "wrapper around L</mknod>."
21618 #: ../fish/guestfish-actions.pod:2654
21623 #: ../fish/guestfish-actions.pod:2656
21626 " mknod-c mode devmajor devminor path\n"
21631 #: ../fish/guestfish-actions.pod:2658
21633 "This call creates a char device node called C<path> with mode C<mode> and "
21634 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
21635 "wrapper around L</mknod>."
21639 #: ../fish/guestfish-actions.pod:2664
21644 #: ../fish/guestfish-actions.pod:2666
21652 #: ../fish/guestfish-actions.pod:2670
21657 #: ../fish/guestfish-actions.pod:2672
21660 " mkswap-L label device\n"
21665 #: ../fish/guestfish-actions.pod:2680
21670 #: ../fish/guestfish-actions.pod:2682
21673 " mkswap-U uuid device\n"
21678 #: ../fish/guestfish-actions.pod:2686
21679 msgid "mkswap-file"
21683 #: ../fish/guestfish-actions.pod:2688
21686 " mkswap-file path\n"
21691 #: ../fish/guestfish-actions.pod:2692
21693 "This command just writes a swap file signature to an existing file. To "
21694 "create the file itself, use something like L</fallocate>."
21698 #: ../fish/guestfish-actions.pod:2695
21703 #: ../fish/guestfish-actions.pod:2697
21706 " modprobe modulename\n"
21711 #: ../fish/guestfish-actions.pod:2704
21716 #: ../fish/guestfish-actions.pod:2706
21719 " mount device mountpoint\n"
21724 #: ../fish/guestfish-actions.pod:2722
21726 "B<Important note:> When you use this call, the filesystem options C<sync> "
21727 "and C<noatime> are set implicitly. This was originally done because we "
21728 "thought it would improve reliability, but it turns out that I<-o sync> has a "
21729 "very large negative performance impact and negligible effect on "
21730 "reliability. Therefore we recommend that you avoid using L</mount> in any "
21731 "code that needs performance, and instead use L</mount-options> (use an empty "
21732 "string for the first parameter if you don't want any options)."
21736 #: ../fish/guestfish-actions.pod:2732
21741 #: ../fish/guestfish-actions.pod:2734
21744 " mount-loop file mountpoint\n"
21749 #: ../fish/guestfish-actions.pod:2740
21750 msgid "mount-options"
21754 #: ../fish/guestfish-actions.pod:2742
21757 " mount-options options device mountpoint\n"
21762 #: ../fish/guestfish-actions.pod:2744
21764 "This is the same as the L</mount> command, but it allows you to set the "
21765 "mount options as for the L<mount(8)> I<-o> flag."
21769 #: ../fish/guestfish-actions.pod:2752
21774 #: ../fish/guestfish-actions.pod:2754
21777 " mount-ro device mountpoint\n"
21782 #: ../fish/guestfish-actions.pod:2756
21784 "This is the same as the L</mount> command, but it mounts the filesystem with "
21785 "the read-only (I<-o ro>) flag."
21789 #: ../fish/guestfish-actions.pod:2759
21794 #: ../fish/guestfish-actions.pod:2761
21797 " mount-vfs options vfstype device mountpoint\n"
21802 #: ../fish/guestfish-actions.pod:2763
21804 "This is the same as the L</mount> command, but it allows you to set both the "
21805 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
21809 #: ../fish/guestfish-actions.pod:2767
21810 msgid "mountpoints"
21814 #: ../fish/guestfish-actions.pod:2769
21822 #: ../fish/guestfish-actions.pod:2771
21824 "This call is similar to L</mounts>. That call returns a list of devices. "
21825 "This one returns a hash table (map) of device name to directory where the "
21826 "device is mounted."
21830 #: ../fish/guestfish-actions.pod:2775
21835 #: ../fish/guestfish-actions.pod:2777
21843 #: ../fish/guestfish-actions.pod:2784
21844 msgid "See also: L</mountpoints>"
21848 #: ../fish/guestfish-actions.pod:2786
21853 #: ../fish/guestfish-actions.pod:2788
21861 #: ../fish/guestfish-actions.pod:2793
21862 msgid "ntfs-3g-probe"
21866 #: ../fish/guestfish-actions.pod:2795
21869 " ntfs-3g-probe true|false device\n"
21874 #: ../fish/guestfish-actions.pod:2809
21879 #: ../fish/guestfish-actions.pod:2811
21882 " ntfsresize device\n"
21887 #: ../fish/guestfish-actions.pod:2817
21888 msgid "ntfsresize-size"
21892 #: ../fish/guestfish-actions.pod:2819
21895 " ntfsresize-size device size\n"
21900 #: ../fish/guestfish-actions.pod:2821
21902 "This command is the same as L</ntfsresize> except that it allows you to "
21903 "specify the new size (in bytes) explicitly."
21907 #: ../fish/guestfish-actions.pod:2824
21912 #: ../fish/guestfish-actions.pod:2826
21915 " part-add device prlogex startsect endsect\n"
21920 #: ../fish/guestfish-actions.pod:2828
21922 "This command adds a partition to C<device>. If there is no partition table "
21923 "on the device, call L</part-init> first."
21927 #: ../fish/guestfish-actions.pod:2840
21929 "Creating a partition which covers the whole disk is not so easy. Use L</"
21930 "part-disk> to do that."
21934 #: ../fish/guestfish-actions.pod:2843
21939 #: ../fish/guestfish-actions.pod:2845
21942 " part-del device partnum\n"
21947 #: ../fish/guestfish-actions.pod:2853
21952 #: ../fish/guestfish-actions.pod:2855
21955 " part-disk device parttype\n"
21960 #: ../fish/guestfish-actions.pod:2857
21962 "This command is simply a combination of L</part-init> followed by L</part-"
21963 "add> to create a single primary partition covering the whole disk."
21967 #: ../fish/guestfish-actions.pod:2861
21969 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
21970 "possible values are described in L</part-init>."
21974 #: ../fish/guestfish-actions.pod:2867
21975 msgid "part-get-bootable"
21979 #: ../fish/guestfish-actions.pod:2869
21982 " part-get-bootable device partnum\n"
21987 #: ../fish/guestfish-actions.pod:2874
21988 msgid "See also L</part-set-bootable>."
21992 #: ../fish/guestfish-actions.pod:2876
21993 msgid "part-get-mbr-id"
21997 #: ../fish/guestfish-actions.pod:2878
22000 " part-get-mbr-id device partnum\n"
22005 #: ../fish/guestfish-actions.pod:2883 ../fish/guestfish-actions.pod:3021
22007 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
22008 "undefined results for other partition table types (see L</part-get-"
22013 #: ../fish/guestfish-actions.pod:2887
22014 msgid "part-get-parttype"
22018 #: ../fish/guestfish-actions.pod:2889
22021 " part-get-parttype device\n"
22026 #: ../fish/guestfish-actions.pod:2894
22028 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
22029 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
22030 "possible, although unusual. See L</part-init> for a full list."
22034 #: ../fish/guestfish-actions.pod:2899
22039 #: ../fish/guestfish-actions.pod:2901
22042 " part-init device parttype\n"
22047 #: ../fish/guestfish-actions.pod:2907
22049 "Initially there are no partitions. Following this, you should call L</part-"
22050 "add> for each partition required."
22054 #: ../fish/guestfish-actions.pod:2970
22059 #: ../fish/guestfish-actions.pod:2972
22062 " part-list device\n"
22067 #: ../fish/guestfish-actions.pod:2987
22069 "Start of the partition I<in bytes>. To get sectors you have to divide by "
22070 "the device's sector size, see L</blockdev-getss>."
22074 #: ../fish/guestfish-actions.pod:3000
22075 msgid "part-set-bootable"
22079 #: ../fish/guestfish-actions.pod:3002
22082 " part-set-bootable device partnum true|false\n"
22087 #: ../fish/guestfish-actions.pod:3011
22088 msgid "part-set-mbr-id"
22092 #: ../fish/guestfish-actions.pod:3013
22095 " part-set-mbr-id device partnum idbyte\n"
22100 #: ../fish/guestfish-actions.pod:3025
22101 msgid "part-set-name"
22105 #: ../fish/guestfish-actions.pod:3027
22108 " part-set-name device partnum name\n"
22113 #: ../fish/guestfish-actions.pod:3035
22114 msgid "part-to-dev"
22118 #: ../fish/guestfish-actions.pod:3037
22121 " part-to-dev partition\n"
22126 #: ../fish/guestfish-actions.pod:3043
22128 "The named partition must exist, for example as a string returned from L</"
22129 "list-partitions>."
22133 #: ../fish/guestfish-actions.pod:3046
22134 msgid "ping-daemon"
22138 #: ../fish/guestfish-actions.pod:3048
22146 #: ../fish/guestfish-actions.pod:3055
22151 #: ../fish/guestfish-actions.pod:3057
22154 " pread path count offset\n"
22159 #: ../fish/guestfish-actions.pod:3065
22160 msgid "See also L</pwrite>, L</pread-device>."
22164 #: ../fish/guestfish-actions.pod:3070
22165 msgid "pread-device"
22169 #: ../fish/guestfish-actions.pod:3072
22172 " pread-device device count offset\n"
22177 #: ../fish/guestfish-actions.pod:3080
22178 msgid "See also L</pread>."
22182 #: ../fish/guestfish-actions.pod:3085
22187 #: ../fish/guestfish-actions.pod:3087
22190 " pvcreate device\n"
22195 #: ../fish/guestfish-actions.pod:3093
22200 #: ../fish/guestfish-actions.pod:3095
22203 " pvremove device\n"
22208 #: ../fish/guestfish-actions.pod:3104
22213 #: ../fish/guestfish-actions.pod:3106
22216 " pvresize device\n"
22221 #: ../fish/guestfish-actions.pod:3111
22222 msgid "pvresize-size"
22226 #: ../fish/guestfish-actions.pod:3113
22229 " pvresize-size device size\n"
22234 #: ../fish/guestfish-actions.pod:3115
22236 "This command is the same as L</pvresize> except that it allows you to "
22237 "specify the new size (in bytes) explicitly."
22241 #: ../fish/guestfish-actions.pod:3118
22246 #: ../fish/guestfish-actions.pod:3120
22254 #: ../fish/guestfish-actions.pod:3128
22255 msgid "See also L</pvs-full>."
22259 #: ../fish/guestfish-actions.pod:3130
22264 #: ../fish/guestfish-actions.pod:3132
22272 #: ../fish/guestfish-actions.pod:3137
22277 #: ../fish/guestfish-actions.pod:3139
22285 #: ../fish/guestfish-actions.pod:3143
22290 #: ../fish/guestfish-actions.pod:3145
22293 " pwrite path content offset\n"
22298 #: ../fish/guestfish-actions.pod:3156
22299 msgid "See also L</pread>, L</pwrite-device>."
22303 #: ../fish/guestfish-actions.pod:3161
22304 msgid "pwrite-device"
22308 #: ../fish/guestfish-actions.pod:3163
22311 " pwrite-device device content offset\n"
22316 #: ../fish/guestfish-actions.pod:3173
22317 msgid "See also L</pwrite>."
22321 #: ../fish/guestfish-actions.pod:3178
22326 #: ../fish/guestfish-actions.pod:3180
22329 " read-file path\n"
22334 #: ../fish/guestfish-actions.pod:3185
22336 "Unlike L</cat>, this function can correctly handle files that contain "
22337 "embedded ASCII NUL characters. However unlike L</download>, this function "
22338 "is limited in the total size of file that can be handled."
22342 #: ../fish/guestfish-actions.pod:3193
22347 #: ../fish/guestfish-actions.pod:3195
22350 " read-lines path\n"
22355 #: ../fish/guestfish-actions.pod:3202
22357 "Note that this function cannot correctly handle binary files (specifically, "
22358 "files containing C<\\0> character which is treated as end of line). For "
22359 "those you need to use the L</read-file> function which has a more complex "
22364 #: ../fish/guestfish-actions.pod:3207
22369 #: ../fish/guestfish-actions.pod:3209
22377 #: ../fish/guestfish-actions.pod:3261
22379 "This function is primarily intended for use by programs. To get a simple "
22380 "list of names, use L</ls>. To get a printable directory for human "
22381 "consumption, use L</ll>."
22385 #: ../fish/guestfish-actions.pod:3265
22390 #: ../fish/guestfish-actions.pod:3267
22398 #: ../fish/guestfish-actions.pod:3271
22399 msgid "readlinklist"
22403 #: ../fish/guestfish-actions.pod:3273
22406 " readlinklist path 'names ...'\n"
22411 #: ../fish/guestfish-actions.pod:3297
22416 #: ../fish/guestfish-actions.pod:3299
22424 #: ../fish/guestfish-actions.pod:3304
22425 msgid "removexattr"
22429 #: ../fish/guestfish-actions.pod:3306
22432 " removexattr xattr path\n"
22437 #: ../fish/guestfish-actions.pod:3311
22438 msgid "See also: L</lremovexattr>, L<attr(5)>."
22442 #: ../fish/guestfish-actions.pod:3313
22447 #: ../fish/guestfish-actions.pod:3315
22450 " resize2fs device\n"
22455 #: ../fish/guestfish-actions.pod:3320
22457 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
22458 "before calling this command. For unknown reasons C<resize2fs> sometimes "
22459 "gives an error about this and sometimes not. In any case, it is always safe "
22460 "to call L</e2fsck-f> before calling this function."
22464 #: ../fish/guestfish-actions.pod:3326
22465 msgid "resize2fs-size"
22469 #: ../fish/guestfish-actions.pod:3328
22472 " resize2fs-size device size\n"
22477 #: ../fish/guestfish-actions.pod:3330
22479 "This command is the same as L</resize2fs> except that it allows you to "
22480 "specify the new size (in bytes) explicitly."
22484 #: ../fish/guestfish-actions.pod:3333
22489 #: ../fish/guestfish-actions.pod:3335
22497 #: ../fish/guestfish-actions.pod:3339
22502 #: ../fish/guestfish-actions.pod:3341
22510 #: ../fish/guestfish-actions.pod:3347
22515 #: ../fish/guestfish-actions.pod:3349
22523 #: ../fish/guestfish-actions.pod:3353
22524 msgid "rmmountpoint"
22528 #: ../fish/guestfish-actions.pod:3355
22531 " rmmountpoint exemptpath\n"
22536 #: ../fish/guestfish-actions.pod:3357
22538 "This calls removes a mountpoint that was previously created with L</"
22539 "mkmountpoint>. See L</mkmountpoint> for full details."
22543 #: ../fish/guestfish-actions.pod:3361
22544 msgid "scrub-device"
22548 #: ../fish/guestfish-actions.pod:3363
22551 " scrub-device device\n"
22556 #: ../fish/guestfish-actions.pod:3374
22561 #: ../fish/guestfish-actions.pod:3376
22564 " scrub-file file\n"
22569 #: ../fish/guestfish-actions.pod:3386
22570 msgid "scrub-freespace"
22574 #: ../fish/guestfish-actions.pod:3388
22577 " scrub-freespace dir\n"
22582 #: ../fish/guestfish-actions.pod:3390
22584 "This command creates the directory C<dir> and then fills it with files until "
22585 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
22586 "deletes them. The intention is to scrub any free space on the partition "
22587 "containing C<dir>."
22591 #: ../fish/guestfish-actions.pod:3399
22596 #: ../fish/guestfish-actions.pod:3401
22601 #: ../fish/guestfish-actions.pod:3403
22604 " set-append append\n"
22609 #: ../fish/guestfish-actions.pod:3414
22610 msgid "set-autosync"
22614 #: ../fish/guestfish-actions.pod:3416
22619 #: ../fish/guestfish-actions.pod:3418
22622 " set-autosync true|false\n"
22627 #: ../fish/guestfish-actions.pod:3420
22629 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
22630 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
22631 "closed (also if the program exits without closing handles)."
22635 #: ../fish/guestfish-actions.pod:3428
22640 #: ../fish/guestfish-actions.pod:3430
22645 #: ../fish/guestfish-actions.pod:3432
22648 " set-direct true|false\n"
22653 #: ../fish/guestfish-actions.pod:3438
22655 "One consequence of this is that log messages aren't caught by the library "
22656 "and handled by L</set-log-message-callback>, but go straight to stdout."
22660 #: ../fish/guestfish-actions.pod:3447
22661 msgid "set-e2label"
22665 #: ../fish/guestfish-actions.pod:3449
22668 " set-e2label device label\n"
22673 #: ../fish/guestfish-actions.pod:3455
22675 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
22676 "label on a filesystem."
22680 #: ../fish/guestfish-actions.pod:3458
22685 #: ../fish/guestfish-actions.pod:3460
22688 " set-e2uuid device uuid\n"
22693 #: ../fish/guestfish-actions.pod:3467
22695 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
22696 "UUID of a filesystem."
22700 #: ../fish/guestfish-actions.pod:3470
22701 msgid "set-memsize"
22705 #: ../fish/guestfish-actions.pod:3472
22710 #: ../fish/guestfish-actions.pod:3474
22713 " set-memsize memsize\n"
22718 #: ../fish/guestfish-actions.pod:3476
22720 "This sets the memory size in megabytes allocated to the qemu subprocess. "
22721 "This only has any effect if called before L</launch>."
22725 #: ../fish/guestfish-actions.pod:3487
22726 msgid "set-network"
22730 #: ../fish/guestfish-actions.pod:3489
22735 #: ../fish/guestfish-actions.pod:3491
22738 " set-network true|false\n"
22743 #: ../fish/guestfish-actions.pod:3499
22745 "You must call this before calling L</launch>, otherwise it has no effect."
22749 #: ../fish/guestfish-actions.pod:3502
22754 #: ../fish/guestfish-actions.pod:3504
22759 #: ../fish/guestfish-actions.pod:3506
22762 " set-path searchpath\n"
22767 #: ../fish/guestfish-actions.pod:3515
22772 #: ../fish/guestfish-actions.pod:3517
22777 #: ../fish/guestfish-actions.pod:3519
22785 #: ../fish/guestfish-actions.pod:3539
22786 msgid "set-recovery-proc"
22790 #: ../fish/guestfish-actions.pod:3541
22791 msgid "recovery-proc"
22795 #: ../fish/guestfish-actions.pod:3543
22798 " set-recovery-proc true|false\n"
22803 #: ../fish/guestfish-actions.pod:3545
22805 "If this is called with the parameter C<false> then L</launch> does not "
22806 "create a recovery process. The purpose of the recovery process is to stop "
22807 "runaway qemu processes in the case where the main program aborts abruptly."
22811 #: ../fish/guestfish-actions.pod:3550
22813 "This only has any effect if called before L</launch>, and the default is "
22818 #: ../fish/guestfish-actions.pod:3559
22819 msgid "set-selinux"
22823 #: ../fish/guestfish-actions.pod:3561
22828 #: ../fish/guestfish-actions.pod:3563
22831 " set-selinux true|false\n"
22836 #: ../fish/guestfish-actions.pod:3574
22841 #: ../fish/guestfish-actions.pod:3576
22846 #: ../fish/guestfish-actions.pod:3578
22849 " set-trace true|false\n"
22854 #: ../fish/guestfish-actions.pod:3594
22855 msgid "set-verbose"
22859 #: ../fish/guestfish-actions.pod:3596
22864 #: ../fish/guestfish-actions.pod:3598
22867 " set-verbose true|false\n"
22872 #: ../fish/guestfish-actions.pod:3605
22877 #: ../fish/guestfish-actions.pod:3607
22880 " setcon context\n"
22885 #: ../fish/guestfish-actions.pod:3614
22890 #: ../fish/guestfish-actions.pod:3616
22893 " setxattr xattr val vallen path\n"
22898 #: ../fish/guestfish-actions.pod:3622
22899 msgid "See also: L</lsetxattr>, L<attr(5)>."
22903 #: ../fish/guestfish-actions.pod:3624
22908 #: ../fish/guestfish-actions.pod:3626
22911 " sfdisk device cyls heads sectors 'lines ...'\n"
22916 #: ../fish/guestfish-actions.pod:3648
22917 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
22921 #: ../fish/guestfish-actions.pod:3654
22926 #: ../fish/guestfish-actions.pod:3656
22929 " sfdiskM device 'lines ...'\n"
22934 #: ../fish/guestfish-actions.pod:3658
22936 "This is a simplified interface to the L</sfdisk> command, where partition "
22937 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
22938 "you don't need to specify the cyls, heads and sectors parameters which were "
22939 "rarely if ever used anyway."
22943 #: ../fish/guestfish-actions.pod:3664
22944 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
22948 #: ../fish/guestfish-actions.pod:3670
22953 #: ../fish/guestfish-actions.pod:3672
22956 " sfdisk-N device partnum cyls heads sectors line\n"
22961 #: ../fish/guestfish-actions.pod:3677
22963 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
22964 "cyls/heads/sectors parameters."
22968 #: ../fish/guestfish-actions.pod:3680
22969 msgid "See also: L</part-add>"
22973 #: ../fish/guestfish-actions.pod:3685
22974 msgid "sfdisk-disk-geometry"
22978 #: ../fish/guestfish-actions.pod:3687
22981 " sfdisk-disk-geometry device\n"
22986 #: ../fish/guestfish-actions.pod:3689
22988 "This displays the disk geometry of C<device> read from the partition table. "
22989 "Especially in the case where the underlying block device has been resized, "
22990 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
22991 "kernel-geometry>)."
22995 #: ../fish/guestfish-actions.pod:3697
22996 msgid "sfdisk-kernel-geometry"
23000 #: ../fish/guestfish-actions.pod:3699
23003 " sfdisk-kernel-geometry device\n"
23008 #: ../fish/guestfish-actions.pod:3706
23013 #: ../fish/guestfish-actions.pod:3708
23016 " sfdisk-l device\n"
23021 #: ../fish/guestfish-actions.pod:3714
23022 msgid "See also: L</part-list>"
23026 #: ../fish/guestfish-actions.pod:3716
23031 #: ../fish/guestfish-actions.pod:3718
23039 #: ../fish/guestfish-actions.pod:3723
23040 msgid "This is like L</command>, but passes the command to:"
23044 #: ../fish/guestfish-actions.pod:3731
23045 msgid "All the provisos about L</command> apply to this call."
23049 #: ../fish/guestfish-actions.pod:3733
23054 #: ../fish/guestfish-actions.pod:3735
23057 " sh-lines command\n"
23062 #: ../fish/guestfish-actions.pod:3737
23063 msgid "This is the same as L</sh>, but splits the result into a list of lines."
23067 #: ../fish/guestfish-actions.pod:3740
23068 msgid "See also: L</command-lines>"
23072 #: ../fish/guestfish-actions.pod:3742
23077 #: ../fish/guestfish-actions.pod:3744
23085 #: ../fish/guestfish-actions.pod:3748
23090 #: ../fish/guestfish-actions.pod:3750
23098 #: ../fish/guestfish-actions.pod:3756
23103 #: ../fish/guestfish-actions.pod:3758
23111 #: ../fish/guestfish-actions.pod:3766
23116 #: ../fish/guestfish-actions.pod:3768
23124 #: ../fish/guestfish-actions.pod:3776
23129 #: ../fish/guestfish-actions.pod:3778
23132 " strings-e encoding path\n"
23137 #: ../fish/guestfish-actions.pod:3780
23139 "This is like the L</strings> command, but allows you to specify the encoding "
23140 "of strings that are looked for in the source file C<path>."
23144 #: ../fish/guestfish-actions.pod:3790
23146 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
23147 "ISO-8859-X (this is what L</strings> uses)."
23151 #: ../fish/guestfish-actions.pod:3822
23152 msgid "swapoff-device"
23156 #: ../fish/guestfish-actions.pod:3824
23159 " swapoff-device device\n"
23164 #: ../fish/guestfish-actions.pod:3826
23166 "This command disables the libguestfs appliance swap device or partition "
23167 "named C<device>. See L</swapon-device>."
23171 #: ../fish/guestfish-actions.pod:3830
23172 msgid "swapoff-file"
23176 #: ../fish/guestfish-actions.pod:3832
23179 " swapoff-file file\n"
23184 #: ../fish/guestfish-actions.pod:3836
23185 msgid "swapoff-label"
23189 #: ../fish/guestfish-actions.pod:3838
23192 " swapoff-label label\n"
23197 #: ../fish/guestfish-actions.pod:3843
23198 msgid "swapoff-uuid"
23202 #: ../fish/guestfish-actions.pod:3845
23205 " swapoff-uuid uuid\n"
23210 #: ../fish/guestfish-actions.pod:3850
23211 msgid "swapon-device"
23215 #: ../fish/guestfish-actions.pod:3852
23218 " swapon-device device\n"
23223 #: ../fish/guestfish-actions.pod:3854
23225 "This command enables the libguestfs appliance to use the swap device or "
23226 "partition named C<device>. The increased memory is made available for all "
23227 "commands, for example those run using L</command> or L</sh>."
23231 #: ../fish/guestfish-actions.pod:3866
23232 msgid "swapon-file"
23236 #: ../fish/guestfish-actions.pod:3868
23239 " swapon-file file\n"
23244 #: ../fish/guestfish-actions.pod:3870
23246 "This command enables swap to a file. See L</swapon-device> for other notes."
23250 #: ../fish/guestfish-actions.pod:3873
23251 msgid "swapon-label"
23255 #: ../fish/guestfish-actions.pod:3875
23258 " swapon-label label\n"
23263 #: ../fish/guestfish-actions.pod:3877
23265 "This command enables swap to a labeled swap partition. See L</swapon-"
23266 "device> for other notes."
23270 #: ../fish/guestfish-actions.pod:3880
23271 msgid "swapon-uuid"
23275 #: ../fish/guestfish-actions.pod:3882
23278 " swapon-uuid uuid\n"
23283 #: ../fish/guestfish-actions.pod:3884
23285 "This command enables swap to a swap partition with the given UUID. See L</"
23286 "swapon-device> for other notes."
23290 #: ../fish/guestfish-actions.pod:3887
23295 #: ../fish/guestfish-actions.pod:3889
23303 #: ../fish/guestfish-actions.pod:3897
23308 #: ../fish/guestfish-actions.pod:3899
23316 #: ../fish/guestfish-actions.pod:3907
23321 #: ../fish/guestfish-actions.pod:3909
23324 " tail-n nrlines path\n"
23329 #: ../fish/guestfish-actions.pod:3922
23334 #: ../fish/guestfish-actions.pod:3924
23337 " tar-in (tarfile|-) directory\n"
23342 #: ../fish/guestfish-actions.pod:3929
23343 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
23347 #: ../fish/guestfish-actions.pod:3934
23352 #: ../fish/guestfish-actions.pod:3936
23355 " tar-out directory (tarfile|-)\n"
23360 #: ../fish/guestfish-actions.pod:3941
23361 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
23365 #: ../fish/guestfish-actions.pod:3946
23370 #: ../fish/guestfish-actions.pod:3948
23373 " tgz-in (tarball|-) directory\n"
23378 #: ../fish/guestfish-actions.pod:3953
23379 msgid "To upload an uncompressed tarball, use L</tar-in>."
23383 #: ../fish/guestfish-actions.pod:3957
23388 #: ../fish/guestfish-actions.pod:3959
23391 " tgz-out directory (tarball|-)\n"
23396 #: ../fish/guestfish-actions.pod:3964
23397 msgid "To download an uncompressed tarball, use L</tar-out>."
23401 #: ../fish/guestfish-actions.pod:3968
23406 #: ../fish/guestfish-actions.pod:3970
23414 #: ../fish/guestfish-actions.pod:3979
23419 #: ../fish/guestfish-actions.pod:3981
23427 #: ../fish/guestfish-actions.pod:3986
23428 msgid "truncate-size"
23432 #: ../fish/guestfish-actions.pod:3988
23435 " truncate-size path size\n"
23440 #: ../fish/guestfish-actions.pod:3993
23442 "If the current file size is less than C<size> then the file is extended to "
23443 "the required size with zero bytes. This creates a sparse file (ie. disk "
23444 "blocks are not allocated for the file until you write to it). To create a "
23445 "non-sparse file of zeroes, use L</fallocate64> instead."
23449 #: ../fish/guestfish-actions.pod:3999
23454 #: ../fish/guestfish-actions.pod:4001
23457 " tune2fs-l device\n"
23462 #: ../fish/guestfish-actions.pod:4011
23467 #: ../fish/guestfish-actions.pod:4013
23470 " txz-in (tarball|-) directory\n"
23475 #: ../fish/guestfish-actions.pod:4020
23480 #: ../fish/guestfish-actions.pod:4022
23483 " txz-out directory (tarball|-)\n"
23488 #: ../fish/guestfish-actions.pod:4029
23493 #: ../fish/guestfish-actions.pod:4031
23501 #: ../fish/guestfish-actions.pod:4045
23502 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
23506 #: ../fish/guestfish-actions.pod:4050
23511 #: ../fish/guestfish-actions.pod:4052
23516 #: ../fish/guestfish-actions.pod:4054
23519 " umount pathordevice\n"
23524 #: ../fish/guestfish-actions.pod:4060
23529 #: ../fish/guestfish-actions.pod:4062
23530 msgid "unmount-all"
23534 #: ../fish/guestfish-actions.pod:4064
23542 #: ../fish/guestfish-actions.pod:4070
23547 #: ../fish/guestfish-actions.pod:4072
23550 " upload (filename|-) remotefilename\n"
23555 #: ../fish/guestfish-actions.pod:4079
23556 msgid "See also L</download>."
23560 #: ../fish/guestfish-actions.pod:4083
23561 msgid "upload-offset"
23565 #: ../fish/guestfish-actions.pod:4085
23568 " upload-offset (filename|-) remotefilename offset\n"
23573 #: ../fish/guestfish-actions.pod:4097
23575 "Note that there is no limit on the amount of data that can be uploaded with "
23576 "this call, unlike with L</pwrite>, and this call always writes the full "
23577 "amount unless an error occurs."
23581 #: ../fish/guestfish-actions.pod:4102
23582 msgid "See also L</upload>, L</pwrite>."
23586 #: ../fish/guestfish-actions.pod:4106
23591 #: ../fish/guestfish-actions.pod:4108
23594 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
23599 #: ../fish/guestfish-actions.pod:4127
23604 #: ../fish/guestfish-actions.pod:4129
23612 #: ../fish/guestfish-actions.pod:4156
23614 "I<Note:> Don't use this call to test for availability of features. In "
23615 "enterprise distributions we backport features from later versions into "
23616 "earlier versions, making this an unreliable way to test for features. Use "
23617 "L</available> instead."
23621 #: ../fish/guestfish-actions.pod:4162
23626 #: ../fish/guestfish-actions.pod:4164
23629 " vfs-label device\n"
23634 #: ../fish/guestfish-actions.pod:4171
23635 msgid "To find a filesystem from the label, use L</findfs-label>."
23639 #: ../fish/guestfish-actions.pod:4173
23644 #: ../fish/guestfish-actions.pod:4175
23647 " vfs-type device\n"
23652 #: ../fish/guestfish-actions.pod:4185
23657 #: ../fish/guestfish-actions.pod:4187
23660 " vfs-uuid device\n"
23665 #: ../fish/guestfish-actions.pod:4194
23666 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
23670 #: ../fish/guestfish-actions.pod:4196
23671 msgid "vg-activate"
23675 #: ../fish/guestfish-actions.pod:4198
23678 " vg-activate true|false 'volgroups ...'\n"
23683 #: ../fish/guestfish-actions.pod:4211
23684 msgid "vg-activate-all"
23688 #: ../fish/guestfish-actions.pod:4213
23691 " vg-activate-all true|false\n"
23696 #: ../fish/guestfish-actions.pod:4223
23701 #: ../fish/guestfish-actions.pod:4225
23704 " vgcreate volgroup 'physvols ...'\n"
23709 #: ../fish/guestfish-actions.pod:4230
23714 #: ../fish/guestfish-actions.pod:4232
23717 " vglvuuids vgname\n"
23722 #: ../fish/guestfish-actions.pod:4237
23724 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
23725 "logical volumes and volume groups."
23729 #: ../fish/guestfish-actions.pod:4240
23730 msgid "See also L</vgpvuuids>."
23734 #: ../fish/guestfish-actions.pod:4242
23739 #: ../fish/guestfish-actions.pod:4244
23742 " vgpvuuids vgname\n"
23747 #: ../fish/guestfish-actions.pod:4249
23749 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
23750 "physical volumes and volume groups."
23754 #: ../fish/guestfish-actions.pod:4252
23755 msgid "See also L</vglvuuids>."
23759 #: ../fish/guestfish-actions.pod:4254
23764 #: ../fish/guestfish-actions.pod:4256
23767 " vgremove vgname\n"
23772 #: ../fish/guestfish-actions.pod:4263
23777 #: ../fish/guestfish-actions.pod:4265
23780 " vgrename volgroup newvolgroup\n"
23785 #: ../fish/guestfish-actions.pod:4269
23790 #: ../fish/guestfish-actions.pod:4271
23798 #: ../fish/guestfish-actions.pod:4279
23799 msgid "See also L</vgs-full>."
23803 #: ../fish/guestfish-actions.pod:4281
23808 #: ../fish/guestfish-actions.pod:4283
23816 #: ../fish/guestfish-actions.pod:4288
23821 #: ../fish/guestfish-actions.pod:4290
23829 #: ../fish/guestfish-actions.pod:4295
23834 #: ../fish/guestfish-actions.pod:4297
23842 #: ../fish/guestfish-actions.pod:4301
23847 #: ../fish/guestfish-actions.pod:4303
23855 #: ../fish/guestfish-actions.pod:4308
23860 #: ../fish/guestfish-actions.pod:4310
23868 #: ../fish/guestfish-actions.pod:4315
23873 #: ../fish/guestfish-actions.pod:4317
23881 #: ../fish/guestfish-actions.pod:4322
23886 #: ../fish/guestfish-actions.pod:4324
23889 " write path content\n"
23894 #: ../fish/guestfish-actions.pod:4332
23899 #: ../fish/guestfish-actions.pod:4334
23902 " write-file path content size\n"
23907 #: ../fish/guestfish-actions.pod:4357
23912 #: ../fish/guestfish-actions.pod:4359
23915 " zegrep regex path\n"
23920 #: ../fish/guestfish-actions.pod:4367
23925 #: ../fish/guestfish-actions.pod:4369
23928 " zegrepi regex path\n"
23933 #: ../fish/guestfish-actions.pod:4377
23938 #: ../fish/guestfish-actions.pod:4379
23946 #: ../fish/guestfish-actions.pod:4387
23947 msgid "See also: L</zero-device>, L</scrub-device>."
23951 #: ../fish/guestfish-actions.pod:4389
23952 msgid "zero-device"
23956 #: ../fish/guestfish-actions.pod:4391
23959 " zero-device device\n"
23964 #: ../fish/guestfish-actions.pod:4393
23966 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
23967 "which just zeroes the first few blocks of a device."
23971 #: ../fish/guestfish-actions.pod:4400
23976 #: ../fish/guestfish-actions.pod:4402
23979 " zerofree device\n"
23984 #: ../fish/guestfish-actions.pod:4415
23989 #: ../fish/guestfish-actions.pod:4417
23992 " zfgrep pattern path\n"
23997 #: ../fish/guestfish-actions.pod:4425
24002 #: ../fish/guestfish-actions.pod:4427
24005 " zfgrepi pattern path\n"
24010 #: ../fish/guestfish-actions.pod:4435
24015 #: ../fish/guestfish-actions.pod:4437
24018 " zfile meth path\n"
24023 #: ../fish/guestfish-actions.pod:4444
24025 "Since 1.0.63, use L</file> instead which can now process compressed files."
24029 #: ../fish/guestfish-actions.pod:4454
24034 #: ../fish/guestfish-actions.pod:4456
24037 " zgrep regex path\n"
24042 #: ../fish/guestfish-actions.pod:4464
24047 #: ../fish/guestfish-actions.pod:4466
24050 " zgrepi regex path\n"
24055 #: ../fish/guestfish-commands.pod:1
24060 #: ../fish/guestfish-commands.pod:3
24065 #: ../fish/guestfish-commands.pod:5
24068 " alloc filename size\n"
24073 #: ../fish/guestfish-commands.pod:7
24075 "This creates an empty (zeroed) file of the given size, and then adds so it "
24076 "can be further examined."
24080 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
24081 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
24085 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
24086 msgid "Size can be specified using standard suffixes, eg. C<1M>."
24090 #: ../fish/guestfish-commands.pod:14
24092 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
24093 "image, see L</PREPARED DISK IMAGES>."
24097 #: ../fish/guestfish-commands.pod:17
24102 #: ../fish/guestfish-commands.pod:19
24105 " copy-in local [local ...] /remotedir\n"
24110 #: ../fish/guestfish-commands.pod:21
24112 "C<copy-in> copies local files or directories recursively into the disk "
24113 "image, placing them in the directory called C</remotedir> (which must "
24114 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
24115 "other commands as necessary."
24119 #: ../fish/guestfish-commands.pod:26
24121 "Multiple local files and directories can be specified, but the last "
24122 "parameter must always be a remote directory. Wildcards cannot be used."
24126 #: ../fish/guestfish-commands.pod:30
24131 #: ../fish/guestfish-commands.pod:32
24134 " copy-out remote [remote ...] localdir\n"
24139 #: ../fish/guestfish-commands.pod:34
24141 "C<copy-out> copies remote files or directories recursively out of the disk "
24142 "image, placing them on the host disk in a local directory called C<localdir> "
24143 "(which must exist). This guestfish meta-command turns into a sequence of L</"
24144 "download>, L</tar-out> and other commands as necessary."
24148 #: ../fish/guestfish-commands.pod:40
24150 "Multiple remote files and directories can be specified, but the last "
24151 "parameter must always be a local directory. To download to the current "
24152 "directory, use C<.> as in:"
24156 #: ../fish/guestfish-commands.pod:44
24159 " copy-out /home .\n"
24164 #: ../fish/guestfish-commands.pod:46
24166 "Wildcards cannot be used in the ordinary command, but you can use them with "
24167 "the help of L</glob> like this:"
24171 #: ../fish/guestfish-commands.pod:49
24174 " glob copy-out /home/* .\n"
24179 #: ../fish/guestfish-commands.pod:51
24184 #: ../fish/guestfish-commands.pod:53
24187 " echo [params ...]\n"
24192 #: ../fish/guestfish-commands.pod:55
24193 msgid "This echos the parameters to the terminal."
24197 #: ../fish/guestfish-commands.pod:57
24202 #: ../fish/guestfish-commands.pod:59
24207 #: ../fish/guestfish-commands.pod:61
24212 #: ../fish/guestfish-commands.pod:63
24220 #: ../fish/guestfish-commands.pod:65
24222 "This is used to edit a file. It downloads the file, edits it locally using "
24223 "your editor, then uploads the result."
24227 #: ../fish/guestfish-commands.pod:68
24229 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
24230 "or C<emacs> you will get those corresponding editors."
24234 #: ../fish/guestfish-commands.pod:72
24239 #: ../fish/guestfish-commands.pod:74
24242 " glob command args...\n"
24247 #: ../fish/guestfish-commands.pod:76
24249 "Expand wildcards in any paths in the args list, and run C<command> "
24250 "repeatedly on each matching path."
24254 #: ../fish/guestfish-commands.pod:79
24255 msgid "See L</WILDCARDS AND GLOBBING>."
24259 #: ../fish/guestfish-commands.pod:81
24264 #: ../fish/guestfish-commands.pod:83
24267 " hexedit <filename|device>\n"
24268 " hexedit <filename|device> <max>\n"
24269 " hexedit <filename|device> <start> <max>\n"
24274 #: ../fish/guestfish-commands.pod:87
24276 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
24281 #: ../fish/guestfish-commands.pod:90
24283 "This command works by downloading potentially the whole file or device, "
24284 "editing it locally, then uploading it. If the file or device is large, you "
24285 "have to specify which part you wish to edit by using C<max> and/or C<start> "
24286 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
24287 "usual modifiers allowed such as C<1M> (1 megabyte)."
24291 #: ../fish/guestfish-commands.pod:97
24292 msgid "For example to edit the first few sectors of a disk you might do:"
24296 #: ../fish/guestfish-commands.pod:100
24299 " hexedit /dev/sda 1M\n"
24304 #: ../fish/guestfish-commands.pod:102
24306 "which would allow you to edit anywhere within the first megabyte of the disk."
24310 #: ../fish/guestfish-commands.pod:105
24311 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
24315 #: ../fish/guestfish-commands.pod:107
24318 " hexedit /dev/sda1 0x400 0x400\n"
24323 #: ../fish/guestfish-commands.pod:109
24324 msgid "(assuming the superblock is in the standard location)."
24328 #: ../fish/guestfish-commands.pod:111
24330 "This command requires the external L<hexedit(1)> program. You can specify "
24331 "another program to use by setting the C<HEXEDITOR> environment variable."
24335 #: ../fish/guestfish-commands.pod:115
24336 msgid "See also L</hexdump>."
24340 #: ../fish/guestfish-commands.pod:117
24345 #: ../fish/guestfish-commands.pod:119
24353 #: ../fish/guestfish-commands.pod:121
24355 "Change the local directory, ie. the current directory of guestfish itself."
24359 #: ../fish/guestfish-commands.pod:124
24360 msgid "Note that C<!cd> won't do what you might expect."
24364 #: ../fish/guestfish-commands.pod:126
24369 #: ../fish/guestfish-commands.pod:128
24374 #: ../fish/guestfish-commands.pod:130
24382 #: ../fish/guestfish-commands.pod:132
24383 msgid "Opens the manual page for guestfish."
24387 #: ../fish/guestfish-commands.pod:134
24392 #: ../fish/guestfish-commands.pod:136
24397 #: ../fish/guestfish-commands.pod:138
24405 #: ../fish/guestfish-commands.pod:140
24413 #: ../fish/guestfish-commands.pod:142
24414 msgid "This is used to view a file."
24418 #: ../fish/guestfish-commands.pod:144
24420 "The default viewer is C<$PAGER>. However if you use the alternate command "
24421 "C<less> you will get the C<less> command specifically."
24425 #: ../fish/guestfish-commands.pod:147
24430 #: ../fish/guestfish-commands.pod:149
24438 #: ../fish/guestfish-commands.pod:151
24440 "Close and reopen the libguestfs handle. It is not necessary to use this "
24441 "normally, because the handle is closed properly when guestfish exits. "
24442 "However this is occasionally useful for testing."
24446 #: ../fish/guestfish-commands.pod:155
24451 #: ../fish/guestfish-commands.pod:157
24454 " sparse filename size\n"
24459 #: ../fish/guestfish-commands.pod:159
24461 "This creates an empty sparse file of the given size, and then adds so it can "
24462 "be further examined."
24466 #: ../fish/guestfish-commands.pod:162
24468 "In all respects it works the same as the L</alloc> command, except that the "
24469 "image file is allocated sparsely, which means that disk blocks are not "
24470 "assigned to the file until they are needed. Sparse disk files only use "
24471 "space when written to, but they are slower and there is a danger you could "
24472 "run out of real disk space during a write operation."
24476 #: ../fish/guestfish-commands.pod:172
24481 #: ../fish/guestfish-commands.pod:174
24489 #: ../fish/guestfish-commands.pod:176
24491 "This command returns a list of the optional groups known to the daemon, and "
24492 "indicates which ones are supported by this build of the libguestfs appliance."
24496 #: ../fish/guestfish-commands.pod:180
24497 msgid "See also L<guestfs(3)/AVAILABILITY>."
24501 #: ../fish/guestfish-commands.pod:182
24506 #: ../fish/guestfish-commands.pod:184
24509 " time command args...\n"
24514 #: ../fish/guestfish-commands.pod:186
24516 "Run the command as usual, but print the elapsed time afterwards. This can "
24517 "be useful for benchmarking operations."
24521 #: ../test-tool/libguestfs-test-tool.pod:5
24522 msgid "libguestfs-test-tool - End user tests for libguestfs"
24526 #: ../test-tool/libguestfs-test-tool.pod:9
24529 " libguestfs-test-tool [--options]\n"
24534 #: ../test-tool/libguestfs-test-tool.pod:13
24536 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
24537 "and developers, to allow them to check basic libguestfs functionality is "
24538 "working. This is needed because libguestfs occasionally breaks for reasons "
24539 "beyond our control: usually because of changes in the underlying qemu or "
24540 "kernel packages, or the host environment."
24544 #: ../test-tool/libguestfs-test-tool.pod:20
24545 msgid "If you suspect a problem in libguestfs, then just run:"
24549 #: ../test-tool/libguestfs-test-tool.pod:22
24552 " libguestfs-test-tool\n"
24557 #: ../test-tool/libguestfs-test-tool.pod:24
24558 msgid "It will print lots of diagnostic messages."
24562 #: ../test-tool/libguestfs-test-tool.pod:26
24563 msgid "If it runs to completion successfully, you will see this near the end:"
24567 #: ../test-tool/libguestfs-test-tool.pod:28
24570 " ===== TEST FINISHED OK =====\n"
24575 #: ../test-tool/libguestfs-test-tool.pod:30
24576 msgid "and the test tool will exit with code 0."
24580 #: ../test-tool/libguestfs-test-tool.pod:32
24582 "If it fails (and/or exits with non-zero error code), please paste the "
24583 "B<complete, unedited> output of the test tool into a bug report. More "
24584 "information about reporting bugs can be found on the L<http://libguestfs.org/"
24589 #: ../test-tool/libguestfs-test-tool.pod:41
24594 #: ../test-tool/libguestfs-test-tool.pod:43
24595 msgid "Display short usage information and exit."
24599 #: ../test-tool/libguestfs-test-tool.pod:45
24600 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
24604 #: ../test-tool/libguestfs-test-tool.pod:47
24606 "Pass an alternate name for the helper program. libguestfs-test-tool will "
24607 "normally look in the C<$libexec> directory that was configured when the tool "
24612 #: ../test-tool/libguestfs-test-tool.pod:51
24613 msgid "I<--qemu qemu_binary>"
24617 #: ../test-tool/libguestfs-test-tool.pod:53
24619 "If you have downloaded another qemu binary, point this option at the full "
24620 "path of the binary to try it."
24624 #: ../test-tool/libguestfs-test-tool.pod:56
24625 msgid "I<--qemudir qemu_source_dir>"
24629 #: ../test-tool/libguestfs-test-tool.pod:58
24631 "If you have compiled qemu from source, point this option at the source "
24632 "directory to try it."
24636 #: ../test-tool/libguestfs-test-tool.pod:61
24637 msgid "I<--timeout N>"
24641 #: ../test-tool/libguestfs-test-tool.pod:63
24643 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
24644 "does not usually need to be adjusted unless your machine is very slow."
24648 #: ../test-tool/libguestfs-test-tool.pod:69
24649 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
24653 #: ../test-tool/libguestfs-test-tool.pod:71
24655 "If you have compiled another version of qemu from source and would like to "
24656 "try that, then you can use the I<--qemudir> option to point to the qemu "
24657 "source directory."
24661 #: ../test-tool/libguestfs-test-tool.pod:75
24663 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
24664 "option to point to the binary."
24668 #: ../test-tool/libguestfs-test-tool.pod:78
24670 "When using an alternate qemu with libguestfs, usually you would need to "
24671 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
24672 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
24673 "use either of the I<--qemudir> or I<--qemu> options."
24677 #: ../test-tool/libguestfs-test-tool.pod:85
24679 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
24680 "I<1> if there was an error."
24684 #: ../test-tool/libguestfs-test-tool.pod:92
24685 msgid "/usr/libexec/libguestfs-test-tool-helper"
24689 #: ../test-tool/libguestfs-test-tool.pod:94
24691 "This helper program is run inside the appliance and provides additional "
24696 #: ../test-tool/libguestfs-test-tool.pod:97
24697 msgid "/usr/bin/mkisofs"
24701 #: ../test-tool/libguestfs-test-tool.pod:99
24703 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
24704 "which is used as part of the tests."
24708 #: ../test-tool/libguestfs-test-tool.pod:106
24710 "For the full list of environment variables which may affect libguestfs, "
24711 "please see the L<guestfs(3)> manual page."
24715 #: ../test-tool/libguestfs-test-tool.pod:111
24716 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
24720 #: ../test-tool/libguestfs-test-tool.pod:121
24721 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
24725 #: ../fuse/guestmount.pod:5
24727 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
24731 #: ../fuse/guestmount.pod:9
24734 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
24739 #: ../fuse/guestmount.pod:11
24742 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
24747 #: ../fuse/guestmount.pod:13
24750 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
24755 #: ../fuse/guestmount.pod:17
24757 "You must I<not> use C<guestmount> in read-write mode on live virtual "
24758 "machines. If you do this, you risk disk corruption in the VM."
24762 #: ../fuse/guestmount.pod:22
24764 "The guestmount program can be used to mount virtual machine filesystems and "
24765 "other disk images on the host. It uses libguestfs for access to the guest "
24766 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
24767 "a mountable device."
24771 #: ../fuse/guestmount.pod:27
24773 "Along with other options, you have to give at least one device (I<-a> "
24774 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
24775 "option) or use the I<-i> inspection option. How this works is better "
24776 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
24781 #: ../fuse/guestmount.pod:33
24783 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
24784 "by you, and the filesystem will not be visible to any other users unless you "
24785 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
24786 "the filesystem, use the C<fusermount -u> command."
24790 #: ../fuse/guestmount.pod:41
24792 "For a typical Windows guest which has its main filesystem on the first "
24797 #: ../fuse/guestmount.pod:44
24800 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
24805 #: ../fuse/guestmount.pod:46
24807 "For a typical Linux guest which has a /boot filesystem on the first "
24808 "partition, and the root filesystem on a logical volume:"
24812 #: ../fuse/guestmount.pod:49
24815 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
24820 #: ../fuse/guestmount.pod:51
24821 msgid "To get libguestfs to detect guest mountpoints for you:"
24825 #: ../fuse/guestmount.pod:53
24828 " guestmount -a guest.img -i --ro /mnt\n"
24833 #: ../fuse/guestmount.pod:55
24834 msgid "For a libvirt guest called \"Guest\" you could do:"
24838 #: ../fuse/guestmount.pod:57
24841 " guestmount -d Guest -i --ro /mnt\n"
24846 #: ../fuse/guestmount.pod:59
24848 "If you don't know what filesystems are contained in a guest or disk image, "
24849 "use L<virt-list-filesystems(1)> first:"
24853 #: ../fuse/guestmount.pod:62
24856 " virt-list-filesystems MyGuest\n"
24861 #: ../fuse/guestmount.pod:64
24863 "If you want to trace the libguestfs calls but without excessive debugging "
24864 "information, we recommend:"
24868 #: ../fuse/guestmount.pod:67
24871 " guestmount [...] --trace /mnt\n"
24876 #: ../fuse/guestmount.pod:69
24877 msgid "If you want to debug the program, we recommend:"
24881 #: ../fuse/guestmount.pod:71
24884 " guestmount [...] --trace --verbose /mnt\n"
24889 #: ../fuse/guestmount.pod:79
24890 msgid "Add a block device or virtual machine image."
24894 #: ../fuse/guestmount.pod:96
24895 msgid "B<--dir-cache-timeout N>"
24899 #: ../fuse/guestmount.pod:98
24901 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
24902 "seconds. The readdir cache [actually, there are several semi-independent "
24903 "caches] is populated after a readdir(2) call with the stat and extended "
24904 "attributes of the files in the directory, in anticipation that they will be "
24905 "requested soon after."
24909 #: ../fuse/guestmount.pod:104
24911 "There is also a different attribute cache implemented by FUSE (see the FUSE "
24912 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
24913 "requests, only cache existing ones."
24917 #: ../fuse/guestmount.pod:122
24919 "If you have untrusted raw-format guest disk images, you should use this "
24920 "option to specify the disk format. This avoids a possible security problem "
24921 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
24922 "guestfs_add_drive_opts>."
24926 #: ../fuse/guestmount.pod:127
24927 msgid "B<--fuse-help>"
24931 #: ../fuse/guestmount.pod:129
24932 msgid "Display help on special FUSE options (see I<-o> below)."
24936 #: ../fuse/guestmount.pod:133
24937 msgid "Display brief help and exit."
24941 #: ../fuse/guestmount.pod:146
24942 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
24946 #: ../fuse/guestmount.pod:148
24948 "Mount the named partition or logical volume on the given mountpoint B<in the "
24949 "guest> (this has nothing to do with mountpoints in the host)."
24953 #: ../fuse/guestmount.pod:151
24955 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
24956 "something on C</>."
24960 #: ../fuse/guestmount.pod:156
24962 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
24963 "unmounted. If you specify this option, then we don't attempt to sync the "
24964 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
24968 #: ../fuse/guestmount.pod:161
24969 msgid "B<-o option> | B<--option option>"
24973 #: ../fuse/guestmount.pod:163
24974 msgid "Pass extra options to FUSE."
24978 #: ../fuse/guestmount.pod:165
24980 "To get a list of all the extra options supported by FUSE, use the command "
24981 "below. Note that only the FUSE I<-o> options can be passed, and only some "
24982 "of them are a good idea."
24986 #: ../fuse/guestmount.pod:169
24989 " guestmount --fuse-help\n"
24994 #: ../fuse/guestmount.pod:171
24995 msgid "Some potentially useful FUSE options:"
24999 #: ../fuse/guestmount.pod:175
25000 msgid "B<-o allow_other>"
25004 #: ../fuse/guestmount.pod:177
25005 msgid "Allow other users to see the filesystem."
25009 #: ../fuse/guestmount.pod:179
25010 msgid "B<-o attr_timeout=N>"
25014 #: ../fuse/guestmount.pod:181
25015 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
25019 #: ../fuse/guestmount.pod:183
25020 msgid "B<-o kernel_cache>"
25024 #: ../fuse/guestmount.pod:185
25026 "Allow the kernel to cache files (reduces the number of reads that have to go "
25027 "through the L<guestfs(3)> API). This is generally a good idea if you can "
25028 "afford the extra memory usage."
25032 #: ../fuse/guestmount.pod:189
25033 msgid "B<-o uid=N> B<-o gid=N>"
25037 #: ../fuse/guestmount.pod:191
25039 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
25040 "the chosen values."
25044 #: ../fuse/guestmount.pod:198
25046 "Add devices and mount everything read-only. Also disallow writes and make "
25047 "the disk appear read-only to FUSE."
25051 #: ../fuse/guestmount.pod:201
25053 "This is highly recommended if you are not going to edit the guest disk. If "
25054 "the guest is running and this option is I<not> supplied, then there is a "
25055 "strong risk of disk corruption in the guest. We try to prevent this from "
25056 "happening, but it is not always possible."
25060 #: ../fuse/guestmount.pod:208
25061 msgid "Enable SELinux support for the guest."
25065 #: ../fuse/guestmount.pod:212
25066 msgid "Enable verbose messages from underlying libguestfs."
25070 #: ../fuse/guestmount.pod:216
25071 msgid "Display the program version and exit."
25075 #: ../fuse/guestmount.pod:218
25076 msgid "B<-x> | B<--trace>"
25080 #: ../fuse/guestmount.pod:220
25081 msgid "Trace libguestfs calls."
25085 #: ../fuse/guestmount.pod:222
25086 msgid "This also stops the daemon from forking into the background."
25090 #: ../fuse/guestmount.pod:228
25092 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
25093 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
25098 #: ../inspector/virt-inspector.pl:35
25100 "virt-inspector - Display operating system version and other information "
25101 "about a virtual machine"
25105 #: ../inspector/virt-inspector.pl:39
25108 " virt-inspector [--connect URI] domname\n"
25113 #: ../inspector/virt-inspector.pl:41
25116 " virt-inspector guest.img [guest.img ...]\n"
25121 #: ../inspector/virt-inspector.pl:45
25123 "B<virt-inspector> examines a virtual machine or disk image and tries to "
25124 "determine the version of the operating system and other information about "
25125 "the virtual machine."
25129 #: ../inspector/virt-inspector.pl:49
25130 msgid "Virt-inspector produces XML output for feeding into other programs."
25134 #: ../inspector/virt-inspector.pl:51
25136 "In the normal usage, use C<virt-inspector domname> where C<domname> is the "
25137 "libvirt domain (see: C<virsh list --all>)."
25141 #: ../inspector/virt-inspector.pl:54
25143 "You can also run virt-inspector directly on disk images from a single "
25144 "virtual machine. Use C<virt-inspector guest.img>. In rare cases a domain "
25145 "has several block devices, in which case you should list them one after "
25146 "another, with the first corresponding to the guest's C</dev/sda>, the second "
25147 "to the guest's C</dev/sdb> and so on."
25151 #: ../inspector/virt-inspector.pl:60
25153 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
25154 "inspect several virtual machines, you have to run virt-inspector several "
25155 "times (for example, from a shell script for-loop)."
25159 #: ../inspector/virt-inspector.pl:65
25161 "Because virt-inspector needs direct access to guest images, it won't "
25162 "normally work over remote libvirt connections."
25166 #: ../inspector/virt-inspector.pl:78 ../tools/virt-edit.pl:82
25167 #: ../tools/virt-win-reg.pl:181 ../tools/virt-df.pl:81 ../tools/virt-ls.pl:88
25168 #: ../tools/virt-list-filesystems.pl:60 ../tools/virt-cat.pl:89
25169 #: ../tools/virt-tar.pl:108 ../tools/virt-rescue.pl:113
25170 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:61
25171 msgid "Display brief help."
25175 #: ../inspector/virt-inspector.pl:84 ../tools/virt-edit.pl:88
25176 #: ../tools/virt-win-reg.pl:187 ../tools/virt-df.pl:87 ../tools/virt-ls.pl:94
25177 #: ../tools/virt-resize.pl:273 ../tools/virt-list-filesystems.pl:66
25178 #: ../tools/virt-cat.pl:95 ../tools/virt-tar.pl:114
25179 #: ../tools/virt-rescue.pl:119 ../tools/virt-make-fs.pl:169
25180 #: ../tools/virt-list-partitions.pl:67
25181 msgid "B<--version>"
25185 #: ../inspector/virt-inspector.pl:86 ../tools/virt-edit.pl:90
25186 #: ../tools/virt-win-reg.pl:189 ../tools/virt-df.pl:89 ../tools/virt-ls.pl:96
25187 #: ../tools/virt-resize.pl:275 ../tools/virt-list-filesystems.pl:68
25188 #: ../tools/virt-cat.pl:97 ../tools/virt-tar.pl:116
25189 #: ../tools/virt-rescue.pl:121 ../tools/virt-make-fs.pl:171
25190 #: ../tools/virt-list-partitions.pl:69
25191 msgid "Display version number and exit."
25195 #: ../inspector/virt-inspector.pl:92 ../tools/virt-edit.pl:112
25196 #: ../tools/virt-win-reg.pl:203 ../tools/virt-df.pl:95 ../tools/virt-ls.pl:102
25197 #: ../tools/virt-list-filesystems.pl:74 ../tools/virt-cat.pl:103
25198 #: ../tools/virt-tar.pl:122 ../tools/virt-rescue.pl:135
25199 #: ../tools/virt-list-partitions.pl:75
25200 msgid "B<--connect URI> | B<-c URI>"
25204 #: ../inspector/virt-inspector.pl:94 ../tools/virt-edit.pl:114
25205 #: ../tools/virt-win-reg.pl:205 ../tools/virt-df.pl:97 ../tools/virt-ls.pl:104
25206 #: ../tools/virt-list-filesystems.pl:76 ../tools/virt-cat.pl:105
25207 #: ../tools/virt-tar.pl:124 ../tools/virt-rescue.pl:137
25208 #: ../tools/virt-list-partitions.pl:77
25210 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
25211 "to the default libvirt hypervisor."
25215 #: ../inspector/virt-inspector.pl:97
25217 "Libvirt is only used if you specify a C<domname> on the command line. If "
25218 "you specify guest block devices directly, then libvirt is not used at all."
25222 #: ../inspector/virt-inspector.pl:105 ../tools/virt-edit.pl:124
25223 #: ../tools/virt-win-reg.pl:215 ../tools/virt-df.pl:117
25224 #: ../tools/virt-ls.pl:114 ../tools/virt-resize.pl:523
25225 #: ../tools/virt-list-filesystems.pl:86 ../tools/virt-cat.pl:115
25226 #: ../tools/virt-tar.pl:134 ../tools/virt-rescue.pl:147
25227 #: ../tools/virt-list-partitions.pl:87
25228 msgid "B<--format> raw"
25232 #: ../inspector/virt-inspector.pl:107 ../tools/virt-edit.pl:126
25233 #: ../tools/virt-win-reg.pl:217 ../tools/virt-df.pl:119
25234 #: ../tools/virt-ls.pl:116 ../tools/virt-list-filesystems.pl:88
25235 #: ../tools/virt-cat.pl:117 ../tools/virt-tar.pl:136
25236 #: ../tools/virt-rescue.pl:149 ../tools/virt-list-partitions.pl:89
25238 "Specify the format of disk images given on the command line. If this is "
25239 "omitted then the format is autodetected from the content of the disk image."
25243 #: ../inspector/virt-inspector.pl:111 ../tools/virt-edit.pl:130
25244 #: ../tools/virt-win-reg.pl:221 ../tools/virt-df.pl:123
25245 #: ../tools/virt-ls.pl:120 ../tools/virt-list-filesystems.pl:92
25246 #: ../tools/virt-cat.pl:121 ../tools/virt-tar.pl:140
25247 #: ../tools/virt-rescue.pl:153 ../tools/virt-list-partitions.pl:93
25249 "If disk images are requested from libvirt, then this program asks libvirt "
25250 "for this information. In this case, the value of the format parameter is "
25255 #: ../inspector/virt-inspector.pl:115 ../tools/virt-edit.pl:134
25256 #: ../tools/virt-win-reg.pl:225 ../tools/virt-df.pl:127
25257 #: ../tools/virt-ls.pl:124 ../tools/virt-resize.pl:528
25258 #: ../tools/virt-resize.pl:543 ../tools/virt-list-filesystems.pl:96
25259 #: ../tools/virt-cat.pl:125 ../tools/virt-tar.pl:144
25260 #: ../tools/virt-rescue.pl:157 ../tools/virt-list-partitions.pl:97
25262 "If working with untrusted raw-format guest disk images, you should ensure "
25263 "the format is always specified."
25267 #: ../inspector/virt-inspector.pl:149
25272 #: ../inspector/virt-inspector.pl:151
25274 "The virt-inspector XML is described precisely in a RELAX NG schema which is "
25275 "supplied with libguestfs. This section is just an overview."
25279 #: ../inspector/virt-inspector.pl:154
25281 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
25282 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
25283 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
25284 "which is vanishingly rare in real world VMs."
25288 #: ../inspector/virt-inspector.pl:159
25289 msgid "E<lt>operatingsystemE<gt>"
25293 #: ../inspector/virt-inspector.pl:161
25295 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
25296 "describe the operating system, its architecture, the descriptive \"product "
25297 "name\" string, the type of OS and so on, as in this example:"
25301 #: ../inspector/virt-inspector.pl:165
25304 " <operatingsystems>\n"
25305 " <operatingsystem>\n"
25306 " <root>/dev/sda2</root>\n"
25307 " <name>windows</name>\n"
25308 " <arch>i386</arch>\n"
25309 " <distro>windows</distro>\n"
25310 " <product_name>Windows 7 Enterprise</product_name>\n"
25311 " <major_version>6</major_version>\n"
25312 " <minor_version>1</minor_version>\n"
25313 " <windows_systemroot>/Windows</windows_systemroot>\n"
25318 #: ../inspector/virt-inspector.pl:176
25320 "These fields are derived from the libguestfs inspection API, and you can "
25321 "find more details in L<guestfs(3)/INSPECTION>."
25325 #: ../inspector/virt-inspector.pl:179
25327 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
25328 "of view of libguestfs (block devices may have completely different names "
25329 "inside the VM itself)."
25333 #: ../inspector/virt-inspector.pl:240
25334 msgid "E<lt>mountpointsE<gt>"
25338 #: ../inspector/virt-inspector.pl:242
25340 "Un*x-like guests typically have multiple filesystems which are mounted at "
25341 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
25342 "element which looks like this:"
25346 #: ../inspector/virt-inspector.pl:246
25349 " <operatingsystems>\n"
25350 " <operatingsystem>\n"
25353 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
25354 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
25355 " </mountpoints>\n"
25360 #: ../inspector/virt-inspector.pl:254
25362 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
25363 "and may have completely different names inside the guest. Only mountable "
25364 "filesystems appear in this list, not things like swap devices."
25368 #: ../inspector/virt-inspector.pl:276
25369 msgid "E<lt>filesystemsE<gt>"
25373 #: ../inspector/virt-inspector.pl:278
25375 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
25376 "filesystems belonging to the guest, including swap and empty partitions. "
25377 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
25378 "this OS or shared by this OS and other OSes)."
25382 #: ../inspector/virt-inspector.pl:283
25383 msgid "You might see something like this:"
25387 #: ../inspector/virt-inspector.pl:285
25390 " <operatingsystems>\n"
25391 " <operatingsystem>\n"
25394 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
25395 " <type>ext4</type>\n"
25396 " <label>Fedora-13-x86_64</label>\n"
25397 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
25403 #: ../inspector/virt-inspector.pl:295
25405 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
25406 "the label, and the UUID."
25410 #: ../inspector/virt-inspector.pl:337
25411 msgid "E<lt>applicationsE<gt>"
25415 #: ../inspector/virt-inspector.pl:339
25417 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
25418 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
25419 "machine. At the moment we are only able to list RPMs and Debian packages "
25420 "installed, but in future we will support other Linux distros and Windows."
25424 #: ../inspector/virt-inspector.pl:345
25426 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
25427 "Typical values would be C<rpm> and C<deb>."
25431 #: ../inspector/virt-inspector.pl:348
25433 "E<lt>package_managementE<gt>, if present, describes the package manager. "
25434 "Typical values include C<yum>, C<up2date> and C<apt>"
25438 #: ../inspector/virt-inspector.pl:351
25439 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
25443 #: ../inspector/virt-inspector.pl:354
25446 " <operatingsystems>\n"
25447 " <operatingsystem>\n"
25449 " <applications>\n"
25451 " <name>coreutils</name>\n"
25452 " <version>8.5</version>\n"
25453 " <release>1</release>\n"
25454 " </application>\n"
25459 #: ../inspector/virt-inspector.pl:364
25461 "(The version and release fields may not be available for some package types)."
25465 #: ../inspector/virt-inspector.pl:544
25466 msgid "USING XPATH"
25470 #: ../inspector/virt-inspector.pl:546
25472 "You can use the XPath query language, and/or the xpath tool, in order to "
25473 "select parts of the XML."
25477 #: ../inspector/virt-inspector.pl:551
25480 " $ virt-inspector Guest | xpath //filesystems\n"
25481 " Found 1 nodes:\n"
25484 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
25485 " <type>ext4</type>\n"
25491 #: ../inspector/virt-inspector.pl:559
25494 " $ virt-inspector Guest | \\\n"
25495 " xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
25496 " Query didn't return a nodeset. Value: ext4\n"
25501 #: ../inspector/virt-inspector.pl:563 ../tools/virt-edit.pl:343
25502 #: ../tools/virt-win-reg.pl:141 ../tools/virt-win-reg.pl:477
25503 #: ../tools/virt-df.pl:633 ../tools/virt-ls.pl:225
25504 #: ../tools/virt-resize.pl:1479 ../tools/virt-list-filesystems.pl:179
25505 #: ../tools/virt-cat.pl:178 ../tools/virt-tar.pl:274
25506 #: ../tools/virt-rescue.pl:260 ../tools/virt-make-fs.pl:527
25507 #: ../tools/virt-list-partitions.pl:247
25508 msgid "SHELL QUOTING"
25512 #: ../inspector/virt-inspector.pl:565 ../tools/virt-edit.pl:345
25513 #: ../tools/virt-win-reg.pl:479 ../tools/virt-df.pl:635
25514 #: ../tools/virt-ls.pl:227 ../tools/virt-resize.pl:1481
25515 #: ../tools/virt-list-filesystems.pl:181 ../tools/virt-cat.pl:180
25516 #: ../tools/virt-tar.pl:276 ../tools/virt-rescue.pl:262
25517 #: ../tools/virt-make-fs.pl:529 ../tools/virt-list-partitions.pl:249
25519 "Libvirt guest names can contain arbitrary characters, some of which have "
25520 "meaning to the shell such as C<#> and space. You may need to quote or "
25521 "escape these characters on the command line. See the shell manual page L<sh"
25522 "(1)> for details."
25526 #: ../inspector/virt-inspector.pl:572
25528 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
25529 "L<Sys::Virt(3)>, L<http://www.w3.org/TR/xpath/>, L<http://libguestfs.org/>."
25533 #: ../inspector/virt-inspector.pl:586 ../tools/virt-edit.pl:364
25534 #: ../tools/virt-win-reg.pl:512 ../tools/virt-df.pl:651
25535 #: ../tools/virt-ls.pl:245 ../tools/virt-resize.pl:1510
25536 #: ../tools/virt-list-filesystems.pl:200 ../tools/virt-cat.pl:197
25537 #: ../tools/virt-tar.pl:294 ../tools/virt-rescue.pl:279
25538 #: ../tools/virt-make-fs.pl:561 ../tools/virt-list-partitions.pl:267
25539 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
25543 #: ../inspector/virt-inspector.pl:590
25544 msgid "Matthew Booth L<mbooth@redhat.com>"
25548 #: ../inspector/virt-inspector.pl:596 ../tools/virt-win-reg.pl:516
25549 #: ../tools/virt-resize.pl:1514 ../tools/virt-make-fs.pl:565
25550 msgid "Copyright (C) 2010 Red Hat Inc."
25554 #: ../tools/virt-edit.pl:34
25555 msgid "virt-edit - Edit a file in a virtual machine"
25559 #: ../tools/virt-edit.pl:38
25562 " virt-edit [--options] domname file\n"
25567 #: ../tools/virt-edit.pl:40
25570 " virt-edit [--options] disk.img [disk.img ...] file\n"
25575 #: ../tools/virt-edit.pl:42
25578 " virt-edit [domname|disk.img] file -e 'expr'\n"
25583 #: ../tools/virt-edit.pl:46
25585 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
25586 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
25587 "doing this, but doesn't catch all cases."
25591 #: ../tools/virt-edit.pl:52
25593 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
25594 "the named virtual machine (or disk image)."
25598 #: ../tools/virt-edit.pl:55
25600 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
25601 "you should look at the L<guestfish(1)> tool."
25605 #: ../tools/virt-edit.pl:60
25606 msgid "Edit the named files interactively:"
25610 #: ../tools/virt-edit.pl:62
25613 " virt-edit mydomain /boot/grub/grub.conf\n"
25618 #: ../tools/virt-edit.pl:64
25621 " virt-edit mydomain /etc/passwd\n"
25626 #: ../tools/virt-edit.pl:66
25628 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
25629 "below). To change the init default level to 5:"
25633 #: ../tools/virt-edit.pl:70
25636 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
25641 #: ../tools/virt-edit.pl:96
25642 msgid "B<--backup extension> | B<-b extension>"
25646 #: ../tools/virt-edit.pl:98
25648 "Create a backup of the original file I<in the guest disk image>. The backup "
25649 "has the original filename with C<extension> added."
25653 #: ../tools/virt-edit.pl:101
25655 "Usually the first character of C<extension> would be a dot C<.> so you would "
25660 #: ../tools/virt-edit.pl:104
25663 " virt-edit -b .orig [etc]\n"
25668 #: ../tools/virt-edit.pl:106
25669 msgid "By default, no backup file is made."
25673 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:208
25674 #: ../tools/virt-df.pl:100 ../tools/virt-ls.pl:107
25675 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-cat.pl:108
25676 #: ../tools/virt-tar.pl:127 ../tools/virt-rescue.pl:140
25677 #: ../tools/virt-list-partitions.pl:80
25679 "If you specify guest block devices directly, then libvirt is not used at all."
25683 #: ../tools/virt-edit.pl:141
25684 msgid "B<--expr EXPR> | B<-e EXPR>"
25688 #: ../tools/virt-edit.pl:143
25690 "Instead of launching the external editor, non-interactively apply the Perl "
25691 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
25696 #: ../tools/virt-edit.pl:147
25698 "Be careful to properly quote the expression to prevent it from being altered "
25703 #: ../tools/virt-edit.pl:268
25704 msgid "NON-INTERACTIVE EDITING"
25708 #: ../tools/virt-edit.pl:270
25710 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
25711 "administrator can interactively edit the file."
25715 #: ../tools/virt-edit.pl:273
25717 "There are two ways also to use C<virt-edit> from scripts in order to make "
25718 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
25719 "like this, it's less error-prone to write scripts directly using the "
25720 "libguestfs API and Augeas for configuration file editing.)"
25724 #: ../tools/virt-edit.pl:279
25726 "The first method is to temporarily set C<$EDITOR> to any script or program "
25727 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
25728 "update C<tmpfile> in place however it likes."
25732 #: ../tools/virt-edit.pl:283
25734 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
25735 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
25736 "instances of C<foo> with C<bar> in a file:"
25740 #: ../tools/virt-edit.pl:287
25743 " virt-edit domname filename -e 's/foo/bar/'\n"
25748 #: ../tools/virt-edit.pl:289
25750 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
25751 "For example to delete root's password you could do:"
25755 #: ../tools/virt-edit.pl:292
25758 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
25763 #: ../tools/virt-edit.pl:294
25765 "What really happens is that the snippet is evaluated as a Perl expression "
25766 "for each line of the file. The line, including the final C<\\n>, is passed "
25767 "in C<$_> and the expression should update C<$_> or leave it unchanged."
25771 #: ../tools/virt-edit.pl:299
25773 "To delete a line, set C<$_> to the empty string. For example, to delete the "
25774 "C<apache> user account from the password file you can do:"
25778 #: ../tools/virt-edit.pl:302
25781 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
25786 #: ../tools/virt-edit.pl:304
25788 "To insert a line, prepend or append it to C<$_>. However appending lines to "
25789 "the end of the file is rather difficult this way since there is no concept "
25790 "of \"last line of the file\" - your expression just doesn't get called "
25791 "again. You might want to use the first method (setting C<$EDITOR>) if you "
25796 #: ../tools/virt-edit.pl:310
25798 "The variable C<$lineno> contains the current line number. As is "
25799 "traditional, the first line in the file is number C<1>."
25803 #: ../tools/virt-edit.pl:313
25805 "The return value from the expression is ignored, but the expression may call "
25806 "C<die> in order to abort the whole program, leaving the original file "
25811 #: ../tools/virt-edit.pl:317
25813 "Remember when matching the end of a line that C<$_> may contain the final C<"
25814 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
25815 "newline then neither of these. Thus to match or substitute some text at the "
25816 "end of a line, use this regular expression:"
25820 #: ../tools/virt-edit.pl:322
25823 " /some text(\\r?\\n)?$/\n"
25828 #: ../tools/virt-edit.pl:324
25830 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
25831 "$_> itself (since that would remove all newlines from the file):"
25835 #: ../tools/virt-edit.pl:328
25838 " my $m = $_; chomp $m; $m =~ /some text$/\n"
25843 #: ../tools/virt-edit.pl:334
25848 #: ../tools/virt-edit.pl:336
25850 "If set, this string is used as the editor. It may contain arguments, eg. C<"
25855 #: ../tools/virt-edit.pl:339
25856 msgid "If not set, C<vi> is used."
25860 #: ../tools/virt-edit.pl:352
25862 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
25863 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, "
25868 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:510
25869 #: ../tools/virt-df.pl:649 ../tools/virt-ls.pl:243
25870 #: ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:198
25871 #: ../tools/virt-cat.pl:195 ../tools/virt-tar.pl:292
25872 #: ../tools/virt-rescue.pl:277 ../tools/virt-make-fs.pl:559
25873 #: ../tools/virt-list-partitions.pl:265
25878 #: ../tools/virt-edit.pl:368 ../tools/virt-df.pl:655
25879 #: ../tools/virt-rescue.pl:283 ../tools/virt-list-partitions.pl:271
25880 msgid "Copyright (C) 2009-2010 Red Hat Inc."
25884 #: ../tools/virt-win-reg.pl:37
25886 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
25890 #: ../tools/virt-win-reg.pl:41
25893 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
25898 #: ../tools/virt-win-reg.pl:43
25901 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
25906 #: ../tools/virt-win-reg.pl:45
25909 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
25914 #: ../tools/virt-win-reg.pl:47
25917 " virt-win-reg --merge domname [input.reg ...]\n"
25922 #: ../tools/virt-win-reg.pl:49
25925 " virt-win-reg [--options] disk.img ... # instead of domname\n"
25930 #: ../tools/virt-win-reg.pl:53
25932 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
25933 "virtual machines. If you do this, you I<will> get irreversible disk "
25934 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
25935 "but doesn't catch all cases."
25939 #: ../tools/virt-win-reg.pl:58
25941 "Modifying the Windows Registry is an inherently risky operation. The format "
25942 "is deliberately obscure and undocumented, and Registry changes can leave the "
25943 "system unbootable. Therefore when using the C<--merge> option, make sure "
25944 "you have a reliable backup first."
25948 #: ../tools/virt-win-reg.pl:65
25950 "This program can export and merge Windows Registry entries from a Windows "
25955 #: ../tools/virt-win-reg.pl:68
25957 "The first parameter is the libvirt guest name or the raw disk image of a "
25962 #: ../tools/virt-win-reg.pl:71
25964 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
25965 "exported (recursively). For example:"
25969 #: ../tools/virt-win-reg.pl:74
25972 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
25977 #: ../tools/virt-win-reg.pl:76
25979 "You can also display single values from within registry keys, for example:"
25983 #: ../tools/virt-win-reg.pl:79
25986 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
25987 " $ virt-win-reg Windows7 $cvkey ProductName\n"
25988 " Windows 7 Enterprise\n"
25993 #: ../tools/virt-win-reg.pl:83
25995 "With C<--merge>, you can merge a textual regedit file into the Windows "
26000 #: ../tools/virt-win-reg.pl:86
26003 " $ virt-win-reg --merge Windows7 changes.reg\n"
26008 #: ../tools/virt-win-reg.pl:88
26009 msgid "SUPPORTED SYSTEMS"
26013 #: ../tools/virt-win-reg.pl:90
26015 "The program currently supports Windows NT-derived guests starting with "
26016 "Windows XP through to at least Windows 7."
26020 #: ../tools/virt-win-reg.pl:93
26022 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
26023 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
26024 "and C<HKEY_USERS\\.DEFAULT>."
26028 #: ../tools/virt-win-reg.pl:97
26030 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
26035 #: ../tools/virt-win-reg.pl:100
26037 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
26042 #: ../tools/virt-win-reg.pl:103
26047 #: ../tools/virt-win-reg.pl:105
26049 "This program is only meant for simple access to the registry. If you want "
26050 "to do complicated things with the registry, we suggest you download the "
26051 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
26052 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
26053 "L<hivexregedit(1)>."
26057 #: ../tools/virt-win-reg.pl:111
26062 #: ../tools/virt-win-reg.pl:113
26064 "C<virt-win-reg> expects that regedit files have already been reencoded in "
26065 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
26066 "style line endings. Since Windows regedit files are often in UTF-16LE with "
26067 "Windows-style line endings, you may need to reencode the whole file before "
26068 "or after processing."
26072 #: ../tools/virt-win-reg.pl:119
26074 "To reencode a file from Windows format to Linux (before processing it with "
26075 "the C<--merge> option), you would do something like this:"
26079 #: ../tools/virt-win-reg.pl:122
26082 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
26087 #: ../tools/virt-win-reg.pl:124
26089 "To go in the opposite direction, after exporting and before sending the file "
26090 "to a Windows user, do something like this:"
26094 #: ../tools/virt-win-reg.pl:127
26097 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
26102 #: ../tools/virt-win-reg.pl:129
26103 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
26107 #: ../tools/virt-win-reg.pl:131
26109 "If you are unsure about the current encoding, use the L<file(1)> command. "
26110 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
26111 "style (CRLF) line endings, like this:"
26115 #: ../tools/virt-win-reg.pl:135
26118 " $ file software.reg\n"
26119 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
26120 " with CRLF line terminators\n"
26125 #: ../tools/virt-win-reg.pl:139
26126 msgid "This file would need conversion before you could C<--merge> it."
26130 #: ../tools/virt-win-reg.pl:143
26132 "Be careful when passing parameters containing C<\\> (backslash) in the "
26133 "shell. Usually you will have to use 'single quotes' or double backslashes "
26134 "(but not both) to protect them from the shell."
26138 #: ../tools/virt-win-reg.pl:147
26139 msgid "Paths and value names are case-insensitive."
26143 #: ../tools/virt-win-reg.pl:149
26144 msgid "CurrentControlSet etc."
26148 #: ../tools/virt-win-reg.pl:151
26150 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
26151 "Registry at the level of the hive file, and therefore you cannot modify "
26156 #: ../tools/virt-win-reg.pl:155
26158 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
26159 "circumstances it might refer to another control set. The way to find out is "
26160 "to look at the C<HKLM\\SYSTEM\\Select> key:"
26164 #: ../tools/virt-win-reg.pl:159
26167 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
26168 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
26169 " \"Current\"=dword:00000001\n"
26170 " \"Default\"=dword:00000001\n"
26171 " \"Failed\"=dword:00000000\n"
26172 " \"LastKnownGood\"=dword:00000002\n"
26177 #: ../tools/virt-win-reg.pl:166
26178 msgid "\"Current\" is the one which Windows will choose when it boots."
26182 #: ../tools/virt-win-reg.pl:168
26184 "Similarly, other C<Current...> keys in the path may need to be replaced."
26188 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
26193 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:501
26194 msgid "Enable debugging messages."
26198 #: ../tools/virt-win-reg.pl:232
26203 #: ../tools/virt-win-reg.pl:234
26205 "In merge mode, this merges a textual regedit file into the Windows Registry "
26206 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
26207 "displays or exports Registry entries instead."
26211 #: ../tools/virt-win-reg.pl:238
26213 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
26214 "result in disk corruption. However exporting (without this flag) is always "
26219 #: ../tools/virt-win-reg.pl:246
26220 msgid "B<--encoding> UTF-16LE|ASCII"
26224 #: ../tools/virt-win-reg.pl:248
26226 "When merging (only), you may need to specify the encoding for strings to be "
26227 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
26228 "(3)/ENCODING STRINGS>."
26232 #: ../tools/virt-win-reg.pl:252
26234 "The default is to use UTF-16LE, which should work with recent versions of "
26239 #: ../tools/virt-win-reg.pl:486
26241 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
26242 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
26243 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26247 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
26249 "When reporting bugs, please enable debugging and capture the I<complete> "
26254 #: ../tools/virt-win-reg.pl:504
26257 " export LIBGUESTFS_DEBUG=1\n"
26258 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
26263 #: ../tools/virt-win-reg.pl:507
26265 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
26270 #: ../tools/virt-df.pl:36
26271 msgid "virt-df - Display free space on virtual filesystems"
26275 #: ../tools/virt-df.pl:40
26278 " virt-df [--options]\n"
26283 #: ../tools/virt-df.pl:42
26286 " virt-df [--options] domname\n"
26291 #: ../tools/virt-df.pl:44
26294 " virt-df [--options] disk.img [disk.img ...]\n"
26299 #: ../tools/virt-df.pl:48
26301 "C<virt-df> is a command line tool to display free space on virtual machine "
26302 "filesystems. Unlike other tools, it doesn't just display the amount of "
26303 "space allocated to a virtual machine, but can look inside the virtual "
26304 "machine to see how much space is really being used."
26308 #: ../tools/virt-df.pl:53
26310 "It is like the L<df(1)> command, but for virtual machines, except that it "
26311 "also works for Windows virtual machines."
26315 #: ../tools/virt-df.pl:56
26317 "If used without any arguments, C<virt-df> checks with libvirt to get a list "
26318 "of all active and inactive guests, and performs a C<df>-type operation on "
26319 "each one in turn, printing out the results."
26323 #: ../tools/virt-df.pl:60
26325 "If used with any argument(s), C<virt-df> performs a C<df>-type operation on "
26326 "either the single named libvirt domain, or on the disk image(s) listed on "
26327 "the command line (which must all belong to a single VM). In this mode (with "
26328 "arguments), C<virt-df> will I<only work for a single guest>. If you want to "
26329 "run on multiple guests, then you have to invoke C<virt-df> multiple times."
26333 #: ../tools/virt-df.pl:67
26335 "Use the C<--csv> option to get a format which can be easily parsed by other "
26336 "programs. Other options are mostly similar to standard C<df> options. See "
26337 "below for the complete list."
26341 #: ../tools/virt-df.pl:107
26346 #: ../tools/virt-df.pl:109
26348 "Write out the results in CSV format (comma-separated values). This format "
26349 "can be imported easily into databases and spreadsheets, but read L</NOTE "
26350 "ABOUT CSV FORMAT> below."
26354 #: ../tools/virt-df.pl:134
26355 msgid "B<--human-readable> | B<-h>"
26359 #: ../tools/virt-df.pl:136
26360 msgid "Print sizes in human-readable format."
26364 #: ../tools/virt-df.pl:138
26365 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
26369 #: ../tools/virt-df.pl:144
26370 msgid "B<--inodes> | B<-i>"
26374 #: ../tools/virt-df.pl:146
26375 msgid "Print inodes instead of blocks."
26379 #: ../tools/virt-df.pl:152
26380 msgid "B<--one-per-guest>"
26384 #: ../tools/virt-df.pl:154
26386 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
26387 "disks from several guests to a single libguestfs appliance."
26391 #: ../tools/virt-df.pl:157
26392 msgid "You might use this option in the following circumstances:"
26396 #: ../tools/virt-df.pl:163
26398 "If you think an untrusted guest might actively try to exploit the libguestfs "
26399 "appliance kernel, then this prevents one guest from interfering with the "
26400 "stats printed for another guest."
26404 #: ../tools/virt-df.pl:169
26406 "If the kernel has a bug which stops it from accessing a filesystem in one "
26407 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
26408 "and report stats for further guests."
26412 #: ../tools/virt-df.pl:180
26417 #: ../tools/virt-df.pl:182
26419 "Print UUIDs instead of names. This is useful for following a guest even "
26420 "when the guest is migrated or renamed, or when two guests happen to have the "
26425 #: ../tools/virt-df.pl:186
26427 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
26428 "images, we still print the disk image name even when this option is "
26433 #: ../tools/virt-df.pl:609
26434 msgid "NOTE ABOUT CSV FORMAT"
26438 #: ../tools/virt-df.pl:611
26440 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
26441 "should be easy to parse, but it is definitely not easy to parse."
26445 #: ../tools/virt-df.pl:614
26447 "Myth: Just split fields at commas. Reality: This does I<not> work "
26448 "reliably. This example has two columns:"
26452 #: ../tools/virt-df.pl:617
26455 " \"foo,bar\",baz\n"
26460 #: ../tools/virt-df.pl:619
26462 "Myth: Read the file one line at a time. Reality: This does I<not> work "
26463 "reliably. This example has one row:"
26467 #: ../tools/virt-df.pl:622
26476 #: ../tools/virt-df.pl:625
26478 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
26479 "packaged in major Linux distributions)."
26483 #: ../tools/virt-df.pl:628
26485 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
26486 "or Python's built-in csv library)."
26490 #: ../tools/virt-df.pl:631
26491 msgid "Most spreadsheets and databases can import CSV directly."
26495 #: ../tools/virt-df.pl:642
26497 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
26498 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26502 #: ../tools/virt-ls.pl:34
26503 msgid "virt-ls - List files in a virtual machine"
26507 #: ../tools/virt-ls.pl:38
26510 " virt-ls [--options] domname directory\n"
26515 #: ../tools/virt-ls.pl:40
26518 " virt-ls [--options] disk.img [disk.img ...] directory\n"
26523 #: ../tools/virt-ls.pl:44
26525 "C<virt-ls> is a command line tool to list the names of files in a directory "
26526 "inside a virtual machine or disk image."
26530 #: ../tools/virt-ls.pl:47
26532 "C<virt-ls> is just a simple wrapper around L<libguestfs(3)> functionality. "
26533 "For more complex cases you should look at the L<guestfish(1)> tool."
26537 #: ../tools/virt-ls.pl:51
26539 "C<virt-ls> can be used in one of three modes: simple, long and recursive. A "
26540 "simple listing is like the ordinary L<ls(1)> command:"
26544 #: ../tools/virt-ls.pl:54
26547 " $ virt-ls myguest /\n"
26555 #: ../tools/virt-ls.pl:59
26556 msgid "With the C<-l> (C<--long>) option, C<virt-ls> shows more detail:"
26560 #: ../tools/virt-ls.pl:61
26563 " $ virt-ls -l myguest /\n"
26565 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
26566 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
26572 #: ../tools/virt-ls.pl:67
26574 "With the C<-R> (C<--recursive>) option, C<virt-ls> lists the names of files "
26575 "and directories recursively:"
26579 #: ../tools/virt-ls.pl:70
26582 " $ virt-ls -R myguest /tmp\n"
26590 #: ../tools/virt-ls.pl:75
26592 "You I<cannot> combine these options. To do more complicated things, use "
26597 #: ../tools/virt-ls.pl:131 ../tools/virt-list-filesystems.pl:103
26598 #: ../tools/virt-list-partitions.pl:112
26599 msgid "B<-l> | B<--long>"
26603 #: ../tools/virt-ls.pl:133
26604 msgid "B<-R> | B<--recursive>"
26608 #: ../tools/virt-ls.pl:135
26610 "Select the mode. With neither of these options, C<virt-ls> produces a "
26611 "simple, flat list of the files in the named directory."
26615 #: ../tools/virt-ls.pl:138
26617 "C<virt-ls -l> produces a \"long listing\", which shows more detail (just "
26618 "like the plain C<ls -l> command)."
26622 #: ../tools/virt-ls.pl:141
26624 "C<virt-ls -R> produces a recursive list of files starting at the named "
26625 "directory. See the documentation for L<guestfs(3)/guestfs_find> for precise "
26630 #: ../tools/virt-ls.pl:145
26631 msgid "You cannot combine these options."
26635 #: ../tools/virt-ls.pl:234
26637 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<Sys::"
26638 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
26643 #: ../tools/virt-ls.pl:249 ../tools/virt-list-filesystems.pl:204
26644 #: ../tools/virt-cat.pl:201 ../tools/virt-tar.pl:298
26645 msgid "Copyright (C) 2009 Red Hat Inc."
26649 #: ../tools/virt-resize.pl:42
26650 msgid "virt-resize - Resize a virtual machine disk"
26654 #: ../tools/virt-resize.pl:46
26657 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
26658 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
26659 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
26664 #: ../tools/virt-resize.pl:52
26666 "Virt-resize is a tool which can resize a virtual machine disk, making it "
26667 "larger or smaller overall, and resizing or deleting any partitions contained "
26672 #: ../tools/virt-resize.pl:56
26674 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
26675 "not> be used on live virtual machines - for consistent results, shut the "
26676 "virtual machine down before resizing it."
26680 #: ../tools/virt-resize.pl:60
26682 "If you are not familiar with the associated tools: L<virt-list-partitions(1)"
26683 ">, L<virt-list-filesystems(1)> and L<virt-df(1)>, we recommend you go and "
26684 "read those manual pages first."
26688 #: ../tools/virt-resize.pl:68
26690 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
26691 "fill the extra 5GB of space."
26695 #: ../tools/virt-resize.pl:71
26698 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
26699 " virt-list-partitions -lht olddisk\n"
26700 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
26701 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
26706 #: ../tools/virt-resize.pl:76
26708 "As above, but make the /boot partition 200MB bigger, while giving the "
26709 "remaining space to /dev/sda2:"
26713 #: ../tools/virt-resize.pl:79
26716 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
26721 #: ../tools/virt-resize.pl:81
26722 msgid "As above, but the output format will be uncompressed qcow2:"
26726 #: ../tools/virt-resize.pl:83
26729 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
26730 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
26735 #: ../tools/virt-resize.pl:86
26736 msgid "DETAILED USAGE"
26740 #: ../tools/virt-resize.pl:88
26741 msgid "EXPANDING A VIRTUAL MACHINE DISK"
26745 #: ../tools/virt-resize.pl:92
26746 msgid "1. Shut down the virtual machine"
26750 #: ../tools/virt-resize.pl:94
26751 msgid "2. Locate input disk image"
26755 #: ../tools/virt-resize.pl:96
26757 "Locate the input disk image (ie. the file or device on the host containing "
26758 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
26759 "dumpxml> like this to find the disk image name:"
26763 #: ../tools/virt-resize.pl:100
26766 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
26767 " Found 1 nodes:\n"
26769 " <source dev=\"/dev/vg/lv_guest\" />\n"
26774 #: ../tools/virt-resize.pl:105
26775 msgid "3. Look at current sizing"
26779 #: ../tools/virt-resize.pl:107
26781 "Use L<virt-list-partitions(1)> to display the current partitions and sizes:"
26785 #: ../tools/virt-resize.pl:110
26788 " # virt-list-partitions -lht /dev/vg/lv_guest\n"
26789 " /dev/sda1 ext3 101.9M\n"
26790 " /dev/sda2 pv 7.9G\n"
26791 " /dev/sda device 8.0G\n"
26796 #: ../tools/virt-resize.pl:115
26798 "(This example is a virtual machine with an 8 GB disk which we would like to "
26799 "expand up to 10 GB)."
26803 #: ../tools/virt-resize.pl:118
26804 msgid "4. Create output disk"
26808 #: ../tools/virt-resize.pl:120
26810 "Virt-resize cannot do in-place disk modifications. You have to have space "
26811 "to store the resized output disk."
26815 #: ../tools/virt-resize.pl:123
26817 "To store the resized disk image in a file, create a file of a suitable size:"
26821 #: ../tools/virt-resize.pl:126
26824 " # rm -f outdisk\n"
26825 " # truncate -s 10G outdisk\n"
26830 #: ../tools/virt-resize.pl:129
26831 msgid "Or use L<lvcreate(1)> to create a logical volume:"
26835 #: ../tools/virt-resize.pl:131
26838 " # lvcreate -L 10G -n lv_name vg_name\n"
26843 #: ../tools/virt-resize.pl:133
26844 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
26848 #: ../tools/virt-resize.pl:135
26851 " # virsh pool-list\n"
26852 " # virsh vol-create-as poolname newvol 10G\n"
26857 #: ../tools/virt-resize.pl:138
26862 #: ../tools/virt-resize.pl:140
26864 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
26865 "file) and the output disk. The output disk is the one created in the "
26870 #: ../tools/virt-resize.pl:144
26873 " # virt-resize indisk outdisk\n"
26878 #: ../tools/virt-resize.pl:146
26880 "This command just copies disk image C<indisk> to disk image C<outdisk> "
26881 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
26882 "larger, then an extra, empty partition is created at the end of the disk "
26883 "covering the extra space. If C<outdisk> is smaller, then it will give an "
26888 #: ../tools/virt-resize.pl:152
26890 "More realistically you'd want to expand existing partitions in the disk "
26891 "image by passing extra options (for the full list see the L</OPTIONS> "
26896 #: ../tools/virt-resize.pl:156
26898 "L</--expand> is the most useful option. It expands the named partition "
26899 "within the disk to fill any extra space:"
26903 #: ../tools/virt-resize.pl:159
26906 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
26911 #: ../tools/virt-resize.pl:161
26913 "(In this case, an extra partition is I<not> created at the end of the disk, "
26914 "because there will be no unused space)."
26918 #: ../tools/virt-resize.pl:164
26920 "L</--resize> is the other commonly used option. The following would "
26921 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
26922 "rest of the available space:"
26926 #: ../tools/virt-resize.pl:168
26929 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
26930 " indisk outdisk\n"
26935 #: ../tools/virt-resize.pl:171
26937 "If the expanded partition in the image contains a filesystem or LVM PV, then "
26938 "if virt-resize knows how, it will resize the contents, the equivalent of "
26939 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
26940 ">. However virt-resize does not know how to resize some filesystems, so you "
26941 "would have to online resize them after booting the guest. And virt-resize "
26942 "also does not resize anything inside an LVM PV, it just resizes the PV "
26943 "itself and leaves the user to resize any LVs inside that PV as desired."
26947 #: ../tools/virt-resize.pl:180
26948 msgid "Other options are covered below."
26952 #: ../tools/virt-resize.pl:182
26957 #: ../tools/virt-resize.pl:184
26958 msgid "Thoroughly test the new disk image I<before> discarding the old one."
26962 #: ../tools/virt-resize.pl:186
26963 msgid "If you are using libvirt, edit the XML to point at the new disk:"
26967 #: ../tools/virt-resize.pl:188
26970 " # virsh edit guestname\n"
26975 #: ../tools/virt-resize.pl:190
26977 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
26978 "html#elementsDisks>"
26982 #: ../tools/virt-resize.pl:193
26983 msgid "Then start up the domain with the new, resized disk:"
26987 #: ../tools/virt-resize.pl:195
26990 " # virsh start guestname\n"
26995 #: ../tools/virt-resize.pl:197
26997 "and check that it still works. See also the L</NOTES> section below for "
26998 "additional information."
27002 #: ../tools/virt-resize.pl:200
27003 msgid "7. Resize LVs etc inside the guest"
27007 #: ../tools/virt-resize.pl:202
27008 msgid "(This can also be done offline using L<guestfish(1)>)"
27012 #: ../tools/virt-resize.pl:204
27014 "Once the guest has booted you should see the new space available, at least "
27015 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
27016 "may need to resize LVs inside PVs, and also resize filesystem types that "
27017 "virt-resize does not know how to expand."
27021 #: ../tools/virt-resize.pl:211
27022 msgid "SHRINKING A VIRTUAL MACHINE DISK"
27026 #: ../tools/virt-resize.pl:213
27028 "Shrinking is somewhat more complex than expanding, and only an overview is "
27033 #: ../tools/virt-resize.pl:216
27035 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
27036 "filesystems). The user has to shrink content before passing the disk image "
27037 "to virt-resize, and virt-resize will check that the content has been shrunk "
27042 #: ../tools/virt-resize.pl:221
27043 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
27047 #: ../tools/virt-resize.pl:223
27049 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
27050 "steps 3 and 4 above to allocate a new disk image."
27054 #: ../tools/virt-resize.pl:226
27056 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
27060 #: ../tools/virt-resize.pl:229
27061 msgid "IGNORING OR DELETING PARTITIONS"
27065 #: ../tools/virt-resize.pl:231
27067 "virt-resize also gives a convenient way to ignore or delete partitions when "
27068 "copying from the input disk to the output disk. Ignoring a partition speeds "
27069 "up the copy where you don't care about the existing contents of a "
27070 "partition. Deleting a partition removes it completely, but note that it "
27071 "also renumbers any partitions after the one which is deleted, which can "
27072 "leave some guests unbootable."
27076 #: ../tools/virt-resize.pl:238
27077 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
27081 #: ../tools/virt-resize.pl:240
27083 "If the input disk is in qcow2 format, then you may prefer that the output is "
27084 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
27085 "the fly. The output format is simply determined by the format of the empty "
27086 "output container that you provide. Thus to create qcow2 output, use:"
27090 #: ../tools/virt-resize.pl:246
27093 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
27098 #: ../tools/virt-resize.pl:248
27099 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
27103 #: ../tools/virt-resize.pl:250
27104 msgid "Similarly, to get non-sparse raw output use:"
27108 #: ../tools/virt-resize.pl:252
27111 " fallocate -l size outdisk\n"
27116 #: ../tools/virt-resize.pl:254
27118 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
27119 "dev/zero of=outdisk bs=1M count=..>)"
27123 #: ../tools/virt-resize.pl:267
27124 msgid "Display help."
27128 #: ../tools/virt-resize.pl:281
27129 msgid "B<--resize part=size>"
27133 #: ../tools/virt-resize.pl:283
27135 "Resize the named partition (expanding or shrinking it) so that it has the "
27140 #: ../tools/virt-resize.pl:286
27142 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
27143 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
27144 "Exabytes; or as a percentage of the current size; or as a relative number or "
27145 "percentage. For example:"
27149 #: ../tools/virt-resize.pl:291
27152 " --resize /dev/sda2=10G\n"
27157 #: ../tools/virt-resize.pl:293
27160 " --resize /dev/sda4=90%\n"
27165 #: ../tools/virt-resize.pl:295
27168 " --resize /dev/sda2=+1G\n"
27173 #: ../tools/virt-resize.pl:297
27176 " --resize /dev/sda2=-200M\n"
27181 #: ../tools/virt-resize.pl:299
27184 " --resize /dev/sda1=+128K\n"
27189 #: ../tools/virt-resize.pl:301
27192 " --resize /dev/sda1=+10%\n"
27197 #: ../tools/virt-resize.pl:303
27200 " --resize /dev/sda1=-10%\n"
27205 #: ../tools/virt-resize.pl:305
27207 "You can increase the size of any partition. Virt-resize will expand the "
27208 "direct content of the partition if it knows how (see C<--expand> below)."
27212 #: ../tools/virt-resize.pl:309
27214 "You can only I<decrease> the size of partitions that contain filesystems or "
27215 "PVs which have already been shrunk. Virt-resize will check this has been "
27216 "done before proceeding, or else will print an error (see also C<--resize-"
27221 #: ../tools/virt-resize.pl:314 ../tools/virt-resize.pl:406
27222 #: ../tools/virt-resize.pl:423
27223 msgid "You can give this option multiple times."
27227 #: ../tools/virt-resize.pl:320
27228 msgid "B<--resize-force part=size>"
27232 #: ../tools/virt-resize.pl:322
27234 "This is the same as C<--resize> except that it will let you decrease the "
27235 "size of any partition. Generally this means you will lose any data which "
27236 "was at the end of the partition you shrink, but you may not care about that "
27237 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
27238 "as a swap partition)."
27242 #: ../tools/virt-resize.pl:328
27243 msgid "See also the C<--ignore> option."
27247 #: ../tools/virt-resize.pl:334
27248 msgid "B<--expand part>"
27252 #: ../tools/virt-resize.pl:336
27254 "Expand the named partition so it uses up all extra space (space left over "
27255 "after any other resize changes that you request have been done)."
27259 #: ../tools/virt-resize.pl:339
27261 "If virt-resize knows how, it will expand the direct content of the "
27262 "partition. For example, if the partition is an LVM PV, it will expand the "
27263 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
27264 "content it doesn't know about alone."
27268 #: ../tools/virt-resize.pl:344
27269 msgid "Currently virt-resize can resize:"
27273 #: ../tools/virt-resize.pl:350
27275 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
27280 #: ../tools/virt-resize.pl:355
27282 "NTFS filesystems contained directly in a partition, if libguestfs was "
27283 "compiled with support for NTFS."
27287 #: ../tools/virt-resize.pl:358
27289 "The filesystem must have been shut down consistently last time it was used. "
27290 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
27291 "consistency check, so at the first boot after resizing Windows will check "
27296 #: ../tools/virt-resize.pl:365
27298 "LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
27299 "inside the PV. The user will have to resize LVs as desired."
27303 #: ../tools/virt-resize.pl:371 ../tools/virt-resize.pl:393
27304 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
27308 #: ../tools/virt-resize.pl:377
27309 msgid "B<--shrink part>"
27313 #: ../tools/virt-resize.pl:379
27315 "Shrink the named partition until the overall disk image fits in the "
27316 "destination. The named partition B<must> contain a filesystem or PV which "
27317 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
27318 "online tools). Virt-resize will check this and give an error if it has not "
27323 #: ../tools/virt-resize.pl:385
27325 "The amount by which the overall disk must be shrunk (after carrying out all "
27326 "other operations requested by the user) is called the \"deficit\". For "
27327 "example, a straight copy (assume no other operations) from a 5GB disk image "
27328 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
27329 "would give an error unless the user specified a partition to shrink and that "
27330 "partition had more than a gigabyte of free space."
27334 #: ../tools/virt-resize.pl:399
27335 msgid "B<--ignore part>"
27339 #: ../tools/virt-resize.pl:401
27341 "Ignore the named partition. Effectively this means the partition is "
27342 "allocated on the destination disk, but the content is not copied across from "
27343 "the source disk. The content of the partition will be blank (all zero "
27348 #: ../tools/virt-resize.pl:412
27349 msgid "B<--delete part>"
27353 #: ../tools/virt-resize.pl:414
27355 "Delete the named partition. It would be more accurate to describe this as "
27356 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
27357 "the original disk image is left intact."
27361 #: ../tools/virt-resize.pl:418
27363 "Note that when you delete a partition, then anything contained in the "
27364 "partition is also deleted. Furthermore, this causes any partitions that "
27365 "come after to be I<renumbered>, which can easily make your guest unbootable."
27369 #: ../tools/virt-resize.pl:429
27370 msgid "B<--LV-expand logvol>"
27374 #: ../tools/virt-resize.pl:431
27376 "This takes the logical volume and, as a final step, expands it to fill all "
27377 "the space available in its volume group. A typical usage, assuming a Linux "
27378 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
27379 "lv_root> would be:"
27383 #: ../tools/virt-resize.pl:436
27386 " virt-resize indisk outdisk \\\n"
27387 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
27392 #: ../tools/virt-resize.pl:439
27394 "This would first expand the partition (and PV), and then expand the root "
27395 "device to fill the extra space in the PV."
27399 #: ../tools/virt-resize.pl:442
27401 "The contents of the LV are also resized if virt-resize knows how to do "
27402 "that. You can stop virt-resize from trying to expand the content by using "
27403 "the option C<--no-expand-content>."
27407 #: ../tools/virt-resize.pl:446
27408 msgid "Use L<virt-list-filesystems(1)> to list the filesystems in the guest."
27412 #: ../tools/virt-resize.pl:449
27414 "You can give this option multiple times, I<but> it doesn't make sense to do "
27415 "this unless the logical volumes you specify are all in different volume "
27420 #: ../tools/virt-resize.pl:457
27421 msgid "B<--no-copy-boot-loader>"
27425 #: ../tools/virt-resize.pl:459
27427 "By default, virt-resize copies over some sectors at the start of the disk "
27428 "(up to the beginning of the first partition). Commonly these sectors "
27429 "contain the Master Boot Record (MBR) and the boot loader, and are required "
27430 "in order for the guest to boot correctly."
27434 #: ../tools/virt-resize.pl:464
27436 "If you specify this flag, then this initial copy is not done. You may need "
27437 "to reinstall the boot loader in this case."
27441 #: ../tools/virt-resize.pl:472
27442 msgid "B<--no-extra-partition>"
27446 #: ../tools/virt-resize.pl:474
27448 "By default, virt-resize creates an extra partition if there is any extra, "
27449 "unused space after all resizing has happened. Use this option to prevent "
27450 "the extra partition from being created. If you do this then the extra space "
27451 "will be inaccessible until you run fdisk, parted, or some other partitioning "
27452 "tool in the guest."
27456 #: ../tools/virt-resize.pl:480
27458 "Note that if the surplus space is smaller than 10 MB, no extra partition "
27463 #: ../tools/virt-resize.pl:487
27464 msgid "B<--no-expand-content>"
27468 #: ../tools/virt-resize.pl:489
27470 "By default, virt-resize will try to expand the direct contents of "
27471 "partitions, if it knows how (see C<--expand> option above)."
27475 #: ../tools/virt-resize.pl:492
27477 "If you give the C<--no-expand-content> option then virt-resize will not "
27482 #: ../tools/virt-resize.pl:499
27483 msgid "B<-d> | B<--debug>"
27487 #: ../tools/virt-resize.pl:507
27488 msgid "B<-n> | B<--dryrun>"
27492 #: ../tools/virt-resize.pl:509
27493 msgid "Print a summary of what would be done, but don't do anything."
27497 #: ../tools/virt-resize.pl:515
27498 msgid "B<-q> | B<--quiet>"
27502 #: ../tools/virt-resize.pl:517
27503 msgid "Don't print the summary."
27507 #: ../tools/virt-resize.pl:525
27509 "Specify the format of the input disk image. If this flag is not given then "
27510 "it is auto-detected from the image itself."
27514 #: ../tools/virt-resize.pl:531
27516 "Note that this option I<does not> affect the output format. See L</QCOW2 "
27517 "AND NON-SPARSE RAW FORMATS>."
27521 #: ../tools/virt-resize.pl:538
27522 msgid "B<--output-format> raw"
27526 #: ../tools/virt-resize.pl:540
27528 "Specify the format of the output disk image. If this flag is not given then "
27529 "it is auto-detected from the image itself."
27533 #: ../tools/virt-resize.pl:546
27535 "Note that you still need to create the output disk with the right format. "
27536 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
27540 #: ../tools/virt-resize.pl:1422 ../tools/virt-rescue.pl:90
27545 #: ../tools/virt-resize.pl:1424
27546 msgid "\"Partition 1 does not end on cylinder boundary.\""
27550 #: ../tools/virt-resize.pl:1426
27552 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
27553 "means the partitions will not be aligned to the ancient CHS geometry. "
27554 "However CHS geometry is meaningless for disks manufactured since the early "
27555 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
27556 "cylinders is not required by any modern operating system."
27560 #: ../tools/virt-resize.pl:1433
27561 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
27565 #: ../tools/virt-resize.pl:1435
27567 "In Windows Vista and later versions, Microsoft switched to using a separate "
27568 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
27569 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
27570 "the boot partition. Doing so seems to break the guest completely. However "
27571 "expanding the second partition (ie. C: drive) should work."
27575 #: ../tools/virt-resize.pl:1442
27577 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
27578 "NTFS partitions have been expanded. This is just a safety check and (unless "
27579 "it find errors) is nothing to worry about."
27583 #: ../tools/virt-resize.pl:1446
27584 msgid "GUEST BOOT STUCK AT \"GRUB\""
27588 #: ../tools/virt-resize.pl:1448
27590 "If a Linux guest does not boot after resizing, and the boot is stuck after "
27591 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
27592 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
27593 "although we think is to do with partition alignment."
27597 #: ../tools/virt-resize.pl:1453
27600 " guestfish -i -a newdisk\n"
27601 " ><fs> cat /boot/grub/device.map\n"
27602 " # check the contents of this file are sensible or\n"
27603 " # edit the file if necessary\n"
27604 " ><fs> grub-install / /dev/vda\n"
27610 #: ../tools/virt-resize.pl:1460
27612 "For more flexible guest reconfiguration, including if you need to specify "
27613 "other parameters to grub-install, use L<virt-rescue(1)>."
27617 #: ../tools/virt-resize.pl:1463
27618 msgid "ALTERNATIVE TOOLS"
27622 #: ../tools/virt-resize.pl:1465
27624 "There are several proprietary tools for resizing partitions. We won't "
27625 "mention any here."
27629 #: ../tools/virt-resize.pl:1468
27631 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
27632 "operations on disk images. They can resize and move partitions, but I don't "
27633 "think they can do anything with the contents, and they certainly don't "
27638 #: ../tools/virt-resize.pl:1473
27640 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
27641 "but at a much lower level. You will probably end up hand-calculating sector "
27642 "offsets, which is something that virt-resize was designed to avoid. If you "
27643 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
27648 #: ../tools/virt-resize.pl:1488
27650 "L<virt-list-partitions(1)>, L<virt-list-filesystems(1)>, L<virt-df(1)>, "
27651 "L<guestfs(3)>, L<guestfish(1)>, L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, "
27652 "L<resize2fs(8)>, L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)"
27653 ">, L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
27654 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
27658 #: ../tools/virt-list-filesystems.pl:32
27660 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
27664 #: ../tools/virt-list-filesystems.pl:36
27667 " virt-list-filesystems [--options] domname\n"
27672 #: ../tools/virt-list-filesystems.pl:38
27675 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
27680 #: ../tools/virt-list-filesystems.pl:42
27682 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
27683 "are contained in a virtual machine or disk image."
27687 #: ../tools/virt-list-filesystems.pl:46
27689 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
27690 "functionality. For more complex cases you should look at the L<guestfish(1)"
27695 #: ../tools/virt-list-filesystems.pl:105
27697 "With this option, C<virt-list-filesystems> displays the type of each "
27698 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
27702 #: ../tools/virt-list-filesystems.pl:112
27703 msgid "B<-a> | B<--all>"
27707 #: ../tools/virt-list-filesystems.pl:114
27709 "Normally we only show mountable filesystems. If this option is given then "
27710 "swap devices are shown too."
27714 #: ../tools/virt-list-filesystems.pl:188
27716 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-list-"
27717 "partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)"
27718 ">, L<http://libguestfs.org/>."
27722 #: ../tools/virt-cat.pl:33
27723 msgid "virt-cat - Display a file in a virtual machine"
27727 #: ../tools/virt-cat.pl:37
27730 " virt-cat [--options] domname file\n"
27735 #: ../tools/virt-cat.pl:39
27738 " virt-cat [--options] disk.img [disk.img ...] file\n"
27743 #: ../tools/virt-cat.pl:43
27745 "C<virt-cat> is a command line tool to display the contents of C<file> where "
27746 "C<file> exists in the named virtual machine (or disk image)."
27750 #: ../tools/virt-cat.pl:46
27752 "C<virt-cat> can be used to quickly view a single file. To edit a file, use "
27753 "C<virt-edit>. For more complex cases you should look at the L<guestfish(1)> "
27758 #: ../tools/virt-cat.pl:52
27760 "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
27764 #: ../tools/virt-cat.pl:55
27767 " virt-cat mydomain /etc/fstab\n"
27772 #: ../tools/virt-cat.pl:57
27773 msgid "List syslog messages from a VM:"
27777 #: ../tools/virt-cat.pl:59
27780 " virt-cat mydomain /var/log/messages | tail\n"
27785 #: ../tools/virt-cat.pl:61
27786 msgid "Find out what DHCP IP address a VM acquired:"
27790 #: ../tools/virt-cat.pl:63
27793 " virt-cat mydomain /var/log/messages | grep 'dhclient: bound to' | tail\n"
27798 #: ../tools/virt-cat.pl:65
27799 msgid "Find out what packages were recently installed:"
27803 #: ../tools/virt-cat.pl:67
27806 " virt-cat mydomain /var/log/yum.log | tail\n"
27811 #: ../tools/virt-cat.pl:69
27812 msgid "Find out who is logged on inside a virtual machine:"
27816 #: ../tools/virt-cat.pl:71
27819 " virt-cat mydomain /var/run/utmp > /tmp/utmp\n"
27825 #: ../tools/virt-cat.pl:74
27826 msgid "or who was logged on:"
27830 #: ../tools/virt-cat.pl:76
27833 " virt-cat mydomain /var/log/wtmp > /tmp/wtmp\n"
27834 " last -f /tmp/wtmp\n"
27839 #: ../tools/virt-cat.pl:187
27841 "L<guestfs(3)>, L<guestfish(1)>, L<virt-edit(1)>, L<Sys::Guestfs(3)>, L<Sys::"
27842 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27846 #: ../tools/virt-tar.pl:33
27847 msgid "virt-tar - Extract or upload files to a virtual machine"
27851 #: ../tools/virt-tar.pl:37
27854 " virt-tar [--options] -x domname directory tarball\n"
27859 #: ../tools/virt-tar.pl:39
27862 " virt-tar [--options] -u domname tarball directory\n"
27867 #: ../tools/virt-tar.pl:41
27870 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
27875 #: ../tools/virt-tar.pl:43
27878 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
27883 #: ../tools/virt-tar.pl:47
27884 msgid "Download C</home> from the VM into a local tarball:"
27888 #: ../tools/virt-tar.pl:49
27891 " virt-tar -x domname /home home.tar\n"
27896 #: ../tools/virt-tar.pl:51
27899 " virt-tar -zx domname /home home.tar.gz\n"
27904 #: ../tools/virt-tar.pl:53
27905 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
27909 #: ../tools/virt-tar.pl:55
27912 " virt-tar -u domname uploadstuff.tar /tmp\n"
27917 #: ../tools/virt-tar.pl:57
27920 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
27925 #: ../tools/virt-tar.pl:61
27927 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
27928 "virtual machines. If you do this, you risk disk corruption in the VM. "
27929 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
27933 #: ../tools/virt-tar.pl:66
27935 "You can use C<-x> (extract) on live virtual machines, but you might get "
27936 "inconsistent results or errors if there is filesystem activity inside the "
27937 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
27938 "work, but the only way to guarantee consistent results is if the virtual "
27939 "machine is shut down."
27943 #: ../tools/virt-tar.pl:74
27945 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
27946 "parts of a guest filesystem. There are many possibilities: making backups, "
27947 "uploading data files, snooping on guest activity, fixing or customizing "
27952 #: ../tools/virt-tar.pl:79
27954 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
27955 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
27956 "should look at the L<guestfish(1)> tool."
27960 #: ../tools/virt-tar.pl:83
27962 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
27963 "its contents (recursively) from the virtual machine into a local tarball. "
27964 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
27965 "virtual machine. You cannot use these two options together."
27969 #: ../tools/virt-tar.pl:89
27971 "In addition, you may need to use the C<-z> (gZip) option to enable "
27972 "compression. When uploading, you have to specify C<-z> if the upload file "
27973 "is compressed because virt-tar won't detect this on its own."
27977 #: ../tools/virt-tar.pl:93
27979 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
27980 "example it cannot do PKZip files or bzip2 compression. If you want that "
27981 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
27982 "the L<libguestfs(3)> API)."
27986 #: ../tools/virt-tar.pl:151
27987 msgid "B<-x> | B<--extract> | B<--download>"
27991 #: ../tools/virt-tar.pl:153
27992 msgid "B<-u> | B<--upload>"
27996 #: ../tools/virt-tar.pl:155
27998 "Use C<-x> to extract (download) a directory from a virtual machine to a "
28003 #: ../tools/virt-tar.pl:158
28005 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
28006 "Please read the L</WARNING> section above before using this option."
28010 #: ../tools/virt-tar.pl:162
28011 msgid "You must specify exactly one of these options."
28015 #: ../tools/virt-tar.pl:168
28016 msgid "B<-z> | B<--gzip>"
28020 #: ../tools/virt-tar.pl:170
28021 msgid "Specify that the input or output tarball is gzip-compressed."
28025 #: ../tools/virt-tar.pl:283
28027 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<Sys::"
28028 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
28033 #: ../tools/virt-rescue.pl:33
28034 msgid "virt-rescue - Run a rescue shell on a virtual machine"
28038 #: ../tools/virt-rescue.pl:37
28041 " virt-rescue [--options] domname\n"
28046 #: ../tools/virt-rescue.pl:39
28049 " virt-rescue [--options] disk.img [disk.img ...]\n"
28054 #: ../tools/virt-rescue.pl:43
28056 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
28057 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
28058 "you from doing this, but doesn't catch all cases."
28062 #: ../tools/virt-rescue.pl:47
28064 "However if you use the I<--ro> (read only) option, then you can attach a "
28065 "shell to a live virtual machine. The results might be strange or "
28066 "inconsistent at times but you won't get disk corruption."
28070 #: ../tools/virt-rescue.pl:53
28072 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
28073 "need for a CD. virt-rescue gives you a rescue shell and some simple "
28074 "recovery tools which you can use to examine or rescue a virtual machine or "
28079 #: ../tools/virt-rescue.pl:58
28081 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
28082 "on disk image(s):"
28086 #: ../tools/virt-rescue.pl:61
28089 " virt-rescue GuestName\n"
28094 #: ../tools/virt-rescue.pl:63
28097 " virt-rescue --ro /path/to/disk.img\n"
28102 #: ../tools/virt-rescue.pl:65
28105 " virt-rescue /dev/sdc\n"
28110 #: ../tools/virt-rescue.pl:67
28111 msgid "For live VMs you I<must> use the --ro option."
28115 #: ../tools/virt-rescue.pl:69
28117 "When you run virt-rescue on a virtual machine or disk image, you are placed "
28118 "in an interactive bash shell where you can use many ordinary Linux "
28119 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
28120 "appliance. You must mount the virtual machine's filesystems by hand. There "
28121 "is an empty directory called C</sysroot> where you can mount filesystems."
28125 #: ../tools/virt-rescue.pl:76
28127 "In the example below, we list logical volumes, then choose one to mount "
28128 "under C</sysroot>:"
28132 #: ../tools/virt-rescue.pl:79
28136 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
28137 " lv_root vg_f11x64 -wi-a- 8.83G\n"
28138 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
28139 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
28140 " ><rescue> ls /sysroot\n"
28145 #: ../tools/virt-rescue.pl:86
28147 "If you don't know what filesystems are available on the virtual machine then "
28148 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
28152 #: ../tools/virt-rescue.pl:92
28154 "Virt-rescue can be used on I<any> disk image file or device, not just a "
28155 "virtual machine. For example you can use it on a blank file if you want to "
28156 "partition that file (although we would recommend using L<guestfish(1)> "
28157 "instead as it is more suitable for this purpose). You can even use virt-"
28158 "rescue on things like SD cards."
28162 #: ../tools/virt-rescue.pl:98
28164 "This tool is just designed for quick interactive hacking on a virtual "
28165 "machine. For more structured access to a virtual machine disk image, you "
28166 "should use L<guestfs(3)>. To get a structured shell that you can use to "
28167 "make scripted changes to guests, use L<guestfish(1)>."
28171 #: ../tools/virt-rescue.pl:127
28172 msgid "B<--append kernelopts>"
28176 #: ../tools/virt-rescue.pl:129
28177 msgid "Pass additional options to the rescue kernel."
28181 #: ../tools/virt-rescue.pl:164
28182 msgid "B<--memsize MB> | B<-m MB>"
28186 #: ../tools/virt-rescue.pl:166
28188 "Change the amount of memory allocated to the rescue system. The default is "
28189 "set by libguestfs and is small but adequate for running system tools. The "
28190 "occasional program might need more memory. The parameter is specified in "
28195 #: ../tools/virt-rescue.pl:175
28196 msgid "B<--network MB>"
28200 #: ../tools/virt-rescue.pl:177
28201 msgid "Enable QEMU user networking in the guest."
28205 #: ../tools/virt-rescue.pl:183
28206 msgid "B<--ro> | B<-r>"
28210 #: ../tools/virt-rescue.pl:185
28211 msgid "Open the image read-only."
28215 #: ../tools/virt-rescue.pl:197
28217 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
28218 "SELINUX> before using this option."
28222 #: ../tools/virt-rescue.pl:257
28224 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
28225 "ENVIRONMENT VARIABLES> for the complete list."
28229 #: ../tools/virt-rescue.pl:269
28231 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
28232 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
28236 #: ../tools/virt-make-fs.pl:37
28237 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
28241 #: ../tools/virt-make-fs.pl:41
28244 " virt-make-fs [--options] input.tar output.img\n"
28249 #: ../tools/virt-make-fs.pl:43
28252 " virt-make-fs [--options] input.tar.gz output.img\n"
28257 #: ../tools/virt-make-fs.pl:45
28260 " virt-make-fs [--options] directory output.img\n"
28265 #: ../tools/virt-make-fs.pl:49
28267 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
28268 "archive or some files in a directory. It is similar to tools like L<mkisofs"
28269 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
28270 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
28271 "you want to attach these filesystems to existing virtual machines (eg. to "
28272 "import large amounts of read-only data to a VM)."
28276 #: ../tools/virt-make-fs.pl:57
28277 msgid "Basic usage is:"
28281 #: ../tools/virt-make-fs.pl:59
28284 " virt-make-fs input output\n"
28289 #: ../tools/virt-make-fs.pl:61
28291 "where C<input> is either a directory containing files that you want to add, "
28292 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
28293 "C<output> is a disk image. The input type is detected automatically. The "
28294 "output disk image defaults to a raw ext2 image unless you specify extra "
28295 "flags (see L</OPTIONS> below)."
28299 #: ../tools/virt-make-fs.pl:67
28300 msgid "EXTRA SPACE"
28304 #: ../tools/virt-make-fs.pl:69
28306 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
28307 "the files that it contains, but might have extra space. Depending on how "
28308 "you are going to use the output, you might think this extra space is wasted "
28309 "and want to minimize it, or you might want to leave space so that more files "
28310 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
28311 "but you can use the C<--size> flag to leave space in the filesystem if you "
28316 #: ../tools/virt-make-fs.pl:77
28318 "An alternative way to leave extra space but not make the output image any "
28319 "bigger is to use an alternative disk image format (instead of the default "
28320 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
28321 "image format (check your hypervisor supports this before using it). This "
28322 "allows you to choose a large C<--size> but the extra space won't actually be "
28323 "allocated in the image until you try to store something in it."
28327 #: ../tools/virt-make-fs.pl:85
28329 "Don't forget that you can also use local commands including L<resize2fs(8)> "
28330 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-"
28331 "resize to build another image from scratch."
28335 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
28336 #: ../tools/virt-make-fs.pl:142
28341 #: ../tools/virt-make-fs.pl:91
28344 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
28349 #: ../tools/virt-make-fs.pl:93
28350 msgid "FILESYSTEM TYPE"
28354 #: ../tools/virt-make-fs.pl:95
28356 "The default filesystem type is C<ext2>. Just about any filesystem type that "
28357 "libguestfs supports can be used (but I<not> read-only formats like "
28358 "ISO9660). Here are some of the more common choices:"
28362 #: ../tools/virt-make-fs.pl:101
28367 #: ../tools/virt-make-fs.pl:103
28369 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
28370 "you are not going to use the filesystem in a way that requires the journal, "
28371 "then this is just wasted overhead."
28375 #: ../tools/virt-make-fs.pl:107
28376 msgid "I<ntfs> or I<vfat>"
28380 #: ../tools/virt-make-fs.pl:109
28381 msgid "Useful if exporting data to a Windows guest."
28385 #: ../tools/virt-make-fs.pl:111
28387 "I<Note for vfat>: The tar archive or local directory must only contain files "
28388 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
28389 "program running within libguestfs is unable to change the ownership of non-"
28390 "root files, since vfat itself does not support this."
28394 #: ../tools/virt-make-fs.pl:116
28399 #: ../tools/virt-make-fs.pl:118
28401 "Lower overhead than C<ext2>, but certain limitations on filename length and "
28402 "total filesystem size."
28406 #: ../tools/virt-make-fs.pl:125
28409 " virt-make-fs --type=minix input minixfs.img\n"
28414 #: ../tools/virt-make-fs.pl:127
28415 msgid "TO PARTITION OR NOT TO PARTITION"
28419 #: ../tools/virt-make-fs.pl:129
28420 msgid "Optionally virt-make-fs can add a partition table to the output disk."
28424 #: ../tools/virt-make-fs.pl:131
28426 "Adding a partition can make the disk image more compatible with certain "
28427 "virtualized operating systems which don't expect to see a filesystem "
28428 "directly located on a block device (Linux doesn't care and will happily "
28429 "handle both types)."
28433 #: ../tools/virt-make-fs.pl:136
28435 "On the other hand, if you have a partition table then the output image is no "
28436 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
28437 "directly on a partitioned disk image. (However libguestfs tools such as "
28438 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
28442 #: ../tools/virt-make-fs.pl:144
28443 msgid "Add an MBR partition:"
28447 #: ../tools/virt-make-fs.pl:146
28450 " virt-make-fs --partition -- input disk.img\n"
28455 #: ../tools/virt-make-fs.pl:148
28457 "If the output disk image could be terabyte-sized or larger, it's better to "
28458 "use an EFI/GPT-compatible partition table:"
28462 #: ../tools/virt-make-fs.pl:151
28465 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
28470 #: ../tools/virt-make-fs.pl:179
28471 msgid "Enable debugging information."
28475 #: ../tools/virt-make-fs.pl:185
28476 msgid "B<--size=E<lt>NE<gt>>"
28480 #: ../tools/virt-make-fs.pl:187
28481 msgid "B<--size=+E<lt>NE<gt>>"
28485 #: ../tools/virt-make-fs.pl:189
28486 msgid "B<-s E<lt>NE<gt>>"
28490 #: ../tools/virt-make-fs.pl:191
28491 msgid "B<-s +E<lt>NE<gt>>"
28495 #: ../tools/virt-make-fs.pl:193
28497 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
28501 #: ../tools/virt-make-fs.pl:196
28503 "If this option is I<not> given, then the output image will be just large "
28504 "enough to contain all the files, with not much wasted space."
28508 #: ../tools/virt-make-fs.pl:199
28510 "To choose a fixed size output disk, specify an absolute number followed by b/"
28511 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28512 "Petabytes or Exabytes. This must be large enough to contain all the input "
28513 "files, else you will get an error."
28517 #: ../tools/virt-make-fs.pl:204
28519 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
28520 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28521 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
28522 "the input files, and (approximately) an extra 200 MB free space."
28526 #: ../tools/virt-make-fs.pl:210
28528 "Note that virt-make-fs estimates free space, and therefore will not produce "
28529 "filesystems containing precisely the free space requested. (It is much more "
28530 "expensive and time-consuming to produce a filesystem which has precisely the "
28531 "desired free space)."
28535 #: ../tools/virt-make-fs.pl:219
28536 msgid "B<--format=E<lt>fmtE<gt>>"
28540 #: ../tools/virt-make-fs.pl:221
28541 msgid "B<-F E<lt>fmtE<gt>>"
28545 #: ../tools/virt-make-fs.pl:223
28546 msgid "Choose the output disk image format."
28550 #: ../tools/virt-make-fs.pl:225
28551 msgid "The default is C<raw> (raw disk image)."
28555 #: ../tools/virt-make-fs.pl:227
28557 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
28558 "that would really make sense here is C<qcow2>."
28562 #: ../tools/virt-make-fs.pl:234
28563 msgid "B<--type=E<lt>fsE<gt>>"
28567 #: ../tools/virt-make-fs.pl:236
28568 msgid "B<-t E<lt>fsE<gt>>"
28572 #: ../tools/virt-make-fs.pl:238
28573 msgid "Choose the output filesystem type."
28577 #: ../tools/virt-make-fs.pl:240
28578 msgid "The default is C<ext2>."
28582 #: ../tools/virt-make-fs.pl:242
28584 "Any filesystem which is supported read-write by libguestfs can be used here."
28588 #: ../tools/virt-make-fs.pl:249
28589 msgid "B<--partition>"
28593 #: ../tools/virt-make-fs.pl:251
28594 msgid "B<--partition=E<lt>parttypeE<gt>>"
28598 #: ../tools/virt-make-fs.pl:253
28600 "If specified, this flag adds an MBR partition table to the output disk image."
28604 #: ../tools/virt-make-fs.pl:256
28606 "You can change the partition table type, eg. C<--partition=gpt> for large "
28611 #: ../tools/virt-make-fs.pl:259
28613 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
28614 "might consider the next parameter to be the partition type. For example:"
28618 #: ../tools/virt-make-fs.pl:263
28621 " virt-make-fs --partition input.tar ...\n"
28626 #: ../tools/virt-make-fs.pl:265
28628 "would cause virt-make-fs to think you wanted to use a partition type of "
28629 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
28630 "dash) between options and the input file argument:"
28634 #: ../tools/virt-make-fs.pl:269
28637 " virt-make-fs --partition -- input.tar ...\n"
28642 #: ../tools/virt-make-fs.pl:536
28644 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
28645 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
28646 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28650 #: ../tools/virt-make-fs.pl:553
28653 " export LIBGUESTFS_DEBUG=1\n"
28654 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
28659 #: ../tools/virt-make-fs.pl:556
28661 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
28666 #: ../tools/virt-list-partitions.pl:32
28668 "virt-list-partitions - List partitions in a virtual machine or disk image"
28672 #: ../tools/virt-list-partitions.pl:36
28675 " virt-list-partitions [--options] domname\n"
28680 #: ../tools/virt-list-partitions.pl:38
28683 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
28688 #: ../tools/virt-list-partitions.pl:42
28690 "C<virt-list-partitions> is a command line tool to list the partitions that "
28691 "are contained in a virtual machine or disk image. It is mainly useful as a "
28692 "first step to using L<virt-resize(1)>."
28696 #: ../tools/virt-list-partitions.pl:47
28698 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
28699 "functionality. For more complex cases you should look at the L<guestfish(1)"
28704 #: ../tools/virt-list-partitions.pl:104
28705 msgid "B<-h> | B<--human-readable>"
28709 #: ../tools/virt-list-partitions.pl:106
28710 msgid "Show sizes in human-readable form (eg. \"1G\")."
28714 #: ../tools/virt-list-partitions.pl:114
28716 "With this option, C<virt-list-partitions> displays the type and size of each "
28717 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
28721 #: ../tools/virt-list-partitions.pl:121
28722 msgid "B<-t> | B<--total>"
28726 #: ../tools/virt-list-partitions.pl:123
28728 "Display the total size of each block device (as a separate row or rows)."
28732 #: ../tools/virt-list-partitions.pl:256
28734 "L<guestfs(3)>, L<guestfish(1)>, L<virt-list-filesystems(1)>, L<virt-resize(1)"
28735 ">, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://"
28736 "libguestfs.org/>."