1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: libguestfs 1.7.3\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2010-11-08 15:50+0000\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=utf-8\n"
17 "Content-Transfer-Encoding: ENCODING"
20 #: ../src/guestfs.pod:1 ../fish/guestfish.pod:1 ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1 ../inspector/virt-inspector.pl:31 ../tools/virt-edit.pl:30 ../tools/virt-win-reg.pl:33 ../tools/virt-df.pl:32 ../tools/virt-ls.pl:30 ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 ../tools/virt-cat.pl:29 ../tools/virt-tar.pl:29 ../tools/virt-rescue.pl:29 ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28
25 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../inspector/virt-inspector.pl:33 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-df.pl:34 ../tools/virt-ls.pl:32 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-cat.pl:31 ../tools/virt-tar.pl:31 ../tools/virt-rescue.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
30 #: ../src/guestfs.pod:5
31 msgid "guestfs - Library for accessing and modifying virtual machine images"
35 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../inspector/virt-inspector.pl:37 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-df.pl:38 ../tools/virt-ls.pl:36 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-cat.pl:35 ../tools/virt-tar.pl:35 ../tools/virt-rescue.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
40 #: ../src/guestfs.pod:9
43 " #include <guestfs.h>\n"
48 #: ../src/guestfs.pod:11
51 " guestfs_h *g = guestfs_create ();\n"
52 " guestfs_add_drive (g, \"guest.img\");\n"
53 " guestfs_launch (g);\n"
54 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
55 " guestfs_touch (g, \"/hello\");\n"
56 " guestfs_umount (g, \"/\");\n"
57 " guestfs_sync (g);\n"
58 " guestfs_close (g);\n"
63 #: ../src/guestfs.pod:20
66 " cc prog.c -o prog -lguestfs\n"
68 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
73 #: ../src/guestfs.pod:24 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../inspector/virt-inspector.pl:43 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-df.pl:46 ../tools/virt-ls.pl:42 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-cat.pl:41 ../tools/virt-tar.pl:72 ../tools/virt-rescue.pl:51 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
78 #: ../src/guestfs.pod:26
80 "Libguestfs is a library for accessing and modifying guest disk images. "
81 "Amongst the things this is good for: making batch configuration changes to "
82 "guests, getting disk used/free statistics (see also: virt-df), migrating "
83 "between virtualization systems (see also: virt-p2v), performing partial "
84 "backups, performing partial guest clones, cloning guests and changing "
85 "registry/UUID/hostname info, and much else besides."
89 #: ../src/guestfs.pod:34
91 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
92 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
93 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
98 #: ../src/guestfs.pod:39
100 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
101 "what filesystem is in each LV, etc.). It can also run commands in the "
102 "context of the guest. Also you can access filesystems over FUSE."
106 #: ../src/guestfs.pod:44
108 "Libguestfs is a library that can be linked with C and C++ management "
109 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
110 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
115 #: ../src/guestfs.pod:49
117 "You don't need to be root to use libguestfs, although obviously you do need "
118 "enough permissions to access the disk images."
122 #: ../src/guestfs.pod:52
124 "Libguestfs is a large API because it can do many things. For a gentle "
125 "introduction, please read the L</API OVERVIEW> section next."
129 #: ../src/guestfs.pod:55
134 #: ../src/guestfs.pod:57
136 "This section provides a gentler overview of the libguestfs API. We also try "
137 "to group API calls together, where that may not be obvious from reading "
138 "about the individual calls in the main section of this manual."
142 #: ../src/guestfs.pod:62
147 #: ../src/guestfs.pod:64
149 "Before you can use libguestfs calls, you have to create a handle. Then you "
150 "must add at least one disk image to the handle, followed by launching the "
151 "handle, then performing whatever operations you want, and finally closing "
152 "the handle. By convention we use the single letter C<g> for the name of the "
153 "handle variable, although of course you can use any name you want."
157 #: ../src/guestfs.pod:71
158 msgid "The general structure of all libguestfs-using programs looks like this:"
162 #: ../src/guestfs.pod:74
165 " guestfs_h *g = guestfs_create ();\n"
170 #: ../src/guestfs.pod:76
173 " /* Call guestfs_add_drive additional times if there are\n"
174 " * multiple disk images.\n"
176 " guestfs_add_drive (g, \"guest.img\");\n"
181 #: ../src/guestfs.pod:81
184 " /* Most manipulation calls won't work until you've launched\n"
185 " * the handle 'g'. You have to do this _after_ adding drives\n"
186 " * and _before_ other commands.\n"
188 " guestfs_launch (g);\n"
193 #: ../src/guestfs.pod:87
196 " /* Now you can examine what partitions, LVs etc are available.\n"
198 " char **partitions = guestfs_list_partitions (g);\n"
199 " char **logvols = guestfs_lvs (g);\n"
204 #: ../src/guestfs.pod:92
207 " /* To access a filesystem in the image, you must mount it.\n"
209 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
214 #: ../src/guestfs.pod:96
217 " /* Now you can perform filesystem actions on the guest\n"
220 " guestfs_touch (g, \"/hello\");\n"
225 #: ../src/guestfs.pod:101
228 " /* You only need to call guestfs_sync if you have made\n"
229 " * changes to the guest image. (But if you've made changes\n"
230 " * then you *must* sync). See also: guestfs_umount and\n"
231 " * guestfs_umount_all calls.\n"
233 " guestfs_sync (g);\n"
238 #: ../src/guestfs.pod:108
241 " /* Close the handle 'g'. */\n"
242 " guestfs_close (g);\n"
247 #: ../src/guestfs.pod:111
249 "The code above doesn't include any error checking. In real code you should "
250 "check return values carefully for errors. In general all functions that "
251 "return integers return C<-1> on error, and all functions that return "
252 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
253 "how to handle errors, and consult the documentation for each function call "
254 "below to see precisely how they return error indications."
258 #: ../src/guestfs.pod:119
263 #: ../src/guestfs.pod:121
265 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
266 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
267 "actual block device, or simply an empty file of zeroes that you have created "
268 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
273 #: ../src/guestfs.pod:127
275 "The call you should use in modern code for adding drives is "
276 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
277 "specifying that the format is raw, do:"
281 #: ../src/guestfs.pod:131
284 " guestfs_add_drive_opts (g, filename,\n"
285 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
291 #: ../src/guestfs.pod:135
292 msgid "You can add a disk read-only using:"
296 #: ../src/guestfs.pod:137
299 " guestfs_add_drive_opts (g, filename,\n"
300 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
301 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
307 #: ../src/guestfs.pod:142
309 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
310 "libguestfs won't modify the file."
314 #: ../src/guestfs.pod:145
316 "Be extremely cautious if the disk image is in use, eg. if it is being used "
317 "by a virtual machine. Adding it read-write will almost certainly cause disk "
318 "corruption, but adding it read-only is safe."
322 #: ../src/guestfs.pod:149
324 "You must add at least one disk image, and you may add multiple disk images. "
325 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
326 "first one you added), C</dev/sdb> (for the second one you added), etc."
330 #: ../src/guestfs.pod:154
332 "Once L</guestfs_launch> has been called you cannot add any more images. You "
333 "can call L</guestfs_list_devices> to get a list of the device names, in the "
334 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
338 #: ../src/guestfs.pod:159
343 #: ../src/guestfs.pod:161
345 "Before you can read or write files, create directories and so on in a disk "
346 "image that contains filesystems, you have to mount those filesystems using "
347 "L</guestfs_mount>. If you already know that a disk image contains (for "
348 "example) one partition with a filesystem on that partition, then you can "
353 #: ../src/guestfs.pod:167
356 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
361 #: ../src/guestfs.pod:169
363 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
364 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
365 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>)."
369 #: ../src/guestfs.pod:173
371 "If you are given a disk image and you don't know what it contains then you "
372 "have to find out. Libguestfs can do that too: use "
373 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
374 "and LVs, and either try mounting each to see what is mountable, or else "
375 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. Libguestfs also "
376 "has a set of APIs for inspection of disk images (see L</INSPECTION> below). "
377 "But you might find it easier to look at higher level programs built on top "
378 "of libguestfs, in particular L<virt-inspector(1)>."
382 #: ../src/guestfs.pod:183
384 "To mount a disk image read-only, use L</guestfs_mount_ro>. There are "
385 "several other variations of the C<guestfs_mount_*> call."
389 #: ../src/guestfs.pod:186
390 msgid "FILESYSTEM ACCESS AND MODIFICATION"
394 #: ../src/guestfs.pod:188
396 "The majority of the libguestfs API consists of fairly low-level calls for "
397 "accessing and modifying the files, directories, symlinks etc on mounted "
398 "filesystems. There are over a hundred such calls which you can find listed "
399 "in detail below in this man page, and we don't even pretend to cover them "
400 "all in this overview."
404 #: ../src/guestfs.pod:194
406 "Specify filenames as full paths, starting with C<\"/\"> and including the "
411 #: ../src/guestfs.pod:197
413 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
414 "the file called C<\"etc/passwd\"> then you could do:"
418 #: ../src/guestfs.pod:200
421 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
426 #: ../src/guestfs.pod:202
428 "This would return C<data> as a newly allocated buffer containing the full "
429 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
430 "or C<NULL> if there was an error."
434 #: ../src/guestfs.pod:206
436 "As another example, to create a top-level directory on that filesystem "
437 "called C<\"var\"> you would do:"
441 #: ../src/guestfs.pod:209
444 " guestfs_mkdir (g, \"/var\");\n"
449 #: ../src/guestfs.pod:211
450 msgid "To create a symlink you could do:"
454 #: ../src/guestfs.pod:213
457 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
458 " \"/etc/rc3.d/S30portmap\");\n"
463 #: ../src/guestfs.pod:216
465 "Libguestfs will reject attempts to use relative paths and there is no "
466 "concept of a current working directory."
470 #: ../src/guestfs.pod:219
472 "Libguestfs can return errors in many situations: for example if the "
473 "filesystem isn't writable, or if a file or directory that you requested "
474 "doesn't exist. If you are using the C API (documented here) you have to "
475 "check for those error conditions after each call. (Other language bindings "
476 "turn these errors into exceptions)."
480 #: ../src/guestfs.pod:225
482 "File writes are affected by the per-handle umask, set by calling "
483 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
487 #: ../src/guestfs.pod:228
492 #: ../src/guestfs.pod:230
494 "Libguestfs contains API calls to read, create and modify partition tables on "
499 #: ../src/guestfs.pod:233
501 "In the common case where you want to create a single partition covering the "
502 "whole disk, you should use the L</guestfs_part_disk> call:"
506 #: ../src/guestfs.pod:237
509 " const char *parttype = \"mbr\";\n"
510 " if (disk_is_larger_than_2TB)\n"
511 " parttype = \"gpt\";\n"
512 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
517 #: ../src/guestfs.pod:242
519 "Obviously this effectively wipes anything that was on that disk image "
524 #: ../src/guestfs.pod:245
529 #: ../src/guestfs.pod:247
531 "Libguestfs provides access to a large part of the LVM2 API, such as "
532 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
533 "unless you familiarize yourself with the concepts of physical volumes, "
534 "volume groups and logical volumes."
538 #: ../src/guestfs.pod:252
540 "This author strongly recommends reading the LVM HOWTO, online at "
541 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
545 #: ../src/guestfs.pod:255
550 #: ../src/guestfs.pod:257
552 "Use L</guestfs_cat> to download small, text only files. This call is "
553 "limited to files which are less than 2 MB and which cannot contain any ASCII "
554 "NUL (C<\\0>) characters. However it has a very simple to use API."
558 #: ../src/guestfs.pod:262
560 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
561 "bit data, since it returns a (pointer, size) pair. However it is still "
562 "limited to \"small\" files, less than 2 MB."
566 #: ../src/guestfs.pod:266
568 "L</guestfs_download> can be used to download any file, with no limits on "
569 "content or size (even files larger than 4 GB)."
573 #: ../src/guestfs.pod:269
574 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
578 #: ../src/guestfs.pod:272
583 #: ../src/guestfs.pod:274
585 "It's often the case that you want to write a file or files to the disk "
590 #: ../src/guestfs.pod:277
592 "To write a small file with fixed content, use L</guestfs_write>. To create "
593 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
594 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
595 "variety of other functions for creating test files, for example "
596 "L</guestfs_fill> and L</guestfs_fill_pattern>."
600 #: ../src/guestfs.pod:283
602 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
603 "file content or size (even files larger than 4 GB)."
607 #: ../src/guestfs.pod:286
608 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
612 #: ../src/guestfs.pod:288
614 "However the fastest way to upload I<large numbers of arbitrary files> is to "
615 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
616 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
617 "the drive in a predictable way (eg. adding it last after all other drives) "
618 "then you can get the device name from L</guestfs_list_devices> and mount it "
619 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
620 "sometimes non-portable between kernel versions, and they don't support "
621 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
622 "using a label or UUID, use an ISO image instead."
626 #: ../src/guestfs.pod:299
631 #: ../src/guestfs.pod:301
633 "There are various different commands for copying between files and devices "
634 "and in and out of the guest filesystem. These are summarised in the table "
639 #: ../src/guestfs.pod:307
640 msgid "B<file> to B<file>"
644 #: ../src/guestfs.pod:309
646 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
647 "directories recursively."
651 #: ../src/guestfs.pod:312
652 msgid "B<file or device> to B<file or device>"
656 #: ../src/guestfs.pod:314
658 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
659 "devices in the guest."
663 #: ../src/guestfs.pod:317
664 msgid "Example: duplicate the contents of an LV:"
668 #: ../src/guestfs.pod:319
671 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
676 #: ../src/guestfs.pod:321
678 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
679 "(C</dev/VG/Original>). To copy less than the whole source device, use "
680 "L</guestfs_copy_size>."
684 #: ../src/guestfs.pod:325
685 msgid "B<file on the host> to B<file or device>"
689 #: ../src/guestfs.pod:327
690 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
694 #: ../src/guestfs.pod:329
695 msgid "B<file or device> to B<file on the host>"
699 #: ../src/guestfs.pod:331
700 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
704 #: ../src/guestfs.pod:335
705 msgid "LISTING FILES"
709 #: ../src/guestfs.pod:337
711 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
712 "L<guestfish(1)>-equivalent command C<ll>)."
716 #: ../src/guestfs.pod:340
718 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
719 "programs, as a flat list of strings."
723 #: ../src/guestfs.pod:343
725 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
726 "directory, plus additional information about each one. It is more "
727 "equivalent to using the L<readdir(3)> call on a local filesystem."
731 #: ../src/guestfs.pod:347
733 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
738 #: ../src/guestfs.pod:350
739 msgid "RUNNING COMMANDS"
743 #: ../src/guestfs.pod:352
745 "Although libguestfs is primarily an API for manipulating files inside guest "
746 "images, we also provide some limited facilities for running commands inside "
751 #: ../src/guestfs.pod:356
752 msgid "There are many limitations to this:"
756 #: ../src/guestfs.pod:360 ../src/guestfs.pod:365 ../src/guestfs.pod:370 ../src/guestfs.pod:374 ../src/guestfs.pod:379 ../src/guestfs.pod:383 ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:1224 ../src/guestfs.pod:1229 ../src/guestfs.pod:1233 ../src/guestfs.pod:1449 ../src/guestfs.pod:1454 ../src/guestfs.pod:1458 ../src/guestfs.pod:1560 ../src/guestfs.pod:1564 ../src/guestfs.pod:1568 ../src/guestfs.pod:1573 ../src/guestfs.pod:1581 ../src/guestfs.pod:1600 ../src/guestfs.pod:1608 ../src/guestfs.pod:1838 ../src/guestfs.pod:1844 ../src/guestfs.pod:1849 ../src/guestfs.pod:1855 ../src/guestfs.pod:1962 ../src/guestfs.pod:1966 ../src/guestfs.pod:1970 ../src/guestfs.pod:1974 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:516 ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:1558 ../src/guestfs-actions.pod:1562 ../src/guestfs-actions.pod:1566 ../src/guestfs-actions.pod:1570 ../src/guestfs-actions.pod:1578 ../src/guestfs-actions.pod:1582 ../src/guestfs-actions.pod:1586 ../src/guestfs-actions.pod:1596 ../src/guestfs-actions.pod:1600 ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1742 ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:1751 ../src/guestfs-actions.pod:1756 ../src/guestfs-actions.pod:1817 ../src/guestfs-actions.pod:1821 ../src/guestfs-actions.pod:1826 ../fish/guestfish.pod:376 ../fish/guestfish.pod:380 ../fish/guestfish.pod:384 ../fish/guestfish.pod:388 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:339 ../fish/guestfish-actions.pod:347 ../fish/guestfish-actions.pod:354 ../fish/guestfish-actions.pod:361 ../fish/guestfish-actions.pod:1056 ../fish/guestfish-actions.pod:1060 ../fish/guestfish-actions.pod:1064 ../fish/guestfish-actions.pod:1068 ../fish/guestfish-actions.pod:1076 ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084 ../fish/guestfish-actions.pod:1094 ../fish/guestfish-actions.pod:1098 ../fish/guestfish-actions.pod:1102 ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1196 ../fish/guestfish-actions.pod:1201 ../fish/guestfish-actions.pod:1206 ../fish/guestfish-actions.pod:1248 ../fish/guestfish-actions.pod:1252 ../fish/guestfish-actions.pod:1257 ../inspector/virt-inspector.pl:584 ../inspector/virt-inspector.pl:588 ../tools/virt-df.pl:161 ../tools/virt-df.pl:167 ../tools/virt-resize.pl:348 ../tools/virt-resize.pl:353 ../tools/virt-resize.pl:363
761 #: ../src/guestfs.pod:362
763 "The kernel version that the command runs under will be different from what "
768 #: ../src/guestfs.pod:367
770 "If the command needs to communicate with daemons, then most likely they "
775 #: ../src/guestfs.pod:372
776 msgid "The command will be running in limited memory."
780 #: ../src/guestfs.pod:376
782 "The network may not be available unless you enable it (see "
783 "L</guestfs_set_network>)."
787 #: ../src/guestfs.pod:381
788 msgid "Only supports Linux guests (not Windows, BSD, etc)."
792 #: ../src/guestfs.pod:385
793 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
797 #: ../src/guestfs.pod:390
799 "For SELinux guests, you may need to enable SELinux and load policy first. "
800 "See L</SELINUX> in this manpage."
804 #: ../src/guestfs.pod:395
806 "I<Security:> It is not safe to run commands from untrusted, possibly "
807 "malicious guests. These commands may attempt to exploit your program by "
808 "sending unexpected output. They could also try to exploit the Linux kernel "
809 "or qemu provided by the libguestfs appliance. They could use the network "
810 "provided by the libguestfs appliance to bypass ordinary network partitions "
811 "and firewalls. They could use the elevated privileges or different SELinux "
812 "context of your program to their advantage."
816 #: ../src/guestfs.pod:404
818 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
819 "(a script which runs when the guest next boots normally), and to have this "
820 "script run the commands you want in the normal context of the running guest, "
821 "network security and so on."
825 #: ../src/guestfs.pod:411
827 "The two main API calls to run commands are L</guestfs_command> and "
828 "L</guestfs_sh> (there are also variations)."
832 #: ../src/guestfs.pod:414
834 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
835 "shell globs, redirections, etc will work."
839 #: ../src/guestfs.pod:417
840 msgid "CONFIGURATION FILES"
844 #: ../src/guestfs.pod:419
846 "To read and write configuration files in Linux guest filesystems, we "
847 "strongly recommend using Augeas. For example, Augeas understands how to "
848 "read and write, say, a Linux shadow password file or X.org configuration "
849 "file, and so avoids you having to write that code."
853 #: ../src/guestfs.pod:424
855 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
856 "document Augeas itself here because there is excellent documentation on the "
857 "L<http://augeas.net/> website."
861 #: ../src/guestfs.pod:428
863 "If you don't want to use Augeas (you fool!) then try calling "
864 "L</guestfs_read_lines> to get the file as a list of lines which you can "
869 #: ../src/guestfs.pod:432
874 #: ../src/guestfs.pod:434
876 "We support SELinux guests. To ensure that labeling happens correctly in "
877 "SELinux guests, you need to enable SELinux and load the guest's policy:"
881 #: ../src/guestfs.pod:440 ../src/guestfs.pod:953
886 #: ../src/guestfs.pod:442
887 msgid "Before launching, do:"
891 #: ../src/guestfs.pod:444
894 " guestfs_set_selinux (g, 1);\n"
899 #: ../src/guestfs.pod:446 ../src/guestfs.pod:957
904 #: ../src/guestfs.pod:448
906 "After mounting the guest's filesystem(s), load the policy. This is best "
907 "done by running the L<load_policy(8)> command in the guest itself:"
911 #: ../src/guestfs.pod:452
914 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
919 #: ../src/guestfs.pod:454
921 "(Older versions of C<load_policy> require you to specify the name of the "
926 #: ../src/guestfs.pod:457 ../src/guestfs.pod:963
931 #: ../src/guestfs.pod:459
933 "Optionally, set the security context for the API. The correct security "
934 "context to use can only be known by inspecting the guest. As an example:"
938 #: ../src/guestfs.pod:463
941 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
946 #: ../src/guestfs.pod:467
947 msgid "This will work for running commands and editing existing files."
951 #: ../src/guestfs.pod:469
953 "When new files are created, you may need to label them explicitly, for "
954 "example by running the external command C<restorecon pathname>."
958 #: ../src/guestfs.pod:473
963 #: ../src/guestfs.pod:475
965 "Certain calls are affected by the current file mode creation mask (the "
966 "\"umask\"). In particular ones which create files or directories, such as "
967 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
968 "either the default mode that the file is created with or modifies the mode "
973 #: ../src/guestfs.pod:481
975 "The default umask is C<022>, so files are created with modes such as C<0644> "
976 "and directories with C<0755>."
980 #: ../src/guestfs.pod:484
982 "There are two ways to avoid being affected by umask. Either set umask to 0 "
983 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
984 "L</guestfs_chmod> after creating each file or directory."
988 #: ../src/guestfs.pod:488
989 msgid "For more information about umask, see L<umask(2)>."
993 #: ../src/guestfs.pod:490 ../fish/guestfish.pod:669
994 msgid "ENCRYPTED DISKS"
998 #: ../src/guestfs.pod:492
1000 "Libguestfs allows you to access Linux guests which have been encrypted using "
1001 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1002 "standard. This includes nearly all whole disk encryption systems used by "
1003 "modern Linux guests."
1007 #: ../src/guestfs.pod:498
1009 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1010 "returns the string C<crypto_LUKS>)."
1014 #: ../src/guestfs.pod:501
1016 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1017 "will require the passphrase!"
1021 #: ../src/guestfs.pod:504
1023 "Opening a LUKS device creates a new device mapper device called "
1024 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1025 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
1026 "decrypted from and encrypted to the underlying block device respectively."
1030 #: ../src/guestfs.pod:510
1032 "LVM volume groups on the device can be made visible by calling "
1033 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
1034 "volume(s) can now be mounted in the usual way."
1038 #: ../src/guestfs.pod:514
1040 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1041 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1042 "[\"/dev/VG\"])>. Then close the mapper device by calling "
1043 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1044 "underlying encrypted block device)."
1048 #: ../src/guestfs.pod:521
1053 #: ../src/guestfs.pod:523
1055 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1056 "contains operating systems. (These APIs used to be in a separate Perl-only "
1057 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1058 "frequently used part of this library has been rewritten in C and moved into "
1063 #: ../src/guestfs.pod:529
1065 "Add all disks belonging to the unknown virtual machine and call "
1066 "L</guestfs_launch> in the usual way."
1070 #: ../src/guestfs.pod:532
1072 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1073 "and certain heuristics, and returns a list of operating systems that were "
1074 "found. An empty list means none were found. A single element is the root "
1075 "filesystem of the operating system. For dual- or multi-boot guests, "
1076 "multiple roots can be returned, each one corresponding to a separate "
1077 "operating system. (Multi-boot virtual machines are extremely rare in the "
1078 "world of virtualization, but since this scenario can happen, we have built "
1079 "libguestfs to deal with it.)"
1083 #: ../src/guestfs.pod:541
1085 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1086 "to get additional details about that operating system. For example, call "
1087 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1088 "Windows and Linux-based operating systems respectively."
1092 #: ../src/guestfs.pod:547
1094 "Un*x-like and Linux-based operating systems usually consist of several "
1095 "filesystems which are mounted at boot time (for example, a separate boot "
1096 "partition mounted on C</boot>). The inspection rules are able to detect how "
1097 "filesystems correspond to mount points. Call "
1098 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1099 "hash table like this example:"
1103 #: ../src/guestfs.pod:554
1106 " /boot => /dev/sda1\n"
1107 " / => /dev/vg_guest/lv_root\n"
1108 " /usr => /dev/vg_guest/lv_usr\n"
1113 #: ../src/guestfs.pod:558
1115 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1116 "filesystems as suggested."
1120 #: ../src/guestfs.pod:561
1122 "Be careful to mount filesystems in the right order (eg. C</> before "
1123 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
1128 #: ../src/guestfs.pod:565
1130 "Inspection currently only works for some common operating systems. "
1131 "Contributors are welcome to send patches for other operating systems that we "
1132 "currently cannot detect."
1136 #: ../src/guestfs.pod:569
1138 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1139 "for more details. The L</guestfs_inspect_os> function just ignores any "
1140 "encrypted devices."
1144 #: ../src/guestfs.pod:573
1146 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1147 "inspection and caches the results in the guest handle. Subsequent calls to "
1148 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
1149 "re-read the disks. If you change the content of the guest disks, you can "
1150 "redo inspection by calling L</guestfs_inspect_os> again."
1154 #: ../src/guestfs.pod:580
1155 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1159 #: ../src/guestfs.pod:582
1161 "Libguestfs can mount NTFS partitions. It does this using the "
1162 "L<http://www.ntfs-3g.org/> driver."
1166 #: ../src/guestfs.pod:585
1168 "DOS and Windows still use drive letters, and the filesystems are always "
1169 "treated as case insensitive by Windows itself, and therefore you might find "
1170 "a Windows configuration file referring to a path like "
1171 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1172 "that directory might be referred to as C</WINDOWS/System32>."
1176 #: ../src/guestfs.pod:591
1178 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1179 "libguestfs to read the appropriate Windows Registry and configuration files, "
1180 "to determine yourself how drives are mapped (see also L<hivex(3)> and "
1181 "L<virt-inspector(1)>)."
1185 #: ../src/guestfs.pod:596
1187 "Replacing backslash characters with forward slash characters is also outside "
1188 "the scope of libguestfs, but something that you can easily do."
1192 #: ../src/guestfs.pod:599
1194 "Where we can help is in resolving the case insensitivity of paths. For "
1195 "this, call L</guestfs_case_sensitive_path>."
1199 #: ../src/guestfs.pod:602
1201 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1202 "files, through the library C<hivex> which is part of the libguestfs project "
1203 "although ships as a separate tarball. You have to locate and download the "
1204 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1205 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1206 "L<virt-win-reg(1)> for more help on this issue."
1210 #: ../src/guestfs.pod:610
1211 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1215 #: ../src/guestfs.pod:612
1217 "Although we don't want to discourage you from using the C API, we will "
1218 "mention here that the same API is also available in other languages."
1222 #: ../src/guestfs.pod:615
1224 "The API is broadly identical in all supported languages. This means that "
1225 "the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, "
1226 "C<g.mount(path)> in Python, and C<Guestfs.mount g path> in OCaml. In other "
1227 "words, a straightforward, predictable isomorphism between each language."
1231 #: ../src/guestfs.pod:621
1233 "Error messages are automatically transformed into exceptions if the language "
1238 #: ../src/guestfs.pod:624
1240 "We don't try to \"object orientify\" parts of the API in OO languages, "
1241 "although contributors are welcome to write higher level APIs above what we "
1242 "provide in their favourite languages if they wish."
1246 #: ../src/guestfs.pod:630
1251 #: ../src/guestfs.pod:632
1253 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1254 "identical to the C API. C++ classes and exceptions are not used."
1258 #: ../src/guestfs.pod:636
1263 #: ../src/guestfs.pod:638
1265 "The C# bindings are highly experimental. Please read the warnings at the "
1266 "top of C<csharp/Libguestfs.cs>."
1270 #: ../src/guestfs.pod:641
1275 #: ../src/guestfs.pod:643
1277 "This is the only language binding that is working but incomplete. Only "
1278 "calls which return simple integers have been bound in Haskell, and we are "
1279 "looking for help to complete this binding."
1283 #: ../src/guestfs.pod:647
1288 #: ../src/guestfs.pod:649
1290 "Full documentation is contained in the Javadoc which is distributed with "
1295 #: ../src/guestfs.pod:652
1300 #: ../src/guestfs.pod:654
1301 msgid "For documentation see the file C<guestfs.mli>."
1305 #: ../src/guestfs.pod:656
1310 #: ../src/guestfs.pod:658
1311 msgid "For documentation see L<Sys::Guestfs(3)>."
1315 #: ../src/guestfs.pod:660
1320 #: ../src/guestfs.pod:662
1322 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1323 "the php-libguestfs package for your distribution."
1327 #: ../src/guestfs.pod:665
1328 msgid "The PHP binding only works correctly on 64 bit machines."
1332 #: ../src/guestfs.pod:667
1337 #: ../src/guestfs.pod:669
1338 msgid "For documentation do:"
1342 #: ../src/guestfs.pod:671
1346 " >>> import guestfs\n"
1347 " >>> help (guestfs)\n"
1352 #: ../src/guestfs.pod:675
1357 #: ../src/guestfs.pod:677
1359 "Use the Guestfs module. There is no Ruby-specific documentation, but you "
1360 "can find examples written in Ruby in the libguestfs source."
1364 #: ../src/guestfs.pod:680
1365 msgid "B<shell scripts>"
1369 #: ../src/guestfs.pod:682
1370 msgid "For documentation see L<guestfish(1)>."
1374 #: ../src/guestfs.pod:686
1375 msgid "LIBGUESTFS GOTCHAS"
1379 #: ../src/guestfs.pod:688
1381 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1382 "system [...] that works in the way it is documented but is counterintuitive "
1383 "and almost invites mistakes.\""
1387 #: ../src/guestfs.pod:692
1389 "Since we developed libguestfs and the associated tools, there are several "
1390 "things we would have designed differently, but are now stuck with for "
1391 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1392 "release, you can expect these to change. Beware of them."
1396 #: ../src/guestfs.pod:700
1397 msgid "Autosync / forgetting to sync."
1401 #: ../src/guestfs.pod:702
1403 "When modifying a filesystem from C or another language, you B<must> unmount "
1404 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1405 "libguestfs handle. You can also call:"
1409 #: ../src/guestfs.pod:706
1412 " guestfs_set_autosync (g, 1);\n"
1417 #: ../src/guestfs.pod:708
1419 "to have the unmount/sync done automatically for you when the handle 'g' is "
1420 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1425 #: ../src/guestfs.pod:712
1427 "If you forget to do this, then it is entirely possible that your changes "
1428 "won't be written out, or will be partially written, or (very rarely) that "
1429 "you'll get disk corruption."
1433 #: ../src/guestfs.pod:716
1435 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1436 "guestfish scripts that forget to sync will work just fine, which can make "
1437 "this very puzzling if you are trying to debug a problem."
1441 #: ../src/guestfs.pod:720
1443 "Update: Autosync is enabled by default for all API users starting from "
1444 "libguestfs 1.5.24."
1448 #: ../src/guestfs.pod:723
1449 msgid "Mount option C<-o sync> should not be the default."
1453 #: ../src/guestfs.pod:725
1455 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1456 "However C<-o sync> does not add any reliability benefit, but does have a "
1457 "very large performance impact."
1461 #: ../src/guestfs.pod:729
1463 "The work around is to use L</guestfs_mount_options> and set the mount "
1464 "options that you actually want to use."
1468 #: ../src/guestfs.pod:732
1469 msgid "Read-only should be the default."
1473 #: ../src/guestfs.pod:734
1475 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1476 "specify I<--rw> if you want to make changes to the image."
1480 #: ../src/guestfs.pod:737
1481 msgid "This would reduce the potential to corrupt live VM images."
1485 #: ../src/guestfs.pod:739
1487 "Note that many filesystems change the disk when you just mount and unmount, "
1488 "even if you didn't perform any writes. You need to use "
1489 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1493 #: ../src/guestfs.pod:743
1494 msgid "guestfish command line is hard to use."
1498 #: ../src/guestfs.pod:745
1500 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1501 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1502 "exist, so it fails. In earlier versions of guestfish the error message was "
1503 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1504 "we should have used C<guestfish -c command> to run commands."
1508 #: ../src/guestfs.pod:752
1509 msgid "guestfish megabyte modifiers don't work right on all commands"
1513 #: ../src/guestfs.pod:754
1515 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1516 "other modifiers). What guestfish actually does is to multiply the number "
1517 "part by the modifier part and pass the result to the C API. However this "
1518 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1519 "expecting some other unit (eg. megabytes)."
1523 #: ../src/guestfs.pod:761
1524 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1528 #: ../src/guestfs.pod:763
1531 " lvcreate LV VG 100M\n"
1536 #: ../src/guestfs.pod:765
1538 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1539 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1540 "megabytes * megabytes) logical volume. The error message you get from this "
1541 "is also a little obscure."
1545 #: ../src/guestfs.pod:770
1547 "This could be fixed in the generator by specially marking parameters and "
1548 "return values which take bytes or other units."
1552 #: ../src/guestfs.pod:773
1553 msgid "Ambiguity between devices and paths"
1557 #: ../src/guestfs.pod:775
1559 "There is a subtle ambiguity in the API between a device name "
1560 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1561 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1565 #: ../src/guestfs.pod:780
1567 "In the current API we usually resolve this ambiguity by having two separate "
1568 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1569 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1570 "detecting if the path supplied begins with C</dev/>."
1574 #: ../src/guestfs.pod:786
1576 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1577 "make paths/devices into structured names. One way to do this would be to "
1578 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1579 "aspect of grub. Another way would be to use a structured type, equivalent "
1580 "to this OCaml type:"
1584 #: ../src/guestfs.pod:792
1587 " type path = Path of string | Device of int | Partition of int * int\n"
1592 #: ../src/guestfs.pod:794
1593 msgid "which would allow you to pass arguments like:"
1597 #: ../src/guestfs.pod:796
1600 " Path \"/foo/bar\"\n"
1601 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1602 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1603 " Path \"/dev/sdb2\" (* not a device *)\n"
1608 #: ../src/guestfs.pod:801
1610 "As you can see there are still problems to resolve even with this "
1611 "representation. Also consider how it might work in guestfish."
1615 #: ../src/guestfs.pod:806
1616 msgid "PROTOCOL LIMITS"
1620 #: ../src/guestfs.pod:808
1622 "Internally libguestfs uses a message-based protocol to pass API calls and "
1623 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1624 "plenty more detail about this). The maximum message size used by the "
1625 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1626 "aware of this limit. The API calls which may be affected are individually "
1627 "documented, with a link back to this section of the documentation."
1631 #: ../src/guestfs.pod:816
1633 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1634 "a simple string. Because this string is at some point internally encoded as "
1635 "a message, the maximum size that it can return is slightly under 4 MB. If "
1636 "the requested file is larger than this then you will get an error."
1640 #: ../src/guestfs.pod:822
1642 "In order to transfer large files into and out of the guest filesystem, you "
1643 "need to use particular calls that support this. The sections L</UPLOADING> "
1644 "and L</DOWNLOADING> document how to do this."
1648 #: ../src/guestfs.pod:826
1650 "You might also consider mounting the disk image using our FUSE filesystem "
1651 "support (L<guestmount(1)>)."
1655 #: ../src/guestfs.pod:829
1656 msgid "KEYS AND PASSPHRASES"
1660 #: ../src/guestfs.pod:831
1662 "Certain libguestfs calls take a parameter that contains sensitive key "
1663 "material, passed in as a C string."
1667 #: ../src/guestfs.pod:834
1669 "In the future we would hope to change the libguestfs implementation so that "
1670 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1671 "swap. However this is I<not> done at the moment, because of the complexity "
1672 "of such an implementation."
1676 #: ../src/guestfs.pod:839
1678 "Therefore you should be aware that any key parameter you pass to libguestfs "
1679 "might end up being written out to the swap partition. If this is a concern, "
1680 "scrub the swap partition or don't use libguestfs on encrypted devices."
1684 #: ../src/guestfs.pod:844
1685 msgid "CONNECTION MANAGEMENT"
1689 #: ../src/guestfs.pod:846
1694 #: ../src/guestfs.pod:848
1696 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
1697 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
1698 "handle and release all resources used."
1702 #: ../src/guestfs.pod:852
1704 "For information on using multiple handles and threads, see the section "
1705 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
1709 #: ../src/guestfs.pod:855
1710 msgid "guestfs_create"
1714 #: ../src/guestfs.pod:857
1717 " guestfs_h *guestfs_create (void);\n"
1722 #: ../src/guestfs.pod:859
1723 msgid "Create a connection handle."
1727 #: ../src/guestfs.pod:861
1729 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
1730 "on the handle at least once."
1734 #: ../src/guestfs.pod:864
1736 "This function returns a non-NULL pointer to a handle on success or NULL on "
1741 #: ../src/guestfs.pod:867
1742 msgid "After configuring the handle, you have to call L</guestfs_launch>."
1746 #: ../src/guestfs.pod:869
1748 "You may also want to configure error handling for the handle. See L</ERROR "
1749 "HANDLING> section below."
1753 #: ../src/guestfs.pod:872
1754 msgid "guestfs_close"
1758 #: ../src/guestfs.pod:874
1761 " void guestfs_close (guestfs_h *g);\n"
1766 #: ../src/guestfs.pod:876
1767 msgid "This closes the connection handle and frees up all resources used."
1771 #: ../src/guestfs.pod:878
1772 msgid "ERROR HANDLING"
1776 #: ../src/guestfs.pod:880
1778 "API functions can return errors. For example, almost all functions that "
1779 "return C<int> will return C<-1> to indicate an error."
1783 #: ../src/guestfs.pod:883
1785 "Additional information is available for errors: an error message string and "
1786 "optionally an error number (errno) if the thing that failed was a system "
1791 #: ../src/guestfs.pod:887
1793 "You can get at the additional information about the last error on the handle "
1794 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
1795 "up an error handler with L</guestfs_set_error_handler>."
1799 #: ../src/guestfs.pod:892
1801 "When the handle is created, a default error handler is installed which "
1802 "prints the error message string to C<stderr>. For small short-running "
1803 "command line programs it is sufficient to do:"
1807 #: ../src/guestfs.pod:896
1810 " if (guestfs_launch (g) == -1)\n"
1811 " exit (EXIT_FAILURE);\n"
1816 #: ../src/guestfs.pod:899
1818 "since the default error handler will ensure that an error message has been "
1819 "printed to C<stderr> before the program exits."
1823 #: ../src/guestfs.pod:902
1825 "For other programs the caller will almost certainly want to install an "
1826 "alternate error handler or do error handling in-line like this:"
1830 #: ../src/guestfs.pod:905
1833 " g = guestfs_create ();\n"
1838 #: ../src/guestfs.pod:907
1841 " /* This disables the default behaviour of printing errors\n"
1843 " guestfs_set_error_handler (g, NULL, NULL);\n"
1848 #: ../src/guestfs.pod:911
1851 " if (guestfs_launch (g) == -1) {\n"
1852 " /* Examine the error message and print it etc. */\n"
1853 " char *msg = guestfs_last_error (g);\n"
1854 " int errnum = guestfs_last_errno (g);\n"
1855 " fprintf (stderr, \"%s\\n\", msg);\n"
1862 #: ../src/guestfs.pod:919
1864 "Out of memory errors are handled differently. The default action is to call "
1865 "L<abort(3)>. If this is undesirable, then you can set a handler using "
1866 "L</guestfs_set_out_of_memory_handler>."
1870 #: ../src/guestfs.pod:923
1872 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
1873 "because there is no handle if this happens there is no way to get additional "
1874 "error information. However L</guestfs_create> is supposed to be a "
1875 "lightweight operation which can only fail because of insufficient memory (it "
1876 "returns NULL in this case)."
1880 #: ../src/guestfs.pod:929
1881 msgid "guestfs_last_error"
1885 #: ../src/guestfs.pod:931
1888 " const char *guestfs_last_error (guestfs_h *g);\n"
1893 #: ../src/guestfs.pod:933
1895 "This returns the last error message that happened on C<g>. If there has not "
1896 "been an error since the handle was created, then this returns C<NULL>."
1900 #: ../src/guestfs.pod:937
1902 "The lifetime of the returned string is until the next error occurs, or "
1903 "L</guestfs_close> is called."
1907 #: ../src/guestfs.pod:940
1908 msgid "guestfs_last_errno"
1912 #: ../src/guestfs.pod:942
1915 " int guestfs_last_errno (guestfs_h *g);\n"
1920 #: ../src/guestfs.pod:944
1921 msgid "This returns the last error number (errno) that happened on C<g>."
1925 #: ../src/guestfs.pod:946
1926 msgid "If successful, an errno integer not equal to zero is returned."
1930 #: ../src/guestfs.pod:948
1931 msgid "If no error, this returns 0. This call can return 0 in three situations:"
1935 #: ../src/guestfs.pod:955
1936 msgid "There has not been any error on the handle."
1940 #: ../src/guestfs.pod:959
1942 "There has been an error but the errno was meaningless. This corresponds to "
1943 "the case where the error did not come from a failed system call, but for "
1944 "some other reason."
1948 #: ../src/guestfs.pod:965
1950 "There was an error from a failed system call, but for some reason the errno "
1951 "was not captured and returned. This usually indicates a bug in libguestfs."
1955 #: ../src/guestfs.pod:971
1957 "Libguestfs tries to convert the errno from inside the applicance into a "
1958 "corresponding errno for the caller (not entirely trivial: the appliance "
1959 "might be running a completely different operating system from the library "
1960 "and error numbers are not standardized across Un*xen). If this could not be "
1961 "done, then the error is translated to C<EINVAL>. In practice this should "
1962 "only happen in very rare circumstances."
1966 #: ../src/guestfs.pod:979
1967 msgid "guestfs_set_error_handler"
1971 #: ../src/guestfs.pod:981
1974 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
1976 " const char *msg);\n"
1977 " void guestfs_set_error_handler (guestfs_h *g,\n"
1978 " guestfs_error_handler_cb cb,\n"
1984 #: ../src/guestfs.pod:988
1986 "The callback C<cb> will be called if there is an error. The parameters "
1987 "passed to the callback are an opaque data pointer and the error message "
1992 #: ../src/guestfs.pod:992
1994 "C<errno> is not passed to the callback. To get that the callback must call "
1995 "L</guestfs_last_errno>."
1999 #: ../src/guestfs.pod:995
2001 "Note that the message string C<msg> is freed as soon as the callback "
2002 "function returns, so if you want to stash it somewhere you must make your "
2007 #: ../src/guestfs.pod:999
2008 msgid "The default handler prints messages on C<stderr>."
2012 #: ../src/guestfs.pod:1001
2013 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2017 #: ../src/guestfs.pod:1003
2018 msgid "guestfs_get_error_handler"
2022 #: ../src/guestfs.pod:1005
2025 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2026 " void **opaque_rtn);\n"
2031 #: ../src/guestfs.pod:1008
2032 msgid "Returns the current error handler callback."
2036 #: ../src/guestfs.pod:1010
2037 msgid "guestfs_set_out_of_memory_handler"
2041 #: ../src/guestfs.pod:1012
2044 " typedef void (*guestfs_abort_cb) (void);\n"
2045 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2046 " guestfs_abort_cb);\n"
2051 #: ../src/guestfs.pod:1016
2053 "The callback C<cb> will be called if there is an out of memory situation. "
2054 "I<Note this callback must not return>."
2058 #: ../src/guestfs.pod:1019
2059 msgid "The default is to call L<abort(3)>."
2063 #: ../src/guestfs.pod:1021
2064 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2068 #: ../src/guestfs.pod:1024
2069 msgid "guestfs_get_out_of_memory_handler"
2073 #: ../src/guestfs.pod:1026
2076 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2081 #: ../src/guestfs.pod:1028
2082 msgid "This returns the current out of memory handler."
2086 #: ../src/guestfs.pod:1030
2091 #: ../src/guestfs.pod:1032
2093 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
2098 #: ../src/guestfs.pod:1035
2100 "By default it looks for these in the directory C<$libdir/guestfs> "
2101 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2105 #: ../src/guestfs.pod:1038
2107 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2108 "to change the directories that libguestfs will search in. The value is a "
2109 "colon-separated list of paths. The current directory is I<not> searched "
2110 "unless the path contains an empty element or C<.>. For example "
2111 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2112 "then C</usr/lib/guestfs>."
2116 #: ../src/guestfs.pod:1045
2117 msgid "HIGH-LEVEL API ACTIONS"
2121 #: ../src/guestfs.pod:1047
2122 msgid "ABI GUARANTEE"
2126 #: ../src/guestfs.pod:1049
2128 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2129 "actions as outlined in this section. Although we will deprecate some "
2130 "actions, for example if they get replaced by newer calls, we will keep the "
2131 "old actions forever. This allows you the developer to program in confidence "
2132 "against the libguestfs API."
2136 #: ../src/guestfs.pod:1055 ../fish/guestfish.pod:907
2141 #: ../src/guestfs.pod:1057
2146 #: ../src/guestfs.pod:1059
2151 #: ../src/guestfs.pod:1061
2152 msgid "AVAILABILITY"
2156 #: ../src/guestfs.pod:1063
2157 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2161 #: ../src/guestfs.pod:1065
2163 "Using L</guestfs_available> you can test availability of the following "
2164 "groups of functions. This test queries the appliance to see if the "
2165 "appliance you are currently using supports the functionality."
2169 #: ../src/guestfs.pod:1070
2170 msgid "@AVAILABILITY@"
2174 #: ../src/guestfs.pod:1072
2175 msgid "GUESTFISH supported COMMAND"
2179 #: ../src/guestfs.pod:1074
2181 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2182 "prints out the available groups and whether they are supported by this build "
2183 "of libguestfs. Note however that you have to do C<run> first."
2187 #: ../src/guestfs.pod:1079
2188 msgid "SINGLE CALLS AT COMPILE TIME"
2192 #: ../src/guestfs.pod:1081
2194 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2195 "function, such as:"
2199 #: ../src/guestfs.pod:1084
2202 " #define LIBGUESTFS_HAVE_DD 1\n"
2207 #: ../src/guestfs.pod:1086
2208 msgid "if L</guestfs_dd> is available."
2212 #: ../src/guestfs.pod:1088
2214 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2215 "function is available at compile time, we recommended using build tools such "
2216 "as autoconf or cmake. For example in autotools you could use:"
2220 #: ../src/guestfs.pod:1093
2223 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2224 " AC_CHECK_FUNCS([guestfs_dd])\n"
2229 #: ../src/guestfs.pod:1096
2231 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2236 #: ../src/guestfs.pod:1099
2237 msgid "SINGLE CALLS AT RUN TIME"
2241 #: ../src/guestfs.pod:1101
2243 "Testing at compile time doesn't guarantee that a function really exists in "
2244 "the library. The reason is that you might be dynamically linked against a "
2245 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2246 "This situation unfortunately results in a segmentation fault, which is a "
2247 "shortcoming of the C dynamic linking system itself."
2251 #: ../src/guestfs.pod:1108
2253 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2254 "in this example program (note that you still need the compile time check as "
2259 #: ../src/guestfs.pod:1112
2262 " #include <stdio.h>\n"
2263 " #include <stdlib.h>\n"
2264 " #include <unistd.h>\n"
2265 " #include <dlfcn.h>\n"
2266 " #include <guestfs.h>\n"
2271 #: ../src/guestfs.pod:1118
2276 " #ifdef LIBGUESTFS_HAVE_DD\n"
2278 " int has_function;\n"
2283 #: ../src/guestfs.pod:1124
2286 " /* Test if the function guestfs_dd is really available. */\n"
2287 " dl = dlopen (NULL, RTLD_LAZY);\n"
2289 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2290 " exit (EXIT_FAILURE);\n"
2292 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2298 #: ../src/guestfs.pod:1133
2301 " if (!has_function)\n"
2302 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2304 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2305 " /* Now it's safe to call\n"
2306 " guestfs_dd (g, \"foo\", \"bar\");\n"
2310 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2317 #: ../src/guestfs.pod:1146
2319 "You may think the above is an awful lot of hassle, and it is. There are "
2320 "other ways outside of the C linking system to ensure that this kind of "
2321 "incompatibility never arises, such as using package versioning:"
2325 #: ../src/guestfs.pod:1151
2328 " Requires: libguestfs >= 1.0.80\n"
2333 #: ../src/guestfs.pod:1153
2334 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2338 #: ../src/guestfs.pod:1155
2340 "A recent feature of the API is the introduction of calls which take optional "
2341 "arguments. In C these are declared 3 ways. The main way is as a call which "
2342 "takes variable arguments (ie. C<...>), as in this example:"
2346 #: ../src/guestfs.pod:1160
2349 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2354 #: ../src/guestfs.pod:1162
2356 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2357 "call with no optional arguments specified:"
2361 #: ../src/guestfs.pod:1165
2364 " guestfs_add_drive_opts (g, filename, -1);\n"
2369 #: ../src/guestfs.pod:1167
2370 msgid "With a single optional argument:"
2374 #: ../src/guestfs.pod:1169
2377 " guestfs_add_drive_opts (g, filename,\n"
2378 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2384 #: ../src/guestfs.pod:1173
2389 #: ../src/guestfs.pod:1175
2392 " guestfs_add_drive_opts (g, filename,\n"
2393 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2394 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
2400 #: ../src/guestfs.pod:1180
2402 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
2407 #: ../src/guestfs.pod:1183
2408 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
2412 #: ../src/guestfs.pod:1185
2414 "The second variant has the same name with the suffix C<_va>, which works the "
2415 "same way but takes a C<va_list>. See the C manual for details. For the "
2416 "example function, this is declared:"
2420 #: ../src/guestfs.pod:1189
2423 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
2429 #: ../src/guestfs.pod:1192
2430 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
2434 #: ../src/guestfs.pod:1194
2436 "The third variant is useful where you need to construct these calls. You "
2437 "pass in a structure where you fill in the optional fields. The structure "
2438 "has a bitmask as the first element which you must set to indicate which "
2439 "fields you have filled in. For our example function the structure and call "
2444 #: ../src/guestfs.pod:1200
2447 " struct guestfs_add_drive_opts_argv {\n"
2448 " uint64_t bitmask;\n"
2450 " const char *format;\n"
2453 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
2454 " const struct guestfs_add_drive_opts_argv *optargs);\n"
2459 #: ../src/guestfs.pod:1209
2460 msgid "You could call it like this:"
2464 #: ../src/guestfs.pod:1211
2467 " struct guestfs_add_drive_opts_argv optargs = {\n"
2468 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
2469 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
2471 " .format = \"qcow2\"\n"
2477 #: ../src/guestfs.pod:1218
2480 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
2485 #: ../src/guestfs.pod:1220 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1813 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1244
2490 #: ../src/guestfs.pod:1226
2491 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
2495 #: ../src/guestfs.pod:1231
2496 msgid "You do not need to fill in all fields of the structure."
2500 #: ../src/guestfs.pod:1235
2502 "There must be a one-to-one correspondence between fields of the structure "
2503 "that are filled in, and bits set in the bitmask."
2507 #: ../src/guestfs.pod:1240
2508 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
2512 #: ../src/guestfs.pod:1242
2514 "In other languages, optional arguments are expressed in the way that is "
2515 "natural for that language. We refer you to the language-specific "
2516 "documentation for more details on that."
2520 #: ../src/guestfs.pod:1246
2521 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
2525 #: ../src/guestfs.pod:1248 ../src/guestfs.pod:1253
2530 #: ../src/guestfs.pod:1250
2532 "<!-- old anchor for the next section --> <a "
2533 "name=\"state_machine_and_low_level_event_api\"/>"
2537 #: ../src/guestfs.pod:1255
2538 msgid "ARCHITECTURE"
2542 #: ../src/guestfs.pod:1257
2544 "Internally, libguestfs is implemented by running an appliance (a special "
2545 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
2546 "process of the main program."
2550 #: ../src/guestfs.pod:1261
2553 " ___________________\n"
2555 " | main program |\n"
2557 " | | child process / appliance\n"
2558 " | | __________________________\n"
2560 " +-------------------+ RPC | +-----------------+ |\n"
2561 " | libguestfs <--------------------> guestfsd | |\n"
2562 " | | | +-----------------+ |\n"
2563 " \\___________________/ | | Linux kernel | |\n"
2564 " | +--^--------------+ |\n"
2565 " \\_________|________________/\n"
2571 " \\______________/\n"
2576 #: ../src/guestfs.pod:1281
2578 "The library, linked to the main program, creates the child process and hence "
2579 "the appliance in the L</guestfs_launch> function."
2583 #: ../src/guestfs.pod:1284
2585 "Inside the appliance is a Linux kernel and a complete stack of userspace "
2586 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
2587 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
2588 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
2589 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
2590 "attached to the qemu process which translates device access by the "
2591 "appliance's Linux kernel into accesses to the image."
2595 #: ../src/guestfs.pod:1293
2597 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
2598 "Although the disk image you are attached to might also be used by some "
2599 "virtual machine, libguestfs doesn't know or care about this. (But you will "
2600 "care if both libguestfs's qemu process and your virtual machine are trying "
2601 "to update the disk image at the same time, since these usually results in "
2602 "massive disk corruption)."
2606 #: ../src/guestfs.pod:1300
2607 msgid "STATE MACHINE"
2611 #: ../src/guestfs.pod:1302
2612 msgid "libguestfs uses a state machine to model the child process:"
2616 #: ../src/guestfs.pod:1304
2628 " / | \\ \\ guestfs_launch\n"
2629 " / | _\\__V______\n"
2631 " / | | LAUNCHING |\n"
2632 " / | \\___________/\n"
2634 " / | guestfs_launch\n"
2636 " ______ / __|____V\n"
2637 " / \\ ------> / \\\n"
2638 " | BUSY | | READY |\n"
2639 " \\______/ <------ \\________/\n"
2644 #: ../src/guestfs.pod:1326
2646 "The normal transitions are (1) CONFIG (when the handle is created, but there "
2647 "is no child process), (2) LAUNCHING (when the child process is booting up), "
2648 "(3) alternating between READY and BUSY as commands are issued to, and "
2649 "carried out by, the child process."
2653 #: ../src/guestfs.pod:1331
2655 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
2656 "asynchronously at any time (eg. due to some internal error), and that causes "
2657 "the state to transition back to CONFIG."
2661 #: ../src/guestfs.pod:1335
2663 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
2664 "issued when in the CONFIG state."
2668 #: ../src/guestfs.pod:1338
2670 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
2671 "L</guestfs_launch> blocks until the child process is READY to accept "
2672 "commands (or until some failure or timeout). L</guestfs_launch> internally "
2673 "moves the state from CONFIG to LAUNCHING while it is running."
2677 #: ../src/guestfs.pod:1344
2679 "API actions such as L</guestfs_mount> can only be issued when in the READY "
2680 "state. These API calls block waiting for the command to be carried out "
2681 "(ie. the state to transition to BUSY and then back to READY). There are no "
2682 "non-blocking versions, and no way to issue more than one command per handle "
2687 #: ../src/guestfs.pod:1350
2689 "Finally, the child process sends asynchronous messages back to the main "
2690 "program, such as kernel log messages. You can register a callback to "
2691 "receive these messages."
2695 #: ../src/guestfs.pod:1354
2696 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
2700 #: ../src/guestfs.pod:1356
2702 "The child process generates events in some situations. Current events "
2703 "include: receiving a log message, the child process exits."
2707 #: ../src/guestfs.pod:1359
2709 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
2714 #: ../src/guestfs.pod:1362
2716 "Only I<one callback of each type> can be registered for each handle. "
2717 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
2718 "that type. Cancel all callbacks of this type by calling this function with "
2719 "C<cb> set to C<NULL>."
2723 #: ../src/guestfs.pod:1367
2724 msgid "guestfs_set_log_message_callback"
2728 #: ../src/guestfs.pod:1369
2731 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
2732 " char *buf, int len);\n"
2733 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
2734 " guestfs_log_message_cb cb,\n"
2740 #: ../src/guestfs.pod:1375
2742 "The callback function C<cb> will be called whenever qemu or the guest writes "
2743 "anything to the console."
2747 #: ../src/guestfs.pod:1378
2748 msgid "Use this function to capture kernel messages and similar."
2752 #: ../src/guestfs.pod:1380
2754 "Normally there is no log message handler, and log messages are just "
2759 #: ../src/guestfs.pod:1383
2760 msgid "guestfs_set_subprocess_quit_callback"
2764 #: ../src/guestfs.pod:1385
2767 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
2768 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
2769 " guestfs_subprocess_quit_cb cb,\n"
2775 #: ../src/guestfs.pod:1390
2777 "The callback function C<cb> will be called when the child process quits, "
2778 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
2779 "corresponds to a transition from any state to the CONFIG state)."
2783 #: ../src/guestfs.pod:1395
2784 msgid "guestfs_set_launch_done_callback"
2788 #: ../src/guestfs.pod:1397
2791 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
2792 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
2793 " guestfs_launch_done_cb cb,\n"
2799 #: ../src/guestfs.pod:1402
2801 "The callback function C<cb> will be called when the child process becomes "
2802 "ready first time after it has been launched. (This corresponds to a "
2803 "transition from LAUNCHING to the READY state)."
2807 #: ../src/guestfs.pod:1406
2808 msgid "guestfs_set_close_callback"
2812 #: ../src/guestfs.pod:1408
2815 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
2816 " void guestfs_set_close_callback (guestfs_h *g,\n"
2817 " guestfs_close_cb cb,\n"
2823 #: ../src/guestfs.pod:1413
2825 "The callback function C<cb> will be called while the handle is being closed "
2826 "(synchronously from L</guestfs_close>)."
2830 #: ../src/guestfs.pod:1416
2832 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
2833 "handles that are open when the program exits. This means that this callback "
2834 "might be called indirectly from L<exit(3)>, which can cause unexpected "
2835 "problems in higher-level languages (eg. if your HLL interpreter has already "
2836 "been cleaned up by the time this is called, and if your callback then jumps "
2837 "into some HLL function)."
2841 #: ../src/guestfs.pod:1424
2842 msgid "guestfs_set_progress_callback"
2846 #: ../src/guestfs.pod:1426
2849 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
2850 " int proc_nr, int serial,\n"
2851 " uint64_t position, uint64_t total);\n"
2852 " void guestfs_set_progress_callback (guestfs_h *g,\n"
2853 " guestfs_progress_cb cb,\n"
2859 #: ../src/guestfs.pod:1433
2861 "Some long-running operations can generate progress messages. If this "
2862 "callback is registered, then it will be called each time a progress message "
2863 "is generated (usually two seconds after the operation started, and three "
2864 "times per second thereafter until it completes, although the frequency may "
2865 "change in future versions)."
2869 #: ../src/guestfs.pod:1439
2871 "The callback receives two numbers: C<position> and C<total>. The units of "
2872 "C<total> are not defined, although for some operations C<total> may relate "
2873 "in some way to the amount of data to be transferred (eg. in bytes or "
2874 "megabytes), and C<position> may be the portion which has been transferred."
2878 #: ../src/guestfs.pod:1445
2879 msgid "The only defined and stable parts of the API are:"
2883 #: ../src/guestfs.pod:1451
2885 "The callback can display to the user some type of progress bar or indicator "
2886 "which shows the ratio of C<position>:C<total>."
2890 #: ../src/guestfs.pod:1456
2891 msgid "0 E<lt>= C<position> E<lt>= C<total>"
2895 #: ../src/guestfs.pod:1460
2897 "If any progress notification is sent during a call, then a final progress "
2898 "notification is always sent when C<position> = C<total>."
2902 #: ../src/guestfs.pod:1463
2904 "This is to simplify caller code, so callers can easily set the progress "
2905 "indicator to \"100%\" at the end of the operation, without requiring special "
2906 "code to detect this case."
2910 #: ../src/guestfs.pod:1469
2912 "The callback also receives the procedure number and serial number of the "
2913 "call. These are only useful for debugging protocol issues, and the callback "
2914 "can normally ignore them. The callback may want to print these numbers in "
2915 "error messages or debugging messages."
2919 #: ../src/guestfs.pod:1474
2920 msgid "PRIVATE DATA AREA"
2924 #: ../src/guestfs.pod:1476
2926 "You can attach named pieces of private data to the libguestfs handle, and "
2927 "fetch them by name for the lifetime of the handle. This is called the "
2928 "private data area and is only available from the C API."
2932 #: ../src/guestfs.pod:1480
2933 msgid "To attach a named piece of data, use the following call:"
2937 #: ../src/guestfs.pod:1482
2940 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
2945 #: ../src/guestfs.pod:1484
2947 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
2948 "pointer (which can be C<NULL>). Any previous item with the same name is "
2953 #: ../src/guestfs.pod:1488
2955 "You can use any C<key> you want, but names beginning with an underscore "
2956 "character are reserved for internal libguestfs purposes (for implementing "
2957 "language bindings). It is recommended to prefix the name with some unique "
2958 "string to avoid collisions with other users."
2962 #: ../src/guestfs.pod:1493
2963 msgid "To retrieve the pointer, use:"
2967 #: ../src/guestfs.pod:1495
2970 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
2975 #: ../src/guestfs.pod:1497
2977 "This function returns C<NULL> if either no data is found associated with "
2978 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
2983 #: ../src/guestfs.pod:1501
2985 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
2986 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
2987 "all. In particular, libguestfs does I<not> try to free the data when the "
2988 "handle is closed. If the data must be freed, then the caller must either "
2989 "free it before calling L</guestfs_close> or must set up a close callback to "
2990 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
2991 "can be registered for a handle)."
2995 #: ../src/guestfs.pod:1509
2997 "The private data area is implemented using a hash table, and should be "
2998 "reasonably efficient for moderate numbers of keys."
3002 #: ../src/guestfs.pod:1512
3003 msgid "BLOCK DEVICE NAMING"
3007 #: ../src/guestfs.pod:1514
3009 "In the kernel there is now quite a profusion of schemata for naming block "
3010 "devices (in this context, by I<block device> I mean a physical or virtual "
3011 "hard drive). The original Linux IDE driver used names starting with "
3012 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
3013 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
3014 "replacement for the old IDE driver (particularly for SATA devices) those "
3015 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
3016 "machines with paravirtualized drivers. This has created several different "
3017 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
3022 #: ../src/guestfs.pod:1526
3024 "As discussed above, libguestfs uses a qemu appliance running an embedded "
3025 "Linux kernel to access block devices. We can run a variety of appliances "
3026 "based on a variety of Linux kernels."
3030 #: ../src/guestfs.pod:1530
3032 "This causes a problem for libguestfs because many API calls use device or "
3033 "partition names. Working scripts and the recipe (example) scripts that we "
3034 "make available over the internet could fail if the naming scheme changes."
3038 #: ../src/guestfs.pod:1535
3040 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
3041 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
3042 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
3043 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
3047 #: ../src/guestfs.pod:1541
3049 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
3050 "L</guestfs_list_partitions> and similar calls return the true names of the "
3051 "devices and partitions as known to the appliance."
3055 #: ../src/guestfs.pod:1546
3056 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
3060 #: ../src/guestfs.pod:1548
3062 "Usually this translation is transparent. However in some (very rare) cases "
3063 "you may need to know the exact algorithm. Such cases include where you use "
3064 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
3065 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
3070 #: ../src/guestfs.pod:1554
3072 "The algorithm is applied only to I<parameters> which are known to be either "
3073 "device or partition names. Return values from functions such as "
3074 "L</guestfs_list_devices> are never changed."
3078 #: ../src/guestfs.pod:1562
3079 msgid "Is the string a parameter which is a device or partition name?"
3083 #: ../src/guestfs.pod:1566
3084 msgid "Does the string begin with C</dev/sd>?"
3088 #: ../src/guestfs.pod:1570
3090 "Does the named device exist? If so, we use that device. However if I<not> "
3091 "then we continue with this algorithm."
3095 #: ../src/guestfs.pod:1575
3096 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
3100 #: ../src/guestfs.pod:1577
3101 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
3105 #: ../src/guestfs.pod:1579
3106 msgid "If that named device exists, use it. If not, continue."
3110 #: ../src/guestfs.pod:1583
3111 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
3115 #: ../src/guestfs.pod:1585
3116 msgid "If that named device exists, use it. If not, return an error."
3120 #: ../src/guestfs.pod:1589
3121 msgid "PORTABILITY CONCERNS"
3125 #: ../src/guestfs.pod:1591
3127 "Although the standard naming scheme and automatic translation is useful for "
3128 "simple programs and guestfish scripts, for larger programs it is best not to "
3129 "rely on this mechanism."
3133 #: ../src/guestfs.pod:1595
3135 "Where possible for maximum future portability programs using libguestfs "
3136 "should use these future-proof techniques:"
3140 #: ../src/guestfs.pod:1602
3142 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
3143 "device names, and then use those names directly."
3147 #: ../src/guestfs.pod:1605
3148 msgid "Since those device names exist by definition, they will never be translated."
3152 #: ../src/guestfs.pod:1610
3154 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
3155 "filesystem labels."
3159 #: ../src/guestfs.pod:1615
3164 #: ../src/guestfs.pod:1617
3165 msgid "COMMUNICATION PROTOCOL"
3169 #: ../src/guestfs.pod:1619
3171 "Don't rely on using this protocol directly. This section documents how it "
3172 "currently works, but it may change at any time."
3176 #: ../src/guestfs.pod:1622
3178 "The protocol used to talk between the library and the daemon running inside "
3179 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3180 "1014, RFC 1832, RFC 4506)."
3184 #: ../src/guestfs.pod:1626
3186 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3187 "this file is automatically generated)."
3191 #: ../src/guestfs.pod:1629
3193 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3194 "and C<FileOut> parameters, which are handled with very simple request/reply "
3195 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3196 "parameters, which use the same request and reply messages, but they may also "
3197 "be followed by files sent using a chunked encoding."
3201 #: ../src/guestfs.pod:1636
3202 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3206 #: ../src/guestfs.pod:1638
3207 msgid "For ordinary functions, the request message is:"
3211 #: ../src/guestfs.pod:1640
3214 " total length (header + arguments,\n"
3215 " but not including the length word itself)\n"
3216 " struct guestfs_message_header (encoded as XDR)\n"
3217 " struct guestfs_<foo>_args (encoded as XDR)\n"
3222 #: ../src/guestfs.pod:1645
3224 "The total length field allows the daemon to allocate a fixed size buffer "
3225 "into which it slurps the rest of the message. As a result, the total length "
3226 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3227 "effective size of any request is limited to somewhere under this size."
3231 #: ../src/guestfs.pod:1651
3233 "Note also that many functions don't take any arguments, in which case the "
3234 "C<guestfs_I<foo>_args> is completely omitted."
3238 #: ../src/guestfs.pod:1654
3240 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3241 "receiver knows what type of args structure to expect, or none at all."
3245 #: ../src/guestfs.pod:1658
3246 msgid "The reply message for ordinary functions is:"
3250 #: ../src/guestfs.pod:1660
3253 " total length (header + ret,\n"
3254 " but not including the length word itself)\n"
3255 " struct guestfs_message_header (encoded as XDR)\n"
3256 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3261 #: ../src/guestfs.pod:1665
3263 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3264 "functions that return no formal return values."
3268 #: ../src/guestfs.pod:1668
3269 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3273 #: ../src/guestfs.pod:1671
3275 "In the case of an error, a flag is set in the header, and the reply message "
3276 "is slightly changed:"
3280 #: ../src/guestfs.pod:1674
3283 " total length (header + error,\n"
3284 " but not including the length word itself)\n"
3285 " struct guestfs_message_header (encoded as XDR)\n"
3286 " struct guestfs_message_error (encoded as XDR)\n"
3291 #: ../src/guestfs.pod:1679
3293 "The C<guestfs_message_error> structure contains the error message as a "
3298 #: ../src/guestfs.pod:1682
3299 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3303 #: ../src/guestfs.pod:1684
3305 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3306 "The normal request message is sent (see above). However this is followed by "
3307 "a sequence of file chunks."
3311 #: ../src/guestfs.pod:1688
3314 " total length (header + arguments,\n"
3315 " but not including the length word itself,\n"
3316 " and not including the chunks)\n"
3317 " struct guestfs_message_header (encoded as XDR)\n"
3318 " struct guestfs_<foo>_args (encoded as XDR)\n"
3319 " sequence of chunks for FileIn param #0\n"
3320 " sequence of chunks for FileIn param #1 etc.\n"
3325 #: ../src/guestfs.pod:1696
3326 msgid "The \"sequence of chunks\" is:"
3330 #: ../src/guestfs.pod:1698
3333 " length of chunk (not including length word itself)\n"
3334 " struct guestfs_chunk (encoded as XDR)\n"
3335 " length of chunk\n"
3336 " struct guestfs_chunk (encoded as XDR)\n"
3338 " length of chunk\n"
3339 " struct guestfs_chunk (with data.data_len == 0)\n"
3344 #: ../src/guestfs.pod:1706
3346 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3347 "is set in the final chunk to indicate either successful completion or early "
3352 #: ../src/guestfs.pod:1710
3354 "At time of writing there are no functions that have more than one FileIn "
3355 "parameter. However this is (theoretically) supported, by sending the "
3356 "sequence of chunks for each FileIn parameter one after another (from left to "
3361 #: ../src/guestfs.pod:1715
3363 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3364 "transfer. The library does this by sending a chunk with a special flag set "
3365 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3366 "RPC, does I<not> send any reply, and goes back to reading the next request."
3370 #: ../src/guestfs.pod:1721
3372 "The daemon may also cancel. It does this by writing a special word "
3373 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3374 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3375 "cancel chunk). The special word is chosen so that even if cancellation "
3376 "happens right at the end of the transfer (after the library has finished "
3377 "writing and has started listening for the reply), the \"spurious\" cancel "
3378 "flag will not be confused with the reply message."
3382 #: ../src/guestfs.pod:1730
3384 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3385 "limit), and also files where the size is not known in advance (eg. from "
3386 "pipes or sockets). However the chunks are rather small "
3387 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3388 "to keep much in memory."
3392 #: ../src/guestfs.pod:1736
3393 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3397 #: ../src/guestfs.pod:1738
3399 "The protocol for FileOut parameters is exactly the same as for FileIn "
3400 "parameters, but with the roles of daemon and library reversed."
3404 #: ../src/guestfs.pod:1741
3407 " total length (header + ret,\n"
3408 " but not including the length word itself,\n"
3409 " and not including the chunks)\n"
3410 " struct guestfs_message_header (encoded as XDR)\n"
3411 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3412 " sequence of chunks for FileOut param #0\n"
3413 " sequence of chunks for FileOut param #1 etc.\n"
3418 #: ../src/guestfs.pod:1749
3419 msgid "INITIAL MESSAGE"
3423 #: ../src/guestfs.pod:1751
3425 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3426 "which indicates that the guest and daemon is alive. This is what "
3427 "L</guestfs_launch> waits for."
3431 #: ../src/guestfs.pod:1755
3432 msgid "PROGRESS NOTIFICATION MESSAGES"
3436 #: ../src/guestfs.pod:1757
3438 "The daemon may send progress notification messages at any time. These are "
3439 "distinguished by the normal length word being replaced by "
3440 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3444 #: ../src/guestfs.pod:1761
3446 "The library turns them into progress callbacks (see "
3447 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3448 "discards them if not."
3452 #: ../src/guestfs.pod:1765
3454 "The daemon self-limits the frequency of progress messages it sends (see "
3455 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3460 #: ../src/guestfs.pod:1769
3461 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
3465 #: ../src/guestfs.pod:1771
3467 "All high-level libguestfs actions are synchronous. If you want to use "
3468 "libguestfs asynchronously then you must create a thread."
3472 #: ../src/guestfs.pod:1774
3474 "Only use the handle from a single thread. Either use the handle exclusively "
3475 "from one thread, or provide your own mutex so that two threads cannot issue "
3476 "calls on the same handle at the same time."
3480 #: ../src/guestfs.pod:1778
3482 "See the graphical program guestfs-browser for one possible architecture for "
3483 "multithreaded programs using libvirt and libguestfs."
3487 #: ../src/guestfs.pod:1781
3488 msgid "QEMU WRAPPERS"
3492 #: ../src/guestfs.pod:1783
3494 "If you want to compile your own qemu, run qemu from a non-standard location, "
3495 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
3500 #: ../src/guestfs.pod:1787
3502 "There is one important rule to remember: you I<must C<exec qemu>> as the "
3503 "last command in the shell script (so that qemu replaces the shell and "
3504 "becomes the direct child of the libguestfs-using program). If you don't do "
3505 "this, then the qemu process won't be cleaned up correctly."
3509 #: ../src/guestfs.pod:1792
3511 "Here is an example of a wrapper, where I have built my own copy of qemu from "
3516 #: ../src/guestfs.pod:1795
3520 " qemudir=/home/rjones/d/qemu\n"
3521 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
3527 #: ../src/guestfs.pod:1799
3529 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
3530 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
3535 #: ../src/guestfs.pod:1803
3538 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
3543 #: ../src/guestfs.pod:1805
3545 "Note that libguestfs also calls qemu with the -help and -version options in "
3546 "order to determine features."
3550 #: ../src/guestfs.pod:1808
3551 msgid "LIBGUESTFS VERSION NUMBERS"
3555 #: ../src/guestfs.pod:1810
3557 "Since April 2010, libguestfs has started to make separate development and "
3558 "stable releases, along with corresponding branches in our git repository. "
3559 "These separate releases can be identified by version number:"
3563 #: ../src/guestfs.pod:1815
3566 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3567 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3573 " | `-------- sub-version\n"
3575 " `------ always '1' because we don't change the ABI\n"
3580 #: ../src/guestfs.pod:1826
3581 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3585 #: ../src/guestfs.pod:1828
3587 "As time passes we cherry pick fixes from the development branch and backport "
3588 "those into the stable branch, the effect being that the stable branch should "
3589 "get more stable and less buggy over time. So the stable releases are ideal "
3590 "for people who don't need new features but would just like the software to "
3595 #: ../src/guestfs.pod:1834
3596 msgid "Our criteria for backporting changes are:"
3600 #: ../src/guestfs.pod:1840
3602 "Documentation changes which don't affect any code are backported unless the "
3603 "documentation refers to a future feature which is not in stable."
3607 #: ../src/guestfs.pod:1846
3609 "Bug fixes which are not controversial, fix obvious problems, and have been "
3610 "well tested are backported."
3614 #: ../src/guestfs.pod:1851
3616 "Simple rearrangements of code which shouldn't affect how it works get "
3617 "backported. This is so that the code in the two branches doesn't get too "
3618 "far out of step, allowing us to backport future fixes more easily."
3622 #: ../src/guestfs.pod:1857
3624 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3625 "exceptional case: the new feature is required in order to implement an "
3626 "important bug fix."
3630 #: ../src/guestfs.pod:1863
3632 "A new stable branch starts when we think the new features in development are "
3633 "substantial and compelling enough over the current stable branch to warrant "
3634 "it. When that happens we create new stable and development versions 1.N.0 "
3635 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
3636 "stable at this point, but by backporting fixes from development, that branch "
3637 "will stabilize over time."
3641 #: ../src/guestfs.pod:1871 ../fish/guestfish.pod:914 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 ../tools/virt-rescue.pl:255
3642 msgid "ENVIRONMENT VARIABLES"
3646 #: ../src/guestfs.pod:1875 ../fish/guestfish.pod:940
3647 msgid "LIBGUESTFS_APPEND"
3651 #: ../src/guestfs.pod:1877 ../fish/guestfish.pod:942
3652 msgid "Pass additional options to the guest kernel."
3656 #: ../src/guestfs.pod:1879 ../fish/guestfish.pod:944
3657 msgid "LIBGUESTFS_DEBUG"
3661 #: ../src/guestfs.pod:1881
3663 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
3664 "effect as calling C<guestfs_set_verbose (g, 1)>."
3668 #: ../src/guestfs.pod:1884 ../fish/guestfish.pod:949
3669 msgid "LIBGUESTFS_MEMSIZE"
3673 #: ../src/guestfs.pod:1886 ../fish/guestfish.pod:951
3674 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
3678 #: ../src/guestfs.pod:1889 ../fish/guestfish.pod:954
3681 " LIBGUESTFS_MEMSIZE=700\n"
3686 #: ../src/guestfs.pod:1891 ../fish/guestfish.pod:956
3687 msgid "LIBGUESTFS_PATH"
3691 #: ../src/guestfs.pod:1893
3693 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
3694 "the discussion of paths in section PATH above."
3698 #: ../src/guestfs.pod:1896 ../fish/guestfish.pod:961
3699 msgid "LIBGUESTFS_QEMU"
3703 #: ../src/guestfs.pod:1898 ../fish/guestfish.pod:963
3705 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
3706 "which was found at compile time by the configure script is used."
3710 #: ../src/guestfs.pod:1902
3711 msgid "See also L</QEMU WRAPPERS> above."
3715 #: ../src/guestfs.pod:1904 ../fish/guestfish.pod:967
3716 msgid "LIBGUESTFS_TRACE"
3720 #: ../src/guestfs.pod:1906
3722 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
3723 "effect as calling C<guestfs_set_trace (g, 1)>."
3727 #: ../src/guestfs.pod:1909 ../fish/guestfish.pod:976
3732 #: ../src/guestfs.pod:1911 ../fish/guestfish.pod:978
3733 msgid "Location of temporary directory, defaults to C</tmp>."
3737 #: ../src/guestfs.pod:1913 ../fish/guestfish.pod:980
3739 "If libguestfs was compiled to use the supermin appliance then the real "
3740 "appliance is cached in this directory, shared between all handles belonging "
3741 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
3742 "use in case C</tmp> is not large enough."
3746 #: ../src/guestfs.pod:1921 ../fish/guestfish.pod:1038 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 ../inspector/virt-inspector.pl:570 ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:484 ../tools/virt-df.pl:640 ../tools/virt-ls.pl:232 ../tools/virt-resize.pl:1486 ../tools/virt-list-filesystems.pl:186 ../tools/virt-cat.pl:185 ../tools/virt-tar.pl:281 ../tools/virt-rescue.pl:267 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:254
3751 #: ../src/guestfs.pod:1923
3753 "L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
3754 "L<virt-edit(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
3755 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
3756 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
3757 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
3761 #: ../src/guestfs.pod:1941
3763 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
3764 "L<lvm(8)>, L<disktype(1)>."
3768 #: ../src/guestfs.pod:1948 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548
3773 #: ../src/guestfs.pod:1950
3774 msgid "To get a list of bugs against libguestfs use this link:"
3778 #: ../src/guestfs.pod:1952
3779 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
3783 #: ../src/guestfs.pod:1954
3784 msgid "To report a new bug against libguestfs use this link:"
3788 #: ../src/guestfs.pod:1956
3789 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
3793 #: ../src/guestfs.pod:1958
3794 msgid "When reporting a bug, please check:"
3798 #: ../src/guestfs.pod:1964
3799 msgid "That the bug hasn't been reported already."
3803 #: ../src/guestfs.pod:1968
3804 msgid "That you are testing a recent version."
3808 #: ../src/guestfs.pod:1972
3809 msgid "Describe the bug accurately, and give a way to reproduce it."
3813 #: ../src/guestfs.pod:1976
3815 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
3820 #: ../src/guestfs.pod:1981 ../fish/guestfish.pod:1055 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244 ../inspector/virt-inspector.pl:580
3825 #: ../src/guestfs.pod:1983 ../fish/guestfish.pod:1057 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
3826 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
3830 #: ../src/guestfs.pod:1985 ../fish/guestfish.pod:1059 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 ../inspector/virt-inspector.pl:594 ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:514 ../tools/virt-df.pl:653 ../tools/virt-ls.pl:247 ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:202 ../tools/virt-cat.pl:199 ../tools/virt-tar.pl:296 ../tools/virt-rescue.pl:281 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:269
3835 #: ../src/guestfs.pod:1987 ../fish/guestfish.pod:1061 ../fuse/guestmount.pod:250
3836 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
3840 #: ../src/guestfs.pod:1990
3842 "This library is free software; you can redistribute it and/or modify it "
3843 "under the terms of the GNU Lesser General Public License as published by the "
3844 "Free Software Foundation; either version 2 of the License, or (at your "
3845 "option) any later version."
3849 #: ../src/guestfs.pod:1995
3851 "This library is distributed in the hope that it will be useful, but WITHOUT "
3852 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
3853 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
3858 #: ../src/guestfs.pod:2000
3860 "You should have received a copy of the GNU Lesser General Public License "
3861 "along with this library; if not, write to the Free Software Foundation, "
3862 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
3866 #: ../src/guestfs-actions.pod:1
3867 msgid "guestfs_add_cdrom"
3871 #: ../src/guestfs-actions.pod:3
3875 " guestfs_add_cdrom (guestfs_h *g,\n"
3876 " const char *filename);\n"
3881 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
3882 msgid "This function adds a virtual CD-ROM disk image to the guest."
3886 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
3887 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
3891 #: ../src/guestfs-actions.pod:17
3893 "This call checks for the existence of C<filename>. This stops you from "
3894 "specifying other types of drive which are supported by qemu such as C<nbd:> "
3895 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
3900 #: ../src/guestfs-actions.pod:24
3902 "If you just want to add an ISO file (often you use this as an efficient way "
3903 "to transfer large files into the guest), then you should probably use "
3904 "C<guestfs_add_drive_ro> instead."
3908 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:58 ../src/guestfs-actions.pod:119 ../src/guestfs-actions.pod:156 ../src/guestfs-actions.pod:170 ../src/guestfs-actions.pod:191 ../src/guestfs-actions.pod:211 ../src/guestfs-actions.pod:225 ../src/guestfs-actions.pod:340 ../src/guestfs-actions.pod:360 ../src/guestfs-actions.pod:374 ../src/guestfs-actions.pod:419 ../src/guestfs-actions.pod:447 ../src/guestfs-actions.pod:465 ../src/guestfs-actions.pod:532 ../src/guestfs-actions.pod:565 ../src/guestfs-actions.pod:579 ../src/guestfs-actions.pod:594 ../src/guestfs-actions.pod:693 ../src/guestfs-actions.pod:711 ../src/guestfs-actions.pod:725 ../src/guestfs-actions.pod:739 ../src/guestfs-actions.pod:900 ../src/guestfs-actions.pod:920 ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1022 ../src/guestfs-actions.pod:1040 ../src/guestfs-actions.pod:1059 ../src/guestfs-actions.pod:1073 ../src/guestfs-actions.pod:1093 ../src/guestfs-actions.pod:1132 ../src/guestfs-actions.pod:1202 ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1258 ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1401 ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1653 ../src/guestfs-actions.pod:1675 ../src/guestfs-actions.pod:1762 ../src/guestfs-actions.pod:2185 ../src/guestfs-actions.pod:2329 ../src/guestfs-actions.pod:2390 ../src/guestfs-actions.pod:2426 ../src/guestfs-actions.pod:2962 ../src/guestfs-actions.pod:2977 ../src/guestfs-actions.pod:2997 ../src/guestfs-actions.pod:3123 ../src/guestfs-actions.pod:3137 ../src/guestfs-actions.pod:3150 ../src/guestfs-actions.pod:3164 ../src/guestfs-actions.pod:3179 ../src/guestfs-actions.pod:3215 ../src/guestfs-actions.pod:3288 ../src/guestfs-actions.pod:3308 ../src/guestfs-actions.pod:3325 ../src/guestfs-actions.pod:3348 ../src/guestfs-actions.pod:3371 ../src/guestfs-actions.pod:3403 ../src/guestfs-actions.pod:3422 ../src/guestfs-actions.pod:3441 ../src/guestfs-actions.pod:3476 ../src/guestfs-actions.pod:3488 ../src/guestfs-actions.pod:3524 ../src/guestfs-actions.pod:3540 ../src/guestfs-actions.pod:3553 ../src/guestfs-actions.pod:3568 ../src/guestfs-actions.pod:3585 ../src/guestfs-actions.pod:3680 ../src/guestfs-actions.pod:3700 ../src/guestfs-actions.pod:3713 ../src/guestfs-actions.pod:3764 ../src/guestfs-actions.pod:3782 ../src/guestfs-actions.pod:3800 ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3830 ../src/guestfs-actions.pod:3844 ../src/guestfs-actions.pod:3861 ../src/guestfs-actions.pod:3876 ../src/guestfs-actions.pod:3896 ../src/guestfs-actions.pod:3945 ../src/guestfs-actions.pod:3976 ../src/guestfs-actions.pod:3995 ../src/guestfs-actions.pod:4014 ../src/guestfs-actions.pod:4026 ../src/guestfs-actions.pod:4043 ../src/guestfs-actions.pod:4056 ../src/guestfs-actions.pod:4071 ../src/guestfs-actions.pod:4086 ../src/guestfs-actions.pod:4121 ../src/guestfs-actions.pod:4136 ../src/guestfs-actions.pod:4156 ../src/guestfs-actions.pod:4170 ../src/guestfs-actions.pod:4187 ../src/guestfs-actions.pod:4236 ../src/guestfs-actions.pod:4273 ../src/guestfs-actions.pod:4287 ../src/guestfs-actions.pod:4315 ../src/guestfs-actions.pod:4332 ../src/guestfs-actions.pod:4350 ../src/guestfs-actions.pod:4484 ../src/guestfs-actions.pod:4542 ../src/guestfs-actions.pod:4564 ../src/guestfs-actions.pod:4582 ../src/guestfs-actions.pod:4614 ../src/guestfs-actions.pod:4680 ../src/guestfs-actions.pod:4697 ../src/guestfs-actions.pod:4710 ../src/guestfs-actions.pod:4724 ../src/guestfs-actions.pod:5015 ../src/guestfs-actions.pod:5034 ../src/guestfs-actions.pod:5048 ../src/guestfs-actions.pod:5060 ../src/guestfs-actions.pod:5074 ../src/guestfs-actions.pod:5086 ../src/guestfs-actions.pod:5100 ../src/guestfs-actions.pod:5116 ../src/guestfs-actions.pod:5137 ../src/guestfs-actions.pod:5156 ../src/guestfs-actions.pod:5175 ../src/guestfs-actions.pod:5193 ../src/guestfs-actions.pod:5216 ../src/guestfs-actions.pod:5234 ../src/guestfs-actions.pod:5253 ../src/guestfs-actions.pod:5274 ../src/guestfs-actions.pod:5293 ../src/guestfs-actions.pod:5310 ../src/guestfs-actions.pod:5338 ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5381 ../src/guestfs-actions.pod:5405 ../src/guestfs-actions.pod:5420 ../src/guestfs-actions.pod:5435 ../src/guestfs-actions.pod:5454 ../src/guestfs-actions.pod:5491 ../src/guestfs-actions.pod:5514 ../src/guestfs-actions.pod:5540 ../src/guestfs-actions.pod:5648 ../src/guestfs-actions.pod:5769 ../src/guestfs-actions.pod:5781 ../src/guestfs-actions.pod:5794 ../src/guestfs-actions.pod:5807 ../src/guestfs-actions.pod:5829 ../src/guestfs-actions.pod:5842 ../src/guestfs-actions.pod:5855 ../src/guestfs-actions.pod:5868 ../src/guestfs-actions.pod:5883 ../src/guestfs-actions.pod:5942 ../src/guestfs-actions.pod:5959 ../src/guestfs-actions.pod:5975 ../src/guestfs-actions.pod:5991 ../src/guestfs-actions.pod:6008 ../src/guestfs-actions.pod:6021 ../src/guestfs-actions.pod:6041 ../src/guestfs-actions.pod:6077 ../src/guestfs-actions.pod:6091 ../src/guestfs-actions.pod:6132 ../src/guestfs-actions.pod:6145 ../src/guestfs-actions.pod:6163 ../src/guestfs-actions.pod:6192 ../src/guestfs-actions.pod:6223 ../src/guestfs-actions.pod:6342 ../src/guestfs-actions.pod:6360 ../src/guestfs-actions.pod:6374 ../src/guestfs-actions.pod:6429 ../src/guestfs-actions.pod:6442 ../src/guestfs-actions.pod:6488 ../src/guestfs-actions.pod:6521 ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:6601 ../src/guestfs-actions.pod:6667 ../src/guestfs-actions.pod:6686 ../src/guestfs-actions.pod:6715
3909 msgid "This function returns 0 on success or -1 on error."
3913 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:172 ../src/guestfs-actions.pod:193 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:117 ../fish/guestfish-actions.pod:131
3915 "This function is deprecated. In new code, use the C<add_drive_opts> call "
3920 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:175 ../src/guestfs-actions.pod:196 ../src/guestfs-actions.pod:1406 ../src/guestfs-actions.pod:1892 ../src/guestfs-actions.pod:1913 ../src/guestfs-actions.pod:6609 ../src/guestfs-actions.pod:6778 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:120 ../fish/guestfish-actions.pod:134 ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:1297 ../fish/guestfish-actions.pod:1311 ../fish/guestfish-actions.pod:4366 ../fish/guestfish-actions.pod:4463
3922 "Deprecated functions will not be removed from the API, but the fact that "
3923 "they are deprecated indicates that there are problems with correct use of "
3928 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:60 ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:1864 ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:2065 ../src/guestfs-actions.pod:2964 ../src/guestfs-actions.pod:2979 ../src/guestfs-actions.pod:4123 ../src/guestfs-actions.pod:5195 ../src/guestfs-actions.pod:5312 ../src/guestfs-actions.pod:5422 ../src/guestfs-actions.pod:5885 ../src/guestfs-actions.pod:6010 ../src/guestfs-actions.pod:6523
3929 msgid "(Added in 0.3)"
3933 #: ../src/guestfs-actions.pod:41
3934 msgid "guestfs_add_drive"
3938 #: ../src/guestfs-actions.pod:43
3942 " guestfs_add_drive (guestfs_h *g,\n"
3943 " const char *filename);\n"
3948 #: ../src/guestfs-actions.pod:47
3950 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
3951 "optional parameters, so the disk is added writable, with the format being "
3952 "detected automatically."
3956 #: ../src/guestfs-actions.pod:51
3958 "Automatic detection of the format opens you up to a potential security hole "
3959 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
3960 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
3961 "you should think about replacing calls to this function with calls to "
3962 "C<guestfs_add_drive_opts>, and specifying the format."
3966 #: ../src/guestfs-actions.pod:62
3967 msgid "guestfs_add_drive_opts"
3971 #: ../src/guestfs-actions.pod:64
3975 " guestfs_add_drive_opts (guestfs_h *g,\n"
3976 " const char *filename,\n"
3982 #: ../src/guestfs-actions.pod:69
3984 "You may supply a list of optional arguments to this call. Use zero or more "
3985 "of the following pairs of parameters, and terminate the list with C<-1> on "
3986 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
3990 #: ../src/guestfs-actions.pod:74
3993 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
3994 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
3995 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
4000 #: ../src/guestfs-actions.pod:78 ../fish/guestfish-actions.pod:56
4002 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4003 "The first time you call this function, the disk appears as C</dev/sda>, the "
4004 "second time as C</dev/sdb>, and so on."
4008 #: ../src/guestfs-actions.pod:83 ../fish/guestfish-actions.pod:61
4010 "You don't necessarily need to be root when using libguestfs. However you "
4011 "obviously do need sufficient permissions to access the filename for whatever "
4012 "operations you want to perform (ie. read access if you just want to read the "
4013 "image or write access if you want to modify the image)."
4017 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:67
4018 msgid "This call checks that C<filename> exists."
4022 #: ../src/guestfs-actions.pod:91 ../fish/guestfish-actions.pod:69
4023 msgid "The optional arguments are:"
4027 #: ../src/guestfs-actions.pod:95 ../fish/guestfish-actions.pod:73
4032 #: ../src/guestfs-actions.pod:97 ../fish/guestfish-actions.pod:75
4034 "If true then the image is treated as read-only. Writes are still allowed, "
4035 "but they are stored in a temporary snapshot overlay which is discarded at "
4036 "the end. The disk that you add is not modified."
4040 #: ../src/guestfs-actions.pod:101 ../fish/guestfish-actions.pod:79
4045 #: ../src/guestfs-actions.pod:103
4047 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4048 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4049 "Possible formats include C<raw> and C<qcow2>."
4053 #: ../src/guestfs-actions.pod:107 ../fish/guestfish-actions.pod:85
4055 "Automatic detection of the format opens you up to a potential security hole "
4056 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4057 "RHBZ#642934. Specifying the format closes this security hole."
4061 #: ../src/guestfs-actions.pod:112 ../fish/guestfish-actions.pod:90
4066 #: ../src/guestfs-actions.pod:114
4068 "This rarely-used option lets you emulate the behaviour of the deprecated "
4069 "C<guestfs_add_drive_with_if> call (q.v.)"
4073 #: ../src/guestfs-actions.pod:121
4074 msgid "(Added in 1.5.23)"
4078 #: ../src/guestfs-actions.pod:123
4079 msgid "guestfs_add_drive_opts_va"
4083 #: ../src/guestfs-actions.pod:125
4087 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
4088 " const char *filename,\n"
4094 #: ../src/guestfs-actions.pod:130
4095 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4099 #: ../src/guestfs-actions.pod:132 ../src/guestfs-actions.pod:143
4100 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4104 #: ../src/guestfs-actions.pod:134
4105 msgid "guestfs_add_drive_opts_argv"
4109 #: ../src/guestfs-actions.pod:136
4113 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4114 " const char *filename,\n"
4115 " const struct guestfs_add_drive_opts_argv "
4121 #: ../src/guestfs-actions.pod:141
4122 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4126 #: ../src/guestfs-actions.pod:145
4127 msgid "guestfs_add_drive_ro"
4131 #: ../src/guestfs-actions.pod:147
4135 " guestfs_add_drive_ro (guestfs_h *g,\n"
4136 " const char *filename);\n"
4141 #: ../src/guestfs-actions.pod:151
4143 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4144 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4145 "disk is added read-only, with the format being detected automatically."
4149 #: ../src/guestfs-actions.pod:158
4150 msgid "(Added in 1.0.38)"
4154 #: ../src/guestfs-actions.pod:160
4155 msgid "guestfs_add_drive_ro_with_if"
4159 #: ../src/guestfs-actions.pod:162
4163 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4164 " const char *filename,\n"
4165 " const char *iface);\n"
4170 #: ../src/guestfs-actions.pod:167
4172 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4173 "QEMU interface emulation to use at run time."
4177 #: ../src/guestfs-actions.pod:179 ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:2275
4178 msgid "(Added in 1.0.84)"
4182 #: ../src/guestfs-actions.pod:181
4183 msgid "guestfs_add_drive_with_if"
4187 #: ../src/guestfs-actions.pod:183
4191 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4192 " const char *filename,\n"
4193 " const char *iface);\n"
4198 #: ../src/guestfs-actions.pod:188
4200 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4201 "QEMU interface emulation to use at run time."
4205 #: ../src/guestfs-actions.pod:202
4206 msgid "guestfs_aug_clear"
4210 #: ../src/guestfs-actions.pod:204
4214 " guestfs_aug_clear (guestfs_h *g,\n"
4215 " const char *augpath);\n"
4220 #: ../src/guestfs-actions.pod:208 ../fish/guestfish-actions.pod:142
4222 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4223 "L<augtool(1)> C<clear> command."
4227 #: ../src/guestfs-actions.pod:213 ../src/guestfs-actions.pod:2054
4228 msgid "(Added in 1.3.4)"
4232 #: ../src/guestfs-actions.pod:215
4233 msgid "guestfs_aug_close"
4237 #: ../src/guestfs-actions.pod:217
4241 " guestfs_aug_close (guestfs_h *g);\n"
4246 #: ../src/guestfs-actions.pod:220
4248 "Close the current Augeas handle and free up any resources used by it. After "
4249 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4250 "any other Augeas functions."
4254 #: ../src/guestfs-actions.pod:227 ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:270 ../src/guestfs-actions.pod:284 ../src/guestfs-actions.pod:342 ../src/guestfs-actions.pod:362 ../src/guestfs-actions.pod:376 ../src/guestfs-actions.pod:407 ../src/guestfs-actions.pod:421 ../src/guestfs-actions.pod:435 ../src/guestfs-actions.pod:449 ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:4872
4255 msgid "(Added in 0.7)"
4259 #: ../src/guestfs-actions.pod:229
4260 msgid "guestfs_aug_defnode"
4264 #: ../src/guestfs-actions.pod:231
4267 " struct guestfs_int_bool *\n"
4268 " guestfs_aug_defnode (guestfs_h *g,\n"
4269 " const char *name,\n"
4270 " const char *expr,\n"
4271 " const char *val);\n"
4276 #: ../src/guestfs-actions.pod:237 ../fish/guestfish-actions.pod:158
4277 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4281 #: ../src/guestfs-actions.pod:240
4283 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4284 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4285 "containing that single node."
4289 #: ../src/guestfs-actions.pod:244 ../fish/guestfish-actions.pod:165
4291 "On success this returns a pair containing the number of nodes in the "
4292 "nodeset, and a boolean flag if a node was created."
4296 #: ../src/guestfs-actions.pod:248
4298 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4299 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4303 #: ../src/guestfs-actions.pod:254
4304 msgid "guestfs_aug_defvar"
4308 #: ../src/guestfs-actions.pod:256
4312 " guestfs_aug_defvar (guestfs_h *g,\n"
4313 " const char *name,\n"
4314 " const char *expr);\n"
4319 #: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:173
4321 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4322 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4326 #: ../src/guestfs-actions.pod:265 ../fish/guestfish-actions.pod:177
4328 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4329 "evaluates to something which is not a nodeset."
4333 #: ../src/guestfs-actions.pod:268 ../src/guestfs-actions.pod:433 ../src/guestfs-actions.pod:611 ../src/guestfs-actions.pod:642 ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:1278 ../src/guestfs-actions.pod:1632 ../src/guestfs-actions.pod:1835 ../src/guestfs-actions.pod:1934 ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2575 ../src/guestfs-actions.pod:2596 ../src/guestfs-actions.pod:4259 ../src/guestfs-actions.pod:4387 ../src/guestfs-actions.pod:4795 ../src/guestfs-actions.pod:4821 ../src/guestfs-actions.pod:6118 ../src/guestfs-actions.pod:6534 ../src/guestfs-actions.pod:6547 ../src/guestfs-actions.pod:6560
4334 msgid "On error this function returns -1."
4338 #: ../src/guestfs-actions.pod:272
4339 msgid "guestfs_aug_get"
4343 #: ../src/guestfs-actions.pod:274
4347 " guestfs_aug_get (guestfs_h *g,\n"
4348 " const char *augpath);\n"
4353 #: ../src/guestfs-actions.pod:278 ../fish/guestfish-actions.pod:184
4355 "Look up the value associated with C<path>. If C<path> matches exactly one "
4356 "node, the C<value> is returned."
4360 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:781 ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:859 ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:978 ../src/guestfs-actions.pod:1112 ../src/guestfs-actions.pod:1147 ../src/guestfs-actions.pod:1164 ../src/guestfs-actions.pod:1183 ../src/guestfs-actions.pod:1312 ../src/guestfs-actions.pod:1503 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1778 ../src/guestfs-actions.pod:1795 ../src/guestfs-actions.pod:1886 ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:2077 ../src/guestfs-actions.pod:2240 ../src/guestfs-actions.pod:2448 ../src/guestfs-actions.pod:2521 ../src/guestfs-actions.pod:2652 ../src/guestfs-actions.pod:2708 ../src/guestfs-actions.pod:2731 ../src/guestfs-actions.pod:3109 ../src/guestfs-actions.pod:3460 ../src/guestfs-actions.pod:3631 ../src/guestfs-actions.pod:3742 ../src/guestfs-actions.pod:4405 ../src/guestfs-actions.pod:4599 ../src/guestfs-actions.pod:4770 ../src/guestfs-actions.pod:4949 ../src/guestfs-actions.pod:4998 ../src/guestfs-actions.pod:5561 ../src/guestfs-actions.pod:5577 ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:5618 ../src/guestfs-actions.pod:6282 ../src/guestfs-actions.pod:6301 ../src/guestfs-actions.pod:6319 ../src/guestfs-actions.pod:6500 ../src/guestfs-actions.pod:6772
4362 "This function returns a string, or NULL on error. I<The caller must free "
4363 "the returned string after use>."
4367 #: ../src/guestfs-actions.pod:286
4368 msgid "guestfs_aug_init"
4372 #: ../src/guestfs-actions.pod:288
4376 " guestfs_aug_init (guestfs_h *g,\n"
4377 " const char *root,\n"
4383 #: ../src/guestfs-actions.pod:293 ../fish/guestfish-actions.pod:191
4385 "Create a new Augeas handle for editing configuration files. If there was "
4386 "any previous Augeas handle associated with this guestfs session, then it is "
4391 #: ../src/guestfs-actions.pod:297
4392 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4396 #: ../src/guestfs-actions.pod:300 ../fish/guestfish-actions.pod:198
4397 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4401 #: ../src/guestfs-actions.pod:303 ../fish/guestfish-actions.pod:201
4403 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4404 "logical I<or> of the following integers:"
4408 #: ../src/guestfs-actions.pod:309 ../fish/guestfish-actions.pod:207
4409 msgid "C<AUG_SAVE_BACKUP> = 1"
4413 #: ../src/guestfs-actions.pod:311 ../fish/guestfish-actions.pod:209
4414 msgid "Keep the original file with a C<.augsave> extension."
4418 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:211
4419 msgid "C<AUG_SAVE_NEWFILE> = 2"
4423 #: ../src/guestfs-actions.pod:315 ../fish/guestfish-actions.pod:213
4425 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4426 "original. Overrides C<AUG_SAVE_BACKUP>."
4430 #: ../src/guestfs-actions.pod:318 ../fish/guestfish-actions.pod:216
4431 msgid "C<AUG_TYPE_CHECK> = 4"
4435 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:218
4436 msgid "Typecheck lenses (can be expensive)."
4440 #: ../src/guestfs-actions.pod:322 ../fish/guestfish-actions.pod:220
4441 msgid "C<AUG_NO_STDINC> = 8"
4445 #: ../src/guestfs-actions.pod:324 ../fish/guestfish-actions.pod:222
4446 msgid "Do not use standard load path for modules."
4450 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:224
4451 msgid "C<AUG_SAVE_NOOP> = 16"
4455 #: ../src/guestfs-actions.pod:328 ../fish/guestfish-actions.pod:226
4456 msgid "Make save a no-op, just record what would have been changed."
4460 #: ../src/guestfs-actions.pod:330 ../fish/guestfish-actions.pod:228
4461 msgid "C<AUG_NO_LOAD> = 32"
4465 #: ../src/guestfs-actions.pod:332
4466 msgid "Do not load the tree in C<guestfs_aug_init>."
4470 #: ../src/guestfs-actions.pod:336
4471 msgid "To close the handle, you can call C<guestfs_aug_close>."
4475 #: ../src/guestfs-actions.pod:338 ../fish/guestfish-actions.pod:236
4476 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4480 #: ../src/guestfs-actions.pod:344
4481 msgid "guestfs_aug_insert"
4485 #: ../src/guestfs-actions.pod:346
4489 " guestfs_aug_insert (guestfs_h *g,\n"
4490 " const char *augpath,\n"
4491 " const char *label,\n"
4497 #: ../src/guestfs-actions.pod:352 ../fish/guestfish-actions.pod:242
4499 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4500 "or after C<path> (depending on the boolean flag C<before>)."
4504 #: ../src/guestfs-actions.pod:356 ../fish/guestfish-actions.pod:246
4506 "C<path> must match exactly one existing node in the tree, and C<label> must "
4507 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4511 #: ../src/guestfs-actions.pod:364
4512 msgid "guestfs_aug_load"
4516 #: ../src/guestfs-actions.pod:366
4520 " guestfs_aug_load (guestfs_h *g);\n"
4525 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:254
4526 msgid "Load files into the tree."
4530 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:256
4531 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4535 #: ../src/guestfs-actions.pod:378
4536 msgid "guestfs_aug_ls"
4540 #: ../src/guestfs-actions.pod:380
4544 " guestfs_aug_ls (guestfs_h *g,\n"
4545 " const char *augpath);\n"
4550 #: ../src/guestfs-actions.pod:384
4552 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
4553 "sorting the resulting nodes into alphabetical order."
4557 #: ../src/guestfs-actions.pod:387 ../src/guestfs-actions.pod:403 ../src/guestfs-actions.pod:549 ../src/guestfs-actions.pod:997 ../src/guestfs-actions.pod:1327 ../src/guestfs-actions.pod:1346 ../src/guestfs-actions.pod:1449 ../src/guestfs-actions.pod:1468 ../src/guestfs-actions.pod:1717 ../src/guestfs-actions.pod:2120 ../src/guestfs-actions.pod:2136 ../src/guestfs-actions.pod:2155 ../src/guestfs-actions.pod:2198 ../src/guestfs-actions.pod:2222 ../src/guestfs-actions.pod:2293 ../src/guestfs-actions.pod:2342 ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:2671 ../src/guestfs-actions.pod:2773 ../src/guestfs-actions.pod:3029 ../src/guestfs-actions.pod:3091 ../src/guestfs-actions.pod:3196 ../src/guestfs-actions.pod:3602 ../src/guestfs-actions.pod:4220 ../src/guestfs-actions.pod:4741 ../src/guestfs-actions.pod:4868 ../src/guestfs-actions.pod:4983 ../src/guestfs-actions.pod:5634 ../src/guestfs-actions.pod:5695 ../src/guestfs-actions.pod:5750 ../src/guestfs-actions.pod:5896 ../src/guestfs-actions.pod:5920 ../src/guestfs-actions.pod:6392 ../src/guestfs-actions.pod:6412 ../src/guestfs-actions.pod:6459 ../src/guestfs-actions.pod:6625 ../src/guestfs-actions.pod:6644 ../src/guestfs-actions.pod:6729 ../src/guestfs-actions.pod:6748 ../src/guestfs-actions.pod:6794 ../src/guestfs-actions.pod:6813
4559 "This function returns a NULL-terminated array of strings (like "
4560 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
4561 "strings and the array after use>."
4565 #: ../src/guestfs-actions.pod:391 ../src/guestfs-actions.pod:922 ../src/guestfs-actions.pod:940 ../src/guestfs-actions.pod:1384 ../src/guestfs-actions.pod:2851 ../src/guestfs-actions.pod:2882 ../src/guestfs-actions.pod:3443 ../src/guestfs-actions.pod:3493 ../src/guestfs-actions.pod:3682 ../src/guestfs-actions.pod:3715 ../src/guestfs-actions.pod:3878 ../src/guestfs-actions.pod:4224 ../src/guestfs-actions.pod:4682 ../src/guestfs-actions.pod:5062 ../src/guestfs-actions.pod:5076 ../src/guestfs-actions.pod:5088 ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:6134 ../src/guestfs-actions.pod:6147 ../src/guestfs-actions.pod:6376 ../src/guestfs-actions.pod:6580 ../src/guestfs-actions.pod:6613
4566 msgid "(Added in 0.8)"
4570 #: ../src/guestfs-actions.pod:393
4571 msgid "guestfs_aug_match"
4575 #: ../src/guestfs-actions.pod:395
4579 " guestfs_aug_match (guestfs_h *g,\n"
4580 " const char *augpath);\n"
4585 #: ../src/guestfs-actions.pod:399 ../fish/guestfish-actions.pod:270
4587 "Returns a list of paths which match the path expression C<path>. The "
4588 "returned paths are sufficiently qualified so that they match exactly one "
4589 "node in the current tree."
4593 #: ../src/guestfs-actions.pod:409
4594 msgid "guestfs_aug_mv"
4598 #: ../src/guestfs-actions.pod:411
4602 " guestfs_aug_mv (guestfs_h *g,\n"
4603 " const char *src,\n"
4604 " const char *dest);\n"
4609 #: ../src/guestfs-actions.pod:416 ../fish/guestfish-actions.pod:278
4611 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4612 "C<dest> is overwritten if it exists."
4616 #: ../src/guestfs-actions.pod:423
4617 msgid "guestfs_aug_rm"
4621 #: ../src/guestfs-actions.pod:425
4625 " guestfs_aug_rm (guestfs_h *g,\n"
4626 " const char *augpath);\n"
4631 #: ../src/guestfs-actions.pod:429 ../fish/guestfish-actions.pod:285
4632 msgid "Remove C<path> and all of its children."
4636 #: ../src/guestfs-actions.pod:431 ../fish/guestfish-actions.pod:287
4637 msgid "On success this returns the number of entries which were removed."
4641 #: ../src/guestfs-actions.pod:437
4642 msgid "guestfs_aug_save"
4646 #: ../src/guestfs-actions.pod:439
4650 " guestfs_aug_save (guestfs_h *g);\n"
4655 #: ../src/guestfs-actions.pod:442 ../fish/guestfish-actions.pod:293
4656 msgid "This writes all pending changes to disk."
4660 #: ../src/guestfs-actions.pod:444
4662 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
4667 #: ../src/guestfs-actions.pod:451
4668 msgid "guestfs_aug_set"
4672 #: ../src/guestfs-actions.pod:453
4676 " guestfs_aug_set (guestfs_h *g,\n"
4677 " const char *augpath,\n"
4678 " const char *val);\n"
4683 #: ../src/guestfs-actions.pod:458 ../fish/guestfish-actions.pod:302
4684 msgid "Set the value associated with C<path> to C<val>."
4688 #: ../src/guestfs-actions.pod:460
4690 "In the Augeas API, it is possible to clear a node by setting the value to "
4691 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
4692 "this call. Instead you must use the C<guestfs_aug_clear> call."
4696 #: ../src/guestfs-actions.pod:469
4697 msgid "guestfs_available"
4701 #: ../src/guestfs-actions.pod:471
4705 " guestfs_available (guestfs_h *g,\n"
4706 " char *const *groups);\n"
4711 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:313
4713 "This command is used to check the availability of some groups of "
4714 "functionality in the appliance, which not all builds of the libguestfs "
4715 "appliance will be able to provide."
4719 #: ../src/guestfs-actions.pod:479
4721 "The libguestfs groups, and the functions that those groups correspond to, "
4722 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
4723 "runtime by calling C<guestfs_available_all_groups>."
4727 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:322
4729 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
4730 "\"augeas\"]> would check for the availability of the Linux inotify functions "
4731 "and Augeas (configuration file editing) functions."
4735 #: ../src/guestfs-actions.pod:489 ../fish/guestfish-actions.pod:327
4736 msgid "The command returns no error if I<all> requested groups are available."
4740 #: ../src/guestfs-actions.pod:491 ../fish/guestfish-actions.pod:329
4742 "It fails with an error if one or more of the requested groups is unavailable "
4747 #: ../src/guestfs-actions.pod:494 ../fish/guestfish-actions.pod:332
4749 "If an unknown group name is included in the list of groups then an error is "
4754 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:335
4759 #: ../src/guestfs-actions.pod:503
4760 msgid "You must call C<guestfs_launch> before calling this function."
4764 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:343
4766 "The reason is because we don't know what groups are supported by the "
4767 "appliance/daemon until it is running and can be queried."
4771 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:349
4773 "If a group of functions is available, this does not necessarily mean that "
4774 "they will work. You still have to check for errors when calling individual "
4775 "API functions even if they are available."
4779 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:356
4781 "It is usually the job of distro packagers to build complete functionality "
4782 "into the libguestfs appliance. Upstream libguestfs, if built from source "
4783 "with all requirements satisfied, will support everything."
4787 #: ../src/guestfs-actions.pod:525
4789 "This call was added in version C<1.0.80>. In previous versions of "
4790 "libguestfs all you could do would be to speculatively execute a command to "
4791 "find out if the daemon implemented it. See also C<guestfs_version>."
4795 #: ../src/guestfs-actions.pod:534 ../src/guestfs-actions.pod:1095
4796 msgid "(Added in 1.0.80)"
4800 #: ../src/guestfs-actions.pod:536
4801 msgid "guestfs_available_all_groups"
4805 #: ../src/guestfs-actions.pod:538
4809 " guestfs_available_all_groups (guestfs_h *g);\n"
4814 #: ../src/guestfs-actions.pod:541
4816 "This command returns a list of all optional groups that this daemon knows "
4817 "about. Note this returns both supported and unsupported groups. To find "
4818 "out which ones the daemon can actually support you have to call "
4819 "C<guestfs_available> on each member of the returned list."
4823 #: ../src/guestfs-actions.pod:547
4824 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
4828 #: ../src/guestfs-actions.pod:553
4829 msgid "(Added in 1.3.15)"
4833 #: ../src/guestfs-actions.pod:555
4834 msgid "guestfs_base64_in"
4838 #: ../src/guestfs-actions.pod:557
4842 " guestfs_base64_in (guestfs_h *g,\n"
4843 " const char *base64file,\n"
4844 " const char *filename);\n"
4849 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:386
4850 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
4854 #: ../src/guestfs-actions.pod:567 ../src/guestfs-actions.pod:581 ../src/guestfs-actions.pod:1134
4855 msgid "(Added in 1.3.5)"
4859 #: ../src/guestfs-actions.pod:569
4860 msgid "guestfs_base64_out"
4864 #: ../src/guestfs-actions.pod:571
4868 " guestfs_base64_out (guestfs_h *g,\n"
4869 " const char *filename,\n"
4870 " const char *base64file);\n"
4875 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:395
4877 "This command downloads the contents of C<filename>, writing it out to local "
4878 "file C<base64file> encoded as base64."
4882 #: ../src/guestfs-actions.pod:583
4883 msgid "guestfs_blockdev_flushbufs"
4887 #: ../src/guestfs-actions.pod:585
4891 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
4892 " const char *device);\n"
4897 #: ../src/guestfs-actions.pod:589 ../fish/guestfish-actions.pod:404
4898 msgid "This tells the kernel to flush internal buffers associated with C<device>."
4902 #: ../src/guestfs-actions.pod:592 ../src/guestfs-actions.pod:609 ../src/guestfs-actions.pod:624 ../src/guestfs-actions.pod:640 ../src/guestfs-actions.pod:658 ../src/guestfs-actions.pod:677 ../src/guestfs-actions.pod:691 ../src/guestfs-actions.pod:709 ../src/guestfs-actions.pod:723 ../src/guestfs-actions.pod:737 ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:418 ../fish/guestfish-actions.pod:427 ../fish/guestfish-actions.pod:437 ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:462 ../fish/guestfish-actions.pod:470 ../fish/guestfish-actions.pod:481 ../fish/guestfish-actions.pod:489 ../fish/guestfish-actions.pod:497
4903 msgid "This uses the L<blockdev(8)> command."
4907 #: ../src/guestfs-actions.pod:596 ../src/guestfs-actions.pod:613 ../src/guestfs-actions.pod:628 ../src/guestfs-actions.pod:644 ../src/guestfs-actions.pod:662 ../src/guestfs-actions.pod:681 ../src/guestfs-actions.pod:695 ../src/guestfs-actions.pod:713 ../src/guestfs-actions.pod:727 ../src/guestfs-actions.pod:741
4908 msgid "(Added in 0.9.3)"
4912 #: ../src/guestfs-actions.pod:598
4913 msgid "guestfs_blockdev_getbsz"
4917 #: ../src/guestfs-actions.pod:600
4921 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
4922 " const char *device);\n"
4927 #: ../src/guestfs-actions.pod:604 ../fish/guestfish-actions.pod:413
4928 msgid "This returns the block size of a device."
4932 #: ../src/guestfs-actions.pod:606 ../src/guestfs-actions.pod:706 ../fish/guestfish-actions.pod:415 ../fish/guestfish-actions.pod:478
4934 "(Note this is different from both I<size in blocks> and I<filesystem block "
4939 #: ../src/guestfs-actions.pod:615
4940 msgid "guestfs_blockdev_getro"
4944 #: ../src/guestfs-actions.pod:617
4948 " guestfs_blockdev_getro (guestfs_h *g,\n"
4949 " const char *device);\n"
4954 #: ../src/guestfs-actions.pod:621 ../fish/guestfish-actions.pod:424
4956 "Returns a boolean indicating if the block device is read-only (true if "
4957 "read-only, false if not)."
4961 #: ../src/guestfs-actions.pod:626 ../src/guestfs-actions.pod:1367 ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1862 ../src/guestfs-actions.pod:1873 ../src/guestfs-actions.pod:1945 ../src/guestfs-actions.pod:2000 ../src/guestfs-actions.pod:2015 ../src/guestfs-actions.pod:2040 ../src/guestfs-actions.pod:2063 ../src/guestfs-actions.pod:2790 ../src/guestfs-actions.pod:2804 ../src/guestfs-actions.pod:2819 ../src/guestfs-actions.pod:2833 ../src/guestfs-actions.pod:2849 ../src/guestfs-actions.pod:2864 ../src/guestfs-actions.pod:2880 ../src/guestfs-actions.pod:2894 ../src/guestfs-actions.pod:2907 ../src/guestfs-actions.pod:2921 ../src/guestfs-actions.pod:2936 ../src/guestfs-actions.pod:2951 ../src/guestfs-actions.pod:4369
4962 msgid "This function returns a C truth value on success or -1 on error."
4966 #: ../src/guestfs-actions.pod:630
4967 msgid "guestfs_blockdev_getsize64"
4971 #: ../src/guestfs-actions.pod:632
4975 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
4976 " const char *device);\n"
4981 #: ../src/guestfs-actions.pod:636 ../fish/guestfish-actions.pod:433
4982 msgid "This returns the size of the device in bytes."
4986 #: ../src/guestfs-actions.pod:638
4987 msgid "See also C<guestfs_blockdev_getsz>."
4991 #: ../src/guestfs-actions.pod:646
4992 msgid "guestfs_blockdev_getss"
4996 #: ../src/guestfs-actions.pod:648
5000 " guestfs_blockdev_getss (guestfs_h *g,\n"
5001 " const char *device);\n"
5006 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:443
5008 "This returns the size of sectors on a block device. Usually 512, but can be "
5009 "larger for modern devices."
5013 #: ../src/guestfs-actions.pod:655
5015 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
5020 #: ../src/guestfs-actions.pod:664
5021 msgid "guestfs_blockdev_getsz"
5025 #: ../src/guestfs-actions.pod:666
5029 " guestfs_blockdev_getsz (guestfs_h *g,\n"
5030 " const char *device);\n"
5035 #: ../src/guestfs-actions.pod:670 ../fish/guestfish-actions.pod:455
5037 "This returns the size of the device in units of 512-byte sectors (even if "
5038 "the sectorsize isn't 512 bytes ... weird)."
5042 #: ../src/guestfs-actions.pod:673
5044 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
5045 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
5049 #: ../src/guestfs-actions.pod:683
5050 msgid "guestfs_blockdev_rereadpt"
5054 #: ../src/guestfs-actions.pod:685
5058 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5059 " const char *device);\n"
5064 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:468
5065 msgid "Reread the partition table on C<device>."
5069 #: ../src/guestfs-actions.pod:697
5070 msgid "guestfs_blockdev_setbsz"
5074 #: ../src/guestfs-actions.pod:699
5078 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5079 " const char *device,\n"
5080 " int blocksize);\n"
5085 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:476
5086 msgid "This sets the block size of a device."
5090 #: ../src/guestfs-actions.pod:715
5091 msgid "guestfs_blockdev_setro"
5095 #: ../src/guestfs-actions.pod:717
5099 " guestfs_blockdev_setro (guestfs_h *g,\n"
5100 " const char *device);\n"
5105 #: ../src/guestfs-actions.pod:721 ../fish/guestfish-actions.pod:487
5106 msgid "Sets the block device named C<device> to read-only."
5110 #: ../src/guestfs-actions.pod:729
5111 msgid "guestfs_blockdev_setrw"
5115 #: ../src/guestfs-actions.pod:731
5119 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5120 " const char *device);\n"
5125 #: ../src/guestfs-actions.pod:735 ../fish/guestfish-actions.pod:495
5126 msgid "Sets the block device named C<device> to read-write."
5130 #: ../src/guestfs-actions.pod:743
5131 msgid "guestfs_case_sensitive_path"
5135 #: ../src/guestfs-actions.pod:745
5139 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5140 " const char *path);\n"
5145 #: ../src/guestfs-actions.pod:749 ../fish/guestfish-actions.pod:503
5147 "This can be used to resolve case insensitive paths on a filesystem which is "
5148 "case sensitive. The use case is to resolve paths which you have read from "
5149 "Windows configuration files or the Windows Registry, to the true path."
5153 #: ../src/guestfs-actions.pod:754 ../fish/guestfish-actions.pod:508
5155 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5156 "(and probably others), which is that although the underlying filesystem is "
5157 "case-insensitive, the driver exports the filesystem to Linux as "
5162 #: ../src/guestfs-actions.pod:759 ../fish/guestfish-actions.pod:513
5164 "One consequence of this is that special directories such as C<c:\\windows> "
5165 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5166 "precise details of how they were created. In Windows itself this would not "
5171 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:519
5173 "Bug or feature? You decide: "
5174 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
5178 #: ../src/guestfs-actions.pod:768 ../fish/guestfish-actions.pod:522
5180 "This function resolves the true case of each element in the path and returns "
5181 "the case-sensitive path."
5185 #: ../src/guestfs-actions.pod:771
5187 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
5188 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5189 "how the directories were originally created under Windows)."
5193 #: ../src/guestfs-actions.pod:776 ../fish/guestfish-actions.pod:530
5194 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5198 #: ../src/guestfs-actions.pod:779
5199 msgid "See also C<guestfs_realpath>."
5203 #: ../src/guestfs-actions.pod:784 ../src/guestfs-actions.pod:6304
5204 msgid "(Added in 1.0.75)"
5208 #: ../src/guestfs-actions.pod:786
5213 #: ../src/guestfs-actions.pod:788
5217 " guestfs_cat (guestfs_h *g,\n"
5218 " const char *path);\n"
5223 #: ../src/guestfs-actions.pod:792 ../src/guestfs-actions.pod:4858 ../fish/guestfish-actions.pod:539 ../fish/guestfish-actions.pod:3210
5224 msgid "Return the contents of the file named C<path>."
5228 #: ../src/guestfs-actions.pod:794
5230 "Note that this function cannot correctly handle binary files (specifically, "
5231 "files containing C<\\0> character which is treated as end of string). For "
5232 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5233 "functions which have a more complex interface."
5237 #: ../src/guestfs-actions.pod:802 ../src/guestfs-actions.pod:981 ../src/guestfs-actions.pod:1001 ../src/guestfs-actions.pod:1331 ../src/guestfs-actions.pod:1350 ../src/guestfs-actions.pod:1453 ../src/guestfs-actions.pod:1472 ../src/guestfs-actions.pod:1721 ../src/guestfs-actions.pod:2140 ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:2202 ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2272 ../src/guestfs-actions.pod:4639 ../src/guestfs-actions.pod:4665 ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4823 ../src/guestfs-actions.pod:4847 ../src/guestfs-actions.pod:5699 ../src/guestfs-actions.pod:5754 ../src/guestfs-actions.pod:5900 ../src/guestfs-actions.pod:5924 ../src/guestfs-actions.pod:6577 ../src/guestfs-actions.pod:6603 ../src/guestfs-actions.pod:6629 ../src/guestfs-actions.pod:6648 ../src/guestfs-actions.pod:6733 ../src/guestfs-actions.pod:6752 ../src/guestfs-actions.pod:6798 ../src/guestfs-actions.pod:6817 ../fish/guestfish-actions.pod:546 ../fish/guestfish-actions.pod:681 ../fish/guestfish-actions.pod:693 ../fish/guestfish-actions.pod:894 ../fish/guestfish-actions.pod:904 ../fish/guestfish-actions.pod:971 ../fish/guestfish-actions.pod:981 ../fish/guestfish-actions.pod:1176 ../fish/guestfish-actions.pod:1451 ../fish/guestfish-actions.pod:1461 ../fish/guestfish-actions.pod:1489 ../fish/guestfish-actions.pod:1504 ../fish/guestfish-actions.pod:1514 ../fish/guestfish-actions.pod:1533 ../fish/guestfish-actions.pod:3080 ../fish/guestfish-actions.pod:3095 ../fish/guestfish-actions.pod:3171 ../fish/guestfish-actions.pod:3188 ../fish/guestfish-actions.pod:3203 ../fish/guestfish-actions.pod:3786 ../fish/guestfish-actions.pod:3832 ../fish/guestfish-actions.pod:3917 ../fish/guestfish-actions.pod:3932 ../fish/guestfish-actions.pod:4342 ../fish/guestfish-actions.pod:4360 ../fish/guestfish-actions.pod:4377 ../fish/guestfish-actions.pod:4387 ../fish/guestfish-actions.pod:4435 ../fish/guestfish-actions.pod:4445 ../fish/guestfish-actions.pod:4474 ../fish/guestfish-actions.pod:4484
5239 "Because of the message protocol, there is a transfer limit of somewhere "
5240 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5244 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:3033 ../src/guestfs-actions.pod:3095 ../src/guestfs-actions.pod:3112 ../src/guestfs-actions.pod:3200 ../src/guestfs-actions.pod:3606 ../src/guestfs-actions.pod:3621 ../src/guestfs-actions.pod:4745 ../src/guestfs-actions.pod:4760 ../src/guestfs-actions.pod:6463 ../src/guestfs-actions.pod:6478
5245 msgid "(Added in 0.4)"
5249 #: ../src/guestfs-actions.pod:807
5250 msgid "guestfs_checksum"
5254 #: ../src/guestfs-actions.pod:809
5258 " guestfs_checksum (guestfs_h *g,\n"
5259 " const char *csumtype,\n"
5260 " const char *path);\n"
5265 #: ../src/guestfs-actions.pod:814 ../fish/guestfish-actions.pod:553
5266 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5270 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:556
5272 "The type of checksum to compute is given by the C<csumtype> parameter which "
5273 "must have one of the following values:"
5277 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:561
5282 #: ../src/guestfs-actions.pod:824 ../fish/guestfish-actions.pod:563
5284 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5289 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:566
5294 #: ../src/guestfs-actions.pod:829 ../fish/guestfish-actions.pod:568
5295 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5299 #: ../src/guestfs-actions.pod:831 ../fish/guestfish-actions.pod:570
5304 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:572
5305 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5309 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:574
5314 #: ../src/guestfs-actions.pod:837 ../fish/guestfish-actions.pod:576
5315 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5319 #: ../src/guestfs-actions.pod:839 ../fish/guestfish-actions.pod:578
5324 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:580
5325 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5329 #: ../src/guestfs-actions.pod:843 ../fish/guestfish-actions.pod:582
5334 #: ../src/guestfs-actions.pod:845 ../fish/guestfish-actions.pod:584
5335 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5339 #: ../src/guestfs-actions.pod:847 ../fish/guestfish-actions.pod:586
5344 #: ../src/guestfs-actions.pod:849 ../fish/guestfish-actions.pod:588
5345 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5349 #: ../src/guestfs-actions.pod:853 ../fish/guestfish-actions.pod:592
5350 msgid "The checksum is returned as a printable string."
5354 #: ../src/guestfs-actions.pod:855
5355 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
5359 #: ../src/guestfs-actions.pod:857
5360 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
5364 #: ../src/guestfs-actions.pod:862 ../src/guestfs-actions.pod:1209 ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:2806 ../src/guestfs-actions.pod:2835 ../src/guestfs-actions.pod:2896 ../src/guestfs-actions.pod:2923 ../src/guestfs-actions.pod:6165
5365 msgid "(Added in 1.0.2)"
5369 #: ../src/guestfs-actions.pod:864
5370 msgid "guestfs_checksum_device"
5374 #: ../src/guestfs-actions.pod:866
5378 " guestfs_checksum_device (guestfs_h *g,\n"
5379 " const char *csumtype,\n"
5380 " const char *device);\n"
5385 #: ../src/guestfs-actions.pod:871
5387 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5388 "device named C<device>. For the types of checksums supported see the "
5389 "C<guestfs_checksum> command."
5393 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:4275 ../src/guestfs-actions.pod:4334 ../src/guestfs-actions.pod:4371 ../src/guestfs-actions.pod:4389 ../src/guestfs-actions.pod:4566 ../src/guestfs-actions.pod:6079 ../src/guestfs-actions.pod:6093 ../src/guestfs-actions.pod:6490
5394 msgid "(Added in 1.3.2)"
5398 #: ../src/guestfs-actions.pod:880
5399 msgid "guestfs_checksums_out"
5403 #: ../src/guestfs-actions.pod:882
5407 " guestfs_checksums_out (guestfs_h *g,\n"
5408 " const char *csumtype,\n"
5409 " const char *directory,\n"
5410 " const char *sumsfile);\n"
5415 #: ../src/guestfs-actions.pod:888 ../fish/guestfish-actions.pod:610
5417 "This command computes the checksums of all regular files in C<directory> and "
5418 "then emits a list of those checksums to the local output file C<sumsfile>."
5422 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:614
5424 "This can be used for verifying the integrity of a virtual machine. However "
5425 "to be properly secure you should pay attention to the output of the checksum "
5426 "command (it uses the ones from GNU coreutils). In particular when the "
5427 "filename is not printable, coreutils uses a special backslash syntax. For "
5428 "more information, see the GNU coreutils info file."
5432 #: ../src/guestfs-actions.pod:902
5433 msgid "(Added in 1.3.7)"
5437 #: ../src/guestfs-actions.pod:904
5438 msgid "guestfs_chmod"
5442 #: ../src/guestfs-actions.pod:906
5446 " guestfs_chmod (guestfs_h *g,\n"
5448 " const char *path);\n"
5453 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:628
5455 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5460 #: ../src/guestfs-actions.pod:914 ../fish/guestfish-actions.pod:631
5462 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5463 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5468 #: ../src/guestfs-actions.pod:918 ../src/guestfs-actions.pod:3859 ../src/guestfs-actions.pod:3974 ../src/guestfs-actions.pod:3993 ../src/guestfs-actions.pod:4012 ../fish/guestfish-actions.pod:635 ../fish/guestfish-actions.pod:2570 ../fish/guestfish-actions.pod:2655 ../fish/guestfish-actions.pod:2665 ../fish/guestfish-actions.pod:2675
5469 msgid "The mode actually set is affected by the umask."
5473 #: ../src/guestfs-actions.pod:924
5474 msgid "guestfs_chown"
5478 #: ../src/guestfs-actions.pod:926
5482 " guestfs_chown (guestfs_h *g,\n"
5485 " const char *path);\n"
5490 #: ../src/guestfs-actions.pod:932 ../fish/guestfish-actions.pod:641
5491 msgid "Change the file owner to C<owner> and group to C<group>."
5495 #: ../src/guestfs-actions.pod:934 ../src/guestfs-actions.pod:2993 ../fish/guestfish-actions.pod:643 ../fish/guestfish-actions.pod:2048
5497 "Only numeric uid and gid are supported. If you want to use names, you will "
5498 "need to locate and parse the password file yourself (Augeas support makes "
5499 "this relatively easy)."
5503 #: ../src/guestfs-actions.pod:942
5504 msgid "guestfs_command"
5508 #: ../src/guestfs-actions.pod:944
5512 " guestfs_command (guestfs_h *g,\n"
5513 " char *const *arguments);\n"
5518 #: ../src/guestfs-actions.pod:948 ../fish/guestfish-actions.pod:651
5520 "This call runs a command from the guest filesystem. The filesystem must be "
5521 "mounted, and must contain a compatible operating system (ie. something "
5522 "Linux, with the same or compatible processor architecture)."
5526 #: ../src/guestfs-actions.pod:953
5528 "The single parameter is an argv-style list of arguments. The first element "
5529 "is the name of the program to run. Subsequent elements are parameters. The "
5530 "list must be non-empty (ie. must contain a program name). Note that the "
5531 "command runs directly, and is I<not> invoked via the shell (see "
5536 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:663
5537 msgid "The return value is anything printed to I<stdout> by the command."
5541 #: ../src/guestfs-actions.pod:963 ../fish/guestfish-actions.pod:666
5543 "If the command returns a non-zero exit status, then this function returns an "
5544 "error message. The error message string is the content of I<stderr> from "
5549 #: ../src/guestfs-actions.pod:967 ../fish/guestfish-actions.pod:670
5551 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
5552 "C</bin>. If you require a program from another location, you should provide "
5553 "the full path in the first parameter."
5557 #: ../src/guestfs-actions.pod:972 ../fish/guestfish-actions.pod:675
5559 "Shared libraries and data files required by the program must be available on "
5560 "filesystems which are mounted in the correct places. It is the caller's "
5561 "responsibility to ensure all filesystems that are needed are mounted at the "
5566 #: ../src/guestfs-actions.pod:984 ../src/guestfs-actions.pod:1004 ../src/guestfs-actions.pod:1506
5567 msgid "(Added in 0.9.1)"
5571 #: ../src/guestfs-actions.pod:986
5572 msgid "guestfs_command_lines"
5576 #: ../src/guestfs-actions.pod:988
5580 " guestfs_command_lines (guestfs_h *g,\n"
5581 " char *const *arguments);\n"
5586 #: ../src/guestfs-actions.pod:992
5588 "This is the same as C<guestfs_command>, but splits the result into a list of "
5593 #: ../src/guestfs-actions.pod:995
5594 msgid "See also: C<guestfs_sh_lines>"
5598 #: ../src/guestfs-actions.pod:1006
5599 msgid "guestfs_config"
5603 #: ../src/guestfs-actions.pod:1008
5607 " guestfs_config (guestfs_h *g,\n"
5608 " const char *qemuparam,\n"
5609 " const char *qemuvalue);\n"
5614 #: ../src/guestfs-actions.pod:1013 ../fish/guestfish-actions.pod:700
5616 "This can be used to add arbitrary qemu command line parameters of the form "
5617 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
5618 "setting some parameters which would interfere with parameters that we use."
5622 #: ../src/guestfs-actions.pod:1018 ../fish/guestfish-actions.pod:705
5623 msgid "The first character of C<param> string must be a C<-> (dash)."
5627 #: ../src/guestfs-actions.pod:1020 ../fish/guestfish-actions.pod:707
5628 msgid "C<value> can be NULL."
5632 #: ../src/guestfs-actions.pod:1026
5633 msgid "guestfs_copy_size"
5637 #: ../src/guestfs-actions.pod:1028
5641 " guestfs_copy_size (guestfs_h *g,\n"
5642 " const char *src,\n"
5643 " const char *dest,\n"
5649 #: ../src/guestfs-actions.pod:1034 ../fish/guestfish-actions.pod:713
5651 "This command copies exactly C<size> bytes from one source device or file "
5652 "C<src> to another destination device or file C<dest>."
5656 #: ../src/guestfs-actions.pod:1037 ../fish/guestfish-actions.pod:716
5658 "Note this will fail if the source is too short or if the destination is not "
5663 #: ../src/guestfs-actions.pod:1042 ../src/guestfs-actions.pod:1204 ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:1655 ../src/guestfs-actions.pod:1677 ../src/guestfs-actions.pod:6669 ../src/guestfs-actions.pod:6688
5665 "This long-running command can generate progress notification messages so "
5666 "that the caller can display a progress bar or indicator. To receive these "
5667 "messages, the caller must register a progress callback. See "
5668 "L<guestfs(3)/guestfs_set_progress_callback>."
5672 #: ../src/guestfs-actions.pod:1047 ../src/guestfs-actions.pod:3634 ../src/guestfs-actions.pod:4773 ../src/guestfs-actions.pod:6396 ../src/guestfs-actions.pod:6416 ../src/guestfs-actions.pod:6503
5673 msgid "(Added in 1.0.87)"
5677 #: ../src/guestfs-actions.pod:1049
5682 #: ../src/guestfs-actions.pod:1051
5686 " guestfs_cp (guestfs_h *g,\n"
5687 " const char *src,\n"
5688 " const char *dest);\n"
5693 #: ../src/guestfs-actions.pod:1056 ../fish/guestfish-actions.pod:723
5695 "This copies a file from C<src> to C<dest> where C<dest> is either a "
5696 "destination filename or destination directory."
5700 #: ../src/guestfs-actions.pod:1061 ../src/guestfs-actions.pod:1075 ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:1260 ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:4238 ../src/guestfs-actions.pod:4616
5701 msgid "(Added in 1.0.18)"
5705 #: ../src/guestfs-actions.pod:1063
5706 msgid "guestfs_cp_a"
5710 #: ../src/guestfs-actions.pod:1065
5714 " guestfs_cp_a (guestfs_h *g,\n"
5715 " const char *src,\n"
5716 " const char *dest);\n"
5721 #: ../src/guestfs-actions.pod:1070 ../fish/guestfish-actions.pod:730
5723 "This copies a file or directory from C<src> to C<dest> recursively using the "
5728 #: ../src/guestfs-actions.pod:1077
5733 #: ../src/guestfs-actions.pod:1079
5737 " guestfs_dd (guestfs_h *g,\n"
5738 " const char *src,\n"
5739 " const char *dest);\n"
5744 #: ../src/guestfs-actions.pod:1084 ../fish/guestfish-actions.pod:737
5746 "This command copies from one source device or file C<src> to another "
5747 "destination device or file C<dest>. Normally you would use this to copy to "
5748 "or from a device or partition, for example to duplicate a filesystem."
5752 #: ../src/guestfs-actions.pod:1089
5754 "If the destination is a device, it must be as large or larger than the "
5755 "source file or device, otherwise the copy will fail. This command cannot do "
5756 "partial copies (see C<guestfs_copy_size>)."
5760 #: ../src/guestfs-actions.pod:1097
5761 msgid "guestfs_debug"
5765 #: ../src/guestfs-actions.pod:1099
5769 " guestfs_debug (guestfs_h *g,\n"
5770 " const char *subcmd,\n"
5771 " char *const *extraargs);\n"
5776 #: ../src/guestfs-actions.pod:1104
5778 "The C<guestfs_debug> command exposes some internals of C<guestfsd> (the "
5779 "guestfs daemon) that runs inside the qemu subprocess."
5783 #: ../src/guestfs-actions.pod:1108 ../fish/guestfish-actions.pod:754
5785 "There is no comprehensive help for this command. You have to look at the "
5786 "file C<daemon/debug.c> in the libguestfs source to find out what you can do."
5790 #: ../src/guestfs-actions.pod:1115
5791 msgid "(Added in 1.0.11)"
5795 #: ../src/guestfs-actions.pod:1117
5796 msgid "guestfs_debug_upload"
5800 #: ../src/guestfs-actions.pod:1119
5804 " guestfs_debug_upload (guestfs_h *g,\n"
5805 " const char *filename,\n"
5806 " const char *tmpname,\n"
5812 #: ../src/guestfs-actions.pod:1125
5814 "The C<guestfs_debug_upload> command uploads a file to the libguestfs "
5819 #: ../src/guestfs-actions.pod:1128 ../fish/guestfish-actions.pod:765
5821 "There is no comprehensive help for this command. You have to look at the "
5822 "file C<daemon/debug.c> in the libguestfs source to find out what it is for."
5826 #: ../src/guestfs-actions.pod:1136
5831 #: ../src/guestfs-actions.pod:1138
5835 " guestfs_df (guestfs_h *g);\n"
5840 #: ../src/guestfs-actions.pod:1141 ../fish/guestfish-actions.pod:775
5841 msgid "This command runs the C<df> command to report disk space used."
5845 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:777 ../fish/guestfish-actions.pod:788
5847 "This command is mostly useful for interactive sessions. It is I<not> "
5848 "intended that you try to parse the output string. Use C<statvfs> from "
5853 #: ../src/guestfs-actions.pod:1150 ../src/guestfs-actions.pod:1167 ../src/guestfs-actions.pod:1280 ../src/guestfs-actions.pod:2205 ../src/guestfs-actions.pod:2229 ../src/guestfs-actions.pod:2297 ../src/guestfs-actions.pod:3745 ../src/guestfs-actions.pod:4138 ../src/guestfs-actions.pod:5903 ../src/guestfs-actions.pod:5927 ../src/guestfs-actions.pod:6536 ../src/guestfs-actions.pod:6549 ../src/guestfs-actions.pod:6562
5854 msgid "(Added in 1.0.54)"
5858 #: ../src/guestfs-actions.pod:1152
5859 msgid "guestfs_df_h"
5863 #: ../src/guestfs-actions.pod:1154
5867 " guestfs_df_h (guestfs_h *g);\n"
5872 #: ../src/guestfs-actions.pod:1157 ../fish/guestfish-actions.pod:785
5874 "This command runs the C<df -h> command to report disk space used in "
5875 "human-readable format."
5879 #: ../src/guestfs-actions.pod:1169
5880 msgid "guestfs_dmesg"
5884 #: ../src/guestfs-actions.pod:1171
5888 " guestfs_dmesg (guestfs_h *g);\n"
5893 #: ../src/guestfs-actions.pod:1174 ../fish/guestfish-actions.pod:796
5895 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
5896 "This is sometimes useful for extended debugging of problems."
5900 #: ../src/guestfs-actions.pod:1178
5902 "Another way to get the same information is to enable verbose messages with "
5903 "C<guestfs_set_verbose> or by setting the environment variable "
5904 "C<LIBGUESTFS_DEBUG=1> before running the program."
5908 #: ../src/guestfs-actions.pod:1188
5909 msgid "guestfs_download"
5913 #: ../src/guestfs-actions.pod:1190
5917 " guestfs_download (guestfs_h *g,\n"
5918 " const char *remotefilename,\n"
5919 " const char *filename);\n"
5924 #: ../src/guestfs-actions.pod:1195 ../src/guestfs-actions.pod:1220 ../fish/guestfish-actions.pod:809 ../fish/guestfish-actions.pod:822
5926 "Download file C<remotefilename> and save it as C<filename> on the local "
5931 #: ../src/guestfs-actions.pod:1198 ../src/guestfs-actions.pod:6159 ../fish/guestfish-actions.pod:812 ../fish/guestfish-actions.pod:4090
5932 msgid "C<filename> can also be a named pipe."
5936 #: ../src/guestfs-actions.pod:1200
5937 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
5941 #: ../src/guestfs-actions.pod:1211
5942 msgid "guestfs_download_offset"
5946 #: ../src/guestfs-actions.pod:1213
5950 " guestfs_download_offset (guestfs_h *g,\n"
5951 " const char *remotefilename,\n"
5952 " const char *filename,\n"
5953 " int64_t offset,\n"
5959 #: ../src/guestfs-actions.pod:1223 ../fish/guestfish-actions.pod:825
5961 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
5962 "region must be within the file or device)."
5966 #: ../src/guestfs-actions.pod:1226
5968 "Note that there is no limit on the amount of data that can be downloaded "
5969 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
5970 "full amount unless an error occurs."
5974 #: ../src/guestfs-actions.pod:1231
5975 msgid "See also C<guestfs_download>, C<guestfs_pread>."
5979 #: ../src/guestfs-actions.pod:1240 ../src/guestfs-actions.pod:6194
5980 msgid "(Added in 1.5.17)"
5984 #: ../src/guestfs-actions.pod:1242
5985 msgid "guestfs_drop_caches"
5989 #: ../src/guestfs-actions.pod:1244
5993 " guestfs_drop_caches (guestfs_h *g,\n"
5994 " int whattodrop);\n"
5999 #: ../src/guestfs-actions.pod:1248 ../fish/guestfish-actions.pod:841
6001 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6002 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6003 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6007 #: ../src/guestfs-actions.pod:1253 ../fish/guestfish-actions.pod:846
6008 msgid "Setting C<whattodrop> to 3 should drop everything."
6012 #: ../src/guestfs-actions.pod:1255 ../fish/guestfish-actions.pod:848
6014 "This automatically calls L<sync(2)> before the operation, so that the "
6015 "maximum guest memory is freed."
6019 #: ../src/guestfs-actions.pod:1262
6024 #: ../src/guestfs-actions.pod:1264
6028 " guestfs_du (guestfs_h *g,\n"
6029 " const char *path);\n"
6034 #: ../src/guestfs-actions.pod:1268 ../fish/guestfish-actions.pod:855
6036 "This command runs the C<du -s> command to estimate file space usage for "
6041 #: ../src/guestfs-actions.pod:1271 ../fish/guestfish-actions.pod:858
6043 "C<path> can be a file or a directory. If C<path> is a directory then the "
6044 "estimate includes the contents of the directory and all subdirectories "
6049 #: ../src/guestfs-actions.pod:1275 ../fish/guestfish-actions.pod:862
6050 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6054 #: ../src/guestfs-actions.pod:1282
6055 msgid "guestfs_e2fsck_f"
6059 #: ../src/guestfs-actions.pod:1284
6063 " guestfs_e2fsck_f (guestfs_h *g,\n"
6064 " const char *device);\n"
6069 #: ../src/guestfs-actions.pod:1288 ../fish/guestfish-actions.pod:869
6071 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6072 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
6077 #: ../src/guestfs-actions.pod:1292
6079 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
6080 "Normally you should use C<guestfs_fsck>."
6084 #: ../src/guestfs-actions.pod:1297
6085 msgid "(Added in 1.0.29)"
6089 #: ../src/guestfs-actions.pod:1299
6090 msgid "guestfs_echo_daemon"
6094 #: ../src/guestfs-actions.pod:1301
6098 " guestfs_echo_daemon (guestfs_h *g,\n"
6099 " char *const *words);\n"
6104 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:880
6106 "This command concatenates the list of C<words> passed with single spaces "
6107 "between them and returns the resulting string."
6111 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:883
6112 msgid "You can use this command to test the connection through to the daemon."
6116 #: ../src/guestfs-actions.pod:1310
6117 msgid "See also C<guestfs_ping_daemon>."
6121 #: ../src/guestfs-actions.pod:1315 ../src/guestfs-actions.pod:2042 ../src/guestfs-actions.pod:5407
6122 msgid "(Added in 1.0.69)"
6126 #: ../src/guestfs-actions.pod:1317
6127 msgid "guestfs_egrep"
6131 #: ../src/guestfs-actions.pod:1319
6135 " guestfs_egrep (guestfs_h *g,\n"
6136 " const char *regex,\n"
6137 " const char *path);\n"
6142 #: ../src/guestfs-actions.pod:1324 ../fish/guestfish-actions.pod:891
6143 msgid "This calls the external C<egrep> program and returns the matching lines."
6147 #: ../src/guestfs-actions.pod:1334 ../src/guestfs-actions.pod:1353 ../src/guestfs-actions.pod:1410 ../src/guestfs-actions.pod:1456 ../src/guestfs-actions.pod:1475 ../src/guestfs-actions.pod:2143 ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:2318 ../src/guestfs-actions.pod:2331 ../src/guestfs-actions.pod:2346 ../src/guestfs-actions.pod:2392 ../src/guestfs-actions.pod:2415 ../src/guestfs-actions.pod:2428 ../src/guestfs-actions.pod:3125 ../src/guestfs-actions.pod:3139 ../src/guestfs-actions.pod:3152 ../src/guestfs-actions.pod:3166 ../src/guestfs-actions.pod:4073 ../src/guestfs-actions.pod:4952 ../src/guestfs-actions.pod:5001 ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5783 ../src/guestfs-actions.pod:5796 ../src/guestfs-actions.pod:5809 ../src/guestfs-actions.pod:5831 ../src/guestfs-actions.pod:5844 ../src/guestfs-actions.pod:5857 ../src/guestfs-actions.pod:5870 ../src/guestfs-actions.pod:6632 ../src/guestfs-actions.pod:6651 ../src/guestfs-actions.pod:6736 ../src/guestfs-actions.pod:6755 ../src/guestfs-actions.pod:6801 ../src/guestfs-actions.pod:6820
6148 msgid "(Added in 1.0.66)"
6152 #: ../src/guestfs-actions.pod:1336
6153 msgid "guestfs_egrepi"
6157 #: ../src/guestfs-actions.pod:1338
6161 " guestfs_egrepi (guestfs_h *g,\n"
6162 " const char *regex,\n"
6163 " const char *path);\n"
6168 #: ../src/guestfs-actions.pod:1343 ../fish/guestfish-actions.pod:901
6169 msgid "This calls the external C<egrep -i> program and returns the matching lines."
6173 #: ../src/guestfs-actions.pod:1355
6174 msgid "guestfs_equal"
6178 #: ../src/guestfs-actions.pod:1357
6182 " guestfs_equal (guestfs_h *g,\n"
6183 " const char *file1,\n"
6184 " const char *file2);\n"
6189 #: ../src/guestfs-actions.pod:1362 ../fish/guestfish-actions.pod:911
6191 "This compares the two files C<file1> and C<file2> and returns true if their "
6192 "content is exactly equal, or false otherwise."
6196 #: ../src/guestfs-actions.pod:1365 ../fish/guestfish-actions.pod:914
6197 msgid "The external L<cmp(1)> program is used for the comparison."
6201 #: ../src/guestfs-actions.pod:1371
6202 msgid "guestfs_exists"
6206 #: ../src/guestfs-actions.pod:1373
6210 " guestfs_exists (guestfs_h *g,\n"
6211 " const char *path);\n"
6216 #: ../src/guestfs-actions.pod:1377 ../fish/guestfish-actions.pod:920
6218 "This returns C<true> if and only if there is a file, directory (or anything) "
6219 "with the given C<path> name."
6223 #: ../src/guestfs-actions.pod:1380
6224 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6228 #: ../src/guestfs-actions.pod:1386
6229 msgid "guestfs_fallocate"
6233 #: ../src/guestfs-actions.pod:1388
6237 " guestfs_fallocate (guestfs_h *g,\n"
6238 " const char *path,\n"
6244 #: ../src/guestfs-actions.pod:1393 ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:929 ../fish/guestfish-actions.pod:948
6246 "This command preallocates a file (containing zero bytes) named C<path> of "
6247 "size C<len> bytes. If the file exists already, it is overwritten."
6251 #: ../src/guestfs-actions.pod:1397 ../fish/guestfish-actions.pod:933
6253 "Do not confuse this with the guestfish-specific C<alloc> command which "
6254 "allocates a file in the host and attaches it as a device."
6258 #: ../src/guestfs-actions.pod:1403 ../fish/guestfish-actions.pod:937
6260 "This function is deprecated. In new code, use the C<fallocate64> call "
6265 #: ../src/guestfs-actions.pod:1412
6266 msgid "guestfs_fallocate64"
6270 #: ../src/guestfs-actions.pod:1414
6274 " guestfs_fallocate64 (guestfs_h *g,\n"
6275 " const char *path,\n"
6281 #: ../src/guestfs-actions.pod:1423
6283 "Note that this call allocates disk blocks for the file. To create a sparse "
6284 "file use C<guestfs_truncate_size> instead."
6288 #: ../src/guestfs-actions.pod:1426
6290 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6291 "oversight it only allowed 30 bit lengths to be specified, effectively "
6292 "limiting the maximum size of files created through that call to 1GB."
6296 #: ../src/guestfs-actions.pod:1431 ../fish/guestfish-actions.pod:960
6298 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6299 "commands which create a file in the host and attach it as a device."
6303 #: ../src/guestfs-actions.pod:1437
6304 msgid "(Added in 1.3.17)"
6308 #: ../src/guestfs-actions.pod:1439
6309 msgid "guestfs_fgrep"
6313 #: ../src/guestfs-actions.pod:1441
6317 " guestfs_fgrep (guestfs_h *g,\n"
6318 " const char *pattern,\n"
6319 " const char *path);\n"
6324 #: ../src/guestfs-actions.pod:1446 ../fish/guestfish-actions.pod:968
6325 msgid "This calls the external C<fgrep> program and returns the matching lines."
6329 #: ../src/guestfs-actions.pod:1458
6330 msgid "guestfs_fgrepi"
6334 #: ../src/guestfs-actions.pod:1460
6338 " guestfs_fgrepi (guestfs_h *g,\n"
6339 " const char *pattern,\n"
6340 " const char *path);\n"
6345 #: ../src/guestfs-actions.pod:1465 ../fish/guestfish-actions.pod:978
6346 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
6350 #: ../src/guestfs-actions.pod:1477
6351 msgid "guestfs_file"
6355 #: ../src/guestfs-actions.pod:1479
6359 " guestfs_file (guestfs_h *g,\n"
6360 " const char *path);\n"
6365 #: ../src/guestfs-actions.pod:1483 ../fish/guestfish-actions.pod:988
6367 "This call uses the standard L<file(1)> command to determine the type or "
6368 "contents of the file."
6372 #: ../src/guestfs-actions.pod:1486 ../fish/guestfish-actions.pod:991
6374 "This call will also transparently look inside various types of compressed "
6379 #: ../src/guestfs-actions.pod:1489 ../fish/guestfish-actions.pod:994
6381 "The exact command which runs is C<file -zb path>. Note in particular that "
6382 "the filename is not prepended to the output (the C<-b> option)."
6386 #: ../src/guestfs-actions.pod:1493
6388 "This command can also be used on C</dev/> devices (and partitions, LV "
6389 "names). You can for example use this to determine if a device contains a "
6390 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
6394 #: ../src/guestfs-actions.pod:1498 ../fish/guestfish-actions.pod:1003
6396 "If the C<path> does not begin with C</dev/> then this command only works for "
6397 "the content of regular files. For other file types (directory, symbolic "
6398 "link etc) it will just return the string C<directory> etc."
6402 #: ../src/guestfs-actions.pod:1508
6403 msgid "guestfs_file_architecture"
6407 #: ../src/guestfs-actions.pod:1510
6411 " guestfs_file_architecture (guestfs_h *g,\n"
6412 " const char *filename);\n"
6417 #: ../src/guestfs-actions.pod:1514 ../fish/guestfish-actions.pod:1012
6419 "This detects the architecture of the binary C<filename>, and returns it if "
6424 #: ../src/guestfs-actions.pod:1517 ../fish/guestfish-actions.pod:1015
6425 msgid "Currently defined architectures are:"
6429 #: ../src/guestfs-actions.pod:1521 ../fish/guestfish-actions.pod:1019
6434 #: ../src/guestfs-actions.pod:1523 ../fish/guestfish-actions.pod:1021
6436 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6437 "irrespective of the precise processor requirements of the binary."
6441 #: ../src/guestfs-actions.pod:1526 ../fish/guestfish-actions.pod:1024
6446 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1026
6447 msgid "64 bit x86-64."
6451 #: ../src/guestfs-actions.pod:1530 ../fish/guestfish-actions.pod:1028
6456 #: ../src/guestfs-actions.pod:1532 ../fish/guestfish-actions.pod:1030
6457 msgid "32 bit SPARC."
6461 #: ../src/guestfs-actions.pod:1534 ../fish/guestfish-actions.pod:1032
6466 #: ../src/guestfs-actions.pod:1536 ../fish/guestfish-actions.pod:1034
6467 msgid "64 bit SPARC V9 and above."
6471 #: ../src/guestfs-actions.pod:1538 ../fish/guestfish-actions.pod:1036
6476 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1038
6477 msgid "Intel Itanium."
6481 #: ../src/guestfs-actions.pod:1542 ../fish/guestfish-actions.pod:1040
6486 #: ../src/guestfs-actions.pod:1544 ../fish/guestfish-actions.pod:1042
6487 msgid "32 bit Power PC."
6491 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1044
6496 #: ../src/guestfs-actions.pod:1548 ../fish/guestfish-actions.pod:1046
6497 msgid "64 bit Power PC."
6501 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1050
6502 msgid "Libguestfs may return other architecture strings in future."
6506 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1052
6507 msgid "The function works on at least the following types of files:"
6511 #: ../src/guestfs-actions.pod:1560 ../fish/guestfish-actions.pod:1058
6512 msgid "many types of Un*x and Linux binary"
6516 #: ../src/guestfs-actions.pod:1564 ../fish/guestfish-actions.pod:1062
6517 msgid "many types of Un*x and Linux shared library"
6521 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1066
6522 msgid "Windows Win32 and Win64 binaries"
6526 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1070
6527 msgid "Windows Win32 and Win64 DLLs"
6531 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1072
6532 msgid "Win32 binaries and DLLs return C<i386>."
6536 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1074
6537 msgid "Win64 binaries and DLLs return C<x86_64>."
6541 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1078
6542 msgid "Linux kernel modules"
6546 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1082
6547 msgid "Linux new-style initrd images"
6551 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1086
6552 msgid "some non-x86 Linux vmlinuz kernels"
6556 #: ../src/guestfs-actions.pod:1592 ../fish/guestfish-actions.pod:1090
6557 msgid "What it can't do currently:"
6561 #: ../src/guestfs-actions.pod:1598 ../fish/guestfish-actions.pod:1096
6562 msgid "static libraries (libfoo.a)"
6566 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1100
6567 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6571 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1104
6572 msgid "x86 Linux vmlinuz kernels"
6576 #: ../src/guestfs-actions.pod:1608 ../fish/guestfish-actions.pod:1106
6578 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6579 "compressed code, and are horribly hard to unpack. If you want to find the "
6580 "architecture of a kernel, use the architecture of the associated initrd or "
6581 "kernel module(s) instead."
6585 #: ../src/guestfs-actions.pod:1618 ../src/guestfs-actions.pod:1781 ../src/guestfs-actions.pod:1798 ../src/guestfs-actions.pod:2451 ../src/guestfs-actions.pod:2524 ../src/guestfs-actions.pod:2550 ../src/guestfs-actions.pod:2577 ../src/guestfs-actions.pod:2598 ../src/guestfs-actions.pod:2631 ../src/guestfs-actions.pod:2655 ../src/guestfs-actions.pod:2711 ../src/guestfs-actions.pod:2777 ../src/guestfs-actions.pod:2909
6586 msgid "(Added in 1.5.3)"
6590 #: ../src/guestfs-actions.pod:1620
6591 msgid "guestfs_filesize"
6595 #: ../src/guestfs-actions.pod:1622
6599 " guestfs_filesize (guestfs_h *g,\n"
6600 " const char *file);\n"
6605 #: ../src/guestfs-actions.pod:1626 ../fish/guestfish-actions.pod:1117
6606 msgid "This command returns the size of C<file> in bytes."
6610 #: ../src/guestfs-actions.pod:1628
6612 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
6613 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
6614 "devices, use C<guestfs_blockdev_getsize64>."
6618 #: ../src/guestfs-actions.pod:1634
6619 msgid "(Added in 1.0.82)"
6623 #: ../src/guestfs-actions.pod:1636
6624 msgid "guestfs_fill"
6628 #: ../src/guestfs-actions.pod:1638
6632 " guestfs_fill (guestfs_h *g,\n"
6635 " const char *path);\n"
6640 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1127
6642 "This command creates a new file called C<path>. The initial content of the "
6643 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
6648 #: ../src/guestfs-actions.pod:1648
6650 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6651 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
6652 "bytes use C<guestfs_fill_pattern>."
6656 #: ../src/guestfs-actions.pod:1660
6657 msgid "(Added in 1.0.79)"
6661 #: ../src/guestfs-actions.pod:1662
6662 msgid "guestfs_fill_pattern"
6666 #: ../src/guestfs-actions.pod:1664
6670 " guestfs_fill_pattern (guestfs_h *g,\n"
6671 " const char *pattern,\n"
6673 " const char *path);\n"
6678 #: ../src/guestfs-actions.pod:1670
6680 "This function is like C<guestfs_fill> except that it creates a new file of "
6681 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
6682 "pattern is truncated if necessary to ensure the length of the file is "
6683 "exactly C<len> bytes."
6687 #: ../src/guestfs-actions.pod:1682
6688 msgid "(Added in 1.3.12)"
6692 #: ../src/guestfs-actions.pod:1684
6693 msgid "guestfs_find"
6697 #: ../src/guestfs-actions.pod:1686
6701 " guestfs_find (guestfs_h *g,\n"
6702 " const char *directory);\n"
6707 #: ../src/guestfs-actions.pod:1690 ../fish/guestfish-actions.pod:1149
6709 "This command lists out all files and directories, recursively, starting at "
6710 "C<directory>. It is essentially equivalent to running the shell command "
6711 "C<find directory -print> but some post-processing happens on the output, "
6716 #: ../src/guestfs-actions.pod:1695 ../fish/guestfish-actions.pod:1154
6718 "This returns a list of strings I<without any prefix>. Thus if the directory "
6723 #: ../src/guestfs-actions.pod:1698 ../fish/guestfish-actions.pod:1157
6733 #: ../src/guestfs-actions.pod:1702
6734 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
6738 #: ../src/guestfs-actions.pod:1705 ../fish/guestfish-actions.pod:1164
6749 #: ../src/guestfs-actions.pod:1710 ../fish/guestfish-actions.pod:1169
6750 msgid "If C<directory> is not a directory, then this command returns an error."
6754 #: ../src/guestfs-actions.pod:1713 ../fish/guestfish-actions.pod:1172
6755 msgid "The returned list is sorted."
6759 #: ../src/guestfs-actions.pod:1715
6760 msgid "See also C<guestfs_find0>."
6764 #: ../src/guestfs-actions.pod:1724 ../src/guestfs-actions.pod:3570 ../src/guestfs-actions.pod:5036
6765 msgid "(Added in 1.0.27)"
6769 #: ../src/guestfs-actions.pod:1726
6770 msgid "guestfs_find0"
6774 #: ../src/guestfs-actions.pod:1728
6778 " guestfs_find0 (guestfs_h *g,\n"
6779 " const char *directory,\n"
6780 " const char *files);\n"
6785 #: ../src/guestfs-actions.pod:1733 ../fish/guestfish-actions.pod:1183
6787 "This command lists out all files and directories, recursively, starting at "
6788 "C<directory>, placing the resulting list in the external file called "
6793 #: ../src/guestfs-actions.pod:1737
6795 "This command works the same way as C<guestfs_find> with the following "
6800 #: ../src/guestfs-actions.pod:1744 ../fish/guestfish-actions.pod:1194
6801 msgid "The resulting list is written to an external file."
6805 #: ../src/guestfs-actions.pod:1748 ../fish/guestfish-actions.pod:1198
6807 "Items (filenames) in the result are separated by C<\\0> characters. See "
6808 "L<find(1)> option I<-print0>."
6812 #: ../src/guestfs-actions.pod:1753 ../fish/guestfish-actions.pod:1203
6813 msgid "This command is not limited in the number of names that it can return."
6817 #: ../src/guestfs-actions.pod:1758 ../fish/guestfish-actions.pod:1208
6818 msgid "The result list is not sorted."
6822 #: ../src/guestfs-actions.pod:1764
6823 msgid "(Added in 1.0.74)"
6827 #: ../src/guestfs-actions.pod:1766
6828 msgid "guestfs_findfs_label"
6832 #: ../src/guestfs-actions.pod:1768
6836 " guestfs_findfs_label (guestfs_h *g,\n"
6837 " const char *label);\n"
6842 #: ../src/guestfs-actions.pod:1772 ../fish/guestfish-actions.pod:1218
6844 "This command searches the filesystems and returns the one which has the "
6845 "given label. An error is returned if no such filesystem can be found."
6849 #: ../src/guestfs-actions.pod:1776
6850 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
6854 #: ../src/guestfs-actions.pod:1783
6855 msgid "guestfs_findfs_uuid"
6859 #: ../src/guestfs-actions.pod:1785
6863 " guestfs_findfs_uuid (guestfs_h *g,\n"
6864 " const char *uuid);\n"
6869 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1228
6871 "This command searches the filesystems and returns the one which has the "
6872 "given UUID. An error is returned if no such filesystem can be found."
6876 #: ../src/guestfs-actions.pod:1793
6877 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
6881 #: ../src/guestfs-actions.pod:1800
6882 msgid "guestfs_fsck"
6886 #: ../src/guestfs-actions.pod:1802
6890 " guestfs_fsck (guestfs_h *g,\n"
6891 " const char *fstype,\n"
6892 " const char *device);\n"
6897 #: ../src/guestfs-actions.pod:1807 ../fish/guestfish-actions.pod:1238
6899 "This runs the filesystem checker (fsck) on C<device> which should have "
6900 "filesystem type C<fstype>."
6904 #: ../src/guestfs-actions.pod:1810 ../fish/guestfish-actions.pod:1241
6906 "The returned integer is the status. See L<fsck(8)> for the list of status "
6907 "codes from C<fsck>."
6911 #: ../src/guestfs-actions.pod:1819 ../fish/guestfish-actions.pod:1250
6912 msgid "Multiple status codes can be summed together."
6916 #: ../src/guestfs-actions.pod:1823 ../fish/guestfish-actions.pod:1254
6918 "A non-zero return code can mean \"success\", for example if errors have been "
6919 "corrected on the filesystem."
6923 #: ../src/guestfs-actions.pod:1828 ../fish/guestfish-actions.pod:1259
6924 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
6928 #: ../src/guestfs-actions.pod:1833 ../fish/guestfish-actions.pod:1264
6929 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
6933 #: ../src/guestfs-actions.pod:1837 ../src/guestfs-actions.pod:6674
6934 msgid "(Added in 1.0.16)"
6938 #: ../src/guestfs-actions.pod:1839
6939 msgid "guestfs_get_append"
6943 #: ../src/guestfs-actions.pod:1841
6947 " guestfs_get_append (guestfs_h *g);\n"
6952 #: ../src/guestfs-actions.pod:1844 ../fish/guestfish-actions.pod:1270
6954 "Return the additional kernel options which are added to the guest kernel "
6959 #: ../src/guestfs-actions.pod:1847 ../fish/guestfish-actions.pod:1273
6960 msgid "If C<NULL> then no options are added."
6964 #: ../src/guestfs-actions.pod:1849
6966 "This function returns a string which may be NULL. There is no way to return "
6967 "an error from this function. The string is owned by the guest handle and "
6968 "must I<not> be freed."
6972 #: ../src/guestfs-actions.pod:1853 ../src/guestfs-actions.pod:4712 ../src/guestfs-actions.pod:5177 ../src/guestfs-actions.pod:5545 ../src/guestfs-actions.pod:5564 ../src/guestfs-actions.pod:5580 ../src/guestfs-actions.pod:5597 ../src/guestfs-actions.pod:6344 ../src/guestfs-actions.pod:6362 ../src/guestfs-actions.pod:6717
6973 msgid "(Added in 1.0.26)"
6977 #: ../src/guestfs-actions.pod:1855
6978 msgid "guestfs_get_autosync"
6982 #: ../src/guestfs-actions.pod:1857
6986 " guestfs_get_autosync (guestfs_h *g);\n"
6991 #: ../src/guestfs-actions.pod:1860 ../fish/guestfish-actions.pod:1279
6992 msgid "Get the autosync flag."
6996 #: ../src/guestfs-actions.pod:1866
6997 msgid "guestfs_get_direct"
7001 #: ../src/guestfs-actions.pod:1868
7005 " guestfs_get_direct (guestfs_h *g);\n"
7010 #: ../src/guestfs-actions.pod:1871 ../fish/guestfish-actions.pod:1285
7011 msgid "Return the direct appliance mode flag."
7015 #: ../src/guestfs-actions.pod:1875 ../src/guestfs-actions.pod:5218
7016 msgid "(Added in 1.0.72)"
7020 #: ../src/guestfs-actions.pod:1877
7021 msgid "guestfs_get_e2label"
7025 #: ../src/guestfs-actions.pod:1879
7029 " guestfs_get_e2label (guestfs_h *g,\n"
7030 " const char *device);\n"
7035 #: ../src/guestfs-actions.pod:1883 ../fish/guestfish-actions.pod:1291
7036 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7040 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1294
7042 "This function is deprecated. In new code, use the C<vfs_label> call "
7047 #: ../src/guestfs-actions.pod:1896 ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:5236 ../src/guestfs-actions.pod:5255
7048 msgid "(Added in 1.0.15)"
7052 #: ../src/guestfs-actions.pod:1898
7053 msgid "guestfs_get_e2uuid"
7057 #: ../src/guestfs-actions.pod:1900
7061 " guestfs_get_e2uuid (guestfs_h *g,\n"
7062 " const char *device);\n"
7067 #: ../src/guestfs-actions.pod:1904 ../fish/guestfish-actions.pod:1305
7068 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7072 #: ../src/guestfs-actions.pod:1910 ../fish/guestfish-actions.pod:1308
7073 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
7077 #: ../src/guestfs-actions.pod:1919
7078 msgid "guestfs_get_memsize"
7082 #: ../src/guestfs-actions.pod:1921
7086 " guestfs_get_memsize (guestfs_h *g);\n"
7091 #: ../src/guestfs-actions.pod:1924 ../fish/guestfish-actions.pod:1319
7092 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
7096 #: ../src/guestfs-actions.pod:1927
7098 "If C<guestfs_set_memsize> was not called on this handle, and if "
7099 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7100 "value for memsize."
7104 #: ../src/guestfs-actions.pod:1931 ../src/guestfs-actions.pod:2012 ../src/guestfs-actions.pod:5271 ../src/guestfs-actions.pod:5378 ../fish/guestfish-actions.pod:1326 ../fish/guestfish-actions.pod:1377 ../fish/guestfish-actions.pod:3497 ../fish/guestfish-actions.pod:3584
7105 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7109 #: ../src/guestfs-actions.pod:1936 ../src/guestfs-actions.pod:3863 ../src/guestfs-actions.pod:3978 ../src/guestfs-actions.pod:3997 ../src/guestfs-actions.pod:4016 ../src/guestfs-actions.pod:4028 ../src/guestfs-actions.pod:4045 ../src/guestfs-actions.pod:4058 ../src/guestfs-actions.pod:4939 ../src/guestfs-actions.pod:5276 ../src/guestfs-actions.pod:5519 ../src/guestfs-actions.pod:6120
7110 msgid "(Added in 1.0.55)"
7114 #: ../src/guestfs-actions.pod:1938
7115 msgid "guestfs_get_network"
7119 #: ../src/guestfs-actions.pod:1940
7123 " guestfs_get_network (guestfs_h *g);\n"
7128 #: ../src/guestfs-actions.pod:1943 ../fish/guestfish-actions.pod:1333
7129 msgid "This returns the enable network flag."
7133 #: ../src/guestfs-actions.pod:1947 ../src/guestfs-actions.pod:5295
7134 msgid "(Added in 1.5.4)"
7138 #: ../src/guestfs-actions.pod:1949
7139 msgid "guestfs_get_path"
7143 #: ../src/guestfs-actions.pod:1951
7147 " guestfs_get_path (guestfs_h *g);\n"
7152 #: ../src/guestfs-actions.pod:1954 ../fish/guestfish-actions.pod:1339
7153 msgid "Return the current search path."
7157 #: ../src/guestfs-actions.pod:1956 ../fish/guestfish-actions.pod:1341
7159 "This is always non-NULL. If it wasn't set already, then this will return "
7164 #: ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:1988
7166 "This function returns a string, or NULL on error. The string is owned by "
7167 "the guest handle and must I<not> be freed."
7171 #: ../src/guestfs-actions.pod:1964
7172 msgid "guestfs_get_pid"
7176 #: ../src/guestfs-actions.pod:1966
7180 " guestfs_get_pid (guestfs_h *g);\n"
7185 #: ../src/guestfs-actions.pod:1969 ../fish/guestfish-actions.pod:1350
7187 "Return the process ID of the qemu subprocess. If there is no qemu "
7188 "subprocess, then this will return an error."
7192 #: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1353
7193 msgid "This is an internal call used for debugging and testing."
7197 #: ../src/guestfs-actions.pod:1976
7198 msgid "(Added in 1.0.56)"
7202 #: ../src/guestfs-actions.pod:1978
7203 msgid "guestfs_get_qemu"
7207 #: ../src/guestfs-actions.pod:1980
7211 " guestfs_get_qemu (guestfs_h *g);\n"
7216 #: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1359
7217 msgid "Return the current qemu binary."
7221 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1361
7223 "This is always non-NULL. If it wasn't set already, then this will return "
7224 "the default qemu binary name."
7228 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:5340
7229 msgid "(Added in 1.0.6)"
7233 #: ../src/guestfs-actions.pod:1993
7234 msgid "guestfs_get_recovery_proc"
7238 #: ../src/guestfs-actions.pod:1995
7242 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7247 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1368
7248 msgid "Return the recovery process enabled flag."
7252 #: ../src/guestfs-actions.pod:2002 ../src/guestfs-actions.pod:2999 ../src/guestfs-actions.pod:3268 ../src/guestfs-actions.pod:3670 ../src/guestfs-actions.pod:3702 ../src/guestfs-actions.pod:4642 ../src/guestfs-actions.pod:4987 ../src/guestfs-actions.pod:5364 ../src/guestfs-actions.pod:6023 ../src/guestfs-actions.pod:6043 ../src/guestfs-actions.pod:6225
7253 msgid "(Added in 1.0.77)"
7257 #: ../src/guestfs-actions.pod:2004
7258 msgid "guestfs_get_selinux"
7262 #: ../src/guestfs-actions.pod:2006
7266 " guestfs_get_selinux (guestfs_h *g);\n"
7271 #: ../src/guestfs-actions.pod:2009
7273 "This returns the current setting of the selinux flag which is passed to the "
7274 "appliance at boot time. See C<guestfs_set_selinux>."
7278 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2080 ../src/guestfs-actions.pod:5383 ../src/guestfs-actions.pod:5437
7279 msgid "(Added in 1.0.67)"
7283 #: ../src/guestfs-actions.pod:2019
7284 msgid "guestfs_get_state"
7288 #: ../src/guestfs-actions.pod:2021
7292 " guestfs_get_state (guestfs_h *g);\n"
7297 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1384
7299 "This returns the current state as an opaque integer. This is only useful "
7300 "for printing debug and internal error messages."
7304 #: ../src/guestfs-actions.pod:2027 ../src/guestfs-actions.pod:2802 ../src/guestfs-actions.pod:2831 ../src/guestfs-actions.pod:2892 ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:1387 ../fish/guestfish-actions.pod:1930 ../fish/guestfish-actions.pod:1948 ../fish/guestfish-actions.pod:1986 ../fish/guestfish-actions.pod:2002
7305 msgid "For more information on states, see L<guestfs(3)>."
7309 #: ../src/guestfs-actions.pod:2033
7310 msgid "guestfs_get_trace"
7314 #: ../src/guestfs-actions.pod:2035
7318 " guestfs_get_trace (guestfs_h *g);\n"
7323 #: ../src/guestfs-actions.pod:2038 ../fish/guestfish-actions.pod:1393
7324 msgid "Return the command trace flag."
7328 #: ../src/guestfs-actions.pod:2044
7329 msgid "guestfs_get_umask"
7333 #: ../src/guestfs-actions.pod:2046
7337 " guestfs_get_umask (guestfs_h *g);\n"
7342 #: ../src/guestfs-actions.pod:2049
7344 "Return the current umask. By default the umask is C<022> unless it has been "
7345 "set by calling C<guestfs_umask>."
7349 #: ../src/guestfs-actions.pod:2056
7350 msgid "guestfs_get_verbose"
7354 #: ../src/guestfs-actions.pod:2058
7358 " guestfs_get_verbose (guestfs_h *g);\n"
7363 #: ../src/guestfs-actions.pod:2061 ../fish/guestfish-actions.pod:1406
7364 msgid "This returns the verbose messages flag."
7368 #: ../src/guestfs-actions.pod:2067
7369 msgid "guestfs_getcon"
7373 #: ../src/guestfs-actions.pod:2069
7377 " guestfs_getcon (guestfs_h *g);\n"
7382 #: ../src/guestfs-actions.pod:2072 ../fish/guestfish-actions.pod:1412
7383 msgid "This gets the SELinux security context of the daemon."
7387 #: ../src/guestfs-actions.pod:2074
7388 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
7392 #: ../src/guestfs-actions.pod:2082
7393 msgid "guestfs_getxattrs"
7397 #: ../src/guestfs-actions.pod:2084
7400 " struct guestfs_xattr_list *\n"
7401 " guestfs_getxattrs (guestfs_h *g,\n"
7402 " const char *path);\n"
7407 #: ../src/guestfs-actions.pod:2088 ../fish/guestfish-actions.pod:1421
7408 msgid "This call lists the extended attributes of the file or directory C<path>."
7412 #: ../src/guestfs-actions.pod:2091 ../fish/guestfish-actions.pod:1424
7414 "At the system call level, this is a combination of the L<listxattr(2)> and "
7415 "L<getxattr(2)> calls."
7419 #: ../src/guestfs-actions.pod:2094
7420 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
7424 #: ../src/guestfs-actions.pod:2096 ../src/guestfs-actions.pod:3011 ../src/guestfs-actions.pod:3665
7426 "This function returns a C<struct guestfs_xattr_list *> (see "
7427 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
7428 "must call C<guestfs_free_xattr_list> after use>."
7432 #: ../src/guestfs-actions.pod:2101 ../src/guestfs-actions.pod:3016 ../src/guestfs-actions.pod:3181 ../src/guestfs-actions.pod:3217 ../src/guestfs-actions.pod:5017 ../src/guestfs-actions.pod:5456 ../src/guestfs-actions.pod:6782
7433 msgid "(Added in 1.0.59)"
7437 #: ../src/guestfs-actions.pod:2103
7438 msgid "guestfs_glob_expand"
7442 #: ../src/guestfs-actions.pod:2105
7446 " guestfs_glob_expand (guestfs_h *g,\n"
7447 " const char *pattern);\n"
7452 #: ../src/guestfs-actions.pod:2109 ../fish/guestfish-actions.pod:1433
7454 "This command searches for all the pathnames matching C<pattern> according to "
7455 "the wildcard expansion rules used by the shell."
7459 #: ../src/guestfs-actions.pod:2113 ../fish/guestfish-actions.pod:1437
7460 msgid "If no paths match, then this returns an empty list (note: not an error)."
7464 #: ../src/guestfs-actions.pod:2116 ../fish/guestfish-actions.pod:1440
7466 "It is just a wrapper around the C L<glob(3)> function with flags "
7467 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
7471 #: ../src/guestfs-actions.pod:2124 ../src/guestfs-actions.pod:5621 ../src/guestfs-actions.pod:5638
7472 msgid "(Added in 1.0.50)"
7476 #: ../src/guestfs-actions.pod:2126
7477 msgid "guestfs_grep"
7481 #: ../src/guestfs-actions.pod:2128
7485 " guestfs_grep (guestfs_h *g,\n"
7486 " const char *regex,\n"
7487 " const char *path);\n"
7492 #: ../src/guestfs-actions.pod:2133 ../fish/guestfish-actions.pod:1448
7493 msgid "This calls the external C<grep> program and returns the matching lines."
7497 #: ../src/guestfs-actions.pod:2145
7498 msgid "guestfs_grepi"
7502 #: ../src/guestfs-actions.pod:2147
7506 " guestfs_grepi (guestfs_h *g,\n"
7507 " const char *regex,\n"
7508 " const char *path);\n"
7513 #: ../src/guestfs-actions.pod:2152 ../fish/guestfish-actions.pod:1458
7514 msgid "This calls the external C<grep -i> program and returns the matching lines."
7518 #: ../src/guestfs-actions.pod:2164
7519 msgid "guestfs_grub_install"
7523 #: ../src/guestfs-actions.pod:2166
7527 " guestfs_grub_install (guestfs_h *g,\n"
7528 " const char *root,\n"
7529 " const char *device);\n"
7534 #: ../src/guestfs-actions.pod:2171 ../fish/guestfish-actions.pod:1468
7536 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
7537 "the root directory being C<root>."
7541 #: ../src/guestfs-actions.pod:2174 ../fish/guestfish-actions.pod:1471
7543 "Note: If grub-install reports the error \"No suitable drive was found in the "
7544 "generated device map.\" it may be that you need to create a "
7545 "C</boot/grub/device.map> file first that contains the mapping between grub "
7546 "device names and Linux device names. It is usually sufficient to create a "
7551 #: ../src/guestfs-actions.pod:2181 ../fish/guestfish-actions.pod:1478
7559 #: ../src/guestfs-actions.pod:2183 ../fish/guestfish-actions.pod:1480
7560 msgid "replacing C</dev/vda> with the name of the installation device."
7564 #: ../src/guestfs-actions.pod:2187
7565 msgid "(Added in 1.0.17)"
7569 #: ../src/guestfs-actions.pod:2189
7570 msgid "guestfs_head"
7574 #: ../src/guestfs-actions.pod:2191
7578 " guestfs_head (guestfs_h *g,\n"
7579 " const char *path);\n"
7584 #: ../src/guestfs-actions.pod:2195 ../fish/guestfish-actions.pod:1486
7586 "This command returns up to the first 10 lines of a file as a list of "
7591 #: ../src/guestfs-actions.pod:2207
7592 msgid "guestfs_head_n"
7596 #: ../src/guestfs-actions.pod:2209
7600 " guestfs_head_n (guestfs_h *g,\n"
7602 " const char *path);\n"
7607 #: ../src/guestfs-actions.pod:2214 ../fish/guestfish-actions.pod:1496
7609 "If the parameter C<nrlines> is a positive number, this returns the first "
7610 "C<nrlines> lines of the file C<path>."
7614 #: ../src/guestfs-actions.pod:2217 ../fish/guestfish-actions.pod:1499
7616 "If the parameter C<nrlines> is a negative number, this returns lines from "
7617 "the file C<path>, excluding the last C<nrlines> lines."
7621 #: ../src/guestfs-actions.pod:2220 ../src/guestfs-actions.pod:5918 ../fish/guestfish-actions.pod:1502 ../fish/guestfish-actions.pod:3930
7622 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7626 #: ../src/guestfs-actions.pod:2231
7627 msgid "guestfs_hexdump"
7631 #: ../src/guestfs-actions.pod:2233
7635 " guestfs_hexdump (guestfs_h *g,\n"
7636 " const char *path);\n"
7641 #: ../src/guestfs-actions.pod:2237 ../fish/guestfish-actions.pod:1511
7643 "This runs C<hexdump -C> on the given C<path>. The result is the "
7644 "human-readable, canonical hex dump of the file."
7648 #: ../src/guestfs-actions.pod:2246 ../src/guestfs-actions.pod:5702 ../src/guestfs-actions.pod:5757
7649 msgid "(Added in 1.0.22)"
7653 #: ../src/guestfs-actions.pod:2248
7654 msgid "guestfs_initrd_cat"
7658 #: ../src/guestfs-actions.pod:2250
7662 " guestfs_initrd_cat (guestfs_h *g,\n"
7663 " const char *initrdpath,\n"
7664 " const char *filename,\n"
7665 " size_t *size_r);\n"
7670 #: ../src/guestfs-actions.pod:2256 ../fish/guestfish-actions.pod:1521
7672 "This command unpacks the file C<filename> from the initrd file called "
7673 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7678 #: ../src/guestfs-actions.pod:2260 ../fish/guestfish-actions.pod:1525
7680 "For example, in guestfish you could use the following command to examine the "
7681 "boot script (usually called C</init>) contained in a Linux initrd or "
7686 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1529
7689 " initrd-cat /boot/initrd-<version>.img init\n"
7694 #: ../src/guestfs-actions.pod:2266
7695 msgid "See also C<guestfs_initrd_list>."
7699 #: ../src/guestfs-actions.pod:2268 ../src/guestfs-actions.pod:4635 ../src/guestfs-actions.pod:4661 ../src/guestfs-actions.pod:4843
7701 "This function returns a buffer, or NULL on error. The size of the returned "
7702 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
7707 #: ../src/guestfs-actions.pod:2277
7708 msgid "guestfs_initrd_list"
7712 #: ../src/guestfs-actions.pod:2279
7716 " guestfs_initrd_list (guestfs_h *g,\n"
7717 " const char *path);\n"
7722 #: ../src/guestfs-actions.pod:2283 ../fish/guestfish-actions.pod:1540
7723 msgid "This command lists out files contained in an initrd."
7727 #: ../src/guestfs-actions.pod:2285 ../fish/guestfish-actions.pod:1542
7729 "The files are listed without any initial C</> character. The files are "
7730 "listed in the order they appear (not necessarily alphabetical). Directory "
7731 "names are listed as separate items."
7735 #: ../src/guestfs-actions.pod:2289 ../fish/guestfish-actions.pod:1546
7737 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
7738 "initrd. We I<only> support the newer initramfs format (compressed cpio "
7743 #: ../src/guestfs-actions.pod:2299
7744 msgid "guestfs_inotify_add_watch"
7748 #: ../src/guestfs-actions.pod:2301
7752 " guestfs_inotify_add_watch (guestfs_h *g,\n"
7753 " const char *path,\n"
7759 #: ../src/guestfs-actions.pod:2306 ../fish/guestfish-actions.pod:1554
7760 msgid "Watch C<path> for the events listed in C<mask>."
7764 #: ../src/guestfs-actions.pod:2308 ../fish/guestfish-actions.pod:1556
7766 "Note that if C<path> is a directory then events within that directory are "
7767 "watched, but this does I<not> happen recursively (in subdirectories)."
7771 #: ../src/guestfs-actions.pod:2312 ../fish/guestfish-actions.pod:1560
7773 "Note for non-C or non-Linux callers: the inotify events are defined by the "
7774 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
7778 #: ../src/guestfs-actions.pod:2320
7779 msgid "guestfs_inotify_close"
7783 #: ../src/guestfs-actions.pod:2322
7787 " guestfs_inotify_close (guestfs_h *g);\n"
7792 #: ../src/guestfs-actions.pod:2325 ../fish/guestfish-actions.pod:1568
7794 "This closes the inotify handle which was previously opened by inotify_init. "
7795 "It removes all watches, throws away any pending events, and deallocates all "
7800 #: ../src/guestfs-actions.pod:2333
7801 msgid "guestfs_inotify_files"
7805 #: ../src/guestfs-actions.pod:2335
7809 " guestfs_inotify_files (guestfs_h *g);\n"
7814 #: ../src/guestfs-actions.pod:2338
7816 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
7817 "returns a list of pathnames of objects that were touched. The returned "
7818 "pathnames are sorted and deduplicated."
7822 #: ../src/guestfs-actions.pod:2348
7823 msgid "guestfs_inotify_init"
7827 #: ../src/guestfs-actions.pod:2350
7831 " guestfs_inotify_init (guestfs_h *g,\n"
7832 " int maxevents);\n"
7837 #: ../src/guestfs-actions.pod:2354 ../fish/guestfish-actions.pod:1584
7839 "This command creates a new inotify handle. The inotify subsystem can be "
7840 "used to notify events which happen to objects in the guest filesystem."
7844 #: ../src/guestfs-actions.pod:2358
7846 "C<maxevents> is the maximum number of events which will be queued up between "
7847 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
7848 "passed as C<0>, then the kernel (or previously set) default is used. For "
7849 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
7850 "throws away events, but records the fact that it threw them away by setting "
7851 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
7852 "C<guestfs_inotify_read>)."
7856 #: ../src/guestfs-actions.pod:2368
7858 "Before any events are generated, you have to add some watches to the "
7859 "internal watch list. See: C<guestfs_inotify_add_watch>, "
7860 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
7864 #: ../src/guestfs-actions.pod:2374
7866 "Queued up events should be read periodically by calling "
7867 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
7868 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
7869 "often enough then you risk the internal queue overflowing."
7873 #: ../src/guestfs-actions.pod:2381
7875 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
7876 "This also removes any watches automatically."
7880 #: ../src/guestfs-actions.pod:2385 ../fish/guestfish-actions.pod:1615
7882 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
7883 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
7884 "that there is one global inotify handle per libguestfs instance."
7888 #: ../src/guestfs-actions.pod:2394
7889 msgid "guestfs_inotify_read"
7893 #: ../src/guestfs-actions.pod:2396
7896 " struct guestfs_inotify_event_list *\n"
7897 " guestfs_inotify_read (guestfs_h *g);\n"
7902 #: ../src/guestfs-actions.pod:2399 ../fish/guestfish-actions.pod:1624
7904 "Return the complete queue of events that have happened since the previous "
7909 #: ../src/guestfs-actions.pod:2402 ../fish/guestfish-actions.pod:1627
7910 msgid "If no events have happened, this returns an empty list."
7914 #: ../src/guestfs-actions.pod:2404 ../fish/guestfish-actions.pod:1629
7916 "I<Note>: In order to make sure that all events have been read, you must call "
7917 "this function repeatedly until it returns an empty list. The reason is that "
7918 "the call will read events up to the maximum appliance-to-host message size "
7919 "and leave remaining events in the queue."
7923 #: ../src/guestfs-actions.pod:2410
7925 "This function returns a C<struct guestfs_inotify_event_list *> (see "
7926 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
7927 "must call C<guestfs_free_inotify_event_list> after use>."
7931 #: ../src/guestfs-actions.pod:2417
7932 msgid "guestfs_inotify_rm_watch"
7936 #: ../src/guestfs-actions.pod:2419
7940 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
7946 #: ../src/guestfs-actions.pod:2423
7948 "Remove a previously defined inotify watch. See "
7949 "C<guestfs_inotify_add_watch>."
7953 #: ../src/guestfs-actions.pod:2430
7954 msgid "guestfs_inspect_get_arch"
7958 #: ../src/guestfs-actions.pod:2432
7962 " guestfs_inspect_get_arch (guestfs_h *g,\n"
7963 " const char *root);\n"
7968 #: ../src/guestfs-actions.pod:2436 ../src/guestfs-actions.pod:2459 ../src/guestfs-actions.pod:2532 ../src/guestfs-actions.pod:2558 ../src/guestfs-actions.pod:2585 ../src/guestfs-actions.pod:2606 ../src/guestfs-actions.pod:2639 ../src/guestfs-actions.pod:2681 ../src/guestfs-actions.pod:2719
7970 "This function should only be called with a root device string as returned by "
7971 "C<guestfs_inspect_os>."
7975 #: ../src/guestfs-actions.pod:2439
7977 "This returns the architecture of the inspected operating system. The "
7978 "possible return values are listed under C<guestfs_file_architecture>."
7982 #: ../src/guestfs-actions.pod:2443 ../fish/guestfish-actions.pod:1653
7984 "If the architecture could not be determined, then the string C<unknown> is "
7989 #: ../src/guestfs-actions.pod:2446 ../src/guestfs-actions.pod:2519 ../src/guestfs-actions.pod:2573 ../src/guestfs-actions.pod:2650 ../src/guestfs-actions.pod:2669 ../src/guestfs-actions.pod:2706 ../src/guestfs-actions.pod:2729 ../src/guestfs-actions.pod:2769 ../fish/guestfish-actions.pod:1656 ../fish/guestfish-actions.pod:1722 ../fish/guestfish-actions.pod:1761 ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1829 ../fish/guestfish-actions.pod:1860 ../fish/guestfish-actions.pod:1876 ../fish/guestfish-actions.pod:1910
7990 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
7994 #: ../src/guestfs-actions.pod:2453
7995 msgid "guestfs_inspect_get_distro"
7999 #: ../src/guestfs-actions.pod:2455
8003 " guestfs_inspect_get_distro (guestfs_h *g,\n"
8004 " const char *root);\n"
8009 #: ../src/guestfs-actions.pod:2462 ../fish/guestfish-actions.pod:1665
8010 msgid "This returns the distro (distribution) of the inspected operating system."
8014 #: ../src/guestfs-actions.pod:2465 ../fish/guestfish-actions.pod:1668
8015 msgid "Currently defined distros are:"
8019 #: ../src/guestfs-actions.pod:2469 ../fish/guestfish-actions.pod:1672
8020 msgid "\"archlinux\""
8024 #: ../src/guestfs-actions.pod:2471 ../fish/guestfish-actions.pod:1674
8029 #: ../src/guestfs-actions.pod:2473 ../fish/guestfish-actions.pod:1676
8034 #: ../src/guestfs-actions.pod:2475 ../fish/guestfish-actions.pod:1678
8035 msgid "Debian or a Debian-derived distro such as Ubuntu."
8039 #: ../src/guestfs-actions.pod:2477 ../fish/guestfish-actions.pod:1680
8044 #: ../src/guestfs-actions.pod:2479 ../fish/guestfish-actions.pod:1682
8049 #: ../src/guestfs-actions.pod:2481 ../fish/guestfish-actions.pod:1684
8054 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1686
8059 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1688
8064 #: ../src/guestfs-actions.pod:2487 ../fish/guestfish-actions.pod:1690
8069 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1692
8074 #: ../src/guestfs-actions.pod:2491 ../fish/guestfish-actions.pod:1694
8079 #: ../src/guestfs-actions.pod:2493 ../fish/guestfish-actions.pod:1696
8080 msgid "\"redhat-based\""
8084 #: ../src/guestfs-actions.pod:2495 ../fish/guestfish-actions.pod:1698
8085 msgid "Some Red Hat-derived distro."
8089 #: ../src/guestfs-actions.pod:2497 ../fish/guestfish-actions.pod:1700
8094 #: ../src/guestfs-actions.pod:2499 ../fish/guestfish-actions.pod:1702
8095 msgid "Red Hat Enterprise Linux and some derivatives."
8099 #: ../src/guestfs-actions.pod:2501 ../src/guestfs-actions.pod:2693 ../fish/guestfish-actions.pod:1704 ../fish/guestfish-actions.pod:1847
8104 #: ../src/guestfs-actions.pod:2503 ../fish/guestfish-actions.pod:1706
8106 "Windows does not have distributions. This string is returned if the OS type "
8111 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1709
8116 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1711
8121 #: ../src/guestfs-actions.pod:2510 ../src/guestfs-actions.pod:2697 ../fish/guestfish-actions.pod:1713 ../fish/guestfish-actions.pod:1851
8126 #: ../src/guestfs-actions.pod:2512 ../fish/guestfish-actions.pod:1715
8127 msgid "The distro could not be determined."
8131 #: ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2703 ../fish/guestfish-actions.pod:1719 ../fish/guestfish-actions.pod:1857
8133 "Future versions of libguestfs may return other strings here. The caller "
8134 "should be prepared to handle any string."
8138 #: ../src/guestfs-actions.pod:2526
8139 msgid "guestfs_inspect_get_filesystems"
8143 #: ../src/guestfs-actions.pod:2528
8147 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
8148 " const char *root);\n"
8153 #: ../src/guestfs-actions.pod:2535 ../fish/guestfish-actions.pod:1731
8155 "This returns a list of all the filesystems that we think are associated with "
8156 "this operating system. This includes the root filesystem, other ordinary "
8157 "filesystems, and non-mounted devices like swap partitions."
8161 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1736
8163 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8164 "to be shared between operating systems."
8168 #: ../src/guestfs-actions.pod:2543
8170 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8171 "C<guestfs_inspect_get_mountpoints>."
8175 #: ../src/guestfs-actions.pod:2552
8176 msgid "guestfs_inspect_get_major_version"
8180 #: ../src/guestfs-actions.pod:2554
8184 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
8185 " const char *root);\n"
8190 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1749
8191 msgid "This returns the major version number of the inspected operating system."
8195 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1752
8197 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8198 "popular public names used by the operating system. Notably the operating "
8199 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8200 "1). You can find out the real versions corresponding to releases of Windows "
8201 "by consulting Wikipedia or MSDN."
8205 #: ../src/guestfs-actions.pod:2571 ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1759 ../fish/guestfish-actions.pod:1773
8206 msgid "If the version could not be determined, then C<0> is returned."
8210 #: ../src/guestfs-actions.pod:2579
8211 msgid "guestfs_inspect_get_minor_version"
8215 #: ../src/guestfs-actions.pod:2581
8219 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
8220 " const char *root);\n"
8225 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1770
8226 msgid "This returns the minor version number of the inspected operating system."
8230 #: ../src/guestfs-actions.pod:2593
8232 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8233 "C<guestfs_inspect_get_major_version>."
8237 #: ../src/guestfs-actions.pod:2600
8238 msgid "guestfs_inspect_get_mountpoints"
8242 #: ../src/guestfs-actions.pod:2602
8246 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
8247 " const char *root);\n"
8252 #: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:1785
8254 "This returns a hash of where we think the filesystems associated with this "
8255 "operating system should be mounted. Callers should note that this is at "
8256 "best an educated guess made by reading configuration files such as "
8261 #: ../src/guestfs-actions.pod:2614 ../fish/guestfish-actions.pod:1790
8263 "Each element in the returned hashtable has a key which is the path of the "
8264 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8265 "mounted there (eg. C</dev/sda1>)."
8269 #: ../src/guestfs-actions.pod:2619 ../fish/guestfish-actions.pod:1795
8270 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
8274 #: ../src/guestfs-actions.pod:2622
8276 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8277 "C<guestfs_inspect_get_filesystems>."
8281 #: ../src/guestfs-actions.pod:2625 ../src/guestfs-actions.pod:3069 ../src/guestfs-actions.pod:4200 ../src/guestfs-actions.pod:6059
8283 "This function returns a NULL-terminated array of strings, or NULL if there "
8284 "was an error. The array of strings will always have length C<2n+1>, where "
8285 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
8286 "caller must free the strings and the array after use>."
8290 #: ../src/guestfs-actions.pod:2633
8291 msgid "guestfs_inspect_get_product_name"
8295 #: ../src/guestfs-actions.pod:2635
8299 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
8300 " const char *root);\n"
8305 #: ../src/guestfs-actions.pod:2642 ../fish/guestfish-actions.pod:1808
8307 "This returns the product name of the inspected operating system. The "
8308 "product name is generally some freeform string which can be displayed to the "
8309 "user, but should not be parsed by programs."
8313 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1813
8315 "If the product name could not be determined, then the string C<unknown> is "
8320 #: ../src/guestfs-actions.pod:2657
8321 msgid "guestfs_inspect_get_roots"
8325 #: ../src/guestfs-actions.pod:2659
8329 " guestfs_inspect_get_roots (guestfs_h *g);\n"
8334 #: ../src/guestfs-actions.pod:2662
8336 "This function is a convenient way to get the list of root devices, as "
8337 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
8338 "the whole inspection process."
8342 #: ../src/guestfs-actions.pod:2666
8344 "This returns an empty list if either no root devices were found or the "
8345 "caller has not called C<guestfs_inspect_os>."
8349 #: ../src/guestfs-actions.pod:2675
8350 msgid "guestfs_inspect_get_type"
8354 #: ../src/guestfs-actions.pod:2677
8358 " guestfs_inspect_get_type (guestfs_h *g,\n"
8359 " const char *root);\n"
8364 #: ../src/guestfs-actions.pod:2684 ../fish/guestfish-actions.pod:1838
8366 "This returns the type of the inspected operating system. Currently defined "
8371 #: ../src/guestfs-actions.pod:2689 ../fish/guestfish-actions.pod:1843
8376 #: ../src/guestfs-actions.pod:2691 ../fish/guestfish-actions.pod:1845
8377 msgid "Any Linux-based operating system."
8381 #: ../src/guestfs-actions.pod:2695 ../fish/guestfish-actions.pod:1849
8382 msgid "Any Microsoft Windows operating system."
8386 #: ../src/guestfs-actions.pod:2699 ../fish/guestfish-actions.pod:1853
8387 msgid "The operating system type could not be determined."
8391 #: ../src/guestfs-actions.pod:2713
8392 msgid "guestfs_inspect_get_windows_systemroot"
8396 #: ../src/guestfs-actions.pod:2715
8400 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
8401 " const char *root);\n"
8406 #: ../src/guestfs-actions.pod:2722 ../fish/guestfish-actions.pod:1869
8408 "This returns the Windows systemroot of the inspected guest. The systemroot "
8409 "is a directory path such as C</WINDOWS>."
8413 #: ../src/guestfs-actions.pod:2725 ../fish/guestfish-actions.pod:1872
8415 "This call assumes that the guest is Windows and that the systemroot could be "
8416 "determined by inspection. If this is not the case then an error is "
8421 #: ../src/guestfs-actions.pod:2734
8422 msgid "(Added in 1.5.25)"
8426 #: ../src/guestfs-actions.pod:2736
8427 msgid "guestfs_inspect_os"
8431 #: ../src/guestfs-actions.pod:2738
8435 " guestfs_inspect_os (guestfs_h *g);\n"
8440 #: ../src/guestfs-actions.pod:2741 ../fish/guestfish-actions.pod:1882
8442 "This function uses other libguestfs functions and certain heuristics to "
8443 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
8444 "for operating systems."
8448 #: ../src/guestfs-actions.pod:2745 ../fish/guestfish-actions.pod:1886
8449 msgid "The list returned is empty if no operating systems were found."
8453 #: ../src/guestfs-actions.pod:2747 ../fish/guestfish-actions.pod:1888
8455 "If one operating system was found, then this returns a list with a single "
8456 "element, which is the name of the root filesystem of this operating system. "
8457 "It is also possible for this function to return a list containing more than "
8458 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
8459 "element being the root filesystem of one of the operating systems."
8463 #: ../src/guestfs-actions.pod:2754
8465 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
8466 "functions in order to query further information about each operating system, "
8467 "such as the name and version."
8471 #: ../src/guestfs-actions.pod:2759
8473 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
8474 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
8475 "the contents. This should be called with no disks currently mounted. The "
8476 "function may also use Augeas, so any existing Augeas handle will be closed."
8480 #: ../src/guestfs-actions.pod:2765 ../fish/guestfish-actions.pod:1906
8482 "This function cannot decrypt encrypted disks. The caller must do that first "
8483 "(supplying the necessary keys) if the disk is encrypted."
8487 #: ../src/guestfs-actions.pod:2771 ../src/guestfs-actions.pod:3027 ../src/guestfs-actions.pod:3089
8488 msgid "See also C<guestfs_list_filesystems>."
8492 #: ../src/guestfs-actions.pod:2779
8493 msgid "guestfs_is_blockdev"
8497 #: ../src/guestfs-actions.pod:2781
8501 " guestfs_is_blockdev (guestfs_h *g,\n"
8502 " const char *path);\n"
8507 #: ../src/guestfs-actions.pod:2785 ../fish/guestfish-actions.pod:1918
8509 "This returns C<true> if and only if there is a block device with the given "
8514 #: ../src/guestfs-actions.pod:2788 ../src/guestfs-actions.pod:2817 ../src/guestfs-actions.pod:2847 ../src/guestfs-actions.pod:2862 ../src/guestfs-actions.pod:2878 ../src/guestfs-actions.pod:2934 ../src/guestfs-actions.pod:2949
8515 msgid "See also C<guestfs_stat>."
8519 #: ../src/guestfs-actions.pod:2792 ../src/guestfs-actions.pod:2821 ../src/guestfs-actions.pod:2866 ../src/guestfs-actions.pod:2938 ../src/guestfs-actions.pod:2953
8520 msgid "(Added in 1.5.10)"
8524 #: ../src/guestfs-actions.pod:2794
8525 msgid "guestfs_is_busy"
8529 #: ../src/guestfs-actions.pod:2796
8533 " guestfs_is_busy (guestfs_h *g);\n"
8538 #: ../src/guestfs-actions.pod:2799 ../fish/guestfish-actions.pod:1927
8540 "This returns true iff this handle is busy processing a command (in the "
8545 #: ../src/guestfs-actions.pod:2808
8546 msgid "guestfs_is_chardev"
8550 #: ../src/guestfs-actions.pod:2810
8554 " guestfs_is_chardev (guestfs_h *g,\n"
8555 " const char *path);\n"
8560 #: ../src/guestfs-actions.pod:2814 ../fish/guestfish-actions.pod:1936
8562 "This returns C<true> if and only if there is a character device with the "
8563 "given C<path> name."
8567 #: ../src/guestfs-actions.pod:2823
8568 msgid "guestfs_is_config"
8572 #: ../src/guestfs-actions.pod:2825
8576 " guestfs_is_config (guestfs_h *g);\n"
8581 #: ../src/guestfs-actions.pod:2828 ../fish/guestfish-actions.pod:1945
8583 "This returns true iff this handle is being configured (in the C<CONFIG> "
8588 #: ../src/guestfs-actions.pod:2837
8589 msgid "guestfs_is_dir"
8593 #: ../src/guestfs-actions.pod:2839
8597 " guestfs_is_dir (guestfs_h *g,\n"
8598 " const char *path);\n"
8603 #: ../src/guestfs-actions.pod:2843 ../fish/guestfish-actions.pod:1954
8605 "This returns C<true> if and only if there is a directory with the given "
8606 "C<path> name. Note that it returns false for other objects like files."
8610 #: ../src/guestfs-actions.pod:2853
8611 msgid "guestfs_is_fifo"
8615 #: ../src/guestfs-actions.pod:2855
8619 " guestfs_is_fifo (guestfs_h *g,\n"
8620 " const char *path);\n"
8625 #: ../src/guestfs-actions.pod:2859 ../fish/guestfish-actions.pod:1964
8627 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
8628 "given C<path> name."
8632 #: ../src/guestfs-actions.pod:2868
8633 msgid "guestfs_is_file"
8637 #: ../src/guestfs-actions.pod:2870
8641 " guestfs_is_file (guestfs_h *g,\n"
8642 " const char *path);\n"
8647 #: ../src/guestfs-actions.pod:2874 ../fish/guestfish-actions.pod:1973
8649 "This returns C<true> if and only if there is a regular file with the given "
8650 "C<path> name. Note that it returns false for other objects like "
8655 #: ../src/guestfs-actions.pod:2884
8656 msgid "guestfs_is_launching"
8660 #: ../src/guestfs-actions.pod:2886
8664 " guestfs_is_launching (guestfs_h *g);\n"
8669 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1983
8671 "This returns true iff this handle is launching the subprocess (in the "
8672 "C<LAUNCHING> state)."
8676 #: ../src/guestfs-actions.pod:2898
8677 msgid "guestfs_is_lv"
8681 #: ../src/guestfs-actions.pod:2900
8685 " guestfs_is_lv (guestfs_h *g,\n"
8686 " const char *device);\n"
8691 #: ../src/guestfs-actions.pod:2904 ../fish/guestfish-actions.pod:1992
8693 "This command tests whether C<device> is a logical volume, and returns true "
8694 "iff this is the case."
8698 #: ../src/guestfs-actions.pod:2911
8699 msgid "guestfs_is_ready"
8703 #: ../src/guestfs-actions.pod:2913
8707 " guestfs_is_ready (guestfs_h *g);\n"
8712 #: ../src/guestfs-actions.pod:2916 ../fish/guestfish-actions.pod:1999
8714 "This returns true iff this handle is ready to accept commands (in the "
8719 #: ../src/guestfs-actions.pod:2925
8720 msgid "guestfs_is_socket"
8724 #: ../src/guestfs-actions.pod:2927
8728 " guestfs_is_socket (guestfs_h *g,\n"
8729 " const char *path);\n"
8734 #: ../src/guestfs-actions.pod:2931 ../fish/guestfish-actions.pod:2008
8736 "This returns C<true> if and only if there is a Unix domain socket with the "
8737 "given C<path> name."
8741 #: ../src/guestfs-actions.pod:2940
8742 msgid "guestfs_is_symlink"
8746 #: ../src/guestfs-actions.pod:2942
8750 " guestfs_is_symlink (guestfs_h *g,\n"
8751 " const char *path);\n"
8756 #: ../src/guestfs-actions.pod:2946 ../fish/guestfish-actions.pod:2017
8758 "This returns C<true> if and only if there is a symbolic link with the given "
8763 #: ../src/guestfs-actions.pod:2955
8764 msgid "guestfs_kill_subprocess"
8768 #: ../src/guestfs-actions.pod:2957
8772 " guestfs_kill_subprocess (guestfs_h *g);\n"
8777 #: ../src/guestfs-actions.pod:2960 ../fish/guestfish-actions.pod:2026
8778 msgid "This kills the qemu subprocess. You should never need to call this."
8782 #: ../src/guestfs-actions.pod:2966
8783 msgid "guestfs_launch"
8787 #: ../src/guestfs-actions.pod:2968
8791 " guestfs_launch (guestfs_h *g);\n"
8796 #: ../src/guestfs-actions.pod:2971 ../fish/guestfish-actions.pod:2034
8798 "Internally libguestfs is implemented by running a virtual machine using "
8803 #: ../src/guestfs-actions.pod:2974 ../fish/guestfish-actions.pod:2037
8805 "You should call this after configuring the handle (eg. adding drives) but "
8806 "before performing any actions."
8810 #: ../src/guestfs-actions.pod:2981
8811 msgid "guestfs_lchown"
8815 #: ../src/guestfs-actions.pod:2983
8819 " guestfs_lchown (guestfs_h *g,\n"
8822 " const char *path);\n"
8827 #: ../src/guestfs-actions.pod:2989
8829 "Change the file owner to C<owner> and group to C<group>. This is like "
8830 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
8831 "changed, not the target."
8835 #: ../src/guestfs-actions.pod:3001
8836 msgid "guestfs_lgetxattrs"
8840 #: ../src/guestfs-actions.pod:3003
8843 " struct guestfs_xattr_list *\n"
8844 " guestfs_lgetxattrs (guestfs_h *g,\n"
8845 " const char *path);\n"
8850 #: ../src/guestfs-actions.pod:3007
8852 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
8853 "then it returns the extended attributes of the link itself."
8857 #: ../src/guestfs-actions.pod:3018
8858 msgid "guestfs_list_devices"
8862 #: ../src/guestfs-actions.pod:3020
8866 " guestfs_list_devices (guestfs_h *g);\n"
8871 #: ../src/guestfs-actions.pod:3023 ../fish/guestfish-actions.pod:2064
8872 msgid "List all the block devices."
8876 #: ../src/guestfs-actions.pod:3025 ../fish/guestfish-actions.pod:2066
8877 msgid "The full block device names are returned, eg. C</dev/sda>."
8881 #: ../src/guestfs-actions.pod:3035
8882 msgid "guestfs_list_filesystems"
8886 #: ../src/guestfs-actions.pod:3037
8890 " guestfs_list_filesystems (guestfs_h *g);\n"
8895 #: ../src/guestfs-actions.pod:3040 ../fish/guestfish-actions.pod:2074
8897 "This inspection command looks for filesystems on partitions, block devices "
8898 "and logical volumes, returning a list of devices containing filesystems and "
8903 #: ../src/guestfs-actions.pod:3044 ../fish/guestfish-actions.pod:2078
8905 "The return value is a hash, where the keys are the devices containing "
8906 "filesystems, and the values are the filesystem types. For example:"
8910 #: ../src/guestfs-actions.pod:3048 ../fish/guestfish-actions.pod:2082
8913 " \"/dev/sda1\" => \"ntfs\"\n"
8914 " \"/dev/sda2\" => \"ext2\"\n"
8915 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
8916 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
8921 #: ../src/guestfs-actions.pod:3053 ../fish/guestfish-actions.pod:2087
8923 "The value can have the special value \"unknown\", meaning the content of the "
8924 "device is undetermined or empty. \"swap\" means a Linux swap partition."
8928 #: ../src/guestfs-actions.pod:3057
8930 "This command runs other libguestfs commands, which might include "
8931 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
8932 "soon after launch and only when nothing is mounted."
8936 #: ../src/guestfs-actions.pod:3061
8938 "Not all of the filesystems returned will be mountable. In particular, swap "
8939 "partitions are returned in the list. Also this command does not check that "
8940 "each filesystem found is valid and mountable, and some filesystems might be "
8941 "mountable but require special options. Filesystems may not all belong to a "
8942 "single logical operating system (use C<guestfs_inspect_os> to look for "
8947 #: ../src/guestfs-actions.pod:3075 ../src/guestfs-actions.pod:4602
8948 msgid "(Added in 1.5.15)"
8952 #: ../src/guestfs-actions.pod:3077
8953 msgid "guestfs_list_partitions"
8957 #: ../src/guestfs-actions.pod:3079
8961 " guestfs_list_partitions (guestfs_h *g);\n"
8966 #: ../src/guestfs-actions.pod:3082 ../fish/guestfish-actions.pod:2107
8967 msgid "List all the partitions detected on all block devices."
8971 #: ../src/guestfs-actions.pod:3084 ../fish/guestfish-actions.pod:2109
8972 msgid "The full partition device names are returned, eg. C</dev/sda1>"
8976 #: ../src/guestfs-actions.pod:3086
8978 "This does not return logical volumes. For that you will need to call "
8983 #: ../src/guestfs-actions.pod:3097
8988 #: ../src/guestfs-actions.pod:3099
8992 " guestfs_ll (guestfs_h *g,\n"
8993 " const char *directory);\n"
8998 #: ../src/guestfs-actions.pod:3103 ../fish/guestfish-actions.pod:2120
9000 "List the files in C<directory> (relative to the root directory, there is no "
9001 "cwd) in the format of 'ls -la'."
9005 #: ../src/guestfs-actions.pod:3106 ../fish/guestfish-actions.pod:2123
9007 "This command is mostly useful for interactive sessions. It is I<not> "
9008 "intended that you try to parse the output string."
9012 #: ../src/guestfs-actions.pod:3114
9017 #: ../src/guestfs-actions.pod:3116
9021 " guestfs_ln (guestfs_h *g,\n"
9022 " const char *target,\n"
9023 " const char *linkname);\n"
9028 #: ../src/guestfs-actions.pod:3121 ../fish/guestfish-actions.pod:2130
9029 msgid "This command creates a hard link using the C<ln> command."
9033 #: ../src/guestfs-actions.pod:3127
9034 msgid "guestfs_ln_f"
9038 #: ../src/guestfs-actions.pod:3129
9042 " guestfs_ln_f (guestfs_h *g,\n"
9043 " const char *target,\n"
9044 " const char *linkname);\n"
9049 #: ../src/guestfs-actions.pod:3134 ../fish/guestfish-actions.pod:2136
9051 "This command creates a hard link using the C<ln -f> command. The C<-f> "
9052 "option removes the link (C<linkname>) if it exists already."
9056 #: ../src/guestfs-actions.pod:3141
9057 msgid "guestfs_ln_s"
9061 #: ../src/guestfs-actions.pod:3143
9065 " guestfs_ln_s (guestfs_h *g,\n"
9066 " const char *target,\n"
9067 " const char *linkname);\n"
9072 #: ../src/guestfs-actions.pod:3148 ../fish/guestfish-actions.pod:2143
9073 msgid "This command creates a symbolic link using the C<ln -s> command."
9077 #: ../src/guestfs-actions.pod:3154
9078 msgid "guestfs_ln_sf"
9082 #: ../src/guestfs-actions.pod:3156
9086 " guestfs_ln_sf (guestfs_h *g,\n"
9087 " const char *target,\n"
9088 " const char *linkname);\n"
9093 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2149
9095 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
9096 "option removes the link (C<linkname>) if it exists already."
9100 #: ../src/guestfs-actions.pod:3168
9101 msgid "guestfs_lremovexattr"
9105 #: ../src/guestfs-actions.pod:3170
9109 " guestfs_lremovexattr (guestfs_h *g,\n"
9110 " const char *xattr,\n"
9111 " const char *path);\n"
9116 #: ../src/guestfs-actions.pod:3175
9118 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
9119 "link, then it removes an extended attribute of the link itself."
9123 #: ../src/guestfs-actions.pod:3183
9128 #: ../src/guestfs-actions.pod:3185
9132 " guestfs_ls (guestfs_h *g,\n"
9133 " const char *directory);\n"
9138 #: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2164
9140 "List the files in C<directory> (relative to the root directory, there is no "
9141 "cwd). The '.' and '..' entries are not returned, but hidden files are "
9146 #: ../src/guestfs-actions.pod:3193
9148 "This command is mostly useful for interactive sessions. Programs should "
9149 "probably use C<guestfs_readdir> instead."
9153 #: ../src/guestfs-actions.pod:3202
9154 msgid "guestfs_lsetxattr"
9158 #: ../src/guestfs-actions.pod:3204
9162 " guestfs_lsetxattr (guestfs_h *g,\n"
9163 " const char *xattr,\n"
9164 " const char *val,\n"
9166 " const char *path);\n"
9171 #: ../src/guestfs-actions.pod:3211
9173 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
9174 "then it sets an extended attribute of the link itself."
9178 #: ../src/guestfs-actions.pod:3219
9179 msgid "guestfs_lstat"
9183 #: ../src/guestfs-actions.pod:3221
9186 " struct guestfs_stat *\n"
9187 " guestfs_lstat (guestfs_h *g,\n"
9188 " const char *path);\n"
9193 #: ../src/guestfs-actions.pod:3225 ../src/guestfs-actions.pod:5658 ../fish/guestfish-actions.pod:2183 ../fish/guestfish-actions.pod:3765
9194 msgid "Returns file information for the given C<path>."
9198 #: ../src/guestfs-actions.pod:3227
9200 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
9201 "link, then the link is stat-ed, not the file it refers to."
9205 #: ../src/guestfs-actions.pod:3231 ../fish/guestfish-actions.pod:2189
9206 msgid "This is the same as the C<lstat(2)> system call."
9210 #: ../src/guestfs-actions.pod:3233 ../src/guestfs-actions.pod:5662
9212 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
9213 "error. I<The caller must call C<guestfs_free_stat> after use>."
9217 #: ../src/guestfs-actions.pod:3237 ../src/guestfs-actions.pod:5666 ../src/guestfs-actions.pod:5684 ../src/guestfs-actions.pod:6065
9218 msgid "(Added in 0.9.2)"
9222 #: ../src/guestfs-actions.pod:3239
9223 msgid "guestfs_lstatlist"
9227 #: ../src/guestfs-actions.pod:3241
9230 " struct guestfs_stat_list *\n"
9231 " guestfs_lstatlist (guestfs_h *g,\n"
9232 " const char *path,\n"
9233 " char *const *names);\n"
9238 #: ../src/guestfs-actions.pod:3246
9240 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
9241 "files, where all files are in the directory C<path>. C<names> is the list "
9242 "of files from this directory."
9246 #: ../src/guestfs-actions.pod:3250 ../fish/guestfish-actions.pod:2199
9248 "On return you get a list of stat structs, with a one-to-one correspondence "
9249 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9250 "then the C<ino> field of that structure is set to C<-1>."
9254 #: ../src/guestfs-actions.pod:3255
9256 "This call is intended for programs that want to efficiently list a directory "
9257 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
9258 "for a similarly efficient call for getting extended attributes. Very long "
9259 "directory listings might cause the protocol message size to be exceeded, "
9260 "causing this call to fail. The caller must split up such requests into "
9261 "smaller groups of names."
9265 #: ../src/guestfs-actions.pod:3263
9267 "This function returns a C<struct guestfs_stat_list *> (see "
9268 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
9269 "must call C<guestfs_free_stat_list> after use>."
9273 #: ../src/guestfs-actions.pod:3270
9274 msgid "guestfs_luks_add_key"
9278 #: ../src/guestfs-actions.pod:3272
9282 " guestfs_luks_add_key (guestfs_h *g,\n"
9283 " const char *device,\n"
9284 " const char *key,\n"
9285 " const char *newkey,\n"
9291 #: ../src/guestfs-actions.pod:3279 ../fish/guestfish-actions.pod:2216
9293 "This command adds a new key on LUKS device C<device>. C<key> is any "
9294 "existing key, and is used to access the device. C<newkey> is the new key to "
9295 "add. C<keyslot> is the key slot that will be replaced."
9299 #: ../src/guestfs-actions.pod:3284
9301 "Note that if C<keyslot> already contains a key, then this command will "
9302 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
9306 #: ../src/guestfs-actions.pod:3290 ../src/guestfs-actions.pod:3330 ../src/guestfs-actions.pod:3353 ../src/guestfs-actions.pod:3373 ../src/guestfs-actions.pod:3405 ../src/guestfs-actions.pod:3424
9308 "This function takes a key or passphrase parameter which could contain "
9309 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
9314 #: ../src/guestfs-actions.pod:3294 ../src/guestfs-actions.pod:3334 ../src/guestfs-actions.pod:3357 ../src/guestfs-actions.pod:3377
9315 msgid "(Added in 1.5.2)"
9319 #: ../src/guestfs-actions.pod:3296
9320 msgid "guestfs_luks_close"
9324 #: ../src/guestfs-actions.pod:3298
9328 " guestfs_luks_close (guestfs_h *g,\n"
9329 " const char *device);\n"
9334 #: ../src/guestfs-actions.pod:3302
9336 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
9337 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
9338 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
9339 "underlying block device."
9343 #: ../src/guestfs-actions.pod:3310 ../src/guestfs-actions.pod:3409 ../src/guestfs-actions.pod:3428 ../src/guestfs-actions.pod:3478 ../src/guestfs-actions.pod:3526
9344 msgid "(Added in 1.5.1)"
9348 #: ../src/guestfs-actions.pod:3312
9349 msgid "guestfs_luks_format"
9353 #: ../src/guestfs-actions.pod:3314
9357 " guestfs_luks_format (guestfs_h *g,\n"
9358 " const char *device,\n"
9359 " const char *key,\n"
9365 #: ../src/guestfs-actions.pod:3320 ../fish/guestfish-actions.pod:2242
9367 "This command erases existing data on C<device> and formats the device as a "
9368 "LUKS encrypted device. C<key> is the initial key, which is added to key "
9369 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
9373 #: ../src/guestfs-actions.pod:3327 ../src/guestfs-actions.pod:3350 ../src/guestfs-actions.pod:3490 ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:5118 ../src/guestfs-actions.pod:5493 ../src/guestfs-actions.pod:5516 ../src/guestfs-actions.pod:5542 ../src/guestfs-actions.pod:6693 ../fish/guestfish-actions.pod:2250 ../fish/guestfish-actions.pod:2263 ../fish/guestfish-actions.pod:2347 ../fish/guestfish-actions.pod:2877 ../fish/guestfish-actions.pod:3384 ../fish/guestfish-actions.pod:3664 ../fish/guestfish-actions.pod:3680 ../fish/guestfish-actions.pod:3695 ../fish/guestfish-actions.pod:4410
9375 "B<This command is dangerous. Without careful use you can easily destroy all "
9380 #: ../src/guestfs-actions.pod:3336
9381 msgid "guestfs_luks_format_cipher"
9385 #: ../src/guestfs-actions.pod:3338
9389 " guestfs_luks_format_cipher (guestfs_h *g,\n"
9390 " const char *device,\n"
9391 " const char *key,\n"
9393 " const char *cipher);\n"
9398 #: ../src/guestfs-actions.pod:3345
9400 "This command is the same as C<guestfs_luks_format> but it also allows you to "
9401 "set the C<cipher> used."
9405 #: ../src/guestfs-actions.pod:3359
9406 msgid "guestfs_luks_kill_slot"
9410 #: ../src/guestfs-actions.pod:3361
9414 " guestfs_luks_kill_slot (guestfs_h *g,\n"
9415 " const char *device,\n"
9416 " const char *key,\n"
9422 #: ../src/guestfs-actions.pod:3367 ../fish/guestfish-actions.pod:2270
9424 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
9425 "device C<device>. C<key> must be one of the I<other> keys."
9429 #: ../src/guestfs-actions.pod:3379
9430 msgid "guestfs_luks_open"
9434 #: ../src/guestfs-actions.pod:3381
9438 " guestfs_luks_open (guestfs_h *g,\n"
9439 " const char *device,\n"
9440 " const char *key,\n"
9441 " const char *mapname);\n"
9446 #: ../src/guestfs-actions.pod:3387 ../fish/guestfish-actions.pod:2281
9448 "This command opens a block device which has been encrypted according to the "
9449 "Linux Unified Key Setup (LUKS) standard."
9453 #: ../src/guestfs-actions.pod:3390 ../fish/guestfish-actions.pod:2284
9454 msgid "C<device> is the encrypted block device or partition."
9458 #: ../src/guestfs-actions.pod:3392 ../fish/guestfish-actions.pod:2286
9460 "The caller must supply one of the keys associated with the LUKS block "
9461 "device, in the C<key> parameter."
9465 #: ../src/guestfs-actions.pod:3395 ../fish/guestfish-actions.pod:2289
9467 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
9468 "writes to this block device are decrypted from and encrypted to the "
9469 "underlying C<device> respectively."
9473 #: ../src/guestfs-actions.pod:3399
9475 "If this block device contains LVM volume groups, then calling "
9476 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
9481 #: ../src/guestfs-actions.pod:3411
9482 msgid "guestfs_luks_open_ro"
9486 #: ../src/guestfs-actions.pod:3413
9490 " guestfs_luks_open_ro (guestfs_h *g,\n"
9491 " const char *device,\n"
9492 " const char *key,\n"
9493 " const char *mapname);\n"
9498 #: ../src/guestfs-actions.pod:3419
9500 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
9505 #: ../src/guestfs-actions.pod:3430
9506 msgid "guestfs_lvcreate"
9510 #: ../src/guestfs-actions.pod:3432
9514 " guestfs_lvcreate (guestfs_h *g,\n"
9515 " const char *logvol,\n"
9516 " const char *volgroup,\n"
9522 #: ../src/guestfs-actions.pod:3438 ../fish/guestfish-actions.pod:2314
9524 "This creates an LVM logical volume called C<logvol> on the volume group "
9525 "C<volgroup>, with C<size> megabytes."
9529 #: ../src/guestfs-actions.pod:3445
9530 msgid "guestfs_lvm_canonical_lv_name"
9534 #: ../src/guestfs-actions.pod:3447
9538 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
9539 " const char *lvname);\n"
9544 #: ../src/guestfs-actions.pod:3451 ../fish/guestfish-actions.pod:2321
9546 "This converts alternative naming schemes for LVs that you might find to the "
9547 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
9552 #: ../src/guestfs-actions.pod:3455 ../fish/guestfish-actions.pod:2325
9554 "This command returns an error if the C<lvname> parameter does not refer to a "
9559 #: ../src/guestfs-actions.pod:3458
9560 msgid "See also C<guestfs_is_lv>."
9564 #: ../src/guestfs-actions.pod:3463
9565 msgid "(Added in 1.5.24)"
9569 #: ../src/guestfs-actions.pod:3465
9570 msgid "guestfs_lvm_clear_filter"
9574 #: ../src/guestfs-actions.pod:3467
9578 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
9583 #: ../src/guestfs-actions.pod:3470
9585 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
9586 "see every block device."
9590 #: ../src/guestfs-actions.pod:3473 ../src/guestfs-actions.pod:3515 ../fish/guestfish-actions.pod:2337 ../fish/guestfish-actions.pod:2368
9591 msgid "This command also clears the LVM cache and performs a volume group scan."
9595 #: ../src/guestfs-actions.pod:3480
9596 msgid "guestfs_lvm_remove_all"
9600 #: ../src/guestfs-actions.pod:3482
9604 " guestfs_lvm_remove_all (guestfs_h *g);\n"
9609 #: ../src/guestfs-actions.pod:3485 ../fish/guestfish-actions.pod:2344
9611 "This command removes all LVM logical volumes, volume groups and physical "
9616 #: ../src/guestfs-actions.pod:3495
9617 msgid "guestfs_lvm_set_filter"
9621 #: ../src/guestfs-actions.pod:3497
9625 " guestfs_lvm_set_filter (guestfs_h *g,\n"
9626 " char *const *devices);\n"
9631 #: ../src/guestfs-actions.pod:3501 ../fish/guestfish-actions.pod:2354
9633 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
9634 "block devices in the list C<devices>, and will ignore all other attached "
9639 #: ../src/guestfs-actions.pod:3505 ../fish/guestfish-actions.pod:2358
9641 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
9642 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
9643 "there are two types of duplication possible: either cloned PVs/VGs which "
9644 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
9645 "same name. In normal operation you cannot create this situation, but you "
9646 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
9647 "inside the LVM metadata."
9651 #: ../src/guestfs-actions.pod:3518 ../fish/guestfish-actions.pod:2371
9652 msgid "You can filter whole block devices or individual partitions."
9656 #: ../src/guestfs-actions.pod:3520 ../fish/guestfish-actions.pod:2373
9658 "You cannot use this if any VG is currently in use (eg. contains a mounted "
9659 "filesystem), even if you are not filtering out that VG."
9663 #: ../src/guestfs-actions.pod:3528
9664 msgid "guestfs_lvremove"
9668 #: ../src/guestfs-actions.pod:3530
9672 " guestfs_lvremove (guestfs_h *g,\n"
9673 " const char *device);\n"
9678 #: ../src/guestfs-actions.pod:3534 ../fish/guestfish-actions.pod:2381
9680 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
9681 "LV, such as C</dev/VG/LV>."
9685 #: ../src/guestfs-actions.pod:3537 ../fish/guestfish-actions.pod:2384
9687 "You can also remove all LVs in a volume group by specifying the VG name, "
9692 #: ../src/guestfs-actions.pod:3542 ../src/guestfs-actions.pod:4699 ../src/guestfs-actions.pod:6431
9693 msgid "(Added in 1.0.13)"
9697 #: ../src/guestfs-actions.pod:3544
9698 msgid "guestfs_lvrename"
9702 #: ../src/guestfs-actions.pod:3546
9706 " guestfs_lvrename (guestfs_h *g,\n"
9707 " const char *logvol,\n"
9708 " const char *newlogvol);\n"
9713 #: ../src/guestfs-actions.pod:3551 ../fish/guestfish-actions.pod:2391
9714 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
9718 #: ../src/guestfs-actions.pod:3555 ../src/guestfs-actions.pod:6444
9719 msgid "(Added in 1.0.83)"
9723 #: ../src/guestfs-actions.pod:3557
9724 msgid "guestfs_lvresize"
9728 #: ../src/guestfs-actions.pod:3559
9732 " guestfs_lvresize (guestfs_h *g,\n"
9733 " const char *device,\n"
9739 #: ../src/guestfs-actions.pod:3564 ../fish/guestfish-actions.pod:2397
9741 "This resizes (expands or shrinks) an existing LVM logical volume to "
9742 "C<mbytes>. When reducing, data in the reduced part is lost."
9746 #: ../src/guestfs-actions.pod:3572
9747 msgid "guestfs_lvresize_free"
9751 #: ../src/guestfs-actions.pod:3574
9755 " guestfs_lvresize_free (guestfs_h *g,\n"
9756 " const char *lv,\n"
9762 #: ../src/guestfs-actions.pod:3579 ../fish/guestfish-actions.pod:2405
9764 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
9765 "remaining free space in the volume group. Commonly you would call this with "
9766 "pc = 100 which expands the logical volume as much as possible, using all "
9767 "remaining free space in the volume group."
9771 #: ../src/guestfs-actions.pod:3587
9772 msgid "(Added in 1.3.3)"
9776 #: ../src/guestfs-actions.pod:3589
9781 #: ../src/guestfs-actions.pod:3591
9785 " guestfs_lvs (guestfs_h *g);\n"
9790 #: ../src/guestfs-actions.pod:3594 ../fish/guestfish-actions.pod:2415
9792 "List all the logical volumes detected. This is the equivalent of the "
9793 "L<lvs(8)> command."
9797 #: ../src/guestfs-actions.pod:3597 ../fish/guestfish-actions.pod:2418
9799 "This returns a list of the logical volume device names "
9800 "(eg. C</dev/VolGroup00/LogVol00>)."
9804 #: ../src/guestfs-actions.pod:3600
9805 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
9809 #: ../src/guestfs-actions.pod:3608
9810 msgid "guestfs_lvs_full"
9814 #: ../src/guestfs-actions.pod:3610
9817 " struct guestfs_lvm_lv_list *\n"
9818 " guestfs_lvs_full (guestfs_h *g);\n"
9823 #: ../src/guestfs-actions.pod:3613 ../fish/guestfish-actions.pod:2427
9825 "List all the logical volumes detected. This is the equivalent of the "
9826 "L<lvs(8)> command. The \"full\" version includes all fields."
9830 #: ../src/guestfs-actions.pod:3616
9832 "This function returns a C<struct guestfs_lvm_lv_list *> (see "
9833 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
9834 "must call C<guestfs_free_lvm_lv_list> after use>."
9838 #: ../src/guestfs-actions.pod:3623
9839 msgid "guestfs_lvuuid"
9843 #: ../src/guestfs-actions.pod:3625
9847 " guestfs_lvuuid (guestfs_h *g,\n"
9848 " const char *device);\n"
9853 #: ../src/guestfs-actions.pod:3629 ../fish/guestfish-actions.pod:2434
9854 msgid "This command returns the UUID of the LVM LV C<device>."
9858 #: ../src/guestfs-actions.pod:3636
9859 msgid "guestfs_lxattrlist"
9863 #: ../src/guestfs-actions.pod:3638
9866 " struct guestfs_xattr_list *\n"
9867 " guestfs_lxattrlist (guestfs_h *g,\n"
9868 " const char *path,\n"
9869 " char *const *names);\n"
9874 #: ../src/guestfs-actions.pod:3643 ../fish/guestfish-actions.pod:2440
9876 "This call allows you to get the extended attributes of multiple files, where "
9877 "all files are in the directory C<path>. C<names> is the list of files from "
9882 #: ../src/guestfs-actions.pod:3647 ../fish/guestfish-actions.pod:2444
9884 "On return you get a flat list of xattr structs which must be interpreted "
9885 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
9886 "C<attrval> in this struct is zero-length to indicate there was an error "
9887 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
9888 "number (the number of following attributes for this file, which could be "
9889 "C<\"0\">). Then after the first xattr struct are the zero or more "
9890 "attributes for the first named file. This repeats for the second and "
9895 #: ../src/guestfs-actions.pod:3657
9897 "This call is intended for programs that want to efficiently list a directory "
9898 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
9899 "a similarly efficient call for getting standard stats. Very long directory "
9900 "listings might cause the protocol message size to be exceeded, causing this "
9901 "call to fail. The caller must split up such requests into smaller groups of "
9906 #: ../src/guestfs-actions.pod:3672
9907 msgid "guestfs_mkdir"
9911 #: ../src/guestfs-actions.pod:3674
9915 " guestfs_mkdir (guestfs_h *g,\n"
9916 " const char *path);\n"
9921 #: ../src/guestfs-actions.pod:3678 ../fish/guestfish-actions.pod:2466
9922 msgid "Create a directory named C<path>."
9926 #: ../src/guestfs-actions.pod:3684
9927 msgid "guestfs_mkdir_mode"
9931 #: ../src/guestfs-actions.pod:3686
9935 " guestfs_mkdir_mode (guestfs_h *g,\n"
9936 " const char *path,\n"
9942 #: ../src/guestfs-actions.pod:3691 ../fish/guestfish-actions.pod:2472
9944 "This command creates a directory, setting the initial permissions of the "
9945 "directory to C<mode>."
9949 #: ../src/guestfs-actions.pod:3694 ../fish/guestfish-actions.pod:2475
9951 "For common Linux filesystems, the actual mode which is set will be C<mode & "
9952 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
9957 #: ../src/guestfs-actions.pod:3698
9958 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
9962 #: ../src/guestfs-actions.pod:3704
9963 msgid "guestfs_mkdir_p"
9967 #: ../src/guestfs-actions.pod:3706
9971 " guestfs_mkdir_p (guestfs_h *g,\n"
9972 " const char *path);\n"
9977 #: ../src/guestfs-actions.pod:3710 ../fish/guestfish-actions.pod:2485
9979 "Create a directory named C<path>, creating any parent directories as "
9980 "necessary. This is like the C<mkdir -p> shell command."
9984 #: ../src/guestfs-actions.pod:3717
9985 msgid "guestfs_mkdtemp"
9989 #: ../src/guestfs-actions.pod:3719
9993 " guestfs_mkdtemp (guestfs_h *g,\n"
9994 " const char *template);\n"
9999 #: ../src/guestfs-actions.pod:3723 ../fish/guestfish-actions.pod:2492
10001 "This command creates a temporary directory. The C<template> parameter "
10002 "should be a full pathname for the temporary directory name with the final "
10003 "six characters being \"XXXXXX\"."
10007 #: ../src/guestfs-actions.pod:3728 ../fish/guestfish-actions.pod:2497
10009 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10010 "being suitable for Windows filesystems."
10014 #: ../src/guestfs-actions.pod:3731 ../fish/guestfish-actions.pod:2500
10015 msgid "The name of the temporary directory that was created is returned."
10019 #: ../src/guestfs-actions.pod:3734 ../fish/guestfish-actions.pod:2503
10020 msgid "The temporary directory is created with mode 0700 and is owned by root."
10024 #: ../src/guestfs-actions.pod:3737 ../fish/guestfish-actions.pod:2506
10026 "The caller is responsible for deleting the temporary directory and its "
10027 "contents after use."
10031 #: ../src/guestfs-actions.pod:3740 ../fish/guestfish-actions.pod:2509
10032 msgid "See also: L<mkdtemp(3)>"
10036 #: ../src/guestfs-actions.pod:3747
10037 msgid "guestfs_mke2fs_J"
10041 #: ../src/guestfs-actions.pod:3749
10045 " guestfs_mke2fs_J (guestfs_h *g,\n"
10046 " const char *fstype,\n"
10047 " int blocksize,\n"
10048 " const char *device,\n"
10049 " const char *journal);\n"
10054 #: ../src/guestfs-actions.pod:3756 ../fish/guestfish-actions.pod:2515
10056 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10057 "C<journal>. It is equivalent to the command:"
10061 #: ../src/guestfs-actions.pod:3760 ../fish/guestfish-actions.pod:2519
10064 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10069 #: ../src/guestfs-actions.pod:3762
10070 msgid "See also C<guestfs_mke2journal>."
10074 #: ../src/guestfs-actions.pod:3766 ../src/guestfs-actions.pod:3784 ../src/guestfs-actions.pod:3802 ../src/guestfs-actions.pod:3818 ../src/guestfs-actions.pod:3832 ../src/guestfs-actions.pod:3846 ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:4088
10075 msgid "(Added in 1.0.68)"
10079 #: ../src/guestfs-actions.pod:3768
10080 msgid "guestfs_mke2fs_JL"
10084 #: ../src/guestfs-actions.pod:3770
10088 " guestfs_mke2fs_JL (guestfs_h *g,\n"
10089 " const char *fstype,\n"
10090 " int blocksize,\n"
10091 " const char *device,\n"
10092 " const char *label);\n"
10097 #: ../src/guestfs-actions.pod:3777 ../fish/guestfish-actions.pod:2527
10099 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10100 "the journal labeled C<label>."
10104 #: ../src/guestfs-actions.pod:3780
10105 msgid "See also C<guestfs_mke2journal_L>."
10109 #: ../src/guestfs-actions.pod:3786
10110 msgid "guestfs_mke2fs_JU"
10114 #: ../src/guestfs-actions.pod:3788
10118 " guestfs_mke2fs_JU (guestfs_h *g,\n"
10119 " const char *fstype,\n"
10120 " int blocksize,\n"
10121 " const char *device,\n"
10122 " const char *uuid);\n"
10127 #: ../src/guestfs-actions.pod:3795 ../fish/guestfish-actions.pod:2536
10129 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10130 "the journal with UUID C<uuid>."
10134 #: ../src/guestfs-actions.pod:3798
10135 msgid "See also C<guestfs_mke2journal_U>."
10139 #: ../src/guestfs-actions.pod:3804
10140 msgid "guestfs_mke2journal"
10144 #: ../src/guestfs-actions.pod:3806
10148 " guestfs_mke2journal (guestfs_h *g,\n"
10149 " int blocksize,\n"
10150 " const char *device);\n"
10155 #: ../src/guestfs-actions.pod:3811 ../fish/guestfish-actions.pod:2545
10157 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10162 #: ../src/guestfs-actions.pod:3814 ../fish/guestfish-actions.pod:2548
10165 " mke2fs -O journal_dev -b blocksize device\n"
10170 #: ../src/guestfs-actions.pod:3820
10171 msgid "guestfs_mke2journal_L"
10175 #: ../src/guestfs-actions.pod:3822
10179 " guestfs_mke2journal_L (guestfs_h *g,\n"
10180 " int blocksize,\n"
10181 " const char *label,\n"
10182 " const char *device);\n"
10187 #: ../src/guestfs-actions.pod:3828 ../fish/guestfish-actions.pod:2554
10188 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10192 #: ../src/guestfs-actions.pod:3834
10193 msgid "guestfs_mke2journal_U"
10197 #: ../src/guestfs-actions.pod:3836
10201 " guestfs_mke2journal_U (guestfs_h *g,\n"
10202 " int blocksize,\n"
10203 " const char *uuid,\n"
10204 " const char *device);\n"
10209 #: ../src/guestfs-actions.pod:3842 ../fish/guestfish-actions.pod:2560
10210 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10214 #: ../src/guestfs-actions.pod:3848
10215 msgid "guestfs_mkfifo"
10219 #: ../src/guestfs-actions.pod:3850
10223 " guestfs_mkfifo (guestfs_h *g,\n"
10225 " const char *path);\n"
10230 #: ../src/guestfs-actions.pod:3855
10232 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10233 "is just a convenient wrapper around C<guestfs_mknod>."
10237 #: ../src/guestfs-actions.pod:3865
10238 msgid "guestfs_mkfs"
10242 #: ../src/guestfs-actions.pod:3867
10246 " guestfs_mkfs (guestfs_h *g,\n"
10247 " const char *fstype,\n"
10248 " const char *device);\n"
10253 #: ../src/guestfs-actions.pod:3872 ../fish/guestfish-actions.pod:2576
10255 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10256 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10260 #: ../src/guestfs-actions.pod:3880
10261 msgid "guestfs_mkfs_b"
10265 #: ../src/guestfs-actions.pod:3882
10269 " guestfs_mkfs_b (guestfs_h *g,\n"
10270 " const char *fstype,\n"
10271 " int blocksize,\n"
10272 " const char *device);\n"
10277 #: ../src/guestfs-actions.pod:3888
10279 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
10280 "block size of the resulting filesystem. Supported block sizes depend on the "
10281 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10285 #: ../src/guestfs-actions.pod:3893 ../fish/guestfish-actions.pod:2589
10287 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10292 #: ../src/guestfs-actions.pod:3900
10293 msgid "guestfs_mkmountpoint"
10297 #: ../src/guestfs-actions.pod:3902
10301 " guestfs_mkmountpoint (guestfs_h *g,\n"
10302 " const char *exemptpath);\n"
10307 #: ../src/guestfs-actions.pod:3906
10309 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
10310 "that can be used to create extra mountpoints before mounting the first "
10315 #: ../src/guestfs-actions.pod:3910 ../fish/guestfish-actions.pod:2600
10317 "These calls are I<only> necessary in some very limited circumstances, mainly "
10318 "the case where you want to mount a mix of unrelated and/or read-only "
10319 "filesystems together."
10323 #: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:2604
10325 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10326 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10327 "inside that. You can unpack this as follows in guestfish:"
10331 #: ../src/guestfs-actions.pod:3919 ../fish/guestfish-actions.pod:2609
10334 " add-ro Fedora-11-i686-Live.iso\n"
10336 " mkmountpoint /cd\n"
10337 " mkmountpoint /sqsh\n"
10338 " mkmountpoint /ext3fs\n"
10339 " mount /dev/sda /cd\n"
10340 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10341 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10346 #: ../src/guestfs-actions.pod:3928 ../fish/guestfish-actions.pod:2618
10347 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
10351 #: ../src/guestfs-actions.pod:3930
10353 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
10354 "may get unexpected errors if you try to mix these calls. It is safest to "
10355 "manually unmount filesystems and remove mountpoints after use."
10359 #: ../src/guestfs-actions.pod:3934
10361 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
10362 "first, so for this to work for manual mountpoints, you must ensure that the "
10363 "innermost mountpoints have the longest pathnames, as in the example code "
10368 #: ../src/guestfs-actions.pod:3939 ../fish/guestfish-actions.pod:2629
10369 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
10373 #: ../src/guestfs-actions.pod:3941
10375 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
10376 "means that C<guestfs_umount_all> is called when the handle is closed which "
10377 "can also trigger these issues."
10381 #: ../src/guestfs-actions.pod:3947 ../src/guestfs-actions.pod:4206 ../src/guestfs-actions.pod:5102
10382 msgid "(Added in 1.0.62)"
10386 #: ../src/guestfs-actions.pod:3949
10387 msgid "guestfs_mknod"
10391 #: ../src/guestfs-actions.pod:3951
10395 " guestfs_mknod (guestfs_h *g,\n"
10399 " const char *path);\n"
10404 #: ../src/guestfs-actions.pod:3958 ../fish/guestfish-actions.pod:2639
10406 "This call creates block or character special devices, or named pipes "
10411 #: ../src/guestfs-actions.pod:3961 ../fish/guestfish-actions.pod:2642
10413 "The C<mode> parameter should be the mode, using the standard constants. "
10414 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
10415 "used when creating block and character special devices."
10419 #: ../src/guestfs-actions.pod:3966
10421 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
10422 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
10423 "regular file). These constants are available in the standard Linux header "
10424 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
10425 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
10426 "the appropriate constant for you."
10430 #: ../src/guestfs-actions.pod:3980
10431 msgid "guestfs_mknod_b"
10435 #: ../src/guestfs-actions.pod:3982
10439 " guestfs_mknod_b (guestfs_h *g,\n"
10443 " const char *path);\n"
10448 #: ../src/guestfs-actions.pod:3989
10450 "This call creates a block device node called C<path> with mode C<mode> and "
10451 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10452 "wrapper around C<guestfs_mknod>."
10456 #: ../src/guestfs-actions.pod:3999
10457 msgid "guestfs_mknod_c"
10461 #: ../src/guestfs-actions.pod:4001
10465 " guestfs_mknod_c (guestfs_h *g,\n"
10469 " const char *path);\n"
10474 #: ../src/guestfs-actions.pod:4008
10476 "This call creates a char device node called C<path> with mode C<mode> and "
10477 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10478 "wrapper around C<guestfs_mknod>."
10482 #: ../src/guestfs-actions.pod:4018
10483 msgid "guestfs_mkswap"
10487 #: ../src/guestfs-actions.pod:4020
10491 " guestfs_mkswap (guestfs_h *g,\n"
10492 " const char *device);\n"
10497 #: ../src/guestfs-actions.pod:4024 ../fish/guestfish-actions.pod:2681
10498 msgid "Create a swap partition on C<device>."
10502 #: ../src/guestfs-actions.pod:4030
10503 msgid "guestfs_mkswap_L"
10507 #: ../src/guestfs-actions.pod:4032
10511 " guestfs_mkswap_L (guestfs_h *g,\n"
10512 " const char *label,\n"
10513 " const char *device);\n"
10518 #: ../src/guestfs-actions.pod:4037 ../fish/guestfish-actions.pod:2687
10519 msgid "Create a swap partition on C<device> with label C<label>."
10523 #: ../src/guestfs-actions.pod:4039 ../fish/guestfish-actions.pod:2689
10525 "Note that you cannot attach a swap label to a block device "
10526 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
10527 "the kernel or swap tools."
10531 #: ../src/guestfs-actions.pod:4047
10532 msgid "guestfs_mkswap_U"
10536 #: ../src/guestfs-actions.pod:4049
10540 " guestfs_mkswap_U (guestfs_h *g,\n"
10541 " const char *uuid,\n"
10542 " const char *device);\n"
10547 #: ../src/guestfs-actions.pod:4054 ../fish/guestfish-actions.pod:2697
10548 msgid "Create a swap partition on C<device> with UUID C<uuid>."
10552 #: ../src/guestfs-actions.pod:4060
10553 msgid "guestfs_mkswap_file"
10557 #: ../src/guestfs-actions.pod:4062
10561 " guestfs_mkswap_file (guestfs_h *g,\n"
10562 " const char *path);\n"
10567 #: ../src/guestfs-actions.pod:4066 ../fish/guestfish-actions.pod:2703
10568 msgid "Create a swap file."
10572 #: ../src/guestfs-actions.pod:4068
10574 "This command just writes a swap file signature to an existing file. To "
10575 "create the file itself, use something like C<guestfs_fallocate>."
10579 #: ../src/guestfs-actions.pod:4075
10580 msgid "guestfs_modprobe"
10584 #: ../src/guestfs-actions.pod:4077
10588 " guestfs_modprobe (guestfs_h *g,\n"
10589 " const char *modulename);\n"
10594 #: ../src/guestfs-actions.pod:4081 ../fish/guestfish-actions.pod:2712
10595 msgid "This loads a kernel module in the appliance."
10599 #: ../src/guestfs-actions.pod:4083 ../fish/guestfish-actions.pod:2714
10601 "The kernel module must have been whitelisted when libguestfs was built (see "
10602 "C<appliance/kmod.whitelist.in> in the source)."
10606 #: ../src/guestfs-actions.pod:4090
10607 msgid "guestfs_mount"
10611 #: ../src/guestfs-actions.pod:4092
10615 " guestfs_mount (guestfs_h *g,\n"
10616 " const char *device,\n"
10617 " const char *mountpoint);\n"
10622 #: ../src/guestfs-actions.pod:4097 ../fish/guestfish-actions.pod:2721
10624 "Mount a guest disk at a position in the filesystem. Block devices are named "
10625 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
10626 "those block devices contain partitions, they will have the usual names "
10627 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
10631 #: ../src/guestfs-actions.pod:4103 ../fish/guestfish-actions.pod:2727
10633 "The rules are the same as for L<mount(2)>: A filesystem must first be "
10634 "mounted on C</> before others can be mounted. Other filesystems can only be "
10635 "mounted on directories which already exist."
10639 #: ../src/guestfs-actions.pod:4108 ../fish/guestfish-actions.pod:2732
10641 "The mounted filesystem is writable, if we have sufficient permissions on the "
10642 "underlying device."
10646 #: ../src/guestfs-actions.pod:4111
10648 "B<Important note:> When you use this call, the filesystem options C<sync> "
10649 "and C<noatime> are set implicitly. This was originally done because we "
10650 "thought it would improve reliability, but it turns out that I<-o sync> has a "
10651 "very large negative performance impact and negligible effect on "
10652 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
10653 "in any code that needs performance, and instead use C<guestfs_mount_options> "
10654 "(use an empty string for the first parameter if you don't want any options)."
10658 #: ../src/guestfs-actions.pod:4125
10659 msgid "guestfs_mount_loop"
10663 #: ../src/guestfs-actions.pod:4127
10667 " guestfs_mount_loop (guestfs_h *g,\n"
10668 " const char *file,\n"
10669 " const char *mountpoint);\n"
10674 #: ../src/guestfs-actions.pod:4132 ../fish/guestfish-actions.pod:2749
10676 "This command lets you mount C<file> (a filesystem image in a file) on a "
10677 "mount point. It is entirely equivalent to the command C<mount -o loop file "
10682 #: ../src/guestfs-actions.pod:4140
10683 msgid "guestfs_mount_options"
10687 #: ../src/guestfs-actions.pod:4142
10691 " guestfs_mount_options (guestfs_h *g,\n"
10692 " const char *options,\n"
10693 " const char *device,\n"
10694 " const char *mountpoint);\n"
10699 #: ../src/guestfs-actions.pod:4148
10701 "This is the same as the C<guestfs_mount> command, but it allows you to set "
10702 "the mount options as for the L<mount(8)> I<-o> flag."
10706 #: ../src/guestfs-actions.pod:4152 ../fish/guestfish-actions.pod:2761
10708 "If the C<options> parameter is an empty string, then no options are passed "
10709 "(all options default to whatever the filesystem uses)."
10713 #: ../src/guestfs-actions.pod:4158 ../src/guestfs-actions.pod:4172 ../src/guestfs-actions.pod:4189
10714 msgid "(Added in 1.0.10)"
10718 #: ../src/guestfs-actions.pod:4160
10719 msgid "guestfs_mount_ro"
10723 #: ../src/guestfs-actions.pod:4162
10727 " guestfs_mount_ro (guestfs_h *g,\n"
10728 " const char *device,\n"
10729 " const char *mountpoint);\n"
10734 #: ../src/guestfs-actions.pod:4167
10736 "This is the same as the C<guestfs_mount> command, but it mounts the "
10737 "filesystem with the read-only (I<-o ro>) flag."
10741 #: ../src/guestfs-actions.pod:4174
10742 msgid "guestfs_mount_vfs"
10746 #: ../src/guestfs-actions.pod:4176
10750 " guestfs_mount_vfs (guestfs_h *g,\n"
10751 " const char *options,\n"
10752 " const char *vfstype,\n"
10753 " const char *device,\n"
10754 " const char *mountpoint);\n"
10759 #: ../src/guestfs-actions.pod:4183
10761 "This is the same as the C<guestfs_mount> command, but it allows you to set "
10762 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
10767 #: ../src/guestfs-actions.pod:4191
10768 msgid "guestfs_mountpoints"
10772 #: ../src/guestfs-actions.pod:4193
10776 " guestfs_mountpoints (guestfs_h *g);\n"
10781 #: ../src/guestfs-actions.pod:4196
10783 "This call is similar to C<guestfs_mounts>. That call returns a list of "
10784 "devices. This one returns a hash table (map) of device name to directory "
10785 "where the device is mounted."
10789 #: ../src/guestfs-actions.pod:4208
10790 msgid "guestfs_mounts"
10794 #: ../src/guestfs-actions.pod:4210
10798 " guestfs_mounts (guestfs_h *g);\n"
10803 #: ../src/guestfs-actions.pod:4213 ../fish/guestfish-actions.pod:2792
10805 "This returns the list of currently mounted filesystems. It returns the list "
10806 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
10810 #: ../src/guestfs-actions.pod:4216 ../fish/guestfish-actions.pod:2795
10811 msgid "Some internal mounts are not shown."
10815 #: ../src/guestfs-actions.pod:4218
10816 msgid "See also: C<guestfs_mountpoints>"
10820 #: ../src/guestfs-actions.pod:4226
10825 #: ../src/guestfs-actions.pod:4228
10829 " guestfs_mv (guestfs_h *g,\n"
10830 " const char *src,\n"
10831 " const char *dest);\n"
10836 #: ../src/guestfs-actions.pod:4233 ../fish/guestfish-actions.pod:2803
10838 "This moves a file from C<src> to C<dest> where C<dest> is either a "
10839 "destination filename or destination directory."
10843 #: ../src/guestfs-actions.pod:4240
10844 msgid "guestfs_ntfs_3g_probe"
10848 #: ../src/guestfs-actions.pod:4242
10852 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
10854 " const char *device);\n"
10859 #: ../src/guestfs-actions.pod:4247 ../fish/guestfish-actions.pod:2810
10861 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
10862 "C<device> for mountability. (Not all NTFS volumes can be mounted "
10863 "read-write, and some cannot be mounted at all)."
10867 #: ../src/guestfs-actions.pod:4251 ../fish/guestfish-actions.pod:2814
10869 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
10870 "can be mounted read-write. Set it to false if you want to test if the "
10871 "volume can be mounted read-only."
10875 #: ../src/guestfs-actions.pod:4255 ../fish/guestfish-actions.pod:2818
10877 "The return value is an integer which C<0> if the operation would succeed, or "
10878 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
10882 #: ../src/guestfs-actions.pod:4261
10883 msgid "(Added in 1.0.43)"
10887 #: ../src/guestfs-actions.pod:4263
10888 msgid "guestfs_ntfsresize"
10892 #: ../src/guestfs-actions.pod:4265
10896 " guestfs_ntfsresize (guestfs_h *g,\n"
10897 " const char *device);\n"
10902 #: ../src/guestfs-actions.pod:4269 ../fish/guestfish-actions.pod:2826
10904 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
10905 "size of the underlying device. See also L<ntfsresize(8)>."
10909 #: ../src/guestfs-actions.pod:4277
10910 msgid "guestfs_ntfsresize_size"
10914 #: ../src/guestfs-actions.pod:4279
10918 " guestfs_ntfsresize_size (guestfs_h *g,\n"
10919 " const char *device,\n"
10920 " int64_t size);\n"
10925 #: ../src/guestfs-actions.pod:4284
10927 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
10928 "to specify the new size (in bytes) explicitly."
10932 #: ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:4726 ../src/guestfs-actions.pod:4800 ../src/guestfs-actions.pod:5050
10933 msgid "(Added in 1.3.14)"
10937 #: ../src/guestfs-actions.pod:4291
10938 msgid "guestfs_part_add"
10942 #: ../src/guestfs-actions.pod:4293
10946 " guestfs_part_add (guestfs_h *g,\n"
10947 " const char *device,\n"
10948 " const char *prlogex,\n"
10949 " int64_t startsect,\n"
10950 " int64_t endsect);\n"
10955 #: ../src/guestfs-actions.pod:4300
10957 "This command adds a partition to C<device>. If there is no partition table "
10958 "on the device, call C<guestfs_part_init> first."
10962 #: ../src/guestfs-actions.pod:4303 ../fish/guestfish-actions.pod:2844
10964 "The C<prlogex> parameter is the type of partition. Normally you should pass "
10965 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
10966 "C<logical>) and C<e> (or C<extended>) partition types."
10970 #: ../src/guestfs-actions.pod:4308 ../fish/guestfish-actions.pod:2849
10972 "C<startsect> and C<endsect> are the start and end of the partition in "
10973 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
10974 "from the end of the disk (C<-1> is the last sector)."
10978 #: ../src/guestfs-actions.pod:4312
10980 "Creating a partition which covers the whole disk is not so easy. Use "
10981 "C<guestfs_part_disk> to do that."
10985 #: ../src/guestfs-actions.pod:4317 ../src/guestfs-actions.pod:4355 ../src/guestfs-actions.pod:4408 ../src/guestfs-actions.pod:4486 ../src/guestfs-actions.pod:4525 ../src/guestfs-actions.pod:4544 ../src/guestfs-actions.pod:4584
10986 msgid "(Added in 1.0.78)"
10990 #: ../src/guestfs-actions.pod:4319
10991 msgid "guestfs_part_del"
10995 #: ../src/guestfs-actions.pod:4321
10999 " guestfs_part_del (guestfs_h *g,\n"
11000 " const char *device,\n"
11006 #: ../src/guestfs-actions.pod:4326 ../fish/guestfish-actions.pod:2860
11007 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11011 #: ../src/guestfs-actions.pod:4328 ../fish/guestfish-actions.pod:2862
11013 "Note that in the case of MBR partitioning, deleting an extended partition "
11014 "also deletes any logical partitions it contains."
11018 #: ../src/guestfs-actions.pod:4336
11019 msgid "guestfs_part_disk"
11023 #: ../src/guestfs-actions.pod:4338
11027 " guestfs_part_disk (guestfs_h *g,\n"
11028 " const char *device,\n"
11029 " const char *parttype);\n"
11034 #: ../src/guestfs-actions.pod:4343
11036 "This command is simply a combination of C<guestfs_part_init> followed by "
11037 "C<guestfs_part_add> to create a single primary partition covering the whole "
11042 #: ../src/guestfs-actions.pod:4347
11044 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11045 "possible values are described in C<guestfs_part_init>."
11049 #: ../src/guestfs-actions.pod:4357
11050 msgid "guestfs_part_get_bootable"
11054 #: ../src/guestfs-actions.pod:4359
11058 " guestfs_part_get_bootable (guestfs_h *g,\n"
11059 " const char *device,\n"
11065 #: ../src/guestfs-actions.pod:4364 ../fish/guestfish-actions.pod:2884
11067 "This command returns true if the partition C<partnum> on C<device> has the "
11068 "bootable flag set."
11072 #: ../src/guestfs-actions.pod:4367
11073 msgid "See also C<guestfs_part_set_bootable>."
11077 #: ../src/guestfs-actions.pod:4373
11078 msgid "guestfs_part_get_mbr_id"
11082 #: ../src/guestfs-actions.pod:4375
11086 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
11087 " const char *device,\n"
11093 #: ../src/guestfs-actions.pod:4380 ../fish/guestfish-actions.pod:2893
11095 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11096 "partition C<partnum>."
11100 #: ../src/guestfs-actions.pod:4383 ../src/guestfs-actions.pod:4560
11102 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11103 "undefined results for other partition table types (see "
11104 "C<guestfs_part_get_parttype>)."
11108 #: ../src/guestfs-actions.pod:4391
11109 msgid "guestfs_part_get_parttype"
11113 #: ../src/guestfs-actions.pod:4393
11117 " guestfs_part_get_parttype (guestfs_h *g,\n"
11118 " const char *device);\n"
11123 #: ../src/guestfs-actions.pod:4397 ../fish/guestfish-actions.pod:2904
11125 "This command examines the partition table on C<device> and returns the "
11126 "partition table type (format) being used."
11130 #: ../src/guestfs-actions.pod:4400
11132 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11133 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11134 "possible, although unusual. See C<guestfs_part_init> for a full list."
11138 #: ../src/guestfs-actions.pod:4410
11139 msgid "guestfs_part_init"
11143 #: ../src/guestfs-actions.pod:4412
11147 " guestfs_part_init (guestfs_h *g,\n"
11148 " const char *device,\n"
11149 " const char *parttype);\n"
11154 #: ../src/guestfs-actions.pod:4417 ../fish/guestfish-actions.pod:2916
11156 "This creates an empty partition table on C<device> of one of the partition "
11157 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11158 "(for large disks)."
11162 #: ../src/guestfs-actions.pod:4421
11164 "Initially there are no partitions. Following this, you should call "
11165 "C<guestfs_part_add> for each partition required."
11169 #: ../src/guestfs-actions.pod:4424 ../fish/guestfish-actions.pod:2923
11170 msgid "Possible values for C<parttype> are:"
11174 #: ../src/guestfs-actions.pod:4428 ../fish/guestfish-actions.pod:2927
11175 msgid "B<efi> | B<gpt>"
11179 #: ../src/guestfs-actions.pod:4430 ../fish/guestfish-actions.pod:2929
11180 msgid "Intel EFI / GPT partition table."
11184 #: ../src/guestfs-actions.pod:4432 ../fish/guestfish-actions.pod:2931
11186 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11187 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11188 "the C<mbr> format."
11192 #: ../src/guestfs-actions.pod:4436 ../fish/guestfish-actions.pod:2935
11193 msgid "B<mbr> | B<msdos>"
11197 #: ../src/guestfs-actions.pod:4438 ../fish/guestfish-actions.pod:2937
11199 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11200 "Windows. This partition type will B<only> work for device sizes up to 2 "
11201 "TB. For large disks we recommend using C<gpt>."
11205 #: ../src/guestfs-actions.pod:4445 ../fish/guestfish-actions.pod:2944
11206 msgid "Other partition table types that may work but are not supported include:"
11210 #: ../src/guestfs-actions.pod:4450 ../fish/guestfish-actions.pod:2949
11215 #: ../src/guestfs-actions.pod:4452 ../fish/guestfish-actions.pod:2951
11216 msgid "AIX disk labels."
11220 #: ../src/guestfs-actions.pod:4454 ../fish/guestfish-actions.pod:2953
11221 msgid "B<amiga> | B<rdb>"
11225 #: ../src/guestfs-actions.pod:4456 ../fish/guestfish-actions.pod:2955
11226 msgid "Amiga \"Rigid Disk Block\" format."
11230 #: ../src/guestfs-actions.pod:4458 ../fish/guestfish-actions.pod:2957
11235 #: ../src/guestfs-actions.pod:4460 ../fish/guestfish-actions.pod:2959
11236 msgid "BSD disk labels."
11240 #: ../src/guestfs-actions.pod:4462 ../fish/guestfish-actions.pod:2961
11245 #: ../src/guestfs-actions.pod:4464 ../fish/guestfish-actions.pod:2963
11246 msgid "DASD, used on IBM mainframes."
11250 #: ../src/guestfs-actions.pod:4466 ../fish/guestfish-actions.pod:2965
11255 #: ../src/guestfs-actions.pod:4468 ../fish/guestfish-actions.pod:2967
11256 msgid "MIPS/SGI volumes."
11260 #: ../src/guestfs-actions.pod:4470 ../fish/guestfish-actions.pod:2969
11265 #: ../src/guestfs-actions.pod:4472 ../fish/guestfish-actions.pod:2971
11266 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11270 #: ../src/guestfs-actions.pod:4474 ../fish/guestfish-actions.pod:2973
11275 #: ../src/guestfs-actions.pod:4476 ../fish/guestfish-actions.pod:2975
11276 msgid "NEC PC-98 format, common in Japan apparently."
11280 #: ../src/guestfs-actions.pod:4478 ../fish/guestfish-actions.pod:2977
11285 #: ../src/guestfs-actions.pod:4480 ../fish/guestfish-actions.pod:2979
11286 msgid "Sun disk labels."
11290 #: ../src/guestfs-actions.pod:4488
11291 msgid "guestfs_part_list"
11295 #: ../src/guestfs-actions.pod:4490
11298 " struct guestfs_partition_list *\n"
11299 " guestfs_part_list (guestfs_h *g,\n"
11300 " const char *device);\n"
11305 #: ../src/guestfs-actions.pod:4494 ../fish/guestfish-actions.pod:2987
11307 "This command parses the partition table on C<device> and returns the list of "
11308 "partitions found."
11312 #: ../src/guestfs-actions.pod:4497 ../fish/guestfish-actions.pod:2990
11313 msgid "The fields in the returned structure are:"
11317 #: ../src/guestfs-actions.pod:4501 ../fish/guestfish-actions.pod:2994
11318 msgid "B<part_num>"
11322 #: ../src/guestfs-actions.pod:4503 ../fish/guestfish-actions.pod:2996
11323 msgid "Partition number, counting from 1."
11327 #: ../src/guestfs-actions.pod:4505 ../fish/guestfish-actions.pod:2998
11328 msgid "B<part_start>"
11332 #: ../src/guestfs-actions.pod:4507
11334 "Start of the partition I<in bytes>. To get sectors you have to divide by "
11335 "the device's sector size, see C<guestfs_blockdev_getss>."
11339 #: ../src/guestfs-actions.pod:4510 ../fish/guestfish-actions.pod:3003
11340 msgid "B<part_end>"
11344 #: ../src/guestfs-actions.pod:4512 ../fish/guestfish-actions.pod:3005
11345 msgid "End of the partition in bytes."
11349 #: ../src/guestfs-actions.pod:4514 ../fish/guestfish-actions.pod:3007
11350 msgid "B<part_size>"
11354 #: ../src/guestfs-actions.pod:4516 ../fish/guestfish-actions.pod:3009
11355 msgid "Size of the partition in bytes."
11359 #: ../src/guestfs-actions.pod:4520
11361 "This function returns a C<struct guestfs_partition_list *> (see "
11362 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
11363 "must call C<guestfs_free_partition_list> after use>."
11367 #: ../src/guestfs-actions.pod:4527
11368 msgid "guestfs_part_set_bootable"
11372 #: ../src/guestfs-actions.pod:4529
11376 " guestfs_part_set_bootable (guestfs_h *g,\n"
11377 " const char *device,\n"
11379 " int bootable);\n"
11384 #: ../src/guestfs-actions.pod:4535 ../fish/guestfish-actions.pod:3017
11386 "This sets the bootable flag on partition numbered C<partnum> on device "
11387 "C<device>. Note that partitions are numbered from 1."
11391 #: ../src/guestfs-actions.pod:4538 ../fish/guestfish-actions.pod:3020
11393 "The bootable flag is used by some operating systems (notably Windows) to "
11394 "determine which partition to boot from. It is by no means universally "
11399 #: ../src/guestfs-actions.pod:4546
11400 msgid "guestfs_part_set_mbr_id"
11404 #: ../src/guestfs-actions.pod:4548
11408 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
11409 " const char *device,\n"
11416 #: ../src/guestfs-actions.pod:4554 ../fish/guestfish-actions.pod:3028
11418 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
11419 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
11420 "documentation are in fact hexadecimal numbers, but usually documented "
11421 "without any leading \"0x\" which might be confusing."
11425 #: ../src/guestfs-actions.pod:4568
11426 msgid "guestfs_part_set_name"
11430 #: ../src/guestfs-actions.pod:4570
11434 " guestfs_part_set_name (guestfs_h *g,\n"
11435 " const char *device,\n"
11437 " const char *name);\n"
11442 #: ../src/guestfs-actions.pod:4576 ../fish/guestfish-actions.pod:3042
11444 "This sets the partition name on partition numbered C<partnum> on device "
11445 "C<device>. Note that partitions are numbered from 1."
11449 #: ../src/guestfs-actions.pod:4579 ../fish/guestfish-actions.pod:3045
11451 "The partition name can only be set on certain types of partition table. "
11452 "This works on C<gpt> but not on C<mbr> partitions."
11456 #: ../src/guestfs-actions.pod:4586
11457 msgid "guestfs_part_to_dev"
11461 #: ../src/guestfs-actions.pod:4588
11465 " guestfs_part_to_dev (guestfs_h *g,\n"
11466 " const char *partition);\n"
11471 #: ../src/guestfs-actions.pod:4592 ../fish/guestfish-actions.pod:3052
11473 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
11474 "partition number, returning the device name (eg. \"/dev/sdb\")."
11478 #: ../src/guestfs-actions.pod:4596
11480 "The named partition must exist, for example as a string returned from "
11481 "C<guestfs_list_partitions>."
11485 #: ../src/guestfs-actions.pod:4604
11486 msgid "guestfs_ping_daemon"
11490 #: ../src/guestfs-actions.pod:4606
11494 " guestfs_ping_daemon (guestfs_h *g);\n"
11499 #: ../src/guestfs-actions.pod:4609 ../fish/guestfish-actions.pod:3063
11501 "This is a test probe into the guestfs daemon running inside the qemu "
11502 "subprocess. Calling this function checks that the daemon responds to the "
11503 "ping message, without affecting the daemon or attached block device(s) in "
11508 #: ../src/guestfs-actions.pod:4618
11509 msgid "guestfs_pread"
11513 #: ../src/guestfs-actions.pod:4620
11517 " guestfs_pread (guestfs_h *g,\n"
11518 " const char *path,\n"
11520 " int64_t offset,\n"
11521 " size_t *size_r);\n"
11526 #: ../src/guestfs-actions.pod:4627 ../fish/guestfish-actions.pod:3072
11528 "This command lets you read part of a file. It reads C<count> bytes of the "
11529 "file, starting at C<offset>, from file C<path>."
11533 #: ../src/guestfs-actions.pod:4630 ../src/guestfs-actions.pod:4656 ../fish/guestfish-actions.pod:3075 ../fish/guestfish-actions.pod:3090
11535 "This may read fewer bytes than requested. For further details see the "
11536 "L<pread(2)> system call."
11540 #: ../src/guestfs-actions.pod:4633
11541 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
11545 #: ../src/guestfs-actions.pod:4644
11546 msgid "guestfs_pread_device"
11550 #: ../src/guestfs-actions.pod:4646
11554 " guestfs_pread_device (guestfs_h *g,\n"
11555 " const char *device,\n"
11557 " int64_t offset,\n"
11558 " size_t *size_r);\n"
11563 #: ../src/guestfs-actions.pod:4653 ../fish/guestfish-actions.pod:3087
11565 "This command lets you read part of a file. It reads C<count> bytes of "
11566 "C<device>, starting at C<offset>."
11570 #: ../src/guestfs-actions.pod:4659
11571 msgid "See also C<guestfs_pread>."
11575 #: ../src/guestfs-actions.pod:4668
11576 msgid "(Added in 1.5.21)"
11580 #: ../src/guestfs-actions.pod:4670
11581 msgid "guestfs_pvcreate"
11585 #: ../src/guestfs-actions.pod:4672
11589 " guestfs_pvcreate (guestfs_h *g,\n"
11590 " const char *device);\n"
11595 #: ../src/guestfs-actions.pod:4676 ../fish/guestfish-actions.pod:3102
11597 "This creates an LVM physical volume on the named C<device>, where C<device> "
11598 "should usually be a partition name such as C</dev/sda1>."
11602 #: ../src/guestfs-actions.pod:4684
11603 msgid "guestfs_pvremove"
11607 #: ../src/guestfs-actions.pod:4686
11611 " guestfs_pvremove (guestfs_h *g,\n"
11612 " const char *device);\n"
11617 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3110
11619 "This wipes a physical volume C<device> so that LVM will no longer recognise "
11624 #: ../src/guestfs-actions.pod:4693 ../fish/guestfish-actions.pod:3113
11626 "The implementation uses the C<pvremove> command which refuses to wipe "
11627 "physical volumes that contain any volume groups, so you have to remove those "
11632 #: ../src/guestfs-actions.pod:4701
11633 msgid "guestfs_pvresize"
11637 #: ../src/guestfs-actions.pod:4703
11641 " guestfs_pvresize (guestfs_h *g,\n"
11642 " const char *device);\n"
11647 #: ../src/guestfs-actions.pod:4707 ../fish/guestfish-actions.pod:3121
11649 "This resizes (expands or shrinks) an existing LVM physical volume to match "
11650 "the new size of the underlying device."
11654 #: ../src/guestfs-actions.pod:4714
11655 msgid "guestfs_pvresize_size"
11659 #: ../src/guestfs-actions.pod:4716
11663 " guestfs_pvresize_size (guestfs_h *g,\n"
11664 " const char *device,\n"
11665 " int64_t size);\n"
11670 #: ../src/guestfs-actions.pod:4721
11672 "This command is the same as C<guestfs_pvresize> except that it allows you to "
11673 "specify the new size (in bytes) explicitly."
11677 #: ../src/guestfs-actions.pod:4728
11678 msgid "guestfs_pvs"
11682 #: ../src/guestfs-actions.pod:4730
11686 " guestfs_pvs (guestfs_h *g);\n"
11691 #: ../src/guestfs-actions.pod:4733 ../fish/guestfish-actions.pod:3135
11693 "List all the physical volumes detected. This is the equivalent of the "
11694 "L<pvs(8)> command."
11698 #: ../src/guestfs-actions.pod:4736 ../fish/guestfish-actions.pod:3138
11700 "This returns a list of just the device names that contain PVs "
11701 "(eg. C</dev/sda2>)."
11705 #: ../src/guestfs-actions.pod:4739
11706 msgid "See also C<guestfs_pvs_full>."
11710 #: ../src/guestfs-actions.pod:4747
11711 msgid "guestfs_pvs_full"
11715 #: ../src/guestfs-actions.pod:4749
11718 " struct guestfs_lvm_pv_list *\n"
11719 " guestfs_pvs_full (guestfs_h *g);\n"
11724 #: ../src/guestfs-actions.pod:4752 ../fish/guestfish-actions.pod:3147
11726 "List all the physical volumes detected. This is the equivalent of the "
11727 "L<pvs(8)> command. The \"full\" version includes all fields."
11731 #: ../src/guestfs-actions.pod:4755
11733 "This function returns a C<struct guestfs_lvm_pv_list *> (see "
11734 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
11735 "must call C<guestfs_free_lvm_pv_list> after use>."
11739 #: ../src/guestfs-actions.pod:4762
11740 msgid "guestfs_pvuuid"
11744 #: ../src/guestfs-actions.pod:4764
11748 " guestfs_pvuuid (guestfs_h *g,\n"
11749 " const char *device);\n"
11754 #: ../src/guestfs-actions.pod:4768 ../fish/guestfish-actions.pod:3154
11755 msgid "This command returns the UUID of the LVM PV C<device>."
11759 #: ../src/guestfs-actions.pod:4775
11760 msgid "guestfs_pwrite"
11764 #: ../src/guestfs-actions.pod:4777
11768 " guestfs_pwrite (guestfs_h *g,\n"
11769 " const char *path,\n"
11770 " const char *content,\n"
11771 " size_t content_size,\n"
11772 " int64_t offset);\n"
11777 #: ../src/guestfs-actions.pod:4784 ../fish/guestfish-actions.pod:3160
11779 "This command writes to part of a file. It writes the data buffer C<content> "
11780 "to the file C<path> starting at offset C<offset>."
11784 #: ../src/guestfs-actions.pod:4787 ../fish/guestfish-actions.pod:3163
11786 "This command implements the L<pwrite(2)> system call, and like that system "
11787 "call it may not write the full data requested. The return value is the "
11788 "number of bytes that were actually written to the file. This could even be "
11789 "0, although short writes are unlikely for regular files in ordinary "
11794 #: ../src/guestfs-actions.pod:4793
11795 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
11799 #: ../src/guestfs-actions.pod:4802
11800 msgid "guestfs_pwrite_device"
11804 #: ../src/guestfs-actions.pod:4804
11808 " guestfs_pwrite_device (guestfs_h *g,\n"
11809 " const char *device,\n"
11810 " const char *content,\n"
11811 " size_t content_size,\n"
11812 " int64_t offset);\n"
11817 #: ../src/guestfs-actions.pod:4811 ../fish/guestfish-actions.pod:3178
11819 "This command writes to part of a device. It writes the data buffer "
11820 "C<content> to C<device> starting at offset C<offset>."
11824 #: ../src/guestfs-actions.pod:4814 ../fish/guestfish-actions.pod:3181
11826 "This command implements the L<pwrite(2)> system call, and like that system "
11827 "call it may not write the full data requested (although short writes to disk "
11828 "devices and partitions are probably impossible with standard Linux kernels)."
11832 #: ../src/guestfs-actions.pod:4819
11833 msgid "See also C<guestfs_pwrite>."
11837 #: ../src/guestfs-actions.pod:4826
11838 msgid "(Added in 1.5.20)"
11842 #: ../src/guestfs-actions.pod:4828
11843 msgid "guestfs_read_file"
11847 #: ../src/guestfs-actions.pod:4830
11851 " guestfs_read_file (guestfs_h *g,\n"
11852 " const char *path,\n"
11853 " size_t *size_r);\n"
11858 #: ../src/guestfs-actions.pod:4835 ../fish/guestfish-actions.pod:3195
11859 msgid "This calls returns the contents of the file C<path> as a buffer."
11863 #: ../src/guestfs-actions.pod:4838
11865 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
11866 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
11867 "function is limited in the total size of file that can be handled."
11871 #: ../src/guestfs-actions.pod:4850
11872 msgid "(Added in 1.0.63)"
11876 #: ../src/guestfs-actions.pod:4852
11877 msgid "guestfs_read_lines"
11881 #: ../src/guestfs-actions.pod:4854
11885 " guestfs_read_lines (guestfs_h *g,\n"
11886 " const char *path);\n"
11891 #: ../src/guestfs-actions.pod:4860 ../fish/guestfish-actions.pod:3212
11893 "The file contents are returned as a list of lines. Trailing C<LF> and "
11894 "C<CRLF> character sequences are I<not> returned."
11898 #: ../src/guestfs-actions.pod:4863
11900 "Note that this function cannot correctly handle binary files (specifically, "
11901 "files containing C<\\0> character which is treated as end of line). For "
11902 "those you need to use the C<guestfs_read_file> function which has a more "
11903 "complex interface."
11907 #: ../src/guestfs-actions.pod:4874
11908 msgid "guestfs_readdir"
11912 #: ../src/guestfs-actions.pod:4876
11915 " struct guestfs_dirent_list *\n"
11916 " guestfs_readdir (guestfs_h *g,\n"
11917 " const char *dir);\n"
11922 #: ../src/guestfs-actions.pod:4880 ../fish/guestfish-actions.pod:3224
11923 msgid "This returns the list of directory entries in directory C<dir>."
11927 #: ../src/guestfs-actions.pod:4882 ../fish/guestfish-actions.pod:3226
11929 "All entries in the directory are returned, including C<.> and C<..>. The "
11930 "entries are I<not> sorted, but returned in the same order as the underlying "
11935 #: ../src/guestfs-actions.pod:4886 ../fish/guestfish-actions.pod:3230
11937 "Also this call returns basic file type information about each file. The "
11938 "C<ftyp> field will contain one of the following characters:"
11942 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3235
11947 #: ../src/guestfs-actions.pod:4893 ../fish/guestfish-actions.pod:3237
11948 msgid "Block special"
11952 #: ../src/guestfs-actions.pod:4895 ../fish/guestfish-actions.pod:3239
11957 #: ../src/guestfs-actions.pod:4897 ../fish/guestfish-actions.pod:3241
11958 msgid "Char special"
11962 #: ../src/guestfs-actions.pod:4899 ../fish/guestfish-actions.pod:3243
11967 #: ../src/guestfs-actions.pod:4901 ../fish/guestfish-actions.pod:3245
11972 #: ../src/guestfs-actions.pod:4903 ../fish/guestfish-actions.pod:3247
11977 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3249
11978 msgid "FIFO (named pipe)"
11982 #: ../src/guestfs-actions.pod:4907 ../fish/guestfish-actions.pod:3251
11987 #: ../src/guestfs-actions.pod:4909 ../fish/guestfish-actions.pod:3253
11988 msgid "Symbolic link"
11992 #: ../src/guestfs-actions.pod:4911 ../fish/guestfish-actions.pod:3255
11997 #: ../src/guestfs-actions.pod:4913 ../fish/guestfish-actions.pod:3257
11998 msgid "Regular file"
12002 #: ../src/guestfs-actions.pod:4915 ../fish/guestfish-actions.pod:3259
12007 #: ../src/guestfs-actions.pod:4917 ../fish/guestfish-actions.pod:3261
12012 #: ../src/guestfs-actions.pod:4919 ../fish/guestfish-actions.pod:3263
12017 #: ../src/guestfs-actions.pod:4921 ../fish/guestfish-actions.pod:3265
12018 msgid "Unknown file type"
12022 #: ../src/guestfs-actions.pod:4923 ../fish/guestfish-actions.pod:3267
12027 #: ../src/guestfs-actions.pod:4925 ../fish/guestfish-actions.pod:3269
12028 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12032 #: ../src/guestfs-actions.pod:4930
12034 "This function is primarily intended for use by programs. To get a simple "
12035 "list of names, use C<guestfs_ls>. To get a printable directory for human "
12036 "consumption, use C<guestfs_ll>."
12040 #: ../src/guestfs-actions.pod:4934
12042 "This function returns a C<struct guestfs_dirent_list *> (see "
12043 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
12044 "must call C<guestfs_free_dirent_list> after use>."
12048 #: ../src/guestfs-actions.pod:4941
12049 msgid "guestfs_readlink"
12053 #: ../src/guestfs-actions.pod:4943
12057 " guestfs_readlink (guestfs_h *g,\n"
12058 " const char *path);\n"
12063 #: ../src/guestfs-actions.pod:4947 ../fish/guestfish-actions.pod:3282
12064 msgid "This command reads the target of a symbolic link."
12068 #: ../src/guestfs-actions.pod:4954
12069 msgid "guestfs_readlinklist"
12073 #: ../src/guestfs-actions.pod:4956
12077 " guestfs_readlinklist (guestfs_h *g,\n"
12078 " const char *path,\n"
12079 " char *const *names);\n"
12084 #: ../src/guestfs-actions.pod:4961 ../fish/guestfish-actions.pod:3288
12086 "This call allows you to do a C<readlink> operation on multiple files, where "
12087 "all files are in the directory C<path>. C<names> is the list of files from "
12092 #: ../src/guestfs-actions.pod:4965 ../fish/guestfish-actions.pod:3292
12094 "On return you get a list of strings, with a one-to-one correspondence to the "
12095 "C<names> list. Each string is the value of the symbolic link."
12099 #: ../src/guestfs-actions.pod:4969 ../fish/guestfish-actions.pod:3296
12101 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12102 "result string is the empty string C<\"\">. However the whole operation is "
12103 "completed even if there were C<readlink(2)> errors, and so you can call this "
12104 "function with names where you don't know if they are symbolic links already "
12105 "(albeit slightly less efficient)."
12109 #: ../src/guestfs-actions.pod:4976 ../fish/guestfish-actions.pod:3303
12111 "This call is intended for programs that want to efficiently list a directory "
12112 "contents without making many round-trips. Very long directory listings "
12113 "might cause the protocol message size to be exceeded, causing this call to "
12114 "fail. The caller must split up such requests into smaller groups of names."
12118 #: ../src/guestfs-actions.pod:4989
12119 msgid "guestfs_realpath"
12123 #: ../src/guestfs-actions.pod:4991
12127 " guestfs_realpath (guestfs_h *g,\n"
12128 " const char *path);\n"
12133 #: ../src/guestfs-actions.pod:4995 ../fish/guestfish-actions.pod:3314
12135 "Return the canonicalized absolute pathname of C<path>. The returned path "
12136 "has no C<.>, C<..> or symbolic link path elements."
12140 #: ../src/guestfs-actions.pod:5003
12141 msgid "guestfs_removexattr"
12145 #: ../src/guestfs-actions.pod:5005
12149 " guestfs_removexattr (guestfs_h *g,\n"
12150 " const char *xattr,\n"
12151 " const char *path);\n"
12156 #: ../src/guestfs-actions.pod:5010 ../fish/guestfish-actions.pod:3321
12157 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
12161 #: ../src/guestfs-actions.pod:5013
12162 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
12166 #: ../src/guestfs-actions.pod:5019
12167 msgid "guestfs_resize2fs"
12171 #: ../src/guestfs-actions.pod:5021
12175 " guestfs_resize2fs (guestfs_h *g,\n"
12176 " const char *device);\n"
12181 #: ../src/guestfs-actions.pod:5025 ../fish/guestfish-actions.pod:3330
12183 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12184 "underlying device."
12188 #: ../src/guestfs-actions.pod:5028
12190 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
12191 "C<device> before calling this command. For unknown reasons C<resize2fs> "
12192 "sometimes gives an error about this and sometimes not. In any case, it is "
12193 "always safe to call C<guestfs_e2fsck_f> before calling this function."
12197 #: ../src/guestfs-actions.pod:5038
12198 msgid "guestfs_resize2fs_size"
12202 #: ../src/guestfs-actions.pod:5040
12206 " guestfs_resize2fs_size (guestfs_h *g,\n"
12207 " const char *device,\n"
12208 " int64_t size);\n"
12213 #: ../src/guestfs-actions.pod:5045
12215 "This command is the same as C<guestfs_resize2fs> except that it allows you "
12216 "to specify the new size (in bytes) explicitly."
12220 #: ../src/guestfs-actions.pod:5052
12225 #: ../src/guestfs-actions.pod:5054
12229 " guestfs_rm (guestfs_h *g,\n"
12230 " const char *path);\n"
12235 #: ../src/guestfs-actions.pod:5058 ../fish/guestfish-actions.pod:3350
12236 msgid "Remove the single file C<path>."
12240 #: ../src/guestfs-actions.pod:5064
12241 msgid "guestfs_rm_rf"
12245 #: ../src/guestfs-actions.pod:5066
12249 " guestfs_rm_rf (guestfs_h *g,\n"
12250 " const char *path);\n"
12255 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3356
12257 "Remove the file or directory C<path>, recursively removing the contents if "
12258 "its a directory. This is like the C<rm -rf> shell command."
12262 #: ../src/guestfs-actions.pod:5078
12263 msgid "guestfs_rmdir"
12267 #: ../src/guestfs-actions.pod:5080
12271 " guestfs_rmdir (guestfs_h *g,\n"
12272 " const char *path);\n"
12277 #: ../src/guestfs-actions.pod:5084 ../fish/guestfish-actions.pod:3364
12278 msgid "Remove the single directory C<path>."
12282 #: ../src/guestfs-actions.pod:5090
12283 msgid "guestfs_rmmountpoint"
12287 #: ../src/guestfs-actions.pod:5092
12291 " guestfs_rmmountpoint (guestfs_h *g,\n"
12292 " const char *exemptpath);\n"
12297 #: ../src/guestfs-actions.pod:5096
12299 "This calls removes a mountpoint that was previously created with "
12300 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
12304 #: ../src/guestfs-actions.pod:5104
12305 msgid "guestfs_scrub_device"
12309 #: ../src/guestfs-actions.pod:5106
12313 " guestfs_scrub_device (guestfs_h *g,\n"
12314 " const char *device);\n"
12319 #: ../src/guestfs-actions.pod:5110 ../fish/guestfish-actions.pod:3378
12321 "This command writes patterns over C<device> to make data retrieval more "
12326 #: ../src/guestfs-actions.pod:5113 ../src/guestfs-actions.pod:5134 ../src/guestfs-actions.pod:5153 ../fish/guestfish-actions.pod:3381 ../fish/guestfish-actions.pod:3396 ../fish/guestfish-actions.pod:3409
12328 "It is an interface to the L<scrub(1)> program. See that manual page for "
12333 #: ../src/guestfs-actions.pod:5121 ../src/guestfs-actions.pod:5139 ../src/guestfs-actions.pod:5158
12334 msgid "(Added in 1.0.52)"
12338 #: ../src/guestfs-actions.pod:5123
12339 msgid "guestfs_scrub_file"
12343 #: ../src/guestfs-actions.pod:5125
12347 " guestfs_scrub_file (guestfs_h *g,\n"
12348 " const char *file);\n"
12353 #: ../src/guestfs-actions.pod:5129 ../fish/guestfish-actions.pod:3391
12355 "This command writes patterns over a file to make data retrieval more "
12360 #: ../src/guestfs-actions.pod:5132 ../fish/guestfish-actions.pod:3394
12361 msgid "The file is I<removed> after scrubbing."
12365 #: ../src/guestfs-actions.pod:5141
12366 msgid "guestfs_scrub_freespace"
12370 #: ../src/guestfs-actions.pod:5143
12374 " guestfs_scrub_freespace (guestfs_h *g,\n"
12375 " const char *dir);\n"
12380 #: ../src/guestfs-actions.pod:5147
12382 "This command creates the directory C<dir> and then fills it with files until "
12383 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
12384 "and deletes them. The intention is to scrub any free space on the partition "
12385 "containing C<dir>."
12389 #: ../src/guestfs-actions.pod:5160
12390 msgid "guestfs_set_append"
12394 #: ../src/guestfs-actions.pod:5162
12398 " guestfs_set_append (guestfs_h *g,\n"
12399 " const char *append);\n"
12404 #: ../src/guestfs-actions.pod:5166 ../fish/guestfish-actions.pod:3418
12406 "This function is used to add additional options to the guest kernel command "
12411 #: ../src/guestfs-actions.pod:5169 ../fish/guestfish-actions.pod:3421
12413 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
12414 "environment variable."
12418 #: ../src/guestfs-actions.pod:5172 ../fish/guestfish-actions.pod:3424
12420 "Setting C<append> to C<NULL> means I<no> additional options are passed "
12421 "(libguestfs always adds a few of its own)."
12425 #: ../src/guestfs-actions.pod:5179
12426 msgid "guestfs_set_autosync"
12430 #: ../src/guestfs-actions.pod:5181
12434 " guestfs_set_autosync (guestfs_h *g,\n"
12435 " int autosync);\n"
12440 #: ../src/guestfs-actions.pod:5185
12442 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
12443 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
12444 "the handle is closed (also if the program exits without closing handles)."
12448 #: ../src/guestfs-actions.pod:5190 ../fish/guestfish-actions.pod:3438
12450 "This is enabled by default (since libguestfs 1.5.24, previously it was "
12451 "disabled by default)."
12455 #: ../src/guestfs-actions.pod:5197
12456 msgid "guestfs_set_direct"
12460 #: ../src/guestfs-actions.pod:5199
12464 " guestfs_set_direct (guestfs_h *g,\n"
12470 #: ../src/guestfs-actions.pod:5203 ../fish/guestfish-actions.pod:3447
12472 "If the direct appliance mode flag is enabled, then stdin and stdout are "
12473 "passed directly through to the appliance once it is launched."
12477 #: ../src/guestfs-actions.pod:5207
12479 "One consequence of this is that log messages aren't caught by the library "
12480 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
12485 #: ../src/guestfs-actions.pod:5211 ../fish/guestfish-actions.pod:3455
12486 msgid "You probably don't want to use this unless you know what you are doing."
12490 #: ../src/guestfs-actions.pod:5214 ../fish/guestfish-actions.pod:3458
12491 msgid "The default is disabled."
12495 #: ../src/guestfs-actions.pod:5220
12496 msgid "guestfs_set_e2label"
12500 #: ../src/guestfs-actions.pod:5222
12504 " guestfs_set_e2label (guestfs_h *g,\n"
12505 " const char *device,\n"
12506 " const char *label);\n"
12511 #: ../src/guestfs-actions.pod:5227 ../fish/guestfish-actions.pod:3464
12513 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
12514 "C<label>. Filesystem labels are limited to 16 characters."
12518 #: ../src/guestfs-actions.pod:5231
12520 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
12521 "the existing label on a filesystem."
12525 #: ../src/guestfs-actions.pod:5238
12526 msgid "guestfs_set_e2uuid"
12530 #: ../src/guestfs-actions.pod:5240
12534 " guestfs_set_e2uuid (guestfs_h *g,\n"
12535 " const char *device,\n"
12536 " const char *uuid);\n"
12541 #: ../src/guestfs-actions.pod:5245 ../fish/guestfish-actions.pod:3475
12543 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
12544 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
12545 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
12549 #: ../src/guestfs-actions.pod:5250
12551 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
12552 "the existing UUID of a filesystem."
12556 #: ../src/guestfs-actions.pod:5257
12557 msgid "guestfs_set_memsize"
12561 #: ../src/guestfs-actions.pod:5259
12565 " guestfs_set_memsize (guestfs_h *g,\n"
12571 #: ../src/guestfs-actions.pod:5263
12573 "This sets the memory size in megabytes allocated to the qemu subprocess. "
12574 "This only has any effect if called before C<guestfs_launch>."
12578 #: ../src/guestfs-actions.pod:5267 ../fish/guestfish-actions.pod:3493
12580 "You can also change this by setting the environment variable "
12581 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
12585 #: ../src/guestfs-actions.pod:5278
12586 msgid "guestfs_set_network"
12590 #: ../src/guestfs-actions.pod:5280
12594 " guestfs_set_network (guestfs_h *g,\n"
12600 #: ../src/guestfs-actions.pod:5284 ../fish/guestfish-actions.pod:3506
12602 "If C<network> is true, then the network is enabled in the libguestfs "
12603 "appliance. The default is false."
12607 #: ../src/guestfs-actions.pod:5287 ../fish/guestfish-actions.pod:3509
12609 "This affects whether commands are able to access the network (see "
12610 "L<guestfs(3)/RUNNING COMMANDS>)."
12614 #: ../src/guestfs-actions.pod:5290
12616 "You must call this before calling C<guestfs_launch>, otherwise it has no "
12621 #: ../src/guestfs-actions.pod:5297
12622 msgid "guestfs_set_path"
12626 #: ../src/guestfs-actions.pod:5299
12630 " guestfs_set_path (guestfs_h *g,\n"
12631 " const char *searchpath);\n"
12636 #: ../src/guestfs-actions.pod:5303 ../fish/guestfish-actions.pod:3521
12637 msgid "Set the path that libguestfs searches for kernel and initrd.img."
12641 #: ../src/guestfs-actions.pod:5305 ../fish/guestfish-actions.pod:3523
12643 "The default is C<$libdir/guestfs> unless overridden by setting "
12644 "C<LIBGUESTFS_PATH> environment variable."
12648 #: ../src/guestfs-actions.pod:5308 ../fish/guestfish-actions.pod:3526
12649 msgid "Setting C<path> to C<NULL> restores the default path."
12653 #: ../src/guestfs-actions.pod:5314
12654 msgid "guestfs_set_qemu"
12658 #: ../src/guestfs-actions.pod:5316
12662 " guestfs_set_qemu (guestfs_h *g,\n"
12663 " const char *qemu);\n"
12668 #: ../src/guestfs-actions.pod:5320 ../fish/guestfish-actions.pod:3534
12669 msgid "Set the qemu binary that we will use."
12673 #: ../src/guestfs-actions.pod:5322 ../fish/guestfish-actions.pod:3536
12674 msgid "The default is chosen when the library was compiled by the configure script."
12678 #: ../src/guestfs-actions.pod:5325 ../fish/guestfish-actions.pod:3539
12680 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
12685 #: ../src/guestfs-actions.pod:5328 ../fish/guestfish-actions.pod:3542
12686 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
12690 #: ../src/guestfs-actions.pod:5330 ../fish/guestfish-actions.pod:3544
12692 "Note that you should call this function as early as possible after creating "
12693 "the handle. This is because some pre-launch operations depend on testing "
12694 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
12695 "don't retest features, and so you might see inconsistent results. Using the "
12696 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
12697 "the qemu binary at the same time as the handle is created."
12701 #: ../src/guestfs-actions.pod:5342
12702 msgid "guestfs_set_recovery_proc"
12706 #: ../src/guestfs-actions.pod:5344
12710 " guestfs_set_recovery_proc (guestfs_h *g,\n"
12711 " int recoveryproc);\n"
12716 #: ../src/guestfs-actions.pod:5348
12718 "If this is called with the parameter C<false> then C<guestfs_launch> does "
12719 "not create a recovery process. The purpose of the recovery process is to "
12720 "stop runaway qemu processes in the case where the main program aborts "
12725 #: ../src/guestfs-actions.pod:5353
12727 "This only has any effect if called before C<guestfs_launch>, and the default "
12732 #: ../src/guestfs-actions.pod:5356 ../fish/guestfish-actions.pod:3566
12734 "About the only time when you would want to disable this is if the main "
12735 "process will fork itself into the background (\"daemonize\" itself). In "
12736 "this case the recovery process thinks that the main program has disappeared "
12737 "and so kills qemu, which is not very helpful."
12741 #: ../src/guestfs-actions.pod:5366
12742 msgid "guestfs_set_selinux"
12746 #: ../src/guestfs-actions.pod:5368
12750 " guestfs_set_selinux (guestfs_h *g,\n"
12756 #: ../src/guestfs-actions.pod:5372 ../fish/guestfish-actions.pod:3578
12758 "This sets the selinux flag that is passed to the appliance at boot time. "
12759 "The default is C<selinux=0> (disabled)."
12763 #: ../src/guestfs-actions.pod:5375 ../fish/guestfish-actions.pod:3581
12765 "Note that if SELinux is enabled, it is always in Permissive mode "
12766 "(C<enforcing=0>)."
12770 #: ../src/guestfs-actions.pod:5385
12771 msgid "guestfs_set_trace"
12775 #: ../src/guestfs-actions.pod:5387
12779 " guestfs_set_trace (guestfs_h *g,\n"
12785 #: ../src/guestfs-actions.pod:5391 ../fish/guestfish-actions.pod:3593
12787 "If the command trace flag is set to 1, then commands are printed on stderr "
12788 "before they are executed in a format which is very similar to the one used "
12789 "by guestfish. In other words, you can run a program with this enabled, and "
12790 "you will get out a script which you can feed to guestfish to perform the "
12791 "same set of actions."
12795 #: ../src/guestfs-actions.pod:5398 ../fish/guestfish-actions.pod:3600
12797 "If you want to trace C API calls into libguestfs (and other libraries) then "
12798 "possibly a better way is to use the external ltrace(1) command."
12802 #: ../src/guestfs-actions.pod:5402 ../fish/guestfish-actions.pod:3604
12804 "Command traces are disabled unless the environment variable "
12805 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
12809 #: ../src/guestfs-actions.pod:5409
12810 msgid "guestfs_set_verbose"
12814 #: ../src/guestfs-actions.pod:5411
12818 " guestfs_set_verbose (guestfs_h *g,\n"
12824 #: ../src/guestfs-actions.pod:5415 ../fish/guestfish-actions.pod:3613
12825 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
12829 #: ../src/guestfs-actions.pod:5417 ../fish/guestfish-actions.pod:3615
12831 "Verbose messages are disabled unless the environment variable "
12832 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
12836 #: ../src/guestfs-actions.pod:5424
12837 msgid "guestfs_setcon"
12841 #: ../src/guestfs-actions.pod:5426
12845 " guestfs_setcon (guestfs_h *g,\n"
12846 " const char *context);\n"
12851 #: ../src/guestfs-actions.pod:5430 ../fish/guestfish-actions.pod:3622
12853 "This sets the SELinux security context of the daemon to the string "
12858 #: ../src/guestfs-actions.pod:5433 ../fish/guestfish-actions.pod:3625
12859 msgid "See the documentation about SELINUX in L<guestfs(3)>."
12863 #: ../src/guestfs-actions.pod:5439
12864 msgid "guestfs_setxattr"
12868 #: ../src/guestfs-actions.pod:5441
12872 " guestfs_setxattr (guestfs_h *g,\n"
12873 " const char *xattr,\n"
12874 " const char *val,\n"
12876 " const char *path);\n"
12881 #: ../src/guestfs-actions.pod:5448 ../fish/guestfish-actions.pod:3631
12883 "This call sets the extended attribute named C<xattr> of the file C<path> to "
12884 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
12888 #: ../src/guestfs-actions.pod:5452
12889 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
12893 #: ../src/guestfs-actions.pod:5458
12894 msgid "guestfs_sfdisk"
12898 #: ../src/guestfs-actions.pod:5460
12902 " guestfs_sfdisk (guestfs_h *g,\n"
12903 " const char *device,\n"
12907 " char *const *lines);\n"
12912 #: ../src/guestfs-actions.pod:5468 ../fish/guestfish-actions.pod:3641
12914 "This is a direct interface to the L<sfdisk(8)> program for creating "
12915 "partitions on block devices."
12919 #: ../src/guestfs-actions.pod:5471 ../fish/guestfish-actions.pod:3644
12920 msgid "C<device> should be a block device, for example C</dev/sda>."
12924 #: ../src/guestfs-actions.pod:5473 ../fish/guestfish-actions.pod:3646
12926 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
12927 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
12928 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
12929 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
12930 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
12931 "the kernel) cannot work out the right geometry and you will need to tell it."
12935 #: ../src/guestfs-actions.pod:5481 ../fish/guestfish-actions.pod:3654
12937 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
12938 "refer to the L<sfdisk(8)> manpage."
12942 #: ../src/guestfs-actions.pod:5484 ../fish/guestfish-actions.pod:3657
12944 "To create a single partition occupying the whole disk, you would pass "
12945 "C<lines> as a single element list, when the single element being the string "
12950 #: ../src/guestfs-actions.pod:5488
12951 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
12955 #: ../src/guestfs-actions.pod:5498
12956 msgid "guestfs_sfdiskM"
12960 #: ../src/guestfs-actions.pod:5500
12964 " guestfs_sfdiskM (guestfs_h *g,\n"
12965 " const char *device,\n"
12966 " char *const *lines);\n"
12971 #: ../src/guestfs-actions.pod:5505
12973 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
12974 "partition sizes are specified in megabytes only (rounded to the nearest "
12975 "cylinder) and you don't need to specify the cyls, heads and sectors "
12976 "parameters which were rarely if ever used anyway."
12980 #: ../src/guestfs-actions.pod:5511
12982 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
12983 "C<guestfs_part_disk>"
12987 #: ../src/guestfs-actions.pod:5521
12988 msgid "guestfs_sfdisk_N"
12992 #: ../src/guestfs-actions.pod:5523
12996 " guestfs_sfdisk_N (guestfs_h *g,\n"
12997 " const char *device,\n"
13002 " const char *line);\n"
13007 #: ../src/guestfs-actions.pod:5532 ../fish/guestfish-actions.pod:3687
13009 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13010 "(note: C<n> counts from 1)."
13014 #: ../src/guestfs-actions.pod:5535
13016 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
13017 "for the cyls/heads/sectors parameters."
13021 #: ../src/guestfs-actions.pod:5538
13022 msgid "See also: C<guestfs_part_add>"
13026 #: ../src/guestfs-actions.pod:5547
13027 msgid "guestfs_sfdisk_disk_geometry"
13031 #: ../src/guestfs-actions.pod:5549
13035 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
13036 " const char *device);\n"
13041 #: ../src/guestfs-actions.pod:5553
13043 "This displays the disk geometry of C<device> read from the partition table. "
13044 "Especially in the case where the underlying block device has been resized, "
13045 "this can be different from the kernel's idea of the geometry (see "
13046 "C<guestfs_sfdisk_kernel_geometry>)."
13050 #: ../src/guestfs-actions.pod:5558 ../src/guestfs-actions.pod:5574 ../fish/guestfish-actions.pod:3707 ../fish/guestfish-actions.pod:3716
13051 msgid "The result is in human-readable format, and not designed to be parsed."
13055 #: ../src/guestfs-actions.pod:5566
13056 msgid "guestfs_sfdisk_kernel_geometry"
13060 #: ../src/guestfs-actions.pod:5568
13064 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
13065 " const char *device);\n"
13070 #: ../src/guestfs-actions.pod:5572 ../fish/guestfish-actions.pod:3714
13071 msgid "This displays the kernel's idea of the geometry of C<device>."
13075 #: ../src/guestfs-actions.pod:5582
13076 msgid "guestfs_sfdisk_l"
13080 #: ../src/guestfs-actions.pod:5584
13084 " guestfs_sfdisk_l (guestfs_h *g,\n"
13085 " const char *device);\n"
13090 #: ../src/guestfs-actions.pod:5588 ../fish/guestfish-actions.pod:3723
13092 "This displays the partition table on C<device>, in the human-readable output "
13093 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13097 #: ../src/guestfs-actions.pod:5592
13098 msgid "See also: C<guestfs_part_list>"
13102 #: ../src/guestfs-actions.pod:5599
13107 #: ../src/guestfs-actions.pod:5601
13111 " guestfs_sh (guestfs_h *g,\n"
13112 " const char *command);\n"
13117 #: ../src/guestfs-actions.pod:5605 ../fish/guestfish-actions.pod:3733
13119 "This call runs a command from the guest filesystem via the guest's "
13124 #: ../src/guestfs-actions.pod:5608
13125 msgid "This is like C<guestfs_command>, but passes the command to:"
13129 #: ../src/guestfs-actions.pod:5610 ../fish/guestfish-actions.pod:3738
13132 " /bin/sh -c \"command\"\n"
13137 #: ../src/guestfs-actions.pod:5612 ../fish/guestfish-actions.pod:3740
13139 "Depending on the guest's shell, this usually results in wildcards being "
13140 "expanded, shell expressions being interpolated and so on."
13144 #: ../src/guestfs-actions.pod:5616
13145 msgid "All the provisos about C<guestfs_command> apply to this call."
13149 #: ../src/guestfs-actions.pod:5623
13150 msgid "guestfs_sh_lines"
13154 #: ../src/guestfs-actions.pod:5625
13158 " guestfs_sh_lines (guestfs_h *g,\n"
13159 " const char *command);\n"
13164 #: ../src/guestfs-actions.pod:5629
13166 "This is the same as C<guestfs_sh>, but splits the result into a list of "
13171 #: ../src/guestfs-actions.pod:5632
13172 msgid "See also: C<guestfs_command_lines>"
13176 #: ../src/guestfs-actions.pod:5640
13177 msgid "guestfs_sleep"
13181 #: ../src/guestfs-actions.pod:5642
13185 " guestfs_sleep (guestfs_h *g,\n"
13191 #: ../src/guestfs-actions.pod:5646 ../fish/guestfish-actions.pod:3759
13192 msgid "Sleep for C<secs> seconds."
13196 #: ../src/guestfs-actions.pod:5650
13197 msgid "(Added in 1.0.41)"
13201 #: ../src/guestfs-actions.pod:5652 ../src/guestfs-structs.pod:109
13202 msgid "guestfs_stat"
13206 #: ../src/guestfs-actions.pod:5654
13209 " struct guestfs_stat *\n"
13210 " guestfs_stat (guestfs_h *g,\n"
13211 " const char *path);\n"
13216 #: ../src/guestfs-actions.pod:5660 ../fish/guestfish-actions.pod:3767
13217 msgid "This is the same as the C<stat(2)> system call."
13221 #: ../src/guestfs-actions.pod:5668 ../src/guestfs-structs.pod:135
13222 msgid "guestfs_statvfs"
13226 #: ../src/guestfs-actions.pod:5670
13229 " struct guestfs_statvfs *\n"
13230 " guestfs_statvfs (guestfs_h *g,\n"
13231 " const char *path);\n"
13236 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3773
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:5678 ../fish/guestfish-actions.pod:3777
13245 msgid "This is the same as the C<statvfs(2)> system call."
13249 #: ../src/guestfs-actions.pod:5680
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:5686
13257 msgid "guestfs_strings"
13261 #: ../src/guestfs-actions.pod:5688
13265 " guestfs_strings (guestfs_h *g,\n"
13266 " const char *path);\n"
13271 #: ../src/guestfs-actions.pod:5692 ../fish/guestfish-actions.pod:3783
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:5704
13279 msgid "guestfs_strings_e"
13283 #: ../src/guestfs-actions.pod:5706
13287 " guestfs_strings_e (guestfs_h *g,\n"
13288 " const char *encoding,\n"
13289 " const char *path);\n"
13294 #: ../src/guestfs-actions.pod:5711
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:5715 ../fish/guestfish-actions.pod:3797
13302 msgid "Allowed encodings are:"
13306 #: ../src/guestfs-actions.pod:5719 ../fish/guestfish-actions.pod:3801
13311 #: ../src/guestfs-actions.pod:5721
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:5724 ../fish/guestfish-actions.pod:3806
13323 #: ../src/guestfs-actions.pod:5726 ../fish/guestfish-actions.pod:3808
13324 msgid "Single 8-bit-byte characters."
13328 #: ../src/guestfs-actions.pod:5728 ../fish/guestfish-actions.pod:3810
13333 #: ../src/guestfs-actions.pod:5730 ../fish/guestfish-actions.pod:3812
13334 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13338 #: ../src/guestfs-actions.pod:5733 ../fish/guestfish-actions.pod:3815
13339 msgid "l (lower case letter L)"
13343 #: ../src/guestfs-actions.pod:5735 ../fish/guestfish-actions.pod:3817
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:5738 ../fish/guestfish-actions.pod:3820
13355 #: ../src/guestfs-actions.pod:5740 ../fish/guestfish-actions.pod:3822
13356 msgid "32-bit big endian such as UCS-4BE."
13360 #: ../src/guestfs-actions.pod:5742 ../fish/guestfish-actions.pod:3824
13365 #: ../src/guestfs-actions.pod:5744 ../fish/guestfish-actions.pod:3826
13366 msgid "32-bit little endian such as UCS-4LE."
13370 #: ../src/guestfs-actions.pod:5748 ../fish/guestfish-actions.pod:3830
13371 msgid "The returned strings are transcoded to UTF-8."
13375 #: ../src/guestfs-actions.pod:5759
13376 msgid "guestfs_swapoff_device"
13380 #: ../src/guestfs-actions.pod:5761
13384 " guestfs_swapoff_device (guestfs_h *g,\n"
13385 " const char *device);\n"
13390 #: ../src/guestfs-actions.pod:5765
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:5773
13398 msgid "guestfs_swapoff_file"
13402 #: ../src/guestfs-actions.pod:5775
13406 " guestfs_swapoff_file (guestfs_h *g,\n"
13407 " const char *file);\n"
13412 #: ../src/guestfs-actions.pod:5779 ../fish/guestfish-actions.pod:3847
13413 msgid "This command disables the libguestfs appliance swap on file."
13417 #: ../src/guestfs-actions.pod:5785
13418 msgid "guestfs_swapoff_label"
13422 #: ../src/guestfs-actions.pod:5787
13426 " guestfs_swapoff_label (guestfs_h *g,\n"
13427 " const char *label);\n"
13432 #: ../src/guestfs-actions.pod:5791 ../fish/guestfish-actions.pod:3853
13434 "This command disables the libguestfs appliance swap on labeled swap "
13439 #: ../src/guestfs-actions.pod:5798
13440 msgid "guestfs_swapoff_uuid"
13444 #: ../src/guestfs-actions.pod:5800
13448 " guestfs_swapoff_uuid (guestfs_h *g,\n"
13449 " const char *uuid);\n"
13454 #: ../src/guestfs-actions.pod:5804 ../fish/guestfish-actions.pod:3860
13456 "This command disables the libguestfs appliance swap partition with the given "
13461 #: ../src/guestfs-actions.pod:5811
13462 msgid "guestfs_swapon_device"
13466 #: ../src/guestfs-actions.pod:5813
13470 " guestfs_swapon_device (guestfs_h *g,\n"
13471 " const char *device);\n"
13476 #: ../src/guestfs-actions.pod:5817
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:5822 ../fish/guestfish-actions.pod:3872
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:5833
13495 msgid "guestfs_swapon_file"
13499 #: ../src/guestfs-actions.pod:5835
13503 " guestfs_swapon_file (guestfs_h *g,\n"
13504 " const char *file);\n"
13509 #: ../src/guestfs-actions.pod:5839
13511 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
13516 #: ../src/guestfs-actions.pod:5846
13517 msgid "guestfs_swapon_label"
13521 #: ../src/guestfs-actions.pod:5848
13525 " guestfs_swapon_label (guestfs_h *g,\n"
13526 " const char *label);\n"
13531 #: ../src/guestfs-actions.pod:5852
13533 "This command enables swap to a labeled swap partition. See "
13534 "C<guestfs_swapon_device> for other notes."
13538 #: ../src/guestfs-actions.pod:5859
13539 msgid "guestfs_swapon_uuid"
13543 #: ../src/guestfs-actions.pod:5861
13547 " guestfs_swapon_uuid (guestfs_h *g,\n"
13548 " const char *uuid);\n"
13553 #: ../src/guestfs-actions.pod:5865
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:5872
13561 msgid "guestfs_sync"
13565 #: ../src/guestfs-actions.pod:5874
13569 " guestfs_sync (guestfs_h *g);\n"
13574 #: ../src/guestfs-actions.pod:5877 ../fish/guestfish-actions.pod:3904
13576 "This syncs the disk, so that any writes are flushed through to the "
13577 "underlying disk image."
13581 #: ../src/guestfs-actions.pod:5880 ../fish/guestfish-actions.pod:3907
13583 "You should always call this if you have modified a disk image, before "
13584 "closing the handle."
13588 #: ../src/guestfs-actions.pod:5887
13589 msgid "guestfs_tail"
13593 #: ../src/guestfs-actions.pod:5889
13597 " guestfs_tail (guestfs_h *g,\n"
13598 " const char *path);\n"
13603 #: ../src/guestfs-actions.pod:5893 ../fish/guestfish-actions.pod:3914
13604 msgid "This command returns up to the last 10 lines of a file as a list of strings."
13608 #: ../src/guestfs-actions.pod:5905
13609 msgid "guestfs_tail_n"
13613 #: ../src/guestfs-actions.pod:5907
13617 " guestfs_tail_n (guestfs_h *g,\n"
13619 " const char *path);\n"
13624 #: ../src/guestfs-actions.pod:5912 ../fish/guestfish-actions.pod:3924
13626 "If the parameter C<nrlines> is a positive number, this returns the last "
13627 "C<nrlines> lines of the file C<path>."
13631 #: ../src/guestfs-actions.pod:5915 ../fish/guestfish-actions.pod:3927
13633 "If the parameter C<nrlines> is a negative number, this returns lines from "
13634 "the file C<path>, starting with the C<-nrlines>th line."
13638 #: ../src/guestfs-actions.pod:5929
13639 msgid "guestfs_tar_in"
13643 #: ../src/guestfs-actions.pod:5931
13647 " guestfs_tar_in (guestfs_h *g,\n"
13648 " const char *tarfile,\n"
13649 " const char *directory);\n"
13654 #: ../src/guestfs-actions.pod:5936 ../fish/guestfish-actions.pod:3939
13656 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
13657 "tar file) into C<directory>."
13661 #: ../src/guestfs-actions.pod:5939
13662 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
13666 #: ../src/guestfs-actions.pod:5944 ../src/guestfs-actions.pod:5961 ../src/guestfs-actions.pod:5977 ../src/guestfs-actions.pod:5993
13667 msgid "(Added in 1.0.3)"
13671 #: ../src/guestfs-actions.pod:5946
13672 msgid "guestfs_tar_out"
13676 #: ../src/guestfs-actions.pod:5948
13680 " guestfs_tar_out (guestfs_h *g,\n"
13681 " const char *directory,\n"
13682 " const char *tarfile);\n"
13687 #: ../src/guestfs-actions.pod:5953 ../fish/guestfish-actions.pod:3951
13689 "This command packs the contents of C<directory> and downloads it to local "
13694 #: ../src/guestfs-actions.pod:5956
13696 "To download a compressed tarball, use C<guestfs_tgz_out> or "
13697 "C<guestfs_txz_out>."
13701 #: ../src/guestfs-actions.pod:5963
13702 msgid "guestfs_tgz_in"
13706 #: ../src/guestfs-actions.pod:5965
13710 " guestfs_tgz_in (guestfs_h *g,\n"
13711 " const char *tarball,\n"
13712 " const char *directory);\n"
13717 #: ../src/guestfs-actions.pod:5970 ../fish/guestfish-actions.pod:3963
13719 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
13720 "tar file) into C<directory>."
13724 #: ../src/guestfs-actions.pod:5973
13725 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
13729 #: ../src/guestfs-actions.pod:5979
13730 msgid "guestfs_tgz_out"
13734 #: ../src/guestfs-actions.pod:5981
13738 " guestfs_tgz_out (guestfs_h *g,\n"
13739 " const char *directory,\n"
13740 " const char *tarball);\n"
13745 #: ../src/guestfs-actions.pod:5986 ../fish/guestfish-actions.pod:3974
13747 "This command packs the contents of C<directory> and downloads it to local "
13752 #: ../src/guestfs-actions.pod:5989
13753 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
13757 #: ../src/guestfs-actions.pod:5995
13758 msgid "guestfs_touch"
13762 #: ../src/guestfs-actions.pod:5997
13766 " guestfs_touch (guestfs_h *g,\n"
13767 " const char *path);\n"
13772 #: ../src/guestfs-actions.pod:6001 ../fish/guestfish-actions.pod:3985
13774 "Touch acts like the L<touch(1)> command. It can be used to update the "
13775 "timestamps on a file, or, if the file does not exist, to create a new "
13776 "zero-length file."
13780 #: ../src/guestfs-actions.pod:6005 ../fish/guestfish-actions.pod:3989
13782 "This command only works on regular files, and will fail on other file types "
13783 "such as directories, symbolic links, block special etc."
13787 #: ../src/guestfs-actions.pod:6012
13788 msgid "guestfs_truncate"
13792 #: ../src/guestfs-actions.pod:6014
13796 " guestfs_truncate (guestfs_h *g,\n"
13797 " const char *path);\n"
13802 #: ../src/guestfs-actions.pod:6018 ../fish/guestfish-actions.pod:3996
13804 "This command truncates C<path> to a zero-length file. The file must exist "
13809 #: ../src/guestfs-actions.pod:6025
13810 msgid "guestfs_truncate_size"
13814 #: ../src/guestfs-actions.pod:6027
13818 " guestfs_truncate_size (guestfs_h *g,\n"
13819 " const char *path,\n"
13820 " int64_t size);\n"
13825 #: ../src/guestfs-actions.pod:6032 ../fish/guestfish-actions.pod:4003
13827 "This command truncates C<path> to size C<size> bytes. The file must exist "
13832 #: ../src/guestfs-actions.pod:6035
13834 "If the current file size is less than C<size> then the file is extended to "
13835 "the required size with zero bytes. This creates a sparse file (ie. disk "
13836 "blocks are not allocated for the file until you write to it). To create a "
13837 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
13841 #: ../src/guestfs-actions.pod:6045
13842 msgid "guestfs_tune2fs_l"
13846 #: ../src/guestfs-actions.pod:6047
13850 " guestfs_tune2fs_l (guestfs_h *g,\n"
13851 " const char *device);\n"
13856 #: ../src/guestfs-actions.pod:6051 ../fish/guestfish-actions.pod:4016
13858 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
13863 #: ../src/guestfs-actions.pod:6054 ../fish/guestfish-actions.pod:4019
13865 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
13866 "for more details. The list of fields returned isn't clearly defined, and "
13867 "depends on both the version of C<tune2fs> that libguestfs was built against, "
13868 "and the filesystem itself."
13872 #: ../src/guestfs-actions.pod:6067
13873 msgid "guestfs_txz_in"
13877 #: ../src/guestfs-actions.pod:6069
13881 " guestfs_txz_in (guestfs_h *g,\n"
13882 " const char *tarball,\n"
13883 " const char *directory);\n"
13888 #: ../src/guestfs-actions.pod:6074 ../fish/guestfish-actions.pod:4028
13890 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
13891 "tar file) into C<directory>."
13895 #: ../src/guestfs-actions.pod:6081
13896 msgid "guestfs_txz_out"
13900 #: ../src/guestfs-actions.pod:6083
13904 " guestfs_txz_out (guestfs_h *g,\n"
13905 " const char *directory,\n"
13906 " const char *tarball);\n"
13911 #: ../src/guestfs-actions.pod:6088 ../fish/guestfish-actions.pod:4037
13913 "This command packs the contents of C<directory> and downloads it to local "
13914 "file C<tarball> (as an xz compressed tar archive)."
13918 #: ../src/guestfs-actions.pod:6095
13919 msgid "guestfs_umask"
13923 #: ../src/guestfs-actions.pod:6097
13927 " guestfs_umask (guestfs_h *g,\n"
13933 #: ../src/guestfs-actions.pod:6101 ../fish/guestfish-actions.pod:4046
13935 "This function sets the mask used for creating new files and device nodes to "
13940 #: ../src/guestfs-actions.pod:6104 ../fish/guestfish-actions.pod:4049
13942 "Typical umask values would be C<022> which creates new files with "
13943 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
13944 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
13948 #: ../src/guestfs-actions.pod:6109 ../fish/guestfish-actions.pod:4054
13950 "The default umask is C<022>. This is important because it means that "
13951 "directories and device nodes will be created with C<0644> or C<0755> mode "
13952 "even if you specify C<0777>."
13956 #: ../src/guestfs-actions.pod:6113
13958 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
13959 "C<guestfs_mkdir>."
13963 #: ../src/guestfs-actions.pod:6116 ../fish/guestfish-actions.pod:4061
13964 msgid "This call returns the previous umask."
13968 #: ../src/guestfs-actions.pod:6122
13969 msgid "guestfs_umount"
13973 #: ../src/guestfs-actions.pod:6124
13977 " guestfs_umount (guestfs_h *g,\n"
13978 " const char *pathordevice);\n"
13983 #: ../src/guestfs-actions.pod:6128 ../fish/guestfish-actions.pod:4069
13985 "This unmounts the given filesystem. The filesystem may be specified either "
13986 "by its mountpoint (path) or the device which contains the filesystem."
13990 #: ../src/guestfs-actions.pod:6136
13991 msgid "guestfs_umount_all"
13995 #: ../src/guestfs-actions.pod:6138
13999 " guestfs_umount_all (guestfs_h *g);\n"
14004 #: ../src/guestfs-actions.pod:6141 ../fish/guestfish-actions.pod:4079
14005 msgid "This unmounts all mounted filesystems."
14009 #: ../src/guestfs-actions.pod:6143 ../fish/guestfish-actions.pod:4081
14010 msgid "Some internal mounts are not unmounted by this call."
14014 #: ../src/guestfs-actions.pod:6149
14015 msgid "guestfs_upload"
14019 #: ../src/guestfs-actions.pod:6151
14023 " guestfs_upload (guestfs_h *g,\n"
14024 " const char *filename,\n"
14025 " const char *remotefilename);\n"
14030 #: ../src/guestfs-actions.pod:6156 ../src/guestfs-actions.pod:6175 ../fish/guestfish-actions.pod:4087 ../fish/guestfish-actions.pod:4100
14031 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14035 #: ../src/guestfs-actions.pod:6161
14036 msgid "See also C<guestfs_download>."
14040 #: ../src/guestfs-actions.pod:6167
14041 msgid "guestfs_upload_offset"
14045 #: ../src/guestfs-actions.pod:6169
14049 " guestfs_upload_offset (guestfs_h *g,\n"
14050 " const char *filename,\n"
14051 " const char *remotefilename,\n"
14052 " int64_t offset);\n"
14057 #: ../src/guestfs-actions.pod:6178 ../fish/guestfish-actions.pod:4103
14059 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14060 "The intention is to overwrite parts of existing files or devices, although "
14061 "if a non-existant file is specified then it is created with a \"hole\" "
14062 "before C<offset>. The size of the data written is implicit in the size of "
14063 "the source C<filename>."
14067 #: ../src/guestfs-actions.pod:6185
14069 "Note that there is no limit on the amount of data that can be uploaded with "
14070 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
14071 "full amount unless an error occurs."
14075 #: ../src/guestfs-actions.pod:6190
14076 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
14080 #: ../src/guestfs-actions.pod:6196
14081 msgid "guestfs_utimens"
14085 #: ../src/guestfs-actions.pod:6198
14089 " guestfs_utimens (guestfs_h *g,\n"
14090 " const char *path,\n"
14091 " int64_t atsecs,\n"
14092 " int64_t atnsecs,\n"
14093 " int64_t mtsecs,\n"
14094 " int64_t mtnsecs);\n"
14099 #: ../src/guestfs-actions.pod:6206 ../fish/guestfish-actions.pod:4123
14100 msgid "This command sets the timestamps of a file with nanosecond precision."
14104 #: ../src/guestfs-actions.pod:6209 ../fish/guestfish-actions.pod:4126
14106 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14111 #: ../src/guestfs-actions.pod:6212 ../fish/guestfish-actions.pod:4129
14113 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14114 "nanoseconds from the epoch."
14118 #: ../src/guestfs-actions.pod:6215 ../fish/guestfish-actions.pod:4132
14120 "If the C<*nsecs> field contains the special value C<-1> then the "
14121 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14122 "ignored in this case)."
14126 #: ../src/guestfs-actions.pod:6219 ../fish/guestfish-actions.pod:4136
14128 "If the C<*nsecs> field contains the special value C<-2> then the "
14129 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14134 #: ../src/guestfs-actions.pod:6227 ../src/guestfs-structs.pod:175
14135 msgid "guestfs_version"
14139 #: ../src/guestfs-actions.pod:6229
14142 " struct guestfs_version *\n"
14143 " guestfs_version (guestfs_h *g);\n"
14148 #: ../src/guestfs-actions.pod:6232 ../fish/guestfish-actions.pod:4144
14149 msgid "Return the libguestfs version number that the program is linked against."
14153 #: ../src/guestfs-actions.pod:6235 ../fish/guestfish-actions.pod:4147
14155 "Note that because of dynamic linking this is not necessarily the version of "
14156 "libguestfs that you compiled against. You can compile the program, and then "
14157 "at runtime dynamically link against a completely different C<libguestfs.so> "
14162 #: ../src/guestfs-actions.pod:6240 ../fish/guestfish-actions.pod:4152
14164 "This call was added in version C<1.0.58>. In previous versions of "
14165 "libguestfs there was no way to get the version number. From C code you can "
14166 "use dynamic linker functions to find out if this symbol exists (if it "
14167 "doesn't, then it's an earlier version)."
14171 #: ../src/guestfs-actions.pod:6246 ../fish/guestfish-actions.pod:4158
14173 "The call returns a structure with four elements. The first three (C<major>, "
14174 "C<minor> and C<release>) are numbers and correspond to the usual version "
14175 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14176 "but may be used for distro-specific information."
14180 #: ../src/guestfs-actions.pod:6252 ../fish/guestfish-actions.pod:4164
14181 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
14185 #: ../src/guestfs-actions.pod:6255 ../fish/guestfish-actions.pod:4167
14186 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14190 #: ../src/guestfs-actions.pod:6257
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:6263
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:6267
14207 msgid "(Added in 1.0.58)"
14211 #: ../src/guestfs-actions.pod:6269
14212 msgid "guestfs_vfs_label"
14216 #: ../src/guestfs-actions.pod:6271
14220 " guestfs_vfs_label (guestfs_h *g,\n"
14221 " const char *device);\n"
14226 #: ../src/guestfs-actions.pod:6275 ../fish/guestfish-actions.pod:4179
14227 msgid "This returns the filesystem label of the filesystem on C<device>."
14231 #: ../src/guestfs-actions.pod:6278 ../fish/guestfish-actions.pod:4182
14232 msgid "If the filesystem is unlabeled, this returns the empty string."
14236 #: ../src/guestfs-actions.pod:6280
14237 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
14241 #: ../src/guestfs-actions.pod:6285 ../src/guestfs-actions.pod:6322
14242 msgid "(Added in 1.3.18)"
14246 #: ../src/guestfs-actions.pod:6287
14247 msgid "guestfs_vfs_type"
14251 #: ../src/guestfs-actions.pod:6289
14255 " guestfs_vfs_type (guestfs_h *g,\n"
14256 " const char *device);\n"
14261 #: ../src/guestfs-actions.pod:6293 ../fish/guestfish-actions.pod:4190
14263 "This command gets the filesystem type corresponding to the filesystem on "
14268 #: ../src/guestfs-actions.pod:6296 ../fish/guestfish-actions.pod:4193
14270 "For most filesystems, the result is the name of the Linux VFS module which "
14271 "would be used to mount this filesystem if you mounted it without specifying "
14272 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14276 #: ../src/guestfs-actions.pod:6306
14277 msgid "guestfs_vfs_uuid"
14281 #: ../src/guestfs-actions.pod:6308
14285 " guestfs_vfs_uuid (guestfs_h *g,\n"
14286 " const char *device);\n"
14291 #: ../src/guestfs-actions.pod:6312 ../fish/guestfish-actions.pod:4202
14292 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14296 #: ../src/guestfs-actions.pod:6315 ../fish/guestfish-actions.pod:4205
14297 msgid "If the filesystem does not have a UUID, this returns the empty string."
14301 #: ../src/guestfs-actions.pod:6317
14302 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
14306 #: ../src/guestfs-actions.pod:6324
14307 msgid "guestfs_vg_activate"
14311 #: ../src/guestfs-actions.pod:6326
14315 " guestfs_vg_activate (guestfs_h *g,\n"
14317 " char *const *volgroups);\n"
14322 #: ../src/guestfs-actions.pod:6331 ../fish/guestfish-actions.pod:4213
14324 "This command activates or (if C<activate> is false) deactivates all logical "
14325 "volumes in the listed volume groups C<volgroups>. If activated, then they "
14326 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
14327 "deactivated, then those devices disappear."
14331 #: ../src/guestfs-actions.pod:6337 ../fish/guestfish-actions.pod:4219
14332 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14336 #: ../src/guestfs-actions.pod:6339 ../fish/guestfish-actions.pod:4221
14338 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14339 "activated or deactivated."
14343 #: ../src/guestfs-actions.pod:6346
14344 msgid "guestfs_vg_activate_all"
14348 #: ../src/guestfs-actions.pod:6348
14352 " guestfs_vg_activate_all (guestfs_h *g,\n"
14353 " int activate);\n"
14358 #: ../src/guestfs-actions.pod:6352 ../fish/guestfish-actions.pod:4228
14360 "This command activates or (if C<activate> is false) deactivates all logical "
14361 "volumes in all volume groups. If activated, then they are made known to the "
14362 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
14363 "those devices disappear."
14367 #: ../src/guestfs-actions.pod:6358 ../fish/guestfish-actions.pod:4234
14368 msgid "This command is the same as running C<vgchange -a y|n>"
14372 #: ../src/guestfs-actions.pod:6364
14373 msgid "guestfs_vgcreate"
14377 #: ../src/guestfs-actions.pod:6366
14381 " guestfs_vgcreate (guestfs_h *g,\n"
14382 " const char *volgroup,\n"
14383 " char *const *physvols);\n"
14388 #: ../src/guestfs-actions.pod:6371 ../fish/guestfish-actions.pod:4240
14390 "This creates an LVM volume group called C<volgroup> from the non-empty list "
14391 "of physical volumes C<physvols>."
14395 #: ../src/guestfs-actions.pod:6378
14396 msgid "guestfs_vglvuuids"
14400 #: ../src/guestfs-actions.pod:6380
14404 " guestfs_vglvuuids (guestfs_h *g,\n"
14405 " const char *vgname);\n"
14410 #: ../src/guestfs-actions.pod:6384 ../fish/guestfish-actions.pod:4247
14412 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
14413 "volumes created in this volume group."
14417 #: ../src/guestfs-actions.pod:6387
14419 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
14420 "associate logical volumes and volume groups."
14424 #: ../src/guestfs-actions.pod:6390
14425 msgid "See also C<guestfs_vgpvuuids>."
14429 #: ../src/guestfs-actions.pod:6398
14430 msgid "guestfs_vgpvuuids"
14434 #: ../src/guestfs-actions.pod:6400
14438 " guestfs_vgpvuuids (guestfs_h *g,\n"
14439 " const char *vgname);\n"
14444 #: ../src/guestfs-actions.pod:6404 ../fish/guestfish-actions.pod:4259
14446 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
14447 "volumes that this volume group resides on."
14451 #: ../src/guestfs-actions.pod:6407
14453 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
14454 "associate physical volumes and volume groups."
14458 #: ../src/guestfs-actions.pod:6410
14459 msgid "See also C<guestfs_vglvuuids>."
14463 #: ../src/guestfs-actions.pod:6418
14464 msgid "guestfs_vgremove"
14468 #: ../src/guestfs-actions.pod:6420
14472 " guestfs_vgremove (guestfs_h *g,\n"
14473 " const char *vgname);\n"
14478 #: ../src/guestfs-actions.pod:6424 ../fish/guestfish-actions.pod:4271
14479 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
14483 #: ../src/guestfs-actions.pod:6426 ../fish/guestfish-actions.pod:4273
14484 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
14488 #: ../src/guestfs-actions.pod:6433
14489 msgid "guestfs_vgrename"
14493 #: ../src/guestfs-actions.pod:6435
14497 " guestfs_vgrename (guestfs_h *g,\n"
14498 " const char *volgroup,\n"
14499 " const char *newvolgroup);\n"
14504 #: ../src/guestfs-actions.pod:6440 ../fish/guestfish-actions.pod:4280
14505 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
14509 #: ../src/guestfs-actions.pod:6446
14510 msgid "guestfs_vgs"
14514 #: ../src/guestfs-actions.pod:6448
14518 " guestfs_vgs (guestfs_h *g);\n"
14523 #: ../src/guestfs-actions.pod:6451 ../fish/guestfish-actions.pod:4286
14525 "List all the volumes groups detected. This is the equivalent of the "
14526 "L<vgs(8)> command."
14530 #: ../src/guestfs-actions.pod:6454 ../fish/guestfish-actions.pod:4289
14532 "This returns a list of just the volume group names that were detected "
14533 "(eg. C<VolGroup00>)."
14537 #: ../src/guestfs-actions.pod:6457
14538 msgid "See also C<guestfs_vgs_full>."
14542 #: ../src/guestfs-actions.pod:6465
14543 msgid "guestfs_vgs_full"
14547 #: ../src/guestfs-actions.pod:6467
14550 " struct guestfs_lvm_vg_list *\n"
14551 " guestfs_vgs_full (guestfs_h *g);\n"
14556 #: ../src/guestfs-actions.pod:6470 ../fish/guestfish-actions.pod:4298
14558 "List all the volumes groups detected. This is the equivalent of the "
14559 "L<vgs(8)> command. The \"full\" version includes all fields."
14563 #: ../src/guestfs-actions.pod:6473
14565 "This function returns a C<struct guestfs_lvm_vg_list *> (see "
14566 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
14567 "must call C<guestfs_free_lvm_vg_list> after use>."
14571 #: ../src/guestfs-actions.pod:6480
14572 msgid "guestfs_vgscan"
14576 #: ../src/guestfs-actions.pod:6482
14580 " guestfs_vgscan (guestfs_h *g);\n"
14585 #: ../src/guestfs-actions.pod:6485 ../fish/guestfish-actions.pod:4305
14587 "This rescans all block devices and rebuilds the list of LVM physical "
14588 "volumes, volume groups and logical volumes."
14592 #: ../src/guestfs-actions.pod:6492
14593 msgid "guestfs_vguuid"
14597 #: ../src/guestfs-actions.pod:6494
14601 " guestfs_vguuid (guestfs_h *g,\n"
14602 " const char *vgname);\n"
14607 #: ../src/guestfs-actions.pod:6498 ../fish/guestfish-actions.pod:4312
14608 msgid "This command returns the UUID of the LVM VG named C<vgname>."
14612 #: ../src/guestfs-actions.pod:6505
14613 msgid "guestfs_wait_ready"
14617 #: ../src/guestfs-actions.pod:6507
14621 " guestfs_wait_ready (guestfs_h *g);\n"
14626 #: ../src/guestfs-actions.pod:6510
14627 msgid "This function is a no op."
14631 #: ../src/guestfs-actions.pod:6512
14633 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
14634 "calling C<guestfs_launch> to wait for the launch to complete. However this "
14635 "is no longer necessary because C<guestfs_launch> now does the waiting."
14639 #: ../src/guestfs-actions.pod:6517
14641 "If you see any calls to this function in code then you can just remove them, "
14642 "unless you want to retain compatibility with older versions of the API."
14646 #: ../src/guestfs-actions.pod:6525
14647 msgid "guestfs_wc_c"
14651 #: ../src/guestfs-actions.pod:6527
14655 " guestfs_wc_c (guestfs_h *g,\n"
14656 " const char *path);\n"
14661 #: ../src/guestfs-actions.pod:6531 ../fish/guestfish-actions.pod:4318
14663 "This command counts the characters in a file, using the C<wc -c> external "
14668 #: ../src/guestfs-actions.pod:6538
14669 msgid "guestfs_wc_l"
14673 #: ../src/guestfs-actions.pod:6540
14677 " guestfs_wc_l (guestfs_h *g,\n"
14678 " const char *path);\n"
14683 #: ../src/guestfs-actions.pod:6544 ../fish/guestfish-actions.pod:4325
14685 "This command counts the lines in a file, using the C<wc -l> external "
14690 #: ../src/guestfs-actions.pod:6551
14691 msgid "guestfs_wc_w"
14695 #: ../src/guestfs-actions.pod:6553
14699 " guestfs_wc_w (guestfs_h *g,\n"
14700 " const char *path);\n"
14705 #: ../src/guestfs-actions.pod:6557 ../fish/guestfish-actions.pod:4332
14707 "This command counts the words in a file, using the C<wc -w> external "
14712 #: ../src/guestfs-actions.pod:6564
14713 msgid "guestfs_write"
14717 #: ../src/guestfs-actions.pod:6566
14721 " guestfs_write (guestfs_h *g,\n"
14722 " const char *path,\n"
14723 " const char *content,\n"
14724 " size_t content_size);\n"
14729 #: ../src/guestfs-actions.pod:6572 ../fish/guestfish-actions.pod:4339
14731 "This call creates a file called C<path>. The content of the file is the "
14732 "string C<content> (which can contain any 8 bit data)."
14736 #: ../src/guestfs-actions.pod:6582
14737 msgid "guestfs_write_file"
14741 #: ../src/guestfs-actions.pod:6584
14745 " guestfs_write_file (guestfs_h *g,\n"
14746 " const char *path,\n"
14747 " const char *content,\n"
14753 #: ../src/guestfs-actions.pod:6590 ../fish/guestfish-actions.pod:4349
14755 "This call creates a file called C<path>. The contents of the file is the "
14756 "string C<content> (which can contain any 8 bit data), with length C<size>."
14760 #: ../src/guestfs-actions.pod:6594 ../fish/guestfish-actions.pod:4353
14762 "As a special case, if C<size> is C<0> then the length is calculated using "
14763 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
14767 #: ../src/guestfs-actions.pod:6598 ../fish/guestfish-actions.pod:4357
14769 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
14770 "I<not> work, even if the length is specified."
14774 #: ../src/guestfs-actions.pod:6606 ../fish/guestfish-actions.pod:4363
14775 msgid "This function is deprecated. In new code, use the C<write> call instead."
14779 #: ../src/guestfs-actions.pod:6615
14780 msgid "guestfs_zegrep"
14784 #: ../src/guestfs-actions.pod:6617
14788 " guestfs_zegrep (guestfs_h *g,\n"
14789 " const char *regex,\n"
14790 " const char *path);\n"
14795 #: ../src/guestfs-actions.pod:6622 ../fish/guestfish-actions.pod:4374
14796 msgid "This calls the external C<zegrep> program and returns the matching lines."
14800 #: ../src/guestfs-actions.pod:6634
14801 msgid "guestfs_zegrepi"
14805 #: ../src/guestfs-actions.pod:6636
14809 " guestfs_zegrepi (guestfs_h *g,\n"
14810 " const char *regex,\n"
14811 " const char *path);\n"
14816 #: ../src/guestfs-actions.pod:6641 ../fish/guestfish-actions.pod:4384
14817 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
14821 #: ../src/guestfs-actions.pod:6653
14822 msgid "guestfs_zero"
14826 #: ../src/guestfs-actions.pod:6655
14830 " guestfs_zero (guestfs_h *g,\n"
14831 " const char *device);\n"
14836 #: ../src/guestfs-actions.pod:6659 ../fish/guestfish-actions.pod:4394
14837 msgid "This command writes zeroes over the first few blocks of C<device>."
14841 #: ../src/guestfs-actions.pod:6661 ../fish/guestfish-actions.pod:4396
14843 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
14844 "securely wipe the device). It should be sufficient to remove any partition "
14845 "tables, filesystem superblocks and so on."
14849 #: ../src/guestfs-actions.pod:6665
14850 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
14854 #: ../src/guestfs-actions.pod:6676
14855 msgid "guestfs_zero_device"
14859 #: ../src/guestfs-actions.pod:6678
14863 " guestfs_zero_device (guestfs_h *g,\n"
14864 " const char *device);\n"
14869 #: ../src/guestfs-actions.pod:6682
14871 "This command writes zeroes over the entire C<device>. Compare with "
14872 "C<guestfs_zero> which just zeroes the first few blocks of a device."
14876 #: ../src/guestfs-actions.pod:6696
14877 msgid "(Added in 1.3.1)"
14881 #: ../src/guestfs-actions.pod:6698
14882 msgid "guestfs_zerofree"
14886 #: ../src/guestfs-actions.pod:6700
14890 " guestfs_zerofree (guestfs_h *g,\n"
14891 " const char *device);\n"
14896 #: ../src/guestfs-actions.pod:6704 ../fish/guestfish-actions.pod:4417
14898 "This runs the I<zerofree> program on C<device>. This program claims to zero "
14899 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
14900 "possible to compress the filesystem more effectively."
14904 #: ../src/guestfs-actions.pod:6709 ../fish/guestfish-actions.pod:4422
14905 msgid "You should B<not> run this program if the filesystem is mounted."
14909 #: ../src/guestfs-actions.pod:6712 ../fish/guestfish-actions.pod:4425
14911 "It is possible that using this program can damage the filesystem or data on "
14916 #: ../src/guestfs-actions.pod:6719
14917 msgid "guestfs_zfgrep"
14921 #: ../src/guestfs-actions.pod:6721
14925 " guestfs_zfgrep (guestfs_h *g,\n"
14926 " const char *pattern,\n"
14927 " const char *path);\n"
14932 #: ../src/guestfs-actions.pod:6726 ../fish/guestfish-actions.pod:4432
14933 msgid "This calls the external C<zfgrep> program and returns the matching lines."
14937 #: ../src/guestfs-actions.pod:6738
14938 msgid "guestfs_zfgrepi"
14942 #: ../src/guestfs-actions.pod:6740
14946 " guestfs_zfgrepi (guestfs_h *g,\n"
14947 " const char *pattern,\n"
14948 " const char *path);\n"
14953 #: ../src/guestfs-actions.pod:6745 ../fish/guestfish-actions.pod:4442
14954 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
14958 #: ../src/guestfs-actions.pod:6757
14959 msgid "guestfs_zfile"
14963 #: ../src/guestfs-actions.pod:6759
14967 " guestfs_zfile (guestfs_h *g,\n"
14968 " const char *meth,\n"
14969 " const char *path);\n"
14974 #: ../src/guestfs-actions.pod:6764 ../fish/guestfish-actions.pod:4452
14975 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
14979 #: ../src/guestfs-actions.pod:6767 ../fish/guestfish-actions.pod:4455
14980 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
14984 #: ../src/guestfs-actions.pod:6769
14986 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
14991 #: ../src/guestfs-actions.pod:6775 ../fish/guestfish-actions.pod:4460
14992 msgid "This function is deprecated. In new code, use the C<file> call instead."
14996 #: ../src/guestfs-actions.pod:6784
14997 msgid "guestfs_zgrep"
15001 #: ../src/guestfs-actions.pod:6786
15005 " guestfs_zgrep (guestfs_h *g,\n"
15006 " const char *regex,\n"
15007 " const char *path);\n"
15012 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4471
15013 msgid "This calls the external C<zgrep> program and returns the matching lines."
15017 #: ../src/guestfs-actions.pod:6803
15018 msgid "guestfs_zgrepi"
15022 #: ../src/guestfs-actions.pod:6805
15026 " guestfs_zgrepi (guestfs_h *g,\n"
15027 " const char *regex,\n"
15028 " const char *path);\n"
15033 #: ../src/guestfs-actions.pod:6810 ../fish/guestfish-actions.pod:4481
15034 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
15038 #: ../src/guestfs-availability.pod:3
15043 #: ../src/guestfs-availability.pod:5
15045 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
15046 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
15047 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
15048 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
15049 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
15053 #: ../src/guestfs-availability.pod:21
15058 #: ../src/guestfs-availability.pod:23
15060 "The following functions: L</guestfs_inotify_add_watch> "
15061 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
15062 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
15066 #: ../src/guestfs-availability.pod:31
15067 msgid "B<linuxfsuuid>"
15071 #: ../src/guestfs-availability.pod:33
15073 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
15074 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
15078 #: ../src/guestfs-availability.pod:40
15079 msgid "B<linuxmodules>"
15083 #: ../src/guestfs-availability.pod:42
15084 msgid "The following functions: L</guestfs_modprobe>"
15088 #: ../src/guestfs-availability.pod:45
15089 msgid "B<linuxxattrs>"
15093 #: ../src/guestfs-availability.pod:47
15095 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> "
15096 "L</guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> "
15097 "L</guestfs_removexattr> L</guestfs_setxattr>"
15101 #: ../src/guestfs-availability.pod:56
15106 #: ../src/guestfs-availability.pod:58
15108 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
15109 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
15110 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
15114 #: ../src/guestfs-availability.pod:67
15119 #: ../src/guestfs-availability.pod:69
15121 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
15122 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
15123 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
15124 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
15125 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
15126 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
15127 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
15128 "L</guestfs_vgs_full>"
15132 #: ../src/guestfs-availability.pod:92
15137 #: ../src/guestfs-availability.pod:94
15139 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
15140 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
15144 #: ../src/guestfs-availability.pod:100
15149 #: ../src/guestfs-availability.pod:102
15150 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
15154 #: ../src/guestfs-availability.pod:105
15155 msgid "B<ntfsprogs>"
15159 #: ../src/guestfs-availability.pod:107
15160 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
15164 #: ../src/guestfs-availability.pod:111
15165 msgid "B<realpath>"
15169 #: ../src/guestfs-availability.pod:113
15170 msgid "The following functions: L</guestfs_realpath>"
15174 #: ../src/guestfs-availability.pod:116
15179 #: ../src/guestfs-availability.pod:118
15181 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
15182 "L</guestfs_scrub_freespace>"
15186 #: ../src/guestfs-availability.pod:123
15191 #: ../src/guestfs-availability.pod:125
15192 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
15196 #: ../src/guestfs-availability.pod:129
15201 #: ../src/guestfs-availability.pod:131
15202 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
15206 #: ../src/guestfs-availability.pod:135
15207 msgid "B<zerofree>"
15211 #: ../src/guestfs-availability.pod:137
15212 msgid "The following functions: L</guestfs_zerofree>"
15216 #: ../src/guestfs-structs.pod:1
15217 msgid "guestfs_int_bool"
15221 #: ../src/guestfs-structs.pod:3
15224 " struct guestfs_int_bool {\n"
15232 #: ../src/guestfs-structs.pod:8
15235 " struct guestfs_int_bool_list {\n"
15236 " uint32_t len; /* Number of elements in list. */\n"
15237 " struct guestfs_int_bool *val; /* Elements. */\n"
15243 #: ../src/guestfs-structs.pod:13
15246 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
15247 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
15252 #: ../src/guestfs-structs.pod:16
15253 msgid "guestfs_lvm_pv"
15257 #: ../src/guestfs-structs.pod:18
15260 " struct guestfs_lvm_pv {\n"
15261 " char *pv_name;\n"
15262 " /* The next field is NOT nul-terminated, be careful when printing it: "
15264 " char pv_uuid[32];\n"
15266 " uint64_t pv_size;\n"
15267 " uint64_t dev_size;\n"
15268 " uint64_t pv_free;\n"
15269 " uint64_t pv_used;\n"
15270 " char *pv_attr;\n"
15271 " int64_t pv_pe_count;\n"
15272 " int64_t pv_pe_alloc_count;\n"
15273 " char *pv_tags;\n"
15274 " uint64_t pe_start;\n"
15275 " int64_t pv_mda_count;\n"
15276 " uint64_t pv_mda_free;\n"
15282 #: ../src/guestfs-structs.pod:36
15285 " struct guestfs_lvm_pv_list {\n"
15286 " uint32_t len; /* Number of elements in list. */\n"
15287 " struct guestfs_lvm_pv *val; /* Elements. */\n"
15293 #: ../src/guestfs-structs.pod:41
15296 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
15297 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
15302 #: ../src/guestfs-structs.pod:44
15303 msgid "guestfs_lvm_vg"
15307 #: ../src/guestfs-structs.pod:46
15310 " struct guestfs_lvm_vg {\n"
15311 " char *vg_name;\n"
15312 " /* The next field is NOT nul-terminated, be careful when printing it: "
15314 " char vg_uuid[32];\n"
15316 " char *vg_attr;\n"
15317 " uint64_t vg_size;\n"
15318 " uint64_t vg_free;\n"
15319 " char *vg_sysid;\n"
15320 " uint64_t vg_extent_size;\n"
15321 " int64_t vg_extent_count;\n"
15322 " int64_t vg_free_count;\n"
15323 " int64_t max_lv;\n"
15324 " int64_t max_pv;\n"
15325 " int64_t pv_count;\n"
15326 " int64_t lv_count;\n"
15327 " int64_t snap_count;\n"
15328 " int64_t vg_seqno;\n"
15329 " char *vg_tags;\n"
15330 " int64_t vg_mda_count;\n"
15331 " uint64_t vg_mda_free;\n"
15337 #: ../src/guestfs-structs.pod:69
15340 " struct guestfs_lvm_vg_list {\n"
15341 " uint32_t len; /* Number of elements in list. */\n"
15342 " struct guestfs_lvm_vg *val; /* Elements. */\n"
15348 #: ../src/guestfs-structs.pod:74
15351 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
15352 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
15357 #: ../src/guestfs-structs.pod:77
15358 msgid "guestfs_lvm_lv"
15362 #: ../src/guestfs-structs.pod:79
15365 " struct guestfs_lvm_lv {\n"
15366 " char *lv_name;\n"
15367 " /* The next field is NOT nul-terminated, be careful when printing it: "
15369 " char lv_uuid[32];\n"
15370 " char *lv_attr;\n"
15371 " int64_t lv_major;\n"
15372 " int64_t lv_minor;\n"
15373 " int64_t lv_kernel_major;\n"
15374 " int64_t lv_kernel_minor;\n"
15375 " uint64_t lv_size;\n"
15376 " int64_t seg_count;\n"
15378 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
15379 " float snap_percent;\n"
15380 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
15381 " float copy_percent;\n"
15382 " char *move_pv;\n"
15383 " char *lv_tags;\n"
15384 " char *mirror_log;\n"
15385 " char *modules;\n"
15391 #: ../src/guestfs-structs.pod:101
15394 " struct guestfs_lvm_lv_list {\n"
15395 " uint32_t len; /* Number of elements in list. */\n"
15396 " struct guestfs_lvm_lv *val; /* Elements. */\n"
15402 #: ../src/guestfs-structs.pod:106
15405 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
15406 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
15411 #: ../src/guestfs-structs.pod:111
15414 " struct guestfs_stat {\n"
15418 " int64_t nlink;\n"
15423 " int64_t blksize;\n"
15424 " int64_t blocks;\n"
15425 " int64_t atime;\n"
15426 " int64_t mtime;\n"
15427 " int64_t ctime;\n"
15433 #: ../src/guestfs-structs.pod:127
15436 " struct guestfs_stat_list {\n"
15437 " uint32_t len; /* Number of elements in list. */\n"
15438 " struct guestfs_stat *val; /* Elements. */\n"
15444 #: ../src/guestfs-structs.pod:132
15447 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
15448 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
15453 #: ../src/guestfs-structs.pod:137
15456 " struct guestfs_statvfs {\n"
15457 " int64_t bsize;\n"
15458 " int64_t frsize;\n"
15459 " int64_t blocks;\n"
15460 " int64_t bfree;\n"
15461 " int64_t bavail;\n"
15462 " int64_t files;\n"
15463 " int64_t ffree;\n"
15464 " int64_t favail;\n"
15467 " int64_t namemax;\n"
15473 #: ../src/guestfs-structs.pod:151
15476 " struct guestfs_statvfs_list {\n"
15477 " uint32_t len; /* Number of elements in list. */\n"
15478 " struct guestfs_statvfs *val; /* Elements. */\n"
15484 #: ../src/guestfs-structs.pod:156
15487 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
15488 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
15493 #: ../src/guestfs-structs.pod:159
15494 msgid "guestfs_dirent"
15498 #: ../src/guestfs-structs.pod:161
15501 " struct guestfs_dirent {\n"
15510 #: ../src/guestfs-structs.pod:167
15513 " struct guestfs_dirent_list {\n"
15514 " uint32_t len; /* Number of elements in list. */\n"
15515 " struct guestfs_dirent *val; /* Elements. */\n"
15521 #: ../src/guestfs-structs.pod:172
15524 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
15525 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
15530 #: ../src/guestfs-structs.pod:177
15533 " struct guestfs_version {\n"
15534 " int64_t major;\n"
15535 " int64_t minor;\n"
15536 " int64_t release;\n"
15543 #: ../src/guestfs-structs.pod:184
15546 " struct guestfs_version_list {\n"
15547 " uint32_t len; /* Number of elements in list. */\n"
15548 " struct guestfs_version *val; /* Elements. */\n"
15554 #: ../src/guestfs-structs.pod:189
15557 " void guestfs_free_version (struct guestfs_free_version *);\n"
15558 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
15563 #: ../src/guestfs-structs.pod:192
15564 msgid "guestfs_xattr"
15568 #: ../src/guestfs-structs.pod:194
15571 " struct guestfs_xattr {\n"
15572 " char *attrname;\n"
15573 " /* The next two fields describe a byte array. */\n"
15574 " uint32_t attrval_len;\n"
15575 " char *attrval;\n"
15581 #: ../src/guestfs-structs.pod:201
15584 " struct guestfs_xattr_list {\n"
15585 " uint32_t len; /* Number of elements in list. */\n"
15586 " struct guestfs_xattr *val; /* Elements. */\n"
15592 #: ../src/guestfs-structs.pod:206
15595 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
15596 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
15601 #: ../src/guestfs-structs.pod:209
15602 msgid "guestfs_inotify_event"
15606 #: ../src/guestfs-structs.pod:211
15609 " struct guestfs_inotify_event {\n"
15610 " int64_t in_wd;\n"
15611 " uint32_t in_mask;\n"
15612 " uint32_t in_cookie;\n"
15613 " char *in_name;\n"
15619 #: ../src/guestfs-structs.pod:218
15622 " struct guestfs_inotify_event_list {\n"
15623 " uint32_t len; /* Number of elements in list. */\n"
15624 " struct guestfs_inotify_event *val; /* Elements. */\n"
15630 #: ../src/guestfs-structs.pod:223
15633 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
15634 " void guestfs_free_inotify_event_list (struct "
15635 "guestfs_free_inotify_event_list *);\n"
15640 #: ../src/guestfs-structs.pod:226
15641 msgid "guestfs_partition"
15645 #: ../src/guestfs-structs.pod:228
15648 " struct guestfs_partition {\n"
15649 " int32_t part_num;\n"
15650 " uint64_t part_start;\n"
15651 " uint64_t part_end;\n"
15652 " uint64_t part_size;\n"
15658 #: ../src/guestfs-structs.pod:235
15661 " struct guestfs_partition_list {\n"
15662 " uint32_t len; /* Number of elements in list. */\n"
15663 " struct guestfs_partition *val; /* Elements. */\n"
15669 #: ../src/guestfs-structs.pod:240
15672 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
15673 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
15678 #: ../fish/guestfish.pod:5
15679 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
15683 #: ../fish/guestfish.pod:9
15686 " guestfish [--options] [commands]\n"
15691 #: ../fish/guestfish.pod:11
15699 #: ../fish/guestfish.pod:13
15702 " guestfish [--ro|--rw] -a disk.img\n"
15707 #: ../fish/guestfish.pod:15
15710 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
15715 #: ../fish/guestfish.pod:17
15718 " guestfish -d libvirt-domain\n"
15723 #: ../fish/guestfish.pod:19
15726 " guestfish [--ro|--rw] -a disk.img -i\n"
15731 #: ../fish/guestfish.pod:21
15734 " guestfish -d libvirt-domain -i\n"
15739 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59 ../tools/virt-rescue.pl:41
15744 #: ../fish/guestfish.pod:25
15746 "Using guestfish in read/write mode on live virtual machines can be "
15747 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
15748 "option to use guestfish safely if the disk image or virtual machine might be "
15753 #: ../fish/guestfish.pod:32
15755 "Guestfish is a shell and command-line tool for examining and modifying "
15756 "virtual machine filesystems. It uses libguestfs and exposes all of the "
15757 "functionality of the guestfs API, see L<guestfs(3)>."
15761 #: ../fish/guestfish.pod:36
15763 "Guestfish gives you structured access to the libguestfs API, from shell "
15764 "scripts or the command line or interactively. If you want to rescue a "
15765 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
15770 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:846 ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58 ../tools/virt-resize.pl:66 ../tools/virt-cat.pl:50 ../tools/virt-tar.pl:45
15775 #: ../fish/guestfish.pod:43
15776 msgid "As an interactive shell"
15780 #: ../fish/guestfish.pod:45
15788 #: ../fish/guestfish.pod:47
15791 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
15792 " editing virtual machine filesystems.\n"
15797 #: ../fish/guestfish.pod:50
15800 " Type: 'help' for a list of commands\n"
15801 " 'man' to read the manual\n"
15802 " 'quit' to quit the shell\n"
15807 #: ../fish/guestfish.pod:54
15810 " ><fs> add-ro disk.img\n"
15812 " ><fs> list-filesystems\n"
15813 " /dev/sda1: ext4\n"
15814 " /dev/vg_guest/lv_root: ext4\n"
15815 " /dev/vg_guest/lv_swap: swap\n"
15816 " ><fs> mount /dev/vg_guest/lv_root /\n"
15817 " ><fs> cat /etc/fstab\n"
15819 " # Created by anaconda\n"
15826 #: ../fish/guestfish.pod:67
15827 msgid "From shell scripts"
15831 #: ../fish/guestfish.pod:69
15832 msgid "Create a new C</etc/motd> file in a guest or disk image:"
15836 #: ../fish/guestfish.pod:71
15839 " guestfish <<_EOF_\n"
15842 " mount /dev/vg_guest/lv_root /\n"
15843 " write /etc/motd \"Welcome, new users\"\n"
15849 #: ../fish/guestfish.pod:78
15850 msgid "List the LVM logical volumes in a disk image:"
15854 #: ../fish/guestfish.pod:80
15857 " guestfish -a disk.img --ro <<_EOF_\n"
15865 #: ../fish/guestfish.pod:85
15866 msgid "List all the filesystems in a disk image:"
15870 #: ../fish/guestfish.pod:87
15873 " guestfish -a disk.img --ro <<_EOF_\n"
15875 " list-filesystems\n"
15881 #: ../fish/guestfish.pod:92
15882 msgid "On one command line"
15886 #: ../fish/guestfish.pod:94
15887 msgid "Update C</etc/resolv.conf> in a guest:"
15891 #: ../fish/guestfish.pod:96
15895 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
15896 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
15901 #: ../fish/guestfish.pod:100
15902 msgid "Edit C</boot/grub/grub.conf> interactively:"
15906 #: ../fish/guestfish.pod:102
15909 " guestfish --rw --add disk.img \\\n"
15910 " --mount /dev/vg_guest/lv_root \\\n"
15911 " --mount /dev/sda1:/boot \\\n"
15912 " edit /boot/grub/grub.conf\n"
15917 #: ../fish/guestfish.pod:107
15918 msgid "Mount disks automatically"
15922 #: ../fish/guestfish.pod:109
15924 "Use the I<-i> option to automatically mount the disks from a virtual "
15929 #: ../fish/guestfish.pod:112
15932 " guestfish --ro -a disk.img -i cat /etc/group\n"
15937 #: ../fish/guestfish.pod:114
15940 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
15945 #: ../fish/guestfish.pod:116
15946 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
15950 #: ../fish/guestfish.pod:118
15953 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
15958 #: ../fish/guestfish.pod:120
15959 msgid "As a script interpreter"
15963 #: ../fish/guestfish.pod:122
15964 msgid "Create a 100MB disk containing an ext2-formatted partition:"
15968 #: ../fish/guestfish.pod:124
15971 " #!/usr/bin/guestfish -f\n"
15972 " sparse test1.img 100M\n"
15974 " part-disk /dev/sda mbr\n"
15975 " mkfs ext2 /dev/sda1\n"
15980 #: ../fish/guestfish.pod:130
15981 msgid "Start with a prepared disk"
15985 #: ../fish/guestfish.pod:132
15987 "An alternate way to create a 100MB disk called C<test1.img> containing a "
15988 "single ext2-formatted partition:"
15992 #: ../fish/guestfish.pod:135
15995 " guestfish -N fs\n"
16000 #: ../fish/guestfish.pod:137
16001 msgid "To list what is available do:"
16005 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:837
16008 " guestfish -N help | less\n"
16013 #: ../fish/guestfish.pod:141
16014 msgid "Remote control"
16018 #: ../fish/guestfish.pod:143
16021 " eval \"`guestfish --listen`\"\n"
16022 " guestfish --remote add-ro disk.img\n"
16023 " guestfish --remote run\n"
16024 " guestfish --remote lvs\n"
16029 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37 ../fuse/guestmount.pod:73 ../inspector/virt-inspector.pl:68 ../tools/virt-edit.pl:72 ../tools/virt-win-reg.pl:171 ../tools/virt-df.pl:71 ../tools/virt-ls.pl:78 ../tools/virt-resize.pl:257 ../tools/virt-list-filesystems.pl:50 ../tools/virt-cat.pl:79 ../tools/virt-tar.pl:98 ../tools/virt-rescue.pl:103 ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:51
16034 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131 ../inspector/virt-inspector.pl:76 ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:179 ../tools/virt-df.pl:79 ../tools/virt-ls.pl:86 ../tools/virt-resize.pl:265 ../tools/virt-list-filesystems.pl:58 ../tools/virt-cat.pl:87 ../tools/virt-tar.pl:106 ../tools/virt-rescue.pl:111 ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:59
16039 #: ../fish/guestfish.pod:154
16040 msgid "Displays general help on options."
16044 #: ../fish/guestfish.pod:156
16045 msgid "B<-h> | B<--cmd-help>"
16049 #: ../fish/guestfish.pod:158
16050 msgid "Lists all available guestfish commands."
16054 #: ../fish/guestfish.pod:160
16055 msgid "B<-h cmd> | B<--cmd-help cmd>"
16059 #: ../fish/guestfish.pod:162
16060 msgid "Displays detailed help on a single command C<cmd>."
16064 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
16065 msgid "B<-a image> | B<--add image>"
16069 #: ../fish/guestfish.pod:166
16070 msgid "Add a block device or virtual machine image to the shell."
16074 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
16076 "The format of the disk image is auto-detected. To override this and force a "
16077 "particular format use the I<--format=..> option."
16081 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
16082 msgid "B<-c URI> | B<--connect URI>"
16086 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
16088 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16089 "URI to use. The default is to use the default libvirt connection."
16093 #: ../fish/guestfish.pod:177
16098 #: ../fish/guestfish.pod:179
16100 "If using the I<--listen> option and a csh-like shell, use this option. See "
16101 "section L</REMOTE CONTROL AND CSH> below."
16105 #: ../fish/guestfish.pod:182 ../fuse/guestmount.pod:90
16106 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
16110 #: ../fish/guestfish.pod:184 ../fuse/guestmount.pod:92
16112 "Add disks from the named libvirt domain. If the I<--ro> option is also "
16113 "used, then any libvirt domain can be used. However in write mode, only "
16114 "libvirt domains which are shut down can be named here."
16118 #: ../fish/guestfish.pod:188
16119 msgid "B<-D> | B<--no-dest-paths>"
16123 #: ../fish/guestfish.pod:190
16125 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
16126 "to hit the tab key to complete paths on the guest filesystem, but this "
16127 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
16128 "allow this feature to be disabled."
16132 #: ../fish/guestfish.pod:195 ../fuse/guestmount.pod:108
16133 msgid "B<--echo-keys>"
16137 #: ../fish/guestfish.pod:197 ../fuse/guestmount.pod:110
16139 "When prompting for keys and passphrases, guestfish normally turns echoing "
16140 "off so you cannot see what you are typing. If you are not worried about "
16141 "Tempest attacks and there is no one else in the room you can specify this "
16142 "flag to see what you are typing."
16146 #: ../fish/guestfish.pod:202
16147 msgid "B<-f file> | B<--file file>"
16151 #: ../fish/guestfish.pod:204
16152 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
16156 #: ../fish/guestfish.pod:207
16159 " #!/usr/bin/guestfish -f\n"
16164 #: ../fish/guestfish.pod:209 ../fuse/guestmount.pod:115
16165 msgid "B<--format=raw|qcow2|..> | B<--format>"
16169 #: ../fish/guestfish.pod:211 ../fuse/guestmount.pod:117
16171 "The default for the I<-a> option is to auto-detect the format of the disk "
16172 "image. Using this forces the disk format for I<-a> options which follow on "
16173 "the command line. Using I<--format> with no argument switches back to "
16174 "auto-detection for subsequent I<-a> options."
16178 #: ../fish/guestfish.pod:216 ../fish/guestfish.pod:543 ../inspector/virt-inspector.pl:549
16179 msgid "For example:"
16183 #: ../fish/guestfish.pod:218
16186 " guestfish --format=raw -a disk.img\n"
16191 #: ../fish/guestfish.pod:220
16192 msgid "forces raw format (no auto-detection) for C<disk.img>."
16196 #: ../fish/guestfish.pod:222
16199 " guestfish --format=raw -a disk.img --format -a another.img\n"
16204 #: ../fish/guestfish.pod:224
16206 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
16207 "auto-detection for C<another.img>."
16211 #: ../fish/guestfish.pod:227
16213 "If you have untrusted raw-format guest disk images, you should use this "
16214 "option to specify the disk format. This avoids a possible security problem "
16215 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
16219 #: ../fish/guestfish.pod:232 ../fuse/guestmount.pod:135
16220 msgid "B<-i> | B<--inspector>"
16224 #: ../fish/guestfish.pod:234 ../fuse/guestmount.pod:137
16226 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
16227 "system and mount filesystems as they would be mounted on the real virtual "
16232 #: ../fish/guestfish.pod:238
16233 msgid "Typical usage is either:"
16237 #: ../fish/guestfish.pod:240
16240 " guestfish -d myguest -i\n"
16245 #: ../fish/guestfish.pod:242
16246 msgid "(for an inactive libvirt domain called I<myguest>), or:"
16250 #: ../fish/guestfish.pod:244
16253 " guestfish --ro -d myguest -i\n"
16258 #: ../fish/guestfish.pod:246
16259 msgid "(for active domains, readonly), or specify the block device directly:"
16263 #: ../fish/guestfish.pod:248
16266 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
16271 #: ../fish/guestfish.pod:250
16273 "Note that the command line syntax changed slightly over older versions of "
16274 "guestfish. You can still use the old syntax:"
16278 #: ../fish/guestfish.pod:253
16281 " guestfish [--ro] -i disk.img\n"
16286 #: ../fish/guestfish.pod:255
16289 " guestfish [--ro] -i libvirt-domain\n"
16294 #: ../fish/guestfish.pod:257 ../fuse/guestmount.pod:141
16295 msgid "B<--keys-from-stdin>"
16299 #: ../fish/guestfish.pod:259 ../fuse/guestmount.pod:143
16301 "Read key or passphrase parameters from stdin. The default is to try to read "
16302 "passphrases from the user by opening C</dev/tty>."
16306 #: ../fish/guestfish.pod:262
16307 msgid "B<--listen>"
16311 #: ../fish/guestfish.pod:264
16313 "Fork into the background and listen for remote commands. See section "
16314 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
16318 #: ../fish/guestfish.pod:267
16319 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
16323 #: ../fish/guestfish.pod:269
16324 msgid "Mount the named partition or logical volume on the given mountpoint."
16328 #: ../fish/guestfish.pod:271
16329 msgid "If the mountpoint is omitted, it defaults to C</>."
16333 #: ../fish/guestfish.pod:273
16334 msgid "You have to mount something on C</> before most commands will work."
16338 #: ../fish/guestfish.pod:275
16340 "If any I<-m> or I<--mount> options are given, the guest is automatically "
16345 #: ../fish/guestfish.pod:278
16347 "If you don't know what filesystems a disk image contains, you can either run "
16348 "guestfish without this option, then list the partitions and LVs available "
16349 "(see L</list-partitions> and L</lvs> commands), or you can use the "
16350 "L<virt-list-filesystems(1)> program."
16354 #: ../fish/guestfish.pod:283 ../fuse/guestmount.pod:154
16355 msgid "B<-n> | B<--no-sync>"
16359 #: ../fish/guestfish.pod:285
16361 "Disable autosync. This is enabled by default. See the discussion of "
16362 "autosync in the L<guestfs(3)> manpage."
16366 #: ../fish/guestfish.pod:288
16367 msgid "B<-N type> | B<--new type> | B<-N help>"
16371 #: ../fish/guestfish.pod:290
16373 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
16374 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
16375 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
16380 #: ../fish/guestfish.pod:295
16381 msgid "B<--progress-bars>"
16385 #: ../fish/guestfish.pod:297
16386 msgid "Enable progress bars, even when guestfish is used non-interactively."
16390 #: ../fish/guestfish.pod:299
16392 "Progress bars are enabled by default when guestfish is used as an "
16393 "interactive shell."
16397 #: ../fish/guestfish.pod:302
16398 msgid "B<--no-progress-bars>"
16402 #: ../fish/guestfish.pod:304
16403 msgid "Disable progress bars."
16407 #: ../fish/guestfish.pod:306
16408 msgid "B<--remote[=pid]>"
16412 #: ../fish/guestfish.pod:308
16414 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
16415 "CONTROL GUESTFISH OVER A SOCKET> below."
16419 #: ../fish/guestfish.pod:311 ../fuse/guestmount.pod:196
16420 msgid "B<-r> | B<--ro>"
16424 #: ../fish/guestfish.pod:313
16426 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
16427 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
16431 #: ../fish/guestfish.pod:316 ../tools/virt-rescue.pl:187
16433 "The option must always be used if the disk image or virtual machine might be "
16434 "running, and is generally recommended in cases where you don't need write "
16435 "access to the disk."
16439 #: ../fish/guestfish.pod:320
16441 "Note that prepared disk images created with I<-N> are not affected by the "
16446 #: ../fish/guestfish.pod:323
16447 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
16451 #: ../fish/guestfish.pod:325 ../fuse/guestmount.pod:208 ../tools/virt-rescue.pl:195
16452 msgid "B<--selinux>"
16456 #: ../fish/guestfish.pod:327
16457 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
16461 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:212
16462 msgid "B<-v> | B<--verbose>"
16466 #: ../fish/guestfish.pod:331
16468 "Enable very verbose messages. This is particularly useful if you find a "
16473 #: ../fish/guestfish.pod:334 ../fuse/guestmount.pod:216
16474 msgid "B<-V> | B<--version>"
16478 #: ../fish/guestfish.pod:336
16479 msgid "Display the guestfish / libguestfs version number and exit."
16483 #: ../fish/guestfish.pod:338 ../fuse/guestmount.pod:220
16484 msgid "B<-w> | B<--rw>"
16488 #: ../fish/guestfish.pod:340
16490 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
16495 #: ../fish/guestfish.pod:343
16500 #: ../fish/guestfish.pod:345
16501 msgid "Echo each command before executing it."
16505 #: ../fish/guestfish.pod:349
16506 msgid "COMMANDS ON COMMAND LINE"
16510 #: ../fish/guestfish.pod:351
16511 msgid "Any additional (non-option) arguments are treated as commands to execute."
16515 #: ../fish/guestfish.pod:354
16517 "Commands to execute should be separated by a colon (C<:>), where the colon "
16518 "is a separate parameter. Thus:"
16522 #: ../fish/guestfish.pod:357
16525 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
16530 #: ../fish/guestfish.pod:359
16532 "If there are no additional arguments, then we enter a shell, either an "
16533 "interactive shell with a prompt (if the input is a terminal) or a "
16534 "non-interactive shell."
16538 #: ../fish/guestfish.pod:363
16540 "In either command line mode or non-interactive shell, the first command that "
16541 "gives an error causes the whole shell to exit. In interactive mode (with a "
16542 "prompt) if a command fails, you can continue to enter commands."
16546 #: ../fish/guestfish.pod:368
16547 msgid "USING launch (OR run)"
16551 #: ../fish/guestfish.pod:370
16553 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
16554 "then launch it, then mount any disks you need, and finally issue "
16555 "actions/commands. So the general order of the day is:"
16559 #: ../fish/guestfish.pod:378
16560 msgid "add or -a/--add"
16564 #: ../fish/guestfish.pod:382
16565 msgid "launch (aka run)"
16569 #: ../fish/guestfish.pod:386
16570 msgid "mount or -m/--mount"
16574 #: ../fish/guestfish.pod:390
16575 msgid "any other commands"
16579 #: ../fish/guestfish.pod:394
16581 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
16582 "guest before mounting or performing any other commands."
16586 #: ../fish/guestfish.pod:397
16588 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
16589 "I<--new> options were given then C<run> is done automatically, simply "
16590 "because guestfish can't perform the action you asked for without doing this."
16594 #: ../fish/guestfish.pod:402
16595 msgid "OPENING DISKS FOR READ AND WRITE"
16599 #: ../fish/guestfish.pod:404
16601 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
16602 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
16603 "open disk images read-only or for writing."
16607 #: ../fish/guestfish.pod:408
16609 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
16610 "disk images supplied on the command line for write. To open a disk image "
16611 "read-only you have to do I<-a image --ro>."
16615 #: ../fish/guestfish.pod:412
16617 "This matters: If you accidentally open a live VM disk image writable then "
16618 "you will cause irreversible disk corruption."
16622 #: ../fish/guestfish.pod:415
16624 "By libguestfs 1.8 we intend to change the default the other way. Disk "
16625 "images will be opened read-only. You will have to either specify "
16626 "I<guestfish --rw> or change a configuration file in order to get write "
16627 "access for disk images specified by those other command line options."
16631 #: ../fish/guestfish.pod:420
16633 "This version of guestfish has a I<--rw> option which does nothing (it is "
16634 "already the default). However it is highly recommended that you use this "
16635 "option to indicate that guestfish needs write access, and to prepare your "
16636 "scripts for the day when this option will be required for write access."
16640 #: ../fish/guestfish.pod:426
16642 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
16643 "other libguestfs program apart from guestfish and guestmount."
16647 #: ../fish/guestfish.pod:429
16652 #: ../fish/guestfish.pod:431
16654 "You can quote ordinary parameters using either single or double quotes. For "
16659 #: ../fish/guestfish.pod:434
16662 " add \"file with a space.img\"\n"
16667 #: ../fish/guestfish.pod:436
16670 " rm '/file name'\n"
16675 #: ../fish/guestfish.pod:438
16683 #: ../fish/guestfish.pod:440
16685 "A few commands require a list of strings to be passed. For these, use a "
16686 "whitespace-separated list, enclosed in quotes. Strings containing "
16687 "whitespace to be passed through must be enclosed in single quotes. A "
16688 "literal single quote must be escaped with a backslash."
16692 #: ../fish/guestfish.pod:445
16695 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
16696 " command \"/bin/echo 'foo bar'\"\n"
16697 " command \"/bin/echo \\'foo\\'\"\n"
16702 #: ../fish/guestfish.pod:449
16703 msgid "OPTIONAL ARGUMENTS"
16707 #: ../fish/guestfish.pod:451
16709 "Some commands take optional arguments. These arguments appear in this "
16710 "documentation as C<[argname:..]>. You can use them as in these examples:"
16714 #: ../fish/guestfish.pod:455
16717 " add-drive-opts filename\n"
16722 #: ../fish/guestfish.pod:457
16725 " add-drive-opts filename readonly:true\n"
16730 #: ../fish/guestfish.pod:459
16733 " add-drive-opts filename format:qcow2 readonly:false\n"
16738 #: ../fish/guestfish.pod:461
16740 "Each optional argument can appear at most once. All optional arguments must "
16741 "appear after the required ones."
16745 #: ../fish/guestfish.pod:464
16750 #: ../fish/guestfish.pod:466
16751 msgid "This section applies to all commands which can take integers as parameters."
16755 #: ../fish/guestfish.pod:469
16756 msgid "SIZE SUFFIX"
16760 #: ../fish/guestfish.pod:471
16762 "When the command takes a parameter measured in bytes, you can use one of the "
16763 "following suffixes to specify kilobytes, megabytes and larger sizes:"
16767 #: ../fish/guestfish.pod:477
16768 msgid "B<k> or B<K> or B<KiB>"
16772 #: ../fish/guestfish.pod:479
16773 msgid "The size in kilobytes (multiplied by 1024)."
16777 #: ../fish/guestfish.pod:481
16782 #: ../fish/guestfish.pod:483
16783 msgid "The size in SI 1000 byte units."
16787 #: ../fish/guestfish.pod:485
16788 msgid "B<M> or B<MiB>"
16792 #: ../fish/guestfish.pod:487
16793 msgid "The size in megabytes (multiplied by 1048576)."
16797 #: ../fish/guestfish.pod:489
16802 #: ../fish/guestfish.pod:491
16803 msgid "The size in SI 1000000 byte units."
16807 #: ../fish/guestfish.pod:493
16808 msgid "B<G> or B<GiB>"
16812 #: ../fish/guestfish.pod:495
16813 msgid "The size in gigabytes (multiplied by 2**30)."
16817 #: ../fish/guestfish.pod:497
16822 #: ../fish/guestfish.pod:499
16823 msgid "The size in SI 10**9 byte units."
16827 #: ../fish/guestfish.pod:501
16828 msgid "B<T> or B<TiB>"
16832 #: ../fish/guestfish.pod:503
16833 msgid "The size in terabytes (multiplied by 2**40)."
16837 #: ../fish/guestfish.pod:505
16842 #: ../fish/guestfish.pod:507
16843 msgid "The size in SI 10**12 byte units."
16847 #: ../fish/guestfish.pod:509
16848 msgid "B<P> or B<PiB>"
16852 #: ../fish/guestfish.pod:511
16853 msgid "The size in petabytes (multiplied by 2**50)."
16857 #: ../fish/guestfish.pod:513
16862 #: ../fish/guestfish.pod:515
16863 msgid "The size in SI 10**15 byte units."
16867 #: ../fish/guestfish.pod:517
16868 msgid "B<E> or B<EiB>"
16872 #: ../fish/guestfish.pod:519
16873 msgid "The size in exabytes (multiplied by 2**60)."
16877 #: ../fish/guestfish.pod:521
16882 #: ../fish/guestfish.pod:523
16883 msgid "The size in SI 10**18 byte units."
16887 #: ../fish/guestfish.pod:525
16888 msgid "B<Z> or B<ZiB>"
16892 #: ../fish/guestfish.pod:527
16893 msgid "The size in zettabytes (multiplied by 2**70)."
16897 #: ../fish/guestfish.pod:529
16902 #: ../fish/guestfish.pod:531
16903 msgid "The size in SI 10**21 byte units."
16907 #: ../fish/guestfish.pod:533
16908 msgid "B<Y> or B<YiB>"
16912 #: ../fish/guestfish.pod:535
16913 msgid "The size in yottabytes (multiplied by 2**80)."
16917 #: ../fish/guestfish.pod:537
16922 #: ../fish/guestfish.pod:539
16923 msgid "The size in SI 10**24 byte units."
16927 #: ../fish/guestfish.pod:545
16930 " truncate-size /file 1G\n"
16935 #: ../fish/guestfish.pod:547
16936 msgid "would truncate the file to 1 gigabyte."
16940 #: ../fish/guestfish.pod:549
16942 "Be careful because a few commands take sizes in kilobytes or megabytes "
16943 "(eg. the parameter to L</memsize> is specified in megabytes already). "
16944 "Adding a suffix will probably not do what you expect."
16948 #: ../fish/guestfish.pod:553
16949 msgid "OCTAL AND HEXADECIMAL NUMBERS"
16953 #: ../fish/guestfish.pod:555
16955 "For specifying the radix (base) use the C convention: C<0> to prefix an "
16956 "octal number or C<0x> to prefix a hexadecimal number. For example:"
16960 #: ../fish/guestfish.pod:558
16963 " 1234 decimal number 1234\n"
16964 " 02322 octal number, equivalent to decimal 1234\n"
16965 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
16970 #: ../fish/guestfish.pod:562
16972 "When using the C<chmod> command, you almost always want to specify an octal "
16973 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
16974 "L<chmod(1)> program):"
16978 #: ../fish/guestfish.pod:566
16981 " chmod 0777 /public # OK\n"
16982 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
16987 #: ../fish/guestfish.pod:569
16989 "Commands that return numbers usually print them in decimal, but some "
16990 "commands print numbers in other radices (eg. C<umask> prints the mode in "
16991 "octal, preceeded by C<0>)."
16995 #: ../fish/guestfish.pod:573
16996 msgid "WILDCARDS AND GLOBBING"
17000 #: ../fish/guestfish.pod:575
17002 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
17003 "(globbing) by default. So for example the following will not do what you "
17008 #: ../fish/guestfish.pod:579
17016 #: ../fish/guestfish.pod:581
17018 "Assuming you don't have a directory called literally C</home/*> then the "
17019 "above command will return an error."
17023 #: ../fish/guestfish.pod:584
17024 msgid "To perform wildcard expansion, use the C<glob> command."
17028 #: ../fish/guestfish.pod:586
17031 " glob rm-rf /home/*\n"
17036 #: ../fish/guestfish.pod:588
17038 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
17039 "many times), equivalent to:"
17043 #: ../fish/guestfish.pod:591
17046 " rm-rf /home/jim\n"
17047 " rm-rf /home/joe\n"
17048 " rm-rf /home/mary\n"
17053 #: ../fish/guestfish.pod:595
17054 msgid "C<glob> only works on simple guest paths and not on device names."
17058 #: ../fish/guestfish.pod:597
17060 "If you have several parameters, each containing a wildcard, then glob will "
17061 "perform a Cartesian product."
17065 #: ../fish/guestfish.pod:600
17070 #: ../fish/guestfish.pod:602
17072 "Any line which starts with a I<#> character is treated as a comment and "
17073 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
17074 "a command. For example:"
17078 #: ../fish/guestfish.pod:606
17081 " # this is a comment\n"
17082 " # this is a comment\n"
17083 " foo # NOT a comment\n"
17088 #: ../fish/guestfish.pod:610
17089 msgid "Blank lines are also ignored."
17093 #: ../fish/guestfish.pod:612
17094 msgid "RUNNING COMMANDS LOCALLY"
17098 #: ../fish/guestfish.pod:614
17100 "Any line which starts with a I<!> character is treated as a command sent to "
17101 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
17105 #: ../fish/guestfish.pod:618
17109 " tgz-out /remote local/remote-data.tar.gz\n"
17114 #: ../fish/guestfish.pod:621
17116 "will create a directory C<local> on the host, and then export the contents "
17117 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17118 "(See C<tgz-out>)."
17122 #: ../fish/guestfish.pod:625
17124 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17125 "effect, due to the way that subprocesses work in Unix."
17129 #: ../fish/guestfish.pod:628
17134 #: ../fish/guestfish.pod:630
17136 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17137 "command (a guestfish command) to the second command (any host command). For "
17142 #: ../fish/guestfish.pod:634
17145 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17150 #: ../fish/guestfish.pod:636
17152 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17153 "program). The above command would list all accounts in the guest filesystem "
17154 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17158 #: ../fish/guestfish.pod:641
17161 " hexdump /bin/ls | head\n"
17162 " list-devices | tail -1\n"
17163 " tgz-out / - | tar ztf -\n"
17168 #: ../fish/guestfish.pod:645
17170 "The space before the pipe symbol is required, any space after the pipe "
17171 "symbol is optional. Everything after the pipe symbol is just passed "
17172 "straight to the host shell, so it can contain redirections, globs and "
17173 "anything else that makes sense on the host side."
17177 #: ../fish/guestfish.pod:650
17179 "To use a literal argument which begins with a pipe symbol, you have to quote "
17184 #: ../fish/guestfish.pod:653
17192 #: ../fish/guestfish.pod:655
17193 msgid "HOME DIRECTORIES"
17197 #: ../fish/guestfish.pod:657
17199 "If a parameter starts with the character C<~> then the tilde may be expanded "
17200 "as a home directory path (either C<~> for the current user's home directory, "
17201 "or C<~user> for another user)."
17205 #: ../fish/guestfish.pod:661
17207 "Note that home directory expansion happens for users known I<on the host>, "
17208 "not in the guest filesystem."
17212 #: ../fish/guestfish.pod:664
17214 "To use a literal argument which begins with a tilde, you have to quote it, "
17219 #: ../fish/guestfish.pod:667
17227 #: ../fish/guestfish.pod:671
17229 "Libguestfs has some support for Linux guests encrypted according to the "
17230 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17231 "disk encryption systems used by modern Linux guests. Currently only "
17232 "LVM-on-LUKS is supported."
17236 #: ../fish/guestfish.pod:676
17237 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17241 #: ../fish/guestfish.pod:678
17244 " ><fs> vfs-type /dev/sda2\n"
17250 #: ../fish/guestfish.pod:681
17252 "Then open those devices using L</luks-open>. This creates a device-mapper "
17253 "device called C</dev/mapper/luksdev>."
17257 #: ../fish/guestfish.pod:684
17260 " ><fs> luks-open /dev/sda2 luksdev\n"
17261 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17266 #: ../fish/guestfish.pod:687
17268 "Finally you have to tell LVM to scan for volume groups on the newly created "
17273 #: ../fish/guestfish.pod:690
17277 " vg-activate-all true\n"
17282 #: ../fish/guestfish.pod:693
17283 msgid "The logical volume(s) can now be mounted in the usual way."
17287 #: ../fish/guestfish.pod:695
17289 "Before closing a LUKS device you must unmount any logical volumes on it and "
17290 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17291 "one. Then you can close the mapper device:"
17295 #: ../fish/guestfish.pod:699
17298 " vg-activate false /dev/VG\n"
17299 " luks-close /dev/mapper/luksdev\n"
17304 #: ../fish/guestfish.pod:702
17305 msgid "WINDOWS PATHS"
17309 #: ../fish/guestfish.pod:704
17311 "If a path is prefixed with C<win:> then you can use Windows-style paths "
17312 "(with some limitations). The following commands are equivalent:"
17316 #: ../fish/guestfish.pod:707
17319 " file /WINDOWS/system32/config/system.LOG\n"
17324 #: ../fish/guestfish.pod:709
17327 " file win:/windows/system32/config/system.log\n"
17332 #: ../fish/guestfish.pod:711
17335 " file win:\\windows\\system32\\config\\system.log\n"
17340 #: ../fish/guestfish.pod:713
17343 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
17348 #: ../fish/guestfish.pod:715
17350 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
17351 "handles case insensitivity like Windows would. This only works in argument "
17352 "positions that expect a path."
17356 #: ../fish/guestfish.pod:719
17357 msgid "UPLOADING AND DOWNLOADING FILES"
17361 #: ../fish/guestfish.pod:721
17363 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
17364 "others which upload from or download to a local file, you can use the "
17365 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
17369 #: ../fish/guestfish.pod:725
17377 #: ../fish/guestfish.pod:727
17378 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
17382 #: ../fish/guestfish.pod:730
17385 " tar-out /etc - | tar tf -\n"
17390 #: ../fish/guestfish.pod:732
17392 "writes the tarball to stdout and then pipes that into the external \"tar\" "
17393 "command (see L</PIPES>)."
17397 #: ../fish/guestfish.pod:735
17399 "When using C<-> to read from stdin, the input is read up to the end of "
17400 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
17401 "some arbitrary end marker:"
17405 #: ../fish/guestfish.pod:739
17408 " upload -<<END /foo\n"
17417 #: ../fish/guestfish.pod:745
17419 "Any string of characters can be used instead of C<END>. The end marker must "
17420 "appear on a line of its own, without any preceeding or following characters "
17421 "(not even spaces)."
17425 #: ../fish/guestfish.pod:749
17427 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
17428 "upload local files (so-called \"FileIn\" parameters in the generator)."
17432 #: ../fish/guestfish.pod:752
17433 msgid "EXIT ON ERROR BEHAVIOUR"
17437 #: ../fish/guestfish.pod:754
17439 "By default, guestfish will ignore any errors when in interactive mode "
17440 "(ie. taking commands from a human over a tty), and will exit on the first "
17441 "error in non-interactive mode (scripts, commands given on the command line)."
17445 #: ../fish/guestfish.pod:759
17447 "If you prefix a command with a I<-> character, then that command will not "
17448 "cause guestfish to exit, even if that (one) command returns an error."
17452 #: ../fish/guestfish.pod:763
17453 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
17457 #: ../fish/guestfish.pod:765
17459 "Guestfish can be remote-controlled over a socket. This is useful "
17460 "particularly in shell scripts where you want to make several different "
17461 "changes to a filesystem, but you don't want the overhead of starting up a "
17462 "guestfish process each time."
17466 #: ../fish/guestfish.pod:770
17467 msgid "Start a guestfish server process using:"
17471 #: ../fish/guestfish.pod:772
17474 " eval \"`guestfish --listen`\"\n"
17479 #: ../fish/guestfish.pod:774
17480 msgid "and then send it commands by doing:"
17484 #: ../fish/guestfish.pod:776
17487 " guestfish --remote cmd [...]\n"
17492 #: ../fish/guestfish.pod:778
17493 msgid "To cause the server to exit, send it the exit command:"
17497 #: ../fish/guestfish.pod:780
17500 " guestfish --remote exit\n"
17505 #: ../fish/guestfish.pod:782
17507 "Note that the server will normally exit if there is an error in a command. "
17508 "You can change this in the usual way. See section L</EXIT ON ERROR "
17513 #: ../fish/guestfish.pod:786
17514 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
17518 #: ../fish/guestfish.pod:788
17520 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
17521 "is how the I<--remote> option knows where to send the commands. You can "
17522 "have several guestfish listener processes running using:"
17526 #: ../fish/guestfish.pod:792
17529 " eval \"`guestfish --listen`\"\n"
17530 " pid1=$GUESTFISH_PID\n"
17531 " eval \"`guestfish --listen`\"\n"
17532 " pid2=$GUESTFISH_PID\n"
17534 " guestfish --remote=$pid1 cmd\n"
17535 " guestfish --remote=$pid2 cmd\n"
17540 #: ../fish/guestfish.pod:800
17541 msgid "REMOTE CONTROL AND CSH"
17545 #: ../fish/guestfish.pod:802
17547 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
17552 #: ../fish/guestfish.pod:805
17555 " eval \"`guestfish --listen --csh`\"\n"
17560 #: ../fish/guestfish.pod:807
17561 msgid "REMOTE CONTROL DETAILS"
17565 #: ../fish/guestfish.pod:809
17567 "Remote control happens over a Unix domain socket called "
17568 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
17569 "of the process, and C<$PID> is the process ID of the server."
17573 #: ../fish/guestfish.pod:813
17574 msgid "Guestfish client and server versions must match exactly."
17578 #: ../fish/guestfish.pod:815
17579 msgid "PREPARED DISK IMAGES"
17583 #: ../fish/guestfish.pod:817
17585 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
17586 "preformatted disk images that guestfish can make for you to save typing. "
17587 "This is particularly useful for testing purposes. This option is used "
17588 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
17589 "can be mixed with I<-a>)."
17593 #: ../fish/guestfish.pod:823
17595 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
17596 "the second and so on. Existing files in the current directory are "
17601 #: ../fish/guestfish.pod:827
17603 "The type briefly describes how the disk should be sized, partitioned, how "
17604 "filesystem(s) should be created, and how content should be added. "
17605 "Optionally the type can be followed by extra parameters, separated by C<:> "
17606 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
17607 "sparsely-allocated disk, containing a single partition, with the partition "
17608 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
17609 "on a 1GB disk instead."
17613 #: ../fish/guestfish.pod:835
17614 msgid "To list the available types and any extra parameters they take, run:"
17618 #: ../fish/guestfish.pod:839
17620 "Note that the prepared filesystem is not mounted. You would usually have to "
17621 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
17625 #: ../fish/guestfish.pod:843
17627 "If any I<-N> or I<--new> options are given, the guest is automatically "
17632 #: ../fish/guestfish.pod:848
17633 msgid "Create a 100MB disk with an ext4-formatted partition:"
17637 #: ../fish/guestfish.pod:850
17640 " guestfish -N fs:ext4\n"
17645 #: ../fish/guestfish.pod:852
17646 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
17650 #: ../fish/guestfish.pod:854
17653 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
17658 #: ../fish/guestfish.pod:856
17659 msgid "Create a blank 200MB disk:"
17663 #: ../fish/guestfish.pod:858
17666 " guestfish -N disk:200M\n"
17671 #: ../fish/guestfish.pod:860
17672 msgid "PROGRESS BARS"
17676 #: ../fish/guestfish.pod:862
17678 "Some (not all) long-running commands send progress notification messages as "
17679 "they are running. Guestfish turns these messages into progress bars."
17683 #: ../fish/guestfish.pod:866
17685 "When a command that supports progress bars takes longer than two seconds to "
17686 "run, and if progress bars are enabled, then you will see one appearing below "
17691 #: ../fish/guestfish.pod:870
17694 " ><fs> copy-size /large-file /another-file 2048M\n"
17695 " / 10% [#####-----------------------------------------] 00:30\n"
17700 #: ../fish/guestfish.pod:873
17702 "The spinner on the left hand side moves round once for every progress "
17703 "notification received from the backend. This is a (reasonably) golden "
17704 "assurance that the command is \"doing something\" even if the progress bar "
17705 "is not moving, because the command is able to send the progress "
17706 "notifications. When the bar reaches 100% and the command finishes, the "
17707 "spinner disappears."
17711 #: ../fish/guestfish.pod:880
17713 "Progress bars are enabled by default when guestfish is used interactively. "
17714 "You can enable them even for non-interactive modes using I<--progress-bars>, "
17715 "and you can disable them completely using I<--no-progress-bars>."
17719 #: ../fish/guestfish.pod:885
17720 msgid "GUESTFISH COMMANDS"
17724 #: ../fish/guestfish.pod:887
17726 "The commands in this section are guestfish convenience commands, in other "
17727 "words, they are not part of the L<guestfs(3)> API."
17731 #: ../fish/guestfish.pod:890
17736 #: ../fish/guestfish.pod:892
17745 #: ../fish/guestfish.pod:895
17746 msgid "Without any parameter, this provides general help."
17750 #: ../fish/guestfish.pod:897
17751 msgid "With a C<cmd> parameter, this displays detailed help for that command."
17755 #: ../fish/guestfish.pod:899
17756 msgid "quit | exit"
17760 #: ../fish/guestfish.pod:901
17761 msgid "This exits guestfish. You can also use C<^D> key."
17765 #: ../fish/guestfish.pod:903
17766 msgid "@FISH_COMMANDS@"
17770 #: ../fish/guestfish.pod:905
17775 #: ../fish/guestfish.pod:909 ../test-tool/libguestfs-test-tool.pod:83
17780 #: ../fish/guestfish.pod:911
17782 "guestfish returns 0 if the commands completed without error, or 1 if there "
17787 #: ../fish/guestfish.pod:918
17792 #: ../fish/guestfish.pod:920
17794 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
17799 #: ../fish/guestfish.pod:923
17800 msgid "GUESTFISH_PID"
17804 #: ../fish/guestfish.pod:925
17806 "Used with the I<--remote> option to specify the remote guestfish process to "
17807 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
17811 #: ../fish/guestfish.pod:929
17816 #: ../fish/guestfish.pod:931
17818 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
17819 "not specified, the external L<hexedit(1)> program is used."
17823 #: ../fish/guestfish.pod:935
17828 #: ../fish/guestfish.pod:937
17830 "If compiled with GNU readline support, various files in the home directory "
17831 "can be used. See L</FILES>."
17835 #: ../fish/guestfish.pod:946
17837 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
17838 "effect as using the B<-v> option."
17842 #: ../fish/guestfish.pod:958
17844 "Set the path that guestfish uses to search for kernel and initrd.img. See "
17845 "the discussion of paths in L<guestfs(3)>."
17849 #: ../fish/guestfish.pod:969
17850 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
17854 #: ../fish/guestfish.pod:971
17859 #: ../fish/guestfish.pod:973
17861 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
17866 #: ../fish/guestfish.pod:988 ../test-tool/libguestfs-test-tool.pod:88
17871 #: ../fish/guestfish.pod:992
17872 msgid "$HOME/.guestfish"
17876 #: ../fish/guestfish.pod:994
17878 "If compiled with GNU readline support, then the command history is saved in "
17883 #: ../fish/guestfish.pod:997
17884 msgid "$HOME/.inputrc"
17888 #: ../fish/guestfish.pod:999
17889 msgid "/etc/inputrc"
17893 #: ../fish/guestfish.pod:1001
17895 "If compiled with GNU readline support, then these files can be used to "
17896 "configure readline. For further information, please see "
17897 "L<readline(3)/INITIALIZATION FILE>."
17901 #: ../fish/guestfish.pod:1005
17902 msgid "To write rules which only apply to guestfish, use:"
17906 #: ../fish/guestfish.pod:1007
17916 #: ../fish/guestfish.pod:1011
17918 "Variables that you can set in inputrc that change the behaviour of guestfish "
17919 "in useful ways include:"
17923 #: ../fish/guestfish.pod:1016
17924 msgid "completion-ignore-case (default: on)"
17928 #: ../fish/guestfish.pod:1018
17930 "By default, guestfish will ignore case when tab-completing paths on the "
17935 #: ../fish/guestfish.pod:1021
17938 " set completion-ignore-case off\n"
17943 #: ../fish/guestfish.pod:1023
17944 msgid "to make guestfish case sensitive."
17948 #: ../fish/guestfish.pod:1027
17953 #: ../fish/guestfish.pod:1029
17954 msgid "test2.img (etc)"
17958 #: ../fish/guestfish.pod:1031
17960 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
17961 "will be created in the file C<test1.img> in the current directory. The "
17962 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
17963 "the same name will be overwritten."
17967 #: ../fish/guestfish.pod:1040
17969 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
17970 "L<virt-edit(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, "
17971 "L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, "
17972 "L<virt-tar(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
17976 #: ../fish/guestfish.pod:1064 ../test-tool/libguestfs-test-tool.pod:124 ../fuse/guestmount.pod:253 ../inspector/virt-inspector.pl:598 ../tools/virt-edit.pl:370 ../tools/virt-win-reg.pl:518 ../tools/virt-df.pl:657 ../tools/virt-ls.pl:251 ../tools/virt-resize.pl:1516 ../tools/virt-list-filesystems.pl:206 ../tools/virt-cat.pl:203 ../tools/virt-tar.pl:300 ../tools/virt-rescue.pl:285 ../tools/virt-make-fs.pl:567 ../tools/virt-list-partitions.pl:273
17978 "This program is free software; you can redistribute it and/or modify it "
17979 "under the terms of the GNU General Public License as published by the Free "
17980 "Software Foundation; either version 2 of the License, or (at your option) "
17981 "any later version."
17985 #: ../fish/guestfish.pod:1069 ../test-tool/libguestfs-test-tool.pod:129 ../fuse/guestmount.pod:258 ../inspector/virt-inspector.pl:603 ../tools/virt-edit.pl:375 ../tools/virt-win-reg.pl:523 ../tools/virt-df.pl:662 ../tools/virt-ls.pl:256 ../tools/virt-resize.pl:1521 ../tools/virt-list-filesystems.pl:211 ../tools/virt-cat.pl:208 ../tools/virt-tar.pl:305 ../tools/virt-rescue.pl:290 ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:278
17987 "This program is distributed in the hope that it will be useful, but WITHOUT "
17988 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
17989 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
17994 #: ../fish/guestfish.pod:1074 ../test-tool/libguestfs-test-tool.pod:134 ../fuse/guestmount.pod:263 ../inspector/virt-inspector.pl:608 ../tools/virt-edit.pl:380 ../tools/virt-win-reg.pl:528 ../tools/virt-df.pl:667 ../tools/virt-ls.pl:261 ../tools/virt-resize.pl:1526 ../tools/virt-list-filesystems.pl:216 ../tools/virt-cat.pl:213 ../tools/virt-tar.pl:310 ../tools/virt-rescue.pl:295 ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:283
17996 "You should have received a copy of the GNU General Public License along with "
17997 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
17998 "Ave, Cambridge, MA 02139, USA."
18002 #: ../fish/guestfish-actions.pod:1
18007 #: ../fish/guestfish-actions.pod:3
18010 " add-cdrom filename\n"
18015 #: ../fish/guestfish-actions.pod:15
18017 "This call checks for the existence of C<filename>. This stops you from "
18018 "specifying other types of drive which are supported by qemu such as C<nbd:> "
18019 "and C<http:> URLs. To specify those, use the general L</config> call "
18024 #: ../fish/guestfish-actions.pod:22
18026 "If you just want to add an ISO file (often you use this as an efficient way "
18027 "to transfer large files into the guest), then you should probably use "
18028 "L</add-drive-ro> instead."
18032 #: ../fish/guestfish-actions.pod:35
18037 #: ../fish/guestfish-actions.pod:37
18040 " add-drive filename\n"
18045 #: ../fish/guestfish-actions.pod:39
18047 "This function is the equivalent of calling L</add-drive-opts> with no "
18048 "optional parameters, so the disk is added writable, with the format being "
18049 "detected automatically."
18053 #: ../fish/guestfish-actions.pod:43
18055 "Automatic detection of the format opens you up to a potential security hole "
18056 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
18057 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
18058 "you should think about replacing calls to this function with calls to "
18059 "L</add-drive-opts>, and specifying the format."
18063 #: ../fish/guestfish-actions.pod:50
18064 msgid "add-drive-opts"
18068 #: ../fish/guestfish-actions.pod:52
18073 #: ../fish/guestfish-actions.pod:54
18076 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
18081 #: ../fish/guestfish-actions.pod:81
18083 "This forces the image format. If you omit this (or use L</add-drive> or "
18084 "L</add-drive-ro>) then the format is automatically detected. Possible "
18085 "formats include C<raw> and C<qcow2>."
18089 #: ../fish/guestfish-actions.pod:92
18091 "This rarely-used option lets you emulate the behaviour of the deprecated "
18092 "L</add-drive-with-if> call (q.v.)"
18096 #: ../fish/guestfish-actions.pod:97
18098 "This command has one or more optional arguments. See L</OPTIONAL "
18103 #: ../fish/guestfish-actions.pod:99
18104 msgid "add-drive-ro"
18108 #: ../fish/guestfish-actions.pod:101
18113 #: ../fish/guestfish-actions.pod:103
18116 " add-drive-ro filename\n"
18121 #: ../fish/guestfish-actions.pod:105
18123 "This function is the equivalent of calling L</add-drive-opts> with the "
18124 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
18125 "is added read-only, with the format being detected automatically."
18129 #: ../fish/guestfish-actions.pod:110
18130 msgid "add-drive-ro-with-if"
18134 #: ../fish/guestfish-actions.pod:112
18137 " add-drive-ro-with-if filename iface\n"
18142 #: ../fish/guestfish-actions.pod:114
18144 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
18145 "interface emulation to use at run time."
18149 #: ../fish/guestfish-actions.pod:124
18150 msgid "add-drive-with-if"
18154 #: ../fish/guestfish-actions.pod:126
18157 " add-drive-with-if filename iface\n"
18162 #: ../fish/guestfish-actions.pod:128
18164 "This is the same as L</add-drive> but it allows you to specify the QEMU "
18165 "interface emulation to use at run time."
18169 #: ../fish/guestfish-actions.pod:138
18174 #: ../fish/guestfish-actions.pod:140
18177 " aug-clear augpath\n"
18182 #: ../fish/guestfish-actions.pod:145
18187 #: ../fish/guestfish-actions.pod:147
18195 #: ../fish/guestfish-actions.pod:149
18197 "Close the current Augeas handle and free up any resources used by it. After "
18198 "calling this, you have to call L</aug-init> again before you can use any "
18199 "other Augeas functions."
18203 #: ../fish/guestfish-actions.pod:154
18204 msgid "aug-defnode"
18208 #: ../fish/guestfish-actions.pod:156
18211 " aug-defnode name expr val\n"
18216 #: ../fish/guestfish-actions.pod:161
18218 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
18219 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
18220 "containing that single node."
18224 #: ../fish/guestfish-actions.pod:169
18229 #: ../fish/guestfish-actions.pod:171
18232 " aug-defvar name expr\n"
18237 #: ../fish/guestfish-actions.pod:180
18242 #: ../fish/guestfish-actions.pod:182
18245 " aug-get augpath\n"
18250 #: ../fish/guestfish-actions.pod:187
18255 #: ../fish/guestfish-actions.pod:189
18258 " aug-init root flags\n"
18263 #: ../fish/guestfish-actions.pod:195
18264 msgid "You must call this before using any other L</aug-*> commands."
18268 #: ../fish/guestfish-actions.pod:230
18269 msgid "Do not load the tree in L</aug-init>."
18273 #: ../fish/guestfish-actions.pod:234
18274 msgid "To close the handle, you can call L</aug-close>."
18278 #: ../fish/guestfish-actions.pod:238
18283 #: ../fish/guestfish-actions.pod:240
18286 " aug-insert augpath label true|false\n"
18291 #: ../fish/guestfish-actions.pod:250
18296 #: ../fish/guestfish-actions.pod:252
18304 #: ../fish/guestfish-actions.pod:259
18309 #: ../fish/guestfish-actions.pod:261
18312 " aug-ls augpath\n"
18317 #: ../fish/guestfish-actions.pod:263
18319 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
18320 "resulting nodes into alphabetical order."
18324 #: ../fish/guestfish-actions.pod:266
18329 #: ../fish/guestfish-actions.pod:268
18332 " aug-match augpath\n"
18337 #: ../fish/guestfish-actions.pod:274
18342 #: ../fish/guestfish-actions.pod:276
18345 " aug-mv src dest\n"
18350 #: ../fish/guestfish-actions.pod:281
18355 #: ../fish/guestfish-actions.pod:283
18358 " aug-rm augpath\n"
18363 #: ../fish/guestfish-actions.pod:289
18368 #: ../fish/guestfish-actions.pod:291
18376 #: ../fish/guestfish-actions.pod:295
18378 "The flags which were passed to L</aug-init> affect exactly how files are "
18383 #: ../fish/guestfish-actions.pod:298
18388 #: ../fish/guestfish-actions.pod:300
18391 " aug-set augpath val\n"
18396 #: ../fish/guestfish-actions.pod:304
18398 "In the Augeas API, it is possible to clear a node by setting the value to "
18399 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
18400 "this call. Instead you must use the L</aug-clear> call."
18404 #: ../fish/guestfish-actions.pod:309
18409 #: ../fish/guestfish-actions.pod:311
18412 " available 'groups ...'\n"
18417 #: ../fish/guestfish-actions.pod:317
18419 "The libguestfs groups, and the functions that those groups correspond to, "
18420 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
18421 "runtime by calling L</available-all-groups>."
18425 #: ../fish/guestfish-actions.pod:341
18426 msgid "You must call L</launch> before calling this function."
18430 #: ../fish/guestfish-actions.pod:363
18432 "This call was added in version C<1.0.80>. In previous versions of "
18433 "libguestfs all you could do would be to speculatively execute a command to "
18434 "find out if the daemon implemented it. See also L</version>."
18438 #: ../fish/guestfish-actions.pod:370
18439 msgid "available-all-groups"
18443 #: ../fish/guestfish-actions.pod:372
18446 " available-all-groups\n"
18451 #: ../fish/guestfish-actions.pod:374
18453 "This command returns a list of all optional groups that this daemon knows "
18454 "about. Note this returns both supported and unsupported groups. To find "
18455 "out which ones the daemon can actually support you have to call "
18456 "L</available> on each member of the returned list."
18460 #: ../fish/guestfish-actions.pod:380
18461 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
18465 #: ../fish/guestfish-actions.pod:382
18470 #: ../fish/guestfish-actions.pod:384
18473 " base64-in (base64file|-) filename\n"
18478 #: ../fish/guestfish-actions.pod:389 ../fish/guestfish-actions.pod:398 ../fish/guestfish-actions.pod:622 ../fish/guestfish-actions.pod:769 ../fish/guestfish-actions.pod:816 ../fish/guestfish-actions.pod:835 ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:3945 ../fish/guestfish-actions.pod:3957 ../fish/guestfish-actions.pod:3968 ../fish/guestfish-actions.pod:3979 ../fish/guestfish-actions.pod:4031 ../fish/guestfish-actions.pod:4040 ../fish/guestfish-actions.pod:4094 ../fish/guestfish-actions.pod:4117
18479 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
18483 #: ../fish/guestfish-actions.pod:391
18488 #: ../fish/guestfish-actions.pod:393
18491 " base64-out filename (base64file|-)\n"
18496 #: ../fish/guestfish-actions.pod:400
18497 msgid "blockdev-flushbufs"
18501 #: ../fish/guestfish-actions.pod:402
18504 " blockdev-flushbufs device\n"
18509 #: ../fish/guestfish-actions.pod:409
18510 msgid "blockdev-getbsz"
18514 #: ../fish/guestfish-actions.pod:411
18517 " blockdev-getbsz device\n"
18522 #: ../fish/guestfish-actions.pod:420
18523 msgid "blockdev-getro"
18527 #: ../fish/guestfish-actions.pod:422
18530 " blockdev-getro device\n"
18535 #: ../fish/guestfish-actions.pod:429
18536 msgid "blockdev-getsize64"
18540 #: ../fish/guestfish-actions.pod:431
18543 " blockdev-getsize64 device\n"
18548 #: ../fish/guestfish-actions.pod:435
18549 msgid "See also L</blockdev-getsz>."
18553 #: ../fish/guestfish-actions.pod:439
18554 msgid "blockdev-getss"
18558 #: ../fish/guestfish-actions.pod:441
18561 " blockdev-getss device\n"
18566 #: ../fish/guestfish-actions.pod:446
18567 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
18571 #: ../fish/guestfish-actions.pod:451
18572 msgid "blockdev-getsz"
18576 #: ../fish/guestfish-actions.pod:453
18579 " blockdev-getsz device\n"
18584 #: ../fish/guestfish-actions.pod:458
18586 "See also L</blockdev-getss> for the real sector size of the device, and "
18587 "L</blockdev-getsize64> for the more useful I<size in bytes>."
18591 #: ../fish/guestfish-actions.pod:464
18592 msgid "blockdev-rereadpt"
18596 #: ../fish/guestfish-actions.pod:466
18599 " blockdev-rereadpt device\n"
18604 #: ../fish/guestfish-actions.pod:472
18605 msgid "blockdev-setbsz"
18609 #: ../fish/guestfish-actions.pod:474
18612 " blockdev-setbsz device blocksize\n"
18617 #: ../fish/guestfish-actions.pod:483
18618 msgid "blockdev-setro"
18622 #: ../fish/guestfish-actions.pod:485
18625 " blockdev-setro device\n"
18630 #: ../fish/guestfish-actions.pod:491
18631 msgid "blockdev-setrw"
18635 #: ../fish/guestfish-actions.pod:493
18638 " blockdev-setrw device\n"
18643 #: ../fish/guestfish-actions.pod:499
18644 msgid "case-sensitive-path"
18648 #: ../fish/guestfish-actions.pod:501
18651 " case-sensitive-path path\n"
18656 #: ../fish/guestfish-actions.pod:525
18658 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
18659 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
18660 "how the directories were originally created under Windows)."
18664 #: ../fish/guestfish-actions.pod:533
18665 msgid "See also L</realpath>."
18669 #: ../fish/guestfish-actions.pod:535
18674 #: ../fish/guestfish-actions.pod:537
18682 #: ../fish/guestfish-actions.pod:541
18684 "Note that this function cannot correctly handle binary files (specifically, "
18685 "files containing C<\\0> character which is treated as end of string). For "
18686 "those you need to use the L</read-file> or L</download> functions which have "
18687 "a more complex interface."
18691 #: ../fish/guestfish-actions.pod:549
18696 #: ../fish/guestfish-actions.pod:551
18699 " checksum csumtype path\n"
18704 #: ../fish/guestfish-actions.pod:594
18705 msgid "To get the checksum for a device, use L</checksum-device>."
18709 #: ../fish/guestfish-actions.pod:596
18710 msgid "To get the checksums for many files, use L</checksums-out>."
18714 #: ../fish/guestfish-actions.pod:598
18715 msgid "checksum-device"
18719 #: ../fish/guestfish-actions.pod:600
18722 " checksum-device csumtype device\n"
18727 #: ../fish/guestfish-actions.pod:602
18729 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
18730 "device named C<device>. For the types of checksums supported see the "
18731 "L</checksum> command."
18735 #: ../fish/guestfish-actions.pod:606
18736 msgid "checksums-out"
18740 #: ../fish/guestfish-actions.pod:608
18743 " checksums-out csumtype directory (sumsfile|-)\n"
18748 #: ../fish/guestfish-actions.pod:624
18753 #: ../fish/guestfish-actions.pod:626
18756 " chmod mode path\n"
18761 #: ../fish/guestfish-actions.pod:637
18766 #: ../fish/guestfish-actions.pod:639
18769 " chown owner group path\n"
18774 #: ../fish/guestfish-actions.pod:647
18779 #: ../fish/guestfish-actions.pod:649
18782 " command 'arguments ...'\n"
18787 #: ../fish/guestfish-actions.pod:656
18789 "The single parameter is an argv-style list of arguments. The first element "
18790 "is the name of the program to run. Subsequent elements are parameters. The "
18791 "list must be non-empty (ie. must contain a program name). Note that the "
18792 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
18796 #: ../fish/guestfish-actions.pod:684
18797 msgid "command-lines"
18801 #: ../fish/guestfish-actions.pod:686
18804 " command-lines 'arguments ...'\n"
18809 #: ../fish/guestfish-actions.pod:688
18810 msgid "This is the same as L</command>, but splits the result into a list of lines."
18814 #: ../fish/guestfish-actions.pod:691
18815 msgid "See also: L</sh-lines>"
18819 #: ../fish/guestfish-actions.pod:696
18824 #: ../fish/guestfish-actions.pod:698
18827 " config qemuparam qemuvalue\n"
18832 #: ../fish/guestfish-actions.pod:709
18837 #: ../fish/guestfish-actions.pod:711
18840 " copy-size src dest size\n"
18845 #: ../fish/guestfish-actions.pod:719
18850 #: ../fish/guestfish-actions.pod:721
18858 #: ../fish/guestfish-actions.pod:726
18863 #: ../fish/guestfish-actions.pod:728
18871 #: ../fish/guestfish-actions.pod:733
18876 #: ../fish/guestfish-actions.pod:735
18884 #: ../fish/guestfish-actions.pod:742
18886 "If the destination is a device, it must be as large or larger than the "
18887 "source file or device, otherwise the copy will fail. This command cannot do "
18888 "partial copies (see L</copy-size>)."
18892 #: ../fish/guestfish-actions.pod:746
18897 #: ../fish/guestfish-actions.pod:748
18900 " debug subcmd 'extraargs ...'\n"
18905 #: ../fish/guestfish-actions.pod:750
18907 "The L</debug> command exposes some internals of C<guestfsd> (the guestfs "
18908 "daemon) that runs inside the qemu subprocess."
18912 #: ../fish/guestfish-actions.pod:758
18913 msgid "debug-upload"
18917 #: ../fish/guestfish-actions.pod:760
18920 " debug-upload (filename|-) tmpname mode\n"
18925 #: ../fish/guestfish-actions.pod:762
18926 msgid "The L</debug-upload> command uploads a file to the libguestfs appliance."
18930 #: ../fish/guestfish-actions.pod:771
18935 #: ../fish/guestfish-actions.pod:773
18943 #: ../fish/guestfish-actions.pod:781
18948 #: ../fish/guestfish-actions.pod:783
18956 #: ../fish/guestfish-actions.pod:792
18961 #: ../fish/guestfish-actions.pod:794
18969 #: ../fish/guestfish-actions.pod:800
18971 "Another way to get the same information is to enable verbose messages with "
18972 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
18973 "before running the program."
18977 #: ../fish/guestfish-actions.pod:805
18982 #: ../fish/guestfish-actions.pod:807
18985 " download remotefilename (filename|-)\n"
18990 #: ../fish/guestfish-actions.pod:814
18991 msgid "See also L</upload>, L</cat>."
18995 #: ../fish/guestfish-actions.pod:818
18996 msgid "download-offset"
19000 #: ../fish/guestfish-actions.pod:820
19003 " download-offset remotefilename (filename|-) offset size\n"
19008 #: ../fish/guestfish-actions.pod:828
19010 "Note that there is no limit on the amount of data that can be downloaded "
19011 "with this call, unlike with L</pread>, and this call always reads the full "
19012 "amount unless an error occurs."
19016 #: ../fish/guestfish-actions.pod:833
19017 msgid "See also L</download>, L</pread>."
19021 #: ../fish/guestfish-actions.pod:837
19022 msgid "drop-caches"
19026 #: ../fish/guestfish-actions.pod:839
19029 " drop-caches whattodrop\n"
19034 #: ../fish/guestfish-actions.pod:851
19039 #: ../fish/guestfish-actions.pod:853
19047 #: ../fish/guestfish-actions.pod:865
19052 #: ../fish/guestfish-actions.pod:867
19055 " e2fsck-f device\n"
19060 #: ../fish/guestfish-actions.pod:873
19062 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
19063 "should use L</fsck>."
19067 #: ../fish/guestfish-actions.pod:876
19068 msgid "echo-daemon"
19072 #: ../fish/guestfish-actions.pod:878
19075 " echo-daemon 'words ...'\n"
19080 #: ../fish/guestfish-actions.pod:885
19081 msgid "See also L</ping-daemon>."
19085 #: ../fish/guestfish-actions.pod:887
19090 #: ../fish/guestfish-actions.pod:889
19093 " egrep regex path\n"
19098 #: ../fish/guestfish-actions.pod:897
19103 #: ../fish/guestfish-actions.pod:899
19106 " egrepi regex path\n"
19111 #: ../fish/guestfish-actions.pod:907
19116 #: ../fish/guestfish-actions.pod:909
19119 " equal file1 file2\n"
19124 #: ../fish/guestfish-actions.pod:916
19129 #: ../fish/guestfish-actions.pod:918
19137 #: ../fish/guestfish-actions.pod:923
19138 msgid "See also L</is-file>, L</is-dir>, L</stat>."
19142 #: ../fish/guestfish-actions.pod:925
19147 #: ../fish/guestfish-actions.pod:927
19150 " fallocate path len\n"
19155 #: ../fish/guestfish-actions.pod:944
19156 msgid "fallocate64"
19160 #: ../fish/guestfish-actions.pod:946
19163 " fallocate64 path len\n"
19168 #: ../fish/guestfish-actions.pod:952
19170 "Note that this call allocates disk blocks for the file. To create a sparse "
19171 "file use L</truncate-size> instead."
19175 #: ../fish/guestfish-actions.pod:955
19177 "The deprecated call L</fallocate> does the same, but owing to an oversight "
19178 "it only allowed 30 bit lengths to be specified, effectively limiting the "
19179 "maximum size of files created through that call to 1GB."
19183 #: ../fish/guestfish-actions.pod:964
19188 #: ../fish/guestfish-actions.pod:966
19191 " fgrep pattern path\n"
19196 #: ../fish/guestfish-actions.pod:974
19201 #: ../fish/guestfish-actions.pod:976
19204 " fgrepi pattern path\n"
19209 #: ../fish/guestfish-actions.pod:984
19214 #: ../fish/guestfish-actions.pod:986
19222 #: ../fish/guestfish-actions.pod:998
19224 "This command can also be used on C</dev/> devices (and partitions, LV "
19225 "names). You can for example use this to determine if a device contains a "
19226 "filesystem, although it's usually better to use L</vfs-type>."
19230 #: ../fish/guestfish-actions.pod:1008
19231 msgid "file-architecture"
19235 #: ../fish/guestfish-actions.pod:1010
19238 " file-architecture filename\n"
19243 #: ../fish/guestfish-actions.pod:1113
19248 #: ../fish/guestfish-actions.pod:1115
19256 #: ../fish/guestfish-actions.pod:1119
19258 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
19259 "L</is-file> etc. To get the size of block devices, use "
19260 "L</blockdev-getsize64>."
19264 #: ../fish/guestfish-actions.pod:1123
19269 #: ../fish/guestfish-actions.pod:1125
19272 " fill c len path\n"
19277 #: ../fish/guestfish-actions.pod:1131
19279 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
19280 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
19281 "L</fill-pattern>."
19285 #: ../fish/guestfish-actions.pod:1136
19286 msgid "fill-pattern"
19290 #: ../fish/guestfish-actions.pod:1138
19293 " fill-pattern pattern len path\n"
19298 #: ../fish/guestfish-actions.pod:1140
19300 "This function is like L</fill> except that it creates a new file of length "
19301 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
19302 "is truncated if necessary to ensure the length of the file is exactly C<len> "
19307 #: ../fish/guestfish-actions.pod:1145
19312 #: ../fish/guestfish-actions.pod:1147
19315 " find directory\n"
19320 #: ../fish/guestfish-actions.pod:1161
19321 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
19325 #: ../fish/guestfish-actions.pod:1174
19326 msgid "See also L</find0>."
19330 #: ../fish/guestfish-actions.pod:1179
19335 #: ../fish/guestfish-actions.pod:1181
19338 " find0 directory (files|-)\n"
19343 #: ../fish/guestfish-actions.pod:1187
19344 msgid "This command works the same way as L</find> with the following exceptions:"
19348 #: ../fish/guestfish-actions.pod:1214
19349 msgid "findfs-label"
19353 #: ../fish/guestfish-actions.pod:1216
19356 " findfs-label label\n"
19361 #: ../fish/guestfish-actions.pod:1222
19362 msgid "To find the label of a filesystem, use L</vfs-label>."
19366 #: ../fish/guestfish-actions.pod:1224
19367 msgid "findfs-uuid"
19371 #: ../fish/guestfish-actions.pod:1226
19374 " findfs-uuid uuid\n"
19379 #: ../fish/guestfish-actions.pod:1232
19380 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
19384 #: ../fish/guestfish-actions.pod:1234
19389 #: ../fish/guestfish-actions.pod:1236
19392 " fsck fstype device\n"
19397 #: ../fish/guestfish-actions.pod:1266
19402 #: ../fish/guestfish-actions.pod:1268
19410 #: ../fish/guestfish-actions.pod:1275
19411 msgid "get-autosync"
19415 #: ../fish/guestfish-actions.pod:1277
19423 #: ../fish/guestfish-actions.pod:1281
19428 #: ../fish/guestfish-actions.pod:1283
19436 #: ../fish/guestfish-actions.pod:1287
19437 msgid "get-e2label"
19441 #: ../fish/guestfish-actions.pod:1289
19444 " get-e2label device\n"
19449 #: ../fish/guestfish-actions.pod:1301
19454 #: ../fish/guestfish-actions.pod:1303
19457 " get-e2uuid device\n"
19462 #: ../fish/guestfish-actions.pod:1315
19463 msgid "get-memsize"
19467 #: ../fish/guestfish-actions.pod:1317
19475 #: ../fish/guestfish-actions.pod:1322
19477 "If L</set-memsize> was not called on this handle, and if "
19478 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
19479 "value for memsize."
19483 #: ../fish/guestfish-actions.pod:1329
19484 msgid "get-network"
19488 #: ../fish/guestfish-actions.pod:1331
19496 #: ../fish/guestfish-actions.pod:1335
19501 #: ../fish/guestfish-actions.pod:1337
19509 #: ../fish/guestfish-actions.pod:1344
19514 #: ../fish/guestfish-actions.pod:1346
19519 #: ../fish/guestfish-actions.pod:1348
19527 #: ../fish/guestfish-actions.pod:1355
19532 #: ../fish/guestfish-actions.pod:1357
19540 #: ../fish/guestfish-actions.pod:1364
19541 msgid "get-recovery-proc"
19545 #: ../fish/guestfish-actions.pod:1366
19548 " get-recovery-proc\n"
19553 #: ../fish/guestfish-actions.pod:1370
19554 msgid "get-selinux"
19558 #: ../fish/guestfish-actions.pod:1372
19566 #: ../fish/guestfish-actions.pod:1374
19568 "This returns the current setting of the selinux flag which is passed to the "
19569 "appliance at boot time. See L</set-selinux>."
19573 #: ../fish/guestfish-actions.pod:1380
19578 #: ../fish/guestfish-actions.pod:1382
19586 #: ../fish/guestfish-actions.pod:1389
19591 #: ../fish/guestfish-actions.pod:1391
19599 #: ../fish/guestfish-actions.pod:1395
19604 #: ../fish/guestfish-actions.pod:1397
19612 #: ../fish/guestfish-actions.pod:1399
19614 "Return the current umask. By default the umask is C<022> unless it has been "
19615 "set by calling L</umask>."
19619 #: ../fish/guestfish-actions.pod:1402
19620 msgid "get-verbose"
19624 #: ../fish/guestfish-actions.pod:1404
19632 #: ../fish/guestfish-actions.pod:1408
19637 #: ../fish/guestfish-actions.pod:1410
19645 #: ../fish/guestfish-actions.pod:1414
19646 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
19650 #: ../fish/guestfish-actions.pod:1417
19655 #: ../fish/guestfish-actions.pod:1419
19658 " getxattrs path\n"
19663 #: ../fish/guestfish-actions.pod:1427
19664 msgid "See also: L</lgetxattrs>, L<attr(5)>."
19668 #: ../fish/guestfish-actions.pod:1429
19669 msgid "glob-expand"
19673 #: ../fish/guestfish-actions.pod:1431
19676 " glob-expand pattern\n"
19681 #: ../fish/guestfish-actions.pod:1444
19686 #: ../fish/guestfish-actions.pod:1446
19689 " grep regex path\n"
19694 #: ../fish/guestfish-actions.pod:1454
19699 #: ../fish/guestfish-actions.pod:1456
19702 " grepi regex path\n"
19707 #: ../fish/guestfish-actions.pod:1464
19708 msgid "grub-install"
19712 #: ../fish/guestfish-actions.pod:1466
19715 " grub-install root device\n"
19720 #: ../fish/guestfish-actions.pod:1482
19725 #: ../fish/guestfish-actions.pod:1484
19733 #: ../fish/guestfish-actions.pod:1492
19738 #: ../fish/guestfish-actions.pod:1494
19741 " head-n nrlines path\n"
19746 #: ../fish/guestfish-actions.pod:1507
19751 #: ../fish/guestfish-actions.pod:1509
19759 #: ../fish/guestfish-actions.pod:1517
19764 #: ../fish/guestfish-actions.pod:1519
19767 " initrd-cat initrdpath filename\n"
19772 #: ../fish/guestfish-actions.pod:1531
19773 msgid "See also L</initrd-list>."
19777 #: ../fish/guestfish-actions.pod:1536
19778 msgid "initrd-list"
19782 #: ../fish/guestfish-actions.pod:1538
19785 " initrd-list path\n"
19790 #: ../fish/guestfish-actions.pod:1550
19791 msgid "inotify-add-watch"
19795 #: ../fish/guestfish-actions.pod:1552
19798 " inotify-add-watch path mask\n"
19803 #: ../fish/guestfish-actions.pod:1564
19804 msgid "inotify-close"
19808 #: ../fish/guestfish-actions.pod:1566
19816 #: ../fish/guestfish-actions.pod:1572
19817 msgid "inotify-files"
19821 #: ../fish/guestfish-actions.pod:1574
19829 #: ../fish/guestfish-actions.pod:1576
19831 "This function is a helpful wrapper around L</inotify-read> which just "
19832 "returns a list of pathnames of objects that were touched. The returned "
19833 "pathnames are sorted and deduplicated."
19837 #: ../fish/guestfish-actions.pod:1580
19838 msgid "inotify-init"
19842 #: ../fish/guestfish-actions.pod:1582
19845 " inotify-init maxevents\n"
19850 #: ../fish/guestfish-actions.pod:1588
19852 "C<maxevents> is the maximum number of events which will be queued up between "
19853 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
19854 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
19855 "default was 16384 events. Beyond this limit, the kernel throws away events, "
19856 "but records the fact that it threw them away by setting a flag "
19857 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
19861 #: ../fish/guestfish-actions.pod:1598
19863 "Before any events are generated, you have to add some watches to the "
19864 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
19865 "L</inotify-watch-all>."
19869 #: ../fish/guestfish-actions.pod:1604
19871 "Queued up events should be read periodically by calling L</inotify-read> (or "
19872 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
19873 "If you don't read the events out often enough then you risk the internal "
19874 "queue overflowing."
19878 #: ../fish/guestfish-actions.pod:1611
19880 "The handle should be closed after use by calling L</inotify-close>. This "
19881 "also removes any watches automatically."
19885 #: ../fish/guestfish-actions.pod:1620
19886 msgid "inotify-read"
19890 #: ../fish/guestfish-actions.pod:1622
19898 #: ../fish/guestfish-actions.pod:1635
19899 msgid "inotify-rm-watch"
19903 #: ../fish/guestfish-actions.pod:1637
19906 " inotify-rm-watch wd\n"
19911 #: ../fish/guestfish-actions.pod:1639
19912 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
19916 #: ../fish/guestfish-actions.pod:1642
19917 msgid "inspect-get-arch"
19921 #: ../fish/guestfish-actions.pod:1644
19924 " inspect-get-arch root\n"
19929 #: ../fish/guestfish-actions.pod:1646 ../fish/guestfish-actions.pod:1662 ../fish/guestfish-actions.pod:1728 ../fish/guestfish-actions.pod:1746 ../fish/guestfish-actions.pod:1767 ../fish/guestfish-actions.pod:1782 ../fish/guestfish-actions.pod:1805 ../fish/guestfish-actions.pod:1835 ../fish/guestfish-actions.pod:1866
19931 "This function should only be called with a root device string as returned by "
19936 #: ../fish/guestfish-actions.pod:1649
19938 "This returns the architecture of the inspected operating system. The "
19939 "possible return values are listed under L</file-architecture>."
19943 #: ../fish/guestfish-actions.pod:1658
19944 msgid "inspect-get-distro"
19948 #: ../fish/guestfish-actions.pod:1660
19951 " inspect-get-distro root\n"
19956 #: ../fish/guestfish-actions.pod:1724
19957 msgid "inspect-get-filesystems"
19961 #: ../fish/guestfish-actions.pod:1726
19964 " inspect-get-filesystems root\n"
19969 #: ../fish/guestfish-actions.pod:1739
19971 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
19972 "L</inspect-get-mountpoints>."
19976 #: ../fish/guestfish-actions.pod:1742
19977 msgid "inspect-get-major-version"
19981 #: ../fish/guestfish-actions.pod:1744
19984 " inspect-get-major-version root\n"
19989 #: ../fish/guestfish-actions.pod:1763
19990 msgid "inspect-get-minor-version"
19994 #: ../fish/guestfish-actions.pod:1765
19997 " inspect-get-minor-version root\n"
20002 #: ../fish/guestfish-actions.pod:1775
20004 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20005 "L</inspect-get-major-version>."
20009 #: ../fish/guestfish-actions.pod:1778
20010 msgid "inspect-get-mountpoints"
20014 #: ../fish/guestfish-actions.pod:1780
20017 " inspect-get-mountpoints root\n"
20022 #: ../fish/guestfish-actions.pod:1798
20024 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20025 "L</inspect-get-filesystems>."
20029 #: ../fish/guestfish-actions.pod:1801
20030 msgid "inspect-get-product-name"
20034 #: ../fish/guestfish-actions.pod:1803
20037 " inspect-get-product-name root\n"
20042 #: ../fish/guestfish-actions.pod:1818
20043 msgid "inspect-get-roots"
20047 #: ../fish/guestfish-actions.pod:1820
20050 " inspect-get-roots\n"
20055 #: ../fish/guestfish-actions.pod:1822
20057 "This function is a convenient way to get the list of root devices, as "
20058 "returned from a previous call to L</inspect-os>, but without redoing the "
20059 "whole inspection process."
20063 #: ../fish/guestfish-actions.pod:1826
20065 "This returns an empty list if either no root devices were found or the "
20066 "caller has not called L</inspect-os>."
20070 #: ../fish/guestfish-actions.pod:1831
20071 msgid "inspect-get-type"
20075 #: ../fish/guestfish-actions.pod:1833
20078 " inspect-get-type root\n"
20083 #: ../fish/guestfish-actions.pod:1862
20084 msgid "inspect-get-windows-systemroot"
20088 #: ../fish/guestfish-actions.pod:1864
20091 " inspect-get-windows-systemroot root\n"
20096 #: ../fish/guestfish-actions.pod:1878
20101 #: ../fish/guestfish-actions.pod:1880
20109 #: ../fish/guestfish-actions.pod:1895
20111 "You can pass the root string(s) returned to other L</inspect-get-*> "
20112 "functions in order to query further information about each operating system, "
20113 "such as the name and version."
20117 #: ../fish/guestfish-actions.pod:1900
20119 "This function uses other libguestfs features such as L</mount-ro> and "
20120 "L</umount-all> in order to mount and unmount filesystems and look at the "
20121 "contents. This should be called with no disks currently mounted. The "
20122 "function may also use Augeas, so any existing Augeas handle will be closed."
20126 #: ../fish/guestfish-actions.pod:1912 ../fish/guestfish-actions.pod:2068 ../fish/guestfish-actions.pod:2114
20127 msgid "See also L</list-filesystems>."
20131 #: ../fish/guestfish-actions.pod:1914
20132 msgid "is-blockdev"
20136 #: ../fish/guestfish-actions.pod:1916
20139 " is-blockdev path\n"
20144 #: ../fish/guestfish-actions.pod:1921 ../fish/guestfish-actions.pod:1939 ../fish/guestfish-actions.pod:1958 ../fish/guestfish-actions.pod:1967 ../fish/guestfish-actions.pod:1977 ../fish/guestfish-actions.pod:2011 ../fish/guestfish-actions.pod:2020
20145 msgid "See also L</stat>."
20149 #: ../fish/guestfish-actions.pod:1923
20154 #: ../fish/guestfish-actions.pod:1925
20162 #: ../fish/guestfish-actions.pod:1932
20167 #: ../fish/guestfish-actions.pod:1934
20170 " is-chardev path\n"
20175 #: ../fish/guestfish-actions.pod:1941
20180 #: ../fish/guestfish-actions.pod:1943
20188 #: ../fish/guestfish-actions.pod:1950
20193 #: ../fish/guestfish-actions.pod:1952
20201 #: ../fish/guestfish-actions.pod:1960
20206 #: ../fish/guestfish-actions.pod:1962
20214 #: ../fish/guestfish-actions.pod:1969
20219 #: ../fish/guestfish-actions.pod:1971
20227 #: ../fish/guestfish-actions.pod:1979
20228 msgid "is-launching"
20232 #: ../fish/guestfish-actions.pod:1981
20240 #: ../fish/guestfish-actions.pod:1988
20245 #: ../fish/guestfish-actions.pod:1990
20253 #: ../fish/guestfish-actions.pod:1995
20258 #: ../fish/guestfish-actions.pod:1997
20266 #: ../fish/guestfish-actions.pod:2004
20271 #: ../fish/guestfish-actions.pod:2006
20274 " is-socket path\n"
20279 #: ../fish/guestfish-actions.pod:2013
20284 #: ../fish/guestfish-actions.pod:2015
20287 " is-symlink path\n"
20292 #: ../fish/guestfish-actions.pod:2022
20293 msgid "kill-subprocess"
20297 #: ../fish/guestfish-actions.pod:2024
20300 " kill-subprocess\n"
20305 #: ../fish/guestfish-actions.pod:2028
20310 #: ../fish/guestfish-actions.pod:2030
20315 #: ../fish/guestfish-actions.pod:2032
20323 #: ../fish/guestfish-actions.pod:2040
20328 #: ../fish/guestfish-actions.pod:2042
20331 " lchown owner group path\n"
20336 #: ../fish/guestfish-actions.pod:2044
20338 "Change the file owner to C<owner> and group to C<group>. This is like "
20339 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
20344 #: ../fish/guestfish-actions.pod:2052
20349 #: ../fish/guestfish-actions.pod:2054
20352 " lgetxattrs path\n"
20357 #: ../fish/guestfish-actions.pod:2056
20359 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
20360 "it returns the extended attributes of the link itself."
20364 #: ../fish/guestfish-actions.pod:2060
20365 msgid "list-devices"
20369 #: ../fish/guestfish-actions.pod:2062
20377 #: ../fish/guestfish-actions.pod:2070
20378 msgid "list-filesystems"
20382 #: ../fish/guestfish-actions.pod:2072
20385 " list-filesystems\n"
20390 #: ../fish/guestfish-actions.pod:2091
20392 "This command runs other libguestfs commands, which might include L</mount> "
20393 "and L</umount>, and therefore you should use this soon after launch and only "
20394 "when nothing is mounted."
20398 #: ../fish/guestfish-actions.pod:2095
20400 "Not all of the filesystems returned will be mountable. In particular, swap "
20401 "partitions are returned in the list. Also this command does not check that "
20402 "each filesystem found is valid and mountable, and some filesystems might be "
20403 "mountable but require special options. Filesystems may not all belong to a "
20404 "single logical operating system (use L</inspect-os> to look for OSes)."
20408 #: ../fish/guestfish-actions.pod:2103
20409 msgid "list-partitions"
20413 #: ../fish/guestfish-actions.pod:2105
20416 " list-partitions\n"
20421 #: ../fish/guestfish-actions.pod:2111
20423 "This does not return logical volumes. For that you will need to call "
20428 #: ../fish/guestfish-actions.pod:2116
20433 #: ../fish/guestfish-actions.pod:2118
20441 #: ../fish/guestfish-actions.pod:2126
20446 #: ../fish/guestfish-actions.pod:2128
20449 " ln target linkname\n"
20454 #: ../fish/guestfish-actions.pod:2132
20459 #: ../fish/guestfish-actions.pod:2134
20462 " ln-f target linkname\n"
20467 #: ../fish/guestfish-actions.pod:2139
20472 #: ../fish/guestfish-actions.pod:2141
20475 " ln-s target linkname\n"
20480 #: ../fish/guestfish-actions.pod:2145
20485 #: ../fish/guestfish-actions.pod:2147
20488 " ln-sf target linkname\n"
20493 #: ../fish/guestfish-actions.pod:2152
20494 msgid "lremovexattr"
20498 #: ../fish/guestfish-actions.pod:2154
20501 " lremovexattr xattr path\n"
20506 #: ../fish/guestfish-actions.pod:2156
20508 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
20509 "it removes an extended attribute of the link itself."
20513 #: ../fish/guestfish-actions.pod:2160
20518 #: ../fish/guestfish-actions.pod:2162
20526 #: ../fish/guestfish-actions.pod:2168
20528 "This command is mostly useful for interactive sessions. Programs should "
20529 "probably use L</readdir> instead."
20533 #: ../fish/guestfish-actions.pod:2171
20538 #: ../fish/guestfish-actions.pod:2173
20541 " lsetxattr xattr val vallen path\n"
20546 #: ../fish/guestfish-actions.pod:2175
20548 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
20549 "sets an extended attribute of the link itself."
20553 #: ../fish/guestfish-actions.pod:2179
20558 #: ../fish/guestfish-actions.pod:2181
20566 #: ../fish/guestfish-actions.pod:2185
20568 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
20569 "the link is stat-ed, not the file it refers to."
20573 #: ../fish/guestfish-actions.pod:2191
20578 #: ../fish/guestfish-actions.pod:2193
20581 " lstatlist path 'names ...'\n"
20586 #: ../fish/guestfish-actions.pod:2195
20588 "This call allows you to perform the L</lstat> operation on multiple files, "
20589 "where all files are in the directory C<path>. C<names> is the list of files "
20590 "from this directory."
20594 #: ../fish/guestfish-actions.pod:2204
20596 "This call is intended for programs that want to efficiently list a directory "
20597 "contents without making many round-trips. See also L</lxattrlist> for a "
20598 "similarly efficient call for getting extended attributes. Very long "
20599 "directory listings might cause the protocol message size to be exceeded, "
20600 "causing this call to fail. The caller must split up such requests into "
20601 "smaller groups of names."
20605 #: ../fish/guestfish-actions.pod:2212
20606 msgid "luks-add-key"
20610 #: ../fish/guestfish-actions.pod:2214
20613 " luks-add-key device keyslot\n"
20618 #: ../fish/guestfish-actions.pod:2221
20620 "Note that if C<keyslot> already contains a key, then this command will "
20621 "fail. You have to use L</luks-kill-slot> first to remove that key."
20625 #: ../fish/guestfish-actions.pod:2225 ../fish/guestfish-actions.pod:2247 ../fish/guestfish-actions.pod:2260 ../fish/guestfish-actions.pod:2274 ../fish/guestfish-actions.pod:2297 ../fish/guestfish-actions.pod:2307
20627 "This command has one or more key or passphrase parameters. Guestfish will "
20628 "prompt for these separately."
20632 #: ../fish/guestfish-actions.pod:2228
20637 #: ../fish/guestfish-actions.pod:2230
20640 " luks-close device\n"
20645 #: ../fish/guestfish-actions.pod:2232
20647 "This closes a LUKS device that was created earlier by L</luks-open> or "
20648 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
20649 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
20650 "underlying block device."
20654 #: ../fish/guestfish-actions.pod:2238
20655 msgid "luks-format"
20659 #: ../fish/guestfish-actions.pod:2240
20662 " luks-format device keyslot\n"
20667 #: ../fish/guestfish-actions.pod:2253
20668 msgid "luks-format-cipher"
20672 #: ../fish/guestfish-actions.pod:2255
20675 " luks-format-cipher device keyslot cipher\n"
20680 #: ../fish/guestfish-actions.pod:2257
20682 "This command is the same as L</luks-format> but it also allows you to set "
20683 "the C<cipher> used."
20687 #: ../fish/guestfish-actions.pod:2266
20688 msgid "luks-kill-slot"
20692 #: ../fish/guestfish-actions.pod:2268
20695 " luks-kill-slot device keyslot\n"
20700 #: ../fish/guestfish-actions.pod:2277
20705 #: ../fish/guestfish-actions.pod:2279
20708 " luks-open device mapname\n"
20713 #: ../fish/guestfish-actions.pod:2293
20715 "If this block device contains LVM volume groups, then calling L</vgscan> "
20716 "followed by L</vg-activate-all> will make them visible."
20720 #: ../fish/guestfish-actions.pod:2300
20721 msgid "luks-open-ro"
20725 #: ../fish/guestfish-actions.pod:2302
20728 " luks-open-ro device mapname\n"
20733 #: ../fish/guestfish-actions.pod:2304
20735 "This is the same as L</luks-open> except that a read-only mapping is "
20740 #: ../fish/guestfish-actions.pod:2310
20745 #: ../fish/guestfish-actions.pod:2312
20748 " lvcreate logvol volgroup mbytes\n"
20753 #: ../fish/guestfish-actions.pod:2317
20754 msgid "lvm-canonical-lv-name"
20758 #: ../fish/guestfish-actions.pod:2319
20761 " lvm-canonical-lv-name lvname\n"
20766 #: ../fish/guestfish-actions.pod:2328
20767 msgid "See also L</is-lv>."
20771 #: ../fish/guestfish-actions.pod:2330
20772 msgid "lvm-clear-filter"
20776 #: ../fish/guestfish-actions.pod:2332
20779 " lvm-clear-filter\n"
20784 #: ../fish/guestfish-actions.pod:2334
20786 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
20791 #: ../fish/guestfish-actions.pod:2340
20792 msgid "lvm-remove-all"
20796 #: ../fish/guestfish-actions.pod:2342
20799 " lvm-remove-all\n"
20804 #: ../fish/guestfish-actions.pod:2350
20805 msgid "lvm-set-filter"
20809 #: ../fish/guestfish-actions.pod:2352
20812 " lvm-set-filter 'devices ...'\n"
20817 #: ../fish/guestfish-actions.pod:2377
20822 #: ../fish/guestfish-actions.pod:2379
20825 " lvremove device\n"
20830 #: ../fish/guestfish-actions.pod:2387
20835 #: ../fish/guestfish-actions.pod:2389
20838 " lvrename logvol newlogvol\n"
20843 #: ../fish/guestfish-actions.pod:2393
20848 #: ../fish/guestfish-actions.pod:2395
20851 " lvresize device mbytes\n"
20856 #: ../fish/guestfish-actions.pod:2401
20857 msgid "lvresize-free"
20861 #: ../fish/guestfish-actions.pod:2403
20864 " lvresize-free lv percent\n"
20869 #: ../fish/guestfish-actions.pod:2411
20874 #: ../fish/guestfish-actions.pod:2413
20882 #: ../fish/guestfish-actions.pod:2421
20883 msgid "See also L</lvs-full>, L</list-filesystems>."
20887 #: ../fish/guestfish-actions.pod:2423
20892 #: ../fish/guestfish-actions.pod:2425
20900 #: ../fish/guestfish-actions.pod:2430
20905 #: ../fish/guestfish-actions.pod:2432
20913 #: ../fish/guestfish-actions.pod:2436
20918 #: ../fish/guestfish-actions.pod:2438
20921 " lxattrlist path 'names ...'\n"
20926 #: ../fish/guestfish-actions.pod:2454
20928 "This call is intended for programs that want to efficiently list a directory "
20929 "contents without making many round-trips. See also L</lstatlist> for a "
20930 "similarly efficient call for getting standard stats. Very long directory "
20931 "listings might cause the protocol message size to be exceeded, causing this "
20932 "call to fail. The caller must split up such requests into smaller groups of "
20937 #: ../fish/guestfish-actions.pod:2462
20942 #: ../fish/guestfish-actions.pod:2464
20950 #: ../fish/guestfish-actions.pod:2468
20955 #: ../fish/guestfish-actions.pod:2470
20958 " mkdir-mode path mode\n"
20963 #: ../fish/guestfish-actions.pod:2479
20964 msgid "See also L</mkdir>, L</umask>"
20968 #: ../fish/guestfish-actions.pod:2481
20973 #: ../fish/guestfish-actions.pod:2483
20981 #: ../fish/guestfish-actions.pod:2488
20986 #: ../fish/guestfish-actions.pod:2490
20989 " mkdtemp template\n"
20994 #: ../fish/guestfish-actions.pod:2511
20999 #: ../fish/guestfish-actions.pod:2513
21002 " mke2fs-J fstype blocksize device journal\n"
21007 #: ../fish/guestfish-actions.pod:2521
21008 msgid "See also L</mke2journal>."
21012 #: ../fish/guestfish-actions.pod:2523
21017 #: ../fish/guestfish-actions.pod:2525
21020 " mke2fs-JL fstype blocksize device label\n"
21025 #: ../fish/guestfish-actions.pod:2530
21026 msgid "See also L</mke2journal-L>."
21030 #: ../fish/guestfish-actions.pod:2532
21035 #: ../fish/guestfish-actions.pod:2534
21038 " mke2fs-JU fstype blocksize device uuid\n"
21043 #: ../fish/guestfish-actions.pod:2539
21044 msgid "See also L</mke2journal-U>."
21048 #: ../fish/guestfish-actions.pod:2541
21049 msgid "mke2journal"
21053 #: ../fish/guestfish-actions.pod:2543
21056 " mke2journal blocksize device\n"
21061 #: ../fish/guestfish-actions.pod:2550
21062 msgid "mke2journal-L"
21066 #: ../fish/guestfish-actions.pod:2552
21069 " mke2journal-L blocksize label device\n"
21074 #: ../fish/guestfish-actions.pod:2556
21075 msgid "mke2journal-U"
21079 #: ../fish/guestfish-actions.pod:2558
21082 " mke2journal-U blocksize uuid device\n"
21087 #: ../fish/guestfish-actions.pod:2562
21092 #: ../fish/guestfish-actions.pod:2564
21095 " mkfifo mode path\n"
21100 #: ../fish/guestfish-actions.pod:2566
21102 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
21103 "is just a convenient wrapper around L</mknod>."
21107 #: ../fish/guestfish-actions.pod:2572
21112 #: ../fish/guestfish-actions.pod:2574
21115 " mkfs fstype device\n"
21120 #: ../fish/guestfish-actions.pod:2580
21125 #: ../fish/guestfish-actions.pod:2582
21128 " mkfs-b fstype blocksize device\n"
21133 #: ../fish/guestfish-actions.pod:2584
21135 "This call is similar to L</mkfs>, but it allows you to control the block "
21136 "size of the resulting filesystem. Supported block sizes depend on the "
21137 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
21141 #: ../fish/guestfish-actions.pod:2592
21142 msgid "mkmountpoint"
21146 #: ../fish/guestfish-actions.pod:2594
21149 " mkmountpoint exemptpath\n"
21154 #: ../fish/guestfish-actions.pod:2596
21156 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
21157 "to create extra mountpoints before mounting the first filesystem."
21161 #: ../fish/guestfish-actions.pod:2620
21163 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
21164 "unexpected errors if you try to mix these calls. It is safest to manually "
21165 "unmount filesystems and remove mountpoints after use."
21169 #: ../fish/guestfish-actions.pod:2624
21171 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
21172 "for this to work for manual mountpoints, you must ensure that the innermost "
21173 "mountpoints have the longest pathnames, as in the example code above."
21177 #: ../fish/guestfish-actions.pod:2631
21179 "Autosync [see L</set-autosync>, this is set by default on handles] means "
21180 "that L</umount-all> is called when the handle is closed which can also "
21181 "trigger these issues."
21185 #: ../fish/guestfish-actions.pod:2635
21190 #: ../fish/guestfish-actions.pod:2637
21193 " mknod mode devmajor devminor path\n"
21198 #: ../fish/guestfish-actions.pod:2647
21200 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
21201 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
21202 "regular file). These constants are available in the standard Linux header "
21203 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
21204 "wrappers around this command which bitwise OR in the appropriate constant "
21209 #: ../fish/guestfish-actions.pod:2657
21214 #: ../fish/guestfish-actions.pod:2659
21217 " mknod-b mode devmajor devminor path\n"
21222 #: ../fish/guestfish-actions.pod:2661
21224 "This call creates a block device node called C<path> with mode C<mode> and "
21225 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
21226 "wrapper around L</mknod>."
21230 #: ../fish/guestfish-actions.pod:2667
21235 #: ../fish/guestfish-actions.pod:2669
21238 " mknod-c mode devmajor devminor path\n"
21243 #: ../fish/guestfish-actions.pod:2671
21245 "This call creates a char device node called C<path> with mode C<mode> and "
21246 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
21247 "wrapper around L</mknod>."
21251 #: ../fish/guestfish-actions.pod:2677
21256 #: ../fish/guestfish-actions.pod:2679
21264 #: ../fish/guestfish-actions.pod:2683
21269 #: ../fish/guestfish-actions.pod:2685
21272 " mkswap-L label device\n"
21277 #: ../fish/guestfish-actions.pod:2693
21282 #: ../fish/guestfish-actions.pod:2695
21285 " mkswap-U uuid device\n"
21290 #: ../fish/guestfish-actions.pod:2699
21291 msgid "mkswap-file"
21295 #: ../fish/guestfish-actions.pod:2701
21298 " mkswap-file path\n"
21303 #: ../fish/guestfish-actions.pod:2705
21305 "This command just writes a swap file signature to an existing file. To "
21306 "create the file itself, use something like L</fallocate>."
21310 #: ../fish/guestfish-actions.pod:2708
21315 #: ../fish/guestfish-actions.pod:2710
21318 " modprobe modulename\n"
21323 #: ../fish/guestfish-actions.pod:2717
21328 #: ../fish/guestfish-actions.pod:2719
21331 " mount device mountpoint\n"
21336 #: ../fish/guestfish-actions.pod:2735
21338 "B<Important note:> When you use this call, the filesystem options C<sync> "
21339 "and C<noatime> are set implicitly. This was originally done because we "
21340 "thought it would improve reliability, but it turns out that I<-o sync> has a "
21341 "very large negative performance impact and negligible effect on "
21342 "reliability. Therefore we recommend that you avoid using L</mount> in any "
21343 "code that needs performance, and instead use L</mount-options> (use an empty "
21344 "string for the first parameter if you don't want any options)."
21348 #: ../fish/guestfish-actions.pod:2745
21353 #: ../fish/guestfish-actions.pod:2747
21356 " mount-loop file mountpoint\n"
21361 #: ../fish/guestfish-actions.pod:2753
21362 msgid "mount-options"
21366 #: ../fish/guestfish-actions.pod:2755
21369 " mount-options options device mountpoint\n"
21374 #: ../fish/guestfish-actions.pod:2757
21376 "This is the same as the L</mount> command, but it allows you to set the "
21377 "mount options as for the L<mount(8)> I<-o> flag."
21381 #: ../fish/guestfish-actions.pod:2765
21386 #: ../fish/guestfish-actions.pod:2767
21389 " mount-ro device mountpoint\n"
21394 #: ../fish/guestfish-actions.pod:2769
21396 "This is the same as the L</mount> command, but it mounts the filesystem with "
21397 "the read-only (I<-o ro>) flag."
21401 #: ../fish/guestfish-actions.pod:2772
21406 #: ../fish/guestfish-actions.pod:2774
21409 " mount-vfs options vfstype device mountpoint\n"
21414 #: ../fish/guestfish-actions.pod:2776
21416 "This is the same as the L</mount> command, but it allows you to set both the "
21417 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
21421 #: ../fish/guestfish-actions.pod:2780
21422 msgid "mountpoints"
21426 #: ../fish/guestfish-actions.pod:2782
21434 #: ../fish/guestfish-actions.pod:2784
21436 "This call is similar to L</mounts>. That call returns a list of devices. "
21437 "This one returns a hash table (map) of device name to directory where the "
21438 "device is mounted."
21442 #: ../fish/guestfish-actions.pod:2788
21447 #: ../fish/guestfish-actions.pod:2790
21455 #: ../fish/guestfish-actions.pod:2797
21456 msgid "See also: L</mountpoints>"
21460 #: ../fish/guestfish-actions.pod:2799
21465 #: ../fish/guestfish-actions.pod:2801
21473 #: ../fish/guestfish-actions.pod:2806
21474 msgid "ntfs-3g-probe"
21478 #: ../fish/guestfish-actions.pod:2808
21481 " ntfs-3g-probe true|false device\n"
21486 #: ../fish/guestfish-actions.pod:2822
21491 #: ../fish/guestfish-actions.pod:2824
21494 " ntfsresize device\n"
21499 #: ../fish/guestfish-actions.pod:2830
21500 msgid "ntfsresize-size"
21504 #: ../fish/guestfish-actions.pod:2832
21507 " ntfsresize-size device size\n"
21512 #: ../fish/guestfish-actions.pod:2834
21514 "This command is the same as L</ntfsresize> except that it allows you to "
21515 "specify the new size (in bytes) explicitly."
21519 #: ../fish/guestfish-actions.pod:2837
21524 #: ../fish/guestfish-actions.pod:2839
21527 " part-add device prlogex startsect endsect\n"
21532 #: ../fish/guestfish-actions.pod:2841
21534 "This command adds a partition to C<device>. If there is no partition table "
21535 "on the device, call L</part-init> first."
21539 #: ../fish/guestfish-actions.pod:2853
21541 "Creating a partition which covers the whole disk is not so easy. Use "
21542 "L</part-disk> to do that."
21546 #: ../fish/guestfish-actions.pod:2856
21551 #: ../fish/guestfish-actions.pod:2858
21554 " part-del device partnum\n"
21559 #: ../fish/guestfish-actions.pod:2866
21564 #: ../fish/guestfish-actions.pod:2868
21567 " part-disk device parttype\n"
21572 #: ../fish/guestfish-actions.pod:2870
21574 "This command is simply a combination of L</part-init> followed by "
21575 "L</part-add> to create a single primary partition covering the whole disk."
21579 #: ../fish/guestfish-actions.pod:2874
21581 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
21582 "possible values are described in L</part-init>."
21586 #: ../fish/guestfish-actions.pod:2880
21587 msgid "part-get-bootable"
21591 #: ../fish/guestfish-actions.pod:2882
21594 " part-get-bootable device partnum\n"
21599 #: ../fish/guestfish-actions.pod:2887
21600 msgid "See also L</part-set-bootable>."
21604 #: ../fish/guestfish-actions.pod:2889
21605 msgid "part-get-mbr-id"
21609 #: ../fish/guestfish-actions.pod:2891
21612 " part-get-mbr-id device partnum\n"
21617 #: ../fish/guestfish-actions.pod:2896 ../fish/guestfish-actions.pod:3034
21619 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
21620 "undefined results for other partition table types (see "
21621 "L</part-get-parttype>)."
21625 #: ../fish/guestfish-actions.pod:2900
21626 msgid "part-get-parttype"
21630 #: ../fish/guestfish-actions.pod:2902
21633 " part-get-parttype device\n"
21638 #: ../fish/guestfish-actions.pod:2907
21640 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
21641 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
21642 "possible, although unusual. See L</part-init> for a full list."
21646 #: ../fish/guestfish-actions.pod:2912
21651 #: ../fish/guestfish-actions.pod:2914
21654 " part-init device parttype\n"
21659 #: ../fish/guestfish-actions.pod:2920
21661 "Initially there are no partitions. Following this, you should call "
21662 "L</part-add> for each partition required."
21666 #: ../fish/guestfish-actions.pod:2983
21671 #: ../fish/guestfish-actions.pod:2985
21674 " part-list device\n"
21679 #: ../fish/guestfish-actions.pod:3000
21681 "Start of the partition I<in bytes>. To get sectors you have to divide by "
21682 "the device's sector size, see L</blockdev-getss>."
21686 #: ../fish/guestfish-actions.pod:3013
21687 msgid "part-set-bootable"
21691 #: ../fish/guestfish-actions.pod:3015
21694 " part-set-bootable device partnum true|false\n"
21699 #: ../fish/guestfish-actions.pod:3024
21700 msgid "part-set-mbr-id"
21704 #: ../fish/guestfish-actions.pod:3026
21707 " part-set-mbr-id device partnum idbyte\n"
21712 #: ../fish/guestfish-actions.pod:3038
21713 msgid "part-set-name"
21717 #: ../fish/guestfish-actions.pod:3040
21720 " part-set-name device partnum name\n"
21725 #: ../fish/guestfish-actions.pod:3048
21726 msgid "part-to-dev"
21730 #: ../fish/guestfish-actions.pod:3050
21733 " part-to-dev partition\n"
21738 #: ../fish/guestfish-actions.pod:3056
21740 "The named partition must exist, for example as a string returned from "
21741 "L</list-partitions>."
21745 #: ../fish/guestfish-actions.pod:3059
21746 msgid "ping-daemon"
21750 #: ../fish/guestfish-actions.pod:3061
21758 #: ../fish/guestfish-actions.pod:3068
21763 #: ../fish/guestfish-actions.pod:3070
21766 " pread path count offset\n"
21771 #: ../fish/guestfish-actions.pod:3078
21772 msgid "See also L</pwrite>, L</pread-device>."
21776 #: ../fish/guestfish-actions.pod:3083
21777 msgid "pread-device"
21781 #: ../fish/guestfish-actions.pod:3085
21784 " pread-device device count offset\n"
21789 #: ../fish/guestfish-actions.pod:3093
21790 msgid "See also L</pread>."
21794 #: ../fish/guestfish-actions.pod:3098
21799 #: ../fish/guestfish-actions.pod:3100
21802 " pvcreate device\n"
21807 #: ../fish/guestfish-actions.pod:3106
21812 #: ../fish/guestfish-actions.pod:3108
21815 " pvremove device\n"
21820 #: ../fish/guestfish-actions.pod:3117
21825 #: ../fish/guestfish-actions.pod:3119
21828 " pvresize device\n"
21833 #: ../fish/guestfish-actions.pod:3124
21834 msgid "pvresize-size"
21838 #: ../fish/guestfish-actions.pod:3126
21841 " pvresize-size device size\n"
21846 #: ../fish/guestfish-actions.pod:3128
21848 "This command is the same as L</pvresize> except that it allows you to "
21849 "specify the new size (in bytes) explicitly."
21853 #: ../fish/guestfish-actions.pod:3131
21858 #: ../fish/guestfish-actions.pod:3133
21866 #: ../fish/guestfish-actions.pod:3141
21867 msgid "See also L</pvs-full>."
21871 #: ../fish/guestfish-actions.pod:3143
21876 #: ../fish/guestfish-actions.pod:3145
21884 #: ../fish/guestfish-actions.pod:3150
21889 #: ../fish/guestfish-actions.pod:3152
21897 #: ../fish/guestfish-actions.pod:3156
21902 #: ../fish/guestfish-actions.pod:3158
21905 " pwrite path content offset\n"
21910 #: ../fish/guestfish-actions.pod:3169
21911 msgid "See also L</pread>, L</pwrite-device>."
21915 #: ../fish/guestfish-actions.pod:3174
21916 msgid "pwrite-device"
21920 #: ../fish/guestfish-actions.pod:3176
21923 " pwrite-device device content offset\n"
21928 #: ../fish/guestfish-actions.pod:3186
21929 msgid "See also L</pwrite>."
21933 #: ../fish/guestfish-actions.pod:3191
21938 #: ../fish/guestfish-actions.pod:3193
21941 " read-file path\n"
21946 #: ../fish/guestfish-actions.pod:3198
21948 "Unlike L</cat>, this function can correctly handle files that contain "
21949 "embedded ASCII NUL characters. However unlike L</download>, this function "
21950 "is limited in the total size of file that can be handled."
21954 #: ../fish/guestfish-actions.pod:3206
21959 #: ../fish/guestfish-actions.pod:3208
21962 " read-lines path\n"
21967 #: ../fish/guestfish-actions.pod:3215
21969 "Note that this function cannot correctly handle binary files (specifically, "
21970 "files containing C<\\0> character which is treated as end of line). For "
21971 "those you need to use the L</read-file> function which has a more complex "
21976 #: ../fish/guestfish-actions.pod:3220
21981 #: ../fish/guestfish-actions.pod:3222
21989 #: ../fish/guestfish-actions.pod:3274
21991 "This function is primarily intended for use by programs. To get a simple "
21992 "list of names, use L</ls>. To get a printable directory for human "
21993 "consumption, use L</ll>."
21997 #: ../fish/guestfish-actions.pod:3278
22002 #: ../fish/guestfish-actions.pod:3280
22010 #: ../fish/guestfish-actions.pod:3284
22011 msgid "readlinklist"
22015 #: ../fish/guestfish-actions.pod:3286
22018 " readlinklist path 'names ...'\n"
22023 #: ../fish/guestfish-actions.pod:3310
22028 #: ../fish/guestfish-actions.pod:3312
22036 #: ../fish/guestfish-actions.pod:3317
22037 msgid "removexattr"
22041 #: ../fish/guestfish-actions.pod:3319
22044 " removexattr xattr path\n"
22049 #: ../fish/guestfish-actions.pod:3324
22050 msgid "See also: L</lremovexattr>, L<attr(5)>."
22054 #: ../fish/guestfish-actions.pod:3326
22059 #: ../fish/guestfish-actions.pod:3328
22062 " resize2fs device\n"
22067 #: ../fish/guestfish-actions.pod:3333
22069 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
22070 "before calling this command. For unknown reasons C<resize2fs> sometimes "
22071 "gives an error about this and sometimes not. In any case, it is always safe "
22072 "to call L</e2fsck-f> before calling this function."
22076 #: ../fish/guestfish-actions.pod:3339
22077 msgid "resize2fs-size"
22081 #: ../fish/guestfish-actions.pod:3341
22084 " resize2fs-size device size\n"
22089 #: ../fish/guestfish-actions.pod:3343
22091 "This command is the same as L</resize2fs> except that it allows you to "
22092 "specify the new size (in bytes) explicitly."
22096 #: ../fish/guestfish-actions.pod:3346
22101 #: ../fish/guestfish-actions.pod:3348
22109 #: ../fish/guestfish-actions.pod:3352
22114 #: ../fish/guestfish-actions.pod:3354
22122 #: ../fish/guestfish-actions.pod:3360
22127 #: ../fish/guestfish-actions.pod:3362
22135 #: ../fish/guestfish-actions.pod:3366
22136 msgid "rmmountpoint"
22140 #: ../fish/guestfish-actions.pod:3368
22143 " rmmountpoint exemptpath\n"
22148 #: ../fish/guestfish-actions.pod:3370
22150 "This calls removes a mountpoint that was previously created with "
22151 "L</mkmountpoint>. See L</mkmountpoint> for full details."
22155 #: ../fish/guestfish-actions.pod:3374
22156 msgid "scrub-device"
22160 #: ../fish/guestfish-actions.pod:3376
22163 " scrub-device device\n"
22168 #: ../fish/guestfish-actions.pod:3387
22173 #: ../fish/guestfish-actions.pod:3389
22176 " scrub-file file\n"
22181 #: ../fish/guestfish-actions.pod:3399
22182 msgid "scrub-freespace"
22186 #: ../fish/guestfish-actions.pod:3401
22189 " scrub-freespace dir\n"
22194 #: ../fish/guestfish-actions.pod:3403
22196 "This command creates the directory C<dir> and then fills it with files until "
22197 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
22198 "deletes them. The intention is to scrub any free space on the partition "
22199 "containing C<dir>."
22203 #: ../fish/guestfish-actions.pod:3412
22208 #: ../fish/guestfish-actions.pod:3414
22213 #: ../fish/guestfish-actions.pod:3416
22216 " set-append append\n"
22221 #: ../fish/guestfish-actions.pod:3427
22222 msgid "set-autosync"
22226 #: ../fish/guestfish-actions.pod:3429
22231 #: ../fish/guestfish-actions.pod:3431
22234 " set-autosync true|false\n"
22239 #: ../fish/guestfish-actions.pod:3433
22241 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
22242 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
22243 "closed (also if the program exits without closing handles)."
22247 #: ../fish/guestfish-actions.pod:3441
22252 #: ../fish/guestfish-actions.pod:3443
22257 #: ../fish/guestfish-actions.pod:3445
22260 " set-direct true|false\n"
22265 #: ../fish/guestfish-actions.pod:3451
22267 "One consequence of this is that log messages aren't caught by the library "
22268 "and handled by L</set-log-message-callback>, but go straight to stdout."
22272 #: ../fish/guestfish-actions.pod:3460
22273 msgid "set-e2label"
22277 #: ../fish/guestfish-actions.pod:3462
22280 " set-e2label device label\n"
22285 #: ../fish/guestfish-actions.pod:3468
22287 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
22288 "label on a filesystem."
22292 #: ../fish/guestfish-actions.pod:3471
22297 #: ../fish/guestfish-actions.pod:3473
22300 " set-e2uuid device uuid\n"
22305 #: ../fish/guestfish-actions.pod:3480
22307 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
22308 "UUID of a filesystem."
22312 #: ../fish/guestfish-actions.pod:3483
22313 msgid "set-memsize"
22317 #: ../fish/guestfish-actions.pod:3485
22322 #: ../fish/guestfish-actions.pod:3487
22325 " set-memsize memsize\n"
22330 #: ../fish/guestfish-actions.pod:3489
22332 "This sets the memory size in megabytes allocated to the qemu subprocess. "
22333 "This only has any effect if called before L</launch>."
22337 #: ../fish/guestfish-actions.pod:3500
22338 msgid "set-network"
22342 #: ../fish/guestfish-actions.pod:3502
22347 #: ../fish/guestfish-actions.pod:3504
22350 " set-network true|false\n"
22355 #: ../fish/guestfish-actions.pod:3512
22356 msgid "You must call this before calling L</launch>, otherwise it has no effect."
22360 #: ../fish/guestfish-actions.pod:3515
22365 #: ../fish/guestfish-actions.pod:3517
22370 #: ../fish/guestfish-actions.pod:3519
22373 " set-path searchpath\n"
22378 #: ../fish/guestfish-actions.pod:3528
22383 #: ../fish/guestfish-actions.pod:3530
22388 #: ../fish/guestfish-actions.pod:3532
22396 #: ../fish/guestfish-actions.pod:3552
22397 msgid "set-recovery-proc"
22401 #: ../fish/guestfish-actions.pod:3554
22402 msgid "recovery-proc"
22406 #: ../fish/guestfish-actions.pod:3556
22409 " set-recovery-proc true|false\n"
22414 #: ../fish/guestfish-actions.pod:3558
22416 "If this is called with the parameter C<false> then L</launch> does not "
22417 "create a recovery process. The purpose of the recovery process is to stop "
22418 "runaway qemu processes in the case where the main program aborts abruptly."
22422 #: ../fish/guestfish-actions.pod:3563
22424 "This only has any effect if called before L</launch>, and the default is "
22429 #: ../fish/guestfish-actions.pod:3572
22430 msgid "set-selinux"
22434 #: ../fish/guestfish-actions.pod:3574
22439 #: ../fish/guestfish-actions.pod:3576
22442 " set-selinux true|false\n"
22447 #: ../fish/guestfish-actions.pod:3587
22452 #: ../fish/guestfish-actions.pod:3589
22457 #: ../fish/guestfish-actions.pod:3591
22460 " set-trace true|false\n"
22465 #: ../fish/guestfish-actions.pod:3607
22466 msgid "set-verbose"
22470 #: ../fish/guestfish-actions.pod:3609
22475 #: ../fish/guestfish-actions.pod:3611
22478 " set-verbose true|false\n"
22483 #: ../fish/guestfish-actions.pod:3618
22488 #: ../fish/guestfish-actions.pod:3620
22491 " setcon context\n"
22496 #: ../fish/guestfish-actions.pod:3627
22501 #: ../fish/guestfish-actions.pod:3629
22504 " setxattr xattr val vallen path\n"
22509 #: ../fish/guestfish-actions.pod:3635
22510 msgid "See also: L</lsetxattr>, L<attr(5)>."
22514 #: ../fish/guestfish-actions.pod:3637
22519 #: ../fish/guestfish-actions.pod:3639
22522 " sfdisk device cyls heads sectors 'lines ...'\n"
22527 #: ../fish/guestfish-actions.pod:3661
22528 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
22532 #: ../fish/guestfish-actions.pod:3667
22537 #: ../fish/guestfish-actions.pod:3669
22540 " sfdiskM device 'lines ...'\n"
22545 #: ../fish/guestfish-actions.pod:3671
22547 "This is a simplified interface to the L</sfdisk> command, where partition "
22548 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
22549 "you don't need to specify the cyls, heads and sectors parameters which were "
22550 "rarely if ever used anyway."
22554 #: ../fish/guestfish-actions.pod:3677
22555 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
22559 #: ../fish/guestfish-actions.pod:3683
22564 #: ../fish/guestfish-actions.pod:3685
22567 " sfdisk-N device partnum cyls heads sectors line\n"
22572 #: ../fish/guestfish-actions.pod:3690
22574 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
22575 "cyls/heads/sectors parameters."
22579 #: ../fish/guestfish-actions.pod:3693
22580 msgid "See also: L</part-add>"
22584 #: ../fish/guestfish-actions.pod:3698
22585 msgid "sfdisk-disk-geometry"
22589 #: ../fish/guestfish-actions.pod:3700
22592 " sfdisk-disk-geometry device\n"
22597 #: ../fish/guestfish-actions.pod:3702
22599 "This displays the disk geometry of C<device> read from the partition table. "
22600 "Especially in the case where the underlying block device has been resized, "
22601 "this can be different from the kernel's idea of the geometry (see "
22602 "L</sfdisk-kernel-geometry>)."
22606 #: ../fish/guestfish-actions.pod:3710
22607 msgid "sfdisk-kernel-geometry"
22611 #: ../fish/guestfish-actions.pod:3712
22614 " sfdisk-kernel-geometry device\n"
22619 #: ../fish/guestfish-actions.pod:3719
22624 #: ../fish/guestfish-actions.pod:3721
22627 " sfdisk-l device\n"
22632 #: ../fish/guestfish-actions.pod:3727
22633 msgid "See also: L</part-list>"
22637 #: ../fish/guestfish-actions.pod:3729
22642 #: ../fish/guestfish-actions.pod:3731
22650 #: ../fish/guestfish-actions.pod:3736
22651 msgid "This is like L</command>, but passes the command to:"
22655 #: ../fish/guestfish-actions.pod:3744
22656 msgid "All the provisos about L</command> apply to this call."
22660 #: ../fish/guestfish-actions.pod:3746
22665 #: ../fish/guestfish-actions.pod:3748
22668 " sh-lines command\n"
22673 #: ../fish/guestfish-actions.pod:3750
22674 msgid "This is the same as L</sh>, but splits the result into a list of lines."
22678 #: ../fish/guestfish-actions.pod:3753
22679 msgid "See also: L</command-lines>"
22683 #: ../fish/guestfish-actions.pod:3755
22688 #: ../fish/guestfish-actions.pod:3757
22696 #: ../fish/guestfish-actions.pod:3761
22701 #: ../fish/guestfish-actions.pod:3763
22709 #: ../fish/guestfish-actions.pod:3769
22714 #: ../fish/guestfish-actions.pod:3771
22722 #: ../fish/guestfish-actions.pod:3779
22727 #: ../fish/guestfish-actions.pod:3781
22735 #: ../fish/guestfish-actions.pod:3789
22740 #: ../fish/guestfish-actions.pod:3791
22743 " strings-e encoding path\n"
22748 #: ../fish/guestfish-actions.pod:3793
22750 "This is like the L</strings> command, but allows you to specify the encoding "
22751 "of strings that are looked for in the source file C<path>."
22755 #: ../fish/guestfish-actions.pod:3803
22757 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
22758 "ISO-8859-X (this is what L</strings> uses)."
22762 #: ../fish/guestfish-actions.pod:3835
22763 msgid "swapoff-device"
22767 #: ../fish/guestfish-actions.pod:3837
22770 " swapoff-device device\n"
22775 #: ../fish/guestfish-actions.pod:3839
22777 "This command disables the libguestfs appliance swap device or partition "
22778 "named C<device>. See L</swapon-device>."
22782 #: ../fish/guestfish-actions.pod:3843
22783 msgid "swapoff-file"
22787 #: ../fish/guestfish-actions.pod:3845
22790 " swapoff-file file\n"
22795 #: ../fish/guestfish-actions.pod:3849
22796 msgid "swapoff-label"
22800 #: ../fish/guestfish-actions.pod:3851
22803 " swapoff-label label\n"
22808 #: ../fish/guestfish-actions.pod:3856
22809 msgid "swapoff-uuid"
22813 #: ../fish/guestfish-actions.pod:3858
22816 " swapoff-uuid uuid\n"
22821 #: ../fish/guestfish-actions.pod:3863
22822 msgid "swapon-device"
22826 #: ../fish/guestfish-actions.pod:3865
22829 " swapon-device device\n"
22834 #: ../fish/guestfish-actions.pod:3867
22836 "This command enables the libguestfs appliance to use the swap device or "
22837 "partition named C<device>. The increased memory is made available for all "
22838 "commands, for example those run using L</command> or L</sh>."
22842 #: ../fish/guestfish-actions.pod:3879
22843 msgid "swapon-file"
22847 #: ../fish/guestfish-actions.pod:3881
22850 " swapon-file file\n"
22855 #: ../fish/guestfish-actions.pod:3883
22856 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
22860 #: ../fish/guestfish-actions.pod:3886
22861 msgid "swapon-label"
22865 #: ../fish/guestfish-actions.pod:3888
22868 " swapon-label label\n"
22873 #: ../fish/guestfish-actions.pod:3890
22875 "This command enables swap to a labeled swap partition. See "
22876 "L</swapon-device> for other notes."
22880 #: ../fish/guestfish-actions.pod:3893
22881 msgid "swapon-uuid"
22885 #: ../fish/guestfish-actions.pod:3895
22888 " swapon-uuid uuid\n"
22893 #: ../fish/guestfish-actions.pod:3897
22895 "This command enables swap to a swap partition with the given UUID. See "
22896 "L</swapon-device> for other notes."
22900 #: ../fish/guestfish-actions.pod:3900
22905 #: ../fish/guestfish-actions.pod:3902
22913 #: ../fish/guestfish-actions.pod:3910
22918 #: ../fish/guestfish-actions.pod:3912
22926 #: ../fish/guestfish-actions.pod:3920
22931 #: ../fish/guestfish-actions.pod:3922
22934 " tail-n nrlines path\n"
22939 #: ../fish/guestfish-actions.pod:3935
22944 #: ../fish/guestfish-actions.pod:3937
22947 " tar-in (tarfile|-) directory\n"
22952 #: ../fish/guestfish-actions.pod:3942
22953 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
22957 #: ../fish/guestfish-actions.pod:3947
22962 #: ../fish/guestfish-actions.pod:3949
22965 " tar-out directory (tarfile|-)\n"
22970 #: ../fish/guestfish-actions.pod:3954
22971 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
22975 #: ../fish/guestfish-actions.pod:3959
22980 #: ../fish/guestfish-actions.pod:3961
22983 " tgz-in (tarball|-) directory\n"
22988 #: ../fish/guestfish-actions.pod:3966
22989 msgid "To upload an uncompressed tarball, use L</tar-in>."
22993 #: ../fish/guestfish-actions.pod:3970
22998 #: ../fish/guestfish-actions.pod:3972
23001 " tgz-out directory (tarball|-)\n"
23006 #: ../fish/guestfish-actions.pod:3977
23007 msgid "To download an uncompressed tarball, use L</tar-out>."
23011 #: ../fish/guestfish-actions.pod:3981
23016 #: ../fish/guestfish-actions.pod:3983
23024 #: ../fish/guestfish-actions.pod:3992
23029 #: ../fish/guestfish-actions.pod:3994
23037 #: ../fish/guestfish-actions.pod:3999
23038 msgid "truncate-size"
23042 #: ../fish/guestfish-actions.pod:4001
23045 " truncate-size path size\n"
23050 #: ../fish/guestfish-actions.pod:4006
23052 "If the current file size is less than C<size> then the file is extended to "
23053 "the required size with zero bytes. This creates a sparse file (ie. disk "
23054 "blocks are not allocated for the file until you write to it). To create a "
23055 "non-sparse file of zeroes, use L</fallocate64> instead."
23059 #: ../fish/guestfish-actions.pod:4012
23064 #: ../fish/guestfish-actions.pod:4014
23067 " tune2fs-l device\n"
23072 #: ../fish/guestfish-actions.pod:4024
23077 #: ../fish/guestfish-actions.pod:4026
23080 " txz-in (tarball|-) directory\n"
23085 #: ../fish/guestfish-actions.pod:4033
23090 #: ../fish/guestfish-actions.pod:4035
23093 " txz-out directory (tarball|-)\n"
23098 #: ../fish/guestfish-actions.pod:4042
23103 #: ../fish/guestfish-actions.pod:4044
23111 #: ../fish/guestfish-actions.pod:4058
23112 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
23116 #: ../fish/guestfish-actions.pod:4063
23121 #: ../fish/guestfish-actions.pod:4065
23126 #: ../fish/guestfish-actions.pod:4067
23129 " umount pathordevice\n"
23134 #: ../fish/guestfish-actions.pod:4073
23139 #: ../fish/guestfish-actions.pod:4075
23140 msgid "unmount-all"
23144 #: ../fish/guestfish-actions.pod:4077
23152 #: ../fish/guestfish-actions.pod:4083
23157 #: ../fish/guestfish-actions.pod:4085
23160 " upload (filename|-) remotefilename\n"
23165 #: ../fish/guestfish-actions.pod:4092
23166 msgid "See also L</download>."
23170 #: ../fish/guestfish-actions.pod:4096
23171 msgid "upload-offset"
23175 #: ../fish/guestfish-actions.pod:4098
23178 " upload-offset (filename|-) remotefilename offset\n"
23183 #: ../fish/guestfish-actions.pod:4110
23185 "Note that there is no limit on the amount of data that can be uploaded with "
23186 "this call, unlike with L</pwrite>, and this call always writes the full "
23187 "amount unless an error occurs."
23191 #: ../fish/guestfish-actions.pod:4115
23192 msgid "See also L</upload>, L</pwrite>."
23196 #: ../fish/guestfish-actions.pod:4119
23201 #: ../fish/guestfish-actions.pod:4121
23204 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
23209 #: ../fish/guestfish-actions.pod:4140
23214 #: ../fish/guestfish-actions.pod:4142
23222 #: ../fish/guestfish-actions.pod:4169
23224 "I<Note:> Don't use this call to test for availability of features. In "
23225 "enterprise distributions we backport features from later versions into "
23226 "earlier versions, making this an unreliable way to test for features. Use "
23227 "L</available> instead."
23231 #: ../fish/guestfish-actions.pod:4175
23236 #: ../fish/guestfish-actions.pod:4177
23239 " vfs-label device\n"
23244 #: ../fish/guestfish-actions.pod:4184
23245 msgid "To find a filesystem from the label, use L</findfs-label>."
23249 #: ../fish/guestfish-actions.pod:4186
23254 #: ../fish/guestfish-actions.pod:4188
23257 " vfs-type device\n"
23262 #: ../fish/guestfish-actions.pod:4198
23267 #: ../fish/guestfish-actions.pod:4200
23270 " vfs-uuid device\n"
23275 #: ../fish/guestfish-actions.pod:4207
23276 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
23280 #: ../fish/guestfish-actions.pod:4209
23281 msgid "vg-activate"
23285 #: ../fish/guestfish-actions.pod:4211
23288 " vg-activate true|false 'volgroups ...'\n"
23293 #: ../fish/guestfish-actions.pod:4224
23294 msgid "vg-activate-all"
23298 #: ../fish/guestfish-actions.pod:4226
23301 " vg-activate-all true|false\n"
23306 #: ../fish/guestfish-actions.pod:4236
23311 #: ../fish/guestfish-actions.pod:4238
23314 " vgcreate volgroup 'physvols ...'\n"
23319 #: ../fish/guestfish-actions.pod:4243
23324 #: ../fish/guestfish-actions.pod:4245
23327 " vglvuuids vgname\n"
23332 #: ../fish/guestfish-actions.pod:4250
23334 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
23335 "logical volumes and volume groups."
23339 #: ../fish/guestfish-actions.pod:4253
23340 msgid "See also L</vgpvuuids>."
23344 #: ../fish/guestfish-actions.pod:4255
23349 #: ../fish/guestfish-actions.pod:4257
23352 " vgpvuuids vgname\n"
23357 #: ../fish/guestfish-actions.pod:4262
23359 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
23360 "physical volumes and volume groups."
23364 #: ../fish/guestfish-actions.pod:4265
23365 msgid "See also L</vglvuuids>."
23369 #: ../fish/guestfish-actions.pod:4267
23374 #: ../fish/guestfish-actions.pod:4269
23377 " vgremove vgname\n"
23382 #: ../fish/guestfish-actions.pod:4276
23387 #: ../fish/guestfish-actions.pod:4278
23390 " vgrename volgroup newvolgroup\n"
23395 #: ../fish/guestfish-actions.pod:4282
23400 #: ../fish/guestfish-actions.pod:4284
23408 #: ../fish/guestfish-actions.pod:4292
23409 msgid "See also L</vgs-full>."
23413 #: ../fish/guestfish-actions.pod:4294
23418 #: ../fish/guestfish-actions.pod:4296
23426 #: ../fish/guestfish-actions.pod:4301
23431 #: ../fish/guestfish-actions.pod:4303
23439 #: ../fish/guestfish-actions.pod:4308
23444 #: ../fish/guestfish-actions.pod:4310
23452 #: ../fish/guestfish-actions.pod:4314
23457 #: ../fish/guestfish-actions.pod:4316
23465 #: ../fish/guestfish-actions.pod:4321
23470 #: ../fish/guestfish-actions.pod:4323
23478 #: ../fish/guestfish-actions.pod:4328
23483 #: ../fish/guestfish-actions.pod:4330
23491 #: ../fish/guestfish-actions.pod:4335
23496 #: ../fish/guestfish-actions.pod:4337
23499 " write path content\n"
23504 #: ../fish/guestfish-actions.pod:4345
23509 #: ../fish/guestfish-actions.pod:4347
23512 " write-file path content size\n"
23517 #: ../fish/guestfish-actions.pod:4370
23522 #: ../fish/guestfish-actions.pod:4372
23525 " zegrep regex path\n"
23530 #: ../fish/guestfish-actions.pod:4380
23535 #: ../fish/guestfish-actions.pod:4382
23538 " zegrepi regex path\n"
23543 #: ../fish/guestfish-actions.pod:4390
23548 #: ../fish/guestfish-actions.pod:4392
23556 #: ../fish/guestfish-actions.pod:4400
23557 msgid "See also: L</zero-device>, L</scrub-device>."
23561 #: ../fish/guestfish-actions.pod:4402
23562 msgid "zero-device"
23566 #: ../fish/guestfish-actions.pod:4404
23569 " zero-device device\n"
23574 #: ../fish/guestfish-actions.pod:4406
23576 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
23577 "which just zeroes the first few blocks of a device."
23581 #: ../fish/guestfish-actions.pod:4413
23586 #: ../fish/guestfish-actions.pod:4415
23589 " zerofree device\n"
23594 #: ../fish/guestfish-actions.pod:4428
23599 #: ../fish/guestfish-actions.pod:4430
23602 " zfgrep pattern path\n"
23607 #: ../fish/guestfish-actions.pod:4438
23612 #: ../fish/guestfish-actions.pod:4440
23615 " zfgrepi pattern path\n"
23620 #: ../fish/guestfish-actions.pod:4448
23625 #: ../fish/guestfish-actions.pod:4450
23628 " zfile meth path\n"
23633 #: ../fish/guestfish-actions.pod:4457
23634 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
23638 #: ../fish/guestfish-actions.pod:4467
23643 #: ../fish/guestfish-actions.pod:4469
23646 " zgrep regex path\n"
23651 #: ../fish/guestfish-actions.pod:4477
23656 #: ../fish/guestfish-actions.pod:4479
23659 " zgrepi regex path\n"
23664 #: ../fish/guestfish-commands.pod:1
23669 #: ../fish/guestfish-commands.pod:3
23674 #: ../fish/guestfish-commands.pod:5
23677 " alloc filename size\n"
23682 #: ../fish/guestfish-commands.pod:7
23684 "This creates an empty (zeroed) file of the given size, and then adds so it "
23685 "can be further examined."
23689 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
23690 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
23694 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
23695 msgid "Size can be specified using standard suffixes, eg. C<1M>."
23699 #: ../fish/guestfish-commands.pod:14
23701 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
23702 "image, see L</PREPARED DISK IMAGES>."
23706 #: ../fish/guestfish-commands.pod:17
23711 #: ../fish/guestfish-commands.pod:19
23714 " copy-in local [local ...] /remotedir\n"
23719 #: ../fish/guestfish-commands.pod:21
23721 "C<copy-in> copies local files or directories recursively into the disk "
23722 "image, placing them in the directory called C</remotedir> (which must "
23723 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
23724 "other commands as necessary."
23728 #: ../fish/guestfish-commands.pod:26
23730 "Multiple local files and directories can be specified, but the last "
23731 "parameter must always be a remote directory. Wildcards cannot be used."
23735 #: ../fish/guestfish-commands.pod:30
23740 #: ../fish/guestfish-commands.pod:32
23743 " copy-out remote [remote ...] localdir\n"
23748 #: ../fish/guestfish-commands.pod:34
23750 "C<copy-out> copies remote files or directories recursively out of the disk "
23751 "image, placing them on the host disk in a local directory called C<localdir> "
23752 "(which must exist). This guestfish meta-command turns into a sequence of "
23753 "L</download>, L</tar-out> and other commands as necessary."
23757 #: ../fish/guestfish-commands.pod:40
23759 "Multiple remote files and directories can be specified, but the last "
23760 "parameter must always be a local directory. To download to the current "
23761 "directory, use C<.> as in:"
23765 #: ../fish/guestfish-commands.pod:44
23768 " copy-out /home .\n"
23773 #: ../fish/guestfish-commands.pod:46
23775 "Wildcards cannot be used in the ordinary command, but you can use them with "
23776 "the help of L</glob> like this:"
23780 #: ../fish/guestfish-commands.pod:49
23783 " glob copy-out /home/* .\n"
23788 #: ../fish/guestfish-commands.pod:51
23793 #: ../fish/guestfish-commands.pod:53
23796 " echo [params ...]\n"
23801 #: ../fish/guestfish-commands.pod:55
23802 msgid "This echos the parameters to the terminal."
23806 #: ../fish/guestfish-commands.pod:57
23811 #: ../fish/guestfish-commands.pod:59
23816 #: ../fish/guestfish-commands.pod:61
23821 #: ../fish/guestfish-commands.pod:63
23829 #: ../fish/guestfish-commands.pod:65
23831 "This is used to edit a file. It downloads the file, edits it locally using "
23832 "your editor, then uploads the result."
23836 #: ../fish/guestfish-commands.pod:68
23838 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
23839 "or C<emacs> you will get those corresponding editors."
23843 #: ../fish/guestfish-commands.pod:72
23848 #: ../fish/guestfish-commands.pod:74
23851 " glob command args...\n"
23856 #: ../fish/guestfish-commands.pod:76
23858 "Expand wildcards in any paths in the args list, and run C<command> "
23859 "repeatedly on each matching path."
23863 #: ../fish/guestfish-commands.pod:79
23864 msgid "See L</WILDCARDS AND GLOBBING>."
23868 #: ../fish/guestfish-commands.pod:81
23873 #: ../fish/guestfish-commands.pod:83
23876 " hexedit <filename|device>\n"
23877 " hexedit <filename|device> <max>\n"
23878 " hexedit <filename|device> <start> <max>\n"
23883 #: ../fish/guestfish-commands.pod:87
23885 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
23890 #: ../fish/guestfish-commands.pod:90
23892 "This command works by downloading potentially the whole file or device, "
23893 "editing it locally, then uploading it. If the file or device is large, you "
23894 "have to specify which part you wish to edit by using C<max> and/or C<start> "
23895 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
23896 "usual modifiers allowed such as C<1M> (1 megabyte)."
23900 #: ../fish/guestfish-commands.pod:97
23901 msgid "For example to edit the first few sectors of a disk you might do:"
23905 #: ../fish/guestfish-commands.pod:100
23908 " hexedit /dev/sda 1M\n"
23913 #: ../fish/guestfish-commands.pod:102
23915 "which would allow you to edit anywhere within the first megabyte of the "
23920 #: ../fish/guestfish-commands.pod:105
23921 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
23925 #: ../fish/guestfish-commands.pod:107
23928 " hexedit /dev/sda1 0x400 0x400\n"
23933 #: ../fish/guestfish-commands.pod:109
23934 msgid "(assuming the superblock is in the standard location)."
23938 #: ../fish/guestfish-commands.pod:111
23940 "This command requires the external L<hexedit(1)> program. You can specify "
23941 "another program to use by setting the C<HEXEDITOR> environment variable."
23945 #: ../fish/guestfish-commands.pod:115
23946 msgid "See also L</hexdump>."
23950 #: ../fish/guestfish-commands.pod:117
23955 #: ../fish/guestfish-commands.pod:119
23963 #: ../fish/guestfish-commands.pod:121
23964 msgid "Change the local directory, ie. the current directory of guestfish itself."
23968 #: ../fish/guestfish-commands.pod:124
23969 msgid "Note that C<!cd> won't do what you might expect."
23973 #: ../fish/guestfish-commands.pod:126
23978 #: ../fish/guestfish-commands.pod:128
23983 #: ../fish/guestfish-commands.pod:130
23991 #: ../fish/guestfish-commands.pod:132
23992 msgid "Opens the manual page for guestfish."
23996 #: ../fish/guestfish-commands.pod:134
24001 #: ../fish/guestfish-commands.pod:136
24006 #: ../fish/guestfish-commands.pod:138
24014 #: ../fish/guestfish-commands.pod:140
24022 #: ../fish/guestfish-commands.pod:142
24023 msgid "This is used to view a file."
24027 #: ../fish/guestfish-commands.pod:144
24029 "The default viewer is C<$PAGER>. However if you use the alternate command "
24030 "C<less> you will get the C<less> command specifically."
24034 #: ../fish/guestfish-commands.pod:147
24039 #: ../fish/guestfish-commands.pod:149
24047 #: ../fish/guestfish-commands.pod:151
24049 "Close and reopen the libguestfs handle. It is not necessary to use this "
24050 "normally, because the handle is closed properly when guestfish exits. "
24051 "However this is occasionally useful for testing."
24055 #: ../fish/guestfish-commands.pod:155
24060 #: ../fish/guestfish-commands.pod:157
24063 " sparse filename size\n"
24068 #: ../fish/guestfish-commands.pod:159
24070 "This creates an empty sparse file of the given size, and then adds so it can "
24071 "be further examined."
24075 #: ../fish/guestfish-commands.pod:162
24077 "In all respects it works the same as the L</alloc> command, except that the "
24078 "image file is allocated sparsely, which means that disk blocks are not "
24079 "assigned to the file until they are needed. Sparse disk files only use "
24080 "space when written to, but they are slower and there is a danger you could "
24081 "run out of real disk space during a write operation."
24085 #: ../fish/guestfish-commands.pod:172
24090 #: ../fish/guestfish-commands.pod:174
24098 #: ../fish/guestfish-commands.pod:176
24100 "This command returns a list of the optional groups known to the daemon, and "
24101 "indicates which ones are supported by this build of the libguestfs "
24106 #: ../fish/guestfish-commands.pod:180
24107 msgid "See also L<guestfs(3)/AVAILABILITY>."
24111 #: ../fish/guestfish-commands.pod:182
24116 #: ../fish/guestfish-commands.pod:184
24119 " time command args...\n"
24124 #: ../fish/guestfish-commands.pod:186
24126 "Run the command as usual, but print the elapsed time afterwards. This can "
24127 "be useful for benchmarking operations."
24131 #: ../test-tool/libguestfs-test-tool.pod:5
24132 msgid "libguestfs-test-tool - End user tests for libguestfs"
24136 #: ../test-tool/libguestfs-test-tool.pod:9
24139 " libguestfs-test-tool [--options]\n"
24144 #: ../test-tool/libguestfs-test-tool.pod:13
24146 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
24147 "and developers, to allow them to check basic libguestfs functionality is "
24148 "working. This is needed because libguestfs occasionally breaks for reasons "
24149 "beyond our control: usually because of changes in the underlying qemu or "
24150 "kernel packages, or the host environment."
24154 #: ../test-tool/libguestfs-test-tool.pod:20
24155 msgid "If you suspect a problem in libguestfs, then just run:"
24159 #: ../test-tool/libguestfs-test-tool.pod:22
24162 " libguestfs-test-tool\n"
24167 #: ../test-tool/libguestfs-test-tool.pod:24
24168 msgid "It will print lots of diagnostic messages."
24172 #: ../test-tool/libguestfs-test-tool.pod:26
24173 msgid "If it runs to completion successfully, you will see this near the end:"
24177 #: ../test-tool/libguestfs-test-tool.pod:28
24180 " ===== TEST FINISHED OK =====\n"
24185 #: ../test-tool/libguestfs-test-tool.pod:30
24186 msgid "and the test tool will exit with code 0."
24190 #: ../test-tool/libguestfs-test-tool.pod:32
24192 "If it fails (and/or exits with non-zero error code), please paste the "
24193 "B<complete, unedited> output of the test tool into a bug report. More "
24194 "information about reporting bugs can be found on the "
24195 "L<http://libguestfs.org/> website."
24199 #: ../test-tool/libguestfs-test-tool.pod:41
24204 #: ../test-tool/libguestfs-test-tool.pod:43
24205 msgid "Display short usage information and exit."
24209 #: ../test-tool/libguestfs-test-tool.pod:45
24210 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
24214 #: ../test-tool/libguestfs-test-tool.pod:47
24216 "Pass an alternate name for the helper program. libguestfs-test-tool will "
24217 "normally look in the C<$libexec> directory that was configured when the tool "
24222 #: ../test-tool/libguestfs-test-tool.pod:51
24223 msgid "I<--qemu qemu_binary>"
24227 #: ../test-tool/libguestfs-test-tool.pod:53
24229 "If you have downloaded another qemu binary, point this option at the full "
24230 "path of the binary to try it."
24234 #: ../test-tool/libguestfs-test-tool.pod:56
24235 msgid "I<--qemudir qemu_source_dir>"
24239 #: ../test-tool/libguestfs-test-tool.pod:58
24241 "If you have compiled qemu from source, point this option at the source "
24242 "directory to try it."
24246 #: ../test-tool/libguestfs-test-tool.pod:61
24247 msgid "I<--timeout N>"
24251 #: ../test-tool/libguestfs-test-tool.pod:63
24253 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
24254 "does not usually need to be adjusted unless your machine is very slow."
24258 #: ../test-tool/libguestfs-test-tool.pod:69
24259 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
24263 #: ../test-tool/libguestfs-test-tool.pod:71
24265 "If you have compiled another version of qemu from source and would like to "
24266 "try that, then you can use the I<--qemudir> option to point to the qemu "
24267 "source directory."
24271 #: ../test-tool/libguestfs-test-tool.pod:75
24273 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
24274 "option to point to the binary."
24278 #: ../test-tool/libguestfs-test-tool.pod:78
24280 "When using an alternate qemu with libguestfs, usually you would need to "
24281 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
24282 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
24283 "when you use either of the I<--qemudir> or I<--qemu> options."
24287 #: ../test-tool/libguestfs-test-tool.pod:85
24289 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
24290 "I<1> if there was an error."
24294 #: ../test-tool/libguestfs-test-tool.pod:92
24295 msgid "/usr/libexec/libguestfs-test-tool-helper"
24299 #: ../test-tool/libguestfs-test-tool.pod:94
24301 "This helper program is run inside the appliance and provides additional "
24306 #: ../test-tool/libguestfs-test-tool.pod:97
24307 msgid "/usr/bin/mkisofs"
24311 #: ../test-tool/libguestfs-test-tool.pod:99
24313 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
24314 "which is used as part of the tests."
24318 #: ../test-tool/libguestfs-test-tool.pod:106
24320 "For the full list of environment variables which may affect libguestfs, "
24321 "please see the L<guestfs(3)> manual page."
24325 #: ../test-tool/libguestfs-test-tool.pod:111
24326 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
24330 #: ../test-tool/libguestfs-test-tool.pod:121
24331 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
24335 #: ../fuse/guestmount.pod:5
24336 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
24340 #: ../fuse/guestmount.pod:9
24343 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
24348 #: ../fuse/guestmount.pod:11
24351 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
24356 #: ../fuse/guestmount.pod:13
24359 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
24364 #: ../fuse/guestmount.pod:17
24366 "You must I<not> use C<guestmount> in read-write mode on live virtual "
24367 "machines. If you do this, you risk disk corruption in the VM."
24371 #: ../fuse/guestmount.pod:22
24373 "The guestmount program can be used to mount virtual machine filesystems and "
24374 "other disk images on the host. It uses libguestfs for access to the guest "
24375 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
24376 "a mountable device."
24380 #: ../fuse/guestmount.pod:27
24382 "Along with other options, you have to give at least one device (I<-a> "
24383 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
24384 "option) or use the I<-i> inspection option. How this works is better "
24385 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
24390 #: ../fuse/guestmount.pod:33
24392 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
24393 "by you, and the filesystem will not be visible to any other users unless you "
24394 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
24395 "the filesystem, use the C<fusermount -u> command."
24399 #: ../fuse/guestmount.pod:41
24401 "For a typical Windows guest which has its main filesystem on the first "
24406 #: ../fuse/guestmount.pod:44
24409 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
24414 #: ../fuse/guestmount.pod:46
24416 "For a typical Linux guest which has a /boot filesystem on the first "
24417 "partition, and the root filesystem on a logical volume:"
24421 #: ../fuse/guestmount.pod:49
24424 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
24429 #: ../fuse/guestmount.pod:51
24430 msgid "To get libguestfs to detect guest mountpoints for you:"
24434 #: ../fuse/guestmount.pod:53
24437 " guestmount -a guest.img -i --ro /mnt\n"
24442 #: ../fuse/guestmount.pod:55
24443 msgid "For a libvirt guest called \"Guest\" you could do:"
24447 #: ../fuse/guestmount.pod:57
24450 " guestmount -d Guest -i --ro /mnt\n"
24455 #: ../fuse/guestmount.pod:59
24457 "If you don't know what filesystems are contained in a guest or disk image, "
24458 "use L<virt-list-filesystems(1)> first:"
24462 #: ../fuse/guestmount.pod:62
24465 " virt-list-filesystems MyGuest\n"
24470 #: ../fuse/guestmount.pod:64
24472 "If you want to trace the libguestfs calls but without excessive debugging "
24473 "information, we recommend:"
24477 #: ../fuse/guestmount.pod:67
24480 " guestmount [...] --trace /mnt\n"
24485 #: ../fuse/guestmount.pod:69
24486 msgid "If you want to debug the program, we recommend:"
24490 #: ../fuse/guestmount.pod:71
24493 " guestmount [...] --trace --verbose /mnt\n"
24498 #: ../fuse/guestmount.pod:79
24499 msgid "Add a block device or virtual machine image."
24503 #: ../fuse/guestmount.pod:96
24504 msgid "B<--dir-cache-timeout N>"
24508 #: ../fuse/guestmount.pod:98
24510 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
24511 "seconds. The readdir cache [actually, there are several semi-independent "
24512 "caches] is populated after a readdir(2) call with the stat and extended "
24513 "attributes of the files in the directory, in anticipation that they will be "
24514 "requested soon after."
24518 #: ../fuse/guestmount.pod:104
24520 "There is also a different attribute cache implemented by FUSE (see the FUSE "
24521 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
24522 "requests, only cache existing ones."
24526 #: ../fuse/guestmount.pod:122
24528 "If you have untrusted raw-format guest disk images, you should use this "
24529 "option to specify the disk format. This avoids a possible security problem "
24530 "with malicious guests (CVE-2010-3851). See also "
24531 "L<guestfs(3)/guestfs_add_drive_opts>."
24535 #: ../fuse/guestmount.pod:127
24536 msgid "B<--fuse-help>"
24540 #: ../fuse/guestmount.pod:129
24541 msgid "Display help on special FUSE options (see I<-o> below)."
24545 #: ../fuse/guestmount.pod:133
24546 msgid "Display brief help and exit."
24550 #: ../fuse/guestmount.pod:146
24551 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
24555 #: ../fuse/guestmount.pod:148
24557 "Mount the named partition or logical volume on the given mountpoint B<in the "
24558 "guest> (this has nothing to do with mountpoints in the host)."
24562 #: ../fuse/guestmount.pod:151
24564 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
24565 "something on C</>."
24569 #: ../fuse/guestmount.pod:156
24571 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
24572 "unmounted. If you specify this option, then we don't attempt to sync the "
24573 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
24577 #: ../fuse/guestmount.pod:161
24578 msgid "B<-o option> | B<--option option>"
24582 #: ../fuse/guestmount.pod:163
24583 msgid "Pass extra options to FUSE."
24587 #: ../fuse/guestmount.pod:165
24589 "To get a list of all the extra options supported by FUSE, use the command "
24590 "below. Note that only the FUSE I<-o> options can be passed, and only some "
24591 "of them are a good idea."
24595 #: ../fuse/guestmount.pod:169
24598 " guestmount --fuse-help\n"
24603 #: ../fuse/guestmount.pod:171
24604 msgid "Some potentially useful FUSE options:"
24608 #: ../fuse/guestmount.pod:175
24609 msgid "B<-o allow_other>"
24613 #: ../fuse/guestmount.pod:177
24614 msgid "Allow other users to see the filesystem."
24618 #: ../fuse/guestmount.pod:179
24619 msgid "B<-o attr_timeout=N>"
24623 #: ../fuse/guestmount.pod:181
24624 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
24628 #: ../fuse/guestmount.pod:183
24629 msgid "B<-o kernel_cache>"
24633 #: ../fuse/guestmount.pod:185
24635 "Allow the kernel to cache files (reduces the number of reads that have to go "
24636 "through the L<guestfs(3)> API). This is generally a good idea if you can "
24637 "afford the extra memory usage."
24641 #: ../fuse/guestmount.pod:189
24642 msgid "B<-o uid=N> B<-o gid=N>"
24646 #: ../fuse/guestmount.pod:191
24648 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
24649 "the chosen values."
24653 #: ../fuse/guestmount.pod:198
24655 "Add devices and mount everything read-only. Also disallow writes and make "
24656 "the disk appear read-only to FUSE."
24660 #: ../fuse/guestmount.pod:201
24662 "This is highly recommended if you are not going to edit the guest disk. If "
24663 "the guest is running and this option is I<not> supplied, then there is a "
24664 "strong risk of disk corruption in the guest. We try to prevent this from "
24665 "happening, but it is not always possible."
24669 #: ../fuse/guestmount.pod:206
24670 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
24674 #: ../fuse/guestmount.pod:210
24675 msgid "Enable SELinux support for the guest."
24679 #: ../fuse/guestmount.pod:214
24680 msgid "Enable verbose messages from underlying libguestfs."
24684 #: ../fuse/guestmount.pod:218
24685 msgid "Display the program version and exit."
24689 #: ../fuse/guestmount.pod:222
24691 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
24692 "FOR READ AND WRITE>."
24696 #: ../fuse/guestmount.pod:225
24697 msgid "B<-x> | B<--trace>"
24701 #: ../fuse/guestmount.pod:227
24702 msgid "Trace libguestfs calls."
24706 #: ../fuse/guestmount.pod:229
24707 msgid "This also stops the daemon from forking into the background."
24711 #: ../fuse/guestmount.pod:235
24713 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
24714 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
24715 "L<http://fuse.sf.net/>."
24719 #: ../inspector/virt-inspector.pl:35
24721 "virt-inspector - Display operating system version and other information "
24722 "about a virtual machine"
24726 #: ../inspector/virt-inspector.pl:39
24729 " virt-inspector [--connect URI] domname\n"
24734 #: ../inspector/virt-inspector.pl:41
24737 " virt-inspector guest.img [guest.img ...]\n"
24742 #: ../inspector/virt-inspector.pl:45
24744 "B<virt-inspector> examines a virtual machine or disk image and tries to "
24745 "determine the version of the operating system and other information about "
24746 "the virtual machine."
24750 #: ../inspector/virt-inspector.pl:49
24751 msgid "Virt-inspector produces XML output for feeding into other programs."
24755 #: ../inspector/virt-inspector.pl:51
24757 "In the normal usage, use C<virt-inspector domname> where C<domname> is the "
24758 "libvirt domain (see: C<virsh list --all>)."
24762 #: ../inspector/virt-inspector.pl:54
24764 "You can also run virt-inspector directly on disk images from a single "
24765 "virtual machine. Use C<virt-inspector guest.img>. In rare cases a domain "
24766 "has several block devices, in which case you should list them one after "
24767 "another, with the first corresponding to the guest's C</dev/sda>, the second "
24768 "to the guest's C</dev/sdb> and so on."
24772 #: ../inspector/virt-inspector.pl:60
24774 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
24775 "inspect several virtual machines, you have to run virt-inspector several "
24776 "times (for example, from a shell script for-loop)."
24780 #: ../inspector/virt-inspector.pl:65
24782 "Because virt-inspector needs direct access to guest images, it won't "
24783 "normally work over remote libvirt connections."
24787 #: ../inspector/virt-inspector.pl:78 ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:181 ../tools/virt-df.pl:81 ../tools/virt-ls.pl:88 ../tools/virt-list-filesystems.pl:60 ../tools/virt-cat.pl:89 ../tools/virt-tar.pl:108 ../tools/virt-rescue.pl:113 ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:61
24788 msgid "Display brief help."
24792 #: ../inspector/virt-inspector.pl:84 ../tools/virt-edit.pl:88 ../tools/virt-win-reg.pl:187 ../tools/virt-df.pl:87 ../tools/virt-ls.pl:94 ../tools/virt-resize.pl:273 ../tools/virt-list-filesystems.pl:66 ../tools/virt-cat.pl:95 ../tools/virt-tar.pl:114 ../tools/virt-rescue.pl:119 ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:67
24793 msgid "B<--version>"
24797 #: ../inspector/virt-inspector.pl:86 ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:189 ../tools/virt-df.pl:89 ../tools/virt-ls.pl:96 ../tools/virt-resize.pl:275 ../tools/virt-list-filesystems.pl:68 ../tools/virt-cat.pl:97 ../tools/virt-tar.pl:116 ../tools/virt-rescue.pl:121 ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:69
24798 msgid "Display version number and exit."
24802 #: ../inspector/virt-inspector.pl:92 ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:203 ../tools/virt-df.pl:95 ../tools/virt-ls.pl:102 ../tools/virt-list-filesystems.pl:74 ../tools/virt-cat.pl:103 ../tools/virt-tar.pl:122 ../tools/virt-rescue.pl:135 ../tools/virt-list-partitions.pl:75
24803 msgid "B<--connect URI> | B<-c URI>"
24807 #: ../inspector/virt-inspector.pl:94 ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:205 ../tools/virt-df.pl:97 ../tools/virt-ls.pl:104 ../tools/virt-list-filesystems.pl:76 ../tools/virt-cat.pl:105 ../tools/virt-tar.pl:124 ../tools/virt-rescue.pl:137 ../tools/virt-list-partitions.pl:77
24809 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
24810 "to the default libvirt hypervisor."
24814 #: ../inspector/virt-inspector.pl:97
24816 "Libvirt is only used if you specify a C<domname> on the command line. If "
24817 "you specify guest block devices directly, then libvirt is not used at all."
24821 #: ../inspector/virt-inspector.pl:105 ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:215 ../tools/virt-df.pl:117 ../tools/virt-ls.pl:114 ../tools/virt-resize.pl:523 ../tools/virt-list-filesystems.pl:86 ../tools/virt-cat.pl:115 ../tools/virt-tar.pl:134 ../tools/virt-rescue.pl:147 ../tools/virt-list-partitions.pl:87
24822 msgid "B<--format> raw"
24826 #: ../inspector/virt-inspector.pl:107 ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:217 ../tools/virt-df.pl:119 ../tools/virt-ls.pl:116 ../tools/virt-list-filesystems.pl:88 ../tools/virt-cat.pl:117 ../tools/virt-tar.pl:136 ../tools/virt-rescue.pl:149 ../tools/virt-list-partitions.pl:89
24828 "Specify the format of disk images given on the command line. If this is "
24829 "omitted then the format is autodetected from the content of the disk image."
24833 #: ../inspector/virt-inspector.pl:111 ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:221 ../tools/virt-df.pl:123 ../tools/virt-ls.pl:120 ../tools/virt-list-filesystems.pl:92 ../tools/virt-cat.pl:121 ../tools/virt-tar.pl:140 ../tools/virt-rescue.pl:153 ../tools/virt-list-partitions.pl:93
24835 "If disk images are requested from libvirt, then this program asks libvirt "
24836 "for this information. In this case, the value of the format parameter is "
24841 #: ../inspector/virt-inspector.pl:115 ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:225 ../tools/virt-df.pl:127 ../tools/virt-ls.pl:124 ../tools/virt-resize.pl:528 ../tools/virt-resize.pl:543 ../tools/virt-list-filesystems.pl:96 ../tools/virt-cat.pl:125 ../tools/virt-tar.pl:144 ../tools/virt-rescue.pl:157 ../tools/virt-list-partitions.pl:97
24843 "If working with untrusted raw-format guest disk images, you should ensure "
24844 "the format is always specified."
24848 #: ../inspector/virt-inspector.pl:149
24853 #: ../inspector/virt-inspector.pl:151
24855 "The virt-inspector XML is described precisely in a RELAX NG schema which is "
24856 "supplied with libguestfs. This section is just an overview."
24860 #: ../inspector/virt-inspector.pl:154
24862 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
24863 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
24864 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
24865 "which is vanishingly rare in real world VMs."
24869 #: ../inspector/virt-inspector.pl:159
24870 msgid "E<lt>operatingsystemE<gt>"
24874 #: ../inspector/virt-inspector.pl:161
24876 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
24877 "describe the operating system, its architecture, the descriptive \"product "
24878 "name\" string, the type of OS and so on, as in this example:"
24882 #: ../inspector/virt-inspector.pl:165
24885 " <operatingsystems>\n"
24886 " <operatingsystem>\n"
24887 " <root>/dev/sda2</root>\n"
24888 " <name>windows</name>\n"
24889 " <arch>i386</arch>\n"
24890 " <distro>windows</distro>\n"
24891 " <product_name>Windows 7 Enterprise</product_name>\n"
24892 " <major_version>6</major_version>\n"
24893 " <minor_version>1</minor_version>\n"
24894 " <windows_systemroot>/Windows</windows_systemroot>\n"
24899 #: ../inspector/virt-inspector.pl:176
24901 "These fields are derived from the libguestfs inspection API, and you can "
24902 "find more details in L<guestfs(3)/INSPECTION>."
24906 #: ../inspector/virt-inspector.pl:179
24908 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
24909 "of view of libguestfs (block devices may have completely different names "
24910 "inside the VM itself)."
24914 #: ../inspector/virt-inspector.pl:240
24915 msgid "E<lt>mountpointsE<gt>"
24919 #: ../inspector/virt-inspector.pl:242
24921 "Un*x-like guests typically have multiple filesystems which are mounted at "
24922 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
24923 "element which looks like this:"
24927 #: ../inspector/virt-inspector.pl:246
24930 " <operatingsystems>\n"
24931 " <operatingsystem>\n"
24934 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
24935 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
24936 " </mountpoints>\n"
24941 #: ../inspector/virt-inspector.pl:254
24943 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
24944 "and may have completely different names inside the guest. Only mountable "
24945 "filesystems appear in this list, not things like swap devices."
24949 #: ../inspector/virt-inspector.pl:276
24950 msgid "E<lt>filesystemsE<gt>"
24954 #: ../inspector/virt-inspector.pl:278
24956 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
24957 "filesystems belonging to the guest, including swap and empty partitions. "
24958 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
24959 "this OS or shared by this OS and other OSes)."
24963 #: ../inspector/virt-inspector.pl:283
24964 msgid "You might see something like this:"
24968 #: ../inspector/virt-inspector.pl:285
24971 " <operatingsystems>\n"
24972 " <operatingsystem>\n"
24975 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
24976 " <type>ext4</type>\n"
24977 " <label>Fedora-13-x86_64</label>\n"
24978 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
24984 #: ../inspector/virt-inspector.pl:295
24986 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
24987 "the label, and the UUID."
24991 #: ../inspector/virt-inspector.pl:337
24992 msgid "E<lt>applicationsE<gt>"
24996 #: ../inspector/virt-inspector.pl:339
24998 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
24999 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
25000 "machine. At the moment we are only able to list RPMs and Debian packages "
25001 "installed, but in future we will support other Linux distros and Windows."
25005 #: ../inspector/virt-inspector.pl:345
25007 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
25008 "Typical values would be C<rpm> and C<deb>."
25012 #: ../inspector/virt-inspector.pl:348
25014 "E<lt>package_managementE<gt>, if present, describes the package manager. "
25015 "Typical values include C<yum>, C<up2date> and C<apt>"
25019 #: ../inspector/virt-inspector.pl:351
25020 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
25024 #: ../inspector/virt-inspector.pl:354
25027 " <operatingsystems>\n"
25028 " <operatingsystem>\n"
25030 " <applications>\n"
25032 " <name>coreutils</name>\n"
25033 " <version>8.5</version>\n"
25034 " <release>1</release>\n"
25035 " </application>\n"
25040 #: ../inspector/virt-inspector.pl:364
25042 "(The version and release fields may not be available for some package "
25047 #: ../inspector/virt-inspector.pl:544
25048 msgid "USING XPATH"
25052 #: ../inspector/virt-inspector.pl:546
25054 "You can use the XPath query language, and/or the xpath tool, in order to "
25055 "select parts of the XML."
25059 #: ../inspector/virt-inspector.pl:551
25062 " $ virt-inspector Guest | xpath //filesystems\n"
25063 " Found 1 nodes:\n"
25066 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
25067 " <type>ext4</type>\n"
25073 #: ../inspector/virt-inspector.pl:559
25076 " $ virt-inspector Guest | \\\n"
25077 " xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
25078 " Query didn't return a nodeset. Value: ext4\n"
25083 #: ../inspector/virt-inspector.pl:563 ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:141 ../tools/virt-win-reg.pl:477 ../tools/virt-df.pl:633 ../tools/virt-ls.pl:225 ../tools/virt-resize.pl:1479 ../tools/virt-list-filesystems.pl:179 ../tools/virt-cat.pl:178 ../tools/virt-tar.pl:274 ../tools/virt-rescue.pl:260 ../tools/virt-make-fs.pl:527 ../tools/virt-list-partitions.pl:247
25084 msgid "SHELL QUOTING"
25088 #: ../inspector/virt-inspector.pl:565 ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:479 ../tools/virt-df.pl:635 ../tools/virt-ls.pl:227 ../tools/virt-resize.pl:1481 ../tools/virt-list-filesystems.pl:181 ../tools/virt-cat.pl:180 ../tools/virt-tar.pl:276 ../tools/virt-rescue.pl:262 ../tools/virt-make-fs.pl:529 ../tools/virt-list-partitions.pl:249
25090 "Libvirt guest names can contain arbitrary characters, some of which have "
25091 "meaning to the shell such as C<#> and space. You may need to quote or "
25092 "escape these characters on the command line. See the shell manual page "
25093 "L<sh(1)> for details."
25097 #: ../inspector/virt-inspector.pl:572
25099 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
25100 "L<Sys::Virt(3)>, L<http://www.w3.org/TR/xpath/>, L<http://libguestfs.org/>."
25104 #: ../inspector/virt-inspector.pl:586 ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:512 ../tools/virt-df.pl:651 ../tools/virt-ls.pl:245 ../tools/virt-resize.pl:1510 ../tools/virt-list-filesystems.pl:200 ../tools/virt-cat.pl:197 ../tools/virt-tar.pl:294 ../tools/virt-rescue.pl:279 ../tools/virt-make-fs.pl:561 ../tools/virt-list-partitions.pl:267
25105 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
25109 #: ../inspector/virt-inspector.pl:590
25110 msgid "Matthew Booth L<mbooth@redhat.com>"
25114 #: ../inspector/virt-inspector.pl:596 ../tools/virt-win-reg.pl:516 ../tools/virt-resize.pl:1514 ../tools/virt-make-fs.pl:565
25115 msgid "Copyright (C) 2010 Red Hat Inc."
25119 #: ../tools/virt-edit.pl:34
25120 msgid "virt-edit - Edit a file in a virtual machine"
25124 #: ../tools/virt-edit.pl:38
25127 " virt-edit [--options] domname file\n"
25132 #: ../tools/virt-edit.pl:40
25135 " virt-edit [--options] disk.img [disk.img ...] file\n"
25140 #: ../tools/virt-edit.pl:42
25143 " virt-edit [domname|disk.img] file -e 'expr'\n"
25148 #: ../tools/virt-edit.pl:46
25150 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
25151 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
25152 "doing this, but doesn't catch all cases."
25156 #: ../tools/virt-edit.pl:52
25158 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
25159 "the named virtual machine (or disk image)."
25163 #: ../tools/virt-edit.pl:55
25165 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
25166 "you should look at the L<guestfish(1)> tool."
25170 #: ../tools/virt-edit.pl:60
25171 msgid "Edit the named files interactively:"
25175 #: ../tools/virt-edit.pl:62
25178 " virt-edit mydomain /boot/grub/grub.conf\n"
25183 #: ../tools/virt-edit.pl:64
25186 " virt-edit mydomain /etc/passwd\n"
25191 #: ../tools/virt-edit.pl:66
25193 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
25194 "below). To change the init default level to 5:"
25198 #: ../tools/virt-edit.pl:70
25201 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
25206 #: ../tools/virt-edit.pl:96
25207 msgid "B<--backup extension> | B<-b extension>"
25211 #: ../tools/virt-edit.pl:98
25213 "Create a backup of the original file I<in the guest disk image>. The backup "
25214 "has the original filename with C<extension> added."
25218 #: ../tools/virt-edit.pl:101
25220 "Usually the first character of C<extension> would be a dot C<.> so you would "
25225 #: ../tools/virt-edit.pl:104
25228 " virt-edit -b .orig [etc]\n"
25233 #: ../tools/virt-edit.pl:106
25234 msgid "By default, no backup file is made."
25238 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:208 ../tools/virt-df.pl:100 ../tools/virt-ls.pl:107 ../tools/virt-list-filesystems.pl:79 ../tools/virt-cat.pl:108 ../tools/virt-tar.pl:127 ../tools/virt-rescue.pl:140 ../tools/virt-list-partitions.pl:80
25240 "If you specify guest block devices directly, then libvirt is not used at "
25245 #: ../tools/virt-edit.pl:141
25246 msgid "B<--expr EXPR> | B<-e EXPR>"
25250 #: ../tools/virt-edit.pl:143
25252 "Instead of launching the external editor, non-interactively apply the Perl "
25253 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
25258 #: ../tools/virt-edit.pl:147
25260 "Be careful to properly quote the expression to prevent it from being altered "
25265 #: ../tools/virt-edit.pl:268
25266 msgid "NON-INTERACTIVE EDITING"
25270 #: ../tools/virt-edit.pl:270
25272 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
25273 "administrator can interactively edit the file."
25277 #: ../tools/virt-edit.pl:273
25279 "There are two ways also to use C<virt-edit> from scripts in order to make "
25280 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
25281 "like this, it's less error-prone to write scripts directly using the "
25282 "libguestfs API and Augeas for configuration file editing.)"
25286 #: ../tools/virt-edit.pl:279
25288 "The first method is to temporarily set C<$EDITOR> to any script or program "
25289 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
25290 "update C<tmpfile> in place however it likes."
25294 #: ../tools/virt-edit.pl:283
25296 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
25297 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
25298 "instances of C<foo> with C<bar> in a file:"
25302 #: ../tools/virt-edit.pl:287
25305 " virt-edit domname filename -e 's/foo/bar/'\n"
25310 #: ../tools/virt-edit.pl:289
25312 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
25313 "For example to delete root's password you could do:"
25317 #: ../tools/virt-edit.pl:292
25320 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
25325 #: ../tools/virt-edit.pl:294
25327 "What really happens is that the snippet is evaluated as a Perl expression "
25328 "for each line of the file. The line, including the final C<\\n>, is passed "
25329 "in C<$_> and the expression should update C<$_> or leave it unchanged."
25333 #: ../tools/virt-edit.pl:299
25335 "To delete a line, set C<$_> to the empty string. For example, to delete the "
25336 "C<apache> user account from the password file you can do:"
25340 #: ../tools/virt-edit.pl:302
25343 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
25348 #: ../tools/virt-edit.pl:304
25350 "To insert a line, prepend or append it to C<$_>. However appending lines to "
25351 "the end of the file is rather difficult this way since there is no concept "
25352 "of \"last line of the file\" - your expression just doesn't get called "
25353 "again. You might want to use the first method (setting C<$EDITOR>) if you "
25358 #: ../tools/virt-edit.pl:310
25360 "The variable C<$lineno> contains the current line number. As is "
25361 "traditional, the first line in the file is number C<1>."
25365 #: ../tools/virt-edit.pl:313
25367 "The return value from the expression is ignored, but the expression may call "
25368 "C<die> in order to abort the whole program, leaving the original file "
25373 #: ../tools/virt-edit.pl:317
25375 "Remember when matching the end of a line that C<$_> may contain the final "
25376 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
25377 "newline then neither of these. Thus to match or substitute some text at the "
25378 "end of a line, use this regular expression:"
25382 #: ../tools/virt-edit.pl:322
25385 " /some text(\\r?\\n)?$/\n"
25390 #: ../tools/virt-edit.pl:324
25392 "Alternately, use the perl C<chomp> function, being careful not to chomp "
25393 "C<$_> itself (since that would remove all newlines from the file):"
25397 #: ../tools/virt-edit.pl:328
25400 " my $m = $_; chomp $m; $m =~ /some text$/\n"
25405 #: ../tools/virt-edit.pl:334
25410 #: ../tools/virt-edit.pl:336
25412 "If set, this string is used as the editor. It may contain arguments, "
25413 "eg. C<\"emacs -nw\">"
25417 #: ../tools/virt-edit.pl:339
25418 msgid "If not set, C<vi> is used."
25422 #: ../tools/virt-edit.pl:352
25424 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
25425 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, "
25426 "L<perl(1)>, L<perlre(1)>."
25430 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:510 ../tools/virt-df.pl:649 ../tools/virt-ls.pl:243 ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:198 ../tools/virt-cat.pl:195 ../tools/virt-tar.pl:292 ../tools/virt-rescue.pl:277 ../tools/virt-make-fs.pl:559 ../tools/virt-list-partitions.pl:265
25435 #: ../tools/virt-edit.pl:368 ../tools/virt-df.pl:655 ../tools/virt-rescue.pl:283 ../tools/virt-list-partitions.pl:271
25436 msgid "Copyright (C) 2009-2010 Red Hat Inc."
25440 #: ../tools/virt-win-reg.pl:37
25442 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
25447 #: ../tools/virt-win-reg.pl:41
25450 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
25455 #: ../tools/virt-win-reg.pl:43
25458 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
25463 #: ../tools/virt-win-reg.pl:45
25466 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
25471 #: ../tools/virt-win-reg.pl:47
25474 " virt-win-reg --merge domname [input.reg ...]\n"
25479 #: ../tools/virt-win-reg.pl:49
25482 " virt-win-reg [--options] disk.img ... # instead of domname\n"
25487 #: ../tools/virt-win-reg.pl:53
25489 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
25490 "virtual machines. If you do this, you I<will> get irreversible disk "
25491 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
25492 "but doesn't catch all cases."
25496 #: ../tools/virt-win-reg.pl:58
25498 "Modifying the Windows Registry is an inherently risky operation. The format "
25499 "is deliberately obscure and undocumented, and Registry changes can leave the "
25500 "system unbootable. Therefore when using the C<--merge> option, make sure "
25501 "you have a reliable backup first."
25505 #: ../tools/virt-win-reg.pl:65
25507 "This program can export and merge Windows Registry entries from a Windows "
25512 #: ../tools/virt-win-reg.pl:68
25514 "The first parameter is the libvirt guest name or the raw disk image of a "
25519 #: ../tools/virt-win-reg.pl:71
25521 "If C<--merge> is I<not> specified, then the chosen registry key is "
25522 "displayed/exported (recursively). For example:"
25526 #: ../tools/virt-win-reg.pl:74
25529 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
25534 #: ../tools/virt-win-reg.pl:76
25535 msgid "You can also display single values from within registry keys, for example:"
25539 #: ../tools/virt-win-reg.pl:79
25542 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
25543 " $ virt-win-reg Windows7 $cvkey ProductName\n"
25544 " Windows 7 Enterprise\n"
25549 #: ../tools/virt-win-reg.pl:83
25551 "With C<--merge>, you can merge a textual regedit file into the Windows "
25556 #: ../tools/virt-win-reg.pl:86
25559 " $ virt-win-reg --merge Windows7 changes.reg\n"
25564 #: ../tools/virt-win-reg.pl:88
25565 msgid "SUPPORTED SYSTEMS"
25569 #: ../tools/virt-win-reg.pl:90
25571 "The program currently supports Windows NT-derived guests starting with "
25572 "Windows XP through to at least Windows 7."
25576 #: ../tools/virt-win-reg.pl:93
25578 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
25579 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
25580 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
25584 #: ../tools/virt-win-reg.pl:97
25586 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
25591 #: ../tools/virt-win-reg.pl:100
25593 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
25598 #: ../tools/virt-win-reg.pl:103
25603 #: ../tools/virt-win-reg.pl:105
25605 "This program is only meant for simple access to the registry. If you want "
25606 "to do complicated things with the registry, we suggest you download the "
25607 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
25608 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
25609 "L<hivexregedit(1)>."
25613 #: ../tools/virt-win-reg.pl:111
25618 #: ../tools/virt-win-reg.pl:113
25620 "C<virt-win-reg> expects that regedit files have already been reencoded in "
25621 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
25622 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
25623 "with Windows-style line endings, you may need to reencode the whole file "
25624 "before or after processing."
25628 #: ../tools/virt-win-reg.pl:119
25630 "To reencode a file from Windows format to Linux (before processing it with "
25631 "the C<--merge> option), you would do something like this:"
25635 #: ../tools/virt-win-reg.pl:122
25638 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
25643 #: ../tools/virt-win-reg.pl:124
25645 "To go in the opposite direction, after exporting and before sending the file "
25646 "to a Windows user, do something like this:"
25650 #: ../tools/virt-win-reg.pl:127
25653 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
25658 #: ../tools/virt-win-reg.pl:129
25659 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
25663 #: ../tools/virt-win-reg.pl:131
25665 "If you are unsure about the current encoding, use the L<file(1)> command. "
25666 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
25667 "Windows-style (CRLF) line endings, like this:"
25671 #: ../tools/virt-win-reg.pl:135
25674 " $ file software.reg\n"
25675 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
25676 " with CRLF line terminators\n"
25681 #: ../tools/virt-win-reg.pl:139
25682 msgid "This file would need conversion before you could C<--merge> it."
25686 #: ../tools/virt-win-reg.pl:143
25688 "Be careful when passing parameters containing C<\\> (backslash) in the "
25689 "shell. Usually you will have to use 'single quotes' or double backslashes "
25690 "(but not both) to protect them from the shell."
25694 #: ../tools/virt-win-reg.pl:147
25695 msgid "Paths and value names are case-insensitive."
25699 #: ../tools/virt-win-reg.pl:149
25700 msgid "CurrentControlSet etc."
25704 #: ../tools/virt-win-reg.pl:151
25706 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
25707 "Registry at the level of the hive file, and therefore you cannot modify "
25712 #: ../tools/virt-win-reg.pl:155
25714 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
25715 "circumstances it might refer to another control set. The way to find out is "
25716 "to look at the C<HKLM\\SYSTEM\\Select> key:"
25720 #: ../tools/virt-win-reg.pl:159
25723 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
25724 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
25725 " \"Current\"=dword:00000001\n"
25726 " \"Default\"=dword:00000001\n"
25727 " \"Failed\"=dword:00000000\n"
25728 " \"LastKnownGood\"=dword:00000002\n"
25733 #: ../tools/virt-win-reg.pl:166
25734 msgid "\"Current\" is the one which Windows will choose when it boots."
25738 #: ../tools/virt-win-reg.pl:168
25739 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
25743 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
25748 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:501
25749 msgid "Enable debugging messages."
25753 #: ../tools/virt-win-reg.pl:232
25758 #: ../tools/virt-win-reg.pl:234
25760 "In merge mode, this merges a textual regedit file into the Windows Registry "
25761 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
25762 "displays or exports Registry entries instead."
25766 #: ../tools/virt-win-reg.pl:238
25768 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
25769 "result in disk corruption. However exporting (without this flag) is always "
25774 #: ../tools/virt-win-reg.pl:246
25775 msgid "B<--encoding> UTF-16LE|ASCII"
25779 #: ../tools/virt-win-reg.pl:248
25781 "When merging (only), you may need to specify the encoding for strings to be "
25782 "used in the hive file. This is explained in detail in "
25783 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
25787 #: ../tools/virt-win-reg.pl:252
25789 "The default is to use UTF-16LE, which should work with recent versions of "
25794 #: ../tools/virt-win-reg.pl:486
25796 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
25797 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
25798 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
25799 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
25803 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
25805 "When reporting bugs, please enable debugging and capture the I<complete> "
25810 #: ../tools/virt-win-reg.pl:504
25813 " export LIBGUESTFS_DEBUG=1\n"
25814 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
25819 #: ../tools/virt-win-reg.pl:507
25821 "Attach /tmp/virt-win-reg.log to a new bug report at "
25822 "L<https://bugzilla.redhat.com/>"
25826 #: ../tools/virt-df.pl:36
25827 msgid "virt-df - Display free space on virtual filesystems"
25831 #: ../tools/virt-df.pl:40
25834 " virt-df [--options]\n"
25839 #: ../tools/virt-df.pl:42
25842 " virt-df [--options] domname\n"
25847 #: ../tools/virt-df.pl:44
25850 " virt-df [--options] disk.img [disk.img ...]\n"
25855 #: ../tools/virt-df.pl:48
25857 "C<virt-df> is a command line tool to display free space on virtual machine "
25858 "filesystems. Unlike other tools, it doesn't just display the amount of "
25859 "space allocated to a virtual machine, but can look inside the virtual "
25860 "machine to see how much space is really being used."
25864 #: ../tools/virt-df.pl:53
25866 "It is like the L<df(1)> command, but for virtual machines, except that it "
25867 "also works for Windows virtual machines."
25871 #: ../tools/virt-df.pl:56
25873 "If used without any arguments, C<virt-df> checks with libvirt to get a list "
25874 "of all active and inactive guests, and performs a C<df>-type operation on "
25875 "each one in turn, printing out the results."
25879 #: ../tools/virt-df.pl:60
25881 "If used with any argument(s), C<virt-df> performs a C<df>-type operation on "
25882 "either the single named libvirt domain, or on the disk image(s) listed on "
25883 "the command line (which must all belong to a single VM). In this mode (with "
25884 "arguments), C<virt-df> will I<only work for a single guest>. If you want to "
25885 "run on multiple guests, then you have to invoke C<virt-df> multiple times."
25889 #: ../tools/virt-df.pl:67
25891 "Use the C<--csv> option to get a format which can be easily parsed by other "
25892 "programs. Other options are mostly similar to standard C<df> options. See "
25893 "below for the complete list."
25897 #: ../tools/virt-df.pl:107
25902 #: ../tools/virt-df.pl:109
25904 "Write out the results in CSV format (comma-separated values). This format "
25905 "can be imported easily into databases and spreadsheets, but read L</NOTE "
25906 "ABOUT CSV FORMAT> below."
25910 #: ../tools/virt-df.pl:134
25911 msgid "B<--human-readable> | B<-h>"
25915 #: ../tools/virt-df.pl:136
25916 msgid "Print sizes in human-readable format."
25920 #: ../tools/virt-df.pl:138
25921 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
25925 #: ../tools/virt-df.pl:144
25926 msgid "B<--inodes> | B<-i>"
25930 #: ../tools/virt-df.pl:146
25931 msgid "Print inodes instead of blocks."
25935 #: ../tools/virt-df.pl:152
25936 msgid "B<--one-per-guest>"
25940 #: ../tools/virt-df.pl:154
25942 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
25943 "disks from several guests to a single libguestfs appliance."
25947 #: ../tools/virt-df.pl:157
25948 msgid "You might use this option in the following circumstances:"
25952 #: ../tools/virt-df.pl:163
25954 "If you think an untrusted guest might actively try to exploit the libguestfs "
25955 "appliance kernel, then this prevents one guest from interfering with the "
25956 "stats printed for another guest."
25960 #: ../tools/virt-df.pl:169
25962 "If the kernel has a bug which stops it from accessing a filesystem in one "
25963 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
25964 "and report stats for further guests."
25968 #: ../tools/virt-df.pl:180
25973 #: ../tools/virt-df.pl:182
25975 "Print UUIDs instead of names. This is useful for following a guest even "
25976 "when the guest is migrated or renamed, or when two guests happen to have the "
25981 #: ../tools/virt-df.pl:186
25983 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
25984 "images, we still print the disk image name even when this option is "
25989 #: ../tools/virt-df.pl:609
25990 msgid "NOTE ABOUT CSV FORMAT"
25994 #: ../tools/virt-df.pl:611
25996 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
25997 "should be easy to parse, but it is definitely not easy to parse."
26001 #: ../tools/virt-df.pl:614
26003 "Myth: Just split fields at commas. Reality: This does I<not> work "
26004 "reliably. This example has two columns:"
26008 #: ../tools/virt-df.pl:617
26011 " \"foo,bar\",baz\n"
26016 #: ../tools/virt-df.pl:619
26018 "Myth: Read the file one line at a time. Reality: This does I<not> work "
26019 "reliably. This example has one row:"
26023 #: ../tools/virt-df.pl:622
26032 #: ../tools/virt-df.pl:625
26034 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
26035 "packaged in major Linux distributions)."
26039 #: ../tools/virt-df.pl:628
26041 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
26042 "or Python's built-in csv library)."
26046 #: ../tools/virt-df.pl:631
26047 msgid "Most spreadsheets and databases can import CSV directly."
26051 #: ../tools/virt-df.pl:642
26053 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
26054 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26058 #: ../tools/virt-ls.pl:34
26059 msgid "virt-ls - List files in a virtual machine"
26063 #: ../tools/virt-ls.pl:38
26066 " virt-ls [--options] domname directory\n"
26071 #: ../tools/virt-ls.pl:40
26074 " virt-ls [--options] disk.img [disk.img ...] directory\n"
26079 #: ../tools/virt-ls.pl:44
26081 "C<virt-ls> is a command line tool to list the names of files in a directory "
26082 "inside a virtual machine or disk image."
26086 #: ../tools/virt-ls.pl:47
26088 "C<virt-ls> is just a simple wrapper around L<libguestfs(3)> functionality. "
26089 "For more complex cases you should look at the L<guestfish(1)> tool."
26093 #: ../tools/virt-ls.pl:51
26095 "C<virt-ls> can be used in one of three modes: simple, long and recursive. A "
26096 "simple listing is like the ordinary L<ls(1)> command:"
26100 #: ../tools/virt-ls.pl:54
26103 " $ virt-ls myguest /\n"
26111 #: ../tools/virt-ls.pl:59
26112 msgid "With the C<-l> (C<--long>) option, C<virt-ls> shows more detail:"
26116 #: ../tools/virt-ls.pl:61
26119 " $ virt-ls -l myguest /\n"
26121 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
26122 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
26128 #: ../tools/virt-ls.pl:67
26130 "With the C<-R> (C<--recursive>) option, C<virt-ls> lists the names of files "
26131 "and directories recursively:"
26135 #: ../tools/virt-ls.pl:70
26138 " $ virt-ls -R myguest /tmp\n"
26146 #: ../tools/virt-ls.pl:75
26148 "You I<cannot> combine these options. To do more complicated things, use "
26153 #: ../tools/virt-ls.pl:131 ../tools/virt-list-filesystems.pl:103 ../tools/virt-list-partitions.pl:112
26154 msgid "B<-l> | B<--long>"
26158 #: ../tools/virt-ls.pl:133
26159 msgid "B<-R> | B<--recursive>"
26163 #: ../tools/virt-ls.pl:135
26165 "Select the mode. With neither of these options, C<virt-ls> produces a "
26166 "simple, flat list of the files in the named directory."
26170 #: ../tools/virt-ls.pl:138
26172 "C<virt-ls -l> produces a \"long listing\", which shows more detail (just "
26173 "like the plain C<ls -l> command)."
26177 #: ../tools/virt-ls.pl:141
26179 "C<virt-ls -R> produces a recursive list of files starting at the named "
26180 "directory. See the documentation for L<guestfs(3)/guestfs_find> for precise "
26185 #: ../tools/virt-ls.pl:145
26186 msgid "You cannot combine these options."
26190 #: ../tools/virt-ls.pl:234
26192 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
26193 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
26194 "L<http://libguestfs.org/>."
26198 #: ../tools/virt-ls.pl:249 ../tools/virt-list-filesystems.pl:204 ../tools/virt-cat.pl:201 ../tools/virt-tar.pl:298
26199 msgid "Copyright (C) 2009 Red Hat Inc."
26203 #: ../tools/virt-resize.pl:42
26204 msgid "virt-resize - Resize a virtual machine disk"
26208 #: ../tools/virt-resize.pl:46
26211 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
26212 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
26213 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
26218 #: ../tools/virt-resize.pl:52
26220 "Virt-resize is a tool which can resize a virtual machine disk, making it "
26221 "larger or smaller overall, and resizing or deleting any partitions contained "
26226 #: ../tools/virt-resize.pl:56
26228 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
26229 "not> be used on live virtual machines - for consistent results, shut the "
26230 "virtual machine down before resizing it."
26234 #: ../tools/virt-resize.pl:60
26236 "If you are not familiar with the associated tools: "
26237 "L<virt-list-partitions(1)>, L<virt-list-filesystems(1)> and L<virt-df(1)>, "
26238 "we recommend you go and read those manual pages first."
26242 #: ../tools/virt-resize.pl:68
26244 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
26245 "fill the extra 5GB of space."
26249 #: ../tools/virt-resize.pl:71
26252 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
26253 " virt-list-partitions -lht olddisk\n"
26254 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
26255 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
26260 #: ../tools/virt-resize.pl:76
26262 "As above, but make the /boot partition 200MB bigger, while giving the "
26263 "remaining space to /dev/sda2:"
26267 #: ../tools/virt-resize.pl:79
26270 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
26275 #: ../tools/virt-resize.pl:81
26276 msgid "As above, but the output format will be uncompressed qcow2:"
26280 #: ../tools/virt-resize.pl:83
26283 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
26284 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
26289 #: ../tools/virt-resize.pl:86
26290 msgid "DETAILED USAGE"
26294 #: ../tools/virt-resize.pl:88
26295 msgid "EXPANDING A VIRTUAL MACHINE DISK"
26299 #: ../tools/virt-resize.pl:92
26300 msgid "1. Shut down the virtual machine"
26304 #: ../tools/virt-resize.pl:94
26305 msgid "2. Locate input disk image"
26309 #: ../tools/virt-resize.pl:96
26311 "Locate the input disk image (ie. the file or device on the host containing "
26312 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
26313 "dumpxml> like this to find the disk image name:"
26317 #: ../tools/virt-resize.pl:100
26320 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
26321 " Found 1 nodes:\n"
26323 " <source dev=\"/dev/vg/lv_guest\" />\n"
26328 #: ../tools/virt-resize.pl:105
26329 msgid "3. Look at current sizing"
26333 #: ../tools/virt-resize.pl:107
26334 msgid "Use L<virt-list-partitions(1)> to display the current partitions and sizes:"
26338 #: ../tools/virt-resize.pl:110
26341 " # virt-list-partitions -lht /dev/vg/lv_guest\n"
26342 " /dev/sda1 ext3 101.9M\n"
26343 " /dev/sda2 pv 7.9G\n"
26344 " /dev/sda device 8.0G\n"
26349 #: ../tools/virt-resize.pl:115
26351 "(This example is a virtual machine with an 8 GB disk which we would like to "
26352 "expand up to 10 GB)."
26356 #: ../tools/virt-resize.pl:118
26357 msgid "4. Create output disk"
26361 #: ../tools/virt-resize.pl:120
26363 "Virt-resize cannot do in-place disk modifications. You have to have space "
26364 "to store the resized output disk."
26368 #: ../tools/virt-resize.pl:123
26369 msgid "To store the resized disk image in a file, create a file of a suitable size:"
26373 #: ../tools/virt-resize.pl:126
26376 " # rm -f outdisk\n"
26377 " # truncate -s 10G outdisk\n"
26382 #: ../tools/virt-resize.pl:129
26383 msgid "Or use L<lvcreate(1)> to create a logical volume:"
26387 #: ../tools/virt-resize.pl:131
26390 " # lvcreate -L 10G -n lv_name vg_name\n"
26395 #: ../tools/virt-resize.pl:133
26396 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
26400 #: ../tools/virt-resize.pl:135
26403 " # virsh pool-list\n"
26404 " # virsh vol-create-as poolname newvol 10G\n"
26409 #: ../tools/virt-resize.pl:138
26414 #: ../tools/virt-resize.pl:140
26416 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
26417 "file) and the output disk. The output disk is the one created in the "
26422 #: ../tools/virt-resize.pl:144
26425 " # virt-resize indisk outdisk\n"
26430 #: ../tools/virt-resize.pl:146
26432 "This command just copies disk image C<indisk> to disk image C<outdisk> "
26433 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
26434 "larger, then an extra, empty partition is created at the end of the disk "
26435 "covering the extra space. If C<outdisk> is smaller, then it will give an "
26440 #: ../tools/virt-resize.pl:152
26442 "More realistically you'd want to expand existing partitions in the disk "
26443 "image by passing extra options (for the full list see the L</OPTIONS> "
26448 #: ../tools/virt-resize.pl:156
26450 "L</--expand> is the most useful option. It expands the named partition "
26451 "within the disk to fill any extra space:"
26455 #: ../tools/virt-resize.pl:159
26458 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
26463 #: ../tools/virt-resize.pl:161
26465 "(In this case, an extra partition is I<not> created at the end of the disk, "
26466 "because there will be no unused space)."
26470 #: ../tools/virt-resize.pl:164
26472 "L</--resize> is the other commonly used option. The following would "
26473 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
26474 "rest of the available space:"
26478 #: ../tools/virt-resize.pl:168
26481 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
26482 " indisk outdisk\n"
26487 #: ../tools/virt-resize.pl:171
26489 "If the expanded partition in the image contains a filesystem or LVM PV, then "
26490 "if virt-resize knows how, it will resize the contents, the equivalent of "
26491 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
26492 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
26493 "filesystems, so you would have to online resize them after booting the "
26494 "guest. And virt-resize also does not resize anything inside an LVM PV, it "
26495 "just resizes the PV itself and leaves the user to resize any LVs inside that "
26500 #: ../tools/virt-resize.pl:180
26501 msgid "Other options are covered below."
26505 #: ../tools/virt-resize.pl:182
26510 #: ../tools/virt-resize.pl:184
26511 msgid "Thoroughly test the new disk image I<before> discarding the old one."
26515 #: ../tools/virt-resize.pl:186
26516 msgid "If you are using libvirt, edit the XML to point at the new disk:"
26520 #: ../tools/virt-resize.pl:188
26523 " # virsh edit guestname\n"
26528 #: ../tools/virt-resize.pl:190
26530 "Change E<lt>source ...E<gt>, see "
26531 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
26535 #: ../tools/virt-resize.pl:193
26536 msgid "Then start up the domain with the new, resized disk:"
26540 #: ../tools/virt-resize.pl:195
26543 " # virsh start guestname\n"
26548 #: ../tools/virt-resize.pl:197
26550 "and check that it still works. See also the L</NOTES> section below for "
26551 "additional information."
26555 #: ../tools/virt-resize.pl:200
26556 msgid "7. Resize LVs etc inside the guest"
26560 #: ../tools/virt-resize.pl:202
26561 msgid "(This can also be done offline using L<guestfish(1)>)"
26565 #: ../tools/virt-resize.pl:204
26567 "Once the guest has booted you should see the new space available, at least "
26568 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
26569 "may need to resize LVs inside PVs, and also resize filesystem types that "
26570 "virt-resize does not know how to expand."
26574 #: ../tools/virt-resize.pl:211
26575 msgid "SHRINKING A VIRTUAL MACHINE DISK"
26579 #: ../tools/virt-resize.pl:213
26581 "Shrinking is somewhat more complex than expanding, and only an overview is "
26586 #: ../tools/virt-resize.pl:216
26588 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
26589 "filesystems). The user has to shrink content before passing the disk image "
26590 "to virt-resize, and virt-resize will check that the content has been shrunk "
26595 #: ../tools/virt-resize.pl:221
26596 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
26600 #: ../tools/virt-resize.pl:223
26602 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
26603 "steps 3 and 4 above to allocate a new disk image."
26607 #: ../tools/virt-resize.pl:226
26608 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
26612 #: ../tools/virt-resize.pl:229
26613 msgid "IGNORING OR DELETING PARTITIONS"
26617 #: ../tools/virt-resize.pl:231
26619 "virt-resize also gives a convenient way to ignore or delete partitions when "
26620 "copying from the input disk to the output disk. Ignoring a partition speeds "
26621 "up the copy where you don't care about the existing contents of a "
26622 "partition. Deleting a partition removes it completely, but note that it "
26623 "also renumbers any partitions after the one which is deleted, which can "
26624 "leave some guests unbootable."
26628 #: ../tools/virt-resize.pl:238
26629 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
26633 #: ../tools/virt-resize.pl:240
26635 "If the input disk is in qcow2 format, then you may prefer that the output is "
26636 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
26637 "the fly. The output format is simply determined by the format of the empty "
26638 "output container that you provide. Thus to create qcow2 output, use:"
26642 #: ../tools/virt-resize.pl:246
26645 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
26650 #: ../tools/virt-resize.pl:248
26651 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
26655 #: ../tools/virt-resize.pl:250
26656 msgid "Similarly, to get non-sparse raw output use:"
26660 #: ../tools/virt-resize.pl:252
26663 " fallocate -l size outdisk\n"
26668 #: ../tools/virt-resize.pl:254
26670 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
26671 "if=/dev/zero of=outdisk bs=1M count=..>)"
26675 #: ../tools/virt-resize.pl:267
26676 msgid "Display help."
26680 #: ../tools/virt-resize.pl:281
26681 msgid "B<--resize part=size>"
26685 #: ../tools/virt-resize.pl:283
26687 "Resize the named partition (expanding or shrinking it) so that it has the "
26692 #: ../tools/virt-resize.pl:286
26694 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
26695 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
26696 "Exabytes; or as a percentage of the current size; or as a relative number or "
26697 "percentage. For example:"
26701 #: ../tools/virt-resize.pl:291
26704 " --resize /dev/sda2=10G\n"
26709 #: ../tools/virt-resize.pl:293
26712 " --resize /dev/sda4=90%\n"
26717 #: ../tools/virt-resize.pl:295
26720 " --resize /dev/sda2=+1G\n"
26725 #: ../tools/virt-resize.pl:297
26728 " --resize /dev/sda2=-200M\n"
26733 #: ../tools/virt-resize.pl:299
26736 " --resize /dev/sda1=+128K\n"
26741 #: ../tools/virt-resize.pl:301
26744 " --resize /dev/sda1=+10%\n"
26749 #: ../tools/virt-resize.pl:303
26752 " --resize /dev/sda1=-10%\n"
26757 #: ../tools/virt-resize.pl:305
26759 "You can increase the size of any partition. Virt-resize will expand the "
26760 "direct content of the partition if it knows how (see C<--expand> below)."
26764 #: ../tools/virt-resize.pl:309
26766 "You can only I<decrease> the size of partitions that contain filesystems or "
26767 "PVs which have already been shrunk. Virt-resize will check this has been "
26768 "done before proceeding, or else will print an error (see also "
26769 "C<--resize-force>)."
26773 #: ../tools/virt-resize.pl:314 ../tools/virt-resize.pl:406 ../tools/virt-resize.pl:423
26774 msgid "You can give this option multiple times."
26778 #: ../tools/virt-resize.pl:320
26779 msgid "B<--resize-force part=size>"
26783 #: ../tools/virt-resize.pl:322
26785 "This is the same as C<--resize> except that it will let you decrease the "
26786 "size of any partition. Generally this means you will lose any data which "
26787 "was at the end of the partition you shrink, but you may not care about that "
26788 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
26789 "as a swap partition)."
26793 #: ../tools/virt-resize.pl:328
26794 msgid "See also the C<--ignore> option."
26798 #: ../tools/virt-resize.pl:334
26799 msgid "B<--expand part>"
26803 #: ../tools/virt-resize.pl:336
26805 "Expand the named partition so it uses up all extra space (space left over "
26806 "after any other resize changes that you request have been done)."
26810 #: ../tools/virt-resize.pl:339
26812 "If virt-resize knows how, it will expand the direct content of the "
26813 "partition. For example, if the partition is an LVM PV, it will expand the "
26814 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
26815 "content it doesn't know about alone."
26819 #: ../tools/virt-resize.pl:344
26820 msgid "Currently virt-resize can resize:"
26824 #: ../tools/virt-resize.pl:350
26826 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
26831 #: ../tools/virt-resize.pl:355
26833 "NTFS filesystems contained directly in a partition, if libguestfs was "
26834 "compiled with support for NTFS."
26838 #: ../tools/virt-resize.pl:358
26840 "The filesystem must have been shut down consistently last time it was used. "
26841 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
26842 "consistency check, so at the first boot after resizing Windows will check "
26847 #: ../tools/virt-resize.pl:365
26849 "LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
26850 "inside the PV. The user will have to resize LVs as desired."
26854 #: ../tools/virt-resize.pl:371 ../tools/virt-resize.pl:393
26855 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
26859 #: ../tools/virt-resize.pl:377
26860 msgid "B<--shrink part>"
26864 #: ../tools/virt-resize.pl:379
26866 "Shrink the named partition until the overall disk image fits in the "
26867 "destination. The named partition B<must> contain a filesystem or PV which "
26868 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
26869 "online tools). Virt-resize will check this and give an error if it has not "
26874 #: ../tools/virt-resize.pl:385
26876 "The amount by which the overall disk must be shrunk (after carrying out all "
26877 "other operations requested by the user) is called the \"deficit\". For "
26878 "example, a straight copy (assume no other operations) from a 5GB disk image "
26879 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
26880 "would give an error unless the user specified a partition to shrink and that "
26881 "partition had more than a gigabyte of free space."
26885 #: ../tools/virt-resize.pl:399
26886 msgid "B<--ignore part>"
26890 #: ../tools/virt-resize.pl:401
26892 "Ignore the named partition. Effectively this means the partition is "
26893 "allocated on the destination disk, but the content is not copied across from "
26894 "the source disk. The content of the partition will be blank (all zero "
26899 #: ../tools/virt-resize.pl:412
26900 msgid "B<--delete part>"
26904 #: ../tools/virt-resize.pl:414
26906 "Delete the named partition. It would be more accurate to describe this as "
26907 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
26908 "the original disk image is left intact."
26912 #: ../tools/virt-resize.pl:418
26914 "Note that when you delete a partition, then anything contained in the "
26915 "partition is also deleted. Furthermore, this causes any partitions that "
26916 "come after to be I<renumbered>, which can easily make your guest unbootable."
26920 #: ../tools/virt-resize.pl:429
26921 msgid "B<--LV-expand logvol>"
26925 #: ../tools/virt-resize.pl:431
26927 "This takes the logical volume and, as a final step, expands it to fill all "
26928 "the space available in its volume group. A typical usage, assuming a Linux "
26929 "guest with a single PV C</dev/sda2> and a root device called "
26930 "C</dev/vg_guest/lv_root> would be:"
26934 #: ../tools/virt-resize.pl:436
26937 " virt-resize indisk outdisk \\\n"
26938 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
26943 #: ../tools/virt-resize.pl:439
26945 "This would first expand the partition (and PV), and then expand the root "
26946 "device to fill the extra space in the PV."
26950 #: ../tools/virt-resize.pl:442
26952 "The contents of the LV are also resized if virt-resize knows how to do "
26953 "that. You can stop virt-resize from trying to expand the content by using "
26954 "the option C<--no-expand-content>."
26958 #: ../tools/virt-resize.pl:446
26959 msgid "Use L<virt-list-filesystems(1)> to list the filesystems in the guest."
26963 #: ../tools/virt-resize.pl:449
26965 "You can give this option multiple times, I<but> it doesn't make sense to do "
26966 "this unless the logical volumes you specify are all in different volume "
26971 #: ../tools/virt-resize.pl:457
26972 msgid "B<--no-copy-boot-loader>"
26976 #: ../tools/virt-resize.pl:459
26978 "By default, virt-resize copies over some sectors at the start of the disk "
26979 "(up to the beginning of the first partition). Commonly these sectors "
26980 "contain the Master Boot Record (MBR) and the boot loader, and are required "
26981 "in order for the guest to boot correctly."
26985 #: ../tools/virt-resize.pl:464
26987 "If you specify this flag, then this initial copy is not done. You may need "
26988 "to reinstall the boot loader in this case."
26992 #: ../tools/virt-resize.pl:472
26993 msgid "B<--no-extra-partition>"
26997 #: ../tools/virt-resize.pl:474
26999 "By default, virt-resize creates an extra partition if there is any extra, "
27000 "unused space after all resizing has happened. Use this option to prevent "
27001 "the extra partition from being created. If you do this then the extra space "
27002 "will be inaccessible until you run fdisk, parted, or some other partitioning "
27003 "tool in the guest."
27007 #: ../tools/virt-resize.pl:480
27009 "Note that if the surplus space is smaller than 10 MB, no extra partition "
27014 #: ../tools/virt-resize.pl:487
27015 msgid "B<--no-expand-content>"
27019 #: ../tools/virt-resize.pl:489
27021 "By default, virt-resize will try to expand the direct contents of "
27022 "partitions, if it knows how (see C<--expand> option above)."
27026 #: ../tools/virt-resize.pl:492
27028 "If you give the C<--no-expand-content> option then virt-resize will not "
27033 #: ../tools/virt-resize.pl:499
27034 msgid "B<-d> | B<--debug>"
27038 #: ../tools/virt-resize.pl:507
27039 msgid "B<-n> | B<--dryrun>"
27043 #: ../tools/virt-resize.pl:509
27044 msgid "Print a summary of what would be done, but don't do anything."
27048 #: ../tools/virt-resize.pl:515
27049 msgid "B<-q> | B<--quiet>"
27053 #: ../tools/virt-resize.pl:517
27054 msgid "Don't print the summary."
27058 #: ../tools/virt-resize.pl:525
27060 "Specify the format of the input disk image. If this flag is not given then "
27061 "it is auto-detected from the image itself."
27065 #: ../tools/virt-resize.pl:531
27067 "Note that this option I<does not> affect the output format. See L</QCOW2 "
27068 "AND NON-SPARSE RAW FORMATS>."
27072 #: ../tools/virt-resize.pl:538
27073 msgid "B<--output-format> raw"
27077 #: ../tools/virt-resize.pl:540
27079 "Specify the format of the output disk image. If this flag is not given then "
27080 "it is auto-detected from the image itself."
27084 #: ../tools/virt-resize.pl:546
27086 "Note that you still need to create the output disk with the right format. "
27087 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
27091 #: ../tools/virt-resize.pl:1422 ../tools/virt-rescue.pl:90
27096 #: ../tools/virt-resize.pl:1424
27097 msgid "\"Partition 1 does not end on cylinder boundary.\""
27101 #: ../tools/virt-resize.pl:1426
27103 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
27104 "means the partitions will not be aligned to the ancient CHS geometry. "
27105 "However CHS geometry is meaningless for disks manufactured since the early "
27106 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
27107 "cylinders is not required by any modern operating system."
27111 #: ../tools/virt-resize.pl:1433
27112 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
27116 #: ../tools/virt-resize.pl:1435
27118 "In Windows Vista and later versions, Microsoft switched to using a separate "
27119 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
27120 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
27121 "the boot partition. Doing so seems to break the guest completely. However "
27122 "expanding the second partition (ie. C: drive) should work."
27126 #: ../tools/virt-resize.pl:1442
27128 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
27129 "NTFS partitions have been expanded. This is just a safety check and (unless "
27130 "it find errors) is nothing to worry about."
27134 #: ../tools/virt-resize.pl:1446
27135 msgid "GUEST BOOT STUCK AT \"GRUB\""
27139 #: ../tools/virt-resize.pl:1448
27141 "If a Linux guest does not boot after resizing, and the boot is stuck after "
27142 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
27143 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
27144 "although we think is to do with partition alignment."
27148 #: ../tools/virt-resize.pl:1453
27151 " guestfish -i -a newdisk\n"
27152 " ><fs> cat /boot/grub/device.map\n"
27153 " # check the contents of this file are sensible or\n"
27154 " # edit the file if necessary\n"
27155 " ><fs> grub-install / /dev/vda\n"
27161 #: ../tools/virt-resize.pl:1460
27163 "For more flexible guest reconfiguration, including if you need to specify "
27164 "other parameters to grub-install, use L<virt-rescue(1)>."
27168 #: ../tools/virt-resize.pl:1463
27169 msgid "ALTERNATIVE TOOLS"
27173 #: ../tools/virt-resize.pl:1465
27175 "There are several proprietary tools for resizing partitions. We won't "
27176 "mention any here."
27180 #: ../tools/virt-resize.pl:1468
27182 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
27183 "operations on disk images. They can resize and move partitions, but I don't "
27184 "think they can do anything with the contents, and they certainly don't "
27189 #: ../tools/virt-resize.pl:1473
27191 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
27192 "but at a much lower level. You will probably end up hand-calculating sector "
27193 "offsets, which is something that virt-resize was designed to avoid. If you "
27194 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
27199 #: ../tools/virt-resize.pl:1488
27201 "L<virt-list-partitions(1)>, L<virt-list-filesystems(1)>, L<virt-df(1)>, "
27202 "L<guestfs(3)>, L<guestfish(1)>, L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, "
27203 "L<resize2fs(8)>, L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, "
27204 "L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, "
27205 "L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
27209 #: ../tools/virt-list-filesystems.pl:32
27210 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
27214 #: ../tools/virt-list-filesystems.pl:36
27217 " virt-list-filesystems [--options] domname\n"
27222 #: ../tools/virt-list-filesystems.pl:38
27225 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
27230 #: ../tools/virt-list-filesystems.pl:42
27232 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
27233 "are contained in a virtual machine or disk image."
27237 #: ../tools/virt-list-filesystems.pl:46
27239 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
27240 "functionality. For more complex cases you should look at the "
27241 "L<guestfish(1)> tool."
27245 #: ../tools/virt-list-filesystems.pl:105
27247 "With this option, C<virt-list-filesystems> displays the type of each "
27248 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
27252 #: ../tools/virt-list-filesystems.pl:112
27253 msgid "B<-a> | B<--all>"
27257 #: ../tools/virt-list-filesystems.pl:114
27259 "Normally we only show mountable filesystems. If this option is given then "
27260 "swap devices are shown too."
27264 #: ../tools/virt-list-filesystems.pl:188
27266 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
27267 "L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
27268 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27272 #: ../tools/virt-cat.pl:33
27273 msgid "virt-cat - Display a file in a virtual machine"
27277 #: ../tools/virt-cat.pl:37
27280 " virt-cat [--options] domname file\n"
27285 #: ../tools/virt-cat.pl:39
27288 " virt-cat [--options] disk.img [disk.img ...] file\n"
27293 #: ../tools/virt-cat.pl:43
27295 "C<virt-cat> is a command line tool to display the contents of C<file> where "
27296 "C<file> exists in the named virtual machine (or disk image)."
27300 #: ../tools/virt-cat.pl:46
27302 "C<virt-cat> can be used to quickly view a single file. To edit a file, use "
27303 "C<virt-edit>. For more complex cases you should look at the L<guestfish(1)> "
27308 #: ../tools/virt-cat.pl:52
27309 msgid "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
27313 #: ../tools/virt-cat.pl:55
27316 " virt-cat mydomain /etc/fstab\n"
27321 #: ../tools/virt-cat.pl:57
27322 msgid "List syslog messages from a VM:"
27326 #: ../tools/virt-cat.pl:59
27329 " virt-cat mydomain /var/log/messages | tail\n"
27334 #: ../tools/virt-cat.pl:61
27335 msgid "Find out what DHCP IP address a VM acquired:"
27339 #: ../tools/virt-cat.pl:63
27342 " virt-cat mydomain /var/log/messages | grep 'dhclient: bound to' | tail\n"
27347 #: ../tools/virt-cat.pl:65
27348 msgid "Find out what packages were recently installed:"
27352 #: ../tools/virt-cat.pl:67
27355 " virt-cat mydomain /var/log/yum.log | tail\n"
27360 #: ../tools/virt-cat.pl:69
27361 msgid "Find out who is logged on inside a virtual machine:"
27365 #: ../tools/virt-cat.pl:71
27368 " virt-cat mydomain /var/run/utmp > /tmp/utmp\n"
27374 #: ../tools/virt-cat.pl:74
27375 msgid "or who was logged on:"
27379 #: ../tools/virt-cat.pl:76
27382 " virt-cat mydomain /var/log/wtmp > /tmp/wtmp\n"
27383 " last -f /tmp/wtmp\n"
27388 #: ../tools/virt-cat.pl:187
27390 "L<guestfs(3)>, L<guestfish(1)>, L<virt-edit(1)>, L<Sys::Guestfs(3)>, "
27391 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27395 #: ../tools/virt-tar.pl:33
27396 msgid "virt-tar - Extract or upload files to a virtual machine"
27400 #: ../tools/virt-tar.pl:37
27403 " virt-tar [--options] -x domname directory tarball\n"
27408 #: ../tools/virt-tar.pl:39
27411 " virt-tar [--options] -u domname tarball directory\n"
27416 #: ../tools/virt-tar.pl:41
27419 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
27424 #: ../tools/virt-tar.pl:43
27427 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
27432 #: ../tools/virt-tar.pl:47
27433 msgid "Download C</home> from the VM into a local tarball:"
27437 #: ../tools/virt-tar.pl:49
27440 " virt-tar -x domname /home home.tar\n"
27445 #: ../tools/virt-tar.pl:51
27448 " virt-tar -zx domname /home home.tar.gz\n"
27453 #: ../tools/virt-tar.pl:53
27454 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
27458 #: ../tools/virt-tar.pl:55
27461 " virt-tar -u domname uploadstuff.tar /tmp\n"
27466 #: ../tools/virt-tar.pl:57
27469 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
27474 #: ../tools/virt-tar.pl:61
27476 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
27477 "virtual machines. If you do this, you risk disk corruption in the VM. "
27478 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
27482 #: ../tools/virt-tar.pl:66
27484 "You can use C<-x> (extract) on live virtual machines, but you might get "
27485 "inconsistent results or errors if there is filesystem activity inside the "
27486 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
27487 "work, but the only way to guarantee consistent results is if the virtual "
27488 "machine is shut down."
27492 #: ../tools/virt-tar.pl:74
27494 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
27495 "parts of a guest filesystem. There are many possibilities: making backups, "
27496 "uploading data files, snooping on guest activity, fixing or customizing "
27501 #: ../tools/virt-tar.pl:79
27503 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
27504 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
27505 "should look at the L<guestfish(1)> tool."
27509 #: ../tools/virt-tar.pl:83
27511 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
27512 "its contents (recursively) from the virtual machine into a local tarball. "
27513 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
27514 "virtual machine. You cannot use these two options together."
27518 #: ../tools/virt-tar.pl:89
27520 "In addition, you may need to use the C<-z> (gZip) option to enable "
27521 "compression. When uploading, you have to specify C<-z> if the upload file "
27522 "is compressed because virt-tar won't detect this on its own."
27526 #: ../tools/virt-tar.pl:93
27528 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
27529 "example it cannot do PKZip files or bzip2 compression. If you want that "
27530 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
27531 "the L<libguestfs(3)> API)."
27535 #: ../tools/virt-tar.pl:151
27536 msgid "B<-x> | B<--extract> | B<--download>"
27540 #: ../tools/virt-tar.pl:153
27541 msgid "B<-u> | B<--upload>"
27545 #: ../tools/virt-tar.pl:155
27547 "Use C<-x> to extract (download) a directory from a virtual machine to a "
27552 #: ../tools/virt-tar.pl:158
27554 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
27555 "Please read the L</WARNING> section above before using this option."
27559 #: ../tools/virt-tar.pl:162
27560 msgid "You must specify exactly one of these options."
27564 #: ../tools/virt-tar.pl:168
27565 msgid "B<-z> | B<--gzip>"
27569 #: ../tools/virt-tar.pl:170
27570 msgid "Specify that the input or output tarball is gzip-compressed."
27574 #: ../tools/virt-tar.pl:283
27576 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
27577 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
27578 "L<http://libguestfs.org/>."
27582 #: ../tools/virt-rescue.pl:33
27583 msgid "virt-rescue - Run a rescue shell on a virtual machine"
27587 #: ../tools/virt-rescue.pl:37
27590 " virt-rescue [--options] domname\n"
27595 #: ../tools/virt-rescue.pl:39
27598 " virt-rescue [--options] disk.img [disk.img ...]\n"
27603 #: ../tools/virt-rescue.pl:43
27605 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
27606 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
27607 "you from doing this, but doesn't catch all cases."
27611 #: ../tools/virt-rescue.pl:47
27613 "However if you use the I<--ro> (read only) option, then you can attach a "
27614 "shell to a live virtual machine. The results might be strange or "
27615 "inconsistent at times but you won't get disk corruption."
27619 #: ../tools/virt-rescue.pl:53
27621 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
27622 "need for a CD. virt-rescue gives you a rescue shell and some simple "
27623 "recovery tools which you can use to examine or rescue a virtual machine or "
27628 #: ../tools/virt-rescue.pl:58
27630 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
27631 "on disk image(s):"
27635 #: ../tools/virt-rescue.pl:61
27638 " virt-rescue GuestName\n"
27643 #: ../tools/virt-rescue.pl:63
27646 " virt-rescue --ro /path/to/disk.img\n"
27651 #: ../tools/virt-rescue.pl:65
27654 " virt-rescue /dev/sdc\n"
27659 #: ../tools/virt-rescue.pl:67
27660 msgid "For live VMs you I<must> use the --ro option."
27664 #: ../tools/virt-rescue.pl:69
27666 "When you run virt-rescue on a virtual machine or disk image, you are placed "
27667 "in an interactive bash shell where you can use many ordinary Linux "
27668 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
27669 "appliance. You must mount the virtual machine's filesystems by hand. There "
27670 "is an empty directory called C</sysroot> where you can mount filesystems."
27674 #: ../tools/virt-rescue.pl:76
27676 "In the example below, we list logical volumes, then choose one to mount "
27677 "under C</sysroot>:"
27681 #: ../tools/virt-rescue.pl:79
27685 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
27686 " lv_root vg_f11x64 -wi-a- 8.83G\n"
27687 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
27688 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
27689 " ><rescue> ls /sysroot\n"
27694 #: ../tools/virt-rescue.pl:86
27696 "If you don't know what filesystems are available on the virtual machine then "
27697 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
27701 #: ../tools/virt-rescue.pl:92
27703 "Virt-rescue can be used on I<any> disk image file or device, not just a "
27704 "virtual machine. For example you can use it on a blank file if you want to "
27705 "partition that file (although we would recommend using L<guestfish(1)> "
27706 "instead as it is more suitable for this purpose). You can even use "
27707 "virt-rescue on things like SD cards."
27711 #: ../tools/virt-rescue.pl:98
27713 "This tool is just designed for quick interactive hacking on a virtual "
27714 "machine. For more structured access to a virtual machine disk image, you "
27715 "should use L<guestfs(3)>. To get a structured shell that you can use to "
27716 "make scripted changes to guests, use L<guestfish(1)>."
27720 #: ../tools/virt-rescue.pl:127
27721 msgid "B<--append kernelopts>"
27725 #: ../tools/virt-rescue.pl:129
27726 msgid "Pass additional options to the rescue kernel."
27730 #: ../tools/virt-rescue.pl:164
27731 msgid "B<--memsize MB> | B<-m MB>"
27735 #: ../tools/virt-rescue.pl:166
27737 "Change the amount of memory allocated to the rescue system. The default is "
27738 "set by libguestfs and is small but adequate for running system tools. The "
27739 "occasional program might need more memory. The parameter is specified in "
27744 #: ../tools/virt-rescue.pl:175
27745 msgid "B<--network MB>"
27749 #: ../tools/virt-rescue.pl:177
27750 msgid "Enable QEMU user networking in the guest."
27754 #: ../tools/virt-rescue.pl:183
27755 msgid "B<--ro> | B<-r>"
27759 #: ../tools/virt-rescue.pl:185
27760 msgid "Open the image read-only."
27764 #: ../tools/virt-rescue.pl:197
27766 "Enable SELinux in the rescue appliance. You should read "
27767 "L<guestfs(3)/SELINUX> before using this option."
27771 #: ../tools/virt-rescue.pl:257
27773 "Several environment variables affect virt-rescue. See "
27774 "L<guestfs(3)/ENVIRONMENT VARIABLES> for the complete list."
27778 #: ../tools/virt-rescue.pl:269
27780 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
27781 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27785 #: ../tools/virt-make-fs.pl:37
27786 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
27790 #: ../tools/virt-make-fs.pl:41
27793 " virt-make-fs [--options] input.tar output.img\n"
27798 #: ../tools/virt-make-fs.pl:43
27801 " virt-make-fs [--options] input.tar.gz output.img\n"
27806 #: ../tools/virt-make-fs.pl:45
27809 " virt-make-fs [--options] directory output.img\n"
27814 #: ../tools/virt-make-fs.pl:49
27816 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
27817 "archive or some files in a directory. It is similar to tools like "
27818 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
27819 "it can create common filesystem types like ext2/3 or NTFS, which can be "
27820 "useful if you want to attach these filesystems to existing virtual machines "
27821 "(eg. to import large amounts of read-only data to a VM)."
27825 #: ../tools/virt-make-fs.pl:57
27826 msgid "Basic usage is:"
27830 #: ../tools/virt-make-fs.pl:59
27833 " virt-make-fs input output\n"
27838 #: ../tools/virt-make-fs.pl:61
27840 "where C<input> is either a directory containing files that you want to add, "
27841 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
27842 "C<output> is a disk image. The input type is detected automatically. The "
27843 "output disk image defaults to a raw ext2 image unless you specify extra "
27844 "flags (see L</OPTIONS> below)."
27848 #: ../tools/virt-make-fs.pl:67
27849 msgid "EXTRA SPACE"
27853 #: ../tools/virt-make-fs.pl:69
27855 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
27856 "the files that it contains, but might have extra space. Depending on how "
27857 "you are going to use the output, you might think this extra space is wasted "
27858 "and want to minimize it, or you might want to leave space so that more files "
27859 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
27860 "but you can use the C<--size> flag to leave space in the filesystem if you "
27865 #: ../tools/virt-make-fs.pl:77
27867 "An alternative way to leave extra space but not make the output image any "
27868 "bigger is to use an alternative disk image format (instead of the default "
27869 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
27870 "image format (check your hypervisor supports this before using it). This "
27871 "allows you to choose a large C<--size> but the extra space won't actually be "
27872 "allocated in the image until you try to store something in it."
27876 #: ../tools/virt-make-fs.pl:85
27878 "Don't forget that you can also use local commands including L<resize2fs(8)> "
27879 "and L<virt-resize(1)> to resize existing filesystems, or rerun "
27880 "virt-make-resize to build another image from scratch."
27884 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
27889 #: ../tools/virt-make-fs.pl:91
27892 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
27897 #: ../tools/virt-make-fs.pl:93
27898 msgid "FILESYSTEM TYPE"
27902 #: ../tools/virt-make-fs.pl:95
27904 "The default filesystem type is C<ext2>. Just about any filesystem type that "
27905 "libguestfs supports can be used (but I<not> read-only formats like "
27906 "ISO9660). Here are some of the more common choices:"
27910 #: ../tools/virt-make-fs.pl:101
27915 #: ../tools/virt-make-fs.pl:103
27917 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
27918 "you are not going to use the filesystem in a way that requires the journal, "
27919 "then this is just wasted overhead."
27923 #: ../tools/virt-make-fs.pl:107
27924 msgid "I<ntfs> or I<vfat>"
27928 #: ../tools/virt-make-fs.pl:109
27929 msgid "Useful if exporting data to a Windows guest."
27933 #: ../tools/virt-make-fs.pl:111
27935 "I<Note for vfat>: The tar archive or local directory must only contain files "
27936 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
27937 "program running within libguestfs is unable to change the ownership of "
27938 "non-root files, since vfat itself does not support this."
27942 #: ../tools/virt-make-fs.pl:116
27947 #: ../tools/virt-make-fs.pl:118
27949 "Lower overhead than C<ext2>, but certain limitations on filename length and "
27950 "total filesystem size."
27954 #: ../tools/virt-make-fs.pl:125
27957 " virt-make-fs --type=minix input minixfs.img\n"
27962 #: ../tools/virt-make-fs.pl:127
27963 msgid "TO PARTITION OR NOT TO PARTITION"
27967 #: ../tools/virt-make-fs.pl:129
27968 msgid "Optionally virt-make-fs can add a partition table to the output disk."
27972 #: ../tools/virt-make-fs.pl:131
27974 "Adding a partition can make the disk image more compatible with certain "
27975 "virtualized operating systems which don't expect to see a filesystem "
27976 "directly located on a block device (Linux doesn't care and will happily "
27977 "handle both types)."
27981 #: ../tools/virt-make-fs.pl:136
27983 "On the other hand, if you have a partition table then the output image is no "
27984 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
27985 "directly on a partitioned disk image. (However libguestfs tools such as "
27986 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
27990 #: ../tools/virt-make-fs.pl:144
27991 msgid "Add an MBR partition:"
27995 #: ../tools/virt-make-fs.pl:146
27998 " virt-make-fs --partition -- input disk.img\n"
28003 #: ../tools/virt-make-fs.pl:148
28005 "If the output disk image could be terabyte-sized or larger, it's better to "
28006 "use an EFI/GPT-compatible partition table:"
28010 #: ../tools/virt-make-fs.pl:151
28013 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
28018 #: ../tools/virt-make-fs.pl:179
28019 msgid "Enable debugging information."
28023 #: ../tools/virt-make-fs.pl:185
28024 msgid "B<--size=E<lt>NE<gt>>"
28028 #: ../tools/virt-make-fs.pl:187
28029 msgid "B<--size=+E<lt>NE<gt>>"
28033 #: ../tools/virt-make-fs.pl:189
28034 msgid "B<-s E<lt>NE<gt>>"
28038 #: ../tools/virt-make-fs.pl:191
28039 msgid "B<-s +E<lt>NE<gt>>"
28043 #: ../tools/virt-make-fs.pl:193
28044 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
28048 #: ../tools/virt-make-fs.pl:196
28050 "If this option is I<not> given, then the output image will be just large "
28051 "enough to contain all the files, with not much wasted space."
28055 #: ../tools/virt-make-fs.pl:199
28057 "To choose a fixed size output disk, specify an absolute number followed by "
28058 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28059 "Petabytes or Exabytes. This must be large enough to contain all the input "
28060 "files, else you will get an error."
28064 #: ../tools/virt-make-fs.pl:204
28066 "To leave extra space, specify C<+> (plus sign) and a number followed by "
28067 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28068 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
28069 "the input files, and (approximately) an extra 200 MB free space."
28073 #: ../tools/virt-make-fs.pl:210
28075 "Note that virt-make-fs estimates free space, and therefore will not produce "
28076 "filesystems containing precisely the free space requested. (It is much more "
28077 "expensive and time-consuming to produce a filesystem which has precisely the "
28078 "desired free space)."
28082 #: ../tools/virt-make-fs.pl:219
28083 msgid "B<--format=E<lt>fmtE<gt>>"
28087 #: ../tools/virt-make-fs.pl:221
28088 msgid "B<-F E<lt>fmtE<gt>>"
28092 #: ../tools/virt-make-fs.pl:223
28093 msgid "Choose the output disk image format."
28097 #: ../tools/virt-make-fs.pl:225
28098 msgid "The default is C<raw> (raw disk image)."
28102 #: ../tools/virt-make-fs.pl:227
28104 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
28105 "that would really make sense here is C<qcow2>."
28109 #: ../tools/virt-make-fs.pl:234
28110 msgid "B<--type=E<lt>fsE<gt>>"
28114 #: ../tools/virt-make-fs.pl:236
28115 msgid "B<-t E<lt>fsE<gt>>"
28119 #: ../tools/virt-make-fs.pl:238
28120 msgid "Choose the output filesystem type."
28124 #: ../tools/virt-make-fs.pl:240
28125 msgid "The default is C<ext2>."
28129 #: ../tools/virt-make-fs.pl:242
28130 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
28134 #: ../tools/virt-make-fs.pl:249
28135 msgid "B<--partition>"
28139 #: ../tools/virt-make-fs.pl:251
28140 msgid "B<--partition=E<lt>parttypeE<gt>>"
28144 #: ../tools/virt-make-fs.pl:253
28146 "If specified, this flag adds an MBR partition table to the output disk "
28151 #: ../tools/virt-make-fs.pl:256
28153 "You can change the partition table type, eg. C<--partition=gpt> for large "
28158 #: ../tools/virt-make-fs.pl:259
28160 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
28161 "might consider the next parameter to be the partition type. For example:"
28165 #: ../tools/virt-make-fs.pl:263
28168 " virt-make-fs --partition input.tar ...\n"
28173 #: ../tools/virt-make-fs.pl:265
28175 "would cause virt-make-fs to think you wanted to use a partition type of "
28176 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
28177 "dash) between options and the input file argument:"
28181 #: ../tools/virt-make-fs.pl:269
28184 " virt-make-fs --partition -- input.tar ...\n"
28189 #: ../tools/virt-make-fs.pl:536
28191 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
28192 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
28193 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28197 #: ../tools/virt-make-fs.pl:553
28200 " export LIBGUESTFS_DEBUG=1\n"
28201 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
28206 #: ../tools/virt-make-fs.pl:556
28208 "Attach /tmp/virt-make-fs.log to a new bug report at "
28209 "L<https://bugzilla.redhat.com/>"
28213 #: ../tools/virt-list-partitions.pl:32
28214 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
28218 #: ../tools/virt-list-partitions.pl:36
28221 " virt-list-partitions [--options] domname\n"
28226 #: ../tools/virt-list-partitions.pl:38
28229 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
28234 #: ../tools/virt-list-partitions.pl:42
28236 "C<virt-list-partitions> is a command line tool to list the partitions that "
28237 "are contained in a virtual machine or disk image. It is mainly useful as a "
28238 "first step to using L<virt-resize(1)>."
28242 #: ../tools/virt-list-partitions.pl:47
28244 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
28245 "functionality. For more complex cases you should look at the "
28246 "L<guestfish(1)> tool."
28250 #: ../tools/virt-list-partitions.pl:104
28251 msgid "B<-h> | B<--human-readable>"
28255 #: ../tools/virt-list-partitions.pl:106
28256 msgid "Show sizes in human-readable form (eg. \"1G\")."
28260 #: ../tools/virt-list-partitions.pl:114
28262 "With this option, C<virt-list-partitions> displays the type and size of each "
28263 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
28267 #: ../tools/virt-list-partitions.pl:121
28268 msgid "B<-t> | B<--total>"
28272 #: ../tools/virt-list-partitions.pl:123
28273 msgid "Display the total size of each block device (as a separate row or rows)."
28277 #: ../tools/virt-list-partitions.pl:256
28279 "L<guestfs(3)>, L<guestfish(1)>, L<virt-list-filesystems(1)>, "
28280 "L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
28281 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."