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.6.1\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2010-11-05 15:21+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:1186 ../src/guestfs.pod:1191 ../src/guestfs.pod:1195 ../src/guestfs.pod:1411 ../src/guestfs.pod:1416 ../src/guestfs.pod:1420 ../src/guestfs.pod:1522 ../src/guestfs.pod:1526 ../src/guestfs.pod:1530 ../src/guestfs.pod:1535 ../src/guestfs.pod:1543 ../src/guestfs.pod:1562 ../src/guestfs.pod:1570 ../src/guestfs.pod:1800 ../src/guestfs.pod:1806 ../src/guestfs.pod:1811 ../src/guestfs.pod:1817 ../src/guestfs.pod:1924 ../src/guestfs.pod:1928 ../src/guestfs.pod:1932 ../src/guestfs.pod:1936 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:461 ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:476 ../src/guestfs-actions.pod:483 ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1426 ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1434 ../src/guestfs-actions.pod:1442 ../src/guestfs-actions.pod:1446 ../src/guestfs-actions.pod:1450 ../src/guestfs-actions.pod:1460 ../src/guestfs-actions.pod:1464 ../src/guestfs-actions.pod:1468 ../src/guestfs-actions.pod:1596 ../src/guestfs-actions.pod:1600 ../src/guestfs-actions.pod:1605 ../src/guestfs-actions.pod:1610 ../src/guestfs-actions.pod:1665 ../src/guestfs-actions.pod:1669 ../src/guestfs-actions.pod:1674 ../fish/guestfish.pod:364 ../fish/guestfish.pod:368 ../fish/guestfish.pod:372 ../fish/guestfish.pod:376 ../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
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
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
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:630
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 "Library should return errno with error messages."
1557 #: ../src/guestfs.pod:775
1559 "It would be a nice-to-have to be able to get the original value of 'errno' "
1560 "from inside the appliance along error paths (where set). Currently "
1561 "L<guestmount(1)> goes through hoops to try to reverse the error message "
1562 "string into an errno, see the function error() in fuse/guestmount.c."
1566 #: ../src/guestfs.pod:781
1568 "In libguestfs 1.5.4, the protocol was changed so that the Linux errno is "
1569 "sent back from the daemon."
1573 #: ../src/guestfs.pod:784
1574 msgid "Ambiguity between devices and paths"
1578 #: ../src/guestfs.pod:786
1580 "There is a subtle ambiguity in the API between a device name "
1581 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1582 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1586 #: ../src/guestfs.pod:791
1588 "In the current API we usually resolve this ambiguity by having two separate "
1589 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1590 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1591 "detecting if the path supplied begins with C</dev/>."
1595 #: ../src/guestfs.pod:797
1597 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1598 "make paths/devices into structured names. One way to do this would be to "
1599 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1600 "aspect of grub. Another way would be to use a structured type, equivalent "
1601 "to this OCaml type:"
1605 #: ../src/guestfs.pod:803
1608 " type path = Path of string | Device of int | Partition of int * int\n"
1613 #: ../src/guestfs.pod:805
1614 msgid "which would allow you to pass arguments like:"
1618 #: ../src/guestfs.pod:807
1621 " Path \"/foo/bar\"\n"
1622 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1623 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1624 " Path \"/dev/sdb2\" (* not a device *)\n"
1629 #: ../src/guestfs.pod:812
1631 "As you can see there are still problems to resolve even with this "
1632 "representation. Also consider how it might work in guestfish."
1636 #: ../src/guestfs.pod:817
1637 msgid "PROTOCOL LIMITS"
1641 #: ../src/guestfs.pod:819
1643 "Internally libguestfs uses a message-based protocol to pass API calls and "
1644 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1645 "plenty more detail about this). The maximum message size used by the "
1646 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1647 "aware of this limit. The API calls which may be affected are individually "
1648 "documented, with a link back to this section of the documentation."
1652 #: ../src/guestfs.pod:827
1654 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1655 "a simple string. Because this string is at some point internally encoded as "
1656 "a message, the maximum size that it can return is slightly under 4 MB. If "
1657 "the requested file is larger than this then you will get an error."
1661 #: ../src/guestfs.pod:833
1663 "In order to transfer large files into and out of the guest filesystem, you "
1664 "need to use particular calls that support this. The sections L</UPLOADING> "
1665 "and L</DOWNLOADING> document how to do this."
1669 #: ../src/guestfs.pod:837
1671 "You might also consider mounting the disk image using our FUSE filesystem "
1672 "support (L<guestmount(1)>)."
1676 #: ../src/guestfs.pod:840
1677 msgid "KEYS AND PASSPHRASES"
1681 #: ../src/guestfs.pod:842
1683 "Certain libguestfs calls take a parameter that contains sensitive key "
1684 "material, passed in as a C string."
1688 #: ../src/guestfs.pod:845
1690 "In the future we would hope to change the libguestfs implementation so that "
1691 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1692 "swap. However this is I<not> done at the moment, because of the complexity "
1693 "of such an implementation."
1697 #: ../src/guestfs.pod:850
1699 "Therefore you should be aware that any key parameter you pass to libguestfs "
1700 "might end up being written out to the swap partition. If this is a concern, "
1701 "scrub the swap partition or don't use libguestfs on encrypted devices."
1705 #: ../src/guestfs.pod:855
1706 msgid "CONNECTION MANAGEMENT"
1710 #: ../src/guestfs.pod:857
1715 #: ../src/guestfs.pod:859
1717 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
1718 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
1719 "handle and release all resources used."
1723 #: ../src/guestfs.pod:863
1725 "For information on using multiple handles and threads, see the section "
1726 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
1730 #: ../src/guestfs.pod:866
1731 msgid "guestfs_create"
1735 #: ../src/guestfs.pod:868
1738 " guestfs_h *guestfs_create (void);\n"
1743 #: ../src/guestfs.pod:870
1744 msgid "Create a connection handle."
1748 #: ../src/guestfs.pod:872
1750 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
1751 "on the handle at least once."
1755 #: ../src/guestfs.pod:875
1757 "This function returns a non-NULL pointer to a handle on success or NULL on "
1762 #: ../src/guestfs.pod:878
1763 msgid "After configuring the handle, you have to call L</guestfs_launch>."
1767 #: ../src/guestfs.pod:880
1769 "You may also want to configure error handling for the handle. See L</ERROR "
1770 "HANDLING> section below."
1774 #: ../src/guestfs.pod:883
1775 msgid "guestfs_close"
1779 #: ../src/guestfs.pod:885
1782 " void guestfs_close (guestfs_h *g);\n"
1787 #: ../src/guestfs.pod:887
1788 msgid "This closes the connection handle and frees up all resources used."
1792 #: ../src/guestfs.pod:889
1793 msgid "ERROR HANDLING"
1797 #: ../src/guestfs.pod:891
1799 "API functions can return errors. For example, almost all functions that "
1800 "return C<int> will return C<-1> to indicate an error. You can get "
1801 "additional information on errors by calling L</guestfs_last_error> and/or by "
1802 "setting up an error handler with L</guestfs_set_error_handler>."
1806 #: ../src/guestfs.pod:897
1808 "When the handle is created, a default error handler is installed which "
1809 "prints the error message string to C<stderr>. For small short-running "
1810 "command line programs it is sufficient to do:"
1814 #: ../src/guestfs.pod:901
1817 " if (guestfs_launch (g) == -1)\n"
1818 " exit (EXIT_FAILURE);\n"
1823 #: ../src/guestfs.pod:904
1825 "since the default error handler will ensure that an error message has been "
1826 "printed to C<stderr> before the program exits."
1830 #: ../src/guestfs.pod:907
1832 "For other programs the caller will almost certainly want to install an "
1833 "alternate error handler or do error handling in-line like this:"
1837 #: ../src/guestfs.pod:910
1840 " g = guestfs_create ();\n"
1845 #: ../src/guestfs.pod:912
1848 " /* This disables the default behaviour of printing errors\n"
1850 " guestfs_set_error_handler (g, NULL, NULL);\n"
1855 #: ../src/guestfs.pod:916
1858 " if (guestfs_launch (g) == -1) {\n"
1859 " /* Examine the error message and print it etc. */\n"
1860 " char *msg = guestfs_last_error (g);\n"
1861 " fprintf (stderr, \"%s\\n\", msg);\n"
1868 #: ../src/guestfs.pod:923
1870 "Out of memory errors are handled differently. The default action is to call "
1871 "L<abort(3)>. If this is undesirable, then you can set a handler using "
1872 "L</guestfs_set_out_of_memory_handler>."
1876 #: ../src/guestfs.pod:927
1878 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
1879 "because there is no handle if this happens there is no way to get additional "
1880 "error information. However L</guestfs_create> is supposed to be a "
1881 "lightweight operation which can only fail because of insufficient memory (it "
1882 "returns NULL in this case)."
1886 #: ../src/guestfs.pod:933
1887 msgid "guestfs_last_error"
1891 #: ../src/guestfs.pod:935
1894 " const char *guestfs_last_error (guestfs_h *g);\n"
1899 #: ../src/guestfs.pod:937
1901 "This returns the last error message that happened on C<g>. If there has not "
1902 "been an error since the handle was created, then this returns C<NULL>."
1906 #: ../src/guestfs.pod:941
1908 "The lifetime of the returned string is until the next error occurs, or "
1909 "L</guestfs_close> is called."
1913 #: ../src/guestfs.pod:944
1914 msgid "guestfs_set_error_handler"
1918 #: ../src/guestfs.pod:946
1921 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
1923 " const char *msg);\n"
1924 " void guestfs_set_error_handler (guestfs_h *g,\n"
1925 " guestfs_error_handler_cb cb,\n"
1931 #: ../src/guestfs.pod:953
1933 "The callback C<cb> will be called if there is an error. The parameters "
1934 "passed to the callback are an opaque data pointer and the error message "
1939 #: ../src/guestfs.pod:957
1941 "Note that the message string C<msg> is freed as soon as the callback "
1942 "function returns, so if you want to stash it somewhere you must make your "
1947 #: ../src/guestfs.pod:961
1948 msgid "The default handler prints messages on C<stderr>."
1952 #: ../src/guestfs.pod:963
1953 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
1957 #: ../src/guestfs.pod:965
1958 msgid "guestfs_get_error_handler"
1962 #: ../src/guestfs.pod:967
1965 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
1966 " void **opaque_rtn);\n"
1971 #: ../src/guestfs.pod:970
1972 msgid "Returns the current error handler callback."
1976 #: ../src/guestfs.pod:972
1977 msgid "guestfs_set_out_of_memory_handler"
1981 #: ../src/guestfs.pod:974
1984 " typedef void (*guestfs_abort_cb) (void);\n"
1985 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
1986 " guestfs_abort_cb);\n"
1991 #: ../src/guestfs.pod:978
1993 "The callback C<cb> will be called if there is an out of memory situation. "
1994 "I<Note this callback must not return>."
1998 #: ../src/guestfs.pod:981
1999 msgid "The default is to call L<abort(3)>."
2003 #: ../src/guestfs.pod:983
2004 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2008 #: ../src/guestfs.pod:986
2009 msgid "guestfs_get_out_of_memory_handler"
2013 #: ../src/guestfs.pod:988
2016 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2021 #: ../src/guestfs.pod:990
2022 msgid "This returns the current out of memory handler."
2026 #: ../src/guestfs.pod:992
2031 #: ../src/guestfs.pod:994
2033 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
2038 #: ../src/guestfs.pod:997
2040 "By default it looks for these in the directory C<$libdir/guestfs> "
2041 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2045 #: ../src/guestfs.pod:1000
2047 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2048 "to change the directories that libguestfs will search in. The value is a "
2049 "colon-separated list of paths. The current directory is I<not> searched "
2050 "unless the path contains an empty element or C<.>. For example "
2051 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2052 "then C</usr/lib/guestfs>."
2056 #: ../src/guestfs.pod:1007
2057 msgid "HIGH-LEVEL API ACTIONS"
2061 #: ../src/guestfs.pod:1009
2062 msgid "ABI GUARANTEE"
2066 #: ../src/guestfs.pod:1011
2068 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2069 "actions as outlined in this section. Although we will deprecate some "
2070 "actions, for example if they get replaced by newer calls, we will keep the "
2071 "old actions forever. This allows you the developer to program in confidence "
2072 "against the libguestfs API."
2076 #: ../src/guestfs.pod:1017 ../fish/guestfish.pod:860
2081 #: ../src/guestfs.pod:1019
2086 #: ../src/guestfs.pod:1021
2091 #: ../src/guestfs.pod:1023
2092 msgid "AVAILABILITY"
2096 #: ../src/guestfs.pod:1025
2097 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2101 #: ../src/guestfs.pod:1027
2103 "Using L</guestfs_available> you can test availability of the following "
2104 "groups of functions. This test queries the appliance to see if the "
2105 "appliance you are currently using supports the functionality."
2109 #: ../src/guestfs.pod:1032
2110 msgid "@AVAILABILITY@"
2114 #: ../src/guestfs.pod:1034
2115 msgid "GUESTFISH supported COMMAND"
2119 #: ../src/guestfs.pod:1036
2121 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2122 "prints out the available groups and whether they are supported by this build "
2123 "of libguestfs. Note however that you have to do C<run> first."
2127 #: ../src/guestfs.pod:1041
2128 msgid "SINGLE CALLS AT COMPILE TIME"
2132 #: ../src/guestfs.pod:1043
2134 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2135 "function, such as:"
2139 #: ../src/guestfs.pod:1046
2142 " #define LIBGUESTFS_HAVE_DD 1\n"
2147 #: ../src/guestfs.pod:1048
2148 msgid "if L</guestfs_dd> is available."
2152 #: ../src/guestfs.pod:1050
2154 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2155 "function is available at compile time, we recommended using build tools such "
2156 "as autoconf or cmake. For example in autotools you could use:"
2160 #: ../src/guestfs.pod:1055
2163 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2164 " AC_CHECK_FUNCS([guestfs_dd])\n"
2169 #: ../src/guestfs.pod:1058
2171 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2176 #: ../src/guestfs.pod:1061
2177 msgid "SINGLE CALLS AT RUN TIME"
2181 #: ../src/guestfs.pod:1063
2183 "Testing at compile time doesn't guarantee that a function really exists in "
2184 "the library. The reason is that you might be dynamically linked against a "
2185 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2186 "This situation unfortunately results in a segmentation fault, which is a "
2187 "shortcoming of the C dynamic linking system itself."
2191 #: ../src/guestfs.pod:1070
2193 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2194 "in this example program (note that you still need the compile time check as "
2199 #: ../src/guestfs.pod:1074
2202 " #include <stdio.h>\n"
2203 " #include <stdlib.h>\n"
2204 " #include <unistd.h>\n"
2205 " #include <dlfcn.h>\n"
2206 " #include <guestfs.h>\n"
2211 #: ../src/guestfs.pod:1080
2216 " #ifdef LIBGUESTFS_HAVE_DD\n"
2218 " int has_function;\n"
2223 #: ../src/guestfs.pod:1086
2226 " /* Test if the function guestfs_dd is really available. */\n"
2227 " dl = dlopen (NULL, RTLD_LAZY);\n"
2229 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2230 " exit (EXIT_FAILURE);\n"
2232 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2238 #: ../src/guestfs.pod:1095
2241 " if (!has_function)\n"
2242 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2244 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2245 " /* Now it's safe to call\n"
2246 " guestfs_dd (g, \"foo\", \"bar\");\n"
2250 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2257 #: ../src/guestfs.pod:1108
2259 "You may think the above is an awful lot of hassle, and it is. There are "
2260 "other ways outside of the C linking system to ensure that this kind of "
2261 "incompatibility never arises, such as using package versioning:"
2265 #: ../src/guestfs.pod:1113
2268 " Requires: libguestfs >= 1.0.80\n"
2273 #: ../src/guestfs.pod:1115
2274 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2278 #: ../src/guestfs.pod:1117
2280 "A recent feature of the API is the introduction of calls which take optional "
2281 "arguments. In C these are declared 3 ways. The main way is as a call which "
2282 "takes variable arguments (ie. C<...>), as in this example:"
2286 #: ../src/guestfs.pod:1122
2289 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2294 #: ../src/guestfs.pod:1124
2296 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2297 "call with no optional arguments specified:"
2301 #: ../src/guestfs.pod:1127
2304 " guestfs_add_drive_opts (g, filename, -1);\n"
2309 #: ../src/guestfs.pod:1129
2310 msgid "With a single optional argument:"
2314 #: ../src/guestfs.pod:1131
2317 " guestfs_add_drive_opts (g, filename,\n"
2318 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2324 #: ../src/guestfs.pod:1135
2329 #: ../src/guestfs.pod:1137
2332 " guestfs_add_drive_opts (g, filename,\n"
2333 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2334 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
2340 #: ../src/guestfs.pod:1142
2342 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
2347 #: ../src/guestfs.pod:1145
2348 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
2352 #: ../src/guestfs.pod:1147
2354 "The second variant has the same name with the suffix C<_va>, which works the "
2355 "same way but takes a C<va_list>. See the C manual for details. For the "
2356 "example function, this is declared:"
2360 #: ../src/guestfs.pod:1151
2363 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
2369 #: ../src/guestfs.pod:1154
2370 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
2374 #: ../src/guestfs.pod:1156
2376 "The third variant is useful where you need to construct these calls. You "
2377 "pass in a structure where you fill in the optional fields. The structure "
2378 "has a bitmask as the first element which you must set to indicate which "
2379 "fields you have filled in. For our example function the structure and call "
2384 #: ../src/guestfs.pod:1162
2387 " struct guestfs_add_drive_opts_argv {\n"
2388 " uint64_t bitmask;\n"
2390 " const char *format;\n"
2393 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
2394 " const struct guestfs_add_drive_opts_argv *optargs);\n"
2399 #: ../src/guestfs.pod:1171
2400 msgid "You could call it like this:"
2404 #: ../src/guestfs.pod:1173
2407 " struct guestfs_add_drive_opts_argv optargs = {\n"
2408 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
2409 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
2411 " .format = \"qcow2\"\n"
2417 #: ../src/guestfs.pod:1180
2420 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
2425 #: ../src/guestfs.pod:1182 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1661 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1244
2430 #: ../src/guestfs.pod:1188
2431 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
2435 #: ../src/guestfs.pod:1193
2436 msgid "You do not need to fill in all fields of the structure."
2440 #: ../src/guestfs.pod:1197
2442 "There must be a one-to-one correspondence between fields of the structure "
2443 "that are filled in, and bits set in the bitmask."
2447 #: ../src/guestfs.pod:1202
2448 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
2452 #: ../src/guestfs.pod:1204
2454 "In other languages, optional arguments are expressed in the way that is "
2455 "natural for that language. We refer you to the language-specific "
2456 "documentation for more details on that."
2460 #: ../src/guestfs.pod:1208
2461 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
2465 #: ../src/guestfs.pod:1210 ../src/guestfs.pod:1215
2470 #: ../src/guestfs.pod:1212
2472 "<!-- old anchor for the next section --> <a "
2473 "name=\"state_machine_and_low_level_event_api\"/>"
2477 #: ../src/guestfs.pod:1217
2478 msgid "ARCHITECTURE"
2482 #: ../src/guestfs.pod:1219
2484 "Internally, libguestfs is implemented by running an appliance (a special "
2485 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
2486 "process of the main program."
2490 #: ../src/guestfs.pod:1223
2493 " ___________________\n"
2495 " | main program |\n"
2497 " | | child process / appliance\n"
2498 " | | __________________________\n"
2500 " +-------------------+ RPC | +-----------------+ |\n"
2501 " | libguestfs <--------------------> guestfsd | |\n"
2502 " | | | +-----------------+ |\n"
2503 " \\___________________/ | | Linux kernel | |\n"
2504 " | +--^--------------+ |\n"
2505 " \\_________|________________/\n"
2511 " \\______________/\n"
2516 #: ../src/guestfs.pod:1243
2518 "The library, linked to the main program, creates the child process and hence "
2519 "the appliance in the L</guestfs_launch> function."
2523 #: ../src/guestfs.pod:1246
2525 "Inside the appliance is a Linux kernel and a complete stack of userspace "
2526 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
2527 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
2528 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
2529 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
2530 "attached to the qemu process which translates device access by the "
2531 "appliance's Linux kernel into accesses to the image."
2535 #: ../src/guestfs.pod:1255
2537 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
2538 "Although the disk image you are attached to might also be used by some "
2539 "virtual machine, libguestfs doesn't know or care about this. (But you will "
2540 "care if both libguestfs's qemu process and your virtual machine are trying "
2541 "to update the disk image at the same time, since these usually results in "
2542 "massive disk corruption)."
2546 #: ../src/guestfs.pod:1262
2547 msgid "STATE MACHINE"
2551 #: ../src/guestfs.pod:1264
2552 msgid "libguestfs uses a state machine to model the child process:"
2556 #: ../src/guestfs.pod:1266
2568 " / | \\ \\ guestfs_launch\n"
2569 " / | _\\__V______\n"
2571 " / | | LAUNCHING |\n"
2572 " / | \\___________/\n"
2574 " / | guestfs_launch\n"
2576 " ______ / __|____V\n"
2577 " / \\ ------> / \\\n"
2578 " | BUSY | | READY |\n"
2579 " \\______/ <------ \\________/\n"
2584 #: ../src/guestfs.pod:1288
2586 "The normal transitions are (1) CONFIG (when the handle is created, but there "
2587 "is no child process), (2) LAUNCHING (when the child process is booting up), "
2588 "(3) alternating between READY and BUSY as commands are issued to, and "
2589 "carried out by, the child process."
2593 #: ../src/guestfs.pod:1293
2595 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
2596 "asynchronously at any time (eg. due to some internal error), and that causes "
2597 "the state to transition back to CONFIG."
2601 #: ../src/guestfs.pod:1297
2603 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
2604 "issued when in the CONFIG state."
2608 #: ../src/guestfs.pod:1300
2610 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
2611 "L</guestfs_launch> blocks until the child process is READY to accept "
2612 "commands (or until some failure or timeout). L</guestfs_launch> internally "
2613 "moves the state from CONFIG to LAUNCHING while it is running."
2617 #: ../src/guestfs.pod:1306
2619 "API actions such as L</guestfs_mount> can only be issued when in the READY "
2620 "state. These API calls block waiting for the command to be carried out "
2621 "(ie. the state to transition to BUSY and then back to READY). There are no "
2622 "non-blocking versions, and no way to issue more than one command per handle "
2627 #: ../src/guestfs.pod:1312
2629 "Finally, the child process sends asynchronous messages back to the main "
2630 "program, such as kernel log messages. You can register a callback to "
2631 "receive these messages."
2635 #: ../src/guestfs.pod:1316
2636 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
2640 #: ../src/guestfs.pod:1318
2642 "The child process generates events in some situations. Current events "
2643 "include: receiving a log message, the child process exits."
2647 #: ../src/guestfs.pod:1321
2649 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
2654 #: ../src/guestfs.pod:1324
2656 "Only I<one callback of each type> can be registered for each handle. "
2657 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
2658 "that type. Cancel all callbacks of this type by calling this function with "
2659 "C<cb> set to C<NULL>."
2663 #: ../src/guestfs.pod:1329
2664 msgid "guestfs_set_log_message_callback"
2668 #: ../src/guestfs.pod:1331
2671 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
2672 " char *buf, int len);\n"
2673 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
2674 " guestfs_log_message_cb cb,\n"
2680 #: ../src/guestfs.pod:1337
2682 "The callback function C<cb> will be called whenever qemu or the guest writes "
2683 "anything to the console."
2687 #: ../src/guestfs.pod:1340
2688 msgid "Use this function to capture kernel messages and similar."
2692 #: ../src/guestfs.pod:1342
2694 "Normally there is no log message handler, and log messages are just "
2699 #: ../src/guestfs.pod:1345
2700 msgid "guestfs_set_subprocess_quit_callback"
2704 #: ../src/guestfs.pod:1347
2707 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
2708 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
2709 " guestfs_subprocess_quit_cb cb,\n"
2715 #: ../src/guestfs.pod:1352
2717 "The callback function C<cb> will be called when the child process quits, "
2718 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
2719 "corresponds to a transition from any state to the CONFIG state)."
2723 #: ../src/guestfs.pod:1357
2724 msgid "guestfs_set_launch_done_callback"
2728 #: ../src/guestfs.pod:1359
2731 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
2732 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
2733 " guestfs_launch_done_cb cb,\n"
2739 #: ../src/guestfs.pod:1364
2741 "The callback function C<cb> will be called when the child process becomes "
2742 "ready first time after it has been launched. (This corresponds to a "
2743 "transition from LAUNCHING to the READY state)."
2747 #: ../src/guestfs.pod:1368
2748 msgid "guestfs_set_close_callback"
2752 #: ../src/guestfs.pod:1370
2755 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
2756 " void guestfs_set_close_callback (guestfs_h *g,\n"
2757 " guestfs_close_cb cb,\n"
2763 #: ../src/guestfs.pod:1375
2765 "The callback function C<cb> will be called while the handle is being closed "
2766 "(synchronously from L</guestfs_close>)."
2770 #: ../src/guestfs.pod:1378
2772 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
2773 "handles that are open when the program exits. This means that this callback "
2774 "might be called indirectly from L<exit(3)>, which can cause unexpected "
2775 "problems in higher-level languages (eg. if your HLL interpreter has already "
2776 "been cleaned up by the time this is called, and if your callback then jumps "
2777 "into some HLL function)."
2781 #: ../src/guestfs.pod:1386
2782 msgid "guestfs_set_progress_callback"
2786 #: ../src/guestfs.pod:1388
2789 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
2790 " int proc_nr, int serial,\n"
2791 " uint64_t position, uint64_t total);\n"
2792 " void guestfs_set_progress_callback (guestfs_h *g,\n"
2793 " guestfs_progress_cb cb,\n"
2799 #: ../src/guestfs.pod:1395
2801 "Some long-running operations can generate progress messages. If this "
2802 "callback is registered, then it will be called each time a progress message "
2803 "is generated (usually two seconds after the operation started, and three "
2804 "times per second thereafter until it completes, although the frequency may "
2805 "change in future versions)."
2809 #: ../src/guestfs.pod:1401
2811 "The callback receives two numbers: C<position> and C<total>. The units of "
2812 "C<total> are not defined, although for some operations C<total> may relate "
2813 "in some way to the amount of data to be transferred (eg. in bytes or "
2814 "megabytes), and C<position> may be the portion which has been transferred."
2818 #: ../src/guestfs.pod:1407
2819 msgid "The only defined and stable parts of the API are:"
2823 #: ../src/guestfs.pod:1413
2825 "The callback can display to the user some type of progress bar or indicator "
2826 "which shows the ratio of C<position>:C<total>."
2830 #: ../src/guestfs.pod:1418
2831 msgid "0 E<lt>= C<position> E<lt>= C<total>"
2835 #: ../src/guestfs.pod:1422
2837 "If any progress notification is sent during a call, then a final progress "
2838 "notification is always sent when C<position> = C<total>."
2842 #: ../src/guestfs.pod:1425
2844 "This is to simplify caller code, so callers can easily set the progress "
2845 "indicator to \"100%\" at the end of the operation, without requiring special "
2846 "code to detect this case."
2850 #: ../src/guestfs.pod:1431
2852 "The callback also receives the procedure number and serial number of the "
2853 "call. These are only useful for debugging protocol issues, and the callback "
2854 "can normally ignore them. The callback may want to print these numbers in "
2855 "error messages or debugging messages."
2859 #: ../src/guestfs.pod:1436
2860 msgid "PRIVATE DATA AREA"
2864 #: ../src/guestfs.pod:1438
2866 "You can attach named pieces of private data to the libguestfs handle, and "
2867 "fetch them by name for the lifetime of the handle. This is called the "
2868 "private data area and is only available from the C API."
2872 #: ../src/guestfs.pod:1442
2873 msgid "To attach a named piece of data, use the following call:"
2877 #: ../src/guestfs.pod:1444
2880 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
2885 #: ../src/guestfs.pod:1446
2887 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
2888 "pointer (which can be C<NULL>). Any previous item with the same name is "
2893 #: ../src/guestfs.pod:1450
2895 "You can use any C<key> you want, but names beginning with an underscore "
2896 "character are reserved for internal libguestfs purposes (for implementing "
2897 "language bindings). It is recommended to prefix the name with some unique "
2898 "string to avoid collisions with other users."
2902 #: ../src/guestfs.pod:1455
2903 msgid "To retrieve the pointer, use:"
2907 #: ../src/guestfs.pod:1457
2910 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
2915 #: ../src/guestfs.pod:1459
2917 "This function returns C<NULL> if either no data is found associated with "
2918 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
2923 #: ../src/guestfs.pod:1463
2925 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
2926 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
2927 "all. In particular, libguestfs does I<not> try to free the data when the "
2928 "handle is closed. If the data must be freed, then the caller must either "
2929 "free it before calling L</guestfs_close> or must set up a close callback to "
2930 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
2931 "can be registered for a handle)."
2935 #: ../src/guestfs.pod:1471
2937 "The private data area is implemented using a hash table, and should be "
2938 "reasonably efficient for moderate numbers of keys."
2942 #: ../src/guestfs.pod:1474
2943 msgid "BLOCK DEVICE NAMING"
2947 #: ../src/guestfs.pod:1476
2949 "In the kernel there is now quite a profusion of schemata for naming block "
2950 "devices (in this context, by I<block device> I mean a physical or virtual "
2951 "hard drive). The original Linux IDE driver used names starting with "
2952 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
2953 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
2954 "replacement for the old IDE driver (particularly for SATA devices) those "
2955 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
2956 "machines with paravirtualized drivers. This has created several different "
2957 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
2962 #: ../src/guestfs.pod:1488
2964 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2965 "Linux kernel to access block devices. We can run a variety of appliances "
2966 "based on a variety of Linux kernels."
2970 #: ../src/guestfs.pod:1492
2972 "This causes a problem for libguestfs because many API calls use device or "
2973 "partition names. Working scripts and the recipe (example) scripts that we "
2974 "make available over the internet could fail if the naming scheme changes."
2978 #: ../src/guestfs.pod:1497
2980 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2981 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2982 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2983 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2987 #: ../src/guestfs.pod:1503
2989 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2990 "L</guestfs_list_partitions> and similar calls return the true names of the "
2991 "devices and partitions as known to the appliance."
2995 #: ../src/guestfs.pod:1508
2996 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
3000 #: ../src/guestfs.pod:1510
3002 "Usually this translation is transparent. However in some (very rare) cases "
3003 "you may need to know the exact algorithm. Such cases include where you use "
3004 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
3005 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
3010 #: ../src/guestfs.pod:1516
3012 "The algorithm is applied only to I<parameters> which are known to be either "
3013 "device or partition names. Return values from functions such as "
3014 "L</guestfs_list_devices> are never changed."
3018 #: ../src/guestfs.pod:1524
3019 msgid "Is the string a parameter which is a device or partition name?"
3023 #: ../src/guestfs.pod:1528
3024 msgid "Does the string begin with C</dev/sd>?"
3028 #: ../src/guestfs.pod:1532
3030 "Does the named device exist? If so, we use that device. However if I<not> "
3031 "then we continue with this algorithm."
3035 #: ../src/guestfs.pod:1537
3036 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
3040 #: ../src/guestfs.pod:1539
3041 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
3045 #: ../src/guestfs.pod:1541
3046 msgid "If that named device exists, use it. If not, continue."
3050 #: ../src/guestfs.pod:1545
3051 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
3055 #: ../src/guestfs.pod:1547
3056 msgid "If that named device exists, use it. If not, return an error."
3060 #: ../src/guestfs.pod:1551
3061 msgid "PORTABILITY CONCERNS"
3065 #: ../src/guestfs.pod:1553
3067 "Although the standard naming scheme and automatic translation is useful for "
3068 "simple programs and guestfish scripts, for larger programs it is best not to "
3069 "rely on this mechanism."
3073 #: ../src/guestfs.pod:1557
3075 "Where possible for maximum future portability programs using libguestfs "
3076 "should use these future-proof techniques:"
3080 #: ../src/guestfs.pod:1564
3082 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
3083 "device names, and then use those names directly."
3087 #: ../src/guestfs.pod:1567
3088 msgid "Since those device names exist by definition, they will never be translated."
3092 #: ../src/guestfs.pod:1572
3094 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
3095 "filesystem labels."
3099 #: ../src/guestfs.pod:1577
3104 #: ../src/guestfs.pod:1579
3105 msgid "COMMUNICATION PROTOCOL"
3109 #: ../src/guestfs.pod:1581
3111 "Don't rely on using this protocol directly. This section documents how it "
3112 "currently works, but it may change at any time."
3116 #: ../src/guestfs.pod:1584
3118 "The protocol used to talk between the library and the daemon running inside "
3119 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3120 "1014, RFC 1832, RFC 4506)."
3124 #: ../src/guestfs.pod:1588
3126 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3127 "this file is automatically generated)."
3131 #: ../src/guestfs.pod:1591
3133 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3134 "and C<FileOut> parameters, which are handled with very simple request/reply "
3135 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3136 "parameters, which use the same request and reply messages, but they may also "
3137 "be followed by files sent using a chunked encoding."
3141 #: ../src/guestfs.pod:1598
3142 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3146 #: ../src/guestfs.pod:1600
3147 msgid "For ordinary functions, the request message is:"
3151 #: ../src/guestfs.pod:1602
3154 " total length (header + arguments,\n"
3155 " but not including the length word itself)\n"
3156 " struct guestfs_message_header (encoded as XDR)\n"
3157 " struct guestfs_<foo>_args (encoded as XDR)\n"
3162 #: ../src/guestfs.pod:1607
3164 "The total length field allows the daemon to allocate a fixed size buffer "
3165 "into which it slurps the rest of the message. As a result, the total length "
3166 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3167 "effective size of any request is limited to somewhere under this size."
3171 #: ../src/guestfs.pod:1613
3173 "Note also that many functions don't take any arguments, in which case the "
3174 "C<guestfs_I<foo>_args> is completely omitted."
3178 #: ../src/guestfs.pod:1616
3180 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3181 "receiver knows what type of args structure to expect, or none at all."
3185 #: ../src/guestfs.pod:1620
3186 msgid "The reply message for ordinary functions is:"
3190 #: ../src/guestfs.pod:1622
3193 " total length (header + ret,\n"
3194 " but not including the length word itself)\n"
3195 " struct guestfs_message_header (encoded as XDR)\n"
3196 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3201 #: ../src/guestfs.pod:1627
3203 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3204 "functions that return no formal return values."
3208 #: ../src/guestfs.pod:1630
3209 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3213 #: ../src/guestfs.pod:1633
3215 "In the case of an error, a flag is set in the header, and the reply message "
3216 "is slightly changed:"
3220 #: ../src/guestfs.pod:1636
3223 " total length (header + error,\n"
3224 " but not including the length word itself)\n"
3225 " struct guestfs_message_header (encoded as XDR)\n"
3226 " struct guestfs_message_error (encoded as XDR)\n"
3231 #: ../src/guestfs.pod:1641
3233 "The C<guestfs_message_error> structure contains the error message as a "
3238 #: ../src/guestfs.pod:1644
3239 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3243 #: ../src/guestfs.pod:1646
3245 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3246 "The normal request message is sent (see above). However this is followed by "
3247 "a sequence of file chunks."
3251 #: ../src/guestfs.pod:1650
3254 " total length (header + arguments,\n"
3255 " but not including the length word itself,\n"
3256 " and not including the chunks)\n"
3257 " struct guestfs_message_header (encoded as XDR)\n"
3258 " struct guestfs_<foo>_args (encoded as XDR)\n"
3259 " sequence of chunks for FileIn param #0\n"
3260 " sequence of chunks for FileIn param #1 etc.\n"
3265 #: ../src/guestfs.pod:1658
3266 msgid "The \"sequence of chunks\" is:"
3270 #: ../src/guestfs.pod:1660
3273 " length of chunk (not including length word itself)\n"
3274 " struct guestfs_chunk (encoded as XDR)\n"
3275 " length of chunk\n"
3276 " struct guestfs_chunk (encoded as XDR)\n"
3278 " length of chunk\n"
3279 " struct guestfs_chunk (with data.data_len == 0)\n"
3284 #: ../src/guestfs.pod:1668
3286 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3287 "is set in the final chunk to indicate either successful completion or early "
3292 #: ../src/guestfs.pod:1672
3294 "At time of writing there are no functions that have more than one FileIn "
3295 "parameter. However this is (theoretically) supported, by sending the "
3296 "sequence of chunks for each FileIn parameter one after another (from left to "
3301 #: ../src/guestfs.pod:1677
3303 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3304 "transfer. The library does this by sending a chunk with a special flag set "
3305 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3306 "RPC, does I<not> send any reply, and goes back to reading the next request."
3310 #: ../src/guestfs.pod:1683
3312 "The daemon may also cancel. It does this by writing a special word "
3313 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3314 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3315 "cancel chunk). The special word is chosen so that even if cancellation "
3316 "happens right at the end of the transfer (after the library has finished "
3317 "writing and has started listening for the reply), the \"spurious\" cancel "
3318 "flag will not be confused with the reply message."
3322 #: ../src/guestfs.pod:1692
3324 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3325 "limit), and also files where the size is not known in advance (eg. from "
3326 "pipes or sockets). However the chunks are rather small "
3327 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3328 "to keep much in memory."
3332 #: ../src/guestfs.pod:1698
3333 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3337 #: ../src/guestfs.pod:1700
3339 "The protocol for FileOut parameters is exactly the same as for FileIn "
3340 "parameters, but with the roles of daemon and library reversed."
3344 #: ../src/guestfs.pod:1703
3347 " total length (header + ret,\n"
3348 " but not including the length word itself,\n"
3349 " and not including the chunks)\n"
3350 " struct guestfs_message_header (encoded as XDR)\n"
3351 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3352 " sequence of chunks for FileOut param #0\n"
3353 " sequence of chunks for FileOut param #1 etc.\n"
3358 #: ../src/guestfs.pod:1711
3359 msgid "INITIAL MESSAGE"
3363 #: ../src/guestfs.pod:1713
3365 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3366 "which indicates that the guest and daemon is alive. This is what "
3367 "L</guestfs_launch> waits for."
3371 #: ../src/guestfs.pod:1717
3372 msgid "PROGRESS NOTIFICATION MESSAGES"
3376 #: ../src/guestfs.pod:1719
3378 "The daemon may send progress notification messages at any time. These are "
3379 "distinguished by the normal length word being replaced by "
3380 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3384 #: ../src/guestfs.pod:1723
3386 "The library turns them into progress callbacks (see "
3387 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3388 "discards them if not."
3392 #: ../src/guestfs.pod:1727
3394 "The daemon self-limits the frequency of progress messages it sends (see "
3395 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3400 #: ../src/guestfs.pod:1731
3401 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
3405 #: ../src/guestfs.pod:1733
3407 "All high-level libguestfs actions are synchronous. If you want to use "
3408 "libguestfs asynchronously then you must create a thread."
3412 #: ../src/guestfs.pod:1736
3414 "Only use the handle from a single thread. Either use the handle exclusively "
3415 "from one thread, or provide your own mutex so that two threads cannot issue "
3416 "calls on the same handle at the same time."
3420 #: ../src/guestfs.pod:1740
3422 "See the graphical program guestfs-browser for one possible architecture for "
3423 "multithreaded programs using libvirt and libguestfs."
3427 #: ../src/guestfs.pod:1743
3428 msgid "QEMU WRAPPERS"
3432 #: ../src/guestfs.pod:1745
3434 "If you want to compile your own qemu, run qemu from a non-standard location, "
3435 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
3440 #: ../src/guestfs.pod:1749
3442 "There is one important rule to remember: you I<must C<exec qemu>> as the "
3443 "last command in the shell script (so that qemu replaces the shell and "
3444 "becomes the direct child of the libguestfs-using program). If you don't do "
3445 "this, then the qemu process won't be cleaned up correctly."
3449 #: ../src/guestfs.pod:1754
3451 "Here is an example of a wrapper, where I have built my own copy of qemu from "
3456 #: ../src/guestfs.pod:1757
3460 " qemudir=/home/rjones/d/qemu\n"
3461 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
3467 #: ../src/guestfs.pod:1761
3469 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
3470 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
3475 #: ../src/guestfs.pod:1765
3478 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
3483 #: ../src/guestfs.pod:1767
3485 "Note that libguestfs also calls qemu with the -help and -version options in "
3486 "order to determine features."
3490 #: ../src/guestfs.pod:1770
3491 msgid "LIBGUESTFS VERSION NUMBERS"
3495 #: ../src/guestfs.pod:1772
3497 "Since April 2010, libguestfs has started to make separate development and "
3498 "stable releases, along with corresponding branches in our git repository. "
3499 "These separate releases can be identified by version number:"
3503 #: ../src/guestfs.pod:1777
3506 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3507 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3513 " | `-------- sub-version\n"
3515 " `------ always '1' because we don't change the ABI\n"
3520 #: ../src/guestfs.pod:1788
3521 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3525 #: ../src/guestfs.pod:1790
3527 "As time passes we cherry pick fixes from the development branch and backport "
3528 "those into the stable branch, the effect being that the stable branch should "
3529 "get more stable and less buggy over time. So the stable releases are ideal "
3530 "for people who don't need new features but would just like the software to "
3535 #: ../src/guestfs.pod:1796
3536 msgid "Our criteria for backporting changes are:"
3540 #: ../src/guestfs.pod:1802
3542 "Documentation changes which don't affect any code are backported unless the "
3543 "documentation refers to a future feature which is not in stable."
3547 #: ../src/guestfs.pod:1808
3549 "Bug fixes which are not controversial, fix obvious problems, and have been "
3550 "well tested are backported."
3554 #: ../src/guestfs.pod:1813
3556 "Simple rearrangements of code which shouldn't affect how it works get "
3557 "backported. This is so that the code in the two branches doesn't get too "
3558 "far out of step, allowing us to backport future fixes more easily."
3562 #: ../src/guestfs.pod:1819
3564 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3565 "exceptional case: the new feature is required in order to implement an "
3566 "important bug fix."
3570 #: ../src/guestfs.pod:1825
3572 "A new stable branch starts when we think the new features in development are "
3573 "substantial and compelling enough over the current stable branch to warrant "
3574 "it. When that happens we create new stable and development versions 1.N.0 "
3575 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
3576 "stable at this point, but by backporting fixes from development, that branch "
3577 "will stabilize over time."
3581 #: ../src/guestfs.pod:1833 ../fish/guestfish.pod:867 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 ../tools/virt-rescue.pl:255
3582 msgid "ENVIRONMENT VARIABLES"
3586 #: ../src/guestfs.pod:1837 ../fish/guestfish.pod:893
3587 msgid "LIBGUESTFS_APPEND"
3591 #: ../src/guestfs.pod:1839 ../fish/guestfish.pod:895
3592 msgid "Pass additional options to the guest kernel."
3596 #: ../src/guestfs.pod:1841 ../fish/guestfish.pod:897
3597 msgid "LIBGUESTFS_DEBUG"
3601 #: ../src/guestfs.pod:1843
3603 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
3604 "effect as calling C<guestfs_set_verbose (g, 1)>."
3608 #: ../src/guestfs.pod:1846 ../fish/guestfish.pod:902
3609 msgid "LIBGUESTFS_MEMSIZE"
3613 #: ../src/guestfs.pod:1848 ../fish/guestfish.pod:904
3614 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
3618 #: ../src/guestfs.pod:1851 ../fish/guestfish.pod:907
3621 " LIBGUESTFS_MEMSIZE=700\n"
3626 #: ../src/guestfs.pod:1853 ../fish/guestfish.pod:909
3627 msgid "LIBGUESTFS_PATH"
3631 #: ../src/guestfs.pod:1855
3633 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
3634 "the discussion of paths in section PATH above."
3638 #: ../src/guestfs.pod:1858 ../fish/guestfish.pod:914
3639 msgid "LIBGUESTFS_QEMU"
3643 #: ../src/guestfs.pod:1860 ../fish/guestfish.pod:916
3645 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
3646 "which was found at compile time by the configure script is used."
3650 #: ../src/guestfs.pod:1864
3651 msgid "See also L</QEMU WRAPPERS> above."
3655 #: ../src/guestfs.pod:1866 ../fish/guestfish.pod:920
3656 msgid "LIBGUESTFS_TRACE"
3660 #: ../src/guestfs.pod:1868
3662 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
3663 "effect as calling C<guestfs_set_trace (g, 1)>."
3667 #: ../src/guestfs.pod:1871 ../fish/guestfish.pod:929
3672 #: ../src/guestfs.pod:1873 ../fish/guestfish.pod:931
3673 msgid "Location of temporary directory, defaults to C</tmp>."
3677 #: ../src/guestfs.pod:1875 ../fish/guestfish.pod:933
3679 "If libguestfs was compiled to use the supermin appliance then the real "
3680 "appliance is cached in this directory, shared between all handles belonging "
3681 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
3682 "use in case C</tmp> is not large enough."
3686 #: ../src/guestfs.pod:1883 ../fish/guestfish.pod:991 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:214 ../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
3691 #: ../src/guestfs.pod:1885
3693 "L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
3694 "L<virt-edit(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
3695 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
3696 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
3697 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
3701 #: ../src/guestfs.pod:1903
3703 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
3704 "L<lvm(8)>, L<disktype(1)>."
3708 #: ../src/guestfs.pod:1910 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548
3713 #: ../src/guestfs.pod:1912
3714 msgid "To get a list of bugs against libguestfs use this link:"
3718 #: ../src/guestfs.pod:1914
3719 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
3723 #: ../src/guestfs.pod:1916
3724 msgid "To report a new bug against libguestfs use this link:"
3728 #: ../src/guestfs.pod:1918
3729 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
3733 #: ../src/guestfs.pod:1920
3734 msgid "When reporting a bug, please check:"
3738 #: ../src/guestfs.pod:1926
3739 msgid "That the bug hasn't been reported already."
3743 #: ../src/guestfs.pod:1930
3744 msgid "That you are testing a recent version."
3748 #: ../src/guestfs.pod:1934
3749 msgid "Describe the bug accurately, and give a way to reproduce it."
3753 #: ../src/guestfs.pod:1938
3755 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
3760 #: ../src/guestfs.pod:1943 ../fish/guestfish.pod:1008 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:225 ../inspector/virt-inspector.pl:580
3765 #: ../src/guestfs.pod:1945 ../fish/guestfish.pod:1010 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:227
3766 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
3770 #: ../src/guestfs.pod:1947 ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:229 ../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
3775 #: ../src/guestfs.pod:1949 ../fish/guestfish.pod:1014 ../fuse/guestmount.pod:231
3776 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
3780 #: ../src/guestfs.pod:1952
3782 "This library is free software; you can redistribute it and/or modify it "
3783 "under the terms of the GNU Lesser General Public License as published by the "
3784 "Free Software Foundation; either version 2 of the License, or (at your "
3785 "option) any later version."
3789 #: ../src/guestfs.pod:1957
3791 "This library is distributed in the hope that it will be useful, but WITHOUT "
3792 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
3793 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
3798 #: ../src/guestfs.pod:1962
3800 "You should have received a copy of the GNU Lesser General Public License "
3801 "along with this library; if not, write to the Free Software Foundation, "
3802 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
3806 #: ../src/guestfs-actions.pod:1
3807 msgid "guestfs_add_cdrom"
3811 #: ../src/guestfs-actions.pod:3
3815 " guestfs_add_cdrom (guestfs_h *g,\n"
3816 " const char *filename);\n"
3821 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
3822 msgid "This function adds a virtual CD-ROM disk image to the guest."
3826 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
3827 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
3831 #: ../src/guestfs-actions.pod:17
3833 "This call checks for the existence of C<filename>. This stops you from "
3834 "specifying other types of drive which are supported by qemu such as C<nbd:> "
3835 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
3840 #: ../src/guestfs-actions.pod:24
3842 "If you just want to add an ISO file (often you use this as an efficient way "
3843 "to transfer large files into the guest), then you should probably use "
3844 "C<guestfs_add_drive_ro> instead."
3848 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:56 ../src/guestfs-actions.pod:115 ../src/guestfs-actions.pod:150 ../src/guestfs-actions.pod:162 ../src/guestfs-actions.pod:181 ../src/guestfs-actions.pod:199 ../src/guestfs-actions.pod:211 ../src/guestfs-actions.pod:318 ../src/guestfs-actions.pod:336 ../src/guestfs-actions.pod:348 ../src/guestfs-actions.pod:387 ../src/guestfs-actions.pod:411 ../src/guestfs-actions.pod:427 ../src/guestfs-actions.pod:492 ../src/guestfs-actions.pod:521 ../src/guestfs-actions.pod:533 ../src/guestfs-actions.pod:546 ../src/guestfs-actions.pod:633 ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:673 ../src/guestfs-actions.pod:824 ../src/guestfs-actions.pod:842 ../src/guestfs-actions.pod:858 ../src/guestfs-actions.pod:936 ../src/guestfs-actions.pod:952 ../src/guestfs-actions.pod:969 ../src/guestfs-actions.pod:981 ../src/guestfs-actions.pod:999 ../src/guestfs-actions.pod:1034 ../src/guestfs-actions.pod:1096 ../src/guestfs-actions.pod:1125 ../src/guestfs-actions.pod:1148 ../src/guestfs-actions.pod:1181 ../src/guestfs-actions.pod:1275 ../src/guestfs-actions.pod:1307 ../src/guestfs-actions.pod:1513 ../src/guestfs-actions.pod:1533 ../src/guestfs-actions.pod:1616 ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2119 ../src/guestfs-actions.pod:2176 ../src/guestfs-actions.pod:2208 ../src/guestfs-actions.pod:2680 ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2711 ../src/guestfs-actions.pod:2825 ../src/guestfs-actions.pod:2837 ../src/guestfs-actions.pod:2848 ../src/guestfs-actions.pod:2860 ../src/guestfs-actions.pod:2873 ../src/guestfs-actions.pod:2905 ../src/guestfs-actions.pod:2972 ../src/guestfs-actions.pod:2990 ../src/guestfs-actions.pod:3005 ../src/guestfs-actions.pod:3026 ../src/guestfs-actions.pod:3047 ../src/guestfs-actions.pod:3077 ../src/guestfs-actions.pod:3094 ../src/guestfs-actions.pod:3111 ../src/guestfs-actions.pod:3142 ../src/guestfs-actions.pod:3152 ../src/guestfs-actions.pod:3186 ../src/guestfs-actions.pod:3200 ../src/guestfs-actions.pod:3211 ../src/guestfs-actions.pod:3224 ../src/guestfs-actions.pod:3239 ../src/guestfs-actions.pod:3324 ../src/guestfs-actions.pod:3342 ../src/guestfs-actions.pod:3353 ../src/guestfs-actions.pod:3400 ../src/guestfs-actions.pod:3416 ../src/guestfs-actions.pod:3432 ../src/guestfs-actions.pod:3446 ../src/guestfs-actions.pod:3458 ../src/guestfs-actions.pod:3470 ../src/guestfs-actions.pod:3485 ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3516 ../src/guestfs-actions.pod:3563 ../src/guestfs-actions.pod:3592 ../src/guestfs-actions.pod:3609 ../src/guestfs-actions.pod:3626 ../src/guestfs-actions.pod:3636 ../src/guestfs-actions.pod:3651 ../src/guestfs-actions.pod:3662 ../src/guestfs-actions.pod:3675 ../src/guestfs-actions.pod:3688 ../src/guestfs-actions.pod:3721 ../src/guestfs-actions.pod:3734 ../src/guestfs-actions.pod:3752 ../src/guestfs-actions.pod:3764 ../src/guestfs-actions.pod:3779 ../src/guestfs-actions.pod:3822 ../src/guestfs-actions.pod:3855 ../src/guestfs-actions.pod:3867 ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:3908 ../src/guestfs-actions.pod:3924 ../src/guestfs-actions.pod:4050 ../src/guestfs-actions.pod:4104 ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4140 ../src/guestfs-actions.pod:4168 ../src/guestfs-actions.pod:4228 ../src/guestfs-actions.pod:4243 ../src/guestfs-actions.pod:4254 ../src/guestfs-actions.pod:4266 ../src/guestfs-actions.pod:4533 ../src/guestfs-actions.pod:4550 ../src/guestfs-actions.pod:4562 ../src/guestfs-actions.pod:4572 ../src/guestfs-actions.pod:4584 ../src/guestfs-actions.pod:4594 ../src/guestfs-actions.pod:4606 ../src/guestfs-actions.pod:4620 ../src/guestfs-actions.pod:4639 ../src/guestfs-actions.pod:4656 ../src/guestfs-actions.pod:4673 ../src/guestfs-actions.pod:4689 ../src/guestfs-actions.pod:4710 ../src/guestfs-actions.pod:4726 ../src/guestfs-actions.pod:4743 ../src/guestfs-actions.pod:4762 ../src/guestfs-actions.pod:4779 ../src/guestfs-actions.pod:4794 ../src/guestfs-actions.pod:4820 ../src/guestfs-actions.pod:4842 ../src/guestfs-actions.pod:4859 ../src/guestfs-actions.pod:4881 ../src/guestfs-actions.pod:4894 ../src/guestfs-actions.pod:4907 ../src/guestfs-actions.pod:4924 ../src/guestfs-actions.pod:4959 ../src/guestfs-actions.pod:4980 ../src/guestfs-actions.pod:5004 ../src/guestfs-actions.pod:5100 ../src/guestfs-actions.pod:5211 ../src/guestfs-actions.pod:5221 ../src/guestfs-actions.pod:5232 ../src/guestfs-actions.pod:5243 ../src/guestfs-actions.pod:5263 ../src/guestfs-actions.pod:5274 ../src/guestfs-actions.pod:5285 ../src/guestfs-actions.pod:5296 ../src/guestfs-actions.pod:5309 ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5377 ../src/guestfs-actions.pod:5391 ../src/guestfs-actions.pod:5405 ../src/guestfs-actions.pod:5420 ../src/guestfs-actions.pod:5431 ../src/guestfs-actions.pod:5449 ../src/guestfs-actions.pod:5481 ../src/guestfs-actions.pod:5493 ../src/guestfs-actions.pod:5530 ../src/guestfs-actions.pod:5541 ../src/guestfs-actions.pod:5557 ../src/guestfs-actions.pod:5584 ../src/guestfs-actions.pod:5613 ../src/guestfs-actions.pod:5722 ../src/guestfs-actions.pod:5738 ../src/guestfs-actions.pod:5750 ../src/guestfs-actions.pod:5799 ../src/guestfs-actions.pod:5810 ../src/guestfs-actions.pod:5850 ../src/guestfs-actions.pod:5879 ../src/guestfs-actions.pod:5925 ../src/guestfs-actions.pod:5949 ../src/guestfs-actions.pod:6009 ../src/guestfs-actions.pod:6026 ../src/guestfs-actions.pod:6053
3849 msgid "This function returns 0 on success or -1 on error."
3853 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:164 ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:117 ../fish/guestfish-actions.pod:131
3855 "This function is deprecated. In new code, use the C<add_drive_opts> call "
3860 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:186 ../src/guestfs-actions.pod:1280 ../src/guestfs-actions.pod:1732 ../src/guestfs-actions.pod:1751 ../src/guestfs-actions.pod:5957 ../src/guestfs-actions.pod:6110 ../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:4353 ../fish/guestfish-actions.pod:4450
3862 "Deprecated functions will not be removed from the API, but the fact that "
3863 "they are deprecated indicates that there are problems with correct use of "
3868 #: ../src/guestfs-actions.pod:39
3869 msgid "guestfs_add_drive"
3873 #: ../src/guestfs-actions.pod:41
3877 " guestfs_add_drive (guestfs_h *g,\n"
3878 " const char *filename);\n"
3883 #: ../src/guestfs-actions.pod:45
3885 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
3886 "optional parameters, so the disk is added writable, with the format being "
3887 "detected automatically."
3891 #: ../src/guestfs-actions.pod:49
3893 "Automatic detection of the format opens you up to a potential security hole "
3894 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
3895 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
3896 "you should think about replacing calls to this function with calls to "
3897 "C<guestfs_add_drive_opts>, and specifying the format."
3901 #: ../src/guestfs-actions.pod:58
3902 msgid "guestfs_add_drive_opts"
3906 #: ../src/guestfs-actions.pod:60
3910 " guestfs_add_drive_opts (guestfs_h *g,\n"
3911 " const char *filename,\n"
3917 #: ../src/guestfs-actions.pod:65
3919 "You may supply a list of optional arguments to this call. Use zero or more "
3920 "of the following pairs of parameters, and terminate the list with C<-1> on "
3921 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
3925 #: ../src/guestfs-actions.pod:70
3928 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
3929 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
3930 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
3935 #: ../src/guestfs-actions.pod:74 ../fish/guestfish-actions.pod:56
3937 "This function adds a virtual machine disk image C<filename> to libguestfs. "
3938 "The first time you call this function, the disk appears as C</dev/sda>, the "
3939 "second time as C</dev/sdb>, and so on."
3943 #: ../src/guestfs-actions.pod:79 ../fish/guestfish-actions.pod:61
3945 "You don't necessarily need to be root when using libguestfs. However you "
3946 "obviously do need sufficient permissions to access the filename for whatever "
3947 "operations you want to perform (ie. read access if you just want to read the "
3948 "image or write access if you want to modify the image)."
3952 #: ../src/guestfs-actions.pod:85 ../fish/guestfish-actions.pod:67
3953 msgid "This call checks that C<filename> exists."
3957 #: ../src/guestfs-actions.pod:87 ../fish/guestfish-actions.pod:69
3958 msgid "The optional arguments are:"
3962 #: ../src/guestfs-actions.pod:91 ../fish/guestfish-actions.pod:73
3967 #: ../src/guestfs-actions.pod:93 ../fish/guestfish-actions.pod:75
3969 "If true then the image is treated as read-only. Writes are still allowed, "
3970 "but they are stored in a temporary snapshot overlay which is discarded at "
3971 "the end. The disk that you add is not modified."
3975 #: ../src/guestfs-actions.pod:97 ../fish/guestfish-actions.pod:79
3980 #: ../src/guestfs-actions.pod:99
3982 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
3983 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
3984 "Possible formats include C<raw> and C<qcow2>."
3988 #: ../src/guestfs-actions.pod:103 ../fish/guestfish-actions.pod:85
3990 "Automatic detection of the format opens you up to a potential security hole "
3991 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
3992 "RHBZ#642934. Specifying the format closes this security hole."
3996 #: ../src/guestfs-actions.pod:108 ../fish/guestfish-actions.pod:90
4001 #: ../src/guestfs-actions.pod:110
4003 "This rarely-used option lets you emulate the behaviour of the deprecated "
4004 "C<guestfs_add_drive_with_if> call (q.v.)"
4008 #: ../src/guestfs-actions.pod:117
4009 msgid "guestfs_add_drive_opts_va"
4013 #: ../src/guestfs-actions.pod:119
4017 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
4018 " const char *filename,\n"
4024 #: ../src/guestfs-actions.pod:124
4025 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4029 #: ../src/guestfs-actions.pod:126 ../src/guestfs-actions.pod:137
4030 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4034 #: ../src/guestfs-actions.pod:128
4035 msgid "guestfs_add_drive_opts_argv"
4039 #: ../src/guestfs-actions.pod:130
4043 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4044 " const char *filename,\n"
4045 " const struct guestfs_add_drive_opts_argv "
4051 #: ../src/guestfs-actions.pod:135
4052 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4056 #: ../src/guestfs-actions.pod:139
4057 msgid "guestfs_add_drive_ro"
4061 #: ../src/guestfs-actions.pod:141
4065 " guestfs_add_drive_ro (guestfs_h *g,\n"
4066 " const char *filename);\n"
4071 #: ../src/guestfs-actions.pod:145
4073 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4074 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4075 "disk is added read-only, with the format being detected automatically."
4079 #: ../src/guestfs-actions.pod:152
4080 msgid "guestfs_add_drive_ro_with_if"
4084 #: ../src/guestfs-actions.pod:154
4088 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4089 " const char *filename,\n"
4090 " const char *iface);\n"
4095 #: ../src/guestfs-actions.pod:159
4097 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4098 "QEMU interface emulation to use at run time."
4102 #: ../src/guestfs-actions.pod:171
4103 msgid "guestfs_add_drive_with_if"
4107 #: ../src/guestfs-actions.pod:173
4111 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4112 " const char *filename,\n"
4113 " const char *iface);\n"
4118 #: ../src/guestfs-actions.pod:178
4120 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4121 "QEMU interface emulation to use at run time."
4125 #: ../src/guestfs-actions.pod:190
4126 msgid "guestfs_aug_clear"
4130 #: ../src/guestfs-actions.pod:192
4134 " guestfs_aug_clear (guestfs_h *g,\n"
4135 " const char *augpath);\n"
4140 #: ../src/guestfs-actions.pod:196 ../fish/guestfish-actions.pod:142
4142 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4143 "L<augtool(1)> C<clear> command."
4147 #: ../src/guestfs-actions.pod:201
4148 msgid "guestfs_aug_close"
4152 #: ../src/guestfs-actions.pod:203
4156 " guestfs_aug_close (guestfs_h *g);\n"
4161 #: ../src/guestfs-actions.pod:206
4163 "Close the current Augeas handle and free up any resources used by it. After "
4164 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4165 "any other Augeas functions."
4169 #: ../src/guestfs-actions.pod:213
4170 msgid "guestfs_aug_defnode"
4174 #: ../src/guestfs-actions.pod:215
4177 " struct guestfs_int_bool *\n"
4178 " guestfs_aug_defnode (guestfs_h *g,\n"
4179 " const char *name,\n"
4180 " const char *expr,\n"
4181 " const char *val);\n"
4186 #: ../src/guestfs-actions.pod:221 ../fish/guestfish-actions.pod:158
4187 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4191 #: ../src/guestfs-actions.pod:224
4193 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4194 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4195 "containing that single node."
4199 #: ../src/guestfs-actions.pod:228 ../fish/guestfish-actions.pod:165
4201 "On success this returns a pair containing the number of nodes in the "
4202 "nodeset, and a boolean flag if a node was created."
4206 #: ../src/guestfs-actions.pod:232
4208 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4209 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4213 #: ../src/guestfs-actions.pod:236
4214 msgid "guestfs_aug_defvar"
4218 #: ../src/guestfs-actions.pod:238
4222 " guestfs_aug_defvar (guestfs_h *g,\n"
4223 " const char *name,\n"
4224 " const char *expr);\n"
4229 #: ../src/guestfs-actions.pod:243 ../fish/guestfish-actions.pod:173
4231 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4232 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4236 #: ../src/guestfs-actions.pod:247 ../fish/guestfish-actions.pod:177
4238 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4239 "evaluates to something which is not a nodeset."
4243 #: ../src/guestfs-actions.pod:250 ../src/guestfs-actions.pod:399 ../src/guestfs-actions.pod:561 ../src/guestfs-actions.pod:588 ../src/guestfs-actions.pod:604 ../src/guestfs-actions.pod:621 ../src/guestfs-actions.pod:1166 ../src/guestfs-actions.pod:1494 ../src/guestfs-actions.pod:1683 ../src/guestfs-actions.pod:1770 ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:1851 ../src/guestfs-actions.pod:1870 ../src/guestfs-actions.pod:2108 ../src/guestfs-actions.pod:2349 ../src/guestfs-actions.pod:2368 ../src/guestfs-actions.pod:3843 ../src/guestfs-actions.pod:3957 ../src/guestfs-actions.pod:4329 ../src/guestfs-actions.pod:4353 ../src/guestfs-actions.pod:5518 ../src/guestfs-actions.pod:5890 ../src/guestfs-actions.pod:5901 ../src/guestfs-actions.pod:5912
4244 msgid "On error this function returns -1."
4248 #: ../src/guestfs-actions.pod:252
4249 msgid "guestfs_aug_get"
4253 #: ../src/guestfs-actions.pod:254
4257 " guestfs_aug_get (guestfs_h *g,\n"
4258 " const char *augpath);\n"
4263 #: ../src/guestfs-actions.pod:258 ../fish/guestfish-actions.pod:184
4265 "Look up the value associated with C<path>. If C<path> matches exactly one "
4266 "node, the C<value> is returned."
4270 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:713 ../src/guestfs-actions.pod:729 ../src/guestfs-actions.pod:787 ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:896 ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1047 ../src/guestfs-actions.pod:1062 ../src/guestfs-actions.pod:1079 ../src/guestfs-actions.pod:1196 ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1479 ../src/guestfs-actions.pod:1630 ../src/guestfs-actions.pod:1645 ../src/guestfs-actions.pod:1726 ../src/guestfs-actions.pod:1745 ../src/guestfs-actions.pod:1891 ../src/guestfs-actions.pod:2038 ../src/guestfs-actions.pod:2228 ../src/guestfs-actions.pod:2299 ../src/guestfs-actions.pod:2420 ../src/guestfs-actions.pod:2456 ../src/guestfs-actions.pod:2477 ../src/guestfs-actions.pod:2813 ../src/guestfs-actions.pod:3128 ../src/guestfs-actions.pod:3279 ../src/guestfs-actions.pod:3380 ../src/guestfs-actions.pod:3973 ../src/guestfs-actions.pod:4155 ../src/guestfs-actions.pod:4306 ../src/guestfs-actions.pod:4473 ../src/guestfs-actions.pod:4518 ../src/guestfs-actions.pod:5023 ../src/guestfs-actions.pod:5037 ../src/guestfs-actions.pod:5052 ../src/guestfs-actions.pod:5074 ../src/guestfs-actions.pod:5668 ../src/guestfs-actions.pod:5685 ../src/guestfs-actions.pod:5701 ../src/guestfs-actions.pod:5860 ../src/guestfs-actions.pod:6104
4272 "This function returns a string, or NULL on error. I<The caller must free "
4273 "the returned string after use>."
4277 #: ../src/guestfs-actions.pod:264
4278 msgid "guestfs_aug_init"
4282 #: ../src/guestfs-actions.pod:266
4286 " guestfs_aug_init (guestfs_h *g,\n"
4287 " const char *root,\n"
4293 #: ../src/guestfs-actions.pod:271 ../fish/guestfish-actions.pod:191
4295 "Create a new Augeas handle for editing configuration files. If there was "
4296 "any previous Augeas handle associated with this guestfs session, then it is "
4301 #: ../src/guestfs-actions.pod:275
4302 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4306 #: ../src/guestfs-actions.pod:278 ../fish/guestfish-actions.pod:198
4307 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4311 #: ../src/guestfs-actions.pod:281 ../fish/guestfish-actions.pod:201
4313 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4314 "logical I<or> of the following integers:"
4318 #: ../src/guestfs-actions.pod:287 ../fish/guestfish-actions.pod:207
4319 msgid "C<AUG_SAVE_BACKUP> = 1"
4323 #: ../src/guestfs-actions.pod:289 ../fish/guestfish-actions.pod:209
4324 msgid "Keep the original file with a C<.augsave> extension."
4328 #: ../src/guestfs-actions.pod:291 ../fish/guestfish-actions.pod:211
4329 msgid "C<AUG_SAVE_NEWFILE> = 2"
4333 #: ../src/guestfs-actions.pod:293 ../fish/guestfish-actions.pod:213
4335 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4336 "original. Overrides C<AUG_SAVE_BACKUP>."
4340 #: ../src/guestfs-actions.pod:296 ../fish/guestfish-actions.pod:216
4341 msgid "C<AUG_TYPE_CHECK> = 4"
4345 #: ../src/guestfs-actions.pod:298 ../fish/guestfish-actions.pod:218
4346 msgid "Typecheck lenses (can be expensive)."
4350 #: ../src/guestfs-actions.pod:300 ../fish/guestfish-actions.pod:220
4351 msgid "C<AUG_NO_STDINC> = 8"
4355 #: ../src/guestfs-actions.pod:302 ../fish/guestfish-actions.pod:222
4356 msgid "Do not use standard load path for modules."
4360 #: ../src/guestfs-actions.pod:304 ../fish/guestfish-actions.pod:224
4361 msgid "C<AUG_SAVE_NOOP> = 16"
4365 #: ../src/guestfs-actions.pod:306 ../fish/guestfish-actions.pod:226
4366 msgid "Make save a no-op, just record what would have been changed."
4370 #: ../src/guestfs-actions.pod:308 ../fish/guestfish-actions.pod:228
4371 msgid "C<AUG_NO_LOAD> = 32"
4375 #: ../src/guestfs-actions.pod:310
4376 msgid "Do not load the tree in C<guestfs_aug_init>."
4380 #: ../src/guestfs-actions.pod:314
4381 msgid "To close the handle, you can call C<guestfs_aug_close>."
4385 #: ../src/guestfs-actions.pod:316 ../fish/guestfish-actions.pod:236
4386 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4390 #: ../src/guestfs-actions.pod:320
4391 msgid "guestfs_aug_insert"
4395 #: ../src/guestfs-actions.pod:322
4399 " guestfs_aug_insert (guestfs_h *g,\n"
4400 " const char *augpath,\n"
4401 " const char *label,\n"
4407 #: ../src/guestfs-actions.pod:328 ../fish/guestfish-actions.pod:242
4409 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4410 "or after C<path> (depending on the boolean flag C<before>)."
4414 #: ../src/guestfs-actions.pod:332 ../fish/guestfish-actions.pod:246
4416 "C<path> must match exactly one existing node in the tree, and C<label> must "
4417 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4421 #: ../src/guestfs-actions.pod:338
4422 msgid "guestfs_aug_load"
4426 #: ../src/guestfs-actions.pod:340
4430 " guestfs_aug_load (guestfs_h *g);\n"
4435 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:254
4436 msgid "Load files into the tree."
4440 #: ../src/guestfs-actions.pod:345 ../fish/guestfish-actions.pod:256
4441 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4445 #: ../src/guestfs-actions.pod:350
4446 msgid "guestfs_aug_ls"
4450 #: ../src/guestfs-actions.pod:352
4454 " guestfs_aug_ls (guestfs_h *g,\n"
4455 " const char *augpath);\n"
4460 #: ../src/guestfs-actions.pod:356
4462 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
4463 "sorting the resulting nodes into alphabetical order."
4467 #: ../src/guestfs-actions.pod:359 ../src/guestfs-actions.pod:373 ../src/guestfs-actions.pod:507 ../src/guestfs-actions.pod:913 ../src/guestfs-actions.pod:1209 ../src/guestfs-actions.pod:1226 ../src/guestfs-actions.pod:1319 ../src/guestfs-actions.pod:1336 ../src/guestfs-actions.pod:1573 ../src/guestfs-actions.pod:1930 ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:1961 ../src/guestfs-actions.pod:2000 ../src/guestfs-actions.pod:2022 ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2130 ../src/guestfs-actions.pod:2322 ../src/guestfs-actions.pod:2517 ../src/guestfs-actions.pod:2739 ../src/guestfs-actions.pod:2797 ../src/guestfs-actions.pod:2888 ../src/guestfs-actions.pod:3254 ../src/guestfs-actions.pod:3808 ../src/guestfs-actions.pod:4281 ../src/guestfs-actions.pod:4396 ../src/guestfs-actions.pod:4505 ../src/guestfs-actions.pod:5088 ../src/guestfs-actions.pod:5141 ../src/guestfs-actions.pod:5194 ../src/guestfs-actions.pod:5320 ../src/guestfs-actions.pod:5342 ../src/guestfs-actions.pod:5766 ../src/guestfs-actions.pod:5784 ../src/guestfs-actions.pod:5825 ../src/guestfs-actions.pod:5971 ../src/guestfs-actions.pod:5988 ../src/guestfs-actions.pod:6065 ../src/guestfs-actions.pod:6082 ../src/guestfs-actions.pod:6124 ../src/guestfs-actions.pod:6141
4469 "This function returns a NULL-terminated array of strings (like "
4470 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
4471 "strings and the array after use>."
4475 #: ../src/guestfs-actions.pod:363
4476 msgid "guestfs_aug_match"
4480 #: ../src/guestfs-actions.pod:365
4484 " guestfs_aug_match (guestfs_h *g,\n"
4485 " const char *augpath);\n"
4490 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:270
4492 "Returns a list of paths which match the path expression C<path>. The "
4493 "returned paths are sufficiently qualified so that they match exactly one "
4494 "node in the current tree."
4498 #: ../src/guestfs-actions.pod:377
4499 msgid "guestfs_aug_mv"
4503 #: ../src/guestfs-actions.pod:379
4507 " guestfs_aug_mv (guestfs_h *g,\n"
4508 " const char *src,\n"
4509 " const char *dest);\n"
4514 #: ../src/guestfs-actions.pod:384 ../fish/guestfish-actions.pod:278
4516 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4517 "C<dest> is overwritten if it exists."
4521 #: ../src/guestfs-actions.pod:389
4522 msgid "guestfs_aug_rm"
4526 #: ../src/guestfs-actions.pod:391
4530 " guestfs_aug_rm (guestfs_h *g,\n"
4531 " const char *augpath);\n"
4536 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:285
4537 msgid "Remove C<path> and all of its children."
4541 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:287
4542 msgid "On success this returns the number of entries which were removed."
4546 #: ../src/guestfs-actions.pod:401
4547 msgid "guestfs_aug_save"
4551 #: ../src/guestfs-actions.pod:403
4555 " guestfs_aug_save (guestfs_h *g);\n"
4560 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:293
4561 msgid "This writes all pending changes to disk."
4565 #: ../src/guestfs-actions.pod:408
4567 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
4572 #: ../src/guestfs-actions.pod:413
4573 msgid "guestfs_aug_set"
4577 #: ../src/guestfs-actions.pod:415
4581 " guestfs_aug_set (guestfs_h *g,\n"
4582 " const char *augpath,\n"
4583 " const char *val);\n"
4588 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:302
4589 msgid "Set the value associated with C<path> to C<val>."
4593 #: ../src/guestfs-actions.pod:422
4595 "In the Augeas API, it is possible to clear a node by setting the value to "
4596 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
4597 "this call. Instead you must use the C<guestfs_aug_clear> call."
4601 #: ../src/guestfs-actions.pod:429
4602 msgid "guestfs_available"
4606 #: ../src/guestfs-actions.pod:431
4610 " guestfs_available (guestfs_h *g,\n"
4611 " char *const *groups);\n"
4616 #: ../src/guestfs-actions.pod:435 ../fish/guestfish-actions.pod:313
4618 "This command is used to check the availability of some groups of "
4619 "functionality in the appliance, which not all builds of the libguestfs "
4620 "appliance will be able to provide."
4624 #: ../src/guestfs-actions.pod:439
4626 "The libguestfs groups, and the functions that those groups correspond to, "
4627 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
4628 "runtime by calling C<guestfs_available_all_groups>."
4632 #: ../src/guestfs-actions.pod:444 ../fish/guestfish-actions.pod:322
4634 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
4635 "\"augeas\"]> would check for the availability of the Linux inotify functions "
4636 "and Augeas (configuration file editing) functions."
4640 #: ../src/guestfs-actions.pod:449 ../fish/guestfish-actions.pod:327
4641 msgid "The command returns no error if I<all> requested groups are available."
4645 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:329
4647 "It fails with an error if one or more of the requested groups is unavailable "
4652 #: ../src/guestfs-actions.pod:454 ../fish/guestfish-actions.pod:332
4654 "If an unknown group name is included in the list of groups then an error is "
4659 #: ../src/guestfs-actions.pod:457 ../fish/guestfish-actions.pod:335
4664 #: ../src/guestfs-actions.pod:463
4665 msgid "You must call C<guestfs_launch> before calling this function."
4669 #: ../src/guestfs-actions.pod:465 ../fish/guestfish-actions.pod:343
4671 "The reason is because we don't know what groups are supported by the "
4672 "appliance/daemon until it is running and can be queried."
4676 #: ../src/guestfs-actions.pod:471 ../fish/guestfish-actions.pod:349
4678 "If a group of functions is available, this does not necessarily mean that "
4679 "they will work. You still have to check for errors when calling individual "
4680 "API functions even if they are available."
4684 #: ../src/guestfs-actions.pod:478 ../fish/guestfish-actions.pod:356
4686 "It is usually the job of distro packagers to build complete functionality "
4687 "into the libguestfs appliance. Upstream libguestfs, if built from source "
4688 "with all requirements satisfied, will support everything."
4692 #: ../src/guestfs-actions.pod:485
4694 "This call was added in version C<1.0.80>. In previous versions of "
4695 "libguestfs all you could do would be to speculatively execute a command to "
4696 "find out if the daemon implemented it. See also C<guestfs_version>."
4700 #: ../src/guestfs-actions.pod:494
4701 msgid "guestfs_available_all_groups"
4705 #: ../src/guestfs-actions.pod:496
4709 " guestfs_available_all_groups (guestfs_h *g);\n"
4714 #: ../src/guestfs-actions.pod:499
4716 "This command returns a list of all optional groups that this daemon knows "
4717 "about. Note this returns both supported and unsupported groups. To find "
4718 "out which ones the daemon can actually support you have to call "
4719 "C<guestfs_available> on each member of the returned list."
4723 #: ../src/guestfs-actions.pod:505
4724 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
4728 #: ../src/guestfs-actions.pod:511
4729 msgid "guestfs_base64_in"
4733 #: ../src/guestfs-actions.pod:513
4737 " guestfs_base64_in (guestfs_h *g,\n"
4738 " const char *base64file,\n"
4739 " const char *filename);\n"
4744 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:386
4745 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
4749 #: ../src/guestfs-actions.pod:523
4750 msgid "guestfs_base64_out"
4754 #: ../src/guestfs-actions.pod:525
4758 " guestfs_base64_out (guestfs_h *g,\n"
4759 " const char *filename,\n"
4760 " const char *base64file);\n"
4765 #: ../src/guestfs-actions.pod:530 ../fish/guestfish-actions.pod:395
4767 "This command downloads the contents of C<filename>, writing it out to local "
4768 "file C<base64file> encoded as base64."
4772 #: ../src/guestfs-actions.pod:535
4773 msgid "guestfs_blockdev_flushbufs"
4777 #: ../src/guestfs-actions.pod:537
4781 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
4782 " const char *device);\n"
4787 #: ../src/guestfs-actions.pod:541 ../fish/guestfish-actions.pod:404
4788 msgid "This tells the kernel to flush internal buffers associated with C<device>."
4792 #: ../src/guestfs-actions.pod:544 ../src/guestfs-actions.pod:559 ../src/guestfs-actions.pod:572 ../src/guestfs-actions.pod:586 ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:619 ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:659 ../src/guestfs-actions.pod:671 ../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
4793 msgid "This uses the L<blockdev(8)> command."
4797 #: ../src/guestfs-actions.pod:548
4798 msgid "guestfs_blockdev_getbsz"
4802 #: ../src/guestfs-actions.pod:550
4806 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
4807 " const char *device);\n"
4812 #: ../src/guestfs-actions.pod:554 ../fish/guestfish-actions.pod:413
4813 msgid "This returns the block size of a device."
4817 #: ../src/guestfs-actions.pod:556 ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:415 ../fish/guestfish-actions.pod:478
4819 "(Note this is different from both I<size in blocks> and I<filesystem block "
4824 #: ../src/guestfs-actions.pod:563
4825 msgid "guestfs_blockdev_getro"
4829 #: ../src/guestfs-actions.pod:565
4833 " guestfs_blockdev_getro (guestfs_h *g,\n"
4834 " const char *device);\n"
4839 #: ../src/guestfs-actions.pod:569 ../fish/guestfish-actions.pod:424
4841 "Returns a boolean indicating if the block device is read-only (true if "
4842 "read-only, false if not)."
4846 #: ../src/guestfs-actions.pod:574 ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1258 ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:1715 ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:1839 ../src/guestfs-actions.pod:1860 ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:2532 ../src/guestfs-actions.pod:2544 ../src/guestfs-actions.pod:2557 ../src/guestfs-actions.pod:2569 ../src/guestfs-actions.pod:2583 ../src/guestfs-actions.pod:2596 ../src/guestfs-actions.pod:2610 ../src/guestfs-actions.pod:2622 ../src/guestfs-actions.pod:2633 ../src/guestfs-actions.pod:2645 ../src/guestfs-actions.pod:2658 ../src/guestfs-actions.pod:2671 ../src/guestfs-actions.pod:3941
4847 msgid "This function returns a C truth value on success or -1 on error."
4851 #: ../src/guestfs-actions.pod:576
4852 msgid "guestfs_blockdev_getsize64"
4856 #: ../src/guestfs-actions.pod:578
4860 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
4861 " const char *device);\n"
4866 #: ../src/guestfs-actions.pod:582 ../fish/guestfish-actions.pod:433
4867 msgid "This returns the size of the device in bytes."
4871 #: ../src/guestfs-actions.pod:584
4872 msgid "See also C<guestfs_blockdev_getsz>."
4876 #: ../src/guestfs-actions.pod:590
4877 msgid "guestfs_blockdev_getss"
4881 #: ../src/guestfs-actions.pod:592
4885 " guestfs_blockdev_getss (guestfs_h *g,\n"
4886 " const char *device);\n"
4891 #: ../src/guestfs-actions.pod:596 ../fish/guestfish-actions.pod:443
4893 "This returns the size of sectors on a block device. Usually 512, but can be "
4894 "larger for modern devices."
4898 #: ../src/guestfs-actions.pod:599
4900 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
4905 #: ../src/guestfs-actions.pod:606
4906 msgid "guestfs_blockdev_getsz"
4910 #: ../src/guestfs-actions.pod:608
4914 " guestfs_blockdev_getsz (guestfs_h *g,\n"
4915 " const char *device);\n"
4920 #: ../src/guestfs-actions.pod:612 ../fish/guestfish-actions.pod:455
4922 "This returns the size of the device in units of 512-byte sectors (even if "
4923 "the sectorsize isn't 512 bytes ... weird)."
4927 #: ../src/guestfs-actions.pod:615
4929 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
4930 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
4934 #: ../src/guestfs-actions.pod:623
4935 msgid "guestfs_blockdev_rereadpt"
4939 #: ../src/guestfs-actions.pod:625
4943 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
4944 " const char *device);\n"
4949 #: ../src/guestfs-actions.pod:629 ../fish/guestfish-actions.pod:468
4950 msgid "Reread the partition table on C<device>."
4954 #: ../src/guestfs-actions.pod:635
4955 msgid "guestfs_blockdev_setbsz"
4959 #: ../src/guestfs-actions.pod:637
4963 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
4964 " const char *device,\n"
4965 " int blocksize);\n"
4970 #: ../src/guestfs-actions.pod:642 ../fish/guestfish-actions.pod:476
4971 msgid "This sets the block size of a device."
4975 #: ../src/guestfs-actions.pod:651
4976 msgid "guestfs_blockdev_setro"
4980 #: ../src/guestfs-actions.pod:653
4984 " guestfs_blockdev_setro (guestfs_h *g,\n"
4985 " const char *device);\n"
4990 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:487
4991 msgid "Sets the block device named C<device> to read-only."
4995 #: ../src/guestfs-actions.pod:663
4996 msgid "guestfs_blockdev_setrw"
5000 #: ../src/guestfs-actions.pod:665
5004 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5005 " const char *device);\n"
5010 #: ../src/guestfs-actions.pod:669 ../fish/guestfish-actions.pod:495
5011 msgid "Sets the block device named C<device> to read-write."
5015 #: ../src/guestfs-actions.pod:675
5016 msgid "guestfs_case_sensitive_path"
5020 #: ../src/guestfs-actions.pod:677
5024 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5025 " const char *path);\n"
5030 #: ../src/guestfs-actions.pod:681 ../fish/guestfish-actions.pod:503
5032 "This can be used to resolve case insensitive paths on a filesystem which is "
5033 "case sensitive. The use case is to resolve paths which you have read from "
5034 "Windows configuration files or the Windows Registry, to the true path."
5038 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:508
5040 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5041 "(and probably others), which is that although the underlying filesystem is "
5042 "case-insensitive, the driver exports the filesystem to Linux as "
5047 #: ../src/guestfs-actions.pod:691 ../fish/guestfish-actions.pod:513
5049 "One consequence of this is that special directories such as C<c:\\windows> "
5050 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5051 "precise details of how they were created. In Windows itself this would not "
5056 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:519
5058 "Bug or feature? You decide: "
5059 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
5063 #: ../src/guestfs-actions.pod:700 ../fish/guestfish-actions.pod:522
5065 "This function resolves the true case of each element in the path and returns "
5066 "the case-sensitive path."
5070 #: ../src/guestfs-actions.pod:703
5072 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
5073 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5074 "how the directories were originally created under Windows)."
5078 #: ../src/guestfs-actions.pod:708 ../fish/guestfish-actions.pod:530
5079 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5083 #: ../src/guestfs-actions.pod:711
5084 msgid "See also C<guestfs_realpath>."
5088 #: ../src/guestfs-actions.pod:716
5093 #: ../src/guestfs-actions.pod:718
5097 " guestfs_cat (guestfs_h *g,\n"
5098 " const char *path);\n"
5103 #: ../src/guestfs-actions.pod:722 ../src/guestfs-actions.pod:4386 ../fish/guestfish-actions.pod:539 ../fish/guestfish-actions.pod:3197
5104 msgid "Return the contents of the file named C<path>."
5108 #: ../src/guestfs-actions.pod:724
5110 "Note that this function cannot correctly handle binary files (specifically, "
5111 "files containing C<\\0> character which is treated as end of string). For "
5112 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5113 "functions which have a more complex interface."
5117 #: ../src/guestfs-actions.pod:732 ../src/guestfs-actions.pod:899 ../src/guestfs-actions.pod:917 ../src/guestfs-actions.pod:1213 ../src/guestfs-actions.pod:1230 ../src/guestfs-actions.pod:1323 ../src/guestfs-actions.pod:1340 ../src/guestfs-actions.pod:1577 ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:2004 ../src/guestfs-actions.pod:2026 ../src/guestfs-actions.pod:2041 ../src/guestfs-actions.pod:2068 ../src/guestfs-actions.pod:4191 ../src/guestfs-actions.pod:4215 ../src/guestfs-actions.pod:4331 ../src/guestfs-actions.pod:4355 ../src/guestfs-actions.pod:4377 ../src/guestfs-actions.pod:5145 ../src/guestfs-actions.pod:5198 ../src/guestfs-actions.pod:5324 ../src/guestfs-actions.pod:5346 ../src/guestfs-actions.pod:5927 ../src/guestfs-actions.pod:5951 ../src/guestfs-actions.pod:5975 ../src/guestfs-actions.pod:5992 ../src/guestfs-actions.pod:6069 ../src/guestfs-actions.pod:6086 ../src/guestfs-actions.pod:6128 ../src/guestfs-actions.pod:6145 ../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:3067 ../fish/guestfish-actions.pod:3082 ../fish/guestfish-actions.pod:3158 ../fish/guestfish-actions.pod:3175 ../fish/guestfish-actions.pod:3190 ../fish/guestfish-actions.pod:3773 ../fish/guestfish-actions.pod:3819 ../fish/guestfish-actions.pod:3904 ../fish/guestfish-actions.pod:3919 ../fish/guestfish-actions.pod:4329 ../fish/guestfish-actions.pod:4347 ../fish/guestfish-actions.pod:4364 ../fish/guestfish-actions.pod:4374 ../fish/guestfish-actions.pod:4422 ../fish/guestfish-actions.pod:4432 ../fish/guestfish-actions.pod:4461 ../fish/guestfish-actions.pod:4471
5119 "Because of the message protocol, there is a transfer limit of somewhere "
5120 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5124 #: ../src/guestfs-actions.pod:735
5125 msgid "guestfs_checksum"
5129 #: ../src/guestfs-actions.pod:737
5133 " guestfs_checksum (guestfs_h *g,\n"
5134 " const char *csumtype,\n"
5135 " const char *path);\n"
5140 #: ../src/guestfs-actions.pod:742 ../fish/guestfish-actions.pod:553
5141 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5145 #: ../src/guestfs-actions.pod:745 ../fish/guestfish-actions.pod:556
5147 "The type of checksum to compute is given by the C<csumtype> parameter which "
5148 "must have one of the following values:"
5152 #: ../src/guestfs-actions.pod:750 ../fish/guestfish-actions.pod:561
5157 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:563
5159 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5164 #: ../src/guestfs-actions.pod:755 ../fish/guestfish-actions.pod:566
5169 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:568
5170 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5174 #: ../src/guestfs-actions.pod:759 ../fish/guestfish-actions.pod:570
5179 #: ../src/guestfs-actions.pod:761 ../fish/guestfish-actions.pod:572
5180 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5184 #: ../src/guestfs-actions.pod:763 ../fish/guestfish-actions.pod:574
5189 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:576
5190 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5194 #: ../src/guestfs-actions.pod:767 ../fish/guestfish-actions.pod:578
5199 #: ../src/guestfs-actions.pod:769 ../fish/guestfish-actions.pod:580
5200 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5204 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:582
5209 #: ../src/guestfs-actions.pod:773 ../fish/guestfish-actions.pod:584
5210 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5214 #: ../src/guestfs-actions.pod:775 ../fish/guestfish-actions.pod:586
5219 #: ../src/guestfs-actions.pod:777 ../fish/guestfish-actions.pod:588
5220 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5224 #: ../src/guestfs-actions.pod:781 ../fish/guestfish-actions.pod:592
5225 msgid "The checksum is returned as a printable string."
5229 #: ../src/guestfs-actions.pod:783
5230 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
5234 #: ../src/guestfs-actions.pod:785
5235 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
5239 #: ../src/guestfs-actions.pod:790
5240 msgid "guestfs_checksum_device"
5244 #: ../src/guestfs-actions.pod:792
5248 " guestfs_checksum_device (guestfs_h *g,\n"
5249 " const char *csumtype,\n"
5250 " const char *device);\n"
5255 #: ../src/guestfs-actions.pod:797
5257 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5258 "device named C<device>. For the types of checksums supported see the "
5259 "C<guestfs_checksum> command."
5263 #: ../src/guestfs-actions.pod:804
5264 msgid "guestfs_checksums_out"
5268 #: ../src/guestfs-actions.pod:806
5272 " guestfs_checksums_out (guestfs_h *g,\n"
5273 " const char *csumtype,\n"
5274 " const char *directory,\n"
5275 " const char *sumsfile);\n"
5280 #: ../src/guestfs-actions.pod:812 ../fish/guestfish-actions.pod:610
5282 "This command computes the checksums of all regular files in C<directory> and "
5283 "then emits a list of those checksums to the local output file C<sumsfile>."
5287 #: ../src/guestfs-actions.pod:816 ../fish/guestfish-actions.pod:614
5289 "This can be used for verifying the integrity of a virtual machine. However "
5290 "to be properly secure you should pay attention to the output of the checksum "
5291 "command (it uses the ones from GNU coreutils). In particular when the "
5292 "filename is not printable, coreutils uses a special backslash syntax. For "
5293 "more information, see the GNU coreutils info file."
5297 #: ../src/guestfs-actions.pod:826
5298 msgid "guestfs_chmod"
5302 #: ../src/guestfs-actions.pod:828
5306 " guestfs_chmod (guestfs_h *g,\n"
5308 " const char *path);\n"
5313 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:628
5315 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5320 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:631
5322 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5323 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5328 #: ../src/guestfs-actions.pod:840 ../src/guestfs-actions.pod:3483 ../src/guestfs-actions.pod:3590 ../src/guestfs-actions.pod:3607 ../src/guestfs-actions.pod:3624 ../fish/guestfish-actions.pod:635 ../fish/guestfish-actions.pod:2557 ../fish/guestfish-actions.pod:2642 ../fish/guestfish-actions.pod:2652 ../fish/guestfish-actions.pod:2662
5329 msgid "The mode actually set is affected by the umask."
5333 #: ../src/guestfs-actions.pod:844
5334 msgid "guestfs_chown"
5338 #: ../src/guestfs-actions.pod:846
5342 " guestfs_chown (guestfs_h *g,\n"
5345 " const char *path);\n"
5350 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:641
5351 msgid "Change the file owner to C<owner> and group to C<group>."
5355 #: ../src/guestfs-actions.pod:854 ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:643 ../fish/guestfish-actions.pod:2035
5357 "Only numeric uid and gid are supported. If you want to use names, you will "
5358 "need to locate and parse the password file yourself (Augeas support makes "
5359 "this relatively easy)."
5363 #: ../src/guestfs-actions.pod:860
5364 msgid "guestfs_command"
5368 #: ../src/guestfs-actions.pod:862
5372 " guestfs_command (guestfs_h *g,\n"
5373 " char *const *arguments);\n"
5378 #: ../src/guestfs-actions.pod:866 ../fish/guestfish-actions.pod:651
5380 "This call runs a command from the guest filesystem. The filesystem must be "
5381 "mounted, and must contain a compatible operating system (ie. something "
5382 "Linux, with the same or compatible processor architecture)."
5386 #: ../src/guestfs-actions.pod:871
5388 "The single parameter is an argv-style list of arguments. The first element "
5389 "is the name of the program to run. Subsequent elements are parameters. The "
5390 "list must be non-empty (ie. must contain a program name). Note that the "
5391 "command runs directly, and is I<not> invoked via the shell (see "
5396 #: ../src/guestfs-actions.pod:878 ../fish/guestfish-actions.pod:663
5397 msgid "The return value is anything printed to I<stdout> by the command."
5401 #: ../src/guestfs-actions.pod:881 ../fish/guestfish-actions.pod:666
5403 "If the command returns a non-zero exit status, then this function returns an "
5404 "error message. The error message string is the content of I<stderr> from "
5409 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:670
5411 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
5412 "C</bin>. If you require a program from another location, you should provide "
5413 "the full path in the first parameter."
5417 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:675
5419 "Shared libraries and data files required by the program must be available on "
5420 "filesystems which are mounted in the correct places. It is the caller's "
5421 "responsibility to ensure all filesystems that are needed are mounted at the "
5426 #: ../src/guestfs-actions.pod:902
5427 msgid "guestfs_command_lines"
5431 #: ../src/guestfs-actions.pod:904
5435 " guestfs_command_lines (guestfs_h *g,\n"
5436 " char *const *arguments);\n"
5441 #: ../src/guestfs-actions.pod:908
5443 "This is the same as C<guestfs_command>, but splits the result into a list of "
5448 #: ../src/guestfs-actions.pod:911
5449 msgid "See also: C<guestfs_sh_lines>"
5453 #: ../src/guestfs-actions.pod:920
5454 msgid "guestfs_config"
5458 #: ../src/guestfs-actions.pod:922
5462 " guestfs_config (guestfs_h *g,\n"
5463 " const char *qemuparam,\n"
5464 " const char *qemuvalue);\n"
5469 #: ../src/guestfs-actions.pod:927 ../fish/guestfish-actions.pod:700
5471 "This can be used to add arbitrary qemu command line parameters of the form "
5472 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
5473 "setting some parameters which would interfere with parameters that we use."
5477 #: ../src/guestfs-actions.pod:932 ../fish/guestfish-actions.pod:705
5478 msgid "The first character of C<param> string must be a C<-> (dash)."
5482 #: ../src/guestfs-actions.pod:934 ../fish/guestfish-actions.pod:707
5483 msgid "C<value> can be NULL."
5487 #: ../src/guestfs-actions.pod:938
5488 msgid "guestfs_copy_size"
5492 #: ../src/guestfs-actions.pod:940
5496 " guestfs_copy_size (guestfs_h *g,\n"
5497 " const char *src,\n"
5498 " const char *dest,\n"
5504 #: ../src/guestfs-actions.pod:946 ../fish/guestfish-actions.pod:713
5506 "This command copies exactly C<size> bytes from one source device or file "
5507 "C<src> to another destination device or file C<dest>."
5511 #: ../src/guestfs-actions.pod:949 ../fish/guestfish-actions.pod:716
5513 "Note this will fail if the source is too short or if the destination is not "
5518 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:1098 ../src/guestfs-actions.pod:1127 ../src/guestfs-actions.pod:1515 ../src/guestfs-actions.pod:1535 ../src/guestfs-actions.pod:6011 ../src/guestfs-actions.pod:6028
5520 "This long-running command can generate progress notification messages so "
5521 "that the caller can display a progress bar or indicator. To receive these "
5522 "messages, the caller must register a progress callback. See "
5523 "L<guestfs(3)/guestfs_set_progress_callback>."
5527 #: ../src/guestfs-actions.pod:959
5532 #: ../src/guestfs-actions.pod:961
5536 " guestfs_cp (guestfs_h *g,\n"
5537 " const char *src,\n"
5538 " const char *dest);\n"
5543 #: ../src/guestfs-actions.pod:966 ../fish/guestfish-actions.pod:723
5545 "This copies a file from C<src> to C<dest> where C<dest> is either a "
5546 "destination filename or destination directory."
5550 #: ../src/guestfs-actions.pod:971
5551 msgid "guestfs_cp_a"
5555 #: ../src/guestfs-actions.pod:973
5559 " guestfs_cp_a (guestfs_h *g,\n"
5560 " const char *src,\n"
5561 " const char *dest);\n"
5566 #: ../src/guestfs-actions.pod:978 ../fish/guestfish-actions.pod:730
5568 "This copies a file or directory from C<src> to C<dest> recursively using the "
5573 #: ../src/guestfs-actions.pod:983
5578 #: ../src/guestfs-actions.pod:985
5582 " guestfs_dd (guestfs_h *g,\n"
5583 " const char *src,\n"
5584 " const char *dest);\n"
5589 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:737
5591 "This command copies from one source device or file C<src> to another "
5592 "destination device or file C<dest>. Normally you would use this to copy to "
5593 "or from a device or partition, for example to duplicate a filesystem."
5597 #: ../src/guestfs-actions.pod:995
5599 "If the destination is a device, it must be as large or larger than the "
5600 "source file or device, otherwise the copy will fail. This command cannot do "
5601 "partial copies (see C<guestfs_copy_size>)."
5605 #: ../src/guestfs-actions.pod:1001
5606 msgid "guestfs_debug"
5610 #: ../src/guestfs-actions.pod:1003
5614 " guestfs_debug (guestfs_h *g,\n"
5615 " const char *subcmd,\n"
5616 " char *const *extraargs);\n"
5621 #: ../src/guestfs-actions.pod:1008
5623 "The C<guestfs_debug> command exposes some internals of C<guestfsd> (the "
5624 "guestfs daemon) that runs inside the qemu subprocess."
5628 #: ../src/guestfs-actions.pod:1012 ../fish/guestfish-actions.pod:754
5630 "There is no comprehensive help for this command. You have to look at the "
5631 "file C<daemon/debug.c> in the libguestfs source to find out what you can do."
5635 #: ../src/guestfs-actions.pod:1019
5636 msgid "guestfs_debug_upload"
5640 #: ../src/guestfs-actions.pod:1021
5644 " guestfs_debug_upload (guestfs_h *g,\n"
5645 " const char *filename,\n"
5646 " const char *tmpname,\n"
5652 #: ../src/guestfs-actions.pod:1027
5654 "The C<guestfs_debug_upload> command uploads a file to the libguestfs "
5659 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:765
5661 "There is no comprehensive help for this command. You have to look at the "
5662 "file C<daemon/debug.c> in the libguestfs source to find out what it is for."
5666 #: ../src/guestfs-actions.pod:1036
5671 #: ../src/guestfs-actions.pod:1038
5675 " guestfs_df (guestfs_h *g);\n"
5680 #: ../src/guestfs-actions.pod:1041 ../fish/guestfish-actions.pod:775
5681 msgid "This command runs the C<df> command to report disk space used."
5685 #: ../src/guestfs-actions.pod:1043 ../src/guestfs-actions.pod:1058 ../fish/guestfish-actions.pod:777 ../fish/guestfish-actions.pod:788
5687 "This command is mostly useful for interactive sessions. It is I<not> "
5688 "intended that you try to parse the output string. Use C<statvfs> from "
5693 #: ../src/guestfs-actions.pod:1050
5694 msgid "guestfs_df_h"
5698 #: ../src/guestfs-actions.pod:1052
5702 " guestfs_df_h (guestfs_h *g);\n"
5707 #: ../src/guestfs-actions.pod:1055 ../fish/guestfish-actions.pod:785
5709 "This command runs the C<df -h> command to report disk space used in "
5710 "human-readable format."
5714 #: ../src/guestfs-actions.pod:1065
5715 msgid "guestfs_dmesg"
5719 #: ../src/guestfs-actions.pod:1067
5723 " guestfs_dmesg (guestfs_h *g);\n"
5728 #: ../src/guestfs-actions.pod:1070 ../fish/guestfish-actions.pod:796
5730 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
5731 "This is sometimes useful for extended debugging of problems."
5735 #: ../src/guestfs-actions.pod:1074
5737 "Another way to get the same information is to enable verbose messages with "
5738 "C<guestfs_set_verbose> or by setting the environment variable "
5739 "C<LIBGUESTFS_DEBUG=1> before running the program."
5743 #: ../src/guestfs-actions.pod:1082
5744 msgid "guestfs_download"
5748 #: ../src/guestfs-actions.pod:1084
5752 " guestfs_download (guestfs_h *g,\n"
5753 " const char *remotefilename,\n"
5754 " const char *filename);\n"
5759 #: ../src/guestfs-actions.pod:1089 ../src/guestfs-actions.pod:1112 ../fish/guestfish-actions.pod:809 ../fish/guestfish-actions.pod:822
5761 "Download file C<remotefilename> and save it as C<filename> on the local "
5766 #: ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:5553 ../fish/guestfish-actions.pod:812 ../fish/guestfish-actions.pod:4077
5767 msgid "C<filename> can also be a named pipe."
5771 #: ../src/guestfs-actions.pod:1094
5772 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
5776 #: ../src/guestfs-actions.pod:1103
5777 msgid "guestfs_download_offset"
5781 #: ../src/guestfs-actions.pod:1105
5785 " guestfs_download_offset (guestfs_h *g,\n"
5786 " const char *remotefilename,\n"
5787 " const char *filename,\n"
5788 " int64_t offset,\n"
5794 #: ../src/guestfs-actions.pod:1115 ../fish/guestfish-actions.pod:825
5796 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
5797 "region must be within the file or device)."
5801 #: ../src/guestfs-actions.pod:1118
5803 "Note that there is no limit on the amount of data that can be downloaded "
5804 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
5805 "full amount unless an error occurs."
5809 #: ../src/guestfs-actions.pod:1123
5810 msgid "See also C<guestfs_download>, C<guestfs_pread>."
5814 #: ../src/guestfs-actions.pod:1132
5815 msgid "guestfs_drop_caches"
5819 #: ../src/guestfs-actions.pod:1134
5823 " guestfs_drop_caches (guestfs_h *g,\n"
5824 " int whattodrop);\n"
5829 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:841
5831 "This instructs the guest kernel to drop its page cache, and/or dentries and "
5832 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
5833 "to drop, see L<http://linux-mm.org/Drop_Caches>"
5837 #: ../src/guestfs-actions.pod:1143 ../fish/guestfish-actions.pod:846
5838 msgid "Setting C<whattodrop> to 3 should drop everything."
5842 #: ../src/guestfs-actions.pod:1145 ../fish/guestfish-actions.pod:848
5844 "This automatically calls L<sync(2)> before the operation, so that the "
5845 "maximum guest memory is freed."
5849 #: ../src/guestfs-actions.pod:1150
5854 #: ../src/guestfs-actions.pod:1152
5858 " guestfs_du (guestfs_h *g,\n"
5859 " const char *path);\n"
5864 #: ../src/guestfs-actions.pod:1156 ../fish/guestfish-actions.pod:855
5866 "This command runs the C<du -s> command to estimate file space usage for "
5871 #: ../src/guestfs-actions.pod:1159 ../fish/guestfish-actions.pod:858
5873 "C<path> can be a file or a directory. If C<path> is a directory then the "
5874 "estimate includes the contents of the directory and all subdirectories "
5879 #: ../src/guestfs-actions.pod:1163 ../fish/guestfish-actions.pod:862
5880 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
5884 #: ../src/guestfs-actions.pod:1168
5885 msgid "guestfs_e2fsck_f"
5889 #: ../src/guestfs-actions.pod:1170
5893 " guestfs_e2fsck_f (guestfs_h *g,\n"
5894 " const char *device);\n"
5899 #: ../src/guestfs-actions.pod:1174 ../fish/guestfish-actions.pod:869
5901 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
5902 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
5907 #: ../src/guestfs-actions.pod:1178
5909 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
5910 "Normally you should use C<guestfs_fsck>."
5914 #: ../src/guestfs-actions.pod:1183
5915 msgid "guestfs_echo_daemon"
5919 #: ../src/guestfs-actions.pod:1185
5923 " guestfs_echo_daemon (guestfs_h *g,\n"
5924 " char *const *words);\n"
5929 #: ../src/guestfs-actions.pod:1189 ../fish/guestfish-actions.pod:880
5931 "This command concatenates the list of C<words> passed with single spaces "
5932 "between them and returns the resulting string."
5936 #: ../src/guestfs-actions.pod:1192 ../fish/guestfish-actions.pod:883
5937 msgid "You can use this command to test the connection through to the daemon."
5941 #: ../src/guestfs-actions.pod:1194
5942 msgid "See also C<guestfs_ping_daemon>."
5946 #: ../src/guestfs-actions.pod:1199
5947 msgid "guestfs_egrep"
5951 #: ../src/guestfs-actions.pod:1201
5955 " guestfs_egrep (guestfs_h *g,\n"
5956 " const char *regex,\n"
5957 " const char *path);\n"
5962 #: ../src/guestfs-actions.pod:1206 ../fish/guestfish-actions.pod:891
5963 msgid "This calls the external C<egrep> program and returns the matching lines."
5967 #: ../src/guestfs-actions.pod:1216
5968 msgid "guestfs_egrepi"
5972 #: ../src/guestfs-actions.pod:1218
5976 " guestfs_egrepi (guestfs_h *g,\n"
5977 " const char *regex,\n"
5978 " const char *path);\n"
5983 #: ../src/guestfs-actions.pod:1223 ../fish/guestfish-actions.pod:901
5984 msgid "This calls the external C<egrep -i> program and returns the matching lines."
5988 #: ../src/guestfs-actions.pod:1233
5989 msgid "guestfs_equal"
5993 #: ../src/guestfs-actions.pod:1235
5997 " guestfs_equal (guestfs_h *g,\n"
5998 " const char *file1,\n"
5999 " const char *file2);\n"
6004 #: ../src/guestfs-actions.pod:1240 ../fish/guestfish-actions.pod:911
6006 "This compares the two files C<file1> and C<file2> and returns true if their "
6007 "content is exactly equal, or false otherwise."
6011 #: ../src/guestfs-actions.pod:1243 ../fish/guestfish-actions.pod:914
6012 msgid "The external L<cmp(1)> program is used for the comparison."
6016 #: ../src/guestfs-actions.pod:1247
6017 msgid "guestfs_exists"
6021 #: ../src/guestfs-actions.pod:1249
6025 " guestfs_exists (guestfs_h *g,\n"
6026 " const char *path);\n"
6031 #: ../src/guestfs-actions.pod:1253 ../fish/guestfish-actions.pod:920
6033 "This returns C<true> if and only if there is a file, directory (or anything) "
6034 "with the given C<path> name."
6038 #: ../src/guestfs-actions.pod:1256
6039 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6043 #: ../src/guestfs-actions.pod:1260
6044 msgid "guestfs_fallocate"
6048 #: ../src/guestfs-actions.pod:1262
6052 " guestfs_fallocate (guestfs_h *g,\n"
6053 " const char *path,\n"
6059 #: ../src/guestfs-actions.pod:1267 ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:929 ../fish/guestfish-actions.pod:948
6061 "This command preallocates a file (containing zero bytes) named C<path> of "
6062 "size C<len> bytes. If the file exists already, it is overwritten."
6066 #: ../src/guestfs-actions.pod:1271 ../fish/guestfish-actions.pod:933
6068 "Do not confuse this with the guestfish-specific C<alloc> command which "
6069 "allocates a file in the host and attaches it as a device."
6073 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:937
6075 "This function is deprecated. In new code, use the C<fallocate64> call "
6080 #: ../src/guestfs-actions.pod:1284
6081 msgid "guestfs_fallocate64"
6085 #: ../src/guestfs-actions.pod:1286
6089 " guestfs_fallocate64 (guestfs_h *g,\n"
6090 " const char *path,\n"
6096 #: ../src/guestfs-actions.pod:1295
6098 "Note that this call allocates disk blocks for the file. To create a sparse "
6099 "file use C<guestfs_truncate_size> instead."
6103 #: ../src/guestfs-actions.pod:1298
6105 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6106 "oversight it only allowed 30 bit lengths to be specified, effectively "
6107 "limiting the maximum size of files created through that call to 1GB."
6111 #: ../src/guestfs-actions.pod:1303 ../fish/guestfish-actions.pod:960
6113 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6114 "commands which create a file in the host and attach it as a device."
6118 #: ../src/guestfs-actions.pod:1309
6119 msgid "guestfs_fgrep"
6123 #: ../src/guestfs-actions.pod:1311
6127 " guestfs_fgrep (guestfs_h *g,\n"
6128 " const char *pattern,\n"
6129 " const char *path);\n"
6134 #: ../src/guestfs-actions.pod:1316 ../fish/guestfish-actions.pod:968
6135 msgid "This calls the external C<fgrep> program and returns the matching lines."
6139 #: ../src/guestfs-actions.pod:1326
6140 msgid "guestfs_fgrepi"
6144 #: ../src/guestfs-actions.pod:1328
6148 " guestfs_fgrepi (guestfs_h *g,\n"
6149 " const char *pattern,\n"
6150 " const char *path);\n"
6155 #: ../src/guestfs-actions.pod:1333 ../fish/guestfish-actions.pod:978
6156 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
6160 #: ../src/guestfs-actions.pod:1343
6161 msgid "guestfs_file"
6165 #: ../src/guestfs-actions.pod:1345
6169 " guestfs_file (guestfs_h *g,\n"
6170 " const char *path);\n"
6175 #: ../src/guestfs-actions.pod:1349 ../fish/guestfish-actions.pod:988
6177 "This call uses the standard L<file(1)> command to determine the type or "
6178 "contents of the file."
6182 #: ../src/guestfs-actions.pod:1352 ../fish/guestfish-actions.pod:991
6184 "This call will also transparently look inside various types of compressed "
6189 #: ../src/guestfs-actions.pod:1355 ../fish/guestfish-actions.pod:994
6191 "The exact command which runs is C<file -zb path>. Note in particular that "
6192 "the filename is not prepended to the output (the C<-b> option)."
6196 #: ../src/guestfs-actions.pod:1359
6198 "This command can also be used on C</dev/> devices (and partitions, LV "
6199 "names). You can for example use this to determine if a device contains a "
6200 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
6204 #: ../src/guestfs-actions.pod:1364 ../fish/guestfish-actions.pod:1003
6206 "If the C<path> does not begin with C</dev/> then this command only works for "
6207 "the content of regular files. For other file types (directory, symbolic "
6208 "link etc) it will just return the string C<directory> etc."
6212 #: ../src/guestfs-actions.pod:1372
6213 msgid "guestfs_file_architecture"
6217 #: ../src/guestfs-actions.pod:1374
6221 " guestfs_file_architecture (guestfs_h *g,\n"
6222 " const char *filename);\n"
6227 #: ../src/guestfs-actions.pod:1378 ../fish/guestfish-actions.pod:1012
6229 "This detects the architecture of the binary C<filename>, and returns it if "
6234 #: ../src/guestfs-actions.pod:1381 ../fish/guestfish-actions.pod:1015
6235 msgid "Currently defined architectures are:"
6239 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:1019
6244 #: ../src/guestfs-actions.pod:1387 ../fish/guestfish-actions.pod:1021
6246 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6247 "irrespective of the precise processor requirements of the binary."
6251 #: ../src/guestfs-actions.pod:1390 ../fish/guestfish-actions.pod:1024
6256 #: ../src/guestfs-actions.pod:1392 ../fish/guestfish-actions.pod:1026
6257 msgid "64 bit x86-64."
6261 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:1028
6266 #: ../src/guestfs-actions.pod:1396 ../fish/guestfish-actions.pod:1030
6267 msgid "32 bit SPARC."
6271 #: ../src/guestfs-actions.pod:1398 ../fish/guestfish-actions.pod:1032
6276 #: ../src/guestfs-actions.pod:1400 ../fish/guestfish-actions.pod:1034
6277 msgid "64 bit SPARC V9 and above."
6281 #: ../src/guestfs-actions.pod:1402 ../fish/guestfish-actions.pod:1036
6286 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:1038
6287 msgid "Intel Itanium."
6291 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:1040
6296 #: ../src/guestfs-actions.pod:1408 ../fish/guestfish-actions.pod:1042
6297 msgid "32 bit Power PC."
6301 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:1044
6306 #: ../src/guestfs-actions.pod:1412 ../fish/guestfish-actions.pod:1046
6307 msgid "64 bit Power PC."
6311 #: ../src/guestfs-actions.pod:1416 ../fish/guestfish-actions.pod:1050
6312 msgid "Libguestfs may return other architecture strings in future."
6316 #: ../src/guestfs-actions.pod:1418 ../fish/guestfish-actions.pod:1052
6317 msgid "The function works on at least the following types of files:"
6321 #: ../src/guestfs-actions.pod:1424 ../fish/guestfish-actions.pod:1058
6322 msgid "many types of Un*x and Linux binary"
6326 #: ../src/guestfs-actions.pod:1428 ../fish/guestfish-actions.pod:1062
6327 msgid "many types of Un*x and Linux shared library"
6331 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:1066
6332 msgid "Windows Win32 and Win64 binaries"
6336 #: ../src/guestfs-actions.pod:1436 ../fish/guestfish-actions.pod:1070
6337 msgid "Windows Win32 and Win64 DLLs"
6341 #: ../src/guestfs-actions.pod:1438 ../fish/guestfish-actions.pod:1072
6342 msgid "Win32 binaries and DLLs return C<i386>."
6346 #: ../src/guestfs-actions.pod:1440 ../fish/guestfish-actions.pod:1074
6347 msgid "Win64 binaries and DLLs return C<x86_64>."
6351 #: ../src/guestfs-actions.pod:1444 ../fish/guestfish-actions.pod:1078
6352 msgid "Linux kernel modules"
6356 #: ../src/guestfs-actions.pod:1448 ../fish/guestfish-actions.pod:1082
6357 msgid "Linux new-style initrd images"
6361 #: ../src/guestfs-actions.pod:1452 ../fish/guestfish-actions.pod:1086
6362 msgid "some non-x86 Linux vmlinuz kernels"
6366 #: ../src/guestfs-actions.pod:1456 ../fish/guestfish-actions.pod:1090
6367 msgid "What it can't do currently:"
6371 #: ../src/guestfs-actions.pod:1462 ../fish/guestfish-actions.pod:1096
6372 msgid "static libraries (libfoo.a)"
6376 #: ../src/guestfs-actions.pod:1466 ../fish/guestfish-actions.pod:1100
6377 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6381 #: ../src/guestfs-actions.pod:1470 ../fish/guestfish-actions.pod:1104
6382 msgid "x86 Linux vmlinuz kernels"
6386 #: ../src/guestfs-actions.pod:1472 ../fish/guestfish-actions.pod:1106
6388 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6389 "compressed code, and are horribly hard to unpack. If you want to find the "
6390 "architecture of a kernel, use the architecture of the associated initrd or "
6391 "kernel module(s) instead."
6395 #: ../src/guestfs-actions.pod:1482
6396 msgid "guestfs_filesize"
6400 #: ../src/guestfs-actions.pod:1484
6404 " guestfs_filesize (guestfs_h *g,\n"
6405 " const char *file);\n"
6410 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:1117
6411 msgid "This command returns the size of C<file> in bytes."
6415 #: ../src/guestfs-actions.pod:1490
6417 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
6418 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
6419 "devices, use C<guestfs_blockdev_getsize64>."
6423 #: ../src/guestfs-actions.pod:1496
6424 msgid "guestfs_fill"
6428 #: ../src/guestfs-actions.pod:1498
6432 " guestfs_fill (guestfs_h *g,\n"
6435 " const char *path);\n"
6440 #: ../src/guestfs-actions.pod:1504 ../fish/guestfish-actions.pod:1127
6442 "This command creates a new file called C<path>. The initial content of the "
6443 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
6448 #: ../src/guestfs-actions.pod:1508
6450 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6451 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
6452 "bytes use C<guestfs_fill_pattern>."
6456 #: ../src/guestfs-actions.pod:1520
6457 msgid "guestfs_fill_pattern"
6461 #: ../src/guestfs-actions.pod:1522
6465 " guestfs_fill_pattern (guestfs_h *g,\n"
6466 " const char *pattern,\n"
6468 " const char *path);\n"
6473 #: ../src/guestfs-actions.pod:1528
6475 "This function is like C<guestfs_fill> except that it creates a new file of "
6476 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
6477 "pattern is truncated if necessary to ensure the length of the file is "
6478 "exactly C<len> bytes."
6482 #: ../src/guestfs-actions.pod:1540
6483 msgid "guestfs_find"
6487 #: ../src/guestfs-actions.pod:1542
6491 " guestfs_find (guestfs_h *g,\n"
6492 " const char *directory);\n"
6497 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1149
6499 "This command lists out all files and directories, recursively, starting at "
6500 "C<directory>. It is essentially equivalent to running the shell command "
6501 "C<find directory -print> but some post-processing happens on the output, "
6506 #: ../src/guestfs-actions.pod:1551 ../fish/guestfish-actions.pod:1154
6508 "This returns a list of strings I<without any prefix>. Thus if the directory "
6513 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1157
6523 #: ../src/guestfs-actions.pod:1558
6524 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
6528 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1164
6539 #: ../src/guestfs-actions.pod:1566 ../fish/guestfish-actions.pod:1169
6540 msgid "If C<directory> is not a directory, then this command returns an error."
6544 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1172
6545 msgid "The returned list is sorted."
6549 #: ../src/guestfs-actions.pod:1571
6550 msgid "See also C<guestfs_find0>."
6554 #: ../src/guestfs-actions.pod:1580
6555 msgid "guestfs_find0"
6559 #: ../src/guestfs-actions.pod:1582
6563 " guestfs_find0 (guestfs_h *g,\n"
6564 " const char *directory,\n"
6565 " const char *files);\n"
6570 #: ../src/guestfs-actions.pod:1587 ../fish/guestfish-actions.pod:1183
6572 "This command lists out all files and directories, recursively, starting at "
6573 "C<directory>, placing the resulting list in the external file called "
6578 #: ../src/guestfs-actions.pod:1591
6580 "This command works the same way as C<guestfs_find> with the following "
6585 #: ../src/guestfs-actions.pod:1598 ../fish/guestfish-actions.pod:1194
6586 msgid "The resulting list is written to an external file."
6590 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1198
6592 "Items (filenames) in the result are separated by C<\\0> characters. See "
6593 "L<find(1)> option I<-print0>."
6597 #: ../src/guestfs-actions.pod:1607 ../fish/guestfish-actions.pod:1203
6598 msgid "This command is not limited in the number of names that it can return."
6602 #: ../src/guestfs-actions.pod:1612 ../fish/guestfish-actions.pod:1208
6603 msgid "The result list is not sorted."
6607 #: ../src/guestfs-actions.pod:1618
6608 msgid "guestfs_findfs_label"
6612 #: ../src/guestfs-actions.pod:1620
6616 " guestfs_findfs_label (guestfs_h *g,\n"
6617 " const char *label);\n"
6622 #: ../src/guestfs-actions.pod:1624 ../fish/guestfish-actions.pod:1218
6624 "This command searches the filesystems and returns the one which has the "
6625 "given label. An error is returned if no such filesystem can be found."
6629 #: ../src/guestfs-actions.pod:1628
6630 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
6634 #: ../src/guestfs-actions.pod:1633
6635 msgid "guestfs_findfs_uuid"
6639 #: ../src/guestfs-actions.pod:1635
6643 " guestfs_findfs_uuid (guestfs_h *g,\n"
6644 " const char *uuid);\n"
6649 #: ../src/guestfs-actions.pod:1639 ../fish/guestfish-actions.pod:1228
6651 "This command searches the filesystems and returns the one which has the "
6652 "given UUID. An error is returned if no such filesystem can be found."
6656 #: ../src/guestfs-actions.pod:1643
6657 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
6661 #: ../src/guestfs-actions.pod:1648
6662 msgid "guestfs_fsck"
6666 #: ../src/guestfs-actions.pod:1650
6670 " guestfs_fsck (guestfs_h *g,\n"
6671 " const char *fstype,\n"
6672 " const char *device);\n"
6677 #: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1238
6679 "This runs the filesystem checker (fsck) on C<device> which should have "
6680 "filesystem type C<fstype>."
6684 #: ../src/guestfs-actions.pod:1658 ../fish/guestfish-actions.pod:1241
6686 "The returned integer is the status. See L<fsck(8)> for the list of status "
6687 "codes from C<fsck>."
6691 #: ../src/guestfs-actions.pod:1667 ../fish/guestfish-actions.pod:1250
6692 msgid "Multiple status codes can be summed together."
6696 #: ../src/guestfs-actions.pod:1671 ../fish/guestfish-actions.pod:1254
6698 "A non-zero return code can mean \"success\", for example if errors have been "
6699 "corrected on the filesystem."
6703 #: ../src/guestfs-actions.pod:1676 ../fish/guestfish-actions.pod:1259
6704 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
6708 #: ../src/guestfs-actions.pod:1681 ../fish/guestfish-actions.pod:1264
6709 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
6713 #: ../src/guestfs-actions.pod:1685
6714 msgid "guestfs_get_append"
6718 #: ../src/guestfs-actions.pod:1687
6722 " guestfs_get_append (guestfs_h *g);\n"
6727 #: ../src/guestfs-actions.pod:1690 ../fish/guestfish-actions.pod:1270
6729 "Return the additional kernel options which are added to the guest kernel "
6734 #: ../src/guestfs-actions.pod:1693 ../fish/guestfish-actions.pod:1273
6735 msgid "If C<NULL> then no options are added."
6739 #: ../src/guestfs-actions.pod:1695
6741 "This function returns a string which may be NULL. There is no way to return "
6742 "an error from this function. The string is owned by the guest handle and "
6743 "must I<not> be freed."
6747 #: ../src/guestfs-actions.pod:1699
6748 msgid "guestfs_get_autosync"
6752 #: ../src/guestfs-actions.pod:1701
6756 " guestfs_get_autosync (guestfs_h *g);\n"
6761 #: ../src/guestfs-actions.pod:1704 ../fish/guestfish-actions.pod:1279
6762 msgid "Get the autosync flag."
6766 #: ../src/guestfs-actions.pod:1708
6767 msgid "guestfs_get_direct"
6771 #: ../src/guestfs-actions.pod:1710
6775 " guestfs_get_direct (guestfs_h *g);\n"
6780 #: ../src/guestfs-actions.pod:1713 ../fish/guestfish-actions.pod:1285
6781 msgid "Return the direct appliance mode flag."
6785 #: ../src/guestfs-actions.pod:1717
6786 msgid "guestfs_get_e2label"
6790 #: ../src/guestfs-actions.pod:1719
6794 " guestfs_get_e2label (guestfs_h *g,\n"
6795 " const char *device);\n"
6800 #: ../src/guestfs-actions.pod:1723 ../fish/guestfish-actions.pod:1291
6801 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
6805 #: ../src/guestfs-actions.pod:1729 ../fish/guestfish-actions.pod:1294
6807 "This function is deprecated. In new code, use the C<vfs_label> call "
6812 #: ../src/guestfs-actions.pod:1736
6813 msgid "guestfs_get_e2uuid"
6817 #: ../src/guestfs-actions.pod:1738
6821 " guestfs_get_e2uuid (guestfs_h *g,\n"
6822 " const char *device);\n"
6827 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1305
6828 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
6832 #: ../src/guestfs-actions.pod:1748 ../fish/guestfish-actions.pod:1308
6833 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
6837 #: ../src/guestfs-actions.pod:1755
6838 msgid "guestfs_get_memsize"
6842 #: ../src/guestfs-actions.pod:1757
6846 " guestfs_get_memsize (guestfs_h *g);\n"
6851 #: ../src/guestfs-actions.pod:1760 ../fish/guestfish-actions.pod:1319
6852 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
6856 #: ../src/guestfs-actions.pod:1763
6858 "If C<guestfs_set_memsize> was not called on this handle, and if "
6859 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
6860 "value for memsize."
6864 #: ../src/guestfs-actions.pod:1767 ../src/guestfs-actions.pod:1836 ../src/guestfs-actions.pod:4759 ../src/guestfs-actions.pod:4856 ../fish/guestfish-actions.pod:1326 ../fish/guestfish-actions.pod:1377 ../fish/guestfish-actions.pod:3484 ../fish/guestfish-actions.pod:3571
6865 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
6869 #: ../src/guestfs-actions.pod:1772
6870 msgid "guestfs_get_network"
6874 #: ../src/guestfs-actions.pod:1774
6878 " guestfs_get_network (guestfs_h *g);\n"
6883 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1333
6884 msgid "This returns the enable network flag."
6888 #: ../src/guestfs-actions.pod:1781
6889 msgid "guestfs_get_path"
6893 #: ../src/guestfs-actions.pod:1783
6897 " guestfs_get_path (guestfs_h *g);\n"
6902 #: ../src/guestfs-actions.pod:1786 ../fish/guestfish-actions.pod:1339
6903 msgid "Return the current search path."
6907 #: ../src/guestfs-actions.pod:1788 ../fish/guestfish-actions.pod:1341
6909 "This is always non-NULL. If it wasn't set already, then this will return "
6914 #: ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:1816
6916 "This function returns a string, or NULL on error. The string is owned by "
6917 "the guest handle and must I<not> be freed."
6921 #: ../src/guestfs-actions.pod:1794
6922 msgid "guestfs_get_pid"
6926 #: ../src/guestfs-actions.pod:1796
6930 " guestfs_get_pid (guestfs_h *g);\n"
6935 #: ../src/guestfs-actions.pod:1799 ../fish/guestfish-actions.pod:1350
6937 "Return the process ID of the qemu subprocess. If there is no qemu "
6938 "subprocess, then this will return an error."
6942 #: ../src/guestfs-actions.pod:1802 ../fish/guestfish-actions.pod:1353
6943 msgid "This is an internal call used for debugging and testing."
6947 #: ../src/guestfs-actions.pod:1806
6948 msgid "guestfs_get_qemu"
6952 #: ../src/guestfs-actions.pod:1808
6956 " guestfs_get_qemu (guestfs_h *g);\n"
6961 #: ../src/guestfs-actions.pod:1811 ../fish/guestfish-actions.pod:1359
6962 msgid "Return the current qemu binary."
6966 #: ../src/guestfs-actions.pod:1813 ../fish/guestfish-actions.pod:1361
6968 "This is always non-NULL. If it wasn't set already, then this will return "
6969 "the default qemu binary name."
6973 #: ../src/guestfs-actions.pod:1819
6974 msgid "guestfs_get_recovery_proc"
6978 #: ../src/guestfs-actions.pod:1821
6982 " guestfs_get_recovery_proc (guestfs_h *g);\n"
6987 #: ../src/guestfs-actions.pod:1824 ../fish/guestfish-actions.pod:1368
6988 msgid "Return the recovery process enabled flag."
6992 #: ../src/guestfs-actions.pod:1828
6993 msgid "guestfs_get_selinux"
6997 #: ../src/guestfs-actions.pod:1830
7001 " guestfs_get_selinux (guestfs_h *g);\n"
7006 #: ../src/guestfs-actions.pod:1833
7008 "This returns the current setting of the selinux flag which is passed to the "
7009 "appliance at boot time. See C<guestfs_set_selinux>."
7013 #: ../src/guestfs-actions.pod:1841
7014 msgid "guestfs_get_state"
7018 #: ../src/guestfs-actions.pod:1843
7022 " guestfs_get_state (guestfs_h *g);\n"
7027 #: ../src/guestfs-actions.pod:1846 ../fish/guestfish-actions.pod:1384
7029 "This returns the current state as an opaque integer. This is only useful "
7030 "for printing debug and internal error messages."
7034 #: ../src/guestfs-actions.pod:1849 ../src/guestfs-actions.pod:2542 ../src/guestfs-actions.pod:2567 ../src/guestfs-actions.pod:2620 ../src/guestfs-actions.pod:2643 ../fish/guestfish-actions.pod:1387 ../fish/guestfish-actions.pod:1917 ../fish/guestfish-actions.pod:1935 ../fish/guestfish-actions.pod:1973 ../fish/guestfish-actions.pod:1989
7035 msgid "For more information on states, see L<guestfs(3)>."
7039 #: ../src/guestfs-actions.pod:1853
7040 msgid "guestfs_get_trace"
7044 #: ../src/guestfs-actions.pod:1855
7048 " guestfs_get_trace (guestfs_h *g);\n"
7053 #: ../src/guestfs-actions.pod:1858 ../fish/guestfish-actions.pod:1393
7054 msgid "Return the command trace flag."
7058 #: ../src/guestfs-actions.pod:1862
7059 msgid "guestfs_get_umask"
7063 #: ../src/guestfs-actions.pod:1864
7067 " guestfs_get_umask (guestfs_h *g);\n"
7072 #: ../src/guestfs-actions.pod:1867
7074 "Return the current umask. By default the umask is C<022> unless it has been "
7075 "set by calling C<guestfs_umask>."
7079 #: ../src/guestfs-actions.pod:1872
7080 msgid "guestfs_get_verbose"
7084 #: ../src/guestfs-actions.pod:1874
7088 " guestfs_get_verbose (guestfs_h *g);\n"
7093 #: ../src/guestfs-actions.pod:1877 ../fish/guestfish-actions.pod:1406
7094 msgid "This returns the verbose messages flag."
7098 #: ../src/guestfs-actions.pod:1881
7099 msgid "guestfs_getcon"
7103 #: ../src/guestfs-actions.pod:1883
7107 " guestfs_getcon (guestfs_h *g);\n"
7112 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1412
7113 msgid "This gets the SELinux security context of the daemon."
7117 #: ../src/guestfs-actions.pod:1888
7118 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
7122 #: ../src/guestfs-actions.pod:1894
7123 msgid "guestfs_getxattrs"
7127 #: ../src/guestfs-actions.pod:1896
7130 " struct guestfs_xattr_list *\n"
7131 " guestfs_getxattrs (guestfs_h *g,\n"
7132 " const char *path);\n"
7137 #: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1421
7138 msgid "This call lists the extended attributes of the file or directory C<path>."
7142 #: ../src/guestfs-actions.pod:1903 ../fish/guestfish-actions.pod:1424
7144 "At the system call level, this is a combination of the L<listxattr(2)> and "
7145 "L<getxattr(2)> calls."
7149 #: ../src/guestfs-actions.pod:1906
7150 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
7154 #: ../src/guestfs-actions.pod:1908 ../src/guestfs-actions.pod:2723 ../src/guestfs-actions.pod:3311
7156 "This function returns a C<struct guestfs_xattr_list *> (see "
7157 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
7158 "must call C<guestfs_free_xattr_list> after use>."
7162 #: ../src/guestfs-actions.pod:1913
7163 msgid "guestfs_glob_expand"
7167 #: ../src/guestfs-actions.pod:1915
7171 " guestfs_glob_expand (guestfs_h *g,\n"
7172 " const char *pattern);\n"
7177 #: ../src/guestfs-actions.pod:1919 ../fish/guestfish-actions.pod:1433
7179 "This command searches for all the pathnames matching C<pattern> according to "
7180 "the wildcard expansion rules used by the shell."
7184 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1437
7185 msgid "If no paths match, then this returns an empty list (note: not an error)."
7189 #: ../src/guestfs-actions.pod:1926 ../fish/guestfish-actions.pod:1440
7191 "It is just a wrapper around the C L<glob(3)> function with flags "
7192 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
7196 #: ../src/guestfs-actions.pod:1934
7197 msgid "guestfs_grep"
7201 #: ../src/guestfs-actions.pod:1936
7205 " guestfs_grep (guestfs_h *g,\n"
7206 " const char *regex,\n"
7207 " const char *path);\n"
7212 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1448
7213 msgid "This calls the external C<grep> program and returns the matching lines."
7217 #: ../src/guestfs-actions.pod:1951
7218 msgid "guestfs_grepi"
7222 #: ../src/guestfs-actions.pod:1953
7226 " guestfs_grepi (guestfs_h *g,\n"
7227 " const char *regex,\n"
7228 " const char *path);\n"
7233 #: ../src/guestfs-actions.pod:1958 ../fish/guestfish-actions.pod:1458
7234 msgid "This calls the external C<grep -i> program and returns the matching lines."
7238 #: ../src/guestfs-actions.pod:1968
7239 msgid "guestfs_grub_install"
7243 #: ../src/guestfs-actions.pod:1970
7247 " guestfs_grub_install (guestfs_h *g,\n"
7248 " const char *root,\n"
7249 " const char *device);\n"
7254 #: ../src/guestfs-actions.pod:1975 ../fish/guestfish-actions.pod:1468
7256 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
7257 "the root directory being C<root>."
7261 #: ../src/guestfs-actions.pod:1978 ../fish/guestfish-actions.pod:1471
7263 "Note: If grub-install reports the error \"No suitable drive was found in the "
7264 "generated device map.\" it may be that you need to create a "
7265 "C</boot/grub/device.map> file first that contains the mapping between grub "
7266 "device names and Linux device names. It is usually sufficient to create a "
7271 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1478
7279 #: ../src/guestfs-actions.pod:1987 ../fish/guestfish-actions.pod:1480
7280 msgid "replacing C</dev/vda> with the name of the installation device."
7284 #: ../src/guestfs-actions.pod:1991
7285 msgid "guestfs_head"
7289 #: ../src/guestfs-actions.pod:1993
7293 " guestfs_head (guestfs_h *g,\n"
7294 " const char *path);\n"
7299 #: ../src/guestfs-actions.pod:1997 ../fish/guestfish-actions.pod:1486
7301 "This command returns up to the first 10 lines of a file as a list of "
7306 #: ../src/guestfs-actions.pod:2007
7307 msgid "guestfs_head_n"
7311 #: ../src/guestfs-actions.pod:2009
7315 " guestfs_head_n (guestfs_h *g,\n"
7317 " const char *path);\n"
7322 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1496
7324 "If the parameter C<nrlines> is a positive number, this returns the first "
7325 "C<nrlines> lines of the file C<path>."
7329 #: ../src/guestfs-actions.pod:2017 ../fish/guestfish-actions.pod:1499
7331 "If the parameter C<nrlines> is a negative number, this returns lines from "
7332 "the file C<path>, excluding the last C<nrlines> lines."
7336 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5340 ../fish/guestfish-actions.pod:1502 ../fish/guestfish-actions.pod:3917
7337 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7341 #: ../src/guestfs-actions.pod:2029
7342 msgid "guestfs_hexdump"
7346 #: ../src/guestfs-actions.pod:2031
7350 " guestfs_hexdump (guestfs_h *g,\n"
7351 " const char *path);\n"
7356 #: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1511
7358 "This runs C<hexdump -C> on the given C<path>. The result is the "
7359 "human-readable, canonical hex dump of the file."
7363 #: ../src/guestfs-actions.pod:2044
7364 msgid "guestfs_initrd_cat"
7368 #: ../src/guestfs-actions.pod:2046
7372 " guestfs_initrd_cat (guestfs_h *g,\n"
7373 " const char *initrdpath,\n"
7374 " const char *filename,\n"
7375 " size_t *size_r);\n"
7380 #: ../src/guestfs-actions.pod:2052 ../fish/guestfish-actions.pod:1521
7382 "This command unpacks the file C<filename> from the initrd file called "
7383 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7388 #: ../src/guestfs-actions.pod:2056 ../fish/guestfish-actions.pod:1525
7390 "For example, in guestfish you could use the following command to examine the "
7391 "boot script (usually called C</init>) contained in a Linux initrd or "
7396 #: ../src/guestfs-actions.pod:2060 ../fish/guestfish-actions.pod:1529
7399 " initrd-cat /boot/initrd-<version>.img init\n"
7404 #: ../src/guestfs-actions.pod:2062
7405 msgid "See also C<guestfs_initrd_list>."
7409 #: ../src/guestfs-actions.pod:2064 ../src/guestfs-actions.pod:4187 ../src/guestfs-actions.pod:4211 ../src/guestfs-actions.pod:4373
7411 "This function returns a buffer, or NULL on error. The size of the returned "
7412 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
7417 #: ../src/guestfs-actions.pod:2071
7418 msgid "guestfs_initrd_list"
7422 #: ../src/guestfs-actions.pod:2073
7426 " guestfs_initrd_list (guestfs_h *g,\n"
7427 " const char *path);\n"
7432 #: ../src/guestfs-actions.pod:2077 ../fish/guestfish-actions.pod:1540
7433 msgid "This command lists out files contained in an initrd."
7437 #: ../src/guestfs-actions.pod:2079 ../fish/guestfish-actions.pod:1542
7439 "The files are listed without any initial C</> character. The files are "
7440 "listed in the order they appear (not necessarily alphabetical). Directory "
7441 "names are listed as separate items."
7445 #: ../src/guestfs-actions.pod:2083 ../fish/guestfish-actions.pod:1546
7447 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
7448 "initrd. We I<only> support the newer initramfs format (compressed cpio "
7453 #: ../src/guestfs-actions.pod:2091
7454 msgid "guestfs_inotify_add_watch"
7458 #: ../src/guestfs-actions.pod:2093
7462 " guestfs_inotify_add_watch (guestfs_h *g,\n"
7463 " const char *path,\n"
7469 #: ../src/guestfs-actions.pod:2098 ../fish/guestfish-actions.pod:1554
7470 msgid "Watch C<path> for the events listed in C<mask>."
7474 #: ../src/guestfs-actions.pod:2100 ../fish/guestfish-actions.pod:1556
7476 "Note that if C<path> is a directory then events within that directory are "
7477 "watched, but this does I<not> happen recursively (in subdirectories)."
7481 #: ../src/guestfs-actions.pod:2104 ../fish/guestfish-actions.pod:1560
7483 "Note for non-C or non-Linux callers: the inotify events are defined by the "
7484 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
7488 #: ../src/guestfs-actions.pod:2110
7489 msgid "guestfs_inotify_close"
7493 #: ../src/guestfs-actions.pod:2112
7497 " guestfs_inotify_close (guestfs_h *g);\n"
7502 #: ../src/guestfs-actions.pod:2115 ../fish/guestfish-actions.pod:1568
7504 "This closes the inotify handle which was previously opened by inotify_init. "
7505 "It removes all watches, throws away any pending events, and deallocates all "
7510 #: ../src/guestfs-actions.pod:2121
7511 msgid "guestfs_inotify_files"
7515 #: ../src/guestfs-actions.pod:2123
7519 " guestfs_inotify_files (guestfs_h *g);\n"
7524 #: ../src/guestfs-actions.pod:2126
7526 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
7527 "returns a list of pathnames of objects that were touched. The returned "
7528 "pathnames are sorted and deduplicated."
7532 #: ../src/guestfs-actions.pod:2134
7533 msgid "guestfs_inotify_init"
7537 #: ../src/guestfs-actions.pod:2136
7541 " guestfs_inotify_init (guestfs_h *g,\n"
7542 " int maxevents);\n"
7547 #: ../src/guestfs-actions.pod:2140 ../fish/guestfish-actions.pod:1584
7549 "This command creates a new inotify handle. The inotify subsystem can be "
7550 "used to notify events which happen to objects in the guest filesystem."
7554 #: ../src/guestfs-actions.pod:2144
7556 "C<maxevents> is the maximum number of events which will be queued up between "
7557 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
7558 "passed as C<0>, then the kernel (or previously set) default is used. For "
7559 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
7560 "throws away events, but records the fact that it threw them away by setting "
7561 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
7562 "C<guestfs_inotify_read>)."
7566 #: ../src/guestfs-actions.pod:2154
7568 "Before any events are generated, you have to add some watches to the "
7569 "internal watch list. See: C<guestfs_inotify_add_watch>, "
7570 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
7574 #: ../src/guestfs-actions.pod:2160
7576 "Queued up events should be read periodically by calling "
7577 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
7578 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
7579 "often enough then you risk the internal queue overflowing."
7583 #: ../src/guestfs-actions.pod:2167
7585 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
7586 "This also removes any watches automatically."
7590 #: ../src/guestfs-actions.pod:2171 ../fish/guestfish-actions.pod:1615
7592 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
7593 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
7594 "that there is one global inotify handle per libguestfs instance."
7598 #: ../src/guestfs-actions.pod:2178
7599 msgid "guestfs_inotify_read"
7603 #: ../src/guestfs-actions.pod:2180
7606 " struct guestfs_inotify_event_list *\n"
7607 " guestfs_inotify_read (guestfs_h *g);\n"
7612 #: ../src/guestfs-actions.pod:2183 ../fish/guestfish-actions.pod:1624
7614 "Return the complete queue of events that have happened since the previous "
7619 #: ../src/guestfs-actions.pod:2186 ../fish/guestfish-actions.pod:1627
7620 msgid "If no events have happened, this returns an empty list."
7624 #: ../src/guestfs-actions.pod:2188 ../fish/guestfish-actions.pod:1629
7626 "I<Note>: In order to make sure that all events have been read, you must call "
7627 "this function repeatedly until it returns an empty list. The reason is that "
7628 "the call will read events up to the maximum appliance-to-host message size "
7629 "and leave remaining events in the queue."
7633 #: ../src/guestfs-actions.pod:2194
7635 "This function returns a C<struct guestfs_inotify_event_list *> (see "
7636 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
7637 "must call C<guestfs_free_inotify_event_list> after use>."
7641 #: ../src/guestfs-actions.pod:2199
7642 msgid "guestfs_inotify_rm_watch"
7646 #: ../src/guestfs-actions.pod:2201
7650 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
7656 #: ../src/guestfs-actions.pod:2205
7658 "Remove a previously defined inotify watch. See "
7659 "C<guestfs_inotify_add_watch>."
7663 #: ../src/guestfs-actions.pod:2210
7664 msgid "guestfs_inspect_get_arch"
7668 #: ../src/guestfs-actions.pod:2212
7672 " guestfs_inspect_get_arch (guestfs_h *g,\n"
7673 " const char *root);\n"
7678 #: ../src/guestfs-actions.pod:2216 ../src/guestfs-actions.pod:2237 ../src/guestfs-actions.pod:2308 ../src/guestfs-actions.pod:2332 ../src/guestfs-actions.pod:2357 ../src/guestfs-actions.pod:2376 ../src/guestfs-actions.pod:2407 ../src/guestfs-actions.pod:2429 ../src/guestfs-actions.pod:2465
7680 "This function should only be called with a root device string as returned by "
7681 "C<guestfs_inspect_os>."
7685 #: ../src/guestfs-actions.pod:2219
7687 "This returns the architecture of the inspected operating system. The "
7688 "possible return values are listed under C<guestfs_file_architecture>."
7692 #: ../src/guestfs-actions.pod:2223 ../fish/guestfish-actions.pod:1653
7694 "If the architecture could not be determined, then the string C<unknown> is "
7699 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:2297 ../src/guestfs-actions.pod:2347 ../src/guestfs-actions.pod:2418 ../src/guestfs-actions.pod:2454 ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2513 ../fish/guestfish-actions.pod:1656 ../fish/guestfish-actions.pod:1722 ../fish/guestfish-actions.pod:1761 ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1847 ../fish/guestfish-actions.pod:1863 ../fish/guestfish-actions.pod:1897
7700 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
7704 #: ../src/guestfs-actions.pod:2231
7705 msgid "guestfs_inspect_get_distro"
7709 #: ../src/guestfs-actions.pod:2233
7713 " guestfs_inspect_get_distro (guestfs_h *g,\n"
7714 " const char *root);\n"
7719 #: ../src/guestfs-actions.pod:2240 ../fish/guestfish-actions.pod:1665
7720 msgid "This returns the distro (distribution) of the inspected operating system."
7724 #: ../src/guestfs-actions.pod:2243 ../fish/guestfish-actions.pod:1668
7725 msgid "Currently defined distros are:"
7729 #: ../src/guestfs-actions.pod:2247 ../fish/guestfish-actions.pod:1672
7730 msgid "\"archlinux\""
7734 #: ../src/guestfs-actions.pod:2249 ../fish/guestfish-actions.pod:1674
7739 #: ../src/guestfs-actions.pod:2251 ../fish/guestfish-actions.pod:1676
7744 #: ../src/guestfs-actions.pod:2253 ../fish/guestfish-actions.pod:1678
7745 msgid "Debian or a Debian-derived distro such as Ubuntu."
7749 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1680
7754 #: ../src/guestfs-actions.pod:2257 ../fish/guestfish-actions.pod:1682
7759 #: ../src/guestfs-actions.pod:2259 ../fish/guestfish-actions.pod:1684
7764 #: ../src/guestfs-actions.pod:2261 ../fish/guestfish-actions.pod:1686
7769 #: ../src/guestfs-actions.pod:2263 ../fish/guestfish-actions.pod:1688
7774 #: ../src/guestfs-actions.pod:2265 ../fish/guestfish-actions.pod:1690
7779 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1692
7784 #: ../src/guestfs-actions.pod:2269 ../fish/guestfish-actions.pod:1694
7789 #: ../src/guestfs-actions.pod:2271 ../fish/guestfish-actions.pod:1696
7790 msgid "\"redhat-based\""
7794 #: ../src/guestfs-actions.pod:2273 ../fish/guestfish-actions.pod:1698
7795 msgid "Some Red Hat-derived distro."
7799 #: ../src/guestfs-actions.pod:2275 ../fish/guestfish-actions.pod:1700
7804 #: ../src/guestfs-actions.pod:2277 ../fish/guestfish-actions.pod:1702
7805 msgid "Red Hat Enterprise Linux and some derivatives."
7809 #: ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2441 ../fish/guestfish-actions.pod:1704 ../fish/guestfish-actions.pod:1834
7814 #: ../src/guestfs-actions.pod:2281 ../fish/guestfish-actions.pod:1706
7816 "Windows does not have distributions. This string is returned if the OS type "
7821 #: ../src/guestfs-actions.pod:2284 ../fish/guestfish-actions.pod:1709
7826 #: ../src/guestfs-actions.pod:2286 ../fish/guestfish-actions.pod:1711
7831 #: ../src/guestfs-actions.pod:2288 ../src/guestfs-actions.pod:2445 ../fish/guestfish-actions.pod:1713 ../fish/guestfish-actions.pod:1838
7836 #: ../src/guestfs-actions.pod:2290 ../fish/guestfish-actions.pod:1715
7837 msgid "The distro could not be determined."
7841 #: ../src/guestfs-actions.pod:2294 ../src/guestfs-actions.pod:2451 ../fish/guestfish-actions.pod:1719 ../fish/guestfish-actions.pod:1844
7843 "Future versions of libguestfs may return other strings here. The caller "
7844 "should be prepared to handle any string."
7848 #: ../src/guestfs-actions.pod:2302
7849 msgid "guestfs_inspect_get_filesystems"
7853 #: ../src/guestfs-actions.pod:2304
7857 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
7858 " const char *root);\n"
7863 #: ../src/guestfs-actions.pod:2311 ../fish/guestfish-actions.pod:1731
7865 "This returns a list of all the filesystems that we think are associated with "
7866 "this operating system. This includes the root filesystem, other ordinary "
7867 "filesystems, and non-mounted devices like swap partitions."
7871 #: ../src/guestfs-actions.pod:2316 ../fish/guestfish-actions.pod:1736
7873 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
7874 "to be shared between operating systems."
7878 #: ../src/guestfs-actions.pod:2319
7880 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7881 "C<guestfs_inspect_get_mountpoints>."
7885 #: ../src/guestfs-actions.pod:2326
7886 msgid "guestfs_inspect_get_major_version"
7890 #: ../src/guestfs-actions.pod:2328
7894 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
7895 " const char *root);\n"
7900 #: ../src/guestfs-actions.pod:2335 ../fish/guestfish-actions.pod:1749
7901 msgid "This returns the major version number of the inspected operating system."
7905 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1752
7907 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
7908 "popular public names used by the operating system. Notably the operating "
7909 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
7910 "1). You can find out the real versions corresponding to releases of Windows "
7911 "by consulting Wikipedia or MSDN."
7915 #: ../src/guestfs-actions.pod:2345 ../src/guestfs-actions.pod:2363 ../fish/guestfish-actions.pod:1759 ../fish/guestfish-actions.pod:1773
7916 msgid "If the version could not be determined, then C<0> is returned."
7920 #: ../src/guestfs-actions.pod:2351
7921 msgid "guestfs_inspect_get_minor_version"
7925 #: ../src/guestfs-actions.pod:2353
7929 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
7930 " const char *root);\n"
7935 #: ../src/guestfs-actions.pod:2360 ../fish/guestfish-actions.pod:1770
7936 msgid "This returns the minor version number of the inspected operating system."
7940 #: ../src/guestfs-actions.pod:2365
7942 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7943 "C<guestfs_inspect_get_major_version>."
7947 #: ../src/guestfs-actions.pod:2370
7948 msgid "guestfs_inspect_get_mountpoints"
7952 #: ../src/guestfs-actions.pod:2372
7956 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
7957 " const char *root);\n"
7962 #: ../src/guestfs-actions.pod:2379 ../fish/guestfish-actions.pod:1785
7964 "This returns a hash of where we think the filesystems associated with this "
7965 "operating system should be mounted. Callers should note that this is at "
7966 "best an educated guess made by reading configuration files such as "
7971 #: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1790
7973 "Each element in the returned hashtable has a key which is the path of the "
7974 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
7975 "mounted there (eg. C</dev/sda1>)."
7979 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1795
7980 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
7984 #: ../src/guestfs-actions.pod:2392
7986 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7987 "C<guestfs_inspect_get_filesystems>."
7991 #: ../src/guestfs-actions.pod:2395 ../src/guestfs-actions.pod:2777 ../src/guestfs-actions.pod:3790 ../src/guestfs-actions.pod:5465
7993 "This function returns a NULL-terminated array of strings, or NULL if there "
7994 "was an error. The array of strings will always have length C<2n+1>, where "
7995 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
7996 "caller must free the strings and the array after use>."
8000 #: ../src/guestfs-actions.pod:2401
8001 msgid "guestfs_inspect_get_product_name"
8005 #: ../src/guestfs-actions.pod:2403
8009 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
8010 " const char *root);\n"
8015 #: ../src/guestfs-actions.pod:2410 ../fish/guestfish-actions.pod:1808
8017 "This returns the product name of the inspected operating system. The "
8018 "product name is generally some freeform string which can be displayed to the "
8019 "user, but should not be parsed by programs."
8023 #: ../src/guestfs-actions.pod:2415 ../fish/guestfish-actions.pod:1813
8025 "If the product name could not be determined, then the string C<unknown> is "
8030 #: ../src/guestfs-actions.pod:2423
8031 msgid "guestfs_inspect_get_type"
8035 #: ../src/guestfs-actions.pod:2425
8039 " guestfs_inspect_get_type (guestfs_h *g,\n"
8040 " const char *root);\n"
8045 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1825
8047 "This returns the type of the inspected operating system. Currently defined "
8052 #: ../src/guestfs-actions.pod:2437 ../fish/guestfish-actions.pod:1830
8057 #: ../src/guestfs-actions.pod:2439 ../fish/guestfish-actions.pod:1832
8058 msgid "Any Linux-based operating system."
8062 #: ../src/guestfs-actions.pod:2443 ../fish/guestfish-actions.pod:1836
8063 msgid "Any Microsoft Windows operating system."
8067 #: ../src/guestfs-actions.pod:2447 ../fish/guestfish-actions.pod:1840
8068 msgid "The operating system type could not be determined."
8072 #: ../src/guestfs-actions.pod:2459
8073 msgid "guestfs_inspect_get_windows_systemroot"
8077 #: ../src/guestfs-actions.pod:2461
8081 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
8082 " const char *root);\n"
8087 #: ../src/guestfs-actions.pod:2468 ../fish/guestfish-actions.pod:1856
8089 "This returns the Windows systemroot of the inspected guest. The systemroot "
8090 "is a directory path such as C</WINDOWS>."
8094 #: ../src/guestfs-actions.pod:2471 ../fish/guestfish-actions.pod:1859
8096 "This call assumes that the guest is Windows and that the systemroot could be "
8097 "determined by inspection. If this is not the case then an error is "
8102 #: ../src/guestfs-actions.pod:2480
8103 msgid "guestfs_inspect_os"
8107 #: ../src/guestfs-actions.pod:2482
8111 " guestfs_inspect_os (guestfs_h *g);\n"
8116 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1869
8118 "This function uses other libguestfs functions and certain heuristics to "
8119 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
8120 "for operating systems."
8124 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1873
8125 msgid "The list returned is empty if no operating systems were found."
8129 #: ../src/guestfs-actions.pod:2491 ../fish/guestfish-actions.pod:1875
8131 "If one operating system was found, then this returns a list with a single "
8132 "element, which is the name of the root filesystem of this operating system. "
8133 "It is also possible for this function to return a list containing more than "
8134 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
8135 "element being the root filesystem of one of the operating systems."
8139 #: ../src/guestfs-actions.pod:2498
8141 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
8142 "functions in order to query further information about each operating system, "
8143 "such as the name and version."
8147 #: ../src/guestfs-actions.pod:2503
8149 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
8150 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
8151 "the contents. This should be called with no disks currently mounted. The "
8152 "function may also use Augeas, so any existing Augeas handle will be closed."
8156 #: ../src/guestfs-actions.pod:2509 ../fish/guestfish-actions.pod:1893
8158 "This function cannot decrypt encrypted disks. The caller must do that first "
8159 "(supplying the necessary keys) if the disk is encrypted."
8163 #: ../src/guestfs-actions.pod:2515 ../src/guestfs-actions.pod:2737 ../src/guestfs-actions.pod:2795
8164 msgid "See also C<guestfs_list_filesystems>."
8168 #: ../src/guestfs-actions.pod:2521
8169 msgid "guestfs_is_blockdev"
8173 #: ../src/guestfs-actions.pod:2523
8177 " guestfs_is_blockdev (guestfs_h *g,\n"
8178 " const char *path);\n"
8183 #: ../src/guestfs-actions.pod:2527 ../fish/guestfish-actions.pod:1905
8185 "This returns C<true> if and only if there is a block device with the given "
8190 #: ../src/guestfs-actions.pod:2530 ../src/guestfs-actions.pod:2555 ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:2594 ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2656 ../src/guestfs-actions.pod:2669
8191 msgid "See also C<guestfs_stat>."
8195 #: ../src/guestfs-actions.pod:2534
8196 msgid "guestfs_is_busy"
8200 #: ../src/guestfs-actions.pod:2536
8204 " guestfs_is_busy (guestfs_h *g);\n"
8209 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1914
8211 "This returns true iff this handle is busy processing a command (in the "
8216 #: ../src/guestfs-actions.pod:2546
8217 msgid "guestfs_is_chardev"
8221 #: ../src/guestfs-actions.pod:2548
8225 " guestfs_is_chardev (guestfs_h *g,\n"
8226 " const char *path);\n"
8231 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1923
8233 "This returns C<true> if and only if there is a character device with the "
8234 "given C<path> name."
8238 #: ../src/guestfs-actions.pod:2559
8239 msgid "guestfs_is_config"
8243 #: ../src/guestfs-actions.pod:2561
8247 " guestfs_is_config (guestfs_h *g);\n"
8252 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1932
8254 "This returns true iff this handle is being configured (in the C<CONFIG> "
8259 #: ../src/guestfs-actions.pod:2571
8260 msgid "guestfs_is_dir"
8264 #: ../src/guestfs-actions.pod:2573
8268 " guestfs_is_dir (guestfs_h *g,\n"
8269 " const char *path);\n"
8274 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1941
8276 "This returns C<true> if and only if there is a directory with the given "
8277 "C<path> name. Note that it returns false for other objects like files."
8281 #: ../src/guestfs-actions.pod:2585
8282 msgid "guestfs_is_fifo"
8286 #: ../src/guestfs-actions.pod:2587
8290 " guestfs_is_fifo (guestfs_h *g,\n"
8291 " const char *path);\n"
8296 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1951
8298 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
8299 "given C<path> name."
8303 #: ../src/guestfs-actions.pod:2598
8304 msgid "guestfs_is_file"
8308 #: ../src/guestfs-actions.pod:2600
8312 " guestfs_is_file (guestfs_h *g,\n"
8313 " const char *path);\n"
8318 #: ../src/guestfs-actions.pod:2604 ../fish/guestfish-actions.pod:1960
8320 "This returns C<true> if and only if there is a regular file with the given "
8321 "C<path> name. Note that it returns false for other objects like "
8326 #: ../src/guestfs-actions.pod:2612
8327 msgid "guestfs_is_launching"
8331 #: ../src/guestfs-actions.pod:2614
8335 " guestfs_is_launching (guestfs_h *g);\n"
8340 #: ../src/guestfs-actions.pod:2617 ../fish/guestfish-actions.pod:1970
8342 "This returns true iff this handle is launching the subprocess (in the "
8343 "C<LAUNCHING> state)."
8347 #: ../src/guestfs-actions.pod:2624
8348 msgid "guestfs_is_lv"
8352 #: ../src/guestfs-actions.pod:2626
8356 " guestfs_is_lv (guestfs_h *g,\n"
8357 " const char *device);\n"
8362 #: ../src/guestfs-actions.pod:2630 ../fish/guestfish-actions.pod:1979
8364 "This command tests whether C<device> is a logical volume, and returns true "
8365 "iff this is the case."
8369 #: ../src/guestfs-actions.pod:2635
8370 msgid "guestfs_is_ready"
8374 #: ../src/guestfs-actions.pod:2637
8378 " guestfs_is_ready (guestfs_h *g);\n"
8383 #: ../src/guestfs-actions.pod:2640 ../fish/guestfish-actions.pod:1986
8385 "This returns true iff this handle is ready to accept commands (in the "
8390 #: ../src/guestfs-actions.pod:2647
8391 msgid "guestfs_is_socket"
8395 #: ../src/guestfs-actions.pod:2649
8399 " guestfs_is_socket (guestfs_h *g,\n"
8400 " const char *path);\n"
8405 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1995
8407 "This returns C<true> if and only if there is a Unix domain socket with the "
8408 "given C<path> name."
8412 #: ../src/guestfs-actions.pod:2660
8413 msgid "guestfs_is_symlink"
8417 #: ../src/guestfs-actions.pod:2662
8421 " guestfs_is_symlink (guestfs_h *g,\n"
8422 " const char *path);\n"
8427 #: ../src/guestfs-actions.pod:2666 ../fish/guestfish-actions.pod:2004
8429 "This returns C<true> if and only if there is a symbolic link with the given "
8434 #: ../src/guestfs-actions.pod:2673
8435 msgid "guestfs_kill_subprocess"
8439 #: ../src/guestfs-actions.pod:2675
8443 " guestfs_kill_subprocess (guestfs_h *g);\n"
8448 #: ../src/guestfs-actions.pod:2678 ../fish/guestfish-actions.pod:2013
8449 msgid "This kills the qemu subprocess. You should never need to call this."
8453 #: ../src/guestfs-actions.pod:2682
8454 msgid "guestfs_launch"
8458 #: ../src/guestfs-actions.pod:2684
8462 " guestfs_launch (guestfs_h *g);\n"
8467 #: ../src/guestfs-actions.pod:2687 ../fish/guestfish-actions.pod:2021
8469 "Internally libguestfs is implemented by running a virtual machine using "
8474 #: ../src/guestfs-actions.pod:2690 ../fish/guestfish-actions.pod:2024
8476 "You should call this after configuring the handle (eg. adding drives) but "
8477 "before performing any actions."
8481 #: ../src/guestfs-actions.pod:2695
8482 msgid "guestfs_lchown"
8486 #: ../src/guestfs-actions.pod:2697
8490 " guestfs_lchown (guestfs_h *g,\n"
8493 " const char *path);\n"
8498 #: ../src/guestfs-actions.pod:2703
8500 "Change the file owner to C<owner> and group to C<group>. This is like "
8501 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
8502 "changed, not the target."
8506 #: ../src/guestfs-actions.pod:2713
8507 msgid "guestfs_lgetxattrs"
8511 #: ../src/guestfs-actions.pod:2715
8514 " struct guestfs_xattr_list *\n"
8515 " guestfs_lgetxattrs (guestfs_h *g,\n"
8516 " const char *path);\n"
8521 #: ../src/guestfs-actions.pod:2719
8523 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
8524 "then it returns the extended attributes of the link itself."
8528 #: ../src/guestfs-actions.pod:2728
8529 msgid "guestfs_list_devices"
8533 #: ../src/guestfs-actions.pod:2730
8537 " guestfs_list_devices (guestfs_h *g);\n"
8542 #: ../src/guestfs-actions.pod:2733 ../fish/guestfish-actions.pod:2051
8543 msgid "List all the block devices."
8547 #: ../src/guestfs-actions.pod:2735 ../fish/guestfish-actions.pod:2053
8548 msgid "The full block device names are returned, eg. C</dev/sda>."
8552 #: ../src/guestfs-actions.pod:2743
8553 msgid "guestfs_list_filesystems"
8557 #: ../src/guestfs-actions.pod:2745
8561 " guestfs_list_filesystems (guestfs_h *g);\n"
8566 #: ../src/guestfs-actions.pod:2748 ../fish/guestfish-actions.pod:2061
8568 "This inspection command looks for filesystems on partitions, block devices "
8569 "and logical volumes, returning a list of devices containing filesystems and "
8574 #: ../src/guestfs-actions.pod:2752 ../fish/guestfish-actions.pod:2065
8576 "The return value is a hash, where the keys are the devices containing "
8577 "filesystems, and the values are the filesystem types. For example:"
8581 #: ../src/guestfs-actions.pod:2756 ../fish/guestfish-actions.pod:2069
8584 " \"/dev/sda1\" => \"ntfs\"\n"
8585 " \"/dev/sda2\" => \"ext2\"\n"
8586 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
8587 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
8592 #: ../src/guestfs-actions.pod:2761 ../fish/guestfish-actions.pod:2074
8594 "The value can have the special value \"unknown\", meaning the content of the "
8595 "device is undetermined or empty. \"swap\" means a Linux swap partition."
8599 #: ../src/guestfs-actions.pod:2765
8601 "This command runs other libguestfs commands, which might include "
8602 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
8603 "soon after launch and only when nothing is mounted."
8607 #: ../src/guestfs-actions.pod:2769
8609 "Not all of the filesystems returned will be mountable. In particular, swap "
8610 "partitions are returned in the list. Also this command does not check that "
8611 "each filesystem found is valid and mountable, and some filesystems might be "
8612 "mountable but require special options. Filesystems may not all belong to a "
8613 "single logical operating system (use C<guestfs_inspect_os> to look for "
8618 #: ../src/guestfs-actions.pod:2783
8619 msgid "guestfs_list_partitions"
8623 #: ../src/guestfs-actions.pod:2785
8627 " guestfs_list_partitions (guestfs_h *g);\n"
8632 #: ../src/guestfs-actions.pod:2788 ../fish/guestfish-actions.pod:2094
8633 msgid "List all the partitions detected on all block devices."
8637 #: ../src/guestfs-actions.pod:2790 ../fish/guestfish-actions.pod:2096
8638 msgid "The full partition device names are returned, eg. C</dev/sda1>"
8642 #: ../src/guestfs-actions.pod:2792
8644 "This does not return logical volumes. For that you will need to call "
8649 #: ../src/guestfs-actions.pod:2801
8654 #: ../src/guestfs-actions.pod:2803
8658 " guestfs_ll (guestfs_h *g,\n"
8659 " const char *directory);\n"
8664 #: ../src/guestfs-actions.pod:2807 ../fish/guestfish-actions.pod:2107
8666 "List the files in C<directory> (relative to the root directory, there is no "
8667 "cwd) in the format of 'ls -la'."
8671 #: ../src/guestfs-actions.pod:2810 ../fish/guestfish-actions.pod:2110
8673 "This command is mostly useful for interactive sessions. It is I<not> "
8674 "intended that you try to parse the output string."
8678 #: ../src/guestfs-actions.pod:2816
8683 #: ../src/guestfs-actions.pod:2818
8687 " guestfs_ln (guestfs_h *g,\n"
8688 " const char *target,\n"
8689 " const char *linkname);\n"
8694 #: ../src/guestfs-actions.pod:2823 ../fish/guestfish-actions.pod:2117
8695 msgid "This command creates a hard link using the C<ln> command."
8699 #: ../src/guestfs-actions.pod:2827
8700 msgid "guestfs_ln_f"
8704 #: ../src/guestfs-actions.pod:2829
8708 " guestfs_ln_f (guestfs_h *g,\n"
8709 " const char *target,\n"
8710 " const char *linkname);\n"
8715 #: ../src/guestfs-actions.pod:2834 ../fish/guestfish-actions.pod:2123
8717 "This command creates a hard link using the C<ln -f> command. The C<-f> "
8718 "option removes the link (C<linkname>) if it exists already."
8722 #: ../src/guestfs-actions.pod:2839
8723 msgid "guestfs_ln_s"
8727 #: ../src/guestfs-actions.pod:2841
8731 " guestfs_ln_s (guestfs_h *g,\n"
8732 " const char *target,\n"
8733 " const char *linkname);\n"
8738 #: ../src/guestfs-actions.pod:2846 ../fish/guestfish-actions.pod:2130
8739 msgid "This command creates a symbolic link using the C<ln -s> command."
8743 #: ../src/guestfs-actions.pod:2850
8744 msgid "guestfs_ln_sf"
8748 #: ../src/guestfs-actions.pod:2852
8752 " guestfs_ln_sf (guestfs_h *g,\n"
8753 " const char *target,\n"
8754 " const char *linkname);\n"
8759 #: ../src/guestfs-actions.pod:2857 ../fish/guestfish-actions.pod:2136
8761 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
8762 "option removes the link (C<linkname>) if it exists already."
8766 #: ../src/guestfs-actions.pod:2862
8767 msgid "guestfs_lremovexattr"
8771 #: ../src/guestfs-actions.pod:2864
8775 " guestfs_lremovexattr (guestfs_h *g,\n"
8776 " const char *xattr,\n"
8777 " const char *path);\n"
8782 #: ../src/guestfs-actions.pod:2869
8784 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
8785 "link, then it removes an extended attribute of the link itself."
8789 #: ../src/guestfs-actions.pod:2875
8794 #: ../src/guestfs-actions.pod:2877
8798 " guestfs_ls (guestfs_h *g,\n"
8799 " const char *directory);\n"
8804 #: ../src/guestfs-actions.pod:2881 ../fish/guestfish-actions.pod:2151
8806 "List the files in C<directory> (relative to the root directory, there is no "
8807 "cwd). The '.' and '..' entries are not returned, but hidden files are "
8812 #: ../src/guestfs-actions.pod:2885
8814 "This command is mostly useful for interactive sessions. Programs should "
8815 "probably use C<guestfs_readdir> instead."
8819 #: ../src/guestfs-actions.pod:2892
8820 msgid "guestfs_lsetxattr"
8824 #: ../src/guestfs-actions.pod:2894
8828 " guestfs_lsetxattr (guestfs_h *g,\n"
8829 " const char *xattr,\n"
8830 " const char *val,\n"
8832 " const char *path);\n"
8837 #: ../src/guestfs-actions.pod:2901
8839 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
8840 "then it sets an extended attribute of the link itself."
8844 #: ../src/guestfs-actions.pod:2907
8845 msgid "guestfs_lstat"
8849 #: ../src/guestfs-actions.pod:2909
8852 " struct guestfs_stat *\n"
8853 " guestfs_lstat (guestfs_h *g,\n"
8854 " const char *path);\n"
8859 #: ../src/guestfs-actions.pod:2913 ../src/guestfs-actions.pod:5108 ../fish/guestfish-actions.pod:2170 ../fish/guestfish-actions.pod:3752
8860 msgid "Returns file information for the given C<path>."
8864 #: ../src/guestfs-actions.pod:2915
8866 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
8867 "link, then the link is stat-ed, not the file it refers to."
8871 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2176
8872 msgid "This is the same as the C<lstat(2)> system call."
8876 #: ../src/guestfs-actions.pod:2921 ../src/guestfs-actions.pod:5112
8878 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
8879 "error. I<The caller must call C<guestfs_free_stat> after use>."
8883 #: ../src/guestfs-actions.pod:2925
8884 msgid "guestfs_lstatlist"
8888 #: ../src/guestfs-actions.pod:2927
8891 " struct guestfs_stat_list *\n"
8892 " guestfs_lstatlist (guestfs_h *g,\n"
8893 " const char *path,\n"
8894 " char *const *names);\n"
8899 #: ../src/guestfs-actions.pod:2932
8901 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
8902 "files, where all files are in the directory C<path>. C<names> is the list "
8903 "of files from this directory."
8907 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2186
8909 "On return you get a list of stat structs, with a one-to-one correspondence "
8910 "to the C<names> list. If any name did not exist or could not be lstat'd, "
8911 "then the C<ino> field of that structure is set to C<-1>."
8915 #: ../src/guestfs-actions.pod:2941
8917 "This call is intended for programs that want to efficiently list a directory "
8918 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
8919 "for a similarly efficient call for getting extended attributes. Very long "
8920 "directory listings might cause the protocol message size to be exceeded, "
8921 "causing this call to fail. The caller must split up such requests into "
8922 "smaller groups of names."
8926 #: ../src/guestfs-actions.pod:2949
8928 "This function returns a C<struct guestfs_stat_list *> (see "
8929 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
8930 "must call C<guestfs_free_stat_list> after use>."
8934 #: ../src/guestfs-actions.pod:2954
8935 msgid "guestfs_luks_add_key"
8939 #: ../src/guestfs-actions.pod:2956
8943 " guestfs_luks_add_key (guestfs_h *g,\n"
8944 " const char *device,\n"
8945 " const char *key,\n"
8946 " const char *newkey,\n"
8952 #: ../src/guestfs-actions.pod:2963 ../fish/guestfish-actions.pod:2203
8954 "This command adds a new key on LUKS device C<device>. C<key> is any "
8955 "existing key, and is used to access the device. C<newkey> is the new key to "
8956 "add. C<keyslot> is the key slot that will be replaced."
8960 #: ../src/guestfs-actions.pod:2968
8962 "Note that if C<keyslot> already contains a key, then this command will "
8963 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
8967 #: ../src/guestfs-actions.pod:2974 ../src/guestfs-actions.pod:3010 ../src/guestfs-actions.pod:3031 ../src/guestfs-actions.pod:3049 ../src/guestfs-actions.pod:3079 ../src/guestfs-actions.pod:3096
8969 "This function takes a key or passphrase parameter which could contain "
8970 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
8975 #: ../src/guestfs-actions.pod:2978
8976 msgid "guestfs_luks_close"
8980 #: ../src/guestfs-actions.pod:2980
8984 " guestfs_luks_close (guestfs_h *g,\n"
8985 " const char *device);\n"
8990 #: ../src/guestfs-actions.pod:2984
8992 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
8993 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
8994 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
8995 "underlying block device."
8999 #: ../src/guestfs-actions.pod:2992
9000 msgid "guestfs_luks_format"
9004 #: ../src/guestfs-actions.pod:2994
9008 " guestfs_luks_format (guestfs_h *g,\n"
9009 " const char *device,\n"
9010 " const char *key,\n"
9016 #: ../src/guestfs-actions.pod:3000 ../fish/guestfish-actions.pod:2229
9018 "This command erases existing data on C<device> and formats the device as a "
9019 "LUKS encrypted device. C<key> is the initial key, which is added to key "
9020 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
9024 #: ../src/guestfs-actions.pod:3007 ../src/guestfs-actions.pod:3028 ../src/guestfs-actions.pod:3154 ../src/guestfs-actions.pod:3926 ../src/guestfs-actions.pod:4622 ../src/guestfs-actions.pod:4961 ../src/guestfs-actions.pod:4982 ../src/guestfs-actions.pod:5006 ../src/guestfs-actions.pod:6033 ../fish/guestfish-actions.pod:2237 ../fish/guestfish-actions.pod:2250 ../fish/guestfish-actions.pod:2334 ../fish/guestfish-actions.pod:2864 ../fish/guestfish-actions.pod:3371 ../fish/guestfish-actions.pod:3651 ../fish/guestfish-actions.pod:3667 ../fish/guestfish-actions.pod:3682 ../fish/guestfish-actions.pod:4397
9026 "B<This command is dangerous. Without careful use you can easily destroy all "
9031 #: ../src/guestfs-actions.pod:3014
9032 msgid "guestfs_luks_format_cipher"
9036 #: ../src/guestfs-actions.pod:3016
9040 " guestfs_luks_format_cipher (guestfs_h *g,\n"
9041 " const char *device,\n"
9042 " const char *key,\n"
9044 " const char *cipher);\n"
9049 #: ../src/guestfs-actions.pod:3023
9051 "This command is the same as C<guestfs_luks_format> but it also allows you to "
9052 "set the C<cipher> used."
9056 #: ../src/guestfs-actions.pod:3035
9057 msgid "guestfs_luks_kill_slot"
9061 #: ../src/guestfs-actions.pod:3037
9065 " guestfs_luks_kill_slot (guestfs_h *g,\n"
9066 " const char *device,\n"
9067 " const char *key,\n"
9073 #: ../src/guestfs-actions.pod:3043 ../fish/guestfish-actions.pod:2257
9075 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
9076 "device C<device>. C<key> must be one of the I<other> keys."
9080 #: ../src/guestfs-actions.pod:3053
9081 msgid "guestfs_luks_open"
9085 #: ../src/guestfs-actions.pod:3055
9089 " guestfs_luks_open (guestfs_h *g,\n"
9090 " const char *device,\n"
9091 " const char *key,\n"
9092 " const char *mapname);\n"
9097 #: ../src/guestfs-actions.pod:3061 ../fish/guestfish-actions.pod:2268
9099 "This command opens a block device which has been encrypted according to the "
9100 "Linux Unified Key Setup (LUKS) standard."
9104 #: ../src/guestfs-actions.pod:3064 ../fish/guestfish-actions.pod:2271
9105 msgid "C<device> is the encrypted block device or partition."
9109 #: ../src/guestfs-actions.pod:3066 ../fish/guestfish-actions.pod:2273
9111 "The caller must supply one of the keys associated with the LUKS block "
9112 "device, in the C<key> parameter."
9116 #: ../src/guestfs-actions.pod:3069 ../fish/guestfish-actions.pod:2276
9118 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
9119 "writes to this block device are decrypted from and encrypted to the "
9120 "underlying C<device> respectively."
9124 #: ../src/guestfs-actions.pod:3073
9126 "If this block device contains LVM volume groups, then calling "
9127 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
9132 #: ../src/guestfs-actions.pod:3083
9133 msgid "guestfs_luks_open_ro"
9137 #: ../src/guestfs-actions.pod:3085
9141 " guestfs_luks_open_ro (guestfs_h *g,\n"
9142 " const char *device,\n"
9143 " const char *key,\n"
9144 " const char *mapname);\n"
9149 #: ../src/guestfs-actions.pod:3091
9151 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
9156 #: ../src/guestfs-actions.pod:3100
9157 msgid "guestfs_lvcreate"
9161 #: ../src/guestfs-actions.pod:3102
9165 " guestfs_lvcreate (guestfs_h *g,\n"
9166 " const char *logvol,\n"
9167 " const char *volgroup,\n"
9173 #: ../src/guestfs-actions.pod:3108 ../fish/guestfish-actions.pod:2301
9175 "This creates an LVM logical volume called C<logvol> on the volume group "
9176 "C<volgroup>, with C<size> megabytes."
9180 #: ../src/guestfs-actions.pod:3113
9181 msgid "guestfs_lvm_canonical_lv_name"
9185 #: ../src/guestfs-actions.pod:3115
9189 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
9190 " const char *lvname);\n"
9195 #: ../src/guestfs-actions.pod:3119 ../fish/guestfish-actions.pod:2308
9197 "This converts alternative naming schemes for LVs that you might find to the "
9198 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
9203 #: ../src/guestfs-actions.pod:3123 ../fish/guestfish-actions.pod:2312
9205 "This command returns an error if the C<lvname> parameter does not refer to a "
9210 #: ../src/guestfs-actions.pod:3126
9211 msgid "See also C<guestfs_is_lv>."
9215 #: ../src/guestfs-actions.pod:3131
9216 msgid "guestfs_lvm_clear_filter"
9220 #: ../src/guestfs-actions.pod:3133
9224 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
9229 #: ../src/guestfs-actions.pod:3136
9231 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
9232 "see every block device."
9236 #: ../src/guestfs-actions.pod:3139 ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2324 ../fish/guestfish-actions.pod:2355
9237 msgid "This command also clears the LVM cache and performs a volume group scan."
9241 #: ../src/guestfs-actions.pod:3144
9242 msgid "guestfs_lvm_remove_all"
9246 #: ../src/guestfs-actions.pod:3146
9250 " guestfs_lvm_remove_all (guestfs_h *g);\n"
9255 #: ../src/guestfs-actions.pod:3149 ../fish/guestfish-actions.pod:2331
9257 "This command removes all LVM logical volumes, volume groups and physical "
9262 #: ../src/guestfs-actions.pod:3157
9263 msgid "guestfs_lvm_set_filter"
9267 #: ../src/guestfs-actions.pod:3159
9271 " guestfs_lvm_set_filter (guestfs_h *g,\n"
9272 " char *const *devices);\n"
9277 #: ../src/guestfs-actions.pod:3163 ../fish/guestfish-actions.pod:2341
9279 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
9280 "block devices in the list C<devices>, and will ignore all other attached "
9285 #: ../src/guestfs-actions.pod:3167 ../fish/guestfish-actions.pod:2345
9287 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
9288 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
9289 "there are two types of duplication possible: either cloned PVs/VGs which "
9290 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
9291 "same name. In normal operation you cannot create this situation, but you "
9292 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
9293 "inside the LVM metadata."
9297 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2358
9298 msgid "You can filter whole block devices or individual partitions."
9302 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2360
9304 "You cannot use this if any VG is currently in use (eg. contains a mounted "
9305 "filesystem), even if you are not filtering out that VG."
9309 #: ../src/guestfs-actions.pod:3188
9310 msgid "guestfs_lvremove"
9314 #: ../src/guestfs-actions.pod:3190
9318 " guestfs_lvremove (guestfs_h *g,\n"
9319 " const char *device);\n"
9324 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2368
9326 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
9327 "LV, such as C</dev/VG/LV>."
9331 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2371
9333 "You can also remove all LVs in a volume group by specifying the VG name, "
9338 #: ../src/guestfs-actions.pod:3202
9339 msgid "guestfs_lvrename"
9343 #: ../src/guestfs-actions.pod:3204
9347 " guestfs_lvrename (guestfs_h *g,\n"
9348 " const char *logvol,\n"
9349 " const char *newlogvol);\n"
9354 #: ../src/guestfs-actions.pod:3209 ../fish/guestfish-actions.pod:2378
9355 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
9359 #: ../src/guestfs-actions.pod:3213
9360 msgid "guestfs_lvresize"
9364 #: ../src/guestfs-actions.pod:3215
9368 " guestfs_lvresize (guestfs_h *g,\n"
9369 " const char *device,\n"
9375 #: ../src/guestfs-actions.pod:3220 ../fish/guestfish-actions.pod:2384
9377 "This resizes (expands or shrinks) an existing LVM logical volume to "
9378 "C<mbytes>. When reducing, data in the reduced part is lost."
9382 #: ../src/guestfs-actions.pod:3226
9383 msgid "guestfs_lvresize_free"
9387 #: ../src/guestfs-actions.pod:3228
9391 " guestfs_lvresize_free (guestfs_h *g,\n"
9392 " const char *lv,\n"
9398 #: ../src/guestfs-actions.pod:3233 ../fish/guestfish-actions.pod:2392
9400 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
9401 "remaining free space in the volume group. Commonly you would call this with "
9402 "pc = 100 which expands the logical volume as much as possible, using all "
9403 "remaining free space in the volume group."
9407 #: ../src/guestfs-actions.pod:3241
9412 #: ../src/guestfs-actions.pod:3243
9416 " guestfs_lvs (guestfs_h *g);\n"
9421 #: ../src/guestfs-actions.pod:3246 ../fish/guestfish-actions.pod:2402
9423 "List all the logical volumes detected. This is the equivalent of the "
9424 "L<lvs(8)> command."
9428 #: ../src/guestfs-actions.pod:3249 ../fish/guestfish-actions.pod:2405
9430 "This returns a list of the logical volume device names "
9431 "(eg. C</dev/VolGroup00/LogVol00>)."
9435 #: ../src/guestfs-actions.pod:3252
9436 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
9440 #: ../src/guestfs-actions.pod:3258
9441 msgid "guestfs_lvs_full"
9445 #: ../src/guestfs-actions.pod:3260
9448 " struct guestfs_lvm_lv_list *\n"
9449 " guestfs_lvs_full (guestfs_h *g);\n"
9454 #: ../src/guestfs-actions.pod:3263 ../fish/guestfish-actions.pod:2414
9456 "List all the logical volumes detected. This is the equivalent of the "
9457 "L<lvs(8)> command. The \"full\" version includes all fields."
9461 #: ../src/guestfs-actions.pod:3266
9463 "This function returns a C<struct guestfs_lvm_lv_list *> (see "
9464 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
9465 "must call C<guestfs_free_lvm_lv_list> after use>."
9469 #: ../src/guestfs-actions.pod:3271
9470 msgid "guestfs_lvuuid"
9474 #: ../src/guestfs-actions.pod:3273
9478 " guestfs_lvuuid (guestfs_h *g,\n"
9479 " const char *device);\n"
9484 #: ../src/guestfs-actions.pod:3277 ../fish/guestfish-actions.pod:2421
9485 msgid "This command returns the UUID of the LVM LV C<device>."
9489 #: ../src/guestfs-actions.pod:3282
9490 msgid "guestfs_lxattrlist"
9494 #: ../src/guestfs-actions.pod:3284
9497 " struct guestfs_xattr_list *\n"
9498 " guestfs_lxattrlist (guestfs_h *g,\n"
9499 " const char *path,\n"
9500 " char *const *names);\n"
9505 #: ../src/guestfs-actions.pod:3289 ../fish/guestfish-actions.pod:2427
9507 "This call allows you to get the extended attributes of multiple files, where "
9508 "all files are in the directory C<path>. C<names> is the list of files from "
9513 #: ../src/guestfs-actions.pod:3293 ../fish/guestfish-actions.pod:2431
9515 "On return you get a flat list of xattr structs which must be interpreted "
9516 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
9517 "C<attrval> in this struct is zero-length to indicate there was an error "
9518 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
9519 "number (the number of following attributes for this file, which could be "
9520 "C<\"0\">). Then after the first xattr struct are the zero or more "
9521 "attributes for the first named file. This repeats for the second and "
9526 #: ../src/guestfs-actions.pod:3303
9528 "This call is intended for programs that want to efficiently list a directory "
9529 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
9530 "a similarly efficient call for getting standard stats. Very long directory "
9531 "listings might cause the protocol message size to be exceeded, causing this "
9532 "call to fail. The caller must split up such requests into smaller groups of "
9537 #: ../src/guestfs-actions.pod:3316
9538 msgid "guestfs_mkdir"
9542 #: ../src/guestfs-actions.pod:3318
9546 " guestfs_mkdir (guestfs_h *g,\n"
9547 " const char *path);\n"
9552 #: ../src/guestfs-actions.pod:3322 ../fish/guestfish-actions.pod:2453
9553 msgid "Create a directory named C<path>."
9557 #: ../src/guestfs-actions.pod:3326
9558 msgid "guestfs_mkdir_mode"
9562 #: ../src/guestfs-actions.pod:3328
9566 " guestfs_mkdir_mode (guestfs_h *g,\n"
9567 " const char *path,\n"
9573 #: ../src/guestfs-actions.pod:3333 ../fish/guestfish-actions.pod:2459
9575 "This command creates a directory, setting the initial permissions of the "
9576 "directory to C<mode>."
9580 #: ../src/guestfs-actions.pod:3336 ../fish/guestfish-actions.pod:2462
9582 "For common Linux filesystems, the actual mode which is set will be C<mode & "
9583 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
9588 #: ../src/guestfs-actions.pod:3340
9589 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
9593 #: ../src/guestfs-actions.pod:3344
9594 msgid "guestfs_mkdir_p"
9598 #: ../src/guestfs-actions.pod:3346
9602 " guestfs_mkdir_p (guestfs_h *g,\n"
9603 " const char *path);\n"
9608 #: ../src/guestfs-actions.pod:3350 ../fish/guestfish-actions.pod:2472
9610 "Create a directory named C<path>, creating any parent directories as "
9611 "necessary. This is like the C<mkdir -p> shell command."
9615 #: ../src/guestfs-actions.pod:3355
9616 msgid "guestfs_mkdtemp"
9620 #: ../src/guestfs-actions.pod:3357
9624 " guestfs_mkdtemp (guestfs_h *g,\n"
9625 " const char *template);\n"
9630 #: ../src/guestfs-actions.pod:3361 ../fish/guestfish-actions.pod:2479
9632 "This command creates a temporary directory. The C<template> parameter "
9633 "should be a full pathname for the temporary directory name with the final "
9634 "six characters being \"XXXXXX\"."
9638 #: ../src/guestfs-actions.pod:3366 ../fish/guestfish-actions.pod:2484
9640 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
9641 "being suitable for Windows filesystems."
9645 #: ../src/guestfs-actions.pod:3369 ../fish/guestfish-actions.pod:2487
9646 msgid "The name of the temporary directory that was created is returned."
9650 #: ../src/guestfs-actions.pod:3372 ../fish/guestfish-actions.pod:2490
9651 msgid "The temporary directory is created with mode 0700 and is owned by root."
9655 #: ../src/guestfs-actions.pod:3375 ../fish/guestfish-actions.pod:2493
9657 "The caller is responsible for deleting the temporary directory and its "
9658 "contents after use."
9662 #: ../src/guestfs-actions.pod:3378 ../fish/guestfish-actions.pod:2496
9663 msgid "See also: L<mkdtemp(3)>"
9667 #: ../src/guestfs-actions.pod:3383
9668 msgid "guestfs_mke2fs_J"
9672 #: ../src/guestfs-actions.pod:3385
9676 " guestfs_mke2fs_J (guestfs_h *g,\n"
9677 " const char *fstype,\n"
9679 " const char *device,\n"
9680 " const char *journal);\n"
9685 #: ../src/guestfs-actions.pod:3392 ../fish/guestfish-actions.pod:2502
9687 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
9688 "C<journal>. It is equivalent to the command:"
9692 #: ../src/guestfs-actions.pod:3396 ../fish/guestfish-actions.pod:2506
9695 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
9700 #: ../src/guestfs-actions.pod:3398
9701 msgid "See also C<guestfs_mke2journal>."
9705 #: ../src/guestfs-actions.pod:3402
9706 msgid "guestfs_mke2fs_JL"
9710 #: ../src/guestfs-actions.pod:3404
9714 " guestfs_mke2fs_JL (guestfs_h *g,\n"
9715 " const char *fstype,\n"
9717 " const char *device,\n"
9718 " const char *label);\n"
9723 #: ../src/guestfs-actions.pod:3411 ../fish/guestfish-actions.pod:2514
9725 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
9726 "the journal labeled C<label>."
9730 #: ../src/guestfs-actions.pod:3414
9731 msgid "See also C<guestfs_mke2journal_L>."
9735 #: ../src/guestfs-actions.pod:3418
9736 msgid "guestfs_mke2fs_JU"
9740 #: ../src/guestfs-actions.pod:3420
9744 " guestfs_mke2fs_JU (guestfs_h *g,\n"
9745 " const char *fstype,\n"
9747 " const char *device,\n"
9748 " const char *uuid);\n"
9753 #: ../src/guestfs-actions.pod:3427 ../fish/guestfish-actions.pod:2523
9755 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
9756 "the journal with UUID C<uuid>."
9760 #: ../src/guestfs-actions.pod:3430
9761 msgid "See also C<guestfs_mke2journal_U>."
9765 #: ../src/guestfs-actions.pod:3434
9766 msgid "guestfs_mke2journal"
9770 #: ../src/guestfs-actions.pod:3436
9774 " guestfs_mke2journal (guestfs_h *g,\n"
9776 " const char *device);\n"
9781 #: ../src/guestfs-actions.pod:3441 ../fish/guestfish-actions.pod:2532
9783 "This creates an ext2 external journal on C<device>. It is equivalent to the "
9788 #: ../src/guestfs-actions.pod:3444 ../fish/guestfish-actions.pod:2535
9791 " mke2fs -O journal_dev -b blocksize device\n"
9796 #: ../src/guestfs-actions.pod:3448
9797 msgid "guestfs_mke2journal_L"
9801 #: ../src/guestfs-actions.pod:3450
9805 " guestfs_mke2journal_L (guestfs_h *g,\n"
9807 " const char *label,\n"
9808 " const char *device);\n"
9813 #: ../src/guestfs-actions.pod:3456 ../fish/guestfish-actions.pod:2541
9814 msgid "This creates an ext2 external journal on C<device> with label C<label>."
9818 #: ../src/guestfs-actions.pod:3460
9819 msgid "guestfs_mke2journal_U"
9823 #: ../src/guestfs-actions.pod:3462
9827 " guestfs_mke2journal_U (guestfs_h *g,\n"
9829 " const char *uuid,\n"
9830 " const char *device);\n"
9835 #: ../src/guestfs-actions.pod:3468 ../fish/guestfish-actions.pod:2547
9836 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
9840 #: ../src/guestfs-actions.pod:3472
9841 msgid "guestfs_mkfifo"
9845 #: ../src/guestfs-actions.pod:3474
9849 " guestfs_mkfifo (guestfs_h *g,\n"
9851 " const char *path);\n"
9856 #: ../src/guestfs-actions.pod:3479
9858 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
9859 "is just a convenient wrapper around C<guestfs_mknod>."
9863 #: ../src/guestfs-actions.pod:3487
9864 msgid "guestfs_mkfs"
9868 #: ../src/guestfs-actions.pod:3489
9872 " guestfs_mkfs (guestfs_h *g,\n"
9873 " const char *fstype,\n"
9874 " const char *device);\n"
9879 #: ../src/guestfs-actions.pod:3494 ../fish/guestfish-actions.pod:2563
9881 "This creates a filesystem on C<device> (usually a partition or LVM logical "
9882 "volume). The filesystem type is C<fstype>, for example C<ext3>."
9886 #: ../src/guestfs-actions.pod:3500
9887 msgid "guestfs_mkfs_b"
9891 #: ../src/guestfs-actions.pod:3502
9895 " guestfs_mkfs_b (guestfs_h *g,\n"
9896 " const char *fstype,\n"
9898 " const char *device);\n"
9903 #: ../src/guestfs-actions.pod:3508
9905 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
9906 "block size of the resulting filesystem. Supported block sizes depend on the "
9907 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
9911 #: ../src/guestfs-actions.pod:3513 ../fish/guestfish-actions.pod:2576
9913 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
9918 #: ../src/guestfs-actions.pod:3518
9919 msgid "guestfs_mkmountpoint"
9923 #: ../src/guestfs-actions.pod:3520
9927 " guestfs_mkmountpoint (guestfs_h *g,\n"
9928 " const char *exemptpath);\n"
9933 #: ../src/guestfs-actions.pod:3524
9935 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
9936 "that can be used to create extra mountpoints before mounting the first "
9941 #: ../src/guestfs-actions.pod:3528 ../fish/guestfish-actions.pod:2587
9943 "These calls are I<only> necessary in some very limited circumstances, mainly "
9944 "the case where you want to mount a mix of unrelated and/or read-only "
9945 "filesystems together."
9949 #: ../src/guestfs-actions.pod:3532 ../fish/guestfish-actions.pod:2591
9951 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
9952 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
9953 "inside that. You can unpack this as follows in guestfish:"
9957 #: ../src/guestfs-actions.pod:3537 ../fish/guestfish-actions.pod:2596
9960 " add-ro Fedora-11-i686-Live.iso\n"
9962 " mkmountpoint /cd\n"
9963 " mkmountpoint /sqsh\n"
9964 " mkmountpoint /ext3fs\n"
9965 " mount /dev/sda /cd\n"
9966 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
9967 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
9972 #: ../src/guestfs-actions.pod:3546 ../fish/guestfish-actions.pod:2605
9973 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
9977 #: ../src/guestfs-actions.pod:3548
9979 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
9980 "may get unexpected errors if you try to mix these calls. It is safest to "
9981 "manually unmount filesystems and remove mountpoints after use."
9985 #: ../src/guestfs-actions.pod:3552
9987 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
9988 "first, so for this to work for manual mountpoints, you must ensure that the "
9989 "innermost mountpoints have the longest pathnames, as in the example code "
9994 #: ../src/guestfs-actions.pod:3557 ../fish/guestfish-actions.pod:2616
9995 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
9999 #: ../src/guestfs-actions.pod:3559
10001 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
10002 "means that C<guestfs_umount_all> is called when the handle is closed which "
10003 "can also trigger these issues."
10007 #: ../src/guestfs-actions.pod:3565
10008 msgid "guestfs_mknod"
10012 #: ../src/guestfs-actions.pod:3567
10016 " guestfs_mknod (guestfs_h *g,\n"
10020 " const char *path);\n"
10025 #: ../src/guestfs-actions.pod:3574 ../fish/guestfish-actions.pod:2626
10027 "This call creates block or character special devices, or named pipes "
10032 #: ../src/guestfs-actions.pod:3577 ../fish/guestfish-actions.pod:2629
10034 "The C<mode> parameter should be the mode, using the standard constants. "
10035 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
10036 "used when creating block and character special devices."
10040 #: ../src/guestfs-actions.pod:3582
10042 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
10043 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
10044 "regular file). These constants are available in the standard Linux header "
10045 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
10046 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
10047 "the appropriate constant for you."
10051 #: ../src/guestfs-actions.pod:3594
10052 msgid "guestfs_mknod_b"
10056 #: ../src/guestfs-actions.pod:3596
10060 " guestfs_mknod_b (guestfs_h *g,\n"
10064 " const char *path);\n"
10069 #: ../src/guestfs-actions.pod:3603
10071 "This call creates a block device node called C<path> with mode C<mode> and "
10072 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10073 "wrapper around C<guestfs_mknod>."
10077 #: ../src/guestfs-actions.pod:3611
10078 msgid "guestfs_mknod_c"
10082 #: ../src/guestfs-actions.pod:3613
10086 " guestfs_mknod_c (guestfs_h *g,\n"
10090 " const char *path);\n"
10095 #: ../src/guestfs-actions.pod:3620
10097 "This call creates a char device node called C<path> with mode C<mode> and "
10098 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10099 "wrapper around C<guestfs_mknod>."
10103 #: ../src/guestfs-actions.pod:3628
10104 msgid "guestfs_mkswap"
10108 #: ../src/guestfs-actions.pod:3630
10112 " guestfs_mkswap (guestfs_h *g,\n"
10113 " const char *device);\n"
10118 #: ../src/guestfs-actions.pod:3634 ../fish/guestfish-actions.pod:2668
10119 msgid "Create a swap partition on C<device>."
10123 #: ../src/guestfs-actions.pod:3638
10124 msgid "guestfs_mkswap_L"
10128 #: ../src/guestfs-actions.pod:3640
10132 " guestfs_mkswap_L (guestfs_h *g,\n"
10133 " const char *label,\n"
10134 " const char *device);\n"
10139 #: ../src/guestfs-actions.pod:3645 ../fish/guestfish-actions.pod:2674
10140 msgid "Create a swap partition on C<device> with label C<label>."
10144 #: ../src/guestfs-actions.pod:3647 ../fish/guestfish-actions.pod:2676
10146 "Note that you cannot attach a swap label to a block device "
10147 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
10148 "the kernel or swap tools."
10152 #: ../src/guestfs-actions.pod:3653
10153 msgid "guestfs_mkswap_U"
10157 #: ../src/guestfs-actions.pod:3655
10161 " guestfs_mkswap_U (guestfs_h *g,\n"
10162 " const char *uuid,\n"
10163 " const char *device);\n"
10168 #: ../src/guestfs-actions.pod:3660 ../fish/guestfish-actions.pod:2684
10169 msgid "Create a swap partition on C<device> with UUID C<uuid>."
10173 #: ../src/guestfs-actions.pod:3664
10174 msgid "guestfs_mkswap_file"
10178 #: ../src/guestfs-actions.pod:3666
10182 " guestfs_mkswap_file (guestfs_h *g,\n"
10183 " const char *path);\n"
10188 #: ../src/guestfs-actions.pod:3670 ../fish/guestfish-actions.pod:2690
10189 msgid "Create a swap file."
10193 #: ../src/guestfs-actions.pod:3672
10195 "This command just writes a swap file signature to an existing file. To "
10196 "create the file itself, use something like C<guestfs_fallocate>."
10200 #: ../src/guestfs-actions.pod:3677
10201 msgid "guestfs_modprobe"
10205 #: ../src/guestfs-actions.pod:3679
10209 " guestfs_modprobe (guestfs_h *g,\n"
10210 " const char *modulename);\n"
10215 #: ../src/guestfs-actions.pod:3683 ../fish/guestfish-actions.pod:2699
10216 msgid "This loads a kernel module in the appliance."
10220 #: ../src/guestfs-actions.pod:3685 ../fish/guestfish-actions.pod:2701
10222 "The kernel module must have been whitelisted when libguestfs was built (see "
10223 "C<appliance/kmod.whitelist.in> in the source)."
10227 #: ../src/guestfs-actions.pod:3690
10228 msgid "guestfs_mount"
10232 #: ../src/guestfs-actions.pod:3692
10236 " guestfs_mount (guestfs_h *g,\n"
10237 " const char *device,\n"
10238 " const char *mountpoint);\n"
10243 #: ../src/guestfs-actions.pod:3697 ../fish/guestfish-actions.pod:2708
10245 "Mount a guest disk at a position in the filesystem. Block devices are named "
10246 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
10247 "those block devices contain partitions, they will have the usual names "
10248 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
10252 #: ../src/guestfs-actions.pod:3703 ../fish/guestfish-actions.pod:2714
10254 "The rules are the same as for L<mount(2)>: A filesystem must first be "
10255 "mounted on C</> before others can be mounted. Other filesystems can only be "
10256 "mounted on directories which already exist."
10260 #: ../src/guestfs-actions.pod:3708 ../fish/guestfish-actions.pod:2719
10262 "The mounted filesystem is writable, if we have sufficient permissions on the "
10263 "underlying device."
10267 #: ../src/guestfs-actions.pod:3711
10269 "B<Important note:> When you use this call, the filesystem options C<sync> "
10270 "and C<noatime> are set implicitly. This was originally done because we "
10271 "thought it would improve reliability, but it turns out that I<-o sync> has a "
10272 "very large negative performance impact and negligible effect on "
10273 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
10274 "in any code that needs performance, and instead use C<guestfs_mount_options> "
10275 "(use an empty string for the first parameter if you don't want any options)."
10279 #: ../src/guestfs-actions.pod:3723
10280 msgid "guestfs_mount_loop"
10284 #: ../src/guestfs-actions.pod:3725
10288 " guestfs_mount_loop (guestfs_h *g,\n"
10289 " const char *file,\n"
10290 " const char *mountpoint);\n"
10295 #: ../src/guestfs-actions.pod:3730 ../fish/guestfish-actions.pod:2736
10297 "This command lets you mount C<file> (a filesystem image in a file) on a "
10298 "mount point. It is entirely equivalent to the command C<mount -o loop file "
10303 #: ../src/guestfs-actions.pod:3736
10304 msgid "guestfs_mount_options"
10308 #: ../src/guestfs-actions.pod:3738
10312 " guestfs_mount_options (guestfs_h *g,\n"
10313 " const char *options,\n"
10314 " const char *device,\n"
10315 " const char *mountpoint);\n"
10320 #: ../src/guestfs-actions.pod:3744
10322 "This is the same as the C<guestfs_mount> command, but it allows you to set "
10323 "the mount options as for the L<mount(8)> I<-o> flag."
10327 #: ../src/guestfs-actions.pod:3748 ../fish/guestfish-actions.pod:2748
10329 "If the C<options> parameter is an empty string, then no options are passed "
10330 "(all options default to whatever the filesystem uses)."
10334 #: ../src/guestfs-actions.pod:3754
10335 msgid "guestfs_mount_ro"
10339 #: ../src/guestfs-actions.pod:3756
10343 " guestfs_mount_ro (guestfs_h *g,\n"
10344 " const char *device,\n"
10345 " const char *mountpoint);\n"
10350 #: ../src/guestfs-actions.pod:3761
10352 "This is the same as the C<guestfs_mount> command, but it mounts the "
10353 "filesystem with the read-only (I<-o ro>) flag."
10357 #: ../src/guestfs-actions.pod:3766
10358 msgid "guestfs_mount_vfs"
10362 #: ../src/guestfs-actions.pod:3768
10366 " guestfs_mount_vfs (guestfs_h *g,\n"
10367 " const char *options,\n"
10368 " const char *vfstype,\n"
10369 " const char *device,\n"
10370 " const char *mountpoint);\n"
10375 #: ../src/guestfs-actions.pod:3775
10377 "This is the same as the C<guestfs_mount> command, but it allows you to set "
10378 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
10383 #: ../src/guestfs-actions.pod:3781
10384 msgid "guestfs_mountpoints"
10388 #: ../src/guestfs-actions.pod:3783
10392 " guestfs_mountpoints (guestfs_h *g);\n"
10397 #: ../src/guestfs-actions.pod:3786
10399 "This call is similar to C<guestfs_mounts>. That call returns a list of "
10400 "devices. This one returns a hash table (map) of device name to directory "
10401 "where the device is mounted."
10405 #: ../src/guestfs-actions.pod:3796
10406 msgid "guestfs_mounts"
10410 #: ../src/guestfs-actions.pod:3798
10414 " guestfs_mounts (guestfs_h *g);\n"
10419 #: ../src/guestfs-actions.pod:3801 ../fish/guestfish-actions.pod:2779
10421 "This returns the list of currently mounted filesystems. It returns the list "
10422 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
10426 #: ../src/guestfs-actions.pod:3804 ../fish/guestfish-actions.pod:2782
10427 msgid "Some internal mounts are not shown."
10431 #: ../src/guestfs-actions.pod:3806
10432 msgid "See also: C<guestfs_mountpoints>"
10436 #: ../src/guestfs-actions.pod:3812
10441 #: ../src/guestfs-actions.pod:3814
10445 " guestfs_mv (guestfs_h *g,\n"
10446 " const char *src,\n"
10447 " const char *dest);\n"
10452 #: ../src/guestfs-actions.pod:3819 ../fish/guestfish-actions.pod:2790
10454 "This moves a file from C<src> to C<dest> where C<dest> is either a "
10455 "destination filename or destination directory."
10459 #: ../src/guestfs-actions.pod:3824
10460 msgid "guestfs_ntfs_3g_probe"
10464 #: ../src/guestfs-actions.pod:3826
10468 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
10470 " const char *device);\n"
10475 #: ../src/guestfs-actions.pod:3831 ../fish/guestfish-actions.pod:2797
10477 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
10478 "C<device> for mountability. (Not all NTFS volumes can be mounted "
10479 "read-write, and some cannot be mounted at all)."
10483 #: ../src/guestfs-actions.pod:3835 ../fish/guestfish-actions.pod:2801
10485 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
10486 "can be mounted read-write. Set it to false if you want to test if the "
10487 "volume can be mounted read-only."
10491 #: ../src/guestfs-actions.pod:3839 ../fish/guestfish-actions.pod:2805
10493 "The return value is an integer which C<0> if the operation would succeed, or "
10494 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
10498 #: ../src/guestfs-actions.pod:3845
10499 msgid "guestfs_ntfsresize"
10503 #: ../src/guestfs-actions.pod:3847
10507 " guestfs_ntfsresize (guestfs_h *g,\n"
10508 " const char *device);\n"
10513 #: ../src/guestfs-actions.pod:3851 ../fish/guestfish-actions.pod:2813
10515 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
10516 "size of the underlying device. See also L<ntfsresize(8)>."
10520 #: ../src/guestfs-actions.pod:3857
10521 msgid "guestfs_ntfsresize_size"
10525 #: ../src/guestfs-actions.pod:3859
10529 " guestfs_ntfsresize_size (guestfs_h *g,\n"
10530 " const char *device,\n"
10531 " int64_t size);\n"
10536 #: ../src/guestfs-actions.pod:3864
10538 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
10539 "to specify the new size (in bytes) explicitly."
10543 #: ../src/guestfs-actions.pod:3869
10544 msgid "guestfs_part_add"
10548 #: ../src/guestfs-actions.pod:3871
10552 " guestfs_part_add (guestfs_h *g,\n"
10553 " const char *device,\n"
10554 " const char *prlogex,\n"
10555 " int64_t startsect,\n"
10556 " int64_t endsect);\n"
10561 #: ../src/guestfs-actions.pod:3878
10563 "This command adds a partition to C<device>. If there is no partition table "
10564 "on the device, call C<guestfs_part_init> first."
10568 #: ../src/guestfs-actions.pod:3881 ../fish/guestfish-actions.pod:2831
10570 "The C<prlogex> parameter is the type of partition. Normally you should pass "
10571 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
10572 "C<logical>) and C<e> (or C<extended>) partition types."
10576 #: ../src/guestfs-actions.pod:3886 ../fish/guestfish-actions.pod:2836
10578 "C<startsect> and C<endsect> are the start and end of the partition in "
10579 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
10580 "from the end of the disk (C<-1> is the last sector)."
10584 #: ../src/guestfs-actions.pod:3890
10586 "Creating a partition which covers the whole disk is not so easy. Use "
10587 "C<guestfs_part_disk> to do that."
10591 #: ../src/guestfs-actions.pod:3895
10592 msgid "guestfs_part_del"
10596 #: ../src/guestfs-actions.pod:3897
10600 " guestfs_part_del (guestfs_h *g,\n"
10601 " const char *device,\n"
10607 #: ../src/guestfs-actions.pod:3902 ../fish/guestfish-actions.pod:2847
10608 msgid "This command deletes the partition numbered C<partnum> on C<device>."
10612 #: ../src/guestfs-actions.pod:3904 ../fish/guestfish-actions.pod:2849
10614 "Note that in the case of MBR partitioning, deleting an extended partition "
10615 "also deletes any logical partitions it contains."
10619 #: ../src/guestfs-actions.pod:3910
10620 msgid "guestfs_part_disk"
10624 #: ../src/guestfs-actions.pod:3912
10628 " guestfs_part_disk (guestfs_h *g,\n"
10629 " const char *device,\n"
10630 " const char *parttype);\n"
10635 #: ../src/guestfs-actions.pod:3917
10637 "This command is simply a combination of C<guestfs_part_init> followed by "
10638 "C<guestfs_part_add> to create a single primary partition covering the whole "
10643 #: ../src/guestfs-actions.pod:3921
10645 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
10646 "possible values are described in C<guestfs_part_init>."
10650 #: ../src/guestfs-actions.pod:3929
10651 msgid "guestfs_part_get_bootable"
10655 #: ../src/guestfs-actions.pod:3931
10659 " guestfs_part_get_bootable (guestfs_h *g,\n"
10660 " const char *device,\n"
10666 #: ../src/guestfs-actions.pod:3936 ../fish/guestfish-actions.pod:2871
10668 "This command returns true if the partition C<partnum> on C<device> has the "
10669 "bootable flag set."
10673 #: ../src/guestfs-actions.pod:3939
10674 msgid "See also C<guestfs_part_set_bootable>."
10678 #: ../src/guestfs-actions.pod:3943
10679 msgid "guestfs_part_get_mbr_id"
10683 #: ../src/guestfs-actions.pod:3945
10687 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
10688 " const char *device,\n"
10694 #: ../src/guestfs-actions.pod:3950 ../fish/guestfish-actions.pod:2880
10696 "Returns the MBR type byte (also known as the ID byte) from the numbered "
10697 "partition C<partnum>."
10701 #: ../src/guestfs-actions.pod:3953 ../src/guestfs-actions.pod:4120
10703 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
10704 "undefined results for other partition table types (see "
10705 "C<guestfs_part_get_parttype>)."
10709 #: ../src/guestfs-actions.pod:3959
10710 msgid "guestfs_part_get_parttype"
10714 #: ../src/guestfs-actions.pod:3961
10718 " guestfs_part_get_parttype (guestfs_h *g,\n"
10719 " const char *device);\n"
10724 #: ../src/guestfs-actions.pod:3965 ../fish/guestfish-actions.pod:2891
10726 "This command examines the partition table on C<device> and returns the "
10727 "partition table type (format) being used."
10731 #: ../src/guestfs-actions.pod:3968
10733 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
10734 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
10735 "possible, although unusual. See C<guestfs_part_init> for a full list."
10739 #: ../src/guestfs-actions.pod:3976
10740 msgid "guestfs_part_init"
10744 #: ../src/guestfs-actions.pod:3978
10748 " guestfs_part_init (guestfs_h *g,\n"
10749 " const char *device,\n"
10750 " const char *parttype);\n"
10755 #: ../src/guestfs-actions.pod:3983 ../fish/guestfish-actions.pod:2903
10757 "This creates an empty partition table on C<device> of one of the partition "
10758 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
10759 "(for large disks)."
10763 #: ../src/guestfs-actions.pod:3987
10765 "Initially there are no partitions. Following this, you should call "
10766 "C<guestfs_part_add> for each partition required."
10770 #: ../src/guestfs-actions.pod:3990 ../fish/guestfish-actions.pod:2910
10771 msgid "Possible values for C<parttype> are:"
10775 #: ../src/guestfs-actions.pod:3994 ../fish/guestfish-actions.pod:2914
10776 msgid "B<efi> | B<gpt>"
10780 #: ../src/guestfs-actions.pod:3996 ../fish/guestfish-actions.pod:2916
10781 msgid "Intel EFI / GPT partition table."
10785 #: ../src/guestfs-actions.pod:3998 ../fish/guestfish-actions.pod:2918
10787 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
10788 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
10789 "the C<mbr> format."
10793 #: ../src/guestfs-actions.pod:4002 ../fish/guestfish-actions.pod:2922
10794 msgid "B<mbr> | B<msdos>"
10798 #: ../src/guestfs-actions.pod:4004 ../fish/guestfish-actions.pod:2924
10800 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
10801 "Windows. This partition type will B<only> work for device sizes up to 2 "
10802 "TB. For large disks we recommend using C<gpt>."
10806 #: ../src/guestfs-actions.pod:4011 ../fish/guestfish-actions.pod:2931
10807 msgid "Other partition table types that may work but are not supported include:"
10811 #: ../src/guestfs-actions.pod:4016 ../fish/guestfish-actions.pod:2936
10816 #: ../src/guestfs-actions.pod:4018 ../fish/guestfish-actions.pod:2938
10817 msgid "AIX disk labels."
10821 #: ../src/guestfs-actions.pod:4020 ../fish/guestfish-actions.pod:2940
10822 msgid "B<amiga> | B<rdb>"
10826 #: ../src/guestfs-actions.pod:4022 ../fish/guestfish-actions.pod:2942
10827 msgid "Amiga \"Rigid Disk Block\" format."
10831 #: ../src/guestfs-actions.pod:4024 ../fish/guestfish-actions.pod:2944
10836 #: ../src/guestfs-actions.pod:4026 ../fish/guestfish-actions.pod:2946
10837 msgid "BSD disk labels."
10841 #: ../src/guestfs-actions.pod:4028 ../fish/guestfish-actions.pod:2948
10846 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:2950
10847 msgid "DASD, used on IBM mainframes."
10851 #: ../src/guestfs-actions.pod:4032 ../fish/guestfish-actions.pod:2952
10856 #: ../src/guestfs-actions.pod:4034 ../fish/guestfish-actions.pod:2954
10857 msgid "MIPS/SGI volumes."
10861 #: ../src/guestfs-actions.pod:4036 ../fish/guestfish-actions.pod:2956
10866 #: ../src/guestfs-actions.pod:4038 ../fish/guestfish-actions.pod:2958
10867 msgid "Old Mac partition format. Modern Macs use C<gpt>."
10871 #: ../src/guestfs-actions.pod:4040 ../fish/guestfish-actions.pod:2960
10876 #: ../src/guestfs-actions.pod:4042 ../fish/guestfish-actions.pod:2962
10877 msgid "NEC PC-98 format, common in Japan apparently."
10881 #: ../src/guestfs-actions.pod:4044 ../fish/guestfish-actions.pod:2964
10886 #: ../src/guestfs-actions.pod:4046 ../fish/guestfish-actions.pod:2966
10887 msgid "Sun disk labels."
10891 #: ../src/guestfs-actions.pod:4052
10892 msgid "guestfs_part_list"
10896 #: ../src/guestfs-actions.pod:4054
10899 " struct guestfs_partition_list *\n"
10900 " guestfs_part_list (guestfs_h *g,\n"
10901 " const char *device);\n"
10906 #: ../src/guestfs-actions.pod:4058 ../fish/guestfish-actions.pod:2974
10908 "This command parses the partition table on C<device> and returns the list of "
10909 "partitions found."
10913 #: ../src/guestfs-actions.pod:4061 ../fish/guestfish-actions.pod:2977
10914 msgid "The fields in the returned structure are:"
10918 #: ../src/guestfs-actions.pod:4065 ../fish/guestfish-actions.pod:2981
10919 msgid "B<part_num>"
10923 #: ../src/guestfs-actions.pod:4067 ../fish/guestfish-actions.pod:2983
10924 msgid "Partition number, counting from 1."
10928 #: ../src/guestfs-actions.pod:4069 ../fish/guestfish-actions.pod:2985
10929 msgid "B<part_start>"
10933 #: ../src/guestfs-actions.pod:4071
10935 "Start of the partition I<in bytes>. To get sectors you have to divide by "
10936 "the device's sector size, see C<guestfs_blockdev_getss>."
10940 #: ../src/guestfs-actions.pod:4074 ../fish/guestfish-actions.pod:2990
10941 msgid "B<part_end>"
10945 #: ../src/guestfs-actions.pod:4076 ../fish/guestfish-actions.pod:2992
10946 msgid "End of the partition in bytes."
10950 #: ../src/guestfs-actions.pod:4078 ../fish/guestfish-actions.pod:2994
10951 msgid "B<part_size>"
10955 #: ../src/guestfs-actions.pod:4080 ../fish/guestfish-actions.pod:2996
10956 msgid "Size of the partition in bytes."
10960 #: ../src/guestfs-actions.pod:4084
10962 "This function returns a C<struct guestfs_partition_list *> (see "
10963 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
10964 "must call C<guestfs_free_partition_list> after use>."
10968 #: ../src/guestfs-actions.pod:4089
10969 msgid "guestfs_part_set_bootable"
10973 #: ../src/guestfs-actions.pod:4091
10977 " guestfs_part_set_bootable (guestfs_h *g,\n"
10978 " const char *device,\n"
10980 " int bootable);\n"
10985 #: ../src/guestfs-actions.pod:4097 ../fish/guestfish-actions.pod:3004
10987 "This sets the bootable flag on partition numbered C<partnum> on device "
10988 "C<device>. Note that partitions are numbered from 1."
10992 #: ../src/guestfs-actions.pod:4100 ../fish/guestfish-actions.pod:3007
10994 "The bootable flag is used by some operating systems (notably Windows) to "
10995 "determine which partition to boot from. It is by no means universally "
11000 #: ../src/guestfs-actions.pod:4106
11001 msgid "guestfs_part_set_mbr_id"
11005 #: ../src/guestfs-actions.pod:4108
11009 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
11010 " const char *device,\n"
11017 #: ../src/guestfs-actions.pod:4114 ../fish/guestfish-actions.pod:3015
11019 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
11020 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
11021 "documentation are in fact hexadecimal numbers, but usually documented "
11022 "without any leading \"0x\" which might be confusing."
11026 #: ../src/guestfs-actions.pod:4126
11027 msgid "guestfs_part_set_name"
11031 #: ../src/guestfs-actions.pod:4128
11035 " guestfs_part_set_name (guestfs_h *g,\n"
11036 " const char *device,\n"
11038 " const char *name);\n"
11043 #: ../src/guestfs-actions.pod:4134 ../fish/guestfish-actions.pod:3029
11045 "This sets the partition name on partition numbered C<partnum> on device "
11046 "C<device>. Note that partitions are numbered from 1."
11050 #: ../src/guestfs-actions.pod:4137 ../fish/guestfish-actions.pod:3032
11052 "The partition name can only be set on certain types of partition table. "
11053 "This works on C<gpt> but not on C<mbr> partitions."
11057 #: ../src/guestfs-actions.pod:4142
11058 msgid "guestfs_part_to_dev"
11062 #: ../src/guestfs-actions.pod:4144
11066 " guestfs_part_to_dev (guestfs_h *g,\n"
11067 " const char *partition);\n"
11072 #: ../src/guestfs-actions.pod:4148 ../fish/guestfish-actions.pod:3039
11074 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
11075 "partition number, returning the device name (eg. \"/dev/sdb\")."
11079 #: ../src/guestfs-actions.pod:4152
11081 "The named partition must exist, for example as a string returned from "
11082 "C<guestfs_list_partitions>."
11086 #: ../src/guestfs-actions.pod:4158
11087 msgid "guestfs_ping_daemon"
11091 #: ../src/guestfs-actions.pod:4160
11095 " guestfs_ping_daemon (guestfs_h *g);\n"
11100 #: ../src/guestfs-actions.pod:4163 ../fish/guestfish-actions.pod:3050
11102 "This is a test probe into the guestfs daemon running inside the qemu "
11103 "subprocess. Calling this function checks that the daemon responds to the "
11104 "ping message, without affecting the daemon or attached block device(s) in "
11109 #: ../src/guestfs-actions.pod:4170
11110 msgid "guestfs_pread"
11114 #: ../src/guestfs-actions.pod:4172
11118 " guestfs_pread (guestfs_h *g,\n"
11119 " const char *path,\n"
11121 " int64_t offset,\n"
11122 " size_t *size_r);\n"
11127 #: ../src/guestfs-actions.pod:4179 ../fish/guestfish-actions.pod:3059
11129 "This command lets you read part of a file. It reads C<count> bytes of the "
11130 "file, starting at C<offset>, from file C<path>."
11134 #: ../src/guestfs-actions.pod:4182 ../src/guestfs-actions.pod:4206 ../fish/guestfish-actions.pod:3062 ../fish/guestfish-actions.pod:3077
11136 "This may read fewer bytes than requested. For further details see the "
11137 "L<pread(2)> system call."
11141 #: ../src/guestfs-actions.pod:4185
11142 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
11146 #: ../src/guestfs-actions.pod:4194
11147 msgid "guestfs_pread_device"
11151 #: ../src/guestfs-actions.pod:4196
11155 " guestfs_pread_device (guestfs_h *g,\n"
11156 " const char *device,\n"
11158 " int64_t offset,\n"
11159 " size_t *size_r);\n"
11164 #: ../src/guestfs-actions.pod:4203 ../fish/guestfish-actions.pod:3074
11166 "This command lets you read part of a file. It reads C<count> bytes of "
11167 "C<device>, starting at C<offset>."
11171 #: ../src/guestfs-actions.pod:4209
11172 msgid "See also C<guestfs_pread>."
11176 #: ../src/guestfs-actions.pod:4218
11177 msgid "guestfs_pvcreate"
11181 #: ../src/guestfs-actions.pod:4220
11185 " guestfs_pvcreate (guestfs_h *g,\n"
11186 " const char *device);\n"
11191 #: ../src/guestfs-actions.pod:4224 ../fish/guestfish-actions.pod:3089
11193 "This creates an LVM physical volume on the named C<device>, where C<device> "
11194 "should usually be a partition name such as C</dev/sda1>."
11198 #: ../src/guestfs-actions.pod:4230
11199 msgid "guestfs_pvremove"
11203 #: ../src/guestfs-actions.pod:4232
11207 " guestfs_pvremove (guestfs_h *g,\n"
11208 " const char *device);\n"
11213 #: ../src/guestfs-actions.pod:4236 ../fish/guestfish-actions.pod:3097
11215 "This wipes a physical volume C<device> so that LVM will no longer recognise "
11220 #: ../src/guestfs-actions.pod:4239 ../fish/guestfish-actions.pod:3100
11222 "The implementation uses the C<pvremove> command which refuses to wipe "
11223 "physical volumes that contain any volume groups, so you have to remove those "
11228 #: ../src/guestfs-actions.pod:4245
11229 msgid "guestfs_pvresize"
11233 #: ../src/guestfs-actions.pod:4247
11237 " guestfs_pvresize (guestfs_h *g,\n"
11238 " const char *device);\n"
11243 #: ../src/guestfs-actions.pod:4251 ../fish/guestfish-actions.pod:3108
11245 "This resizes (expands or shrinks) an existing LVM physical volume to match "
11246 "the new size of the underlying device."
11250 #: ../src/guestfs-actions.pod:4256
11251 msgid "guestfs_pvresize_size"
11255 #: ../src/guestfs-actions.pod:4258
11259 " guestfs_pvresize_size (guestfs_h *g,\n"
11260 " const char *device,\n"
11261 " int64_t size);\n"
11266 #: ../src/guestfs-actions.pod:4263
11268 "This command is the same as C<guestfs_pvresize> except that it allows you to "
11269 "specify the new size (in bytes) explicitly."
11273 #: ../src/guestfs-actions.pod:4268
11274 msgid "guestfs_pvs"
11278 #: ../src/guestfs-actions.pod:4270
11282 " guestfs_pvs (guestfs_h *g);\n"
11287 #: ../src/guestfs-actions.pod:4273 ../fish/guestfish-actions.pod:3122
11289 "List all the physical volumes detected. This is the equivalent of the "
11290 "L<pvs(8)> command."
11294 #: ../src/guestfs-actions.pod:4276 ../fish/guestfish-actions.pod:3125
11296 "This returns a list of just the device names that contain PVs "
11297 "(eg. C</dev/sda2>)."
11301 #: ../src/guestfs-actions.pod:4279
11302 msgid "See also C<guestfs_pvs_full>."
11306 #: ../src/guestfs-actions.pod:4285
11307 msgid "guestfs_pvs_full"
11311 #: ../src/guestfs-actions.pod:4287
11314 " struct guestfs_lvm_pv_list *\n"
11315 " guestfs_pvs_full (guestfs_h *g);\n"
11320 #: ../src/guestfs-actions.pod:4290 ../fish/guestfish-actions.pod:3134
11322 "List all the physical volumes detected. This is the equivalent of the "
11323 "L<pvs(8)> command. The \"full\" version includes all fields."
11327 #: ../src/guestfs-actions.pod:4293
11329 "This function returns a C<struct guestfs_lvm_pv_list *> (see "
11330 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
11331 "must call C<guestfs_free_lvm_pv_list> after use>."
11335 #: ../src/guestfs-actions.pod:4298
11336 msgid "guestfs_pvuuid"
11340 #: ../src/guestfs-actions.pod:4300
11344 " guestfs_pvuuid (guestfs_h *g,\n"
11345 " const char *device);\n"
11350 #: ../src/guestfs-actions.pod:4304 ../fish/guestfish-actions.pod:3141
11351 msgid "This command returns the UUID of the LVM PV C<device>."
11355 #: ../src/guestfs-actions.pod:4309
11356 msgid "guestfs_pwrite"
11360 #: ../src/guestfs-actions.pod:4311
11364 " guestfs_pwrite (guestfs_h *g,\n"
11365 " const char *path,\n"
11366 " const char *content,\n"
11367 " size_t content_size,\n"
11368 " int64_t offset);\n"
11373 #: ../src/guestfs-actions.pod:4318 ../fish/guestfish-actions.pod:3147
11375 "This command writes to part of a file. It writes the data buffer C<content> "
11376 "to the file C<path> starting at offset C<offset>."
11380 #: ../src/guestfs-actions.pod:4321 ../fish/guestfish-actions.pod:3150
11382 "This command implements the L<pwrite(2)> system call, and like that system "
11383 "call it may not write the full data requested. The return value is the "
11384 "number of bytes that were actually written to the file. This could even be "
11385 "0, although short writes are unlikely for regular files in ordinary "
11390 #: ../src/guestfs-actions.pod:4327
11391 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
11395 #: ../src/guestfs-actions.pod:4334
11396 msgid "guestfs_pwrite_device"
11400 #: ../src/guestfs-actions.pod:4336
11404 " guestfs_pwrite_device (guestfs_h *g,\n"
11405 " const char *device,\n"
11406 " const char *content,\n"
11407 " size_t content_size,\n"
11408 " int64_t offset);\n"
11413 #: ../src/guestfs-actions.pod:4343 ../fish/guestfish-actions.pod:3165
11415 "This command writes to part of a device. It writes the data buffer "
11416 "C<content> to C<device> starting at offset C<offset>."
11420 #: ../src/guestfs-actions.pod:4346 ../fish/guestfish-actions.pod:3168
11422 "This command implements the L<pwrite(2)> system call, and like that system "
11423 "call it may not write the full data requested (although short writes to disk "
11424 "devices and partitions are probably impossible with standard Linux kernels)."
11428 #: ../src/guestfs-actions.pod:4351
11429 msgid "See also C<guestfs_pwrite>."
11433 #: ../src/guestfs-actions.pod:4358
11434 msgid "guestfs_read_file"
11438 #: ../src/guestfs-actions.pod:4360
11442 " guestfs_read_file (guestfs_h *g,\n"
11443 " const char *path,\n"
11444 " size_t *size_r);\n"
11449 #: ../src/guestfs-actions.pod:4365 ../fish/guestfish-actions.pod:3182
11450 msgid "This calls returns the contents of the file C<path> as a buffer."
11454 #: ../src/guestfs-actions.pod:4368
11456 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
11457 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
11458 "function is limited in the total size of file that can be handled."
11462 #: ../src/guestfs-actions.pod:4380
11463 msgid "guestfs_read_lines"
11467 #: ../src/guestfs-actions.pod:4382
11471 " guestfs_read_lines (guestfs_h *g,\n"
11472 " const char *path);\n"
11477 #: ../src/guestfs-actions.pod:4388 ../fish/guestfish-actions.pod:3199
11479 "The file contents are returned as a list of lines. Trailing C<LF> and "
11480 "C<CRLF> character sequences are I<not> returned."
11484 #: ../src/guestfs-actions.pod:4391
11486 "Note that this function cannot correctly handle binary files (specifically, "
11487 "files containing C<\\0> character which is treated as end of line). For "
11488 "those you need to use the C<guestfs_read_file> function which has a more "
11489 "complex interface."
11493 #: ../src/guestfs-actions.pod:4400
11494 msgid "guestfs_readdir"
11498 #: ../src/guestfs-actions.pod:4402
11501 " struct guestfs_dirent_list *\n"
11502 " guestfs_readdir (guestfs_h *g,\n"
11503 " const char *dir);\n"
11508 #: ../src/guestfs-actions.pod:4406 ../fish/guestfish-actions.pod:3211
11509 msgid "This returns the list of directory entries in directory C<dir>."
11513 #: ../src/guestfs-actions.pod:4408 ../fish/guestfish-actions.pod:3213
11515 "All entries in the directory are returned, including C<.> and C<..>. The "
11516 "entries are I<not> sorted, but returned in the same order as the underlying "
11521 #: ../src/guestfs-actions.pod:4412 ../fish/guestfish-actions.pod:3217
11523 "Also this call returns basic file type information about each file. The "
11524 "C<ftyp> field will contain one of the following characters:"
11528 #: ../src/guestfs-actions.pod:4417 ../fish/guestfish-actions.pod:3222
11533 #: ../src/guestfs-actions.pod:4419 ../fish/guestfish-actions.pod:3224
11534 msgid "Block special"
11538 #: ../src/guestfs-actions.pod:4421 ../fish/guestfish-actions.pod:3226
11543 #: ../src/guestfs-actions.pod:4423 ../fish/guestfish-actions.pod:3228
11544 msgid "Char special"
11548 #: ../src/guestfs-actions.pod:4425 ../fish/guestfish-actions.pod:3230
11553 #: ../src/guestfs-actions.pod:4427 ../fish/guestfish-actions.pod:3232
11558 #: ../src/guestfs-actions.pod:4429 ../fish/guestfish-actions.pod:3234
11563 #: ../src/guestfs-actions.pod:4431 ../fish/guestfish-actions.pod:3236
11564 msgid "FIFO (named pipe)"
11568 #: ../src/guestfs-actions.pod:4433 ../fish/guestfish-actions.pod:3238
11573 #: ../src/guestfs-actions.pod:4435 ../fish/guestfish-actions.pod:3240
11574 msgid "Symbolic link"
11578 #: ../src/guestfs-actions.pod:4437 ../fish/guestfish-actions.pod:3242
11583 #: ../src/guestfs-actions.pod:4439 ../fish/guestfish-actions.pod:3244
11584 msgid "Regular file"
11588 #: ../src/guestfs-actions.pod:4441 ../fish/guestfish-actions.pod:3246
11593 #: ../src/guestfs-actions.pod:4443 ../fish/guestfish-actions.pod:3248
11598 #: ../src/guestfs-actions.pod:4445 ../fish/guestfish-actions.pod:3250
11603 #: ../src/guestfs-actions.pod:4447 ../fish/guestfish-actions.pod:3252
11604 msgid "Unknown file type"
11608 #: ../src/guestfs-actions.pod:4449 ../fish/guestfish-actions.pod:3254
11613 #: ../src/guestfs-actions.pod:4451 ../fish/guestfish-actions.pod:3256
11614 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
11618 #: ../src/guestfs-actions.pod:4456
11620 "This function is primarily intended for use by programs. To get a simple "
11621 "list of names, use C<guestfs_ls>. To get a printable directory for human "
11622 "consumption, use C<guestfs_ll>."
11626 #: ../src/guestfs-actions.pod:4460
11628 "This function returns a C<struct guestfs_dirent_list *> (see "
11629 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
11630 "must call C<guestfs_free_dirent_list> after use>."
11634 #: ../src/guestfs-actions.pod:4465
11635 msgid "guestfs_readlink"
11639 #: ../src/guestfs-actions.pod:4467
11643 " guestfs_readlink (guestfs_h *g,\n"
11644 " const char *path);\n"
11649 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3269
11650 msgid "This command reads the target of a symbolic link."
11654 #: ../src/guestfs-actions.pod:4476
11655 msgid "guestfs_readlinklist"
11659 #: ../src/guestfs-actions.pod:4478
11663 " guestfs_readlinklist (guestfs_h *g,\n"
11664 " const char *path,\n"
11665 " char *const *names);\n"
11670 #: ../src/guestfs-actions.pod:4483 ../fish/guestfish-actions.pod:3275
11672 "This call allows you to do a C<readlink> operation on multiple files, where "
11673 "all files are in the directory C<path>. C<names> is the list of files from "
11678 #: ../src/guestfs-actions.pod:4487 ../fish/guestfish-actions.pod:3279
11680 "On return you get a list of strings, with a one-to-one correspondence to the "
11681 "C<names> list. Each string is the value of the symbolic link."
11685 #: ../src/guestfs-actions.pod:4491 ../fish/guestfish-actions.pod:3283
11687 "If the C<readlink(2)> operation fails on any name, then the corresponding "
11688 "result string is the empty string C<\"\">. However the whole operation is "
11689 "completed even if there were C<readlink(2)> errors, and so you can call this "
11690 "function with names where you don't know if they are symbolic links already "
11691 "(albeit slightly less efficient)."
11695 #: ../src/guestfs-actions.pod:4498 ../fish/guestfish-actions.pod:3290
11697 "This call is intended for programs that want to efficiently list a directory "
11698 "contents without making many round-trips. Very long directory listings "
11699 "might cause the protocol message size to be exceeded, causing this call to "
11700 "fail. The caller must split up such requests into smaller groups of names."
11704 #: ../src/guestfs-actions.pod:4509
11705 msgid "guestfs_realpath"
11709 #: ../src/guestfs-actions.pod:4511
11713 " guestfs_realpath (guestfs_h *g,\n"
11714 " const char *path);\n"
11719 #: ../src/guestfs-actions.pod:4515 ../fish/guestfish-actions.pod:3301
11721 "Return the canonicalized absolute pathname of C<path>. The returned path "
11722 "has no C<.>, C<..> or symbolic link path elements."
11726 #: ../src/guestfs-actions.pod:4521
11727 msgid "guestfs_removexattr"
11731 #: ../src/guestfs-actions.pod:4523
11735 " guestfs_removexattr (guestfs_h *g,\n"
11736 " const char *xattr,\n"
11737 " const char *path);\n"
11742 #: ../src/guestfs-actions.pod:4528 ../fish/guestfish-actions.pod:3308
11743 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
11747 #: ../src/guestfs-actions.pod:4531
11748 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
11752 #: ../src/guestfs-actions.pod:4535
11753 msgid "guestfs_resize2fs"
11757 #: ../src/guestfs-actions.pod:4537
11761 " guestfs_resize2fs (guestfs_h *g,\n"
11762 " const char *device);\n"
11767 #: ../src/guestfs-actions.pod:4541 ../fish/guestfish-actions.pod:3317
11769 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
11770 "underlying device."
11774 #: ../src/guestfs-actions.pod:4544
11776 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
11777 "C<device> before calling this command. For unknown reasons C<resize2fs> "
11778 "sometimes gives an error about this and sometimes not. In any case, it is "
11779 "always safe to call C<guestfs_e2fsck_f> before calling this function."
11783 #: ../src/guestfs-actions.pod:4552
11784 msgid "guestfs_resize2fs_size"
11788 #: ../src/guestfs-actions.pod:4554
11792 " guestfs_resize2fs_size (guestfs_h *g,\n"
11793 " const char *device,\n"
11794 " int64_t size);\n"
11799 #: ../src/guestfs-actions.pod:4559
11801 "This command is the same as C<guestfs_resize2fs> except that it allows you "
11802 "to specify the new size (in bytes) explicitly."
11806 #: ../src/guestfs-actions.pod:4564
11811 #: ../src/guestfs-actions.pod:4566
11815 " guestfs_rm (guestfs_h *g,\n"
11816 " const char *path);\n"
11821 #: ../src/guestfs-actions.pod:4570 ../fish/guestfish-actions.pod:3337
11822 msgid "Remove the single file C<path>."
11826 #: ../src/guestfs-actions.pod:4574
11827 msgid "guestfs_rm_rf"
11831 #: ../src/guestfs-actions.pod:4576
11835 " guestfs_rm_rf (guestfs_h *g,\n"
11836 " const char *path);\n"
11841 #: ../src/guestfs-actions.pod:4580 ../fish/guestfish-actions.pod:3343
11843 "Remove the file or directory C<path>, recursively removing the contents if "
11844 "its a directory. This is like the C<rm -rf> shell command."
11848 #: ../src/guestfs-actions.pod:4586
11849 msgid "guestfs_rmdir"
11853 #: ../src/guestfs-actions.pod:4588
11857 " guestfs_rmdir (guestfs_h *g,\n"
11858 " const char *path);\n"
11863 #: ../src/guestfs-actions.pod:4592 ../fish/guestfish-actions.pod:3351
11864 msgid "Remove the single directory C<path>."
11868 #: ../src/guestfs-actions.pod:4596
11869 msgid "guestfs_rmmountpoint"
11873 #: ../src/guestfs-actions.pod:4598
11877 " guestfs_rmmountpoint (guestfs_h *g,\n"
11878 " const char *exemptpath);\n"
11883 #: ../src/guestfs-actions.pod:4602
11885 "This calls removes a mountpoint that was previously created with "
11886 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
11890 #: ../src/guestfs-actions.pod:4608
11891 msgid "guestfs_scrub_device"
11895 #: ../src/guestfs-actions.pod:4610
11899 " guestfs_scrub_device (guestfs_h *g,\n"
11900 " const char *device);\n"
11905 #: ../src/guestfs-actions.pod:4614 ../fish/guestfish-actions.pod:3365
11907 "This command writes patterns over C<device> to make data retrieval more "
11912 #: ../src/guestfs-actions.pod:4617 ../src/guestfs-actions.pod:4636 ../src/guestfs-actions.pod:4653 ../fish/guestfish-actions.pod:3368 ../fish/guestfish-actions.pod:3383 ../fish/guestfish-actions.pod:3396
11914 "It is an interface to the L<scrub(1)> program. See that manual page for "
11919 #: ../src/guestfs-actions.pod:4625
11920 msgid "guestfs_scrub_file"
11924 #: ../src/guestfs-actions.pod:4627
11928 " guestfs_scrub_file (guestfs_h *g,\n"
11929 " const char *file);\n"
11934 #: ../src/guestfs-actions.pod:4631 ../fish/guestfish-actions.pod:3378
11936 "This command writes patterns over a file to make data retrieval more "
11941 #: ../src/guestfs-actions.pod:4634 ../fish/guestfish-actions.pod:3381
11942 msgid "The file is I<removed> after scrubbing."
11946 #: ../src/guestfs-actions.pod:4641
11947 msgid "guestfs_scrub_freespace"
11951 #: ../src/guestfs-actions.pod:4643
11955 " guestfs_scrub_freespace (guestfs_h *g,\n"
11956 " const char *dir);\n"
11961 #: ../src/guestfs-actions.pod:4647
11963 "This command creates the directory C<dir> and then fills it with files until "
11964 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
11965 "and deletes them. The intention is to scrub any free space on the partition "
11966 "containing C<dir>."
11970 #: ../src/guestfs-actions.pod:4658
11971 msgid "guestfs_set_append"
11975 #: ../src/guestfs-actions.pod:4660
11979 " guestfs_set_append (guestfs_h *g,\n"
11980 " const char *append);\n"
11985 #: ../src/guestfs-actions.pod:4664 ../fish/guestfish-actions.pod:3405
11987 "This function is used to add additional options to the guest kernel command "
11992 #: ../src/guestfs-actions.pod:4667 ../fish/guestfish-actions.pod:3408
11994 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
11995 "environment variable."
11999 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3411
12001 "Setting C<append> to C<NULL> means I<no> additional options are passed "
12002 "(libguestfs always adds a few of its own)."
12006 #: ../src/guestfs-actions.pod:4675
12007 msgid "guestfs_set_autosync"
12011 #: ../src/guestfs-actions.pod:4677
12015 " guestfs_set_autosync (guestfs_h *g,\n"
12016 " int autosync);\n"
12021 #: ../src/guestfs-actions.pod:4681
12023 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
12024 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
12025 "the handle is closed (also if the program exits without closing handles)."
12029 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3425
12031 "This is enabled by default (since libguestfs 1.5.24, previously it was "
12032 "disabled by default)."
12036 #: ../src/guestfs-actions.pod:4691
12037 msgid "guestfs_set_direct"
12041 #: ../src/guestfs-actions.pod:4693
12045 " guestfs_set_direct (guestfs_h *g,\n"
12051 #: ../src/guestfs-actions.pod:4697 ../fish/guestfish-actions.pod:3434
12053 "If the direct appliance mode flag is enabled, then stdin and stdout are "
12054 "passed directly through to the appliance once it is launched."
12058 #: ../src/guestfs-actions.pod:4701
12060 "One consequence of this is that log messages aren't caught by the library "
12061 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
12066 #: ../src/guestfs-actions.pod:4705 ../fish/guestfish-actions.pod:3442
12067 msgid "You probably don't want to use this unless you know what you are doing."
12071 #: ../src/guestfs-actions.pod:4708 ../fish/guestfish-actions.pod:3445
12072 msgid "The default is disabled."
12076 #: ../src/guestfs-actions.pod:4712
12077 msgid "guestfs_set_e2label"
12081 #: ../src/guestfs-actions.pod:4714
12085 " guestfs_set_e2label (guestfs_h *g,\n"
12086 " const char *device,\n"
12087 " const char *label);\n"
12092 #: ../src/guestfs-actions.pod:4719 ../fish/guestfish-actions.pod:3451
12094 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
12095 "C<label>. Filesystem labels are limited to 16 characters."
12099 #: ../src/guestfs-actions.pod:4723
12101 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
12102 "the existing label on a filesystem."
12106 #: ../src/guestfs-actions.pod:4728
12107 msgid "guestfs_set_e2uuid"
12111 #: ../src/guestfs-actions.pod:4730
12115 " guestfs_set_e2uuid (guestfs_h *g,\n"
12116 " const char *device,\n"
12117 " const char *uuid);\n"
12122 #: ../src/guestfs-actions.pod:4735 ../fish/guestfish-actions.pod:3462
12124 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
12125 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
12126 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
12130 #: ../src/guestfs-actions.pod:4740
12132 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
12133 "the existing UUID of a filesystem."
12137 #: ../src/guestfs-actions.pod:4745
12138 msgid "guestfs_set_memsize"
12142 #: ../src/guestfs-actions.pod:4747
12146 " guestfs_set_memsize (guestfs_h *g,\n"
12152 #: ../src/guestfs-actions.pod:4751
12154 "This sets the memory size in megabytes allocated to the qemu subprocess. "
12155 "This only has any effect if called before C<guestfs_launch>."
12159 #: ../src/guestfs-actions.pod:4755 ../fish/guestfish-actions.pod:3480
12161 "You can also change this by setting the environment variable "
12162 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
12166 #: ../src/guestfs-actions.pod:4764
12167 msgid "guestfs_set_network"
12171 #: ../src/guestfs-actions.pod:4766
12175 " guestfs_set_network (guestfs_h *g,\n"
12181 #: ../src/guestfs-actions.pod:4770 ../fish/guestfish-actions.pod:3493
12183 "If C<network> is true, then the network is enabled in the libguestfs "
12184 "appliance. The default is false."
12188 #: ../src/guestfs-actions.pod:4773 ../fish/guestfish-actions.pod:3496
12190 "This affects whether commands are able to access the network (see "
12191 "L<guestfs(3)/RUNNING COMMANDS>)."
12195 #: ../src/guestfs-actions.pod:4776
12197 "You must call this before calling C<guestfs_launch>, otherwise it has no "
12202 #: ../src/guestfs-actions.pod:4781
12203 msgid "guestfs_set_path"
12207 #: ../src/guestfs-actions.pod:4783
12211 " guestfs_set_path (guestfs_h *g,\n"
12212 " const char *searchpath);\n"
12217 #: ../src/guestfs-actions.pod:4787 ../fish/guestfish-actions.pod:3508
12218 msgid "Set the path that libguestfs searches for kernel and initrd.img."
12222 #: ../src/guestfs-actions.pod:4789 ../fish/guestfish-actions.pod:3510
12224 "The default is C<$libdir/guestfs> unless overridden by setting "
12225 "C<LIBGUESTFS_PATH> environment variable."
12229 #: ../src/guestfs-actions.pod:4792 ../fish/guestfish-actions.pod:3513
12230 msgid "Setting C<path> to C<NULL> restores the default path."
12234 #: ../src/guestfs-actions.pod:4796
12235 msgid "guestfs_set_qemu"
12239 #: ../src/guestfs-actions.pod:4798
12243 " guestfs_set_qemu (guestfs_h *g,\n"
12244 " const char *qemu);\n"
12249 #: ../src/guestfs-actions.pod:4802 ../fish/guestfish-actions.pod:3521
12250 msgid "Set the qemu binary that we will use."
12254 #: ../src/guestfs-actions.pod:4804 ../fish/guestfish-actions.pod:3523
12255 msgid "The default is chosen when the library was compiled by the configure script."
12259 #: ../src/guestfs-actions.pod:4807 ../fish/guestfish-actions.pod:3526
12261 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
12266 #: ../src/guestfs-actions.pod:4810 ../fish/guestfish-actions.pod:3529
12267 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
12271 #: ../src/guestfs-actions.pod:4812 ../fish/guestfish-actions.pod:3531
12273 "Note that you should call this function as early as possible after creating "
12274 "the handle. This is because some pre-launch operations depend on testing "
12275 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
12276 "don't retest features, and so you might see inconsistent results. Using the "
12277 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
12278 "the qemu binary at the same time as the handle is created."
12282 #: ../src/guestfs-actions.pod:4822
12283 msgid "guestfs_set_recovery_proc"
12287 #: ../src/guestfs-actions.pod:4824
12291 " guestfs_set_recovery_proc (guestfs_h *g,\n"
12292 " int recoveryproc);\n"
12297 #: ../src/guestfs-actions.pod:4828
12299 "If this is called with the parameter C<false> then C<guestfs_launch> does "
12300 "not create a recovery process. The purpose of the recovery process is to "
12301 "stop runaway qemu processes in the case where the main program aborts "
12306 #: ../src/guestfs-actions.pod:4833
12308 "This only has any effect if called before C<guestfs_launch>, and the default "
12313 #: ../src/guestfs-actions.pod:4836 ../fish/guestfish-actions.pod:3553
12315 "About the only time when you would want to disable this is if the main "
12316 "process will fork itself into the background (\"daemonize\" itself). In "
12317 "this case the recovery process thinks that the main program has disappeared "
12318 "and so kills qemu, which is not very helpful."
12322 #: ../src/guestfs-actions.pod:4844
12323 msgid "guestfs_set_selinux"
12327 #: ../src/guestfs-actions.pod:4846
12331 " guestfs_set_selinux (guestfs_h *g,\n"
12337 #: ../src/guestfs-actions.pod:4850 ../fish/guestfish-actions.pod:3565
12339 "This sets the selinux flag that is passed to the appliance at boot time. "
12340 "The default is C<selinux=0> (disabled)."
12344 #: ../src/guestfs-actions.pod:4853 ../fish/guestfish-actions.pod:3568
12346 "Note that if SELinux is enabled, it is always in Permissive mode "
12347 "(C<enforcing=0>)."
12351 #: ../src/guestfs-actions.pod:4861
12352 msgid "guestfs_set_trace"
12356 #: ../src/guestfs-actions.pod:4863
12360 " guestfs_set_trace (guestfs_h *g,\n"
12366 #: ../src/guestfs-actions.pod:4867 ../fish/guestfish-actions.pod:3580
12368 "If the command trace flag is set to 1, then commands are printed on stderr "
12369 "before they are executed in a format which is very similar to the one used "
12370 "by guestfish. In other words, you can run a program with this enabled, and "
12371 "you will get out a script which you can feed to guestfish to perform the "
12372 "same set of actions."
12376 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3587
12378 "If you want to trace C API calls into libguestfs (and other libraries) then "
12379 "possibly a better way is to use the external ltrace(1) command."
12383 #: ../src/guestfs-actions.pod:4878 ../fish/guestfish-actions.pod:3591
12385 "Command traces are disabled unless the environment variable "
12386 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
12390 #: ../src/guestfs-actions.pod:4883
12391 msgid "guestfs_set_verbose"
12395 #: ../src/guestfs-actions.pod:4885
12399 " guestfs_set_verbose (guestfs_h *g,\n"
12405 #: ../src/guestfs-actions.pod:4889 ../fish/guestfish-actions.pod:3600
12406 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
12410 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3602
12412 "Verbose messages are disabled unless the environment variable "
12413 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
12417 #: ../src/guestfs-actions.pod:4896
12418 msgid "guestfs_setcon"
12422 #: ../src/guestfs-actions.pod:4898
12426 " guestfs_setcon (guestfs_h *g,\n"
12427 " const char *context);\n"
12432 #: ../src/guestfs-actions.pod:4902 ../fish/guestfish-actions.pod:3609
12434 "This sets the SELinux security context of the daemon to the string "
12439 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3612
12440 msgid "See the documentation about SELINUX in L<guestfs(3)>."
12444 #: ../src/guestfs-actions.pod:4909
12445 msgid "guestfs_setxattr"
12449 #: ../src/guestfs-actions.pod:4911
12453 " guestfs_setxattr (guestfs_h *g,\n"
12454 " const char *xattr,\n"
12455 " const char *val,\n"
12457 " const char *path);\n"
12462 #: ../src/guestfs-actions.pod:4918 ../fish/guestfish-actions.pod:3618
12464 "This call sets the extended attribute named C<xattr> of the file C<path> to "
12465 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
12469 #: ../src/guestfs-actions.pod:4922
12470 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
12474 #: ../src/guestfs-actions.pod:4926
12475 msgid "guestfs_sfdisk"
12479 #: ../src/guestfs-actions.pod:4928
12483 " guestfs_sfdisk (guestfs_h *g,\n"
12484 " const char *device,\n"
12488 " char *const *lines);\n"
12493 #: ../src/guestfs-actions.pod:4936 ../fish/guestfish-actions.pod:3628
12495 "This is a direct interface to the L<sfdisk(8)> program for creating "
12496 "partitions on block devices."
12500 #: ../src/guestfs-actions.pod:4939 ../fish/guestfish-actions.pod:3631
12501 msgid "C<device> should be a block device, for example C</dev/sda>."
12505 #: ../src/guestfs-actions.pod:4941 ../fish/guestfish-actions.pod:3633
12507 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
12508 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
12509 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
12510 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
12511 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
12512 "the kernel) cannot work out the right geometry and you will need to tell it."
12516 #: ../src/guestfs-actions.pod:4949 ../fish/guestfish-actions.pod:3641
12518 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
12519 "refer to the L<sfdisk(8)> manpage."
12523 #: ../src/guestfs-actions.pod:4952 ../fish/guestfish-actions.pod:3644
12525 "To create a single partition occupying the whole disk, you would pass "
12526 "C<lines> as a single element list, when the single element being the string "
12531 #: ../src/guestfs-actions.pod:4956
12532 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
12536 #: ../src/guestfs-actions.pod:4964
12537 msgid "guestfs_sfdiskM"
12541 #: ../src/guestfs-actions.pod:4966
12545 " guestfs_sfdiskM (guestfs_h *g,\n"
12546 " const char *device,\n"
12547 " char *const *lines);\n"
12552 #: ../src/guestfs-actions.pod:4971
12554 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
12555 "partition sizes are specified in megabytes only (rounded to the nearest "
12556 "cylinder) and you don't need to specify the cyls, heads and sectors "
12557 "parameters which were rarely if ever used anyway."
12561 #: ../src/guestfs-actions.pod:4977
12563 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
12564 "C<guestfs_part_disk>"
12568 #: ../src/guestfs-actions.pod:4985
12569 msgid "guestfs_sfdisk_N"
12573 #: ../src/guestfs-actions.pod:4987
12577 " guestfs_sfdisk_N (guestfs_h *g,\n"
12578 " const char *device,\n"
12583 " const char *line);\n"
12588 #: ../src/guestfs-actions.pod:4996 ../fish/guestfish-actions.pod:3674
12590 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
12591 "(note: C<n> counts from 1)."
12595 #: ../src/guestfs-actions.pod:4999
12597 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
12598 "for the cyls/heads/sectors parameters."
12602 #: ../src/guestfs-actions.pod:5002
12603 msgid "See also: C<guestfs_part_add>"
12607 #: ../src/guestfs-actions.pod:5009
12608 msgid "guestfs_sfdisk_disk_geometry"
12612 #: ../src/guestfs-actions.pod:5011
12616 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
12617 " const char *device);\n"
12622 #: ../src/guestfs-actions.pod:5015
12624 "This displays the disk geometry of C<device> read from the partition table. "
12625 "Especially in the case where the underlying block device has been resized, "
12626 "this can be different from the kernel's idea of the geometry (see "
12627 "C<guestfs_sfdisk_kernel_geometry>)."
12631 #: ../src/guestfs-actions.pod:5020 ../src/guestfs-actions.pod:5034 ../fish/guestfish-actions.pod:3694 ../fish/guestfish-actions.pod:3703
12632 msgid "The result is in human-readable format, and not designed to be parsed."
12636 #: ../src/guestfs-actions.pod:5026
12637 msgid "guestfs_sfdisk_kernel_geometry"
12641 #: ../src/guestfs-actions.pod:5028
12645 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
12646 " const char *device);\n"
12651 #: ../src/guestfs-actions.pod:5032 ../fish/guestfish-actions.pod:3701
12652 msgid "This displays the kernel's idea of the geometry of C<device>."
12656 #: ../src/guestfs-actions.pod:5040
12657 msgid "guestfs_sfdisk_l"
12661 #: ../src/guestfs-actions.pod:5042
12665 " guestfs_sfdisk_l (guestfs_h *g,\n"
12666 " const char *device);\n"
12671 #: ../src/guestfs-actions.pod:5046 ../fish/guestfish-actions.pod:3710
12673 "This displays the partition table on C<device>, in the human-readable output "
12674 "of the L<sfdisk(8)> command. It is not intended to be parsed."
12678 #: ../src/guestfs-actions.pod:5050
12679 msgid "See also: C<guestfs_part_list>"
12683 #: ../src/guestfs-actions.pod:5055
12688 #: ../src/guestfs-actions.pod:5057
12692 " guestfs_sh (guestfs_h *g,\n"
12693 " const char *command);\n"
12698 #: ../src/guestfs-actions.pod:5061 ../fish/guestfish-actions.pod:3720
12700 "This call runs a command from the guest filesystem via the guest's "
12705 #: ../src/guestfs-actions.pod:5064
12706 msgid "This is like C<guestfs_command>, but passes the command to:"
12710 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3725
12713 " /bin/sh -c \"command\"\n"
12718 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3727
12720 "Depending on the guest's shell, this usually results in wildcards being "
12721 "expanded, shell expressions being interpolated and so on."
12725 #: ../src/guestfs-actions.pod:5072
12726 msgid "All the provisos about C<guestfs_command> apply to this call."
12730 #: ../src/guestfs-actions.pod:5077
12731 msgid "guestfs_sh_lines"
12735 #: ../src/guestfs-actions.pod:5079
12739 " guestfs_sh_lines (guestfs_h *g,\n"
12740 " const char *command);\n"
12745 #: ../src/guestfs-actions.pod:5083
12747 "This is the same as C<guestfs_sh>, but splits the result into a list of "
12752 #: ../src/guestfs-actions.pod:5086
12753 msgid "See also: C<guestfs_command_lines>"
12757 #: ../src/guestfs-actions.pod:5092
12758 msgid "guestfs_sleep"
12762 #: ../src/guestfs-actions.pod:5094
12766 " guestfs_sleep (guestfs_h *g,\n"
12772 #: ../src/guestfs-actions.pod:5098 ../fish/guestfish-actions.pod:3746
12773 msgid "Sleep for C<secs> seconds."
12777 #: ../src/guestfs-actions.pod:5102 ../src/guestfs-structs.pod:109
12778 msgid "guestfs_stat"
12782 #: ../src/guestfs-actions.pod:5104
12785 " struct guestfs_stat *\n"
12786 " guestfs_stat (guestfs_h *g,\n"
12787 " const char *path);\n"
12792 #: ../src/guestfs-actions.pod:5110 ../fish/guestfish-actions.pod:3754
12793 msgid "This is the same as the C<stat(2)> system call."
12797 #: ../src/guestfs-actions.pod:5116 ../src/guestfs-structs.pod:135
12798 msgid "guestfs_statvfs"
12802 #: ../src/guestfs-actions.pod:5118
12805 " struct guestfs_statvfs *\n"
12806 " guestfs_statvfs (guestfs_h *g,\n"
12807 " const char *path);\n"
12812 #: ../src/guestfs-actions.pod:5122 ../fish/guestfish-actions.pod:3760
12814 "Returns file system statistics for any mounted file system. C<path> should "
12815 "be a file or directory in the mounted file system (typically it is the mount "
12816 "point itself, but it doesn't need to be)."
12820 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3764
12821 msgid "This is the same as the C<statvfs(2)> system call."
12825 #: ../src/guestfs-actions.pod:5128
12827 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
12828 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
12832 #: ../src/guestfs-actions.pod:5132
12833 msgid "guestfs_strings"
12837 #: ../src/guestfs-actions.pod:5134
12841 " guestfs_strings (guestfs_h *g,\n"
12842 " const char *path);\n"
12847 #: ../src/guestfs-actions.pod:5138 ../fish/guestfish-actions.pod:3770
12849 "This runs the L<strings(1)> command on a file and returns the list of "
12850 "printable strings found."
12854 #: ../src/guestfs-actions.pod:5148
12855 msgid "guestfs_strings_e"
12859 #: ../src/guestfs-actions.pod:5150
12863 " guestfs_strings_e (guestfs_h *g,\n"
12864 " const char *encoding,\n"
12865 " const char *path);\n"
12870 #: ../src/guestfs-actions.pod:5155
12872 "This is like the C<guestfs_strings> command, but allows you to specify the "
12873 "encoding of strings that are looked for in the source file C<path>."
12877 #: ../src/guestfs-actions.pod:5159 ../fish/guestfish-actions.pod:3784
12878 msgid "Allowed encodings are:"
12882 #: ../src/guestfs-actions.pod:5163 ../fish/guestfish-actions.pod:3788
12887 #: ../src/guestfs-actions.pod:5165
12889 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
12890 "ISO-8859-X (this is what C<guestfs_strings> uses)."
12894 #: ../src/guestfs-actions.pod:5168 ../fish/guestfish-actions.pod:3793
12899 #: ../src/guestfs-actions.pod:5170 ../fish/guestfish-actions.pod:3795
12900 msgid "Single 8-bit-byte characters."
12904 #: ../src/guestfs-actions.pod:5172 ../fish/guestfish-actions.pod:3797
12909 #: ../src/guestfs-actions.pod:5174 ../fish/guestfish-actions.pod:3799
12910 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
12914 #: ../src/guestfs-actions.pod:5177 ../fish/guestfish-actions.pod:3802
12915 msgid "l (lower case letter L)"
12919 #: ../src/guestfs-actions.pod:5179 ../fish/guestfish-actions.pod:3804
12921 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
12922 "examining binaries in Windows guests."
12926 #: ../src/guestfs-actions.pod:5182 ../fish/guestfish-actions.pod:3807
12931 #: ../src/guestfs-actions.pod:5184 ../fish/guestfish-actions.pod:3809
12932 msgid "32-bit big endian such as UCS-4BE."
12936 #: ../src/guestfs-actions.pod:5186 ../fish/guestfish-actions.pod:3811
12941 #: ../src/guestfs-actions.pod:5188 ../fish/guestfish-actions.pod:3813
12942 msgid "32-bit little endian such as UCS-4LE."
12946 #: ../src/guestfs-actions.pod:5192 ../fish/guestfish-actions.pod:3817
12947 msgid "The returned strings are transcoded to UTF-8."
12951 #: ../src/guestfs-actions.pod:5201
12952 msgid "guestfs_swapoff_device"
12956 #: ../src/guestfs-actions.pod:5203
12960 " guestfs_swapoff_device (guestfs_h *g,\n"
12961 " const char *device);\n"
12966 #: ../src/guestfs-actions.pod:5207
12968 "This command disables the libguestfs appliance swap device or partition "
12969 "named C<device>. See C<guestfs_swapon_device>."
12973 #: ../src/guestfs-actions.pod:5213
12974 msgid "guestfs_swapoff_file"
12978 #: ../src/guestfs-actions.pod:5215
12982 " guestfs_swapoff_file (guestfs_h *g,\n"
12983 " const char *file);\n"
12988 #: ../src/guestfs-actions.pod:5219 ../fish/guestfish-actions.pod:3834
12989 msgid "This command disables the libguestfs appliance swap on file."
12993 #: ../src/guestfs-actions.pod:5223
12994 msgid "guestfs_swapoff_label"
12998 #: ../src/guestfs-actions.pod:5225
13002 " guestfs_swapoff_label (guestfs_h *g,\n"
13003 " const char *label);\n"
13008 #: ../src/guestfs-actions.pod:5229 ../fish/guestfish-actions.pod:3840
13010 "This command disables the libguestfs appliance swap on labeled swap "
13015 #: ../src/guestfs-actions.pod:5234
13016 msgid "guestfs_swapoff_uuid"
13020 #: ../src/guestfs-actions.pod:5236
13024 " guestfs_swapoff_uuid (guestfs_h *g,\n"
13025 " const char *uuid);\n"
13030 #: ../src/guestfs-actions.pod:5240 ../fish/guestfish-actions.pod:3847
13032 "This command disables the libguestfs appliance swap partition with the given "
13037 #: ../src/guestfs-actions.pod:5245
13038 msgid "guestfs_swapon_device"
13042 #: ../src/guestfs-actions.pod:5247
13046 " guestfs_swapon_device (guestfs_h *g,\n"
13047 " const char *device);\n"
13052 #: ../src/guestfs-actions.pod:5251
13054 "This command enables the libguestfs appliance to use the swap device or "
13055 "partition named C<device>. The increased memory is made available for all "
13056 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
13060 #: ../src/guestfs-actions.pod:5256 ../fish/guestfish-actions.pod:3859
13062 "Note that you should not swap to existing guest swap partitions unless you "
13063 "know what you are doing. They may contain hibernation information, or other "
13064 "information that the guest doesn't want you to trash. You also risk leaking "
13065 "information about the host to the guest this way. Instead, attach a new "
13066 "host device to the guest and swap on that."
13070 #: ../src/guestfs-actions.pod:5265
13071 msgid "guestfs_swapon_file"
13075 #: ../src/guestfs-actions.pod:5267
13079 " guestfs_swapon_file (guestfs_h *g,\n"
13080 " const char *file);\n"
13085 #: ../src/guestfs-actions.pod:5271
13087 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
13092 #: ../src/guestfs-actions.pod:5276
13093 msgid "guestfs_swapon_label"
13097 #: ../src/guestfs-actions.pod:5278
13101 " guestfs_swapon_label (guestfs_h *g,\n"
13102 " const char *label);\n"
13107 #: ../src/guestfs-actions.pod:5282
13109 "This command enables swap to a labeled swap partition. See "
13110 "C<guestfs_swapon_device> for other notes."
13114 #: ../src/guestfs-actions.pod:5287
13115 msgid "guestfs_swapon_uuid"
13119 #: ../src/guestfs-actions.pod:5289
13123 " guestfs_swapon_uuid (guestfs_h *g,\n"
13124 " const char *uuid);\n"
13129 #: ../src/guestfs-actions.pod:5293
13131 "This command enables swap to a swap partition with the given UUID. See "
13132 "C<guestfs_swapon_device> for other notes."
13136 #: ../src/guestfs-actions.pod:5298
13137 msgid "guestfs_sync"
13141 #: ../src/guestfs-actions.pod:5300
13145 " guestfs_sync (guestfs_h *g);\n"
13150 #: ../src/guestfs-actions.pod:5303 ../fish/guestfish-actions.pod:3891
13152 "This syncs the disk, so that any writes are flushed through to the "
13153 "underlying disk image."
13157 #: ../src/guestfs-actions.pod:5306 ../fish/guestfish-actions.pod:3894
13159 "You should always call this if you have modified a disk image, before "
13160 "closing the handle."
13164 #: ../src/guestfs-actions.pod:5311
13165 msgid "guestfs_tail"
13169 #: ../src/guestfs-actions.pod:5313
13173 " guestfs_tail (guestfs_h *g,\n"
13174 " const char *path);\n"
13179 #: ../src/guestfs-actions.pod:5317 ../fish/guestfish-actions.pod:3901
13180 msgid "This command returns up to the last 10 lines of a file as a list of strings."
13184 #: ../src/guestfs-actions.pod:5327
13185 msgid "guestfs_tail_n"
13189 #: ../src/guestfs-actions.pod:5329
13193 " guestfs_tail_n (guestfs_h *g,\n"
13195 " const char *path);\n"
13200 #: ../src/guestfs-actions.pod:5334 ../fish/guestfish-actions.pod:3911
13202 "If the parameter C<nrlines> is a positive number, this returns the last "
13203 "C<nrlines> lines of the file C<path>."
13207 #: ../src/guestfs-actions.pod:5337 ../fish/guestfish-actions.pod:3914
13209 "If the parameter C<nrlines> is a negative number, this returns lines from "
13210 "the file C<path>, starting with the C<-nrlines>th line."
13214 #: ../src/guestfs-actions.pod:5349
13215 msgid "guestfs_tar_in"
13219 #: ../src/guestfs-actions.pod:5351
13223 " guestfs_tar_in (guestfs_h *g,\n"
13224 " const char *tarfile,\n"
13225 " const char *directory);\n"
13230 #: ../src/guestfs-actions.pod:5356 ../fish/guestfish-actions.pod:3926
13232 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
13233 "tar file) into C<directory>."
13237 #: ../src/guestfs-actions.pod:5359
13238 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
13242 #: ../src/guestfs-actions.pod:5364
13243 msgid "guestfs_tar_out"
13247 #: ../src/guestfs-actions.pod:5366
13251 " guestfs_tar_out (guestfs_h *g,\n"
13252 " const char *directory,\n"
13253 " const char *tarfile);\n"
13258 #: ../src/guestfs-actions.pod:5371 ../fish/guestfish-actions.pod:3938
13260 "This command packs the contents of C<directory> and downloads it to local "
13265 #: ../src/guestfs-actions.pod:5374
13267 "To download a compressed tarball, use C<guestfs_tgz_out> or "
13268 "C<guestfs_txz_out>."
13272 #: ../src/guestfs-actions.pod:5379
13273 msgid "guestfs_tgz_in"
13277 #: ../src/guestfs-actions.pod:5381
13281 " guestfs_tgz_in (guestfs_h *g,\n"
13282 " const char *tarball,\n"
13283 " const char *directory);\n"
13288 #: ../src/guestfs-actions.pod:5386 ../fish/guestfish-actions.pod:3950
13290 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
13291 "tar file) into C<directory>."
13295 #: ../src/guestfs-actions.pod:5389
13296 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
13300 #: ../src/guestfs-actions.pod:5393
13301 msgid "guestfs_tgz_out"
13305 #: ../src/guestfs-actions.pod:5395
13309 " guestfs_tgz_out (guestfs_h *g,\n"
13310 " const char *directory,\n"
13311 " const char *tarball);\n"
13316 #: ../src/guestfs-actions.pod:5400 ../fish/guestfish-actions.pod:3961
13318 "This command packs the contents of C<directory> and downloads it to local "
13323 #: ../src/guestfs-actions.pod:5403
13324 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
13328 #: ../src/guestfs-actions.pod:5407
13329 msgid "guestfs_touch"
13333 #: ../src/guestfs-actions.pod:5409
13337 " guestfs_touch (guestfs_h *g,\n"
13338 " const char *path);\n"
13343 #: ../src/guestfs-actions.pod:5413 ../fish/guestfish-actions.pod:3972
13345 "Touch acts like the L<touch(1)> command. It can be used to update the "
13346 "timestamps on a file, or, if the file does not exist, to create a new "
13347 "zero-length file."
13351 #: ../src/guestfs-actions.pod:5417 ../fish/guestfish-actions.pod:3976
13353 "This command only works on regular files, and will fail on other file types "
13354 "such as directories, symbolic links, block special etc."
13358 #: ../src/guestfs-actions.pod:5422
13359 msgid "guestfs_truncate"
13363 #: ../src/guestfs-actions.pod:5424
13367 " guestfs_truncate (guestfs_h *g,\n"
13368 " const char *path);\n"
13373 #: ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3983
13375 "This command truncates C<path> to a zero-length file. The file must exist "
13380 #: ../src/guestfs-actions.pod:5433
13381 msgid "guestfs_truncate_size"
13385 #: ../src/guestfs-actions.pod:5435
13389 " guestfs_truncate_size (guestfs_h *g,\n"
13390 " const char *path,\n"
13391 " int64_t size);\n"
13396 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3990
13398 "This command truncates C<path> to size C<size> bytes. The file must exist "
13403 #: ../src/guestfs-actions.pod:5443
13405 "If the current file size is less than C<size> then the file is extended to "
13406 "the required size with zero bytes. This creates a sparse file (ie. disk "
13407 "blocks are not allocated for the file until you write to it). To create a "
13408 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
13412 #: ../src/guestfs-actions.pod:5451
13413 msgid "guestfs_tune2fs_l"
13417 #: ../src/guestfs-actions.pod:5453
13421 " guestfs_tune2fs_l (guestfs_h *g,\n"
13422 " const char *device);\n"
13427 #: ../src/guestfs-actions.pod:5457 ../fish/guestfish-actions.pod:4003
13429 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
13434 #: ../src/guestfs-actions.pod:5460 ../fish/guestfish-actions.pod:4006
13436 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
13437 "for more details. The list of fields returned isn't clearly defined, and "
13438 "depends on both the version of C<tune2fs> that libguestfs was built against, "
13439 "and the filesystem itself."
13443 #: ../src/guestfs-actions.pod:5471
13444 msgid "guestfs_txz_in"
13448 #: ../src/guestfs-actions.pod:5473
13452 " guestfs_txz_in (guestfs_h *g,\n"
13453 " const char *tarball,\n"
13454 " const char *directory);\n"
13459 #: ../src/guestfs-actions.pod:5478 ../fish/guestfish-actions.pod:4015
13461 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
13462 "tar file) into C<directory>."
13466 #: ../src/guestfs-actions.pod:5483
13467 msgid "guestfs_txz_out"
13471 #: ../src/guestfs-actions.pod:5485
13475 " guestfs_txz_out (guestfs_h *g,\n"
13476 " const char *directory,\n"
13477 " const char *tarball);\n"
13482 #: ../src/guestfs-actions.pod:5490 ../fish/guestfish-actions.pod:4024
13484 "This command packs the contents of C<directory> and downloads it to local "
13485 "file C<tarball> (as an xz compressed tar archive)."
13489 #: ../src/guestfs-actions.pod:5495
13490 msgid "guestfs_umask"
13494 #: ../src/guestfs-actions.pod:5497
13498 " guestfs_umask (guestfs_h *g,\n"
13504 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:4033
13506 "This function sets the mask used for creating new files and device nodes to "
13511 #: ../src/guestfs-actions.pod:5504 ../fish/guestfish-actions.pod:4036
13513 "Typical umask values would be C<022> which creates new files with "
13514 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
13515 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
13519 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:4041
13521 "The default umask is C<022>. This is important because it means that "
13522 "directories and device nodes will be created with C<0644> or C<0755> mode "
13523 "even if you specify C<0777>."
13527 #: ../src/guestfs-actions.pod:5513
13529 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
13530 "C<guestfs_mkdir>."
13534 #: ../src/guestfs-actions.pod:5516 ../fish/guestfish-actions.pod:4048
13535 msgid "This call returns the previous umask."
13539 #: ../src/guestfs-actions.pod:5520
13540 msgid "guestfs_umount"
13544 #: ../src/guestfs-actions.pod:5522
13548 " guestfs_umount (guestfs_h *g,\n"
13549 " const char *pathordevice);\n"
13554 #: ../src/guestfs-actions.pod:5526 ../fish/guestfish-actions.pod:4056
13556 "This unmounts the given filesystem. The filesystem may be specified either "
13557 "by its mountpoint (path) or the device which contains the filesystem."
13561 #: ../src/guestfs-actions.pod:5532
13562 msgid "guestfs_umount_all"
13566 #: ../src/guestfs-actions.pod:5534
13570 " guestfs_umount_all (guestfs_h *g);\n"
13575 #: ../src/guestfs-actions.pod:5537 ../fish/guestfish-actions.pod:4066
13576 msgid "This unmounts all mounted filesystems."
13580 #: ../src/guestfs-actions.pod:5539 ../fish/guestfish-actions.pod:4068
13581 msgid "Some internal mounts are not unmounted by this call."
13585 #: ../src/guestfs-actions.pod:5543
13586 msgid "guestfs_upload"
13590 #: ../src/guestfs-actions.pod:5545
13594 " guestfs_upload (guestfs_h *g,\n"
13595 " const char *filename,\n"
13596 " const char *remotefilename);\n"
13601 #: ../src/guestfs-actions.pod:5550 ../src/guestfs-actions.pod:5567 ../fish/guestfish-actions.pod:4074 ../fish/guestfish-actions.pod:4087
13602 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
13606 #: ../src/guestfs-actions.pod:5555
13607 msgid "See also C<guestfs_download>."
13611 #: ../src/guestfs-actions.pod:5559
13612 msgid "guestfs_upload_offset"
13616 #: ../src/guestfs-actions.pod:5561
13620 " guestfs_upload_offset (guestfs_h *g,\n"
13621 " const char *filename,\n"
13622 " const char *remotefilename,\n"
13623 " int64_t offset);\n"
13628 #: ../src/guestfs-actions.pod:5570 ../fish/guestfish-actions.pod:4090
13630 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
13631 "The intention is to overwrite parts of existing files or devices, although "
13632 "if a non-existant file is specified then it is created with a \"hole\" "
13633 "before C<offset>. The size of the data written is implicit in the size of "
13634 "the source C<filename>."
13638 #: ../src/guestfs-actions.pod:5577
13640 "Note that there is no limit on the amount of data that can be uploaded with "
13641 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
13642 "full amount unless an error occurs."
13646 #: ../src/guestfs-actions.pod:5582
13647 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
13651 #: ../src/guestfs-actions.pod:5586
13652 msgid "guestfs_utimens"
13656 #: ../src/guestfs-actions.pod:5588
13660 " guestfs_utimens (guestfs_h *g,\n"
13661 " const char *path,\n"
13662 " int64_t atsecs,\n"
13663 " int64_t atnsecs,\n"
13664 " int64_t mtsecs,\n"
13665 " int64_t mtnsecs);\n"
13670 #: ../src/guestfs-actions.pod:5596 ../fish/guestfish-actions.pod:4110
13671 msgid "This command sets the timestamps of a file with nanosecond precision."
13675 #: ../src/guestfs-actions.pod:5599 ../fish/guestfish-actions.pod:4113
13677 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
13682 #: ../src/guestfs-actions.pod:5602 ../fish/guestfish-actions.pod:4116
13684 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
13685 "nanoseconds from the epoch."
13689 #: ../src/guestfs-actions.pod:5605 ../fish/guestfish-actions.pod:4119
13691 "If the C<*nsecs> field contains the special value C<-1> then the "
13692 "corresponding timestamp is set to the current time. (The C<*secs> field is "
13693 "ignored in this case)."
13697 #: ../src/guestfs-actions.pod:5609 ../fish/guestfish-actions.pod:4123
13699 "If the C<*nsecs> field contains the special value C<-2> then the "
13700 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
13705 #: ../src/guestfs-actions.pod:5615 ../src/guestfs-structs.pod:175
13706 msgid "guestfs_version"
13710 #: ../src/guestfs-actions.pod:5617
13713 " struct guestfs_version *\n"
13714 " guestfs_version (guestfs_h *g);\n"
13719 #: ../src/guestfs-actions.pod:5620 ../fish/guestfish-actions.pod:4131
13720 msgid "Return the libguestfs version number that the program is linked against."
13724 #: ../src/guestfs-actions.pod:5623 ../fish/guestfish-actions.pod:4134
13726 "Note that because of dynamic linking this is not necessarily the version of "
13727 "libguestfs that you compiled against. You can compile the program, and then "
13728 "at runtime dynamically link against a completely different C<libguestfs.so> "
13733 #: ../src/guestfs-actions.pod:5628 ../fish/guestfish-actions.pod:4139
13735 "This call was added in version C<1.0.58>. In previous versions of "
13736 "libguestfs there was no way to get the version number. From C code you can "
13737 "use dynamic linker functions to find out if this symbol exists (if it "
13738 "doesn't, then it's an earlier version)."
13742 #: ../src/guestfs-actions.pod:5634 ../fish/guestfish-actions.pod:4145
13744 "The call returns a structure with four elements. The first three (C<major>, "
13745 "C<minor> and C<release>) are numbers and correspond to the usual version "
13746 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
13747 "but may be used for distro-specific information."
13751 #: ../src/guestfs-actions.pod:5640 ../fish/guestfish-actions.pod:4151
13752 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
13756 #: ../src/guestfs-actions.pod:5643 ../fish/guestfish-actions.pod:4154
13757 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
13761 #: ../src/guestfs-actions.pod:5645
13763 "I<Note:> Don't use this call to test for availability of features. In "
13764 "enterprise distributions we backport features from later versions into "
13765 "earlier versions, making this an unreliable way to test for features. Use "
13766 "C<guestfs_available> instead."
13770 #: ../src/guestfs-actions.pod:5651
13772 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
13773 "error. I<The caller must call C<guestfs_free_version> after use>."
13777 #: ../src/guestfs-actions.pod:5655
13778 msgid "guestfs_vfs_label"
13782 #: ../src/guestfs-actions.pod:5657
13786 " guestfs_vfs_label (guestfs_h *g,\n"
13787 " const char *device);\n"
13792 #: ../src/guestfs-actions.pod:5661 ../fish/guestfish-actions.pod:4166
13793 msgid "This returns the filesystem label of the filesystem on C<device>."
13797 #: ../src/guestfs-actions.pod:5664 ../fish/guestfish-actions.pod:4169
13798 msgid "If the filesystem is unlabeled, this returns the empty string."
13802 #: ../src/guestfs-actions.pod:5666
13803 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
13807 #: ../src/guestfs-actions.pod:5671
13808 msgid "guestfs_vfs_type"
13812 #: ../src/guestfs-actions.pod:5673
13816 " guestfs_vfs_type (guestfs_h *g,\n"
13817 " const char *device);\n"
13822 #: ../src/guestfs-actions.pod:5677 ../fish/guestfish-actions.pod:4177
13824 "This command gets the filesystem type corresponding to the filesystem on "
13829 #: ../src/guestfs-actions.pod:5680 ../fish/guestfish-actions.pod:4180
13831 "For most filesystems, the result is the name of the Linux VFS module which "
13832 "would be used to mount this filesystem if you mounted it without specifying "
13833 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
13837 #: ../src/guestfs-actions.pod:5688
13838 msgid "guestfs_vfs_uuid"
13842 #: ../src/guestfs-actions.pod:5690
13846 " guestfs_vfs_uuid (guestfs_h *g,\n"
13847 " const char *device);\n"
13852 #: ../src/guestfs-actions.pod:5694 ../fish/guestfish-actions.pod:4189
13853 msgid "This returns the filesystem UUID of the filesystem on C<device>."
13857 #: ../src/guestfs-actions.pod:5697 ../fish/guestfish-actions.pod:4192
13858 msgid "If the filesystem does not have a UUID, this returns the empty string."
13862 #: ../src/guestfs-actions.pod:5699
13863 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
13867 #: ../src/guestfs-actions.pod:5704
13868 msgid "guestfs_vg_activate"
13872 #: ../src/guestfs-actions.pod:5706
13876 " guestfs_vg_activate (guestfs_h *g,\n"
13878 " char *const *volgroups);\n"
13883 #: ../src/guestfs-actions.pod:5711 ../fish/guestfish-actions.pod:4200
13885 "This command activates or (if C<activate> is false) deactivates all logical "
13886 "volumes in the listed volume groups C<volgroups>. If activated, then they "
13887 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
13888 "deactivated, then those devices disappear."
13892 #: ../src/guestfs-actions.pod:5717 ../fish/guestfish-actions.pod:4206
13893 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
13897 #: ../src/guestfs-actions.pod:5719 ../fish/guestfish-actions.pod:4208
13899 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
13900 "activated or deactivated."
13904 #: ../src/guestfs-actions.pod:5724
13905 msgid "guestfs_vg_activate_all"
13909 #: ../src/guestfs-actions.pod:5726
13913 " guestfs_vg_activate_all (guestfs_h *g,\n"
13914 " int activate);\n"
13919 #: ../src/guestfs-actions.pod:5730 ../fish/guestfish-actions.pod:4215
13921 "This command activates or (if C<activate> is false) deactivates all logical "
13922 "volumes in all volume groups. If activated, then they are made known to the "
13923 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
13924 "those devices disappear."
13928 #: ../src/guestfs-actions.pod:5736 ../fish/guestfish-actions.pod:4221
13929 msgid "This command is the same as running C<vgchange -a y|n>"
13933 #: ../src/guestfs-actions.pod:5740
13934 msgid "guestfs_vgcreate"
13938 #: ../src/guestfs-actions.pod:5742
13942 " guestfs_vgcreate (guestfs_h *g,\n"
13943 " const char *volgroup,\n"
13944 " char *const *physvols);\n"
13949 #: ../src/guestfs-actions.pod:5747 ../fish/guestfish-actions.pod:4227
13951 "This creates an LVM volume group called C<volgroup> from the non-empty list "
13952 "of physical volumes C<physvols>."
13956 #: ../src/guestfs-actions.pod:5752
13957 msgid "guestfs_vglvuuids"
13961 #: ../src/guestfs-actions.pod:5754
13965 " guestfs_vglvuuids (guestfs_h *g,\n"
13966 " const char *vgname);\n"
13971 #: ../src/guestfs-actions.pod:5758 ../fish/guestfish-actions.pod:4234
13973 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
13974 "volumes created in this volume group."
13978 #: ../src/guestfs-actions.pod:5761
13980 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
13981 "associate logical volumes and volume groups."
13985 #: ../src/guestfs-actions.pod:5764
13986 msgid "See also C<guestfs_vgpvuuids>."
13990 #: ../src/guestfs-actions.pod:5770
13991 msgid "guestfs_vgpvuuids"
13995 #: ../src/guestfs-actions.pod:5772
13999 " guestfs_vgpvuuids (guestfs_h *g,\n"
14000 " const char *vgname);\n"
14005 #: ../src/guestfs-actions.pod:5776 ../fish/guestfish-actions.pod:4246
14007 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
14008 "volumes that this volume group resides on."
14012 #: ../src/guestfs-actions.pod:5779
14014 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
14015 "associate physical volumes and volume groups."
14019 #: ../src/guestfs-actions.pod:5782
14020 msgid "See also C<guestfs_vglvuuids>."
14024 #: ../src/guestfs-actions.pod:5788
14025 msgid "guestfs_vgremove"
14029 #: ../src/guestfs-actions.pod:5790
14033 " guestfs_vgremove (guestfs_h *g,\n"
14034 " const char *vgname);\n"
14039 #: ../src/guestfs-actions.pod:5794 ../fish/guestfish-actions.pod:4258
14040 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
14044 #: ../src/guestfs-actions.pod:5796 ../fish/guestfish-actions.pod:4260
14045 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
14049 #: ../src/guestfs-actions.pod:5801
14050 msgid "guestfs_vgrename"
14054 #: ../src/guestfs-actions.pod:5803
14058 " guestfs_vgrename (guestfs_h *g,\n"
14059 " const char *volgroup,\n"
14060 " const char *newvolgroup);\n"
14065 #: ../src/guestfs-actions.pod:5808 ../fish/guestfish-actions.pod:4267
14066 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
14070 #: ../src/guestfs-actions.pod:5812
14071 msgid "guestfs_vgs"
14075 #: ../src/guestfs-actions.pod:5814
14079 " guestfs_vgs (guestfs_h *g);\n"
14084 #: ../src/guestfs-actions.pod:5817 ../fish/guestfish-actions.pod:4273
14086 "List all the volumes groups detected. This is the equivalent of the "
14087 "L<vgs(8)> command."
14091 #: ../src/guestfs-actions.pod:5820 ../fish/guestfish-actions.pod:4276
14093 "This returns a list of just the volume group names that were detected "
14094 "(eg. C<VolGroup00>)."
14098 #: ../src/guestfs-actions.pod:5823
14099 msgid "See also C<guestfs_vgs_full>."
14103 #: ../src/guestfs-actions.pod:5829
14104 msgid "guestfs_vgs_full"
14108 #: ../src/guestfs-actions.pod:5831
14111 " struct guestfs_lvm_vg_list *\n"
14112 " guestfs_vgs_full (guestfs_h *g);\n"
14117 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:4285
14119 "List all the volumes groups detected. This is the equivalent of the "
14120 "L<vgs(8)> command. The \"full\" version includes all fields."
14124 #: ../src/guestfs-actions.pod:5837
14126 "This function returns a C<struct guestfs_lvm_vg_list *> (see "
14127 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
14128 "must call C<guestfs_free_lvm_vg_list> after use>."
14132 #: ../src/guestfs-actions.pod:5842
14133 msgid "guestfs_vgscan"
14137 #: ../src/guestfs-actions.pod:5844
14141 " guestfs_vgscan (guestfs_h *g);\n"
14146 #: ../src/guestfs-actions.pod:5847 ../fish/guestfish-actions.pod:4292
14148 "This rescans all block devices and rebuilds the list of LVM physical "
14149 "volumes, volume groups and logical volumes."
14153 #: ../src/guestfs-actions.pod:5852
14154 msgid "guestfs_vguuid"
14158 #: ../src/guestfs-actions.pod:5854
14162 " guestfs_vguuid (guestfs_h *g,\n"
14163 " const char *vgname);\n"
14168 #: ../src/guestfs-actions.pod:5858 ../fish/guestfish-actions.pod:4299
14169 msgid "This command returns the UUID of the LVM VG named C<vgname>."
14173 #: ../src/guestfs-actions.pod:5863
14174 msgid "guestfs_wait_ready"
14178 #: ../src/guestfs-actions.pod:5865
14182 " guestfs_wait_ready (guestfs_h *g);\n"
14187 #: ../src/guestfs-actions.pod:5868
14188 msgid "This function is a no op."
14192 #: ../src/guestfs-actions.pod:5870
14194 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
14195 "calling C<guestfs_launch> to wait for the launch to complete. However this "
14196 "is no longer necessary because C<guestfs_launch> now does the waiting."
14200 #: ../src/guestfs-actions.pod:5875
14202 "If you see any calls to this function in code then you can just remove them, "
14203 "unless you want to retain compatibility with older versions of the API."
14207 #: ../src/guestfs-actions.pod:5881
14208 msgid "guestfs_wc_c"
14212 #: ../src/guestfs-actions.pod:5883
14216 " guestfs_wc_c (guestfs_h *g,\n"
14217 " const char *path);\n"
14222 #: ../src/guestfs-actions.pod:5887 ../fish/guestfish-actions.pod:4305
14224 "This command counts the characters in a file, using the C<wc -c> external "
14229 #: ../src/guestfs-actions.pod:5892
14230 msgid "guestfs_wc_l"
14234 #: ../src/guestfs-actions.pod:5894
14238 " guestfs_wc_l (guestfs_h *g,\n"
14239 " const char *path);\n"
14244 #: ../src/guestfs-actions.pod:5898 ../fish/guestfish-actions.pod:4312
14246 "This command counts the lines in a file, using the C<wc -l> external "
14251 #: ../src/guestfs-actions.pod:5903
14252 msgid "guestfs_wc_w"
14256 #: ../src/guestfs-actions.pod:5905
14260 " guestfs_wc_w (guestfs_h *g,\n"
14261 " const char *path);\n"
14266 #: ../src/guestfs-actions.pod:5909 ../fish/guestfish-actions.pod:4319
14268 "This command counts the words in a file, using the C<wc -w> external "
14273 #: ../src/guestfs-actions.pod:5914
14274 msgid "guestfs_write"
14278 #: ../src/guestfs-actions.pod:5916
14282 " guestfs_write (guestfs_h *g,\n"
14283 " const char *path,\n"
14284 " const char *content,\n"
14285 " size_t content_size);\n"
14290 #: ../src/guestfs-actions.pod:5922 ../fish/guestfish-actions.pod:4326
14292 "This call creates a file called C<path>. The content of the file is the "
14293 "string C<content> (which can contain any 8 bit data)."
14297 #: ../src/guestfs-actions.pod:5930
14298 msgid "guestfs_write_file"
14302 #: ../src/guestfs-actions.pod:5932
14306 " guestfs_write_file (guestfs_h *g,\n"
14307 " const char *path,\n"
14308 " const char *content,\n"
14314 #: ../src/guestfs-actions.pod:5938 ../fish/guestfish-actions.pod:4336
14316 "This call creates a file called C<path>. The contents of the file is the "
14317 "string C<content> (which can contain any 8 bit data), with length C<size>."
14321 #: ../src/guestfs-actions.pod:5942 ../fish/guestfish-actions.pod:4340
14323 "As a special case, if C<size> is C<0> then the length is calculated using "
14324 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
14328 #: ../src/guestfs-actions.pod:5946 ../fish/guestfish-actions.pod:4344
14330 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
14331 "I<not> work, even if the length is specified."
14335 #: ../src/guestfs-actions.pod:5954 ../fish/guestfish-actions.pod:4350
14336 msgid "This function is deprecated. In new code, use the C<write> call instead."
14340 #: ../src/guestfs-actions.pod:5961
14341 msgid "guestfs_zegrep"
14345 #: ../src/guestfs-actions.pod:5963
14349 " guestfs_zegrep (guestfs_h *g,\n"
14350 " const char *regex,\n"
14351 " const char *path);\n"
14356 #: ../src/guestfs-actions.pod:5968 ../fish/guestfish-actions.pod:4361
14357 msgid "This calls the external C<zegrep> program and returns the matching lines."
14361 #: ../src/guestfs-actions.pod:5978
14362 msgid "guestfs_zegrepi"
14366 #: ../src/guestfs-actions.pod:5980
14370 " guestfs_zegrepi (guestfs_h *g,\n"
14371 " const char *regex,\n"
14372 " const char *path);\n"
14377 #: ../src/guestfs-actions.pod:5985 ../fish/guestfish-actions.pod:4371
14378 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
14382 #: ../src/guestfs-actions.pod:5995
14383 msgid "guestfs_zero"
14387 #: ../src/guestfs-actions.pod:5997
14391 " guestfs_zero (guestfs_h *g,\n"
14392 " const char *device);\n"
14397 #: ../src/guestfs-actions.pod:6001 ../fish/guestfish-actions.pod:4381
14398 msgid "This command writes zeroes over the first few blocks of C<device>."
14402 #: ../src/guestfs-actions.pod:6003 ../fish/guestfish-actions.pod:4383
14404 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
14405 "securely wipe the device). It should be sufficient to remove any partition "
14406 "tables, filesystem superblocks and so on."
14410 #: ../src/guestfs-actions.pod:6007
14411 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
14415 #: ../src/guestfs-actions.pod:6016
14416 msgid "guestfs_zero_device"
14420 #: ../src/guestfs-actions.pod:6018
14424 " guestfs_zero_device (guestfs_h *g,\n"
14425 " const char *device);\n"
14430 #: ../src/guestfs-actions.pod:6022
14432 "This command writes zeroes over the entire C<device>. Compare with "
14433 "C<guestfs_zero> which just zeroes the first few blocks of a device."
14437 #: ../src/guestfs-actions.pod:6036
14438 msgid "guestfs_zerofree"
14442 #: ../src/guestfs-actions.pod:6038
14446 " guestfs_zerofree (guestfs_h *g,\n"
14447 " const char *device);\n"
14452 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:4404
14454 "This runs the I<zerofree> program on C<device>. This program claims to zero "
14455 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
14456 "possible to compress the filesystem more effectively."
14460 #: ../src/guestfs-actions.pod:6047 ../fish/guestfish-actions.pod:4409
14461 msgid "You should B<not> run this program if the filesystem is mounted."
14465 #: ../src/guestfs-actions.pod:6050 ../fish/guestfish-actions.pod:4412
14467 "It is possible that using this program can damage the filesystem or data on "
14472 #: ../src/guestfs-actions.pod:6055
14473 msgid "guestfs_zfgrep"
14477 #: ../src/guestfs-actions.pod:6057
14481 " guestfs_zfgrep (guestfs_h *g,\n"
14482 " const char *pattern,\n"
14483 " const char *path);\n"
14488 #: ../src/guestfs-actions.pod:6062 ../fish/guestfish-actions.pod:4419
14489 msgid "This calls the external C<zfgrep> program and returns the matching lines."
14493 #: ../src/guestfs-actions.pod:6072
14494 msgid "guestfs_zfgrepi"
14498 #: ../src/guestfs-actions.pod:6074
14502 " guestfs_zfgrepi (guestfs_h *g,\n"
14503 " const char *pattern,\n"
14504 " const char *path);\n"
14509 #: ../src/guestfs-actions.pod:6079 ../fish/guestfish-actions.pod:4429
14510 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
14514 #: ../src/guestfs-actions.pod:6089
14515 msgid "guestfs_zfile"
14519 #: ../src/guestfs-actions.pod:6091
14523 " guestfs_zfile (guestfs_h *g,\n"
14524 " const char *meth,\n"
14525 " const char *path);\n"
14530 #: ../src/guestfs-actions.pod:6096 ../fish/guestfish-actions.pod:4439
14531 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
14535 #: ../src/guestfs-actions.pod:6099 ../fish/guestfish-actions.pod:4442
14536 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
14540 #: ../src/guestfs-actions.pod:6101
14542 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
14547 #: ../src/guestfs-actions.pod:6107 ../fish/guestfish-actions.pod:4447
14548 msgid "This function is deprecated. In new code, use the C<file> call instead."
14552 #: ../src/guestfs-actions.pod:6114
14553 msgid "guestfs_zgrep"
14557 #: ../src/guestfs-actions.pod:6116
14561 " guestfs_zgrep (guestfs_h *g,\n"
14562 " const char *regex,\n"
14563 " const char *path);\n"
14568 #: ../src/guestfs-actions.pod:6121 ../fish/guestfish-actions.pod:4458
14569 msgid "This calls the external C<zgrep> program and returns the matching lines."
14573 #: ../src/guestfs-actions.pod:6131
14574 msgid "guestfs_zgrepi"
14578 #: ../src/guestfs-actions.pod:6133
14582 " guestfs_zgrepi (guestfs_h *g,\n"
14583 " const char *regex,\n"
14584 " const char *path);\n"
14589 #: ../src/guestfs-actions.pod:6138 ../fish/guestfish-actions.pod:4468
14590 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
14594 #: ../src/guestfs-availability.pod:3
14599 #: ../src/guestfs-availability.pod:5
14601 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
14602 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
14603 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
14604 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
14605 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
14609 #: ../src/guestfs-availability.pod:21
14614 #: ../src/guestfs-availability.pod:23
14616 "The following functions: L</guestfs_inotify_add_watch> "
14617 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
14618 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
14622 #: ../src/guestfs-availability.pod:31
14623 msgid "B<linuxfsuuid>"
14627 #: ../src/guestfs-availability.pod:33
14629 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
14630 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
14634 #: ../src/guestfs-availability.pod:40
14635 msgid "B<linuxmodules>"
14639 #: ../src/guestfs-availability.pod:42
14640 msgid "The following functions: L</guestfs_modprobe>"
14644 #: ../src/guestfs-availability.pod:45
14645 msgid "B<linuxxattrs>"
14649 #: ../src/guestfs-availability.pod:47
14651 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> "
14652 "L</guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> "
14653 "L</guestfs_removexattr> L</guestfs_setxattr>"
14657 #: ../src/guestfs-availability.pod:56
14662 #: ../src/guestfs-availability.pod:58
14664 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
14665 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
14666 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
14670 #: ../src/guestfs-availability.pod:67
14675 #: ../src/guestfs-availability.pod:69
14677 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
14678 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
14679 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
14680 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
14681 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
14682 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
14683 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
14684 "L</guestfs_vgs_full>"
14688 #: ../src/guestfs-availability.pod:92
14693 #: ../src/guestfs-availability.pod:94
14695 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
14696 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
14700 #: ../src/guestfs-availability.pod:100
14705 #: ../src/guestfs-availability.pod:102
14706 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
14710 #: ../src/guestfs-availability.pod:105
14711 msgid "B<ntfsprogs>"
14715 #: ../src/guestfs-availability.pod:107
14716 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
14720 #: ../src/guestfs-availability.pod:111
14721 msgid "B<realpath>"
14725 #: ../src/guestfs-availability.pod:113
14726 msgid "The following functions: L</guestfs_realpath>"
14730 #: ../src/guestfs-availability.pod:116
14735 #: ../src/guestfs-availability.pod:118
14737 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
14738 "L</guestfs_scrub_freespace>"
14742 #: ../src/guestfs-availability.pod:123
14747 #: ../src/guestfs-availability.pod:125
14748 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
14752 #: ../src/guestfs-availability.pod:129
14757 #: ../src/guestfs-availability.pod:131
14758 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
14762 #: ../src/guestfs-availability.pod:135
14763 msgid "B<zerofree>"
14767 #: ../src/guestfs-availability.pod:137
14768 msgid "The following functions: L</guestfs_zerofree>"
14772 #: ../src/guestfs-structs.pod:1
14773 msgid "guestfs_int_bool"
14777 #: ../src/guestfs-structs.pod:3
14780 " struct guestfs_int_bool {\n"
14788 #: ../src/guestfs-structs.pod:8
14791 " struct guestfs_int_bool_list {\n"
14792 " uint32_t len; /* Number of elements in list. */\n"
14793 " struct guestfs_int_bool *val; /* Elements. */\n"
14799 #: ../src/guestfs-structs.pod:13
14802 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
14803 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
14808 #: ../src/guestfs-structs.pod:16
14809 msgid "guestfs_lvm_pv"
14813 #: ../src/guestfs-structs.pod:18
14816 " struct guestfs_lvm_pv {\n"
14817 " char *pv_name;\n"
14818 " /* The next field is NOT nul-terminated, be careful when printing it: "
14820 " char pv_uuid[32];\n"
14822 " uint64_t pv_size;\n"
14823 " uint64_t dev_size;\n"
14824 " uint64_t pv_free;\n"
14825 " uint64_t pv_used;\n"
14826 " char *pv_attr;\n"
14827 " int64_t pv_pe_count;\n"
14828 " int64_t pv_pe_alloc_count;\n"
14829 " char *pv_tags;\n"
14830 " uint64_t pe_start;\n"
14831 " int64_t pv_mda_count;\n"
14832 " uint64_t pv_mda_free;\n"
14838 #: ../src/guestfs-structs.pod:36
14841 " struct guestfs_lvm_pv_list {\n"
14842 " uint32_t len; /* Number of elements in list. */\n"
14843 " struct guestfs_lvm_pv *val; /* Elements. */\n"
14849 #: ../src/guestfs-structs.pod:41
14852 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
14853 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
14858 #: ../src/guestfs-structs.pod:44
14859 msgid "guestfs_lvm_vg"
14863 #: ../src/guestfs-structs.pod:46
14866 " struct guestfs_lvm_vg {\n"
14867 " char *vg_name;\n"
14868 " /* The next field is NOT nul-terminated, be careful when printing it: "
14870 " char vg_uuid[32];\n"
14872 " char *vg_attr;\n"
14873 " uint64_t vg_size;\n"
14874 " uint64_t vg_free;\n"
14875 " char *vg_sysid;\n"
14876 " uint64_t vg_extent_size;\n"
14877 " int64_t vg_extent_count;\n"
14878 " int64_t vg_free_count;\n"
14879 " int64_t max_lv;\n"
14880 " int64_t max_pv;\n"
14881 " int64_t pv_count;\n"
14882 " int64_t lv_count;\n"
14883 " int64_t snap_count;\n"
14884 " int64_t vg_seqno;\n"
14885 " char *vg_tags;\n"
14886 " int64_t vg_mda_count;\n"
14887 " uint64_t vg_mda_free;\n"
14893 #: ../src/guestfs-structs.pod:69
14896 " struct guestfs_lvm_vg_list {\n"
14897 " uint32_t len; /* Number of elements in list. */\n"
14898 " struct guestfs_lvm_vg *val; /* Elements. */\n"
14904 #: ../src/guestfs-structs.pod:74
14907 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
14908 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
14913 #: ../src/guestfs-structs.pod:77
14914 msgid "guestfs_lvm_lv"
14918 #: ../src/guestfs-structs.pod:79
14921 " struct guestfs_lvm_lv {\n"
14922 " char *lv_name;\n"
14923 " /* The next field is NOT nul-terminated, be careful when printing it: "
14925 " char lv_uuid[32];\n"
14926 " char *lv_attr;\n"
14927 " int64_t lv_major;\n"
14928 " int64_t lv_minor;\n"
14929 " int64_t lv_kernel_major;\n"
14930 " int64_t lv_kernel_minor;\n"
14931 " uint64_t lv_size;\n"
14932 " int64_t seg_count;\n"
14934 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
14935 " float snap_percent;\n"
14936 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
14937 " float copy_percent;\n"
14938 " char *move_pv;\n"
14939 " char *lv_tags;\n"
14940 " char *mirror_log;\n"
14941 " char *modules;\n"
14947 #: ../src/guestfs-structs.pod:101
14950 " struct guestfs_lvm_lv_list {\n"
14951 " uint32_t len; /* Number of elements in list. */\n"
14952 " struct guestfs_lvm_lv *val; /* Elements. */\n"
14958 #: ../src/guestfs-structs.pod:106
14961 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
14962 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
14967 #: ../src/guestfs-structs.pod:111
14970 " struct guestfs_stat {\n"
14974 " int64_t nlink;\n"
14979 " int64_t blksize;\n"
14980 " int64_t blocks;\n"
14981 " int64_t atime;\n"
14982 " int64_t mtime;\n"
14983 " int64_t ctime;\n"
14989 #: ../src/guestfs-structs.pod:127
14992 " struct guestfs_stat_list {\n"
14993 " uint32_t len; /* Number of elements in list. */\n"
14994 " struct guestfs_stat *val; /* Elements. */\n"
15000 #: ../src/guestfs-structs.pod:132
15003 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
15004 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
15009 #: ../src/guestfs-structs.pod:137
15012 " struct guestfs_statvfs {\n"
15013 " int64_t bsize;\n"
15014 " int64_t frsize;\n"
15015 " int64_t blocks;\n"
15016 " int64_t bfree;\n"
15017 " int64_t bavail;\n"
15018 " int64_t files;\n"
15019 " int64_t ffree;\n"
15020 " int64_t favail;\n"
15023 " int64_t namemax;\n"
15029 #: ../src/guestfs-structs.pod:151
15032 " struct guestfs_statvfs_list {\n"
15033 " uint32_t len; /* Number of elements in list. */\n"
15034 " struct guestfs_statvfs *val; /* Elements. */\n"
15040 #: ../src/guestfs-structs.pod:156
15043 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
15044 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
15049 #: ../src/guestfs-structs.pod:159
15050 msgid "guestfs_dirent"
15054 #: ../src/guestfs-structs.pod:161
15057 " struct guestfs_dirent {\n"
15066 #: ../src/guestfs-structs.pod:167
15069 " struct guestfs_dirent_list {\n"
15070 " uint32_t len; /* Number of elements in list. */\n"
15071 " struct guestfs_dirent *val; /* Elements. */\n"
15077 #: ../src/guestfs-structs.pod:172
15080 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
15081 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
15086 #: ../src/guestfs-structs.pod:177
15089 " struct guestfs_version {\n"
15090 " int64_t major;\n"
15091 " int64_t minor;\n"
15092 " int64_t release;\n"
15099 #: ../src/guestfs-structs.pod:184
15102 " struct guestfs_version_list {\n"
15103 " uint32_t len; /* Number of elements in list. */\n"
15104 " struct guestfs_version *val; /* Elements. */\n"
15110 #: ../src/guestfs-structs.pod:189
15113 " void guestfs_free_version (struct guestfs_free_version *);\n"
15114 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
15119 #: ../src/guestfs-structs.pod:192
15120 msgid "guestfs_xattr"
15124 #: ../src/guestfs-structs.pod:194
15127 " struct guestfs_xattr {\n"
15128 " char *attrname;\n"
15129 " /* The next two fields describe a byte array. */\n"
15130 " uint32_t attrval_len;\n"
15131 " char *attrval;\n"
15137 #: ../src/guestfs-structs.pod:201
15140 " struct guestfs_xattr_list {\n"
15141 " uint32_t len; /* Number of elements in list. */\n"
15142 " struct guestfs_xattr *val; /* Elements. */\n"
15148 #: ../src/guestfs-structs.pod:206
15151 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
15152 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
15157 #: ../src/guestfs-structs.pod:209
15158 msgid "guestfs_inotify_event"
15162 #: ../src/guestfs-structs.pod:211
15165 " struct guestfs_inotify_event {\n"
15166 " int64_t in_wd;\n"
15167 " uint32_t in_mask;\n"
15168 " uint32_t in_cookie;\n"
15169 " char *in_name;\n"
15175 #: ../src/guestfs-structs.pod:218
15178 " struct guestfs_inotify_event_list {\n"
15179 " uint32_t len; /* Number of elements in list. */\n"
15180 " struct guestfs_inotify_event *val; /* Elements. */\n"
15186 #: ../src/guestfs-structs.pod:223
15189 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
15190 " void guestfs_free_inotify_event_list (struct "
15191 "guestfs_free_inotify_event_list *);\n"
15196 #: ../src/guestfs-structs.pod:226
15197 msgid "guestfs_partition"
15201 #: ../src/guestfs-structs.pod:228
15204 " struct guestfs_partition {\n"
15205 " int32_t part_num;\n"
15206 " uint64_t part_start;\n"
15207 " uint64_t part_end;\n"
15208 " uint64_t part_size;\n"
15214 #: ../src/guestfs-structs.pod:235
15217 " struct guestfs_partition_list {\n"
15218 " uint32_t len; /* Number of elements in list. */\n"
15219 " struct guestfs_partition *val; /* Elements. */\n"
15225 #: ../src/guestfs-structs.pod:240
15228 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
15229 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
15234 #: ../fish/guestfish.pod:5
15235 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
15239 #: ../fish/guestfish.pod:9
15242 " guestfish [--options] [commands]\n"
15247 #: ../fish/guestfish.pod:11
15255 #: ../fish/guestfish.pod:13
15258 " guestfish -a disk.img\n"
15263 #: ../fish/guestfish.pod:15
15266 " guestfish -a disk.img -m dev[:mountpoint]\n"
15271 #: ../fish/guestfish.pod:17
15274 " guestfish -d libvirt-domain\n"
15279 #: ../fish/guestfish.pod:19
15282 " guestfish -a disk.img -i\n"
15287 #: ../fish/guestfish.pod:21
15290 " guestfish -d libvirt-domain -i\n"
15295 #: ../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
15300 #: ../fish/guestfish.pod:25
15302 "Using guestfish in read/write mode on live virtual machines can be "
15303 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
15304 "option to use guestfish safely if the disk image or virtual machine might be "
15309 #: ../fish/guestfish.pod:32
15311 "Guestfish is a shell and command-line tool for examining and modifying "
15312 "virtual machine filesystems. It uses libguestfs and exposes all of the "
15313 "functionality of the guestfs API, see L<guestfs(3)>."
15317 #: ../fish/guestfish.pod:36
15319 "Guestfish gives you structured access to the libguestfs API, from shell "
15320 "scripts or the command line or interactively. If you want to rescue a "
15321 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
15326 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:800 ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58 ../tools/virt-resize.pl:66 ../tools/virt-cat.pl:50 ../tools/virt-tar.pl:45
15331 #: ../fish/guestfish.pod:43
15332 msgid "As an interactive shell"
15336 #: ../fish/guestfish.pod:45
15344 #: ../fish/guestfish.pod:47
15347 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
15348 " editing virtual machine filesystems.\n"
15353 #: ../fish/guestfish.pod:50
15356 " Type: 'help' for a list of commands\n"
15357 " 'man' to read the manual\n"
15358 " 'quit' to quit the shell\n"
15363 #: ../fish/guestfish.pod:54
15366 " ><fs> add-ro disk.img\n"
15368 " ><fs> list-filesystems\n"
15369 " /dev/sda1: ext4\n"
15370 " /dev/vg_guest/lv_root: ext4\n"
15371 " /dev/vg_guest/lv_swap: swap\n"
15372 " ><fs> mount /dev/vg_guest/lv_root /\n"
15373 " ><fs> cat /etc/fstab\n"
15375 " # Created by anaconda\n"
15382 #: ../fish/guestfish.pod:67
15383 msgid "From shell scripts"
15387 #: ../fish/guestfish.pod:69
15388 msgid "Create a new C</etc/motd> file in a guest or disk image:"
15392 #: ../fish/guestfish.pod:71
15395 " guestfish <<_EOF_\n"
15398 " mount /dev/vg_guest/lv_root /\n"
15399 " write /etc/motd \"Welcome, new users\"\n"
15405 #: ../fish/guestfish.pod:78
15406 msgid "List the LVM logical volumes in a disk image:"
15410 #: ../fish/guestfish.pod:80
15413 " guestfish -a disk.img --ro <<_EOF_\n"
15421 #: ../fish/guestfish.pod:85
15422 msgid "List all the filesystems in a disk image:"
15426 #: ../fish/guestfish.pod:87
15429 " guestfish -a disk.img --ro <<_EOF_\n"
15431 " list-filesystems\n"
15437 #: ../fish/guestfish.pod:92
15438 msgid "On one command line"
15442 #: ../fish/guestfish.pod:94
15443 msgid "Update C</etc/resolv.conf> in a guest:"
15447 #: ../fish/guestfish.pod:96
15451 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
15452 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
15457 #: ../fish/guestfish.pod:100
15458 msgid "Edit C</boot/grub/grub.conf> interactively:"
15462 #: ../fish/guestfish.pod:102
15465 " guestfish --add disk.img \\\n"
15466 " --mount /dev/vg_guest/lv_root \\\n"
15467 " --mount /dev/sda1:/boot \\\n"
15468 " edit /boot/grub/grub.conf\n"
15473 #: ../fish/guestfish.pod:107
15474 msgid "Mount disks automatically"
15478 #: ../fish/guestfish.pod:109
15480 "Use the I<-i> option to automatically mount the disks from a virtual "
15485 #: ../fish/guestfish.pod:112
15488 " guestfish --ro -a disk.img -i cat /etc/group\n"
15493 #: ../fish/guestfish.pod:114
15496 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
15501 #: ../fish/guestfish.pod:116
15502 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
15506 #: ../fish/guestfish.pod:118
15509 " guestfish -a disk.img -i edit /boot/grub/grub.conf\n"
15514 #: ../fish/guestfish.pod:120
15515 msgid "As a script interpreter"
15519 #: ../fish/guestfish.pod:122
15520 msgid "Create a 100MB disk containing an ext2-formatted partition:"
15524 #: ../fish/guestfish.pod:124
15527 " #!/usr/bin/guestfish -f\n"
15528 " sparse test1.img 100M\n"
15530 " part-disk /dev/sda mbr\n"
15531 " mkfs ext2 /dev/sda1\n"
15536 #: ../fish/guestfish.pod:130
15537 msgid "Start with a prepared disk"
15541 #: ../fish/guestfish.pod:132
15543 "An alternate way to create a 100MB disk called C<test1.img> containing a "
15544 "single ext2-formatted partition:"
15548 #: ../fish/guestfish.pod:135
15551 " guestfish -N fs\n"
15556 #: ../fish/guestfish.pod:137
15557 msgid "To list what is available do:"
15561 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:791
15564 " guestfish -N help | less\n"
15569 #: ../fish/guestfish.pod:141
15570 msgid "Remote control"
15574 #: ../fish/guestfish.pod:143
15577 " eval `guestfish --listen`\n"
15578 " guestfish --remote add-ro disk.img\n"
15579 " guestfish --remote run\n"
15580 " guestfish --remote lvs\n"
15585 #: ../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
15590 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:124 ../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
15595 #: ../fish/guestfish.pod:154
15596 msgid "Displays general help on options."
15600 #: ../fish/guestfish.pod:156
15601 msgid "B<-h> | B<--cmd-help>"
15605 #: ../fish/guestfish.pod:158
15606 msgid "Lists all available guestfish commands."
15610 #: ../fish/guestfish.pod:160
15611 msgid "B<-h cmd> | B<--cmd-help cmd>"
15615 #: ../fish/guestfish.pod:162
15616 msgid "Displays detailed help on a single command C<cmd>."
15620 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
15621 msgid "B<-a image> | B<--add image>"
15625 #: ../fish/guestfish.pod:166
15626 msgid "Add a block device or virtual machine image to the shell."
15630 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
15632 "The format of the disk image is auto-detected. To override this and force a "
15633 "particular format use the I<--format=..> option."
15637 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
15638 msgid "B<-c URI> | B<--connect URI>"
15642 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
15644 "When used in conjunction with the I<-d> option, this specifies the libvirt "
15645 "URI to use. The default is to use the default libvirt connection."
15649 #: ../fish/guestfish.pod:177 ../fuse/guestmount.pod:90
15650 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
15654 #: ../fish/guestfish.pod:179 ../fuse/guestmount.pod:92
15656 "Add disks from the named libvirt domain. If the I<--ro> option is also "
15657 "used, then any libvirt domain can be used. However in write mode, only "
15658 "libvirt domains which are shut down can be named here."
15662 #: ../fish/guestfish.pod:183
15663 msgid "B<-D> | B<--no-dest-paths>"
15667 #: ../fish/guestfish.pod:185
15669 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
15670 "to hit the tab key to complete paths on the guest filesystem, but this "
15671 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
15672 "allow this feature to be disabled."
15676 #: ../fish/guestfish.pod:190
15677 msgid "B<--echo-keys>"
15681 #: ../fish/guestfish.pod:192
15683 "When prompting for keys and passphrases, guestfish normally turns echoing "
15684 "off so you cannot see what you are typing. If you are not worried about "
15685 "Tempest attacks and there is no one else in the room you can specify this "
15686 "flag to see what you are typing."
15690 #: ../fish/guestfish.pod:197
15691 msgid "B<-f file> | B<--file file>"
15695 #: ../fish/guestfish.pod:199
15696 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
15700 #: ../fish/guestfish.pod:202
15703 " #!/usr/bin/guestfish -f\n"
15708 #: ../fish/guestfish.pod:204 ../fuse/guestmount.pod:108
15709 msgid "B<--format=raw|qcow2|..> | B<--format>"
15713 #: ../fish/guestfish.pod:206 ../fuse/guestmount.pod:110
15715 "The default for the I<-a> option is to auto-detect the format of the disk "
15716 "image. Using this forces the disk format for I<-a> options which follow on "
15717 "the command line. Using I<--format> with no argument switches back to "
15718 "auto-detection for subsequent I<-a> options."
15722 #: ../fish/guestfish.pod:211 ../fish/guestfish.pod:504 ../inspector/virt-inspector.pl:549
15723 msgid "For example:"
15727 #: ../fish/guestfish.pod:213
15730 " guestfish --format=raw -a disk.img\n"
15735 #: ../fish/guestfish.pod:215
15736 msgid "forces raw format (no auto-detection) for C<disk.img>."
15740 #: ../fish/guestfish.pod:217
15743 " guestfish --format=raw -a disk.img --format -a another.img\n"
15748 #: ../fish/guestfish.pod:219
15750 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
15751 "auto-detection for C<another.img>."
15755 #: ../fish/guestfish.pod:222
15757 "If you have untrusted raw-format guest disk images, you should use this "
15758 "option to specify the disk format. This avoids a possible security problem "
15759 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
15763 #: ../fish/guestfish.pod:227 ../fuse/guestmount.pod:128
15764 msgid "B<-i> | B<--inspector>"
15768 #: ../fish/guestfish.pod:229 ../fuse/guestmount.pod:130
15770 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
15771 "system and mount filesystems as they would be mounted on the real virtual "
15776 #: ../fish/guestfish.pod:233
15777 msgid "Typical usage is either:"
15781 #: ../fish/guestfish.pod:235
15784 " guestfish -d myguest -i\n"
15789 #: ../fish/guestfish.pod:237
15790 msgid "(for an inactive libvirt domain called I<myguest>), or:"
15794 #: ../fish/guestfish.pod:239
15797 " guestfish --ro -d myguest -i\n"
15802 #: ../fish/guestfish.pod:241
15803 msgid "(for active domains, readonly), or specify the block device directly:"
15807 #: ../fish/guestfish.pod:243
15810 " guestfish -a /dev/Guests/MyGuest -i\n"
15815 #: ../fish/guestfish.pod:245
15817 "Note that the command line syntax changed slightly over older versions of "
15818 "guestfish. You can still use the old syntax:"
15822 #: ../fish/guestfish.pod:248
15825 " guestfish [--ro] -i disk.img\n"
15830 #: ../fish/guestfish.pod:250
15833 " guestfish [--ro] -i libvirt-domain\n"
15838 #: ../fish/guestfish.pod:252
15839 msgid "B<--keys-from-stdin>"
15843 #: ../fish/guestfish.pod:254
15845 "Read key or passphrase parameters from stdin. The default is to try to read "
15846 "passphrases from the user by opening C</dev/tty>."
15850 #: ../fish/guestfish.pod:257
15851 msgid "B<--listen>"
15855 #: ../fish/guestfish.pod:259
15857 "Fork into the background and listen for remote commands. See section "
15858 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
15862 #: ../fish/guestfish.pod:262
15863 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
15867 #: ../fish/guestfish.pod:264
15868 msgid "Mount the named partition or logical volume on the given mountpoint."
15872 #: ../fish/guestfish.pod:266
15873 msgid "If the mountpoint is omitted, it defaults to C</>."
15877 #: ../fish/guestfish.pod:268
15878 msgid "You have to mount something on C</> before most commands will work."
15882 #: ../fish/guestfish.pod:270
15884 "If any I<-m> or I<--mount> options are given, the guest is automatically "
15889 #: ../fish/guestfish.pod:273
15891 "If you don't know what filesystems a disk image contains, you can either run "
15892 "guestfish without this option, then list the partitions and LVs available "
15893 "(see L</list-partitions> and L</lvs> commands), or you can use the "
15894 "L<virt-list-filesystems(1)> program."
15898 #: ../fish/guestfish.pod:278 ../fuse/guestmount.pod:142
15899 msgid "B<-n> | B<--no-sync>"
15903 #: ../fish/guestfish.pod:280
15905 "Disable autosync. This is enabled by default. See the discussion of "
15906 "autosync in the L<guestfs(3)> manpage."
15910 #: ../fish/guestfish.pod:283
15911 msgid "B<-N type> | B<--new type> | B<-N help>"
15915 #: ../fish/guestfish.pod:285
15917 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
15918 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
15919 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
15924 #: ../fish/guestfish.pod:290
15925 msgid "B<--progress-bars>"
15929 #: ../fish/guestfish.pod:292
15930 msgid "Enable progress bars, even when guestfish is used non-interactively."
15934 #: ../fish/guestfish.pod:294
15936 "Progress bars are enabled by default when guestfish is used as an "
15937 "interactive shell."
15941 #: ../fish/guestfish.pod:297
15942 msgid "B<--no-progress-bars>"
15946 #: ../fish/guestfish.pod:299
15947 msgid "Disable progress bars."
15951 #: ../fish/guestfish.pod:301
15952 msgid "B<--remote[=pid]>"
15956 #: ../fish/guestfish.pod:303
15958 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
15959 "CONTROL GUESTFISH OVER A SOCKET> below."
15963 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:184
15964 msgid "B<-r> | B<--ro>"
15968 #: ../fish/guestfish.pod:308
15970 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
15971 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
15975 #: ../fish/guestfish.pod:311 ../tools/virt-rescue.pl:187
15977 "The option must always be used if the disk image or virtual machine might be "
15978 "running, and is generally recommended in cases where you don't need write "
15979 "access to the disk."
15983 #: ../fish/guestfish.pod:315
15985 "Note that prepared disk images created with I<-N> are not affected by the "
15990 #: ../fish/guestfish.pod:318 ../fuse/guestmount.pod:194 ../tools/virt-rescue.pl:195
15991 msgid "B<--selinux>"
15995 #: ../fish/guestfish.pod:320
15996 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
16000 #: ../fish/guestfish.pod:322 ../fuse/guestmount.pod:198
16001 msgid "B<-v> | B<--verbose>"
16005 #: ../fish/guestfish.pod:324
16007 "Enable very verbose messages. This is particularly useful if you find a "
16012 #: ../fish/guestfish.pod:327 ../fuse/guestmount.pod:202
16013 msgid "B<-V> | B<--version>"
16017 #: ../fish/guestfish.pod:329
16018 msgid "Display the guestfish / libguestfs version number and exit."
16022 #: ../fish/guestfish.pod:331
16027 #: ../fish/guestfish.pod:333
16028 msgid "Echo each command before executing it."
16032 #: ../fish/guestfish.pod:337
16033 msgid "COMMANDS ON COMMAND LINE"
16037 #: ../fish/guestfish.pod:339
16038 msgid "Any additional (non-option) arguments are treated as commands to execute."
16042 #: ../fish/guestfish.pod:342
16044 "Commands to execute should be separated by a colon (C<:>), where the colon "
16045 "is a separate parameter. Thus:"
16049 #: ../fish/guestfish.pod:345
16052 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
16057 #: ../fish/guestfish.pod:347
16059 "If there are no additional arguments, then we enter a shell, either an "
16060 "interactive shell with a prompt (if the input is a terminal) or a "
16061 "non-interactive shell."
16065 #: ../fish/guestfish.pod:351
16067 "In either command line mode or non-interactive shell, the first command that "
16068 "gives an error causes the whole shell to exit. In interactive mode (with a "
16069 "prompt) if a command fails, you can continue to enter commands."
16073 #: ../fish/guestfish.pod:356
16074 msgid "USING launch (OR run)"
16078 #: ../fish/guestfish.pod:358
16080 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
16081 "then launch it, then mount any disks you need, and finally issue "
16082 "actions/commands. So the general order of the day is:"
16086 #: ../fish/guestfish.pod:366
16087 msgid "add or -a/--add"
16091 #: ../fish/guestfish.pod:370
16092 msgid "launch (aka run)"
16096 #: ../fish/guestfish.pod:374
16097 msgid "mount or -m/--mount"
16101 #: ../fish/guestfish.pod:378
16102 msgid "any other commands"
16106 #: ../fish/guestfish.pod:382
16108 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
16109 "guest before mounting or performing any other commands."
16113 #: ../fish/guestfish.pod:385
16115 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
16116 "I<--new> options were given then C<run> is done automatically, simply "
16117 "because guestfish can't perform the action you asked for without doing this."
16121 #: ../fish/guestfish.pod:390
16126 #: ../fish/guestfish.pod:392
16128 "You can quote ordinary parameters using either single or double quotes. For "
16133 #: ../fish/guestfish.pod:395
16136 " add \"file with a space.img\"\n"
16141 #: ../fish/guestfish.pod:397
16144 " rm '/file name'\n"
16149 #: ../fish/guestfish.pod:399
16157 #: ../fish/guestfish.pod:401
16159 "A few commands require a list of strings to be passed. For these, use a "
16160 "whitespace-separated list, enclosed in quotes. Strings containing "
16161 "whitespace to be passed through must be enclosed in single quotes. A "
16162 "literal single quote must be escaped with a backslash."
16166 #: ../fish/guestfish.pod:406
16169 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
16170 " command \"/bin/echo 'foo bar'\"\n"
16171 " command \"/bin/echo \\'foo\\'\"\n"
16176 #: ../fish/guestfish.pod:410
16177 msgid "OPTIONAL ARGUMENTS"
16181 #: ../fish/guestfish.pod:412
16183 "Some commands take optional arguments. These arguments appear in this "
16184 "documentation as C<[argname:..]>. You can use them as in these examples:"
16188 #: ../fish/guestfish.pod:416
16191 " add-drive-opts filename\n"
16196 #: ../fish/guestfish.pod:418
16199 " add-drive-opts filename readonly:true\n"
16204 #: ../fish/guestfish.pod:420
16207 " add-drive-opts filename format:qcow2 readonly:false\n"
16212 #: ../fish/guestfish.pod:422
16214 "Each optional argument can appear at most once. All optional arguments must "
16215 "appear after the required ones."
16219 #: ../fish/guestfish.pod:425
16224 #: ../fish/guestfish.pod:427
16225 msgid "This section applies to all commands which can take integers as parameters."
16229 #: ../fish/guestfish.pod:430
16230 msgid "SIZE SUFFIX"
16234 #: ../fish/guestfish.pod:432
16236 "When the command takes a parameter measured in bytes, you can use one of the "
16237 "following suffixes to specify kilobytes, megabytes and larger sizes:"
16241 #: ../fish/guestfish.pod:438
16242 msgid "B<k> or B<K> or B<KiB>"
16246 #: ../fish/guestfish.pod:440
16247 msgid "The size in kilobytes (multiplied by 1024)."
16251 #: ../fish/guestfish.pod:442
16256 #: ../fish/guestfish.pod:444
16257 msgid "The size in SI 1000 byte units."
16261 #: ../fish/guestfish.pod:446
16262 msgid "B<M> or B<MiB>"
16266 #: ../fish/guestfish.pod:448
16267 msgid "The size in megabytes (multiplied by 1048576)."
16271 #: ../fish/guestfish.pod:450
16276 #: ../fish/guestfish.pod:452
16277 msgid "The size in SI 1000000 byte units."
16281 #: ../fish/guestfish.pod:454
16282 msgid "B<G> or B<GiB>"
16286 #: ../fish/guestfish.pod:456
16287 msgid "The size in gigabytes (multiplied by 2**30)."
16291 #: ../fish/guestfish.pod:458
16296 #: ../fish/guestfish.pod:460
16297 msgid "The size in SI 10**9 byte units."
16301 #: ../fish/guestfish.pod:462
16302 msgid "B<T> or B<TiB>"
16306 #: ../fish/guestfish.pod:464
16307 msgid "The size in terabytes (multiplied by 2**40)."
16311 #: ../fish/guestfish.pod:466
16316 #: ../fish/guestfish.pod:468
16317 msgid "The size in SI 10**12 byte units."
16321 #: ../fish/guestfish.pod:470
16322 msgid "B<P> or B<PiB>"
16326 #: ../fish/guestfish.pod:472
16327 msgid "The size in petabytes (multiplied by 2**50)."
16331 #: ../fish/guestfish.pod:474
16336 #: ../fish/guestfish.pod:476
16337 msgid "The size in SI 10**15 byte units."
16341 #: ../fish/guestfish.pod:478
16342 msgid "B<E> or B<EiB>"
16346 #: ../fish/guestfish.pod:480
16347 msgid "The size in exabytes (multiplied by 2**60)."
16351 #: ../fish/guestfish.pod:482
16356 #: ../fish/guestfish.pod:484
16357 msgid "The size in SI 10**18 byte units."
16361 #: ../fish/guestfish.pod:486
16362 msgid "B<Z> or B<ZiB>"
16366 #: ../fish/guestfish.pod:488
16367 msgid "The size in zettabytes (multiplied by 2**70)."
16371 #: ../fish/guestfish.pod:490
16376 #: ../fish/guestfish.pod:492
16377 msgid "The size in SI 10**21 byte units."
16381 #: ../fish/guestfish.pod:494
16382 msgid "B<Y> or B<YiB>"
16386 #: ../fish/guestfish.pod:496
16387 msgid "The size in yottabytes (multiplied by 2**80)."
16391 #: ../fish/guestfish.pod:498
16396 #: ../fish/guestfish.pod:500
16397 msgid "The size in SI 10**24 byte units."
16401 #: ../fish/guestfish.pod:506
16404 " truncate-size /file 1G\n"
16409 #: ../fish/guestfish.pod:508
16410 msgid "would truncate the file to 1 gigabyte."
16414 #: ../fish/guestfish.pod:510
16416 "Be careful because a few commands take sizes in kilobytes or megabytes "
16417 "(eg. the parameter to L</memsize> is specified in megabytes already). "
16418 "Adding a suffix will probably not do what you expect."
16422 #: ../fish/guestfish.pod:514
16423 msgid "OCTAL AND HEXADECIMAL NUMBERS"
16427 #: ../fish/guestfish.pod:516
16429 "For specifying the radix (base) use the C convention: C<0> to prefix an "
16430 "octal number or C<0x> to prefix a hexadecimal number. For example:"
16434 #: ../fish/guestfish.pod:519
16437 " 1234 decimal number 1234\n"
16438 " 02322 octal number, equivalent to decimal 1234\n"
16439 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
16444 #: ../fish/guestfish.pod:523
16446 "When using the C<chmod> command, you almost always want to specify an octal "
16447 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
16448 "L<chmod(1)> program):"
16452 #: ../fish/guestfish.pod:527
16455 " chmod 0777 /public # OK\n"
16456 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
16461 #: ../fish/guestfish.pod:530
16463 "Commands that return numbers usually print them in decimal, but some "
16464 "commands print numbers in other radices (eg. C<umask> prints the mode in "
16465 "octal, preceeded by C<0>)."
16469 #: ../fish/guestfish.pod:534
16470 msgid "WILDCARDS AND GLOBBING"
16474 #: ../fish/guestfish.pod:536
16476 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
16477 "(globbing) by default. So for example the following will not do what you "
16482 #: ../fish/guestfish.pod:540
16490 #: ../fish/guestfish.pod:542
16492 "Assuming you don't have a directory called literally C</home/*> then the "
16493 "above command will return an error."
16497 #: ../fish/guestfish.pod:545
16498 msgid "To perform wildcard expansion, use the C<glob> command."
16502 #: ../fish/guestfish.pod:547
16505 " glob rm-rf /home/*\n"
16510 #: ../fish/guestfish.pod:549
16512 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
16513 "many times), equivalent to:"
16517 #: ../fish/guestfish.pod:552
16520 " rm-rf /home/jim\n"
16521 " rm-rf /home/joe\n"
16522 " rm-rf /home/mary\n"
16527 #: ../fish/guestfish.pod:556
16528 msgid "C<glob> only works on simple guest paths and not on device names."
16532 #: ../fish/guestfish.pod:558
16534 "If you have several parameters, each containing a wildcard, then glob will "
16535 "perform a Cartesian product."
16539 #: ../fish/guestfish.pod:561
16544 #: ../fish/guestfish.pod:563
16546 "Any line which starts with a I<#> character is treated as a comment and "
16547 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
16548 "a command. For example:"
16552 #: ../fish/guestfish.pod:567
16555 " # this is a comment\n"
16556 " # this is a comment\n"
16557 " foo # NOT a comment\n"
16562 #: ../fish/guestfish.pod:571
16563 msgid "Blank lines are also ignored."
16567 #: ../fish/guestfish.pod:573
16568 msgid "RUNNING COMMANDS LOCALLY"
16572 #: ../fish/guestfish.pod:575
16574 "Any line which starts with a I<!> character is treated as a command sent to "
16575 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
16579 #: ../fish/guestfish.pod:579
16583 " tgz-out /remote local/remote-data.tar.gz\n"
16588 #: ../fish/guestfish.pod:582
16590 "will create a directory C<local> on the host, and then export the contents "
16591 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
16592 "(See C<tgz-out>)."
16596 #: ../fish/guestfish.pod:586
16598 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
16599 "effect, due to the way that subprocesses work in Unix."
16603 #: ../fish/guestfish.pod:589
16608 #: ../fish/guestfish.pod:591
16610 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
16611 "command (a guestfish command) to the second command (any host command). For "
16616 #: ../fish/guestfish.pod:595
16619 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
16624 #: ../fish/guestfish.pod:597
16626 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
16627 "program). The above command would list all accounts in the guest filesystem "
16628 "which have UID 0, ie. root accounts including backdoors. Other examples:"
16632 #: ../fish/guestfish.pod:602
16635 " hexdump /bin/ls | head\n"
16636 " list-devices | tail -1\n"
16637 " tgz-out / - | tar ztf -\n"
16642 #: ../fish/guestfish.pod:606
16644 "The space before the pipe symbol is required, any space after the pipe "
16645 "symbol is optional. Everything after the pipe symbol is just passed "
16646 "straight to the host shell, so it can contain redirections, globs and "
16647 "anything else that makes sense on the host side."
16651 #: ../fish/guestfish.pod:611
16653 "To use a literal argument which begins with a pipe symbol, you have to quote "
16658 #: ../fish/guestfish.pod:614
16666 #: ../fish/guestfish.pod:616
16667 msgid "HOME DIRECTORIES"
16671 #: ../fish/guestfish.pod:618
16673 "If a parameter starts with the character C<~> then the tilde may be expanded "
16674 "as a home directory path (either C<~> for the current user's home directory, "
16675 "or C<~user> for another user)."
16679 #: ../fish/guestfish.pod:622
16681 "Note that home directory expansion happens for users known I<on the host>, "
16682 "not in the guest filesystem."
16686 #: ../fish/guestfish.pod:625
16688 "To use a literal argument which begins with a tilde, you have to quote it, "
16693 #: ../fish/guestfish.pod:628
16701 #: ../fish/guestfish.pod:632
16703 "Libguestfs has some support for Linux guests encrypted according to the "
16704 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
16705 "disk encryption systems used by modern Linux guests. Currently only "
16706 "LVM-on-LUKS is supported."
16710 #: ../fish/guestfish.pod:637
16711 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
16715 #: ../fish/guestfish.pod:639
16718 " ><fs> vfs-type /dev/sda2\n"
16724 #: ../fish/guestfish.pod:642
16726 "Then open those devices using L</luks-open>. This creates a device-mapper "
16727 "device called C</dev/mapper/luksdev>."
16731 #: ../fish/guestfish.pod:645
16734 " ><fs> luks-open /dev/sda2 luksdev\n"
16735 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
16740 #: ../fish/guestfish.pod:648
16742 "Finally you have to tell LVM to scan for volume groups on the newly created "
16747 #: ../fish/guestfish.pod:651
16751 " vg-activate-all true\n"
16756 #: ../fish/guestfish.pod:654
16757 msgid "The logical volume(s) can now be mounted in the usual way."
16761 #: ../fish/guestfish.pod:656
16763 "Before closing a LUKS device you must unmount any logical volumes on it and "
16764 "deactivate the volume groups by calling C<vg-activate false VG> on each "
16765 "one. Then you can close the mapper device:"
16769 #: ../fish/guestfish.pod:660
16772 " vg-activate false /dev/VG\n"
16773 " luks-close /dev/mapper/luksdev\n"
16778 #: ../fish/guestfish.pod:663
16779 msgid "WINDOWS PATHS"
16783 #: ../fish/guestfish.pod:665
16785 "If a path is prefixed with C<win:> then you can use Windows-style paths "
16786 "(with some limitations). The following commands are equivalent:"
16790 #: ../fish/guestfish.pod:668
16793 " file /WINDOWS/system32/config/system.LOG\n"
16798 #: ../fish/guestfish.pod:670
16801 " file win:/windows/system32/config/system.log\n"
16806 #: ../fish/guestfish.pod:672
16809 " file win:\\windows\\system32\\config\\system.log\n"
16814 #: ../fish/guestfish.pod:674
16817 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
16822 #: ../fish/guestfish.pod:676
16824 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
16825 "handles case insensitivity like Windows would. This only works in argument "
16826 "positions that expect a path."
16830 #: ../fish/guestfish.pod:680
16831 msgid "UPLOADING AND DOWNLOADING FILES"
16835 #: ../fish/guestfish.pod:682
16837 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
16838 "others which upload from or download to a local file, you can use the "
16839 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
16843 #: ../fish/guestfish.pod:686
16851 #: ../fish/guestfish.pod:688
16852 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
16856 #: ../fish/guestfish.pod:691
16859 " tar-out /etc - | tar tf -\n"
16864 #: ../fish/guestfish.pod:693
16866 "writes the tarball to stdout and then pipes that into the external \"tar\" "
16867 "command (see L</PIPES>)."
16871 #: ../fish/guestfish.pod:696
16873 "When using C<-> to read from stdin, the input is read up to the end of "
16874 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
16875 "some arbitrary end marker:"
16879 #: ../fish/guestfish.pod:700
16882 " upload -<<END /foo\n"
16891 #: ../fish/guestfish.pod:706
16893 "Any string of characters can be used instead of C<END>. The end marker must "
16894 "appear on a line of its own, without any preceeding or following characters "
16895 "(not even spaces)."
16899 #: ../fish/guestfish.pod:710
16901 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
16902 "upload local files (so-called \"FileIn\" parameters in the generator)."
16906 #: ../fish/guestfish.pod:713
16907 msgid "EXIT ON ERROR BEHAVIOUR"
16911 #: ../fish/guestfish.pod:715
16913 "By default, guestfish will ignore any errors when in interactive mode "
16914 "(ie. taking commands from a human over a tty), and will exit on the first "
16915 "error in non-interactive mode (scripts, commands given on the command line)."
16919 #: ../fish/guestfish.pod:720
16921 "If you prefix a command with a I<-> character, then that command will not "
16922 "cause guestfish to exit, even if that (one) command returns an error."
16926 #: ../fish/guestfish.pod:724
16927 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
16931 #: ../fish/guestfish.pod:726
16933 "Guestfish can be remote-controlled over a socket. This is useful "
16934 "particularly in shell scripts where you want to make several different "
16935 "changes to a filesystem, but you don't want the overhead of starting up a "
16936 "guestfish process each time."
16940 #: ../fish/guestfish.pod:731
16941 msgid "Start a guestfish server process using:"
16945 #: ../fish/guestfish.pod:733
16948 " eval `guestfish --listen`\n"
16953 #: ../fish/guestfish.pod:735
16954 msgid "and then send it commands by doing:"
16958 #: ../fish/guestfish.pod:737
16961 " guestfish --remote cmd [...]\n"
16966 #: ../fish/guestfish.pod:739
16967 msgid "To cause the server to exit, send it the exit command:"
16971 #: ../fish/guestfish.pod:741
16974 " guestfish --remote exit\n"
16979 #: ../fish/guestfish.pod:743
16981 "Note that the server will normally exit if there is an error in a command. "
16982 "You can change this in the usual way. See section L</EXIT ON ERROR "
16987 #: ../fish/guestfish.pod:747
16988 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
16992 #: ../fish/guestfish.pod:749
16994 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
16995 "is how the I<--remote> option knows where to send the commands. You can "
16996 "have several guestfish listener processes running using:"
17000 #: ../fish/guestfish.pod:753
17003 " eval `guestfish --listen`\n"
17004 " pid1=$GUESTFISH_PID\n"
17005 " eval `guestfish --listen`\n"
17006 " pid2=$GUESTFISH_PID\n"
17008 " guestfish --remote=$pid1 cmd\n"
17009 " guestfish --remote=$pid2 cmd\n"
17014 #: ../fish/guestfish.pod:761
17015 msgid "REMOTE CONTROL DETAILS"
17019 #: ../fish/guestfish.pod:763
17021 "Remote control happens over a Unix domain socket called "
17022 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
17023 "of the process, and C<$PID> is the process ID of the server."
17027 #: ../fish/guestfish.pod:767
17028 msgid "Guestfish client and server versions must match exactly."
17032 #: ../fish/guestfish.pod:769
17033 msgid "PREPARED DISK IMAGES"
17037 #: ../fish/guestfish.pod:771
17039 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
17040 "preformatted disk images that guestfish can make for you to save typing. "
17041 "This is particularly useful for testing purposes. This option is used "
17042 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
17043 "can be mixed with I<-a>)."
17047 #: ../fish/guestfish.pod:777
17049 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
17050 "the second and so on. Existing files in the current directory are "
17055 #: ../fish/guestfish.pod:781
17057 "The type briefly describes how the disk should be sized, partitioned, how "
17058 "filesystem(s) should be created, and how content should be added. "
17059 "Optionally the type can be followed by extra parameters, separated by C<:> "
17060 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
17061 "sparsely-allocated disk, containing a single partition, with the partition "
17062 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
17063 "on a 1GB disk instead."
17067 #: ../fish/guestfish.pod:789
17068 msgid "To list the available types and any extra parameters they take, run:"
17072 #: ../fish/guestfish.pod:793
17074 "Note that the prepared filesystem is not mounted. You would usually have to "
17075 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
17079 #: ../fish/guestfish.pod:797
17081 "If any I<-N> or I<--new> options are given, the guest is automatically "
17086 #: ../fish/guestfish.pod:802
17087 msgid "Create a 100MB disk with an ext4-formatted partition:"
17091 #: ../fish/guestfish.pod:804
17094 " guestfish -N fs:ext4\n"
17099 #: ../fish/guestfish.pod:806
17100 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
17104 #: ../fish/guestfish.pod:808
17107 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
17112 #: ../fish/guestfish.pod:810
17113 msgid "Create a blank 200MB disk:"
17117 #: ../fish/guestfish.pod:812
17120 " guestfish -N disk:200M\n"
17125 #: ../fish/guestfish.pod:814
17126 msgid "PROGRESS BARS"
17130 #: ../fish/guestfish.pod:816
17132 "Some (not all) long-running commands send progress notification messages as "
17133 "they are running. Guestfish turns these messages into progress bars."
17137 #: ../fish/guestfish.pod:820
17139 "When a command that supports progress bars takes longer than two seconds to "
17140 "run, and if progress bars are enabled, then you will see one appearing below "
17145 #: ../fish/guestfish.pod:824
17148 " ><fs> copy-size /large-file /another-file 2048M\n"
17149 " / 10% [#####-----------------------------------------] 00:30\n"
17154 #: ../fish/guestfish.pod:827
17156 "The spinner on the left hand side moves round once for every progress "
17157 "notification received from the backend. This is a (reasonably) golden "
17158 "assurance that the command is \"doing something\" even if the progress bar "
17159 "is not moving, because the command is able to send the progress "
17160 "notifications. When the bar reaches 100% and the command finishes, the "
17161 "spinner disappears."
17165 #: ../fish/guestfish.pod:834
17167 "Progress bars are enabled by default when guestfish is used interactively. "
17168 "You can enable them even for non-interactive modes using I<--progress-bars>, "
17169 "and you can disable them completely using I<--no-progress-bars>."
17173 #: ../fish/guestfish.pod:839
17174 msgid "GUESTFISH COMMANDS"
17178 #: ../fish/guestfish.pod:841
17180 "The commands in this section are guestfish convenience commands, in other "
17181 "words, they are not part of the L<guestfs(3)> API."
17185 #: ../fish/guestfish.pod:844
17190 #: ../fish/guestfish.pod:846
17199 #: ../fish/guestfish.pod:849
17201 "Without any parameter, this lists all commands. With a C<cmd> parameter, "
17202 "this displays detailed help for a command."
17206 #: ../fish/guestfish.pod:852
17207 msgid "quit | exit"
17211 #: ../fish/guestfish.pod:854
17212 msgid "This exits guestfish. You can also use C<^D> key."
17216 #: ../fish/guestfish.pod:856
17217 msgid "@FISH_COMMANDS@"
17221 #: ../fish/guestfish.pod:858
17226 #: ../fish/guestfish.pod:862 ../test-tool/libguestfs-test-tool.pod:83
17231 #: ../fish/guestfish.pod:864
17233 "guestfish returns 0 if the commands completed without error, or 1 if there "
17238 #: ../fish/guestfish.pod:871
17243 #: ../fish/guestfish.pod:873
17245 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
17250 #: ../fish/guestfish.pod:876
17251 msgid "GUESTFISH_PID"
17255 #: ../fish/guestfish.pod:878
17257 "Used with the I<--remote> option to specify the remote guestfish process to "
17258 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
17262 #: ../fish/guestfish.pod:882
17267 #: ../fish/guestfish.pod:884
17269 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
17270 "not specified, the external L<hexedit(1)> program is used."
17274 #: ../fish/guestfish.pod:888
17279 #: ../fish/guestfish.pod:890
17281 "If compiled with GNU readline support, various files in the home directory "
17282 "can be used. See L</FILES>."
17286 #: ../fish/guestfish.pod:899
17288 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
17289 "effect as using the B<-v> option."
17293 #: ../fish/guestfish.pod:911
17295 "Set the path that guestfish uses to search for kernel and initrd.img. See "
17296 "the discussion of paths in L<guestfs(3)>."
17300 #: ../fish/guestfish.pod:922
17301 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
17305 #: ../fish/guestfish.pod:924
17310 #: ../fish/guestfish.pod:926
17312 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
17317 #: ../fish/guestfish.pod:941 ../test-tool/libguestfs-test-tool.pod:88
17322 #: ../fish/guestfish.pod:945
17323 msgid "$HOME/.guestfish"
17327 #: ../fish/guestfish.pod:947
17329 "If compiled with GNU readline support, then the command history is saved in "
17334 #: ../fish/guestfish.pod:950
17335 msgid "$HOME/.inputrc"
17339 #: ../fish/guestfish.pod:952
17340 msgid "/etc/inputrc"
17344 #: ../fish/guestfish.pod:954
17346 "If compiled with GNU readline support, then these files can be used to "
17347 "configure readline. For further information, please see "
17348 "L<readline(3)/INITIALIZATION FILE>."
17352 #: ../fish/guestfish.pod:958
17353 msgid "To write rules which only apply to guestfish, use:"
17357 #: ../fish/guestfish.pod:960
17367 #: ../fish/guestfish.pod:964
17369 "Variables that you can set in inputrc that change the behaviour of guestfish "
17370 "in useful ways include:"
17374 #: ../fish/guestfish.pod:969
17375 msgid "completion-ignore-case (default: on)"
17379 #: ../fish/guestfish.pod:971
17381 "By default, guestfish will ignore case when tab-completing paths on the "
17386 #: ../fish/guestfish.pod:974
17389 " set completion-ignore-case off\n"
17394 #: ../fish/guestfish.pod:976
17395 msgid "to make guestfish case sensitive."
17399 #: ../fish/guestfish.pod:980
17404 #: ../fish/guestfish.pod:982
17405 msgid "test2.img (etc)"
17409 #: ../fish/guestfish.pod:984
17411 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
17412 "will be created in the file C<test1.img> in the current directory. The "
17413 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
17414 "the same name will be overwritten."
17418 #: ../fish/guestfish.pod:993
17420 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
17421 "L<virt-edit(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, "
17422 "L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, "
17423 "L<virt-tar(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
17427 #: ../fish/guestfish.pod:1017 ../test-tool/libguestfs-test-tool.pod:124 ../fuse/guestmount.pod:234 ../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
17429 "This program is free software; you can redistribute it and/or modify it "
17430 "under the terms of the GNU General Public License as published by the Free "
17431 "Software Foundation; either version 2 of the License, or (at your option) "
17432 "any later version."
17436 #: ../fish/guestfish.pod:1022 ../test-tool/libguestfs-test-tool.pod:129 ../fuse/guestmount.pod:239 ../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
17438 "This program is distributed in the hope that it will be useful, but WITHOUT "
17439 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
17440 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
17445 #: ../fish/guestfish.pod:1027 ../test-tool/libguestfs-test-tool.pod:134 ../fuse/guestmount.pod:244 ../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
17447 "You should have received a copy of the GNU General Public License along with "
17448 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
17449 "Ave, Cambridge, MA 02139, USA."
17453 #: ../fish/guestfish-actions.pod:1
17458 #: ../fish/guestfish-actions.pod:3
17461 " add-cdrom filename\n"
17466 #: ../fish/guestfish-actions.pod:15
17468 "This call checks for the existence of C<filename>. This stops you from "
17469 "specifying other types of drive which are supported by qemu such as C<nbd:> "
17470 "and C<http:> URLs. To specify those, use the general L</config> call "
17475 #: ../fish/guestfish-actions.pod:22
17477 "If you just want to add an ISO file (often you use this as an efficient way "
17478 "to transfer large files into the guest), then you should probably use "
17479 "L</add-drive-ro> instead."
17483 #: ../fish/guestfish-actions.pod:35
17488 #: ../fish/guestfish-actions.pod:37
17491 " add-drive filename\n"
17496 #: ../fish/guestfish-actions.pod:39
17498 "This function is the equivalent of calling L</add-drive-opts> with no "
17499 "optional parameters, so the disk is added writable, with the format being "
17500 "detected automatically."
17504 #: ../fish/guestfish-actions.pod:43
17506 "Automatic detection of the format opens you up to a potential security hole "
17507 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
17508 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
17509 "you should think about replacing calls to this function with calls to "
17510 "L</add-drive-opts>, and specifying the format."
17514 #: ../fish/guestfish-actions.pod:50
17515 msgid "add-drive-opts"
17519 #: ../fish/guestfish-actions.pod:52
17524 #: ../fish/guestfish-actions.pod:54
17527 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
17532 #: ../fish/guestfish-actions.pod:81
17534 "This forces the image format. If you omit this (or use L</add-drive> or "
17535 "L</add-drive-ro>) then the format is automatically detected. Possible "
17536 "formats include C<raw> and C<qcow2>."
17540 #: ../fish/guestfish-actions.pod:92
17542 "This rarely-used option lets you emulate the behaviour of the deprecated "
17543 "L</add-drive-with-if> call (q.v.)"
17547 #: ../fish/guestfish-actions.pod:97
17549 "This command has one or more optional arguments. See L</OPTIONAL "
17554 #: ../fish/guestfish-actions.pod:99
17555 msgid "add-drive-ro"
17559 #: ../fish/guestfish-actions.pod:101
17564 #: ../fish/guestfish-actions.pod:103
17567 " add-drive-ro filename\n"
17572 #: ../fish/guestfish-actions.pod:105
17574 "This function is the equivalent of calling L</add-drive-opts> with the "
17575 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
17576 "is added read-only, with the format being detected automatically."
17580 #: ../fish/guestfish-actions.pod:110
17581 msgid "add-drive-ro-with-if"
17585 #: ../fish/guestfish-actions.pod:112
17588 " add-drive-ro-with-if filename iface\n"
17593 #: ../fish/guestfish-actions.pod:114
17595 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
17596 "interface emulation to use at run time."
17600 #: ../fish/guestfish-actions.pod:124
17601 msgid "add-drive-with-if"
17605 #: ../fish/guestfish-actions.pod:126
17608 " add-drive-with-if filename iface\n"
17613 #: ../fish/guestfish-actions.pod:128
17615 "This is the same as L</add-drive> but it allows you to specify the QEMU "
17616 "interface emulation to use at run time."
17620 #: ../fish/guestfish-actions.pod:138
17625 #: ../fish/guestfish-actions.pod:140
17628 " aug-clear augpath\n"
17633 #: ../fish/guestfish-actions.pod:145
17638 #: ../fish/guestfish-actions.pod:147
17646 #: ../fish/guestfish-actions.pod:149
17648 "Close the current Augeas handle and free up any resources used by it. After "
17649 "calling this, you have to call L</aug-init> again before you can use any "
17650 "other Augeas functions."
17654 #: ../fish/guestfish-actions.pod:154
17655 msgid "aug-defnode"
17659 #: ../fish/guestfish-actions.pod:156
17662 " aug-defnode name expr val\n"
17667 #: ../fish/guestfish-actions.pod:161
17669 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
17670 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
17671 "containing that single node."
17675 #: ../fish/guestfish-actions.pod:169
17680 #: ../fish/guestfish-actions.pod:171
17683 " aug-defvar name expr\n"
17688 #: ../fish/guestfish-actions.pod:180
17693 #: ../fish/guestfish-actions.pod:182
17696 " aug-get augpath\n"
17701 #: ../fish/guestfish-actions.pod:187
17706 #: ../fish/guestfish-actions.pod:189
17709 " aug-init root flags\n"
17714 #: ../fish/guestfish-actions.pod:195
17715 msgid "You must call this before using any other L</aug-*> commands."
17719 #: ../fish/guestfish-actions.pod:230
17720 msgid "Do not load the tree in L</aug-init>."
17724 #: ../fish/guestfish-actions.pod:234
17725 msgid "To close the handle, you can call L</aug-close>."
17729 #: ../fish/guestfish-actions.pod:238
17734 #: ../fish/guestfish-actions.pod:240
17737 " aug-insert augpath label true|false\n"
17742 #: ../fish/guestfish-actions.pod:250
17747 #: ../fish/guestfish-actions.pod:252
17755 #: ../fish/guestfish-actions.pod:259
17760 #: ../fish/guestfish-actions.pod:261
17763 " aug-ls augpath\n"
17768 #: ../fish/guestfish-actions.pod:263
17770 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
17771 "resulting nodes into alphabetical order."
17775 #: ../fish/guestfish-actions.pod:266
17780 #: ../fish/guestfish-actions.pod:268
17783 " aug-match augpath\n"
17788 #: ../fish/guestfish-actions.pod:274
17793 #: ../fish/guestfish-actions.pod:276
17796 " aug-mv src dest\n"
17801 #: ../fish/guestfish-actions.pod:281
17806 #: ../fish/guestfish-actions.pod:283
17809 " aug-rm augpath\n"
17814 #: ../fish/guestfish-actions.pod:289
17819 #: ../fish/guestfish-actions.pod:291
17827 #: ../fish/guestfish-actions.pod:295
17829 "The flags which were passed to L</aug-init> affect exactly how files are "
17834 #: ../fish/guestfish-actions.pod:298
17839 #: ../fish/guestfish-actions.pod:300
17842 " aug-set augpath val\n"
17847 #: ../fish/guestfish-actions.pod:304
17849 "In the Augeas API, it is possible to clear a node by setting the value to "
17850 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
17851 "this call. Instead you must use the L</aug-clear> call."
17855 #: ../fish/guestfish-actions.pod:309
17860 #: ../fish/guestfish-actions.pod:311
17863 " available 'groups ...'\n"
17868 #: ../fish/guestfish-actions.pod:317
17870 "The libguestfs groups, and the functions that those groups correspond to, "
17871 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
17872 "runtime by calling L</available-all-groups>."
17876 #: ../fish/guestfish-actions.pod:341
17877 msgid "You must call L</launch> before calling this function."
17881 #: ../fish/guestfish-actions.pod:363
17883 "This call was added in version C<1.0.80>. In previous versions of "
17884 "libguestfs all you could do would be to speculatively execute a command to "
17885 "find out if the daemon implemented it. See also L</version>."
17889 #: ../fish/guestfish-actions.pod:370
17890 msgid "available-all-groups"
17894 #: ../fish/guestfish-actions.pod:372
17897 " available-all-groups\n"
17902 #: ../fish/guestfish-actions.pod:374
17904 "This command returns a list of all optional groups that this daemon knows "
17905 "about. Note this returns both supported and unsupported groups. To find "
17906 "out which ones the daemon can actually support you have to call "
17907 "L</available> on each member of the returned list."
17911 #: ../fish/guestfish-actions.pod:380
17912 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
17916 #: ../fish/guestfish-actions.pod:382
17921 #: ../fish/guestfish-actions.pod:384
17924 " base64-in (base64file|-) filename\n"
17929 #: ../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:3932 ../fish/guestfish-actions.pod:3944 ../fish/guestfish-actions.pod:3955 ../fish/guestfish-actions.pod:3966 ../fish/guestfish-actions.pod:4018 ../fish/guestfish-actions.pod:4027 ../fish/guestfish-actions.pod:4081 ../fish/guestfish-actions.pod:4104
17930 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
17934 #: ../fish/guestfish-actions.pod:391
17939 #: ../fish/guestfish-actions.pod:393
17942 " base64-out filename (base64file|-)\n"
17947 #: ../fish/guestfish-actions.pod:400
17948 msgid "blockdev-flushbufs"
17952 #: ../fish/guestfish-actions.pod:402
17955 " blockdev-flushbufs device\n"
17960 #: ../fish/guestfish-actions.pod:409
17961 msgid "blockdev-getbsz"
17965 #: ../fish/guestfish-actions.pod:411
17968 " blockdev-getbsz device\n"
17973 #: ../fish/guestfish-actions.pod:420
17974 msgid "blockdev-getro"
17978 #: ../fish/guestfish-actions.pod:422
17981 " blockdev-getro device\n"
17986 #: ../fish/guestfish-actions.pod:429
17987 msgid "blockdev-getsize64"
17991 #: ../fish/guestfish-actions.pod:431
17994 " blockdev-getsize64 device\n"
17999 #: ../fish/guestfish-actions.pod:435
18000 msgid "See also L</blockdev-getsz>."
18004 #: ../fish/guestfish-actions.pod:439
18005 msgid "blockdev-getss"
18009 #: ../fish/guestfish-actions.pod:441
18012 " blockdev-getss device\n"
18017 #: ../fish/guestfish-actions.pod:446
18018 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
18022 #: ../fish/guestfish-actions.pod:451
18023 msgid "blockdev-getsz"
18027 #: ../fish/guestfish-actions.pod:453
18030 " blockdev-getsz device\n"
18035 #: ../fish/guestfish-actions.pod:458
18037 "See also L</blockdev-getss> for the real sector size of the device, and "
18038 "L</blockdev-getsize64> for the more useful I<size in bytes>."
18042 #: ../fish/guestfish-actions.pod:464
18043 msgid "blockdev-rereadpt"
18047 #: ../fish/guestfish-actions.pod:466
18050 " blockdev-rereadpt device\n"
18055 #: ../fish/guestfish-actions.pod:472
18056 msgid "blockdev-setbsz"
18060 #: ../fish/guestfish-actions.pod:474
18063 " blockdev-setbsz device blocksize\n"
18068 #: ../fish/guestfish-actions.pod:483
18069 msgid "blockdev-setro"
18073 #: ../fish/guestfish-actions.pod:485
18076 " blockdev-setro device\n"
18081 #: ../fish/guestfish-actions.pod:491
18082 msgid "blockdev-setrw"
18086 #: ../fish/guestfish-actions.pod:493
18089 " blockdev-setrw device\n"
18094 #: ../fish/guestfish-actions.pod:499
18095 msgid "case-sensitive-path"
18099 #: ../fish/guestfish-actions.pod:501
18102 " case-sensitive-path path\n"
18107 #: ../fish/guestfish-actions.pod:525
18109 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
18110 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
18111 "how the directories were originally created under Windows)."
18115 #: ../fish/guestfish-actions.pod:533
18116 msgid "See also L</realpath>."
18120 #: ../fish/guestfish-actions.pod:535
18125 #: ../fish/guestfish-actions.pod:537
18133 #: ../fish/guestfish-actions.pod:541
18135 "Note that this function cannot correctly handle binary files (specifically, "
18136 "files containing C<\\0> character which is treated as end of string). For "
18137 "those you need to use the L</read-file> or L</download> functions which have "
18138 "a more complex interface."
18142 #: ../fish/guestfish-actions.pod:549
18147 #: ../fish/guestfish-actions.pod:551
18150 " checksum csumtype path\n"
18155 #: ../fish/guestfish-actions.pod:594
18156 msgid "To get the checksum for a device, use L</checksum-device>."
18160 #: ../fish/guestfish-actions.pod:596
18161 msgid "To get the checksums for many files, use L</checksums-out>."
18165 #: ../fish/guestfish-actions.pod:598
18166 msgid "checksum-device"
18170 #: ../fish/guestfish-actions.pod:600
18173 " checksum-device csumtype device\n"
18178 #: ../fish/guestfish-actions.pod:602
18180 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
18181 "device named C<device>. For the types of checksums supported see the "
18182 "L</checksum> command."
18186 #: ../fish/guestfish-actions.pod:606
18187 msgid "checksums-out"
18191 #: ../fish/guestfish-actions.pod:608
18194 " checksums-out csumtype directory (sumsfile|-)\n"
18199 #: ../fish/guestfish-actions.pod:624
18204 #: ../fish/guestfish-actions.pod:626
18207 " chmod mode path\n"
18212 #: ../fish/guestfish-actions.pod:637
18217 #: ../fish/guestfish-actions.pod:639
18220 " chown owner group path\n"
18225 #: ../fish/guestfish-actions.pod:647
18230 #: ../fish/guestfish-actions.pod:649
18233 " command 'arguments ...'\n"
18238 #: ../fish/guestfish-actions.pod:656
18240 "The single parameter is an argv-style list of arguments. The first element "
18241 "is the name of the program to run. Subsequent elements are parameters. The "
18242 "list must be non-empty (ie. must contain a program name). Note that the "
18243 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
18247 #: ../fish/guestfish-actions.pod:684
18248 msgid "command-lines"
18252 #: ../fish/guestfish-actions.pod:686
18255 " command-lines 'arguments ...'\n"
18260 #: ../fish/guestfish-actions.pod:688
18261 msgid "This is the same as L</command>, but splits the result into a list of lines."
18265 #: ../fish/guestfish-actions.pod:691
18266 msgid "See also: L</sh-lines>"
18270 #: ../fish/guestfish-actions.pod:696
18275 #: ../fish/guestfish-actions.pod:698
18278 " config qemuparam qemuvalue\n"
18283 #: ../fish/guestfish-actions.pod:709
18288 #: ../fish/guestfish-actions.pod:711
18291 " copy-size src dest size\n"
18296 #: ../fish/guestfish-actions.pod:719
18301 #: ../fish/guestfish-actions.pod:721
18309 #: ../fish/guestfish-actions.pod:726
18314 #: ../fish/guestfish-actions.pod:728
18322 #: ../fish/guestfish-actions.pod:733
18327 #: ../fish/guestfish-actions.pod:735
18335 #: ../fish/guestfish-actions.pod:742
18337 "If the destination is a device, it must be as large or larger than the "
18338 "source file or device, otherwise the copy will fail. This command cannot do "
18339 "partial copies (see L</copy-size>)."
18343 #: ../fish/guestfish-actions.pod:746
18348 #: ../fish/guestfish-actions.pod:748
18351 " debug subcmd 'extraargs ...'\n"
18356 #: ../fish/guestfish-actions.pod:750
18358 "The L</debug> command exposes some internals of C<guestfsd> (the guestfs "
18359 "daemon) that runs inside the qemu subprocess."
18363 #: ../fish/guestfish-actions.pod:758
18364 msgid "debug-upload"
18368 #: ../fish/guestfish-actions.pod:760
18371 " debug-upload (filename|-) tmpname mode\n"
18376 #: ../fish/guestfish-actions.pod:762
18377 msgid "The L</debug-upload> command uploads a file to the libguestfs appliance."
18381 #: ../fish/guestfish-actions.pod:771
18386 #: ../fish/guestfish-actions.pod:773
18394 #: ../fish/guestfish-actions.pod:781
18399 #: ../fish/guestfish-actions.pod:783
18407 #: ../fish/guestfish-actions.pod:792
18412 #: ../fish/guestfish-actions.pod:794
18420 #: ../fish/guestfish-actions.pod:800
18422 "Another way to get the same information is to enable verbose messages with "
18423 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
18424 "before running the program."
18428 #: ../fish/guestfish-actions.pod:805
18433 #: ../fish/guestfish-actions.pod:807
18436 " download remotefilename (filename|-)\n"
18441 #: ../fish/guestfish-actions.pod:814
18442 msgid "See also L</upload>, L</cat>."
18446 #: ../fish/guestfish-actions.pod:818
18447 msgid "download-offset"
18451 #: ../fish/guestfish-actions.pod:820
18454 " download-offset remotefilename (filename|-) offset size\n"
18459 #: ../fish/guestfish-actions.pod:828
18461 "Note that there is no limit on the amount of data that can be downloaded "
18462 "with this call, unlike with L</pread>, and this call always reads the full "
18463 "amount unless an error occurs."
18467 #: ../fish/guestfish-actions.pod:833
18468 msgid "See also L</download>, L</pread>."
18472 #: ../fish/guestfish-actions.pod:837
18473 msgid "drop-caches"
18477 #: ../fish/guestfish-actions.pod:839
18480 " drop-caches whattodrop\n"
18485 #: ../fish/guestfish-actions.pod:851
18490 #: ../fish/guestfish-actions.pod:853
18498 #: ../fish/guestfish-actions.pod:865
18503 #: ../fish/guestfish-actions.pod:867
18506 " e2fsck-f device\n"
18511 #: ../fish/guestfish-actions.pod:873
18513 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
18514 "should use L</fsck>."
18518 #: ../fish/guestfish-actions.pod:876
18519 msgid "echo-daemon"
18523 #: ../fish/guestfish-actions.pod:878
18526 " echo-daemon 'words ...'\n"
18531 #: ../fish/guestfish-actions.pod:885
18532 msgid "See also L</ping-daemon>."
18536 #: ../fish/guestfish-actions.pod:887
18541 #: ../fish/guestfish-actions.pod:889
18544 " egrep regex path\n"
18549 #: ../fish/guestfish-actions.pod:897
18554 #: ../fish/guestfish-actions.pod:899
18557 " egrepi regex path\n"
18562 #: ../fish/guestfish-actions.pod:907
18567 #: ../fish/guestfish-actions.pod:909
18570 " equal file1 file2\n"
18575 #: ../fish/guestfish-actions.pod:916
18580 #: ../fish/guestfish-actions.pod:918
18588 #: ../fish/guestfish-actions.pod:923
18589 msgid "See also L</is-file>, L</is-dir>, L</stat>."
18593 #: ../fish/guestfish-actions.pod:925
18598 #: ../fish/guestfish-actions.pod:927
18601 " fallocate path len\n"
18606 #: ../fish/guestfish-actions.pod:944
18607 msgid "fallocate64"
18611 #: ../fish/guestfish-actions.pod:946
18614 " fallocate64 path len\n"
18619 #: ../fish/guestfish-actions.pod:952
18621 "Note that this call allocates disk blocks for the file. To create a sparse "
18622 "file use L</truncate-size> instead."
18626 #: ../fish/guestfish-actions.pod:955
18628 "The deprecated call L</fallocate> does the same, but owing to an oversight "
18629 "it only allowed 30 bit lengths to be specified, effectively limiting the "
18630 "maximum size of files created through that call to 1GB."
18634 #: ../fish/guestfish-actions.pod:964
18639 #: ../fish/guestfish-actions.pod:966
18642 " fgrep pattern path\n"
18647 #: ../fish/guestfish-actions.pod:974
18652 #: ../fish/guestfish-actions.pod:976
18655 " fgrepi pattern path\n"
18660 #: ../fish/guestfish-actions.pod:984
18665 #: ../fish/guestfish-actions.pod:986
18673 #: ../fish/guestfish-actions.pod:998
18675 "This command can also be used on C</dev/> devices (and partitions, LV "
18676 "names). You can for example use this to determine if a device contains a "
18677 "filesystem, although it's usually better to use L</vfs-type>."
18681 #: ../fish/guestfish-actions.pod:1008
18682 msgid "file-architecture"
18686 #: ../fish/guestfish-actions.pod:1010
18689 " file-architecture filename\n"
18694 #: ../fish/guestfish-actions.pod:1113
18699 #: ../fish/guestfish-actions.pod:1115
18707 #: ../fish/guestfish-actions.pod:1119
18709 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
18710 "L</is-file> etc. To get the size of block devices, use "
18711 "L</blockdev-getsize64>."
18715 #: ../fish/guestfish-actions.pod:1123
18720 #: ../fish/guestfish-actions.pod:1125
18723 " fill c len path\n"
18728 #: ../fish/guestfish-actions.pod:1131
18730 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
18731 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
18732 "L</fill-pattern>."
18736 #: ../fish/guestfish-actions.pod:1136
18737 msgid "fill-pattern"
18741 #: ../fish/guestfish-actions.pod:1138
18744 " fill-pattern pattern len path\n"
18749 #: ../fish/guestfish-actions.pod:1140
18751 "This function is like L</fill> except that it creates a new file of length "
18752 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
18753 "is truncated if necessary to ensure the length of the file is exactly C<len> "
18758 #: ../fish/guestfish-actions.pod:1145
18763 #: ../fish/guestfish-actions.pod:1147
18766 " find directory\n"
18771 #: ../fish/guestfish-actions.pod:1161
18772 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
18776 #: ../fish/guestfish-actions.pod:1174
18777 msgid "See also L</find0>."
18781 #: ../fish/guestfish-actions.pod:1179
18786 #: ../fish/guestfish-actions.pod:1181
18789 " find0 directory (files|-)\n"
18794 #: ../fish/guestfish-actions.pod:1187
18795 msgid "This command works the same way as L</find> with the following exceptions:"
18799 #: ../fish/guestfish-actions.pod:1214
18800 msgid "findfs-label"
18804 #: ../fish/guestfish-actions.pod:1216
18807 " findfs-label label\n"
18812 #: ../fish/guestfish-actions.pod:1222
18813 msgid "To find the label of a filesystem, use L</vfs-label>."
18817 #: ../fish/guestfish-actions.pod:1224
18818 msgid "findfs-uuid"
18822 #: ../fish/guestfish-actions.pod:1226
18825 " findfs-uuid uuid\n"
18830 #: ../fish/guestfish-actions.pod:1232
18831 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
18835 #: ../fish/guestfish-actions.pod:1234
18840 #: ../fish/guestfish-actions.pod:1236
18843 " fsck fstype device\n"
18848 #: ../fish/guestfish-actions.pod:1266
18853 #: ../fish/guestfish-actions.pod:1268
18861 #: ../fish/guestfish-actions.pod:1275
18862 msgid "get-autosync"
18866 #: ../fish/guestfish-actions.pod:1277
18874 #: ../fish/guestfish-actions.pod:1281
18879 #: ../fish/guestfish-actions.pod:1283
18887 #: ../fish/guestfish-actions.pod:1287
18888 msgid "get-e2label"
18892 #: ../fish/guestfish-actions.pod:1289
18895 " get-e2label device\n"
18900 #: ../fish/guestfish-actions.pod:1301
18905 #: ../fish/guestfish-actions.pod:1303
18908 " get-e2uuid device\n"
18913 #: ../fish/guestfish-actions.pod:1315
18914 msgid "get-memsize"
18918 #: ../fish/guestfish-actions.pod:1317
18926 #: ../fish/guestfish-actions.pod:1322
18928 "If L</set-memsize> was not called on this handle, and if "
18929 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
18930 "value for memsize."
18934 #: ../fish/guestfish-actions.pod:1329
18935 msgid "get-network"
18939 #: ../fish/guestfish-actions.pod:1331
18947 #: ../fish/guestfish-actions.pod:1335
18952 #: ../fish/guestfish-actions.pod:1337
18960 #: ../fish/guestfish-actions.pod:1344
18965 #: ../fish/guestfish-actions.pod:1346
18970 #: ../fish/guestfish-actions.pod:1348
18978 #: ../fish/guestfish-actions.pod:1355
18983 #: ../fish/guestfish-actions.pod:1357
18991 #: ../fish/guestfish-actions.pod:1364
18992 msgid "get-recovery-proc"
18996 #: ../fish/guestfish-actions.pod:1366
18999 " get-recovery-proc\n"
19004 #: ../fish/guestfish-actions.pod:1370
19005 msgid "get-selinux"
19009 #: ../fish/guestfish-actions.pod:1372
19017 #: ../fish/guestfish-actions.pod:1374
19019 "This returns the current setting of the selinux flag which is passed to the "
19020 "appliance at boot time. See L</set-selinux>."
19024 #: ../fish/guestfish-actions.pod:1380
19029 #: ../fish/guestfish-actions.pod:1382
19037 #: ../fish/guestfish-actions.pod:1389
19042 #: ../fish/guestfish-actions.pod:1391
19050 #: ../fish/guestfish-actions.pod:1395
19055 #: ../fish/guestfish-actions.pod:1397
19063 #: ../fish/guestfish-actions.pod:1399
19065 "Return the current umask. By default the umask is C<022> unless it has been "
19066 "set by calling L</umask>."
19070 #: ../fish/guestfish-actions.pod:1402
19071 msgid "get-verbose"
19075 #: ../fish/guestfish-actions.pod:1404
19083 #: ../fish/guestfish-actions.pod:1408
19088 #: ../fish/guestfish-actions.pod:1410
19096 #: ../fish/guestfish-actions.pod:1414
19097 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
19101 #: ../fish/guestfish-actions.pod:1417
19106 #: ../fish/guestfish-actions.pod:1419
19109 " getxattrs path\n"
19114 #: ../fish/guestfish-actions.pod:1427
19115 msgid "See also: L</lgetxattrs>, L<attr(5)>."
19119 #: ../fish/guestfish-actions.pod:1429
19120 msgid "glob-expand"
19124 #: ../fish/guestfish-actions.pod:1431
19127 " glob-expand pattern\n"
19132 #: ../fish/guestfish-actions.pod:1444
19137 #: ../fish/guestfish-actions.pod:1446
19140 " grep regex path\n"
19145 #: ../fish/guestfish-actions.pod:1454
19150 #: ../fish/guestfish-actions.pod:1456
19153 " grepi regex path\n"
19158 #: ../fish/guestfish-actions.pod:1464
19159 msgid "grub-install"
19163 #: ../fish/guestfish-actions.pod:1466
19166 " grub-install root device\n"
19171 #: ../fish/guestfish-actions.pod:1482
19176 #: ../fish/guestfish-actions.pod:1484
19184 #: ../fish/guestfish-actions.pod:1492
19189 #: ../fish/guestfish-actions.pod:1494
19192 " head-n nrlines path\n"
19197 #: ../fish/guestfish-actions.pod:1507
19202 #: ../fish/guestfish-actions.pod:1509
19210 #: ../fish/guestfish-actions.pod:1517
19215 #: ../fish/guestfish-actions.pod:1519
19218 " initrd-cat initrdpath filename\n"
19223 #: ../fish/guestfish-actions.pod:1531
19224 msgid "See also L</initrd-list>."
19228 #: ../fish/guestfish-actions.pod:1536
19229 msgid "initrd-list"
19233 #: ../fish/guestfish-actions.pod:1538
19236 " initrd-list path\n"
19241 #: ../fish/guestfish-actions.pod:1550
19242 msgid "inotify-add-watch"
19246 #: ../fish/guestfish-actions.pod:1552
19249 " inotify-add-watch path mask\n"
19254 #: ../fish/guestfish-actions.pod:1564
19255 msgid "inotify-close"
19259 #: ../fish/guestfish-actions.pod:1566
19267 #: ../fish/guestfish-actions.pod:1572
19268 msgid "inotify-files"
19272 #: ../fish/guestfish-actions.pod:1574
19280 #: ../fish/guestfish-actions.pod:1576
19282 "This function is a helpful wrapper around L</inotify-read> which just "
19283 "returns a list of pathnames of objects that were touched. The returned "
19284 "pathnames are sorted and deduplicated."
19288 #: ../fish/guestfish-actions.pod:1580
19289 msgid "inotify-init"
19293 #: ../fish/guestfish-actions.pod:1582
19296 " inotify-init maxevents\n"
19301 #: ../fish/guestfish-actions.pod:1588
19303 "C<maxevents> is the maximum number of events which will be queued up between "
19304 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
19305 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
19306 "default was 16384 events. Beyond this limit, the kernel throws away events, "
19307 "but records the fact that it threw them away by setting a flag "
19308 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
19312 #: ../fish/guestfish-actions.pod:1598
19314 "Before any events are generated, you have to add some watches to the "
19315 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
19316 "L</inotify-watch-all>."
19320 #: ../fish/guestfish-actions.pod:1604
19322 "Queued up events should be read periodically by calling L</inotify-read> (or "
19323 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
19324 "If you don't read the events out often enough then you risk the internal "
19325 "queue overflowing."
19329 #: ../fish/guestfish-actions.pod:1611
19331 "The handle should be closed after use by calling L</inotify-close>. This "
19332 "also removes any watches automatically."
19336 #: ../fish/guestfish-actions.pod:1620
19337 msgid "inotify-read"
19341 #: ../fish/guestfish-actions.pod:1622
19349 #: ../fish/guestfish-actions.pod:1635
19350 msgid "inotify-rm-watch"
19354 #: ../fish/guestfish-actions.pod:1637
19357 " inotify-rm-watch wd\n"
19362 #: ../fish/guestfish-actions.pod:1639
19363 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
19367 #: ../fish/guestfish-actions.pod:1642
19368 msgid "inspect-get-arch"
19372 #: ../fish/guestfish-actions.pod:1644
19375 " inspect-get-arch root\n"
19380 #: ../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:1822 ../fish/guestfish-actions.pod:1853
19382 "This function should only be called with a root device string as returned by "
19387 #: ../fish/guestfish-actions.pod:1649
19389 "This returns the architecture of the inspected operating system. The "
19390 "possible return values are listed under L</file-architecture>."
19394 #: ../fish/guestfish-actions.pod:1658
19395 msgid "inspect-get-distro"
19399 #: ../fish/guestfish-actions.pod:1660
19402 " inspect-get-distro root\n"
19407 #: ../fish/guestfish-actions.pod:1724
19408 msgid "inspect-get-filesystems"
19412 #: ../fish/guestfish-actions.pod:1726
19415 " inspect-get-filesystems root\n"
19420 #: ../fish/guestfish-actions.pod:1739
19422 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
19423 "L</inspect-get-mountpoints>."
19427 #: ../fish/guestfish-actions.pod:1742
19428 msgid "inspect-get-major-version"
19432 #: ../fish/guestfish-actions.pod:1744
19435 " inspect-get-major-version root\n"
19440 #: ../fish/guestfish-actions.pod:1763
19441 msgid "inspect-get-minor-version"
19445 #: ../fish/guestfish-actions.pod:1765
19448 " inspect-get-minor-version root\n"
19453 #: ../fish/guestfish-actions.pod:1775
19455 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
19456 "L</inspect-get-major-version>."
19460 #: ../fish/guestfish-actions.pod:1778
19461 msgid "inspect-get-mountpoints"
19465 #: ../fish/guestfish-actions.pod:1780
19468 " inspect-get-mountpoints root\n"
19473 #: ../fish/guestfish-actions.pod:1798
19475 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
19476 "L</inspect-get-filesystems>."
19480 #: ../fish/guestfish-actions.pod:1801
19481 msgid "inspect-get-product-name"
19485 #: ../fish/guestfish-actions.pod:1803
19488 " inspect-get-product-name root\n"
19493 #: ../fish/guestfish-actions.pod:1818
19494 msgid "inspect-get-type"
19498 #: ../fish/guestfish-actions.pod:1820
19501 " inspect-get-type root\n"
19506 #: ../fish/guestfish-actions.pod:1849
19507 msgid "inspect-get-windows-systemroot"
19511 #: ../fish/guestfish-actions.pod:1851
19514 " inspect-get-windows-systemroot root\n"
19519 #: ../fish/guestfish-actions.pod:1865
19524 #: ../fish/guestfish-actions.pod:1867
19532 #: ../fish/guestfish-actions.pod:1882
19534 "You can pass the root string(s) returned to other L</inspect-get-*> "
19535 "functions in order to query further information about each operating system, "
19536 "such as the name and version."
19540 #: ../fish/guestfish-actions.pod:1887
19542 "This function uses other libguestfs features such as L</mount-ro> and "
19543 "L</umount-all> in order to mount and unmount filesystems and look at the "
19544 "contents. This should be called with no disks currently mounted. The "
19545 "function may also use Augeas, so any existing Augeas handle will be closed."
19549 #: ../fish/guestfish-actions.pod:1899 ../fish/guestfish-actions.pod:2055 ../fish/guestfish-actions.pod:2101
19550 msgid "See also L</list-filesystems>."
19554 #: ../fish/guestfish-actions.pod:1901
19555 msgid "is-blockdev"
19559 #: ../fish/guestfish-actions.pod:1903
19562 " is-blockdev path\n"
19567 #: ../fish/guestfish-actions.pod:1908 ../fish/guestfish-actions.pod:1926 ../fish/guestfish-actions.pod:1945 ../fish/guestfish-actions.pod:1954 ../fish/guestfish-actions.pod:1964 ../fish/guestfish-actions.pod:1998 ../fish/guestfish-actions.pod:2007
19568 msgid "See also L</stat>."
19572 #: ../fish/guestfish-actions.pod:1910
19577 #: ../fish/guestfish-actions.pod:1912
19585 #: ../fish/guestfish-actions.pod:1919
19590 #: ../fish/guestfish-actions.pod:1921
19593 " is-chardev path\n"
19598 #: ../fish/guestfish-actions.pod:1928
19603 #: ../fish/guestfish-actions.pod:1930
19611 #: ../fish/guestfish-actions.pod:1937
19616 #: ../fish/guestfish-actions.pod:1939
19624 #: ../fish/guestfish-actions.pod:1947
19629 #: ../fish/guestfish-actions.pod:1949
19637 #: ../fish/guestfish-actions.pod:1956
19642 #: ../fish/guestfish-actions.pod:1958
19650 #: ../fish/guestfish-actions.pod:1966
19651 msgid "is-launching"
19655 #: ../fish/guestfish-actions.pod:1968
19663 #: ../fish/guestfish-actions.pod:1975
19668 #: ../fish/guestfish-actions.pod:1977
19676 #: ../fish/guestfish-actions.pod:1982
19681 #: ../fish/guestfish-actions.pod:1984
19689 #: ../fish/guestfish-actions.pod:1991
19694 #: ../fish/guestfish-actions.pod:1993
19697 " is-socket path\n"
19702 #: ../fish/guestfish-actions.pod:2000
19707 #: ../fish/guestfish-actions.pod:2002
19710 " is-symlink path\n"
19715 #: ../fish/guestfish-actions.pod:2009
19716 msgid "kill-subprocess"
19720 #: ../fish/guestfish-actions.pod:2011
19723 " kill-subprocess\n"
19728 #: ../fish/guestfish-actions.pod:2015
19733 #: ../fish/guestfish-actions.pod:2017
19738 #: ../fish/guestfish-actions.pod:2019
19746 #: ../fish/guestfish-actions.pod:2027
19751 #: ../fish/guestfish-actions.pod:2029
19754 " lchown owner group path\n"
19759 #: ../fish/guestfish-actions.pod:2031
19761 "Change the file owner to C<owner> and group to C<group>. This is like "
19762 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
19767 #: ../fish/guestfish-actions.pod:2039
19772 #: ../fish/guestfish-actions.pod:2041
19775 " lgetxattrs path\n"
19780 #: ../fish/guestfish-actions.pod:2043
19782 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
19783 "it returns the extended attributes of the link itself."
19787 #: ../fish/guestfish-actions.pod:2047
19788 msgid "list-devices"
19792 #: ../fish/guestfish-actions.pod:2049
19800 #: ../fish/guestfish-actions.pod:2057
19801 msgid "list-filesystems"
19805 #: ../fish/guestfish-actions.pod:2059
19808 " list-filesystems\n"
19813 #: ../fish/guestfish-actions.pod:2078
19815 "This command runs other libguestfs commands, which might include L</mount> "
19816 "and L</umount>, and therefore you should use this soon after launch and only "
19817 "when nothing is mounted."
19821 #: ../fish/guestfish-actions.pod:2082
19823 "Not all of the filesystems returned will be mountable. In particular, swap "
19824 "partitions are returned in the list. Also this command does not check that "
19825 "each filesystem found is valid and mountable, and some filesystems might be "
19826 "mountable but require special options. Filesystems may not all belong to a "
19827 "single logical operating system (use L</inspect-os> to look for OSes)."
19831 #: ../fish/guestfish-actions.pod:2090
19832 msgid "list-partitions"
19836 #: ../fish/guestfish-actions.pod:2092
19839 " list-partitions\n"
19844 #: ../fish/guestfish-actions.pod:2098
19846 "This does not return logical volumes. For that you will need to call "
19851 #: ../fish/guestfish-actions.pod:2103
19856 #: ../fish/guestfish-actions.pod:2105
19864 #: ../fish/guestfish-actions.pod:2113
19869 #: ../fish/guestfish-actions.pod:2115
19872 " ln target linkname\n"
19877 #: ../fish/guestfish-actions.pod:2119
19882 #: ../fish/guestfish-actions.pod:2121
19885 " ln-f target linkname\n"
19890 #: ../fish/guestfish-actions.pod:2126
19895 #: ../fish/guestfish-actions.pod:2128
19898 " ln-s target linkname\n"
19903 #: ../fish/guestfish-actions.pod:2132
19908 #: ../fish/guestfish-actions.pod:2134
19911 " ln-sf target linkname\n"
19916 #: ../fish/guestfish-actions.pod:2139
19917 msgid "lremovexattr"
19921 #: ../fish/guestfish-actions.pod:2141
19924 " lremovexattr xattr path\n"
19929 #: ../fish/guestfish-actions.pod:2143
19931 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
19932 "it removes an extended attribute of the link itself."
19936 #: ../fish/guestfish-actions.pod:2147
19941 #: ../fish/guestfish-actions.pod:2149
19949 #: ../fish/guestfish-actions.pod:2155
19951 "This command is mostly useful for interactive sessions. Programs should "
19952 "probably use L</readdir> instead."
19956 #: ../fish/guestfish-actions.pod:2158
19961 #: ../fish/guestfish-actions.pod:2160
19964 " lsetxattr xattr val vallen path\n"
19969 #: ../fish/guestfish-actions.pod:2162
19971 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
19972 "sets an extended attribute of the link itself."
19976 #: ../fish/guestfish-actions.pod:2166
19981 #: ../fish/guestfish-actions.pod:2168
19989 #: ../fish/guestfish-actions.pod:2172
19991 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
19992 "the link is stat-ed, not the file it refers to."
19996 #: ../fish/guestfish-actions.pod:2178
20001 #: ../fish/guestfish-actions.pod:2180
20004 " lstatlist path 'names ...'\n"
20009 #: ../fish/guestfish-actions.pod:2182
20011 "This call allows you to perform the L</lstat> operation on multiple files, "
20012 "where all files are in the directory C<path>. C<names> is the list of files "
20013 "from this directory."
20017 #: ../fish/guestfish-actions.pod:2191
20019 "This call is intended for programs that want to efficiently list a directory "
20020 "contents without making many round-trips. See also L</lxattrlist> for a "
20021 "similarly efficient call for getting extended attributes. Very long "
20022 "directory listings might cause the protocol message size to be exceeded, "
20023 "causing this call to fail. The caller must split up such requests into "
20024 "smaller groups of names."
20028 #: ../fish/guestfish-actions.pod:2199
20029 msgid "luks-add-key"
20033 #: ../fish/guestfish-actions.pod:2201
20036 " luks-add-key device keyslot\n"
20041 #: ../fish/guestfish-actions.pod:2208
20043 "Note that if C<keyslot> already contains a key, then this command will "
20044 "fail. You have to use L</luks-kill-slot> first to remove that key."
20048 #: ../fish/guestfish-actions.pod:2212 ../fish/guestfish-actions.pod:2234 ../fish/guestfish-actions.pod:2247 ../fish/guestfish-actions.pod:2261 ../fish/guestfish-actions.pod:2284 ../fish/guestfish-actions.pod:2294
20050 "This command has one or more key or passphrase parameters. Guestfish will "
20051 "prompt for these separately."
20055 #: ../fish/guestfish-actions.pod:2215
20060 #: ../fish/guestfish-actions.pod:2217
20063 " luks-close device\n"
20068 #: ../fish/guestfish-actions.pod:2219
20070 "This closes a LUKS device that was created earlier by L</luks-open> or "
20071 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
20072 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
20073 "underlying block device."
20077 #: ../fish/guestfish-actions.pod:2225
20078 msgid "luks-format"
20082 #: ../fish/guestfish-actions.pod:2227
20085 " luks-format device keyslot\n"
20090 #: ../fish/guestfish-actions.pod:2240
20091 msgid "luks-format-cipher"
20095 #: ../fish/guestfish-actions.pod:2242
20098 " luks-format-cipher device keyslot cipher\n"
20103 #: ../fish/guestfish-actions.pod:2244
20105 "This command is the same as L</luks-format> but it also allows you to set "
20106 "the C<cipher> used."
20110 #: ../fish/guestfish-actions.pod:2253
20111 msgid "luks-kill-slot"
20115 #: ../fish/guestfish-actions.pod:2255
20118 " luks-kill-slot device keyslot\n"
20123 #: ../fish/guestfish-actions.pod:2264
20128 #: ../fish/guestfish-actions.pod:2266
20131 " luks-open device mapname\n"
20136 #: ../fish/guestfish-actions.pod:2280
20138 "If this block device contains LVM volume groups, then calling L</vgscan> "
20139 "followed by L</vg-activate-all> will make them visible."
20143 #: ../fish/guestfish-actions.pod:2287
20144 msgid "luks-open-ro"
20148 #: ../fish/guestfish-actions.pod:2289
20151 " luks-open-ro device mapname\n"
20156 #: ../fish/guestfish-actions.pod:2291
20158 "This is the same as L</luks-open> except that a read-only mapping is "
20163 #: ../fish/guestfish-actions.pod:2297
20168 #: ../fish/guestfish-actions.pod:2299
20171 " lvcreate logvol volgroup mbytes\n"
20176 #: ../fish/guestfish-actions.pod:2304
20177 msgid "lvm-canonical-lv-name"
20181 #: ../fish/guestfish-actions.pod:2306
20184 " lvm-canonical-lv-name lvname\n"
20189 #: ../fish/guestfish-actions.pod:2315
20190 msgid "See also L</is-lv>."
20194 #: ../fish/guestfish-actions.pod:2317
20195 msgid "lvm-clear-filter"
20199 #: ../fish/guestfish-actions.pod:2319
20202 " lvm-clear-filter\n"
20207 #: ../fish/guestfish-actions.pod:2321
20209 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
20214 #: ../fish/guestfish-actions.pod:2327
20215 msgid "lvm-remove-all"
20219 #: ../fish/guestfish-actions.pod:2329
20222 " lvm-remove-all\n"
20227 #: ../fish/guestfish-actions.pod:2337
20228 msgid "lvm-set-filter"
20232 #: ../fish/guestfish-actions.pod:2339
20235 " lvm-set-filter 'devices ...'\n"
20240 #: ../fish/guestfish-actions.pod:2364
20245 #: ../fish/guestfish-actions.pod:2366
20248 " lvremove device\n"
20253 #: ../fish/guestfish-actions.pod:2374
20258 #: ../fish/guestfish-actions.pod:2376
20261 " lvrename logvol newlogvol\n"
20266 #: ../fish/guestfish-actions.pod:2380
20271 #: ../fish/guestfish-actions.pod:2382
20274 " lvresize device mbytes\n"
20279 #: ../fish/guestfish-actions.pod:2388
20280 msgid "lvresize-free"
20284 #: ../fish/guestfish-actions.pod:2390
20287 " lvresize-free lv percent\n"
20292 #: ../fish/guestfish-actions.pod:2398
20297 #: ../fish/guestfish-actions.pod:2400
20305 #: ../fish/guestfish-actions.pod:2408
20306 msgid "See also L</lvs-full>, L</list-filesystems>."
20310 #: ../fish/guestfish-actions.pod:2410
20315 #: ../fish/guestfish-actions.pod:2412
20323 #: ../fish/guestfish-actions.pod:2417
20328 #: ../fish/guestfish-actions.pod:2419
20336 #: ../fish/guestfish-actions.pod:2423
20341 #: ../fish/guestfish-actions.pod:2425
20344 " lxattrlist path 'names ...'\n"
20349 #: ../fish/guestfish-actions.pod:2441
20351 "This call is intended for programs that want to efficiently list a directory "
20352 "contents without making many round-trips. See also L</lstatlist> for a "
20353 "similarly efficient call for getting standard stats. Very long directory "
20354 "listings might cause the protocol message size to be exceeded, causing this "
20355 "call to fail. The caller must split up such requests into smaller groups of "
20360 #: ../fish/guestfish-actions.pod:2449
20365 #: ../fish/guestfish-actions.pod:2451
20373 #: ../fish/guestfish-actions.pod:2455
20378 #: ../fish/guestfish-actions.pod:2457
20381 " mkdir-mode path mode\n"
20386 #: ../fish/guestfish-actions.pod:2466
20387 msgid "See also L</mkdir>, L</umask>"
20391 #: ../fish/guestfish-actions.pod:2468
20396 #: ../fish/guestfish-actions.pod:2470
20404 #: ../fish/guestfish-actions.pod:2475
20409 #: ../fish/guestfish-actions.pod:2477
20412 " mkdtemp template\n"
20417 #: ../fish/guestfish-actions.pod:2498
20422 #: ../fish/guestfish-actions.pod:2500
20425 " mke2fs-J fstype blocksize device journal\n"
20430 #: ../fish/guestfish-actions.pod:2508
20431 msgid "See also L</mke2journal>."
20435 #: ../fish/guestfish-actions.pod:2510
20440 #: ../fish/guestfish-actions.pod:2512
20443 " mke2fs-JL fstype blocksize device label\n"
20448 #: ../fish/guestfish-actions.pod:2517
20449 msgid "See also L</mke2journal-L>."
20453 #: ../fish/guestfish-actions.pod:2519
20458 #: ../fish/guestfish-actions.pod:2521
20461 " mke2fs-JU fstype blocksize device uuid\n"
20466 #: ../fish/guestfish-actions.pod:2526
20467 msgid "See also L</mke2journal-U>."
20471 #: ../fish/guestfish-actions.pod:2528
20472 msgid "mke2journal"
20476 #: ../fish/guestfish-actions.pod:2530
20479 " mke2journal blocksize device\n"
20484 #: ../fish/guestfish-actions.pod:2537
20485 msgid "mke2journal-L"
20489 #: ../fish/guestfish-actions.pod:2539
20492 " mke2journal-L blocksize label device\n"
20497 #: ../fish/guestfish-actions.pod:2543
20498 msgid "mke2journal-U"
20502 #: ../fish/guestfish-actions.pod:2545
20505 " mke2journal-U blocksize uuid device\n"
20510 #: ../fish/guestfish-actions.pod:2549
20515 #: ../fish/guestfish-actions.pod:2551
20518 " mkfifo mode path\n"
20523 #: ../fish/guestfish-actions.pod:2553
20525 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
20526 "is just a convenient wrapper around L</mknod>."
20530 #: ../fish/guestfish-actions.pod:2559
20535 #: ../fish/guestfish-actions.pod:2561
20538 " mkfs fstype device\n"
20543 #: ../fish/guestfish-actions.pod:2567
20548 #: ../fish/guestfish-actions.pod:2569
20551 " mkfs-b fstype blocksize device\n"
20556 #: ../fish/guestfish-actions.pod:2571
20558 "This call is similar to L</mkfs>, but it allows you to control the block "
20559 "size of the resulting filesystem. Supported block sizes depend on the "
20560 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
20564 #: ../fish/guestfish-actions.pod:2579
20565 msgid "mkmountpoint"
20569 #: ../fish/guestfish-actions.pod:2581
20572 " mkmountpoint exemptpath\n"
20577 #: ../fish/guestfish-actions.pod:2583
20579 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
20580 "to create extra mountpoints before mounting the first filesystem."
20584 #: ../fish/guestfish-actions.pod:2607
20586 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
20587 "unexpected errors if you try to mix these calls. It is safest to manually "
20588 "unmount filesystems and remove mountpoints after use."
20592 #: ../fish/guestfish-actions.pod:2611
20594 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
20595 "for this to work for manual mountpoints, you must ensure that the innermost "
20596 "mountpoints have the longest pathnames, as in the example code above."
20600 #: ../fish/guestfish-actions.pod:2618
20602 "Autosync [see L</set-autosync>, this is set by default on handles] means "
20603 "that L</umount-all> is called when the handle is closed which can also "
20604 "trigger these issues."
20608 #: ../fish/guestfish-actions.pod:2622
20613 #: ../fish/guestfish-actions.pod:2624
20616 " mknod mode devmajor devminor path\n"
20621 #: ../fish/guestfish-actions.pod:2634
20623 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
20624 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
20625 "regular file). These constants are available in the standard Linux header "
20626 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
20627 "wrappers around this command which bitwise OR in the appropriate constant "
20632 #: ../fish/guestfish-actions.pod:2644
20637 #: ../fish/guestfish-actions.pod:2646
20640 " mknod-b mode devmajor devminor path\n"
20645 #: ../fish/guestfish-actions.pod:2648
20647 "This call creates a block device node called C<path> with mode C<mode> and "
20648 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
20649 "wrapper around L</mknod>."
20653 #: ../fish/guestfish-actions.pod:2654
20658 #: ../fish/guestfish-actions.pod:2656
20661 " mknod-c mode devmajor devminor path\n"
20666 #: ../fish/guestfish-actions.pod:2658
20668 "This call creates a char device node called C<path> with mode C<mode> and "
20669 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
20670 "wrapper around L</mknod>."
20674 #: ../fish/guestfish-actions.pod:2664
20679 #: ../fish/guestfish-actions.pod:2666
20687 #: ../fish/guestfish-actions.pod:2670
20692 #: ../fish/guestfish-actions.pod:2672
20695 " mkswap-L label device\n"
20700 #: ../fish/guestfish-actions.pod:2680
20705 #: ../fish/guestfish-actions.pod:2682
20708 " mkswap-U uuid device\n"
20713 #: ../fish/guestfish-actions.pod:2686
20714 msgid "mkswap-file"
20718 #: ../fish/guestfish-actions.pod:2688
20721 " mkswap-file path\n"
20726 #: ../fish/guestfish-actions.pod:2692
20728 "This command just writes a swap file signature to an existing file. To "
20729 "create the file itself, use something like L</fallocate>."
20733 #: ../fish/guestfish-actions.pod:2695
20738 #: ../fish/guestfish-actions.pod:2697
20741 " modprobe modulename\n"
20746 #: ../fish/guestfish-actions.pod:2704
20751 #: ../fish/guestfish-actions.pod:2706
20754 " mount device mountpoint\n"
20759 #: ../fish/guestfish-actions.pod:2722
20761 "B<Important note:> When you use this call, the filesystem options C<sync> "
20762 "and C<noatime> are set implicitly. This was originally done because we "
20763 "thought it would improve reliability, but it turns out that I<-o sync> has a "
20764 "very large negative performance impact and negligible effect on "
20765 "reliability. Therefore we recommend that you avoid using L</mount> in any "
20766 "code that needs performance, and instead use L</mount-options> (use an empty "
20767 "string for the first parameter if you don't want any options)."
20771 #: ../fish/guestfish-actions.pod:2732
20776 #: ../fish/guestfish-actions.pod:2734
20779 " mount-loop file mountpoint\n"
20784 #: ../fish/guestfish-actions.pod:2740
20785 msgid "mount-options"
20789 #: ../fish/guestfish-actions.pod:2742
20792 " mount-options options device mountpoint\n"
20797 #: ../fish/guestfish-actions.pod:2744
20799 "This is the same as the L</mount> command, but it allows you to set the "
20800 "mount options as for the L<mount(8)> I<-o> flag."
20804 #: ../fish/guestfish-actions.pod:2752
20809 #: ../fish/guestfish-actions.pod:2754
20812 " mount-ro device mountpoint\n"
20817 #: ../fish/guestfish-actions.pod:2756
20819 "This is the same as the L</mount> command, but it mounts the filesystem with "
20820 "the read-only (I<-o ro>) flag."
20824 #: ../fish/guestfish-actions.pod:2759
20829 #: ../fish/guestfish-actions.pod:2761
20832 " mount-vfs options vfstype device mountpoint\n"
20837 #: ../fish/guestfish-actions.pod:2763
20839 "This is the same as the L</mount> command, but it allows you to set both the "
20840 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
20844 #: ../fish/guestfish-actions.pod:2767
20845 msgid "mountpoints"
20849 #: ../fish/guestfish-actions.pod:2769
20857 #: ../fish/guestfish-actions.pod:2771
20859 "This call is similar to L</mounts>. That call returns a list of devices. "
20860 "This one returns a hash table (map) of device name to directory where the "
20861 "device is mounted."
20865 #: ../fish/guestfish-actions.pod:2775
20870 #: ../fish/guestfish-actions.pod:2777
20878 #: ../fish/guestfish-actions.pod:2784
20879 msgid "See also: L</mountpoints>"
20883 #: ../fish/guestfish-actions.pod:2786
20888 #: ../fish/guestfish-actions.pod:2788
20896 #: ../fish/guestfish-actions.pod:2793
20897 msgid "ntfs-3g-probe"
20901 #: ../fish/guestfish-actions.pod:2795
20904 " ntfs-3g-probe true|false device\n"
20909 #: ../fish/guestfish-actions.pod:2809
20914 #: ../fish/guestfish-actions.pod:2811
20917 " ntfsresize device\n"
20922 #: ../fish/guestfish-actions.pod:2817
20923 msgid "ntfsresize-size"
20927 #: ../fish/guestfish-actions.pod:2819
20930 " ntfsresize-size device size\n"
20935 #: ../fish/guestfish-actions.pod:2821
20937 "This command is the same as L</ntfsresize> except that it allows you to "
20938 "specify the new size (in bytes) explicitly."
20942 #: ../fish/guestfish-actions.pod:2824
20947 #: ../fish/guestfish-actions.pod:2826
20950 " part-add device prlogex startsect endsect\n"
20955 #: ../fish/guestfish-actions.pod:2828
20957 "This command adds a partition to C<device>. If there is no partition table "
20958 "on the device, call L</part-init> first."
20962 #: ../fish/guestfish-actions.pod:2840
20964 "Creating a partition which covers the whole disk is not so easy. Use "
20965 "L</part-disk> to do that."
20969 #: ../fish/guestfish-actions.pod:2843
20974 #: ../fish/guestfish-actions.pod:2845
20977 " part-del device partnum\n"
20982 #: ../fish/guestfish-actions.pod:2853
20987 #: ../fish/guestfish-actions.pod:2855
20990 " part-disk device parttype\n"
20995 #: ../fish/guestfish-actions.pod:2857
20997 "This command is simply a combination of L</part-init> followed by "
20998 "L</part-add> to create a single primary partition covering the whole disk."
21002 #: ../fish/guestfish-actions.pod:2861
21004 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
21005 "possible values are described in L</part-init>."
21009 #: ../fish/guestfish-actions.pod:2867
21010 msgid "part-get-bootable"
21014 #: ../fish/guestfish-actions.pod:2869
21017 " part-get-bootable device partnum\n"
21022 #: ../fish/guestfish-actions.pod:2874
21023 msgid "See also L</part-set-bootable>."
21027 #: ../fish/guestfish-actions.pod:2876
21028 msgid "part-get-mbr-id"
21032 #: ../fish/guestfish-actions.pod:2878
21035 " part-get-mbr-id device partnum\n"
21040 #: ../fish/guestfish-actions.pod:2883 ../fish/guestfish-actions.pod:3021
21042 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
21043 "undefined results for other partition table types (see "
21044 "L</part-get-parttype>)."
21048 #: ../fish/guestfish-actions.pod:2887
21049 msgid "part-get-parttype"
21053 #: ../fish/guestfish-actions.pod:2889
21056 " part-get-parttype device\n"
21061 #: ../fish/guestfish-actions.pod:2894
21063 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
21064 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
21065 "possible, although unusual. See L</part-init> for a full list."
21069 #: ../fish/guestfish-actions.pod:2899
21074 #: ../fish/guestfish-actions.pod:2901
21077 " part-init device parttype\n"
21082 #: ../fish/guestfish-actions.pod:2907
21084 "Initially there are no partitions. Following this, you should call "
21085 "L</part-add> for each partition required."
21089 #: ../fish/guestfish-actions.pod:2970
21094 #: ../fish/guestfish-actions.pod:2972
21097 " part-list device\n"
21102 #: ../fish/guestfish-actions.pod:2987
21104 "Start of the partition I<in bytes>. To get sectors you have to divide by "
21105 "the device's sector size, see L</blockdev-getss>."
21109 #: ../fish/guestfish-actions.pod:3000
21110 msgid "part-set-bootable"
21114 #: ../fish/guestfish-actions.pod:3002
21117 " part-set-bootable device partnum true|false\n"
21122 #: ../fish/guestfish-actions.pod:3011
21123 msgid "part-set-mbr-id"
21127 #: ../fish/guestfish-actions.pod:3013
21130 " part-set-mbr-id device partnum idbyte\n"
21135 #: ../fish/guestfish-actions.pod:3025
21136 msgid "part-set-name"
21140 #: ../fish/guestfish-actions.pod:3027
21143 " part-set-name device partnum name\n"
21148 #: ../fish/guestfish-actions.pod:3035
21149 msgid "part-to-dev"
21153 #: ../fish/guestfish-actions.pod:3037
21156 " part-to-dev partition\n"
21161 #: ../fish/guestfish-actions.pod:3043
21163 "The named partition must exist, for example as a string returned from "
21164 "L</list-partitions>."
21168 #: ../fish/guestfish-actions.pod:3046
21169 msgid "ping-daemon"
21173 #: ../fish/guestfish-actions.pod:3048
21181 #: ../fish/guestfish-actions.pod:3055
21186 #: ../fish/guestfish-actions.pod:3057
21189 " pread path count offset\n"
21194 #: ../fish/guestfish-actions.pod:3065
21195 msgid "See also L</pwrite>, L</pread-device>."
21199 #: ../fish/guestfish-actions.pod:3070
21200 msgid "pread-device"
21204 #: ../fish/guestfish-actions.pod:3072
21207 " pread-device device count offset\n"
21212 #: ../fish/guestfish-actions.pod:3080
21213 msgid "See also L</pread>."
21217 #: ../fish/guestfish-actions.pod:3085
21222 #: ../fish/guestfish-actions.pod:3087
21225 " pvcreate device\n"
21230 #: ../fish/guestfish-actions.pod:3093
21235 #: ../fish/guestfish-actions.pod:3095
21238 " pvremove device\n"
21243 #: ../fish/guestfish-actions.pod:3104
21248 #: ../fish/guestfish-actions.pod:3106
21251 " pvresize device\n"
21256 #: ../fish/guestfish-actions.pod:3111
21257 msgid "pvresize-size"
21261 #: ../fish/guestfish-actions.pod:3113
21264 " pvresize-size device size\n"
21269 #: ../fish/guestfish-actions.pod:3115
21271 "This command is the same as L</pvresize> except that it allows you to "
21272 "specify the new size (in bytes) explicitly."
21276 #: ../fish/guestfish-actions.pod:3118
21281 #: ../fish/guestfish-actions.pod:3120
21289 #: ../fish/guestfish-actions.pod:3128
21290 msgid "See also L</pvs-full>."
21294 #: ../fish/guestfish-actions.pod:3130
21299 #: ../fish/guestfish-actions.pod:3132
21307 #: ../fish/guestfish-actions.pod:3137
21312 #: ../fish/guestfish-actions.pod:3139
21320 #: ../fish/guestfish-actions.pod:3143
21325 #: ../fish/guestfish-actions.pod:3145
21328 " pwrite path content offset\n"
21333 #: ../fish/guestfish-actions.pod:3156
21334 msgid "See also L</pread>, L</pwrite-device>."
21338 #: ../fish/guestfish-actions.pod:3161
21339 msgid "pwrite-device"
21343 #: ../fish/guestfish-actions.pod:3163
21346 " pwrite-device device content offset\n"
21351 #: ../fish/guestfish-actions.pod:3173
21352 msgid "See also L</pwrite>."
21356 #: ../fish/guestfish-actions.pod:3178
21361 #: ../fish/guestfish-actions.pod:3180
21364 " read-file path\n"
21369 #: ../fish/guestfish-actions.pod:3185
21371 "Unlike L</cat>, this function can correctly handle files that contain "
21372 "embedded ASCII NUL characters. However unlike L</download>, this function "
21373 "is limited in the total size of file that can be handled."
21377 #: ../fish/guestfish-actions.pod:3193
21382 #: ../fish/guestfish-actions.pod:3195
21385 " read-lines path\n"
21390 #: ../fish/guestfish-actions.pod:3202
21392 "Note that this function cannot correctly handle binary files (specifically, "
21393 "files containing C<\\0> character which is treated as end of line). For "
21394 "those you need to use the L</read-file> function which has a more complex "
21399 #: ../fish/guestfish-actions.pod:3207
21404 #: ../fish/guestfish-actions.pod:3209
21412 #: ../fish/guestfish-actions.pod:3261
21414 "This function is primarily intended for use by programs. To get a simple "
21415 "list of names, use L</ls>. To get a printable directory for human "
21416 "consumption, use L</ll>."
21420 #: ../fish/guestfish-actions.pod:3265
21425 #: ../fish/guestfish-actions.pod:3267
21433 #: ../fish/guestfish-actions.pod:3271
21434 msgid "readlinklist"
21438 #: ../fish/guestfish-actions.pod:3273
21441 " readlinklist path 'names ...'\n"
21446 #: ../fish/guestfish-actions.pod:3297
21451 #: ../fish/guestfish-actions.pod:3299
21459 #: ../fish/guestfish-actions.pod:3304
21460 msgid "removexattr"
21464 #: ../fish/guestfish-actions.pod:3306
21467 " removexattr xattr path\n"
21472 #: ../fish/guestfish-actions.pod:3311
21473 msgid "See also: L</lremovexattr>, L<attr(5)>."
21477 #: ../fish/guestfish-actions.pod:3313
21482 #: ../fish/guestfish-actions.pod:3315
21485 " resize2fs device\n"
21490 #: ../fish/guestfish-actions.pod:3320
21492 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
21493 "before calling this command. For unknown reasons C<resize2fs> sometimes "
21494 "gives an error about this and sometimes not. In any case, it is always safe "
21495 "to call L</e2fsck-f> before calling this function."
21499 #: ../fish/guestfish-actions.pod:3326
21500 msgid "resize2fs-size"
21504 #: ../fish/guestfish-actions.pod:3328
21507 " resize2fs-size device size\n"
21512 #: ../fish/guestfish-actions.pod:3330
21514 "This command is the same as L</resize2fs> except that it allows you to "
21515 "specify the new size (in bytes) explicitly."
21519 #: ../fish/guestfish-actions.pod:3333
21524 #: ../fish/guestfish-actions.pod:3335
21532 #: ../fish/guestfish-actions.pod:3339
21537 #: ../fish/guestfish-actions.pod:3341
21545 #: ../fish/guestfish-actions.pod:3347
21550 #: ../fish/guestfish-actions.pod:3349
21558 #: ../fish/guestfish-actions.pod:3353
21559 msgid "rmmountpoint"
21563 #: ../fish/guestfish-actions.pod:3355
21566 " rmmountpoint exemptpath\n"
21571 #: ../fish/guestfish-actions.pod:3357
21573 "This calls removes a mountpoint that was previously created with "
21574 "L</mkmountpoint>. See L</mkmountpoint> for full details."
21578 #: ../fish/guestfish-actions.pod:3361
21579 msgid "scrub-device"
21583 #: ../fish/guestfish-actions.pod:3363
21586 " scrub-device device\n"
21591 #: ../fish/guestfish-actions.pod:3374
21596 #: ../fish/guestfish-actions.pod:3376
21599 " scrub-file file\n"
21604 #: ../fish/guestfish-actions.pod:3386
21605 msgid "scrub-freespace"
21609 #: ../fish/guestfish-actions.pod:3388
21612 " scrub-freespace dir\n"
21617 #: ../fish/guestfish-actions.pod:3390
21619 "This command creates the directory C<dir> and then fills it with files until "
21620 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
21621 "deletes them. The intention is to scrub any free space on the partition "
21622 "containing C<dir>."
21626 #: ../fish/guestfish-actions.pod:3399
21631 #: ../fish/guestfish-actions.pod:3401
21636 #: ../fish/guestfish-actions.pod:3403
21639 " set-append append\n"
21644 #: ../fish/guestfish-actions.pod:3414
21645 msgid "set-autosync"
21649 #: ../fish/guestfish-actions.pod:3416
21654 #: ../fish/guestfish-actions.pod:3418
21657 " set-autosync true|false\n"
21662 #: ../fish/guestfish-actions.pod:3420
21664 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
21665 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
21666 "closed (also if the program exits without closing handles)."
21670 #: ../fish/guestfish-actions.pod:3428
21675 #: ../fish/guestfish-actions.pod:3430
21680 #: ../fish/guestfish-actions.pod:3432
21683 " set-direct true|false\n"
21688 #: ../fish/guestfish-actions.pod:3438
21690 "One consequence of this is that log messages aren't caught by the library "
21691 "and handled by L</set-log-message-callback>, but go straight to stdout."
21695 #: ../fish/guestfish-actions.pod:3447
21696 msgid "set-e2label"
21700 #: ../fish/guestfish-actions.pod:3449
21703 " set-e2label device label\n"
21708 #: ../fish/guestfish-actions.pod:3455
21710 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
21711 "label on a filesystem."
21715 #: ../fish/guestfish-actions.pod:3458
21720 #: ../fish/guestfish-actions.pod:3460
21723 " set-e2uuid device uuid\n"
21728 #: ../fish/guestfish-actions.pod:3467
21730 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
21731 "UUID of a filesystem."
21735 #: ../fish/guestfish-actions.pod:3470
21736 msgid "set-memsize"
21740 #: ../fish/guestfish-actions.pod:3472
21745 #: ../fish/guestfish-actions.pod:3474
21748 " set-memsize memsize\n"
21753 #: ../fish/guestfish-actions.pod:3476
21755 "This sets the memory size in megabytes allocated to the qemu subprocess. "
21756 "This only has any effect if called before L</launch>."
21760 #: ../fish/guestfish-actions.pod:3487
21761 msgid "set-network"
21765 #: ../fish/guestfish-actions.pod:3489
21770 #: ../fish/guestfish-actions.pod:3491
21773 " set-network true|false\n"
21778 #: ../fish/guestfish-actions.pod:3499
21779 msgid "You must call this before calling L</launch>, otherwise it has no effect."
21783 #: ../fish/guestfish-actions.pod:3502
21788 #: ../fish/guestfish-actions.pod:3504
21793 #: ../fish/guestfish-actions.pod:3506
21796 " set-path searchpath\n"
21801 #: ../fish/guestfish-actions.pod:3515
21806 #: ../fish/guestfish-actions.pod:3517
21811 #: ../fish/guestfish-actions.pod:3519
21819 #: ../fish/guestfish-actions.pod:3539
21820 msgid "set-recovery-proc"
21824 #: ../fish/guestfish-actions.pod:3541
21825 msgid "recovery-proc"
21829 #: ../fish/guestfish-actions.pod:3543
21832 " set-recovery-proc true|false\n"
21837 #: ../fish/guestfish-actions.pod:3545
21839 "If this is called with the parameter C<false> then L</launch> does not "
21840 "create a recovery process. The purpose of the recovery process is to stop "
21841 "runaway qemu processes in the case where the main program aborts abruptly."
21845 #: ../fish/guestfish-actions.pod:3550
21847 "This only has any effect if called before L</launch>, and the default is "
21852 #: ../fish/guestfish-actions.pod:3559
21853 msgid "set-selinux"
21857 #: ../fish/guestfish-actions.pod:3561
21862 #: ../fish/guestfish-actions.pod:3563
21865 " set-selinux true|false\n"
21870 #: ../fish/guestfish-actions.pod:3574
21875 #: ../fish/guestfish-actions.pod:3576
21880 #: ../fish/guestfish-actions.pod:3578
21883 " set-trace true|false\n"
21888 #: ../fish/guestfish-actions.pod:3594
21889 msgid "set-verbose"
21893 #: ../fish/guestfish-actions.pod:3596
21898 #: ../fish/guestfish-actions.pod:3598
21901 " set-verbose true|false\n"
21906 #: ../fish/guestfish-actions.pod:3605
21911 #: ../fish/guestfish-actions.pod:3607
21914 " setcon context\n"
21919 #: ../fish/guestfish-actions.pod:3614
21924 #: ../fish/guestfish-actions.pod:3616
21927 " setxattr xattr val vallen path\n"
21932 #: ../fish/guestfish-actions.pod:3622
21933 msgid "See also: L</lsetxattr>, L<attr(5)>."
21937 #: ../fish/guestfish-actions.pod:3624
21942 #: ../fish/guestfish-actions.pod:3626
21945 " sfdisk device cyls heads sectors 'lines ...'\n"
21950 #: ../fish/guestfish-actions.pod:3648
21951 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
21955 #: ../fish/guestfish-actions.pod:3654
21960 #: ../fish/guestfish-actions.pod:3656
21963 " sfdiskM device 'lines ...'\n"
21968 #: ../fish/guestfish-actions.pod:3658
21970 "This is a simplified interface to the L</sfdisk> command, where partition "
21971 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
21972 "you don't need to specify the cyls, heads and sectors parameters which were "
21973 "rarely if ever used anyway."
21977 #: ../fish/guestfish-actions.pod:3664
21978 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
21982 #: ../fish/guestfish-actions.pod:3670
21987 #: ../fish/guestfish-actions.pod:3672
21990 " sfdisk-N device partnum cyls heads sectors line\n"
21995 #: ../fish/guestfish-actions.pod:3677
21997 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
21998 "cyls/heads/sectors parameters."
22002 #: ../fish/guestfish-actions.pod:3680
22003 msgid "See also: L</part-add>"
22007 #: ../fish/guestfish-actions.pod:3685
22008 msgid "sfdisk-disk-geometry"
22012 #: ../fish/guestfish-actions.pod:3687
22015 " sfdisk-disk-geometry device\n"
22020 #: ../fish/guestfish-actions.pod:3689
22022 "This displays the disk geometry of C<device> read from the partition table. "
22023 "Especially in the case where the underlying block device has been resized, "
22024 "this can be different from the kernel's idea of the geometry (see "
22025 "L</sfdisk-kernel-geometry>)."
22029 #: ../fish/guestfish-actions.pod:3697
22030 msgid "sfdisk-kernel-geometry"
22034 #: ../fish/guestfish-actions.pod:3699
22037 " sfdisk-kernel-geometry device\n"
22042 #: ../fish/guestfish-actions.pod:3706
22047 #: ../fish/guestfish-actions.pod:3708
22050 " sfdisk-l device\n"
22055 #: ../fish/guestfish-actions.pod:3714
22056 msgid "See also: L</part-list>"
22060 #: ../fish/guestfish-actions.pod:3716
22065 #: ../fish/guestfish-actions.pod:3718
22073 #: ../fish/guestfish-actions.pod:3723
22074 msgid "This is like L</command>, but passes the command to:"
22078 #: ../fish/guestfish-actions.pod:3731
22079 msgid "All the provisos about L</command> apply to this call."
22083 #: ../fish/guestfish-actions.pod:3733
22088 #: ../fish/guestfish-actions.pod:3735
22091 " sh-lines command\n"
22096 #: ../fish/guestfish-actions.pod:3737
22097 msgid "This is the same as L</sh>, but splits the result into a list of lines."
22101 #: ../fish/guestfish-actions.pod:3740
22102 msgid "See also: L</command-lines>"
22106 #: ../fish/guestfish-actions.pod:3742
22111 #: ../fish/guestfish-actions.pod:3744
22119 #: ../fish/guestfish-actions.pod:3748
22124 #: ../fish/guestfish-actions.pod:3750
22132 #: ../fish/guestfish-actions.pod:3756
22137 #: ../fish/guestfish-actions.pod:3758
22145 #: ../fish/guestfish-actions.pod:3766
22150 #: ../fish/guestfish-actions.pod:3768
22158 #: ../fish/guestfish-actions.pod:3776
22163 #: ../fish/guestfish-actions.pod:3778
22166 " strings-e encoding path\n"
22171 #: ../fish/guestfish-actions.pod:3780
22173 "This is like the L</strings> command, but allows you to specify the encoding "
22174 "of strings that are looked for in the source file C<path>."
22178 #: ../fish/guestfish-actions.pod:3790
22180 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
22181 "ISO-8859-X (this is what L</strings> uses)."
22185 #: ../fish/guestfish-actions.pod:3822
22186 msgid "swapoff-device"
22190 #: ../fish/guestfish-actions.pod:3824
22193 " swapoff-device device\n"
22198 #: ../fish/guestfish-actions.pod:3826
22200 "This command disables the libguestfs appliance swap device or partition "
22201 "named C<device>. See L</swapon-device>."
22205 #: ../fish/guestfish-actions.pod:3830
22206 msgid "swapoff-file"
22210 #: ../fish/guestfish-actions.pod:3832
22213 " swapoff-file file\n"
22218 #: ../fish/guestfish-actions.pod:3836
22219 msgid "swapoff-label"
22223 #: ../fish/guestfish-actions.pod:3838
22226 " swapoff-label label\n"
22231 #: ../fish/guestfish-actions.pod:3843
22232 msgid "swapoff-uuid"
22236 #: ../fish/guestfish-actions.pod:3845
22239 " swapoff-uuid uuid\n"
22244 #: ../fish/guestfish-actions.pod:3850
22245 msgid "swapon-device"
22249 #: ../fish/guestfish-actions.pod:3852
22252 " swapon-device device\n"
22257 #: ../fish/guestfish-actions.pod:3854
22259 "This command enables the libguestfs appliance to use the swap device or "
22260 "partition named C<device>. The increased memory is made available for all "
22261 "commands, for example those run using L</command> or L</sh>."
22265 #: ../fish/guestfish-actions.pod:3866
22266 msgid "swapon-file"
22270 #: ../fish/guestfish-actions.pod:3868
22273 " swapon-file file\n"
22278 #: ../fish/guestfish-actions.pod:3870
22279 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
22283 #: ../fish/guestfish-actions.pod:3873
22284 msgid "swapon-label"
22288 #: ../fish/guestfish-actions.pod:3875
22291 " swapon-label label\n"
22296 #: ../fish/guestfish-actions.pod:3877
22298 "This command enables swap to a labeled swap partition. See "
22299 "L</swapon-device> for other notes."
22303 #: ../fish/guestfish-actions.pod:3880
22304 msgid "swapon-uuid"
22308 #: ../fish/guestfish-actions.pod:3882
22311 " swapon-uuid uuid\n"
22316 #: ../fish/guestfish-actions.pod:3884
22318 "This command enables swap to a swap partition with the given UUID. See "
22319 "L</swapon-device> for other notes."
22323 #: ../fish/guestfish-actions.pod:3887
22328 #: ../fish/guestfish-actions.pod:3889
22336 #: ../fish/guestfish-actions.pod:3897
22341 #: ../fish/guestfish-actions.pod:3899
22349 #: ../fish/guestfish-actions.pod:3907
22354 #: ../fish/guestfish-actions.pod:3909
22357 " tail-n nrlines path\n"
22362 #: ../fish/guestfish-actions.pod:3922
22367 #: ../fish/guestfish-actions.pod:3924
22370 " tar-in (tarfile|-) directory\n"
22375 #: ../fish/guestfish-actions.pod:3929
22376 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
22380 #: ../fish/guestfish-actions.pod:3934
22385 #: ../fish/guestfish-actions.pod:3936
22388 " tar-out directory (tarfile|-)\n"
22393 #: ../fish/guestfish-actions.pod:3941
22394 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
22398 #: ../fish/guestfish-actions.pod:3946
22403 #: ../fish/guestfish-actions.pod:3948
22406 " tgz-in (tarball|-) directory\n"
22411 #: ../fish/guestfish-actions.pod:3953
22412 msgid "To upload an uncompressed tarball, use L</tar-in>."
22416 #: ../fish/guestfish-actions.pod:3957
22421 #: ../fish/guestfish-actions.pod:3959
22424 " tgz-out directory (tarball|-)\n"
22429 #: ../fish/guestfish-actions.pod:3964
22430 msgid "To download an uncompressed tarball, use L</tar-out>."
22434 #: ../fish/guestfish-actions.pod:3968
22439 #: ../fish/guestfish-actions.pod:3970
22447 #: ../fish/guestfish-actions.pod:3979
22452 #: ../fish/guestfish-actions.pod:3981
22460 #: ../fish/guestfish-actions.pod:3986
22461 msgid "truncate-size"
22465 #: ../fish/guestfish-actions.pod:3988
22468 " truncate-size path size\n"
22473 #: ../fish/guestfish-actions.pod:3993
22475 "If the current file size is less than C<size> then the file is extended to "
22476 "the required size with zero bytes. This creates a sparse file (ie. disk "
22477 "blocks are not allocated for the file until you write to it). To create a "
22478 "non-sparse file of zeroes, use L</fallocate64> instead."
22482 #: ../fish/guestfish-actions.pod:3999
22487 #: ../fish/guestfish-actions.pod:4001
22490 " tune2fs-l device\n"
22495 #: ../fish/guestfish-actions.pod:4011
22500 #: ../fish/guestfish-actions.pod:4013
22503 " txz-in (tarball|-) directory\n"
22508 #: ../fish/guestfish-actions.pod:4020
22513 #: ../fish/guestfish-actions.pod:4022
22516 " txz-out directory (tarball|-)\n"
22521 #: ../fish/guestfish-actions.pod:4029
22526 #: ../fish/guestfish-actions.pod:4031
22534 #: ../fish/guestfish-actions.pod:4045
22535 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
22539 #: ../fish/guestfish-actions.pod:4050
22544 #: ../fish/guestfish-actions.pod:4052
22549 #: ../fish/guestfish-actions.pod:4054
22552 " umount pathordevice\n"
22557 #: ../fish/guestfish-actions.pod:4060
22562 #: ../fish/guestfish-actions.pod:4062
22563 msgid "unmount-all"
22567 #: ../fish/guestfish-actions.pod:4064
22575 #: ../fish/guestfish-actions.pod:4070
22580 #: ../fish/guestfish-actions.pod:4072
22583 " upload (filename|-) remotefilename\n"
22588 #: ../fish/guestfish-actions.pod:4079
22589 msgid "See also L</download>."
22593 #: ../fish/guestfish-actions.pod:4083
22594 msgid "upload-offset"
22598 #: ../fish/guestfish-actions.pod:4085
22601 " upload-offset (filename|-) remotefilename offset\n"
22606 #: ../fish/guestfish-actions.pod:4097
22608 "Note that there is no limit on the amount of data that can be uploaded with "
22609 "this call, unlike with L</pwrite>, and this call always writes the full "
22610 "amount unless an error occurs."
22614 #: ../fish/guestfish-actions.pod:4102
22615 msgid "See also L</upload>, L</pwrite>."
22619 #: ../fish/guestfish-actions.pod:4106
22624 #: ../fish/guestfish-actions.pod:4108
22627 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
22632 #: ../fish/guestfish-actions.pod:4127
22637 #: ../fish/guestfish-actions.pod:4129
22645 #: ../fish/guestfish-actions.pod:4156
22647 "I<Note:> Don't use this call to test for availability of features. In "
22648 "enterprise distributions we backport features from later versions into "
22649 "earlier versions, making this an unreliable way to test for features. Use "
22650 "L</available> instead."
22654 #: ../fish/guestfish-actions.pod:4162
22659 #: ../fish/guestfish-actions.pod:4164
22662 " vfs-label device\n"
22667 #: ../fish/guestfish-actions.pod:4171
22668 msgid "To find a filesystem from the label, use L</findfs-label>."
22672 #: ../fish/guestfish-actions.pod:4173
22677 #: ../fish/guestfish-actions.pod:4175
22680 " vfs-type device\n"
22685 #: ../fish/guestfish-actions.pod:4185
22690 #: ../fish/guestfish-actions.pod:4187
22693 " vfs-uuid device\n"
22698 #: ../fish/guestfish-actions.pod:4194
22699 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
22703 #: ../fish/guestfish-actions.pod:4196
22704 msgid "vg-activate"
22708 #: ../fish/guestfish-actions.pod:4198
22711 " vg-activate true|false 'volgroups ...'\n"
22716 #: ../fish/guestfish-actions.pod:4211
22717 msgid "vg-activate-all"
22721 #: ../fish/guestfish-actions.pod:4213
22724 " vg-activate-all true|false\n"
22729 #: ../fish/guestfish-actions.pod:4223
22734 #: ../fish/guestfish-actions.pod:4225
22737 " vgcreate volgroup 'physvols ...'\n"
22742 #: ../fish/guestfish-actions.pod:4230
22747 #: ../fish/guestfish-actions.pod:4232
22750 " vglvuuids vgname\n"
22755 #: ../fish/guestfish-actions.pod:4237
22757 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
22758 "logical volumes and volume groups."
22762 #: ../fish/guestfish-actions.pod:4240
22763 msgid "See also L</vgpvuuids>."
22767 #: ../fish/guestfish-actions.pod:4242
22772 #: ../fish/guestfish-actions.pod:4244
22775 " vgpvuuids vgname\n"
22780 #: ../fish/guestfish-actions.pod:4249
22782 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
22783 "physical volumes and volume groups."
22787 #: ../fish/guestfish-actions.pod:4252
22788 msgid "See also L</vglvuuids>."
22792 #: ../fish/guestfish-actions.pod:4254
22797 #: ../fish/guestfish-actions.pod:4256
22800 " vgremove vgname\n"
22805 #: ../fish/guestfish-actions.pod:4263
22810 #: ../fish/guestfish-actions.pod:4265
22813 " vgrename volgroup newvolgroup\n"
22818 #: ../fish/guestfish-actions.pod:4269
22823 #: ../fish/guestfish-actions.pod:4271
22831 #: ../fish/guestfish-actions.pod:4279
22832 msgid "See also L</vgs-full>."
22836 #: ../fish/guestfish-actions.pod:4281
22841 #: ../fish/guestfish-actions.pod:4283
22849 #: ../fish/guestfish-actions.pod:4288
22854 #: ../fish/guestfish-actions.pod:4290
22862 #: ../fish/guestfish-actions.pod:4295
22867 #: ../fish/guestfish-actions.pod:4297
22875 #: ../fish/guestfish-actions.pod:4301
22880 #: ../fish/guestfish-actions.pod:4303
22888 #: ../fish/guestfish-actions.pod:4308
22893 #: ../fish/guestfish-actions.pod:4310
22901 #: ../fish/guestfish-actions.pod:4315
22906 #: ../fish/guestfish-actions.pod:4317
22914 #: ../fish/guestfish-actions.pod:4322
22919 #: ../fish/guestfish-actions.pod:4324
22922 " write path content\n"
22927 #: ../fish/guestfish-actions.pod:4332
22932 #: ../fish/guestfish-actions.pod:4334
22935 " write-file path content size\n"
22940 #: ../fish/guestfish-actions.pod:4357
22945 #: ../fish/guestfish-actions.pod:4359
22948 " zegrep regex path\n"
22953 #: ../fish/guestfish-actions.pod:4367
22958 #: ../fish/guestfish-actions.pod:4369
22961 " zegrepi regex path\n"
22966 #: ../fish/guestfish-actions.pod:4377
22971 #: ../fish/guestfish-actions.pod:4379
22979 #: ../fish/guestfish-actions.pod:4387
22980 msgid "See also: L</zero-device>, L</scrub-device>."
22984 #: ../fish/guestfish-actions.pod:4389
22985 msgid "zero-device"
22989 #: ../fish/guestfish-actions.pod:4391
22992 " zero-device device\n"
22997 #: ../fish/guestfish-actions.pod:4393
22999 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
23000 "which just zeroes the first few blocks of a device."
23004 #: ../fish/guestfish-actions.pod:4400
23009 #: ../fish/guestfish-actions.pod:4402
23012 " zerofree device\n"
23017 #: ../fish/guestfish-actions.pod:4415
23022 #: ../fish/guestfish-actions.pod:4417
23025 " zfgrep pattern path\n"
23030 #: ../fish/guestfish-actions.pod:4425
23035 #: ../fish/guestfish-actions.pod:4427
23038 " zfgrepi pattern path\n"
23043 #: ../fish/guestfish-actions.pod:4435
23048 #: ../fish/guestfish-actions.pod:4437
23051 " zfile meth path\n"
23056 #: ../fish/guestfish-actions.pod:4444
23057 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
23061 #: ../fish/guestfish-actions.pod:4454
23066 #: ../fish/guestfish-actions.pod:4456
23069 " zgrep regex path\n"
23074 #: ../fish/guestfish-actions.pod:4464
23079 #: ../fish/guestfish-actions.pod:4466
23082 " zgrepi regex path\n"
23087 #: ../fish/guestfish-commands.pod:1
23092 #: ../fish/guestfish-commands.pod:3
23097 #: ../fish/guestfish-commands.pod:5
23100 " alloc filename size\n"
23105 #: ../fish/guestfish-commands.pod:7
23107 "This creates an empty (zeroed) file of the given size, and then adds so it "
23108 "can be further examined."
23112 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
23113 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
23117 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
23118 msgid "Size can be specified using standard suffixes, eg. C<1M>."
23122 #: ../fish/guestfish-commands.pod:14
23124 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
23125 "image, see L</PREPARED DISK IMAGES>."
23129 #: ../fish/guestfish-commands.pod:17
23134 #: ../fish/guestfish-commands.pod:19
23137 " copy-in local [local ...] /remotedir\n"
23142 #: ../fish/guestfish-commands.pod:21
23144 "C<copy-in> copies local files or directories recursively into the disk "
23145 "image, placing them in the directory called C</remotedir> (which must "
23146 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
23147 "other commands as necessary."
23151 #: ../fish/guestfish-commands.pod:26
23153 "Multiple local files and directories can be specified, but the last "
23154 "parameter must always be a remote directory. Wildcards cannot be used."
23158 #: ../fish/guestfish-commands.pod:30
23163 #: ../fish/guestfish-commands.pod:32
23166 " copy-out remote [remote ...] localdir\n"
23171 #: ../fish/guestfish-commands.pod:34
23173 "C<copy-out> copies remote files or directories recursively out of the disk "
23174 "image, placing them on the host disk in a local directory called C<localdir> "
23175 "(which must exist). This guestfish meta-command turns into a sequence of "
23176 "L</download>, L</tar-out> and other commands as necessary."
23180 #: ../fish/guestfish-commands.pod:40
23182 "Multiple remote files and directories can be specified, but the last "
23183 "parameter must always be a local directory. To download to the current "
23184 "directory, use C<.> as in:"
23188 #: ../fish/guestfish-commands.pod:44
23191 " copy-out /home .\n"
23196 #: ../fish/guestfish-commands.pod:46
23198 "Wildcards cannot be used in the ordinary command, but you can use them with "
23199 "the help of L</glob> like this:"
23203 #: ../fish/guestfish-commands.pod:49
23206 " glob copy-out /home/* .\n"
23211 #: ../fish/guestfish-commands.pod:51
23216 #: ../fish/guestfish-commands.pod:53
23219 " echo [params ...]\n"
23224 #: ../fish/guestfish-commands.pod:55
23225 msgid "This echos the parameters to the terminal."
23229 #: ../fish/guestfish-commands.pod:57
23234 #: ../fish/guestfish-commands.pod:59
23239 #: ../fish/guestfish-commands.pod:61
23244 #: ../fish/guestfish-commands.pod:63
23252 #: ../fish/guestfish-commands.pod:65
23254 "This is used to edit a file. It downloads the file, edits it locally using "
23255 "your editor, then uploads the result."
23259 #: ../fish/guestfish-commands.pod:68
23261 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
23262 "or C<emacs> you will get those corresponding editors."
23266 #: ../fish/guestfish-commands.pod:72
23271 #: ../fish/guestfish-commands.pod:74
23274 " glob command args...\n"
23279 #: ../fish/guestfish-commands.pod:76
23281 "Expand wildcards in any paths in the args list, and run C<command> "
23282 "repeatedly on each matching path."
23286 #: ../fish/guestfish-commands.pod:79
23287 msgid "See L</WILDCARDS AND GLOBBING>."
23291 #: ../fish/guestfish-commands.pod:81
23296 #: ../fish/guestfish-commands.pod:83
23299 " hexedit <filename|device>\n"
23300 " hexedit <filename|device> <max>\n"
23301 " hexedit <filename|device> <start> <max>\n"
23306 #: ../fish/guestfish-commands.pod:87
23308 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
23313 #: ../fish/guestfish-commands.pod:90
23315 "This command works by downloading potentially the whole file or device, "
23316 "editing it locally, then uploading it. If the file or device is large, you "
23317 "have to specify which part you wish to edit by using C<max> and/or C<start> "
23318 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
23319 "usual modifiers allowed such as C<1M> (1 megabyte)."
23323 #: ../fish/guestfish-commands.pod:97
23324 msgid "For example to edit the first few sectors of a disk you might do:"
23328 #: ../fish/guestfish-commands.pod:100
23331 " hexedit /dev/sda 1M\n"
23336 #: ../fish/guestfish-commands.pod:102
23338 "which would allow you to edit anywhere within the first megabyte of the "
23343 #: ../fish/guestfish-commands.pod:105
23344 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
23348 #: ../fish/guestfish-commands.pod:107
23351 " hexedit /dev/sda1 0x400 0x400\n"
23356 #: ../fish/guestfish-commands.pod:109
23357 msgid "(assuming the superblock is in the standard location)."
23361 #: ../fish/guestfish-commands.pod:111
23363 "This command requires the external L<hexedit(1)> program. You can specify "
23364 "another program to use by setting the C<HEXEDITOR> environment variable."
23368 #: ../fish/guestfish-commands.pod:115
23369 msgid "See also L</hexdump>."
23373 #: ../fish/guestfish-commands.pod:117
23378 #: ../fish/guestfish-commands.pod:119
23386 #: ../fish/guestfish-commands.pod:121
23387 msgid "Change the local directory, ie. the current directory of guestfish itself."
23391 #: ../fish/guestfish-commands.pod:124
23392 msgid "Note that C<!cd> won't do what you might expect."
23396 #: ../fish/guestfish-commands.pod:126
23401 #: ../fish/guestfish-commands.pod:128
23406 #: ../fish/guestfish-commands.pod:130
23414 #: ../fish/guestfish-commands.pod:132
23415 msgid "Opens the manual page for guestfish."
23419 #: ../fish/guestfish-commands.pod:134
23424 #: ../fish/guestfish-commands.pod:136
23429 #: ../fish/guestfish-commands.pod:138
23437 #: ../fish/guestfish-commands.pod:140
23445 #: ../fish/guestfish-commands.pod:142
23446 msgid "This is used to view a file."
23450 #: ../fish/guestfish-commands.pod:144
23452 "The default viewer is C<$PAGER>. However if you use the alternate command "
23453 "C<less> you will get the C<less> command specifically."
23457 #: ../fish/guestfish-commands.pod:147
23462 #: ../fish/guestfish-commands.pod:149
23470 #: ../fish/guestfish-commands.pod:151
23472 "Close and reopen the libguestfs handle. It is not necessary to use this "
23473 "normally, because the handle is closed properly when guestfish exits. "
23474 "However this is occasionally useful for testing."
23478 #: ../fish/guestfish-commands.pod:155
23483 #: ../fish/guestfish-commands.pod:157
23486 " sparse filename size\n"
23491 #: ../fish/guestfish-commands.pod:159
23493 "This creates an empty sparse file of the given size, and then adds so it can "
23494 "be further examined."
23498 #: ../fish/guestfish-commands.pod:162
23500 "In all respects it works the same as the L</alloc> command, except that the "
23501 "image file is allocated sparsely, which means that disk blocks are not "
23502 "assigned to the file until they are needed. Sparse disk files only use "
23503 "space when written to, but they are slower and there is a danger you could "
23504 "run out of real disk space during a write operation."
23508 #: ../fish/guestfish-commands.pod:172
23513 #: ../fish/guestfish-commands.pod:174
23521 #: ../fish/guestfish-commands.pod:176
23523 "This command returns a list of the optional groups known to the daemon, and "
23524 "indicates which ones are supported by this build of the libguestfs "
23529 #: ../fish/guestfish-commands.pod:180
23530 msgid "See also L<guestfs(3)/AVAILABILITY>."
23534 #: ../fish/guestfish-commands.pod:182
23539 #: ../fish/guestfish-commands.pod:184
23542 " time command args...\n"
23547 #: ../fish/guestfish-commands.pod:186
23549 "Run the command as usual, but print the elapsed time afterwards. This can "
23550 "be useful for benchmarking operations."
23554 #: ../test-tool/libguestfs-test-tool.pod:5
23555 msgid "libguestfs-test-tool - End user tests for libguestfs"
23559 #: ../test-tool/libguestfs-test-tool.pod:9
23562 " libguestfs-test-tool [--options]\n"
23567 #: ../test-tool/libguestfs-test-tool.pod:13
23569 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
23570 "and developers, to allow them to check basic libguestfs functionality is "
23571 "working. This is needed because libguestfs occasionally breaks for reasons "
23572 "beyond our control: usually because of changes in the underlying qemu or "
23573 "kernel packages, or the host environment."
23577 #: ../test-tool/libguestfs-test-tool.pod:20
23578 msgid "If you suspect a problem in libguestfs, then just run:"
23582 #: ../test-tool/libguestfs-test-tool.pod:22
23585 " libguestfs-test-tool\n"
23590 #: ../test-tool/libguestfs-test-tool.pod:24
23591 msgid "It will print lots of diagnostic messages."
23595 #: ../test-tool/libguestfs-test-tool.pod:26
23596 msgid "If it runs to completion successfully, you will see this near the end:"
23600 #: ../test-tool/libguestfs-test-tool.pod:28
23603 " ===== TEST FINISHED OK =====\n"
23608 #: ../test-tool/libguestfs-test-tool.pod:30
23609 msgid "and the test tool will exit with code 0."
23613 #: ../test-tool/libguestfs-test-tool.pod:32
23615 "If it fails (and/or exits with non-zero error code), please paste the "
23616 "B<complete, unedited> output of the test tool into a bug report. More "
23617 "information about reporting bugs can be found on the "
23618 "L<http://libguestfs.org/> website."
23622 #: ../test-tool/libguestfs-test-tool.pod:41
23627 #: ../test-tool/libguestfs-test-tool.pod:43
23628 msgid "Display short usage information and exit."
23632 #: ../test-tool/libguestfs-test-tool.pod:45
23633 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
23637 #: ../test-tool/libguestfs-test-tool.pod:47
23639 "Pass an alternate name for the helper program. libguestfs-test-tool will "
23640 "normally look in the C<$libexec> directory that was configured when the tool "
23645 #: ../test-tool/libguestfs-test-tool.pod:51
23646 msgid "I<--qemu qemu_binary>"
23650 #: ../test-tool/libguestfs-test-tool.pod:53
23652 "If you have downloaded another qemu binary, point this option at the full "
23653 "path of the binary to try it."
23657 #: ../test-tool/libguestfs-test-tool.pod:56
23658 msgid "I<--qemudir qemu_source_dir>"
23662 #: ../test-tool/libguestfs-test-tool.pod:58
23664 "If you have compiled qemu from source, point this option at the source "
23665 "directory to try it."
23669 #: ../test-tool/libguestfs-test-tool.pod:61
23670 msgid "I<--timeout N>"
23674 #: ../test-tool/libguestfs-test-tool.pod:63
23676 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
23677 "does not usually need to be adjusted unless your machine is very slow."
23681 #: ../test-tool/libguestfs-test-tool.pod:69
23682 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
23686 #: ../test-tool/libguestfs-test-tool.pod:71
23688 "If you have compiled another version of qemu from source and would like to "
23689 "try that, then you can use the I<--qemudir> option to point to the qemu "
23690 "source directory."
23694 #: ../test-tool/libguestfs-test-tool.pod:75
23696 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
23697 "option to point to the binary."
23701 #: ../test-tool/libguestfs-test-tool.pod:78
23703 "When using an alternate qemu with libguestfs, usually you would need to "
23704 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
23705 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
23706 "when you use either of the I<--qemudir> or I<--qemu> options."
23710 #: ../test-tool/libguestfs-test-tool.pod:85
23712 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
23713 "I<1> if there was an error."
23717 #: ../test-tool/libguestfs-test-tool.pod:92
23718 msgid "/usr/libexec/libguestfs-test-tool-helper"
23722 #: ../test-tool/libguestfs-test-tool.pod:94
23724 "This helper program is run inside the appliance and provides additional "
23729 #: ../test-tool/libguestfs-test-tool.pod:97
23730 msgid "/usr/bin/mkisofs"
23734 #: ../test-tool/libguestfs-test-tool.pod:99
23736 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
23737 "which is used as part of the tests."
23741 #: ../test-tool/libguestfs-test-tool.pod:106
23743 "For the full list of environment variables which may affect libguestfs, "
23744 "please see the L<guestfs(3)> manual page."
23748 #: ../test-tool/libguestfs-test-tool.pod:111
23749 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
23753 #: ../test-tool/libguestfs-test-tool.pod:121
23754 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
23758 #: ../fuse/guestmount.pod:5
23759 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
23763 #: ../fuse/guestmount.pod:9
23766 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
23771 #: ../fuse/guestmount.pod:11
23774 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
23779 #: ../fuse/guestmount.pod:13
23782 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
23787 #: ../fuse/guestmount.pod:17
23789 "You must I<not> use C<guestmount> in read-write mode on live virtual "
23790 "machines. If you do this, you risk disk corruption in the VM."
23794 #: ../fuse/guestmount.pod:22
23796 "The guestmount program can be used to mount virtual machine filesystems and "
23797 "other disk images on the host. It uses libguestfs for access to the guest "
23798 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
23799 "a mountable device."
23803 #: ../fuse/guestmount.pod:27
23805 "Along with other options, you have to give at least one device (I<-a> "
23806 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
23807 "option) or use the I<-i> inspection option. How this works is better "
23808 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
23813 #: ../fuse/guestmount.pod:33
23815 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
23816 "by you, and the filesystem will not be visible to any other users unless you "
23817 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
23818 "the filesystem, use the C<fusermount -u> command."
23822 #: ../fuse/guestmount.pod:41
23824 "For a typical Windows guest which has its main filesystem on the first "
23829 #: ../fuse/guestmount.pod:44
23832 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
23837 #: ../fuse/guestmount.pod:46
23839 "For a typical Linux guest which has a /boot filesystem on the first "
23840 "partition, and the root filesystem on a logical volume:"
23844 #: ../fuse/guestmount.pod:49
23847 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
23852 #: ../fuse/guestmount.pod:51
23853 msgid "To get libguestfs to detect guest mountpoints for you:"
23857 #: ../fuse/guestmount.pod:53
23860 " guestmount -a guest.img -i --ro /mnt\n"
23865 #: ../fuse/guestmount.pod:55
23866 msgid "For a libvirt guest called \"Guest\" you could do:"
23870 #: ../fuse/guestmount.pod:57
23873 " guestmount -d Guest -i --ro /mnt\n"
23878 #: ../fuse/guestmount.pod:59
23880 "If you don't know what filesystems are contained in a guest or disk image, "
23881 "use L<virt-list-filesystems(1)> first:"
23885 #: ../fuse/guestmount.pod:62
23888 " virt-list-filesystems MyGuest\n"
23893 #: ../fuse/guestmount.pod:64
23895 "If you want to trace the libguestfs calls but without excessive debugging "
23896 "information, we recommend:"
23900 #: ../fuse/guestmount.pod:67
23903 " guestmount [...] --trace /mnt\n"
23908 #: ../fuse/guestmount.pod:69
23909 msgid "If you want to debug the program, we recommend:"
23913 #: ../fuse/guestmount.pod:71
23916 " guestmount [...] --trace --verbose /mnt\n"
23921 #: ../fuse/guestmount.pod:79
23922 msgid "Add a block device or virtual machine image."
23926 #: ../fuse/guestmount.pod:96
23927 msgid "B<--dir-cache-timeout N>"
23931 #: ../fuse/guestmount.pod:98
23933 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
23934 "seconds. The readdir cache [actually, there are several semi-independent "
23935 "caches] is populated after a readdir(2) call with the stat and extended "
23936 "attributes of the files in the directory, in anticipation that they will be "
23937 "requested soon after."
23941 #: ../fuse/guestmount.pod:104
23943 "There is also a different attribute cache implemented by FUSE (see the FUSE "
23944 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
23945 "requests, only cache existing ones."
23949 #: ../fuse/guestmount.pod:115
23951 "If you have untrusted raw-format guest disk images, you should use this "
23952 "option to specify the disk format. This avoids a possible security problem "
23953 "with malicious guests (CVE-2010-3851). See also "
23954 "L<guestfs(3)/guestfs_add_drive_opts>."
23958 #: ../fuse/guestmount.pod:120
23959 msgid "B<--fuse-help>"
23963 #: ../fuse/guestmount.pod:122
23964 msgid "Display help on special FUSE options (see I<-o> below)."
23968 #: ../fuse/guestmount.pod:126
23969 msgid "Display brief help and exit."
23973 #: ../fuse/guestmount.pod:134
23974 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
23978 #: ../fuse/guestmount.pod:136
23980 "Mount the named partition or logical volume on the given mountpoint B<in the "
23981 "guest> (this has nothing to do with mountpoints in the host)."
23985 #: ../fuse/guestmount.pod:139
23987 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
23988 "something on C</>."
23992 #: ../fuse/guestmount.pod:144
23994 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
23995 "unmounted. If you specify this option, then we don't attempt to sync the "
23996 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
24000 #: ../fuse/guestmount.pod:149
24001 msgid "B<-o option> | B<--option option>"
24005 #: ../fuse/guestmount.pod:151
24006 msgid "Pass extra options to FUSE."
24010 #: ../fuse/guestmount.pod:153
24012 "To get a list of all the extra options supported by FUSE, use the command "
24013 "below. Note that only the FUSE I<-o> options can be passed, and only some "
24014 "of them are a good idea."
24018 #: ../fuse/guestmount.pod:157
24021 " guestmount --fuse-help\n"
24026 #: ../fuse/guestmount.pod:159
24027 msgid "Some potentially useful FUSE options:"
24031 #: ../fuse/guestmount.pod:163
24032 msgid "B<-o allow_other>"
24036 #: ../fuse/guestmount.pod:165
24037 msgid "Allow other users to see the filesystem."
24041 #: ../fuse/guestmount.pod:167
24042 msgid "B<-o attr_timeout=N>"
24046 #: ../fuse/guestmount.pod:169
24047 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
24051 #: ../fuse/guestmount.pod:171
24052 msgid "B<-o kernel_cache>"
24056 #: ../fuse/guestmount.pod:173
24058 "Allow the kernel to cache files (reduces the number of reads that have to go "
24059 "through the L<guestfs(3)> API). This is generally a good idea if you can "
24060 "afford the extra memory usage."
24064 #: ../fuse/guestmount.pod:177
24065 msgid "B<-o uid=N> B<-o gid=N>"
24069 #: ../fuse/guestmount.pod:179
24071 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
24072 "the chosen values."
24076 #: ../fuse/guestmount.pod:186
24078 "Add devices and mount everything read-only. Also disallow writes and make "
24079 "the disk appear read-only to FUSE."
24083 #: ../fuse/guestmount.pod:189
24085 "This is highly recommended if you are not going to edit the guest disk. If "
24086 "the guest is running and this option is I<not> supplied, then there is a "
24087 "strong risk of disk corruption in the guest. We try to prevent this from "
24088 "happening, but it is not always possible."
24092 #: ../fuse/guestmount.pod:196
24093 msgid "Enable SELinux support for the guest."
24097 #: ../fuse/guestmount.pod:200
24098 msgid "Enable verbose messages from underlying libguestfs."
24102 #: ../fuse/guestmount.pod:204
24103 msgid "Display the program version and exit."
24107 #: ../fuse/guestmount.pod:206
24108 msgid "B<-x> | B<--trace>"
24112 #: ../fuse/guestmount.pod:208
24113 msgid "Trace libguestfs calls."
24117 #: ../fuse/guestmount.pod:210
24118 msgid "This also stops the daemon from forking into the background."
24122 #: ../fuse/guestmount.pod:216
24124 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
24125 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
24126 "L<http://fuse.sf.net/>."
24130 #: ../inspector/virt-inspector.pl:35
24132 "virt-inspector - Display operating system version and other information "
24133 "about a virtual machine"
24137 #: ../inspector/virt-inspector.pl:39
24140 " virt-inspector [--connect URI] domname\n"
24145 #: ../inspector/virt-inspector.pl:41
24148 " virt-inspector guest.img [guest.img ...]\n"
24153 #: ../inspector/virt-inspector.pl:45
24155 "B<virt-inspector> examines a virtual machine or disk image and tries to "
24156 "determine the version of the operating system and other information about "
24157 "the virtual machine."
24161 #: ../inspector/virt-inspector.pl:49
24162 msgid "Virt-inspector produces XML output for feeding into other programs."
24166 #: ../inspector/virt-inspector.pl:51
24168 "In the normal usage, use C<virt-inspector domname> where C<domname> is the "
24169 "libvirt domain (see: C<virsh list --all>)."
24173 #: ../inspector/virt-inspector.pl:54
24175 "You can also run virt-inspector directly on disk images from a single "
24176 "virtual machine. Use C<virt-inspector guest.img>. In rare cases a domain "
24177 "has several block devices, in which case you should list them one after "
24178 "another, with the first corresponding to the guest's C</dev/sda>, the second "
24179 "to the guest's C</dev/sdb> and so on."
24183 #: ../inspector/virt-inspector.pl:60
24185 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
24186 "inspect several virtual machines, you have to run virt-inspector several "
24187 "times (for example, from a shell script for-loop)."
24191 #: ../inspector/virt-inspector.pl:65
24193 "Because virt-inspector needs direct access to guest images, it won't "
24194 "normally work over remote libvirt connections."
24198 #: ../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
24199 msgid "Display brief help."
24203 #: ../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
24204 msgid "B<--version>"
24208 #: ../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
24209 msgid "Display version number and exit."
24213 #: ../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
24214 msgid "B<--connect URI> | B<-c URI>"
24218 #: ../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
24220 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
24221 "to the default libvirt hypervisor."
24225 #: ../inspector/virt-inspector.pl:97
24227 "Libvirt is only used if you specify a C<domname> on the command line. If "
24228 "you specify guest block devices directly, then libvirt is not used at all."
24232 #: ../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
24233 msgid "B<--format> raw"
24237 #: ../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
24239 "Specify the format of disk images given on the command line. If this is "
24240 "omitted then the format is autodetected from the content of the disk image."
24244 #: ../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
24246 "If disk images are requested from libvirt, then this program asks libvirt "
24247 "for this information. In this case, the value of the format parameter is "
24252 #: ../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
24254 "If working with untrusted raw-format guest disk images, you should ensure "
24255 "the format is always specified."
24259 #: ../inspector/virt-inspector.pl:149
24264 #: ../inspector/virt-inspector.pl:151
24266 "The virt-inspector XML is described precisely in a RELAX NG schema which is "
24267 "supplied with libguestfs. This section is just an overview."
24271 #: ../inspector/virt-inspector.pl:154
24273 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
24274 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
24275 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
24276 "which is vanishingly rare in real world VMs."
24280 #: ../inspector/virt-inspector.pl:159
24281 msgid "E<lt>operatingsystemE<gt>"
24285 #: ../inspector/virt-inspector.pl:161
24287 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
24288 "describe the operating system, its architecture, the descriptive \"product "
24289 "name\" string, the type of OS and so on, as in this example:"
24293 #: ../inspector/virt-inspector.pl:165
24296 " <operatingsystems>\n"
24297 " <operatingsystem>\n"
24298 " <root>/dev/sda2</root>\n"
24299 " <name>windows</name>\n"
24300 " <arch>i386</arch>\n"
24301 " <distro>windows</distro>\n"
24302 " <product_name>Windows 7 Enterprise</product_name>\n"
24303 " <major_version>6</major_version>\n"
24304 " <minor_version>1</minor_version>\n"
24305 " <windows_systemroot>/Windows</windows_systemroot>\n"
24310 #: ../inspector/virt-inspector.pl:176
24312 "These fields are derived from the libguestfs inspection API, and you can "
24313 "find more details in L<guestfs(3)/INSPECTION>."
24317 #: ../inspector/virt-inspector.pl:179
24319 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
24320 "of view of libguestfs (block devices may have completely different names "
24321 "inside the VM itself)."
24325 #: ../inspector/virt-inspector.pl:240
24326 msgid "E<lt>mountpointsE<gt>"
24330 #: ../inspector/virt-inspector.pl:242
24332 "Un*x-like guests typically have multiple filesystems which are mounted at "
24333 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
24334 "element which looks like this:"
24338 #: ../inspector/virt-inspector.pl:246
24341 " <operatingsystems>\n"
24342 " <operatingsystem>\n"
24345 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
24346 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
24347 " </mountpoints>\n"
24352 #: ../inspector/virt-inspector.pl:254
24354 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
24355 "and may have completely different names inside the guest. Only mountable "
24356 "filesystems appear in this list, not things like swap devices."
24360 #: ../inspector/virt-inspector.pl:276
24361 msgid "E<lt>filesystemsE<gt>"
24365 #: ../inspector/virt-inspector.pl:278
24367 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
24368 "filesystems belonging to the guest, including swap and empty partitions. "
24369 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
24370 "this OS or shared by this OS and other OSes)."
24374 #: ../inspector/virt-inspector.pl:283
24375 msgid "You might see something like this:"
24379 #: ../inspector/virt-inspector.pl:285
24382 " <operatingsystems>\n"
24383 " <operatingsystem>\n"
24386 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
24387 " <type>ext4</type>\n"
24388 " <label>Fedora-13-x86_64</label>\n"
24389 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
24395 #: ../inspector/virt-inspector.pl:295
24397 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
24398 "the label, and the UUID."
24402 #: ../inspector/virt-inspector.pl:337
24403 msgid "E<lt>applicationsE<gt>"
24407 #: ../inspector/virt-inspector.pl:339
24409 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
24410 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
24411 "machine. At the moment we are only able to list RPMs and Debian packages "
24412 "installed, but in future we will support other Linux distros and Windows."
24416 #: ../inspector/virt-inspector.pl:345
24418 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
24419 "Typical values would be C<rpm> and C<deb>."
24423 #: ../inspector/virt-inspector.pl:348
24425 "E<lt>package_managementE<gt>, if present, describes the package manager. "
24426 "Typical values include C<yum>, C<up2date> and C<apt>"
24430 #: ../inspector/virt-inspector.pl:351
24431 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
24435 #: ../inspector/virt-inspector.pl:354
24438 " <operatingsystems>\n"
24439 " <operatingsystem>\n"
24441 " <applications>\n"
24443 " <name>coreutils</name>\n"
24444 " <version>8.5</version>\n"
24445 " <release>1</release>\n"
24446 " </application>\n"
24451 #: ../inspector/virt-inspector.pl:364
24453 "(The version and release fields may not be available for some package "
24458 #: ../inspector/virt-inspector.pl:544
24459 msgid "USING XPATH"
24463 #: ../inspector/virt-inspector.pl:546
24465 "You can use the XPath query language, and/or the xpath tool, in order to "
24466 "select parts of the XML."
24470 #: ../inspector/virt-inspector.pl:551
24473 " $ virt-inspector Guest | xpath //filesystems\n"
24474 " Found 1 nodes:\n"
24477 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
24478 " <type>ext4</type>\n"
24484 #: ../inspector/virt-inspector.pl:559
24487 " $ virt-inspector Guest | \\\n"
24488 " xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
24489 " Query didn't return a nodeset. Value: ext4\n"
24494 #: ../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
24495 msgid "SHELL QUOTING"
24499 #: ../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
24501 "Libvirt guest names can contain arbitrary characters, some of which have "
24502 "meaning to the shell such as C<#> and space. You may need to quote or "
24503 "escape these characters on the command line. See the shell manual page "
24504 "L<sh(1)> for details."
24508 #: ../inspector/virt-inspector.pl:572
24510 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
24511 "L<Sys::Virt(3)>, L<http://www.w3.org/TR/xpath/>, L<http://libguestfs.org/>."
24515 #: ../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
24516 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
24520 #: ../inspector/virt-inspector.pl:590
24521 msgid "Matthew Booth L<mbooth@redhat.com>"
24525 #: ../inspector/virt-inspector.pl:596 ../tools/virt-win-reg.pl:516 ../tools/virt-resize.pl:1514 ../tools/virt-make-fs.pl:565
24526 msgid "Copyright (C) 2010 Red Hat Inc."
24530 #: ../tools/virt-edit.pl:34
24531 msgid "virt-edit - Edit a file in a virtual machine"
24535 #: ../tools/virt-edit.pl:38
24538 " virt-edit [--options] domname file\n"
24543 #: ../tools/virt-edit.pl:40
24546 " virt-edit [--options] disk.img [disk.img ...] file\n"
24551 #: ../tools/virt-edit.pl:42
24554 " virt-edit [domname|disk.img] file -e 'expr'\n"
24559 #: ../tools/virt-edit.pl:46
24561 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
24562 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
24563 "doing this, but doesn't catch all cases."
24567 #: ../tools/virt-edit.pl:52
24569 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
24570 "the named virtual machine (or disk image)."
24574 #: ../tools/virt-edit.pl:55
24576 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
24577 "you should look at the L<guestfish(1)> tool."
24581 #: ../tools/virt-edit.pl:60
24582 msgid "Edit the named files interactively:"
24586 #: ../tools/virt-edit.pl:62
24589 " virt-edit mydomain /boot/grub/grub.conf\n"
24594 #: ../tools/virt-edit.pl:64
24597 " virt-edit mydomain /etc/passwd\n"
24602 #: ../tools/virt-edit.pl:66
24604 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
24605 "below). To change the init default level to 5:"
24609 #: ../tools/virt-edit.pl:70
24612 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
24617 #: ../tools/virt-edit.pl:96
24618 msgid "B<--backup extension> | B<-b extension>"
24622 #: ../tools/virt-edit.pl:98
24624 "Create a backup of the original file I<in the guest disk image>. The backup "
24625 "has the original filename with C<extension> added."
24629 #: ../tools/virt-edit.pl:101
24631 "Usually the first character of C<extension> would be a dot C<.> so you would "
24636 #: ../tools/virt-edit.pl:104
24639 " virt-edit -b .orig [etc]\n"
24644 #: ../tools/virt-edit.pl:106
24645 msgid "By default, no backup file is made."
24649 #: ../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
24651 "If you specify guest block devices directly, then libvirt is not used at "
24656 #: ../tools/virt-edit.pl:141
24657 msgid "B<--expr EXPR> | B<-e EXPR>"
24661 #: ../tools/virt-edit.pl:143
24663 "Instead of launching the external editor, non-interactively apply the Perl "
24664 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
24669 #: ../tools/virt-edit.pl:147
24671 "Be careful to properly quote the expression to prevent it from being altered "
24676 #: ../tools/virt-edit.pl:268
24677 msgid "NON-INTERACTIVE EDITING"
24681 #: ../tools/virt-edit.pl:270
24683 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
24684 "administrator can interactively edit the file."
24688 #: ../tools/virt-edit.pl:273
24690 "There are two ways also to use C<virt-edit> from scripts in order to make "
24691 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
24692 "like this, it's less error-prone to write scripts directly using the "
24693 "libguestfs API and Augeas for configuration file editing.)"
24697 #: ../tools/virt-edit.pl:279
24699 "The first method is to temporarily set C<$EDITOR> to any script or program "
24700 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
24701 "update C<tmpfile> in place however it likes."
24705 #: ../tools/virt-edit.pl:283
24707 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
24708 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
24709 "instances of C<foo> with C<bar> in a file:"
24713 #: ../tools/virt-edit.pl:287
24716 " virt-edit domname filename -e 's/foo/bar/'\n"
24721 #: ../tools/virt-edit.pl:289
24723 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
24724 "For example to delete root's password you could do:"
24728 #: ../tools/virt-edit.pl:292
24731 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
24736 #: ../tools/virt-edit.pl:294
24738 "What really happens is that the snippet is evaluated as a Perl expression "
24739 "for each line of the file. The line, including the final C<\\n>, is passed "
24740 "in C<$_> and the expression should update C<$_> or leave it unchanged."
24744 #: ../tools/virt-edit.pl:299
24746 "To delete a line, set C<$_> to the empty string. For example, to delete the "
24747 "C<apache> user account from the password file you can do:"
24751 #: ../tools/virt-edit.pl:302
24754 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
24759 #: ../tools/virt-edit.pl:304
24761 "To insert a line, prepend or append it to C<$_>. However appending lines to "
24762 "the end of the file is rather difficult this way since there is no concept "
24763 "of \"last line of the file\" - your expression just doesn't get called "
24764 "again. You might want to use the first method (setting C<$EDITOR>) if you "
24769 #: ../tools/virt-edit.pl:310
24771 "The variable C<$lineno> contains the current line number. As is "
24772 "traditional, the first line in the file is number C<1>."
24776 #: ../tools/virt-edit.pl:313
24778 "The return value from the expression is ignored, but the expression may call "
24779 "C<die> in order to abort the whole program, leaving the original file "
24784 #: ../tools/virt-edit.pl:317
24786 "Remember when matching the end of a line that C<$_> may contain the final "
24787 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
24788 "newline then neither of these. Thus to match or substitute some text at the "
24789 "end of a line, use this regular expression:"
24793 #: ../tools/virt-edit.pl:322
24796 " /some text(\\r?\\n)?$/\n"
24801 #: ../tools/virt-edit.pl:324
24803 "Alternately, use the perl C<chomp> function, being careful not to chomp "
24804 "C<$_> itself (since that would remove all newlines from the file):"
24808 #: ../tools/virt-edit.pl:328
24811 " my $m = $_; chomp $m; $m =~ /some text$/\n"
24816 #: ../tools/virt-edit.pl:334
24821 #: ../tools/virt-edit.pl:336
24823 "If set, this string is used as the editor. It may contain arguments, "
24824 "eg. C<\"emacs -nw\">"
24828 #: ../tools/virt-edit.pl:339
24829 msgid "If not set, C<vi> is used."
24833 #: ../tools/virt-edit.pl:352
24835 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
24836 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, "
24837 "L<perl(1)>, L<perlre(1)>."
24841 #: ../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
24846 #: ../tools/virt-edit.pl:368 ../tools/virt-df.pl:655 ../tools/virt-rescue.pl:283 ../tools/virt-list-partitions.pl:271
24847 msgid "Copyright (C) 2009-2010 Red Hat Inc."
24851 #: ../tools/virt-win-reg.pl:37
24853 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
24858 #: ../tools/virt-win-reg.pl:41
24861 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
24866 #: ../tools/virt-win-reg.pl:43
24869 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
24874 #: ../tools/virt-win-reg.pl:45
24877 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
24882 #: ../tools/virt-win-reg.pl:47
24885 " virt-win-reg --merge domname [input.reg ...]\n"
24890 #: ../tools/virt-win-reg.pl:49
24893 " virt-win-reg [--options] disk.img ... # instead of domname\n"
24898 #: ../tools/virt-win-reg.pl:53
24900 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
24901 "virtual machines. If you do this, you I<will> get irreversible disk "
24902 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
24903 "but doesn't catch all cases."
24907 #: ../tools/virt-win-reg.pl:58
24909 "Modifying the Windows Registry is an inherently risky operation. The format "
24910 "is deliberately obscure and undocumented, and Registry changes can leave the "
24911 "system unbootable. Therefore when using the C<--merge> option, make sure "
24912 "you have a reliable backup first."
24916 #: ../tools/virt-win-reg.pl:65
24918 "This program can export and merge Windows Registry entries from a Windows "
24923 #: ../tools/virt-win-reg.pl:68
24925 "The first parameter is the libvirt guest name or the raw disk image of a "
24930 #: ../tools/virt-win-reg.pl:71
24932 "If C<--merge> is I<not> specified, then the chosen registry key is "
24933 "displayed/exported (recursively). For example:"
24937 #: ../tools/virt-win-reg.pl:74
24940 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
24945 #: ../tools/virt-win-reg.pl:76
24946 msgid "You can also display single values from within registry keys, for example:"
24950 #: ../tools/virt-win-reg.pl:79
24953 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
24954 " $ virt-win-reg Windows7 $cvkey ProductName\n"
24955 " Windows 7 Enterprise\n"
24960 #: ../tools/virt-win-reg.pl:83
24962 "With C<--merge>, you can merge a textual regedit file into the Windows "
24967 #: ../tools/virt-win-reg.pl:86
24970 " $ virt-win-reg --merge Windows7 changes.reg\n"
24975 #: ../tools/virt-win-reg.pl:88
24976 msgid "SUPPORTED SYSTEMS"
24980 #: ../tools/virt-win-reg.pl:90
24982 "The program currently supports Windows NT-derived guests starting with "
24983 "Windows XP through to at least Windows 7."
24987 #: ../tools/virt-win-reg.pl:93
24989 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
24990 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
24991 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
24995 #: ../tools/virt-win-reg.pl:97
24997 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
25002 #: ../tools/virt-win-reg.pl:100
25004 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
25009 #: ../tools/virt-win-reg.pl:103
25014 #: ../tools/virt-win-reg.pl:105
25016 "This program is only meant for simple access to the registry. If you want "
25017 "to do complicated things with the registry, we suggest you download the "
25018 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
25019 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
25020 "L<hivexregedit(1)>."
25024 #: ../tools/virt-win-reg.pl:111
25029 #: ../tools/virt-win-reg.pl:113
25031 "C<virt-win-reg> expects that regedit files have already been reencoded in "
25032 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
25033 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
25034 "with Windows-style line endings, you may need to reencode the whole file "
25035 "before or after processing."
25039 #: ../tools/virt-win-reg.pl:119
25041 "To reencode a file from Windows format to Linux (before processing it with "
25042 "the C<--merge> option), you would do something like this:"
25046 #: ../tools/virt-win-reg.pl:122
25049 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
25054 #: ../tools/virt-win-reg.pl:124
25056 "To go in the opposite direction, after exporting and before sending the file "
25057 "to a Windows user, do something like this:"
25061 #: ../tools/virt-win-reg.pl:127
25064 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
25069 #: ../tools/virt-win-reg.pl:129
25070 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
25074 #: ../tools/virt-win-reg.pl:131
25076 "If you are unsure about the current encoding, use the L<file(1)> command. "
25077 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
25078 "Windows-style (CRLF) line endings, like this:"
25082 #: ../tools/virt-win-reg.pl:135
25085 " $ file software.reg\n"
25086 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
25087 " with CRLF line terminators\n"
25092 #: ../tools/virt-win-reg.pl:139
25093 msgid "This file would need conversion before you could C<--merge> it."
25097 #: ../tools/virt-win-reg.pl:143
25099 "Be careful when passing parameters containing C<\\> (backslash) in the "
25100 "shell. Usually you will have to use 'single quotes' or double backslashes "
25101 "(but not both) to protect them from the shell."
25105 #: ../tools/virt-win-reg.pl:147
25106 msgid "Paths and value names are case-insensitive."
25110 #: ../tools/virt-win-reg.pl:149
25111 msgid "CurrentControlSet etc."
25115 #: ../tools/virt-win-reg.pl:151
25117 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
25118 "Registry at the level of the hive file, and therefore you cannot modify "
25123 #: ../tools/virt-win-reg.pl:155
25125 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
25126 "circumstances it might refer to another control set. The way to find out is "
25127 "to look at the C<HKLM\\SYSTEM\\Select> key:"
25131 #: ../tools/virt-win-reg.pl:159
25134 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
25135 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
25136 " \"Current\"=dword:00000001\n"
25137 " \"Default\"=dword:00000001\n"
25138 " \"Failed\"=dword:00000000\n"
25139 " \"LastKnownGood\"=dword:00000002\n"
25144 #: ../tools/virt-win-reg.pl:166
25145 msgid "\"Current\" is the one which Windows will choose when it boots."
25149 #: ../tools/virt-win-reg.pl:168
25150 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
25154 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
25159 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:501
25160 msgid "Enable debugging messages."
25164 #: ../tools/virt-win-reg.pl:232
25169 #: ../tools/virt-win-reg.pl:234
25171 "In merge mode, this merges a textual regedit file into the Windows Registry "
25172 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
25173 "displays or exports Registry entries instead."
25177 #: ../tools/virt-win-reg.pl:238
25179 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
25180 "result in disk corruption. However exporting (without this flag) is always "
25185 #: ../tools/virt-win-reg.pl:246
25186 msgid "B<--encoding> UTF-16LE|ASCII"
25190 #: ../tools/virt-win-reg.pl:248
25192 "When merging (only), you may need to specify the encoding for strings to be "
25193 "used in the hive file. This is explained in detail in "
25194 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
25198 #: ../tools/virt-win-reg.pl:252
25200 "The default is to use UTF-16LE, which should work with recent versions of "
25205 #: ../tools/virt-win-reg.pl:486
25207 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
25208 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
25209 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
25210 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
25214 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
25216 "When reporting bugs, please enable debugging and capture the I<complete> "
25221 #: ../tools/virt-win-reg.pl:504
25224 " export LIBGUESTFS_DEBUG=1\n"
25225 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
25230 #: ../tools/virt-win-reg.pl:507
25232 "Attach /tmp/virt-win-reg.log to a new bug report at "
25233 "L<https://bugzilla.redhat.com/>"
25237 #: ../tools/virt-df.pl:36
25238 msgid "virt-df - Display free space on virtual filesystems"
25242 #: ../tools/virt-df.pl:40
25245 " virt-df [--options]\n"
25250 #: ../tools/virt-df.pl:42
25253 " virt-df [--options] domname\n"
25258 #: ../tools/virt-df.pl:44
25261 " virt-df [--options] disk.img [disk.img ...]\n"
25266 #: ../tools/virt-df.pl:48
25268 "C<virt-df> is a command line tool to display free space on virtual machine "
25269 "filesystems. Unlike other tools, it doesn't just display the amount of "
25270 "space allocated to a virtual machine, but can look inside the virtual "
25271 "machine to see how much space is really being used."
25275 #: ../tools/virt-df.pl:53
25277 "It is like the L<df(1)> command, but for virtual machines, except that it "
25278 "also works for Windows virtual machines."
25282 #: ../tools/virt-df.pl:56
25284 "If used without any arguments, C<virt-df> checks with libvirt to get a list "
25285 "of all active and inactive guests, and performs a C<df>-type operation on "
25286 "each one in turn, printing out the results."
25290 #: ../tools/virt-df.pl:60
25292 "If used with any argument(s), C<virt-df> performs a C<df>-type operation on "
25293 "either the single named libvirt domain, or on the disk image(s) listed on "
25294 "the command line (which must all belong to a single VM). In this mode (with "
25295 "arguments), C<virt-df> will I<only work for a single guest>. If you want to "
25296 "run on multiple guests, then you have to invoke C<virt-df> multiple times."
25300 #: ../tools/virt-df.pl:67
25302 "Use the C<--csv> option to get a format which can be easily parsed by other "
25303 "programs. Other options are mostly similar to standard C<df> options. See "
25304 "below for the complete list."
25308 #: ../tools/virt-df.pl:107
25313 #: ../tools/virt-df.pl:109
25315 "Write out the results in CSV format (comma-separated values). This format "
25316 "can be imported easily into databases and spreadsheets, but read L</NOTE "
25317 "ABOUT CSV FORMAT> below."
25321 #: ../tools/virt-df.pl:134
25322 msgid "B<--human-readable> | B<-h>"
25326 #: ../tools/virt-df.pl:136
25327 msgid "Print sizes in human-readable format."
25331 #: ../tools/virt-df.pl:138
25332 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
25336 #: ../tools/virt-df.pl:144
25337 msgid "B<--inodes> | B<-i>"
25341 #: ../tools/virt-df.pl:146
25342 msgid "Print inodes instead of blocks."
25346 #: ../tools/virt-df.pl:152
25347 msgid "B<--one-per-guest>"
25351 #: ../tools/virt-df.pl:154
25353 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
25354 "disks from several guests to a single libguestfs appliance."
25358 #: ../tools/virt-df.pl:157
25359 msgid "You might use this option in the following circumstances:"
25363 #: ../tools/virt-df.pl:163
25365 "If you think an untrusted guest might actively try to exploit the libguestfs "
25366 "appliance kernel, then this prevents one guest from interfering with the "
25367 "stats printed for another guest."
25371 #: ../tools/virt-df.pl:169
25373 "If the kernel has a bug which stops it from accessing a filesystem in one "
25374 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
25375 "and report stats for further guests."
25379 #: ../tools/virt-df.pl:180
25384 #: ../tools/virt-df.pl:182
25386 "Print UUIDs instead of names. This is useful for following a guest even "
25387 "when the guest is migrated or renamed, or when two guests happen to have the "
25392 #: ../tools/virt-df.pl:186
25394 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
25395 "images, we still print the disk image name even when this option is "
25400 #: ../tools/virt-df.pl:609
25401 msgid "NOTE ABOUT CSV FORMAT"
25405 #: ../tools/virt-df.pl:611
25407 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
25408 "should be easy to parse, but it is definitely not easy to parse."
25412 #: ../tools/virt-df.pl:614
25414 "Myth: Just split fields at commas. Reality: This does I<not> work "
25415 "reliably. This example has two columns:"
25419 #: ../tools/virt-df.pl:617
25422 " \"foo,bar\",baz\n"
25427 #: ../tools/virt-df.pl:619
25429 "Myth: Read the file one line at a time. Reality: This does I<not> work "
25430 "reliably. This example has one row:"
25434 #: ../tools/virt-df.pl:622
25443 #: ../tools/virt-df.pl:625
25445 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
25446 "packaged in major Linux distributions)."
25450 #: ../tools/virt-df.pl:628
25452 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
25453 "or Python's built-in csv library)."
25457 #: ../tools/virt-df.pl:631
25458 msgid "Most spreadsheets and databases can import CSV directly."
25462 #: ../tools/virt-df.pl:642
25464 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
25465 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
25469 #: ../tools/virt-ls.pl:34
25470 msgid "virt-ls - List files in a virtual machine"
25474 #: ../tools/virt-ls.pl:38
25477 " virt-ls [--options] domname directory\n"
25482 #: ../tools/virt-ls.pl:40
25485 " virt-ls [--options] disk.img [disk.img ...] directory\n"
25490 #: ../tools/virt-ls.pl:44
25492 "C<virt-ls> is a command line tool to list the names of files in a directory "
25493 "inside a virtual machine or disk image."
25497 #: ../tools/virt-ls.pl:47
25499 "C<virt-ls> is just a simple wrapper around L<libguestfs(3)> functionality. "
25500 "For more complex cases you should look at the L<guestfish(1)> tool."
25504 #: ../tools/virt-ls.pl:51
25506 "C<virt-ls> can be used in one of three modes: simple, long and recursive. A "
25507 "simple listing is like the ordinary L<ls(1)> command:"
25511 #: ../tools/virt-ls.pl:54
25514 " $ virt-ls myguest /\n"
25522 #: ../tools/virt-ls.pl:59
25523 msgid "With the C<-l> (C<--long>) option, C<virt-ls> shows more detail:"
25527 #: ../tools/virt-ls.pl:61
25530 " $ virt-ls -l myguest /\n"
25532 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
25533 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
25539 #: ../tools/virt-ls.pl:67
25541 "With the C<-R> (C<--recursive>) option, C<virt-ls> lists the names of files "
25542 "and directories recursively:"
25546 #: ../tools/virt-ls.pl:70
25549 " $ virt-ls -R myguest /tmp\n"
25557 #: ../tools/virt-ls.pl:75
25559 "You I<cannot> combine these options. To do more complicated things, use "
25564 #: ../tools/virt-ls.pl:131 ../tools/virt-list-filesystems.pl:103 ../tools/virt-list-partitions.pl:112
25565 msgid "B<-l> | B<--long>"
25569 #: ../tools/virt-ls.pl:133
25570 msgid "B<-R> | B<--recursive>"
25574 #: ../tools/virt-ls.pl:135
25576 "Select the mode. With neither of these options, C<virt-ls> produces a "
25577 "simple, flat list of the files in the named directory."
25581 #: ../tools/virt-ls.pl:138
25583 "C<virt-ls -l> produces a \"long listing\", which shows more detail (just "
25584 "like the plain C<ls -l> command)."
25588 #: ../tools/virt-ls.pl:141
25590 "C<virt-ls -R> produces a recursive list of files starting at the named "
25591 "directory. See the documentation for L<guestfs(3)/guestfs_find> for precise "
25596 #: ../tools/virt-ls.pl:145
25597 msgid "You cannot combine these options."
25601 #: ../tools/virt-ls.pl:234
25603 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
25604 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
25605 "L<http://libguestfs.org/>."
25609 #: ../tools/virt-ls.pl:249 ../tools/virt-list-filesystems.pl:204 ../tools/virt-cat.pl:201 ../tools/virt-tar.pl:298
25610 msgid "Copyright (C) 2009 Red Hat Inc."
25614 #: ../tools/virt-resize.pl:42
25615 msgid "virt-resize - Resize a virtual machine disk"
25619 #: ../tools/virt-resize.pl:46
25622 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
25623 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
25624 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
25629 #: ../tools/virt-resize.pl:52
25631 "Virt-resize is a tool which can resize a virtual machine disk, making it "
25632 "larger or smaller overall, and resizing or deleting any partitions contained "
25637 #: ../tools/virt-resize.pl:56
25639 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
25640 "not> be used on live virtual machines - for consistent results, shut the "
25641 "virtual machine down before resizing it."
25645 #: ../tools/virt-resize.pl:60
25647 "If you are not familiar with the associated tools: "
25648 "L<virt-list-partitions(1)>, L<virt-list-filesystems(1)> and L<virt-df(1)>, "
25649 "we recommend you go and read those manual pages first."
25653 #: ../tools/virt-resize.pl:68
25655 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
25656 "fill the extra 5GB of space."
25660 #: ../tools/virt-resize.pl:71
25663 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
25664 " virt-list-partitions -lht olddisk\n"
25665 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
25666 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
25671 #: ../tools/virt-resize.pl:76
25673 "As above, but make the /boot partition 200MB bigger, while giving the "
25674 "remaining space to /dev/sda2:"
25678 #: ../tools/virt-resize.pl:79
25681 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
25686 #: ../tools/virt-resize.pl:81
25687 msgid "As above, but the output format will be uncompressed qcow2:"
25691 #: ../tools/virt-resize.pl:83
25694 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
25695 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
25700 #: ../tools/virt-resize.pl:86
25701 msgid "DETAILED USAGE"
25705 #: ../tools/virt-resize.pl:88
25706 msgid "EXPANDING A VIRTUAL MACHINE DISK"
25710 #: ../tools/virt-resize.pl:92
25711 msgid "1. Shut down the virtual machine"
25715 #: ../tools/virt-resize.pl:94
25716 msgid "2. Locate input disk image"
25720 #: ../tools/virt-resize.pl:96
25722 "Locate the input disk image (ie. the file or device on the host containing "
25723 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
25724 "dumpxml> like this to find the disk image name:"
25728 #: ../tools/virt-resize.pl:100
25731 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
25732 " Found 1 nodes:\n"
25734 " <source dev=\"/dev/vg/lv_guest\" />\n"
25739 #: ../tools/virt-resize.pl:105
25740 msgid "3. Look at current sizing"
25744 #: ../tools/virt-resize.pl:107
25745 msgid "Use L<virt-list-partitions(1)> to display the current partitions and sizes:"
25749 #: ../tools/virt-resize.pl:110
25752 " # virt-list-partitions -lht /dev/vg/lv_guest\n"
25753 " /dev/sda1 ext3 101.9M\n"
25754 " /dev/sda2 pv 7.9G\n"
25755 " /dev/sda device 8.0G\n"
25760 #: ../tools/virt-resize.pl:115
25762 "(This example is a virtual machine with an 8 GB disk which we would like to "
25763 "expand up to 10 GB)."
25767 #: ../tools/virt-resize.pl:118
25768 msgid "4. Create output disk"
25772 #: ../tools/virt-resize.pl:120
25774 "Virt-resize cannot do in-place disk modifications. You have to have space "
25775 "to store the resized output disk."
25779 #: ../tools/virt-resize.pl:123
25780 msgid "To store the resized disk image in a file, create a file of a suitable size:"
25784 #: ../tools/virt-resize.pl:126
25787 " # rm -f outdisk\n"
25788 " # truncate -s 10G outdisk\n"
25793 #: ../tools/virt-resize.pl:129
25794 msgid "Or use L<lvcreate(1)> to create a logical volume:"
25798 #: ../tools/virt-resize.pl:131
25801 " # lvcreate -L 10G -n lv_name vg_name\n"
25806 #: ../tools/virt-resize.pl:133
25807 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
25811 #: ../tools/virt-resize.pl:135
25814 " # virsh pool-list\n"
25815 " # virsh vol-create-as poolname newvol 10G\n"
25820 #: ../tools/virt-resize.pl:138
25825 #: ../tools/virt-resize.pl:140
25827 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
25828 "file) and the output disk. The output disk is the one created in the "
25833 #: ../tools/virt-resize.pl:144
25836 " # virt-resize indisk outdisk\n"
25841 #: ../tools/virt-resize.pl:146
25843 "This command just copies disk image C<indisk> to disk image C<outdisk> "
25844 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
25845 "larger, then an extra, empty partition is created at the end of the disk "
25846 "covering the extra space. If C<outdisk> is smaller, then it will give an "
25851 #: ../tools/virt-resize.pl:152
25853 "More realistically you'd want to expand existing partitions in the disk "
25854 "image by passing extra options (for the full list see the L</OPTIONS> "
25859 #: ../tools/virt-resize.pl:156
25861 "L</--expand> is the most useful option. It expands the named partition "
25862 "within the disk to fill any extra space:"
25866 #: ../tools/virt-resize.pl:159
25869 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
25874 #: ../tools/virt-resize.pl:161
25876 "(In this case, an extra partition is I<not> created at the end of the disk, "
25877 "because there will be no unused space)."
25881 #: ../tools/virt-resize.pl:164
25883 "L</--resize> is the other commonly used option. The following would "
25884 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
25885 "rest of the available space:"
25889 #: ../tools/virt-resize.pl:168
25892 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
25893 " indisk outdisk\n"
25898 #: ../tools/virt-resize.pl:171
25900 "If the expanded partition in the image contains a filesystem or LVM PV, then "
25901 "if virt-resize knows how, it will resize the contents, the equivalent of "
25902 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
25903 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
25904 "filesystems, so you would have to online resize them after booting the "
25905 "guest. And virt-resize also does not resize anything inside an LVM PV, it "
25906 "just resizes the PV itself and leaves the user to resize any LVs inside that "
25911 #: ../tools/virt-resize.pl:180
25912 msgid "Other options are covered below."
25916 #: ../tools/virt-resize.pl:182
25921 #: ../tools/virt-resize.pl:184
25922 msgid "Thoroughly test the new disk image I<before> discarding the old one."
25926 #: ../tools/virt-resize.pl:186
25927 msgid "If you are using libvirt, edit the XML to point at the new disk:"
25931 #: ../tools/virt-resize.pl:188
25934 " # virsh edit guestname\n"
25939 #: ../tools/virt-resize.pl:190
25941 "Change E<lt>source ...E<gt>, see "
25942 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
25946 #: ../tools/virt-resize.pl:193
25947 msgid "Then start up the domain with the new, resized disk:"
25951 #: ../tools/virt-resize.pl:195
25954 " # virsh start guestname\n"
25959 #: ../tools/virt-resize.pl:197
25961 "and check that it still works. See also the L</NOTES> section below for "
25962 "additional information."
25966 #: ../tools/virt-resize.pl:200
25967 msgid "7. Resize LVs etc inside the guest"
25971 #: ../tools/virt-resize.pl:202
25972 msgid "(This can also be done offline using L<guestfish(1)>)"
25976 #: ../tools/virt-resize.pl:204
25978 "Once the guest has booted you should see the new space available, at least "
25979 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
25980 "may need to resize LVs inside PVs, and also resize filesystem types that "
25981 "virt-resize does not know how to expand."
25985 #: ../tools/virt-resize.pl:211
25986 msgid "SHRINKING A VIRTUAL MACHINE DISK"
25990 #: ../tools/virt-resize.pl:213
25992 "Shrinking is somewhat more complex than expanding, and only an overview is "
25997 #: ../tools/virt-resize.pl:216
25999 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
26000 "filesystems). The user has to shrink content before passing the disk image "
26001 "to virt-resize, and virt-resize will check that the content has been shrunk "
26006 #: ../tools/virt-resize.pl:221
26007 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
26011 #: ../tools/virt-resize.pl:223
26013 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
26014 "steps 3 and 4 above to allocate a new disk image."
26018 #: ../tools/virt-resize.pl:226
26019 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
26023 #: ../tools/virt-resize.pl:229
26024 msgid "IGNORING OR DELETING PARTITIONS"
26028 #: ../tools/virt-resize.pl:231
26030 "virt-resize also gives a convenient way to ignore or delete partitions when "
26031 "copying from the input disk to the output disk. Ignoring a partition speeds "
26032 "up the copy where you don't care about the existing contents of a "
26033 "partition. Deleting a partition removes it completely, but note that it "
26034 "also renumbers any partitions after the one which is deleted, which can "
26035 "leave some guests unbootable."
26039 #: ../tools/virt-resize.pl:238
26040 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
26044 #: ../tools/virt-resize.pl:240
26046 "If the input disk is in qcow2 format, then you may prefer that the output is "
26047 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
26048 "the fly. The output format is simply determined by the format of the empty "
26049 "output container that you provide. Thus to create qcow2 output, use:"
26053 #: ../tools/virt-resize.pl:246
26056 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
26061 #: ../tools/virt-resize.pl:248
26062 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
26066 #: ../tools/virt-resize.pl:250
26067 msgid "Similarly, to get non-sparse raw output use:"
26071 #: ../tools/virt-resize.pl:252
26074 " fallocate -l size outdisk\n"
26079 #: ../tools/virt-resize.pl:254
26081 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
26082 "if=/dev/zero of=outdisk bs=1M count=..>)"
26086 #: ../tools/virt-resize.pl:267
26087 msgid "Display help."
26091 #: ../tools/virt-resize.pl:281
26092 msgid "B<--resize part=size>"
26096 #: ../tools/virt-resize.pl:283
26098 "Resize the named partition (expanding or shrinking it) so that it has the "
26103 #: ../tools/virt-resize.pl:286
26105 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
26106 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
26107 "Exabytes; or as a percentage of the current size; or as a relative number or "
26108 "percentage. For example:"
26112 #: ../tools/virt-resize.pl:291
26115 " --resize /dev/sda2=10G\n"
26120 #: ../tools/virt-resize.pl:293
26123 " --resize /dev/sda4=90%\n"
26128 #: ../tools/virt-resize.pl:295
26131 " --resize /dev/sda2=+1G\n"
26136 #: ../tools/virt-resize.pl:297
26139 " --resize /dev/sda2=-200M\n"
26144 #: ../tools/virt-resize.pl:299
26147 " --resize /dev/sda1=+128K\n"
26152 #: ../tools/virt-resize.pl:301
26155 " --resize /dev/sda1=+10%\n"
26160 #: ../tools/virt-resize.pl:303
26163 " --resize /dev/sda1=-10%\n"
26168 #: ../tools/virt-resize.pl:305
26170 "You can increase the size of any partition. Virt-resize will expand the "
26171 "direct content of the partition if it knows how (see C<--expand> below)."
26175 #: ../tools/virt-resize.pl:309
26177 "You can only I<decrease> the size of partitions that contain filesystems or "
26178 "PVs which have already been shrunk. Virt-resize will check this has been "
26179 "done before proceeding, or else will print an error (see also "
26180 "C<--resize-force>)."
26184 #: ../tools/virt-resize.pl:314 ../tools/virt-resize.pl:406 ../tools/virt-resize.pl:423
26185 msgid "You can give this option multiple times."
26189 #: ../tools/virt-resize.pl:320
26190 msgid "B<--resize-force part=size>"
26194 #: ../tools/virt-resize.pl:322
26196 "This is the same as C<--resize> except that it will let you decrease the "
26197 "size of any partition. Generally this means you will lose any data which "
26198 "was at the end of the partition you shrink, but you may not care about that "
26199 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
26200 "as a swap partition)."
26204 #: ../tools/virt-resize.pl:328
26205 msgid "See also the C<--ignore> option."
26209 #: ../tools/virt-resize.pl:334
26210 msgid "B<--expand part>"
26214 #: ../tools/virt-resize.pl:336
26216 "Expand the named partition so it uses up all extra space (space left over "
26217 "after any other resize changes that you request have been done)."
26221 #: ../tools/virt-resize.pl:339
26223 "If virt-resize knows how, it will expand the direct content of the "
26224 "partition. For example, if the partition is an LVM PV, it will expand the "
26225 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
26226 "content it doesn't know about alone."
26230 #: ../tools/virt-resize.pl:344
26231 msgid "Currently virt-resize can resize:"
26235 #: ../tools/virt-resize.pl:350
26237 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
26242 #: ../tools/virt-resize.pl:355
26244 "NTFS filesystems contained directly in a partition, if libguestfs was "
26245 "compiled with support for NTFS."
26249 #: ../tools/virt-resize.pl:358
26251 "The filesystem must have been shut down consistently last time it was used. "
26252 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
26253 "consistency check, so at the first boot after resizing Windows will check "
26258 #: ../tools/virt-resize.pl:365
26260 "LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
26261 "inside the PV. The user will have to resize LVs as desired."
26265 #: ../tools/virt-resize.pl:371 ../tools/virt-resize.pl:393
26266 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
26270 #: ../tools/virt-resize.pl:377
26271 msgid "B<--shrink part>"
26275 #: ../tools/virt-resize.pl:379
26277 "Shrink the named partition until the overall disk image fits in the "
26278 "destination. The named partition B<must> contain a filesystem or PV which "
26279 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
26280 "online tools). Virt-resize will check this and give an error if it has not "
26285 #: ../tools/virt-resize.pl:385
26287 "The amount by which the overall disk must be shrunk (after carrying out all "
26288 "other operations requested by the user) is called the \"deficit\". For "
26289 "example, a straight copy (assume no other operations) from a 5GB disk image "
26290 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
26291 "would give an error unless the user specified a partition to shrink and that "
26292 "partition had more than a gigabyte of free space."
26296 #: ../tools/virt-resize.pl:399
26297 msgid "B<--ignore part>"
26301 #: ../tools/virt-resize.pl:401
26303 "Ignore the named partition. Effectively this means the partition is "
26304 "allocated on the destination disk, but the content is not copied across from "
26305 "the source disk. The content of the partition will be blank (all zero "
26310 #: ../tools/virt-resize.pl:412
26311 msgid "B<--delete part>"
26315 #: ../tools/virt-resize.pl:414
26317 "Delete the named partition. It would be more accurate to describe this as "
26318 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
26319 "the original disk image is left intact."
26323 #: ../tools/virt-resize.pl:418
26325 "Note that when you delete a partition, then anything contained in the "
26326 "partition is also deleted. Furthermore, this causes any partitions that "
26327 "come after to be I<renumbered>, which can easily make your guest unbootable."
26331 #: ../tools/virt-resize.pl:429
26332 msgid "B<--LV-expand logvol>"
26336 #: ../tools/virt-resize.pl:431
26338 "This takes the logical volume and, as a final step, expands it to fill all "
26339 "the space available in its volume group. A typical usage, assuming a Linux "
26340 "guest with a single PV C</dev/sda2> and a root device called "
26341 "C</dev/vg_guest/lv_root> would be:"
26345 #: ../tools/virt-resize.pl:436
26348 " virt-resize indisk outdisk \\\n"
26349 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
26354 #: ../tools/virt-resize.pl:439
26356 "This would first expand the partition (and PV), and then expand the root "
26357 "device to fill the extra space in the PV."
26361 #: ../tools/virt-resize.pl:442
26363 "The contents of the LV are also resized if virt-resize knows how to do "
26364 "that. You can stop virt-resize from trying to expand the content by using "
26365 "the option C<--no-expand-content>."
26369 #: ../tools/virt-resize.pl:446
26370 msgid "Use L<virt-list-filesystems(1)> to list the filesystems in the guest."
26374 #: ../tools/virt-resize.pl:449
26376 "You can give this option multiple times, I<but> it doesn't make sense to do "
26377 "this unless the logical volumes you specify are all in different volume "
26382 #: ../tools/virt-resize.pl:457
26383 msgid "B<--no-copy-boot-loader>"
26387 #: ../tools/virt-resize.pl:459
26389 "By default, virt-resize copies over some sectors at the start of the disk "
26390 "(up to the beginning of the first partition). Commonly these sectors "
26391 "contain the Master Boot Record (MBR) and the boot loader, and are required "
26392 "in order for the guest to boot correctly."
26396 #: ../tools/virt-resize.pl:464
26398 "If you specify this flag, then this initial copy is not done. You may need "
26399 "to reinstall the boot loader in this case."
26403 #: ../tools/virt-resize.pl:472
26404 msgid "B<--no-extra-partition>"
26408 #: ../tools/virt-resize.pl:474
26410 "By default, virt-resize creates an extra partition if there is any extra, "
26411 "unused space after all resizing has happened. Use this option to prevent "
26412 "the extra partition from being created. If you do this then the extra space "
26413 "will be inaccessible until you run fdisk, parted, or some other partitioning "
26414 "tool in the guest."
26418 #: ../tools/virt-resize.pl:480
26420 "Note that if the surplus space is smaller than 10 MB, no extra partition "
26425 #: ../tools/virt-resize.pl:487
26426 msgid "B<--no-expand-content>"
26430 #: ../tools/virt-resize.pl:489
26432 "By default, virt-resize will try to expand the direct contents of "
26433 "partitions, if it knows how (see C<--expand> option above)."
26437 #: ../tools/virt-resize.pl:492
26439 "If you give the C<--no-expand-content> option then virt-resize will not "
26444 #: ../tools/virt-resize.pl:499
26445 msgid "B<-d> | B<--debug>"
26449 #: ../tools/virt-resize.pl:507
26450 msgid "B<-n> | B<--dryrun>"
26454 #: ../tools/virt-resize.pl:509
26455 msgid "Print a summary of what would be done, but don't do anything."
26459 #: ../tools/virt-resize.pl:515
26460 msgid "B<-q> | B<--quiet>"
26464 #: ../tools/virt-resize.pl:517
26465 msgid "Don't print the summary."
26469 #: ../tools/virt-resize.pl:525
26471 "Specify the format of the input disk image. If this flag is not given then "
26472 "it is auto-detected from the image itself."
26476 #: ../tools/virt-resize.pl:531
26478 "Note that this option I<does not> affect the output format. See L</QCOW2 "
26479 "AND NON-SPARSE RAW FORMATS>."
26483 #: ../tools/virt-resize.pl:538
26484 msgid "B<--output-format> raw"
26488 #: ../tools/virt-resize.pl:540
26490 "Specify the format of the output disk image. If this flag is not given then "
26491 "it is auto-detected from the image itself."
26495 #: ../tools/virt-resize.pl:546
26497 "Note that you still need to create the output disk with the right format. "
26498 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
26502 #: ../tools/virt-resize.pl:1422 ../tools/virt-rescue.pl:90
26507 #: ../tools/virt-resize.pl:1424
26508 msgid "\"Partition 1 does not end on cylinder boundary.\""
26512 #: ../tools/virt-resize.pl:1426
26514 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
26515 "means the partitions will not be aligned to the ancient CHS geometry. "
26516 "However CHS geometry is meaningless for disks manufactured since the early "
26517 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
26518 "cylinders is not required by any modern operating system."
26522 #: ../tools/virt-resize.pl:1433
26523 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
26527 #: ../tools/virt-resize.pl:1435
26529 "In Windows Vista and later versions, Microsoft switched to using a separate "
26530 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
26531 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
26532 "the boot partition. Doing so seems to break the guest completely. However "
26533 "expanding the second partition (ie. C: drive) should work."
26537 #: ../tools/virt-resize.pl:1442
26539 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
26540 "NTFS partitions have been expanded. This is just a safety check and (unless "
26541 "it find errors) is nothing to worry about."
26545 #: ../tools/virt-resize.pl:1446
26546 msgid "GUEST BOOT STUCK AT \"GRUB\""
26550 #: ../tools/virt-resize.pl:1448
26552 "If a Linux guest does not boot after resizing, and the boot is stuck after "
26553 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
26554 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
26555 "although we think is to do with partition alignment."
26559 #: ../tools/virt-resize.pl:1453
26562 " guestfish -i -a newdisk\n"
26563 " ><fs> cat /boot/grub/device.map\n"
26564 " # check the contents of this file are sensible or\n"
26565 " # edit the file if necessary\n"
26566 " ><fs> grub-install / /dev/vda\n"
26572 #: ../tools/virt-resize.pl:1460
26574 "For more flexible guest reconfiguration, including if you need to specify "
26575 "other parameters to grub-install, use L<virt-rescue(1)>."
26579 #: ../tools/virt-resize.pl:1463
26580 msgid "ALTERNATIVE TOOLS"
26584 #: ../tools/virt-resize.pl:1465
26586 "There are several proprietary tools for resizing partitions. We won't "
26587 "mention any here."
26591 #: ../tools/virt-resize.pl:1468
26593 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
26594 "operations on disk images. They can resize and move partitions, but I don't "
26595 "think they can do anything with the contents, and they certainly don't "
26600 #: ../tools/virt-resize.pl:1473
26602 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
26603 "but at a much lower level. You will probably end up hand-calculating sector "
26604 "offsets, which is something that virt-resize was designed to avoid. If you "
26605 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
26610 #: ../tools/virt-resize.pl:1488
26612 "L<virt-list-partitions(1)>, L<virt-list-filesystems(1)>, L<virt-df(1)>, "
26613 "L<guestfs(3)>, L<guestfish(1)>, L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, "
26614 "L<resize2fs(8)>, L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, "
26615 "L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, "
26616 "L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
26620 #: ../tools/virt-list-filesystems.pl:32
26621 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
26625 #: ../tools/virt-list-filesystems.pl:36
26628 " virt-list-filesystems [--options] domname\n"
26633 #: ../tools/virt-list-filesystems.pl:38
26636 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
26641 #: ../tools/virt-list-filesystems.pl:42
26643 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
26644 "are contained in a virtual machine or disk image."
26648 #: ../tools/virt-list-filesystems.pl:46
26650 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
26651 "functionality. For more complex cases you should look at the "
26652 "L<guestfish(1)> tool."
26656 #: ../tools/virt-list-filesystems.pl:105
26658 "With this option, C<virt-list-filesystems> displays the type of each "
26659 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
26663 #: ../tools/virt-list-filesystems.pl:112
26664 msgid "B<-a> | B<--all>"
26668 #: ../tools/virt-list-filesystems.pl:114
26670 "Normally we only show mountable filesystems. If this option is given then "
26671 "swap devices are shown too."
26675 #: ../tools/virt-list-filesystems.pl:188
26677 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
26678 "L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
26679 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26683 #: ../tools/virt-cat.pl:33
26684 msgid "virt-cat - Display a file in a virtual machine"
26688 #: ../tools/virt-cat.pl:37
26691 " virt-cat [--options] domname file\n"
26696 #: ../tools/virt-cat.pl:39
26699 " virt-cat [--options] disk.img [disk.img ...] file\n"
26704 #: ../tools/virt-cat.pl:43
26706 "C<virt-cat> is a command line tool to display the contents of C<file> where "
26707 "C<file> exists in the named virtual machine (or disk image)."
26711 #: ../tools/virt-cat.pl:46
26713 "C<virt-cat> can be used to quickly view a single file. To edit a file, use "
26714 "C<virt-edit>. For more complex cases you should look at the L<guestfish(1)> "
26719 #: ../tools/virt-cat.pl:52
26720 msgid "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
26724 #: ../tools/virt-cat.pl:55
26727 " virt-cat mydomain /etc/fstab\n"
26732 #: ../tools/virt-cat.pl:57
26733 msgid "List syslog messages from a VM:"
26737 #: ../tools/virt-cat.pl:59
26740 " virt-cat mydomain /var/log/messages | tail\n"
26745 #: ../tools/virt-cat.pl:61
26746 msgid "Find out what DHCP IP address a VM acquired:"
26750 #: ../tools/virt-cat.pl:63
26753 " virt-cat mydomain /var/log/messages | grep 'dhclient: bound to' | tail\n"
26758 #: ../tools/virt-cat.pl:65
26759 msgid "Find out what packages were recently installed:"
26763 #: ../tools/virt-cat.pl:67
26766 " virt-cat mydomain /var/log/yum.log | tail\n"
26771 #: ../tools/virt-cat.pl:69
26772 msgid "Find out who is logged on inside a virtual machine:"
26776 #: ../tools/virt-cat.pl:71
26779 " virt-cat mydomain /var/run/utmp > /tmp/utmp\n"
26785 #: ../tools/virt-cat.pl:74
26786 msgid "or who was logged on:"
26790 #: ../tools/virt-cat.pl:76
26793 " virt-cat mydomain /var/log/wtmp > /tmp/wtmp\n"
26794 " last -f /tmp/wtmp\n"
26799 #: ../tools/virt-cat.pl:187
26801 "L<guestfs(3)>, L<guestfish(1)>, L<virt-edit(1)>, L<Sys::Guestfs(3)>, "
26802 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26806 #: ../tools/virt-tar.pl:33
26807 msgid "virt-tar - Extract or upload files to a virtual machine"
26811 #: ../tools/virt-tar.pl:37
26814 " virt-tar [--options] -x domname directory tarball\n"
26819 #: ../tools/virt-tar.pl:39
26822 " virt-tar [--options] -u domname tarball directory\n"
26827 #: ../tools/virt-tar.pl:41
26830 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
26835 #: ../tools/virt-tar.pl:43
26838 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
26843 #: ../tools/virt-tar.pl:47
26844 msgid "Download C</home> from the VM into a local tarball:"
26848 #: ../tools/virt-tar.pl:49
26851 " virt-tar -x domname /home home.tar\n"
26856 #: ../tools/virt-tar.pl:51
26859 " virt-tar -zx domname /home home.tar.gz\n"
26864 #: ../tools/virt-tar.pl:53
26865 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
26869 #: ../tools/virt-tar.pl:55
26872 " virt-tar -u domname uploadstuff.tar /tmp\n"
26877 #: ../tools/virt-tar.pl:57
26880 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
26885 #: ../tools/virt-tar.pl:61
26887 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
26888 "virtual machines. If you do this, you risk disk corruption in the VM. "
26889 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
26893 #: ../tools/virt-tar.pl:66
26895 "You can use C<-x> (extract) on live virtual machines, but you might get "
26896 "inconsistent results or errors if there is filesystem activity inside the "
26897 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
26898 "work, but the only way to guarantee consistent results is if the virtual "
26899 "machine is shut down."
26903 #: ../tools/virt-tar.pl:74
26905 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
26906 "parts of a guest filesystem. There are many possibilities: making backups, "
26907 "uploading data files, snooping on guest activity, fixing or customizing "
26912 #: ../tools/virt-tar.pl:79
26914 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
26915 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
26916 "should look at the L<guestfish(1)> tool."
26920 #: ../tools/virt-tar.pl:83
26922 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
26923 "its contents (recursively) from the virtual machine into a local tarball. "
26924 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
26925 "virtual machine. You cannot use these two options together."
26929 #: ../tools/virt-tar.pl:89
26931 "In addition, you may need to use the C<-z> (gZip) option to enable "
26932 "compression. When uploading, you have to specify C<-z> if the upload file "
26933 "is compressed because virt-tar won't detect this on its own."
26937 #: ../tools/virt-tar.pl:93
26939 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
26940 "example it cannot do PKZip files or bzip2 compression. If you want that "
26941 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
26942 "the L<libguestfs(3)> API)."
26946 #: ../tools/virt-tar.pl:151
26947 msgid "B<-x> | B<--extract> | B<--download>"
26951 #: ../tools/virt-tar.pl:153
26952 msgid "B<-u> | B<--upload>"
26956 #: ../tools/virt-tar.pl:155
26958 "Use C<-x> to extract (download) a directory from a virtual machine to a "
26963 #: ../tools/virt-tar.pl:158
26965 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
26966 "Please read the L</WARNING> section above before using this option."
26970 #: ../tools/virt-tar.pl:162
26971 msgid "You must specify exactly one of these options."
26975 #: ../tools/virt-tar.pl:168
26976 msgid "B<-z> | B<--gzip>"
26980 #: ../tools/virt-tar.pl:170
26981 msgid "Specify that the input or output tarball is gzip-compressed."
26985 #: ../tools/virt-tar.pl:283
26987 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
26988 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
26989 "L<http://libguestfs.org/>."
26993 #: ../tools/virt-rescue.pl:33
26994 msgid "virt-rescue - Run a rescue shell on a virtual machine"
26998 #: ../tools/virt-rescue.pl:37
27001 " virt-rescue [--options] domname\n"
27006 #: ../tools/virt-rescue.pl:39
27009 " virt-rescue [--options] disk.img [disk.img ...]\n"
27014 #: ../tools/virt-rescue.pl:43
27016 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
27017 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
27018 "you from doing this, but doesn't catch all cases."
27022 #: ../tools/virt-rescue.pl:47
27024 "However if you use the I<--ro> (read only) option, then you can attach a "
27025 "shell to a live virtual machine. The results might be strange or "
27026 "inconsistent at times but you won't get disk corruption."
27030 #: ../tools/virt-rescue.pl:53
27032 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
27033 "need for a CD. virt-rescue gives you a rescue shell and some simple "
27034 "recovery tools which you can use to examine or rescue a virtual machine or "
27039 #: ../tools/virt-rescue.pl:58
27041 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
27042 "on disk image(s):"
27046 #: ../tools/virt-rescue.pl:61
27049 " virt-rescue GuestName\n"
27054 #: ../tools/virt-rescue.pl:63
27057 " virt-rescue --ro /path/to/disk.img\n"
27062 #: ../tools/virt-rescue.pl:65
27065 " virt-rescue /dev/sdc\n"
27070 #: ../tools/virt-rescue.pl:67
27071 msgid "For live VMs you I<must> use the --ro option."
27075 #: ../tools/virt-rescue.pl:69
27077 "When you run virt-rescue on a virtual machine or disk image, you are placed "
27078 "in an interactive bash shell where you can use many ordinary Linux "
27079 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
27080 "appliance. You must mount the virtual machine's filesystems by hand. There "
27081 "is an empty directory called C</sysroot> where you can mount filesystems."
27085 #: ../tools/virt-rescue.pl:76
27087 "In the example below, we list logical volumes, then choose one to mount "
27088 "under C</sysroot>:"
27092 #: ../tools/virt-rescue.pl:79
27096 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
27097 " lv_root vg_f11x64 -wi-a- 8.83G\n"
27098 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
27099 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
27100 " ><rescue> ls /sysroot\n"
27105 #: ../tools/virt-rescue.pl:86
27107 "If you don't know what filesystems are available on the virtual machine then "
27108 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
27112 #: ../tools/virt-rescue.pl:92
27114 "Virt-rescue can be used on I<any> disk image file or device, not just a "
27115 "virtual machine. For example you can use it on a blank file if you want to "
27116 "partition that file (although we would recommend using L<guestfish(1)> "
27117 "instead as it is more suitable for this purpose). You can even use "
27118 "virt-rescue on things like SD cards."
27122 #: ../tools/virt-rescue.pl:98
27124 "This tool is just designed for quick interactive hacking on a virtual "
27125 "machine. For more structured access to a virtual machine disk image, you "
27126 "should use L<guestfs(3)>. To get a structured shell that you can use to "
27127 "make scripted changes to guests, use L<guestfish(1)>."
27131 #: ../tools/virt-rescue.pl:127
27132 msgid "B<--append kernelopts>"
27136 #: ../tools/virt-rescue.pl:129
27137 msgid "Pass additional options to the rescue kernel."
27141 #: ../tools/virt-rescue.pl:164
27142 msgid "B<--memsize MB> | B<-m MB>"
27146 #: ../tools/virt-rescue.pl:166
27148 "Change the amount of memory allocated to the rescue system. The default is "
27149 "set by libguestfs and is small but adequate for running system tools. The "
27150 "occasional program might need more memory. The parameter is specified in "
27155 #: ../tools/virt-rescue.pl:175
27156 msgid "B<--network MB>"
27160 #: ../tools/virt-rescue.pl:177
27161 msgid "Enable QEMU user networking in the guest."
27165 #: ../tools/virt-rescue.pl:183
27166 msgid "B<--ro> | B<-r>"
27170 #: ../tools/virt-rescue.pl:185
27171 msgid "Open the image read-only."
27175 #: ../tools/virt-rescue.pl:197
27177 "Enable SELinux in the rescue appliance. You should read "
27178 "L<guestfs(3)/SELINUX> before using this option."
27182 #: ../tools/virt-rescue.pl:257
27184 "Several environment variables affect virt-rescue. See "
27185 "L<guestfs(3)/ENVIRONMENT VARIABLES> for the complete list."
27189 #: ../tools/virt-rescue.pl:269
27191 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
27192 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27196 #: ../tools/virt-make-fs.pl:37
27197 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
27201 #: ../tools/virt-make-fs.pl:41
27204 " virt-make-fs [--options] input.tar output.img\n"
27209 #: ../tools/virt-make-fs.pl:43
27212 " virt-make-fs [--options] input.tar.gz output.img\n"
27217 #: ../tools/virt-make-fs.pl:45
27220 " virt-make-fs [--options] directory output.img\n"
27225 #: ../tools/virt-make-fs.pl:49
27227 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
27228 "archive or some files in a directory. It is similar to tools like "
27229 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
27230 "it can create common filesystem types like ext2/3 or NTFS, which can be "
27231 "useful if you want to attach these filesystems to existing virtual machines "
27232 "(eg. to import large amounts of read-only data to a VM)."
27236 #: ../tools/virt-make-fs.pl:57
27237 msgid "Basic usage is:"
27241 #: ../tools/virt-make-fs.pl:59
27244 " virt-make-fs input output\n"
27249 #: ../tools/virt-make-fs.pl:61
27251 "where C<input> is either a directory containing files that you want to add, "
27252 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
27253 "C<output> is a disk image. The input type is detected automatically. The "
27254 "output disk image defaults to a raw ext2 image unless you specify extra "
27255 "flags (see L</OPTIONS> below)."
27259 #: ../tools/virt-make-fs.pl:67
27260 msgid "EXTRA SPACE"
27264 #: ../tools/virt-make-fs.pl:69
27266 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
27267 "the files that it contains, but might have extra space. Depending on how "
27268 "you are going to use the output, you might think this extra space is wasted "
27269 "and want to minimize it, or you might want to leave space so that more files "
27270 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
27271 "but you can use the C<--size> flag to leave space in the filesystem if you "
27276 #: ../tools/virt-make-fs.pl:77
27278 "An alternative way to leave extra space but not make the output image any "
27279 "bigger is to use an alternative disk image format (instead of the default "
27280 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
27281 "image format (check your hypervisor supports this before using it). This "
27282 "allows you to choose a large C<--size> but the extra space won't actually be "
27283 "allocated in the image until you try to store something in it."
27287 #: ../tools/virt-make-fs.pl:85
27289 "Don't forget that you can also use local commands including L<resize2fs(8)> "
27290 "and L<virt-resize(1)> to resize existing filesystems, or rerun "
27291 "virt-make-resize to build another image from scratch."
27295 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
27300 #: ../tools/virt-make-fs.pl:91
27303 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
27308 #: ../tools/virt-make-fs.pl:93
27309 msgid "FILESYSTEM TYPE"
27313 #: ../tools/virt-make-fs.pl:95
27315 "The default filesystem type is C<ext2>. Just about any filesystem type that "
27316 "libguestfs supports can be used (but I<not> read-only formats like "
27317 "ISO9660). Here are some of the more common choices:"
27321 #: ../tools/virt-make-fs.pl:101
27326 #: ../tools/virt-make-fs.pl:103
27328 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
27329 "you are not going to use the filesystem in a way that requires the journal, "
27330 "then this is just wasted overhead."
27334 #: ../tools/virt-make-fs.pl:107
27335 msgid "I<ntfs> or I<vfat>"
27339 #: ../tools/virt-make-fs.pl:109
27340 msgid "Useful if exporting data to a Windows guest."
27344 #: ../tools/virt-make-fs.pl:111
27346 "I<Note for vfat>: The tar archive or local directory must only contain files "
27347 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
27348 "program running within libguestfs is unable to change the ownership of "
27349 "non-root files, since vfat itself does not support this."
27353 #: ../tools/virt-make-fs.pl:116
27358 #: ../tools/virt-make-fs.pl:118
27360 "Lower overhead than C<ext2>, but certain limitations on filename length and "
27361 "total filesystem size."
27365 #: ../tools/virt-make-fs.pl:125
27368 " virt-make-fs --type=minix input minixfs.img\n"
27373 #: ../tools/virt-make-fs.pl:127
27374 msgid "TO PARTITION OR NOT TO PARTITION"
27378 #: ../tools/virt-make-fs.pl:129
27379 msgid "Optionally virt-make-fs can add a partition table to the output disk."
27383 #: ../tools/virt-make-fs.pl:131
27385 "Adding a partition can make the disk image more compatible with certain "
27386 "virtualized operating systems which don't expect to see a filesystem "
27387 "directly located on a block device (Linux doesn't care and will happily "
27388 "handle both types)."
27392 #: ../tools/virt-make-fs.pl:136
27394 "On the other hand, if you have a partition table then the output image is no "
27395 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
27396 "directly on a partitioned disk image. (However libguestfs tools such as "
27397 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
27401 #: ../tools/virt-make-fs.pl:144
27402 msgid "Add an MBR partition:"
27406 #: ../tools/virt-make-fs.pl:146
27409 " virt-make-fs --partition -- input disk.img\n"
27414 #: ../tools/virt-make-fs.pl:148
27416 "If the output disk image could be terabyte-sized or larger, it's better to "
27417 "use an EFI/GPT-compatible partition table:"
27421 #: ../tools/virt-make-fs.pl:151
27424 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
27429 #: ../tools/virt-make-fs.pl:179
27430 msgid "Enable debugging information."
27434 #: ../tools/virt-make-fs.pl:185
27435 msgid "B<--size=E<lt>NE<gt>>"
27439 #: ../tools/virt-make-fs.pl:187
27440 msgid "B<--size=+E<lt>NE<gt>>"
27444 #: ../tools/virt-make-fs.pl:189
27445 msgid "B<-s E<lt>NE<gt>>"
27449 #: ../tools/virt-make-fs.pl:191
27450 msgid "B<-s +E<lt>NE<gt>>"
27454 #: ../tools/virt-make-fs.pl:193
27455 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
27459 #: ../tools/virt-make-fs.pl:196
27461 "If this option is I<not> given, then the output image will be just large "
27462 "enough to contain all the files, with not much wasted space."
27466 #: ../tools/virt-make-fs.pl:199
27468 "To choose a fixed size output disk, specify an absolute number followed by "
27469 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
27470 "Petabytes or Exabytes. This must be large enough to contain all the input "
27471 "files, else you will get an error."
27475 #: ../tools/virt-make-fs.pl:204
27477 "To leave extra space, specify C<+> (plus sign) and a number followed by "
27478 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
27479 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
27480 "the input files, and (approximately) an extra 200 MB free space."
27484 #: ../tools/virt-make-fs.pl:210
27486 "Note that virt-make-fs estimates free space, and therefore will not produce "
27487 "filesystems containing precisely the free space requested. (It is much more "
27488 "expensive and time-consuming to produce a filesystem which has precisely the "
27489 "desired free space)."
27493 #: ../tools/virt-make-fs.pl:219
27494 msgid "B<--format=E<lt>fmtE<gt>>"
27498 #: ../tools/virt-make-fs.pl:221
27499 msgid "B<-F E<lt>fmtE<gt>>"
27503 #: ../tools/virt-make-fs.pl:223
27504 msgid "Choose the output disk image format."
27508 #: ../tools/virt-make-fs.pl:225
27509 msgid "The default is C<raw> (raw disk image)."
27513 #: ../tools/virt-make-fs.pl:227
27515 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
27516 "that would really make sense here is C<qcow2>."
27520 #: ../tools/virt-make-fs.pl:234
27521 msgid "B<--type=E<lt>fsE<gt>>"
27525 #: ../tools/virt-make-fs.pl:236
27526 msgid "B<-t E<lt>fsE<gt>>"
27530 #: ../tools/virt-make-fs.pl:238
27531 msgid "Choose the output filesystem type."
27535 #: ../tools/virt-make-fs.pl:240
27536 msgid "The default is C<ext2>."
27540 #: ../tools/virt-make-fs.pl:242
27541 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
27545 #: ../tools/virt-make-fs.pl:249
27546 msgid "B<--partition>"
27550 #: ../tools/virt-make-fs.pl:251
27551 msgid "B<--partition=E<lt>parttypeE<gt>>"
27555 #: ../tools/virt-make-fs.pl:253
27557 "If specified, this flag adds an MBR partition table to the output disk "
27562 #: ../tools/virt-make-fs.pl:256
27564 "You can change the partition table type, eg. C<--partition=gpt> for large "
27569 #: ../tools/virt-make-fs.pl:259
27571 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
27572 "might consider the next parameter to be the partition type. For example:"
27576 #: ../tools/virt-make-fs.pl:263
27579 " virt-make-fs --partition input.tar ...\n"
27584 #: ../tools/virt-make-fs.pl:265
27586 "would cause virt-make-fs to think you wanted to use a partition type of "
27587 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
27588 "dash) between options and the input file argument:"
27592 #: ../tools/virt-make-fs.pl:269
27595 " virt-make-fs --partition -- input.tar ...\n"
27600 #: ../tools/virt-make-fs.pl:536
27602 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
27603 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
27604 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
27608 #: ../tools/virt-make-fs.pl:553
27611 " export LIBGUESTFS_DEBUG=1\n"
27612 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
27617 #: ../tools/virt-make-fs.pl:556
27619 "Attach /tmp/virt-make-fs.log to a new bug report at "
27620 "L<https://bugzilla.redhat.com/>"
27624 #: ../tools/virt-list-partitions.pl:32
27625 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
27629 #: ../tools/virt-list-partitions.pl:36
27632 " virt-list-partitions [--options] domname\n"
27637 #: ../tools/virt-list-partitions.pl:38
27640 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
27645 #: ../tools/virt-list-partitions.pl:42
27647 "C<virt-list-partitions> is a command line tool to list the partitions that "
27648 "are contained in a virtual machine or disk image. It is mainly useful as a "
27649 "first step to using L<virt-resize(1)>."
27653 #: ../tools/virt-list-partitions.pl:47
27655 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
27656 "functionality. For more complex cases you should look at the "
27657 "L<guestfish(1)> tool."
27661 #: ../tools/virt-list-partitions.pl:104
27662 msgid "B<-h> | B<--human-readable>"
27666 #: ../tools/virt-list-partitions.pl:106
27667 msgid "Show sizes in human-readable form (eg. \"1G\")."
27671 #: ../tools/virt-list-partitions.pl:114
27673 "With this option, C<virt-list-partitions> displays the type and size of each "
27674 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
27678 #: ../tools/virt-list-partitions.pl:121
27679 msgid "B<-t> | B<--total>"
27683 #: ../tools/virt-list-partitions.pl:123
27684 msgid "Display the total size of each block device (as a separate row or rows)."
27688 #: ../tools/virt-list-partitions.pl:256
27690 "L<guestfs(3)>, L<guestfish(1)>, L<virt-list-filesystems(1)>, "
27691 "L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
27692 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."