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-03 21:09+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:461 ../src/guestfs-actions.pod:469
791 #: ../src/guestfs-actions.pod:476 ../src/guestfs-actions.pod:483
792 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1426
793 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1434
794 #: ../src/guestfs-actions.pod:1442 ../src/guestfs-actions.pod:1446
795 #: ../src/guestfs-actions.pod:1450 ../src/guestfs-actions.pod:1460
796 #: ../src/guestfs-actions.pod:1464 ../src/guestfs-actions.pod:1468
797 #: ../src/guestfs-actions.pod:1596 ../src/guestfs-actions.pod:1600
798 #: ../src/guestfs-actions.pod:1605 ../src/guestfs-actions.pod:1610
799 #: ../src/guestfs-actions.pod:1665 ../src/guestfs-actions.pod:1669
800 #: ../src/guestfs-actions.pod:1674 ../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:860
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:1661 ../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:867
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:893
3711 msgid "LIBGUESTFS_APPEND"
3715 #: ../src/guestfs.pod:1877 ../fish/guestfish.pod:895
3716 msgid "Pass additional options to the guest kernel."
3720 #: ../src/guestfs.pod:1879 ../fish/guestfish.pod:897
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:902
3733 msgid "LIBGUESTFS_MEMSIZE"
3737 #: ../src/guestfs.pod:1886 ../fish/guestfish.pod:904
3739 "Set the memory allocated to the qemu process, in megabytes. For example:"
3743 #: ../src/guestfs.pod:1889 ../fish/guestfish.pod:907
3746 " LIBGUESTFS_MEMSIZE=700\n"
3751 #: ../src/guestfs.pod:1891 ../fish/guestfish.pod:909
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:914
3764 msgid "LIBGUESTFS_QEMU"
3768 #: ../src/guestfs.pod:1898 ../fish/guestfish.pod:916
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:920
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:929
3797 #: ../src/guestfs.pod:1911 ../fish/guestfish.pod:931
3798 msgid "Location of temporary directory, defaults to C</tmp>."
3802 #: ../src/guestfs.pod:1913 ../fish/guestfish.pod:933
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:991
3812 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:214
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:1008
3898 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:225
3899 #: ../inspector/virt-inspector.pl:580
3904 #: ../src/guestfs.pod:1983 ../fish/guestfish.pod:1010
3905 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:227
3906 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
3910 #: ../src/guestfs.pod:1985 ../fish/guestfish.pod:1012
3911 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:229
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:1014
3923 #: ../fuse/guestmount.pod:231
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:56
3997 #: ../src/guestfs-actions.pod:115 ../src/guestfs-actions.pod:150
3998 #: ../src/guestfs-actions.pod:162 ../src/guestfs-actions.pod:181
3999 #: ../src/guestfs-actions.pod:199 ../src/guestfs-actions.pod:211
4000 #: ../src/guestfs-actions.pod:318 ../src/guestfs-actions.pod:336
4001 #: ../src/guestfs-actions.pod:348 ../src/guestfs-actions.pod:387
4002 #: ../src/guestfs-actions.pod:411 ../src/guestfs-actions.pod:427
4003 #: ../src/guestfs-actions.pod:492 ../src/guestfs-actions.pod:521
4004 #: ../src/guestfs-actions.pod:533 ../src/guestfs-actions.pod:546
4005 #: ../src/guestfs-actions.pod:633 ../src/guestfs-actions.pod:649
4006 #: ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:673
4007 #: ../src/guestfs-actions.pod:824 ../src/guestfs-actions.pod:842
4008 #: ../src/guestfs-actions.pod:858 ../src/guestfs-actions.pod:936
4009 #: ../src/guestfs-actions.pod:952 ../src/guestfs-actions.pod:969
4010 #: ../src/guestfs-actions.pod:981 ../src/guestfs-actions.pod:999
4011 #: ../src/guestfs-actions.pod:1034 ../src/guestfs-actions.pod:1096
4012 #: ../src/guestfs-actions.pod:1125 ../src/guestfs-actions.pod:1148
4013 #: ../src/guestfs-actions.pod:1181 ../src/guestfs-actions.pod:1275
4014 #: ../src/guestfs-actions.pod:1307 ../src/guestfs-actions.pod:1513
4015 #: ../src/guestfs-actions.pod:1533 ../src/guestfs-actions.pod:1616
4016 #: ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2119
4017 #: ../src/guestfs-actions.pod:2176 ../src/guestfs-actions.pod:2208
4018 #: ../src/guestfs-actions.pod:2680 ../src/guestfs-actions.pod:2693
4019 #: ../src/guestfs-actions.pod:2711 ../src/guestfs-actions.pod:2825
4020 #: ../src/guestfs-actions.pod:2837 ../src/guestfs-actions.pod:2848
4021 #: ../src/guestfs-actions.pod:2860 ../src/guestfs-actions.pod:2873
4022 #: ../src/guestfs-actions.pod:2905 ../src/guestfs-actions.pod:2972
4023 #: ../src/guestfs-actions.pod:2990 ../src/guestfs-actions.pod:3005
4024 #: ../src/guestfs-actions.pod:3026 ../src/guestfs-actions.pod:3047
4025 #: ../src/guestfs-actions.pod:3077 ../src/guestfs-actions.pod:3094
4026 #: ../src/guestfs-actions.pod:3111 ../src/guestfs-actions.pod:3142
4027 #: ../src/guestfs-actions.pod:3152 ../src/guestfs-actions.pod:3186
4028 #: ../src/guestfs-actions.pod:3200 ../src/guestfs-actions.pod:3211
4029 #: ../src/guestfs-actions.pod:3224 ../src/guestfs-actions.pod:3239
4030 #: ../src/guestfs-actions.pod:3324 ../src/guestfs-actions.pod:3342
4031 #: ../src/guestfs-actions.pod:3353 ../src/guestfs-actions.pod:3400
4032 #: ../src/guestfs-actions.pod:3416 ../src/guestfs-actions.pod:3432
4033 #: ../src/guestfs-actions.pod:3446 ../src/guestfs-actions.pod:3458
4034 #: ../src/guestfs-actions.pod:3470 ../src/guestfs-actions.pod:3485
4035 #: ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3516
4036 #: ../src/guestfs-actions.pod:3563 ../src/guestfs-actions.pod:3592
4037 #: ../src/guestfs-actions.pod:3609 ../src/guestfs-actions.pod:3626
4038 #: ../src/guestfs-actions.pod:3636 ../src/guestfs-actions.pod:3651
4039 #: ../src/guestfs-actions.pod:3662 ../src/guestfs-actions.pod:3675
4040 #: ../src/guestfs-actions.pod:3688 ../src/guestfs-actions.pod:3721
4041 #: ../src/guestfs-actions.pod:3734 ../src/guestfs-actions.pod:3752
4042 #: ../src/guestfs-actions.pod:3764 ../src/guestfs-actions.pod:3779
4043 #: ../src/guestfs-actions.pod:3822 ../src/guestfs-actions.pod:3855
4044 #: ../src/guestfs-actions.pod:3867 ../src/guestfs-actions.pod:3893
4045 #: ../src/guestfs-actions.pod:3908 ../src/guestfs-actions.pod:3924
4046 #: ../src/guestfs-actions.pod:4050 ../src/guestfs-actions.pod:4104
4047 #: ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4140
4048 #: ../src/guestfs-actions.pod:4168 ../src/guestfs-actions.pod:4228
4049 #: ../src/guestfs-actions.pod:4243 ../src/guestfs-actions.pod:4254
4050 #: ../src/guestfs-actions.pod:4266 ../src/guestfs-actions.pod:4533
4051 #: ../src/guestfs-actions.pod:4550 ../src/guestfs-actions.pod:4562
4052 #: ../src/guestfs-actions.pod:4572 ../src/guestfs-actions.pod:4584
4053 #: ../src/guestfs-actions.pod:4594 ../src/guestfs-actions.pod:4606
4054 #: ../src/guestfs-actions.pod:4620 ../src/guestfs-actions.pod:4639
4055 #: ../src/guestfs-actions.pod:4656 ../src/guestfs-actions.pod:4673
4056 #: ../src/guestfs-actions.pod:4689 ../src/guestfs-actions.pod:4710
4057 #: ../src/guestfs-actions.pod:4726 ../src/guestfs-actions.pod:4743
4058 #: ../src/guestfs-actions.pod:4762 ../src/guestfs-actions.pod:4779
4059 #: ../src/guestfs-actions.pod:4794 ../src/guestfs-actions.pod:4820
4060 #: ../src/guestfs-actions.pod:4842 ../src/guestfs-actions.pod:4859
4061 #: ../src/guestfs-actions.pod:4881 ../src/guestfs-actions.pod:4894
4062 #: ../src/guestfs-actions.pod:4907 ../src/guestfs-actions.pod:4924
4063 #: ../src/guestfs-actions.pod:4959 ../src/guestfs-actions.pod:4980
4064 #: ../src/guestfs-actions.pod:5004 ../src/guestfs-actions.pod:5100
4065 #: ../src/guestfs-actions.pod:5211 ../src/guestfs-actions.pod:5221
4066 #: ../src/guestfs-actions.pod:5232 ../src/guestfs-actions.pod:5243
4067 #: ../src/guestfs-actions.pod:5263 ../src/guestfs-actions.pod:5274
4068 #: ../src/guestfs-actions.pod:5285 ../src/guestfs-actions.pod:5296
4069 #: ../src/guestfs-actions.pod:5309 ../src/guestfs-actions.pod:5362
4070 #: ../src/guestfs-actions.pod:5377 ../src/guestfs-actions.pod:5391
4071 #: ../src/guestfs-actions.pod:5405 ../src/guestfs-actions.pod:5420
4072 #: ../src/guestfs-actions.pod:5431 ../src/guestfs-actions.pod:5449
4073 #: ../src/guestfs-actions.pod:5481 ../src/guestfs-actions.pod:5493
4074 #: ../src/guestfs-actions.pod:5530 ../src/guestfs-actions.pod:5541
4075 #: ../src/guestfs-actions.pod:5557 ../src/guestfs-actions.pod:5584
4076 #: ../src/guestfs-actions.pod:5613 ../src/guestfs-actions.pod:5722
4077 #: ../src/guestfs-actions.pod:5738 ../src/guestfs-actions.pod:5750
4078 #: ../src/guestfs-actions.pod:5799 ../src/guestfs-actions.pod:5810
4079 #: ../src/guestfs-actions.pod:5850 ../src/guestfs-actions.pod:5879
4080 #: ../src/guestfs-actions.pod:5925 ../src/guestfs-actions.pod:5949
4081 #: ../src/guestfs-actions.pod:6009 ../src/guestfs-actions.pod:6026
4082 #: ../src/guestfs-actions.pod:6053
4083 msgid "This function returns 0 on success or -1 on error."
4087 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:164
4088 #: ../src/guestfs-actions.pod:183 ../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:167
4097 #: ../src/guestfs-actions.pod:186 ../src/guestfs-actions.pod:1280
4098 #: ../src/guestfs-actions.pod:1732 ../src/guestfs-actions.pod:1751
4099 #: ../src/guestfs-actions.pod:5957 ../src/guestfs-actions.pod:6110
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
4112 msgid "guestfs_add_drive"
4116 #: ../src/guestfs-actions.pod:41
4120 " guestfs_add_drive (guestfs_h *g,\n"
4121 " const char *filename);\n"
4126 #: ../src/guestfs-actions.pod:45
4128 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
4129 "optional parameters, so the disk is added writable, with the format being "
4130 "detected automatically."
4134 #: ../src/guestfs-actions.pod:49
4136 "Automatic detection of the format opens you up to a potential security hole "
4137 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4138 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4139 "you should think about replacing calls to this function with calls to "
4140 "C<guestfs_add_drive_opts>, and specifying the format."
4144 #: ../src/guestfs-actions.pod:58
4145 msgid "guestfs_add_drive_opts"
4149 #: ../src/guestfs-actions.pod:60
4153 " guestfs_add_drive_opts (guestfs_h *g,\n"
4154 " const char *filename,\n"
4160 #: ../src/guestfs-actions.pod:65
4162 "You may supply a list of optional arguments to this call. Use zero or more "
4163 "of the following pairs of parameters, and terminate the list with C<-1> on "
4164 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
4168 #: ../src/guestfs-actions.pod:70
4171 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
4172 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
4173 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
4178 #: ../src/guestfs-actions.pod:74 ../fish/guestfish-actions.pod:56
4180 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4181 "The first time you call this function, the disk appears as C</dev/sda>, the "
4182 "second time as C</dev/sdb>, and so on."
4186 #: ../src/guestfs-actions.pod:79 ../fish/guestfish-actions.pod:61
4188 "You don't necessarily need to be root when using libguestfs. However you "
4189 "obviously do need sufficient permissions to access the filename for whatever "
4190 "operations you want to perform (ie. read access if you just want to read the "
4191 "image or write access if you want to modify the image)."
4195 #: ../src/guestfs-actions.pod:85 ../fish/guestfish-actions.pod:67
4196 msgid "This call checks that C<filename> exists."
4200 #: ../src/guestfs-actions.pod:87 ../fish/guestfish-actions.pod:69
4201 msgid "The optional arguments are:"
4205 #: ../src/guestfs-actions.pod:91 ../fish/guestfish-actions.pod:73
4210 #: ../src/guestfs-actions.pod:93 ../fish/guestfish-actions.pod:75
4212 "If true then the image is treated as read-only. Writes are still allowed, "
4213 "but they are stored in a temporary snapshot overlay which is discarded at "
4214 "the end. The disk that you add is not modified."
4218 #: ../src/guestfs-actions.pod:97 ../fish/guestfish-actions.pod:79
4223 #: ../src/guestfs-actions.pod:99
4225 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4226 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4227 "Possible formats include C<raw> and C<qcow2>."
4231 #: ../src/guestfs-actions.pod:103 ../fish/guestfish-actions.pod:85
4233 "Automatic detection of the format opens you up to a potential security hole "
4234 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4235 "RHBZ#642934. Specifying the format closes this security hole."
4239 #: ../src/guestfs-actions.pod:108 ../fish/guestfish-actions.pod:90
4244 #: ../src/guestfs-actions.pod:110
4246 "This rarely-used option lets you emulate the behaviour of the deprecated "
4247 "C<guestfs_add_drive_with_if> call (q.v.)"
4251 #: ../src/guestfs-actions.pod:117
4252 msgid "guestfs_add_drive_opts_va"
4256 #: ../src/guestfs-actions.pod:119
4260 "guestfs_add_drive_opts_va (guestfs_h *g,\n"
4261 " const char *filename,\n"
4267 #: ../src/guestfs-actions.pod:124
4268 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4272 #: ../src/guestfs-actions.pod:126 ../src/guestfs-actions.pod:137
4273 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4277 #: ../src/guestfs-actions.pod:128
4278 msgid "guestfs_add_drive_opts_argv"
4282 #: ../src/guestfs-actions.pod:130
4286 "guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4287 " const char *filename,\n"
4288 " const struct guestfs_add_drive_opts_argv *optargs);\n"
4293 #: ../src/guestfs-actions.pod:135
4294 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4298 #: ../src/guestfs-actions.pod:139
4299 msgid "guestfs_add_drive_ro"
4303 #: ../src/guestfs-actions.pod:141
4307 " guestfs_add_drive_ro (guestfs_h *g,\n"
4308 " const char *filename);\n"
4313 #: ../src/guestfs-actions.pod:145
4315 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4316 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4317 "disk is added read-only, with the format being detected automatically."
4321 #: ../src/guestfs-actions.pod:152
4322 msgid "guestfs_add_drive_ro_with_if"
4326 #: ../src/guestfs-actions.pod:154
4330 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4331 " const char *filename,\n"
4332 " const char *iface);\n"
4337 #: ../src/guestfs-actions.pod:159
4339 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4340 "QEMU interface emulation to use at run time."
4344 #: ../src/guestfs-actions.pod:171
4345 msgid "guestfs_add_drive_with_if"
4349 #: ../src/guestfs-actions.pod:173
4353 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4354 " const char *filename,\n"
4355 " const char *iface);\n"
4360 #: ../src/guestfs-actions.pod:178
4362 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4363 "QEMU interface emulation to use at run time."
4367 #: ../src/guestfs-actions.pod:190
4368 msgid "guestfs_aug_clear"
4372 #: ../src/guestfs-actions.pod:192
4376 " guestfs_aug_clear (guestfs_h *g,\n"
4377 " const char *augpath);\n"
4382 #: ../src/guestfs-actions.pod:196 ../fish/guestfish-actions.pod:142
4384 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4385 "L<augtool(1)> C<clear> command."
4389 #: ../src/guestfs-actions.pod:201
4390 msgid "guestfs_aug_close"
4394 #: ../src/guestfs-actions.pod:203
4398 " guestfs_aug_close (guestfs_h *g);\n"
4403 #: ../src/guestfs-actions.pod:206
4405 "Close the current Augeas handle and free up any resources used by it. After "
4406 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4407 "any other Augeas functions."
4411 #: ../src/guestfs-actions.pod:213
4412 msgid "guestfs_aug_defnode"
4416 #: ../src/guestfs-actions.pod:215
4419 " struct guestfs_int_bool *\n"
4420 " guestfs_aug_defnode (guestfs_h *g,\n"
4421 " const char *name,\n"
4422 " const char *expr,\n"
4423 " const char *val);\n"
4428 #: ../src/guestfs-actions.pod:221 ../fish/guestfish-actions.pod:158
4430 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4434 #: ../src/guestfs-actions.pod:224
4436 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4437 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4438 "containing that single node."
4442 #: ../src/guestfs-actions.pod:228 ../fish/guestfish-actions.pod:165
4444 "On success this returns a pair containing the number of nodes in the "
4445 "nodeset, and a boolean flag if a node was created."
4449 #: ../src/guestfs-actions.pod:232
4451 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4452 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4456 #: ../src/guestfs-actions.pod:236
4457 msgid "guestfs_aug_defvar"
4461 #: ../src/guestfs-actions.pod:238
4465 " guestfs_aug_defvar (guestfs_h *g,\n"
4466 " const char *name,\n"
4467 " const char *expr);\n"
4472 #: ../src/guestfs-actions.pod:243 ../fish/guestfish-actions.pod:173
4474 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4475 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4479 #: ../src/guestfs-actions.pod:247 ../fish/guestfish-actions.pod:177
4481 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4482 "evaluates to something which is not a nodeset."
4486 #: ../src/guestfs-actions.pod:250 ../src/guestfs-actions.pod:399
4487 #: ../src/guestfs-actions.pod:561 ../src/guestfs-actions.pod:588
4488 #: ../src/guestfs-actions.pod:604 ../src/guestfs-actions.pod:621
4489 #: ../src/guestfs-actions.pod:1166 ../src/guestfs-actions.pod:1494
4490 #: ../src/guestfs-actions.pod:1683 ../src/guestfs-actions.pod:1770
4491 #: ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:1851
4492 #: ../src/guestfs-actions.pod:1870 ../src/guestfs-actions.pod:2108
4493 #: ../src/guestfs-actions.pod:2349 ../src/guestfs-actions.pod:2368
4494 #: ../src/guestfs-actions.pod:3843 ../src/guestfs-actions.pod:3957
4495 #: ../src/guestfs-actions.pod:4329 ../src/guestfs-actions.pod:4353
4496 #: ../src/guestfs-actions.pod:5518 ../src/guestfs-actions.pod:5890
4497 #: ../src/guestfs-actions.pod:5901 ../src/guestfs-actions.pod:5912
4498 msgid "On error this function returns -1."
4502 #: ../src/guestfs-actions.pod:252
4503 msgid "guestfs_aug_get"
4507 #: ../src/guestfs-actions.pod:254
4511 " guestfs_aug_get (guestfs_h *g,\n"
4512 " const char *augpath);\n"
4517 #: ../src/guestfs-actions.pod:258 ../fish/guestfish-actions.pod:184
4519 "Look up the value associated with C<path>. If C<path> matches exactly one "
4520 "node, the C<value> is returned."
4524 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:713
4525 #: ../src/guestfs-actions.pod:729 ../src/guestfs-actions.pod:787
4526 #: ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:896
4527 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1047
4528 #: ../src/guestfs-actions.pod:1062 ../src/guestfs-actions.pod:1079
4529 #: ../src/guestfs-actions.pod:1196 ../src/guestfs-actions.pod:1369
4530 #: ../src/guestfs-actions.pod:1479 ../src/guestfs-actions.pod:1630
4531 #: ../src/guestfs-actions.pod:1645 ../src/guestfs-actions.pod:1726
4532 #: ../src/guestfs-actions.pod:1745 ../src/guestfs-actions.pod:1891
4533 #: ../src/guestfs-actions.pod:2038 ../src/guestfs-actions.pod:2228
4534 #: ../src/guestfs-actions.pod:2299 ../src/guestfs-actions.pod:2420
4535 #: ../src/guestfs-actions.pod:2456 ../src/guestfs-actions.pod:2477
4536 #: ../src/guestfs-actions.pod:2813 ../src/guestfs-actions.pod:3128
4537 #: ../src/guestfs-actions.pod:3279 ../src/guestfs-actions.pod:3380
4538 #: ../src/guestfs-actions.pod:3973 ../src/guestfs-actions.pod:4155
4539 #: ../src/guestfs-actions.pod:4306 ../src/guestfs-actions.pod:4473
4540 #: ../src/guestfs-actions.pod:4518 ../src/guestfs-actions.pod:5023
4541 #: ../src/guestfs-actions.pod:5037 ../src/guestfs-actions.pod:5052
4542 #: ../src/guestfs-actions.pod:5074 ../src/guestfs-actions.pod:5668
4543 #: ../src/guestfs-actions.pod:5685 ../src/guestfs-actions.pod:5701
4544 #: ../src/guestfs-actions.pod:5860 ../src/guestfs-actions.pod:6104
4546 "This function returns a string, or NULL on error. I<The caller must free "
4547 "the returned string after use>."
4551 #: ../src/guestfs-actions.pod:264
4552 msgid "guestfs_aug_init"
4556 #: ../src/guestfs-actions.pod:266
4560 " guestfs_aug_init (guestfs_h *g,\n"
4561 " const char *root,\n"
4567 #: ../src/guestfs-actions.pod:271 ../fish/guestfish-actions.pod:191
4569 "Create a new Augeas handle for editing configuration files. If there was "
4570 "any previous Augeas handle associated with this guestfs session, then it is "
4575 #: ../src/guestfs-actions.pod:275
4576 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4580 #: ../src/guestfs-actions.pod:278 ../fish/guestfish-actions.pod:198
4582 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4586 #: ../src/guestfs-actions.pod:281 ../fish/guestfish-actions.pod:201
4588 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4589 "logical I<or> of the following integers:"
4593 #: ../src/guestfs-actions.pod:287 ../fish/guestfish-actions.pod:207
4594 msgid "C<AUG_SAVE_BACKUP> = 1"
4598 #: ../src/guestfs-actions.pod:289 ../fish/guestfish-actions.pod:209
4599 msgid "Keep the original file with a C<.augsave> extension."
4603 #: ../src/guestfs-actions.pod:291 ../fish/guestfish-actions.pod:211
4604 msgid "C<AUG_SAVE_NEWFILE> = 2"
4608 #: ../src/guestfs-actions.pod:293 ../fish/guestfish-actions.pod:213
4610 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4611 "original. Overrides C<AUG_SAVE_BACKUP>."
4615 #: ../src/guestfs-actions.pod:296 ../fish/guestfish-actions.pod:216
4616 msgid "C<AUG_TYPE_CHECK> = 4"
4620 #: ../src/guestfs-actions.pod:298 ../fish/guestfish-actions.pod:218
4621 msgid "Typecheck lenses (can be expensive)."
4625 #: ../src/guestfs-actions.pod:300 ../fish/guestfish-actions.pod:220
4626 msgid "C<AUG_NO_STDINC> = 8"
4630 #: ../src/guestfs-actions.pod:302 ../fish/guestfish-actions.pod:222
4631 msgid "Do not use standard load path for modules."
4635 #: ../src/guestfs-actions.pod:304 ../fish/guestfish-actions.pod:224
4636 msgid "C<AUG_SAVE_NOOP> = 16"
4640 #: ../src/guestfs-actions.pod:306 ../fish/guestfish-actions.pod:226
4641 msgid "Make save a no-op, just record what would have been changed."
4645 #: ../src/guestfs-actions.pod:308 ../fish/guestfish-actions.pod:228
4646 msgid "C<AUG_NO_LOAD> = 32"
4650 #: ../src/guestfs-actions.pod:310
4651 msgid "Do not load the tree in C<guestfs_aug_init>."
4655 #: ../src/guestfs-actions.pod:314
4656 msgid "To close the handle, you can call C<guestfs_aug_close>."
4660 #: ../src/guestfs-actions.pod:316 ../fish/guestfish-actions.pod:236
4661 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4665 #: ../src/guestfs-actions.pod:320
4666 msgid "guestfs_aug_insert"
4670 #: ../src/guestfs-actions.pod:322
4674 " guestfs_aug_insert (guestfs_h *g,\n"
4675 " const char *augpath,\n"
4676 " const char *label,\n"
4682 #: ../src/guestfs-actions.pod:328 ../fish/guestfish-actions.pod:242
4684 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4685 "or after C<path> (depending on the boolean flag C<before>)."
4689 #: ../src/guestfs-actions.pod:332 ../fish/guestfish-actions.pod:246
4691 "C<path> must match exactly one existing node in the tree, and C<label> must "
4692 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4696 #: ../src/guestfs-actions.pod:338
4697 msgid "guestfs_aug_load"
4701 #: ../src/guestfs-actions.pod:340
4705 " guestfs_aug_load (guestfs_h *g);\n"
4710 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:254
4711 msgid "Load files into the tree."
4715 #: ../src/guestfs-actions.pod:345 ../fish/guestfish-actions.pod:256
4716 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4720 #: ../src/guestfs-actions.pod:350
4721 msgid "guestfs_aug_ls"
4725 #: ../src/guestfs-actions.pod:352
4729 " guestfs_aug_ls (guestfs_h *g,\n"
4730 " const char *augpath);\n"
4735 #: ../src/guestfs-actions.pod:356
4737 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
4738 "sorting the resulting nodes into alphabetical order."
4742 #: ../src/guestfs-actions.pod:359 ../src/guestfs-actions.pod:373
4743 #: ../src/guestfs-actions.pod:507 ../src/guestfs-actions.pod:913
4744 #: ../src/guestfs-actions.pod:1209 ../src/guestfs-actions.pod:1226
4745 #: ../src/guestfs-actions.pod:1319 ../src/guestfs-actions.pod:1336
4746 #: ../src/guestfs-actions.pod:1573 ../src/guestfs-actions.pod:1930
4747 #: ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:1961
4748 #: ../src/guestfs-actions.pod:2000 ../src/guestfs-actions.pod:2022
4749 #: ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2130
4750 #: ../src/guestfs-actions.pod:2322 ../src/guestfs-actions.pod:2517
4751 #: ../src/guestfs-actions.pod:2739 ../src/guestfs-actions.pod:2797
4752 #: ../src/guestfs-actions.pod:2888 ../src/guestfs-actions.pod:3254
4753 #: ../src/guestfs-actions.pod:3808 ../src/guestfs-actions.pod:4281
4754 #: ../src/guestfs-actions.pod:4396 ../src/guestfs-actions.pod:4505
4755 #: ../src/guestfs-actions.pod:5088 ../src/guestfs-actions.pod:5141
4756 #: ../src/guestfs-actions.pod:5194 ../src/guestfs-actions.pod:5320
4757 #: ../src/guestfs-actions.pod:5342 ../src/guestfs-actions.pod:5766
4758 #: ../src/guestfs-actions.pod:5784 ../src/guestfs-actions.pod:5825
4759 #: ../src/guestfs-actions.pod:5971 ../src/guestfs-actions.pod:5988
4760 #: ../src/guestfs-actions.pod:6065 ../src/guestfs-actions.pod:6082
4761 #: ../src/guestfs-actions.pod:6124 ../src/guestfs-actions.pod:6141
4763 "This function returns a NULL-terminated array of strings (like L<environ(3)"
4764 ">), or NULL if there was an error. I<The caller must free the strings and "
4765 "the array after use>."
4769 #: ../src/guestfs-actions.pod:363
4770 msgid "guestfs_aug_match"
4774 #: ../src/guestfs-actions.pod:365
4778 " guestfs_aug_match (guestfs_h *g,\n"
4779 " const char *augpath);\n"
4784 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:270
4786 "Returns a list of paths which match the path expression C<path>. The "
4787 "returned paths are sufficiently qualified so that they match exactly one "
4788 "node in the current tree."
4792 #: ../src/guestfs-actions.pod:377
4793 msgid "guestfs_aug_mv"
4797 #: ../src/guestfs-actions.pod:379
4801 " guestfs_aug_mv (guestfs_h *g,\n"
4802 " const char *src,\n"
4803 " const char *dest);\n"
4808 #: ../src/guestfs-actions.pod:384 ../fish/guestfish-actions.pod:278
4810 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4811 "C<dest> is overwritten if it exists."
4815 #: ../src/guestfs-actions.pod:389
4816 msgid "guestfs_aug_rm"
4820 #: ../src/guestfs-actions.pod:391
4824 " guestfs_aug_rm (guestfs_h *g,\n"
4825 " const char *augpath);\n"
4830 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:285
4831 msgid "Remove C<path> and all of its children."
4835 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:287
4836 msgid "On success this returns the number of entries which were removed."
4840 #: ../src/guestfs-actions.pod:401
4841 msgid "guestfs_aug_save"
4845 #: ../src/guestfs-actions.pod:403
4849 " guestfs_aug_save (guestfs_h *g);\n"
4854 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:293
4855 msgid "This writes all pending changes to disk."
4859 #: ../src/guestfs-actions.pod:408
4861 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
4866 #: ../src/guestfs-actions.pod:413
4867 msgid "guestfs_aug_set"
4871 #: ../src/guestfs-actions.pod:415
4875 " guestfs_aug_set (guestfs_h *g,\n"
4876 " const char *augpath,\n"
4877 " const char *val);\n"
4882 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:302
4883 msgid "Set the value associated with C<path> to C<val>."
4887 #: ../src/guestfs-actions.pod:422
4889 "In the Augeas API, it is possible to clear a node by setting the value to "
4890 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
4891 "this call. Instead you must use the C<guestfs_aug_clear> call."
4895 #: ../src/guestfs-actions.pod:429
4896 msgid "guestfs_available"
4900 #: ../src/guestfs-actions.pod:431
4904 " guestfs_available (guestfs_h *g,\n"
4905 " char *const *groups);\n"
4910 #: ../src/guestfs-actions.pod:435 ../fish/guestfish-actions.pod:313
4912 "This command is used to check the availability of some groups of "
4913 "functionality in the appliance, which not all builds of the libguestfs "
4914 "appliance will be able to provide."
4918 #: ../src/guestfs-actions.pod:439
4920 "The libguestfs groups, and the functions that those groups correspond to, "
4921 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
4922 "runtime by calling C<guestfs_available_all_groups>."
4926 #: ../src/guestfs-actions.pod:444 ../fish/guestfish-actions.pod:322
4928 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
4929 "\"]> would check for the availability of the Linux inotify functions and "
4930 "Augeas (configuration file editing) functions."
4934 #: ../src/guestfs-actions.pod:449 ../fish/guestfish-actions.pod:327
4935 msgid "The command returns no error if I<all> requested groups are available."
4939 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:329
4941 "It fails with an error if one or more of the requested groups is unavailable "
4946 #: ../src/guestfs-actions.pod:454 ../fish/guestfish-actions.pod:332
4948 "If an unknown group name is included in the list of groups then an error is "
4953 #: ../src/guestfs-actions.pod:457 ../fish/guestfish-actions.pod:335
4958 #: ../src/guestfs-actions.pod:463
4959 msgid "You must call C<guestfs_launch> before calling this function."
4963 #: ../src/guestfs-actions.pod:465 ../fish/guestfish-actions.pod:343
4965 "The reason is because we don't know what groups are supported by the "
4966 "appliance/daemon until it is running and can be queried."
4970 #: ../src/guestfs-actions.pod:471 ../fish/guestfish-actions.pod:349
4972 "If a group of functions is available, this does not necessarily mean that "
4973 "they will work. You still have to check for errors when calling individual "
4974 "API functions even if they are available."
4978 #: ../src/guestfs-actions.pod:478 ../fish/guestfish-actions.pod:356
4980 "It is usually the job of distro packagers to build complete functionality "
4981 "into the libguestfs appliance. Upstream libguestfs, if built from source "
4982 "with all requirements satisfied, will support everything."
4986 #: ../src/guestfs-actions.pod:485
4988 "This call was added in version C<1.0.80>. In previous versions of "
4989 "libguestfs all you could do would be to speculatively execute a command to "
4990 "find out if the daemon implemented it. See also C<guestfs_version>."
4994 #: ../src/guestfs-actions.pod:494
4995 msgid "guestfs_available_all_groups"
4999 #: ../src/guestfs-actions.pod:496
5003 " guestfs_available_all_groups (guestfs_h *g);\n"
5008 #: ../src/guestfs-actions.pod:499
5010 "This command returns a list of all optional groups that this daemon knows "
5011 "about. Note this returns both supported and unsupported groups. To find "
5012 "out which ones the daemon can actually support you have to call "
5013 "C<guestfs_available> on each member of the returned list."
5017 #: ../src/guestfs-actions.pod:505
5018 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
5022 #: ../src/guestfs-actions.pod:511
5023 msgid "guestfs_base64_in"
5027 #: ../src/guestfs-actions.pod:513
5031 " guestfs_base64_in (guestfs_h *g,\n"
5032 " const char *base64file,\n"
5033 " const char *filename);\n"
5038 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:386
5040 "This command uploads base64-encoded data from C<base64file> to C<filename>."
5044 #: ../src/guestfs-actions.pod:523
5045 msgid "guestfs_base64_out"
5049 #: ../src/guestfs-actions.pod:525
5053 " guestfs_base64_out (guestfs_h *g,\n"
5054 " const char *filename,\n"
5055 " const char *base64file);\n"
5060 #: ../src/guestfs-actions.pod:530 ../fish/guestfish-actions.pod:395
5062 "This command downloads the contents of C<filename>, writing it out to local "
5063 "file C<base64file> encoded as base64."
5067 #: ../src/guestfs-actions.pod:535
5068 msgid "guestfs_blockdev_flushbufs"
5072 #: ../src/guestfs-actions.pod:537
5076 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
5077 " const char *device);\n"
5082 #: ../src/guestfs-actions.pod:541 ../fish/guestfish-actions.pod:404
5084 "This tells the kernel to flush internal buffers associated with C<device>."
5088 #: ../src/guestfs-actions.pod:544 ../src/guestfs-actions.pod:559
5089 #: ../src/guestfs-actions.pod:572 ../src/guestfs-actions.pod:586
5090 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:619
5091 #: ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:647
5092 #: ../src/guestfs-actions.pod:659 ../src/guestfs-actions.pod:671
5093 #: ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:418
5094 #: ../fish/guestfish-actions.pod:427 ../fish/guestfish-actions.pod:437
5095 #: ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:462
5096 #: ../fish/guestfish-actions.pod:470 ../fish/guestfish-actions.pod:481
5097 #: ../fish/guestfish-actions.pod:489 ../fish/guestfish-actions.pod:497
5098 msgid "This uses the L<blockdev(8)> command."
5102 #: ../src/guestfs-actions.pod:548
5103 msgid "guestfs_blockdev_getbsz"
5107 #: ../src/guestfs-actions.pod:550
5111 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
5112 " const char *device);\n"
5117 #: ../src/guestfs-actions.pod:554 ../fish/guestfish-actions.pod:413
5118 msgid "This returns the block size of a device."
5122 #: ../src/guestfs-actions.pod:556 ../src/guestfs-actions.pod:644
5123 #: ../fish/guestfish-actions.pod:415 ../fish/guestfish-actions.pod:478
5125 "(Note this is different from both I<size in blocks> and I<filesystem block "
5130 #: ../src/guestfs-actions.pod:563
5131 msgid "guestfs_blockdev_getro"
5135 #: ../src/guestfs-actions.pod:565
5139 " guestfs_blockdev_getro (guestfs_h *g,\n"
5140 " const char *device);\n"
5145 #: ../src/guestfs-actions.pod:569 ../fish/guestfish-actions.pod:424
5147 "Returns a boolean indicating if the block device is read-only (true if read-"
5148 "only, false if not)."
5152 #: ../src/guestfs-actions.pod:574 ../src/guestfs-actions.pod:1245
5153 #: ../src/guestfs-actions.pod:1258 ../src/guestfs-actions.pod:1706
5154 #: ../src/guestfs-actions.pod:1715 ../src/guestfs-actions.pod:1779
5155 #: ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:1839
5156 #: ../src/guestfs-actions.pod:1860 ../src/guestfs-actions.pod:1879
5157 #: ../src/guestfs-actions.pod:2532 ../src/guestfs-actions.pod:2544
5158 #: ../src/guestfs-actions.pod:2557 ../src/guestfs-actions.pod:2569
5159 #: ../src/guestfs-actions.pod:2583 ../src/guestfs-actions.pod:2596
5160 #: ../src/guestfs-actions.pod:2610 ../src/guestfs-actions.pod:2622
5161 #: ../src/guestfs-actions.pod:2633 ../src/guestfs-actions.pod:2645
5162 #: ../src/guestfs-actions.pod:2658 ../src/guestfs-actions.pod:2671
5163 #: ../src/guestfs-actions.pod:3941
5164 msgid "This function returns a C truth value on success or -1 on error."
5168 #: ../src/guestfs-actions.pod:576
5169 msgid "guestfs_blockdev_getsize64"
5173 #: ../src/guestfs-actions.pod:578
5177 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
5178 " const char *device);\n"
5183 #: ../src/guestfs-actions.pod:582 ../fish/guestfish-actions.pod:433
5184 msgid "This returns the size of the device in bytes."
5188 #: ../src/guestfs-actions.pod:584
5189 msgid "See also C<guestfs_blockdev_getsz>."
5193 #: ../src/guestfs-actions.pod:590
5194 msgid "guestfs_blockdev_getss"
5198 #: ../src/guestfs-actions.pod:592
5202 " guestfs_blockdev_getss (guestfs_h *g,\n"
5203 " const char *device);\n"
5208 #: ../src/guestfs-actions.pod:596 ../fish/guestfish-actions.pod:443
5210 "This returns the size of sectors on a block device. Usually 512, but can be "
5211 "larger for modern devices."
5215 #: ../src/guestfs-actions.pod:599
5217 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
5222 #: ../src/guestfs-actions.pod:606
5223 msgid "guestfs_blockdev_getsz"
5227 #: ../src/guestfs-actions.pod:608
5231 " guestfs_blockdev_getsz (guestfs_h *g,\n"
5232 " const char *device);\n"
5237 #: ../src/guestfs-actions.pod:612 ../fish/guestfish-actions.pod:455
5239 "This returns the size of the device in units of 512-byte sectors (even if "
5240 "the sectorsize isn't 512 bytes ... weird)."
5244 #: ../src/guestfs-actions.pod:615
5246 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
5247 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
5251 #: ../src/guestfs-actions.pod:623
5252 msgid "guestfs_blockdev_rereadpt"
5256 #: ../src/guestfs-actions.pod:625
5260 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5261 " const char *device);\n"
5266 #: ../src/guestfs-actions.pod:629 ../fish/guestfish-actions.pod:468
5267 msgid "Reread the partition table on C<device>."
5271 #: ../src/guestfs-actions.pod:635
5272 msgid "guestfs_blockdev_setbsz"
5276 #: ../src/guestfs-actions.pod:637
5280 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5281 " const char *device,\n"
5282 " int blocksize);\n"
5287 #: ../src/guestfs-actions.pod:642 ../fish/guestfish-actions.pod:476
5288 msgid "This sets the block size of a device."
5292 #: ../src/guestfs-actions.pod:651
5293 msgid "guestfs_blockdev_setro"
5297 #: ../src/guestfs-actions.pod:653
5301 " guestfs_blockdev_setro (guestfs_h *g,\n"
5302 " const char *device);\n"
5307 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:487
5308 msgid "Sets the block device named C<device> to read-only."
5312 #: ../src/guestfs-actions.pod:663
5313 msgid "guestfs_blockdev_setrw"
5317 #: ../src/guestfs-actions.pod:665
5321 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5322 " const char *device);\n"
5327 #: ../src/guestfs-actions.pod:669 ../fish/guestfish-actions.pod:495
5328 msgid "Sets the block device named C<device> to read-write."
5332 #: ../src/guestfs-actions.pod:675
5333 msgid "guestfs_case_sensitive_path"
5337 #: ../src/guestfs-actions.pod:677
5341 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5342 " const char *path);\n"
5347 #: ../src/guestfs-actions.pod:681 ../fish/guestfish-actions.pod:503
5349 "This can be used to resolve case insensitive paths on a filesystem which is "
5350 "case sensitive. The use case is to resolve paths which you have read from "
5351 "Windows configuration files or the Windows Registry, to the true path."
5355 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:508
5357 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5358 "(and probably others), which is that although the underlying filesystem is "
5359 "case-insensitive, the driver exports the filesystem to Linux as case-"
5364 #: ../src/guestfs-actions.pod:691 ../fish/guestfish-actions.pod:513
5366 "One consequence of this is that special directories such as C<c:\\windows> "
5367 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5368 "precise details of how they were created. In Windows itself this would not "
5373 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:519
5375 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
5380 #: ../src/guestfs-actions.pod:700 ../fish/guestfish-actions.pod:522
5382 "This function resolves the true case of each element in the path and returns "
5383 "the case-sensitive path."
5387 #: ../src/guestfs-actions.pod:703
5389 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
5390 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5391 "how the directories were originally created under Windows)."
5395 #: ../src/guestfs-actions.pod:708 ../fish/guestfish-actions.pod:530
5396 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5400 #: ../src/guestfs-actions.pod:711
5401 msgid "See also C<guestfs_realpath>."
5405 #: ../src/guestfs-actions.pod:716
5410 #: ../src/guestfs-actions.pod:718
5414 " guestfs_cat (guestfs_h *g,\n"
5415 " const char *path);\n"
5420 #: ../src/guestfs-actions.pod:722 ../src/guestfs-actions.pod:4386
5421 #: ../fish/guestfish-actions.pod:539 ../fish/guestfish-actions.pod:3197
5422 msgid "Return the contents of the file named C<path>."
5426 #: ../src/guestfs-actions.pod:724
5428 "Note that this function cannot correctly handle binary files (specifically, "
5429 "files containing C<\\0> character which is treated as end of string). For "
5430 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5431 "functions which have a more complex interface."
5435 #: ../src/guestfs-actions.pod:732 ../src/guestfs-actions.pod:899
5436 #: ../src/guestfs-actions.pod:917 ../src/guestfs-actions.pod:1213
5437 #: ../src/guestfs-actions.pod:1230 ../src/guestfs-actions.pod:1323
5438 #: ../src/guestfs-actions.pod:1340 ../src/guestfs-actions.pod:1577
5439 #: ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:1965
5440 #: ../src/guestfs-actions.pod:2004 ../src/guestfs-actions.pod:2026
5441 #: ../src/guestfs-actions.pod:2041 ../src/guestfs-actions.pod:2068
5442 #: ../src/guestfs-actions.pod:4191 ../src/guestfs-actions.pod:4215
5443 #: ../src/guestfs-actions.pod:4331 ../src/guestfs-actions.pod:4355
5444 #: ../src/guestfs-actions.pod:4377 ../src/guestfs-actions.pod:5145
5445 #: ../src/guestfs-actions.pod:5198 ../src/guestfs-actions.pod:5324
5446 #: ../src/guestfs-actions.pod:5346 ../src/guestfs-actions.pod:5927
5447 #: ../src/guestfs-actions.pod:5951 ../src/guestfs-actions.pod:5975
5448 #: ../src/guestfs-actions.pod:5992 ../src/guestfs-actions.pod:6069
5449 #: ../src/guestfs-actions.pod:6086 ../src/guestfs-actions.pod:6128
5450 #: ../src/guestfs-actions.pod:6145 ../fish/guestfish-actions.pod:546
5451 #: ../fish/guestfish-actions.pod:681 ../fish/guestfish-actions.pod:693
5452 #: ../fish/guestfish-actions.pod:894 ../fish/guestfish-actions.pod:904
5453 #: ../fish/guestfish-actions.pod:971 ../fish/guestfish-actions.pod:981
5454 #: ../fish/guestfish-actions.pod:1176 ../fish/guestfish-actions.pod:1451
5455 #: ../fish/guestfish-actions.pod:1461 ../fish/guestfish-actions.pod:1489
5456 #: ../fish/guestfish-actions.pod:1504 ../fish/guestfish-actions.pod:1514
5457 #: ../fish/guestfish-actions.pod:1533 ../fish/guestfish-actions.pod:3067
5458 #: ../fish/guestfish-actions.pod:3082 ../fish/guestfish-actions.pod:3158
5459 #: ../fish/guestfish-actions.pod:3175 ../fish/guestfish-actions.pod:3190
5460 #: ../fish/guestfish-actions.pod:3773 ../fish/guestfish-actions.pod:3819
5461 #: ../fish/guestfish-actions.pod:3904 ../fish/guestfish-actions.pod:3919
5462 #: ../fish/guestfish-actions.pod:4329 ../fish/guestfish-actions.pod:4347
5463 #: ../fish/guestfish-actions.pod:4364 ../fish/guestfish-actions.pod:4374
5464 #: ../fish/guestfish-actions.pod:4422 ../fish/guestfish-actions.pod:4432
5465 #: ../fish/guestfish-actions.pod:4461 ../fish/guestfish-actions.pod:4471
5467 "Because of the message protocol, there is a transfer limit of somewhere "
5468 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5472 #: ../src/guestfs-actions.pod:735
5473 msgid "guestfs_checksum"
5477 #: ../src/guestfs-actions.pod:737
5481 " guestfs_checksum (guestfs_h *g,\n"
5482 " const char *csumtype,\n"
5483 " const char *path);\n"
5488 #: ../src/guestfs-actions.pod:742 ../fish/guestfish-actions.pod:553
5490 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5494 #: ../src/guestfs-actions.pod:745 ../fish/guestfish-actions.pod:556
5496 "The type of checksum to compute is given by the C<csumtype> parameter which "
5497 "must have one of the following values:"
5501 #: ../src/guestfs-actions.pod:750 ../fish/guestfish-actions.pod:561
5506 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:563
5508 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5513 #: ../src/guestfs-actions.pod:755 ../fish/guestfish-actions.pod:566
5518 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:568
5519 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5523 #: ../src/guestfs-actions.pod:759 ../fish/guestfish-actions.pod:570
5528 #: ../src/guestfs-actions.pod:761 ../fish/guestfish-actions.pod:572
5529 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5533 #: ../src/guestfs-actions.pod:763 ../fish/guestfish-actions.pod:574
5538 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:576
5539 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5543 #: ../src/guestfs-actions.pod:767 ../fish/guestfish-actions.pod:578
5548 #: ../src/guestfs-actions.pod:769 ../fish/guestfish-actions.pod:580
5549 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5553 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:582
5558 #: ../src/guestfs-actions.pod:773 ../fish/guestfish-actions.pod:584
5559 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5563 #: ../src/guestfs-actions.pod:775 ../fish/guestfish-actions.pod:586
5568 #: ../src/guestfs-actions.pod:777 ../fish/guestfish-actions.pod:588
5569 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5573 #: ../src/guestfs-actions.pod:781 ../fish/guestfish-actions.pod:592
5574 msgid "The checksum is returned as a printable string."
5578 #: ../src/guestfs-actions.pod:783
5579 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
5583 #: ../src/guestfs-actions.pod:785
5584 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
5588 #: ../src/guestfs-actions.pod:790
5589 msgid "guestfs_checksum_device"
5593 #: ../src/guestfs-actions.pod:792
5597 " guestfs_checksum_device (guestfs_h *g,\n"
5598 " const char *csumtype,\n"
5599 " const char *device);\n"
5604 #: ../src/guestfs-actions.pod:797
5606 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5607 "device named C<device>. For the types of checksums supported see the "
5608 "C<guestfs_checksum> command."
5612 #: ../src/guestfs-actions.pod:804
5613 msgid "guestfs_checksums_out"
5617 #: ../src/guestfs-actions.pod:806
5621 " guestfs_checksums_out (guestfs_h *g,\n"
5622 " const char *csumtype,\n"
5623 " const char *directory,\n"
5624 " const char *sumsfile);\n"
5629 #: ../src/guestfs-actions.pod:812 ../fish/guestfish-actions.pod:610
5631 "This command computes the checksums of all regular files in C<directory> and "
5632 "then emits a list of those checksums to the local output file C<sumsfile>."
5636 #: ../src/guestfs-actions.pod:816 ../fish/guestfish-actions.pod:614
5638 "This can be used for verifying the integrity of a virtual machine. However "
5639 "to be properly secure you should pay attention to the output of the checksum "
5640 "command (it uses the ones from GNU coreutils). In particular when the "
5641 "filename is not printable, coreutils uses a special backslash syntax. For "
5642 "more information, see the GNU coreutils info file."
5646 #: ../src/guestfs-actions.pod:826
5647 msgid "guestfs_chmod"
5651 #: ../src/guestfs-actions.pod:828
5655 " guestfs_chmod (guestfs_h *g,\n"
5657 " const char *path);\n"
5662 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:628
5664 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5669 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:631
5671 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5672 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5677 #: ../src/guestfs-actions.pod:840 ../src/guestfs-actions.pod:3483
5678 #: ../src/guestfs-actions.pod:3590 ../src/guestfs-actions.pod:3607
5679 #: ../src/guestfs-actions.pod:3624 ../fish/guestfish-actions.pod:635
5680 #: ../fish/guestfish-actions.pod:2557 ../fish/guestfish-actions.pod:2642
5681 #: ../fish/guestfish-actions.pod:2652 ../fish/guestfish-actions.pod:2662
5682 msgid "The mode actually set is affected by the umask."
5686 #: ../src/guestfs-actions.pod:844
5687 msgid "guestfs_chown"
5691 #: ../src/guestfs-actions.pod:846
5695 " guestfs_chown (guestfs_h *g,\n"
5698 " const char *path);\n"
5703 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:641
5704 msgid "Change the file owner to C<owner> and group to C<group>."
5708 #: ../src/guestfs-actions.pod:854 ../src/guestfs-actions.pod:2707
5709 #: ../fish/guestfish-actions.pod:643 ../fish/guestfish-actions.pod:2035
5711 "Only numeric uid and gid are supported. If you want to use names, you will "
5712 "need to locate and parse the password file yourself (Augeas support makes "
5713 "this relatively easy)."
5717 #: ../src/guestfs-actions.pod:860
5718 msgid "guestfs_command"
5722 #: ../src/guestfs-actions.pod:862
5726 " guestfs_command (guestfs_h *g,\n"
5727 " char *const *arguments);\n"
5732 #: ../src/guestfs-actions.pod:866 ../fish/guestfish-actions.pod:651
5734 "This call runs a command from the guest filesystem. The filesystem must be "
5735 "mounted, and must contain a compatible operating system (ie. something "
5736 "Linux, with the same or compatible processor architecture)."
5740 #: ../src/guestfs-actions.pod:871
5742 "The single parameter is an argv-style list of arguments. The first element "
5743 "is the name of the program to run. Subsequent elements are parameters. The "
5744 "list must be non-empty (ie. must contain a program name). Note that the "
5745 "command runs directly, and is I<not> invoked via the shell (see "
5750 #: ../src/guestfs-actions.pod:878 ../fish/guestfish-actions.pod:663
5751 msgid "The return value is anything printed to I<stdout> by the command."
5755 #: ../src/guestfs-actions.pod:881 ../fish/guestfish-actions.pod:666
5757 "If the command returns a non-zero exit status, then this function returns an "
5758 "error message. The error message string is the content of I<stderr> from "
5763 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:670
5765 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
5766 "bin>. If you require a program from another location, you should provide "
5767 "the full path in the first parameter."
5771 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:675
5773 "Shared libraries and data files required by the program must be available on "
5774 "filesystems which are mounted in the correct places. It is the caller's "
5775 "responsibility to ensure all filesystems that are needed are mounted at the "
5780 #: ../src/guestfs-actions.pod:902
5781 msgid "guestfs_command_lines"
5785 #: ../src/guestfs-actions.pod:904
5789 " guestfs_command_lines (guestfs_h *g,\n"
5790 " char *const *arguments);\n"
5795 #: ../src/guestfs-actions.pod:908
5797 "This is the same as C<guestfs_command>, but splits the result into a list of "
5802 #: ../src/guestfs-actions.pod:911
5803 msgid "See also: C<guestfs_sh_lines>"
5807 #: ../src/guestfs-actions.pod:920
5808 msgid "guestfs_config"
5812 #: ../src/guestfs-actions.pod:922
5816 " guestfs_config (guestfs_h *g,\n"
5817 " const char *qemuparam,\n"
5818 " const char *qemuvalue);\n"
5823 #: ../src/guestfs-actions.pod:927 ../fish/guestfish-actions.pod:700
5825 "This can be used to add arbitrary qemu command line parameters of the form "
5826 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
5827 "setting some parameters which would interfere with parameters that we use."
5831 #: ../src/guestfs-actions.pod:932 ../fish/guestfish-actions.pod:705
5832 msgid "The first character of C<param> string must be a C<-> (dash)."
5836 #: ../src/guestfs-actions.pod:934 ../fish/guestfish-actions.pod:707
5837 msgid "C<value> can be NULL."
5841 #: ../src/guestfs-actions.pod:938
5842 msgid "guestfs_copy_size"
5846 #: ../src/guestfs-actions.pod:940
5850 " guestfs_copy_size (guestfs_h *g,\n"
5851 " const char *src,\n"
5852 " const char *dest,\n"
5858 #: ../src/guestfs-actions.pod:946 ../fish/guestfish-actions.pod:713
5860 "This command copies exactly C<size> bytes from one source device or file "
5861 "C<src> to another destination device or file C<dest>."
5865 #: ../src/guestfs-actions.pod:949 ../fish/guestfish-actions.pod:716
5867 "Note this will fail if the source is too short or if the destination is not "
5872 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:1098
5873 #: ../src/guestfs-actions.pod:1127 ../src/guestfs-actions.pod:1515
5874 #: ../src/guestfs-actions.pod:1535 ../src/guestfs-actions.pod:6011
5875 #: ../src/guestfs-actions.pod:6028
5877 "This long-running command can generate progress notification messages so "
5878 "that the caller can display a progress bar or indicator. To receive these "
5879 "messages, the caller must register a progress callback. See L<guestfs(3)/"
5880 "guestfs_set_progress_callback>."
5884 #: ../src/guestfs-actions.pod:959
5889 #: ../src/guestfs-actions.pod:961
5893 " guestfs_cp (guestfs_h *g,\n"
5894 " const char *src,\n"
5895 " const char *dest);\n"
5900 #: ../src/guestfs-actions.pod:966 ../fish/guestfish-actions.pod:723
5902 "This copies a file from C<src> to C<dest> where C<dest> is either a "
5903 "destination filename or destination directory."
5907 #: ../src/guestfs-actions.pod:971
5908 msgid "guestfs_cp_a"
5912 #: ../src/guestfs-actions.pod:973
5916 " guestfs_cp_a (guestfs_h *g,\n"
5917 " const char *src,\n"
5918 " const char *dest);\n"
5923 #: ../src/guestfs-actions.pod:978 ../fish/guestfish-actions.pod:730
5925 "This copies a file or directory from C<src> to C<dest> recursively using the "
5930 #: ../src/guestfs-actions.pod:983
5935 #: ../src/guestfs-actions.pod:985
5939 " guestfs_dd (guestfs_h *g,\n"
5940 " const char *src,\n"
5941 " const char *dest);\n"
5946 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:737
5948 "This command copies from one source device or file C<src> to another "
5949 "destination device or file C<dest>. Normally you would use this to copy to "
5950 "or from a device or partition, for example to duplicate a filesystem."
5954 #: ../src/guestfs-actions.pod:995
5956 "If the destination is a device, it must be as large or larger than the "
5957 "source file or device, otherwise the copy will fail. This command cannot do "
5958 "partial copies (see C<guestfs_copy_size>)."
5962 #: ../src/guestfs-actions.pod:1001
5963 msgid "guestfs_debug"
5967 #: ../src/guestfs-actions.pod:1003
5971 " guestfs_debug (guestfs_h *g,\n"
5972 " const char *subcmd,\n"
5973 " char *const *extraargs);\n"
5978 #: ../src/guestfs-actions.pod:1008
5980 "The C<guestfs_debug> command exposes some internals of C<guestfsd> (the "
5981 "guestfs daemon) that runs inside the qemu subprocess."
5985 #: ../src/guestfs-actions.pod:1012 ../fish/guestfish-actions.pod:754
5987 "There is no comprehensive help for this command. You have to look at the "
5988 "file C<daemon/debug.c> in the libguestfs source to find out what you can do."
5992 #: ../src/guestfs-actions.pod:1019
5993 msgid "guestfs_debug_upload"
5997 #: ../src/guestfs-actions.pod:1021
6001 " guestfs_debug_upload (guestfs_h *g,\n"
6002 " const char *filename,\n"
6003 " const char *tmpname,\n"
6009 #: ../src/guestfs-actions.pod:1027
6011 "The C<guestfs_debug_upload> command uploads a file to the libguestfs "
6016 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:765
6018 "There is no comprehensive help for this command. You have to look at the "
6019 "file C<daemon/debug.c> in the libguestfs source to find out what it is for."
6023 #: ../src/guestfs-actions.pod:1036
6028 #: ../src/guestfs-actions.pod:1038
6032 " guestfs_df (guestfs_h *g);\n"
6037 #: ../src/guestfs-actions.pod:1041 ../fish/guestfish-actions.pod:775
6038 msgid "This command runs the C<df> command to report disk space used."
6042 #: ../src/guestfs-actions.pod:1043 ../src/guestfs-actions.pod:1058
6043 #: ../fish/guestfish-actions.pod:777 ../fish/guestfish-actions.pod:788
6045 "This command is mostly useful for interactive sessions. It is I<not> "
6046 "intended that you try to parse the output string. Use C<statvfs> from "
6051 #: ../src/guestfs-actions.pod:1050
6052 msgid "guestfs_df_h"
6056 #: ../src/guestfs-actions.pod:1052
6060 " guestfs_df_h (guestfs_h *g);\n"
6065 #: ../src/guestfs-actions.pod:1055 ../fish/guestfish-actions.pod:785
6067 "This command runs the C<df -h> command to report disk space used in human-"
6072 #: ../src/guestfs-actions.pod:1065
6073 msgid "guestfs_dmesg"
6077 #: ../src/guestfs-actions.pod:1067
6081 " guestfs_dmesg (guestfs_h *g);\n"
6086 #: ../src/guestfs-actions.pod:1070 ../fish/guestfish-actions.pod:796
6088 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
6089 "This is sometimes useful for extended debugging of problems."
6093 #: ../src/guestfs-actions.pod:1074
6095 "Another way to get the same information is to enable verbose messages with "
6096 "C<guestfs_set_verbose> or by setting the environment variable "
6097 "C<LIBGUESTFS_DEBUG=1> before running the program."
6101 #: ../src/guestfs-actions.pod:1082
6102 msgid "guestfs_download"
6106 #: ../src/guestfs-actions.pod:1084
6110 " guestfs_download (guestfs_h *g,\n"
6111 " const char *remotefilename,\n"
6112 " const char *filename);\n"
6117 #: ../src/guestfs-actions.pod:1089 ../src/guestfs-actions.pod:1112
6118 #: ../fish/guestfish-actions.pod:809 ../fish/guestfish-actions.pod:822
6120 "Download file C<remotefilename> and save it as C<filename> on the local "
6125 #: ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:5553
6126 #: ../fish/guestfish-actions.pod:812 ../fish/guestfish-actions.pod:4077
6127 msgid "C<filename> can also be a named pipe."
6131 #: ../src/guestfs-actions.pod:1094
6132 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
6136 #: ../src/guestfs-actions.pod:1103
6137 msgid "guestfs_download_offset"
6141 #: ../src/guestfs-actions.pod:1105
6145 " guestfs_download_offset (guestfs_h *g,\n"
6146 " const char *remotefilename,\n"
6147 " const char *filename,\n"
6148 " int64_t offset,\n"
6154 #: ../src/guestfs-actions.pod:1115 ../fish/guestfish-actions.pod:825
6156 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6157 "region must be within the file or device)."
6161 #: ../src/guestfs-actions.pod:1118
6163 "Note that there is no limit on the amount of data that can be downloaded "
6164 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
6165 "full amount unless an error occurs."
6169 #: ../src/guestfs-actions.pod:1123
6170 msgid "See also C<guestfs_download>, C<guestfs_pread>."
6174 #: ../src/guestfs-actions.pod:1132
6175 msgid "guestfs_drop_caches"
6179 #: ../src/guestfs-actions.pod:1134
6183 " guestfs_drop_caches (guestfs_h *g,\n"
6184 " int whattodrop);\n"
6189 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:841
6191 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6192 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6193 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6197 #: ../src/guestfs-actions.pod:1143 ../fish/guestfish-actions.pod:846
6198 msgid "Setting C<whattodrop> to 3 should drop everything."
6202 #: ../src/guestfs-actions.pod:1145 ../fish/guestfish-actions.pod:848
6204 "This automatically calls L<sync(2)> before the operation, so that the "
6205 "maximum guest memory is freed."
6209 #: ../src/guestfs-actions.pod:1150
6214 #: ../src/guestfs-actions.pod:1152
6218 " guestfs_du (guestfs_h *g,\n"
6219 " const char *path);\n"
6224 #: ../src/guestfs-actions.pod:1156 ../fish/guestfish-actions.pod:855
6226 "This command runs the C<du -s> command to estimate file space usage for "
6231 #: ../src/guestfs-actions.pod:1159 ../fish/guestfish-actions.pod:858
6233 "C<path> can be a file or a directory. If C<path> is a directory then the "
6234 "estimate includes the contents of the directory and all subdirectories "
6239 #: ../src/guestfs-actions.pod:1163 ../fish/guestfish-actions.pod:862
6241 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6245 #: ../src/guestfs-actions.pod:1168
6246 msgid "guestfs_e2fsck_f"
6250 #: ../src/guestfs-actions.pod:1170
6254 " guestfs_e2fsck_f (guestfs_h *g,\n"
6255 " const char *device);\n"
6260 #: ../src/guestfs-actions.pod:1174 ../fish/guestfish-actions.pod:869
6262 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6263 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
6268 #: ../src/guestfs-actions.pod:1178
6270 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
6271 "Normally you should use C<guestfs_fsck>."
6275 #: ../src/guestfs-actions.pod:1183
6276 msgid "guestfs_echo_daemon"
6280 #: ../src/guestfs-actions.pod:1185
6284 " guestfs_echo_daemon (guestfs_h *g,\n"
6285 " char *const *words);\n"
6290 #: ../src/guestfs-actions.pod:1189 ../fish/guestfish-actions.pod:880
6292 "This command concatenates the list of C<words> passed with single spaces "
6293 "between them and returns the resulting string."
6297 #: ../src/guestfs-actions.pod:1192 ../fish/guestfish-actions.pod:883
6298 msgid "You can use this command to test the connection through to the daemon."
6302 #: ../src/guestfs-actions.pod:1194
6303 msgid "See also C<guestfs_ping_daemon>."
6307 #: ../src/guestfs-actions.pod:1199
6308 msgid "guestfs_egrep"
6312 #: ../src/guestfs-actions.pod:1201
6316 " guestfs_egrep (guestfs_h *g,\n"
6317 " const char *regex,\n"
6318 " const char *path);\n"
6323 #: ../src/guestfs-actions.pod:1206 ../fish/guestfish-actions.pod:891
6325 "This calls the external C<egrep> program and returns the matching lines."
6329 #: ../src/guestfs-actions.pod:1216
6330 msgid "guestfs_egrepi"
6334 #: ../src/guestfs-actions.pod:1218
6338 " guestfs_egrepi (guestfs_h *g,\n"
6339 " const char *regex,\n"
6340 " const char *path);\n"
6345 #: ../src/guestfs-actions.pod:1223 ../fish/guestfish-actions.pod:901
6347 "This calls the external C<egrep -i> program and returns the matching lines."
6351 #: ../src/guestfs-actions.pod:1233
6352 msgid "guestfs_equal"
6356 #: ../src/guestfs-actions.pod:1235
6360 " guestfs_equal (guestfs_h *g,\n"
6361 " const char *file1,\n"
6362 " const char *file2);\n"
6367 #: ../src/guestfs-actions.pod:1240 ../fish/guestfish-actions.pod:911
6369 "This compares the two files C<file1> and C<file2> and returns true if their "
6370 "content is exactly equal, or false otherwise."
6374 #: ../src/guestfs-actions.pod:1243 ../fish/guestfish-actions.pod:914
6375 msgid "The external L<cmp(1)> program is used for the comparison."
6379 #: ../src/guestfs-actions.pod:1247
6380 msgid "guestfs_exists"
6384 #: ../src/guestfs-actions.pod:1249
6388 " guestfs_exists (guestfs_h *g,\n"
6389 " const char *path);\n"
6394 #: ../src/guestfs-actions.pod:1253 ../fish/guestfish-actions.pod:920
6396 "This returns C<true> if and only if there is a file, directory (or anything) "
6397 "with the given C<path> name."
6401 #: ../src/guestfs-actions.pod:1256
6402 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6406 #: ../src/guestfs-actions.pod:1260
6407 msgid "guestfs_fallocate"
6411 #: ../src/guestfs-actions.pod:1262
6415 " guestfs_fallocate (guestfs_h *g,\n"
6416 " const char *path,\n"
6422 #: ../src/guestfs-actions.pod:1267 ../src/guestfs-actions.pod:1291
6423 #: ../fish/guestfish-actions.pod:929 ../fish/guestfish-actions.pod:948
6425 "This command preallocates a file (containing zero bytes) named C<path> of "
6426 "size C<len> bytes. If the file exists already, it is overwritten."
6430 #: ../src/guestfs-actions.pod:1271 ../fish/guestfish-actions.pod:933
6432 "Do not confuse this with the guestfish-specific C<alloc> command which "
6433 "allocates a file in the host and attaches it as a device."
6437 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:937
6439 "This function is deprecated. In new code, use the C<fallocate64> call "
6444 #: ../src/guestfs-actions.pod:1284
6445 msgid "guestfs_fallocate64"
6449 #: ../src/guestfs-actions.pod:1286
6453 " guestfs_fallocate64 (guestfs_h *g,\n"
6454 " const char *path,\n"
6460 #: ../src/guestfs-actions.pod:1295
6462 "Note that this call allocates disk blocks for the file. To create a sparse "
6463 "file use C<guestfs_truncate_size> instead."
6467 #: ../src/guestfs-actions.pod:1298
6469 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6470 "oversight it only allowed 30 bit lengths to be specified, effectively "
6471 "limiting the maximum size of files created through that call to 1GB."
6475 #: ../src/guestfs-actions.pod:1303 ../fish/guestfish-actions.pod:960
6477 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6478 "commands which create a file in the host and attach it as a device."
6482 #: ../src/guestfs-actions.pod:1309
6483 msgid "guestfs_fgrep"
6487 #: ../src/guestfs-actions.pod:1311
6491 " guestfs_fgrep (guestfs_h *g,\n"
6492 " const char *pattern,\n"
6493 " const char *path);\n"
6498 #: ../src/guestfs-actions.pod:1316 ../fish/guestfish-actions.pod:968
6500 "This calls the external C<fgrep> program and returns the matching lines."
6504 #: ../src/guestfs-actions.pod:1326
6505 msgid "guestfs_fgrepi"
6509 #: ../src/guestfs-actions.pod:1328
6513 " guestfs_fgrepi (guestfs_h *g,\n"
6514 " const char *pattern,\n"
6515 " const char *path);\n"
6520 #: ../src/guestfs-actions.pod:1333 ../fish/guestfish-actions.pod:978
6522 "This calls the external C<fgrep -i> program and returns the matching lines."
6526 #: ../src/guestfs-actions.pod:1343
6527 msgid "guestfs_file"
6531 #: ../src/guestfs-actions.pod:1345
6535 " guestfs_file (guestfs_h *g,\n"
6536 " const char *path);\n"
6541 #: ../src/guestfs-actions.pod:1349 ../fish/guestfish-actions.pod:988
6543 "This call uses the standard L<file(1)> command to determine the type or "
6544 "contents of the file."
6548 #: ../src/guestfs-actions.pod:1352 ../fish/guestfish-actions.pod:991
6550 "This call will also transparently look inside various types of compressed "
6555 #: ../src/guestfs-actions.pod:1355 ../fish/guestfish-actions.pod:994
6557 "The exact command which runs is C<file -zb path>. Note in particular that "
6558 "the filename is not prepended to the output (the C<-b> option)."
6562 #: ../src/guestfs-actions.pod:1359
6564 "This command can also be used on C</dev/> devices (and partitions, LV "
6565 "names). You can for example use this to determine if a device contains a "
6566 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
6570 #: ../src/guestfs-actions.pod:1364 ../fish/guestfish-actions.pod:1003
6572 "If the C<path> does not begin with C</dev/> then this command only works for "
6573 "the content of regular files. For other file types (directory, symbolic "
6574 "link etc) it will just return the string C<directory> etc."
6578 #: ../src/guestfs-actions.pod:1372
6579 msgid "guestfs_file_architecture"
6583 #: ../src/guestfs-actions.pod:1374
6587 " guestfs_file_architecture (guestfs_h *g,\n"
6588 " const char *filename);\n"
6593 #: ../src/guestfs-actions.pod:1378 ../fish/guestfish-actions.pod:1012
6595 "This detects the architecture of the binary C<filename>, and returns it if "
6600 #: ../src/guestfs-actions.pod:1381 ../fish/guestfish-actions.pod:1015
6601 msgid "Currently defined architectures are:"
6605 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:1019
6610 #: ../src/guestfs-actions.pod:1387 ../fish/guestfish-actions.pod:1021
6612 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6613 "irrespective of the precise processor requirements of the binary."
6617 #: ../src/guestfs-actions.pod:1390 ../fish/guestfish-actions.pod:1024
6622 #: ../src/guestfs-actions.pod:1392 ../fish/guestfish-actions.pod:1026
6623 msgid "64 bit x86-64."
6627 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:1028
6632 #: ../src/guestfs-actions.pod:1396 ../fish/guestfish-actions.pod:1030
6633 msgid "32 bit SPARC."
6637 #: ../src/guestfs-actions.pod:1398 ../fish/guestfish-actions.pod:1032
6642 #: ../src/guestfs-actions.pod:1400 ../fish/guestfish-actions.pod:1034
6643 msgid "64 bit SPARC V9 and above."
6647 #: ../src/guestfs-actions.pod:1402 ../fish/guestfish-actions.pod:1036
6652 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:1038
6653 msgid "Intel Itanium."
6657 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:1040
6662 #: ../src/guestfs-actions.pod:1408 ../fish/guestfish-actions.pod:1042
6663 msgid "32 bit Power PC."
6667 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:1044
6672 #: ../src/guestfs-actions.pod:1412 ../fish/guestfish-actions.pod:1046
6673 msgid "64 bit Power PC."
6677 #: ../src/guestfs-actions.pod:1416 ../fish/guestfish-actions.pod:1050
6678 msgid "Libguestfs may return other architecture strings in future."
6682 #: ../src/guestfs-actions.pod:1418 ../fish/guestfish-actions.pod:1052
6683 msgid "The function works on at least the following types of files:"
6687 #: ../src/guestfs-actions.pod:1424 ../fish/guestfish-actions.pod:1058
6688 msgid "many types of Un*x and Linux binary"
6692 #: ../src/guestfs-actions.pod:1428 ../fish/guestfish-actions.pod:1062
6693 msgid "many types of Un*x and Linux shared library"
6697 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:1066
6698 msgid "Windows Win32 and Win64 binaries"
6702 #: ../src/guestfs-actions.pod:1436 ../fish/guestfish-actions.pod:1070
6703 msgid "Windows Win32 and Win64 DLLs"
6707 #: ../src/guestfs-actions.pod:1438 ../fish/guestfish-actions.pod:1072
6708 msgid "Win32 binaries and DLLs return C<i386>."
6712 #: ../src/guestfs-actions.pod:1440 ../fish/guestfish-actions.pod:1074
6713 msgid "Win64 binaries and DLLs return C<x86_64>."
6717 #: ../src/guestfs-actions.pod:1444 ../fish/guestfish-actions.pod:1078
6718 msgid "Linux kernel modules"
6722 #: ../src/guestfs-actions.pod:1448 ../fish/guestfish-actions.pod:1082
6723 msgid "Linux new-style initrd images"
6727 #: ../src/guestfs-actions.pod:1452 ../fish/guestfish-actions.pod:1086
6728 msgid "some non-x86 Linux vmlinuz kernels"
6732 #: ../src/guestfs-actions.pod:1456 ../fish/guestfish-actions.pod:1090
6733 msgid "What it can't do currently:"
6737 #: ../src/guestfs-actions.pod:1462 ../fish/guestfish-actions.pod:1096
6738 msgid "static libraries (libfoo.a)"
6742 #: ../src/guestfs-actions.pod:1466 ../fish/guestfish-actions.pod:1100
6743 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6747 #: ../src/guestfs-actions.pod:1470 ../fish/guestfish-actions.pod:1104
6748 msgid "x86 Linux vmlinuz kernels"
6752 #: ../src/guestfs-actions.pod:1472 ../fish/guestfish-actions.pod:1106
6754 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6755 "compressed code, and are horribly hard to unpack. If you want to find the "
6756 "architecture of a kernel, use the architecture of the associated initrd or "
6757 "kernel module(s) instead."
6761 #: ../src/guestfs-actions.pod:1482
6762 msgid "guestfs_filesize"
6766 #: ../src/guestfs-actions.pod:1484
6770 " guestfs_filesize (guestfs_h *g,\n"
6771 " const char *file);\n"
6776 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:1117
6777 msgid "This command returns the size of C<file> in bytes."
6781 #: ../src/guestfs-actions.pod:1490
6783 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
6784 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
6785 "devices, use C<guestfs_blockdev_getsize64>."
6789 #: ../src/guestfs-actions.pod:1496
6790 msgid "guestfs_fill"
6794 #: ../src/guestfs-actions.pod:1498
6798 " guestfs_fill (guestfs_h *g,\n"
6801 " const char *path);\n"
6806 #: ../src/guestfs-actions.pod:1504 ../fish/guestfish-actions.pod:1127
6808 "This command creates a new file called C<path>. The initial content of the "
6809 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
6814 #: ../src/guestfs-actions.pod:1508
6816 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6817 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
6818 "bytes use C<guestfs_fill_pattern>."
6822 #: ../src/guestfs-actions.pod:1520
6823 msgid "guestfs_fill_pattern"
6827 #: ../src/guestfs-actions.pod:1522
6831 " guestfs_fill_pattern (guestfs_h *g,\n"
6832 " const char *pattern,\n"
6834 " const char *path);\n"
6839 #: ../src/guestfs-actions.pod:1528
6841 "This function is like C<guestfs_fill> except that it creates a new file of "
6842 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
6843 "pattern is truncated if necessary to ensure the length of the file is "
6844 "exactly C<len> bytes."
6848 #: ../src/guestfs-actions.pod:1540
6849 msgid "guestfs_find"
6853 #: ../src/guestfs-actions.pod:1542
6857 " guestfs_find (guestfs_h *g,\n"
6858 " const char *directory);\n"
6863 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1149
6865 "This command lists out all files and directories, recursively, starting at "
6866 "C<directory>. It is essentially equivalent to running the shell command "
6867 "C<find directory -print> but some post-processing happens on the output, "
6872 #: ../src/guestfs-actions.pod:1551 ../fish/guestfish-actions.pod:1154
6874 "This returns a list of strings I<without any prefix>. Thus if the directory "
6879 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1157
6889 #: ../src/guestfs-actions.pod:1558
6891 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
6895 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1164
6906 #: ../src/guestfs-actions.pod:1566 ../fish/guestfish-actions.pod:1169
6907 msgid "If C<directory> is not a directory, then this command returns an error."
6911 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1172
6912 msgid "The returned list is sorted."
6916 #: ../src/guestfs-actions.pod:1571
6917 msgid "See also C<guestfs_find0>."
6921 #: ../src/guestfs-actions.pod:1580
6922 msgid "guestfs_find0"
6926 #: ../src/guestfs-actions.pod:1582
6930 " guestfs_find0 (guestfs_h *g,\n"
6931 " const char *directory,\n"
6932 " const char *files);\n"
6937 #: ../src/guestfs-actions.pod:1587 ../fish/guestfish-actions.pod:1183
6939 "This command lists out all files and directories, recursively, starting at "
6940 "C<directory>, placing the resulting list in the external file called "
6945 #: ../src/guestfs-actions.pod:1591
6947 "This command works the same way as C<guestfs_find> with the following "
6952 #: ../src/guestfs-actions.pod:1598 ../fish/guestfish-actions.pod:1194
6953 msgid "The resulting list is written to an external file."
6957 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1198
6959 "Items (filenames) in the result are separated by C<\\0> characters. See "
6960 "L<find(1)> option I<-print0>."
6964 #: ../src/guestfs-actions.pod:1607 ../fish/guestfish-actions.pod:1203
6965 msgid "This command is not limited in the number of names that it can return."
6969 #: ../src/guestfs-actions.pod:1612 ../fish/guestfish-actions.pod:1208
6970 msgid "The result list is not sorted."
6974 #: ../src/guestfs-actions.pod:1618
6975 msgid "guestfs_findfs_label"
6979 #: ../src/guestfs-actions.pod:1620
6983 " guestfs_findfs_label (guestfs_h *g,\n"
6984 " const char *label);\n"
6989 #: ../src/guestfs-actions.pod:1624 ../fish/guestfish-actions.pod:1218
6991 "This command searches the filesystems and returns the one which has the "
6992 "given label. An error is returned if no such filesystem can be found."
6996 #: ../src/guestfs-actions.pod:1628
6997 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
7001 #: ../src/guestfs-actions.pod:1633
7002 msgid "guestfs_findfs_uuid"
7006 #: ../src/guestfs-actions.pod:1635
7010 " guestfs_findfs_uuid (guestfs_h *g,\n"
7011 " const char *uuid);\n"
7016 #: ../src/guestfs-actions.pod:1639 ../fish/guestfish-actions.pod:1228
7018 "This command searches the filesystems and returns the one which has the "
7019 "given UUID. An error is returned if no such filesystem can be found."
7023 #: ../src/guestfs-actions.pod:1643
7024 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
7028 #: ../src/guestfs-actions.pod:1648
7029 msgid "guestfs_fsck"
7033 #: ../src/guestfs-actions.pod:1650
7037 " guestfs_fsck (guestfs_h *g,\n"
7038 " const char *fstype,\n"
7039 " const char *device);\n"
7044 #: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1238
7046 "This runs the filesystem checker (fsck) on C<device> which should have "
7047 "filesystem type C<fstype>."
7051 #: ../src/guestfs-actions.pod:1658 ../fish/guestfish-actions.pod:1241
7053 "The returned integer is the status. See L<fsck(8)> for the list of status "
7054 "codes from C<fsck>."
7058 #: ../src/guestfs-actions.pod:1667 ../fish/guestfish-actions.pod:1250
7059 msgid "Multiple status codes can be summed together."
7063 #: ../src/guestfs-actions.pod:1671 ../fish/guestfish-actions.pod:1254
7065 "A non-zero return code can mean \"success\", for example if errors have been "
7066 "corrected on the filesystem."
7070 #: ../src/guestfs-actions.pod:1676 ../fish/guestfish-actions.pod:1259
7071 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
7075 #: ../src/guestfs-actions.pod:1681 ../fish/guestfish-actions.pod:1264
7077 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
7081 #: ../src/guestfs-actions.pod:1685
7082 msgid "guestfs_get_append"
7086 #: ../src/guestfs-actions.pod:1687
7090 " guestfs_get_append (guestfs_h *g);\n"
7095 #: ../src/guestfs-actions.pod:1690 ../fish/guestfish-actions.pod:1270
7097 "Return the additional kernel options which are added to the guest kernel "
7102 #: ../src/guestfs-actions.pod:1693 ../fish/guestfish-actions.pod:1273
7103 msgid "If C<NULL> then no options are added."
7107 #: ../src/guestfs-actions.pod:1695
7109 "This function returns a string which may be NULL. There is no way to return "
7110 "an error from this function. The string is owned by the guest handle and "
7111 "must I<not> be freed."
7115 #: ../src/guestfs-actions.pod:1699
7116 msgid "guestfs_get_autosync"
7120 #: ../src/guestfs-actions.pod:1701
7124 " guestfs_get_autosync (guestfs_h *g);\n"
7129 #: ../src/guestfs-actions.pod:1704 ../fish/guestfish-actions.pod:1279
7130 msgid "Get the autosync flag."
7134 #: ../src/guestfs-actions.pod:1708
7135 msgid "guestfs_get_direct"
7139 #: ../src/guestfs-actions.pod:1710
7143 " guestfs_get_direct (guestfs_h *g);\n"
7148 #: ../src/guestfs-actions.pod:1713 ../fish/guestfish-actions.pod:1285
7149 msgid "Return the direct appliance mode flag."
7153 #: ../src/guestfs-actions.pod:1717
7154 msgid "guestfs_get_e2label"
7158 #: ../src/guestfs-actions.pod:1719
7162 " guestfs_get_e2label (guestfs_h *g,\n"
7163 " const char *device);\n"
7168 #: ../src/guestfs-actions.pod:1723 ../fish/guestfish-actions.pod:1291
7170 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7174 #: ../src/guestfs-actions.pod:1729 ../fish/guestfish-actions.pod:1294
7176 "This function is deprecated. In new code, use the C<vfs_label> call instead."
7180 #: ../src/guestfs-actions.pod:1736
7181 msgid "guestfs_get_e2uuid"
7185 #: ../src/guestfs-actions.pod:1738
7189 " guestfs_get_e2uuid (guestfs_h *g,\n"
7190 " const char *device);\n"
7195 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1305
7197 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7201 #: ../src/guestfs-actions.pod:1748 ../fish/guestfish-actions.pod:1308
7203 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
7207 #: ../src/guestfs-actions.pod:1755
7208 msgid "guestfs_get_memsize"
7212 #: ../src/guestfs-actions.pod:1757
7216 " guestfs_get_memsize (guestfs_h *g);\n"
7221 #: ../src/guestfs-actions.pod:1760 ../fish/guestfish-actions.pod:1319
7223 "This gets the memory size in megabytes allocated to the qemu subprocess."
7227 #: ../src/guestfs-actions.pod:1763
7229 "If C<guestfs_set_memsize> was not called on this handle, and if "
7230 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7231 "value for memsize."
7235 #: ../src/guestfs-actions.pod:1767 ../src/guestfs-actions.pod:1836
7236 #: ../src/guestfs-actions.pod:4759 ../src/guestfs-actions.pod:4856
7237 #: ../fish/guestfish-actions.pod:1326 ../fish/guestfish-actions.pod:1377
7238 #: ../fish/guestfish-actions.pod:3484 ../fish/guestfish-actions.pod:3571
7240 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7244 #: ../src/guestfs-actions.pod:1772
7245 msgid "guestfs_get_network"
7249 #: ../src/guestfs-actions.pod:1774
7253 " guestfs_get_network (guestfs_h *g);\n"
7258 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1333
7259 msgid "This returns the enable network flag."
7263 #: ../src/guestfs-actions.pod:1781
7264 msgid "guestfs_get_path"
7268 #: ../src/guestfs-actions.pod:1783
7272 " guestfs_get_path (guestfs_h *g);\n"
7277 #: ../src/guestfs-actions.pod:1786 ../fish/guestfish-actions.pod:1339
7278 msgid "Return the current search path."
7282 #: ../src/guestfs-actions.pod:1788 ../fish/guestfish-actions.pod:1341
7284 "This is always non-NULL. If it wasn't set already, then this will return "
7289 #: ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:1816
7291 "This function returns a string, or NULL on error. The string is owned by "
7292 "the guest handle and must I<not> be freed."
7296 #: ../src/guestfs-actions.pod:1794
7297 msgid "guestfs_get_pid"
7301 #: ../src/guestfs-actions.pod:1796
7305 " guestfs_get_pid (guestfs_h *g);\n"
7310 #: ../src/guestfs-actions.pod:1799 ../fish/guestfish-actions.pod:1350
7312 "Return the process ID of the qemu subprocess. If there is no qemu "
7313 "subprocess, then this will return an error."
7317 #: ../src/guestfs-actions.pod:1802 ../fish/guestfish-actions.pod:1353
7318 msgid "This is an internal call used for debugging and testing."
7322 #: ../src/guestfs-actions.pod:1806
7323 msgid "guestfs_get_qemu"
7327 #: ../src/guestfs-actions.pod:1808
7331 " guestfs_get_qemu (guestfs_h *g);\n"
7336 #: ../src/guestfs-actions.pod:1811 ../fish/guestfish-actions.pod:1359
7337 msgid "Return the current qemu binary."
7341 #: ../src/guestfs-actions.pod:1813 ../fish/guestfish-actions.pod:1361
7343 "This is always non-NULL. If it wasn't set already, then this will return "
7344 "the default qemu binary name."
7348 #: ../src/guestfs-actions.pod:1819
7349 msgid "guestfs_get_recovery_proc"
7353 #: ../src/guestfs-actions.pod:1821
7357 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7362 #: ../src/guestfs-actions.pod:1824 ../fish/guestfish-actions.pod:1368
7363 msgid "Return the recovery process enabled flag."
7367 #: ../src/guestfs-actions.pod:1828
7368 msgid "guestfs_get_selinux"
7372 #: ../src/guestfs-actions.pod:1830
7376 " guestfs_get_selinux (guestfs_h *g);\n"
7381 #: ../src/guestfs-actions.pod:1833
7383 "This returns the current setting of the selinux flag which is passed to the "
7384 "appliance at boot time. See C<guestfs_set_selinux>."
7388 #: ../src/guestfs-actions.pod:1841
7389 msgid "guestfs_get_state"
7393 #: ../src/guestfs-actions.pod:1843
7397 " guestfs_get_state (guestfs_h *g);\n"
7402 #: ../src/guestfs-actions.pod:1846 ../fish/guestfish-actions.pod:1384
7404 "This returns the current state as an opaque integer. This is only useful "
7405 "for printing debug and internal error messages."
7409 #: ../src/guestfs-actions.pod:1849 ../src/guestfs-actions.pod:2542
7410 #: ../src/guestfs-actions.pod:2567 ../src/guestfs-actions.pod:2620
7411 #: ../src/guestfs-actions.pod:2643 ../fish/guestfish-actions.pod:1387
7412 #: ../fish/guestfish-actions.pod:1917 ../fish/guestfish-actions.pod:1935
7413 #: ../fish/guestfish-actions.pod:1973 ../fish/guestfish-actions.pod:1989
7414 msgid "For more information on states, see L<guestfs(3)>."
7418 #: ../src/guestfs-actions.pod:1853
7419 msgid "guestfs_get_trace"
7423 #: ../src/guestfs-actions.pod:1855
7427 " guestfs_get_trace (guestfs_h *g);\n"
7432 #: ../src/guestfs-actions.pod:1858 ../fish/guestfish-actions.pod:1393
7433 msgid "Return the command trace flag."
7437 #: ../src/guestfs-actions.pod:1862
7438 msgid "guestfs_get_umask"
7442 #: ../src/guestfs-actions.pod:1864
7446 " guestfs_get_umask (guestfs_h *g);\n"
7451 #: ../src/guestfs-actions.pod:1867
7453 "Return the current umask. By default the umask is C<022> unless it has been "
7454 "set by calling C<guestfs_umask>."
7458 #: ../src/guestfs-actions.pod:1872
7459 msgid "guestfs_get_verbose"
7463 #: ../src/guestfs-actions.pod:1874
7467 " guestfs_get_verbose (guestfs_h *g);\n"
7472 #: ../src/guestfs-actions.pod:1877 ../fish/guestfish-actions.pod:1406
7473 msgid "This returns the verbose messages flag."
7477 #: ../src/guestfs-actions.pod:1881
7478 msgid "guestfs_getcon"
7482 #: ../src/guestfs-actions.pod:1883
7486 " guestfs_getcon (guestfs_h *g);\n"
7491 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1412
7492 msgid "This gets the SELinux security context of the daemon."
7496 #: ../src/guestfs-actions.pod:1888
7498 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
7502 #: ../src/guestfs-actions.pod:1894
7503 msgid "guestfs_getxattrs"
7507 #: ../src/guestfs-actions.pod:1896
7510 " struct guestfs_xattr_list *\n"
7511 " guestfs_getxattrs (guestfs_h *g,\n"
7512 " const char *path);\n"
7517 #: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1421
7519 "This call lists the extended attributes of the file or directory C<path>."
7523 #: ../src/guestfs-actions.pod:1903 ../fish/guestfish-actions.pod:1424
7525 "At the system call level, this is a combination of the L<listxattr(2)> and "
7526 "L<getxattr(2)> calls."
7530 #: ../src/guestfs-actions.pod:1906
7531 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
7535 #: ../src/guestfs-actions.pod:1908 ../src/guestfs-actions.pod:2723
7536 #: ../src/guestfs-actions.pod:3311
7538 "This function returns a C<struct guestfs_xattr_list *> (see E<lt>guestfs-"
7539 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
7540 "C<guestfs_free_xattr_list> after use>."
7544 #: ../src/guestfs-actions.pod:1913
7545 msgid "guestfs_glob_expand"
7549 #: ../src/guestfs-actions.pod:1915
7553 " guestfs_glob_expand (guestfs_h *g,\n"
7554 " const char *pattern);\n"
7559 #: ../src/guestfs-actions.pod:1919 ../fish/guestfish-actions.pod:1433
7561 "This command searches for all the pathnames matching C<pattern> according to "
7562 "the wildcard expansion rules used by the shell."
7566 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1437
7568 "If no paths match, then this returns an empty list (note: not an error)."
7572 #: ../src/guestfs-actions.pod:1926 ../fish/guestfish-actions.pod:1440
7574 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
7575 "GLOB_BRACE>. See that manual page for more details."
7579 #: ../src/guestfs-actions.pod:1934
7580 msgid "guestfs_grep"
7584 #: ../src/guestfs-actions.pod:1936
7588 " guestfs_grep (guestfs_h *g,\n"
7589 " const char *regex,\n"
7590 " const char *path);\n"
7595 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1448
7596 msgid "This calls the external C<grep> program and returns the matching lines."
7600 #: ../src/guestfs-actions.pod:1951
7601 msgid "guestfs_grepi"
7605 #: ../src/guestfs-actions.pod:1953
7609 " guestfs_grepi (guestfs_h *g,\n"
7610 " const char *regex,\n"
7611 " const char *path);\n"
7616 #: ../src/guestfs-actions.pod:1958 ../fish/guestfish-actions.pod:1458
7618 "This calls the external C<grep -i> program and returns the matching lines."
7622 #: ../src/guestfs-actions.pod:1968
7623 msgid "guestfs_grub_install"
7627 #: ../src/guestfs-actions.pod:1970
7631 " guestfs_grub_install (guestfs_h *g,\n"
7632 " const char *root,\n"
7633 " const char *device);\n"
7638 #: ../src/guestfs-actions.pod:1975 ../fish/guestfish-actions.pod:1468
7640 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
7641 "the root directory being C<root>."
7645 #: ../src/guestfs-actions.pod:1978 ../fish/guestfish-actions.pod:1471
7647 "Note: If grub-install reports the error \"No suitable drive was found in the "
7648 "generated device map.\" it may be that you need to create a C</boot/grub/"
7649 "device.map> file first that contains the mapping between grub device names "
7650 "and Linux device names. It is usually sufficient to create a file "
7655 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1478
7663 #: ../src/guestfs-actions.pod:1987 ../fish/guestfish-actions.pod:1480
7664 msgid "replacing C</dev/vda> with the name of the installation device."
7668 #: ../src/guestfs-actions.pod:1991
7669 msgid "guestfs_head"
7673 #: ../src/guestfs-actions.pod:1993
7677 " guestfs_head (guestfs_h *g,\n"
7678 " const char *path);\n"
7683 #: ../src/guestfs-actions.pod:1997 ../fish/guestfish-actions.pod:1486
7685 "This command returns up to the first 10 lines of a file as a list of strings."
7689 #: ../src/guestfs-actions.pod:2007
7690 msgid "guestfs_head_n"
7694 #: ../src/guestfs-actions.pod:2009
7698 " guestfs_head_n (guestfs_h *g,\n"
7700 " const char *path);\n"
7705 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1496
7707 "If the parameter C<nrlines> is a positive number, this returns the first "
7708 "C<nrlines> lines of the file C<path>."
7712 #: ../src/guestfs-actions.pod:2017 ../fish/guestfish-actions.pod:1499
7714 "If the parameter C<nrlines> is a negative number, this returns lines from "
7715 "the file C<path>, excluding the last C<nrlines> lines."
7719 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5340
7720 #: ../fish/guestfish-actions.pod:1502 ../fish/guestfish-actions.pod:3917
7721 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7725 #: ../src/guestfs-actions.pod:2029
7726 msgid "guestfs_hexdump"
7730 #: ../src/guestfs-actions.pod:2031
7734 " guestfs_hexdump (guestfs_h *g,\n"
7735 " const char *path);\n"
7740 #: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1511
7742 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
7743 "readable, canonical hex dump of the file."
7747 #: ../src/guestfs-actions.pod:2044
7748 msgid "guestfs_initrd_cat"
7752 #: ../src/guestfs-actions.pod:2046
7756 " guestfs_initrd_cat (guestfs_h *g,\n"
7757 " const char *initrdpath,\n"
7758 " const char *filename,\n"
7759 " size_t *size_r);\n"
7764 #: ../src/guestfs-actions.pod:2052 ../fish/guestfish-actions.pod:1521
7766 "This command unpacks the file C<filename> from the initrd file called "
7767 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7772 #: ../src/guestfs-actions.pod:2056 ../fish/guestfish-actions.pod:1525
7774 "For example, in guestfish you could use the following command to examine the "
7775 "boot script (usually called C</init>) contained in a Linux initrd or "
7780 #: ../src/guestfs-actions.pod:2060 ../fish/guestfish-actions.pod:1529
7783 " initrd-cat /boot/initrd-<version>.img init\n"
7788 #: ../src/guestfs-actions.pod:2062
7789 msgid "See also C<guestfs_initrd_list>."
7793 #: ../src/guestfs-actions.pod:2064 ../src/guestfs-actions.pod:4187
7794 #: ../src/guestfs-actions.pod:4211 ../src/guestfs-actions.pod:4373
7796 "This function returns a buffer, or NULL on error. The size of the returned "
7797 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
7802 #: ../src/guestfs-actions.pod:2071
7803 msgid "guestfs_initrd_list"
7807 #: ../src/guestfs-actions.pod:2073
7811 " guestfs_initrd_list (guestfs_h *g,\n"
7812 " const char *path);\n"
7817 #: ../src/guestfs-actions.pod:2077 ../fish/guestfish-actions.pod:1540
7818 msgid "This command lists out files contained in an initrd."
7822 #: ../src/guestfs-actions.pod:2079 ../fish/guestfish-actions.pod:1542
7824 "The files are listed without any initial C</> character. The files are "
7825 "listed in the order they appear (not necessarily alphabetical). Directory "
7826 "names are listed as separate items."
7830 #: ../src/guestfs-actions.pod:2083 ../fish/guestfish-actions.pod:1546
7832 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
7833 "initrd. We I<only> support the newer initramfs format (compressed cpio "
7838 #: ../src/guestfs-actions.pod:2091
7839 msgid "guestfs_inotify_add_watch"
7843 #: ../src/guestfs-actions.pod:2093
7847 " guestfs_inotify_add_watch (guestfs_h *g,\n"
7848 " const char *path,\n"
7854 #: ../src/guestfs-actions.pod:2098 ../fish/guestfish-actions.pod:1554
7855 msgid "Watch C<path> for the events listed in C<mask>."
7859 #: ../src/guestfs-actions.pod:2100 ../fish/guestfish-actions.pod:1556
7861 "Note that if C<path> is a directory then events within that directory are "
7862 "watched, but this does I<not> happen recursively (in subdirectories)."
7866 #: ../src/guestfs-actions.pod:2104 ../fish/guestfish-actions.pod:1560
7868 "Note for non-C or non-Linux callers: the inotify events are defined by the "
7869 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
7873 #: ../src/guestfs-actions.pod:2110
7874 msgid "guestfs_inotify_close"
7878 #: ../src/guestfs-actions.pod:2112
7882 " guestfs_inotify_close (guestfs_h *g);\n"
7887 #: ../src/guestfs-actions.pod:2115 ../fish/guestfish-actions.pod:1568
7889 "This closes the inotify handle which was previously opened by inotify_init. "
7890 "It removes all watches, throws away any pending events, and deallocates all "
7895 #: ../src/guestfs-actions.pod:2121
7896 msgid "guestfs_inotify_files"
7900 #: ../src/guestfs-actions.pod:2123
7904 " guestfs_inotify_files (guestfs_h *g);\n"
7909 #: ../src/guestfs-actions.pod:2126
7911 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
7912 "returns a list of pathnames of objects that were touched. The returned "
7913 "pathnames are sorted and deduplicated."
7917 #: ../src/guestfs-actions.pod:2134
7918 msgid "guestfs_inotify_init"
7922 #: ../src/guestfs-actions.pod:2136
7926 " guestfs_inotify_init (guestfs_h *g,\n"
7927 " int maxevents);\n"
7932 #: ../src/guestfs-actions.pod:2140 ../fish/guestfish-actions.pod:1584
7934 "This command creates a new inotify handle. The inotify subsystem can be "
7935 "used to notify events which happen to objects in the guest filesystem."
7939 #: ../src/guestfs-actions.pod:2144
7941 "C<maxevents> is the maximum number of events which will be queued up between "
7942 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
7943 "passed as C<0>, then the kernel (or previously set) default is used. For "
7944 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
7945 "throws away events, but records the fact that it threw them away by setting "
7946 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
7947 "C<guestfs_inotify_read>)."
7951 #: ../src/guestfs-actions.pod:2154
7953 "Before any events are generated, you have to add some watches to the "
7954 "internal watch list. See: C<guestfs_inotify_add_watch>, "
7955 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
7959 #: ../src/guestfs-actions.pod:2160
7961 "Queued up events should be read periodically by calling "
7962 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
7963 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
7964 "often enough then you risk the internal queue overflowing."
7968 #: ../src/guestfs-actions.pod:2167
7970 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
7971 "This also removes any watches automatically."
7975 #: ../src/guestfs-actions.pod:2171 ../fish/guestfish-actions.pod:1615
7977 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
7978 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
7979 "that there is one global inotify handle per libguestfs instance."
7983 #: ../src/guestfs-actions.pod:2178
7984 msgid "guestfs_inotify_read"
7988 #: ../src/guestfs-actions.pod:2180
7991 " struct guestfs_inotify_event_list *\n"
7992 " guestfs_inotify_read (guestfs_h *g);\n"
7997 #: ../src/guestfs-actions.pod:2183 ../fish/guestfish-actions.pod:1624
7999 "Return the complete queue of events that have happened since the previous "
8004 #: ../src/guestfs-actions.pod:2186 ../fish/guestfish-actions.pod:1627
8005 msgid "If no events have happened, this returns an empty list."
8009 #: ../src/guestfs-actions.pod:2188 ../fish/guestfish-actions.pod:1629
8011 "I<Note>: In order to make sure that all events have been read, you must call "
8012 "this function repeatedly until it returns an empty list. The reason is that "
8013 "the call will read events up to the maximum appliance-to-host message size "
8014 "and leave remaining events in the queue."
8018 #: ../src/guestfs-actions.pod:2194
8020 "This function returns a C<struct guestfs_inotify_event_list *> (see "
8021 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
8022 "must call C<guestfs_free_inotify_event_list> after use>."
8026 #: ../src/guestfs-actions.pod:2199
8027 msgid "guestfs_inotify_rm_watch"
8031 #: ../src/guestfs-actions.pod:2201
8035 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
8041 #: ../src/guestfs-actions.pod:2205
8043 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
8047 #: ../src/guestfs-actions.pod:2210
8048 msgid "guestfs_inspect_get_arch"
8052 #: ../src/guestfs-actions.pod:2212
8056 " guestfs_inspect_get_arch (guestfs_h *g,\n"
8057 " const char *root);\n"
8062 #: ../src/guestfs-actions.pod:2216 ../src/guestfs-actions.pod:2237
8063 #: ../src/guestfs-actions.pod:2308 ../src/guestfs-actions.pod:2332
8064 #: ../src/guestfs-actions.pod:2357 ../src/guestfs-actions.pod:2376
8065 #: ../src/guestfs-actions.pod:2407 ../src/guestfs-actions.pod:2429
8066 #: ../src/guestfs-actions.pod:2465
8068 "This function should only be called with a root device string as returned by "
8069 "C<guestfs_inspect_os>."
8073 #: ../src/guestfs-actions.pod:2219
8075 "This returns the architecture of the inspected operating system. The "
8076 "possible return values are listed under C<guestfs_file_architecture>."
8080 #: ../src/guestfs-actions.pod:2223 ../fish/guestfish-actions.pod:1653
8082 "If the architecture could not be determined, then the string C<unknown> is "
8087 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:2297
8088 #: ../src/guestfs-actions.pod:2347 ../src/guestfs-actions.pod:2418
8089 #: ../src/guestfs-actions.pod:2454 ../src/guestfs-actions.pod:2475
8090 #: ../src/guestfs-actions.pod:2513 ../fish/guestfish-actions.pod:1656
8091 #: ../fish/guestfish-actions.pod:1722 ../fish/guestfish-actions.pod:1761
8092 #: ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1847
8093 #: ../fish/guestfish-actions.pod:1863 ../fish/guestfish-actions.pod:1897
8094 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
8098 #: ../src/guestfs-actions.pod:2231
8099 msgid "guestfs_inspect_get_distro"
8103 #: ../src/guestfs-actions.pod:2233
8107 " guestfs_inspect_get_distro (guestfs_h *g,\n"
8108 " const char *root);\n"
8113 #: ../src/guestfs-actions.pod:2240 ../fish/guestfish-actions.pod:1665
8115 "This returns the distro (distribution) of the inspected operating system."
8119 #: ../src/guestfs-actions.pod:2243 ../fish/guestfish-actions.pod:1668
8120 msgid "Currently defined distros are:"
8124 #: ../src/guestfs-actions.pod:2247 ../fish/guestfish-actions.pod:1672
8125 msgid "\"archlinux\""
8129 #: ../src/guestfs-actions.pod:2249 ../fish/guestfish-actions.pod:1674
8134 #: ../src/guestfs-actions.pod:2251 ../fish/guestfish-actions.pod:1676
8139 #: ../src/guestfs-actions.pod:2253 ../fish/guestfish-actions.pod:1678
8140 msgid "Debian or a Debian-derived distro such as Ubuntu."
8144 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1680
8149 #: ../src/guestfs-actions.pod:2257 ../fish/guestfish-actions.pod:1682
8154 #: ../src/guestfs-actions.pod:2259 ../fish/guestfish-actions.pod:1684
8159 #: ../src/guestfs-actions.pod:2261 ../fish/guestfish-actions.pod:1686
8164 #: ../src/guestfs-actions.pod:2263 ../fish/guestfish-actions.pod:1688
8169 #: ../src/guestfs-actions.pod:2265 ../fish/guestfish-actions.pod:1690
8174 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1692
8179 #: ../src/guestfs-actions.pod:2269 ../fish/guestfish-actions.pod:1694
8184 #: ../src/guestfs-actions.pod:2271 ../fish/guestfish-actions.pod:1696
8185 msgid "\"redhat-based\""
8189 #: ../src/guestfs-actions.pod:2273 ../fish/guestfish-actions.pod:1698
8190 msgid "Some Red Hat-derived distro."
8194 #: ../src/guestfs-actions.pod:2275 ../fish/guestfish-actions.pod:1700
8199 #: ../src/guestfs-actions.pod:2277 ../fish/guestfish-actions.pod:1702
8200 msgid "Red Hat Enterprise Linux and some derivatives."
8204 #: ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2441
8205 #: ../fish/guestfish-actions.pod:1704 ../fish/guestfish-actions.pod:1834
8210 #: ../src/guestfs-actions.pod:2281 ../fish/guestfish-actions.pod:1706
8212 "Windows does not have distributions. This string is returned if the OS type "
8217 #: ../src/guestfs-actions.pod:2284 ../fish/guestfish-actions.pod:1709
8222 #: ../src/guestfs-actions.pod:2286 ../fish/guestfish-actions.pod:1711
8227 #: ../src/guestfs-actions.pod:2288 ../src/guestfs-actions.pod:2445
8228 #: ../fish/guestfish-actions.pod:1713 ../fish/guestfish-actions.pod:1838
8233 #: ../src/guestfs-actions.pod:2290 ../fish/guestfish-actions.pod:1715
8234 msgid "The distro could not be determined."
8238 #: ../src/guestfs-actions.pod:2294 ../src/guestfs-actions.pod:2451
8239 #: ../fish/guestfish-actions.pod:1719 ../fish/guestfish-actions.pod:1844
8241 "Future versions of libguestfs may return other strings here. The caller "
8242 "should be prepared to handle any string."
8246 #: ../src/guestfs-actions.pod:2302
8247 msgid "guestfs_inspect_get_filesystems"
8251 #: ../src/guestfs-actions.pod:2304
8255 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
8256 " const char *root);\n"
8261 #: ../src/guestfs-actions.pod:2311 ../fish/guestfish-actions.pod:1731
8263 "This returns a list of all the filesystems that we think are associated with "
8264 "this operating system. This includes the root filesystem, other ordinary "
8265 "filesystems, and non-mounted devices like swap partitions."
8269 #: ../src/guestfs-actions.pod:2316 ../fish/guestfish-actions.pod:1736
8271 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8272 "to be shared between operating systems."
8276 #: ../src/guestfs-actions.pod:2319
8278 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8279 "C<guestfs_inspect_get_mountpoints>."
8283 #: ../src/guestfs-actions.pod:2326
8284 msgid "guestfs_inspect_get_major_version"
8288 #: ../src/guestfs-actions.pod:2328
8292 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
8293 " const char *root);\n"
8298 #: ../src/guestfs-actions.pod:2335 ../fish/guestfish-actions.pod:1749
8300 "This returns the major version number of the inspected operating system."
8304 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1752
8306 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8307 "popular public names used by the operating system. Notably the operating "
8308 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8309 "1). You can find out the real versions corresponding to releases of Windows "
8310 "by consulting Wikipedia or MSDN."
8314 #: ../src/guestfs-actions.pod:2345 ../src/guestfs-actions.pod:2363
8315 #: ../fish/guestfish-actions.pod:1759 ../fish/guestfish-actions.pod:1773
8316 msgid "If the version could not be determined, then C<0> is returned."
8320 #: ../src/guestfs-actions.pod:2351
8321 msgid "guestfs_inspect_get_minor_version"
8325 #: ../src/guestfs-actions.pod:2353
8329 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
8330 " const char *root);\n"
8335 #: ../src/guestfs-actions.pod:2360 ../fish/guestfish-actions.pod:1770
8337 "This returns the minor version number of the inspected operating system."
8341 #: ../src/guestfs-actions.pod:2365
8343 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8344 "C<guestfs_inspect_get_major_version>."
8348 #: ../src/guestfs-actions.pod:2370
8349 msgid "guestfs_inspect_get_mountpoints"
8353 #: ../src/guestfs-actions.pod:2372
8357 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
8358 " const char *root);\n"
8363 #: ../src/guestfs-actions.pod:2379 ../fish/guestfish-actions.pod:1785
8365 "This returns a hash of where we think the filesystems associated with this "
8366 "operating system should be mounted. Callers should note that this is at "
8367 "best an educated guess made by reading configuration files such as C</etc/"
8372 #: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1790
8374 "Each element in the returned hashtable has a key which is the path of the "
8375 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8376 "mounted there (eg. C</dev/sda1>)."
8380 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1795
8382 "Non-mounted devices such as swap devices are I<not> returned in this list."
8386 #: ../src/guestfs-actions.pod:2392
8388 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8389 "C<guestfs_inspect_get_filesystems>."
8393 #: ../src/guestfs-actions.pod:2395 ../src/guestfs-actions.pod:2777
8394 #: ../src/guestfs-actions.pod:3790 ../src/guestfs-actions.pod:5465
8396 "This function returns a NULL-terminated array of strings, or NULL if there "
8397 "was an error. The array of strings will always have length C<2n+1>, where "
8398 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
8399 "caller must free the strings and the array after use>."
8403 #: ../src/guestfs-actions.pod:2401
8404 msgid "guestfs_inspect_get_product_name"
8408 #: ../src/guestfs-actions.pod:2403
8412 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
8413 " const char *root);\n"
8418 #: ../src/guestfs-actions.pod:2410 ../fish/guestfish-actions.pod:1808
8420 "This returns the product name of the inspected operating system. The "
8421 "product name is generally some freeform string which can be displayed to the "
8422 "user, but should not be parsed by programs."
8426 #: ../src/guestfs-actions.pod:2415 ../fish/guestfish-actions.pod:1813
8428 "If the product name could not be determined, then the string C<unknown> is "
8433 #: ../src/guestfs-actions.pod:2423
8434 msgid "guestfs_inspect_get_type"
8438 #: ../src/guestfs-actions.pod:2425
8442 " guestfs_inspect_get_type (guestfs_h *g,\n"
8443 " const char *root);\n"
8448 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1825
8450 "This returns the type of the inspected operating system. Currently defined "
8455 #: ../src/guestfs-actions.pod:2437 ../fish/guestfish-actions.pod:1830
8460 #: ../src/guestfs-actions.pod:2439 ../fish/guestfish-actions.pod:1832
8461 msgid "Any Linux-based operating system."
8465 #: ../src/guestfs-actions.pod:2443 ../fish/guestfish-actions.pod:1836
8466 msgid "Any Microsoft Windows operating system."
8470 #: ../src/guestfs-actions.pod:2447 ../fish/guestfish-actions.pod:1840
8471 msgid "The operating system type could not be determined."
8475 #: ../src/guestfs-actions.pod:2459
8476 msgid "guestfs_inspect_get_windows_systemroot"
8480 #: ../src/guestfs-actions.pod:2461
8484 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
8485 " const char *root);\n"
8490 #: ../src/guestfs-actions.pod:2468 ../fish/guestfish-actions.pod:1856
8492 "This returns the Windows systemroot of the inspected guest. The systemroot "
8493 "is a directory path such as C</WINDOWS>."
8497 #: ../src/guestfs-actions.pod:2471 ../fish/guestfish-actions.pod:1859
8499 "This call assumes that the guest is Windows and that the systemroot could be "
8500 "determined by inspection. If this is not the case then an error is returned."
8504 #: ../src/guestfs-actions.pod:2480
8505 msgid "guestfs_inspect_os"
8509 #: ../src/guestfs-actions.pod:2482
8513 " guestfs_inspect_os (guestfs_h *g);\n"
8518 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1869
8520 "This function uses other libguestfs functions and certain heuristics to "
8521 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
8522 "for operating systems."
8526 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1873
8527 msgid "The list returned is empty if no operating systems were found."
8531 #: ../src/guestfs-actions.pod:2491 ../fish/guestfish-actions.pod:1875
8533 "If one operating system was found, then this returns a list with a single "
8534 "element, which is the name of the root filesystem of this operating system. "
8535 "It is also possible for this function to return a list containing more than "
8536 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
8537 "element being the root filesystem of one of the operating systems."
8541 #: ../src/guestfs-actions.pod:2498
8543 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
8544 "functions in order to query further information about each operating system, "
8545 "such as the name and version."
8549 #: ../src/guestfs-actions.pod:2503
8551 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
8552 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
8553 "the contents. This should be called with no disks currently mounted. The "
8554 "function may also use Augeas, so any existing Augeas handle will be closed."
8558 #: ../src/guestfs-actions.pod:2509 ../fish/guestfish-actions.pod:1893
8560 "This function cannot decrypt encrypted disks. The caller must do that first "
8561 "(supplying the necessary keys) if the disk is encrypted."
8565 #: ../src/guestfs-actions.pod:2515 ../src/guestfs-actions.pod:2737
8566 #: ../src/guestfs-actions.pod:2795
8567 msgid "See also C<guestfs_list_filesystems>."
8571 #: ../src/guestfs-actions.pod:2521
8572 msgid "guestfs_is_blockdev"
8576 #: ../src/guestfs-actions.pod:2523
8580 " guestfs_is_blockdev (guestfs_h *g,\n"
8581 " const char *path);\n"
8586 #: ../src/guestfs-actions.pod:2527 ../fish/guestfish-actions.pod:1905
8588 "This returns C<true> if and only if there is a block device with the given "
8593 #: ../src/guestfs-actions.pod:2530 ../src/guestfs-actions.pod:2555
8594 #: ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:2594
8595 #: ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2656
8596 #: ../src/guestfs-actions.pod:2669
8597 msgid "See also C<guestfs_stat>."
8601 #: ../src/guestfs-actions.pod:2534
8602 msgid "guestfs_is_busy"
8606 #: ../src/guestfs-actions.pod:2536
8610 " guestfs_is_busy (guestfs_h *g);\n"
8615 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1914
8617 "This returns true iff this handle is busy processing a command (in the "
8622 #: ../src/guestfs-actions.pod:2546
8623 msgid "guestfs_is_chardev"
8627 #: ../src/guestfs-actions.pod:2548
8631 " guestfs_is_chardev (guestfs_h *g,\n"
8632 " const char *path);\n"
8637 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1923
8639 "This returns C<true> if and only if there is a character device with the "
8640 "given C<path> name."
8644 #: ../src/guestfs-actions.pod:2559
8645 msgid "guestfs_is_config"
8649 #: ../src/guestfs-actions.pod:2561
8653 " guestfs_is_config (guestfs_h *g);\n"
8658 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1932
8660 "This returns true iff this handle is being configured (in the C<CONFIG> "
8665 #: ../src/guestfs-actions.pod:2571
8666 msgid "guestfs_is_dir"
8670 #: ../src/guestfs-actions.pod:2573
8674 " guestfs_is_dir (guestfs_h *g,\n"
8675 " const char *path);\n"
8680 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1941
8682 "This returns C<true> if and only if there is a directory with the given "
8683 "C<path> name. Note that it returns false for other objects like files."
8687 #: ../src/guestfs-actions.pod:2585
8688 msgid "guestfs_is_fifo"
8692 #: ../src/guestfs-actions.pod:2587
8696 " guestfs_is_fifo (guestfs_h *g,\n"
8697 " const char *path);\n"
8702 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1951
8704 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
8705 "given C<path> name."
8709 #: ../src/guestfs-actions.pod:2598
8710 msgid "guestfs_is_file"
8714 #: ../src/guestfs-actions.pod:2600
8718 " guestfs_is_file (guestfs_h *g,\n"
8719 " const char *path);\n"
8724 #: ../src/guestfs-actions.pod:2604 ../fish/guestfish-actions.pod:1960
8726 "This returns C<true> if and only if there is a regular file with the given "
8727 "C<path> name. Note that it returns false for other objects like directories."
8731 #: ../src/guestfs-actions.pod:2612
8732 msgid "guestfs_is_launching"
8736 #: ../src/guestfs-actions.pod:2614
8740 " guestfs_is_launching (guestfs_h *g);\n"
8745 #: ../src/guestfs-actions.pod:2617 ../fish/guestfish-actions.pod:1970
8747 "This returns true iff this handle is launching the subprocess (in the "
8748 "C<LAUNCHING> state)."
8752 #: ../src/guestfs-actions.pod:2624
8753 msgid "guestfs_is_lv"
8757 #: ../src/guestfs-actions.pod:2626
8761 " guestfs_is_lv (guestfs_h *g,\n"
8762 " const char *device);\n"
8767 #: ../src/guestfs-actions.pod:2630 ../fish/guestfish-actions.pod:1979
8769 "This command tests whether C<device> is a logical volume, and returns true "
8770 "iff this is the case."
8774 #: ../src/guestfs-actions.pod:2635
8775 msgid "guestfs_is_ready"
8779 #: ../src/guestfs-actions.pod:2637
8783 " guestfs_is_ready (guestfs_h *g);\n"
8788 #: ../src/guestfs-actions.pod:2640 ../fish/guestfish-actions.pod:1986
8790 "This returns true iff this handle is ready to accept commands (in the "
8795 #: ../src/guestfs-actions.pod:2647
8796 msgid "guestfs_is_socket"
8800 #: ../src/guestfs-actions.pod:2649
8804 " guestfs_is_socket (guestfs_h *g,\n"
8805 " const char *path);\n"
8810 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1995
8812 "This returns C<true> if and only if there is a Unix domain socket with the "
8813 "given C<path> name."
8817 #: ../src/guestfs-actions.pod:2660
8818 msgid "guestfs_is_symlink"
8822 #: ../src/guestfs-actions.pod:2662
8826 " guestfs_is_symlink (guestfs_h *g,\n"
8827 " const char *path);\n"
8832 #: ../src/guestfs-actions.pod:2666 ../fish/guestfish-actions.pod:2004
8834 "This returns C<true> if and only if there is a symbolic link with the given "
8839 #: ../src/guestfs-actions.pod:2673
8840 msgid "guestfs_kill_subprocess"
8844 #: ../src/guestfs-actions.pod:2675
8848 " guestfs_kill_subprocess (guestfs_h *g);\n"
8853 #: ../src/guestfs-actions.pod:2678 ../fish/guestfish-actions.pod:2013
8854 msgid "This kills the qemu subprocess. You should never need to call this."
8858 #: ../src/guestfs-actions.pod:2682
8859 msgid "guestfs_launch"
8863 #: ../src/guestfs-actions.pod:2684
8867 " guestfs_launch (guestfs_h *g);\n"
8872 #: ../src/guestfs-actions.pod:2687 ../fish/guestfish-actions.pod:2021
8874 "Internally libguestfs is implemented by running a virtual machine using "
8879 #: ../src/guestfs-actions.pod:2690 ../fish/guestfish-actions.pod:2024
8881 "You should call this after configuring the handle (eg. adding drives) but "
8882 "before performing any actions."
8886 #: ../src/guestfs-actions.pod:2695
8887 msgid "guestfs_lchown"
8891 #: ../src/guestfs-actions.pod:2697
8895 " guestfs_lchown (guestfs_h *g,\n"
8898 " const char *path);\n"
8903 #: ../src/guestfs-actions.pod:2703
8905 "Change the file owner to C<owner> and group to C<group>. This is like "
8906 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
8907 "changed, not the target."
8911 #: ../src/guestfs-actions.pod:2713
8912 msgid "guestfs_lgetxattrs"
8916 #: ../src/guestfs-actions.pod:2715
8919 " struct guestfs_xattr_list *\n"
8920 " guestfs_lgetxattrs (guestfs_h *g,\n"
8921 " const char *path);\n"
8926 #: ../src/guestfs-actions.pod:2719
8928 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
8929 "then it returns the extended attributes of the link itself."
8933 #: ../src/guestfs-actions.pod:2728
8934 msgid "guestfs_list_devices"
8938 #: ../src/guestfs-actions.pod:2730
8942 " guestfs_list_devices (guestfs_h *g);\n"
8947 #: ../src/guestfs-actions.pod:2733 ../fish/guestfish-actions.pod:2051
8948 msgid "List all the block devices."
8952 #: ../src/guestfs-actions.pod:2735 ../fish/guestfish-actions.pod:2053
8953 msgid "The full block device names are returned, eg. C</dev/sda>."
8957 #: ../src/guestfs-actions.pod:2743
8958 msgid "guestfs_list_filesystems"
8962 #: ../src/guestfs-actions.pod:2745
8966 " guestfs_list_filesystems (guestfs_h *g);\n"
8971 #: ../src/guestfs-actions.pod:2748 ../fish/guestfish-actions.pod:2061
8973 "This inspection command looks for filesystems on partitions, block devices "
8974 "and logical volumes, returning a list of devices containing filesystems and "
8979 #: ../src/guestfs-actions.pod:2752 ../fish/guestfish-actions.pod:2065
8981 "The return value is a hash, where the keys are the devices containing "
8982 "filesystems, and the values are the filesystem types. For example:"
8986 #: ../src/guestfs-actions.pod:2756 ../fish/guestfish-actions.pod:2069
8989 " \"/dev/sda1\" => \"ntfs\"\n"
8990 " \"/dev/sda2\" => \"ext2\"\n"
8991 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
8992 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
8997 #: ../src/guestfs-actions.pod:2761 ../fish/guestfish-actions.pod:2074
8999 "The value can have the special value \"unknown\", meaning the content of the "
9000 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9004 #: ../src/guestfs-actions.pod:2765
9006 "This command runs other libguestfs commands, which might include "
9007 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
9008 "soon after launch and only when nothing is mounted."
9012 #: ../src/guestfs-actions.pod:2769
9014 "Not all of the filesystems returned will be mountable. In particular, swap "
9015 "partitions are returned in the list. Also this command does not check that "
9016 "each filesystem found is valid and mountable, and some filesystems might be "
9017 "mountable but require special options. Filesystems may not all belong to a "
9018 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
9022 #: ../src/guestfs-actions.pod:2783
9023 msgid "guestfs_list_partitions"
9027 #: ../src/guestfs-actions.pod:2785
9031 " guestfs_list_partitions (guestfs_h *g);\n"
9036 #: ../src/guestfs-actions.pod:2788 ../fish/guestfish-actions.pod:2094
9037 msgid "List all the partitions detected on all block devices."
9041 #: ../src/guestfs-actions.pod:2790 ../fish/guestfish-actions.pod:2096
9042 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9046 #: ../src/guestfs-actions.pod:2792
9048 "This does not return logical volumes. For that you will need to call "
9053 #: ../src/guestfs-actions.pod:2801
9058 #: ../src/guestfs-actions.pod:2803
9062 " guestfs_ll (guestfs_h *g,\n"
9063 " const char *directory);\n"
9068 #: ../src/guestfs-actions.pod:2807 ../fish/guestfish-actions.pod:2107
9070 "List the files in C<directory> (relative to the root directory, there is no "
9071 "cwd) in the format of 'ls -la'."
9075 #: ../src/guestfs-actions.pod:2810 ../fish/guestfish-actions.pod:2110
9077 "This command is mostly useful for interactive sessions. It is I<not> "
9078 "intended that you try to parse the output string."
9082 #: ../src/guestfs-actions.pod:2816
9087 #: ../src/guestfs-actions.pod:2818
9091 " guestfs_ln (guestfs_h *g,\n"
9092 " const char *target,\n"
9093 " const char *linkname);\n"
9098 #: ../src/guestfs-actions.pod:2823 ../fish/guestfish-actions.pod:2117
9099 msgid "This command creates a hard link using the C<ln> command."
9103 #: ../src/guestfs-actions.pod:2827
9104 msgid "guestfs_ln_f"
9108 #: ../src/guestfs-actions.pod:2829
9112 " guestfs_ln_f (guestfs_h *g,\n"
9113 " const char *target,\n"
9114 " const char *linkname);\n"
9119 #: ../src/guestfs-actions.pod:2834 ../fish/guestfish-actions.pod:2123
9121 "This command creates a hard link using the C<ln -f> command. The C<-f> "
9122 "option removes the link (C<linkname>) if it exists already."
9126 #: ../src/guestfs-actions.pod:2839
9127 msgid "guestfs_ln_s"
9131 #: ../src/guestfs-actions.pod:2841
9135 " guestfs_ln_s (guestfs_h *g,\n"
9136 " const char *target,\n"
9137 " const char *linkname);\n"
9142 #: ../src/guestfs-actions.pod:2846 ../fish/guestfish-actions.pod:2130
9143 msgid "This command creates a symbolic link using the C<ln -s> command."
9147 #: ../src/guestfs-actions.pod:2850
9148 msgid "guestfs_ln_sf"
9152 #: ../src/guestfs-actions.pod:2852
9156 " guestfs_ln_sf (guestfs_h *g,\n"
9157 " const char *target,\n"
9158 " const char *linkname);\n"
9163 #: ../src/guestfs-actions.pod:2857 ../fish/guestfish-actions.pod:2136
9165 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
9166 "option removes the link (C<linkname>) if it exists already."
9170 #: ../src/guestfs-actions.pod:2862
9171 msgid "guestfs_lremovexattr"
9175 #: ../src/guestfs-actions.pod:2864
9179 " guestfs_lremovexattr (guestfs_h *g,\n"
9180 " const char *xattr,\n"
9181 " const char *path);\n"
9186 #: ../src/guestfs-actions.pod:2869
9188 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
9189 "link, then it removes an extended attribute of the link itself."
9193 #: ../src/guestfs-actions.pod:2875
9198 #: ../src/guestfs-actions.pod:2877
9202 " guestfs_ls (guestfs_h *g,\n"
9203 " const char *directory);\n"
9208 #: ../src/guestfs-actions.pod:2881 ../fish/guestfish-actions.pod:2151
9210 "List the files in C<directory> (relative to the root directory, there is no "
9211 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
9215 #: ../src/guestfs-actions.pod:2885
9217 "This command is mostly useful for interactive sessions. Programs should "
9218 "probably use C<guestfs_readdir> instead."
9222 #: ../src/guestfs-actions.pod:2892
9223 msgid "guestfs_lsetxattr"
9227 #: ../src/guestfs-actions.pod:2894
9231 " guestfs_lsetxattr (guestfs_h *g,\n"
9232 " const char *xattr,\n"
9233 " const char *val,\n"
9235 " const char *path);\n"
9240 #: ../src/guestfs-actions.pod:2901
9242 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
9243 "then it sets an extended attribute of the link itself."
9247 #: ../src/guestfs-actions.pod:2907
9248 msgid "guestfs_lstat"
9252 #: ../src/guestfs-actions.pod:2909
9255 " struct guestfs_stat *\n"
9256 " guestfs_lstat (guestfs_h *g,\n"
9257 " const char *path);\n"
9262 #: ../src/guestfs-actions.pod:2913 ../src/guestfs-actions.pod:5108
9263 #: ../fish/guestfish-actions.pod:2170 ../fish/guestfish-actions.pod:3752
9264 msgid "Returns file information for the given C<path>."
9268 #: ../src/guestfs-actions.pod:2915
9270 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
9271 "link, then the link is stat-ed, not the file it refers to."
9275 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2176
9276 msgid "This is the same as the C<lstat(2)> system call."
9280 #: ../src/guestfs-actions.pod:2921 ../src/guestfs-actions.pod:5112
9282 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
9283 "error. I<The caller must call C<guestfs_free_stat> after use>."
9287 #: ../src/guestfs-actions.pod:2925
9288 msgid "guestfs_lstatlist"
9292 #: ../src/guestfs-actions.pod:2927
9295 " struct guestfs_stat_list *\n"
9296 " guestfs_lstatlist (guestfs_h *g,\n"
9297 " const char *path,\n"
9298 " char *const *names);\n"
9303 #: ../src/guestfs-actions.pod:2932
9305 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
9306 "files, where all files are in the directory C<path>. C<names> is the list "
9307 "of files from this directory."
9311 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2186
9313 "On return you get a list of stat structs, with a one-to-one correspondence "
9314 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9315 "then the C<ino> field of that structure is set to C<-1>."
9319 #: ../src/guestfs-actions.pod:2941
9321 "This call is intended for programs that want to efficiently list a directory "
9322 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
9323 "for a similarly efficient call for getting extended attributes. Very long "
9324 "directory listings might cause the protocol message size to be exceeded, "
9325 "causing this call to fail. The caller must split up such requests into "
9326 "smaller groups of names."
9330 #: ../src/guestfs-actions.pod:2949
9332 "This function returns a C<struct guestfs_stat_list *> (see E<lt>guestfs-"
9333 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
9334 "C<guestfs_free_stat_list> after use>."
9338 #: ../src/guestfs-actions.pod:2954
9339 msgid "guestfs_luks_add_key"
9343 #: ../src/guestfs-actions.pod:2956
9347 " guestfs_luks_add_key (guestfs_h *g,\n"
9348 " const char *device,\n"
9349 " const char *key,\n"
9350 " const char *newkey,\n"
9356 #: ../src/guestfs-actions.pod:2963 ../fish/guestfish-actions.pod:2203
9358 "This command adds a new key on LUKS device C<device>. C<key> is any "
9359 "existing key, and is used to access the device. C<newkey> is the new key to "
9360 "add. C<keyslot> is the key slot that will be replaced."
9364 #: ../src/guestfs-actions.pod:2968
9366 "Note that if C<keyslot> already contains a key, then this command will "
9367 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
9371 #: ../src/guestfs-actions.pod:2974 ../src/guestfs-actions.pod:3010
9372 #: ../src/guestfs-actions.pod:3031 ../src/guestfs-actions.pod:3049
9373 #: ../src/guestfs-actions.pod:3079 ../src/guestfs-actions.pod:3096
9375 "This function takes a key or passphrase parameter which could contain "
9376 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
9381 #: ../src/guestfs-actions.pod:2978
9382 msgid "guestfs_luks_close"
9386 #: ../src/guestfs-actions.pod:2980
9390 " guestfs_luks_close (guestfs_h *g,\n"
9391 " const char *device);\n"
9396 #: ../src/guestfs-actions.pod:2984
9398 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
9399 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
9400 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
9401 "underlying block device."
9405 #: ../src/guestfs-actions.pod:2992
9406 msgid "guestfs_luks_format"
9410 #: ../src/guestfs-actions.pod:2994
9414 " guestfs_luks_format (guestfs_h *g,\n"
9415 " const char *device,\n"
9416 " const char *key,\n"
9422 #: ../src/guestfs-actions.pod:3000 ../fish/guestfish-actions.pod:2229
9424 "This command erases existing data on C<device> and formats the device as a "
9425 "LUKS encrypted device. C<key> is the initial key, which is added to key "
9426 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
9430 #: ../src/guestfs-actions.pod:3007 ../src/guestfs-actions.pod:3028
9431 #: ../src/guestfs-actions.pod:3154 ../src/guestfs-actions.pod:3926
9432 #: ../src/guestfs-actions.pod:4622 ../src/guestfs-actions.pod:4961
9433 #: ../src/guestfs-actions.pod:4982 ../src/guestfs-actions.pod:5006
9434 #: ../src/guestfs-actions.pod:6033 ../fish/guestfish-actions.pod:2237
9435 #: ../fish/guestfish-actions.pod:2250 ../fish/guestfish-actions.pod:2334
9436 #: ../fish/guestfish-actions.pod:2864 ../fish/guestfish-actions.pod:3371
9437 #: ../fish/guestfish-actions.pod:3651 ../fish/guestfish-actions.pod:3667
9438 #: ../fish/guestfish-actions.pod:3682 ../fish/guestfish-actions.pod:4397
9440 "B<This command is dangerous. Without careful use you can easily destroy all "
9445 #: ../src/guestfs-actions.pod:3014
9446 msgid "guestfs_luks_format_cipher"
9450 #: ../src/guestfs-actions.pod:3016
9454 " guestfs_luks_format_cipher (guestfs_h *g,\n"
9455 " const char *device,\n"
9456 " const char *key,\n"
9458 " const char *cipher);\n"
9463 #: ../src/guestfs-actions.pod:3023
9465 "This command is the same as C<guestfs_luks_format> but it also allows you to "
9466 "set the C<cipher> used."
9470 #: ../src/guestfs-actions.pod:3035
9471 msgid "guestfs_luks_kill_slot"
9475 #: ../src/guestfs-actions.pod:3037
9479 " guestfs_luks_kill_slot (guestfs_h *g,\n"
9480 " const char *device,\n"
9481 " const char *key,\n"
9487 #: ../src/guestfs-actions.pod:3043 ../fish/guestfish-actions.pod:2257
9489 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
9490 "device C<device>. C<key> must be one of the I<other> keys."
9494 #: ../src/guestfs-actions.pod:3053
9495 msgid "guestfs_luks_open"
9499 #: ../src/guestfs-actions.pod:3055
9503 " guestfs_luks_open (guestfs_h *g,\n"
9504 " const char *device,\n"
9505 " const char *key,\n"
9506 " const char *mapname);\n"
9511 #: ../src/guestfs-actions.pod:3061 ../fish/guestfish-actions.pod:2268
9513 "This command opens a block device which has been encrypted according to the "
9514 "Linux Unified Key Setup (LUKS) standard."
9518 #: ../src/guestfs-actions.pod:3064 ../fish/guestfish-actions.pod:2271
9519 msgid "C<device> is the encrypted block device or partition."
9523 #: ../src/guestfs-actions.pod:3066 ../fish/guestfish-actions.pod:2273
9525 "The caller must supply one of the keys associated with the LUKS block "
9526 "device, in the C<key> parameter."
9530 #: ../src/guestfs-actions.pod:3069 ../fish/guestfish-actions.pod:2276
9532 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
9533 "writes to this block device are decrypted from and encrypted to the "
9534 "underlying C<device> respectively."
9538 #: ../src/guestfs-actions.pod:3073
9540 "If this block device contains LVM volume groups, then calling "
9541 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
9546 #: ../src/guestfs-actions.pod:3083
9547 msgid "guestfs_luks_open_ro"
9551 #: ../src/guestfs-actions.pod:3085
9555 " guestfs_luks_open_ro (guestfs_h *g,\n"
9556 " const char *device,\n"
9557 " const char *key,\n"
9558 " const char *mapname);\n"
9563 #: ../src/guestfs-actions.pod:3091
9565 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
9570 #: ../src/guestfs-actions.pod:3100
9571 msgid "guestfs_lvcreate"
9575 #: ../src/guestfs-actions.pod:3102
9579 " guestfs_lvcreate (guestfs_h *g,\n"
9580 " const char *logvol,\n"
9581 " const char *volgroup,\n"
9587 #: ../src/guestfs-actions.pod:3108 ../fish/guestfish-actions.pod:2301
9589 "This creates an LVM logical volume called C<logvol> on the volume group "
9590 "C<volgroup>, with C<size> megabytes."
9594 #: ../src/guestfs-actions.pod:3113
9595 msgid "guestfs_lvm_canonical_lv_name"
9599 #: ../src/guestfs-actions.pod:3115
9603 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
9604 " const char *lvname);\n"
9609 #: ../src/guestfs-actions.pod:3119 ../fish/guestfish-actions.pod:2308
9611 "This converts alternative naming schemes for LVs that you might find to the "
9612 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
9617 #: ../src/guestfs-actions.pod:3123 ../fish/guestfish-actions.pod:2312
9619 "This command returns an error if the C<lvname> parameter does not refer to a "
9624 #: ../src/guestfs-actions.pod:3126
9625 msgid "See also C<guestfs_is_lv>."
9629 #: ../src/guestfs-actions.pod:3131
9630 msgid "guestfs_lvm_clear_filter"
9634 #: ../src/guestfs-actions.pod:3133
9638 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
9643 #: ../src/guestfs-actions.pod:3136
9645 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
9646 "see every block device."
9650 #: ../src/guestfs-actions.pod:3139 ../src/guestfs-actions.pod:3177
9651 #: ../fish/guestfish-actions.pod:2324 ../fish/guestfish-actions.pod:2355
9653 "This command also clears the LVM cache and performs a volume group scan."
9657 #: ../src/guestfs-actions.pod:3144
9658 msgid "guestfs_lvm_remove_all"
9662 #: ../src/guestfs-actions.pod:3146
9666 " guestfs_lvm_remove_all (guestfs_h *g);\n"
9671 #: ../src/guestfs-actions.pod:3149 ../fish/guestfish-actions.pod:2331
9673 "This command removes all LVM logical volumes, volume groups and physical "
9678 #: ../src/guestfs-actions.pod:3157
9679 msgid "guestfs_lvm_set_filter"
9683 #: ../src/guestfs-actions.pod:3159
9687 " guestfs_lvm_set_filter (guestfs_h *g,\n"
9688 " char *const *devices);\n"
9693 #: ../src/guestfs-actions.pod:3163 ../fish/guestfish-actions.pod:2341
9695 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
9696 "block devices in the list C<devices>, and will ignore all other attached "
9701 #: ../src/guestfs-actions.pod:3167 ../fish/guestfish-actions.pod:2345
9703 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
9704 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
9705 "there are two types of duplication possible: either cloned PVs/VGs which "
9706 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
9707 "same name. In normal operation you cannot create this situation, but you "
9708 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
9709 "inside the LVM metadata."
9713 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2358
9714 msgid "You can filter whole block devices or individual partitions."
9718 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2360
9720 "You cannot use this if any VG is currently in use (eg. contains a mounted "
9721 "filesystem), even if you are not filtering out that VG."
9725 #: ../src/guestfs-actions.pod:3188
9726 msgid "guestfs_lvremove"
9730 #: ../src/guestfs-actions.pod:3190
9734 " guestfs_lvremove (guestfs_h *g,\n"
9735 " const char *device);\n"
9740 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2368
9742 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
9743 "LV, such as C</dev/VG/LV>."
9747 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2371
9749 "You can also remove all LVs in a volume group by specifying the VG name, C</"
9754 #: ../src/guestfs-actions.pod:3202
9755 msgid "guestfs_lvrename"
9759 #: ../src/guestfs-actions.pod:3204
9763 " guestfs_lvrename (guestfs_h *g,\n"
9764 " const char *logvol,\n"
9765 " const char *newlogvol);\n"
9770 #: ../src/guestfs-actions.pod:3209 ../fish/guestfish-actions.pod:2378
9771 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
9775 #: ../src/guestfs-actions.pod:3213
9776 msgid "guestfs_lvresize"
9780 #: ../src/guestfs-actions.pod:3215
9784 " guestfs_lvresize (guestfs_h *g,\n"
9785 " const char *device,\n"
9791 #: ../src/guestfs-actions.pod:3220 ../fish/guestfish-actions.pod:2384
9793 "This resizes (expands or shrinks) an existing LVM logical volume to "
9794 "C<mbytes>. When reducing, data in the reduced part is lost."
9798 #: ../src/guestfs-actions.pod:3226
9799 msgid "guestfs_lvresize_free"
9803 #: ../src/guestfs-actions.pod:3228
9807 " guestfs_lvresize_free (guestfs_h *g,\n"
9808 " const char *lv,\n"
9814 #: ../src/guestfs-actions.pod:3233 ../fish/guestfish-actions.pod:2392
9816 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
9817 "remaining free space in the volume group. Commonly you would call this with "
9818 "pc = 100 which expands the logical volume as much as possible, using all "
9819 "remaining free space in the volume group."
9823 #: ../src/guestfs-actions.pod:3241
9828 #: ../src/guestfs-actions.pod:3243
9832 " guestfs_lvs (guestfs_h *g);\n"
9837 #: ../src/guestfs-actions.pod:3246 ../fish/guestfish-actions.pod:2402
9839 "List all the logical volumes detected. This is the equivalent of the L<lvs"
9844 #: ../src/guestfs-actions.pod:3249 ../fish/guestfish-actions.pod:2405
9846 "This returns a list of the logical volume device names (eg. C</dev/"
9847 "VolGroup00/LogVol00>)."
9851 #: ../src/guestfs-actions.pod:3252
9852 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
9856 #: ../src/guestfs-actions.pod:3258
9857 msgid "guestfs_lvs_full"
9861 #: ../src/guestfs-actions.pod:3260
9864 " struct guestfs_lvm_lv_list *\n"
9865 " guestfs_lvs_full (guestfs_h *g);\n"
9870 #: ../src/guestfs-actions.pod:3263 ../fish/guestfish-actions.pod:2414
9872 "List all the logical volumes detected. This is the equivalent of the L<lvs"
9873 "(8)> command. The \"full\" version includes all fields."
9877 #: ../src/guestfs-actions.pod:3266
9879 "This function returns a C<struct guestfs_lvm_lv_list *> (see E<lt>guestfs-"
9880 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
9881 "C<guestfs_free_lvm_lv_list> after use>."
9885 #: ../src/guestfs-actions.pod:3271
9886 msgid "guestfs_lvuuid"
9890 #: ../src/guestfs-actions.pod:3273
9894 " guestfs_lvuuid (guestfs_h *g,\n"
9895 " const char *device);\n"
9900 #: ../src/guestfs-actions.pod:3277 ../fish/guestfish-actions.pod:2421
9901 msgid "This command returns the UUID of the LVM LV C<device>."
9905 #: ../src/guestfs-actions.pod:3282
9906 msgid "guestfs_lxattrlist"
9910 #: ../src/guestfs-actions.pod:3284
9913 " struct guestfs_xattr_list *\n"
9914 " guestfs_lxattrlist (guestfs_h *g,\n"
9915 " const char *path,\n"
9916 " char *const *names);\n"
9921 #: ../src/guestfs-actions.pod:3289 ../fish/guestfish-actions.pod:2427
9923 "This call allows you to get the extended attributes of multiple files, where "
9924 "all files are in the directory C<path>. C<names> is the list of files from "
9929 #: ../src/guestfs-actions.pod:3293 ../fish/guestfish-actions.pod:2431
9931 "On return you get a flat list of xattr structs which must be interpreted "
9932 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
9933 "C<attrval> in this struct is zero-length to indicate there was an error "
9934 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
9935 "number (the number of following attributes for this file, which could be C<"
9936 "\"0\">). Then after the first xattr struct are the zero or more attributes "
9937 "for the first named file. This repeats for the second and subsequent files."
9941 #: ../src/guestfs-actions.pod:3303
9943 "This call is intended for programs that want to efficiently list a directory "
9944 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
9945 "a similarly efficient call for getting standard stats. Very long directory "
9946 "listings might cause the protocol message size to be exceeded, causing this "
9947 "call to fail. The caller must split up such requests into smaller groups of "
9952 #: ../src/guestfs-actions.pod:3316
9953 msgid "guestfs_mkdir"
9957 #: ../src/guestfs-actions.pod:3318
9961 " guestfs_mkdir (guestfs_h *g,\n"
9962 " const char *path);\n"
9967 #: ../src/guestfs-actions.pod:3322 ../fish/guestfish-actions.pod:2453
9968 msgid "Create a directory named C<path>."
9972 #: ../src/guestfs-actions.pod:3326
9973 msgid "guestfs_mkdir_mode"
9977 #: ../src/guestfs-actions.pod:3328
9981 " guestfs_mkdir_mode (guestfs_h *g,\n"
9982 " const char *path,\n"
9988 #: ../src/guestfs-actions.pod:3333 ../fish/guestfish-actions.pod:2459
9990 "This command creates a directory, setting the initial permissions of the "
9991 "directory to C<mode>."
9995 #: ../src/guestfs-actions.pod:3336 ../fish/guestfish-actions.pod:2462
9997 "For common Linux filesystems, the actual mode which is set will be C<mode & "
9998 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
10003 #: ../src/guestfs-actions.pod:3340
10004 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
10008 #: ../src/guestfs-actions.pod:3344
10009 msgid "guestfs_mkdir_p"
10013 #: ../src/guestfs-actions.pod:3346
10017 " guestfs_mkdir_p (guestfs_h *g,\n"
10018 " const char *path);\n"
10023 #: ../src/guestfs-actions.pod:3350 ../fish/guestfish-actions.pod:2472
10025 "Create a directory named C<path>, creating any parent directories as "
10026 "necessary. This is like the C<mkdir -p> shell command."
10030 #: ../src/guestfs-actions.pod:3355
10031 msgid "guestfs_mkdtemp"
10035 #: ../src/guestfs-actions.pod:3357
10039 " guestfs_mkdtemp (guestfs_h *g,\n"
10040 " const char *template);\n"
10045 #: ../src/guestfs-actions.pod:3361 ../fish/guestfish-actions.pod:2479
10047 "This command creates a temporary directory. The C<template> parameter "
10048 "should be a full pathname for the temporary directory name with the final "
10049 "six characters being \"XXXXXX\"."
10053 #: ../src/guestfs-actions.pod:3366 ../fish/guestfish-actions.pod:2484
10055 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10056 "being suitable for Windows filesystems."
10060 #: ../src/guestfs-actions.pod:3369 ../fish/guestfish-actions.pod:2487
10061 msgid "The name of the temporary directory that was created is returned."
10065 #: ../src/guestfs-actions.pod:3372 ../fish/guestfish-actions.pod:2490
10066 msgid "The temporary directory is created with mode 0700 and is owned by root."
10070 #: ../src/guestfs-actions.pod:3375 ../fish/guestfish-actions.pod:2493
10072 "The caller is responsible for deleting the temporary directory and its "
10073 "contents after use."
10077 #: ../src/guestfs-actions.pod:3378 ../fish/guestfish-actions.pod:2496
10078 msgid "See also: L<mkdtemp(3)>"
10082 #: ../src/guestfs-actions.pod:3383
10083 msgid "guestfs_mke2fs_J"
10087 #: ../src/guestfs-actions.pod:3385
10091 " guestfs_mke2fs_J (guestfs_h *g,\n"
10092 " const char *fstype,\n"
10093 " int blocksize,\n"
10094 " const char *device,\n"
10095 " const char *journal);\n"
10100 #: ../src/guestfs-actions.pod:3392 ../fish/guestfish-actions.pod:2502
10102 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10103 "C<journal>. It is equivalent to the command:"
10107 #: ../src/guestfs-actions.pod:3396 ../fish/guestfish-actions.pod:2506
10110 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10115 #: ../src/guestfs-actions.pod:3398
10116 msgid "See also C<guestfs_mke2journal>."
10120 #: ../src/guestfs-actions.pod:3402
10121 msgid "guestfs_mke2fs_JL"
10125 #: ../src/guestfs-actions.pod:3404
10129 " guestfs_mke2fs_JL (guestfs_h *g,\n"
10130 " const char *fstype,\n"
10131 " int blocksize,\n"
10132 " const char *device,\n"
10133 " const char *label);\n"
10138 #: ../src/guestfs-actions.pod:3411 ../fish/guestfish-actions.pod:2514
10140 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10141 "the journal labeled C<label>."
10145 #: ../src/guestfs-actions.pod:3414
10146 msgid "See also C<guestfs_mke2journal_L>."
10150 #: ../src/guestfs-actions.pod:3418
10151 msgid "guestfs_mke2fs_JU"
10155 #: ../src/guestfs-actions.pod:3420
10159 " guestfs_mke2fs_JU (guestfs_h *g,\n"
10160 " const char *fstype,\n"
10161 " int blocksize,\n"
10162 " const char *device,\n"
10163 " const char *uuid);\n"
10168 #: ../src/guestfs-actions.pod:3427 ../fish/guestfish-actions.pod:2523
10170 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10171 "the journal with UUID C<uuid>."
10175 #: ../src/guestfs-actions.pod:3430
10176 msgid "See also C<guestfs_mke2journal_U>."
10180 #: ../src/guestfs-actions.pod:3434
10181 msgid "guestfs_mke2journal"
10185 #: ../src/guestfs-actions.pod:3436
10189 " guestfs_mke2journal (guestfs_h *g,\n"
10190 " int blocksize,\n"
10191 " const char *device);\n"
10196 #: ../src/guestfs-actions.pod:3441 ../fish/guestfish-actions.pod:2532
10198 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10203 #: ../src/guestfs-actions.pod:3444 ../fish/guestfish-actions.pod:2535
10206 " mke2fs -O journal_dev -b blocksize device\n"
10211 #: ../src/guestfs-actions.pod:3448
10212 msgid "guestfs_mke2journal_L"
10216 #: ../src/guestfs-actions.pod:3450
10220 " guestfs_mke2journal_L (guestfs_h *g,\n"
10221 " int blocksize,\n"
10222 " const char *label,\n"
10223 " const char *device);\n"
10228 #: ../src/guestfs-actions.pod:3456 ../fish/guestfish-actions.pod:2541
10229 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10233 #: ../src/guestfs-actions.pod:3460
10234 msgid "guestfs_mke2journal_U"
10238 #: ../src/guestfs-actions.pod:3462
10242 " guestfs_mke2journal_U (guestfs_h *g,\n"
10243 " int blocksize,\n"
10244 " const char *uuid,\n"
10245 " const char *device);\n"
10250 #: ../src/guestfs-actions.pod:3468 ../fish/guestfish-actions.pod:2547
10251 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10255 #: ../src/guestfs-actions.pod:3472
10256 msgid "guestfs_mkfifo"
10260 #: ../src/guestfs-actions.pod:3474
10264 " guestfs_mkfifo (guestfs_h *g,\n"
10266 " const char *path);\n"
10271 #: ../src/guestfs-actions.pod:3479
10273 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10274 "is just a convenient wrapper around C<guestfs_mknod>."
10278 #: ../src/guestfs-actions.pod:3487
10279 msgid "guestfs_mkfs"
10283 #: ../src/guestfs-actions.pod:3489
10287 " guestfs_mkfs (guestfs_h *g,\n"
10288 " const char *fstype,\n"
10289 " const char *device);\n"
10294 #: ../src/guestfs-actions.pod:3494 ../fish/guestfish-actions.pod:2563
10296 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10297 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10301 #: ../src/guestfs-actions.pod:3500
10302 msgid "guestfs_mkfs_b"
10306 #: ../src/guestfs-actions.pod:3502
10310 " guestfs_mkfs_b (guestfs_h *g,\n"
10311 " const char *fstype,\n"
10312 " int blocksize,\n"
10313 " const char *device);\n"
10318 #: ../src/guestfs-actions.pod:3508
10320 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
10321 "block size of the resulting filesystem. Supported block sizes depend on the "
10322 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10326 #: ../src/guestfs-actions.pod:3513 ../fish/guestfish-actions.pod:2576
10328 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10333 #: ../src/guestfs-actions.pod:3518
10334 msgid "guestfs_mkmountpoint"
10338 #: ../src/guestfs-actions.pod:3520
10342 " guestfs_mkmountpoint (guestfs_h *g,\n"
10343 " const char *exemptpath);\n"
10348 #: ../src/guestfs-actions.pod:3524
10350 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
10351 "that can be used to create extra mountpoints before mounting the first "
10356 #: ../src/guestfs-actions.pod:3528 ../fish/guestfish-actions.pod:2587
10358 "These calls are I<only> necessary in some very limited circumstances, mainly "
10359 "the case where you want to mount a mix of unrelated and/or read-only "
10360 "filesystems together."
10364 #: ../src/guestfs-actions.pod:3532 ../fish/guestfish-actions.pod:2591
10366 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10367 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10368 "inside that. You can unpack this as follows in guestfish:"
10372 #: ../src/guestfs-actions.pod:3537 ../fish/guestfish-actions.pod:2596
10375 " add-ro Fedora-11-i686-Live.iso\n"
10377 " mkmountpoint /cd\n"
10378 " mkmountpoint /sqsh\n"
10379 " mkmountpoint /ext3fs\n"
10380 " mount /dev/sda /cd\n"
10381 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10382 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10387 #: ../src/guestfs-actions.pod:3546 ../fish/guestfish-actions.pod:2605
10388 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
10392 #: ../src/guestfs-actions.pod:3548
10394 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
10395 "may get unexpected errors if you try to mix these calls. It is safest to "
10396 "manually unmount filesystems and remove mountpoints after use."
10400 #: ../src/guestfs-actions.pod:3552
10402 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
10403 "first, so for this to work for manual mountpoints, you must ensure that the "
10404 "innermost mountpoints have the longest pathnames, as in the example code "
10409 #: ../src/guestfs-actions.pod:3557 ../fish/guestfish-actions.pod:2616
10411 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
10415 #: ../src/guestfs-actions.pod:3559
10417 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
10418 "means that C<guestfs_umount_all> is called when the handle is closed which "
10419 "can also trigger these issues."
10423 #: ../src/guestfs-actions.pod:3565
10424 msgid "guestfs_mknod"
10428 #: ../src/guestfs-actions.pod:3567
10432 " guestfs_mknod (guestfs_h *g,\n"
10436 " const char *path);\n"
10441 #: ../src/guestfs-actions.pod:3574 ../fish/guestfish-actions.pod:2626
10443 "This call creates block or character special devices, or named pipes (FIFOs)."
10447 #: ../src/guestfs-actions.pod:3577 ../fish/guestfish-actions.pod:2629
10449 "The C<mode> parameter should be the mode, using the standard constants. "
10450 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
10451 "used when creating block and character special devices."
10455 #: ../src/guestfs-actions.pod:3582
10457 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
10458 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
10459 "regular file). These constants are available in the standard Linux header "
10460 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
10461 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
10462 "the appropriate constant for you."
10466 #: ../src/guestfs-actions.pod:3594
10467 msgid "guestfs_mknod_b"
10471 #: ../src/guestfs-actions.pod:3596
10475 " guestfs_mknod_b (guestfs_h *g,\n"
10479 " const char *path);\n"
10484 #: ../src/guestfs-actions.pod:3603
10486 "This call creates a block device node called C<path> with mode C<mode> and "
10487 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10488 "wrapper around C<guestfs_mknod>."
10492 #: ../src/guestfs-actions.pod:3611
10493 msgid "guestfs_mknod_c"
10497 #: ../src/guestfs-actions.pod:3613
10501 " guestfs_mknod_c (guestfs_h *g,\n"
10505 " const char *path);\n"
10510 #: ../src/guestfs-actions.pod:3620
10512 "This call creates a char device node called C<path> with mode C<mode> and "
10513 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10514 "wrapper around C<guestfs_mknod>."
10518 #: ../src/guestfs-actions.pod:3628
10519 msgid "guestfs_mkswap"
10523 #: ../src/guestfs-actions.pod:3630
10527 " guestfs_mkswap (guestfs_h *g,\n"
10528 " const char *device);\n"
10533 #: ../src/guestfs-actions.pod:3634 ../fish/guestfish-actions.pod:2668
10534 msgid "Create a swap partition on C<device>."
10538 #: ../src/guestfs-actions.pod:3638
10539 msgid "guestfs_mkswap_L"
10543 #: ../src/guestfs-actions.pod:3640
10547 " guestfs_mkswap_L (guestfs_h *g,\n"
10548 " const char *label,\n"
10549 " const char *device);\n"
10554 #: ../src/guestfs-actions.pod:3645 ../fish/guestfish-actions.pod:2674
10555 msgid "Create a swap partition on C<device> with label C<label>."
10559 #: ../src/guestfs-actions.pod:3647 ../fish/guestfish-actions.pod:2676
10561 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
10562 "sda>), just to a partition. This appears to be a limitation of the kernel "
10567 #: ../src/guestfs-actions.pod:3653
10568 msgid "guestfs_mkswap_U"
10572 #: ../src/guestfs-actions.pod:3655
10576 " guestfs_mkswap_U (guestfs_h *g,\n"
10577 " const char *uuid,\n"
10578 " const char *device);\n"
10583 #: ../src/guestfs-actions.pod:3660 ../fish/guestfish-actions.pod:2684
10584 msgid "Create a swap partition on C<device> with UUID C<uuid>."
10588 #: ../src/guestfs-actions.pod:3664
10589 msgid "guestfs_mkswap_file"
10593 #: ../src/guestfs-actions.pod:3666
10597 " guestfs_mkswap_file (guestfs_h *g,\n"
10598 " const char *path);\n"
10603 #: ../src/guestfs-actions.pod:3670 ../fish/guestfish-actions.pod:2690
10604 msgid "Create a swap file."
10608 #: ../src/guestfs-actions.pod:3672
10610 "This command just writes a swap file signature to an existing file. To "
10611 "create the file itself, use something like C<guestfs_fallocate>."
10615 #: ../src/guestfs-actions.pod:3677
10616 msgid "guestfs_modprobe"
10620 #: ../src/guestfs-actions.pod:3679
10624 " guestfs_modprobe (guestfs_h *g,\n"
10625 " const char *modulename);\n"
10630 #: ../src/guestfs-actions.pod:3683 ../fish/guestfish-actions.pod:2699
10631 msgid "This loads a kernel module in the appliance."
10635 #: ../src/guestfs-actions.pod:3685 ../fish/guestfish-actions.pod:2701
10637 "The kernel module must have been whitelisted when libguestfs was built (see "
10638 "C<appliance/kmod.whitelist.in> in the source)."
10642 #: ../src/guestfs-actions.pod:3690
10643 msgid "guestfs_mount"
10647 #: ../src/guestfs-actions.pod:3692
10651 " guestfs_mount (guestfs_h *g,\n"
10652 " const char *device,\n"
10653 " const char *mountpoint);\n"
10658 #: ../src/guestfs-actions.pod:3697 ../fish/guestfish-actions.pod:2708
10660 "Mount a guest disk at a position in the filesystem. Block devices are named "
10661 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
10662 "those block devices contain partitions, they will have the usual names (eg. "
10663 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
10667 #: ../src/guestfs-actions.pod:3703 ../fish/guestfish-actions.pod:2714
10669 "The rules are the same as for L<mount(2)>: A filesystem must first be "
10670 "mounted on C</> before others can be mounted. Other filesystems can only be "
10671 "mounted on directories which already exist."
10675 #: ../src/guestfs-actions.pod:3708 ../fish/guestfish-actions.pod:2719
10677 "The mounted filesystem is writable, if we have sufficient permissions on the "
10678 "underlying device."
10682 #: ../src/guestfs-actions.pod:3711
10684 "B<Important note:> When you use this call, the filesystem options C<sync> "
10685 "and C<noatime> are set implicitly. This was originally done because we "
10686 "thought it would improve reliability, but it turns out that I<-o sync> has a "
10687 "very large negative performance impact and negligible effect on "
10688 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
10689 "in any code that needs performance, and instead use C<guestfs_mount_options> "
10690 "(use an empty string for the first parameter if you don't want any options)."
10694 #: ../src/guestfs-actions.pod:3723
10695 msgid "guestfs_mount_loop"
10699 #: ../src/guestfs-actions.pod:3725
10703 " guestfs_mount_loop (guestfs_h *g,\n"
10704 " const char *file,\n"
10705 " const char *mountpoint);\n"
10710 #: ../src/guestfs-actions.pod:3730 ../fish/guestfish-actions.pod:2736
10712 "This command lets you mount C<file> (a filesystem image in a file) on a "
10713 "mount point. It is entirely equivalent to the command C<mount -o loop file "
10718 #: ../src/guestfs-actions.pod:3736
10719 msgid "guestfs_mount_options"
10723 #: ../src/guestfs-actions.pod:3738
10727 " guestfs_mount_options (guestfs_h *g,\n"
10728 " const char *options,\n"
10729 " const char *device,\n"
10730 " const char *mountpoint);\n"
10735 #: ../src/guestfs-actions.pod:3744
10737 "This is the same as the C<guestfs_mount> command, but it allows you to set "
10738 "the mount options as for the L<mount(8)> I<-o> flag."
10742 #: ../src/guestfs-actions.pod:3748 ../fish/guestfish-actions.pod:2748
10744 "If the C<options> parameter is an empty string, then no options are passed "
10745 "(all options default to whatever the filesystem uses)."
10749 #: ../src/guestfs-actions.pod:3754
10750 msgid "guestfs_mount_ro"
10754 #: ../src/guestfs-actions.pod:3756
10758 " guestfs_mount_ro (guestfs_h *g,\n"
10759 " const char *device,\n"
10760 " const char *mountpoint);\n"
10765 #: ../src/guestfs-actions.pod:3761
10767 "This is the same as the C<guestfs_mount> command, but it mounts the "
10768 "filesystem with the read-only (I<-o ro>) flag."
10772 #: ../src/guestfs-actions.pod:3766
10773 msgid "guestfs_mount_vfs"
10777 #: ../src/guestfs-actions.pod:3768
10781 " guestfs_mount_vfs (guestfs_h *g,\n"
10782 " const char *options,\n"
10783 " const char *vfstype,\n"
10784 " const char *device,\n"
10785 " const char *mountpoint);\n"
10790 #: ../src/guestfs-actions.pod:3775
10792 "This is the same as the C<guestfs_mount> command, but it allows you to set "
10793 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
10798 #: ../src/guestfs-actions.pod:3781
10799 msgid "guestfs_mountpoints"
10803 #: ../src/guestfs-actions.pod:3783
10807 " guestfs_mountpoints (guestfs_h *g);\n"
10812 #: ../src/guestfs-actions.pod:3786
10814 "This call is similar to C<guestfs_mounts>. That call returns a list of "
10815 "devices. This one returns a hash table (map) of device name to directory "
10816 "where the device is mounted."
10820 #: ../src/guestfs-actions.pod:3796
10821 msgid "guestfs_mounts"
10825 #: ../src/guestfs-actions.pod:3798
10829 " guestfs_mounts (guestfs_h *g);\n"
10834 #: ../src/guestfs-actions.pod:3801 ../fish/guestfish-actions.pod:2779
10836 "This returns the list of currently mounted filesystems. It returns the list "
10837 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
10841 #: ../src/guestfs-actions.pod:3804 ../fish/guestfish-actions.pod:2782
10842 msgid "Some internal mounts are not shown."
10846 #: ../src/guestfs-actions.pod:3806
10847 msgid "See also: C<guestfs_mountpoints>"
10851 #: ../src/guestfs-actions.pod:3812
10856 #: ../src/guestfs-actions.pod:3814
10860 " guestfs_mv (guestfs_h *g,\n"
10861 " const char *src,\n"
10862 " const char *dest);\n"
10867 #: ../src/guestfs-actions.pod:3819 ../fish/guestfish-actions.pod:2790
10869 "This moves a file from C<src> to C<dest> where C<dest> is either a "
10870 "destination filename or destination directory."
10874 #: ../src/guestfs-actions.pod:3824
10875 msgid "guestfs_ntfs_3g_probe"
10879 #: ../src/guestfs-actions.pod:3826
10883 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
10885 " const char *device);\n"
10890 #: ../src/guestfs-actions.pod:3831 ../fish/guestfish-actions.pod:2797
10892 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
10893 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
10894 "write, and some cannot be mounted at all)."
10898 #: ../src/guestfs-actions.pod:3835 ../fish/guestfish-actions.pod:2801
10900 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
10901 "can be mounted read-write. Set it to false if you want to test if the "
10902 "volume can be mounted read-only."
10906 #: ../src/guestfs-actions.pod:3839 ../fish/guestfish-actions.pod:2805
10908 "The return value is an integer which C<0> if the operation would succeed, or "
10909 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
10913 #: ../src/guestfs-actions.pod:3845
10914 msgid "guestfs_ntfsresize"
10918 #: ../src/guestfs-actions.pod:3847
10922 " guestfs_ntfsresize (guestfs_h *g,\n"
10923 " const char *device);\n"
10928 #: ../src/guestfs-actions.pod:3851 ../fish/guestfish-actions.pod:2813
10930 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
10931 "size of the underlying device. See also L<ntfsresize(8)>."
10935 #: ../src/guestfs-actions.pod:3857
10936 msgid "guestfs_ntfsresize_size"
10940 #: ../src/guestfs-actions.pod:3859
10944 " guestfs_ntfsresize_size (guestfs_h *g,\n"
10945 " const char *device,\n"
10946 " int64_t size);\n"
10951 #: ../src/guestfs-actions.pod:3864
10953 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
10954 "to specify the new size (in bytes) explicitly."
10958 #: ../src/guestfs-actions.pod:3869
10959 msgid "guestfs_part_add"
10963 #: ../src/guestfs-actions.pod:3871
10967 " guestfs_part_add (guestfs_h *g,\n"
10968 " const char *device,\n"
10969 " const char *prlogex,\n"
10970 " int64_t startsect,\n"
10971 " int64_t endsect);\n"
10976 #: ../src/guestfs-actions.pod:3878
10978 "This command adds a partition to C<device>. If there is no partition table "
10979 "on the device, call C<guestfs_part_init> first."
10983 #: ../src/guestfs-actions.pod:3881 ../fish/guestfish-actions.pod:2831
10985 "The C<prlogex> parameter is the type of partition. Normally you should pass "
10986 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
10987 "C<logical>) and C<e> (or C<extended>) partition types."
10991 #: ../src/guestfs-actions.pod:3886 ../fish/guestfish-actions.pod:2836
10993 "C<startsect> and C<endsect> are the start and end of the partition in "
10994 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
10995 "from the end of the disk (C<-1> is the last sector)."
10999 #: ../src/guestfs-actions.pod:3890
11001 "Creating a partition which covers the whole disk is not so easy. Use "
11002 "C<guestfs_part_disk> to do that."
11006 #: ../src/guestfs-actions.pod:3895
11007 msgid "guestfs_part_del"
11011 #: ../src/guestfs-actions.pod:3897
11015 " guestfs_part_del (guestfs_h *g,\n"
11016 " const char *device,\n"
11022 #: ../src/guestfs-actions.pod:3902 ../fish/guestfish-actions.pod:2847
11023 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11027 #: ../src/guestfs-actions.pod:3904 ../fish/guestfish-actions.pod:2849
11029 "Note that in the case of MBR partitioning, deleting an extended partition "
11030 "also deletes any logical partitions it contains."
11034 #: ../src/guestfs-actions.pod:3910
11035 msgid "guestfs_part_disk"
11039 #: ../src/guestfs-actions.pod:3912
11043 " guestfs_part_disk (guestfs_h *g,\n"
11044 " const char *device,\n"
11045 " const char *parttype);\n"
11050 #: ../src/guestfs-actions.pod:3917
11052 "This command is simply a combination of C<guestfs_part_init> followed by "
11053 "C<guestfs_part_add> to create a single primary partition covering the whole "
11058 #: ../src/guestfs-actions.pod:3921
11060 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11061 "possible values are described in C<guestfs_part_init>."
11065 #: ../src/guestfs-actions.pod:3929
11066 msgid "guestfs_part_get_bootable"
11070 #: ../src/guestfs-actions.pod:3931
11074 " guestfs_part_get_bootable (guestfs_h *g,\n"
11075 " const char *device,\n"
11081 #: ../src/guestfs-actions.pod:3936 ../fish/guestfish-actions.pod:2871
11083 "This command returns true if the partition C<partnum> on C<device> has the "
11084 "bootable flag set."
11088 #: ../src/guestfs-actions.pod:3939
11089 msgid "See also C<guestfs_part_set_bootable>."
11093 #: ../src/guestfs-actions.pod:3943
11094 msgid "guestfs_part_get_mbr_id"
11098 #: ../src/guestfs-actions.pod:3945
11102 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
11103 " const char *device,\n"
11109 #: ../src/guestfs-actions.pod:3950 ../fish/guestfish-actions.pod:2880
11111 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11112 "partition C<partnum>."
11116 #: ../src/guestfs-actions.pod:3953 ../src/guestfs-actions.pod:4120
11118 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11119 "undefined results for other partition table types (see "
11120 "C<guestfs_part_get_parttype>)."
11124 #: ../src/guestfs-actions.pod:3959
11125 msgid "guestfs_part_get_parttype"
11129 #: ../src/guestfs-actions.pod:3961
11133 " guestfs_part_get_parttype (guestfs_h *g,\n"
11134 " const char *device);\n"
11139 #: ../src/guestfs-actions.pod:3965 ../fish/guestfish-actions.pod:2891
11141 "This command examines the partition table on C<device> and returns the "
11142 "partition table type (format) being used."
11146 #: ../src/guestfs-actions.pod:3968
11148 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11149 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11150 "possible, although unusual. See C<guestfs_part_init> for a full list."
11154 #: ../src/guestfs-actions.pod:3976
11155 msgid "guestfs_part_init"
11159 #: ../src/guestfs-actions.pod:3978
11163 " guestfs_part_init (guestfs_h *g,\n"
11164 " const char *device,\n"
11165 " const char *parttype);\n"
11170 #: ../src/guestfs-actions.pod:3983 ../fish/guestfish-actions.pod:2903
11172 "This creates an empty partition table on C<device> of one of the partition "
11173 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11174 "(for large disks)."
11178 #: ../src/guestfs-actions.pod:3987
11180 "Initially there are no partitions. Following this, you should call "
11181 "C<guestfs_part_add> for each partition required."
11185 #: ../src/guestfs-actions.pod:3990 ../fish/guestfish-actions.pod:2910
11186 msgid "Possible values for C<parttype> are:"
11190 #: ../src/guestfs-actions.pod:3994 ../fish/guestfish-actions.pod:2914
11191 msgid "B<efi> | B<gpt>"
11195 #: ../src/guestfs-actions.pod:3996 ../fish/guestfish-actions.pod:2916
11196 msgid "Intel EFI / GPT partition table."
11200 #: ../src/guestfs-actions.pod:3998 ../fish/guestfish-actions.pod:2918
11202 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11203 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11204 "the C<mbr> format."
11208 #: ../src/guestfs-actions.pod:4002 ../fish/guestfish-actions.pod:2922
11209 msgid "B<mbr> | B<msdos>"
11213 #: ../src/guestfs-actions.pod:4004 ../fish/guestfish-actions.pod:2924
11215 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11216 "Windows. This partition type will B<only> work for device sizes up to 2 "
11217 "TB. For large disks we recommend using C<gpt>."
11221 #: ../src/guestfs-actions.pod:4011 ../fish/guestfish-actions.pod:2931
11223 "Other partition table types that may work but are not supported include:"
11227 #: ../src/guestfs-actions.pod:4016 ../fish/guestfish-actions.pod:2936
11232 #: ../src/guestfs-actions.pod:4018 ../fish/guestfish-actions.pod:2938
11233 msgid "AIX disk labels."
11237 #: ../src/guestfs-actions.pod:4020 ../fish/guestfish-actions.pod:2940
11238 msgid "B<amiga> | B<rdb>"
11242 #: ../src/guestfs-actions.pod:4022 ../fish/guestfish-actions.pod:2942
11243 msgid "Amiga \"Rigid Disk Block\" format."
11247 #: ../src/guestfs-actions.pod:4024 ../fish/guestfish-actions.pod:2944
11252 #: ../src/guestfs-actions.pod:4026 ../fish/guestfish-actions.pod:2946
11253 msgid "BSD disk labels."
11257 #: ../src/guestfs-actions.pod:4028 ../fish/guestfish-actions.pod:2948
11262 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:2950
11263 msgid "DASD, used on IBM mainframes."
11267 #: ../src/guestfs-actions.pod:4032 ../fish/guestfish-actions.pod:2952
11272 #: ../src/guestfs-actions.pod:4034 ../fish/guestfish-actions.pod:2954
11273 msgid "MIPS/SGI volumes."
11277 #: ../src/guestfs-actions.pod:4036 ../fish/guestfish-actions.pod:2956
11282 #: ../src/guestfs-actions.pod:4038 ../fish/guestfish-actions.pod:2958
11283 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11287 #: ../src/guestfs-actions.pod:4040 ../fish/guestfish-actions.pod:2960
11292 #: ../src/guestfs-actions.pod:4042 ../fish/guestfish-actions.pod:2962
11293 msgid "NEC PC-98 format, common in Japan apparently."
11297 #: ../src/guestfs-actions.pod:4044 ../fish/guestfish-actions.pod:2964
11302 #: ../src/guestfs-actions.pod:4046 ../fish/guestfish-actions.pod:2966
11303 msgid "Sun disk labels."
11307 #: ../src/guestfs-actions.pod:4052
11308 msgid "guestfs_part_list"
11312 #: ../src/guestfs-actions.pod:4054
11315 " struct guestfs_partition_list *\n"
11316 " guestfs_part_list (guestfs_h *g,\n"
11317 " const char *device);\n"
11322 #: ../src/guestfs-actions.pod:4058 ../fish/guestfish-actions.pod:2974
11324 "This command parses the partition table on C<device> and returns the list of "
11325 "partitions found."
11329 #: ../src/guestfs-actions.pod:4061 ../fish/guestfish-actions.pod:2977
11330 msgid "The fields in the returned structure are:"
11334 #: ../src/guestfs-actions.pod:4065 ../fish/guestfish-actions.pod:2981
11335 msgid "B<part_num>"
11339 #: ../src/guestfs-actions.pod:4067 ../fish/guestfish-actions.pod:2983
11340 msgid "Partition number, counting from 1."
11344 #: ../src/guestfs-actions.pod:4069 ../fish/guestfish-actions.pod:2985
11345 msgid "B<part_start>"
11349 #: ../src/guestfs-actions.pod:4071
11351 "Start of the partition I<in bytes>. To get sectors you have to divide by "
11352 "the device's sector size, see C<guestfs_blockdev_getss>."
11356 #: ../src/guestfs-actions.pod:4074 ../fish/guestfish-actions.pod:2990
11357 msgid "B<part_end>"
11361 #: ../src/guestfs-actions.pod:4076 ../fish/guestfish-actions.pod:2992
11362 msgid "End of the partition in bytes."
11366 #: ../src/guestfs-actions.pod:4078 ../fish/guestfish-actions.pod:2994
11367 msgid "B<part_size>"
11371 #: ../src/guestfs-actions.pod:4080 ../fish/guestfish-actions.pod:2996
11372 msgid "Size of the partition in bytes."
11376 #: ../src/guestfs-actions.pod:4084
11378 "This function returns a C<struct guestfs_partition_list *> (see E<lt>guestfs-"
11379 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
11380 "C<guestfs_free_partition_list> after use>."
11384 #: ../src/guestfs-actions.pod:4089
11385 msgid "guestfs_part_set_bootable"
11389 #: ../src/guestfs-actions.pod:4091
11393 " guestfs_part_set_bootable (guestfs_h *g,\n"
11394 " const char *device,\n"
11396 " int bootable);\n"
11401 #: ../src/guestfs-actions.pod:4097 ../fish/guestfish-actions.pod:3004
11403 "This sets the bootable flag on partition numbered C<partnum> on device "
11404 "C<device>. Note that partitions are numbered from 1."
11408 #: ../src/guestfs-actions.pod:4100 ../fish/guestfish-actions.pod:3007
11410 "The bootable flag is used by some operating systems (notably Windows) to "
11411 "determine which partition to boot from. It is by no means universally "
11416 #: ../src/guestfs-actions.pod:4106
11417 msgid "guestfs_part_set_mbr_id"
11421 #: ../src/guestfs-actions.pod:4108
11425 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
11426 " const char *device,\n"
11433 #: ../src/guestfs-actions.pod:4114 ../fish/guestfish-actions.pod:3015
11435 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
11436 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
11437 "documentation are in fact hexadecimal numbers, but usually documented "
11438 "without any leading \"0x\" which might be confusing."
11442 #: ../src/guestfs-actions.pod:4126
11443 msgid "guestfs_part_set_name"
11447 #: ../src/guestfs-actions.pod:4128
11451 " guestfs_part_set_name (guestfs_h *g,\n"
11452 " const char *device,\n"
11454 " const char *name);\n"
11459 #: ../src/guestfs-actions.pod:4134 ../fish/guestfish-actions.pod:3029
11461 "This sets the partition name on partition numbered C<partnum> on device "
11462 "C<device>. Note that partitions are numbered from 1."
11466 #: ../src/guestfs-actions.pod:4137 ../fish/guestfish-actions.pod:3032
11468 "The partition name can only be set on certain types of partition table. "
11469 "This works on C<gpt> but not on C<mbr> partitions."
11473 #: ../src/guestfs-actions.pod:4142
11474 msgid "guestfs_part_to_dev"
11478 #: ../src/guestfs-actions.pod:4144
11482 " guestfs_part_to_dev (guestfs_h *g,\n"
11483 " const char *partition);\n"
11488 #: ../src/guestfs-actions.pod:4148 ../fish/guestfish-actions.pod:3039
11490 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
11491 "partition number, returning the device name (eg. \"/dev/sdb\")."
11495 #: ../src/guestfs-actions.pod:4152
11497 "The named partition must exist, for example as a string returned from "
11498 "C<guestfs_list_partitions>."
11502 #: ../src/guestfs-actions.pod:4158
11503 msgid "guestfs_ping_daemon"
11507 #: ../src/guestfs-actions.pod:4160
11511 " guestfs_ping_daemon (guestfs_h *g);\n"
11516 #: ../src/guestfs-actions.pod:4163 ../fish/guestfish-actions.pod:3050
11518 "This is a test probe into the guestfs daemon running inside the qemu "
11519 "subprocess. Calling this function checks that the daemon responds to the "
11520 "ping message, without affecting the daemon or attached block device(s) in "
11525 #: ../src/guestfs-actions.pod:4170
11526 msgid "guestfs_pread"
11530 #: ../src/guestfs-actions.pod:4172
11534 " guestfs_pread (guestfs_h *g,\n"
11535 " const char *path,\n"
11537 " int64_t offset,\n"
11538 " size_t *size_r);\n"
11543 #: ../src/guestfs-actions.pod:4179 ../fish/guestfish-actions.pod:3059
11545 "This command lets you read part of a file. It reads C<count> bytes of the "
11546 "file, starting at C<offset>, from file C<path>."
11550 #: ../src/guestfs-actions.pod:4182 ../src/guestfs-actions.pod:4206
11551 #: ../fish/guestfish-actions.pod:3062 ../fish/guestfish-actions.pod:3077
11553 "This may read fewer bytes than requested. For further details see the "
11554 "L<pread(2)> system call."
11558 #: ../src/guestfs-actions.pod:4185
11559 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
11563 #: ../src/guestfs-actions.pod:4194
11564 msgid "guestfs_pread_device"
11568 #: ../src/guestfs-actions.pod:4196
11572 " guestfs_pread_device (guestfs_h *g,\n"
11573 " const char *device,\n"
11575 " int64_t offset,\n"
11576 " size_t *size_r);\n"
11581 #: ../src/guestfs-actions.pod:4203 ../fish/guestfish-actions.pod:3074
11583 "This command lets you read part of a file. It reads C<count> bytes of "
11584 "C<device>, starting at C<offset>."
11588 #: ../src/guestfs-actions.pod:4209
11589 msgid "See also C<guestfs_pread>."
11593 #: ../src/guestfs-actions.pod:4218
11594 msgid "guestfs_pvcreate"
11598 #: ../src/guestfs-actions.pod:4220
11602 " guestfs_pvcreate (guestfs_h *g,\n"
11603 " const char *device);\n"
11608 #: ../src/guestfs-actions.pod:4224 ../fish/guestfish-actions.pod:3089
11610 "This creates an LVM physical volume on the named C<device>, where C<device> "
11611 "should usually be a partition name such as C</dev/sda1>."
11615 #: ../src/guestfs-actions.pod:4230
11616 msgid "guestfs_pvremove"
11620 #: ../src/guestfs-actions.pod:4232
11624 " guestfs_pvremove (guestfs_h *g,\n"
11625 " const char *device);\n"
11630 #: ../src/guestfs-actions.pod:4236 ../fish/guestfish-actions.pod:3097
11632 "This wipes a physical volume C<device> so that LVM will no longer recognise "
11637 #: ../src/guestfs-actions.pod:4239 ../fish/guestfish-actions.pod:3100
11639 "The implementation uses the C<pvremove> command which refuses to wipe "
11640 "physical volumes that contain any volume groups, so you have to remove those "
11645 #: ../src/guestfs-actions.pod:4245
11646 msgid "guestfs_pvresize"
11650 #: ../src/guestfs-actions.pod:4247
11654 " guestfs_pvresize (guestfs_h *g,\n"
11655 " const char *device);\n"
11660 #: ../src/guestfs-actions.pod:4251 ../fish/guestfish-actions.pod:3108
11662 "This resizes (expands or shrinks) an existing LVM physical volume to match "
11663 "the new size of the underlying device."
11667 #: ../src/guestfs-actions.pod:4256
11668 msgid "guestfs_pvresize_size"
11672 #: ../src/guestfs-actions.pod:4258
11676 " guestfs_pvresize_size (guestfs_h *g,\n"
11677 " const char *device,\n"
11678 " int64_t size);\n"
11683 #: ../src/guestfs-actions.pod:4263
11685 "This command is the same as C<guestfs_pvresize> except that it allows you to "
11686 "specify the new size (in bytes) explicitly."
11690 #: ../src/guestfs-actions.pod:4268
11691 msgid "guestfs_pvs"
11695 #: ../src/guestfs-actions.pod:4270
11699 " guestfs_pvs (guestfs_h *g);\n"
11704 #: ../src/guestfs-actions.pod:4273 ../fish/guestfish-actions.pod:3122
11706 "List all the physical volumes detected. This is the equivalent of the L<pvs"
11711 #: ../src/guestfs-actions.pod:4276 ../fish/guestfish-actions.pod:3125
11713 "This returns a list of just the device names that contain PVs (eg. C</dev/"
11718 #: ../src/guestfs-actions.pod:4279
11719 msgid "See also C<guestfs_pvs_full>."
11723 #: ../src/guestfs-actions.pod:4285
11724 msgid "guestfs_pvs_full"
11728 #: ../src/guestfs-actions.pod:4287
11731 " struct guestfs_lvm_pv_list *\n"
11732 " guestfs_pvs_full (guestfs_h *g);\n"
11737 #: ../src/guestfs-actions.pod:4290 ../fish/guestfish-actions.pod:3134
11739 "List all the physical volumes detected. This is the equivalent of the L<pvs"
11740 "(8)> command. The \"full\" version includes all fields."
11744 #: ../src/guestfs-actions.pod:4293
11746 "This function returns a C<struct guestfs_lvm_pv_list *> (see E<lt>guestfs-"
11747 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
11748 "C<guestfs_free_lvm_pv_list> after use>."
11752 #: ../src/guestfs-actions.pod:4298
11753 msgid "guestfs_pvuuid"
11757 #: ../src/guestfs-actions.pod:4300
11761 " guestfs_pvuuid (guestfs_h *g,\n"
11762 " const char *device);\n"
11767 #: ../src/guestfs-actions.pod:4304 ../fish/guestfish-actions.pod:3141
11768 msgid "This command returns the UUID of the LVM PV C<device>."
11772 #: ../src/guestfs-actions.pod:4309
11773 msgid "guestfs_pwrite"
11777 #: ../src/guestfs-actions.pod:4311
11781 " guestfs_pwrite (guestfs_h *g,\n"
11782 " const char *path,\n"
11783 " const char *content,\n"
11784 " size_t content_size,\n"
11785 " int64_t offset);\n"
11790 #: ../src/guestfs-actions.pod:4318 ../fish/guestfish-actions.pod:3147
11792 "This command writes to part of a file. It writes the data buffer C<content> "
11793 "to the file C<path> starting at offset C<offset>."
11797 #: ../src/guestfs-actions.pod:4321 ../fish/guestfish-actions.pod:3150
11799 "This command implements the L<pwrite(2)> system call, and like that system "
11800 "call it may not write the full data requested. The return value is the "
11801 "number of bytes that were actually written to the file. This could even be "
11802 "0, although short writes are unlikely for regular files in ordinary "
11807 #: ../src/guestfs-actions.pod:4327
11808 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
11812 #: ../src/guestfs-actions.pod:4334
11813 msgid "guestfs_pwrite_device"
11817 #: ../src/guestfs-actions.pod:4336
11821 " guestfs_pwrite_device (guestfs_h *g,\n"
11822 " const char *device,\n"
11823 " const char *content,\n"
11824 " size_t content_size,\n"
11825 " int64_t offset);\n"
11830 #: ../src/guestfs-actions.pod:4343 ../fish/guestfish-actions.pod:3165
11832 "This command writes to part of a device. It writes the data buffer "
11833 "C<content> to C<device> starting at offset C<offset>."
11837 #: ../src/guestfs-actions.pod:4346 ../fish/guestfish-actions.pod:3168
11839 "This command implements the L<pwrite(2)> system call, and like that system "
11840 "call it may not write the full data requested (although short writes to disk "
11841 "devices and partitions are probably impossible with standard Linux kernels)."
11845 #: ../src/guestfs-actions.pod:4351
11846 msgid "See also C<guestfs_pwrite>."
11850 #: ../src/guestfs-actions.pod:4358
11851 msgid "guestfs_read_file"
11855 #: ../src/guestfs-actions.pod:4360
11859 " guestfs_read_file (guestfs_h *g,\n"
11860 " const char *path,\n"
11861 " size_t *size_r);\n"
11866 #: ../src/guestfs-actions.pod:4365 ../fish/guestfish-actions.pod:3182
11867 msgid "This calls returns the contents of the file C<path> as a buffer."
11871 #: ../src/guestfs-actions.pod:4368
11873 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
11874 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
11875 "function is limited in the total size of file that can be handled."
11879 #: ../src/guestfs-actions.pod:4380
11880 msgid "guestfs_read_lines"
11884 #: ../src/guestfs-actions.pod:4382
11888 " guestfs_read_lines (guestfs_h *g,\n"
11889 " const char *path);\n"
11894 #: ../src/guestfs-actions.pod:4388 ../fish/guestfish-actions.pod:3199
11896 "The file contents are returned as a list of lines. Trailing C<LF> and "
11897 "C<CRLF> character sequences are I<not> returned."
11901 #: ../src/guestfs-actions.pod:4391
11903 "Note that this function cannot correctly handle binary files (specifically, "
11904 "files containing C<\\0> character which is treated as end of line). For "
11905 "those you need to use the C<guestfs_read_file> function which has a more "
11906 "complex interface."
11910 #: ../src/guestfs-actions.pod:4400
11911 msgid "guestfs_readdir"
11915 #: ../src/guestfs-actions.pod:4402
11918 " struct guestfs_dirent_list *\n"
11919 " guestfs_readdir (guestfs_h *g,\n"
11920 " const char *dir);\n"
11925 #: ../src/guestfs-actions.pod:4406 ../fish/guestfish-actions.pod:3211
11926 msgid "This returns the list of directory entries in directory C<dir>."
11930 #: ../src/guestfs-actions.pod:4408 ../fish/guestfish-actions.pod:3213
11932 "All entries in the directory are returned, including C<.> and C<..>. The "
11933 "entries are I<not> sorted, but returned in the same order as the underlying "
11938 #: ../src/guestfs-actions.pod:4412 ../fish/guestfish-actions.pod:3217
11940 "Also this call returns basic file type information about each file. The "
11941 "C<ftyp> field will contain one of the following characters:"
11945 #: ../src/guestfs-actions.pod:4417 ../fish/guestfish-actions.pod:3222
11950 #: ../src/guestfs-actions.pod:4419 ../fish/guestfish-actions.pod:3224
11951 msgid "Block special"
11955 #: ../src/guestfs-actions.pod:4421 ../fish/guestfish-actions.pod:3226
11960 #: ../src/guestfs-actions.pod:4423 ../fish/guestfish-actions.pod:3228
11961 msgid "Char special"
11965 #: ../src/guestfs-actions.pod:4425 ../fish/guestfish-actions.pod:3230
11970 #: ../src/guestfs-actions.pod:4427 ../fish/guestfish-actions.pod:3232
11975 #: ../src/guestfs-actions.pod:4429 ../fish/guestfish-actions.pod:3234
11980 #: ../src/guestfs-actions.pod:4431 ../fish/guestfish-actions.pod:3236
11981 msgid "FIFO (named pipe)"
11985 #: ../src/guestfs-actions.pod:4433 ../fish/guestfish-actions.pod:3238
11990 #: ../src/guestfs-actions.pod:4435 ../fish/guestfish-actions.pod:3240
11991 msgid "Symbolic link"
11995 #: ../src/guestfs-actions.pod:4437 ../fish/guestfish-actions.pod:3242
12000 #: ../src/guestfs-actions.pod:4439 ../fish/guestfish-actions.pod:3244
12001 msgid "Regular file"
12005 #: ../src/guestfs-actions.pod:4441 ../fish/guestfish-actions.pod:3246
12010 #: ../src/guestfs-actions.pod:4443 ../fish/guestfish-actions.pod:3248
12015 #: ../src/guestfs-actions.pod:4445 ../fish/guestfish-actions.pod:3250
12020 #: ../src/guestfs-actions.pod:4447 ../fish/guestfish-actions.pod:3252
12021 msgid "Unknown file type"
12025 #: ../src/guestfs-actions.pod:4449 ../fish/guestfish-actions.pod:3254
12030 #: ../src/guestfs-actions.pod:4451 ../fish/guestfish-actions.pod:3256
12032 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12036 #: ../src/guestfs-actions.pod:4456
12038 "This function is primarily intended for use by programs. To get a simple "
12039 "list of names, use C<guestfs_ls>. To get a printable directory for human "
12040 "consumption, use C<guestfs_ll>."
12044 #: ../src/guestfs-actions.pod:4460
12046 "This function returns a C<struct guestfs_dirent_list *> (see E<lt>guestfs-"
12047 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
12048 "C<guestfs_free_dirent_list> after use>."
12052 #: ../src/guestfs-actions.pod:4465
12053 msgid "guestfs_readlink"
12057 #: ../src/guestfs-actions.pod:4467
12061 " guestfs_readlink (guestfs_h *g,\n"
12062 " const char *path);\n"
12067 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3269
12068 msgid "This command reads the target of a symbolic link."
12072 #: ../src/guestfs-actions.pod:4476
12073 msgid "guestfs_readlinklist"
12077 #: ../src/guestfs-actions.pod:4478
12081 " guestfs_readlinklist (guestfs_h *g,\n"
12082 " const char *path,\n"
12083 " char *const *names);\n"
12088 #: ../src/guestfs-actions.pod:4483 ../fish/guestfish-actions.pod:3275
12090 "This call allows you to do a C<readlink> operation on multiple files, where "
12091 "all files are in the directory C<path>. C<names> is the list of files from "
12096 #: ../src/guestfs-actions.pod:4487 ../fish/guestfish-actions.pod:3279
12098 "On return you get a list of strings, with a one-to-one correspondence to the "
12099 "C<names> list. Each string is the value of the symbolic link."
12103 #: ../src/guestfs-actions.pod:4491 ../fish/guestfish-actions.pod:3283
12105 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12106 "result string is the empty string C<\"\">. However the whole operation is "
12107 "completed even if there were C<readlink(2)> errors, and so you can call this "
12108 "function with names where you don't know if they are symbolic links already "
12109 "(albeit slightly less efficient)."
12113 #: ../src/guestfs-actions.pod:4498 ../fish/guestfish-actions.pod:3290
12115 "This call is intended for programs that want to efficiently list a directory "
12116 "contents without making many round-trips. Very long directory listings "
12117 "might cause the protocol message size to be exceeded, causing this call to "
12118 "fail. The caller must split up such requests into smaller groups of names."
12122 #: ../src/guestfs-actions.pod:4509
12123 msgid "guestfs_realpath"
12127 #: ../src/guestfs-actions.pod:4511
12131 " guestfs_realpath (guestfs_h *g,\n"
12132 " const char *path);\n"
12137 #: ../src/guestfs-actions.pod:4515 ../fish/guestfish-actions.pod:3301
12139 "Return the canonicalized absolute pathname of C<path>. The returned path "
12140 "has no C<.>, C<..> or symbolic link path elements."
12144 #: ../src/guestfs-actions.pod:4521
12145 msgid "guestfs_removexattr"
12149 #: ../src/guestfs-actions.pod:4523
12153 " guestfs_removexattr (guestfs_h *g,\n"
12154 " const char *xattr,\n"
12155 " const char *path);\n"
12160 #: ../src/guestfs-actions.pod:4528 ../fish/guestfish-actions.pod:3308
12162 "This call removes the extended attribute named C<xattr> of the file C<path>."
12166 #: ../src/guestfs-actions.pod:4531
12167 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
12171 #: ../src/guestfs-actions.pod:4535
12172 msgid "guestfs_resize2fs"
12176 #: ../src/guestfs-actions.pod:4537
12180 " guestfs_resize2fs (guestfs_h *g,\n"
12181 " const char *device);\n"
12186 #: ../src/guestfs-actions.pod:4541 ../fish/guestfish-actions.pod:3317
12188 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12189 "underlying device."
12193 #: ../src/guestfs-actions.pod:4544
12195 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
12196 "C<device> before calling this command. For unknown reasons C<resize2fs> "
12197 "sometimes gives an error about this and sometimes not. In any case, it is "
12198 "always safe to call C<guestfs_e2fsck_f> before calling this function."
12202 #: ../src/guestfs-actions.pod:4552
12203 msgid "guestfs_resize2fs_size"
12207 #: ../src/guestfs-actions.pod:4554
12211 " guestfs_resize2fs_size (guestfs_h *g,\n"
12212 " const char *device,\n"
12213 " int64_t size);\n"
12218 #: ../src/guestfs-actions.pod:4559
12220 "This command is the same as C<guestfs_resize2fs> except that it allows you "
12221 "to specify the new size (in bytes) explicitly."
12225 #: ../src/guestfs-actions.pod:4564
12230 #: ../src/guestfs-actions.pod:4566
12234 " guestfs_rm (guestfs_h *g,\n"
12235 " const char *path);\n"
12240 #: ../src/guestfs-actions.pod:4570 ../fish/guestfish-actions.pod:3337
12241 msgid "Remove the single file C<path>."
12245 #: ../src/guestfs-actions.pod:4574
12246 msgid "guestfs_rm_rf"
12250 #: ../src/guestfs-actions.pod:4576
12254 " guestfs_rm_rf (guestfs_h *g,\n"
12255 " const char *path);\n"
12260 #: ../src/guestfs-actions.pod:4580 ../fish/guestfish-actions.pod:3343
12262 "Remove the file or directory C<path>, recursively removing the contents if "
12263 "its a directory. This is like the C<rm -rf> shell command."
12267 #: ../src/guestfs-actions.pod:4586
12268 msgid "guestfs_rmdir"
12272 #: ../src/guestfs-actions.pod:4588
12276 " guestfs_rmdir (guestfs_h *g,\n"
12277 " const char *path);\n"
12282 #: ../src/guestfs-actions.pod:4592 ../fish/guestfish-actions.pod:3351
12283 msgid "Remove the single directory C<path>."
12287 #: ../src/guestfs-actions.pod:4596
12288 msgid "guestfs_rmmountpoint"
12292 #: ../src/guestfs-actions.pod:4598
12296 " guestfs_rmmountpoint (guestfs_h *g,\n"
12297 " const char *exemptpath);\n"
12302 #: ../src/guestfs-actions.pod:4602
12304 "This calls removes a mountpoint that was previously created with "
12305 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
12309 #: ../src/guestfs-actions.pod:4608
12310 msgid "guestfs_scrub_device"
12314 #: ../src/guestfs-actions.pod:4610
12318 " guestfs_scrub_device (guestfs_h *g,\n"
12319 " const char *device);\n"
12324 #: ../src/guestfs-actions.pod:4614 ../fish/guestfish-actions.pod:3365
12326 "This command writes patterns over C<device> to make data retrieval more "
12331 #: ../src/guestfs-actions.pod:4617 ../src/guestfs-actions.pod:4636
12332 #: ../src/guestfs-actions.pod:4653 ../fish/guestfish-actions.pod:3368
12333 #: ../fish/guestfish-actions.pod:3383 ../fish/guestfish-actions.pod:3396
12335 "It is an interface to the L<scrub(1)> program. See that manual page for "
12340 #: ../src/guestfs-actions.pod:4625
12341 msgid "guestfs_scrub_file"
12345 #: ../src/guestfs-actions.pod:4627
12349 " guestfs_scrub_file (guestfs_h *g,\n"
12350 " const char *file);\n"
12355 #: ../src/guestfs-actions.pod:4631 ../fish/guestfish-actions.pod:3378
12357 "This command writes patterns over a file to make data retrieval more "
12362 #: ../src/guestfs-actions.pod:4634 ../fish/guestfish-actions.pod:3381
12363 msgid "The file is I<removed> after scrubbing."
12367 #: ../src/guestfs-actions.pod:4641
12368 msgid "guestfs_scrub_freespace"
12372 #: ../src/guestfs-actions.pod:4643
12376 " guestfs_scrub_freespace (guestfs_h *g,\n"
12377 " const char *dir);\n"
12382 #: ../src/guestfs-actions.pod:4647
12384 "This command creates the directory C<dir> and then fills it with files until "
12385 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
12386 "and deletes them. The intention is to scrub any free space on the partition "
12387 "containing C<dir>."
12391 #: ../src/guestfs-actions.pod:4658
12392 msgid "guestfs_set_append"
12396 #: ../src/guestfs-actions.pod:4660
12400 " guestfs_set_append (guestfs_h *g,\n"
12401 " const char *append);\n"
12406 #: ../src/guestfs-actions.pod:4664 ../fish/guestfish-actions.pod:3405
12408 "This function is used to add additional options to the guest kernel command "
12413 #: ../src/guestfs-actions.pod:4667 ../fish/guestfish-actions.pod:3408
12415 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
12416 "environment variable."
12420 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3411
12422 "Setting C<append> to C<NULL> means I<no> additional options are passed "
12423 "(libguestfs always adds a few of its own)."
12427 #: ../src/guestfs-actions.pod:4675
12428 msgid "guestfs_set_autosync"
12432 #: ../src/guestfs-actions.pod:4677
12436 " guestfs_set_autosync (guestfs_h *g,\n"
12437 " int autosync);\n"
12442 #: ../src/guestfs-actions.pod:4681
12444 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
12445 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
12446 "the handle is closed (also if the program exits without closing handles)."
12450 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3425
12452 "This is enabled by default (since libguestfs 1.5.24, previously it was "
12453 "disabled by default)."
12457 #: ../src/guestfs-actions.pod:4691
12458 msgid "guestfs_set_direct"
12462 #: ../src/guestfs-actions.pod:4693
12466 " guestfs_set_direct (guestfs_h *g,\n"
12472 #: ../src/guestfs-actions.pod:4697 ../fish/guestfish-actions.pod:3434
12474 "If the direct appliance mode flag is enabled, then stdin and stdout are "
12475 "passed directly through to the appliance once it is launched."
12479 #: ../src/guestfs-actions.pod:4701
12481 "One consequence of this is that log messages aren't caught by the library "
12482 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
12487 #: ../src/guestfs-actions.pod:4705 ../fish/guestfish-actions.pod:3442
12488 msgid "You probably don't want to use this unless you know what you are doing."
12492 #: ../src/guestfs-actions.pod:4708 ../fish/guestfish-actions.pod:3445
12493 msgid "The default is disabled."
12497 #: ../src/guestfs-actions.pod:4712
12498 msgid "guestfs_set_e2label"
12502 #: ../src/guestfs-actions.pod:4714
12506 " guestfs_set_e2label (guestfs_h *g,\n"
12507 " const char *device,\n"
12508 " const char *label);\n"
12513 #: ../src/guestfs-actions.pod:4719 ../fish/guestfish-actions.pod:3451
12515 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
12516 "C<label>. Filesystem labels are limited to 16 characters."
12520 #: ../src/guestfs-actions.pod:4723
12522 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
12523 "the existing label on a filesystem."
12527 #: ../src/guestfs-actions.pod:4728
12528 msgid "guestfs_set_e2uuid"
12532 #: ../src/guestfs-actions.pod:4730
12536 " guestfs_set_e2uuid (guestfs_h *g,\n"
12537 " const char *device,\n"
12538 " const char *uuid);\n"
12543 #: ../src/guestfs-actions.pod:4735 ../fish/guestfish-actions.pod:3462
12545 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
12546 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
12547 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
12551 #: ../src/guestfs-actions.pod:4740
12553 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
12554 "the existing UUID of a filesystem."
12558 #: ../src/guestfs-actions.pod:4745
12559 msgid "guestfs_set_memsize"
12563 #: ../src/guestfs-actions.pod:4747
12567 " guestfs_set_memsize (guestfs_h *g,\n"
12573 #: ../src/guestfs-actions.pod:4751
12575 "This sets the memory size in megabytes allocated to the qemu subprocess. "
12576 "This only has any effect if called before C<guestfs_launch>."
12580 #: ../src/guestfs-actions.pod:4755 ../fish/guestfish-actions.pod:3480
12582 "You can also change this by setting the environment variable "
12583 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
12587 #: ../src/guestfs-actions.pod:4764
12588 msgid "guestfs_set_network"
12592 #: ../src/guestfs-actions.pod:4766
12596 " guestfs_set_network (guestfs_h *g,\n"
12602 #: ../src/guestfs-actions.pod:4770 ../fish/guestfish-actions.pod:3493
12604 "If C<network> is true, then the network is enabled in the libguestfs "
12605 "appliance. The default is false."
12609 #: ../src/guestfs-actions.pod:4773 ../fish/guestfish-actions.pod:3496
12611 "This affects whether commands are able to access the network (see L<guestfs"
12612 "(3)/RUNNING COMMANDS>)."
12616 #: ../src/guestfs-actions.pod:4776
12618 "You must call this before calling C<guestfs_launch>, otherwise it has no "
12623 #: ../src/guestfs-actions.pod:4781
12624 msgid "guestfs_set_path"
12628 #: ../src/guestfs-actions.pod:4783
12632 " guestfs_set_path (guestfs_h *g,\n"
12633 " const char *searchpath);\n"
12638 #: ../src/guestfs-actions.pod:4787 ../fish/guestfish-actions.pod:3508
12639 msgid "Set the path that libguestfs searches for kernel and initrd.img."
12643 #: ../src/guestfs-actions.pod:4789 ../fish/guestfish-actions.pod:3510
12645 "The default is C<$libdir/guestfs> unless overridden by setting "
12646 "C<LIBGUESTFS_PATH> environment variable."
12650 #: ../src/guestfs-actions.pod:4792 ../fish/guestfish-actions.pod:3513
12651 msgid "Setting C<path> to C<NULL> restores the default path."
12655 #: ../src/guestfs-actions.pod:4796
12656 msgid "guestfs_set_qemu"
12660 #: ../src/guestfs-actions.pod:4798
12664 " guestfs_set_qemu (guestfs_h *g,\n"
12665 " const char *qemu);\n"
12670 #: ../src/guestfs-actions.pod:4802 ../fish/guestfish-actions.pod:3521
12671 msgid "Set the qemu binary that we will use."
12675 #: ../src/guestfs-actions.pod:4804 ../fish/guestfish-actions.pod:3523
12677 "The default is chosen when the library was compiled by the configure script."
12681 #: ../src/guestfs-actions.pod:4807 ../fish/guestfish-actions.pod:3526
12683 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
12688 #: ../src/guestfs-actions.pod:4810 ../fish/guestfish-actions.pod:3529
12689 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
12693 #: ../src/guestfs-actions.pod:4812 ../fish/guestfish-actions.pod:3531
12695 "Note that you should call this function as early as possible after creating "
12696 "the handle. This is because some pre-launch operations depend on testing "
12697 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
12698 "don't retest features, and so you might see inconsistent results. Using the "
12699 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
12700 "the qemu binary at the same time as the handle is created."
12704 #: ../src/guestfs-actions.pod:4822
12705 msgid "guestfs_set_recovery_proc"
12709 #: ../src/guestfs-actions.pod:4824
12713 " guestfs_set_recovery_proc (guestfs_h *g,\n"
12714 " int recoveryproc);\n"
12719 #: ../src/guestfs-actions.pod:4828
12721 "If this is called with the parameter C<false> then C<guestfs_launch> does "
12722 "not create a recovery process. The purpose of the recovery process is to "
12723 "stop runaway qemu processes in the case where the main program aborts "
12728 #: ../src/guestfs-actions.pod:4833
12730 "This only has any effect if called before C<guestfs_launch>, and the default "
12735 #: ../src/guestfs-actions.pod:4836 ../fish/guestfish-actions.pod:3553
12737 "About the only time when you would want to disable this is if the main "
12738 "process will fork itself into the background (\"daemonize\" itself). In "
12739 "this case the recovery process thinks that the main program has disappeared "
12740 "and so kills qemu, which is not very helpful."
12744 #: ../src/guestfs-actions.pod:4844
12745 msgid "guestfs_set_selinux"
12749 #: ../src/guestfs-actions.pod:4846
12753 " guestfs_set_selinux (guestfs_h *g,\n"
12759 #: ../src/guestfs-actions.pod:4850 ../fish/guestfish-actions.pod:3565
12761 "This sets the selinux flag that is passed to the appliance at boot time. "
12762 "The default is C<selinux=0> (disabled)."
12766 #: ../src/guestfs-actions.pod:4853 ../fish/guestfish-actions.pod:3568
12768 "Note that if SELinux is enabled, it is always in Permissive mode "
12769 "(C<enforcing=0>)."
12773 #: ../src/guestfs-actions.pod:4861
12774 msgid "guestfs_set_trace"
12778 #: ../src/guestfs-actions.pod:4863
12782 " guestfs_set_trace (guestfs_h *g,\n"
12788 #: ../src/guestfs-actions.pod:4867 ../fish/guestfish-actions.pod:3580
12790 "If the command trace flag is set to 1, then commands are printed on stderr "
12791 "before they are executed in a format which is very similar to the one used "
12792 "by guestfish. In other words, you can run a program with this enabled, and "
12793 "you will get out a script which you can feed to guestfish to perform the "
12794 "same set of actions."
12798 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3587
12800 "If you want to trace C API calls into libguestfs (and other libraries) then "
12801 "possibly a better way is to use the external ltrace(1) command."
12805 #: ../src/guestfs-actions.pod:4878 ../fish/guestfish-actions.pod:3591
12807 "Command traces are disabled unless the environment variable "
12808 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
12812 #: ../src/guestfs-actions.pod:4883
12813 msgid "guestfs_set_verbose"
12817 #: ../src/guestfs-actions.pod:4885
12821 " guestfs_set_verbose (guestfs_h *g,\n"
12827 #: ../src/guestfs-actions.pod:4889 ../fish/guestfish-actions.pod:3600
12828 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
12832 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3602
12834 "Verbose messages are disabled unless the environment variable "
12835 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
12839 #: ../src/guestfs-actions.pod:4896
12840 msgid "guestfs_setcon"
12844 #: ../src/guestfs-actions.pod:4898
12848 " guestfs_setcon (guestfs_h *g,\n"
12849 " const char *context);\n"
12854 #: ../src/guestfs-actions.pod:4902 ../fish/guestfish-actions.pod:3609
12856 "This sets the SELinux security context of the daemon to the string "
12861 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3612
12862 msgid "See the documentation about SELINUX in L<guestfs(3)>."
12866 #: ../src/guestfs-actions.pod:4909
12867 msgid "guestfs_setxattr"
12871 #: ../src/guestfs-actions.pod:4911
12875 " guestfs_setxattr (guestfs_h *g,\n"
12876 " const char *xattr,\n"
12877 " const char *val,\n"
12879 " const char *path);\n"
12884 #: ../src/guestfs-actions.pod:4918 ../fish/guestfish-actions.pod:3618
12886 "This call sets the extended attribute named C<xattr> of the file C<path> to "
12887 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
12891 #: ../src/guestfs-actions.pod:4922
12892 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
12896 #: ../src/guestfs-actions.pod:4926
12897 msgid "guestfs_sfdisk"
12901 #: ../src/guestfs-actions.pod:4928
12905 " guestfs_sfdisk (guestfs_h *g,\n"
12906 " const char *device,\n"
12910 " char *const *lines);\n"
12915 #: ../src/guestfs-actions.pod:4936 ../fish/guestfish-actions.pod:3628
12917 "This is a direct interface to the L<sfdisk(8)> program for creating "
12918 "partitions on block devices."
12922 #: ../src/guestfs-actions.pod:4939 ../fish/guestfish-actions.pod:3631
12923 msgid "C<device> should be a block device, for example C</dev/sda>."
12927 #: ../src/guestfs-actions.pod:4941 ../fish/guestfish-actions.pod:3633
12929 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
12930 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
12931 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
12932 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
12933 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
12934 "the kernel) cannot work out the right geometry and you will need to tell it."
12938 #: ../src/guestfs-actions.pod:4949 ../fish/guestfish-actions.pod:3641
12940 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
12941 "refer to the L<sfdisk(8)> manpage."
12945 #: ../src/guestfs-actions.pod:4952 ../fish/guestfish-actions.pod:3644
12947 "To create a single partition occupying the whole disk, you would pass "
12948 "C<lines> as a single element list, when the single element being the string "
12953 #: ../src/guestfs-actions.pod:4956
12955 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
12959 #: ../src/guestfs-actions.pod:4964
12960 msgid "guestfs_sfdiskM"
12964 #: ../src/guestfs-actions.pod:4966
12968 " guestfs_sfdiskM (guestfs_h *g,\n"
12969 " const char *device,\n"
12970 " char *const *lines);\n"
12975 #: ../src/guestfs-actions.pod:4971
12977 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
12978 "partition sizes are specified in megabytes only (rounded to the nearest "
12979 "cylinder) and you don't need to specify the cyls, heads and sectors "
12980 "parameters which were rarely if ever used anyway."
12984 #: ../src/guestfs-actions.pod:4977
12986 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
12987 "C<guestfs_part_disk>"
12991 #: ../src/guestfs-actions.pod:4985
12992 msgid "guestfs_sfdisk_N"
12996 #: ../src/guestfs-actions.pod:4987
13000 " guestfs_sfdisk_N (guestfs_h *g,\n"
13001 " const char *device,\n"
13006 " const char *line);\n"
13011 #: ../src/guestfs-actions.pod:4996 ../fish/guestfish-actions.pod:3674
13013 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13014 "(note: C<n> counts from 1)."
13018 #: ../src/guestfs-actions.pod:4999
13020 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
13021 "for the cyls/heads/sectors parameters."
13025 #: ../src/guestfs-actions.pod:5002
13026 msgid "See also: C<guestfs_part_add>"
13030 #: ../src/guestfs-actions.pod:5009
13031 msgid "guestfs_sfdisk_disk_geometry"
13035 #: ../src/guestfs-actions.pod:5011
13039 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
13040 " const char *device);\n"
13045 #: ../src/guestfs-actions.pod:5015
13047 "This displays the disk geometry of C<device> read from the partition table. "
13048 "Especially in the case where the underlying block device has been resized, "
13049 "this can be different from the kernel's idea of the geometry (see "
13050 "C<guestfs_sfdisk_kernel_geometry>)."
13054 #: ../src/guestfs-actions.pod:5020 ../src/guestfs-actions.pod:5034
13055 #: ../fish/guestfish-actions.pod:3694 ../fish/guestfish-actions.pod:3703
13056 msgid "The result is in human-readable format, and not designed to be parsed."
13060 #: ../src/guestfs-actions.pod:5026
13061 msgid "guestfs_sfdisk_kernel_geometry"
13065 #: ../src/guestfs-actions.pod:5028
13069 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
13070 " const char *device);\n"
13075 #: ../src/guestfs-actions.pod:5032 ../fish/guestfish-actions.pod:3701
13076 msgid "This displays the kernel's idea of the geometry of C<device>."
13080 #: ../src/guestfs-actions.pod:5040
13081 msgid "guestfs_sfdisk_l"
13085 #: ../src/guestfs-actions.pod:5042
13089 " guestfs_sfdisk_l (guestfs_h *g,\n"
13090 " const char *device);\n"
13095 #: ../src/guestfs-actions.pod:5046 ../fish/guestfish-actions.pod:3710
13097 "This displays the partition table on C<device>, in the human-readable output "
13098 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13102 #: ../src/guestfs-actions.pod:5050
13103 msgid "See also: C<guestfs_part_list>"
13107 #: ../src/guestfs-actions.pod:5055
13112 #: ../src/guestfs-actions.pod:5057
13116 " guestfs_sh (guestfs_h *g,\n"
13117 " const char *command);\n"
13122 #: ../src/guestfs-actions.pod:5061 ../fish/guestfish-actions.pod:3720
13124 "This call runs a command from the guest filesystem via the guest's C</bin/"
13129 #: ../src/guestfs-actions.pod:5064
13130 msgid "This is like C<guestfs_command>, but passes the command to:"
13134 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3725
13137 " /bin/sh -c \"command\"\n"
13142 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3727
13144 "Depending on the guest's shell, this usually results in wildcards being "
13145 "expanded, shell expressions being interpolated and so on."
13149 #: ../src/guestfs-actions.pod:5072
13150 msgid "All the provisos about C<guestfs_command> apply to this call."
13154 #: ../src/guestfs-actions.pod:5077
13155 msgid "guestfs_sh_lines"
13159 #: ../src/guestfs-actions.pod:5079
13163 " guestfs_sh_lines (guestfs_h *g,\n"
13164 " const char *command);\n"
13169 #: ../src/guestfs-actions.pod:5083
13171 "This is the same as C<guestfs_sh>, but splits the result into a list of "
13176 #: ../src/guestfs-actions.pod:5086
13177 msgid "See also: C<guestfs_command_lines>"
13181 #: ../src/guestfs-actions.pod:5092
13182 msgid "guestfs_sleep"
13186 #: ../src/guestfs-actions.pod:5094
13190 " guestfs_sleep (guestfs_h *g,\n"
13196 #: ../src/guestfs-actions.pod:5098 ../fish/guestfish-actions.pod:3746
13197 msgid "Sleep for C<secs> seconds."
13201 #: ../src/guestfs-actions.pod:5102 ../src/guestfs-structs.pod:109
13202 msgid "guestfs_stat"
13206 #: ../src/guestfs-actions.pod:5104
13209 " struct guestfs_stat *\n"
13210 " guestfs_stat (guestfs_h *g,\n"
13211 " const char *path);\n"
13216 #: ../src/guestfs-actions.pod:5110 ../fish/guestfish-actions.pod:3754
13217 msgid "This is the same as the C<stat(2)> system call."
13221 #: ../src/guestfs-actions.pod:5116 ../src/guestfs-structs.pod:135
13222 msgid "guestfs_statvfs"
13226 #: ../src/guestfs-actions.pod:5118
13229 " struct guestfs_statvfs *\n"
13230 " guestfs_statvfs (guestfs_h *g,\n"
13231 " const char *path);\n"
13236 #: ../src/guestfs-actions.pod:5122 ../fish/guestfish-actions.pod:3760
13238 "Returns file system statistics for any mounted file system. C<path> should "
13239 "be a file or directory in the mounted file system (typically it is the mount "
13240 "point itself, but it doesn't need to be)."
13244 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3764
13245 msgid "This is the same as the C<statvfs(2)> system call."
13249 #: ../src/guestfs-actions.pod:5128
13251 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
13252 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
13256 #: ../src/guestfs-actions.pod:5132
13257 msgid "guestfs_strings"
13261 #: ../src/guestfs-actions.pod:5134
13265 " guestfs_strings (guestfs_h *g,\n"
13266 " const char *path);\n"
13271 #: ../src/guestfs-actions.pod:5138 ../fish/guestfish-actions.pod:3770
13273 "This runs the L<strings(1)> command on a file and returns the list of "
13274 "printable strings found."
13278 #: ../src/guestfs-actions.pod:5148
13279 msgid "guestfs_strings_e"
13283 #: ../src/guestfs-actions.pod:5150
13287 " guestfs_strings_e (guestfs_h *g,\n"
13288 " const char *encoding,\n"
13289 " const char *path);\n"
13294 #: ../src/guestfs-actions.pod:5155
13296 "This is like the C<guestfs_strings> command, but allows you to specify the "
13297 "encoding of strings that are looked for in the source file C<path>."
13301 #: ../src/guestfs-actions.pod:5159 ../fish/guestfish-actions.pod:3784
13302 msgid "Allowed encodings are:"
13306 #: ../src/guestfs-actions.pod:5163 ../fish/guestfish-actions.pod:3788
13311 #: ../src/guestfs-actions.pod:5165
13313 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13314 "ISO-8859-X (this is what C<guestfs_strings> uses)."
13318 #: ../src/guestfs-actions.pod:5168 ../fish/guestfish-actions.pod:3793
13323 #: ../src/guestfs-actions.pod:5170 ../fish/guestfish-actions.pod:3795
13324 msgid "Single 8-bit-byte characters."
13328 #: ../src/guestfs-actions.pod:5172 ../fish/guestfish-actions.pod:3797
13333 #: ../src/guestfs-actions.pod:5174 ../fish/guestfish-actions.pod:3799
13334 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13338 #: ../src/guestfs-actions.pod:5177 ../fish/guestfish-actions.pod:3802
13339 msgid "l (lower case letter L)"
13343 #: ../src/guestfs-actions.pod:5179 ../fish/guestfish-actions.pod:3804
13345 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
13346 "examining binaries in Windows guests."
13350 #: ../src/guestfs-actions.pod:5182 ../fish/guestfish-actions.pod:3807
13355 #: ../src/guestfs-actions.pod:5184 ../fish/guestfish-actions.pod:3809
13356 msgid "32-bit big endian such as UCS-4BE."
13360 #: ../src/guestfs-actions.pod:5186 ../fish/guestfish-actions.pod:3811
13365 #: ../src/guestfs-actions.pod:5188 ../fish/guestfish-actions.pod:3813
13366 msgid "32-bit little endian such as UCS-4LE."
13370 #: ../src/guestfs-actions.pod:5192 ../fish/guestfish-actions.pod:3817
13371 msgid "The returned strings are transcoded to UTF-8."
13375 #: ../src/guestfs-actions.pod:5201
13376 msgid "guestfs_swapoff_device"
13380 #: ../src/guestfs-actions.pod:5203
13384 " guestfs_swapoff_device (guestfs_h *g,\n"
13385 " const char *device);\n"
13390 #: ../src/guestfs-actions.pod:5207
13392 "This command disables the libguestfs appliance swap device or partition "
13393 "named C<device>. See C<guestfs_swapon_device>."
13397 #: ../src/guestfs-actions.pod:5213
13398 msgid "guestfs_swapoff_file"
13402 #: ../src/guestfs-actions.pod:5215
13406 " guestfs_swapoff_file (guestfs_h *g,\n"
13407 " const char *file);\n"
13412 #: ../src/guestfs-actions.pod:5219 ../fish/guestfish-actions.pod:3834
13413 msgid "This command disables the libguestfs appliance swap on file."
13417 #: ../src/guestfs-actions.pod:5223
13418 msgid "guestfs_swapoff_label"
13422 #: ../src/guestfs-actions.pod:5225
13426 " guestfs_swapoff_label (guestfs_h *g,\n"
13427 " const char *label);\n"
13432 #: ../src/guestfs-actions.pod:5229 ../fish/guestfish-actions.pod:3840
13434 "This command disables the libguestfs appliance swap on labeled swap "
13439 #: ../src/guestfs-actions.pod:5234
13440 msgid "guestfs_swapoff_uuid"
13444 #: ../src/guestfs-actions.pod:5236
13448 " guestfs_swapoff_uuid (guestfs_h *g,\n"
13449 " const char *uuid);\n"
13454 #: ../src/guestfs-actions.pod:5240 ../fish/guestfish-actions.pod:3847
13456 "This command disables the libguestfs appliance swap partition with the given "
13461 #: ../src/guestfs-actions.pod:5245
13462 msgid "guestfs_swapon_device"
13466 #: ../src/guestfs-actions.pod:5247
13470 " guestfs_swapon_device (guestfs_h *g,\n"
13471 " const char *device);\n"
13476 #: ../src/guestfs-actions.pod:5251
13478 "This command enables the libguestfs appliance to use the swap device or "
13479 "partition named C<device>. The increased memory is made available for all "
13480 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
13484 #: ../src/guestfs-actions.pod:5256 ../fish/guestfish-actions.pod:3859
13486 "Note that you should not swap to existing guest swap partitions unless you "
13487 "know what you are doing. They may contain hibernation information, or other "
13488 "information that the guest doesn't want you to trash. You also risk leaking "
13489 "information about the host to the guest this way. Instead, attach a new "
13490 "host device to the guest and swap on that."
13494 #: ../src/guestfs-actions.pod:5265
13495 msgid "guestfs_swapon_file"
13499 #: ../src/guestfs-actions.pod:5267
13503 " guestfs_swapon_file (guestfs_h *g,\n"
13504 " const char *file);\n"
13509 #: ../src/guestfs-actions.pod:5271
13511 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
13516 #: ../src/guestfs-actions.pod:5276
13517 msgid "guestfs_swapon_label"
13521 #: ../src/guestfs-actions.pod:5278
13525 " guestfs_swapon_label (guestfs_h *g,\n"
13526 " const char *label);\n"
13531 #: ../src/guestfs-actions.pod:5282
13533 "This command enables swap to a labeled swap partition. See "
13534 "C<guestfs_swapon_device> for other notes."
13538 #: ../src/guestfs-actions.pod:5287
13539 msgid "guestfs_swapon_uuid"
13543 #: ../src/guestfs-actions.pod:5289
13547 " guestfs_swapon_uuid (guestfs_h *g,\n"
13548 " const char *uuid);\n"
13553 #: ../src/guestfs-actions.pod:5293
13555 "This command enables swap to a swap partition with the given UUID. See "
13556 "C<guestfs_swapon_device> for other notes."
13560 #: ../src/guestfs-actions.pod:5298
13561 msgid "guestfs_sync"
13565 #: ../src/guestfs-actions.pod:5300
13569 " guestfs_sync (guestfs_h *g);\n"
13574 #: ../src/guestfs-actions.pod:5303 ../fish/guestfish-actions.pod:3891
13576 "This syncs the disk, so that any writes are flushed through to the "
13577 "underlying disk image."
13581 #: ../src/guestfs-actions.pod:5306 ../fish/guestfish-actions.pod:3894
13583 "You should always call this if you have modified a disk image, before "
13584 "closing the handle."
13588 #: ../src/guestfs-actions.pod:5311
13589 msgid "guestfs_tail"
13593 #: ../src/guestfs-actions.pod:5313
13597 " guestfs_tail (guestfs_h *g,\n"
13598 " const char *path);\n"
13603 #: ../src/guestfs-actions.pod:5317 ../fish/guestfish-actions.pod:3901
13605 "This command returns up to the last 10 lines of a file as a list of strings."
13609 #: ../src/guestfs-actions.pod:5327
13610 msgid "guestfs_tail_n"
13614 #: ../src/guestfs-actions.pod:5329
13618 " guestfs_tail_n (guestfs_h *g,\n"
13620 " const char *path);\n"
13625 #: ../src/guestfs-actions.pod:5334 ../fish/guestfish-actions.pod:3911
13627 "If the parameter C<nrlines> is a positive number, this returns the last "
13628 "C<nrlines> lines of the file C<path>."
13632 #: ../src/guestfs-actions.pod:5337 ../fish/guestfish-actions.pod:3914
13634 "If the parameter C<nrlines> is a negative number, this returns lines from "
13635 "the file C<path>, starting with the C<-nrlines>th line."
13639 #: ../src/guestfs-actions.pod:5349
13640 msgid "guestfs_tar_in"
13644 #: ../src/guestfs-actions.pod:5351
13648 " guestfs_tar_in (guestfs_h *g,\n"
13649 " const char *tarfile,\n"
13650 " const char *directory);\n"
13655 #: ../src/guestfs-actions.pod:5356 ../fish/guestfish-actions.pod:3926
13657 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
13658 "tar file) into C<directory>."
13662 #: ../src/guestfs-actions.pod:5359
13664 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
13668 #: ../src/guestfs-actions.pod:5364
13669 msgid "guestfs_tar_out"
13673 #: ../src/guestfs-actions.pod:5366
13677 " guestfs_tar_out (guestfs_h *g,\n"
13678 " const char *directory,\n"
13679 " const char *tarfile);\n"
13684 #: ../src/guestfs-actions.pod:5371 ../fish/guestfish-actions.pod:3938
13686 "This command packs the contents of C<directory> and downloads it to local "
13691 #: ../src/guestfs-actions.pod:5374
13693 "To download a compressed tarball, use C<guestfs_tgz_out> or "
13694 "C<guestfs_txz_out>."
13698 #: ../src/guestfs-actions.pod:5379
13699 msgid "guestfs_tgz_in"
13703 #: ../src/guestfs-actions.pod:5381
13707 " guestfs_tgz_in (guestfs_h *g,\n"
13708 " const char *tarball,\n"
13709 " const char *directory);\n"
13714 #: ../src/guestfs-actions.pod:5386 ../fish/guestfish-actions.pod:3950
13716 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
13717 "tar file) into C<directory>."
13721 #: ../src/guestfs-actions.pod:5389
13722 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
13726 #: ../src/guestfs-actions.pod:5393
13727 msgid "guestfs_tgz_out"
13731 #: ../src/guestfs-actions.pod:5395
13735 " guestfs_tgz_out (guestfs_h *g,\n"
13736 " const char *directory,\n"
13737 " const char *tarball);\n"
13742 #: ../src/guestfs-actions.pod:5400 ../fish/guestfish-actions.pod:3961
13744 "This command packs the contents of C<directory> and downloads it to local "
13749 #: ../src/guestfs-actions.pod:5403
13750 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
13754 #: ../src/guestfs-actions.pod:5407
13755 msgid "guestfs_touch"
13759 #: ../src/guestfs-actions.pod:5409
13763 " guestfs_touch (guestfs_h *g,\n"
13764 " const char *path);\n"
13769 #: ../src/guestfs-actions.pod:5413 ../fish/guestfish-actions.pod:3972
13771 "Touch acts like the L<touch(1)> command. It can be used to update the "
13772 "timestamps on a file, or, if the file does not exist, to create a new zero-"
13777 #: ../src/guestfs-actions.pod:5417 ../fish/guestfish-actions.pod:3976
13779 "This command only works on regular files, and will fail on other file types "
13780 "such as directories, symbolic links, block special etc."
13784 #: ../src/guestfs-actions.pod:5422
13785 msgid "guestfs_truncate"
13789 #: ../src/guestfs-actions.pod:5424
13793 " guestfs_truncate (guestfs_h *g,\n"
13794 " const char *path);\n"
13799 #: ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3983
13801 "This command truncates C<path> to a zero-length file. The file must exist "
13806 #: ../src/guestfs-actions.pod:5433
13807 msgid "guestfs_truncate_size"
13811 #: ../src/guestfs-actions.pod:5435
13815 " guestfs_truncate_size (guestfs_h *g,\n"
13816 " const char *path,\n"
13817 " int64_t size);\n"
13822 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3990
13824 "This command truncates C<path> to size C<size> bytes. The file must exist "
13829 #: ../src/guestfs-actions.pod:5443
13831 "If the current file size is less than C<size> then the file is extended to "
13832 "the required size with zero bytes. This creates a sparse file (ie. disk "
13833 "blocks are not allocated for the file until you write to it). To create a "
13834 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
13838 #: ../src/guestfs-actions.pod:5451
13839 msgid "guestfs_tune2fs_l"
13843 #: ../src/guestfs-actions.pod:5453
13847 " guestfs_tune2fs_l (guestfs_h *g,\n"
13848 " const char *device);\n"
13853 #: ../src/guestfs-actions.pod:5457 ../fish/guestfish-actions.pod:4003
13855 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
13860 #: ../src/guestfs-actions.pod:5460 ../fish/guestfish-actions.pod:4006
13862 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
13863 "for more details. The list of fields returned isn't clearly defined, and "
13864 "depends on both the version of C<tune2fs> that libguestfs was built against, "
13865 "and the filesystem itself."
13869 #: ../src/guestfs-actions.pod:5471
13870 msgid "guestfs_txz_in"
13874 #: ../src/guestfs-actions.pod:5473
13878 " guestfs_txz_in (guestfs_h *g,\n"
13879 " const char *tarball,\n"
13880 " const char *directory);\n"
13885 #: ../src/guestfs-actions.pod:5478 ../fish/guestfish-actions.pod:4015
13887 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
13888 "tar file) into C<directory>."
13892 #: ../src/guestfs-actions.pod:5483
13893 msgid "guestfs_txz_out"
13897 #: ../src/guestfs-actions.pod:5485
13901 " guestfs_txz_out (guestfs_h *g,\n"
13902 " const char *directory,\n"
13903 " const char *tarball);\n"
13908 #: ../src/guestfs-actions.pod:5490 ../fish/guestfish-actions.pod:4024
13910 "This command packs the contents of C<directory> and downloads it to local "
13911 "file C<tarball> (as an xz compressed tar archive)."
13915 #: ../src/guestfs-actions.pod:5495
13916 msgid "guestfs_umask"
13920 #: ../src/guestfs-actions.pod:5497
13924 " guestfs_umask (guestfs_h *g,\n"
13930 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:4033
13932 "This function sets the mask used for creating new files and device nodes to "
13937 #: ../src/guestfs-actions.pod:5504 ../fish/guestfish-actions.pod:4036
13939 "Typical umask values would be C<022> which creates new files with "
13940 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
13941 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
13945 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:4041
13947 "The default umask is C<022>. This is important because it means that "
13948 "directories and device nodes will be created with C<0644> or C<0755> mode "
13949 "even if you specify C<0777>."
13953 #: ../src/guestfs-actions.pod:5513
13955 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
13956 "C<guestfs_mkdir>."
13960 #: ../src/guestfs-actions.pod:5516 ../fish/guestfish-actions.pod:4048
13961 msgid "This call returns the previous umask."
13965 #: ../src/guestfs-actions.pod:5520
13966 msgid "guestfs_umount"
13970 #: ../src/guestfs-actions.pod:5522
13974 " guestfs_umount (guestfs_h *g,\n"
13975 " const char *pathordevice);\n"
13980 #: ../src/guestfs-actions.pod:5526 ../fish/guestfish-actions.pod:4056
13982 "This unmounts the given filesystem. The filesystem may be specified either "
13983 "by its mountpoint (path) or the device which contains the filesystem."
13987 #: ../src/guestfs-actions.pod:5532
13988 msgid "guestfs_umount_all"
13992 #: ../src/guestfs-actions.pod:5534
13996 " guestfs_umount_all (guestfs_h *g);\n"
14001 #: ../src/guestfs-actions.pod:5537 ../fish/guestfish-actions.pod:4066
14002 msgid "This unmounts all mounted filesystems."
14006 #: ../src/guestfs-actions.pod:5539 ../fish/guestfish-actions.pod:4068
14007 msgid "Some internal mounts are not unmounted by this call."
14011 #: ../src/guestfs-actions.pod:5543
14012 msgid "guestfs_upload"
14016 #: ../src/guestfs-actions.pod:5545
14020 " guestfs_upload (guestfs_h *g,\n"
14021 " const char *filename,\n"
14022 " const char *remotefilename);\n"
14027 #: ../src/guestfs-actions.pod:5550 ../src/guestfs-actions.pod:5567
14028 #: ../fish/guestfish-actions.pod:4074 ../fish/guestfish-actions.pod:4087
14029 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14033 #: ../src/guestfs-actions.pod:5555
14034 msgid "See also C<guestfs_download>."
14038 #: ../src/guestfs-actions.pod:5559
14039 msgid "guestfs_upload_offset"
14043 #: ../src/guestfs-actions.pod:5561
14047 " guestfs_upload_offset (guestfs_h *g,\n"
14048 " const char *filename,\n"
14049 " const char *remotefilename,\n"
14050 " int64_t offset);\n"
14055 #: ../src/guestfs-actions.pod:5570 ../fish/guestfish-actions.pod:4090
14057 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14058 "The intention is to overwrite parts of existing files or devices, although "
14059 "if a non-existant file is specified then it is created with a \"hole\" "
14060 "before C<offset>. The size of the data written is implicit in the size of "
14061 "the source C<filename>."
14065 #: ../src/guestfs-actions.pod:5577
14067 "Note that there is no limit on the amount of data that can be uploaded with "
14068 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
14069 "full amount unless an error occurs."
14073 #: ../src/guestfs-actions.pod:5582
14074 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
14078 #: ../src/guestfs-actions.pod:5586
14079 msgid "guestfs_utimens"
14083 #: ../src/guestfs-actions.pod:5588
14087 " guestfs_utimens (guestfs_h *g,\n"
14088 " const char *path,\n"
14089 " int64_t atsecs,\n"
14090 " int64_t atnsecs,\n"
14091 " int64_t mtsecs,\n"
14092 " int64_t mtnsecs);\n"
14097 #: ../src/guestfs-actions.pod:5596 ../fish/guestfish-actions.pod:4110
14098 msgid "This command sets the timestamps of a file with nanosecond precision."
14102 #: ../src/guestfs-actions.pod:5599 ../fish/guestfish-actions.pod:4113
14104 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14109 #: ../src/guestfs-actions.pod:5602 ../fish/guestfish-actions.pod:4116
14111 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14112 "nanoseconds from the epoch."
14116 #: ../src/guestfs-actions.pod:5605 ../fish/guestfish-actions.pod:4119
14118 "If the C<*nsecs> field contains the special value C<-1> then the "
14119 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14120 "ignored in this case)."
14124 #: ../src/guestfs-actions.pod:5609 ../fish/guestfish-actions.pod:4123
14126 "If the C<*nsecs> field contains the special value C<-2> then the "
14127 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14132 #: ../src/guestfs-actions.pod:5615 ../src/guestfs-structs.pod:175
14133 msgid "guestfs_version"
14137 #: ../src/guestfs-actions.pod:5617
14140 " struct guestfs_version *\n"
14141 " guestfs_version (guestfs_h *g);\n"
14146 #: ../src/guestfs-actions.pod:5620 ../fish/guestfish-actions.pod:4131
14148 "Return the libguestfs version number that the program is linked against."
14152 #: ../src/guestfs-actions.pod:5623 ../fish/guestfish-actions.pod:4134
14154 "Note that because of dynamic linking this is not necessarily the version of "
14155 "libguestfs that you compiled against. You can compile the program, and then "
14156 "at runtime dynamically link against a completely different C<libguestfs.so> "
14161 #: ../src/guestfs-actions.pod:5628 ../fish/guestfish-actions.pod:4139
14163 "This call was added in version C<1.0.58>. In previous versions of "
14164 "libguestfs there was no way to get the version number. From C code you can "
14165 "use dynamic linker functions to find out if this symbol exists (if it "
14166 "doesn't, then it's an earlier version)."
14170 #: ../src/guestfs-actions.pod:5634 ../fish/guestfish-actions.pod:4145
14172 "The call returns a structure with four elements. The first three (C<major>, "
14173 "C<minor> and C<release>) are numbers and correspond to the usual version "
14174 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14175 "but may be used for distro-specific information."
14179 #: ../src/guestfs-actions.pod:5640 ../fish/guestfish-actions.pod:4151
14181 "To construct the original version string: C<$major.$minor.$release$extra>"
14185 #: ../src/guestfs-actions.pod:5643 ../fish/guestfish-actions.pod:4154
14186 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14190 #: ../src/guestfs-actions.pod:5645
14192 "I<Note:> Don't use this call to test for availability of features. In "
14193 "enterprise distributions we backport features from later versions into "
14194 "earlier versions, making this an unreliable way to test for features. Use "
14195 "C<guestfs_available> instead."
14199 #: ../src/guestfs-actions.pod:5651
14201 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
14202 "error. I<The caller must call C<guestfs_free_version> after use>."
14206 #: ../src/guestfs-actions.pod:5655
14207 msgid "guestfs_vfs_label"
14211 #: ../src/guestfs-actions.pod:5657
14215 " guestfs_vfs_label (guestfs_h *g,\n"
14216 " const char *device);\n"
14221 #: ../src/guestfs-actions.pod:5661 ../fish/guestfish-actions.pod:4166
14222 msgid "This returns the filesystem label of the filesystem on C<device>."
14226 #: ../src/guestfs-actions.pod:5664 ../fish/guestfish-actions.pod:4169
14227 msgid "If the filesystem is unlabeled, this returns the empty string."
14231 #: ../src/guestfs-actions.pod:5666
14232 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
14236 #: ../src/guestfs-actions.pod:5671
14237 msgid "guestfs_vfs_type"
14241 #: ../src/guestfs-actions.pod:5673
14245 " guestfs_vfs_type (guestfs_h *g,\n"
14246 " const char *device);\n"
14251 #: ../src/guestfs-actions.pod:5677 ../fish/guestfish-actions.pod:4177
14253 "This command gets the filesystem type corresponding to the filesystem on "
14258 #: ../src/guestfs-actions.pod:5680 ../fish/guestfish-actions.pod:4180
14260 "For most filesystems, the result is the name of the Linux VFS module which "
14261 "would be used to mount this filesystem if you mounted it without specifying "
14262 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14266 #: ../src/guestfs-actions.pod:5688
14267 msgid "guestfs_vfs_uuid"
14271 #: ../src/guestfs-actions.pod:5690
14275 " guestfs_vfs_uuid (guestfs_h *g,\n"
14276 " const char *device);\n"
14281 #: ../src/guestfs-actions.pod:5694 ../fish/guestfish-actions.pod:4189
14282 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14286 #: ../src/guestfs-actions.pod:5697 ../fish/guestfish-actions.pod:4192
14287 msgid "If the filesystem does not have a UUID, this returns the empty string."
14291 #: ../src/guestfs-actions.pod:5699
14292 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
14296 #: ../src/guestfs-actions.pod:5704
14297 msgid "guestfs_vg_activate"
14301 #: ../src/guestfs-actions.pod:5706
14305 " guestfs_vg_activate (guestfs_h *g,\n"
14307 " char *const *volgroups);\n"
14312 #: ../src/guestfs-actions.pod:5711 ../fish/guestfish-actions.pod:4200
14314 "This command activates or (if C<activate> is false) deactivates all logical "
14315 "volumes in the listed volume groups C<volgroups>. If activated, then they "
14316 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
14317 "deactivated, then those devices disappear."
14321 #: ../src/guestfs-actions.pod:5717 ../fish/guestfish-actions.pod:4206
14322 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14326 #: ../src/guestfs-actions.pod:5719 ../fish/guestfish-actions.pod:4208
14328 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14329 "activated or deactivated."
14333 #: ../src/guestfs-actions.pod:5724
14334 msgid "guestfs_vg_activate_all"
14338 #: ../src/guestfs-actions.pod:5726
14342 " guestfs_vg_activate_all (guestfs_h *g,\n"
14343 " int activate);\n"
14348 #: ../src/guestfs-actions.pod:5730 ../fish/guestfish-actions.pod:4215
14350 "This command activates or (if C<activate> is false) deactivates all logical "
14351 "volumes in all volume groups. If activated, then they are made known to the "
14352 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
14353 "those devices disappear."
14357 #: ../src/guestfs-actions.pod:5736 ../fish/guestfish-actions.pod:4221
14358 msgid "This command is the same as running C<vgchange -a y|n>"
14362 #: ../src/guestfs-actions.pod:5740
14363 msgid "guestfs_vgcreate"
14367 #: ../src/guestfs-actions.pod:5742
14371 " guestfs_vgcreate (guestfs_h *g,\n"
14372 " const char *volgroup,\n"
14373 " char *const *physvols);\n"
14378 #: ../src/guestfs-actions.pod:5747 ../fish/guestfish-actions.pod:4227
14380 "This creates an LVM volume group called C<volgroup> from the non-empty list "
14381 "of physical volumes C<physvols>."
14385 #: ../src/guestfs-actions.pod:5752
14386 msgid "guestfs_vglvuuids"
14390 #: ../src/guestfs-actions.pod:5754
14394 " guestfs_vglvuuids (guestfs_h *g,\n"
14395 " const char *vgname);\n"
14400 #: ../src/guestfs-actions.pod:5758 ../fish/guestfish-actions.pod:4234
14402 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
14403 "volumes created in this volume group."
14407 #: ../src/guestfs-actions.pod:5761
14409 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
14410 "associate logical volumes and volume groups."
14414 #: ../src/guestfs-actions.pod:5764
14415 msgid "See also C<guestfs_vgpvuuids>."
14419 #: ../src/guestfs-actions.pod:5770
14420 msgid "guestfs_vgpvuuids"
14424 #: ../src/guestfs-actions.pod:5772
14428 " guestfs_vgpvuuids (guestfs_h *g,\n"
14429 " const char *vgname);\n"
14434 #: ../src/guestfs-actions.pod:5776 ../fish/guestfish-actions.pod:4246
14436 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
14437 "volumes that this volume group resides on."
14441 #: ../src/guestfs-actions.pod:5779
14443 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
14444 "associate physical volumes and volume groups."
14448 #: ../src/guestfs-actions.pod:5782
14449 msgid "See also C<guestfs_vglvuuids>."
14453 #: ../src/guestfs-actions.pod:5788
14454 msgid "guestfs_vgremove"
14458 #: ../src/guestfs-actions.pod:5790
14462 " guestfs_vgremove (guestfs_h *g,\n"
14463 " const char *vgname);\n"
14468 #: ../src/guestfs-actions.pod:5794 ../fish/guestfish-actions.pod:4258
14469 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
14473 #: ../src/guestfs-actions.pod:5796 ../fish/guestfish-actions.pod:4260
14475 "This also forcibly removes all logical volumes in the volume group (if any)."
14479 #: ../src/guestfs-actions.pod:5801
14480 msgid "guestfs_vgrename"
14484 #: ../src/guestfs-actions.pod:5803
14488 " guestfs_vgrename (guestfs_h *g,\n"
14489 " const char *volgroup,\n"
14490 " const char *newvolgroup);\n"
14495 #: ../src/guestfs-actions.pod:5808 ../fish/guestfish-actions.pod:4267
14496 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
14500 #: ../src/guestfs-actions.pod:5812
14501 msgid "guestfs_vgs"
14505 #: ../src/guestfs-actions.pod:5814
14509 " guestfs_vgs (guestfs_h *g);\n"
14514 #: ../src/guestfs-actions.pod:5817 ../fish/guestfish-actions.pod:4273
14516 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
14521 #: ../src/guestfs-actions.pod:5820 ../fish/guestfish-actions.pod:4276
14523 "This returns a list of just the volume group names that were detected (eg. "
14528 #: ../src/guestfs-actions.pod:5823
14529 msgid "See also C<guestfs_vgs_full>."
14533 #: ../src/guestfs-actions.pod:5829
14534 msgid "guestfs_vgs_full"
14538 #: ../src/guestfs-actions.pod:5831
14541 " struct guestfs_lvm_vg_list *\n"
14542 " guestfs_vgs_full (guestfs_h *g);\n"
14547 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:4285
14549 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
14550 "> command. The \"full\" version includes all fields."
14554 #: ../src/guestfs-actions.pod:5837
14556 "This function returns a C<struct guestfs_lvm_vg_list *> (see E<lt>guestfs-"
14557 "structs.hE<gt>), or NULL if there was an error. I<The caller must call "
14558 "C<guestfs_free_lvm_vg_list> after use>."
14562 #: ../src/guestfs-actions.pod:5842
14563 msgid "guestfs_vgscan"
14567 #: ../src/guestfs-actions.pod:5844
14571 " guestfs_vgscan (guestfs_h *g);\n"
14576 #: ../src/guestfs-actions.pod:5847 ../fish/guestfish-actions.pod:4292
14578 "This rescans all block devices and rebuilds the list of LVM physical "
14579 "volumes, volume groups and logical volumes."
14583 #: ../src/guestfs-actions.pod:5852
14584 msgid "guestfs_vguuid"
14588 #: ../src/guestfs-actions.pod:5854
14592 " guestfs_vguuid (guestfs_h *g,\n"
14593 " const char *vgname);\n"
14598 #: ../src/guestfs-actions.pod:5858 ../fish/guestfish-actions.pod:4299
14599 msgid "This command returns the UUID of the LVM VG named C<vgname>."
14603 #: ../src/guestfs-actions.pod:5863
14604 msgid "guestfs_wait_ready"
14608 #: ../src/guestfs-actions.pod:5865
14612 " guestfs_wait_ready (guestfs_h *g);\n"
14617 #: ../src/guestfs-actions.pod:5868
14618 msgid "This function is a no op."
14622 #: ../src/guestfs-actions.pod:5870
14624 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
14625 "calling C<guestfs_launch> to wait for the launch to complete. However this "
14626 "is no longer necessary because C<guestfs_launch> now does the waiting."
14630 #: ../src/guestfs-actions.pod:5875
14632 "If you see any calls to this function in code then you can just remove them, "
14633 "unless you want to retain compatibility with older versions of the API."
14637 #: ../src/guestfs-actions.pod:5881
14638 msgid "guestfs_wc_c"
14642 #: ../src/guestfs-actions.pod:5883
14646 " guestfs_wc_c (guestfs_h *g,\n"
14647 " const char *path);\n"
14652 #: ../src/guestfs-actions.pod:5887 ../fish/guestfish-actions.pod:4305
14654 "This command counts the characters in a file, using the C<wc -c> external "
14659 #: ../src/guestfs-actions.pod:5892
14660 msgid "guestfs_wc_l"
14664 #: ../src/guestfs-actions.pod:5894
14668 " guestfs_wc_l (guestfs_h *g,\n"
14669 " const char *path);\n"
14674 #: ../src/guestfs-actions.pod:5898 ../fish/guestfish-actions.pod:4312
14676 "This command counts the lines in a file, using the C<wc -l> external command."
14680 #: ../src/guestfs-actions.pod:5903
14681 msgid "guestfs_wc_w"
14685 #: ../src/guestfs-actions.pod:5905
14689 " guestfs_wc_w (guestfs_h *g,\n"
14690 " const char *path);\n"
14695 #: ../src/guestfs-actions.pod:5909 ../fish/guestfish-actions.pod:4319
14697 "This command counts the words in a file, using the C<wc -w> external command."
14701 #: ../src/guestfs-actions.pod:5914
14702 msgid "guestfs_write"
14706 #: ../src/guestfs-actions.pod:5916
14710 " guestfs_write (guestfs_h *g,\n"
14711 " const char *path,\n"
14712 " const char *content,\n"
14713 " size_t content_size);\n"
14718 #: ../src/guestfs-actions.pod:5922 ../fish/guestfish-actions.pod:4326
14720 "This call creates a file called C<path>. The content of the file is the "
14721 "string C<content> (which can contain any 8 bit data)."
14725 #: ../src/guestfs-actions.pod:5930
14726 msgid "guestfs_write_file"
14730 #: ../src/guestfs-actions.pod:5932
14734 " guestfs_write_file (guestfs_h *g,\n"
14735 " const char *path,\n"
14736 " const char *content,\n"
14742 #: ../src/guestfs-actions.pod:5938 ../fish/guestfish-actions.pod:4336
14744 "This call creates a file called C<path>. The contents of the file is the "
14745 "string C<content> (which can contain any 8 bit data), with length C<size>."
14749 #: ../src/guestfs-actions.pod:5942 ../fish/guestfish-actions.pod:4340
14751 "As a special case, if C<size> is C<0> then the length is calculated using "
14752 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
14756 #: ../src/guestfs-actions.pod:5946 ../fish/guestfish-actions.pod:4344
14758 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
14759 "I<not> work, even if the length is specified."
14763 #: ../src/guestfs-actions.pod:5954 ../fish/guestfish-actions.pod:4350
14765 "This function is deprecated. In new code, use the C<write> call instead."
14769 #: ../src/guestfs-actions.pod:5961
14770 msgid "guestfs_zegrep"
14774 #: ../src/guestfs-actions.pod:5963
14778 " guestfs_zegrep (guestfs_h *g,\n"
14779 " const char *regex,\n"
14780 " const char *path);\n"
14785 #: ../src/guestfs-actions.pod:5968 ../fish/guestfish-actions.pod:4361
14787 "This calls the external C<zegrep> program and returns the matching lines."
14791 #: ../src/guestfs-actions.pod:5978
14792 msgid "guestfs_zegrepi"
14796 #: ../src/guestfs-actions.pod:5980
14800 " guestfs_zegrepi (guestfs_h *g,\n"
14801 " const char *regex,\n"
14802 " const char *path);\n"
14807 #: ../src/guestfs-actions.pod:5985 ../fish/guestfish-actions.pod:4371
14809 "This calls the external C<zegrep -i> program and returns the matching lines."
14813 #: ../src/guestfs-actions.pod:5995
14814 msgid "guestfs_zero"
14818 #: ../src/guestfs-actions.pod:5997
14822 " guestfs_zero (guestfs_h *g,\n"
14823 " const char *device);\n"
14828 #: ../src/guestfs-actions.pod:6001 ../fish/guestfish-actions.pod:4381
14829 msgid "This command writes zeroes over the first few blocks of C<device>."
14833 #: ../src/guestfs-actions.pod:6003 ../fish/guestfish-actions.pod:4383
14835 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
14836 "securely wipe the device). It should be sufficient to remove any partition "
14837 "tables, filesystem superblocks and so on."
14841 #: ../src/guestfs-actions.pod:6007
14842 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
14846 #: ../src/guestfs-actions.pod:6016
14847 msgid "guestfs_zero_device"
14851 #: ../src/guestfs-actions.pod:6018
14855 " guestfs_zero_device (guestfs_h *g,\n"
14856 " const char *device);\n"
14861 #: ../src/guestfs-actions.pod:6022
14863 "This command writes zeroes over the entire C<device>. Compare with "
14864 "C<guestfs_zero> which just zeroes the first few blocks of a device."
14868 #: ../src/guestfs-actions.pod:6036
14869 msgid "guestfs_zerofree"
14873 #: ../src/guestfs-actions.pod:6038
14877 " guestfs_zerofree (guestfs_h *g,\n"
14878 " const char *device);\n"
14883 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:4404
14885 "This runs the I<zerofree> program on C<device>. This program claims to zero "
14886 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
14887 "possible to compress the filesystem more effectively."
14891 #: ../src/guestfs-actions.pod:6047 ../fish/guestfish-actions.pod:4409
14892 msgid "You should B<not> run this program if the filesystem is mounted."
14896 #: ../src/guestfs-actions.pod:6050 ../fish/guestfish-actions.pod:4412
14898 "It is possible that using this program can damage the filesystem or data on "
14903 #: ../src/guestfs-actions.pod:6055
14904 msgid "guestfs_zfgrep"
14908 #: ../src/guestfs-actions.pod:6057
14912 " guestfs_zfgrep (guestfs_h *g,\n"
14913 " const char *pattern,\n"
14914 " const char *path);\n"
14919 #: ../src/guestfs-actions.pod:6062 ../fish/guestfish-actions.pod:4419
14921 "This calls the external C<zfgrep> program and returns the matching lines."
14925 #: ../src/guestfs-actions.pod:6072
14926 msgid "guestfs_zfgrepi"
14930 #: ../src/guestfs-actions.pod:6074
14934 " guestfs_zfgrepi (guestfs_h *g,\n"
14935 " const char *pattern,\n"
14936 " const char *path);\n"
14941 #: ../src/guestfs-actions.pod:6079 ../fish/guestfish-actions.pod:4429
14943 "This calls the external C<zfgrep -i> program and returns the matching lines."
14947 #: ../src/guestfs-actions.pod:6089
14948 msgid "guestfs_zfile"
14952 #: ../src/guestfs-actions.pod:6091
14956 " guestfs_zfile (guestfs_h *g,\n"
14957 " const char *meth,\n"
14958 " const char *path);\n"
14963 #: ../src/guestfs-actions.pod:6096 ../fish/guestfish-actions.pod:4439
14965 "This command runs C<file> after first decompressing C<path> using C<method>."
14969 #: ../src/guestfs-actions.pod:6099 ../fish/guestfish-actions.pod:4442
14970 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
14974 #: ../src/guestfs-actions.pod:6101
14976 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
14981 #: ../src/guestfs-actions.pod:6107 ../fish/guestfish-actions.pod:4447
14983 "This function is deprecated. In new code, use the C<file> call instead."
14987 #: ../src/guestfs-actions.pod:6114
14988 msgid "guestfs_zgrep"
14992 #: ../src/guestfs-actions.pod:6116
14996 " guestfs_zgrep (guestfs_h *g,\n"
14997 " const char *regex,\n"
14998 " const char *path);\n"
15003 #: ../src/guestfs-actions.pod:6121 ../fish/guestfish-actions.pod:4458
15005 "This calls the external C<zgrep> program and returns the matching lines."
15009 #: ../src/guestfs-actions.pod:6131
15010 msgid "guestfs_zgrepi"
15014 #: ../src/guestfs-actions.pod:6133
15018 " guestfs_zgrepi (guestfs_h *g,\n"
15019 " const char *regex,\n"
15020 " const char *path);\n"
15025 #: ../src/guestfs-actions.pod:6138 ../fish/guestfish-actions.pod:4468
15027 "This calls the external C<zgrep -i> program and returns the matching lines."
15031 #: ../src/guestfs-availability.pod:3
15036 #: ../src/guestfs-availability.pod:5
15038 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
15039 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
15040 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
15041 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
15042 "L</guestfs_aug_save> L</guestfs_aug_set>"
15046 #: ../src/guestfs-availability.pod:21
15051 #: ../src/guestfs-availability.pod:23
15053 "The following functions: L</guestfs_inotify_add_watch> L</"
15054 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
15055 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
15059 #: ../src/guestfs-availability.pod:31
15060 msgid "B<linuxfsuuid>"
15064 #: ../src/guestfs-availability.pod:33
15066 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
15067 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
15071 #: ../src/guestfs-availability.pod:40
15072 msgid "B<linuxmodules>"
15076 #: ../src/guestfs-availability.pod:42
15077 msgid "The following functions: L</guestfs_modprobe>"
15081 #: ../src/guestfs-availability.pod:45
15082 msgid "B<linuxxattrs>"
15086 #: ../src/guestfs-availability.pod:47
15088 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> L</"
15089 "guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</"
15090 "guestfs_removexattr> L</guestfs_setxattr>"
15094 #: ../src/guestfs-availability.pod:56
15099 #: ../src/guestfs-availability.pod:58
15101 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
15102 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
15103 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
15107 #: ../src/guestfs-availability.pod:67
15112 #: ../src/guestfs-availability.pod:69
15114 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
15115 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
15116 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
15117 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
15118 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
15119 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
15120 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
15124 #: ../src/guestfs-availability.pod:92
15129 #: ../src/guestfs-availability.pod:94
15131 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
15132 "guestfs_mknod_b> L</guestfs_mknod_c>"
15136 #: ../src/guestfs-availability.pod:100
15141 #: ../src/guestfs-availability.pod:102
15142 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
15146 #: ../src/guestfs-availability.pod:105
15147 msgid "B<ntfsprogs>"
15151 #: ../src/guestfs-availability.pod:107
15153 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
15157 #: ../src/guestfs-availability.pod:111
15158 msgid "B<realpath>"
15162 #: ../src/guestfs-availability.pod:113
15163 msgid "The following functions: L</guestfs_realpath>"
15167 #: ../src/guestfs-availability.pod:116
15172 #: ../src/guestfs-availability.pod:118
15174 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
15175 "guestfs_scrub_freespace>"
15179 #: ../src/guestfs-availability.pod:123
15184 #: ../src/guestfs-availability.pod:125
15185 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
15189 #: ../src/guestfs-availability.pod:129
15194 #: ../src/guestfs-availability.pod:131
15195 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
15199 #: ../src/guestfs-availability.pod:135
15200 msgid "B<zerofree>"
15204 #: ../src/guestfs-availability.pod:137
15205 msgid "The following functions: L</guestfs_zerofree>"
15209 #: ../src/guestfs-structs.pod:1
15210 msgid "guestfs_int_bool"
15214 #: ../src/guestfs-structs.pod:3
15217 " struct guestfs_int_bool {\n"
15225 #: ../src/guestfs-structs.pod:8
15228 " struct guestfs_int_bool_list {\n"
15229 " uint32_t len; /* Number of elements in list. */\n"
15230 " struct guestfs_int_bool *val; /* Elements. */\n"
15236 #: ../src/guestfs-structs.pod:13
15239 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
15240 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
15245 #: ../src/guestfs-structs.pod:16
15246 msgid "guestfs_lvm_pv"
15250 #: ../src/guestfs-structs.pod:18
15253 " struct guestfs_lvm_pv {\n"
15254 " char *pv_name;\n"
15255 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
15256 " char pv_uuid[32];\n"
15258 " uint64_t pv_size;\n"
15259 " uint64_t dev_size;\n"
15260 " uint64_t pv_free;\n"
15261 " uint64_t pv_used;\n"
15262 " char *pv_attr;\n"
15263 " int64_t pv_pe_count;\n"
15264 " int64_t pv_pe_alloc_count;\n"
15265 " char *pv_tags;\n"
15266 " uint64_t pe_start;\n"
15267 " int64_t pv_mda_count;\n"
15268 " uint64_t pv_mda_free;\n"
15274 #: ../src/guestfs-structs.pod:36
15277 " struct guestfs_lvm_pv_list {\n"
15278 " uint32_t len; /* Number of elements in list. */\n"
15279 " struct guestfs_lvm_pv *val; /* Elements. */\n"
15285 #: ../src/guestfs-structs.pod:41
15288 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
15289 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
15294 #: ../src/guestfs-structs.pod:44
15295 msgid "guestfs_lvm_vg"
15299 #: ../src/guestfs-structs.pod:46
15302 " struct guestfs_lvm_vg {\n"
15303 " char *vg_name;\n"
15304 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
15305 " char vg_uuid[32];\n"
15307 " char *vg_attr;\n"
15308 " uint64_t vg_size;\n"
15309 " uint64_t vg_free;\n"
15310 " char *vg_sysid;\n"
15311 " uint64_t vg_extent_size;\n"
15312 " int64_t vg_extent_count;\n"
15313 " int64_t vg_free_count;\n"
15314 " int64_t max_lv;\n"
15315 " int64_t max_pv;\n"
15316 " int64_t pv_count;\n"
15317 " int64_t lv_count;\n"
15318 " int64_t snap_count;\n"
15319 " int64_t vg_seqno;\n"
15320 " char *vg_tags;\n"
15321 " int64_t vg_mda_count;\n"
15322 " uint64_t vg_mda_free;\n"
15328 #: ../src/guestfs-structs.pod:69
15331 " struct guestfs_lvm_vg_list {\n"
15332 " uint32_t len; /* Number of elements in list. */\n"
15333 " struct guestfs_lvm_vg *val; /* Elements. */\n"
15339 #: ../src/guestfs-structs.pod:74
15342 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
15343 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
15348 #: ../src/guestfs-structs.pod:77
15349 msgid "guestfs_lvm_lv"
15353 #: ../src/guestfs-structs.pod:79
15356 " struct guestfs_lvm_lv {\n"
15357 " char *lv_name;\n"
15358 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
15359 " char lv_uuid[32];\n"
15360 " char *lv_attr;\n"
15361 " int64_t lv_major;\n"
15362 " int64_t lv_minor;\n"
15363 " int64_t lv_kernel_major;\n"
15364 " int64_t lv_kernel_minor;\n"
15365 " uint64_t lv_size;\n"
15366 " int64_t seg_count;\n"
15368 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
15369 " float snap_percent;\n"
15370 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
15371 " float copy_percent;\n"
15372 " char *move_pv;\n"
15373 " char *lv_tags;\n"
15374 " char *mirror_log;\n"
15375 " char *modules;\n"
15381 #: ../src/guestfs-structs.pod:101
15384 " struct guestfs_lvm_lv_list {\n"
15385 " uint32_t len; /* Number of elements in list. */\n"
15386 " struct guestfs_lvm_lv *val; /* Elements. */\n"
15392 #: ../src/guestfs-structs.pod:106
15395 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
15396 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
15401 #: ../src/guestfs-structs.pod:111
15404 " struct guestfs_stat {\n"
15408 " int64_t nlink;\n"
15413 " int64_t blksize;\n"
15414 " int64_t blocks;\n"
15415 " int64_t atime;\n"
15416 " int64_t mtime;\n"
15417 " int64_t ctime;\n"
15423 #: ../src/guestfs-structs.pod:127
15426 " struct guestfs_stat_list {\n"
15427 " uint32_t len; /* Number of elements in list. */\n"
15428 " struct guestfs_stat *val; /* Elements. */\n"
15434 #: ../src/guestfs-structs.pod:132
15437 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
15438 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
15443 #: ../src/guestfs-structs.pod:137
15446 " struct guestfs_statvfs {\n"
15447 " int64_t bsize;\n"
15448 " int64_t frsize;\n"
15449 " int64_t blocks;\n"
15450 " int64_t bfree;\n"
15451 " int64_t bavail;\n"
15452 " int64_t files;\n"
15453 " int64_t ffree;\n"
15454 " int64_t favail;\n"
15457 " int64_t namemax;\n"
15463 #: ../src/guestfs-structs.pod:151
15466 " struct guestfs_statvfs_list {\n"
15467 " uint32_t len; /* Number of elements in list. */\n"
15468 " struct guestfs_statvfs *val; /* Elements. */\n"
15474 #: ../src/guestfs-structs.pod:156
15477 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
15478 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
15483 #: ../src/guestfs-structs.pod:159
15484 msgid "guestfs_dirent"
15488 #: ../src/guestfs-structs.pod:161
15491 " struct guestfs_dirent {\n"
15500 #: ../src/guestfs-structs.pod:167
15503 " struct guestfs_dirent_list {\n"
15504 " uint32_t len; /* Number of elements in list. */\n"
15505 " struct guestfs_dirent *val; /* Elements. */\n"
15511 #: ../src/guestfs-structs.pod:172
15514 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
15515 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
15520 #: ../src/guestfs-structs.pod:177
15523 " struct guestfs_version {\n"
15524 " int64_t major;\n"
15525 " int64_t minor;\n"
15526 " int64_t release;\n"
15533 #: ../src/guestfs-structs.pod:184
15536 " struct guestfs_version_list {\n"
15537 " uint32_t len; /* Number of elements in list. */\n"
15538 " struct guestfs_version *val; /* Elements. */\n"
15544 #: ../src/guestfs-structs.pod:189
15547 " void guestfs_free_version (struct guestfs_free_version *);\n"
15548 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
15553 #: ../src/guestfs-structs.pod:192
15554 msgid "guestfs_xattr"
15558 #: ../src/guestfs-structs.pod:194
15561 " struct guestfs_xattr {\n"
15562 " char *attrname;\n"
15563 " /* The next two fields describe a byte array. */\n"
15564 " uint32_t attrval_len;\n"
15565 " char *attrval;\n"
15571 #: ../src/guestfs-structs.pod:201
15574 " struct guestfs_xattr_list {\n"
15575 " uint32_t len; /* Number of elements in list. */\n"
15576 " struct guestfs_xattr *val; /* Elements. */\n"
15582 #: ../src/guestfs-structs.pod:206
15585 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
15586 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
15591 #: ../src/guestfs-structs.pod:209
15592 msgid "guestfs_inotify_event"
15596 #: ../src/guestfs-structs.pod:211
15599 " struct guestfs_inotify_event {\n"
15600 " int64_t in_wd;\n"
15601 " uint32_t in_mask;\n"
15602 " uint32_t in_cookie;\n"
15603 " char *in_name;\n"
15609 #: ../src/guestfs-structs.pod:218
15612 " struct guestfs_inotify_event_list {\n"
15613 " uint32_t len; /* Number of elements in list. */\n"
15614 " struct guestfs_inotify_event *val; /* Elements. */\n"
15620 #: ../src/guestfs-structs.pod:223
15623 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
15624 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
15629 #: ../src/guestfs-structs.pod:226
15630 msgid "guestfs_partition"
15634 #: ../src/guestfs-structs.pod:228
15637 " struct guestfs_partition {\n"
15638 " int32_t part_num;\n"
15639 " uint64_t part_start;\n"
15640 " uint64_t part_end;\n"
15641 " uint64_t part_size;\n"
15647 #: ../src/guestfs-structs.pod:235
15650 " struct guestfs_partition_list {\n"
15651 " uint32_t len; /* Number of elements in list. */\n"
15652 " struct guestfs_partition *val; /* Elements. */\n"
15658 #: ../src/guestfs-structs.pod:240
15661 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
15662 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
15667 #: ../fish/guestfish.pod:5
15668 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
15672 #: ../fish/guestfish.pod:9
15675 " guestfish [--options] [commands]\n"
15680 #: ../fish/guestfish.pod:11
15688 #: ../fish/guestfish.pod:13
15691 " guestfish -a disk.img\n"
15696 #: ../fish/guestfish.pod:15
15699 " guestfish -a disk.img -m dev[:mountpoint]\n"
15704 #: ../fish/guestfish.pod:17
15707 " guestfish -d libvirt-domain\n"
15712 #: ../fish/guestfish.pod:19
15715 " guestfish -a disk.img -i\n"
15720 #: ../fish/guestfish.pod:21
15723 " guestfish -d libvirt-domain -i\n"
15728 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
15729 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
15730 #: ../tools/virt-rescue.pl:41
15735 #: ../fish/guestfish.pod:25
15737 "Using guestfish in read/write mode on live virtual machines can be "
15738 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
15739 "option to use guestfish safely if the disk image or virtual machine might be "
15744 #: ../fish/guestfish.pod:32
15746 "Guestfish is a shell and command-line tool for examining and modifying "
15747 "virtual machine filesystems. It uses libguestfs and exposes all of the "
15748 "functionality of the guestfs API, see L<guestfs(3)>."
15752 #: ../fish/guestfish.pod:36
15754 "Guestfish gives you structured access to the libguestfs API, from shell "
15755 "scripts or the command line or interactively. If you want to rescue a "
15756 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
15761 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:800
15762 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58
15763 #: ../tools/virt-resize.pl:66 ../tools/virt-cat.pl:50 ../tools/virt-tar.pl:45
15768 #: ../fish/guestfish.pod:43
15769 msgid "As an interactive shell"
15773 #: ../fish/guestfish.pod:45
15781 #: ../fish/guestfish.pod:47
15784 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
15785 " editing virtual machine filesystems.\n"
15790 #: ../fish/guestfish.pod:50
15793 " Type: 'help' for a list of commands\n"
15794 " 'man' to read the manual\n"
15795 " 'quit' to quit the shell\n"
15800 #: ../fish/guestfish.pod:54
15803 " ><fs> add-ro disk.img\n"
15805 " ><fs> list-filesystems\n"
15806 " /dev/sda1: ext4\n"
15807 " /dev/vg_guest/lv_root: ext4\n"
15808 " /dev/vg_guest/lv_swap: swap\n"
15809 " ><fs> mount /dev/vg_guest/lv_root /\n"
15810 " ><fs> cat /etc/fstab\n"
15812 " # Created by anaconda\n"
15819 #: ../fish/guestfish.pod:67
15820 msgid "From shell scripts"
15824 #: ../fish/guestfish.pod:69
15825 msgid "Create a new C</etc/motd> file in a guest or disk image:"
15829 #: ../fish/guestfish.pod:71
15832 " guestfish <<_EOF_\n"
15835 " mount /dev/vg_guest/lv_root /\n"
15836 " write /etc/motd \"Welcome, new users\"\n"
15842 #: ../fish/guestfish.pod:78
15843 msgid "List the LVM logical volumes in a disk image:"
15847 #: ../fish/guestfish.pod:80
15850 " guestfish -a disk.img --ro <<_EOF_\n"
15858 #: ../fish/guestfish.pod:85
15859 msgid "List all the filesystems in a disk image:"
15863 #: ../fish/guestfish.pod:87
15866 " guestfish -a disk.img --ro <<_EOF_\n"
15868 " list-filesystems\n"
15874 #: ../fish/guestfish.pod:92
15875 msgid "On one command line"
15879 #: ../fish/guestfish.pod:94
15880 msgid "Update C</etc/resolv.conf> in a guest:"
15884 #: ../fish/guestfish.pod:96
15888 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
15889 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
15894 #: ../fish/guestfish.pod:100
15895 msgid "Edit C</boot/grub/grub.conf> interactively:"
15899 #: ../fish/guestfish.pod:102
15902 " guestfish --add disk.img \\\n"
15903 " --mount /dev/vg_guest/lv_root \\\n"
15904 " --mount /dev/sda1:/boot \\\n"
15905 " edit /boot/grub/grub.conf\n"
15910 #: ../fish/guestfish.pod:107
15911 msgid "Mount disks automatically"
15915 #: ../fish/guestfish.pod:109
15917 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
15921 #: ../fish/guestfish.pod:112
15924 " guestfish --ro -a disk.img -i cat /etc/group\n"
15929 #: ../fish/guestfish.pod:114
15932 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
15937 #: ../fish/guestfish.pod:116
15938 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
15942 #: ../fish/guestfish.pod:118
15945 " guestfish -a disk.img -i edit /boot/grub/grub.conf\n"
15950 #: ../fish/guestfish.pod:120
15951 msgid "As a script interpreter"
15955 #: ../fish/guestfish.pod:122
15956 msgid "Create a 100MB disk containing an ext2-formatted partition:"
15960 #: ../fish/guestfish.pod:124
15963 " #!/usr/bin/guestfish -f\n"
15964 " sparse test1.img 100M\n"
15966 " part-disk /dev/sda mbr\n"
15967 " mkfs ext2 /dev/sda1\n"
15972 #: ../fish/guestfish.pod:130
15973 msgid "Start with a prepared disk"
15977 #: ../fish/guestfish.pod:132
15979 "An alternate way to create a 100MB disk called C<test1.img> containing a "
15980 "single ext2-formatted partition:"
15984 #: ../fish/guestfish.pod:135
15987 " guestfish -N fs\n"
15992 #: ../fish/guestfish.pod:137
15993 msgid "To list what is available do:"
15997 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:791
16000 " guestfish -N help | less\n"
16005 #: ../fish/guestfish.pod:141
16006 msgid "Remote control"
16010 #: ../fish/guestfish.pod:143
16013 " eval `guestfish --listen`\n"
16014 " guestfish --remote add-ro disk.img\n"
16015 " guestfish --remote run\n"
16016 " guestfish --remote lvs\n"
16021 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
16022 #: ../fuse/guestmount.pod:73 ../inspector/virt-inspector.pl:68
16023 #: ../tools/virt-edit.pl:72 ../tools/virt-win-reg.pl:171
16024 #: ../tools/virt-df.pl:71 ../tools/virt-ls.pl:78 ../tools/virt-resize.pl:257
16025 #: ../tools/virt-list-filesystems.pl:50 ../tools/virt-cat.pl:79
16026 #: ../tools/virt-tar.pl:98 ../tools/virt-rescue.pl:103
16027 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:51
16032 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:124
16033 #: ../inspector/virt-inspector.pl:76 ../tools/virt-edit.pl:80
16034 #: ../tools/virt-win-reg.pl:179 ../tools/virt-df.pl:79 ../tools/virt-ls.pl:86
16035 #: ../tools/virt-resize.pl:265 ../tools/virt-list-filesystems.pl:58
16036 #: ../tools/virt-cat.pl:87 ../tools/virt-tar.pl:106
16037 #: ../tools/virt-rescue.pl:111 ../tools/virt-make-fs.pl:161
16038 #: ../tools/virt-list-partitions.pl:59
16043 #: ../fish/guestfish.pod:154
16044 msgid "Displays general help on options."
16048 #: ../fish/guestfish.pod:156
16049 msgid "B<-h> | B<--cmd-help>"
16053 #: ../fish/guestfish.pod:158
16054 msgid "Lists all available guestfish commands."
16058 #: ../fish/guestfish.pod:160
16059 msgid "B<-h cmd> | B<--cmd-help cmd>"
16063 #: ../fish/guestfish.pod:162
16064 msgid "Displays detailed help on a single command C<cmd>."
16068 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
16069 msgid "B<-a image> | B<--add image>"
16073 #: ../fish/guestfish.pod:166
16074 msgid "Add a block device or virtual machine image to the shell."
16078 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
16080 "The format of the disk image is auto-detected. To override this and force a "
16081 "particular format use the I<--format=..> option."
16085 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
16086 msgid "B<-c URI> | B<--connect URI>"
16090 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
16092 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16093 "URI to use. The default is to use the default libvirt connection."
16097 #: ../fish/guestfish.pod:177 ../fuse/guestmount.pod:90
16098 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
16102 #: ../fish/guestfish.pod:179 ../fuse/guestmount.pod:92
16104 "Add disks from the named libvirt domain. If the I<--ro> option is also "
16105 "used, then any libvirt domain can be used. However in write mode, only "
16106 "libvirt domains which are shut down can be named here."
16110 #: ../fish/guestfish.pod:183
16111 msgid "B<-D> | B<--no-dest-paths>"
16115 #: ../fish/guestfish.pod:185
16117 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
16118 "to hit the tab key to complete paths on the guest filesystem, but this "
16119 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
16120 "allow this feature to be disabled."
16124 #: ../fish/guestfish.pod:190
16125 msgid "B<--echo-keys>"
16129 #: ../fish/guestfish.pod:192
16131 "When prompting for keys and passphrases, guestfish normally turns echoing "
16132 "off so you cannot see what you are typing. If you are not worried about "
16133 "Tempest attacks and there is no one else in the room you can specify this "
16134 "flag to see what you are typing."
16138 #: ../fish/guestfish.pod:197
16139 msgid "B<-f file> | B<--file file>"
16143 #: ../fish/guestfish.pod:199
16144 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
16148 #: ../fish/guestfish.pod:202
16151 " #!/usr/bin/guestfish -f\n"
16156 #: ../fish/guestfish.pod:204 ../fuse/guestmount.pod:108
16157 msgid "B<--format=raw|qcow2|..> | B<--format>"
16161 #: ../fish/guestfish.pod:206 ../fuse/guestmount.pod:110
16163 "The default for the I<-a> option is to auto-detect the format of the disk "
16164 "image. Using this forces the disk format for I<-a> options which follow on "
16165 "the command line. Using I<--format> with no argument switches back to auto-"
16166 "detection for subsequent I<-a> options."
16170 #: ../fish/guestfish.pod:211 ../fish/guestfish.pod:504
16171 #: ../inspector/virt-inspector.pl:549
16172 msgid "For example:"
16176 #: ../fish/guestfish.pod:213
16179 " guestfish --format=raw -a disk.img\n"
16184 #: ../fish/guestfish.pod:215
16185 msgid "forces raw format (no auto-detection) for C<disk.img>."
16189 #: ../fish/guestfish.pod:217
16192 " guestfish --format=raw -a disk.img --format -a another.img\n"
16197 #: ../fish/guestfish.pod:219
16199 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
16200 "detection for C<another.img>."
16204 #: ../fish/guestfish.pod:222
16206 "If you have untrusted raw-format guest disk images, you should use this "
16207 "option to specify the disk format. This avoids a possible security problem "
16208 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
16212 #: ../fish/guestfish.pod:227 ../fuse/guestmount.pod:128
16213 msgid "B<-i> | B<--inspector>"
16217 #: ../fish/guestfish.pod:229 ../fuse/guestmount.pod:130
16219 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
16220 "system and mount filesystems as they would be mounted on the real virtual "
16225 #: ../fish/guestfish.pod:233
16226 msgid "Typical usage is either:"
16230 #: ../fish/guestfish.pod:235
16233 " guestfish -d myguest -i\n"
16238 #: ../fish/guestfish.pod:237
16239 msgid "(for an inactive libvirt domain called I<myguest>), or:"
16243 #: ../fish/guestfish.pod:239
16246 " guestfish --ro -d myguest -i\n"
16251 #: ../fish/guestfish.pod:241
16252 msgid "(for active domains, readonly), or specify the block device directly:"
16256 #: ../fish/guestfish.pod:243
16259 " guestfish -a /dev/Guests/MyGuest -i\n"
16264 #: ../fish/guestfish.pod:245
16266 "Note that the command line syntax changed slightly over older versions of "
16267 "guestfish. You can still use the old syntax:"
16271 #: ../fish/guestfish.pod:248
16274 " guestfish [--ro] -i disk.img\n"
16279 #: ../fish/guestfish.pod:250
16282 " guestfish [--ro] -i libvirt-domain\n"
16287 #: ../fish/guestfish.pod:252
16288 msgid "B<--keys-from-stdin>"
16292 #: ../fish/guestfish.pod:254
16294 "Read key or passphrase parameters from stdin. The default is to try to read "
16295 "passphrases from the user by opening C</dev/tty>."
16299 #: ../fish/guestfish.pod:257
16300 msgid "B<--listen>"
16304 #: ../fish/guestfish.pod:259
16306 "Fork into the background and listen for remote commands. See section L</"
16307 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
16311 #: ../fish/guestfish.pod:262
16312 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
16316 #: ../fish/guestfish.pod:264
16317 msgid "Mount the named partition or logical volume on the given mountpoint."
16321 #: ../fish/guestfish.pod:266
16322 msgid "If the mountpoint is omitted, it defaults to C</>."
16326 #: ../fish/guestfish.pod:268
16327 msgid "You have to mount something on C</> before most commands will work."
16331 #: ../fish/guestfish.pod:270
16333 "If any I<-m> or I<--mount> options are given, the guest is automatically "
16338 #: ../fish/guestfish.pod:273
16340 "If you don't know what filesystems a disk image contains, you can either run "
16341 "guestfish without this option, then list the partitions and LVs available "
16342 "(see L</list-partitions> and L</lvs> commands), or you can use the L<virt-"
16343 "list-filesystems(1)> program."
16347 #: ../fish/guestfish.pod:278 ../fuse/guestmount.pod:142
16348 msgid "B<-n> | B<--no-sync>"
16352 #: ../fish/guestfish.pod:280
16354 "Disable autosync. This is enabled by default. See the discussion of "
16355 "autosync in the L<guestfs(3)> manpage."
16359 #: ../fish/guestfish.pod:283
16360 msgid "B<-N type> | B<--new type> | B<-N help>"
16364 #: ../fish/guestfish.pod:285
16366 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
16367 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
16368 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
16373 #: ../fish/guestfish.pod:290
16374 msgid "B<--progress-bars>"
16378 #: ../fish/guestfish.pod:292
16379 msgid "Enable progress bars, even when guestfish is used non-interactively."
16383 #: ../fish/guestfish.pod:294
16385 "Progress bars are enabled by default when guestfish is used as an "
16386 "interactive shell."
16390 #: ../fish/guestfish.pod:297
16391 msgid "B<--no-progress-bars>"
16395 #: ../fish/guestfish.pod:299
16396 msgid "Disable progress bars."
16400 #: ../fish/guestfish.pod:301
16401 msgid "B<--remote[=pid]>"
16405 #: ../fish/guestfish.pod:303
16407 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
16408 "CONTROL GUESTFISH OVER A SOCKET> below."
16412 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:184
16413 msgid "B<-r> | B<--ro>"
16417 #: ../fish/guestfish.pod:308
16419 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
16420 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
16424 #: ../fish/guestfish.pod:311 ../tools/virt-rescue.pl:187
16426 "The option must always be used if the disk image or virtual machine might be "
16427 "running, and is generally recommended in cases where you don't need write "
16428 "access to the disk."
16432 #: ../fish/guestfish.pod:315
16434 "Note that prepared disk images created with I<-N> are not affected by the "
16439 #: ../fish/guestfish.pod:318 ../fuse/guestmount.pod:194
16440 #: ../tools/virt-rescue.pl:195
16441 msgid "B<--selinux>"
16445 #: ../fish/guestfish.pod:320
16446 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
16450 #: ../fish/guestfish.pod:322 ../fuse/guestmount.pod:198
16451 msgid "B<-v> | B<--verbose>"
16455 #: ../fish/guestfish.pod:324
16457 "Enable very verbose messages. This is particularly useful if you find a bug."
16461 #: ../fish/guestfish.pod:327 ../fuse/guestmount.pod:202
16462 msgid "B<-V> | B<--version>"
16466 #: ../fish/guestfish.pod:329
16467 msgid "Display the guestfish / libguestfs version number and exit."
16471 #: ../fish/guestfish.pod:331
16476 #: ../fish/guestfish.pod:333
16477 msgid "Echo each command before executing it."
16481 #: ../fish/guestfish.pod:337
16482 msgid "COMMANDS ON COMMAND LINE"
16486 #: ../fish/guestfish.pod:339
16488 "Any additional (non-option) arguments are treated as commands to execute."
16492 #: ../fish/guestfish.pod:342
16494 "Commands to execute should be separated by a colon (C<:>), where the colon "
16495 "is a separate parameter. Thus:"
16499 #: ../fish/guestfish.pod:345
16502 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
16507 #: ../fish/guestfish.pod:347
16509 "If there are no additional arguments, then we enter a shell, either an "
16510 "interactive shell with a prompt (if the input is a terminal) or a non-"
16511 "interactive shell."
16515 #: ../fish/guestfish.pod:351
16517 "In either command line mode or non-interactive shell, the first command that "
16518 "gives an error causes the whole shell to exit. In interactive mode (with a "
16519 "prompt) if a command fails, you can continue to enter commands."
16523 #: ../fish/guestfish.pod:356
16524 msgid "USING launch (OR run)"
16528 #: ../fish/guestfish.pod:358
16530 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
16531 "then launch it, then mount any disks you need, and finally issue actions/"
16532 "commands. So the general order of the day is:"
16536 #: ../fish/guestfish.pod:366
16537 msgid "add or -a/--add"
16541 #: ../fish/guestfish.pod:370
16542 msgid "launch (aka run)"
16546 #: ../fish/guestfish.pod:374
16547 msgid "mount or -m/--mount"
16551 #: ../fish/guestfish.pod:378
16552 msgid "any other commands"
16556 #: ../fish/guestfish.pod:382
16558 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
16559 "guest before mounting or performing any other commands."
16563 #: ../fish/guestfish.pod:385
16565 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
16566 "I<--new> options were given then C<run> is done automatically, simply "
16567 "because guestfish can't perform the action you asked for without doing this."
16571 #: ../fish/guestfish.pod:390
16576 #: ../fish/guestfish.pod:392
16578 "You can quote ordinary parameters using either single or double quotes. For "
16583 #: ../fish/guestfish.pod:395
16586 " add \"file with a space.img\"\n"
16591 #: ../fish/guestfish.pod:397
16594 " rm '/file name'\n"
16599 #: ../fish/guestfish.pod:399
16607 #: ../fish/guestfish.pod:401
16609 "A few commands require a list of strings to be passed. For these, use a "
16610 "whitespace-separated list, enclosed in quotes. Strings containing "
16611 "whitespace to be passed through must be enclosed in single quotes. A "
16612 "literal single quote must be escaped with a backslash."
16616 #: ../fish/guestfish.pod:406
16619 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
16620 " command \"/bin/echo 'foo bar'\"\n"
16621 " command \"/bin/echo \\'foo\\'\"\n"
16626 #: ../fish/guestfish.pod:410
16627 msgid "OPTIONAL ARGUMENTS"
16631 #: ../fish/guestfish.pod:412
16633 "Some commands take optional arguments. These arguments appear in this "
16634 "documentation as C<[argname:..]>. You can use them as in these examples:"
16638 #: ../fish/guestfish.pod:416
16641 " add-drive-opts filename\n"
16646 #: ../fish/guestfish.pod:418
16649 " add-drive-opts filename readonly:true\n"
16654 #: ../fish/guestfish.pod:420
16657 " add-drive-opts filename format:qcow2 readonly:false\n"
16662 #: ../fish/guestfish.pod:422
16664 "Each optional argument can appear at most once. All optional arguments must "
16665 "appear after the required ones."
16669 #: ../fish/guestfish.pod:425
16674 #: ../fish/guestfish.pod:427
16676 "This section applies to all commands which can take integers as parameters."
16680 #: ../fish/guestfish.pod:430
16681 msgid "SIZE SUFFIX"
16685 #: ../fish/guestfish.pod:432
16687 "When the command takes a parameter measured in bytes, you can use one of the "
16688 "following suffixes to specify kilobytes, megabytes and larger sizes:"
16692 #: ../fish/guestfish.pod:438
16693 msgid "B<k> or B<K> or B<KiB>"
16697 #: ../fish/guestfish.pod:440
16698 msgid "The size in kilobytes (multiplied by 1024)."
16702 #: ../fish/guestfish.pod:442
16707 #: ../fish/guestfish.pod:444
16708 msgid "The size in SI 1000 byte units."
16712 #: ../fish/guestfish.pod:446
16713 msgid "B<M> or B<MiB>"
16717 #: ../fish/guestfish.pod:448
16718 msgid "The size in megabytes (multiplied by 1048576)."
16722 #: ../fish/guestfish.pod:450
16727 #: ../fish/guestfish.pod:452
16728 msgid "The size in SI 1000000 byte units."
16732 #: ../fish/guestfish.pod:454
16733 msgid "B<G> or B<GiB>"
16737 #: ../fish/guestfish.pod:456
16738 msgid "The size in gigabytes (multiplied by 2**30)."
16742 #: ../fish/guestfish.pod:458
16747 #: ../fish/guestfish.pod:460
16748 msgid "The size in SI 10**9 byte units."
16752 #: ../fish/guestfish.pod:462
16753 msgid "B<T> or B<TiB>"
16757 #: ../fish/guestfish.pod:464
16758 msgid "The size in terabytes (multiplied by 2**40)."
16762 #: ../fish/guestfish.pod:466
16767 #: ../fish/guestfish.pod:468
16768 msgid "The size in SI 10**12 byte units."
16772 #: ../fish/guestfish.pod:470
16773 msgid "B<P> or B<PiB>"
16777 #: ../fish/guestfish.pod:472
16778 msgid "The size in petabytes (multiplied by 2**50)."
16782 #: ../fish/guestfish.pod:474
16787 #: ../fish/guestfish.pod:476
16788 msgid "The size in SI 10**15 byte units."
16792 #: ../fish/guestfish.pod:478
16793 msgid "B<E> or B<EiB>"
16797 #: ../fish/guestfish.pod:480
16798 msgid "The size in exabytes (multiplied by 2**60)."
16802 #: ../fish/guestfish.pod:482
16807 #: ../fish/guestfish.pod:484
16808 msgid "The size in SI 10**18 byte units."
16812 #: ../fish/guestfish.pod:486
16813 msgid "B<Z> or B<ZiB>"
16817 #: ../fish/guestfish.pod:488
16818 msgid "The size in zettabytes (multiplied by 2**70)."
16822 #: ../fish/guestfish.pod:490
16827 #: ../fish/guestfish.pod:492
16828 msgid "The size in SI 10**21 byte units."
16832 #: ../fish/guestfish.pod:494
16833 msgid "B<Y> or B<YiB>"
16837 #: ../fish/guestfish.pod:496
16838 msgid "The size in yottabytes (multiplied by 2**80)."
16842 #: ../fish/guestfish.pod:498
16847 #: ../fish/guestfish.pod:500
16848 msgid "The size in SI 10**24 byte units."
16852 #: ../fish/guestfish.pod:506
16855 " truncate-size /file 1G\n"
16860 #: ../fish/guestfish.pod:508
16861 msgid "would truncate the file to 1 gigabyte."
16865 #: ../fish/guestfish.pod:510
16867 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
16868 "the parameter to L</memsize> is specified in megabytes already). Adding a "
16869 "suffix will probably not do what you expect."
16873 #: ../fish/guestfish.pod:514
16874 msgid "OCTAL AND HEXADECIMAL NUMBERS"
16878 #: ../fish/guestfish.pod:516
16880 "For specifying the radix (base) use the C convention: C<0> to prefix an "
16881 "octal number or C<0x> to prefix a hexadecimal number. For example:"
16885 #: ../fish/guestfish.pod:519
16888 " 1234 decimal number 1234\n"
16889 " 02322 octal number, equivalent to decimal 1234\n"
16890 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
16895 #: ../fish/guestfish.pod:523
16897 "When using the C<chmod> command, you almost always want to specify an octal "
16898 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
16899 "L<chmod(1)> program):"
16903 #: ../fish/guestfish.pod:527
16906 " chmod 0777 /public # OK\n"
16907 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
16912 #: ../fish/guestfish.pod:530
16914 "Commands that return numbers usually print them in decimal, but some "
16915 "commands print numbers in other radices (eg. C<umask> prints the mode in "
16916 "octal, preceeded by C<0>)."
16920 #: ../fish/guestfish.pod:534
16921 msgid "WILDCARDS AND GLOBBING"
16925 #: ../fish/guestfish.pod:536
16927 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
16928 "(globbing) by default. So for example the following will not do what you "
16933 #: ../fish/guestfish.pod:540
16941 #: ../fish/guestfish.pod:542
16943 "Assuming you don't have a directory called literally C</home/*> then the "
16944 "above command will return an error."
16948 #: ../fish/guestfish.pod:545
16949 msgid "To perform wildcard expansion, use the C<glob> command."
16953 #: ../fish/guestfish.pod:547
16956 " glob rm-rf /home/*\n"
16961 #: ../fish/guestfish.pod:549
16963 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
16964 "many times), equivalent to:"
16968 #: ../fish/guestfish.pod:552
16971 " rm-rf /home/jim\n"
16972 " rm-rf /home/joe\n"
16973 " rm-rf /home/mary\n"
16978 #: ../fish/guestfish.pod:556
16979 msgid "C<glob> only works on simple guest paths and not on device names."
16983 #: ../fish/guestfish.pod:558
16985 "If you have several parameters, each containing a wildcard, then glob will "
16986 "perform a Cartesian product."
16990 #: ../fish/guestfish.pod:561
16995 #: ../fish/guestfish.pod:563
16997 "Any line which starts with a I<#> character is treated as a comment and "
16998 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
16999 "a command. For example:"
17003 #: ../fish/guestfish.pod:567
17006 " # this is a comment\n"
17007 " # this is a comment\n"
17008 " foo # NOT a comment\n"
17013 #: ../fish/guestfish.pod:571
17014 msgid "Blank lines are also ignored."
17018 #: ../fish/guestfish.pod:573
17019 msgid "RUNNING COMMANDS LOCALLY"
17023 #: ../fish/guestfish.pod:575
17025 "Any line which starts with a I<!> character is treated as a command sent to "
17026 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
17030 #: ../fish/guestfish.pod:579
17034 " tgz-out /remote local/remote-data.tar.gz\n"
17039 #: ../fish/guestfish.pod:582
17041 "will create a directory C<local> on the host, and then export the contents "
17042 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17043 "(See C<tgz-out>)."
17047 #: ../fish/guestfish.pod:586
17049 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17050 "effect, due to the way that subprocesses work in Unix."
17054 #: ../fish/guestfish.pod:589
17059 #: ../fish/guestfish.pod:591
17061 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17062 "command (a guestfish command) to the second command (any host command). For "
17067 #: ../fish/guestfish.pod:595
17070 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17075 #: ../fish/guestfish.pod:597
17077 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17078 "program). The above command would list all accounts in the guest filesystem "
17079 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17083 #: ../fish/guestfish.pod:602
17086 " hexdump /bin/ls | head\n"
17087 " list-devices | tail -1\n"
17088 " tgz-out / - | tar ztf -\n"
17093 #: ../fish/guestfish.pod:606
17095 "The space before the pipe symbol is required, any space after the pipe "
17096 "symbol is optional. Everything after the pipe symbol is just passed "
17097 "straight to the host shell, so it can contain redirections, globs and "
17098 "anything else that makes sense on the host side."
17102 #: ../fish/guestfish.pod:611
17104 "To use a literal argument which begins with a pipe symbol, you have to quote "
17109 #: ../fish/guestfish.pod:614
17117 #: ../fish/guestfish.pod:616
17118 msgid "HOME DIRECTORIES"
17122 #: ../fish/guestfish.pod:618
17124 "If a parameter starts with the character C<~> then the tilde may be expanded "
17125 "as a home directory path (either C<~> for the current user's home directory, "
17126 "or C<~user> for another user)."
17130 #: ../fish/guestfish.pod:622
17132 "Note that home directory expansion happens for users known I<on the host>, "
17133 "not in the guest filesystem."
17137 #: ../fish/guestfish.pod:625
17139 "To use a literal argument which begins with a tilde, you have to quote it, "
17144 #: ../fish/guestfish.pod:628
17152 #: ../fish/guestfish.pod:632
17154 "Libguestfs has some support for Linux guests encrypted according to the "
17155 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17156 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
17157 "LUKS is supported."
17161 #: ../fish/guestfish.pod:637
17162 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17166 #: ../fish/guestfish.pod:639
17169 " ><fs> vfs-type /dev/sda2\n"
17175 #: ../fish/guestfish.pod:642
17177 "Then open those devices using L</luks-open>. This creates a device-mapper "
17178 "device called C</dev/mapper/luksdev>."
17182 #: ../fish/guestfish.pod:645
17185 " ><fs> luks-open /dev/sda2 luksdev\n"
17186 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17191 #: ../fish/guestfish.pod:648
17193 "Finally you have to tell LVM to scan for volume groups on the newly created "
17198 #: ../fish/guestfish.pod:651
17202 " vg-activate-all true\n"
17207 #: ../fish/guestfish.pod:654
17208 msgid "The logical volume(s) can now be mounted in the usual way."
17212 #: ../fish/guestfish.pod:656
17214 "Before closing a LUKS device you must unmount any logical volumes on it and "
17215 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17216 "one. Then you can close the mapper device:"
17220 #: ../fish/guestfish.pod:660
17223 " vg-activate false /dev/VG\n"
17224 " luks-close /dev/mapper/luksdev\n"
17229 #: ../fish/guestfish.pod:663
17230 msgid "WINDOWS PATHS"
17234 #: ../fish/guestfish.pod:665
17236 "If a path is prefixed with C<win:> then you can use Windows-style paths "
17237 "(with some limitations). The following commands are equivalent:"
17241 #: ../fish/guestfish.pod:668
17244 " file /WINDOWS/system32/config/system.LOG\n"
17249 #: ../fish/guestfish.pod:670
17252 " file win:/windows/system32/config/system.log\n"
17257 #: ../fish/guestfish.pod:672
17260 " file win:\\windows\\system32\\config\\system.log\n"
17265 #: ../fish/guestfish.pod:674
17268 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
17273 #: ../fish/guestfish.pod:676
17275 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
17276 "handles case insensitivity like Windows would. This only works in argument "
17277 "positions that expect a path."
17281 #: ../fish/guestfish.pod:680
17282 msgid "UPLOADING AND DOWNLOADING FILES"
17286 #: ../fish/guestfish.pod:682
17288 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
17289 "others which upload from or download to a local file, you can use the "
17290 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
17294 #: ../fish/guestfish.pod:686
17302 #: ../fish/guestfish.pod:688
17304 "reads stdin and creates from that a file C</foo> in the disk image, and:"
17308 #: ../fish/guestfish.pod:691
17311 " tar-out /etc - | tar tf -\n"
17316 #: ../fish/guestfish.pod:693
17318 "writes the tarball to stdout and then pipes that into the external \"tar\" "
17319 "command (see L</PIPES>)."
17323 #: ../fish/guestfish.pod:696
17325 "When using C<-> to read from stdin, the input is read up to the end of "
17326 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
17327 "some arbitrary end marker:"
17331 #: ../fish/guestfish.pod:700
17334 " upload -<<END /foo\n"
17343 #: ../fish/guestfish.pod:706
17345 "Any string of characters can be used instead of C<END>. The end marker must "
17346 "appear on a line of its own, without any preceeding or following characters "
17347 "(not even spaces)."
17351 #: ../fish/guestfish.pod:710
17353 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
17354 "upload local files (so-called \"FileIn\" parameters in the generator)."
17358 #: ../fish/guestfish.pod:713
17359 msgid "EXIT ON ERROR BEHAVIOUR"
17363 #: ../fish/guestfish.pod:715
17365 "By default, guestfish will ignore any errors when in interactive mode (ie. "
17366 "taking commands from a human over a tty), and will exit on the first error "
17367 "in non-interactive mode (scripts, commands given on the command line)."
17371 #: ../fish/guestfish.pod:720
17373 "If you prefix a command with a I<-> character, then that command will not "
17374 "cause guestfish to exit, even if that (one) command returns an error."
17378 #: ../fish/guestfish.pod:724
17379 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
17383 #: ../fish/guestfish.pod:726
17385 "Guestfish can be remote-controlled over a socket. This is useful "
17386 "particularly in shell scripts where you want to make several different "
17387 "changes to a filesystem, but you don't want the overhead of starting up a "
17388 "guestfish process each time."
17392 #: ../fish/guestfish.pod:731
17393 msgid "Start a guestfish server process using:"
17397 #: ../fish/guestfish.pod:733
17400 " eval `guestfish --listen`\n"
17405 #: ../fish/guestfish.pod:735
17406 msgid "and then send it commands by doing:"
17410 #: ../fish/guestfish.pod:737
17413 " guestfish --remote cmd [...]\n"
17418 #: ../fish/guestfish.pod:739
17419 msgid "To cause the server to exit, send it the exit command:"
17423 #: ../fish/guestfish.pod:741
17426 " guestfish --remote exit\n"
17431 #: ../fish/guestfish.pod:743
17433 "Note that the server will normally exit if there is an error in a command. "
17434 "You can change this in the usual way. See section L</EXIT ON ERROR "
17439 #: ../fish/guestfish.pod:747
17440 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
17444 #: ../fish/guestfish.pod:749
17446 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
17447 "is how the I<--remote> option knows where to send the commands. You can "
17448 "have several guestfish listener processes running using:"
17452 #: ../fish/guestfish.pod:753
17455 " eval `guestfish --listen`\n"
17456 " pid1=$GUESTFISH_PID\n"
17457 " eval `guestfish --listen`\n"
17458 " pid2=$GUESTFISH_PID\n"
17460 " guestfish --remote=$pid1 cmd\n"
17461 " guestfish --remote=$pid2 cmd\n"
17466 #: ../fish/guestfish.pod:761
17467 msgid "REMOTE CONTROL DETAILS"
17471 #: ../fish/guestfish.pod:763
17473 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
17474 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
17475 "and C<$PID> is the process ID of the server."
17479 #: ../fish/guestfish.pod:767
17480 msgid "Guestfish client and server versions must match exactly."
17484 #: ../fish/guestfish.pod:769
17485 msgid "PREPARED DISK IMAGES"
17489 #: ../fish/guestfish.pod:771
17491 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
17492 "preformatted disk images that guestfish can make for you to save typing. "
17493 "This is particularly useful for testing purposes. This option is used "
17494 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
17495 "can be mixed with I<-a>)."
17499 #: ../fish/guestfish.pod:777
17501 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
17502 "the second and so on. Existing files in the current directory are "
17507 #: ../fish/guestfish.pod:781
17509 "The type briefly describes how the disk should be sized, partitioned, how "
17510 "filesystem(s) should be created, and how content should be added. "
17511 "Optionally the type can be followed by extra parameters, separated by C<:> "
17512 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
17513 "allocated disk, containing a single partition, with the partition formatted "
17514 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
17519 #: ../fish/guestfish.pod:789
17520 msgid "To list the available types and any extra parameters they take, run:"
17524 #: ../fish/guestfish.pod:793
17526 "Note that the prepared filesystem is not mounted. You would usually have to "
17527 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
17531 #: ../fish/guestfish.pod:797
17533 "If any I<-N> or I<--new> options are given, the guest is automatically "
17538 #: ../fish/guestfish.pod:802
17539 msgid "Create a 100MB disk with an ext4-formatted partition:"
17543 #: ../fish/guestfish.pod:804
17546 " guestfish -N fs:ext4\n"
17551 #: ../fish/guestfish.pod:806
17552 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
17556 #: ../fish/guestfish.pod:808
17559 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
17564 #: ../fish/guestfish.pod:810
17565 msgid "Create a blank 200MB disk:"
17569 #: ../fish/guestfish.pod:812
17572 " guestfish -N disk:200M\n"
17577 #: ../fish/guestfish.pod:814
17578 msgid "PROGRESS BARS"
17582 #: ../fish/guestfish.pod:816
17584 "Some (not all) long-running commands send progress notification messages as "
17585 "they are running. Guestfish turns these messages into progress bars."
17589 #: ../fish/guestfish.pod:820
17591 "When a command that supports progress bars takes longer than two seconds to "
17592 "run, and if progress bars are enabled, then you will see one appearing below "
17597 #: ../fish/guestfish.pod:824
17600 " ><fs> copy-size /large-file /another-file 2048M\n"
17601 " / 10% [#####-----------------------------------------] 00:30\n"
17606 #: ../fish/guestfish.pod:827
17608 "The spinner on the left hand side moves round once for every progress "
17609 "notification received from the backend. This is a (reasonably) golden "
17610 "assurance that the command is \"doing something\" even if the progress bar "
17611 "is not moving, because the command is able to send the progress "
17612 "notifications. When the bar reaches 100% and the command finishes, the "
17613 "spinner disappears."
17617 #: ../fish/guestfish.pod:834
17619 "Progress bars are enabled by default when guestfish is used interactively. "
17620 "You can enable them even for non-interactive modes using I<--progress-bars>, "
17621 "and you can disable them completely using I<--no-progress-bars>."
17625 #: ../fish/guestfish.pod:839
17626 msgid "GUESTFISH COMMANDS"
17630 #: ../fish/guestfish.pod:841
17632 "The commands in this section are guestfish convenience commands, in other "
17633 "words, they are not part of the L<guestfs(3)> API."
17637 #: ../fish/guestfish.pod:844
17642 #: ../fish/guestfish.pod:846
17651 #: ../fish/guestfish.pod:849
17653 "Without any parameter, this lists all commands. With a C<cmd> parameter, "
17654 "this displays detailed help for a command."
17658 #: ../fish/guestfish.pod:852
17659 msgid "quit | exit"
17663 #: ../fish/guestfish.pod:854
17664 msgid "This exits guestfish. You can also use C<^D> key."
17668 #: ../fish/guestfish.pod:856
17669 msgid "@FISH_COMMANDS@"
17673 #: ../fish/guestfish.pod:858
17678 #: ../fish/guestfish.pod:862 ../test-tool/libguestfs-test-tool.pod:83
17683 #: ../fish/guestfish.pod:864
17685 "guestfish returns 0 if the commands completed without error, or 1 if there "
17690 #: ../fish/guestfish.pod:871
17695 #: ../fish/guestfish.pod:873
17697 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
17702 #: ../fish/guestfish.pod:876
17703 msgid "GUESTFISH_PID"
17707 #: ../fish/guestfish.pod:878
17709 "Used with the I<--remote> option to specify the remote guestfish process to "
17710 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
17714 #: ../fish/guestfish.pod:882
17719 #: ../fish/guestfish.pod:884
17721 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
17722 "not specified, the external L<hexedit(1)> program is used."
17726 #: ../fish/guestfish.pod:888
17731 #: ../fish/guestfish.pod:890
17733 "If compiled with GNU readline support, various files in the home directory "
17734 "can be used. See L</FILES>."
17738 #: ../fish/guestfish.pod:899
17740 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
17741 "effect as using the B<-v> option."
17745 #: ../fish/guestfish.pod:911
17747 "Set the path that guestfish uses to search for kernel and initrd.img. See "
17748 "the discussion of paths in L<guestfs(3)>."
17752 #: ../fish/guestfish.pod:922
17753 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
17757 #: ../fish/guestfish.pod:924
17762 #: ../fish/guestfish.pod:926
17764 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
17769 #: ../fish/guestfish.pod:941 ../test-tool/libguestfs-test-tool.pod:88
17774 #: ../fish/guestfish.pod:945
17775 msgid "$HOME/.guestfish"
17779 #: ../fish/guestfish.pod:947
17781 "If compiled with GNU readline support, then the command history is saved in "
17786 #: ../fish/guestfish.pod:950
17787 msgid "$HOME/.inputrc"
17791 #: ../fish/guestfish.pod:952
17792 msgid "/etc/inputrc"
17796 #: ../fish/guestfish.pod:954
17798 "If compiled with GNU readline support, then these files can be used to "
17799 "configure readline. For further information, please see L<readline(3)/"
17800 "INITIALIZATION FILE>."
17804 #: ../fish/guestfish.pod:958
17805 msgid "To write rules which only apply to guestfish, use:"
17809 #: ../fish/guestfish.pod:960
17819 #: ../fish/guestfish.pod:964
17821 "Variables that you can set in inputrc that change the behaviour of guestfish "
17822 "in useful ways include:"
17826 #: ../fish/guestfish.pod:969
17827 msgid "completion-ignore-case (default: on)"
17831 #: ../fish/guestfish.pod:971
17833 "By default, guestfish will ignore case when tab-completing paths on the "
17838 #: ../fish/guestfish.pod:974
17841 " set completion-ignore-case off\n"
17846 #: ../fish/guestfish.pod:976
17847 msgid "to make guestfish case sensitive."
17851 #: ../fish/guestfish.pod:980
17856 #: ../fish/guestfish.pod:982
17857 msgid "test2.img (etc)"
17861 #: ../fish/guestfish.pod:984
17863 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
17864 "will be created in the file C<test1.img> in the current directory. The "
17865 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
17866 "the same name will be overwritten."
17870 #: ../fish/guestfish.pod:993
17872 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
17873 "L<virt-edit(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, "
17874 "L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, "
17875 "L<virt-tar(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
17879 #: ../fish/guestfish.pod:1017 ../test-tool/libguestfs-test-tool.pod:124
17880 #: ../fuse/guestmount.pod:234 ../inspector/virt-inspector.pl:598
17881 #: ../tools/virt-edit.pl:370 ../tools/virt-win-reg.pl:518
17882 #: ../tools/virt-df.pl:657 ../tools/virt-ls.pl:251
17883 #: ../tools/virt-resize.pl:1516 ../tools/virt-list-filesystems.pl:206
17884 #: ../tools/virt-cat.pl:203 ../tools/virt-tar.pl:300
17885 #: ../tools/virt-rescue.pl:285 ../tools/virt-make-fs.pl:567
17886 #: ../tools/virt-list-partitions.pl:273
17888 "This program is free software; you can redistribute it and/or modify it "
17889 "under the terms of the GNU General Public License as published by the Free "
17890 "Software Foundation; either version 2 of the License, or (at your option) "
17891 "any later version."
17895 #: ../fish/guestfish.pod:1022 ../test-tool/libguestfs-test-tool.pod:129
17896 #: ../fuse/guestmount.pod:239 ../inspector/virt-inspector.pl:603
17897 #: ../tools/virt-edit.pl:375 ../tools/virt-win-reg.pl:523
17898 #: ../tools/virt-df.pl:662 ../tools/virt-ls.pl:256
17899 #: ../tools/virt-resize.pl:1521 ../tools/virt-list-filesystems.pl:211
17900 #: ../tools/virt-cat.pl:208 ../tools/virt-tar.pl:305
17901 #: ../tools/virt-rescue.pl:290 ../tools/virt-make-fs.pl:572
17902 #: ../tools/virt-list-partitions.pl:278
17904 "This program is distributed in the hope that it will be useful, but WITHOUT "
17905 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
17906 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
17911 #: ../fish/guestfish.pod:1027 ../test-tool/libguestfs-test-tool.pod:134
17912 #: ../fuse/guestmount.pod:244 ../inspector/virt-inspector.pl:608
17913 #: ../tools/virt-edit.pl:380 ../tools/virt-win-reg.pl:528
17914 #: ../tools/virt-df.pl:667 ../tools/virt-ls.pl:261
17915 #: ../tools/virt-resize.pl:1526 ../tools/virt-list-filesystems.pl:216
17916 #: ../tools/virt-cat.pl:213 ../tools/virt-tar.pl:310
17917 #: ../tools/virt-rescue.pl:295 ../tools/virt-make-fs.pl:577
17918 #: ../tools/virt-list-partitions.pl:283
17920 "You should have received a copy of the GNU General Public License along with "
17921 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
17922 "Ave, Cambridge, MA 02139, USA."
17926 #: ../fish/guestfish-actions.pod:1
17931 #: ../fish/guestfish-actions.pod:3
17934 " add-cdrom filename\n"
17939 #: ../fish/guestfish-actions.pod:15
17941 "This call checks for the existence of C<filename>. This stops you from "
17942 "specifying other types of drive which are supported by qemu such as C<nbd:> "
17943 "and C<http:> URLs. To specify those, use the general L</config> call "
17948 #: ../fish/guestfish-actions.pod:22
17950 "If you just want to add an ISO file (often you use this as an efficient way "
17951 "to transfer large files into the guest), then you should probably use L</add-"
17952 "drive-ro> instead."
17956 #: ../fish/guestfish-actions.pod:35
17961 #: ../fish/guestfish-actions.pod:37
17964 " add-drive filename\n"
17969 #: ../fish/guestfish-actions.pod:39
17971 "This function is the equivalent of calling L</add-drive-opts> with no "
17972 "optional parameters, so the disk is added writable, with the format being "
17973 "detected automatically."
17977 #: ../fish/guestfish-actions.pod:43
17979 "Automatic detection of the format opens you up to a potential security hole "
17980 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
17981 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
17982 "you should think about replacing calls to this function with calls to L</add-"
17983 "drive-opts>, and specifying the format."
17987 #: ../fish/guestfish-actions.pod:50
17988 msgid "add-drive-opts"
17992 #: ../fish/guestfish-actions.pod:52
17997 #: ../fish/guestfish-actions.pod:54
18000 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
18005 #: ../fish/guestfish-actions.pod:81
18007 "This forces the image format. If you omit this (or use L</add-drive> or L</"
18008 "add-drive-ro>) then the format is automatically detected. Possible formats "
18009 "include C<raw> and C<qcow2>."
18013 #: ../fish/guestfish-actions.pod:92
18015 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
18016 "add-drive-with-if> call (q.v.)"
18020 #: ../fish/guestfish-actions.pod:97
18022 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
18026 #: ../fish/guestfish-actions.pod:99
18027 msgid "add-drive-ro"
18031 #: ../fish/guestfish-actions.pod:101
18036 #: ../fish/guestfish-actions.pod:103
18039 " add-drive-ro filename\n"
18044 #: ../fish/guestfish-actions.pod:105
18046 "This function is the equivalent of calling L</add-drive-opts> with the "
18047 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
18048 "is added read-only, with the format being detected automatically."
18052 #: ../fish/guestfish-actions.pod:110
18053 msgid "add-drive-ro-with-if"
18057 #: ../fish/guestfish-actions.pod:112
18060 " add-drive-ro-with-if filename iface\n"
18065 #: ../fish/guestfish-actions.pod:114
18067 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
18068 "interface emulation to use at run time."
18072 #: ../fish/guestfish-actions.pod:124
18073 msgid "add-drive-with-if"
18077 #: ../fish/guestfish-actions.pod:126
18080 " add-drive-with-if filename iface\n"
18085 #: ../fish/guestfish-actions.pod:128
18087 "This is the same as L</add-drive> but it allows you to specify the QEMU "
18088 "interface emulation to use at run time."
18092 #: ../fish/guestfish-actions.pod:138
18097 #: ../fish/guestfish-actions.pod:140
18100 " aug-clear augpath\n"
18105 #: ../fish/guestfish-actions.pod:145
18110 #: ../fish/guestfish-actions.pod:147
18118 #: ../fish/guestfish-actions.pod:149
18120 "Close the current Augeas handle and free up any resources used by it. After "
18121 "calling this, you have to call L</aug-init> again before you can use any "
18122 "other Augeas functions."
18126 #: ../fish/guestfish-actions.pod:154
18127 msgid "aug-defnode"
18131 #: ../fish/guestfish-actions.pod:156
18134 " aug-defnode name expr val\n"
18139 #: ../fish/guestfish-actions.pod:161
18141 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
18142 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
18143 "containing that single node."
18147 #: ../fish/guestfish-actions.pod:169
18152 #: ../fish/guestfish-actions.pod:171
18155 " aug-defvar name expr\n"
18160 #: ../fish/guestfish-actions.pod:180
18165 #: ../fish/guestfish-actions.pod:182
18168 " aug-get augpath\n"
18173 #: ../fish/guestfish-actions.pod:187
18178 #: ../fish/guestfish-actions.pod:189
18181 " aug-init root flags\n"
18186 #: ../fish/guestfish-actions.pod:195
18187 msgid "You must call this before using any other L</aug-*> commands."
18191 #: ../fish/guestfish-actions.pod:230
18192 msgid "Do not load the tree in L</aug-init>."
18196 #: ../fish/guestfish-actions.pod:234
18197 msgid "To close the handle, you can call L</aug-close>."
18201 #: ../fish/guestfish-actions.pod:238
18206 #: ../fish/guestfish-actions.pod:240
18209 " aug-insert augpath label true|false\n"
18214 #: ../fish/guestfish-actions.pod:250
18219 #: ../fish/guestfish-actions.pod:252
18227 #: ../fish/guestfish-actions.pod:259
18232 #: ../fish/guestfish-actions.pod:261
18235 " aug-ls augpath\n"
18240 #: ../fish/guestfish-actions.pod:263
18242 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
18243 "resulting nodes into alphabetical order."
18247 #: ../fish/guestfish-actions.pod:266
18252 #: ../fish/guestfish-actions.pod:268
18255 " aug-match augpath\n"
18260 #: ../fish/guestfish-actions.pod:274
18265 #: ../fish/guestfish-actions.pod:276
18268 " aug-mv src dest\n"
18273 #: ../fish/guestfish-actions.pod:281
18278 #: ../fish/guestfish-actions.pod:283
18281 " aug-rm augpath\n"
18286 #: ../fish/guestfish-actions.pod:289
18291 #: ../fish/guestfish-actions.pod:291
18299 #: ../fish/guestfish-actions.pod:295
18301 "The flags which were passed to L</aug-init> affect exactly how files are "
18306 #: ../fish/guestfish-actions.pod:298
18311 #: ../fish/guestfish-actions.pod:300
18314 " aug-set augpath val\n"
18319 #: ../fish/guestfish-actions.pod:304
18321 "In the Augeas API, it is possible to clear a node by setting the value to "
18322 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
18323 "this call. Instead you must use the L</aug-clear> call."
18327 #: ../fish/guestfish-actions.pod:309
18332 #: ../fish/guestfish-actions.pod:311
18335 " available 'groups ...'\n"
18340 #: ../fish/guestfish-actions.pod:317
18342 "The libguestfs groups, and the functions that those groups correspond to, "
18343 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
18344 "runtime by calling L</available-all-groups>."
18348 #: ../fish/guestfish-actions.pod:341
18349 msgid "You must call L</launch> before calling this function."
18353 #: ../fish/guestfish-actions.pod:363
18355 "This call was added in version C<1.0.80>. In previous versions of "
18356 "libguestfs all you could do would be to speculatively execute a command to "
18357 "find out if the daemon implemented it. See also L</version>."
18361 #: ../fish/guestfish-actions.pod:370
18362 msgid "available-all-groups"
18366 #: ../fish/guestfish-actions.pod:372
18369 " available-all-groups\n"
18374 #: ../fish/guestfish-actions.pod:374
18376 "This command returns a list of all optional groups that this daemon knows "
18377 "about. Note this returns both supported and unsupported groups. To find "
18378 "out which ones the daemon can actually support you have to call L</"
18379 "available> on each member of the returned list."
18383 #: ../fish/guestfish-actions.pod:380
18384 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
18388 #: ../fish/guestfish-actions.pod:382
18393 #: ../fish/guestfish-actions.pod:384
18396 " base64-in (base64file|-) filename\n"
18401 #: ../fish/guestfish-actions.pod:389 ../fish/guestfish-actions.pod:398
18402 #: ../fish/guestfish-actions.pod:622 ../fish/guestfish-actions.pod:769
18403 #: ../fish/guestfish-actions.pod:816 ../fish/guestfish-actions.pod:835
18404 #: ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:3932
18405 #: ../fish/guestfish-actions.pod:3944 ../fish/guestfish-actions.pod:3955
18406 #: ../fish/guestfish-actions.pod:3966 ../fish/guestfish-actions.pod:4018
18407 #: ../fish/guestfish-actions.pod:4027 ../fish/guestfish-actions.pod:4081
18408 #: ../fish/guestfish-actions.pod:4104
18409 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
18413 #: ../fish/guestfish-actions.pod:391
18418 #: ../fish/guestfish-actions.pod:393
18421 " base64-out filename (base64file|-)\n"
18426 #: ../fish/guestfish-actions.pod:400
18427 msgid "blockdev-flushbufs"
18431 #: ../fish/guestfish-actions.pod:402
18434 " blockdev-flushbufs device\n"
18439 #: ../fish/guestfish-actions.pod:409
18440 msgid "blockdev-getbsz"
18444 #: ../fish/guestfish-actions.pod:411
18447 " blockdev-getbsz device\n"
18452 #: ../fish/guestfish-actions.pod:420
18453 msgid "blockdev-getro"
18457 #: ../fish/guestfish-actions.pod:422
18460 " blockdev-getro device\n"
18465 #: ../fish/guestfish-actions.pod:429
18466 msgid "blockdev-getsize64"
18470 #: ../fish/guestfish-actions.pod:431
18473 " blockdev-getsize64 device\n"
18478 #: ../fish/guestfish-actions.pod:435
18479 msgid "See also L</blockdev-getsz>."
18483 #: ../fish/guestfish-actions.pod:439
18484 msgid "blockdev-getss"
18488 #: ../fish/guestfish-actions.pod:441
18491 " blockdev-getss device\n"
18496 #: ../fish/guestfish-actions.pod:446
18498 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
18502 #: ../fish/guestfish-actions.pod:451
18503 msgid "blockdev-getsz"
18507 #: ../fish/guestfish-actions.pod:453
18510 " blockdev-getsz device\n"
18515 #: ../fish/guestfish-actions.pod:458
18517 "See also L</blockdev-getss> for the real sector size of the device, and L</"
18518 "blockdev-getsize64> for the more useful I<size in bytes>."
18522 #: ../fish/guestfish-actions.pod:464
18523 msgid "blockdev-rereadpt"
18527 #: ../fish/guestfish-actions.pod:466
18530 " blockdev-rereadpt device\n"
18535 #: ../fish/guestfish-actions.pod:472
18536 msgid "blockdev-setbsz"
18540 #: ../fish/guestfish-actions.pod:474
18543 " blockdev-setbsz device blocksize\n"
18548 #: ../fish/guestfish-actions.pod:483
18549 msgid "blockdev-setro"
18553 #: ../fish/guestfish-actions.pod:485
18556 " blockdev-setro device\n"
18561 #: ../fish/guestfish-actions.pod:491
18562 msgid "blockdev-setrw"
18566 #: ../fish/guestfish-actions.pod:493
18569 " blockdev-setrw device\n"
18574 #: ../fish/guestfish-actions.pod:499
18575 msgid "case-sensitive-path"
18579 #: ../fish/guestfish-actions.pod:501
18582 " case-sensitive-path path\n"
18587 #: ../fish/guestfish-actions.pod:525
18589 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
18590 "WINDOWS/system32\"> (the exact return value would depend on details of how "
18591 "the directories were originally created under Windows)."
18595 #: ../fish/guestfish-actions.pod:533
18596 msgid "See also L</realpath>."
18600 #: ../fish/guestfish-actions.pod:535
18605 #: ../fish/guestfish-actions.pod:537
18613 #: ../fish/guestfish-actions.pod:541
18615 "Note that this function cannot correctly handle binary files (specifically, "
18616 "files containing C<\\0> character which is treated as end of string). For "
18617 "those you need to use the L</read-file> or L</download> functions which have "
18618 "a more complex interface."
18622 #: ../fish/guestfish-actions.pod:549
18627 #: ../fish/guestfish-actions.pod:551
18630 " checksum csumtype path\n"
18635 #: ../fish/guestfish-actions.pod:594
18636 msgid "To get the checksum for a device, use L</checksum-device>."
18640 #: ../fish/guestfish-actions.pod:596
18641 msgid "To get the checksums for many files, use L</checksums-out>."
18645 #: ../fish/guestfish-actions.pod:598
18646 msgid "checksum-device"
18650 #: ../fish/guestfish-actions.pod:600
18653 " checksum-device csumtype device\n"
18658 #: ../fish/guestfish-actions.pod:602
18660 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
18661 "device named C<device>. For the types of checksums supported see the L</"
18662 "checksum> command."
18666 #: ../fish/guestfish-actions.pod:606
18667 msgid "checksums-out"
18671 #: ../fish/guestfish-actions.pod:608
18674 " checksums-out csumtype directory (sumsfile|-)\n"
18679 #: ../fish/guestfish-actions.pod:624
18684 #: ../fish/guestfish-actions.pod:626
18687 " chmod mode path\n"
18692 #: ../fish/guestfish-actions.pod:637
18697 #: ../fish/guestfish-actions.pod:639
18700 " chown owner group path\n"
18705 #: ../fish/guestfish-actions.pod:647
18710 #: ../fish/guestfish-actions.pod:649
18713 " command 'arguments ...'\n"
18718 #: ../fish/guestfish-actions.pod:656
18720 "The single parameter is an argv-style list of arguments. The first element "
18721 "is the name of the program to run. Subsequent elements are parameters. The "
18722 "list must be non-empty (ie. must contain a program name). Note that the "
18723 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
18727 #: ../fish/guestfish-actions.pod:684
18728 msgid "command-lines"
18732 #: ../fish/guestfish-actions.pod:686
18735 " command-lines 'arguments ...'\n"
18740 #: ../fish/guestfish-actions.pod:688
18742 "This is the same as L</command>, but splits the result into a list of lines."
18746 #: ../fish/guestfish-actions.pod:691
18747 msgid "See also: L</sh-lines>"
18751 #: ../fish/guestfish-actions.pod:696
18756 #: ../fish/guestfish-actions.pod:698
18759 " config qemuparam qemuvalue\n"
18764 #: ../fish/guestfish-actions.pod:709
18769 #: ../fish/guestfish-actions.pod:711
18772 " copy-size src dest size\n"
18777 #: ../fish/guestfish-actions.pod:719
18782 #: ../fish/guestfish-actions.pod:721
18790 #: ../fish/guestfish-actions.pod:726
18795 #: ../fish/guestfish-actions.pod:728
18803 #: ../fish/guestfish-actions.pod:733
18808 #: ../fish/guestfish-actions.pod:735
18816 #: ../fish/guestfish-actions.pod:742
18818 "If the destination is a device, it must be as large or larger than the "
18819 "source file or device, otherwise the copy will fail. This command cannot do "
18820 "partial copies (see L</copy-size>)."
18824 #: ../fish/guestfish-actions.pod:746
18829 #: ../fish/guestfish-actions.pod:748
18832 " debug subcmd 'extraargs ...'\n"
18837 #: ../fish/guestfish-actions.pod:750
18839 "The L</debug> command exposes some internals of C<guestfsd> (the guestfs "
18840 "daemon) that runs inside the qemu subprocess."
18844 #: ../fish/guestfish-actions.pod:758
18845 msgid "debug-upload"
18849 #: ../fish/guestfish-actions.pod:760
18852 " debug-upload (filename|-) tmpname mode\n"
18857 #: ../fish/guestfish-actions.pod:762
18859 "The L</debug-upload> command uploads a file to the libguestfs appliance."
18863 #: ../fish/guestfish-actions.pod:771
18868 #: ../fish/guestfish-actions.pod:773
18876 #: ../fish/guestfish-actions.pod:781
18881 #: ../fish/guestfish-actions.pod:783
18889 #: ../fish/guestfish-actions.pod:792
18894 #: ../fish/guestfish-actions.pod:794
18902 #: ../fish/guestfish-actions.pod:800
18904 "Another way to get the same information is to enable verbose messages with "
18905 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
18906 "before running the program."
18910 #: ../fish/guestfish-actions.pod:805
18915 #: ../fish/guestfish-actions.pod:807
18918 " download remotefilename (filename|-)\n"
18923 #: ../fish/guestfish-actions.pod:814
18924 msgid "See also L</upload>, L</cat>."
18928 #: ../fish/guestfish-actions.pod:818
18929 msgid "download-offset"
18933 #: ../fish/guestfish-actions.pod:820
18936 " download-offset remotefilename (filename|-) offset size\n"
18941 #: ../fish/guestfish-actions.pod:828
18943 "Note that there is no limit on the amount of data that can be downloaded "
18944 "with this call, unlike with L</pread>, and this call always reads the full "
18945 "amount unless an error occurs."
18949 #: ../fish/guestfish-actions.pod:833
18950 msgid "See also L</download>, L</pread>."
18954 #: ../fish/guestfish-actions.pod:837
18955 msgid "drop-caches"
18959 #: ../fish/guestfish-actions.pod:839
18962 " drop-caches whattodrop\n"
18967 #: ../fish/guestfish-actions.pod:851
18972 #: ../fish/guestfish-actions.pod:853
18980 #: ../fish/guestfish-actions.pod:865
18985 #: ../fish/guestfish-actions.pod:867
18988 " e2fsck-f device\n"
18993 #: ../fish/guestfish-actions.pod:873
18995 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
18996 "should use L</fsck>."
19000 #: ../fish/guestfish-actions.pod:876
19001 msgid "echo-daemon"
19005 #: ../fish/guestfish-actions.pod:878
19008 " echo-daemon 'words ...'\n"
19013 #: ../fish/guestfish-actions.pod:885
19014 msgid "See also L</ping-daemon>."
19018 #: ../fish/guestfish-actions.pod:887
19023 #: ../fish/guestfish-actions.pod:889
19026 " egrep regex path\n"
19031 #: ../fish/guestfish-actions.pod:897
19036 #: ../fish/guestfish-actions.pod:899
19039 " egrepi regex path\n"
19044 #: ../fish/guestfish-actions.pod:907
19049 #: ../fish/guestfish-actions.pod:909
19052 " equal file1 file2\n"
19057 #: ../fish/guestfish-actions.pod:916
19062 #: ../fish/guestfish-actions.pod:918
19070 #: ../fish/guestfish-actions.pod:923
19071 msgid "See also L</is-file>, L</is-dir>, L</stat>."
19075 #: ../fish/guestfish-actions.pod:925
19080 #: ../fish/guestfish-actions.pod:927
19083 " fallocate path len\n"
19088 #: ../fish/guestfish-actions.pod:944
19089 msgid "fallocate64"
19093 #: ../fish/guestfish-actions.pod:946
19096 " fallocate64 path len\n"
19101 #: ../fish/guestfish-actions.pod:952
19103 "Note that this call allocates disk blocks for the file. To create a sparse "
19104 "file use L</truncate-size> instead."
19108 #: ../fish/guestfish-actions.pod:955
19110 "The deprecated call L</fallocate> does the same, but owing to an oversight "
19111 "it only allowed 30 bit lengths to be specified, effectively limiting the "
19112 "maximum size of files created through that call to 1GB."
19116 #: ../fish/guestfish-actions.pod:964
19121 #: ../fish/guestfish-actions.pod:966
19124 " fgrep pattern path\n"
19129 #: ../fish/guestfish-actions.pod:974
19134 #: ../fish/guestfish-actions.pod:976
19137 " fgrepi pattern path\n"
19142 #: ../fish/guestfish-actions.pod:984
19147 #: ../fish/guestfish-actions.pod:986
19155 #: ../fish/guestfish-actions.pod:998
19157 "This command can also be used on C</dev/> devices (and partitions, LV "
19158 "names). You can for example use this to determine if a device contains a "
19159 "filesystem, although it's usually better to use L</vfs-type>."
19163 #: ../fish/guestfish-actions.pod:1008
19164 msgid "file-architecture"
19168 #: ../fish/guestfish-actions.pod:1010
19171 " file-architecture filename\n"
19176 #: ../fish/guestfish-actions.pod:1113
19181 #: ../fish/guestfish-actions.pod:1115
19189 #: ../fish/guestfish-actions.pod:1119
19191 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
19192 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
19196 #: ../fish/guestfish-actions.pod:1123
19201 #: ../fish/guestfish-actions.pod:1125
19204 " fill c len path\n"
19209 #: ../fish/guestfish-actions.pod:1131
19211 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
19212 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
19213 "L</fill-pattern>."
19217 #: ../fish/guestfish-actions.pod:1136
19218 msgid "fill-pattern"
19222 #: ../fish/guestfish-actions.pod:1138
19225 " fill-pattern pattern len path\n"
19230 #: ../fish/guestfish-actions.pod:1140
19232 "This function is like L</fill> except that it creates a new file of length "
19233 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
19234 "is truncated if necessary to ensure the length of the file is exactly C<len> "
19239 #: ../fish/guestfish-actions.pod:1145
19244 #: ../fish/guestfish-actions.pod:1147
19247 " find directory\n"
19252 #: ../fish/guestfish-actions.pod:1161
19253 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
19257 #: ../fish/guestfish-actions.pod:1174
19258 msgid "See also L</find0>."
19262 #: ../fish/guestfish-actions.pod:1179
19267 #: ../fish/guestfish-actions.pod:1181
19270 " find0 directory (files|-)\n"
19275 #: ../fish/guestfish-actions.pod:1187
19277 "This command works the same way as L</find> with the following exceptions:"
19281 #: ../fish/guestfish-actions.pod:1214
19282 msgid "findfs-label"
19286 #: ../fish/guestfish-actions.pod:1216
19289 " findfs-label label\n"
19294 #: ../fish/guestfish-actions.pod:1222
19295 msgid "To find the label of a filesystem, use L</vfs-label>."
19299 #: ../fish/guestfish-actions.pod:1224
19300 msgid "findfs-uuid"
19304 #: ../fish/guestfish-actions.pod:1226
19307 " findfs-uuid uuid\n"
19312 #: ../fish/guestfish-actions.pod:1232
19313 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
19317 #: ../fish/guestfish-actions.pod:1234
19322 #: ../fish/guestfish-actions.pod:1236
19325 " fsck fstype device\n"
19330 #: ../fish/guestfish-actions.pod:1266
19335 #: ../fish/guestfish-actions.pod:1268
19343 #: ../fish/guestfish-actions.pod:1275
19344 msgid "get-autosync"
19348 #: ../fish/guestfish-actions.pod:1277
19356 #: ../fish/guestfish-actions.pod:1281
19361 #: ../fish/guestfish-actions.pod:1283
19369 #: ../fish/guestfish-actions.pod:1287
19370 msgid "get-e2label"
19374 #: ../fish/guestfish-actions.pod:1289
19377 " get-e2label device\n"
19382 #: ../fish/guestfish-actions.pod:1301
19387 #: ../fish/guestfish-actions.pod:1303
19390 " get-e2uuid device\n"
19395 #: ../fish/guestfish-actions.pod:1315
19396 msgid "get-memsize"
19400 #: ../fish/guestfish-actions.pod:1317
19408 #: ../fish/guestfish-actions.pod:1322
19410 "If L</set-memsize> was not called on this handle, and if "
19411 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
19412 "value for memsize."
19416 #: ../fish/guestfish-actions.pod:1329
19417 msgid "get-network"
19421 #: ../fish/guestfish-actions.pod:1331
19429 #: ../fish/guestfish-actions.pod:1335
19434 #: ../fish/guestfish-actions.pod:1337
19442 #: ../fish/guestfish-actions.pod:1344
19447 #: ../fish/guestfish-actions.pod:1346
19452 #: ../fish/guestfish-actions.pod:1348
19460 #: ../fish/guestfish-actions.pod:1355
19465 #: ../fish/guestfish-actions.pod:1357
19473 #: ../fish/guestfish-actions.pod:1364
19474 msgid "get-recovery-proc"
19478 #: ../fish/guestfish-actions.pod:1366
19481 " get-recovery-proc\n"
19486 #: ../fish/guestfish-actions.pod:1370
19487 msgid "get-selinux"
19491 #: ../fish/guestfish-actions.pod:1372
19499 #: ../fish/guestfish-actions.pod:1374
19501 "This returns the current setting of the selinux flag which is passed to the "
19502 "appliance at boot time. See L</set-selinux>."
19506 #: ../fish/guestfish-actions.pod:1380
19511 #: ../fish/guestfish-actions.pod:1382
19519 #: ../fish/guestfish-actions.pod:1389
19524 #: ../fish/guestfish-actions.pod:1391
19532 #: ../fish/guestfish-actions.pod:1395
19537 #: ../fish/guestfish-actions.pod:1397
19545 #: ../fish/guestfish-actions.pod:1399
19547 "Return the current umask. By default the umask is C<022> unless it has been "
19548 "set by calling L</umask>."
19552 #: ../fish/guestfish-actions.pod:1402
19553 msgid "get-verbose"
19557 #: ../fish/guestfish-actions.pod:1404
19565 #: ../fish/guestfish-actions.pod:1408
19570 #: ../fish/guestfish-actions.pod:1410
19578 #: ../fish/guestfish-actions.pod:1414
19579 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
19583 #: ../fish/guestfish-actions.pod:1417
19588 #: ../fish/guestfish-actions.pod:1419
19591 " getxattrs path\n"
19596 #: ../fish/guestfish-actions.pod:1427
19597 msgid "See also: L</lgetxattrs>, L<attr(5)>."
19601 #: ../fish/guestfish-actions.pod:1429
19602 msgid "glob-expand"
19606 #: ../fish/guestfish-actions.pod:1431
19609 " glob-expand pattern\n"
19614 #: ../fish/guestfish-actions.pod:1444
19619 #: ../fish/guestfish-actions.pod:1446
19622 " grep regex path\n"
19627 #: ../fish/guestfish-actions.pod:1454
19632 #: ../fish/guestfish-actions.pod:1456
19635 " grepi regex path\n"
19640 #: ../fish/guestfish-actions.pod:1464
19641 msgid "grub-install"
19645 #: ../fish/guestfish-actions.pod:1466
19648 " grub-install root device\n"
19653 #: ../fish/guestfish-actions.pod:1482
19658 #: ../fish/guestfish-actions.pod:1484
19666 #: ../fish/guestfish-actions.pod:1492
19671 #: ../fish/guestfish-actions.pod:1494
19674 " head-n nrlines path\n"
19679 #: ../fish/guestfish-actions.pod:1507
19684 #: ../fish/guestfish-actions.pod:1509
19692 #: ../fish/guestfish-actions.pod:1517
19697 #: ../fish/guestfish-actions.pod:1519
19700 " initrd-cat initrdpath filename\n"
19705 #: ../fish/guestfish-actions.pod:1531
19706 msgid "See also L</initrd-list>."
19710 #: ../fish/guestfish-actions.pod:1536
19711 msgid "initrd-list"
19715 #: ../fish/guestfish-actions.pod:1538
19718 " initrd-list path\n"
19723 #: ../fish/guestfish-actions.pod:1550
19724 msgid "inotify-add-watch"
19728 #: ../fish/guestfish-actions.pod:1552
19731 " inotify-add-watch path mask\n"
19736 #: ../fish/guestfish-actions.pod:1564
19737 msgid "inotify-close"
19741 #: ../fish/guestfish-actions.pod:1566
19749 #: ../fish/guestfish-actions.pod:1572
19750 msgid "inotify-files"
19754 #: ../fish/guestfish-actions.pod:1574
19762 #: ../fish/guestfish-actions.pod:1576
19764 "This function is a helpful wrapper around L</inotify-read> which just "
19765 "returns a list of pathnames of objects that were touched. The returned "
19766 "pathnames are sorted and deduplicated."
19770 #: ../fish/guestfish-actions.pod:1580
19771 msgid "inotify-init"
19775 #: ../fish/guestfish-actions.pod:1582
19778 " inotify-init maxevents\n"
19783 #: ../fish/guestfish-actions.pod:1588
19785 "C<maxevents> is the maximum number of events which will be queued up between "
19786 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
19787 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
19788 "default was 16384 events. Beyond this limit, the kernel throws away events, "
19789 "but records the fact that it threw them away by setting a flag "
19790 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
19794 #: ../fish/guestfish-actions.pod:1598
19796 "Before any events are generated, you have to add some watches to the "
19797 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
19798 "L</inotify-watch-all>."
19802 #: ../fish/guestfish-actions.pod:1604
19804 "Queued up events should be read periodically by calling L</inotify-read> (or "
19805 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
19806 "If you don't read the events out often enough then you risk the internal "
19807 "queue overflowing."
19811 #: ../fish/guestfish-actions.pod:1611
19813 "The handle should be closed after use by calling L</inotify-close>. This "
19814 "also removes any watches automatically."
19818 #: ../fish/guestfish-actions.pod:1620
19819 msgid "inotify-read"
19823 #: ../fish/guestfish-actions.pod:1622
19831 #: ../fish/guestfish-actions.pod:1635
19832 msgid "inotify-rm-watch"
19836 #: ../fish/guestfish-actions.pod:1637
19839 " inotify-rm-watch wd\n"
19844 #: ../fish/guestfish-actions.pod:1639
19845 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
19849 #: ../fish/guestfish-actions.pod:1642
19850 msgid "inspect-get-arch"
19854 #: ../fish/guestfish-actions.pod:1644
19857 " inspect-get-arch root\n"
19862 #: ../fish/guestfish-actions.pod:1646 ../fish/guestfish-actions.pod:1662
19863 #: ../fish/guestfish-actions.pod:1728 ../fish/guestfish-actions.pod:1746
19864 #: ../fish/guestfish-actions.pod:1767 ../fish/guestfish-actions.pod:1782
19865 #: ../fish/guestfish-actions.pod:1805 ../fish/guestfish-actions.pod:1822
19866 #: ../fish/guestfish-actions.pod:1853
19868 "This function should only be called with a root device string as returned by "
19873 #: ../fish/guestfish-actions.pod:1649
19875 "This returns the architecture of the inspected operating system. The "
19876 "possible return values are listed under L</file-architecture>."
19880 #: ../fish/guestfish-actions.pod:1658
19881 msgid "inspect-get-distro"
19885 #: ../fish/guestfish-actions.pod:1660
19888 " inspect-get-distro root\n"
19893 #: ../fish/guestfish-actions.pod:1724
19894 msgid "inspect-get-filesystems"
19898 #: ../fish/guestfish-actions.pod:1726
19901 " inspect-get-filesystems root\n"
19906 #: ../fish/guestfish-actions.pod:1739
19908 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
19909 "get-mountpoints>."
19913 #: ../fish/guestfish-actions.pod:1742
19914 msgid "inspect-get-major-version"
19918 #: ../fish/guestfish-actions.pod:1744
19921 " inspect-get-major-version root\n"
19926 #: ../fish/guestfish-actions.pod:1763
19927 msgid "inspect-get-minor-version"
19931 #: ../fish/guestfish-actions.pod:1765
19934 " inspect-get-minor-version root\n"
19939 #: ../fish/guestfish-actions.pod:1775
19941 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
19942 "get-major-version>."
19946 #: ../fish/guestfish-actions.pod:1778
19947 msgid "inspect-get-mountpoints"
19951 #: ../fish/guestfish-actions.pod:1780
19954 " inspect-get-mountpoints root\n"
19959 #: ../fish/guestfish-actions.pod:1798
19961 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
19962 "get-filesystems>."
19966 #: ../fish/guestfish-actions.pod:1801
19967 msgid "inspect-get-product-name"
19971 #: ../fish/guestfish-actions.pod:1803
19974 " inspect-get-product-name root\n"
19979 #: ../fish/guestfish-actions.pod:1818
19980 msgid "inspect-get-type"
19984 #: ../fish/guestfish-actions.pod:1820
19987 " inspect-get-type root\n"
19992 #: ../fish/guestfish-actions.pod:1849
19993 msgid "inspect-get-windows-systemroot"
19997 #: ../fish/guestfish-actions.pod:1851
20000 " inspect-get-windows-systemroot root\n"
20005 #: ../fish/guestfish-actions.pod:1865
20010 #: ../fish/guestfish-actions.pod:1867
20018 #: ../fish/guestfish-actions.pod:1882
20020 "You can pass the root string(s) returned to other L</inspect-get-*> "
20021 "functions in order to query further information about each operating system, "
20022 "such as the name and version."
20026 #: ../fish/guestfish-actions.pod:1887
20028 "This function uses other libguestfs features such as L</mount-ro> and L</"
20029 "umount-all> in order to mount and unmount filesystems and look at the "
20030 "contents. This should be called with no disks currently mounted. The "
20031 "function may also use Augeas, so any existing Augeas handle will be closed."
20035 #: ../fish/guestfish-actions.pod:1899 ../fish/guestfish-actions.pod:2055
20036 #: ../fish/guestfish-actions.pod:2101
20037 msgid "See also L</list-filesystems>."
20041 #: ../fish/guestfish-actions.pod:1901
20042 msgid "is-blockdev"
20046 #: ../fish/guestfish-actions.pod:1903
20049 " is-blockdev path\n"
20054 #: ../fish/guestfish-actions.pod:1908 ../fish/guestfish-actions.pod:1926
20055 #: ../fish/guestfish-actions.pod:1945 ../fish/guestfish-actions.pod:1954
20056 #: ../fish/guestfish-actions.pod:1964 ../fish/guestfish-actions.pod:1998
20057 #: ../fish/guestfish-actions.pod:2007
20058 msgid "See also L</stat>."
20062 #: ../fish/guestfish-actions.pod:1910
20067 #: ../fish/guestfish-actions.pod:1912
20075 #: ../fish/guestfish-actions.pod:1919
20080 #: ../fish/guestfish-actions.pod:1921
20083 " is-chardev path\n"
20088 #: ../fish/guestfish-actions.pod:1928
20093 #: ../fish/guestfish-actions.pod:1930
20101 #: ../fish/guestfish-actions.pod:1937
20106 #: ../fish/guestfish-actions.pod:1939
20114 #: ../fish/guestfish-actions.pod:1947
20119 #: ../fish/guestfish-actions.pod:1949
20127 #: ../fish/guestfish-actions.pod:1956
20132 #: ../fish/guestfish-actions.pod:1958
20140 #: ../fish/guestfish-actions.pod:1966
20141 msgid "is-launching"
20145 #: ../fish/guestfish-actions.pod:1968
20153 #: ../fish/guestfish-actions.pod:1975
20158 #: ../fish/guestfish-actions.pod:1977
20166 #: ../fish/guestfish-actions.pod:1982
20171 #: ../fish/guestfish-actions.pod:1984
20179 #: ../fish/guestfish-actions.pod:1991
20184 #: ../fish/guestfish-actions.pod:1993
20187 " is-socket path\n"
20192 #: ../fish/guestfish-actions.pod:2000
20197 #: ../fish/guestfish-actions.pod:2002
20200 " is-symlink path\n"
20205 #: ../fish/guestfish-actions.pod:2009
20206 msgid "kill-subprocess"
20210 #: ../fish/guestfish-actions.pod:2011
20213 " kill-subprocess\n"
20218 #: ../fish/guestfish-actions.pod:2015
20223 #: ../fish/guestfish-actions.pod:2017
20228 #: ../fish/guestfish-actions.pod:2019
20236 #: ../fish/guestfish-actions.pod:2027
20241 #: ../fish/guestfish-actions.pod:2029
20244 " lchown owner group path\n"
20249 #: ../fish/guestfish-actions.pod:2031
20251 "Change the file owner to C<owner> and group to C<group>. This is like L</"
20252 "chown> but if C<path> is a symlink then the link itself is changed, not the "
20257 #: ../fish/guestfish-actions.pod:2039
20262 #: ../fish/guestfish-actions.pod:2041
20265 " lgetxattrs path\n"
20270 #: ../fish/guestfish-actions.pod:2043
20272 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
20273 "it returns the extended attributes of the link itself."
20277 #: ../fish/guestfish-actions.pod:2047
20278 msgid "list-devices"
20282 #: ../fish/guestfish-actions.pod:2049
20290 #: ../fish/guestfish-actions.pod:2057
20291 msgid "list-filesystems"
20295 #: ../fish/guestfish-actions.pod:2059
20298 " list-filesystems\n"
20303 #: ../fish/guestfish-actions.pod:2078
20305 "This command runs other libguestfs commands, which might include L</mount> "
20306 "and L</umount>, and therefore you should use this soon after launch and only "
20307 "when nothing is mounted."
20311 #: ../fish/guestfish-actions.pod:2082
20313 "Not all of the filesystems returned will be mountable. In particular, swap "
20314 "partitions are returned in the list. Also this command does not check that "
20315 "each filesystem found is valid and mountable, and some filesystems might be "
20316 "mountable but require special options. Filesystems may not all belong to a "
20317 "single logical operating system (use L</inspect-os> to look for OSes)."
20321 #: ../fish/guestfish-actions.pod:2090
20322 msgid "list-partitions"
20326 #: ../fish/guestfish-actions.pod:2092
20329 " list-partitions\n"
20334 #: ../fish/guestfish-actions.pod:2098
20336 "This does not return logical volumes. For that you will need to call L</"
20341 #: ../fish/guestfish-actions.pod:2103
20346 #: ../fish/guestfish-actions.pod:2105
20354 #: ../fish/guestfish-actions.pod:2113
20359 #: ../fish/guestfish-actions.pod:2115
20362 " ln target linkname\n"
20367 #: ../fish/guestfish-actions.pod:2119
20372 #: ../fish/guestfish-actions.pod:2121
20375 " ln-f target linkname\n"
20380 #: ../fish/guestfish-actions.pod:2126
20385 #: ../fish/guestfish-actions.pod:2128
20388 " ln-s target linkname\n"
20393 #: ../fish/guestfish-actions.pod:2132
20398 #: ../fish/guestfish-actions.pod:2134
20401 " ln-sf target linkname\n"
20406 #: ../fish/guestfish-actions.pod:2139
20407 msgid "lremovexattr"
20411 #: ../fish/guestfish-actions.pod:2141
20414 " lremovexattr xattr path\n"
20419 #: ../fish/guestfish-actions.pod:2143
20421 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
20422 "it removes an extended attribute of the link itself."
20426 #: ../fish/guestfish-actions.pod:2147
20431 #: ../fish/guestfish-actions.pod:2149
20439 #: ../fish/guestfish-actions.pod:2155
20441 "This command is mostly useful for interactive sessions. Programs should "
20442 "probably use L</readdir> instead."
20446 #: ../fish/guestfish-actions.pod:2158
20451 #: ../fish/guestfish-actions.pod:2160
20454 " lsetxattr xattr val vallen path\n"
20459 #: ../fish/guestfish-actions.pod:2162
20461 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
20462 "sets an extended attribute of the link itself."
20466 #: ../fish/guestfish-actions.pod:2166
20471 #: ../fish/guestfish-actions.pod:2168
20479 #: ../fish/guestfish-actions.pod:2172
20481 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
20482 "the link is stat-ed, not the file it refers to."
20486 #: ../fish/guestfish-actions.pod:2178
20491 #: ../fish/guestfish-actions.pod:2180
20494 " lstatlist path 'names ...'\n"
20499 #: ../fish/guestfish-actions.pod:2182
20501 "This call allows you to perform the L</lstat> operation on multiple files, "
20502 "where all files are in the directory C<path>. C<names> is the list of files "
20503 "from this directory."
20507 #: ../fish/guestfish-actions.pod:2191
20509 "This call is intended for programs that want to efficiently list a directory "
20510 "contents without making many round-trips. See also L</lxattrlist> for a "
20511 "similarly efficient call for getting extended attributes. Very long "
20512 "directory listings might cause the protocol message size to be exceeded, "
20513 "causing this call to fail. The caller must split up such requests into "
20514 "smaller groups of names."
20518 #: ../fish/guestfish-actions.pod:2199
20519 msgid "luks-add-key"
20523 #: ../fish/guestfish-actions.pod:2201
20526 " luks-add-key device keyslot\n"
20531 #: ../fish/guestfish-actions.pod:2208
20533 "Note that if C<keyslot> already contains a key, then this command will "
20534 "fail. You have to use L</luks-kill-slot> first to remove that key."
20538 #: ../fish/guestfish-actions.pod:2212 ../fish/guestfish-actions.pod:2234
20539 #: ../fish/guestfish-actions.pod:2247 ../fish/guestfish-actions.pod:2261
20540 #: ../fish/guestfish-actions.pod:2284 ../fish/guestfish-actions.pod:2294
20542 "This command has one or more key or passphrase parameters. Guestfish will "
20543 "prompt for these separately."
20547 #: ../fish/guestfish-actions.pod:2215
20552 #: ../fish/guestfish-actions.pod:2217
20555 " luks-close device\n"
20560 #: ../fish/guestfish-actions.pod:2219
20562 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
20563 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
20564 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
20569 #: ../fish/guestfish-actions.pod:2225
20570 msgid "luks-format"
20574 #: ../fish/guestfish-actions.pod:2227
20577 " luks-format device keyslot\n"
20582 #: ../fish/guestfish-actions.pod:2240
20583 msgid "luks-format-cipher"
20587 #: ../fish/guestfish-actions.pod:2242
20590 " luks-format-cipher device keyslot cipher\n"
20595 #: ../fish/guestfish-actions.pod:2244
20597 "This command is the same as L</luks-format> but it also allows you to set "
20598 "the C<cipher> used."
20602 #: ../fish/guestfish-actions.pod:2253
20603 msgid "luks-kill-slot"
20607 #: ../fish/guestfish-actions.pod:2255
20610 " luks-kill-slot device keyslot\n"
20615 #: ../fish/guestfish-actions.pod:2264
20620 #: ../fish/guestfish-actions.pod:2266
20623 " luks-open device mapname\n"
20628 #: ../fish/guestfish-actions.pod:2280
20630 "If this block device contains LVM volume groups, then calling L</vgscan> "
20631 "followed by L</vg-activate-all> will make them visible."
20635 #: ../fish/guestfish-actions.pod:2287
20636 msgid "luks-open-ro"
20640 #: ../fish/guestfish-actions.pod:2289
20643 " luks-open-ro device mapname\n"
20648 #: ../fish/guestfish-actions.pod:2291
20650 "This is the same as L</luks-open> except that a read-only mapping is created."
20654 #: ../fish/guestfish-actions.pod:2297
20659 #: ../fish/guestfish-actions.pod:2299
20662 " lvcreate logvol volgroup mbytes\n"
20667 #: ../fish/guestfish-actions.pod:2304
20668 msgid "lvm-canonical-lv-name"
20672 #: ../fish/guestfish-actions.pod:2306
20675 " lvm-canonical-lv-name lvname\n"
20680 #: ../fish/guestfish-actions.pod:2315
20681 msgid "See also L</is-lv>."
20685 #: ../fish/guestfish-actions.pod:2317
20686 msgid "lvm-clear-filter"
20690 #: ../fish/guestfish-actions.pod:2319
20693 " lvm-clear-filter\n"
20698 #: ../fish/guestfish-actions.pod:2321
20700 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
20705 #: ../fish/guestfish-actions.pod:2327
20706 msgid "lvm-remove-all"
20710 #: ../fish/guestfish-actions.pod:2329
20713 " lvm-remove-all\n"
20718 #: ../fish/guestfish-actions.pod:2337
20719 msgid "lvm-set-filter"
20723 #: ../fish/guestfish-actions.pod:2339
20726 " lvm-set-filter 'devices ...'\n"
20731 #: ../fish/guestfish-actions.pod:2364
20736 #: ../fish/guestfish-actions.pod:2366
20739 " lvremove device\n"
20744 #: ../fish/guestfish-actions.pod:2374
20749 #: ../fish/guestfish-actions.pod:2376
20752 " lvrename logvol newlogvol\n"
20757 #: ../fish/guestfish-actions.pod:2380
20762 #: ../fish/guestfish-actions.pod:2382
20765 " lvresize device mbytes\n"
20770 #: ../fish/guestfish-actions.pod:2388
20771 msgid "lvresize-free"
20775 #: ../fish/guestfish-actions.pod:2390
20778 " lvresize-free lv percent\n"
20783 #: ../fish/guestfish-actions.pod:2398
20788 #: ../fish/guestfish-actions.pod:2400
20796 #: ../fish/guestfish-actions.pod:2408
20797 msgid "See also L</lvs-full>, L</list-filesystems>."
20801 #: ../fish/guestfish-actions.pod:2410
20806 #: ../fish/guestfish-actions.pod:2412
20814 #: ../fish/guestfish-actions.pod:2417
20819 #: ../fish/guestfish-actions.pod:2419
20827 #: ../fish/guestfish-actions.pod:2423
20832 #: ../fish/guestfish-actions.pod:2425
20835 " lxattrlist path 'names ...'\n"
20840 #: ../fish/guestfish-actions.pod:2441
20842 "This call is intended for programs that want to efficiently list a directory "
20843 "contents without making many round-trips. See also L</lstatlist> for a "
20844 "similarly efficient call for getting standard stats. Very long directory "
20845 "listings might cause the protocol message size to be exceeded, causing this "
20846 "call to fail. The caller must split up such requests into smaller groups of "
20851 #: ../fish/guestfish-actions.pod:2449
20856 #: ../fish/guestfish-actions.pod:2451
20864 #: ../fish/guestfish-actions.pod:2455
20869 #: ../fish/guestfish-actions.pod:2457
20872 " mkdir-mode path mode\n"
20877 #: ../fish/guestfish-actions.pod:2466
20878 msgid "See also L</mkdir>, L</umask>"
20882 #: ../fish/guestfish-actions.pod:2468
20887 #: ../fish/guestfish-actions.pod:2470
20895 #: ../fish/guestfish-actions.pod:2475
20900 #: ../fish/guestfish-actions.pod:2477
20903 " mkdtemp template\n"
20908 #: ../fish/guestfish-actions.pod:2498
20913 #: ../fish/guestfish-actions.pod:2500
20916 " mke2fs-J fstype blocksize device journal\n"
20921 #: ../fish/guestfish-actions.pod:2508
20922 msgid "See also L</mke2journal>."
20926 #: ../fish/guestfish-actions.pod:2510
20931 #: ../fish/guestfish-actions.pod:2512
20934 " mke2fs-JL fstype blocksize device label\n"
20939 #: ../fish/guestfish-actions.pod:2517
20940 msgid "See also L</mke2journal-L>."
20944 #: ../fish/guestfish-actions.pod:2519
20949 #: ../fish/guestfish-actions.pod:2521
20952 " mke2fs-JU fstype blocksize device uuid\n"
20957 #: ../fish/guestfish-actions.pod:2526
20958 msgid "See also L</mke2journal-U>."
20962 #: ../fish/guestfish-actions.pod:2528
20963 msgid "mke2journal"
20967 #: ../fish/guestfish-actions.pod:2530
20970 " mke2journal blocksize device\n"
20975 #: ../fish/guestfish-actions.pod:2537
20976 msgid "mke2journal-L"
20980 #: ../fish/guestfish-actions.pod:2539
20983 " mke2journal-L blocksize label device\n"
20988 #: ../fish/guestfish-actions.pod:2543
20989 msgid "mke2journal-U"
20993 #: ../fish/guestfish-actions.pod:2545
20996 " mke2journal-U blocksize uuid device\n"
21001 #: ../fish/guestfish-actions.pod:2549
21006 #: ../fish/guestfish-actions.pod:2551
21009 " mkfifo mode path\n"
21014 #: ../fish/guestfish-actions.pod:2553
21016 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
21017 "is just a convenient wrapper around L</mknod>."
21021 #: ../fish/guestfish-actions.pod:2559
21026 #: ../fish/guestfish-actions.pod:2561
21029 " mkfs fstype device\n"
21034 #: ../fish/guestfish-actions.pod:2567
21039 #: ../fish/guestfish-actions.pod:2569
21042 " mkfs-b fstype blocksize device\n"
21047 #: ../fish/guestfish-actions.pod:2571
21049 "This call is similar to L</mkfs>, but it allows you to control the block "
21050 "size of the resulting filesystem. Supported block sizes depend on the "
21051 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
21055 #: ../fish/guestfish-actions.pod:2579
21056 msgid "mkmountpoint"
21060 #: ../fish/guestfish-actions.pod:2581
21063 " mkmountpoint exemptpath\n"
21068 #: ../fish/guestfish-actions.pod:2583
21070 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
21071 "to create extra mountpoints before mounting the first filesystem."
21075 #: ../fish/guestfish-actions.pod:2607
21077 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
21078 "unexpected errors if you try to mix these calls. It is safest to manually "
21079 "unmount filesystems and remove mountpoints after use."
21083 #: ../fish/guestfish-actions.pod:2611
21085 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
21086 "for this to work for manual mountpoints, you must ensure that the innermost "
21087 "mountpoints have the longest pathnames, as in the example code above."
21091 #: ../fish/guestfish-actions.pod:2618
21093 "Autosync [see L</set-autosync>, this is set by default on handles] means "
21094 "that L</umount-all> is called when the handle is closed which can also "
21095 "trigger these issues."
21099 #: ../fish/guestfish-actions.pod:2622
21104 #: ../fish/guestfish-actions.pod:2624
21107 " mknod mode devmajor devminor path\n"
21112 #: ../fish/guestfish-actions.pod:2634
21114 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
21115 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
21116 "regular file). These constants are available in the standard Linux header "
21117 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
21118 "wrappers around this command which bitwise OR in the appropriate constant "
21123 #: ../fish/guestfish-actions.pod:2644
21128 #: ../fish/guestfish-actions.pod:2646
21131 " mknod-b mode devmajor devminor path\n"
21136 #: ../fish/guestfish-actions.pod:2648
21138 "This call creates a block device node called C<path> with mode C<mode> and "
21139 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
21140 "wrapper around L</mknod>."
21144 #: ../fish/guestfish-actions.pod:2654
21149 #: ../fish/guestfish-actions.pod:2656
21152 " mknod-c mode devmajor devminor path\n"
21157 #: ../fish/guestfish-actions.pod:2658
21159 "This call creates a char device node called C<path> with mode C<mode> and "
21160 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
21161 "wrapper around L</mknod>."
21165 #: ../fish/guestfish-actions.pod:2664
21170 #: ../fish/guestfish-actions.pod:2666
21178 #: ../fish/guestfish-actions.pod:2670
21183 #: ../fish/guestfish-actions.pod:2672
21186 " mkswap-L label device\n"
21191 #: ../fish/guestfish-actions.pod:2680
21196 #: ../fish/guestfish-actions.pod:2682
21199 " mkswap-U uuid device\n"
21204 #: ../fish/guestfish-actions.pod:2686
21205 msgid "mkswap-file"
21209 #: ../fish/guestfish-actions.pod:2688
21212 " mkswap-file path\n"
21217 #: ../fish/guestfish-actions.pod:2692
21219 "This command just writes a swap file signature to an existing file. To "
21220 "create the file itself, use something like L</fallocate>."
21224 #: ../fish/guestfish-actions.pod:2695
21229 #: ../fish/guestfish-actions.pod:2697
21232 " modprobe modulename\n"
21237 #: ../fish/guestfish-actions.pod:2704
21242 #: ../fish/guestfish-actions.pod:2706
21245 " mount device mountpoint\n"
21250 #: ../fish/guestfish-actions.pod:2722
21252 "B<Important note:> When you use this call, the filesystem options C<sync> "
21253 "and C<noatime> are set implicitly. This was originally done because we "
21254 "thought it would improve reliability, but it turns out that I<-o sync> has a "
21255 "very large negative performance impact and negligible effect on "
21256 "reliability. Therefore we recommend that you avoid using L</mount> in any "
21257 "code that needs performance, and instead use L</mount-options> (use an empty "
21258 "string for the first parameter if you don't want any options)."
21262 #: ../fish/guestfish-actions.pod:2732
21267 #: ../fish/guestfish-actions.pod:2734
21270 " mount-loop file mountpoint\n"
21275 #: ../fish/guestfish-actions.pod:2740
21276 msgid "mount-options"
21280 #: ../fish/guestfish-actions.pod:2742
21283 " mount-options options device mountpoint\n"
21288 #: ../fish/guestfish-actions.pod:2744
21290 "This is the same as the L</mount> command, but it allows you to set the "
21291 "mount options as for the L<mount(8)> I<-o> flag."
21295 #: ../fish/guestfish-actions.pod:2752
21300 #: ../fish/guestfish-actions.pod:2754
21303 " mount-ro device mountpoint\n"
21308 #: ../fish/guestfish-actions.pod:2756
21310 "This is the same as the L</mount> command, but it mounts the filesystem with "
21311 "the read-only (I<-o ro>) flag."
21315 #: ../fish/guestfish-actions.pod:2759
21320 #: ../fish/guestfish-actions.pod:2761
21323 " mount-vfs options vfstype device mountpoint\n"
21328 #: ../fish/guestfish-actions.pod:2763
21330 "This is the same as the L</mount> command, but it allows you to set both the "
21331 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
21335 #: ../fish/guestfish-actions.pod:2767
21336 msgid "mountpoints"
21340 #: ../fish/guestfish-actions.pod:2769
21348 #: ../fish/guestfish-actions.pod:2771
21350 "This call is similar to L</mounts>. That call returns a list of devices. "
21351 "This one returns a hash table (map) of device name to directory where the "
21352 "device is mounted."
21356 #: ../fish/guestfish-actions.pod:2775
21361 #: ../fish/guestfish-actions.pod:2777
21369 #: ../fish/guestfish-actions.pod:2784
21370 msgid "See also: L</mountpoints>"
21374 #: ../fish/guestfish-actions.pod:2786
21379 #: ../fish/guestfish-actions.pod:2788
21387 #: ../fish/guestfish-actions.pod:2793
21388 msgid "ntfs-3g-probe"
21392 #: ../fish/guestfish-actions.pod:2795
21395 " ntfs-3g-probe true|false device\n"
21400 #: ../fish/guestfish-actions.pod:2809
21405 #: ../fish/guestfish-actions.pod:2811
21408 " ntfsresize device\n"
21413 #: ../fish/guestfish-actions.pod:2817
21414 msgid "ntfsresize-size"
21418 #: ../fish/guestfish-actions.pod:2819
21421 " ntfsresize-size device size\n"
21426 #: ../fish/guestfish-actions.pod:2821
21428 "This command is the same as L</ntfsresize> except that it allows you to "
21429 "specify the new size (in bytes) explicitly."
21433 #: ../fish/guestfish-actions.pod:2824
21438 #: ../fish/guestfish-actions.pod:2826
21441 " part-add device prlogex startsect endsect\n"
21446 #: ../fish/guestfish-actions.pod:2828
21448 "This command adds a partition to C<device>. If there is no partition table "
21449 "on the device, call L</part-init> first."
21453 #: ../fish/guestfish-actions.pod:2840
21455 "Creating a partition which covers the whole disk is not so easy. Use L</"
21456 "part-disk> to do that."
21460 #: ../fish/guestfish-actions.pod:2843
21465 #: ../fish/guestfish-actions.pod:2845
21468 " part-del device partnum\n"
21473 #: ../fish/guestfish-actions.pod:2853
21478 #: ../fish/guestfish-actions.pod:2855
21481 " part-disk device parttype\n"
21486 #: ../fish/guestfish-actions.pod:2857
21488 "This command is simply a combination of L</part-init> followed by L</part-"
21489 "add> to create a single primary partition covering the whole disk."
21493 #: ../fish/guestfish-actions.pod:2861
21495 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
21496 "possible values are described in L</part-init>."
21500 #: ../fish/guestfish-actions.pod:2867
21501 msgid "part-get-bootable"
21505 #: ../fish/guestfish-actions.pod:2869
21508 " part-get-bootable device partnum\n"
21513 #: ../fish/guestfish-actions.pod:2874
21514 msgid "See also L</part-set-bootable>."
21518 #: ../fish/guestfish-actions.pod:2876
21519 msgid "part-get-mbr-id"
21523 #: ../fish/guestfish-actions.pod:2878
21526 " part-get-mbr-id device partnum\n"
21531 #: ../fish/guestfish-actions.pod:2883 ../fish/guestfish-actions.pod:3021
21533 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
21534 "undefined results for other partition table types (see L</part-get-"
21539 #: ../fish/guestfish-actions.pod:2887
21540 msgid "part-get-parttype"
21544 #: ../fish/guestfish-actions.pod:2889
21547 " part-get-parttype device\n"
21552 #: ../fish/guestfish-actions.pod:2894
21554 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
21555 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
21556 "possible, although unusual. See L</part-init> for a full list."
21560 #: ../fish/guestfish-actions.pod:2899
21565 #: ../fish/guestfish-actions.pod:2901
21568 " part-init device parttype\n"
21573 #: ../fish/guestfish-actions.pod:2907
21575 "Initially there are no partitions. Following this, you should call L</part-"
21576 "add> for each partition required."
21580 #: ../fish/guestfish-actions.pod:2970
21585 #: ../fish/guestfish-actions.pod:2972
21588 " part-list device\n"
21593 #: ../fish/guestfish-actions.pod:2987
21595 "Start of the partition I<in bytes>. To get sectors you have to divide by "
21596 "the device's sector size, see L</blockdev-getss>."
21600 #: ../fish/guestfish-actions.pod:3000
21601 msgid "part-set-bootable"
21605 #: ../fish/guestfish-actions.pod:3002
21608 " part-set-bootable device partnum true|false\n"
21613 #: ../fish/guestfish-actions.pod:3011
21614 msgid "part-set-mbr-id"
21618 #: ../fish/guestfish-actions.pod:3013
21621 " part-set-mbr-id device partnum idbyte\n"
21626 #: ../fish/guestfish-actions.pod:3025
21627 msgid "part-set-name"
21631 #: ../fish/guestfish-actions.pod:3027
21634 " part-set-name device partnum name\n"
21639 #: ../fish/guestfish-actions.pod:3035
21640 msgid "part-to-dev"
21644 #: ../fish/guestfish-actions.pod:3037
21647 " part-to-dev partition\n"
21652 #: ../fish/guestfish-actions.pod:3043
21654 "The named partition must exist, for example as a string returned from L</"
21655 "list-partitions>."
21659 #: ../fish/guestfish-actions.pod:3046
21660 msgid "ping-daemon"
21664 #: ../fish/guestfish-actions.pod:3048
21672 #: ../fish/guestfish-actions.pod:3055
21677 #: ../fish/guestfish-actions.pod:3057
21680 " pread path count offset\n"
21685 #: ../fish/guestfish-actions.pod:3065
21686 msgid "See also L</pwrite>, L</pread-device>."
21690 #: ../fish/guestfish-actions.pod:3070
21691 msgid "pread-device"
21695 #: ../fish/guestfish-actions.pod:3072
21698 " pread-device device count offset\n"
21703 #: ../fish/guestfish-actions.pod:3080
21704 msgid "See also L</pread>."
21708 #: ../fish/guestfish-actions.pod:3085
21713 #: ../fish/guestfish-actions.pod:3087
21716 " pvcreate device\n"
21721 #: ../fish/guestfish-actions.pod:3093
21726 #: ../fish/guestfish-actions.pod:3095
21729 " pvremove device\n"
21734 #: ../fish/guestfish-actions.pod:3104
21739 #: ../fish/guestfish-actions.pod:3106
21742 " pvresize device\n"
21747 #: ../fish/guestfish-actions.pod:3111
21748 msgid "pvresize-size"
21752 #: ../fish/guestfish-actions.pod:3113
21755 " pvresize-size device size\n"
21760 #: ../fish/guestfish-actions.pod:3115
21762 "This command is the same as L</pvresize> except that it allows you to "
21763 "specify the new size (in bytes) explicitly."
21767 #: ../fish/guestfish-actions.pod:3118
21772 #: ../fish/guestfish-actions.pod:3120
21780 #: ../fish/guestfish-actions.pod:3128
21781 msgid "See also L</pvs-full>."
21785 #: ../fish/guestfish-actions.pod:3130
21790 #: ../fish/guestfish-actions.pod:3132
21798 #: ../fish/guestfish-actions.pod:3137
21803 #: ../fish/guestfish-actions.pod:3139
21811 #: ../fish/guestfish-actions.pod:3143
21816 #: ../fish/guestfish-actions.pod:3145
21819 " pwrite path content offset\n"
21824 #: ../fish/guestfish-actions.pod:3156
21825 msgid "See also L</pread>, L</pwrite-device>."
21829 #: ../fish/guestfish-actions.pod:3161
21830 msgid "pwrite-device"
21834 #: ../fish/guestfish-actions.pod:3163
21837 " pwrite-device device content offset\n"
21842 #: ../fish/guestfish-actions.pod:3173
21843 msgid "See also L</pwrite>."
21847 #: ../fish/guestfish-actions.pod:3178
21852 #: ../fish/guestfish-actions.pod:3180
21855 " read-file path\n"
21860 #: ../fish/guestfish-actions.pod:3185
21862 "Unlike L</cat>, this function can correctly handle files that contain "
21863 "embedded ASCII NUL characters. However unlike L</download>, this function "
21864 "is limited in the total size of file that can be handled."
21868 #: ../fish/guestfish-actions.pod:3193
21873 #: ../fish/guestfish-actions.pod:3195
21876 " read-lines path\n"
21881 #: ../fish/guestfish-actions.pod:3202
21883 "Note that this function cannot correctly handle binary files (specifically, "
21884 "files containing C<\\0> character which is treated as end of line). For "
21885 "those you need to use the L</read-file> function which has a more complex "
21890 #: ../fish/guestfish-actions.pod:3207
21895 #: ../fish/guestfish-actions.pod:3209
21903 #: ../fish/guestfish-actions.pod:3261
21905 "This function is primarily intended for use by programs. To get a simple "
21906 "list of names, use L</ls>. To get a printable directory for human "
21907 "consumption, use L</ll>."
21911 #: ../fish/guestfish-actions.pod:3265
21916 #: ../fish/guestfish-actions.pod:3267
21924 #: ../fish/guestfish-actions.pod:3271
21925 msgid "readlinklist"
21929 #: ../fish/guestfish-actions.pod:3273
21932 " readlinklist path 'names ...'\n"
21937 #: ../fish/guestfish-actions.pod:3297
21942 #: ../fish/guestfish-actions.pod:3299
21950 #: ../fish/guestfish-actions.pod:3304
21951 msgid "removexattr"
21955 #: ../fish/guestfish-actions.pod:3306
21958 " removexattr xattr path\n"
21963 #: ../fish/guestfish-actions.pod:3311
21964 msgid "See also: L</lremovexattr>, L<attr(5)>."
21968 #: ../fish/guestfish-actions.pod:3313
21973 #: ../fish/guestfish-actions.pod:3315
21976 " resize2fs device\n"
21981 #: ../fish/guestfish-actions.pod:3320
21983 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
21984 "before calling this command. For unknown reasons C<resize2fs> sometimes "
21985 "gives an error about this and sometimes not. In any case, it is always safe "
21986 "to call L</e2fsck-f> before calling this function."
21990 #: ../fish/guestfish-actions.pod:3326
21991 msgid "resize2fs-size"
21995 #: ../fish/guestfish-actions.pod:3328
21998 " resize2fs-size device size\n"
22003 #: ../fish/guestfish-actions.pod:3330
22005 "This command is the same as L</resize2fs> except that it allows you to "
22006 "specify the new size (in bytes) explicitly."
22010 #: ../fish/guestfish-actions.pod:3333
22015 #: ../fish/guestfish-actions.pod:3335
22023 #: ../fish/guestfish-actions.pod:3339
22028 #: ../fish/guestfish-actions.pod:3341
22036 #: ../fish/guestfish-actions.pod:3347
22041 #: ../fish/guestfish-actions.pod:3349
22049 #: ../fish/guestfish-actions.pod:3353
22050 msgid "rmmountpoint"
22054 #: ../fish/guestfish-actions.pod:3355
22057 " rmmountpoint exemptpath\n"
22062 #: ../fish/guestfish-actions.pod:3357
22064 "This calls removes a mountpoint that was previously created with L</"
22065 "mkmountpoint>. See L</mkmountpoint> for full details."
22069 #: ../fish/guestfish-actions.pod:3361
22070 msgid "scrub-device"
22074 #: ../fish/guestfish-actions.pod:3363
22077 " scrub-device device\n"
22082 #: ../fish/guestfish-actions.pod:3374
22087 #: ../fish/guestfish-actions.pod:3376
22090 " scrub-file file\n"
22095 #: ../fish/guestfish-actions.pod:3386
22096 msgid "scrub-freespace"
22100 #: ../fish/guestfish-actions.pod:3388
22103 " scrub-freespace dir\n"
22108 #: ../fish/guestfish-actions.pod:3390
22110 "This command creates the directory C<dir> and then fills it with files until "
22111 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
22112 "deletes them. The intention is to scrub any free space on the partition "
22113 "containing C<dir>."
22117 #: ../fish/guestfish-actions.pod:3399
22122 #: ../fish/guestfish-actions.pod:3401
22127 #: ../fish/guestfish-actions.pod:3403
22130 " set-append append\n"
22135 #: ../fish/guestfish-actions.pod:3414
22136 msgid "set-autosync"
22140 #: ../fish/guestfish-actions.pod:3416
22145 #: ../fish/guestfish-actions.pod:3418
22148 " set-autosync true|false\n"
22153 #: ../fish/guestfish-actions.pod:3420
22155 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
22156 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
22157 "closed (also if the program exits without closing handles)."
22161 #: ../fish/guestfish-actions.pod:3428
22166 #: ../fish/guestfish-actions.pod:3430
22171 #: ../fish/guestfish-actions.pod:3432
22174 " set-direct true|false\n"
22179 #: ../fish/guestfish-actions.pod:3438
22181 "One consequence of this is that log messages aren't caught by the library "
22182 "and handled by L</set-log-message-callback>, but go straight to stdout."
22186 #: ../fish/guestfish-actions.pod:3447
22187 msgid "set-e2label"
22191 #: ../fish/guestfish-actions.pod:3449
22194 " set-e2label device label\n"
22199 #: ../fish/guestfish-actions.pod:3455
22201 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
22202 "label on a filesystem."
22206 #: ../fish/guestfish-actions.pod:3458
22211 #: ../fish/guestfish-actions.pod:3460
22214 " set-e2uuid device uuid\n"
22219 #: ../fish/guestfish-actions.pod:3467
22221 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
22222 "UUID of a filesystem."
22226 #: ../fish/guestfish-actions.pod:3470
22227 msgid "set-memsize"
22231 #: ../fish/guestfish-actions.pod:3472
22236 #: ../fish/guestfish-actions.pod:3474
22239 " set-memsize memsize\n"
22244 #: ../fish/guestfish-actions.pod:3476
22246 "This sets the memory size in megabytes allocated to the qemu subprocess. "
22247 "This only has any effect if called before L</launch>."
22251 #: ../fish/guestfish-actions.pod:3487
22252 msgid "set-network"
22256 #: ../fish/guestfish-actions.pod:3489
22261 #: ../fish/guestfish-actions.pod:3491
22264 " set-network true|false\n"
22269 #: ../fish/guestfish-actions.pod:3499
22271 "You must call this before calling L</launch>, otherwise it has no effect."
22275 #: ../fish/guestfish-actions.pod:3502
22280 #: ../fish/guestfish-actions.pod:3504
22285 #: ../fish/guestfish-actions.pod:3506
22288 " set-path searchpath\n"
22293 #: ../fish/guestfish-actions.pod:3515
22298 #: ../fish/guestfish-actions.pod:3517
22303 #: ../fish/guestfish-actions.pod:3519
22311 #: ../fish/guestfish-actions.pod:3539
22312 msgid "set-recovery-proc"
22316 #: ../fish/guestfish-actions.pod:3541
22317 msgid "recovery-proc"
22321 #: ../fish/guestfish-actions.pod:3543
22324 " set-recovery-proc true|false\n"
22329 #: ../fish/guestfish-actions.pod:3545
22331 "If this is called with the parameter C<false> then L</launch> does not "
22332 "create a recovery process. The purpose of the recovery process is to stop "
22333 "runaway qemu processes in the case where the main program aborts abruptly."
22337 #: ../fish/guestfish-actions.pod:3550
22339 "This only has any effect if called before L</launch>, and the default is "
22344 #: ../fish/guestfish-actions.pod:3559
22345 msgid "set-selinux"
22349 #: ../fish/guestfish-actions.pod:3561
22354 #: ../fish/guestfish-actions.pod:3563
22357 " set-selinux true|false\n"
22362 #: ../fish/guestfish-actions.pod:3574
22367 #: ../fish/guestfish-actions.pod:3576
22372 #: ../fish/guestfish-actions.pod:3578
22375 " set-trace true|false\n"
22380 #: ../fish/guestfish-actions.pod:3594
22381 msgid "set-verbose"
22385 #: ../fish/guestfish-actions.pod:3596
22390 #: ../fish/guestfish-actions.pod:3598
22393 " set-verbose true|false\n"
22398 #: ../fish/guestfish-actions.pod:3605
22403 #: ../fish/guestfish-actions.pod:3607
22406 " setcon context\n"
22411 #: ../fish/guestfish-actions.pod:3614
22416 #: ../fish/guestfish-actions.pod:3616
22419 " setxattr xattr val vallen path\n"
22424 #: ../fish/guestfish-actions.pod:3622
22425 msgid "See also: L</lsetxattr>, L<attr(5)>."
22429 #: ../fish/guestfish-actions.pod:3624
22434 #: ../fish/guestfish-actions.pod:3626
22437 " sfdisk device cyls heads sectors 'lines ...'\n"
22442 #: ../fish/guestfish-actions.pod:3648
22443 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
22447 #: ../fish/guestfish-actions.pod:3654
22452 #: ../fish/guestfish-actions.pod:3656
22455 " sfdiskM device 'lines ...'\n"
22460 #: ../fish/guestfish-actions.pod:3658
22462 "This is a simplified interface to the L</sfdisk> command, where partition "
22463 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
22464 "you don't need to specify the cyls, heads and sectors parameters which were "
22465 "rarely if ever used anyway."
22469 #: ../fish/guestfish-actions.pod:3664
22470 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
22474 #: ../fish/guestfish-actions.pod:3670
22479 #: ../fish/guestfish-actions.pod:3672
22482 " sfdisk-N device partnum cyls heads sectors line\n"
22487 #: ../fish/guestfish-actions.pod:3677
22489 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
22490 "cyls/heads/sectors parameters."
22494 #: ../fish/guestfish-actions.pod:3680
22495 msgid "See also: L</part-add>"
22499 #: ../fish/guestfish-actions.pod:3685
22500 msgid "sfdisk-disk-geometry"
22504 #: ../fish/guestfish-actions.pod:3687
22507 " sfdisk-disk-geometry device\n"
22512 #: ../fish/guestfish-actions.pod:3689
22514 "This displays the disk geometry of C<device> read from the partition table. "
22515 "Especially in the case where the underlying block device has been resized, "
22516 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
22517 "kernel-geometry>)."
22521 #: ../fish/guestfish-actions.pod:3697
22522 msgid "sfdisk-kernel-geometry"
22526 #: ../fish/guestfish-actions.pod:3699
22529 " sfdisk-kernel-geometry device\n"
22534 #: ../fish/guestfish-actions.pod:3706
22539 #: ../fish/guestfish-actions.pod:3708
22542 " sfdisk-l device\n"
22547 #: ../fish/guestfish-actions.pod:3714
22548 msgid "See also: L</part-list>"
22552 #: ../fish/guestfish-actions.pod:3716
22557 #: ../fish/guestfish-actions.pod:3718
22565 #: ../fish/guestfish-actions.pod:3723
22566 msgid "This is like L</command>, but passes the command to:"
22570 #: ../fish/guestfish-actions.pod:3731
22571 msgid "All the provisos about L</command> apply to this call."
22575 #: ../fish/guestfish-actions.pod:3733
22580 #: ../fish/guestfish-actions.pod:3735
22583 " sh-lines command\n"
22588 #: ../fish/guestfish-actions.pod:3737
22589 msgid "This is the same as L</sh>, but splits the result into a list of lines."
22593 #: ../fish/guestfish-actions.pod:3740
22594 msgid "See also: L</command-lines>"
22598 #: ../fish/guestfish-actions.pod:3742
22603 #: ../fish/guestfish-actions.pod:3744
22611 #: ../fish/guestfish-actions.pod:3748
22616 #: ../fish/guestfish-actions.pod:3750
22624 #: ../fish/guestfish-actions.pod:3756
22629 #: ../fish/guestfish-actions.pod:3758
22637 #: ../fish/guestfish-actions.pod:3766
22642 #: ../fish/guestfish-actions.pod:3768
22650 #: ../fish/guestfish-actions.pod:3776
22655 #: ../fish/guestfish-actions.pod:3778
22658 " strings-e encoding path\n"
22663 #: ../fish/guestfish-actions.pod:3780
22665 "This is like the L</strings> command, but allows you to specify the encoding "
22666 "of strings that are looked for in the source file C<path>."
22670 #: ../fish/guestfish-actions.pod:3790
22672 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
22673 "ISO-8859-X (this is what L</strings> uses)."
22677 #: ../fish/guestfish-actions.pod:3822
22678 msgid "swapoff-device"
22682 #: ../fish/guestfish-actions.pod:3824
22685 " swapoff-device device\n"
22690 #: ../fish/guestfish-actions.pod:3826
22692 "This command disables the libguestfs appliance swap device or partition "
22693 "named C<device>. See L</swapon-device>."
22697 #: ../fish/guestfish-actions.pod:3830
22698 msgid "swapoff-file"
22702 #: ../fish/guestfish-actions.pod:3832
22705 " swapoff-file file\n"
22710 #: ../fish/guestfish-actions.pod:3836
22711 msgid "swapoff-label"
22715 #: ../fish/guestfish-actions.pod:3838
22718 " swapoff-label label\n"
22723 #: ../fish/guestfish-actions.pod:3843
22724 msgid "swapoff-uuid"
22728 #: ../fish/guestfish-actions.pod:3845
22731 " swapoff-uuid uuid\n"
22736 #: ../fish/guestfish-actions.pod:3850
22737 msgid "swapon-device"
22741 #: ../fish/guestfish-actions.pod:3852
22744 " swapon-device device\n"
22749 #: ../fish/guestfish-actions.pod:3854
22751 "This command enables the libguestfs appliance to use the swap device or "
22752 "partition named C<device>. The increased memory is made available for all "
22753 "commands, for example those run using L</command> or L</sh>."
22757 #: ../fish/guestfish-actions.pod:3866
22758 msgid "swapon-file"
22762 #: ../fish/guestfish-actions.pod:3868
22765 " swapon-file file\n"
22770 #: ../fish/guestfish-actions.pod:3870
22772 "This command enables swap to a file. See L</swapon-device> for other notes."
22776 #: ../fish/guestfish-actions.pod:3873
22777 msgid "swapon-label"
22781 #: ../fish/guestfish-actions.pod:3875
22784 " swapon-label label\n"
22789 #: ../fish/guestfish-actions.pod:3877
22791 "This command enables swap to a labeled swap partition. See L</swapon-"
22792 "device> for other notes."
22796 #: ../fish/guestfish-actions.pod:3880
22797 msgid "swapon-uuid"
22801 #: ../fish/guestfish-actions.pod:3882
22804 " swapon-uuid uuid\n"
22809 #: ../fish/guestfish-actions.pod:3884
22811 "This command enables swap to a swap partition with the given UUID. See L</"
22812 "swapon-device> for other notes."
22816 #: ../fish/guestfish-actions.pod:3887
22821 #: ../fish/guestfish-actions.pod:3889
22829 #: ../fish/guestfish-actions.pod:3897
22834 #: ../fish/guestfish-actions.pod:3899
22842 #: ../fish/guestfish-actions.pod:3907
22847 #: ../fish/guestfish-actions.pod:3909
22850 " tail-n nrlines path\n"
22855 #: ../fish/guestfish-actions.pod:3922
22860 #: ../fish/guestfish-actions.pod:3924
22863 " tar-in (tarfile|-) directory\n"
22868 #: ../fish/guestfish-actions.pod:3929
22869 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
22873 #: ../fish/guestfish-actions.pod:3934
22878 #: ../fish/guestfish-actions.pod:3936
22881 " tar-out directory (tarfile|-)\n"
22886 #: ../fish/guestfish-actions.pod:3941
22887 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
22891 #: ../fish/guestfish-actions.pod:3946
22896 #: ../fish/guestfish-actions.pod:3948
22899 " tgz-in (tarball|-) directory\n"
22904 #: ../fish/guestfish-actions.pod:3953
22905 msgid "To upload an uncompressed tarball, use L</tar-in>."
22909 #: ../fish/guestfish-actions.pod:3957
22914 #: ../fish/guestfish-actions.pod:3959
22917 " tgz-out directory (tarball|-)\n"
22922 #: ../fish/guestfish-actions.pod:3964
22923 msgid "To download an uncompressed tarball, use L</tar-out>."
22927 #: ../fish/guestfish-actions.pod:3968
22932 #: ../fish/guestfish-actions.pod:3970
22940 #: ../fish/guestfish-actions.pod:3979
22945 #: ../fish/guestfish-actions.pod:3981
22953 #: ../fish/guestfish-actions.pod:3986
22954 msgid "truncate-size"
22958 #: ../fish/guestfish-actions.pod:3988
22961 " truncate-size path size\n"
22966 #: ../fish/guestfish-actions.pod:3993
22968 "If the current file size is less than C<size> then the file is extended to "
22969 "the required size with zero bytes. This creates a sparse file (ie. disk "
22970 "blocks are not allocated for the file until you write to it). To create a "
22971 "non-sparse file of zeroes, use L</fallocate64> instead."
22975 #: ../fish/guestfish-actions.pod:3999
22980 #: ../fish/guestfish-actions.pod:4001
22983 " tune2fs-l device\n"
22988 #: ../fish/guestfish-actions.pod:4011
22993 #: ../fish/guestfish-actions.pod:4013
22996 " txz-in (tarball|-) directory\n"
23001 #: ../fish/guestfish-actions.pod:4020
23006 #: ../fish/guestfish-actions.pod:4022
23009 " txz-out directory (tarball|-)\n"
23014 #: ../fish/guestfish-actions.pod:4029
23019 #: ../fish/guestfish-actions.pod:4031
23027 #: ../fish/guestfish-actions.pod:4045
23028 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
23032 #: ../fish/guestfish-actions.pod:4050
23037 #: ../fish/guestfish-actions.pod:4052
23042 #: ../fish/guestfish-actions.pod:4054
23045 " umount pathordevice\n"
23050 #: ../fish/guestfish-actions.pod:4060
23055 #: ../fish/guestfish-actions.pod:4062
23056 msgid "unmount-all"
23060 #: ../fish/guestfish-actions.pod:4064
23068 #: ../fish/guestfish-actions.pod:4070
23073 #: ../fish/guestfish-actions.pod:4072
23076 " upload (filename|-) remotefilename\n"
23081 #: ../fish/guestfish-actions.pod:4079
23082 msgid "See also L</download>."
23086 #: ../fish/guestfish-actions.pod:4083
23087 msgid "upload-offset"
23091 #: ../fish/guestfish-actions.pod:4085
23094 " upload-offset (filename|-) remotefilename offset\n"
23099 #: ../fish/guestfish-actions.pod:4097
23101 "Note that there is no limit on the amount of data that can be uploaded with "
23102 "this call, unlike with L</pwrite>, and this call always writes the full "
23103 "amount unless an error occurs."
23107 #: ../fish/guestfish-actions.pod:4102
23108 msgid "See also L</upload>, L</pwrite>."
23112 #: ../fish/guestfish-actions.pod:4106
23117 #: ../fish/guestfish-actions.pod:4108
23120 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
23125 #: ../fish/guestfish-actions.pod:4127
23130 #: ../fish/guestfish-actions.pod:4129
23138 #: ../fish/guestfish-actions.pod:4156
23140 "I<Note:> Don't use this call to test for availability of features. In "
23141 "enterprise distributions we backport features from later versions into "
23142 "earlier versions, making this an unreliable way to test for features. Use "
23143 "L</available> instead."
23147 #: ../fish/guestfish-actions.pod:4162
23152 #: ../fish/guestfish-actions.pod:4164
23155 " vfs-label device\n"
23160 #: ../fish/guestfish-actions.pod:4171
23161 msgid "To find a filesystem from the label, use L</findfs-label>."
23165 #: ../fish/guestfish-actions.pod:4173
23170 #: ../fish/guestfish-actions.pod:4175
23173 " vfs-type device\n"
23178 #: ../fish/guestfish-actions.pod:4185
23183 #: ../fish/guestfish-actions.pod:4187
23186 " vfs-uuid device\n"
23191 #: ../fish/guestfish-actions.pod:4194
23192 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
23196 #: ../fish/guestfish-actions.pod:4196
23197 msgid "vg-activate"
23201 #: ../fish/guestfish-actions.pod:4198
23204 " vg-activate true|false 'volgroups ...'\n"
23209 #: ../fish/guestfish-actions.pod:4211
23210 msgid "vg-activate-all"
23214 #: ../fish/guestfish-actions.pod:4213
23217 " vg-activate-all true|false\n"
23222 #: ../fish/guestfish-actions.pod:4223
23227 #: ../fish/guestfish-actions.pod:4225
23230 " vgcreate volgroup 'physvols ...'\n"
23235 #: ../fish/guestfish-actions.pod:4230
23240 #: ../fish/guestfish-actions.pod:4232
23243 " vglvuuids vgname\n"
23248 #: ../fish/guestfish-actions.pod:4237
23250 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
23251 "logical volumes and volume groups."
23255 #: ../fish/guestfish-actions.pod:4240
23256 msgid "See also L</vgpvuuids>."
23260 #: ../fish/guestfish-actions.pod:4242
23265 #: ../fish/guestfish-actions.pod:4244
23268 " vgpvuuids vgname\n"
23273 #: ../fish/guestfish-actions.pod:4249
23275 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
23276 "physical volumes and volume groups."
23280 #: ../fish/guestfish-actions.pod:4252
23281 msgid "See also L</vglvuuids>."
23285 #: ../fish/guestfish-actions.pod:4254
23290 #: ../fish/guestfish-actions.pod:4256
23293 " vgremove vgname\n"
23298 #: ../fish/guestfish-actions.pod:4263
23303 #: ../fish/guestfish-actions.pod:4265
23306 " vgrename volgroup newvolgroup\n"
23311 #: ../fish/guestfish-actions.pod:4269
23316 #: ../fish/guestfish-actions.pod:4271
23324 #: ../fish/guestfish-actions.pod:4279
23325 msgid "See also L</vgs-full>."
23329 #: ../fish/guestfish-actions.pod:4281
23334 #: ../fish/guestfish-actions.pod:4283
23342 #: ../fish/guestfish-actions.pod:4288
23347 #: ../fish/guestfish-actions.pod:4290
23355 #: ../fish/guestfish-actions.pod:4295
23360 #: ../fish/guestfish-actions.pod:4297
23368 #: ../fish/guestfish-actions.pod:4301
23373 #: ../fish/guestfish-actions.pod:4303
23381 #: ../fish/guestfish-actions.pod:4308
23386 #: ../fish/guestfish-actions.pod:4310
23394 #: ../fish/guestfish-actions.pod:4315
23399 #: ../fish/guestfish-actions.pod:4317
23407 #: ../fish/guestfish-actions.pod:4322
23412 #: ../fish/guestfish-actions.pod:4324
23415 " write path content\n"
23420 #: ../fish/guestfish-actions.pod:4332
23425 #: ../fish/guestfish-actions.pod:4334
23428 " write-file path content size\n"
23433 #: ../fish/guestfish-actions.pod:4357
23438 #: ../fish/guestfish-actions.pod:4359
23441 " zegrep regex path\n"
23446 #: ../fish/guestfish-actions.pod:4367
23451 #: ../fish/guestfish-actions.pod:4369
23454 " zegrepi regex path\n"
23459 #: ../fish/guestfish-actions.pod:4377
23464 #: ../fish/guestfish-actions.pod:4379
23472 #: ../fish/guestfish-actions.pod:4387
23473 msgid "See also: L</zero-device>, L</scrub-device>."
23477 #: ../fish/guestfish-actions.pod:4389
23478 msgid "zero-device"
23482 #: ../fish/guestfish-actions.pod:4391
23485 " zero-device device\n"
23490 #: ../fish/guestfish-actions.pod:4393
23492 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
23493 "which just zeroes the first few blocks of a device."
23497 #: ../fish/guestfish-actions.pod:4400
23502 #: ../fish/guestfish-actions.pod:4402
23505 " zerofree device\n"
23510 #: ../fish/guestfish-actions.pod:4415
23515 #: ../fish/guestfish-actions.pod:4417
23518 " zfgrep pattern path\n"
23523 #: ../fish/guestfish-actions.pod:4425
23528 #: ../fish/guestfish-actions.pod:4427
23531 " zfgrepi pattern path\n"
23536 #: ../fish/guestfish-actions.pod:4435
23541 #: ../fish/guestfish-actions.pod:4437
23544 " zfile meth path\n"
23549 #: ../fish/guestfish-actions.pod:4444
23551 "Since 1.0.63, use L</file> instead which can now process compressed files."
23555 #: ../fish/guestfish-actions.pod:4454
23560 #: ../fish/guestfish-actions.pod:4456
23563 " zgrep regex path\n"
23568 #: ../fish/guestfish-actions.pod:4464
23573 #: ../fish/guestfish-actions.pod:4466
23576 " zgrepi regex path\n"
23581 #: ../fish/guestfish-commands.pod:1
23586 #: ../fish/guestfish-commands.pod:3
23591 #: ../fish/guestfish-commands.pod:5
23594 " alloc filename size\n"
23599 #: ../fish/guestfish-commands.pod:7
23601 "This creates an empty (zeroed) file of the given size, and then adds so it "
23602 "can be further examined."
23606 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
23607 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
23611 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
23612 msgid "Size can be specified using standard suffixes, eg. C<1M>."
23616 #: ../fish/guestfish-commands.pod:14
23618 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
23619 "image, see L</PREPARED DISK IMAGES>."
23623 #: ../fish/guestfish-commands.pod:17
23628 #: ../fish/guestfish-commands.pod:19
23631 " copy-in local [local ...] /remotedir\n"
23636 #: ../fish/guestfish-commands.pod:21
23638 "C<copy-in> copies local files or directories recursively into the disk "
23639 "image, placing them in the directory called C</remotedir> (which must "
23640 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
23641 "other commands as necessary."
23645 #: ../fish/guestfish-commands.pod:26
23647 "Multiple local files and directories can be specified, but the last "
23648 "parameter must always be a remote directory. Wildcards cannot be used."
23652 #: ../fish/guestfish-commands.pod:30
23657 #: ../fish/guestfish-commands.pod:32
23660 " copy-out remote [remote ...] localdir\n"
23665 #: ../fish/guestfish-commands.pod:34
23667 "C<copy-out> copies remote files or directories recursively out of the disk "
23668 "image, placing them on the host disk in a local directory called C<localdir> "
23669 "(which must exist). This guestfish meta-command turns into a sequence of L</"
23670 "download>, L</tar-out> and other commands as necessary."
23674 #: ../fish/guestfish-commands.pod:40
23676 "Multiple remote files and directories can be specified, but the last "
23677 "parameter must always be a local directory. To download to the current "
23678 "directory, use C<.> as in:"
23682 #: ../fish/guestfish-commands.pod:44
23685 " copy-out /home .\n"
23690 #: ../fish/guestfish-commands.pod:46
23692 "Wildcards cannot be used in the ordinary command, but you can use them with "
23693 "the help of L</glob> like this:"
23697 #: ../fish/guestfish-commands.pod:49
23700 " glob copy-out /home/* .\n"
23705 #: ../fish/guestfish-commands.pod:51
23710 #: ../fish/guestfish-commands.pod:53
23713 " echo [params ...]\n"
23718 #: ../fish/guestfish-commands.pod:55
23719 msgid "This echos the parameters to the terminal."
23723 #: ../fish/guestfish-commands.pod:57
23728 #: ../fish/guestfish-commands.pod:59
23733 #: ../fish/guestfish-commands.pod:61
23738 #: ../fish/guestfish-commands.pod:63
23746 #: ../fish/guestfish-commands.pod:65
23748 "This is used to edit a file. It downloads the file, edits it locally using "
23749 "your editor, then uploads the result."
23753 #: ../fish/guestfish-commands.pod:68
23755 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
23756 "or C<emacs> you will get those corresponding editors."
23760 #: ../fish/guestfish-commands.pod:72
23765 #: ../fish/guestfish-commands.pod:74
23768 " glob command args...\n"
23773 #: ../fish/guestfish-commands.pod:76
23775 "Expand wildcards in any paths in the args list, and run C<command> "
23776 "repeatedly on each matching path."
23780 #: ../fish/guestfish-commands.pod:79
23781 msgid "See L</WILDCARDS AND GLOBBING>."
23785 #: ../fish/guestfish-commands.pod:81
23790 #: ../fish/guestfish-commands.pod:83
23793 " hexedit <filename|device>\n"
23794 " hexedit <filename|device> <max>\n"
23795 " hexedit <filename|device> <start> <max>\n"
23800 #: ../fish/guestfish-commands.pod:87
23802 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
23807 #: ../fish/guestfish-commands.pod:90
23809 "This command works by downloading potentially the whole file or device, "
23810 "editing it locally, then uploading it. If the file or device is large, you "
23811 "have to specify which part you wish to edit by using C<max> and/or C<start> "
23812 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
23813 "usual modifiers allowed such as C<1M> (1 megabyte)."
23817 #: ../fish/guestfish-commands.pod:97
23818 msgid "For example to edit the first few sectors of a disk you might do:"
23822 #: ../fish/guestfish-commands.pod:100
23825 " hexedit /dev/sda 1M\n"
23830 #: ../fish/guestfish-commands.pod:102
23832 "which would allow you to edit anywhere within the first megabyte of the disk."
23836 #: ../fish/guestfish-commands.pod:105
23837 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
23841 #: ../fish/guestfish-commands.pod:107
23844 " hexedit /dev/sda1 0x400 0x400\n"
23849 #: ../fish/guestfish-commands.pod:109
23850 msgid "(assuming the superblock is in the standard location)."
23854 #: ../fish/guestfish-commands.pod:111
23856 "This command requires the external L<hexedit(1)> program. You can specify "
23857 "another program to use by setting the C<HEXEDITOR> environment variable."
23861 #: ../fish/guestfish-commands.pod:115
23862 msgid "See also L</hexdump>."
23866 #: ../fish/guestfish-commands.pod:117
23871 #: ../fish/guestfish-commands.pod:119
23879 #: ../fish/guestfish-commands.pod:121
23881 "Change the local directory, ie. the current directory of guestfish itself."
23885 #: ../fish/guestfish-commands.pod:124
23886 msgid "Note that C<!cd> won't do what you might expect."
23890 #: ../fish/guestfish-commands.pod:126
23895 #: ../fish/guestfish-commands.pod:128
23900 #: ../fish/guestfish-commands.pod:130
23908 #: ../fish/guestfish-commands.pod:132
23909 msgid "Opens the manual page for guestfish."
23913 #: ../fish/guestfish-commands.pod:134
23918 #: ../fish/guestfish-commands.pod:136
23923 #: ../fish/guestfish-commands.pod:138
23931 #: ../fish/guestfish-commands.pod:140
23939 #: ../fish/guestfish-commands.pod:142
23940 msgid "This is used to view a file."
23944 #: ../fish/guestfish-commands.pod:144
23946 "The default viewer is C<$PAGER>. However if you use the alternate command "
23947 "C<less> you will get the C<less> command specifically."
23951 #: ../fish/guestfish-commands.pod:147
23956 #: ../fish/guestfish-commands.pod:149
23964 #: ../fish/guestfish-commands.pod:151
23966 "Close and reopen the libguestfs handle. It is not necessary to use this "
23967 "normally, because the handle is closed properly when guestfish exits. "
23968 "However this is occasionally useful for testing."
23972 #: ../fish/guestfish-commands.pod:155
23977 #: ../fish/guestfish-commands.pod:157
23980 " sparse filename size\n"
23985 #: ../fish/guestfish-commands.pod:159
23987 "This creates an empty sparse file of the given size, and then adds so it can "
23988 "be further examined."
23992 #: ../fish/guestfish-commands.pod:162
23994 "In all respects it works the same as the L</alloc> command, except that the "
23995 "image file is allocated sparsely, which means that disk blocks are not "
23996 "assigned to the file until they are needed. Sparse disk files only use "
23997 "space when written to, but they are slower and there is a danger you could "
23998 "run out of real disk space during a write operation."
24002 #: ../fish/guestfish-commands.pod:172
24007 #: ../fish/guestfish-commands.pod:174
24015 #: ../fish/guestfish-commands.pod:176
24017 "This command returns a list of the optional groups known to the daemon, and "
24018 "indicates which ones are supported by this build of the libguestfs appliance."
24022 #: ../fish/guestfish-commands.pod:180
24023 msgid "See also L<guestfs(3)/AVAILABILITY>."
24027 #: ../fish/guestfish-commands.pod:182
24032 #: ../fish/guestfish-commands.pod:184
24035 " time command args...\n"
24040 #: ../fish/guestfish-commands.pod:186
24042 "Run the command as usual, but print the elapsed time afterwards. This can "
24043 "be useful for benchmarking operations."
24047 #: ../test-tool/libguestfs-test-tool.pod:5
24048 msgid "libguestfs-test-tool - End user tests for libguestfs"
24052 #: ../test-tool/libguestfs-test-tool.pod:9
24055 " libguestfs-test-tool [--options]\n"
24060 #: ../test-tool/libguestfs-test-tool.pod:13
24062 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
24063 "and developers, to allow them to check basic libguestfs functionality is "
24064 "working. This is needed because libguestfs occasionally breaks for reasons "
24065 "beyond our control: usually because of changes in the underlying qemu or "
24066 "kernel packages, or the host environment."
24070 #: ../test-tool/libguestfs-test-tool.pod:20
24071 msgid "If you suspect a problem in libguestfs, then just run:"
24075 #: ../test-tool/libguestfs-test-tool.pod:22
24078 " libguestfs-test-tool\n"
24083 #: ../test-tool/libguestfs-test-tool.pod:24
24084 msgid "It will print lots of diagnostic messages."
24088 #: ../test-tool/libguestfs-test-tool.pod:26
24089 msgid "If it runs to completion successfully, you will see this near the end:"
24093 #: ../test-tool/libguestfs-test-tool.pod:28
24096 " ===== TEST FINISHED OK =====\n"
24101 #: ../test-tool/libguestfs-test-tool.pod:30
24102 msgid "and the test tool will exit with code 0."
24106 #: ../test-tool/libguestfs-test-tool.pod:32
24108 "If it fails (and/or exits with non-zero error code), please paste the "
24109 "B<complete, unedited> output of the test tool into a bug report. More "
24110 "information about reporting bugs can be found on the L<http://libguestfs.org/"
24115 #: ../test-tool/libguestfs-test-tool.pod:41
24120 #: ../test-tool/libguestfs-test-tool.pod:43
24121 msgid "Display short usage information and exit."
24125 #: ../test-tool/libguestfs-test-tool.pod:45
24126 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
24130 #: ../test-tool/libguestfs-test-tool.pod:47
24132 "Pass an alternate name for the helper program. libguestfs-test-tool will "
24133 "normally look in the C<$libexec> directory that was configured when the tool "
24138 #: ../test-tool/libguestfs-test-tool.pod:51
24139 msgid "I<--qemu qemu_binary>"
24143 #: ../test-tool/libguestfs-test-tool.pod:53
24145 "If you have downloaded another qemu binary, point this option at the full "
24146 "path of the binary to try it."
24150 #: ../test-tool/libguestfs-test-tool.pod:56
24151 msgid "I<--qemudir qemu_source_dir>"
24155 #: ../test-tool/libguestfs-test-tool.pod:58
24157 "If you have compiled qemu from source, point this option at the source "
24158 "directory to try it."
24162 #: ../test-tool/libguestfs-test-tool.pod:61
24163 msgid "I<--timeout N>"
24167 #: ../test-tool/libguestfs-test-tool.pod:63
24169 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
24170 "does not usually need to be adjusted unless your machine is very slow."
24174 #: ../test-tool/libguestfs-test-tool.pod:69
24175 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
24179 #: ../test-tool/libguestfs-test-tool.pod:71
24181 "If you have compiled another version of qemu from source and would like to "
24182 "try that, then you can use the I<--qemudir> option to point to the qemu "
24183 "source directory."
24187 #: ../test-tool/libguestfs-test-tool.pod:75
24189 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
24190 "option to point to the binary."
24194 #: ../test-tool/libguestfs-test-tool.pod:78
24196 "When using an alternate qemu with libguestfs, usually you would need to "
24197 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
24198 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
24199 "use either of the I<--qemudir> or I<--qemu> options."
24203 #: ../test-tool/libguestfs-test-tool.pod:85
24205 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
24206 "I<1> if there was an error."
24210 #: ../test-tool/libguestfs-test-tool.pod:92
24211 msgid "/usr/libexec/libguestfs-test-tool-helper"
24215 #: ../test-tool/libguestfs-test-tool.pod:94
24217 "This helper program is run inside the appliance and provides additional "
24222 #: ../test-tool/libguestfs-test-tool.pod:97
24223 msgid "/usr/bin/mkisofs"
24227 #: ../test-tool/libguestfs-test-tool.pod:99
24229 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
24230 "which is used as part of the tests."
24234 #: ../test-tool/libguestfs-test-tool.pod:106
24236 "For the full list of environment variables which may affect libguestfs, "
24237 "please see the L<guestfs(3)> manual page."
24241 #: ../test-tool/libguestfs-test-tool.pod:111
24242 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
24246 #: ../test-tool/libguestfs-test-tool.pod:121
24247 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
24251 #: ../fuse/guestmount.pod:5
24253 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
24257 #: ../fuse/guestmount.pod:9
24260 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
24265 #: ../fuse/guestmount.pod:11
24268 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
24273 #: ../fuse/guestmount.pod:13
24276 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
24281 #: ../fuse/guestmount.pod:17
24283 "You must I<not> use C<guestmount> in read-write mode on live virtual "
24284 "machines. If you do this, you risk disk corruption in the VM."
24288 #: ../fuse/guestmount.pod:22
24290 "The guestmount program can be used to mount virtual machine filesystems and "
24291 "other disk images on the host. It uses libguestfs for access to the guest "
24292 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
24293 "a mountable device."
24297 #: ../fuse/guestmount.pod:27
24299 "Along with other options, you have to give at least one device (I<-a> "
24300 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
24301 "option) or use the I<-i> inspection option. How this works is better "
24302 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
24307 #: ../fuse/guestmount.pod:33
24309 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
24310 "by you, and the filesystem will not be visible to any other users unless you "
24311 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
24312 "the filesystem, use the C<fusermount -u> command."
24316 #: ../fuse/guestmount.pod:41
24318 "For a typical Windows guest which has its main filesystem on the first "
24323 #: ../fuse/guestmount.pod:44
24326 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
24331 #: ../fuse/guestmount.pod:46
24333 "For a typical Linux guest which has a /boot filesystem on the first "
24334 "partition, and the root filesystem on a logical volume:"
24338 #: ../fuse/guestmount.pod:49
24341 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
24346 #: ../fuse/guestmount.pod:51
24347 msgid "To get libguestfs to detect guest mountpoints for you:"
24351 #: ../fuse/guestmount.pod:53
24354 " guestmount -a guest.img -i --ro /mnt\n"
24359 #: ../fuse/guestmount.pod:55
24360 msgid "For a libvirt guest called \"Guest\" you could do:"
24364 #: ../fuse/guestmount.pod:57
24367 " guestmount -d Guest -i --ro /mnt\n"
24372 #: ../fuse/guestmount.pod:59
24374 "If you don't know what filesystems are contained in a guest or disk image, "
24375 "use L<virt-list-filesystems(1)> first:"
24379 #: ../fuse/guestmount.pod:62
24382 " virt-list-filesystems MyGuest\n"
24387 #: ../fuse/guestmount.pod:64
24389 "If you want to trace the libguestfs calls but without excessive debugging "
24390 "information, we recommend:"
24394 #: ../fuse/guestmount.pod:67
24397 " guestmount [...] --trace /mnt\n"
24402 #: ../fuse/guestmount.pod:69
24403 msgid "If you want to debug the program, we recommend:"
24407 #: ../fuse/guestmount.pod:71
24410 " guestmount [...] --trace --verbose /mnt\n"
24415 #: ../fuse/guestmount.pod:79
24416 msgid "Add a block device or virtual machine image."
24420 #: ../fuse/guestmount.pod:96
24421 msgid "B<--dir-cache-timeout N>"
24425 #: ../fuse/guestmount.pod:98
24427 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
24428 "seconds. The readdir cache [actually, there are several semi-independent "
24429 "caches] is populated after a readdir(2) call with the stat and extended "
24430 "attributes of the files in the directory, in anticipation that they will be "
24431 "requested soon after."
24435 #: ../fuse/guestmount.pod:104
24437 "There is also a different attribute cache implemented by FUSE (see the FUSE "
24438 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
24439 "requests, only cache existing ones."
24443 #: ../fuse/guestmount.pod:115
24445 "If you have untrusted raw-format guest disk images, you should use this "
24446 "option to specify the disk format. This avoids a possible security problem "
24447 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
24448 "guestfs_add_drive_opts>."
24452 #: ../fuse/guestmount.pod:120
24453 msgid "B<--fuse-help>"
24457 #: ../fuse/guestmount.pod:122
24458 msgid "Display help on special FUSE options (see I<-o> below)."
24462 #: ../fuse/guestmount.pod:126
24463 msgid "Display brief help and exit."
24467 #: ../fuse/guestmount.pod:134
24468 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
24472 #: ../fuse/guestmount.pod:136
24474 "Mount the named partition or logical volume on the given mountpoint B<in the "
24475 "guest> (this has nothing to do with mountpoints in the host)."
24479 #: ../fuse/guestmount.pod:139
24481 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
24482 "something on C</>."
24486 #: ../fuse/guestmount.pod:144
24488 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
24489 "unmounted. If you specify this option, then we don't attempt to sync the "
24490 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
24494 #: ../fuse/guestmount.pod:149
24495 msgid "B<-o option> | B<--option option>"
24499 #: ../fuse/guestmount.pod:151
24500 msgid "Pass extra options to FUSE."
24504 #: ../fuse/guestmount.pod:153
24506 "To get a list of all the extra options supported by FUSE, use the command "
24507 "below. Note that only the FUSE I<-o> options can be passed, and only some "
24508 "of them are a good idea."
24512 #: ../fuse/guestmount.pod:157
24515 " guestmount --fuse-help\n"
24520 #: ../fuse/guestmount.pod:159
24521 msgid "Some potentially useful FUSE options:"
24525 #: ../fuse/guestmount.pod:163
24526 msgid "B<-o allow_other>"
24530 #: ../fuse/guestmount.pod:165
24531 msgid "Allow other users to see the filesystem."
24535 #: ../fuse/guestmount.pod:167
24536 msgid "B<-o attr_timeout=N>"
24540 #: ../fuse/guestmount.pod:169
24541 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
24545 #: ../fuse/guestmount.pod:171
24546 msgid "B<-o kernel_cache>"
24550 #: ../fuse/guestmount.pod:173
24552 "Allow the kernel to cache files (reduces the number of reads that have to go "
24553 "through the L<guestfs(3)> API). This is generally a good idea if you can "
24554 "afford the extra memory usage."
24558 #: ../fuse/guestmount.pod:177
24559 msgid "B<-o uid=N> B<-o gid=N>"
24563 #: ../fuse/guestmount.pod:179
24565 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
24566 "the chosen values."
24570 #: ../fuse/guestmount.pod:186
24572 "Add devices and mount everything read-only. Also disallow writes and make "
24573 "the disk appear read-only to FUSE."
24577 #: ../fuse/guestmount.pod:189
24579 "This is highly recommended if you are not going to edit the guest disk. If "
24580 "the guest is running and this option is I<not> supplied, then there is a "
24581 "strong risk of disk corruption in the guest. We try to prevent this from "
24582 "happening, but it is not always possible."
24586 #: ../fuse/guestmount.pod:196
24587 msgid "Enable SELinux support for the guest."
24591 #: ../fuse/guestmount.pod:200
24592 msgid "Enable verbose messages from underlying libguestfs."
24596 #: ../fuse/guestmount.pod:204
24597 msgid "Display the program version and exit."
24601 #: ../fuse/guestmount.pod:206
24602 msgid "B<-x> | B<--trace>"
24606 #: ../fuse/guestmount.pod:208
24607 msgid "Trace libguestfs calls."
24611 #: ../fuse/guestmount.pod:210
24612 msgid "This also stops the daemon from forking into the background."
24616 #: ../fuse/guestmount.pod:216
24618 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
24619 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
24624 #: ../inspector/virt-inspector.pl:35
24626 "virt-inspector - Display operating system version and other information "
24627 "about a virtual machine"
24631 #: ../inspector/virt-inspector.pl:39
24634 " virt-inspector [--connect URI] domname\n"
24639 #: ../inspector/virt-inspector.pl:41
24642 " virt-inspector guest.img [guest.img ...]\n"
24647 #: ../inspector/virt-inspector.pl:45
24649 "B<virt-inspector> examines a virtual machine or disk image and tries to "
24650 "determine the version of the operating system and other information about "
24651 "the virtual machine."
24655 #: ../inspector/virt-inspector.pl:49
24656 msgid "Virt-inspector produces XML output for feeding into other programs."
24660 #: ../inspector/virt-inspector.pl:51
24662 "In the normal usage, use C<virt-inspector domname> where C<domname> is the "
24663 "libvirt domain (see: C<virsh list --all>)."
24667 #: ../inspector/virt-inspector.pl:54
24669 "You can also run virt-inspector directly on disk images from a single "
24670 "virtual machine. Use C<virt-inspector guest.img>. In rare cases a domain "
24671 "has several block devices, in which case you should list them one after "
24672 "another, with the first corresponding to the guest's C</dev/sda>, the second "
24673 "to the guest's C</dev/sdb> and so on."
24677 #: ../inspector/virt-inspector.pl:60
24679 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
24680 "inspect several virtual machines, you have to run virt-inspector several "
24681 "times (for example, from a shell script for-loop)."
24685 #: ../inspector/virt-inspector.pl:65
24687 "Because virt-inspector needs direct access to guest images, it won't "
24688 "normally work over remote libvirt connections."
24692 #: ../inspector/virt-inspector.pl:78 ../tools/virt-edit.pl:82
24693 #: ../tools/virt-win-reg.pl:181 ../tools/virt-df.pl:81 ../tools/virt-ls.pl:88
24694 #: ../tools/virt-list-filesystems.pl:60 ../tools/virt-cat.pl:89
24695 #: ../tools/virt-tar.pl:108 ../tools/virt-rescue.pl:113
24696 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:61
24697 msgid "Display brief help."
24701 #: ../inspector/virt-inspector.pl:84 ../tools/virt-edit.pl:88
24702 #: ../tools/virt-win-reg.pl:187 ../tools/virt-df.pl:87 ../tools/virt-ls.pl:94
24703 #: ../tools/virt-resize.pl:273 ../tools/virt-list-filesystems.pl:66
24704 #: ../tools/virt-cat.pl:95 ../tools/virt-tar.pl:114
24705 #: ../tools/virt-rescue.pl:119 ../tools/virt-make-fs.pl:169
24706 #: ../tools/virt-list-partitions.pl:67
24707 msgid "B<--version>"
24711 #: ../inspector/virt-inspector.pl:86 ../tools/virt-edit.pl:90
24712 #: ../tools/virt-win-reg.pl:189 ../tools/virt-df.pl:89 ../tools/virt-ls.pl:96
24713 #: ../tools/virt-resize.pl:275 ../tools/virt-list-filesystems.pl:68
24714 #: ../tools/virt-cat.pl:97 ../tools/virt-tar.pl:116
24715 #: ../tools/virt-rescue.pl:121 ../tools/virt-make-fs.pl:171
24716 #: ../tools/virt-list-partitions.pl:69
24717 msgid "Display version number and exit."
24721 #: ../inspector/virt-inspector.pl:92 ../tools/virt-edit.pl:112
24722 #: ../tools/virt-win-reg.pl:203 ../tools/virt-df.pl:95 ../tools/virt-ls.pl:102
24723 #: ../tools/virt-list-filesystems.pl:74 ../tools/virt-cat.pl:103
24724 #: ../tools/virt-tar.pl:122 ../tools/virt-rescue.pl:135
24725 #: ../tools/virt-list-partitions.pl:75
24726 msgid "B<--connect URI> | B<-c URI>"
24730 #: ../inspector/virt-inspector.pl:94 ../tools/virt-edit.pl:114
24731 #: ../tools/virt-win-reg.pl:205 ../tools/virt-df.pl:97 ../tools/virt-ls.pl:104
24732 #: ../tools/virt-list-filesystems.pl:76 ../tools/virt-cat.pl:105
24733 #: ../tools/virt-tar.pl:124 ../tools/virt-rescue.pl:137
24734 #: ../tools/virt-list-partitions.pl:77
24736 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
24737 "to the default libvirt hypervisor."
24741 #: ../inspector/virt-inspector.pl:97
24743 "Libvirt is only used if you specify a C<domname> on the command line. If "
24744 "you specify guest block devices directly, then libvirt is not used at all."
24748 #: ../inspector/virt-inspector.pl:105 ../tools/virt-edit.pl:124
24749 #: ../tools/virt-win-reg.pl:215 ../tools/virt-df.pl:117
24750 #: ../tools/virt-ls.pl:114 ../tools/virt-resize.pl:523
24751 #: ../tools/virt-list-filesystems.pl:86 ../tools/virt-cat.pl:115
24752 #: ../tools/virt-tar.pl:134 ../tools/virt-rescue.pl:147
24753 #: ../tools/virt-list-partitions.pl:87
24754 msgid "B<--format> raw"
24758 #: ../inspector/virt-inspector.pl:107 ../tools/virt-edit.pl:126
24759 #: ../tools/virt-win-reg.pl:217 ../tools/virt-df.pl:119
24760 #: ../tools/virt-ls.pl:116 ../tools/virt-list-filesystems.pl:88
24761 #: ../tools/virt-cat.pl:117 ../tools/virt-tar.pl:136
24762 #: ../tools/virt-rescue.pl:149 ../tools/virt-list-partitions.pl:89
24764 "Specify the format of disk images given on the command line. If this is "
24765 "omitted then the format is autodetected from the content of the disk image."
24769 #: ../inspector/virt-inspector.pl:111 ../tools/virt-edit.pl:130
24770 #: ../tools/virt-win-reg.pl:221 ../tools/virt-df.pl:123
24771 #: ../tools/virt-ls.pl:120 ../tools/virt-list-filesystems.pl:92
24772 #: ../tools/virt-cat.pl:121 ../tools/virt-tar.pl:140
24773 #: ../tools/virt-rescue.pl:153 ../tools/virt-list-partitions.pl:93
24775 "If disk images are requested from libvirt, then this program asks libvirt "
24776 "for this information. In this case, the value of the format parameter is "
24781 #: ../inspector/virt-inspector.pl:115 ../tools/virt-edit.pl:134
24782 #: ../tools/virt-win-reg.pl:225 ../tools/virt-df.pl:127
24783 #: ../tools/virt-ls.pl:124 ../tools/virt-resize.pl:528
24784 #: ../tools/virt-resize.pl:543 ../tools/virt-list-filesystems.pl:96
24785 #: ../tools/virt-cat.pl:125 ../tools/virt-tar.pl:144
24786 #: ../tools/virt-rescue.pl:157 ../tools/virt-list-partitions.pl:97
24788 "If working with untrusted raw-format guest disk images, you should ensure "
24789 "the format is always specified."
24793 #: ../inspector/virt-inspector.pl:149
24798 #: ../inspector/virt-inspector.pl:151
24800 "The virt-inspector XML is described precisely in a RELAX NG schema which is "
24801 "supplied with libguestfs. This section is just an overview."
24805 #: ../inspector/virt-inspector.pl:154
24807 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
24808 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
24809 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
24810 "which is vanishingly rare in real world VMs."
24814 #: ../inspector/virt-inspector.pl:159
24815 msgid "E<lt>operatingsystemE<gt>"
24819 #: ../inspector/virt-inspector.pl:161
24821 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
24822 "describe the operating system, its architecture, the descriptive \"product "
24823 "name\" string, the type of OS and so on, as in this example:"
24827 #: ../inspector/virt-inspector.pl:165
24830 " <operatingsystems>\n"
24831 " <operatingsystem>\n"
24832 " <root>/dev/sda2</root>\n"
24833 " <name>windows</name>\n"
24834 " <arch>i386</arch>\n"
24835 " <distro>windows</distro>\n"
24836 " <product_name>Windows 7 Enterprise</product_name>\n"
24837 " <major_version>6</major_version>\n"
24838 " <minor_version>1</minor_version>\n"
24839 " <windows_systemroot>/Windows</windows_systemroot>\n"
24844 #: ../inspector/virt-inspector.pl:176
24846 "These fields are derived from the libguestfs inspection API, and you can "
24847 "find more details in L<guestfs(3)/INSPECTION>."
24851 #: ../inspector/virt-inspector.pl:179
24853 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
24854 "of view of libguestfs (block devices may have completely different names "
24855 "inside the VM itself)."
24859 #: ../inspector/virt-inspector.pl:240
24860 msgid "E<lt>mountpointsE<gt>"
24864 #: ../inspector/virt-inspector.pl:242
24866 "Un*x-like guests typically have multiple filesystems which are mounted at "
24867 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
24868 "element which looks like this:"
24872 #: ../inspector/virt-inspector.pl:246
24875 " <operatingsystems>\n"
24876 " <operatingsystem>\n"
24879 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
24880 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
24881 " </mountpoints>\n"
24886 #: ../inspector/virt-inspector.pl:254
24888 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
24889 "and may have completely different names inside the guest. Only mountable "
24890 "filesystems appear in this list, not things like swap devices."
24894 #: ../inspector/virt-inspector.pl:276
24895 msgid "E<lt>filesystemsE<gt>"
24899 #: ../inspector/virt-inspector.pl:278
24901 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
24902 "filesystems belonging to the guest, including swap and empty partitions. "
24903 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
24904 "this OS or shared by this OS and other OSes)."
24908 #: ../inspector/virt-inspector.pl:283
24909 msgid "You might see something like this:"
24913 #: ../inspector/virt-inspector.pl:285
24916 " <operatingsystems>\n"
24917 " <operatingsystem>\n"
24920 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
24921 " <type>ext4</type>\n"
24922 " <label>Fedora-13-x86_64</label>\n"
24923 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
24929 #: ../inspector/virt-inspector.pl:295
24931 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
24932 "the label, and the UUID."
24936 #: ../inspector/virt-inspector.pl:337
24937 msgid "E<lt>applicationsE<gt>"
24941 #: ../inspector/virt-inspector.pl:339
24943 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
24944 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
24945 "machine. At the moment we are only able to list RPMs and Debian packages "
24946 "installed, but in future we will support other Linux distros and Windows."
24950 #: ../inspector/virt-inspector.pl:345
24952 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
24953 "Typical values would be C<rpm> and C<deb>."
24957 #: ../inspector/virt-inspector.pl:348
24959 "E<lt>package_managementE<gt>, if present, describes the package manager. "
24960 "Typical values include C<yum>, C<up2date> and C<apt>"
24964 #: ../inspector/virt-inspector.pl:351
24965 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
24969 #: ../inspector/virt-inspector.pl:354
24972 " <operatingsystems>\n"
24973 " <operatingsystem>\n"
24975 " <applications>\n"
24977 " <name>coreutils</name>\n"
24978 " <version>8.5</version>\n"
24979 " <release>1</release>\n"
24980 " </application>\n"
24985 #: ../inspector/virt-inspector.pl:364
24987 "(The version and release fields may not be available for some package types)."
24991 #: ../inspector/virt-inspector.pl:544
24992 msgid "USING XPATH"
24996 #: ../inspector/virt-inspector.pl:546
24998 "You can use the XPath query language, and/or the xpath tool, in order to "
24999 "select parts of the XML."
25003 #: ../inspector/virt-inspector.pl:551
25006 " $ virt-inspector Guest | xpath //filesystems\n"
25007 " Found 1 nodes:\n"
25010 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
25011 " <type>ext4</type>\n"
25017 #: ../inspector/virt-inspector.pl:559
25020 " $ virt-inspector Guest | \\\n"
25021 " xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
25022 " Query didn't return a nodeset. Value: ext4\n"
25027 #: ../inspector/virt-inspector.pl:563 ../tools/virt-edit.pl:343
25028 #: ../tools/virt-win-reg.pl:141 ../tools/virt-win-reg.pl:477
25029 #: ../tools/virt-df.pl:633 ../tools/virt-ls.pl:225
25030 #: ../tools/virt-resize.pl:1479 ../tools/virt-list-filesystems.pl:179
25031 #: ../tools/virt-cat.pl:178 ../tools/virt-tar.pl:274
25032 #: ../tools/virt-rescue.pl:260 ../tools/virt-make-fs.pl:527
25033 #: ../tools/virt-list-partitions.pl:247
25034 msgid "SHELL QUOTING"
25038 #: ../inspector/virt-inspector.pl:565 ../tools/virt-edit.pl:345
25039 #: ../tools/virt-win-reg.pl:479 ../tools/virt-df.pl:635
25040 #: ../tools/virt-ls.pl:227 ../tools/virt-resize.pl:1481
25041 #: ../tools/virt-list-filesystems.pl:181 ../tools/virt-cat.pl:180
25042 #: ../tools/virt-tar.pl:276 ../tools/virt-rescue.pl:262
25043 #: ../tools/virt-make-fs.pl:529 ../tools/virt-list-partitions.pl:249
25045 "Libvirt guest names can contain arbitrary characters, some of which have "
25046 "meaning to the shell such as C<#> and space. You may need to quote or "
25047 "escape these characters on the command line. See the shell manual page L<sh"
25048 "(1)> for details."
25052 #: ../inspector/virt-inspector.pl:572
25054 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
25055 "L<Sys::Virt(3)>, L<http://www.w3.org/TR/xpath/>, L<http://libguestfs.org/>."
25059 #: ../inspector/virt-inspector.pl:586 ../tools/virt-edit.pl:364
25060 #: ../tools/virt-win-reg.pl:512 ../tools/virt-df.pl:651
25061 #: ../tools/virt-ls.pl:245 ../tools/virt-resize.pl:1510
25062 #: ../tools/virt-list-filesystems.pl:200 ../tools/virt-cat.pl:197
25063 #: ../tools/virt-tar.pl:294 ../tools/virt-rescue.pl:279
25064 #: ../tools/virt-make-fs.pl:561 ../tools/virt-list-partitions.pl:267
25065 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
25069 #: ../inspector/virt-inspector.pl:590
25070 msgid "Matthew Booth L<mbooth@redhat.com>"
25074 #: ../inspector/virt-inspector.pl:596 ../tools/virt-win-reg.pl:516
25075 #: ../tools/virt-resize.pl:1514 ../tools/virt-make-fs.pl:565
25076 msgid "Copyright (C) 2010 Red Hat Inc."
25080 #: ../tools/virt-edit.pl:34
25081 msgid "virt-edit - Edit a file in a virtual machine"
25085 #: ../tools/virt-edit.pl:38
25088 " virt-edit [--options] domname file\n"
25093 #: ../tools/virt-edit.pl:40
25096 " virt-edit [--options] disk.img [disk.img ...] file\n"
25101 #: ../tools/virt-edit.pl:42
25104 " virt-edit [domname|disk.img] file -e 'expr'\n"
25109 #: ../tools/virt-edit.pl:46
25111 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
25112 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
25113 "doing this, but doesn't catch all cases."
25117 #: ../tools/virt-edit.pl:52
25119 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
25120 "the named virtual machine (or disk image)."
25124 #: ../tools/virt-edit.pl:55
25126 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
25127 "you should look at the L<guestfish(1)> tool."
25131 #: ../tools/virt-edit.pl:60
25132 msgid "Edit the named files interactively:"
25136 #: ../tools/virt-edit.pl:62
25139 " virt-edit mydomain /boot/grub/grub.conf\n"
25144 #: ../tools/virt-edit.pl:64
25147 " virt-edit mydomain /etc/passwd\n"
25152 #: ../tools/virt-edit.pl:66
25154 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
25155 "below). To change the init default level to 5:"
25159 #: ../tools/virt-edit.pl:70
25162 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
25167 #: ../tools/virt-edit.pl:96
25168 msgid "B<--backup extension> | B<-b extension>"
25172 #: ../tools/virt-edit.pl:98
25174 "Create a backup of the original file I<in the guest disk image>. The backup "
25175 "has the original filename with C<extension> added."
25179 #: ../tools/virt-edit.pl:101
25181 "Usually the first character of C<extension> would be a dot C<.> so you would "
25186 #: ../tools/virt-edit.pl:104
25189 " virt-edit -b .orig [etc]\n"
25194 #: ../tools/virt-edit.pl:106
25195 msgid "By default, no backup file is made."
25199 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:208
25200 #: ../tools/virt-df.pl:100 ../tools/virt-ls.pl:107
25201 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-cat.pl:108
25202 #: ../tools/virt-tar.pl:127 ../tools/virt-rescue.pl:140
25203 #: ../tools/virt-list-partitions.pl:80
25205 "If you specify guest block devices directly, then libvirt is not used at all."
25209 #: ../tools/virt-edit.pl:141
25210 msgid "B<--expr EXPR> | B<-e EXPR>"
25214 #: ../tools/virt-edit.pl:143
25216 "Instead of launching the external editor, non-interactively apply the Perl "
25217 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
25222 #: ../tools/virt-edit.pl:147
25224 "Be careful to properly quote the expression to prevent it from being altered "
25229 #: ../tools/virt-edit.pl:268
25230 msgid "NON-INTERACTIVE EDITING"
25234 #: ../tools/virt-edit.pl:270
25236 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
25237 "administrator can interactively edit the file."
25241 #: ../tools/virt-edit.pl:273
25243 "There are two ways also to use C<virt-edit> from scripts in order to make "
25244 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
25245 "like this, it's less error-prone to write scripts directly using the "
25246 "libguestfs API and Augeas for configuration file editing.)"
25250 #: ../tools/virt-edit.pl:279
25252 "The first method is to temporarily set C<$EDITOR> to any script or program "
25253 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
25254 "update C<tmpfile> in place however it likes."
25258 #: ../tools/virt-edit.pl:283
25260 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
25261 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
25262 "instances of C<foo> with C<bar> in a file:"
25266 #: ../tools/virt-edit.pl:287
25269 " virt-edit domname filename -e 's/foo/bar/'\n"
25274 #: ../tools/virt-edit.pl:289
25276 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
25277 "For example to delete root's password you could do:"
25281 #: ../tools/virt-edit.pl:292
25284 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
25289 #: ../tools/virt-edit.pl:294
25291 "What really happens is that the snippet is evaluated as a Perl expression "
25292 "for each line of the file. The line, including the final C<\\n>, is passed "
25293 "in C<$_> and the expression should update C<$_> or leave it unchanged."
25297 #: ../tools/virt-edit.pl:299
25299 "To delete a line, set C<$_> to the empty string. For example, to delete the "
25300 "C<apache> user account from the password file you can do:"
25304 #: ../tools/virt-edit.pl:302
25307 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
25312 #: ../tools/virt-edit.pl:304
25314 "To insert a line, prepend or append it to C<$_>. However appending lines to "
25315 "the end of the file is rather difficult this way since there is no concept "
25316 "of \"last line of the file\" - your expression just doesn't get called "
25317 "again. You might want to use the first method (setting C<$EDITOR>) if you "
25322 #: ../tools/virt-edit.pl:310
25324 "The variable C<$lineno> contains the current line number. As is "
25325 "traditional, the first line in the file is number C<1>."
25329 #: ../tools/virt-edit.pl:313
25331 "The return value from the expression is ignored, but the expression may call "
25332 "C<die> in order to abort the whole program, leaving the original file "
25337 #: ../tools/virt-edit.pl:317
25339 "Remember when matching the end of a line that C<$_> may contain the final C<"
25340 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
25341 "newline then neither of these. Thus to match or substitute some text at the "
25342 "end of a line, use this regular expression:"
25346 #: ../tools/virt-edit.pl:322
25349 " /some text(\\r?\\n)?$/\n"
25354 #: ../tools/virt-edit.pl:324
25356 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
25357 "$_> itself (since that would remove all newlines from the file):"
25361 #: ../tools/virt-edit.pl:328
25364 " my $m = $_; chomp $m; $m =~ /some text$/\n"
25369 #: ../tools/virt-edit.pl:334
25374 #: ../tools/virt-edit.pl:336
25376 "If set, this string is used as the editor. It may contain arguments, eg. C<"
25381 #: ../tools/virt-edit.pl:339
25382 msgid "If not set, C<vi> is used."
25386 #: ../tools/virt-edit.pl:352
25388 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
25389 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, "
25394 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:510
25395 #: ../tools/virt-df.pl:649 ../tools/virt-ls.pl:243
25396 #: ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:198
25397 #: ../tools/virt-cat.pl:195 ../tools/virt-tar.pl:292
25398 #: ../tools/virt-rescue.pl:277 ../tools/virt-make-fs.pl:559
25399 #: ../tools/virt-list-partitions.pl:265
25404 #: ../tools/virt-edit.pl:368 ../tools/virt-df.pl:655
25405 #: ../tools/virt-rescue.pl:283 ../tools/virt-list-partitions.pl:271
25406 msgid "Copyright (C) 2009-2010 Red Hat Inc."
25410 #: ../tools/virt-win-reg.pl:37
25412 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
25416 #: ../tools/virt-win-reg.pl:41
25419 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
25424 #: ../tools/virt-win-reg.pl:43
25427 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
25432 #: ../tools/virt-win-reg.pl:45
25435 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
25440 #: ../tools/virt-win-reg.pl:47
25443 " virt-win-reg --merge domname [input.reg ...]\n"
25448 #: ../tools/virt-win-reg.pl:49
25451 " virt-win-reg [--options] disk.img ... # instead of domname\n"
25456 #: ../tools/virt-win-reg.pl:53
25458 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
25459 "virtual machines. If you do this, you I<will> get irreversible disk "
25460 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
25461 "but doesn't catch all cases."
25465 #: ../tools/virt-win-reg.pl:58
25467 "Modifying the Windows Registry is an inherently risky operation. The format "
25468 "is deliberately obscure and undocumented, and Registry changes can leave the "
25469 "system unbootable. Therefore when using the C<--merge> option, make sure "
25470 "you have a reliable backup first."
25474 #: ../tools/virt-win-reg.pl:65
25476 "This program can export and merge Windows Registry entries from a Windows "
25481 #: ../tools/virt-win-reg.pl:68
25483 "The first parameter is the libvirt guest name or the raw disk image of a "
25488 #: ../tools/virt-win-reg.pl:71
25490 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
25491 "exported (recursively). For example:"
25495 #: ../tools/virt-win-reg.pl:74
25498 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
25503 #: ../tools/virt-win-reg.pl:76
25505 "You can also display single values from within registry keys, for example:"
25509 #: ../tools/virt-win-reg.pl:79
25512 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
25513 " $ virt-win-reg Windows7 $cvkey ProductName\n"
25514 " Windows 7 Enterprise\n"
25519 #: ../tools/virt-win-reg.pl:83
25521 "With C<--merge>, you can merge a textual regedit file into the Windows "
25526 #: ../tools/virt-win-reg.pl:86
25529 " $ virt-win-reg --merge Windows7 changes.reg\n"
25534 #: ../tools/virt-win-reg.pl:88
25535 msgid "SUPPORTED SYSTEMS"
25539 #: ../tools/virt-win-reg.pl:90
25541 "The program currently supports Windows NT-derived guests starting with "
25542 "Windows XP through to at least Windows 7."
25546 #: ../tools/virt-win-reg.pl:93
25548 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
25549 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
25550 "and C<HKEY_USERS\\.DEFAULT>."
25554 #: ../tools/virt-win-reg.pl:97
25556 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
25561 #: ../tools/virt-win-reg.pl:100
25563 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
25568 #: ../tools/virt-win-reg.pl:103
25573 #: ../tools/virt-win-reg.pl:105
25575 "This program is only meant for simple access to the registry. If you want "
25576 "to do complicated things with the registry, we suggest you download the "
25577 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
25578 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
25579 "L<hivexregedit(1)>."
25583 #: ../tools/virt-win-reg.pl:111
25588 #: ../tools/virt-win-reg.pl:113
25590 "C<virt-win-reg> expects that regedit files have already been reencoded in "
25591 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
25592 "style line endings. Since Windows regedit files are often in UTF-16LE with "
25593 "Windows-style line endings, you may need to reencode the whole file before "
25594 "or after processing."
25598 #: ../tools/virt-win-reg.pl:119
25600 "To reencode a file from Windows format to Linux (before processing it with "
25601 "the C<--merge> option), you would do something like this:"
25605 #: ../tools/virt-win-reg.pl:122
25608 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
25613 #: ../tools/virt-win-reg.pl:124
25615 "To go in the opposite direction, after exporting and before sending the file "
25616 "to a Windows user, do something like this:"
25620 #: ../tools/virt-win-reg.pl:127
25623 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
25628 #: ../tools/virt-win-reg.pl:129
25629 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
25633 #: ../tools/virt-win-reg.pl:131
25635 "If you are unsure about the current encoding, use the L<file(1)> command. "
25636 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
25637 "style (CRLF) line endings, like this:"
25641 #: ../tools/virt-win-reg.pl:135
25644 " $ file software.reg\n"
25645 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
25646 " with CRLF line terminators\n"
25651 #: ../tools/virt-win-reg.pl:139
25652 msgid "This file would need conversion before you could C<--merge> it."
25656 #: ../tools/virt-win-reg.pl:143
25658 "Be careful when passing parameters containing C<\\> (backslash) in the "
25659 "shell. Usually you will have to use 'single quotes' or double backslashes "
25660 "(but not both) to protect them from the shell."
25664 #: ../tools/virt-win-reg.pl:147
25665 msgid "Paths and value names are case-insensitive."
25669 #: ../tools/virt-win-reg.pl:149
25670 msgid "CurrentControlSet etc."
25674 #: ../tools/virt-win-reg.pl:151
25676 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
25677 "Registry at the level of the hive file, and therefore you cannot modify "
25682 #: ../tools/virt-win-reg.pl:155
25684 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
25685 "circumstances it might refer to another control set. The way to find out is "
25686 "to look at the C<HKLM\\SYSTEM\\Select> key:"
25690 #: ../tools/virt-win-reg.pl:159
25693 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
25694 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
25695 " \"Current\"=dword:00000001\n"
25696 " \"Default\"=dword:00000001\n"
25697 " \"Failed\"=dword:00000000\n"
25698 " \"LastKnownGood\"=dword:00000002\n"
25703 #: ../tools/virt-win-reg.pl:166
25704 msgid "\"Default\" is the one which Windows will choose when it boots."
25708 #: ../tools/virt-win-reg.pl:168
25710 "Similarly, other C<Current...> keys in the path may need to be replaced."
25714 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
25719 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:501
25720 msgid "Enable debugging messages."
25724 #: ../tools/virt-win-reg.pl:232
25729 #: ../tools/virt-win-reg.pl:234
25731 "In merge mode, this merges a textual regedit file into the Windows Registry "
25732 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
25733 "displays or exports Registry entries instead."
25737 #: ../tools/virt-win-reg.pl:238
25739 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
25740 "result in disk corruption. However exporting (without this flag) is always "
25745 #: ../tools/virt-win-reg.pl:246
25746 msgid "B<--encoding> UTF-16LE|ASCII"
25750 #: ../tools/virt-win-reg.pl:248
25752 "When merging (only), you may need to specify the encoding for strings to be "
25753 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
25754 "(3)/ENCODING STRINGS>."
25758 #: ../tools/virt-win-reg.pl:252
25760 "The default is to use UTF-16LE, which should work with recent versions of "
25765 #: ../tools/virt-win-reg.pl:486
25767 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
25768 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
25769 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
25773 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
25775 "When reporting bugs, please enable debugging and capture the I<complete> "
25780 #: ../tools/virt-win-reg.pl:504
25783 " export LIBGUESTFS_DEBUG=1\n"
25784 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
25789 #: ../tools/virt-win-reg.pl:507
25791 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
25796 #: ../tools/virt-df.pl:36
25797 msgid "virt-df - Display free space on virtual filesystems"
25801 #: ../tools/virt-df.pl:40
25804 " virt-df [--options]\n"
25809 #: ../tools/virt-df.pl:42
25812 " virt-df [--options] domname\n"
25817 #: ../tools/virt-df.pl:44
25820 " virt-df [--options] disk.img [disk.img ...]\n"
25825 #: ../tools/virt-df.pl:48
25827 "C<virt-df> is a command line tool to display free space on virtual machine "
25828 "filesystems. Unlike other tools, it doesn't just display the amount of "
25829 "space allocated to a virtual machine, but can look inside the virtual "
25830 "machine to see how much space is really being used."
25834 #: ../tools/virt-df.pl:53
25836 "It is like the L<df(1)> command, but for virtual machines, except that it "
25837 "also works for Windows virtual machines."
25841 #: ../tools/virt-df.pl:56
25843 "If used without any arguments, C<virt-df> checks with libvirt to get a list "
25844 "of all active and inactive guests, and performs a C<df>-type operation on "
25845 "each one in turn, printing out the results."
25849 #: ../tools/virt-df.pl:60
25851 "If used with any argument(s), C<virt-df> performs a C<df>-type operation on "
25852 "either the single named libvirt domain, or on the disk image(s) listed on "
25853 "the command line (which must all belong to a single VM). In this mode (with "
25854 "arguments), C<virt-df> will I<only work for a single guest>. If you want to "
25855 "run on multiple guests, then you have to invoke C<virt-df> multiple times."
25859 #: ../tools/virt-df.pl:67
25861 "Use the C<--csv> option to get a format which can be easily parsed by other "
25862 "programs. Other options are mostly similar to standard C<df> options. See "
25863 "below for the complete list."
25867 #: ../tools/virt-df.pl:107
25872 #: ../tools/virt-df.pl:109
25874 "Write out the results in CSV format (comma-separated values). This format "
25875 "can be imported easily into databases and spreadsheets, but read L</NOTE "
25876 "ABOUT CSV FORMAT> below."
25880 #: ../tools/virt-df.pl:134
25881 msgid "B<--human-readable> | B<-h>"
25885 #: ../tools/virt-df.pl:136
25886 msgid "Print sizes in human-readable format."
25890 #: ../tools/virt-df.pl:138
25891 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
25895 #: ../tools/virt-df.pl:144
25896 msgid "B<--inodes> | B<-i>"
25900 #: ../tools/virt-df.pl:146
25901 msgid "Print inodes instead of blocks."
25905 #: ../tools/virt-df.pl:152
25906 msgid "B<--one-per-guest>"
25910 #: ../tools/virt-df.pl:154
25912 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
25913 "disks from several guests to a single libguestfs appliance."
25917 #: ../tools/virt-df.pl:157
25918 msgid "You might use this option in the following circumstances:"
25922 #: ../tools/virt-df.pl:163
25924 "If you think an untrusted guest might actively try to exploit the libguestfs "
25925 "appliance kernel, then this prevents one guest from interfering with the "
25926 "stats printed for another guest."
25930 #: ../tools/virt-df.pl:169
25932 "If the kernel has a bug which stops it from accessing a filesystem in one "
25933 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
25934 "and report stats for further guests."
25938 #: ../tools/virt-df.pl:180
25943 #: ../tools/virt-df.pl:182
25945 "Print UUIDs instead of names. This is useful for following a guest even "
25946 "when the guest is migrated or renamed, or when two guests happen to have the "
25951 #: ../tools/virt-df.pl:186
25953 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
25954 "images, we still print the disk image name even when this option is "
25959 #: ../tools/virt-df.pl:609
25960 msgid "NOTE ABOUT CSV FORMAT"
25964 #: ../tools/virt-df.pl:611
25966 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
25967 "should be easy to parse, but it is definitely not easy to parse."
25971 #: ../tools/virt-df.pl:614
25973 "Myth: Just split fields at commas. Reality: This does I<not> work "
25974 "reliably. This example has two columns:"
25978 #: ../tools/virt-df.pl:617
25981 " \"foo,bar\",baz\n"
25986 #: ../tools/virt-df.pl:619
25988 "Myth: Read the file one line at a time. Reality: This does I<not> work "
25989 "reliably. This example has one row:"
25993 #: ../tools/virt-df.pl:622
26002 #: ../tools/virt-df.pl:625
26004 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
26005 "packaged in major Linux distributions)."
26009 #: ../tools/virt-df.pl:628
26011 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
26012 "or Python's built-in csv library)."
26016 #: ../tools/virt-df.pl:631
26017 msgid "Most spreadsheets and databases can import CSV directly."
26021 #: ../tools/virt-df.pl:642
26023 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
26024 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26028 #: ../tools/virt-ls.pl:34
26029 msgid "virt-ls - List files in a virtual machine"
26033 #: ../tools/virt-ls.pl:38
26036 " virt-ls [--options] domname directory\n"
26041 #: ../tools/virt-ls.pl:40
26044 " virt-ls [--options] disk.img [disk.img ...] directory\n"
26049 #: ../tools/virt-ls.pl:44
26051 "C<virt-ls> is a command line tool to list the names of files in a directory "
26052 "inside a virtual machine or disk image."
26056 #: ../tools/virt-ls.pl:47
26058 "C<virt-ls> is just a simple wrapper around L<libguestfs(3)> functionality. "
26059 "For more complex cases you should look at the L<guestfish(1)> tool."
26063 #: ../tools/virt-ls.pl:51
26065 "C<virt-ls> can be used in one of three modes: simple, long and recursive. A "
26066 "simple listing is like the ordinary L<ls(1)> command:"
26070 #: ../tools/virt-ls.pl:54
26073 " $ virt-ls myguest /\n"
26081 #: ../tools/virt-ls.pl:59
26082 msgid "With the C<-l> (C<--long>) option, C<virt-ls> shows more detail:"
26086 #: ../tools/virt-ls.pl:61
26089 " $ virt-ls -l myguest /\n"
26091 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
26092 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
26098 #: ../tools/virt-ls.pl:67
26100 "With the C<-R> (C<--recursive>) option, C<virt-ls> lists the names of files "
26101 "and directories recursively:"
26105 #: ../tools/virt-ls.pl:70
26108 " $ virt-ls -R myguest /tmp\n"
26116 #: ../tools/virt-ls.pl:75
26118 "You I<cannot> combine these options. To do more complicated things, use "
26123 #: ../tools/virt-ls.pl:131 ../tools/virt-list-filesystems.pl:103
26124 #: ../tools/virt-list-partitions.pl:112
26125 msgid "B<-l> | B<--long>"
26129 #: ../tools/virt-ls.pl:133
26130 msgid "B<-R> | B<--recursive>"
26134 #: ../tools/virt-ls.pl:135
26136 "Select the mode. With neither of these options, C<virt-ls> produces a "
26137 "simple, flat list of the files in the named directory."
26141 #: ../tools/virt-ls.pl:138
26143 "C<virt-ls -l> produces a \"long listing\", which shows more detail (just "
26144 "like the plain C<ls -l> command)."
26148 #: ../tools/virt-ls.pl:141
26150 "C<virt-ls -R> produces a recursive list of files starting at the named "
26151 "directory. See the documentation for L<guestfs(3)/guestfs_find> for precise "
26156 #: ../tools/virt-ls.pl:145
26157 msgid "You cannot combine these options."
26161 #: ../tools/virt-ls.pl:234
26163 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<Sys::"
26164 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
26169 #: ../tools/virt-ls.pl:249 ../tools/virt-list-filesystems.pl:204
26170 #: ../tools/virt-cat.pl:201 ../tools/virt-tar.pl:298
26171 msgid "Copyright (C) 2009 Red Hat Inc."
26175 #: ../tools/virt-resize.pl:42
26176 msgid "virt-resize - Resize a virtual machine disk"
26180 #: ../tools/virt-resize.pl:46
26183 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
26184 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
26185 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
26190 #: ../tools/virt-resize.pl:52
26192 "Virt-resize is a tool which can resize a virtual machine disk, making it "
26193 "larger or smaller overall, and resizing or deleting any partitions contained "
26198 #: ../tools/virt-resize.pl:56
26200 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
26201 "not> be used on live virtual machines - for consistent results, shut the "
26202 "virtual machine down before resizing it."
26206 #: ../tools/virt-resize.pl:60
26208 "If you are not familiar with the associated tools: L<virt-list-partitions(1)"
26209 ">, L<virt-list-filesystems(1)> and L<virt-df(1)>, we recommend you go and "
26210 "read those manual pages first."
26214 #: ../tools/virt-resize.pl:68
26216 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
26217 "fill the extra 5GB of space."
26221 #: ../tools/virt-resize.pl:71
26224 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
26225 " virt-list-partitions -lht olddisk\n"
26226 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
26227 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
26232 #: ../tools/virt-resize.pl:76
26234 "As above, but make the /boot partition 200MB bigger, while giving the "
26235 "remaining space to /dev/sda2:"
26239 #: ../tools/virt-resize.pl:79
26242 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
26247 #: ../tools/virt-resize.pl:81
26248 msgid "As above, but the output format will be uncompressed qcow2:"
26252 #: ../tools/virt-resize.pl:83
26255 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
26256 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
26261 #: ../tools/virt-resize.pl:86
26262 msgid "DETAILED USAGE"
26266 #: ../tools/virt-resize.pl:88
26267 msgid "EXPANDING A VIRTUAL MACHINE DISK"
26271 #: ../tools/virt-resize.pl:92
26272 msgid "1. Shut down the virtual machine"
26276 #: ../tools/virt-resize.pl:94
26277 msgid "2. Locate input disk image"
26281 #: ../tools/virt-resize.pl:96
26283 "Locate the input disk image (ie. the file or device on the host containing "
26284 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
26285 "dumpxml> like this to find the disk image name:"
26289 #: ../tools/virt-resize.pl:100
26292 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
26293 " Found 1 nodes:\n"
26295 " <source dev=\"/dev/vg/lv_guest\" />\n"
26300 #: ../tools/virt-resize.pl:105
26301 msgid "3. Look at current sizing"
26305 #: ../tools/virt-resize.pl:107
26307 "Use L<virt-list-partitions(1)> to display the current partitions and sizes:"
26311 #: ../tools/virt-resize.pl:110
26314 " # virt-list-partitions -lht /dev/vg/lv_guest\n"
26315 " /dev/sda1 ext3 101.9M\n"
26316 " /dev/sda2 pv 7.9G\n"
26317 " /dev/sda device 8.0G\n"
26322 #: ../tools/virt-resize.pl:115
26324 "(This example is a virtual machine with an 8 GB disk which we would like to "
26325 "expand up to 10 GB)."
26329 #: ../tools/virt-resize.pl:118
26330 msgid "4. Create output disk"
26334 #: ../tools/virt-resize.pl:120
26336 "Virt-resize cannot do in-place disk modifications. You have to have space "
26337 "to store the resized output disk."
26341 #: ../tools/virt-resize.pl:123
26343 "To store the resized disk image in a file, create a file of a suitable size:"
26347 #: ../tools/virt-resize.pl:126
26350 " # rm -f outdisk\n"
26351 " # truncate -s 10G outdisk\n"
26356 #: ../tools/virt-resize.pl:129
26357 msgid "Or use L<lvcreate(1)> to create a logical volume:"
26361 #: ../tools/virt-resize.pl:131
26364 " # lvcreate -L 10G -n lv_name vg_name\n"
26369 #: ../tools/virt-resize.pl:133
26370 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
26374 #: ../tools/virt-resize.pl:135
26377 " # virsh pool-list\n"
26378 " # virsh vol-create-as poolname newvol 10G\n"
26383 #: ../tools/virt-resize.pl:138
26388 #: ../tools/virt-resize.pl:140
26390 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
26391 "file) and the output disk. The output disk is the one created in the "
26396 #: ../tools/virt-resize.pl:144
26399 " # virt-resize indisk outdisk\n"
26404 #: ../tools/virt-resize.pl:146
26406 "This command just copies disk image C<indisk> to disk image C<outdisk> "
26407 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
26408 "larger, then an extra, empty partition is created at the end of the disk "
26409 "covering the extra space. If C<outdisk> is smaller, then it will give an "
26414 #: ../tools/virt-resize.pl:152
26416 "More realistically you'd want to expand existing partitions in the disk "
26417 "image by passing extra options (for the full list see the L</OPTIONS> "
26422 #: ../tools/virt-resize.pl:156
26424 "L</--expand> is the most useful option. It expands the named partition "
26425 "within the disk to fill any extra space:"
26429 #: ../tools/virt-resize.pl:159
26432 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
26437 #: ../tools/virt-resize.pl:161
26439 "(In this case, an extra partition is I<not> created at the end of the disk, "
26440 "because there will be no unused space)."
26444 #: ../tools/virt-resize.pl:164
26446 "L</--resize> is the other commonly used option. The following would "
26447 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
26448 "rest of the available space:"
26452 #: ../tools/virt-resize.pl:168
26455 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
26456 " indisk outdisk\n"
26461 #: ../tools/virt-resize.pl:171
26463 "If the expanded partition in the image contains a filesystem or LVM PV, then "
26464 "if virt-resize knows how, it will resize the contents, the equivalent of "
26465 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
26466 ">. However virt-resize does not know how to resize some filesystems, so you "
26467 "would have to online resize them after booting the guest. And virt-resize "
26468 "also does not resize anything inside an LVM PV, it just resizes the PV "
26469 "itself and leaves the user to resize any LVs inside that PV as desired."
26473 #: ../tools/virt-resize.pl:180
26474 msgid "Other options are covered below."
26478 #: ../tools/virt-resize.pl:182
26483 #: ../tools/virt-resize.pl:184
26484 msgid "Thoroughly test the new disk image I<before> discarding the old one."
26488 #: ../tools/virt-resize.pl:186
26489 msgid "If you are using libvirt, edit the XML to point at the new disk:"
26493 #: ../tools/virt-resize.pl:188
26496 " # virsh edit guestname\n"
26501 #: ../tools/virt-resize.pl:190
26503 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
26504 "html#elementsDisks>"
26508 #: ../tools/virt-resize.pl:193
26509 msgid "Then start up the domain with the new, resized disk:"
26513 #: ../tools/virt-resize.pl:195
26516 " # virsh start guestname\n"
26521 #: ../tools/virt-resize.pl:197
26523 "and check that it still works. See also the L</NOTES> section below for "
26524 "additional information."
26528 #: ../tools/virt-resize.pl:200
26529 msgid "7. Resize LVs etc inside the guest"
26533 #: ../tools/virt-resize.pl:202
26534 msgid "(This can also be done offline using L<guestfish(1)>)"
26538 #: ../tools/virt-resize.pl:204
26540 "Once the guest has booted you should see the new space available, at least "
26541 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
26542 "may need to resize LVs inside PVs, and also resize filesystem types that "
26543 "virt-resize does not know how to expand."
26547 #: ../tools/virt-resize.pl:211
26548 msgid "SHRINKING A VIRTUAL MACHINE DISK"
26552 #: ../tools/virt-resize.pl:213
26554 "Shrinking is somewhat more complex than expanding, and only an overview is "
26559 #: ../tools/virt-resize.pl:216
26561 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
26562 "filesystems). The user has to shrink content before passing the disk image "
26563 "to virt-resize, and virt-resize will check that the content has been shrunk "
26568 #: ../tools/virt-resize.pl:221
26569 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
26573 #: ../tools/virt-resize.pl:223
26575 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
26576 "steps 3 and 4 above to allocate a new disk image."
26580 #: ../tools/virt-resize.pl:226
26582 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
26586 #: ../tools/virt-resize.pl:229
26587 msgid "IGNORING OR DELETING PARTITIONS"
26591 #: ../tools/virt-resize.pl:231
26593 "virt-resize also gives a convenient way to ignore or delete partitions when "
26594 "copying from the input disk to the output disk. Ignoring a partition speeds "
26595 "up the copy where you don't care about the existing contents of a "
26596 "partition. Deleting a partition removes it completely, but note that it "
26597 "also renumbers any partitions after the one which is deleted, which can "
26598 "leave some guests unbootable."
26602 #: ../tools/virt-resize.pl:238
26603 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
26607 #: ../tools/virt-resize.pl:240
26609 "If the input disk is in qcow2 format, then you may prefer that the output is "
26610 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
26611 "the fly. The output format is simply determined by the format of the empty "
26612 "output container that you provide. Thus to create qcow2 output, use:"
26616 #: ../tools/virt-resize.pl:246
26619 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
26624 #: ../tools/virt-resize.pl:248
26625 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
26629 #: ../tools/virt-resize.pl:250
26630 msgid "Similarly, to get non-sparse raw output use:"
26634 #: ../tools/virt-resize.pl:252
26637 " fallocate -l size outdisk\n"
26642 #: ../tools/virt-resize.pl:254
26644 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
26645 "dev/zero of=outdisk bs=1M count=..>)"
26649 #: ../tools/virt-resize.pl:267
26650 msgid "Display help."
26654 #: ../tools/virt-resize.pl:281
26655 msgid "B<--resize part=size>"
26659 #: ../tools/virt-resize.pl:283
26661 "Resize the named partition (expanding or shrinking it) so that it has the "
26666 #: ../tools/virt-resize.pl:286
26668 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
26669 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
26670 "Exabytes; or as a percentage of the current size; or as a relative number or "
26671 "percentage. For example:"
26675 #: ../tools/virt-resize.pl:291
26678 " --resize /dev/sda2=10G\n"
26683 #: ../tools/virt-resize.pl:293
26686 " --resize /dev/sda4=90%\n"
26691 #: ../tools/virt-resize.pl:295
26694 " --resize /dev/sda2=+1G\n"
26699 #: ../tools/virt-resize.pl:297
26702 " --resize /dev/sda2=-200M\n"
26707 #: ../tools/virt-resize.pl:299
26710 " --resize /dev/sda1=+128K\n"
26715 #: ../tools/virt-resize.pl:301
26718 " --resize /dev/sda1=+10%\n"
26723 #: ../tools/virt-resize.pl:303
26726 " --resize /dev/sda1=-10%\n"
26731 #: ../tools/virt-resize.pl:305
26733 "You can increase the size of any partition. Virt-resize will expand the "
26734 "direct content of the partition if it knows how (see C<--expand> below)."
26738 #: ../tools/virt-resize.pl:309
26740 "You can only I<decrease> the size of partitions that contain filesystems or "
26741 "PVs which have already been shrunk. Virt-resize will check this has been "
26742 "done before proceeding, or else will print an error (see also C<--resize-"
26747 #: ../tools/virt-resize.pl:314 ../tools/virt-resize.pl:406
26748 #: ../tools/virt-resize.pl:423
26749 msgid "You can give this option multiple times."
26753 #: ../tools/virt-resize.pl:320
26754 msgid "B<--resize-force part=size>"
26758 #: ../tools/virt-resize.pl:322
26760 "This is the same as C<--resize> except that it will let you decrease the "
26761 "size of any partition. Generally this means you will lose any data which "
26762 "was at the end of the partition you shrink, but you may not care about that "
26763 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
26764 "as a swap partition)."
26768 #: ../tools/virt-resize.pl:328
26769 msgid "See also the C<--ignore> option."
26773 #: ../tools/virt-resize.pl:334
26774 msgid "B<--expand part>"
26778 #: ../tools/virt-resize.pl:336
26780 "Expand the named partition so it uses up all extra space (space left over "
26781 "after any other resize changes that you request have been done)."
26785 #: ../tools/virt-resize.pl:339
26787 "If virt-resize knows how, it will expand the direct content of the "
26788 "partition. For example, if the partition is an LVM PV, it will expand the "
26789 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
26790 "content it doesn't know about alone."
26794 #: ../tools/virt-resize.pl:344
26795 msgid "Currently virt-resize can resize:"
26799 #: ../tools/virt-resize.pl:350
26801 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
26806 #: ../tools/virt-resize.pl:355
26808 "NTFS filesystems contained directly in a partition, if libguestfs was "
26809 "compiled with support for NTFS."
26813 #: ../tools/virt-resize.pl:358
26815 "The filesystem must have been shut down consistently last time it was used. "
26816 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
26817 "consistency check, so at the first boot after resizing Windows will check "
26822 #: ../tools/virt-resize.pl:365
26824 "LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
26825 "inside the PV. The user will have to resize LVs as desired."
26829 #: ../tools/virt-resize.pl:371 ../tools/virt-resize.pl:393
26830 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
26834 #: ../tools/virt-resize.pl:377
26835 msgid "B<--shrink part>"
26839 #: ../tools/virt-resize.pl:379
26841 "Shrink the named partition until the overall disk image fits in the "
26842 "destination. The named partition B<must> contain a filesystem or PV which "
26843 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
26844 "online tools). Virt-resize will check this and give an error if it has not "
26849 #: ../tools/virt-resize.pl:385
26851 "The amount by which the overall disk must be shrunk (after carrying out all "
26852 "other operations requested by the user) is called the \"deficit\". For "
26853 "example, a straight copy (assume no other operations) from a 5GB disk image "
26854 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
26855 "would give an error unless the user specified a partition to shrink and that "
26856 "partition had more than a gigabyte of free space."
26860 #: ../tools/virt-resize.pl:399
26861 msgid "B<--ignore part>"
26865 #: ../tools/virt-resize.pl:401
26867 "Ignore the named partition. Effectively this means the partition is "
26868 "allocated on the destination disk, but the content is not copied across from "
26869 "the source disk. The content of the partition will be blank (all zero "
26874 #: ../tools/virt-resize.pl:412
26875 msgid "B<--delete part>"
26879 #: ../tools/virt-resize.pl:414
26881 "Delete the named partition. It would be more accurate to describe this as "
26882 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
26883 "the original disk image is left intact."
26887 #: ../tools/virt-resize.pl:418
26889 "Note that when you delete a partition, then anything contained in the "
26890 "partition is also deleted. Furthermore, this causes any partitions that "
26891 "come after to be I<renumbered>, which can easily make your guest unbootable."
26895 #: ../tools/virt-resize.pl:429
26896 msgid "B<--LV-expand logvol>"
26900 #: ../tools/virt-resize.pl:431
26902 "This takes the logical volume and, as a final step, expands it to fill all "
26903 "the space available in its volume group. A typical usage, assuming a Linux "
26904 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
26905 "lv_root> would be:"
26909 #: ../tools/virt-resize.pl:436
26912 " virt-resize indisk outdisk \\\n"
26913 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
26918 #: ../tools/virt-resize.pl:439
26920 "This would first expand the partition (and PV), and then expand the root "
26921 "device to fill the extra space in the PV."
26925 #: ../tools/virt-resize.pl:442
26927 "The contents of the LV are also resized if virt-resize knows how to do "
26928 "that. You can stop virt-resize from trying to expand the content by using "
26929 "the option C<--no-expand-content>."
26933 #: ../tools/virt-resize.pl:446
26934 msgid "Use L<virt-list-filesystems(1)> to list the filesystems in the guest."
26938 #: ../tools/virt-resize.pl:449
26940 "You can give this option multiple times, I<but> it doesn't make sense to do "
26941 "this unless the logical volumes you specify are all in different volume "
26946 #: ../tools/virt-resize.pl:457
26947 msgid "B<--no-copy-boot-loader>"
26951 #: ../tools/virt-resize.pl:459
26953 "By default, virt-resize copies over some sectors at the start of the disk "
26954 "(up to the beginning of the first partition). Commonly these sectors "
26955 "contain the Master Boot Record (MBR) and the boot loader, and are required "
26956 "in order for the guest to boot correctly."
26960 #: ../tools/virt-resize.pl:464
26962 "If you specify this flag, then this initial copy is not done. You may need "
26963 "to reinstall the boot loader in this case."
26967 #: ../tools/virt-resize.pl:472
26968 msgid "B<--no-extra-partition>"
26972 #: ../tools/virt-resize.pl:474
26974 "By default, virt-resize creates an extra partition if there is any extra, "
26975 "unused space after all resizing has happened. Use this option to prevent "
26976 "the extra partition from being created. If you do this then the extra space "
26977 "will be inaccessible until you run fdisk, parted, or some other partitioning "
26978 "tool in the guest."
26982 #: ../tools/virt-resize.pl:480
26984 "Note that if the surplus space is smaller than 10 MB, no extra partition "
26989 #: ../tools/virt-resize.pl:487
26990 msgid "B<--no-expand-content>"
26994 #: ../tools/virt-resize.pl:489
26996 "By default, virt-resize will try to expand the direct contents of "
26997 "partitions, if it knows how (see C<--expand> option above)."
27001 #: ../tools/virt-resize.pl:492
27003 "If you give the C<--no-expand-content> option then virt-resize will not "
27008 #: ../tools/virt-resize.pl:499
27009 msgid "B<-d> | B<--debug>"
27013 #: ../tools/virt-resize.pl:507
27014 msgid "B<-n> | B<--dryrun>"
27018 #: ../tools/virt-resize.pl:509
27019 msgid "Print a summary of what would be done, but don't do anything."
27023 #: ../tools/virt-resize.pl:515
27024 msgid "B<-q> | B<--quiet>"
27028 #: ../tools/virt-resize.pl:517
27029 msgid "Don't print the summary."
27033 #: ../tools/virt-resize.pl:525
27035 "Specify the format of the input disk image. If this flag is not given then "
27036 "it is auto-detected from the image itself."
27040 #: ../tools/virt-resize.pl:531
27042 "Note that this option I<does not> affect the output format. See L</QCOW2 "
27043 "AND NON-SPARSE RAW FORMATS>."
27047 #: ../tools/virt-resize.pl:538
27048 msgid "B<--output-format> raw"
27052 #: ../tools/virt-resize.pl:540
27054 "Specify the format of the output disk image. If this flag is not given then "
27055 "it is auto-detected from the image itself."
27059 #: ../tools/virt-resize.pl:546
27061 "Note that you still need to create the output disk with the right format. "
27062 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
27066 #: ../tools/virt-resize.pl:1422 ../tools/virt-rescue.pl:90
27071 #: ../tools/virt-resize.pl:1424
27072 msgid "\"Partition 1 does not end on cylinder boundary.\""
27076 #: ../tools/virt-resize.pl:1426
27078 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
27079 "means the partitions will not be aligned to the ancient CHS geometry. "
27080 "However CHS geometry is meaningless for disks manufactured since the early "
27081 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
27082 "cylinders is not required by any modern operating system."
27086 #: ../tools/virt-resize.pl:1433
27087 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
27091 #: ../tools/virt-resize.pl:1435
27093 "In Windows Vista and later versions, Microsoft switched to using a separate "
27094 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
27095 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
27096 "the boot partition. Doing so seems to break the guest completely. However "
27097 "expanding the second partition (ie. C: drive) should work."
27101 #: ../tools/virt-resize.pl:1442
27103 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
27104 "NTFS partitions have been expanded. This is just a safety check and (unless "
27105 "it find errors) is nothing to worry about."
27109 #: ../tools/virt-resize.pl:1446
27110 msgid "GUEST BOOT STUCK AT \"GRUB\""
27114 #: ../tools/virt-resize.pl:1448
27116 "If a Linux guest does not boot after resizing, and the boot is stuck after "
27117 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
27118 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
27119 "although we think is to do with partition alignment."
27123 #: ../tools/virt-resize.pl:1453
27126 " guestfish -i -a newdisk\n"
27127 " ><fs> cat /boot/grub/device.map\n"
27128 " # check the contents of this file are sensible or\n"
27129 " # edit the file if necessary\n"
27130 " ><fs> grub-install / /dev/vda\n"
27136 #: ../tools/virt-resize.pl:1460
27138 "For more flexible guest reconfiguration, including if you need to specify "
27139 "other parameters to grub-install, use L<virt-rescue(1)>."
27143 #: ../tools/virt-resize.pl:1463
27144 msgid "ALTERNATIVE TOOLS"
27148 #: ../tools/virt-resize.pl:1465
27150 "There are several proprietary tools for resizing partitions. We won't "
27151 "mention any here."
27155 #: ../tools/virt-resize.pl:1468
27157 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
27158 "operations on disk images. They can resize and move partitions, but I don't "
27159 "think they can do anything with the contents, and they certainly don't "
27164 #: ../tools/virt-resize.pl:1473
27166 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
27167 "but at a much lower level. You will probably end up hand-calculating sector "
27168 "offsets, which is something that virt-resize was designed to avoid. If you "
27169 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
27174 #: ../tools/virt-resize.pl:1488
27176 "L<virt-list-partitions(1)>, L<virt-list-filesystems(1)>, L<virt-df(1)>, "
27177 "L<guestfs(3)>, L<guestfish(1)>, L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, "
27178 "L<resize2fs(8)>, L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)"
27179 ">, L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
27180 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
27184 #: ../tools/virt-list-filesystems.pl:32
27186 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
27190 #: ../tools/virt-list-filesystems.pl:36
27193 " virt-list-filesystems [--options] domname\n"
27198 #: ../tools/virt-list-filesystems.pl:38
27201 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
27206 #: ../tools/virt-list-filesystems.pl:42
27208 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
27209 "are contained in a virtual machine or disk image."
27213 #: ../tools/virt-list-filesystems.pl:46
27215 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
27216 "functionality. For more complex cases you should look at the L<guestfish(1)"
27221 #: ../tools/virt-list-filesystems.pl:105
27223 "With this option, C<virt-list-filesystems> displays the type of each "
27224 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
27228 #: ../tools/virt-list-filesystems.pl:112
27229 msgid "B<-a> | B<--all>"
27233 #: ../tools/virt-list-filesystems.pl:114
27235 "Normally we only show mountable filesystems. If this option is given then "
27236 "swap devices are shown too."
27240 #: ../tools/virt-list-filesystems.pl:188
27242 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-list-"
27243 "partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)"
27244 ">, L<http://libguestfs.org/>."
27248 #: ../tools/virt-cat.pl:33
27249 msgid "virt-cat - Display a file in a virtual machine"
27253 #: ../tools/virt-cat.pl:37
27256 " virt-cat [--options] domname file\n"
27261 #: ../tools/virt-cat.pl:39
27264 " virt-cat [--options] disk.img [disk.img ...] file\n"
27269 #: ../tools/virt-cat.pl:43
27271 "C<virt-cat> is a command line tool to display the contents of C<file> where "
27272 "C<file> exists in the named virtual machine (or disk image)."
27276 #: ../tools/virt-cat.pl:46
27278 "C<virt-cat> can be used to quickly view a single file. To edit a file, use "
27279 "C<virt-edit>. For more complex cases you should look at the L<guestfish(1)> "
27284 #: ../tools/virt-cat.pl:52
27286 "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
27290 #: ../tools/virt-cat.pl:55
27293 " virt-cat mydomain /etc/fstab\n"
27298 #: ../tools/virt-cat.pl:57
27299 msgid "List syslog messages from a VM:"
27303 #: ../tools/virt-cat.pl:59
27306 " virt-cat mydomain /var/log/messages | tail\n"
27311 #: ../tools/virt-cat.pl:61
27312 msgid "Find out what DHCP IP address a VM acquired:"
27316 #: ../tools/virt-cat.pl:63
27319 " virt-cat mydomain /var/log/messages | grep 'dhclient: bound to' | tail\n"
27324 #: ../tools/virt-cat.pl:65
27325 msgid "Find out what packages were recently installed:"
27329 #: ../tools/virt-cat.pl:67
27332 " virt-cat mydomain /var/log/yum.log | tail\n"
27337 #: ../tools/virt-cat.pl:69
27338 msgid "Find out who is logged on inside a virtual machine:"
27342 #: ../tools/virt-cat.pl:71
27345 " virt-cat mydomain /var/run/utmp > /tmp/utmp\n"
27351 #: ../tools/virt-cat.pl:74
27352 msgid "or who was logged on:"
27356 #: ../tools/virt-cat.pl:76
27359 " virt-cat mydomain /var/log/wtmp > /tmp/wtmp\n"
27360 " last -f /tmp/wtmp\n"
27365 #: ../tools/virt-cat.pl:187
27367 "L<guestfs(3)>, L<guestfish(1)>, L<virt-edit(1)>, L<Sys::Guestfs(3)>, L<Sys::"
27368 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27372 #: ../tools/virt-tar.pl:33
27373 msgid "virt-tar - Extract or upload files to a virtual machine"
27377 #: ../tools/virt-tar.pl:37
27380 " virt-tar [--options] -x domname directory tarball\n"
27385 #: ../tools/virt-tar.pl:39
27388 " virt-tar [--options] -u domname tarball directory\n"
27393 #: ../tools/virt-tar.pl:41
27396 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
27401 #: ../tools/virt-tar.pl:43
27404 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
27409 #: ../tools/virt-tar.pl:47
27410 msgid "Download C</home> from the VM into a local tarball:"
27414 #: ../tools/virt-tar.pl:49
27417 " virt-tar -x domname /home home.tar\n"
27422 #: ../tools/virt-tar.pl:51
27425 " virt-tar -zx domname /home home.tar.gz\n"
27430 #: ../tools/virt-tar.pl:53
27431 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
27435 #: ../tools/virt-tar.pl:55
27438 " virt-tar -u domname uploadstuff.tar /tmp\n"
27443 #: ../tools/virt-tar.pl:57
27446 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
27451 #: ../tools/virt-tar.pl:61
27453 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
27454 "virtual machines. If you do this, you risk disk corruption in the VM. "
27455 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
27459 #: ../tools/virt-tar.pl:66
27461 "You can use C<-x> (extract) on live virtual machines, but you might get "
27462 "inconsistent results or errors if there is filesystem activity inside the "
27463 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
27464 "work, but the only way to guarantee consistent results is if the virtual "
27465 "machine is shut down."
27469 #: ../tools/virt-tar.pl:74
27471 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
27472 "parts of a guest filesystem. There are many possibilities: making backups, "
27473 "uploading data files, snooping on guest activity, fixing or customizing "
27478 #: ../tools/virt-tar.pl:79
27480 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
27481 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
27482 "should look at the L<guestfish(1)> tool."
27486 #: ../tools/virt-tar.pl:83
27488 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
27489 "its contents (recursively) from the virtual machine into a local tarball. "
27490 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
27491 "virtual machine. You cannot use these two options together."
27495 #: ../tools/virt-tar.pl:89
27497 "In addition, you may need to use the C<-z> (gZip) option to enable "
27498 "compression. When uploading, you have to specify C<-z> if the upload file "
27499 "is compressed because virt-tar won't detect this on its own."
27503 #: ../tools/virt-tar.pl:93
27505 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
27506 "example it cannot do PKZip files or bzip2 compression. If you want that "
27507 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
27508 "the L<libguestfs(3)> API)."
27512 #: ../tools/virt-tar.pl:151
27513 msgid "B<-x> | B<--extract> | B<--download>"
27517 #: ../tools/virt-tar.pl:153
27518 msgid "B<-u> | B<--upload>"
27522 #: ../tools/virt-tar.pl:155
27524 "Use C<-x> to extract (download) a directory from a virtual machine to a "
27529 #: ../tools/virt-tar.pl:158
27531 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
27532 "Please read the L</WARNING> section above before using this option."
27536 #: ../tools/virt-tar.pl:162
27537 msgid "You must specify exactly one of these options."
27541 #: ../tools/virt-tar.pl:168
27542 msgid "B<-z> | B<--gzip>"
27546 #: ../tools/virt-tar.pl:170
27547 msgid "Specify that the input or output tarball is gzip-compressed."
27551 #: ../tools/virt-tar.pl:283
27553 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<Sys::"
27554 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
27559 #: ../tools/virt-rescue.pl:33
27560 msgid "virt-rescue - Run a rescue shell on a virtual machine"
27564 #: ../tools/virt-rescue.pl:37
27567 " virt-rescue [--options] domname\n"
27572 #: ../tools/virt-rescue.pl:39
27575 " virt-rescue [--options] disk.img [disk.img ...]\n"
27580 #: ../tools/virt-rescue.pl:43
27582 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
27583 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
27584 "you from doing this, but doesn't catch all cases."
27588 #: ../tools/virt-rescue.pl:47
27590 "However if you use the I<--ro> (read only) option, then you can attach a "
27591 "shell to a live virtual machine. The results might be strange or "
27592 "inconsistent at times but you won't get disk corruption."
27596 #: ../tools/virt-rescue.pl:53
27598 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
27599 "need for a CD. virt-rescue gives you a rescue shell and some simple "
27600 "recovery tools which you can use to examine or rescue a virtual machine or "
27605 #: ../tools/virt-rescue.pl:58
27607 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
27608 "on disk image(s):"
27612 #: ../tools/virt-rescue.pl:61
27615 " virt-rescue GuestName\n"
27620 #: ../tools/virt-rescue.pl:63
27623 " virt-rescue --ro /path/to/disk.img\n"
27628 #: ../tools/virt-rescue.pl:65
27631 " virt-rescue /dev/sdc\n"
27636 #: ../tools/virt-rescue.pl:67
27637 msgid "For live VMs you I<must> use the --ro option."
27641 #: ../tools/virt-rescue.pl:69
27643 "When you run virt-rescue on a virtual machine or disk image, you are placed "
27644 "in an interactive bash shell where you can use many ordinary Linux "
27645 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
27646 "appliance. You must mount the virtual machine's filesystems by hand. There "
27647 "is an empty directory called C</sysroot> where you can mount filesystems."
27651 #: ../tools/virt-rescue.pl:76
27653 "In the example below, we list logical volumes, then choose one to mount "
27654 "under C</sysroot>:"
27658 #: ../tools/virt-rescue.pl:79
27662 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
27663 " lv_root vg_f11x64 -wi-a- 8.83G\n"
27664 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
27665 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
27666 " ><rescue> ls /sysroot\n"
27671 #: ../tools/virt-rescue.pl:86
27673 "If you don't know what filesystems are available on the virtual machine then "
27674 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
27678 #: ../tools/virt-rescue.pl:92
27680 "Virt-rescue can be used on I<any> disk image file or device, not just a "
27681 "virtual machine. For example you can use it on a blank file if you want to "
27682 "partition that file (although we would recommend using L<guestfish(1)> "
27683 "instead as it is more suitable for this purpose). You can even use virt-"
27684 "rescue on things like SD cards."
27688 #: ../tools/virt-rescue.pl:98
27690 "This tool is just designed for quick interactive hacking on a virtual "
27691 "machine. For more structured access to a virtual machine disk image, you "
27692 "should use L<guestfs(3)>. To get a structured shell that you can use to "
27693 "make scripted changes to guests, use L<guestfish(1)>."
27697 #: ../tools/virt-rescue.pl:127
27698 msgid "B<--append kernelopts>"
27702 #: ../tools/virt-rescue.pl:129
27703 msgid "Pass additional options to the rescue kernel."
27707 #: ../tools/virt-rescue.pl:164
27708 msgid "B<--memsize MB> | B<-m MB>"
27712 #: ../tools/virt-rescue.pl:166
27714 "Change the amount of memory allocated to the rescue system. The default is "
27715 "set by libguestfs and is small but adequate for running system tools. The "
27716 "occasional program might need more memory. The parameter is specified in "
27721 #: ../tools/virt-rescue.pl:175
27722 msgid "B<--network MB>"
27726 #: ../tools/virt-rescue.pl:177
27727 msgid "Enable QEMU user networking in the guest."
27731 #: ../tools/virt-rescue.pl:183
27732 msgid "B<--ro> | B<-r>"
27736 #: ../tools/virt-rescue.pl:185
27737 msgid "Open the image read-only."
27741 #: ../tools/virt-rescue.pl:197
27743 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
27744 "SELINUX> before using this option."
27748 #: ../tools/virt-rescue.pl:257
27750 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
27751 "ENVIRONMENT VARIABLES> for the complete list."
27755 #: ../tools/virt-rescue.pl:269
27757 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
27758 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27762 #: ../tools/virt-make-fs.pl:37
27763 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
27767 #: ../tools/virt-make-fs.pl:41
27770 " virt-make-fs [--options] input.tar output.img\n"
27775 #: ../tools/virt-make-fs.pl:43
27778 " virt-make-fs [--options] input.tar.gz output.img\n"
27783 #: ../tools/virt-make-fs.pl:45
27786 " virt-make-fs [--options] directory output.img\n"
27791 #: ../tools/virt-make-fs.pl:49
27793 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
27794 "archive or some files in a directory. It is similar to tools like L<mkisofs"
27795 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
27796 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
27797 "you want to attach these filesystems to existing virtual machines (eg. to "
27798 "import large amounts of read-only data to a VM)."
27802 #: ../tools/virt-make-fs.pl:57
27803 msgid "Basic usage is:"
27807 #: ../tools/virt-make-fs.pl:59
27810 " virt-make-fs input output\n"
27815 #: ../tools/virt-make-fs.pl:61
27817 "where C<input> is either a directory containing files that you want to add, "
27818 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
27819 "C<output> is a disk image. The input type is detected automatically. The "
27820 "output disk image defaults to a raw ext2 image unless you specify extra "
27821 "flags (see L</OPTIONS> below)."
27825 #: ../tools/virt-make-fs.pl:67
27826 msgid "EXTRA SPACE"
27830 #: ../tools/virt-make-fs.pl:69
27832 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
27833 "the files that it contains, but might have extra space. Depending on how "
27834 "you are going to use the output, you might think this extra space is wasted "
27835 "and want to minimize it, or you might want to leave space so that more files "
27836 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
27837 "but you can use the C<--size> flag to leave space in the filesystem if you "
27842 #: ../tools/virt-make-fs.pl:77
27844 "An alternative way to leave extra space but not make the output image any "
27845 "bigger is to use an alternative disk image format (instead of the default "
27846 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
27847 "image format (check your hypervisor supports this before using it). This "
27848 "allows you to choose a large C<--size> but the extra space won't actually be "
27849 "allocated in the image until you try to store something in it."
27853 #: ../tools/virt-make-fs.pl:85
27855 "Don't forget that you can also use local commands including L<resize2fs(8)> "
27856 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-"
27857 "resize to build another image from scratch."
27861 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
27862 #: ../tools/virt-make-fs.pl:142
27867 #: ../tools/virt-make-fs.pl:91
27870 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
27875 #: ../tools/virt-make-fs.pl:93
27876 msgid "FILESYSTEM TYPE"
27880 #: ../tools/virt-make-fs.pl:95
27882 "The default filesystem type is C<ext2>. Just about any filesystem type that "
27883 "libguestfs supports can be used (but I<not> read-only formats like "
27884 "ISO9660). Here are some of the more common choices:"
27888 #: ../tools/virt-make-fs.pl:101
27893 #: ../tools/virt-make-fs.pl:103
27895 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
27896 "you are not going to use the filesystem in a way that requires the journal, "
27897 "then this is just wasted overhead."
27901 #: ../tools/virt-make-fs.pl:107
27902 msgid "I<ntfs> or I<vfat>"
27906 #: ../tools/virt-make-fs.pl:109
27907 msgid "Useful if exporting data to a Windows guest."
27911 #: ../tools/virt-make-fs.pl:111
27913 "I<Note for vfat>: The tar archive or local directory must only contain files "
27914 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
27915 "program running within libguestfs is unable to change the ownership of non-"
27916 "root files, since vfat itself does not support this."
27920 #: ../tools/virt-make-fs.pl:116
27925 #: ../tools/virt-make-fs.pl:118
27927 "Lower overhead than C<ext2>, but certain limitations on filename length and "
27928 "total filesystem size."
27932 #: ../tools/virt-make-fs.pl:125
27935 " virt-make-fs --type=minix input minixfs.img\n"
27940 #: ../tools/virt-make-fs.pl:127
27941 msgid "TO PARTITION OR NOT TO PARTITION"
27945 #: ../tools/virt-make-fs.pl:129
27946 msgid "Optionally virt-make-fs can add a partition table to the output disk."
27950 #: ../tools/virt-make-fs.pl:131
27952 "Adding a partition can make the disk image more compatible with certain "
27953 "virtualized operating systems which don't expect to see a filesystem "
27954 "directly located on a block device (Linux doesn't care and will happily "
27955 "handle both types)."
27959 #: ../tools/virt-make-fs.pl:136
27961 "On the other hand, if you have a partition table then the output image is no "
27962 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
27963 "directly on a partitioned disk image. (However libguestfs tools such as "
27964 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
27968 #: ../tools/virt-make-fs.pl:144
27969 msgid "Add an MBR partition:"
27973 #: ../tools/virt-make-fs.pl:146
27976 " virt-make-fs --partition -- input disk.img\n"
27981 #: ../tools/virt-make-fs.pl:148
27983 "If the output disk image could be terabyte-sized or larger, it's better to "
27984 "use an EFI/GPT-compatible partition table:"
27988 #: ../tools/virt-make-fs.pl:151
27991 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
27996 #: ../tools/virt-make-fs.pl:179
27997 msgid "Enable debugging information."
28001 #: ../tools/virt-make-fs.pl:185
28002 msgid "B<--size=E<lt>NE<gt>>"
28006 #: ../tools/virt-make-fs.pl:187
28007 msgid "B<--size=+E<lt>NE<gt>>"
28011 #: ../tools/virt-make-fs.pl:189
28012 msgid "B<-s E<lt>NE<gt>>"
28016 #: ../tools/virt-make-fs.pl:191
28017 msgid "B<-s +E<lt>NE<gt>>"
28021 #: ../tools/virt-make-fs.pl:193
28023 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
28027 #: ../tools/virt-make-fs.pl:196
28029 "If this option is I<not> given, then the output image will be just large "
28030 "enough to contain all the files, with not much wasted space."
28034 #: ../tools/virt-make-fs.pl:199
28036 "To choose a fixed size output disk, specify an absolute number followed by b/"
28037 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28038 "Petabytes or Exabytes. This must be large enough to contain all the input "
28039 "files, else you will get an error."
28043 #: ../tools/virt-make-fs.pl:204
28045 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
28046 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28047 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
28048 "the input files, and (approximately) an extra 200 MB free space."
28052 #: ../tools/virt-make-fs.pl:210
28054 "Note that virt-make-fs estimates free space, and therefore will not produce "
28055 "filesystems containing precisely the free space requested. (It is much more "
28056 "expensive and time-consuming to produce a filesystem which has precisely the "
28057 "desired free space)."
28061 #: ../tools/virt-make-fs.pl:219
28062 msgid "B<--format=E<lt>fmtE<gt>>"
28066 #: ../tools/virt-make-fs.pl:221
28067 msgid "B<-F E<lt>fmtE<gt>>"
28071 #: ../tools/virt-make-fs.pl:223
28072 msgid "Choose the output disk image format."
28076 #: ../tools/virt-make-fs.pl:225
28077 msgid "The default is C<raw> (raw disk image)."
28081 #: ../tools/virt-make-fs.pl:227
28083 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
28084 "that would really make sense here is C<qcow2>."
28088 #: ../tools/virt-make-fs.pl:234
28089 msgid "B<--type=E<lt>fsE<gt>>"
28093 #: ../tools/virt-make-fs.pl:236
28094 msgid "B<-t E<lt>fsE<gt>>"
28098 #: ../tools/virt-make-fs.pl:238
28099 msgid "Choose the output filesystem type."
28103 #: ../tools/virt-make-fs.pl:240
28104 msgid "The default is C<ext2>."
28108 #: ../tools/virt-make-fs.pl:242
28110 "Any filesystem which is supported read-write by libguestfs can be used here."
28114 #: ../tools/virt-make-fs.pl:249
28115 msgid "B<--partition>"
28119 #: ../tools/virt-make-fs.pl:251
28120 msgid "B<--partition=E<lt>parttypeE<gt>>"
28124 #: ../tools/virt-make-fs.pl:253
28126 "If specified, this flag adds an MBR partition table to the output disk image."
28130 #: ../tools/virt-make-fs.pl:256
28132 "You can change the partition table type, eg. C<--partition=gpt> for large "
28137 #: ../tools/virt-make-fs.pl:259
28139 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
28140 "might consider the next parameter to be the partition type. For example:"
28144 #: ../tools/virt-make-fs.pl:263
28147 " virt-make-fs --partition input.tar ...\n"
28152 #: ../tools/virt-make-fs.pl:265
28154 "would cause virt-make-fs to think you wanted to use a partition type of "
28155 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
28156 "dash) between options and the input file argument:"
28160 #: ../tools/virt-make-fs.pl:269
28163 " virt-make-fs --partition -- input.tar ...\n"
28168 #: ../tools/virt-make-fs.pl:536
28170 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
28171 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
28172 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28176 #: ../tools/virt-make-fs.pl:553
28179 " export LIBGUESTFS_DEBUG=1\n"
28180 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
28185 #: ../tools/virt-make-fs.pl:556
28187 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
28192 #: ../tools/virt-list-partitions.pl:32
28194 "virt-list-partitions - List partitions in a virtual machine or disk image"
28198 #: ../tools/virt-list-partitions.pl:36
28201 " virt-list-partitions [--options] domname\n"
28206 #: ../tools/virt-list-partitions.pl:38
28209 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
28214 #: ../tools/virt-list-partitions.pl:42
28216 "C<virt-list-partitions> is a command line tool to list the partitions that "
28217 "are contained in a virtual machine or disk image. It is mainly useful as a "
28218 "first step to using L<virt-resize(1)>."
28222 #: ../tools/virt-list-partitions.pl:47
28224 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
28225 "functionality. For more complex cases you should look at the L<guestfish(1)"
28230 #: ../tools/virt-list-partitions.pl:104
28231 msgid "B<-h> | B<--human-readable>"
28235 #: ../tools/virt-list-partitions.pl:106
28236 msgid "Show sizes in human-readable form (eg. \"1G\")."
28240 #: ../tools/virt-list-partitions.pl:114
28242 "With this option, C<virt-list-partitions> displays the type and size of each "
28243 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
28247 #: ../tools/virt-list-partitions.pl:121
28248 msgid "B<-t> | B<--total>"
28252 #: ../tools/virt-list-partitions.pl:123
28254 "Display the total size of each block device (as a separate row or rows)."
28258 #: ../tools/virt-list-partitions.pl:256
28260 "L<guestfs(3)>, L<guestfish(1)>, L<virt-list-filesystems(1)>, L<virt-resize(1)"
28261 ">, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://"
28262 "libguestfs.org/>."