1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: libguestfs 1.7.1\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2010-11-03 21:09+0000\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=utf-8\n"
17 "Content-Transfer-Encoding: ENCODING"
20 #: ../src/guestfs.pod:1 ../fish/guestfish.pod:1 ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1 ../inspector/virt-inspector.pl:31 ../tools/virt-edit.pl:30 ../tools/virt-win-reg.pl:33 ../tools/virt-df.pl:32 ../tools/virt-ls.pl:30 ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 ../tools/virt-cat.pl:29 ../tools/virt-tar.pl:29 ../tools/virt-rescue.pl:29 ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28
25 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../inspector/virt-inspector.pl:33 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-df.pl:34 ../tools/virt-ls.pl:32 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-cat.pl:31 ../tools/virt-tar.pl:31 ../tools/virt-rescue.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
30 #: ../src/guestfs.pod:5
31 msgid "guestfs - Library for accessing and modifying virtual machine images"
35 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../inspector/virt-inspector.pl:37 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-df.pl:38 ../tools/virt-ls.pl:36 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-cat.pl:35 ../tools/virt-tar.pl:35 ../tools/virt-rescue.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
40 #: ../src/guestfs.pod:9
43 " #include <guestfs.h>\n"
48 #: ../src/guestfs.pod:11
51 " guestfs_h *g = guestfs_create ();\n"
52 " guestfs_add_drive (g, \"guest.img\");\n"
53 " guestfs_launch (g);\n"
54 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
55 " guestfs_touch (g, \"/hello\");\n"
56 " guestfs_umount (g, \"/\");\n"
57 " guestfs_sync (g);\n"
58 " guestfs_close (g);\n"
63 #: ../src/guestfs.pod:20
66 " cc prog.c -o prog -lguestfs\n"
68 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
73 #: ../src/guestfs.pod:24 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../inspector/virt-inspector.pl:43 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-df.pl:46 ../tools/virt-ls.pl:42 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-cat.pl:41 ../tools/virt-tar.pl:72 ../tools/virt-rescue.pl:51 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
78 #: ../src/guestfs.pod:26
80 "Libguestfs is a library for accessing and modifying guest disk images. "
81 "Amongst the things this is good for: making batch configuration changes to "
82 "guests, getting disk used/free statistics (see also: virt-df), migrating "
83 "between virtualization systems (see also: virt-p2v), performing partial "
84 "backups, performing partial guest clones, cloning guests and changing "
85 "registry/UUID/hostname info, and much else besides."
89 #: ../src/guestfs.pod:34
91 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
92 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
93 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
98 #: ../src/guestfs.pod:39
100 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
101 "what filesystem is in each LV, etc.). It can also run commands in the "
102 "context of the guest. Also you can access filesystems over FUSE."
106 #: ../src/guestfs.pod:44
108 "Libguestfs is a library that can be linked with C and C++ management "
109 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
110 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
115 #: ../src/guestfs.pod:49
117 "You don't need to be root to use libguestfs, although obviously you do need "
118 "enough permissions to access the disk images."
122 #: ../src/guestfs.pod:52
124 "Libguestfs is a large API because it can do many things. For a gentle "
125 "introduction, please read the L</API OVERVIEW> section next."
129 #: ../src/guestfs.pod:55
134 #: ../src/guestfs.pod:57
136 "This section provides a gentler overview of the libguestfs API. We also try "
137 "to group API calls together, where that may not be obvious from reading "
138 "about the individual calls in the main section of this manual."
142 #: ../src/guestfs.pod:62
147 #: ../src/guestfs.pod:64
149 "Before you can use libguestfs calls, you have to create a handle. Then you "
150 "must add at least one disk image to the handle, followed by launching the "
151 "handle, then performing whatever operations you want, and finally closing "
152 "the handle. By convention we use the single letter C<g> for the name of the "
153 "handle variable, although of course you can use any name you want."
157 #: ../src/guestfs.pod:71
158 msgid "The general structure of all libguestfs-using programs looks like this:"
162 #: ../src/guestfs.pod:74
165 " guestfs_h *g = guestfs_create ();\n"
170 #: ../src/guestfs.pod:76
173 " /* Call guestfs_add_drive additional times if there are\n"
174 " * multiple disk images.\n"
176 " guestfs_add_drive (g, \"guest.img\");\n"
181 #: ../src/guestfs.pod:81
184 " /* Most manipulation calls won't work until you've launched\n"
185 " * the handle 'g'. You have to do this _after_ adding drives\n"
186 " * and _before_ other commands.\n"
188 " guestfs_launch (g);\n"
193 #: ../src/guestfs.pod:87
196 " /* Now you can examine what partitions, LVs etc are available.\n"
198 " char **partitions = guestfs_list_partitions (g);\n"
199 " char **logvols = guestfs_lvs (g);\n"
204 #: ../src/guestfs.pod:92
207 " /* To access a filesystem in the image, you must mount it.\n"
209 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
214 #: ../src/guestfs.pod:96
217 " /* Now you can perform filesystem actions on the guest\n"
220 " guestfs_touch (g, \"/hello\");\n"
225 #: ../src/guestfs.pod:101
228 " /* You only need to call guestfs_sync if you have made\n"
229 " * changes to the guest image. (But if you've made changes\n"
230 " * then you *must* sync). See also: guestfs_umount and\n"
231 " * guestfs_umount_all calls.\n"
233 " guestfs_sync (g);\n"
238 #: ../src/guestfs.pod:108
241 " /* Close the handle 'g'. */\n"
242 " guestfs_close (g);\n"
247 #: ../src/guestfs.pod:111
249 "The code above doesn't include any error checking. In real code you should "
250 "check return values carefully for errors. In general all functions that "
251 "return integers return C<-1> on error, and all functions that return "
252 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
253 "how to handle errors, and consult the documentation for each function call "
254 "below to see precisely how they return error indications."
258 #: ../src/guestfs.pod:119
263 #: ../src/guestfs.pod:121
265 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
266 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
267 "actual block device, or simply an empty file of zeroes that you have created "
268 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
273 #: ../src/guestfs.pod:127
275 "The call you should use in modern code for adding drives is "
276 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
277 "specifying that the format is raw, do:"
281 #: ../src/guestfs.pod:131
284 " guestfs_add_drive_opts (g, filename,\n"
285 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
291 #: ../src/guestfs.pod:135
292 msgid "You can add a disk read-only using:"
296 #: ../src/guestfs.pod:137
299 " guestfs_add_drive_opts (g, filename,\n"
300 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
301 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
307 #: ../src/guestfs.pod:142
309 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
310 "libguestfs won't modify the file."
314 #: ../src/guestfs.pod:145
316 "Be extremely cautious if the disk image is in use, eg. if it is being used "
317 "by a virtual machine. Adding it read-write will almost certainly cause disk "
318 "corruption, but adding it read-only is safe."
322 #: ../src/guestfs.pod:149
324 "You must add at least one disk image, and you may add multiple disk images. "
325 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
326 "first one you added), C</dev/sdb> (for the second one you added), etc."
330 #: ../src/guestfs.pod:154
332 "Once L</guestfs_launch> has been called you cannot add any more images. You "
333 "can call L</guestfs_list_devices> to get a list of the device names, in the "
334 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
338 #: ../src/guestfs.pod:159
343 #: ../src/guestfs.pod:161
345 "Before you can read or write files, create directories and so on in a disk "
346 "image that contains filesystems, you have to mount those filesystems using "
347 "L</guestfs_mount>. If you already know that a disk image contains (for "
348 "example) one partition with a filesystem on that partition, then you can "
353 #: ../src/guestfs.pod:167
356 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
361 #: ../src/guestfs.pod:169
363 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
364 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
365 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>)."
369 #: ../src/guestfs.pod:173
371 "If you are given a disk image and you don't know what it contains then you "
372 "have to find out. Libguestfs can do that too: use "
373 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
374 "and LVs, and either try mounting each to see what is mountable, or else "
375 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. Libguestfs also "
376 "has a set of APIs for inspection of disk images (see L</INSPECTION> below). "
377 "But you might find it easier to look at higher level programs built on top "
378 "of libguestfs, in particular L<virt-inspector(1)>."
382 #: ../src/guestfs.pod:183
384 "To mount a disk image read-only, use L</guestfs_mount_ro>. There are "
385 "several other variations of the C<guestfs_mount_*> call."
389 #: ../src/guestfs.pod:186
390 msgid "FILESYSTEM ACCESS AND MODIFICATION"
394 #: ../src/guestfs.pod:188
396 "The majority of the libguestfs API consists of fairly low-level calls for "
397 "accessing and modifying the files, directories, symlinks etc on mounted "
398 "filesystems. There are over a hundred such calls which you can find listed "
399 "in detail below in this man page, and we don't even pretend to cover them "
400 "all in this overview."
404 #: ../src/guestfs.pod:194
406 "Specify filenames as full paths, starting with C<\"/\"> and including the "
411 #: ../src/guestfs.pod:197
413 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
414 "the file called C<\"etc/passwd\"> then you could do:"
418 #: ../src/guestfs.pod:200
421 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
426 #: ../src/guestfs.pod:202
428 "This would return C<data> as a newly allocated buffer containing the full "
429 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
430 "or C<NULL> if there was an error."
434 #: ../src/guestfs.pod:206
436 "As another example, to create a top-level directory on that filesystem "
437 "called C<\"var\"> you would do:"
441 #: ../src/guestfs.pod:209
444 " guestfs_mkdir (g, \"/var\");\n"
449 #: ../src/guestfs.pod:211
450 msgid "To create a symlink you could do:"
454 #: ../src/guestfs.pod:213
457 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
458 " \"/etc/rc3.d/S30portmap\");\n"
463 #: ../src/guestfs.pod:216
465 "Libguestfs will reject attempts to use relative paths and there is no "
466 "concept of a current working directory."
470 #: ../src/guestfs.pod:219
472 "Libguestfs can return errors in many situations: for example if the "
473 "filesystem isn't writable, or if a file or directory that you requested "
474 "doesn't exist. If you are using the C API (documented here) you have to "
475 "check for those error conditions after each call. (Other language bindings "
476 "turn these errors into exceptions)."
480 #: ../src/guestfs.pod:225
482 "File writes are affected by the per-handle umask, set by calling "
483 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
487 #: ../src/guestfs.pod:228
492 #: ../src/guestfs.pod:230
494 "Libguestfs contains API calls to read, create and modify partition tables on "
499 #: ../src/guestfs.pod:233
501 "In the common case where you want to create a single partition covering the "
502 "whole disk, you should use the L</guestfs_part_disk> call:"
506 #: ../src/guestfs.pod:237
509 " const char *parttype = \"mbr\";\n"
510 " if (disk_is_larger_than_2TB)\n"
511 " parttype = \"gpt\";\n"
512 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
517 #: ../src/guestfs.pod:242
519 "Obviously this effectively wipes anything that was on that disk image "
524 #: ../src/guestfs.pod:245
529 #: ../src/guestfs.pod:247
531 "Libguestfs provides access to a large part of the LVM2 API, such as "
532 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
533 "unless you familiarize yourself with the concepts of physical volumes, "
534 "volume groups and logical volumes."
538 #: ../src/guestfs.pod:252
540 "This author strongly recommends reading the LVM HOWTO, online at "
541 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
545 #: ../src/guestfs.pod:255
550 #: ../src/guestfs.pod:257
552 "Use L</guestfs_cat> to download small, text only files. This call is "
553 "limited to files which are less than 2 MB and which cannot contain any ASCII "
554 "NUL (C<\\0>) characters. However it has a very simple to use API."
558 #: ../src/guestfs.pod:262
560 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
561 "bit data, since it returns a (pointer, size) pair. However it is still "
562 "limited to \"small\" files, less than 2 MB."
566 #: ../src/guestfs.pod:266
568 "L</guestfs_download> can be used to download any file, with no limits on "
569 "content or size (even files larger than 4 GB)."
573 #: ../src/guestfs.pod:269
574 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
578 #: ../src/guestfs.pod:272
583 #: ../src/guestfs.pod:274
585 "It's often the case that you want to write a file or files to the disk "
590 #: ../src/guestfs.pod:277
592 "To write a small file with fixed content, use L</guestfs_write>. To create "
593 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
594 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
595 "variety of other functions for creating test files, for example "
596 "L</guestfs_fill> and L</guestfs_fill_pattern>."
600 #: ../src/guestfs.pod:283
602 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
603 "file content or size (even files larger than 4 GB)."
607 #: ../src/guestfs.pod:286
608 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
612 #: ../src/guestfs.pod:288
614 "However the fastest way to upload I<large numbers of arbitrary files> is to "
615 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
616 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
617 "the drive in a predictable way (eg. adding it last after all other drives) "
618 "then you can get the device name from L</guestfs_list_devices> and mount it "
619 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
620 "sometimes non-portable between kernel versions, and they don't support "
621 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
622 "using a label or UUID, use an ISO image instead."
626 #: ../src/guestfs.pod:299
631 #: ../src/guestfs.pod:301
633 "There are various different commands for copying between files and devices "
634 "and in and out of the guest filesystem. These are summarised in the table "
639 #: ../src/guestfs.pod:307
640 msgid "B<file> to B<file>"
644 #: ../src/guestfs.pod:309
646 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
647 "directories recursively."
651 #: ../src/guestfs.pod:312
652 msgid "B<file or device> to B<file or device>"
656 #: ../src/guestfs.pod:314
658 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
659 "devices in the guest."
663 #: ../src/guestfs.pod:317
664 msgid "Example: duplicate the contents of an LV:"
668 #: ../src/guestfs.pod:319
671 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
676 #: ../src/guestfs.pod:321
678 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
679 "(C</dev/VG/Original>). To copy less than the whole source device, use "
680 "L</guestfs_copy_size>."
684 #: ../src/guestfs.pod:325
685 msgid "B<file on the host> to B<file or device>"
689 #: ../src/guestfs.pod:327
690 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
694 #: ../src/guestfs.pod:329
695 msgid "B<file or device> to B<file on the host>"
699 #: ../src/guestfs.pod:331
700 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
704 #: ../src/guestfs.pod:335
705 msgid "LISTING FILES"
709 #: ../src/guestfs.pod:337
711 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
712 "L<guestfish(1)>-equivalent command C<ll>)."
716 #: ../src/guestfs.pod:340
718 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
719 "programs, as a flat list of strings."
723 #: ../src/guestfs.pod:343
725 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
726 "directory, plus additional information about each one. It is more "
727 "equivalent to using the L<readdir(3)> call on a local filesystem."
731 #: ../src/guestfs.pod:347
733 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
738 #: ../src/guestfs.pod:350
739 msgid "RUNNING COMMANDS"
743 #: ../src/guestfs.pod:352
745 "Although libguestfs is primarily an API for manipulating files inside guest "
746 "images, we also provide some limited facilities for running commands inside "
751 #: ../src/guestfs.pod:356
752 msgid "There are many limitations to this:"
756 #: ../src/guestfs.pod:360 ../src/guestfs.pod:365 ../src/guestfs.pod:370 ../src/guestfs.pod:374 ../src/guestfs.pod:379 ../src/guestfs.pod:383 ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:1224 ../src/guestfs.pod:1229 ../src/guestfs.pod:1233 ../src/guestfs.pod:1449 ../src/guestfs.pod:1454 ../src/guestfs.pod:1458 ../src/guestfs.pod:1560 ../src/guestfs.pod:1564 ../src/guestfs.pod:1568 ../src/guestfs.pod:1573 ../src/guestfs.pod:1581 ../src/guestfs.pod:1600 ../src/guestfs.pod:1608 ../src/guestfs.pod:1838 ../src/guestfs.pod:1844 ../src/guestfs.pod:1849 ../src/guestfs.pod:1855 ../src/guestfs.pod:1962 ../src/guestfs.pod:1966 ../src/guestfs.pod:1970 ../src/guestfs.pod:1974 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod: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 ../src/guestfs.pod:953
886 #: ../src/guestfs.pod:442
887 msgid "Before launching, do:"
891 #: ../src/guestfs.pod:444
894 " guestfs_set_selinux (g, 1);\n"
899 #: ../src/guestfs.pod:446 ../src/guestfs.pod:957
904 #: ../src/guestfs.pod:448
906 "After mounting the guest's filesystem(s), load the policy. This is best "
907 "done by running the L<load_policy(8)> command in the guest itself:"
911 #: ../src/guestfs.pod:452
914 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
919 #: ../src/guestfs.pod:454
921 "(Older versions of C<load_policy> require you to specify the name of the "
926 #: ../src/guestfs.pod:457 ../src/guestfs.pod:963
931 #: ../src/guestfs.pod:459
933 "Optionally, set the security context for the API. The correct security "
934 "context to use can only be known by inspecting the guest. As an example:"
938 #: ../src/guestfs.pod:463
941 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
946 #: ../src/guestfs.pod:467
947 msgid "This will work for running commands and editing existing files."
951 #: ../src/guestfs.pod:469
953 "When new files are created, you may need to label them explicitly, for "
954 "example by running the external command C<restorecon pathname>."
958 #: ../src/guestfs.pod:473
963 #: ../src/guestfs.pod:475
965 "Certain calls are affected by the current file mode creation mask (the "
966 "\"umask\"). In particular ones which create files or directories, such as "
967 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
968 "either the default mode that the file is created with or modifies the mode "
973 #: ../src/guestfs.pod:481
975 "The default umask is C<022>, so files are created with modes such as C<0644> "
976 "and directories with C<0755>."
980 #: ../src/guestfs.pod:484
982 "There are two ways to avoid being affected by umask. Either set umask to 0 "
983 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
984 "L</guestfs_chmod> after creating each file or directory."
988 #: ../src/guestfs.pod:488
989 msgid "For more information about umask, see L<umask(2)>."
993 #: ../src/guestfs.pod:490 ../fish/guestfish.pod: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 "Ambiguity between devices and paths"
1557 #: ../src/guestfs.pod:775
1559 "There is a subtle ambiguity in the API between a device name "
1560 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1561 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1565 #: ../src/guestfs.pod:780
1567 "In the current API we usually resolve this ambiguity by having two separate "
1568 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1569 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1570 "detecting if the path supplied begins with C</dev/>."
1574 #: ../src/guestfs.pod:786
1576 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1577 "make paths/devices into structured names. One way to do this would be to "
1578 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1579 "aspect of grub. Another way would be to use a structured type, equivalent "
1580 "to this OCaml type:"
1584 #: ../src/guestfs.pod:792
1587 " type path = Path of string | Device of int | Partition of int * int\n"
1592 #: ../src/guestfs.pod:794
1593 msgid "which would allow you to pass arguments like:"
1597 #: ../src/guestfs.pod:796
1600 " Path \"/foo/bar\"\n"
1601 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1602 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1603 " Path \"/dev/sdb2\" (* not a device *)\n"
1608 #: ../src/guestfs.pod:801
1610 "As you can see there are still problems to resolve even with this "
1611 "representation. Also consider how it might work in guestfish."
1615 #: ../src/guestfs.pod:806
1616 msgid "PROTOCOL LIMITS"
1620 #: ../src/guestfs.pod:808
1622 "Internally libguestfs uses a message-based protocol to pass API calls and "
1623 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1624 "plenty more detail about this). The maximum message size used by the "
1625 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1626 "aware of this limit. The API calls which may be affected are individually "
1627 "documented, with a link back to this section of the documentation."
1631 #: ../src/guestfs.pod:816
1633 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1634 "a simple string. Because this string is at some point internally encoded as "
1635 "a message, the maximum size that it can return is slightly under 4 MB. If "
1636 "the requested file is larger than this then you will get an error."
1640 #: ../src/guestfs.pod:822
1642 "In order to transfer large files into and out of the guest filesystem, you "
1643 "need to use particular calls that support this. The sections L</UPLOADING> "
1644 "and L</DOWNLOADING> document how to do this."
1648 #: ../src/guestfs.pod:826
1650 "You might also consider mounting the disk image using our FUSE filesystem "
1651 "support (L<guestmount(1)>)."
1655 #: ../src/guestfs.pod:829
1656 msgid "KEYS AND PASSPHRASES"
1660 #: ../src/guestfs.pod:831
1662 "Certain libguestfs calls take a parameter that contains sensitive key "
1663 "material, passed in as a C string."
1667 #: ../src/guestfs.pod:834
1669 "In the future we would hope to change the libguestfs implementation so that "
1670 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1671 "swap. However this is I<not> done at the moment, because of the complexity "
1672 "of such an implementation."
1676 #: ../src/guestfs.pod:839
1678 "Therefore you should be aware that any key parameter you pass to libguestfs "
1679 "might end up being written out to the swap partition. If this is a concern, "
1680 "scrub the swap partition or don't use libguestfs on encrypted devices."
1684 #: ../src/guestfs.pod:844
1685 msgid "CONNECTION MANAGEMENT"
1689 #: ../src/guestfs.pod:846
1694 #: ../src/guestfs.pod:848
1696 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
1697 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
1698 "handle and release all resources used."
1702 #: ../src/guestfs.pod:852
1704 "For information on using multiple handles and threads, see the section "
1705 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
1709 #: ../src/guestfs.pod:855
1710 msgid "guestfs_create"
1714 #: ../src/guestfs.pod:857
1717 " guestfs_h *guestfs_create (void);\n"
1722 #: ../src/guestfs.pod:859
1723 msgid "Create a connection handle."
1727 #: ../src/guestfs.pod:861
1729 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
1730 "on the handle at least once."
1734 #: ../src/guestfs.pod:864
1736 "This function returns a non-NULL pointer to a handle on success or NULL on "
1741 #: ../src/guestfs.pod:867
1742 msgid "After configuring the handle, you have to call L</guestfs_launch>."
1746 #: ../src/guestfs.pod:869
1748 "You may also want to configure error handling for the handle. See L</ERROR "
1749 "HANDLING> section below."
1753 #: ../src/guestfs.pod:872
1754 msgid "guestfs_close"
1758 #: ../src/guestfs.pod:874
1761 " void guestfs_close (guestfs_h *g);\n"
1766 #: ../src/guestfs.pod:876
1767 msgid "This closes the connection handle and frees up all resources used."
1771 #: ../src/guestfs.pod:878
1772 msgid "ERROR HANDLING"
1776 #: ../src/guestfs.pod:880
1778 "API functions can return errors. For example, almost all functions that "
1779 "return C<int> will return C<-1> to indicate an error."
1783 #: ../src/guestfs.pod:883
1785 "Additional information is available for errors: an error message string and "
1786 "optionally an error number (errno) if the thing that failed was a system "
1791 #: ../src/guestfs.pod:887
1793 "You can get at the additional information about the last error on the handle "
1794 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
1795 "up an error handler with L</guestfs_set_error_handler>."
1799 #: ../src/guestfs.pod:892
1801 "When the handle is created, a default error handler is installed which "
1802 "prints the error message string to C<stderr>. For small short-running "
1803 "command line programs it is sufficient to do:"
1807 #: ../src/guestfs.pod:896
1810 " if (guestfs_launch (g) == -1)\n"
1811 " exit (EXIT_FAILURE);\n"
1816 #: ../src/guestfs.pod:899
1818 "since the default error handler will ensure that an error message has been "
1819 "printed to C<stderr> before the program exits."
1823 #: ../src/guestfs.pod:902
1825 "For other programs the caller will almost certainly want to install an "
1826 "alternate error handler or do error handling in-line like this:"
1830 #: ../src/guestfs.pod:905
1833 " g = guestfs_create ();\n"
1838 #: ../src/guestfs.pod:907
1841 " /* This disables the default behaviour of printing errors\n"
1843 " guestfs_set_error_handler (g, NULL, NULL);\n"
1848 #: ../src/guestfs.pod:911
1851 " if (guestfs_launch (g) == -1) {\n"
1852 " /* Examine the error message and print it etc. */\n"
1853 " char *msg = guestfs_last_error (g);\n"
1854 " int errnum = guestfs_last_errno (g);\n"
1855 " fprintf (stderr, \"%s\\n\", msg);\n"
1862 #: ../src/guestfs.pod:919
1864 "Out of memory errors are handled differently. The default action is to call "
1865 "L<abort(3)>. If this is undesirable, then you can set a handler using "
1866 "L</guestfs_set_out_of_memory_handler>."
1870 #: ../src/guestfs.pod:923
1872 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
1873 "because there is no handle if this happens there is no way to get additional "
1874 "error information. However L</guestfs_create> is supposed to be a "
1875 "lightweight operation which can only fail because of insufficient memory (it "
1876 "returns NULL in this case)."
1880 #: ../src/guestfs.pod:929
1881 msgid "guestfs_last_error"
1885 #: ../src/guestfs.pod:931
1888 " const char *guestfs_last_error (guestfs_h *g);\n"
1893 #: ../src/guestfs.pod:933
1895 "This returns the last error message that happened on C<g>. If there has not "
1896 "been an error since the handle was created, then this returns C<NULL>."
1900 #: ../src/guestfs.pod:937
1902 "The lifetime of the returned string is until the next error occurs, or "
1903 "L</guestfs_close> is called."
1907 #: ../src/guestfs.pod:940
1908 msgid "guestfs_last_errno"
1912 #: ../src/guestfs.pod:942
1915 " int guestfs_last_errno (guestfs_h *g);\n"
1920 #: ../src/guestfs.pod:944
1921 msgid "This returns the last error number (errno) that happened on C<g>."
1925 #: ../src/guestfs.pod:946
1926 msgid "If successful, an errno integer not equal to zero is returned."
1930 #: ../src/guestfs.pod:948
1931 msgid "If no error, this returns 0. This call can return 0 in three situations:"
1935 #: ../src/guestfs.pod:955
1936 msgid "There has not been any error on the handle."
1940 #: ../src/guestfs.pod:959
1942 "There has been an error but the errno was meaningless. This corresponds to "
1943 "the case where the error did not come from a failed system call, but for "
1944 "some other reason."
1948 #: ../src/guestfs.pod:965
1950 "There was an error from a failed system call, but for some reason the errno "
1951 "was not captured and returned. This usually indicates a bug in libguestfs."
1955 #: ../src/guestfs.pod:971
1957 "Libguestfs tries to convert the errno from inside the applicance into a "
1958 "corresponding errno for the caller (not entirely trivial: the appliance "
1959 "might be running a completely different operating system from the library "
1960 "and error numbers are not standardized across Un*xen). If this could not be "
1961 "done, then the error is translated to C<EINVAL>. In practice this should "
1962 "only happen in very rare circumstances."
1966 #: ../src/guestfs.pod:979
1967 msgid "guestfs_set_error_handler"
1971 #: ../src/guestfs.pod:981
1974 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
1976 " const char *msg);\n"
1977 " void guestfs_set_error_handler (guestfs_h *g,\n"
1978 " guestfs_error_handler_cb cb,\n"
1984 #: ../src/guestfs.pod:988
1986 "The callback C<cb> will be called if there is an error. The parameters "
1987 "passed to the callback are an opaque data pointer and the error message "
1992 #: ../src/guestfs.pod:992
1994 "C<errno> is not passed to the callback. To get that the callback must call "
1995 "L</guestfs_last_errno>."
1999 #: ../src/guestfs.pod:995
2001 "Note that the message string C<msg> is freed as soon as the callback "
2002 "function returns, so if you want to stash it somewhere you must make your "
2007 #: ../src/guestfs.pod:999
2008 msgid "The default handler prints messages on C<stderr>."
2012 #: ../src/guestfs.pod:1001
2013 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2017 #: ../src/guestfs.pod:1003
2018 msgid "guestfs_get_error_handler"
2022 #: ../src/guestfs.pod:1005
2025 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2026 " void **opaque_rtn);\n"
2031 #: ../src/guestfs.pod:1008
2032 msgid "Returns the current error handler callback."
2036 #: ../src/guestfs.pod:1010
2037 msgid "guestfs_set_out_of_memory_handler"
2041 #: ../src/guestfs.pod:1012
2044 " typedef void (*guestfs_abort_cb) (void);\n"
2045 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2046 " guestfs_abort_cb);\n"
2051 #: ../src/guestfs.pod:1016
2053 "The callback C<cb> will be called if there is an out of memory situation. "
2054 "I<Note this callback must not return>."
2058 #: ../src/guestfs.pod:1019
2059 msgid "The default is to call L<abort(3)>."
2063 #: ../src/guestfs.pod:1021
2064 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2068 #: ../src/guestfs.pod:1024
2069 msgid "guestfs_get_out_of_memory_handler"
2073 #: ../src/guestfs.pod:1026
2076 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2081 #: ../src/guestfs.pod:1028
2082 msgid "This returns the current out of memory handler."
2086 #: ../src/guestfs.pod:1030
2091 #: ../src/guestfs.pod:1032
2093 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
2098 #: ../src/guestfs.pod:1035
2100 "By default it looks for these in the directory C<$libdir/guestfs> "
2101 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2105 #: ../src/guestfs.pod:1038
2107 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2108 "to change the directories that libguestfs will search in. The value is a "
2109 "colon-separated list of paths. The current directory is I<not> searched "
2110 "unless the path contains an empty element or C<.>. For example "
2111 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2112 "then C</usr/lib/guestfs>."
2116 #: ../src/guestfs.pod:1045
2117 msgid "HIGH-LEVEL API ACTIONS"
2121 #: ../src/guestfs.pod:1047
2122 msgid "ABI GUARANTEE"
2126 #: ../src/guestfs.pod:1049
2128 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2129 "actions as outlined in this section. Although we will deprecate some "
2130 "actions, for example if they get replaced by newer calls, we will keep the "
2131 "old actions forever. This allows you the developer to program in confidence "
2132 "against the libguestfs API."
2136 #: ../src/guestfs.pod:1055 ../fish/guestfish.pod:860
2141 #: ../src/guestfs.pod:1057
2146 #: ../src/guestfs.pod:1059
2151 #: ../src/guestfs.pod:1061
2152 msgid "AVAILABILITY"
2156 #: ../src/guestfs.pod:1063
2157 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2161 #: ../src/guestfs.pod:1065
2163 "Using L</guestfs_available> you can test availability of the following "
2164 "groups of functions. This test queries the appliance to see if the "
2165 "appliance you are currently using supports the functionality."
2169 #: ../src/guestfs.pod:1070
2170 msgid "@AVAILABILITY@"
2174 #: ../src/guestfs.pod:1072
2175 msgid "GUESTFISH supported COMMAND"
2179 #: ../src/guestfs.pod:1074
2181 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2182 "prints out the available groups and whether they are supported by this build "
2183 "of libguestfs. Note however that you have to do C<run> first."
2187 #: ../src/guestfs.pod:1079
2188 msgid "SINGLE CALLS AT COMPILE TIME"
2192 #: ../src/guestfs.pod:1081
2194 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2195 "function, such as:"
2199 #: ../src/guestfs.pod:1084
2202 " #define LIBGUESTFS_HAVE_DD 1\n"
2207 #: ../src/guestfs.pod:1086
2208 msgid "if L</guestfs_dd> is available."
2212 #: ../src/guestfs.pod:1088
2214 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2215 "function is available at compile time, we recommended using build tools such "
2216 "as autoconf or cmake. For example in autotools you could use:"
2220 #: ../src/guestfs.pod:1093
2223 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2224 " AC_CHECK_FUNCS([guestfs_dd])\n"
2229 #: ../src/guestfs.pod:1096
2231 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2236 #: ../src/guestfs.pod:1099
2237 msgid "SINGLE CALLS AT RUN TIME"
2241 #: ../src/guestfs.pod:1101
2243 "Testing at compile time doesn't guarantee that a function really exists in "
2244 "the library. The reason is that you might be dynamically linked against a "
2245 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2246 "This situation unfortunately results in a segmentation fault, which is a "
2247 "shortcoming of the C dynamic linking system itself."
2251 #: ../src/guestfs.pod:1108
2253 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2254 "in this example program (note that you still need the compile time check as "
2259 #: ../src/guestfs.pod:1112
2262 " #include <stdio.h>\n"
2263 " #include <stdlib.h>\n"
2264 " #include <unistd.h>\n"
2265 " #include <dlfcn.h>\n"
2266 " #include <guestfs.h>\n"
2271 #: ../src/guestfs.pod:1118
2276 " #ifdef LIBGUESTFS_HAVE_DD\n"
2278 " int has_function;\n"
2283 #: ../src/guestfs.pod:1124
2286 " /* Test if the function guestfs_dd is really available. */\n"
2287 " dl = dlopen (NULL, RTLD_LAZY);\n"
2289 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2290 " exit (EXIT_FAILURE);\n"
2292 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2298 #: ../src/guestfs.pod:1133
2301 " if (!has_function)\n"
2302 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2304 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2305 " /* Now it's safe to call\n"
2306 " guestfs_dd (g, \"foo\", \"bar\");\n"
2310 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2317 #: ../src/guestfs.pod:1146
2319 "You may think the above is an awful lot of hassle, and it is. There are "
2320 "other ways outside of the C linking system to ensure that this kind of "
2321 "incompatibility never arises, such as using package versioning:"
2325 #: ../src/guestfs.pod:1151
2328 " Requires: libguestfs >= 1.0.80\n"
2333 #: ../src/guestfs.pod:1153
2334 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2338 #: ../src/guestfs.pod:1155
2340 "A recent feature of the API is the introduction of calls which take optional "
2341 "arguments. In C these are declared 3 ways. The main way is as a call which "
2342 "takes variable arguments (ie. C<...>), as in this example:"
2346 #: ../src/guestfs.pod:1160
2349 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2354 #: ../src/guestfs.pod:1162
2356 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2357 "call with no optional arguments specified:"
2361 #: ../src/guestfs.pod:1165
2364 " guestfs_add_drive_opts (g, filename, -1);\n"
2369 #: ../src/guestfs.pod:1167
2370 msgid "With a single optional argument:"
2374 #: ../src/guestfs.pod:1169
2377 " guestfs_add_drive_opts (g, filename,\n"
2378 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2384 #: ../src/guestfs.pod:1173
2389 #: ../src/guestfs.pod:1175
2392 " guestfs_add_drive_opts (g, filename,\n"
2393 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2394 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
2400 #: ../src/guestfs.pod:1180
2402 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
2407 #: ../src/guestfs.pod:1183
2408 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
2412 #: ../src/guestfs.pod:1185
2414 "The second variant has the same name with the suffix C<_va>, which works the "
2415 "same way but takes a C<va_list>. See the C manual for details. For the "
2416 "example function, this is declared:"
2420 #: ../src/guestfs.pod:1189
2423 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
2429 #: ../src/guestfs.pod:1192
2430 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
2434 #: ../src/guestfs.pod:1194
2436 "The third variant is useful where you need to construct these calls. You "
2437 "pass in a structure where you fill in the optional fields. The structure "
2438 "has a bitmask as the first element which you must set to indicate which "
2439 "fields you have filled in. For our example function the structure and call "
2444 #: ../src/guestfs.pod:1200
2447 " struct guestfs_add_drive_opts_argv {\n"
2448 " uint64_t bitmask;\n"
2450 " const char *format;\n"
2453 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
2454 " const struct guestfs_add_drive_opts_argv *optargs);\n"
2459 #: ../src/guestfs.pod:1209
2460 msgid "You could call it like this:"
2464 #: ../src/guestfs.pod:1211
2467 " struct guestfs_add_drive_opts_argv optargs = {\n"
2468 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
2469 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
2471 " .format = \"qcow2\"\n"
2477 #: ../src/guestfs.pod:1218
2480 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
2485 #: ../src/guestfs.pod:1220 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1661 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1244
2490 #: ../src/guestfs.pod:1226
2491 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
2495 #: ../src/guestfs.pod:1231
2496 msgid "You do not need to fill in all fields of the structure."
2500 #: ../src/guestfs.pod:1235
2502 "There must be a one-to-one correspondence between fields of the structure "
2503 "that are filled in, and bits set in the bitmask."
2507 #: ../src/guestfs.pod:1240
2508 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
2512 #: ../src/guestfs.pod:1242
2514 "In other languages, optional arguments are expressed in the way that is "
2515 "natural for that language. We refer you to the language-specific "
2516 "documentation for more details on that."
2520 #: ../src/guestfs.pod:1246
2521 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
2525 #: ../src/guestfs.pod:1248 ../src/guestfs.pod:1253
2530 #: ../src/guestfs.pod:1250
2532 "<!-- old anchor for the next section --> <a "
2533 "name=\"state_machine_and_low_level_event_api\"/>"
2537 #: ../src/guestfs.pod:1255
2538 msgid "ARCHITECTURE"
2542 #: ../src/guestfs.pod:1257
2544 "Internally, libguestfs is implemented by running an appliance (a special "
2545 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
2546 "process of the main program."
2550 #: ../src/guestfs.pod:1261
2553 " ___________________\n"
2555 " | main program |\n"
2557 " | | child process / appliance\n"
2558 " | | __________________________\n"
2560 " +-------------------+ RPC | +-----------------+ |\n"
2561 " | libguestfs <--------------------> guestfsd | |\n"
2562 " | | | +-----------------+ |\n"
2563 " \\___________________/ | | Linux kernel | |\n"
2564 " | +--^--------------+ |\n"
2565 " \\_________|________________/\n"
2571 " \\______________/\n"
2576 #: ../src/guestfs.pod:1281
2578 "The library, linked to the main program, creates the child process and hence "
2579 "the appliance in the L</guestfs_launch> function."
2583 #: ../src/guestfs.pod:1284
2585 "Inside the appliance is a Linux kernel and a complete stack of userspace "
2586 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
2587 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
2588 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
2589 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
2590 "attached to the qemu process which translates device access by the "
2591 "appliance's Linux kernel into accesses to the image."
2595 #: ../src/guestfs.pod:1293
2597 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
2598 "Although the disk image you are attached to might also be used by some "
2599 "virtual machine, libguestfs doesn't know or care about this. (But you will "
2600 "care if both libguestfs's qemu process and your virtual machine are trying "
2601 "to update the disk image at the same time, since these usually results in "
2602 "massive disk corruption)."
2606 #: ../src/guestfs.pod:1300
2607 msgid "STATE MACHINE"
2611 #: ../src/guestfs.pod:1302
2612 msgid "libguestfs uses a state machine to model the child process:"
2616 #: ../src/guestfs.pod:1304
2628 " / | \\ \\ guestfs_launch\n"
2629 " / | _\\__V______\n"
2631 " / | | LAUNCHING |\n"
2632 " / | \\___________/\n"
2634 " / | guestfs_launch\n"
2636 " ______ / __|____V\n"
2637 " / \\ ------> / \\\n"
2638 " | BUSY | | READY |\n"
2639 " \\______/ <------ \\________/\n"
2644 #: ../src/guestfs.pod:1326
2646 "The normal transitions are (1) CONFIG (when the handle is created, but there "
2647 "is no child process), (2) LAUNCHING (when the child process is booting up), "
2648 "(3) alternating between READY and BUSY as commands are issued to, and "
2649 "carried out by, the child process."
2653 #: ../src/guestfs.pod:1331
2655 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
2656 "asynchronously at any time (eg. due to some internal error), and that causes "
2657 "the state to transition back to CONFIG."
2661 #: ../src/guestfs.pod:1335
2663 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
2664 "issued when in the CONFIG state."
2668 #: ../src/guestfs.pod:1338
2670 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
2671 "L</guestfs_launch> blocks until the child process is READY to accept "
2672 "commands (or until some failure or timeout). L</guestfs_launch> internally "
2673 "moves the state from CONFIG to LAUNCHING while it is running."
2677 #: ../src/guestfs.pod:1344
2679 "API actions such as L</guestfs_mount> can only be issued when in the READY "
2680 "state. These API calls block waiting for the command to be carried out "
2681 "(ie. the state to transition to BUSY and then back to READY). There are no "
2682 "non-blocking versions, and no way to issue more than one command per handle "
2687 #: ../src/guestfs.pod:1350
2689 "Finally, the child process sends asynchronous messages back to the main "
2690 "program, such as kernel log messages. You can register a callback to "
2691 "receive these messages."
2695 #: ../src/guestfs.pod:1354
2696 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
2700 #: ../src/guestfs.pod:1356
2702 "The child process generates events in some situations. Current events "
2703 "include: receiving a log message, the child process exits."
2707 #: ../src/guestfs.pod:1359
2709 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
2714 #: ../src/guestfs.pod:1362
2716 "Only I<one callback of each type> can be registered for each handle. "
2717 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
2718 "that type. Cancel all callbacks of this type by calling this function with "
2719 "C<cb> set to C<NULL>."
2723 #: ../src/guestfs.pod:1367
2724 msgid "guestfs_set_log_message_callback"
2728 #: ../src/guestfs.pod:1369
2731 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
2732 " char *buf, int len);\n"
2733 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
2734 " guestfs_log_message_cb cb,\n"
2740 #: ../src/guestfs.pod:1375
2742 "The callback function C<cb> will be called whenever qemu or the guest writes "
2743 "anything to the console."
2747 #: ../src/guestfs.pod:1378
2748 msgid "Use this function to capture kernel messages and similar."
2752 #: ../src/guestfs.pod:1380
2754 "Normally there is no log message handler, and log messages are just "
2759 #: ../src/guestfs.pod:1383
2760 msgid "guestfs_set_subprocess_quit_callback"
2764 #: ../src/guestfs.pod:1385
2767 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
2768 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
2769 " guestfs_subprocess_quit_cb cb,\n"
2775 #: ../src/guestfs.pod:1390
2777 "The callback function C<cb> will be called when the child process quits, "
2778 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
2779 "corresponds to a transition from any state to the CONFIG state)."
2783 #: ../src/guestfs.pod:1395
2784 msgid "guestfs_set_launch_done_callback"
2788 #: ../src/guestfs.pod:1397
2791 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
2792 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
2793 " guestfs_launch_done_cb cb,\n"
2799 #: ../src/guestfs.pod:1402
2801 "The callback function C<cb> will be called when the child process becomes "
2802 "ready first time after it has been launched. (This corresponds to a "
2803 "transition from LAUNCHING to the READY state)."
2807 #: ../src/guestfs.pod:1406
2808 msgid "guestfs_set_close_callback"
2812 #: ../src/guestfs.pod:1408
2815 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
2816 " void guestfs_set_close_callback (guestfs_h *g,\n"
2817 " guestfs_close_cb cb,\n"
2823 #: ../src/guestfs.pod:1413
2825 "The callback function C<cb> will be called while the handle is being closed "
2826 "(synchronously from L</guestfs_close>)."
2830 #: ../src/guestfs.pod:1416
2832 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
2833 "handles that are open when the program exits. This means that this callback "
2834 "might be called indirectly from L<exit(3)>, which can cause unexpected "
2835 "problems in higher-level languages (eg. if your HLL interpreter has already "
2836 "been cleaned up by the time this is called, and if your callback then jumps "
2837 "into some HLL function)."
2841 #: ../src/guestfs.pod:1424
2842 msgid "guestfs_set_progress_callback"
2846 #: ../src/guestfs.pod:1426
2849 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
2850 " int proc_nr, int serial,\n"
2851 " uint64_t position, uint64_t total);\n"
2852 " void guestfs_set_progress_callback (guestfs_h *g,\n"
2853 " guestfs_progress_cb cb,\n"
2859 #: ../src/guestfs.pod:1433
2861 "Some long-running operations can generate progress messages. If this "
2862 "callback is registered, then it will be called each time a progress message "
2863 "is generated (usually two seconds after the operation started, and three "
2864 "times per second thereafter until it completes, although the frequency may "
2865 "change in future versions)."
2869 #: ../src/guestfs.pod:1439
2871 "The callback receives two numbers: C<position> and C<total>. The units of "
2872 "C<total> are not defined, although for some operations C<total> may relate "
2873 "in some way to the amount of data to be transferred (eg. in bytes or "
2874 "megabytes), and C<position> may be the portion which has been transferred."
2878 #: ../src/guestfs.pod:1445
2879 msgid "The only defined and stable parts of the API are:"
2883 #: ../src/guestfs.pod:1451
2885 "The callback can display to the user some type of progress bar or indicator "
2886 "which shows the ratio of C<position>:C<total>."
2890 #: ../src/guestfs.pod:1456
2891 msgid "0 E<lt>= C<position> E<lt>= C<total>"
2895 #: ../src/guestfs.pod:1460
2897 "If any progress notification is sent during a call, then a final progress "
2898 "notification is always sent when C<position> = C<total>."
2902 #: ../src/guestfs.pod:1463
2904 "This is to simplify caller code, so callers can easily set the progress "
2905 "indicator to \"100%\" at the end of the operation, without requiring special "
2906 "code to detect this case."
2910 #: ../src/guestfs.pod:1469
2912 "The callback also receives the procedure number and serial number of the "
2913 "call. These are only useful for debugging protocol issues, and the callback "
2914 "can normally ignore them. The callback may want to print these numbers in "
2915 "error messages or debugging messages."
2919 #: ../src/guestfs.pod:1474
2920 msgid "PRIVATE DATA AREA"
2924 #: ../src/guestfs.pod:1476
2926 "You can attach named pieces of private data to the libguestfs handle, and "
2927 "fetch them by name for the lifetime of the handle. This is called the "
2928 "private data area and is only available from the C API."
2932 #: ../src/guestfs.pod:1480
2933 msgid "To attach a named piece of data, use the following call:"
2937 #: ../src/guestfs.pod:1482
2940 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
2945 #: ../src/guestfs.pod:1484
2947 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
2948 "pointer (which can be C<NULL>). Any previous item with the same name is "
2953 #: ../src/guestfs.pod:1488
2955 "You can use any C<key> you want, but names beginning with an underscore "
2956 "character are reserved for internal libguestfs purposes (for implementing "
2957 "language bindings). It is recommended to prefix the name with some unique "
2958 "string to avoid collisions with other users."
2962 #: ../src/guestfs.pod:1493
2963 msgid "To retrieve the pointer, use:"
2967 #: ../src/guestfs.pod:1495
2970 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
2975 #: ../src/guestfs.pod:1497
2977 "This function returns C<NULL> if either no data is found associated with "
2978 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
2983 #: ../src/guestfs.pod:1501
2985 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
2986 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
2987 "all. In particular, libguestfs does I<not> try to free the data when the "
2988 "handle is closed. If the data must be freed, then the caller must either "
2989 "free it before calling L</guestfs_close> or must set up a close callback to "
2990 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
2991 "can be registered for a handle)."
2995 #: ../src/guestfs.pod:1509
2997 "The private data area is implemented using a hash table, and should be "
2998 "reasonably efficient for moderate numbers of keys."
3002 #: ../src/guestfs.pod:1512
3003 msgid "BLOCK DEVICE NAMING"
3007 #: ../src/guestfs.pod:1514
3009 "In the kernel there is now quite a profusion of schemata for naming block "
3010 "devices (in this context, by I<block device> I mean a physical or virtual "
3011 "hard drive). The original Linux IDE driver used names starting with "
3012 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
3013 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
3014 "replacement for the old IDE driver (particularly for SATA devices) those "
3015 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
3016 "machines with paravirtualized drivers. This has created several different "
3017 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
3022 #: ../src/guestfs.pod:1526
3024 "As discussed above, libguestfs uses a qemu appliance running an embedded "
3025 "Linux kernel to access block devices. We can run a variety of appliances "
3026 "based on a variety of Linux kernels."
3030 #: ../src/guestfs.pod:1530
3032 "This causes a problem for libguestfs because many API calls use device or "
3033 "partition names. Working scripts and the recipe (example) scripts that we "
3034 "make available over the internet could fail if the naming scheme changes."
3038 #: ../src/guestfs.pod:1535
3040 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
3041 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
3042 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
3043 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
3047 #: ../src/guestfs.pod:1541
3049 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
3050 "L</guestfs_list_partitions> and similar calls return the true names of the "
3051 "devices and partitions as known to the appliance."
3055 #: ../src/guestfs.pod:1546
3056 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
3060 #: ../src/guestfs.pod:1548
3062 "Usually this translation is transparent. However in some (very rare) cases "
3063 "you may need to know the exact algorithm. Such cases include where you use "
3064 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
3065 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
3070 #: ../src/guestfs.pod:1554
3072 "The algorithm is applied only to I<parameters> which are known to be either "
3073 "device or partition names. Return values from functions such as "
3074 "L</guestfs_list_devices> are never changed."
3078 #: ../src/guestfs.pod:1562
3079 msgid "Is the string a parameter which is a device or partition name?"
3083 #: ../src/guestfs.pod:1566
3084 msgid "Does the string begin with C</dev/sd>?"
3088 #: ../src/guestfs.pod:1570
3090 "Does the named device exist? If so, we use that device. However if I<not> "
3091 "then we continue with this algorithm."
3095 #: ../src/guestfs.pod:1575
3096 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
3100 #: ../src/guestfs.pod:1577
3101 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
3105 #: ../src/guestfs.pod:1579
3106 msgid "If that named device exists, use it. If not, continue."
3110 #: ../src/guestfs.pod:1583
3111 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
3115 #: ../src/guestfs.pod:1585
3116 msgid "If that named device exists, use it. If not, return an error."
3120 #: ../src/guestfs.pod:1589
3121 msgid "PORTABILITY CONCERNS"
3125 #: ../src/guestfs.pod:1591
3127 "Although the standard naming scheme and automatic translation is useful for "
3128 "simple programs and guestfish scripts, for larger programs it is best not to "
3129 "rely on this mechanism."
3133 #: ../src/guestfs.pod:1595
3135 "Where possible for maximum future portability programs using libguestfs "
3136 "should use these future-proof techniques:"
3140 #: ../src/guestfs.pod:1602
3142 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
3143 "device names, and then use those names directly."
3147 #: ../src/guestfs.pod:1605
3148 msgid "Since those device names exist by definition, they will never be translated."
3152 #: ../src/guestfs.pod:1610
3154 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
3155 "filesystem labels."
3159 #: ../src/guestfs.pod:1615
3164 #: ../src/guestfs.pod:1617
3165 msgid "COMMUNICATION PROTOCOL"
3169 #: ../src/guestfs.pod:1619
3171 "Don't rely on using this protocol directly. This section documents how it "
3172 "currently works, but it may change at any time."
3176 #: ../src/guestfs.pod:1622
3178 "The protocol used to talk between the library and the daemon running inside "
3179 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3180 "1014, RFC 1832, RFC 4506)."
3184 #: ../src/guestfs.pod:1626
3186 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3187 "this file is automatically generated)."
3191 #: ../src/guestfs.pod:1629
3193 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3194 "and C<FileOut> parameters, which are handled with very simple request/reply "
3195 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3196 "parameters, which use the same request and reply messages, but they may also "
3197 "be followed by files sent using a chunked encoding."
3201 #: ../src/guestfs.pod:1636
3202 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3206 #: ../src/guestfs.pod:1638
3207 msgid "For ordinary functions, the request message is:"
3211 #: ../src/guestfs.pod:1640
3214 " total length (header + arguments,\n"
3215 " but not including the length word itself)\n"
3216 " struct guestfs_message_header (encoded as XDR)\n"
3217 " struct guestfs_<foo>_args (encoded as XDR)\n"
3222 #: ../src/guestfs.pod:1645
3224 "The total length field allows the daemon to allocate a fixed size buffer "
3225 "into which it slurps the rest of the message. As a result, the total length "
3226 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3227 "effective size of any request is limited to somewhere under this size."
3231 #: ../src/guestfs.pod:1651
3233 "Note also that many functions don't take any arguments, in which case the "
3234 "C<guestfs_I<foo>_args> is completely omitted."
3238 #: ../src/guestfs.pod:1654
3240 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3241 "receiver knows what type of args structure to expect, or none at all."
3245 #: ../src/guestfs.pod:1658
3246 msgid "The reply message for ordinary functions is:"
3250 #: ../src/guestfs.pod:1660
3253 " total length (header + ret,\n"
3254 " but not including the length word itself)\n"
3255 " struct guestfs_message_header (encoded as XDR)\n"
3256 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3261 #: ../src/guestfs.pod:1665
3263 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3264 "functions that return no formal return values."
3268 #: ../src/guestfs.pod:1668
3269 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3273 #: ../src/guestfs.pod:1671
3275 "In the case of an error, a flag is set in the header, and the reply message "
3276 "is slightly changed:"
3280 #: ../src/guestfs.pod:1674
3283 " total length (header + error,\n"
3284 " but not including the length word itself)\n"
3285 " struct guestfs_message_header (encoded as XDR)\n"
3286 " struct guestfs_message_error (encoded as XDR)\n"
3291 #: ../src/guestfs.pod:1679
3293 "The C<guestfs_message_error> structure contains the error message as a "
3298 #: ../src/guestfs.pod:1682
3299 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3303 #: ../src/guestfs.pod:1684
3305 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3306 "The normal request message is sent (see above). However this is followed by "
3307 "a sequence of file chunks."
3311 #: ../src/guestfs.pod:1688
3314 " total length (header + arguments,\n"
3315 " but not including the length word itself,\n"
3316 " and not including the chunks)\n"
3317 " struct guestfs_message_header (encoded as XDR)\n"
3318 " struct guestfs_<foo>_args (encoded as XDR)\n"
3319 " sequence of chunks for FileIn param #0\n"
3320 " sequence of chunks for FileIn param #1 etc.\n"
3325 #: ../src/guestfs.pod:1696
3326 msgid "The \"sequence of chunks\" is:"
3330 #: ../src/guestfs.pod:1698
3333 " length of chunk (not including length word itself)\n"
3334 " struct guestfs_chunk (encoded as XDR)\n"
3335 " length of chunk\n"
3336 " struct guestfs_chunk (encoded as XDR)\n"
3338 " length of chunk\n"
3339 " struct guestfs_chunk (with data.data_len == 0)\n"
3344 #: ../src/guestfs.pod:1706
3346 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3347 "is set in the final chunk to indicate either successful completion or early "
3352 #: ../src/guestfs.pod:1710
3354 "At time of writing there are no functions that have more than one FileIn "
3355 "parameter. However this is (theoretically) supported, by sending the "
3356 "sequence of chunks for each FileIn parameter one after another (from left to "
3361 #: ../src/guestfs.pod:1715
3363 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3364 "transfer. The library does this by sending a chunk with a special flag set "
3365 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3366 "RPC, does I<not> send any reply, and goes back to reading the next request."
3370 #: ../src/guestfs.pod:1721
3372 "The daemon may also cancel. It does this by writing a special word "
3373 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3374 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3375 "cancel chunk). The special word is chosen so that even if cancellation "
3376 "happens right at the end of the transfer (after the library has finished "
3377 "writing and has started listening for the reply), the \"spurious\" cancel "
3378 "flag will not be confused with the reply message."
3382 #: ../src/guestfs.pod:1730
3384 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3385 "limit), and also files where the size is not known in advance (eg. from "
3386 "pipes or sockets). However the chunks are rather small "
3387 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3388 "to keep much in memory."
3392 #: ../src/guestfs.pod:1736
3393 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3397 #: ../src/guestfs.pod:1738
3399 "The protocol for FileOut parameters is exactly the same as for FileIn "
3400 "parameters, but with the roles of daemon and library reversed."
3404 #: ../src/guestfs.pod:1741
3407 " total length (header + ret,\n"
3408 " but not including the length word itself,\n"
3409 " and not including the chunks)\n"
3410 " struct guestfs_message_header (encoded as XDR)\n"
3411 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3412 " sequence of chunks for FileOut param #0\n"
3413 " sequence of chunks for FileOut param #1 etc.\n"
3418 #: ../src/guestfs.pod:1749
3419 msgid "INITIAL MESSAGE"
3423 #: ../src/guestfs.pod:1751
3425 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3426 "which indicates that the guest and daemon is alive. This is what "
3427 "L</guestfs_launch> waits for."
3431 #: ../src/guestfs.pod:1755
3432 msgid "PROGRESS NOTIFICATION MESSAGES"
3436 #: ../src/guestfs.pod:1757
3438 "The daemon may send progress notification messages at any time. These are "
3439 "distinguished by the normal length word being replaced by "
3440 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3444 #: ../src/guestfs.pod:1761
3446 "The library turns them into progress callbacks (see "
3447 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3448 "discards them if not."
3452 #: ../src/guestfs.pod:1765
3454 "The daemon self-limits the frequency of progress messages it sends (see "
3455 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3460 #: ../src/guestfs.pod:1769
3461 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
3465 #: ../src/guestfs.pod:1771
3467 "All high-level libguestfs actions are synchronous. If you want to use "
3468 "libguestfs asynchronously then you must create a thread."
3472 #: ../src/guestfs.pod:1774
3474 "Only use the handle from a single thread. Either use the handle exclusively "
3475 "from one thread, or provide your own mutex so that two threads cannot issue "
3476 "calls on the same handle at the same time."
3480 #: ../src/guestfs.pod:1778
3482 "See the graphical program guestfs-browser for one possible architecture for "
3483 "multithreaded programs using libvirt and libguestfs."
3487 #: ../src/guestfs.pod:1781
3488 msgid "QEMU WRAPPERS"
3492 #: ../src/guestfs.pod:1783
3494 "If you want to compile your own qemu, run qemu from a non-standard location, "
3495 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
3500 #: ../src/guestfs.pod:1787
3502 "There is one important rule to remember: you I<must C<exec qemu>> as the "
3503 "last command in the shell script (so that qemu replaces the shell and "
3504 "becomes the direct child of the libguestfs-using program). If you don't do "
3505 "this, then the qemu process won't be cleaned up correctly."
3509 #: ../src/guestfs.pod:1792
3511 "Here is an example of a wrapper, where I have built my own copy of qemu from "
3516 #: ../src/guestfs.pod:1795
3520 " qemudir=/home/rjones/d/qemu\n"
3521 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
3527 #: ../src/guestfs.pod:1799
3529 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
3530 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
3535 #: ../src/guestfs.pod:1803
3538 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
3543 #: ../src/guestfs.pod:1805
3545 "Note that libguestfs also calls qemu with the -help and -version options in "
3546 "order to determine features."
3550 #: ../src/guestfs.pod:1808
3551 msgid "LIBGUESTFS VERSION NUMBERS"
3555 #: ../src/guestfs.pod:1810
3557 "Since April 2010, libguestfs has started to make separate development and "
3558 "stable releases, along with corresponding branches in our git repository. "
3559 "These separate releases can be identified by version number:"
3563 #: ../src/guestfs.pod:1815
3566 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3567 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3573 " | `-------- sub-version\n"
3575 " `------ always '1' because we don't change the ABI\n"
3580 #: ../src/guestfs.pod:1826
3581 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3585 #: ../src/guestfs.pod:1828
3587 "As time passes we cherry pick fixes from the development branch and backport "
3588 "those into the stable branch, the effect being that the stable branch should "
3589 "get more stable and less buggy over time. So the stable releases are ideal "
3590 "for people who don't need new features but would just like the software to "
3595 #: ../src/guestfs.pod:1834
3596 msgid "Our criteria for backporting changes are:"
3600 #: ../src/guestfs.pod:1840
3602 "Documentation changes which don't affect any code are backported unless the "
3603 "documentation refers to a future feature which is not in stable."
3607 #: ../src/guestfs.pod:1846
3609 "Bug fixes which are not controversial, fix obvious problems, and have been "
3610 "well tested are backported."
3614 #: ../src/guestfs.pod:1851
3616 "Simple rearrangements of code which shouldn't affect how it works get "
3617 "backported. This is so that the code in the two branches doesn't get too "
3618 "far out of step, allowing us to backport future fixes more easily."
3622 #: ../src/guestfs.pod:1857
3624 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3625 "exceptional case: the new feature is required in order to implement an "
3626 "important bug fix."
3630 #: ../src/guestfs.pod:1863
3632 "A new stable branch starts when we think the new features in development are "
3633 "substantial and compelling enough over the current stable branch to warrant "
3634 "it. When that happens we create new stable and development versions 1.N.0 "
3635 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
3636 "stable at this point, but by backporting fixes from development, that branch "
3637 "will stabilize over time."
3641 #: ../src/guestfs.pod:1871 ../fish/guestfish.pod:867 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 ../tools/virt-rescue.pl:255
3642 msgid "ENVIRONMENT VARIABLES"
3646 #: ../src/guestfs.pod:1875 ../fish/guestfish.pod:893
3647 msgid "LIBGUESTFS_APPEND"
3651 #: ../src/guestfs.pod:1877 ../fish/guestfish.pod:895
3652 msgid "Pass additional options to the guest kernel."
3656 #: ../src/guestfs.pod:1879 ../fish/guestfish.pod:897
3657 msgid "LIBGUESTFS_DEBUG"
3661 #: ../src/guestfs.pod:1881
3663 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
3664 "effect as calling C<guestfs_set_verbose (g, 1)>."
3668 #: ../src/guestfs.pod:1884 ../fish/guestfish.pod:902
3669 msgid "LIBGUESTFS_MEMSIZE"
3673 #: ../src/guestfs.pod:1886 ../fish/guestfish.pod:904
3674 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
3678 #: ../src/guestfs.pod:1889 ../fish/guestfish.pod:907
3681 " LIBGUESTFS_MEMSIZE=700\n"
3686 #: ../src/guestfs.pod:1891 ../fish/guestfish.pod:909
3687 msgid "LIBGUESTFS_PATH"
3691 #: ../src/guestfs.pod:1893
3693 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
3694 "the discussion of paths in section PATH above."
3698 #: ../src/guestfs.pod:1896 ../fish/guestfish.pod:914
3699 msgid "LIBGUESTFS_QEMU"
3703 #: ../src/guestfs.pod:1898 ../fish/guestfish.pod:916
3705 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
3706 "which was found at compile time by the configure script is used."
3710 #: ../src/guestfs.pod:1902
3711 msgid "See also L</QEMU WRAPPERS> above."
3715 #: ../src/guestfs.pod:1904 ../fish/guestfish.pod:920
3716 msgid "LIBGUESTFS_TRACE"
3720 #: ../src/guestfs.pod:1906
3722 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
3723 "effect as calling C<guestfs_set_trace (g, 1)>."
3727 #: ../src/guestfs.pod:1909 ../fish/guestfish.pod:929
3732 #: ../src/guestfs.pod:1911 ../fish/guestfish.pod:931
3733 msgid "Location of temporary directory, defaults to C</tmp>."
3737 #: ../src/guestfs.pod:1913 ../fish/guestfish.pod:933
3739 "If libguestfs was compiled to use the supermin appliance then the real "
3740 "appliance is cached in this directory, shared between all handles belonging "
3741 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
3742 "use in case C</tmp> is not large enough."
3746 #: ../src/guestfs.pod:1921 ../fish/guestfish.pod: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
3751 #: ../src/guestfs.pod:1923
3753 "L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
3754 "L<virt-edit(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
3755 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
3756 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
3757 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
3761 #: ../src/guestfs.pod:1941
3763 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
3764 "L<lvm(8)>, L<disktype(1)>."
3768 #: ../src/guestfs.pod:1948 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548
3773 #: ../src/guestfs.pod:1950
3774 msgid "To get a list of bugs against libguestfs use this link:"
3778 #: ../src/guestfs.pod:1952
3779 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
3783 #: ../src/guestfs.pod:1954
3784 msgid "To report a new bug against libguestfs use this link:"
3788 #: ../src/guestfs.pod:1956
3789 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
3793 #: ../src/guestfs.pod:1958
3794 msgid "When reporting a bug, please check:"
3798 #: ../src/guestfs.pod:1964
3799 msgid "That the bug hasn't been reported already."
3803 #: ../src/guestfs.pod:1968
3804 msgid "That you are testing a recent version."
3808 #: ../src/guestfs.pod:1972
3809 msgid "Describe the bug accurately, and give a way to reproduce it."
3813 #: ../src/guestfs.pod:1976
3815 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
3820 #: ../src/guestfs.pod:1981 ../fish/guestfish.pod:1008 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:225 ../inspector/virt-inspector.pl:580
3825 #: ../src/guestfs.pod:1983 ../fish/guestfish.pod:1010 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:227
3826 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
3830 #: ../src/guestfs.pod:1985 ../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
3835 #: ../src/guestfs.pod:1987 ../fish/guestfish.pod:1014 ../fuse/guestmount.pod:231
3836 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
3840 #: ../src/guestfs.pod:1990
3842 "This library is free software; you can redistribute it and/or modify it "
3843 "under the terms of the GNU Lesser General Public License as published by the "
3844 "Free Software Foundation; either version 2 of the License, or (at your "
3845 "option) any later version."
3849 #: ../src/guestfs.pod:1995
3851 "This library is distributed in the hope that it will be useful, but WITHOUT "
3852 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
3853 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
3858 #: ../src/guestfs.pod:2000
3860 "You should have received a copy of the GNU Lesser General Public License "
3861 "along with this library; if not, write to the Free Software Foundation, "
3862 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
3866 #: ../src/guestfs-actions.pod:1
3867 msgid "guestfs_add_cdrom"
3871 #: ../src/guestfs-actions.pod:3
3875 " guestfs_add_cdrom (guestfs_h *g,\n"
3876 " const char *filename);\n"
3881 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
3882 msgid "This function adds a virtual CD-ROM disk image to the guest."
3886 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
3887 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
3891 #: ../src/guestfs-actions.pod:17
3893 "This call checks for the existence of C<filename>. This stops you from "
3894 "specifying other types of drive which are supported by qemu such as C<nbd:> "
3895 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
3900 #: ../src/guestfs-actions.pod:24
3902 "If you just want to add an ISO file (often you use this as an efficient way "
3903 "to transfer large files into the guest), then you should probably use "
3904 "C<guestfs_add_drive_ro> instead."
3908 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod: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
3909 msgid "This function returns 0 on success or -1 on error."
3913 #: ../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
3915 "This function is deprecated. In new code, use the C<add_drive_opts> call "
3920 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod: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
3922 "Deprecated functions will not be removed from the API, but the fact that "
3923 "they are deprecated indicates that there are problems with correct use of "
3928 #: ../src/guestfs-actions.pod:39
3929 msgid "guestfs_add_drive"
3933 #: ../src/guestfs-actions.pod:41
3937 " guestfs_add_drive (guestfs_h *g,\n"
3938 " const char *filename);\n"
3943 #: ../src/guestfs-actions.pod:45
3945 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
3946 "optional parameters, so the disk is added writable, with the format being "
3947 "detected automatically."
3951 #: ../src/guestfs-actions.pod:49
3953 "Automatic detection of the format opens you up to a potential security hole "
3954 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
3955 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
3956 "you should think about replacing calls to this function with calls to "
3957 "C<guestfs_add_drive_opts>, and specifying the format."
3961 #: ../src/guestfs-actions.pod:58
3962 msgid "guestfs_add_drive_opts"
3966 #: ../src/guestfs-actions.pod:60
3970 " guestfs_add_drive_opts (guestfs_h *g,\n"
3971 " const char *filename,\n"
3977 #: ../src/guestfs-actions.pod:65
3979 "You may supply a list of optional arguments to this call. Use zero or more "
3980 "of the following pairs of parameters, and terminate the list with C<-1> on "
3981 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
3985 #: ../src/guestfs-actions.pod:70
3988 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
3989 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
3990 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
3995 #: ../src/guestfs-actions.pod:74 ../fish/guestfish-actions.pod:56
3997 "This function adds a virtual machine disk image C<filename> to libguestfs. "
3998 "The first time you call this function, the disk appears as C</dev/sda>, the "
3999 "second time as C</dev/sdb>, and so on."
4003 #: ../src/guestfs-actions.pod:79 ../fish/guestfish-actions.pod:61
4005 "You don't necessarily need to be root when using libguestfs. However you "
4006 "obviously do need sufficient permissions to access the filename for whatever "
4007 "operations you want to perform (ie. read access if you just want to read the "
4008 "image or write access if you want to modify the image)."
4012 #: ../src/guestfs-actions.pod:85 ../fish/guestfish-actions.pod:67
4013 msgid "This call checks that C<filename> exists."
4017 #: ../src/guestfs-actions.pod:87 ../fish/guestfish-actions.pod:69
4018 msgid "The optional arguments are:"
4022 #: ../src/guestfs-actions.pod:91 ../fish/guestfish-actions.pod:73
4027 #: ../src/guestfs-actions.pod:93 ../fish/guestfish-actions.pod:75
4029 "If true then the image is treated as read-only. Writes are still allowed, "
4030 "but they are stored in a temporary snapshot overlay which is discarded at "
4031 "the end. The disk that you add is not modified."
4035 #: ../src/guestfs-actions.pod:97 ../fish/guestfish-actions.pod:79
4040 #: ../src/guestfs-actions.pod:99
4042 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4043 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4044 "Possible formats include C<raw> and C<qcow2>."
4048 #: ../src/guestfs-actions.pod:103 ../fish/guestfish-actions.pod:85
4050 "Automatic detection of the format opens you up to a potential security hole "
4051 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4052 "RHBZ#642934. Specifying the format closes this security hole."
4056 #: ../src/guestfs-actions.pod:108 ../fish/guestfish-actions.pod:90
4061 #: ../src/guestfs-actions.pod:110
4063 "This rarely-used option lets you emulate the behaviour of the deprecated "
4064 "C<guestfs_add_drive_with_if> call (q.v.)"
4068 #: ../src/guestfs-actions.pod:117
4069 msgid "guestfs_add_drive_opts_va"
4073 #: ../src/guestfs-actions.pod:119
4077 "guestfs_add_drive_opts_va (guestfs_h *g,\n"
4078 " const char *filename,\n"
4084 #: ../src/guestfs-actions.pod:124
4085 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4089 #: ../src/guestfs-actions.pod:126 ../src/guestfs-actions.pod:137
4090 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4094 #: ../src/guestfs-actions.pod:128
4095 msgid "guestfs_add_drive_opts_argv"
4099 #: ../src/guestfs-actions.pod:130
4103 "guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4104 " const char *filename,\n"
4105 " const struct guestfs_add_drive_opts_argv "
4111 #: ../src/guestfs-actions.pod:135
4112 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4116 #: ../src/guestfs-actions.pod:139
4117 msgid "guestfs_add_drive_ro"
4121 #: ../src/guestfs-actions.pod:141
4125 " guestfs_add_drive_ro (guestfs_h *g,\n"
4126 " const char *filename);\n"
4131 #: ../src/guestfs-actions.pod:145
4133 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4134 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4135 "disk is added read-only, with the format being detected automatically."
4139 #: ../src/guestfs-actions.pod:152
4140 msgid "guestfs_add_drive_ro_with_if"
4144 #: ../src/guestfs-actions.pod:154
4148 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4149 " const char *filename,\n"
4150 " const char *iface);\n"
4155 #: ../src/guestfs-actions.pod:159
4157 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4158 "QEMU interface emulation to use at run time."
4162 #: ../src/guestfs-actions.pod:171
4163 msgid "guestfs_add_drive_with_if"
4167 #: ../src/guestfs-actions.pod:173
4171 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4172 " const char *filename,\n"
4173 " const char *iface);\n"
4178 #: ../src/guestfs-actions.pod:178
4180 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4181 "QEMU interface emulation to use at run time."
4185 #: ../src/guestfs-actions.pod:190
4186 msgid "guestfs_aug_clear"
4190 #: ../src/guestfs-actions.pod:192
4194 " guestfs_aug_clear (guestfs_h *g,\n"
4195 " const char *augpath);\n"
4200 #: ../src/guestfs-actions.pod:196 ../fish/guestfish-actions.pod:142
4202 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4203 "L<augtool(1)> C<clear> command."
4207 #: ../src/guestfs-actions.pod:201
4208 msgid "guestfs_aug_close"
4212 #: ../src/guestfs-actions.pod:203
4216 " guestfs_aug_close (guestfs_h *g);\n"
4221 #: ../src/guestfs-actions.pod:206
4223 "Close the current Augeas handle and free up any resources used by it. After "
4224 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4225 "any other Augeas functions."
4229 #: ../src/guestfs-actions.pod:213
4230 msgid "guestfs_aug_defnode"
4234 #: ../src/guestfs-actions.pod:215
4237 " struct guestfs_int_bool *\n"
4238 " guestfs_aug_defnode (guestfs_h *g,\n"
4239 " const char *name,\n"
4240 " const char *expr,\n"
4241 " const char *val);\n"
4246 #: ../src/guestfs-actions.pod:221 ../fish/guestfish-actions.pod:158
4247 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4251 #: ../src/guestfs-actions.pod:224
4253 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4254 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4255 "containing that single node."
4259 #: ../src/guestfs-actions.pod:228 ../fish/guestfish-actions.pod:165
4261 "On success this returns a pair containing the number of nodes in the "
4262 "nodeset, and a boolean flag if a node was created."
4266 #: ../src/guestfs-actions.pod:232
4268 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4269 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4273 #: ../src/guestfs-actions.pod:236
4274 msgid "guestfs_aug_defvar"
4278 #: ../src/guestfs-actions.pod:238
4282 " guestfs_aug_defvar (guestfs_h *g,\n"
4283 " const char *name,\n"
4284 " const char *expr);\n"
4289 #: ../src/guestfs-actions.pod:243 ../fish/guestfish-actions.pod:173
4291 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4292 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4296 #: ../src/guestfs-actions.pod:247 ../fish/guestfish-actions.pod:177
4298 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4299 "evaluates to something which is not a nodeset."
4303 #: ../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
4304 msgid "On error this function returns -1."
4308 #: ../src/guestfs-actions.pod:252
4309 msgid "guestfs_aug_get"
4313 #: ../src/guestfs-actions.pod:254
4317 " guestfs_aug_get (guestfs_h *g,\n"
4318 " const char *augpath);\n"
4323 #: ../src/guestfs-actions.pod:258 ../fish/guestfish-actions.pod:184
4325 "Look up the value associated with C<path>. If C<path> matches exactly one "
4326 "node, the C<value> is returned."
4330 #: ../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
4332 "This function returns a string, or NULL on error. I<The caller must free "
4333 "the returned string after use>."
4337 #: ../src/guestfs-actions.pod:264
4338 msgid "guestfs_aug_init"
4342 #: ../src/guestfs-actions.pod:266
4346 " guestfs_aug_init (guestfs_h *g,\n"
4347 " const char *root,\n"
4353 #: ../src/guestfs-actions.pod:271 ../fish/guestfish-actions.pod:191
4355 "Create a new Augeas handle for editing configuration files. If there was "
4356 "any previous Augeas handle associated with this guestfs session, then it is "
4361 #: ../src/guestfs-actions.pod:275
4362 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4366 #: ../src/guestfs-actions.pod:278 ../fish/guestfish-actions.pod:198
4367 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4371 #: ../src/guestfs-actions.pod:281 ../fish/guestfish-actions.pod:201
4373 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4374 "logical I<or> of the following integers:"
4378 #: ../src/guestfs-actions.pod:287 ../fish/guestfish-actions.pod:207
4379 msgid "C<AUG_SAVE_BACKUP> = 1"
4383 #: ../src/guestfs-actions.pod:289 ../fish/guestfish-actions.pod:209
4384 msgid "Keep the original file with a C<.augsave> extension."
4388 #: ../src/guestfs-actions.pod:291 ../fish/guestfish-actions.pod:211
4389 msgid "C<AUG_SAVE_NEWFILE> = 2"
4393 #: ../src/guestfs-actions.pod:293 ../fish/guestfish-actions.pod:213
4395 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4396 "original. Overrides C<AUG_SAVE_BACKUP>."
4400 #: ../src/guestfs-actions.pod:296 ../fish/guestfish-actions.pod:216
4401 msgid "C<AUG_TYPE_CHECK> = 4"
4405 #: ../src/guestfs-actions.pod:298 ../fish/guestfish-actions.pod:218
4406 msgid "Typecheck lenses (can be expensive)."
4410 #: ../src/guestfs-actions.pod:300 ../fish/guestfish-actions.pod:220
4411 msgid "C<AUG_NO_STDINC> = 8"
4415 #: ../src/guestfs-actions.pod:302 ../fish/guestfish-actions.pod:222
4416 msgid "Do not use standard load path for modules."
4420 #: ../src/guestfs-actions.pod:304 ../fish/guestfish-actions.pod:224
4421 msgid "C<AUG_SAVE_NOOP> = 16"
4425 #: ../src/guestfs-actions.pod:306 ../fish/guestfish-actions.pod:226
4426 msgid "Make save a no-op, just record what would have been changed."
4430 #: ../src/guestfs-actions.pod:308 ../fish/guestfish-actions.pod:228
4431 msgid "C<AUG_NO_LOAD> = 32"
4435 #: ../src/guestfs-actions.pod:310
4436 msgid "Do not load the tree in C<guestfs_aug_init>."
4440 #: ../src/guestfs-actions.pod:314
4441 msgid "To close the handle, you can call C<guestfs_aug_close>."
4445 #: ../src/guestfs-actions.pod:316 ../fish/guestfish-actions.pod:236
4446 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4450 #: ../src/guestfs-actions.pod:320
4451 msgid "guestfs_aug_insert"
4455 #: ../src/guestfs-actions.pod:322
4459 " guestfs_aug_insert (guestfs_h *g,\n"
4460 " const char *augpath,\n"
4461 " const char *label,\n"
4467 #: ../src/guestfs-actions.pod:328 ../fish/guestfish-actions.pod:242
4469 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4470 "or after C<path> (depending on the boolean flag C<before>)."
4474 #: ../src/guestfs-actions.pod:332 ../fish/guestfish-actions.pod:246
4476 "C<path> must match exactly one existing node in the tree, and C<label> must "
4477 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4481 #: ../src/guestfs-actions.pod:338
4482 msgid "guestfs_aug_load"
4486 #: ../src/guestfs-actions.pod:340
4490 " guestfs_aug_load (guestfs_h *g);\n"
4495 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:254
4496 msgid "Load files into the tree."
4500 #: ../src/guestfs-actions.pod:345 ../fish/guestfish-actions.pod:256
4501 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4505 #: ../src/guestfs-actions.pod:350
4506 msgid "guestfs_aug_ls"
4510 #: ../src/guestfs-actions.pod:352
4514 " guestfs_aug_ls (guestfs_h *g,\n"
4515 " const char *augpath);\n"
4520 #: ../src/guestfs-actions.pod:356
4522 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
4523 "sorting the resulting nodes into alphabetical order."
4527 #: ../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
4529 "This function returns a NULL-terminated array of strings (like "
4530 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
4531 "strings and the array after use>."
4535 #: ../src/guestfs-actions.pod:363
4536 msgid "guestfs_aug_match"
4540 #: ../src/guestfs-actions.pod:365
4544 " guestfs_aug_match (guestfs_h *g,\n"
4545 " const char *augpath);\n"
4550 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:270
4552 "Returns a list of paths which match the path expression C<path>. The "
4553 "returned paths are sufficiently qualified so that they match exactly one "
4554 "node in the current tree."
4558 #: ../src/guestfs-actions.pod:377
4559 msgid "guestfs_aug_mv"
4563 #: ../src/guestfs-actions.pod:379
4567 " guestfs_aug_mv (guestfs_h *g,\n"
4568 " const char *src,\n"
4569 " const char *dest);\n"
4574 #: ../src/guestfs-actions.pod:384 ../fish/guestfish-actions.pod:278
4576 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4577 "C<dest> is overwritten if it exists."
4581 #: ../src/guestfs-actions.pod:389
4582 msgid "guestfs_aug_rm"
4586 #: ../src/guestfs-actions.pod:391
4590 " guestfs_aug_rm (guestfs_h *g,\n"
4591 " const char *augpath);\n"
4596 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:285
4597 msgid "Remove C<path> and all of its children."
4601 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:287
4602 msgid "On success this returns the number of entries which were removed."
4606 #: ../src/guestfs-actions.pod:401
4607 msgid "guestfs_aug_save"
4611 #: ../src/guestfs-actions.pod:403
4615 " guestfs_aug_save (guestfs_h *g);\n"
4620 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:293
4621 msgid "This writes all pending changes to disk."
4625 #: ../src/guestfs-actions.pod:408
4627 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
4632 #: ../src/guestfs-actions.pod:413
4633 msgid "guestfs_aug_set"
4637 #: ../src/guestfs-actions.pod:415
4641 " guestfs_aug_set (guestfs_h *g,\n"
4642 " const char *augpath,\n"
4643 " const char *val);\n"
4648 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:302
4649 msgid "Set the value associated with C<path> to C<val>."
4653 #: ../src/guestfs-actions.pod:422
4655 "In the Augeas API, it is possible to clear a node by setting the value to "
4656 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
4657 "this call. Instead you must use the C<guestfs_aug_clear> call."
4661 #: ../src/guestfs-actions.pod:429
4662 msgid "guestfs_available"
4666 #: ../src/guestfs-actions.pod:431
4670 " guestfs_available (guestfs_h *g,\n"
4671 " char *const *groups);\n"
4676 #: ../src/guestfs-actions.pod:435 ../fish/guestfish-actions.pod:313
4678 "This command is used to check the availability of some groups of "
4679 "functionality in the appliance, which not all builds of the libguestfs "
4680 "appliance will be able to provide."
4684 #: ../src/guestfs-actions.pod:439
4686 "The libguestfs groups, and the functions that those groups correspond to, "
4687 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
4688 "runtime by calling C<guestfs_available_all_groups>."
4692 #: ../src/guestfs-actions.pod:444 ../fish/guestfish-actions.pod:322
4694 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
4695 "\"augeas\"]> would check for the availability of the Linux inotify functions "
4696 "and Augeas (configuration file editing) functions."
4700 #: ../src/guestfs-actions.pod:449 ../fish/guestfish-actions.pod:327
4701 msgid "The command returns no error if I<all> requested groups are available."
4705 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:329
4707 "It fails with an error if one or more of the requested groups is unavailable "
4712 #: ../src/guestfs-actions.pod:454 ../fish/guestfish-actions.pod:332
4714 "If an unknown group name is included in the list of groups then an error is "
4719 #: ../src/guestfs-actions.pod:457 ../fish/guestfish-actions.pod:335
4724 #: ../src/guestfs-actions.pod:463
4725 msgid "You must call C<guestfs_launch> before calling this function."
4729 #: ../src/guestfs-actions.pod:465 ../fish/guestfish-actions.pod:343
4731 "The reason is because we don't know what groups are supported by the "
4732 "appliance/daemon until it is running and can be queried."
4736 #: ../src/guestfs-actions.pod:471 ../fish/guestfish-actions.pod:349
4738 "If a group of functions is available, this does not necessarily mean that "
4739 "they will work. You still have to check for errors when calling individual "
4740 "API functions even if they are available."
4744 #: ../src/guestfs-actions.pod:478 ../fish/guestfish-actions.pod:356
4746 "It is usually the job of distro packagers to build complete functionality "
4747 "into the libguestfs appliance. Upstream libguestfs, if built from source "
4748 "with all requirements satisfied, will support everything."
4752 #: ../src/guestfs-actions.pod:485
4754 "This call was added in version C<1.0.80>. In previous versions of "
4755 "libguestfs all you could do would be to speculatively execute a command to "
4756 "find out if the daemon implemented it. See also C<guestfs_version>."
4760 #: ../src/guestfs-actions.pod:494
4761 msgid "guestfs_available_all_groups"
4765 #: ../src/guestfs-actions.pod:496
4769 " guestfs_available_all_groups (guestfs_h *g);\n"
4774 #: ../src/guestfs-actions.pod:499
4776 "This command returns a list of all optional groups that this daemon knows "
4777 "about. Note this returns both supported and unsupported groups. To find "
4778 "out which ones the daemon can actually support you have to call "
4779 "C<guestfs_available> on each member of the returned list."
4783 #: ../src/guestfs-actions.pod:505
4784 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
4788 #: ../src/guestfs-actions.pod:511
4789 msgid "guestfs_base64_in"
4793 #: ../src/guestfs-actions.pod:513
4797 " guestfs_base64_in (guestfs_h *g,\n"
4798 " const char *base64file,\n"
4799 " const char *filename);\n"
4804 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:386
4805 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
4809 #: ../src/guestfs-actions.pod:523
4810 msgid "guestfs_base64_out"
4814 #: ../src/guestfs-actions.pod:525
4818 " guestfs_base64_out (guestfs_h *g,\n"
4819 " const char *filename,\n"
4820 " const char *base64file);\n"
4825 #: ../src/guestfs-actions.pod:530 ../fish/guestfish-actions.pod:395
4827 "This command downloads the contents of C<filename>, writing it out to local "
4828 "file C<base64file> encoded as base64."
4832 #: ../src/guestfs-actions.pod:535
4833 msgid "guestfs_blockdev_flushbufs"
4837 #: ../src/guestfs-actions.pod:537
4841 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
4842 " const char *device);\n"
4847 #: ../src/guestfs-actions.pod:541 ../fish/guestfish-actions.pod:404
4848 msgid "This tells the kernel to flush internal buffers associated with C<device>."
4852 #: ../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
4853 msgid "This uses the L<blockdev(8)> command."
4857 #: ../src/guestfs-actions.pod:548
4858 msgid "guestfs_blockdev_getbsz"
4862 #: ../src/guestfs-actions.pod:550
4866 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
4867 " const char *device);\n"
4872 #: ../src/guestfs-actions.pod:554 ../fish/guestfish-actions.pod:413
4873 msgid "This returns the block size of a device."
4877 #: ../src/guestfs-actions.pod:556 ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:415 ../fish/guestfish-actions.pod:478
4879 "(Note this is different from both I<size in blocks> and I<filesystem block "
4884 #: ../src/guestfs-actions.pod:563
4885 msgid "guestfs_blockdev_getro"
4889 #: ../src/guestfs-actions.pod:565
4893 " guestfs_blockdev_getro (guestfs_h *g,\n"
4894 " const char *device);\n"
4899 #: ../src/guestfs-actions.pod:569 ../fish/guestfish-actions.pod:424
4901 "Returns a boolean indicating if the block device is read-only (true if "
4902 "read-only, false if not)."
4906 #: ../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
4907 msgid "This function returns a C truth value on success or -1 on error."
4911 #: ../src/guestfs-actions.pod:576
4912 msgid "guestfs_blockdev_getsize64"
4916 #: ../src/guestfs-actions.pod:578
4920 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
4921 " const char *device);\n"
4926 #: ../src/guestfs-actions.pod:582 ../fish/guestfish-actions.pod:433
4927 msgid "This returns the size of the device in bytes."
4931 #: ../src/guestfs-actions.pod:584
4932 msgid "See also C<guestfs_blockdev_getsz>."
4936 #: ../src/guestfs-actions.pod:590
4937 msgid "guestfs_blockdev_getss"
4941 #: ../src/guestfs-actions.pod:592
4945 " guestfs_blockdev_getss (guestfs_h *g,\n"
4946 " const char *device);\n"
4951 #: ../src/guestfs-actions.pod:596 ../fish/guestfish-actions.pod:443
4953 "This returns the size of sectors on a block device. Usually 512, but can be "
4954 "larger for modern devices."
4958 #: ../src/guestfs-actions.pod:599
4960 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
4965 #: ../src/guestfs-actions.pod:606
4966 msgid "guestfs_blockdev_getsz"
4970 #: ../src/guestfs-actions.pod:608
4974 " guestfs_blockdev_getsz (guestfs_h *g,\n"
4975 " const char *device);\n"
4980 #: ../src/guestfs-actions.pod:612 ../fish/guestfish-actions.pod:455
4982 "This returns the size of the device in units of 512-byte sectors (even if "
4983 "the sectorsize isn't 512 bytes ... weird)."
4987 #: ../src/guestfs-actions.pod:615
4989 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
4990 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
4994 #: ../src/guestfs-actions.pod:623
4995 msgid "guestfs_blockdev_rereadpt"
4999 #: ../src/guestfs-actions.pod:625
5003 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5004 " const char *device);\n"
5009 #: ../src/guestfs-actions.pod:629 ../fish/guestfish-actions.pod:468
5010 msgid "Reread the partition table on C<device>."
5014 #: ../src/guestfs-actions.pod:635
5015 msgid "guestfs_blockdev_setbsz"
5019 #: ../src/guestfs-actions.pod:637
5023 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5024 " const char *device,\n"
5025 " int blocksize);\n"
5030 #: ../src/guestfs-actions.pod:642 ../fish/guestfish-actions.pod:476
5031 msgid "This sets the block size of a device."
5035 #: ../src/guestfs-actions.pod:651
5036 msgid "guestfs_blockdev_setro"
5040 #: ../src/guestfs-actions.pod:653
5044 " guestfs_blockdev_setro (guestfs_h *g,\n"
5045 " const char *device);\n"
5050 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:487
5051 msgid "Sets the block device named C<device> to read-only."
5055 #: ../src/guestfs-actions.pod:663
5056 msgid "guestfs_blockdev_setrw"
5060 #: ../src/guestfs-actions.pod:665
5064 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5065 " const char *device);\n"
5070 #: ../src/guestfs-actions.pod:669 ../fish/guestfish-actions.pod:495
5071 msgid "Sets the block device named C<device> to read-write."
5075 #: ../src/guestfs-actions.pod:675
5076 msgid "guestfs_case_sensitive_path"
5080 #: ../src/guestfs-actions.pod:677
5084 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5085 " const char *path);\n"
5090 #: ../src/guestfs-actions.pod:681 ../fish/guestfish-actions.pod:503
5092 "This can be used to resolve case insensitive paths on a filesystem which is "
5093 "case sensitive. The use case is to resolve paths which you have read from "
5094 "Windows configuration files or the Windows Registry, to the true path."
5098 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:508
5100 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5101 "(and probably others), which is that although the underlying filesystem is "
5102 "case-insensitive, the driver exports the filesystem to Linux as "
5107 #: ../src/guestfs-actions.pod:691 ../fish/guestfish-actions.pod:513
5109 "One consequence of this is that special directories such as C<c:\\windows> "
5110 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5111 "precise details of how they were created. In Windows itself this would not "
5116 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:519
5118 "Bug or feature? You decide: "
5119 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
5123 #: ../src/guestfs-actions.pod:700 ../fish/guestfish-actions.pod:522
5125 "This function resolves the true case of each element in the path and returns "
5126 "the case-sensitive path."
5130 #: ../src/guestfs-actions.pod:703
5132 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
5133 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5134 "how the directories were originally created under Windows)."
5138 #: ../src/guestfs-actions.pod:708 ../fish/guestfish-actions.pod:530
5139 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5143 #: ../src/guestfs-actions.pod:711
5144 msgid "See also C<guestfs_realpath>."
5148 #: ../src/guestfs-actions.pod:716
5153 #: ../src/guestfs-actions.pod:718
5157 " guestfs_cat (guestfs_h *g,\n"
5158 " const char *path);\n"
5163 #: ../src/guestfs-actions.pod:722 ../src/guestfs-actions.pod:4386 ../fish/guestfish-actions.pod:539 ../fish/guestfish-actions.pod:3197
5164 msgid "Return the contents of the file named C<path>."
5168 #: ../src/guestfs-actions.pod:724
5170 "Note that this function cannot correctly handle binary files (specifically, "
5171 "files containing C<\\0> character which is treated as end of string). For "
5172 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5173 "functions which have a more complex interface."
5177 #: ../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
5179 "Because of the message protocol, there is a transfer limit of somewhere "
5180 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5184 #: ../src/guestfs-actions.pod:735
5185 msgid "guestfs_checksum"
5189 #: ../src/guestfs-actions.pod:737
5193 " guestfs_checksum (guestfs_h *g,\n"
5194 " const char *csumtype,\n"
5195 " const char *path);\n"
5200 #: ../src/guestfs-actions.pod:742 ../fish/guestfish-actions.pod:553
5201 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5205 #: ../src/guestfs-actions.pod:745 ../fish/guestfish-actions.pod:556
5207 "The type of checksum to compute is given by the C<csumtype> parameter which "
5208 "must have one of the following values:"
5212 #: ../src/guestfs-actions.pod:750 ../fish/guestfish-actions.pod:561
5217 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:563
5219 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5224 #: ../src/guestfs-actions.pod:755 ../fish/guestfish-actions.pod:566
5229 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:568
5230 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5234 #: ../src/guestfs-actions.pod:759 ../fish/guestfish-actions.pod:570
5239 #: ../src/guestfs-actions.pod:761 ../fish/guestfish-actions.pod:572
5240 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5244 #: ../src/guestfs-actions.pod:763 ../fish/guestfish-actions.pod:574
5249 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:576
5250 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5254 #: ../src/guestfs-actions.pod:767 ../fish/guestfish-actions.pod:578
5259 #: ../src/guestfs-actions.pod:769 ../fish/guestfish-actions.pod:580
5260 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5264 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:582
5269 #: ../src/guestfs-actions.pod:773 ../fish/guestfish-actions.pod:584
5270 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5274 #: ../src/guestfs-actions.pod:775 ../fish/guestfish-actions.pod:586
5279 #: ../src/guestfs-actions.pod:777 ../fish/guestfish-actions.pod:588
5280 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5284 #: ../src/guestfs-actions.pod:781 ../fish/guestfish-actions.pod:592
5285 msgid "The checksum is returned as a printable string."
5289 #: ../src/guestfs-actions.pod:783
5290 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
5294 #: ../src/guestfs-actions.pod:785
5295 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
5299 #: ../src/guestfs-actions.pod:790
5300 msgid "guestfs_checksum_device"
5304 #: ../src/guestfs-actions.pod:792
5308 " guestfs_checksum_device (guestfs_h *g,\n"
5309 " const char *csumtype,\n"
5310 " const char *device);\n"
5315 #: ../src/guestfs-actions.pod:797
5317 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5318 "device named C<device>. For the types of checksums supported see the "
5319 "C<guestfs_checksum> command."
5323 #: ../src/guestfs-actions.pod:804
5324 msgid "guestfs_checksums_out"
5328 #: ../src/guestfs-actions.pod:806
5332 " guestfs_checksums_out (guestfs_h *g,\n"
5333 " const char *csumtype,\n"
5334 " const char *directory,\n"
5335 " const char *sumsfile);\n"
5340 #: ../src/guestfs-actions.pod:812 ../fish/guestfish-actions.pod:610
5342 "This command computes the checksums of all regular files in C<directory> and "
5343 "then emits a list of those checksums to the local output file C<sumsfile>."
5347 #: ../src/guestfs-actions.pod:816 ../fish/guestfish-actions.pod:614
5349 "This can be used for verifying the integrity of a virtual machine. However "
5350 "to be properly secure you should pay attention to the output of the checksum "
5351 "command (it uses the ones from GNU coreutils). In particular when the "
5352 "filename is not printable, coreutils uses a special backslash syntax. For "
5353 "more information, see the GNU coreutils info file."
5357 #: ../src/guestfs-actions.pod:826
5358 msgid "guestfs_chmod"
5362 #: ../src/guestfs-actions.pod:828
5366 " guestfs_chmod (guestfs_h *g,\n"
5368 " const char *path);\n"
5373 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:628
5375 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5380 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:631
5382 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5383 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5388 #: ../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
5389 msgid "The mode actually set is affected by the umask."
5393 #: ../src/guestfs-actions.pod:844
5394 msgid "guestfs_chown"
5398 #: ../src/guestfs-actions.pod:846
5402 " guestfs_chown (guestfs_h *g,\n"
5405 " const char *path);\n"
5410 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:641
5411 msgid "Change the file owner to C<owner> and group to C<group>."
5415 #: ../src/guestfs-actions.pod:854 ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:643 ../fish/guestfish-actions.pod:2035
5417 "Only numeric uid and gid are supported. If you want to use names, you will "
5418 "need to locate and parse the password file yourself (Augeas support makes "
5419 "this relatively easy)."
5423 #: ../src/guestfs-actions.pod:860
5424 msgid "guestfs_command"
5428 #: ../src/guestfs-actions.pod:862
5432 " guestfs_command (guestfs_h *g,\n"
5433 " char *const *arguments);\n"
5438 #: ../src/guestfs-actions.pod:866 ../fish/guestfish-actions.pod:651
5440 "This call runs a command from the guest filesystem. The filesystem must be "
5441 "mounted, and must contain a compatible operating system (ie. something "
5442 "Linux, with the same or compatible processor architecture)."
5446 #: ../src/guestfs-actions.pod:871
5448 "The single parameter is an argv-style list of arguments. The first element "
5449 "is the name of the program to run. Subsequent elements are parameters. The "
5450 "list must be non-empty (ie. must contain a program name). Note that the "
5451 "command runs directly, and is I<not> invoked via the shell (see "
5456 #: ../src/guestfs-actions.pod:878 ../fish/guestfish-actions.pod:663
5457 msgid "The return value is anything printed to I<stdout> by the command."
5461 #: ../src/guestfs-actions.pod:881 ../fish/guestfish-actions.pod:666
5463 "If the command returns a non-zero exit status, then this function returns an "
5464 "error message. The error message string is the content of I<stderr> from "
5469 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:670
5471 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
5472 "C</bin>. If you require a program from another location, you should provide "
5473 "the full path in the first parameter."
5477 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:675
5479 "Shared libraries and data files required by the program must be available on "
5480 "filesystems which are mounted in the correct places. It is the caller's "
5481 "responsibility to ensure all filesystems that are needed are mounted at the "
5486 #: ../src/guestfs-actions.pod:902
5487 msgid "guestfs_command_lines"
5491 #: ../src/guestfs-actions.pod:904
5495 " guestfs_command_lines (guestfs_h *g,\n"
5496 " char *const *arguments);\n"
5501 #: ../src/guestfs-actions.pod:908
5503 "This is the same as C<guestfs_command>, but splits the result into a list of "
5508 #: ../src/guestfs-actions.pod:911
5509 msgid "See also: C<guestfs_sh_lines>"
5513 #: ../src/guestfs-actions.pod:920
5514 msgid "guestfs_config"
5518 #: ../src/guestfs-actions.pod:922
5522 " guestfs_config (guestfs_h *g,\n"
5523 " const char *qemuparam,\n"
5524 " const char *qemuvalue);\n"
5529 #: ../src/guestfs-actions.pod:927 ../fish/guestfish-actions.pod:700
5531 "This can be used to add arbitrary qemu command line parameters of the form "
5532 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
5533 "setting some parameters which would interfere with parameters that we use."
5537 #: ../src/guestfs-actions.pod:932 ../fish/guestfish-actions.pod:705
5538 msgid "The first character of C<param> string must be a C<-> (dash)."
5542 #: ../src/guestfs-actions.pod:934 ../fish/guestfish-actions.pod:707
5543 msgid "C<value> can be NULL."
5547 #: ../src/guestfs-actions.pod:938
5548 msgid "guestfs_copy_size"
5552 #: ../src/guestfs-actions.pod:940
5556 " guestfs_copy_size (guestfs_h *g,\n"
5557 " const char *src,\n"
5558 " const char *dest,\n"
5564 #: ../src/guestfs-actions.pod:946 ../fish/guestfish-actions.pod:713
5566 "This command copies exactly C<size> bytes from one source device or file "
5567 "C<src> to another destination device or file C<dest>."
5571 #: ../src/guestfs-actions.pod:949 ../fish/guestfish-actions.pod:716
5573 "Note this will fail if the source is too short or if the destination is not "
5578 #: ../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
5580 "This long-running command can generate progress notification messages so "
5581 "that the caller can display a progress bar or indicator. To receive these "
5582 "messages, the caller must register a progress callback. See "
5583 "L<guestfs(3)/guestfs_set_progress_callback>."
5587 #: ../src/guestfs-actions.pod:959
5592 #: ../src/guestfs-actions.pod:961
5596 " guestfs_cp (guestfs_h *g,\n"
5597 " const char *src,\n"
5598 " const char *dest);\n"
5603 #: ../src/guestfs-actions.pod:966 ../fish/guestfish-actions.pod:723
5605 "This copies a file from C<src> to C<dest> where C<dest> is either a "
5606 "destination filename or destination directory."
5610 #: ../src/guestfs-actions.pod:971
5611 msgid "guestfs_cp_a"
5615 #: ../src/guestfs-actions.pod:973
5619 " guestfs_cp_a (guestfs_h *g,\n"
5620 " const char *src,\n"
5621 " const char *dest);\n"
5626 #: ../src/guestfs-actions.pod:978 ../fish/guestfish-actions.pod:730
5628 "This copies a file or directory from C<src> to C<dest> recursively using the "
5633 #: ../src/guestfs-actions.pod:983
5638 #: ../src/guestfs-actions.pod:985
5642 " guestfs_dd (guestfs_h *g,\n"
5643 " const char *src,\n"
5644 " const char *dest);\n"
5649 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:737
5651 "This command copies from one source device or file C<src> to another "
5652 "destination device or file C<dest>. Normally you would use this to copy to "
5653 "or from a device or partition, for example to duplicate a filesystem."
5657 #: ../src/guestfs-actions.pod:995
5659 "If the destination is a device, it must be as large or larger than the "
5660 "source file or device, otherwise the copy will fail. This command cannot do "
5661 "partial copies (see C<guestfs_copy_size>)."
5665 #: ../src/guestfs-actions.pod:1001
5666 msgid "guestfs_debug"
5670 #: ../src/guestfs-actions.pod:1003
5674 " guestfs_debug (guestfs_h *g,\n"
5675 " const char *subcmd,\n"
5676 " char *const *extraargs);\n"
5681 #: ../src/guestfs-actions.pod:1008
5683 "The C<guestfs_debug> command exposes some internals of C<guestfsd> (the "
5684 "guestfs daemon) that runs inside the qemu subprocess."
5688 #: ../src/guestfs-actions.pod:1012 ../fish/guestfish-actions.pod:754
5690 "There is no comprehensive help for this command. You have to look at the "
5691 "file C<daemon/debug.c> in the libguestfs source to find out what you can do."
5695 #: ../src/guestfs-actions.pod:1019
5696 msgid "guestfs_debug_upload"
5700 #: ../src/guestfs-actions.pod:1021
5704 " guestfs_debug_upload (guestfs_h *g,\n"
5705 " const char *filename,\n"
5706 " const char *tmpname,\n"
5712 #: ../src/guestfs-actions.pod:1027
5714 "The C<guestfs_debug_upload> command uploads a file to the libguestfs "
5719 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:765
5721 "There is no comprehensive help for this command. You have to look at the "
5722 "file C<daemon/debug.c> in the libguestfs source to find out what it is for."
5726 #: ../src/guestfs-actions.pod:1036
5731 #: ../src/guestfs-actions.pod:1038
5735 " guestfs_df (guestfs_h *g);\n"
5740 #: ../src/guestfs-actions.pod:1041 ../fish/guestfish-actions.pod:775
5741 msgid "This command runs the C<df> command to report disk space used."
5745 #: ../src/guestfs-actions.pod:1043 ../src/guestfs-actions.pod:1058 ../fish/guestfish-actions.pod:777 ../fish/guestfish-actions.pod:788
5747 "This command is mostly useful for interactive sessions. It is I<not> "
5748 "intended that you try to parse the output string. Use C<statvfs> from "
5753 #: ../src/guestfs-actions.pod:1050
5754 msgid "guestfs_df_h"
5758 #: ../src/guestfs-actions.pod:1052
5762 " guestfs_df_h (guestfs_h *g);\n"
5767 #: ../src/guestfs-actions.pod:1055 ../fish/guestfish-actions.pod:785
5769 "This command runs the C<df -h> command to report disk space used in "
5770 "human-readable format."
5774 #: ../src/guestfs-actions.pod:1065
5775 msgid "guestfs_dmesg"
5779 #: ../src/guestfs-actions.pod:1067
5783 " guestfs_dmesg (guestfs_h *g);\n"
5788 #: ../src/guestfs-actions.pod:1070 ../fish/guestfish-actions.pod:796
5790 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
5791 "This is sometimes useful for extended debugging of problems."
5795 #: ../src/guestfs-actions.pod:1074
5797 "Another way to get the same information is to enable verbose messages with "
5798 "C<guestfs_set_verbose> or by setting the environment variable "
5799 "C<LIBGUESTFS_DEBUG=1> before running the program."
5803 #: ../src/guestfs-actions.pod:1082
5804 msgid "guestfs_download"
5808 #: ../src/guestfs-actions.pod:1084
5812 " guestfs_download (guestfs_h *g,\n"
5813 " const char *remotefilename,\n"
5814 " const char *filename);\n"
5819 #: ../src/guestfs-actions.pod:1089 ../src/guestfs-actions.pod:1112 ../fish/guestfish-actions.pod:809 ../fish/guestfish-actions.pod:822
5821 "Download file C<remotefilename> and save it as C<filename> on the local "
5826 #: ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:5553 ../fish/guestfish-actions.pod:812 ../fish/guestfish-actions.pod:4077
5827 msgid "C<filename> can also be a named pipe."
5831 #: ../src/guestfs-actions.pod:1094
5832 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
5836 #: ../src/guestfs-actions.pod:1103
5837 msgid "guestfs_download_offset"
5841 #: ../src/guestfs-actions.pod:1105
5845 " guestfs_download_offset (guestfs_h *g,\n"
5846 " const char *remotefilename,\n"
5847 " const char *filename,\n"
5848 " int64_t offset,\n"
5854 #: ../src/guestfs-actions.pod:1115 ../fish/guestfish-actions.pod:825
5856 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
5857 "region must be within the file or device)."
5861 #: ../src/guestfs-actions.pod:1118
5863 "Note that there is no limit on the amount of data that can be downloaded "
5864 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
5865 "full amount unless an error occurs."
5869 #: ../src/guestfs-actions.pod:1123
5870 msgid "See also C<guestfs_download>, C<guestfs_pread>."
5874 #: ../src/guestfs-actions.pod:1132
5875 msgid "guestfs_drop_caches"
5879 #: ../src/guestfs-actions.pod:1134
5883 " guestfs_drop_caches (guestfs_h *g,\n"
5884 " int whattodrop);\n"
5889 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:841
5891 "This instructs the guest kernel to drop its page cache, and/or dentries and "
5892 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
5893 "to drop, see L<http://linux-mm.org/Drop_Caches>"
5897 #: ../src/guestfs-actions.pod:1143 ../fish/guestfish-actions.pod:846
5898 msgid "Setting C<whattodrop> to 3 should drop everything."
5902 #: ../src/guestfs-actions.pod:1145 ../fish/guestfish-actions.pod:848
5904 "This automatically calls L<sync(2)> before the operation, so that the "
5905 "maximum guest memory is freed."
5909 #: ../src/guestfs-actions.pod:1150
5914 #: ../src/guestfs-actions.pod:1152
5918 " guestfs_du (guestfs_h *g,\n"
5919 " const char *path);\n"
5924 #: ../src/guestfs-actions.pod:1156 ../fish/guestfish-actions.pod:855
5926 "This command runs the C<du -s> command to estimate file space usage for "
5931 #: ../src/guestfs-actions.pod:1159 ../fish/guestfish-actions.pod:858
5933 "C<path> can be a file or a directory. If C<path> is a directory then the "
5934 "estimate includes the contents of the directory and all subdirectories "
5939 #: ../src/guestfs-actions.pod:1163 ../fish/guestfish-actions.pod:862
5940 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
5944 #: ../src/guestfs-actions.pod:1168
5945 msgid "guestfs_e2fsck_f"
5949 #: ../src/guestfs-actions.pod:1170
5953 " guestfs_e2fsck_f (guestfs_h *g,\n"
5954 " const char *device);\n"
5959 #: ../src/guestfs-actions.pod:1174 ../fish/guestfish-actions.pod:869
5961 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
5962 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
5967 #: ../src/guestfs-actions.pod:1178
5969 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
5970 "Normally you should use C<guestfs_fsck>."
5974 #: ../src/guestfs-actions.pod:1183
5975 msgid "guestfs_echo_daemon"
5979 #: ../src/guestfs-actions.pod:1185
5983 " guestfs_echo_daemon (guestfs_h *g,\n"
5984 " char *const *words);\n"
5989 #: ../src/guestfs-actions.pod:1189 ../fish/guestfish-actions.pod:880
5991 "This command concatenates the list of C<words> passed with single spaces "
5992 "between them and returns the resulting string."
5996 #: ../src/guestfs-actions.pod:1192 ../fish/guestfish-actions.pod:883
5997 msgid "You can use this command to test the connection through to the daemon."
6001 #: ../src/guestfs-actions.pod:1194
6002 msgid "See also C<guestfs_ping_daemon>."
6006 #: ../src/guestfs-actions.pod:1199
6007 msgid "guestfs_egrep"
6011 #: ../src/guestfs-actions.pod:1201
6015 " guestfs_egrep (guestfs_h *g,\n"
6016 " const char *regex,\n"
6017 " const char *path);\n"
6022 #: ../src/guestfs-actions.pod:1206 ../fish/guestfish-actions.pod:891
6023 msgid "This calls the external C<egrep> program and returns the matching lines."
6027 #: ../src/guestfs-actions.pod:1216
6028 msgid "guestfs_egrepi"
6032 #: ../src/guestfs-actions.pod:1218
6036 " guestfs_egrepi (guestfs_h *g,\n"
6037 " const char *regex,\n"
6038 " const char *path);\n"
6043 #: ../src/guestfs-actions.pod:1223 ../fish/guestfish-actions.pod:901
6044 msgid "This calls the external C<egrep -i> program and returns the matching lines."
6048 #: ../src/guestfs-actions.pod:1233
6049 msgid "guestfs_equal"
6053 #: ../src/guestfs-actions.pod:1235
6057 " guestfs_equal (guestfs_h *g,\n"
6058 " const char *file1,\n"
6059 " const char *file2);\n"
6064 #: ../src/guestfs-actions.pod:1240 ../fish/guestfish-actions.pod:911
6066 "This compares the two files C<file1> and C<file2> and returns true if their "
6067 "content is exactly equal, or false otherwise."
6071 #: ../src/guestfs-actions.pod:1243 ../fish/guestfish-actions.pod:914
6072 msgid "The external L<cmp(1)> program is used for the comparison."
6076 #: ../src/guestfs-actions.pod:1247
6077 msgid "guestfs_exists"
6081 #: ../src/guestfs-actions.pod:1249
6085 " guestfs_exists (guestfs_h *g,\n"
6086 " const char *path);\n"
6091 #: ../src/guestfs-actions.pod:1253 ../fish/guestfish-actions.pod:920
6093 "This returns C<true> if and only if there is a file, directory (or anything) "
6094 "with the given C<path> name."
6098 #: ../src/guestfs-actions.pod:1256
6099 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6103 #: ../src/guestfs-actions.pod:1260
6104 msgid "guestfs_fallocate"
6108 #: ../src/guestfs-actions.pod:1262
6112 " guestfs_fallocate (guestfs_h *g,\n"
6113 " const char *path,\n"
6119 #: ../src/guestfs-actions.pod:1267 ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:929 ../fish/guestfish-actions.pod:948
6121 "This command preallocates a file (containing zero bytes) named C<path> of "
6122 "size C<len> bytes. If the file exists already, it is overwritten."
6126 #: ../src/guestfs-actions.pod:1271 ../fish/guestfish-actions.pod:933
6128 "Do not confuse this with the guestfish-specific C<alloc> command which "
6129 "allocates a file in the host and attaches it as a device."
6133 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:937
6135 "This function is deprecated. In new code, use the C<fallocate64> call "
6140 #: ../src/guestfs-actions.pod:1284
6141 msgid "guestfs_fallocate64"
6145 #: ../src/guestfs-actions.pod:1286
6149 " guestfs_fallocate64 (guestfs_h *g,\n"
6150 " const char *path,\n"
6156 #: ../src/guestfs-actions.pod:1295
6158 "Note that this call allocates disk blocks for the file. To create a sparse "
6159 "file use C<guestfs_truncate_size> instead."
6163 #: ../src/guestfs-actions.pod:1298
6165 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6166 "oversight it only allowed 30 bit lengths to be specified, effectively "
6167 "limiting the maximum size of files created through that call to 1GB."
6171 #: ../src/guestfs-actions.pod:1303 ../fish/guestfish-actions.pod:960
6173 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6174 "commands which create a file in the host and attach it as a device."
6178 #: ../src/guestfs-actions.pod:1309
6179 msgid "guestfs_fgrep"
6183 #: ../src/guestfs-actions.pod:1311
6187 " guestfs_fgrep (guestfs_h *g,\n"
6188 " const char *pattern,\n"
6189 " const char *path);\n"
6194 #: ../src/guestfs-actions.pod:1316 ../fish/guestfish-actions.pod:968
6195 msgid "This calls the external C<fgrep> program and returns the matching lines."
6199 #: ../src/guestfs-actions.pod:1326
6200 msgid "guestfs_fgrepi"
6204 #: ../src/guestfs-actions.pod:1328
6208 " guestfs_fgrepi (guestfs_h *g,\n"
6209 " const char *pattern,\n"
6210 " const char *path);\n"
6215 #: ../src/guestfs-actions.pod:1333 ../fish/guestfish-actions.pod:978
6216 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
6220 #: ../src/guestfs-actions.pod:1343
6221 msgid "guestfs_file"
6225 #: ../src/guestfs-actions.pod:1345
6229 " guestfs_file (guestfs_h *g,\n"
6230 " const char *path);\n"
6235 #: ../src/guestfs-actions.pod:1349 ../fish/guestfish-actions.pod:988
6237 "This call uses the standard L<file(1)> command to determine the type or "
6238 "contents of the file."
6242 #: ../src/guestfs-actions.pod:1352 ../fish/guestfish-actions.pod:991
6244 "This call will also transparently look inside various types of compressed "
6249 #: ../src/guestfs-actions.pod:1355 ../fish/guestfish-actions.pod:994
6251 "The exact command which runs is C<file -zb path>. Note in particular that "
6252 "the filename is not prepended to the output (the C<-b> option)."
6256 #: ../src/guestfs-actions.pod:1359
6258 "This command can also be used on C</dev/> devices (and partitions, LV "
6259 "names). You can for example use this to determine if a device contains a "
6260 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
6264 #: ../src/guestfs-actions.pod:1364 ../fish/guestfish-actions.pod:1003
6266 "If the C<path> does not begin with C</dev/> then this command only works for "
6267 "the content of regular files. For other file types (directory, symbolic "
6268 "link etc) it will just return the string C<directory> etc."
6272 #: ../src/guestfs-actions.pod:1372
6273 msgid "guestfs_file_architecture"
6277 #: ../src/guestfs-actions.pod:1374
6281 " guestfs_file_architecture (guestfs_h *g,\n"
6282 " const char *filename);\n"
6287 #: ../src/guestfs-actions.pod:1378 ../fish/guestfish-actions.pod:1012
6289 "This detects the architecture of the binary C<filename>, and returns it if "
6294 #: ../src/guestfs-actions.pod:1381 ../fish/guestfish-actions.pod:1015
6295 msgid "Currently defined architectures are:"
6299 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:1019
6304 #: ../src/guestfs-actions.pod:1387 ../fish/guestfish-actions.pod:1021
6306 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6307 "irrespective of the precise processor requirements of the binary."
6311 #: ../src/guestfs-actions.pod:1390 ../fish/guestfish-actions.pod:1024
6316 #: ../src/guestfs-actions.pod:1392 ../fish/guestfish-actions.pod:1026
6317 msgid "64 bit x86-64."
6321 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:1028
6326 #: ../src/guestfs-actions.pod:1396 ../fish/guestfish-actions.pod:1030
6327 msgid "32 bit SPARC."
6331 #: ../src/guestfs-actions.pod:1398 ../fish/guestfish-actions.pod:1032
6336 #: ../src/guestfs-actions.pod:1400 ../fish/guestfish-actions.pod:1034
6337 msgid "64 bit SPARC V9 and above."
6341 #: ../src/guestfs-actions.pod:1402 ../fish/guestfish-actions.pod:1036
6346 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:1038
6347 msgid "Intel Itanium."
6351 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:1040
6356 #: ../src/guestfs-actions.pod:1408 ../fish/guestfish-actions.pod:1042
6357 msgid "32 bit Power PC."
6361 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:1044
6366 #: ../src/guestfs-actions.pod:1412 ../fish/guestfish-actions.pod:1046
6367 msgid "64 bit Power PC."
6371 #: ../src/guestfs-actions.pod:1416 ../fish/guestfish-actions.pod:1050
6372 msgid "Libguestfs may return other architecture strings in future."
6376 #: ../src/guestfs-actions.pod:1418 ../fish/guestfish-actions.pod:1052
6377 msgid "The function works on at least the following types of files:"
6381 #: ../src/guestfs-actions.pod:1424 ../fish/guestfish-actions.pod:1058
6382 msgid "many types of Un*x and Linux binary"
6386 #: ../src/guestfs-actions.pod:1428 ../fish/guestfish-actions.pod:1062
6387 msgid "many types of Un*x and Linux shared library"
6391 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:1066
6392 msgid "Windows Win32 and Win64 binaries"
6396 #: ../src/guestfs-actions.pod:1436 ../fish/guestfish-actions.pod:1070
6397 msgid "Windows Win32 and Win64 DLLs"
6401 #: ../src/guestfs-actions.pod:1438 ../fish/guestfish-actions.pod:1072
6402 msgid "Win32 binaries and DLLs return C<i386>."
6406 #: ../src/guestfs-actions.pod:1440 ../fish/guestfish-actions.pod:1074
6407 msgid "Win64 binaries and DLLs return C<x86_64>."
6411 #: ../src/guestfs-actions.pod:1444 ../fish/guestfish-actions.pod:1078
6412 msgid "Linux kernel modules"
6416 #: ../src/guestfs-actions.pod:1448 ../fish/guestfish-actions.pod:1082
6417 msgid "Linux new-style initrd images"
6421 #: ../src/guestfs-actions.pod:1452 ../fish/guestfish-actions.pod:1086
6422 msgid "some non-x86 Linux vmlinuz kernels"
6426 #: ../src/guestfs-actions.pod:1456 ../fish/guestfish-actions.pod:1090
6427 msgid "What it can't do currently:"
6431 #: ../src/guestfs-actions.pod:1462 ../fish/guestfish-actions.pod:1096
6432 msgid "static libraries (libfoo.a)"
6436 #: ../src/guestfs-actions.pod:1466 ../fish/guestfish-actions.pod:1100
6437 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6441 #: ../src/guestfs-actions.pod:1470 ../fish/guestfish-actions.pod:1104
6442 msgid "x86 Linux vmlinuz kernels"
6446 #: ../src/guestfs-actions.pod:1472 ../fish/guestfish-actions.pod:1106
6448 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6449 "compressed code, and are horribly hard to unpack. If you want to find the "
6450 "architecture of a kernel, use the architecture of the associated initrd or "
6451 "kernel module(s) instead."
6455 #: ../src/guestfs-actions.pod:1482
6456 msgid "guestfs_filesize"
6460 #: ../src/guestfs-actions.pod:1484
6464 " guestfs_filesize (guestfs_h *g,\n"
6465 " const char *file);\n"
6470 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:1117
6471 msgid "This command returns the size of C<file> in bytes."
6475 #: ../src/guestfs-actions.pod:1490
6477 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
6478 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
6479 "devices, use C<guestfs_blockdev_getsize64>."
6483 #: ../src/guestfs-actions.pod:1496
6484 msgid "guestfs_fill"
6488 #: ../src/guestfs-actions.pod:1498
6492 " guestfs_fill (guestfs_h *g,\n"
6495 " const char *path);\n"
6500 #: ../src/guestfs-actions.pod:1504 ../fish/guestfish-actions.pod:1127
6502 "This command creates a new file called C<path>. The initial content of the "
6503 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
6508 #: ../src/guestfs-actions.pod:1508
6510 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6511 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
6512 "bytes use C<guestfs_fill_pattern>."
6516 #: ../src/guestfs-actions.pod:1520
6517 msgid "guestfs_fill_pattern"
6521 #: ../src/guestfs-actions.pod:1522
6525 " guestfs_fill_pattern (guestfs_h *g,\n"
6526 " const char *pattern,\n"
6528 " const char *path);\n"
6533 #: ../src/guestfs-actions.pod:1528
6535 "This function is like C<guestfs_fill> except that it creates a new file of "
6536 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
6537 "pattern is truncated if necessary to ensure the length of the file is "
6538 "exactly C<len> bytes."
6542 #: ../src/guestfs-actions.pod:1540
6543 msgid "guestfs_find"
6547 #: ../src/guestfs-actions.pod:1542
6551 " guestfs_find (guestfs_h *g,\n"
6552 " const char *directory);\n"
6557 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1149
6559 "This command lists out all files and directories, recursively, starting at "
6560 "C<directory>. It is essentially equivalent to running the shell command "
6561 "C<find directory -print> but some post-processing happens on the output, "
6566 #: ../src/guestfs-actions.pod:1551 ../fish/guestfish-actions.pod:1154
6568 "This returns a list of strings I<without any prefix>. Thus if the directory "
6573 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1157
6583 #: ../src/guestfs-actions.pod:1558
6584 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
6588 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1164
6599 #: ../src/guestfs-actions.pod:1566 ../fish/guestfish-actions.pod:1169
6600 msgid "If C<directory> is not a directory, then this command returns an error."
6604 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1172
6605 msgid "The returned list is sorted."
6609 #: ../src/guestfs-actions.pod:1571
6610 msgid "See also C<guestfs_find0>."
6614 #: ../src/guestfs-actions.pod:1580
6615 msgid "guestfs_find0"
6619 #: ../src/guestfs-actions.pod:1582
6623 " guestfs_find0 (guestfs_h *g,\n"
6624 " const char *directory,\n"
6625 " const char *files);\n"
6630 #: ../src/guestfs-actions.pod:1587 ../fish/guestfish-actions.pod:1183
6632 "This command lists out all files and directories, recursively, starting at "
6633 "C<directory>, placing the resulting list in the external file called "
6638 #: ../src/guestfs-actions.pod:1591
6640 "This command works the same way as C<guestfs_find> with the following "
6645 #: ../src/guestfs-actions.pod:1598 ../fish/guestfish-actions.pod:1194
6646 msgid "The resulting list is written to an external file."
6650 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1198
6652 "Items (filenames) in the result are separated by C<\\0> characters. See "
6653 "L<find(1)> option I<-print0>."
6657 #: ../src/guestfs-actions.pod:1607 ../fish/guestfish-actions.pod:1203
6658 msgid "This command is not limited in the number of names that it can return."
6662 #: ../src/guestfs-actions.pod:1612 ../fish/guestfish-actions.pod:1208
6663 msgid "The result list is not sorted."
6667 #: ../src/guestfs-actions.pod:1618
6668 msgid "guestfs_findfs_label"
6672 #: ../src/guestfs-actions.pod:1620
6676 " guestfs_findfs_label (guestfs_h *g,\n"
6677 " const char *label);\n"
6682 #: ../src/guestfs-actions.pod:1624 ../fish/guestfish-actions.pod:1218
6684 "This command searches the filesystems and returns the one which has the "
6685 "given label. An error is returned if no such filesystem can be found."
6689 #: ../src/guestfs-actions.pod:1628
6690 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
6694 #: ../src/guestfs-actions.pod:1633
6695 msgid "guestfs_findfs_uuid"
6699 #: ../src/guestfs-actions.pod:1635
6703 " guestfs_findfs_uuid (guestfs_h *g,\n"
6704 " const char *uuid);\n"
6709 #: ../src/guestfs-actions.pod:1639 ../fish/guestfish-actions.pod:1228
6711 "This command searches the filesystems and returns the one which has the "
6712 "given UUID. An error is returned if no such filesystem can be found."
6716 #: ../src/guestfs-actions.pod:1643
6717 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
6721 #: ../src/guestfs-actions.pod:1648
6722 msgid "guestfs_fsck"
6726 #: ../src/guestfs-actions.pod:1650
6730 " guestfs_fsck (guestfs_h *g,\n"
6731 " const char *fstype,\n"
6732 " const char *device);\n"
6737 #: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1238
6739 "This runs the filesystem checker (fsck) on C<device> which should have "
6740 "filesystem type C<fstype>."
6744 #: ../src/guestfs-actions.pod:1658 ../fish/guestfish-actions.pod:1241
6746 "The returned integer is the status. See L<fsck(8)> for the list of status "
6747 "codes from C<fsck>."
6751 #: ../src/guestfs-actions.pod:1667 ../fish/guestfish-actions.pod:1250
6752 msgid "Multiple status codes can be summed together."
6756 #: ../src/guestfs-actions.pod:1671 ../fish/guestfish-actions.pod:1254
6758 "A non-zero return code can mean \"success\", for example if errors have been "
6759 "corrected on the filesystem."
6763 #: ../src/guestfs-actions.pod:1676 ../fish/guestfish-actions.pod:1259
6764 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
6768 #: ../src/guestfs-actions.pod:1681 ../fish/guestfish-actions.pod:1264
6769 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
6773 #: ../src/guestfs-actions.pod:1685
6774 msgid "guestfs_get_append"
6778 #: ../src/guestfs-actions.pod:1687
6782 " guestfs_get_append (guestfs_h *g);\n"
6787 #: ../src/guestfs-actions.pod:1690 ../fish/guestfish-actions.pod:1270
6789 "Return the additional kernel options which are added to the guest kernel "
6794 #: ../src/guestfs-actions.pod:1693 ../fish/guestfish-actions.pod:1273
6795 msgid "If C<NULL> then no options are added."
6799 #: ../src/guestfs-actions.pod:1695
6801 "This function returns a string which may be NULL. There is no way to return "
6802 "an error from this function. The string is owned by the guest handle and "
6803 "must I<not> be freed."
6807 #: ../src/guestfs-actions.pod:1699
6808 msgid "guestfs_get_autosync"
6812 #: ../src/guestfs-actions.pod:1701
6816 " guestfs_get_autosync (guestfs_h *g);\n"
6821 #: ../src/guestfs-actions.pod:1704 ../fish/guestfish-actions.pod:1279
6822 msgid "Get the autosync flag."
6826 #: ../src/guestfs-actions.pod:1708
6827 msgid "guestfs_get_direct"
6831 #: ../src/guestfs-actions.pod:1710
6835 " guestfs_get_direct (guestfs_h *g);\n"
6840 #: ../src/guestfs-actions.pod:1713 ../fish/guestfish-actions.pod:1285
6841 msgid "Return the direct appliance mode flag."
6845 #: ../src/guestfs-actions.pod:1717
6846 msgid "guestfs_get_e2label"
6850 #: ../src/guestfs-actions.pod:1719
6854 " guestfs_get_e2label (guestfs_h *g,\n"
6855 " const char *device);\n"
6860 #: ../src/guestfs-actions.pod:1723 ../fish/guestfish-actions.pod:1291
6861 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
6865 #: ../src/guestfs-actions.pod:1729 ../fish/guestfish-actions.pod:1294
6867 "This function is deprecated. In new code, use the C<vfs_label> call "
6872 #: ../src/guestfs-actions.pod:1736
6873 msgid "guestfs_get_e2uuid"
6877 #: ../src/guestfs-actions.pod:1738
6881 " guestfs_get_e2uuid (guestfs_h *g,\n"
6882 " const char *device);\n"
6887 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1305
6888 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
6892 #: ../src/guestfs-actions.pod:1748 ../fish/guestfish-actions.pod:1308
6893 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
6897 #: ../src/guestfs-actions.pod:1755
6898 msgid "guestfs_get_memsize"
6902 #: ../src/guestfs-actions.pod:1757
6906 " guestfs_get_memsize (guestfs_h *g);\n"
6911 #: ../src/guestfs-actions.pod:1760 ../fish/guestfish-actions.pod:1319
6912 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
6916 #: ../src/guestfs-actions.pod:1763
6918 "If C<guestfs_set_memsize> was not called on this handle, and if "
6919 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
6920 "value for memsize."
6924 #: ../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
6925 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
6929 #: ../src/guestfs-actions.pod:1772
6930 msgid "guestfs_get_network"
6934 #: ../src/guestfs-actions.pod:1774
6938 " guestfs_get_network (guestfs_h *g);\n"
6943 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1333
6944 msgid "This returns the enable network flag."
6948 #: ../src/guestfs-actions.pod:1781
6949 msgid "guestfs_get_path"
6953 #: ../src/guestfs-actions.pod:1783
6957 " guestfs_get_path (guestfs_h *g);\n"
6962 #: ../src/guestfs-actions.pod:1786 ../fish/guestfish-actions.pod:1339
6963 msgid "Return the current search path."
6967 #: ../src/guestfs-actions.pod:1788 ../fish/guestfish-actions.pod:1341
6969 "This is always non-NULL. If it wasn't set already, then this will return "
6974 #: ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:1816
6976 "This function returns a string, or NULL on error. The string is owned by "
6977 "the guest handle and must I<not> be freed."
6981 #: ../src/guestfs-actions.pod:1794
6982 msgid "guestfs_get_pid"
6986 #: ../src/guestfs-actions.pod:1796
6990 " guestfs_get_pid (guestfs_h *g);\n"
6995 #: ../src/guestfs-actions.pod:1799 ../fish/guestfish-actions.pod:1350
6997 "Return the process ID of the qemu subprocess. If there is no qemu "
6998 "subprocess, then this will return an error."
7002 #: ../src/guestfs-actions.pod:1802 ../fish/guestfish-actions.pod:1353
7003 msgid "This is an internal call used for debugging and testing."
7007 #: ../src/guestfs-actions.pod:1806
7008 msgid "guestfs_get_qemu"
7012 #: ../src/guestfs-actions.pod:1808
7016 " guestfs_get_qemu (guestfs_h *g);\n"
7021 #: ../src/guestfs-actions.pod:1811 ../fish/guestfish-actions.pod:1359
7022 msgid "Return the current qemu binary."
7026 #: ../src/guestfs-actions.pod:1813 ../fish/guestfish-actions.pod:1361
7028 "This is always non-NULL. If it wasn't set already, then this will return "
7029 "the default qemu binary name."
7033 #: ../src/guestfs-actions.pod:1819
7034 msgid "guestfs_get_recovery_proc"
7038 #: ../src/guestfs-actions.pod:1821
7042 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7047 #: ../src/guestfs-actions.pod:1824 ../fish/guestfish-actions.pod:1368
7048 msgid "Return the recovery process enabled flag."
7052 #: ../src/guestfs-actions.pod:1828
7053 msgid "guestfs_get_selinux"
7057 #: ../src/guestfs-actions.pod:1830
7061 " guestfs_get_selinux (guestfs_h *g);\n"
7066 #: ../src/guestfs-actions.pod:1833
7068 "This returns the current setting of the selinux flag which is passed to the "
7069 "appliance at boot time. See C<guestfs_set_selinux>."
7073 #: ../src/guestfs-actions.pod:1841
7074 msgid "guestfs_get_state"
7078 #: ../src/guestfs-actions.pod:1843
7082 " guestfs_get_state (guestfs_h *g);\n"
7087 #: ../src/guestfs-actions.pod:1846 ../fish/guestfish-actions.pod:1384
7089 "This returns the current state as an opaque integer. This is only useful "
7090 "for printing debug and internal error messages."
7094 #: ../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
7095 msgid "For more information on states, see L<guestfs(3)>."
7099 #: ../src/guestfs-actions.pod:1853
7100 msgid "guestfs_get_trace"
7104 #: ../src/guestfs-actions.pod:1855
7108 " guestfs_get_trace (guestfs_h *g);\n"
7113 #: ../src/guestfs-actions.pod:1858 ../fish/guestfish-actions.pod:1393
7114 msgid "Return the command trace flag."
7118 #: ../src/guestfs-actions.pod:1862
7119 msgid "guestfs_get_umask"
7123 #: ../src/guestfs-actions.pod:1864
7127 " guestfs_get_umask (guestfs_h *g);\n"
7132 #: ../src/guestfs-actions.pod:1867
7134 "Return the current umask. By default the umask is C<022> unless it has been "
7135 "set by calling C<guestfs_umask>."
7139 #: ../src/guestfs-actions.pod:1872
7140 msgid "guestfs_get_verbose"
7144 #: ../src/guestfs-actions.pod:1874
7148 " guestfs_get_verbose (guestfs_h *g);\n"
7153 #: ../src/guestfs-actions.pod:1877 ../fish/guestfish-actions.pod:1406
7154 msgid "This returns the verbose messages flag."
7158 #: ../src/guestfs-actions.pod:1881
7159 msgid "guestfs_getcon"
7163 #: ../src/guestfs-actions.pod:1883
7167 " guestfs_getcon (guestfs_h *g);\n"
7172 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1412
7173 msgid "This gets the SELinux security context of the daemon."
7177 #: ../src/guestfs-actions.pod:1888
7178 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
7182 #: ../src/guestfs-actions.pod:1894
7183 msgid "guestfs_getxattrs"
7187 #: ../src/guestfs-actions.pod:1896
7190 " struct guestfs_xattr_list *\n"
7191 " guestfs_getxattrs (guestfs_h *g,\n"
7192 " const char *path);\n"
7197 #: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1421
7198 msgid "This call lists the extended attributes of the file or directory C<path>."
7202 #: ../src/guestfs-actions.pod:1903 ../fish/guestfish-actions.pod:1424
7204 "At the system call level, this is a combination of the L<listxattr(2)> and "
7205 "L<getxattr(2)> calls."
7209 #: ../src/guestfs-actions.pod:1906
7210 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
7214 #: ../src/guestfs-actions.pod:1908 ../src/guestfs-actions.pod:2723 ../src/guestfs-actions.pod:3311
7216 "This function returns a C<struct guestfs_xattr_list *> (see "
7217 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
7218 "must call C<guestfs_free_xattr_list> after use>."
7222 #: ../src/guestfs-actions.pod:1913
7223 msgid "guestfs_glob_expand"
7227 #: ../src/guestfs-actions.pod:1915
7231 " guestfs_glob_expand (guestfs_h *g,\n"
7232 " const char *pattern);\n"
7237 #: ../src/guestfs-actions.pod:1919 ../fish/guestfish-actions.pod:1433
7239 "This command searches for all the pathnames matching C<pattern> according to "
7240 "the wildcard expansion rules used by the shell."
7244 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1437
7245 msgid "If no paths match, then this returns an empty list (note: not an error)."
7249 #: ../src/guestfs-actions.pod:1926 ../fish/guestfish-actions.pod:1440
7251 "It is just a wrapper around the C L<glob(3)> function with flags "
7252 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
7256 #: ../src/guestfs-actions.pod:1934
7257 msgid "guestfs_grep"
7261 #: ../src/guestfs-actions.pod:1936
7265 " guestfs_grep (guestfs_h *g,\n"
7266 " const char *regex,\n"
7267 " const char *path);\n"
7272 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1448
7273 msgid "This calls the external C<grep> program and returns the matching lines."
7277 #: ../src/guestfs-actions.pod:1951
7278 msgid "guestfs_grepi"
7282 #: ../src/guestfs-actions.pod:1953
7286 " guestfs_grepi (guestfs_h *g,\n"
7287 " const char *regex,\n"
7288 " const char *path);\n"
7293 #: ../src/guestfs-actions.pod:1958 ../fish/guestfish-actions.pod:1458
7294 msgid "This calls the external C<grep -i> program and returns the matching lines."
7298 #: ../src/guestfs-actions.pod:1968
7299 msgid "guestfs_grub_install"
7303 #: ../src/guestfs-actions.pod:1970
7307 " guestfs_grub_install (guestfs_h *g,\n"
7308 " const char *root,\n"
7309 " const char *device);\n"
7314 #: ../src/guestfs-actions.pod:1975 ../fish/guestfish-actions.pod:1468
7316 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
7317 "the root directory being C<root>."
7321 #: ../src/guestfs-actions.pod:1978 ../fish/guestfish-actions.pod:1471
7323 "Note: If grub-install reports the error \"No suitable drive was found in the "
7324 "generated device map.\" it may be that you need to create a "
7325 "C</boot/grub/device.map> file first that contains the mapping between grub "
7326 "device names and Linux device names. It is usually sufficient to create a "
7331 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1478
7339 #: ../src/guestfs-actions.pod:1987 ../fish/guestfish-actions.pod:1480
7340 msgid "replacing C</dev/vda> with the name of the installation device."
7344 #: ../src/guestfs-actions.pod:1991
7345 msgid "guestfs_head"
7349 #: ../src/guestfs-actions.pod:1993
7353 " guestfs_head (guestfs_h *g,\n"
7354 " const char *path);\n"
7359 #: ../src/guestfs-actions.pod:1997 ../fish/guestfish-actions.pod:1486
7361 "This command returns up to the first 10 lines of a file as a list of "
7366 #: ../src/guestfs-actions.pod:2007
7367 msgid "guestfs_head_n"
7371 #: ../src/guestfs-actions.pod:2009
7375 " guestfs_head_n (guestfs_h *g,\n"
7377 " const char *path);\n"
7382 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1496
7384 "If the parameter C<nrlines> is a positive number, this returns the first "
7385 "C<nrlines> lines of the file C<path>."
7389 #: ../src/guestfs-actions.pod:2017 ../fish/guestfish-actions.pod:1499
7391 "If the parameter C<nrlines> is a negative number, this returns lines from "
7392 "the file C<path>, excluding the last C<nrlines> lines."
7396 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5340 ../fish/guestfish-actions.pod:1502 ../fish/guestfish-actions.pod:3917
7397 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7401 #: ../src/guestfs-actions.pod:2029
7402 msgid "guestfs_hexdump"
7406 #: ../src/guestfs-actions.pod:2031
7410 " guestfs_hexdump (guestfs_h *g,\n"
7411 " const char *path);\n"
7416 #: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1511
7418 "This runs C<hexdump -C> on the given C<path>. The result is the "
7419 "human-readable, canonical hex dump of the file."
7423 #: ../src/guestfs-actions.pod:2044
7424 msgid "guestfs_initrd_cat"
7428 #: ../src/guestfs-actions.pod:2046
7432 " guestfs_initrd_cat (guestfs_h *g,\n"
7433 " const char *initrdpath,\n"
7434 " const char *filename,\n"
7435 " size_t *size_r);\n"
7440 #: ../src/guestfs-actions.pod:2052 ../fish/guestfish-actions.pod:1521
7442 "This command unpacks the file C<filename> from the initrd file called "
7443 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7448 #: ../src/guestfs-actions.pod:2056 ../fish/guestfish-actions.pod:1525
7450 "For example, in guestfish you could use the following command to examine the "
7451 "boot script (usually called C</init>) contained in a Linux initrd or "
7456 #: ../src/guestfs-actions.pod:2060 ../fish/guestfish-actions.pod:1529
7459 " initrd-cat /boot/initrd-<version>.img init\n"
7464 #: ../src/guestfs-actions.pod:2062
7465 msgid "See also C<guestfs_initrd_list>."
7469 #: ../src/guestfs-actions.pod:2064 ../src/guestfs-actions.pod:4187 ../src/guestfs-actions.pod:4211 ../src/guestfs-actions.pod:4373
7471 "This function returns a buffer, or NULL on error. The size of the returned "
7472 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
7477 #: ../src/guestfs-actions.pod:2071
7478 msgid "guestfs_initrd_list"
7482 #: ../src/guestfs-actions.pod:2073
7486 " guestfs_initrd_list (guestfs_h *g,\n"
7487 " const char *path);\n"
7492 #: ../src/guestfs-actions.pod:2077 ../fish/guestfish-actions.pod:1540
7493 msgid "This command lists out files contained in an initrd."
7497 #: ../src/guestfs-actions.pod:2079 ../fish/guestfish-actions.pod:1542
7499 "The files are listed without any initial C</> character. The files are "
7500 "listed in the order they appear (not necessarily alphabetical). Directory "
7501 "names are listed as separate items."
7505 #: ../src/guestfs-actions.pod:2083 ../fish/guestfish-actions.pod:1546
7507 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
7508 "initrd. We I<only> support the newer initramfs format (compressed cpio "
7513 #: ../src/guestfs-actions.pod:2091
7514 msgid "guestfs_inotify_add_watch"
7518 #: ../src/guestfs-actions.pod:2093
7522 " guestfs_inotify_add_watch (guestfs_h *g,\n"
7523 " const char *path,\n"
7529 #: ../src/guestfs-actions.pod:2098 ../fish/guestfish-actions.pod:1554
7530 msgid "Watch C<path> for the events listed in C<mask>."
7534 #: ../src/guestfs-actions.pod:2100 ../fish/guestfish-actions.pod:1556
7536 "Note that if C<path> is a directory then events within that directory are "
7537 "watched, but this does I<not> happen recursively (in subdirectories)."
7541 #: ../src/guestfs-actions.pod:2104 ../fish/guestfish-actions.pod:1560
7543 "Note for non-C or non-Linux callers: the inotify events are defined by the "
7544 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
7548 #: ../src/guestfs-actions.pod:2110
7549 msgid "guestfs_inotify_close"
7553 #: ../src/guestfs-actions.pod:2112
7557 " guestfs_inotify_close (guestfs_h *g);\n"
7562 #: ../src/guestfs-actions.pod:2115 ../fish/guestfish-actions.pod:1568
7564 "This closes the inotify handle which was previously opened by inotify_init. "
7565 "It removes all watches, throws away any pending events, and deallocates all "
7570 #: ../src/guestfs-actions.pod:2121
7571 msgid "guestfs_inotify_files"
7575 #: ../src/guestfs-actions.pod:2123
7579 " guestfs_inotify_files (guestfs_h *g);\n"
7584 #: ../src/guestfs-actions.pod:2126
7586 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
7587 "returns a list of pathnames of objects that were touched. The returned "
7588 "pathnames are sorted and deduplicated."
7592 #: ../src/guestfs-actions.pod:2134
7593 msgid "guestfs_inotify_init"
7597 #: ../src/guestfs-actions.pod:2136
7601 " guestfs_inotify_init (guestfs_h *g,\n"
7602 " int maxevents);\n"
7607 #: ../src/guestfs-actions.pod:2140 ../fish/guestfish-actions.pod:1584
7609 "This command creates a new inotify handle. The inotify subsystem can be "
7610 "used to notify events which happen to objects in the guest filesystem."
7614 #: ../src/guestfs-actions.pod:2144
7616 "C<maxevents> is the maximum number of events which will be queued up between "
7617 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
7618 "passed as C<0>, then the kernel (or previously set) default is used. For "
7619 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
7620 "throws away events, but records the fact that it threw them away by setting "
7621 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
7622 "C<guestfs_inotify_read>)."
7626 #: ../src/guestfs-actions.pod:2154
7628 "Before any events are generated, you have to add some watches to the "
7629 "internal watch list. See: C<guestfs_inotify_add_watch>, "
7630 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
7634 #: ../src/guestfs-actions.pod:2160
7636 "Queued up events should be read periodically by calling "
7637 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
7638 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
7639 "often enough then you risk the internal queue overflowing."
7643 #: ../src/guestfs-actions.pod:2167
7645 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
7646 "This also removes any watches automatically."
7650 #: ../src/guestfs-actions.pod:2171 ../fish/guestfish-actions.pod:1615
7652 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
7653 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
7654 "that there is one global inotify handle per libguestfs instance."
7658 #: ../src/guestfs-actions.pod:2178
7659 msgid "guestfs_inotify_read"
7663 #: ../src/guestfs-actions.pod:2180
7666 " struct guestfs_inotify_event_list *\n"
7667 " guestfs_inotify_read (guestfs_h *g);\n"
7672 #: ../src/guestfs-actions.pod:2183 ../fish/guestfish-actions.pod:1624
7674 "Return the complete queue of events that have happened since the previous "
7679 #: ../src/guestfs-actions.pod:2186 ../fish/guestfish-actions.pod:1627
7680 msgid "If no events have happened, this returns an empty list."
7684 #: ../src/guestfs-actions.pod:2188 ../fish/guestfish-actions.pod:1629
7686 "I<Note>: In order to make sure that all events have been read, you must call "
7687 "this function repeatedly until it returns an empty list. The reason is that "
7688 "the call will read events up to the maximum appliance-to-host message size "
7689 "and leave remaining events in the queue."
7693 #: ../src/guestfs-actions.pod:2194
7695 "This function returns a C<struct guestfs_inotify_event_list *> (see "
7696 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
7697 "must call C<guestfs_free_inotify_event_list> after use>."
7701 #: ../src/guestfs-actions.pod:2199
7702 msgid "guestfs_inotify_rm_watch"
7706 #: ../src/guestfs-actions.pod:2201
7710 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
7716 #: ../src/guestfs-actions.pod:2205
7718 "Remove a previously defined inotify watch. See "
7719 "C<guestfs_inotify_add_watch>."
7723 #: ../src/guestfs-actions.pod:2210
7724 msgid "guestfs_inspect_get_arch"
7728 #: ../src/guestfs-actions.pod:2212
7732 " guestfs_inspect_get_arch (guestfs_h *g,\n"
7733 " const char *root);\n"
7738 #: ../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
7740 "This function should only be called with a root device string as returned by "
7741 "C<guestfs_inspect_os>."
7745 #: ../src/guestfs-actions.pod:2219
7747 "This returns the architecture of the inspected operating system. The "
7748 "possible return values are listed under C<guestfs_file_architecture>."
7752 #: ../src/guestfs-actions.pod:2223 ../fish/guestfish-actions.pod:1653
7754 "If the architecture could not be determined, then the string C<unknown> is "
7759 #: ../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
7760 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
7764 #: ../src/guestfs-actions.pod:2231
7765 msgid "guestfs_inspect_get_distro"
7769 #: ../src/guestfs-actions.pod:2233
7773 " guestfs_inspect_get_distro (guestfs_h *g,\n"
7774 " const char *root);\n"
7779 #: ../src/guestfs-actions.pod:2240 ../fish/guestfish-actions.pod:1665
7780 msgid "This returns the distro (distribution) of the inspected operating system."
7784 #: ../src/guestfs-actions.pod:2243 ../fish/guestfish-actions.pod:1668
7785 msgid "Currently defined distros are:"
7789 #: ../src/guestfs-actions.pod:2247 ../fish/guestfish-actions.pod:1672
7790 msgid "\"archlinux\""
7794 #: ../src/guestfs-actions.pod:2249 ../fish/guestfish-actions.pod:1674
7799 #: ../src/guestfs-actions.pod:2251 ../fish/guestfish-actions.pod:1676
7804 #: ../src/guestfs-actions.pod:2253 ../fish/guestfish-actions.pod:1678
7805 msgid "Debian or a Debian-derived distro such as Ubuntu."
7809 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1680
7814 #: ../src/guestfs-actions.pod:2257 ../fish/guestfish-actions.pod:1682
7819 #: ../src/guestfs-actions.pod:2259 ../fish/guestfish-actions.pod:1684
7824 #: ../src/guestfs-actions.pod:2261 ../fish/guestfish-actions.pod:1686
7829 #: ../src/guestfs-actions.pod:2263 ../fish/guestfish-actions.pod:1688
7834 #: ../src/guestfs-actions.pod:2265 ../fish/guestfish-actions.pod:1690
7839 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1692
7844 #: ../src/guestfs-actions.pod:2269 ../fish/guestfish-actions.pod:1694
7849 #: ../src/guestfs-actions.pod:2271 ../fish/guestfish-actions.pod:1696
7850 msgid "\"redhat-based\""
7854 #: ../src/guestfs-actions.pod:2273 ../fish/guestfish-actions.pod:1698
7855 msgid "Some Red Hat-derived distro."
7859 #: ../src/guestfs-actions.pod:2275 ../fish/guestfish-actions.pod:1700
7864 #: ../src/guestfs-actions.pod:2277 ../fish/guestfish-actions.pod:1702
7865 msgid "Red Hat Enterprise Linux and some derivatives."
7869 #: ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2441 ../fish/guestfish-actions.pod:1704 ../fish/guestfish-actions.pod:1834
7874 #: ../src/guestfs-actions.pod:2281 ../fish/guestfish-actions.pod:1706
7876 "Windows does not have distributions. This string is returned if the OS type "
7881 #: ../src/guestfs-actions.pod:2284 ../fish/guestfish-actions.pod:1709
7886 #: ../src/guestfs-actions.pod:2286 ../fish/guestfish-actions.pod:1711
7891 #: ../src/guestfs-actions.pod:2288 ../src/guestfs-actions.pod:2445 ../fish/guestfish-actions.pod:1713 ../fish/guestfish-actions.pod:1838
7896 #: ../src/guestfs-actions.pod:2290 ../fish/guestfish-actions.pod:1715
7897 msgid "The distro could not be determined."
7901 #: ../src/guestfs-actions.pod:2294 ../src/guestfs-actions.pod:2451 ../fish/guestfish-actions.pod:1719 ../fish/guestfish-actions.pod:1844
7903 "Future versions of libguestfs may return other strings here. The caller "
7904 "should be prepared to handle any string."
7908 #: ../src/guestfs-actions.pod:2302
7909 msgid "guestfs_inspect_get_filesystems"
7913 #: ../src/guestfs-actions.pod:2304
7917 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
7918 " const char *root);\n"
7923 #: ../src/guestfs-actions.pod:2311 ../fish/guestfish-actions.pod:1731
7925 "This returns a list of all the filesystems that we think are associated with "
7926 "this operating system. This includes the root filesystem, other ordinary "
7927 "filesystems, and non-mounted devices like swap partitions."
7931 #: ../src/guestfs-actions.pod:2316 ../fish/guestfish-actions.pod:1736
7933 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
7934 "to be shared between operating systems."
7938 #: ../src/guestfs-actions.pod:2319
7940 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7941 "C<guestfs_inspect_get_mountpoints>."
7945 #: ../src/guestfs-actions.pod:2326
7946 msgid "guestfs_inspect_get_major_version"
7950 #: ../src/guestfs-actions.pod:2328
7954 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
7955 " const char *root);\n"
7960 #: ../src/guestfs-actions.pod:2335 ../fish/guestfish-actions.pod:1749
7961 msgid "This returns the major version number of the inspected operating system."
7965 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1752
7967 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
7968 "popular public names used by the operating system. Notably the operating "
7969 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
7970 "1). You can find out the real versions corresponding to releases of Windows "
7971 "by consulting Wikipedia or MSDN."
7975 #: ../src/guestfs-actions.pod:2345 ../src/guestfs-actions.pod:2363 ../fish/guestfish-actions.pod:1759 ../fish/guestfish-actions.pod:1773
7976 msgid "If the version could not be determined, then C<0> is returned."
7980 #: ../src/guestfs-actions.pod:2351
7981 msgid "guestfs_inspect_get_minor_version"
7985 #: ../src/guestfs-actions.pod:2353
7989 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
7990 " const char *root);\n"
7995 #: ../src/guestfs-actions.pod:2360 ../fish/guestfish-actions.pod:1770
7996 msgid "This returns the minor version number of the inspected operating system."
8000 #: ../src/guestfs-actions.pod:2365
8002 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8003 "C<guestfs_inspect_get_major_version>."
8007 #: ../src/guestfs-actions.pod:2370
8008 msgid "guestfs_inspect_get_mountpoints"
8012 #: ../src/guestfs-actions.pod:2372
8016 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
8017 " const char *root);\n"
8022 #: ../src/guestfs-actions.pod:2379 ../fish/guestfish-actions.pod:1785
8024 "This returns a hash of where we think the filesystems associated with this "
8025 "operating system should be mounted. Callers should note that this is at "
8026 "best an educated guess made by reading configuration files such as "
8031 #: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1790
8033 "Each element in the returned hashtable has a key which is the path of the "
8034 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8035 "mounted there (eg. C</dev/sda1>)."
8039 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1795
8040 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
8044 #: ../src/guestfs-actions.pod:2392
8046 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8047 "C<guestfs_inspect_get_filesystems>."
8051 #: ../src/guestfs-actions.pod:2395 ../src/guestfs-actions.pod:2777 ../src/guestfs-actions.pod:3790 ../src/guestfs-actions.pod:5465
8053 "This function returns a NULL-terminated array of strings, or NULL if there "
8054 "was an error. The array of strings will always have length C<2n+1>, where "
8055 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
8056 "caller must free the strings and the array after use>."
8060 #: ../src/guestfs-actions.pod:2401
8061 msgid "guestfs_inspect_get_product_name"
8065 #: ../src/guestfs-actions.pod:2403
8069 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
8070 " const char *root);\n"
8075 #: ../src/guestfs-actions.pod:2410 ../fish/guestfish-actions.pod:1808
8077 "This returns the product name of the inspected operating system. The "
8078 "product name is generally some freeform string which can be displayed to the "
8079 "user, but should not be parsed by programs."
8083 #: ../src/guestfs-actions.pod:2415 ../fish/guestfish-actions.pod:1813
8085 "If the product name could not be determined, then the string C<unknown> is "
8090 #: ../src/guestfs-actions.pod:2423
8091 msgid "guestfs_inspect_get_type"
8095 #: ../src/guestfs-actions.pod:2425
8099 " guestfs_inspect_get_type (guestfs_h *g,\n"
8100 " const char *root);\n"
8105 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1825
8107 "This returns the type of the inspected operating system. Currently defined "
8112 #: ../src/guestfs-actions.pod:2437 ../fish/guestfish-actions.pod:1830
8117 #: ../src/guestfs-actions.pod:2439 ../fish/guestfish-actions.pod:1832
8118 msgid "Any Linux-based operating system."
8122 #: ../src/guestfs-actions.pod:2443 ../fish/guestfish-actions.pod:1836
8123 msgid "Any Microsoft Windows operating system."
8127 #: ../src/guestfs-actions.pod:2447 ../fish/guestfish-actions.pod:1840
8128 msgid "The operating system type could not be determined."
8132 #: ../src/guestfs-actions.pod:2459
8133 msgid "guestfs_inspect_get_windows_systemroot"
8137 #: ../src/guestfs-actions.pod:2461
8141 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
8142 " const char *root);\n"
8147 #: ../src/guestfs-actions.pod:2468 ../fish/guestfish-actions.pod:1856
8149 "This returns the Windows systemroot of the inspected guest. The systemroot "
8150 "is a directory path such as C</WINDOWS>."
8154 #: ../src/guestfs-actions.pod:2471 ../fish/guestfish-actions.pod:1859
8156 "This call assumes that the guest is Windows and that the systemroot could be "
8157 "determined by inspection. If this is not the case then an error is "
8162 #: ../src/guestfs-actions.pod:2480
8163 msgid "guestfs_inspect_os"
8167 #: ../src/guestfs-actions.pod:2482
8171 " guestfs_inspect_os (guestfs_h *g);\n"
8176 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1869
8178 "This function uses other libguestfs functions and certain heuristics to "
8179 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
8180 "for operating systems."
8184 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1873
8185 msgid "The list returned is empty if no operating systems were found."
8189 #: ../src/guestfs-actions.pod:2491 ../fish/guestfish-actions.pod:1875
8191 "If one operating system was found, then this returns a list with a single "
8192 "element, which is the name of the root filesystem of this operating system. "
8193 "It is also possible for this function to return a list containing more than "
8194 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
8195 "element being the root filesystem of one of the operating systems."
8199 #: ../src/guestfs-actions.pod:2498
8201 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
8202 "functions in order to query further information about each operating system, "
8203 "such as the name and version."
8207 #: ../src/guestfs-actions.pod:2503
8209 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
8210 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
8211 "the contents. This should be called with no disks currently mounted. The "
8212 "function may also use Augeas, so any existing Augeas handle will be closed."
8216 #: ../src/guestfs-actions.pod:2509 ../fish/guestfish-actions.pod:1893
8218 "This function cannot decrypt encrypted disks. The caller must do that first "
8219 "(supplying the necessary keys) if the disk is encrypted."
8223 #: ../src/guestfs-actions.pod:2515 ../src/guestfs-actions.pod:2737 ../src/guestfs-actions.pod:2795
8224 msgid "See also C<guestfs_list_filesystems>."
8228 #: ../src/guestfs-actions.pod:2521
8229 msgid "guestfs_is_blockdev"
8233 #: ../src/guestfs-actions.pod:2523
8237 " guestfs_is_blockdev (guestfs_h *g,\n"
8238 " const char *path);\n"
8243 #: ../src/guestfs-actions.pod:2527 ../fish/guestfish-actions.pod:1905
8245 "This returns C<true> if and only if there is a block device with the given "
8250 #: ../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
8251 msgid "See also C<guestfs_stat>."
8255 #: ../src/guestfs-actions.pod:2534
8256 msgid "guestfs_is_busy"
8260 #: ../src/guestfs-actions.pod:2536
8264 " guestfs_is_busy (guestfs_h *g);\n"
8269 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1914
8271 "This returns true iff this handle is busy processing a command (in the "
8276 #: ../src/guestfs-actions.pod:2546
8277 msgid "guestfs_is_chardev"
8281 #: ../src/guestfs-actions.pod:2548
8285 " guestfs_is_chardev (guestfs_h *g,\n"
8286 " const char *path);\n"
8291 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1923
8293 "This returns C<true> if and only if there is a character device with the "
8294 "given C<path> name."
8298 #: ../src/guestfs-actions.pod:2559
8299 msgid "guestfs_is_config"
8303 #: ../src/guestfs-actions.pod:2561
8307 " guestfs_is_config (guestfs_h *g);\n"
8312 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1932
8314 "This returns true iff this handle is being configured (in the C<CONFIG> "
8319 #: ../src/guestfs-actions.pod:2571
8320 msgid "guestfs_is_dir"
8324 #: ../src/guestfs-actions.pod:2573
8328 " guestfs_is_dir (guestfs_h *g,\n"
8329 " const char *path);\n"
8334 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1941
8336 "This returns C<true> if and only if there is a directory with the given "
8337 "C<path> name. Note that it returns false for other objects like files."
8341 #: ../src/guestfs-actions.pod:2585
8342 msgid "guestfs_is_fifo"
8346 #: ../src/guestfs-actions.pod:2587
8350 " guestfs_is_fifo (guestfs_h *g,\n"
8351 " const char *path);\n"
8356 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1951
8358 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
8359 "given C<path> name."
8363 #: ../src/guestfs-actions.pod:2598
8364 msgid "guestfs_is_file"
8368 #: ../src/guestfs-actions.pod:2600
8372 " guestfs_is_file (guestfs_h *g,\n"
8373 " const char *path);\n"
8378 #: ../src/guestfs-actions.pod:2604 ../fish/guestfish-actions.pod:1960
8380 "This returns C<true> if and only if there is a regular file with the given "
8381 "C<path> name. Note that it returns false for other objects like "
8386 #: ../src/guestfs-actions.pod:2612
8387 msgid "guestfs_is_launching"
8391 #: ../src/guestfs-actions.pod:2614
8395 " guestfs_is_launching (guestfs_h *g);\n"
8400 #: ../src/guestfs-actions.pod:2617 ../fish/guestfish-actions.pod:1970
8402 "This returns true iff this handle is launching the subprocess (in the "
8403 "C<LAUNCHING> state)."
8407 #: ../src/guestfs-actions.pod:2624
8408 msgid "guestfs_is_lv"
8412 #: ../src/guestfs-actions.pod:2626
8416 " guestfs_is_lv (guestfs_h *g,\n"
8417 " const char *device);\n"
8422 #: ../src/guestfs-actions.pod:2630 ../fish/guestfish-actions.pod:1979
8424 "This command tests whether C<device> is a logical volume, and returns true "
8425 "iff this is the case."
8429 #: ../src/guestfs-actions.pod:2635
8430 msgid "guestfs_is_ready"
8434 #: ../src/guestfs-actions.pod:2637
8438 " guestfs_is_ready (guestfs_h *g);\n"
8443 #: ../src/guestfs-actions.pod:2640 ../fish/guestfish-actions.pod:1986
8445 "This returns true iff this handle is ready to accept commands (in the "
8450 #: ../src/guestfs-actions.pod:2647
8451 msgid "guestfs_is_socket"
8455 #: ../src/guestfs-actions.pod:2649
8459 " guestfs_is_socket (guestfs_h *g,\n"
8460 " const char *path);\n"
8465 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1995
8467 "This returns C<true> if and only if there is a Unix domain socket with the "
8468 "given C<path> name."
8472 #: ../src/guestfs-actions.pod:2660
8473 msgid "guestfs_is_symlink"
8477 #: ../src/guestfs-actions.pod:2662
8481 " guestfs_is_symlink (guestfs_h *g,\n"
8482 " const char *path);\n"
8487 #: ../src/guestfs-actions.pod:2666 ../fish/guestfish-actions.pod:2004
8489 "This returns C<true> if and only if there is a symbolic link with the given "
8494 #: ../src/guestfs-actions.pod:2673
8495 msgid "guestfs_kill_subprocess"
8499 #: ../src/guestfs-actions.pod:2675
8503 " guestfs_kill_subprocess (guestfs_h *g);\n"
8508 #: ../src/guestfs-actions.pod:2678 ../fish/guestfish-actions.pod:2013
8509 msgid "This kills the qemu subprocess. You should never need to call this."
8513 #: ../src/guestfs-actions.pod:2682
8514 msgid "guestfs_launch"
8518 #: ../src/guestfs-actions.pod:2684
8522 " guestfs_launch (guestfs_h *g);\n"
8527 #: ../src/guestfs-actions.pod:2687 ../fish/guestfish-actions.pod:2021
8529 "Internally libguestfs is implemented by running a virtual machine using "
8534 #: ../src/guestfs-actions.pod:2690 ../fish/guestfish-actions.pod:2024
8536 "You should call this after configuring the handle (eg. adding drives) but "
8537 "before performing any actions."
8541 #: ../src/guestfs-actions.pod:2695
8542 msgid "guestfs_lchown"
8546 #: ../src/guestfs-actions.pod:2697
8550 " guestfs_lchown (guestfs_h *g,\n"
8553 " const char *path);\n"
8558 #: ../src/guestfs-actions.pod:2703
8560 "Change the file owner to C<owner> and group to C<group>. This is like "
8561 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
8562 "changed, not the target."
8566 #: ../src/guestfs-actions.pod:2713
8567 msgid "guestfs_lgetxattrs"
8571 #: ../src/guestfs-actions.pod:2715
8574 " struct guestfs_xattr_list *\n"
8575 " guestfs_lgetxattrs (guestfs_h *g,\n"
8576 " const char *path);\n"
8581 #: ../src/guestfs-actions.pod:2719
8583 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
8584 "then it returns the extended attributes of the link itself."
8588 #: ../src/guestfs-actions.pod:2728
8589 msgid "guestfs_list_devices"
8593 #: ../src/guestfs-actions.pod:2730
8597 " guestfs_list_devices (guestfs_h *g);\n"
8602 #: ../src/guestfs-actions.pod:2733 ../fish/guestfish-actions.pod:2051
8603 msgid "List all the block devices."
8607 #: ../src/guestfs-actions.pod:2735 ../fish/guestfish-actions.pod:2053
8608 msgid "The full block device names are returned, eg. C</dev/sda>."
8612 #: ../src/guestfs-actions.pod:2743
8613 msgid "guestfs_list_filesystems"
8617 #: ../src/guestfs-actions.pod:2745
8621 " guestfs_list_filesystems (guestfs_h *g);\n"
8626 #: ../src/guestfs-actions.pod:2748 ../fish/guestfish-actions.pod:2061
8628 "This inspection command looks for filesystems on partitions, block devices "
8629 "and logical volumes, returning a list of devices containing filesystems and "
8634 #: ../src/guestfs-actions.pod:2752 ../fish/guestfish-actions.pod:2065
8636 "The return value is a hash, where the keys are the devices containing "
8637 "filesystems, and the values are the filesystem types. For example:"
8641 #: ../src/guestfs-actions.pod:2756 ../fish/guestfish-actions.pod:2069
8644 " \"/dev/sda1\" => \"ntfs\"\n"
8645 " \"/dev/sda2\" => \"ext2\"\n"
8646 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
8647 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
8652 #: ../src/guestfs-actions.pod:2761 ../fish/guestfish-actions.pod:2074
8654 "The value can have the special value \"unknown\", meaning the content of the "
8655 "device is undetermined or empty. \"swap\" means a Linux swap partition."
8659 #: ../src/guestfs-actions.pod:2765
8661 "This command runs other libguestfs commands, which might include "
8662 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
8663 "soon after launch and only when nothing is mounted."
8667 #: ../src/guestfs-actions.pod:2769
8669 "Not all of the filesystems returned will be mountable. In particular, swap "
8670 "partitions are returned in the list. Also this command does not check that "
8671 "each filesystem found is valid and mountable, and some filesystems might be "
8672 "mountable but require special options. Filesystems may not all belong to a "
8673 "single logical operating system (use C<guestfs_inspect_os> to look for "
8678 #: ../src/guestfs-actions.pod:2783
8679 msgid "guestfs_list_partitions"
8683 #: ../src/guestfs-actions.pod:2785
8687 " guestfs_list_partitions (guestfs_h *g);\n"
8692 #: ../src/guestfs-actions.pod:2788 ../fish/guestfish-actions.pod:2094
8693 msgid "List all the partitions detected on all block devices."
8697 #: ../src/guestfs-actions.pod:2790 ../fish/guestfish-actions.pod:2096
8698 msgid "The full partition device names are returned, eg. C</dev/sda1>"
8702 #: ../src/guestfs-actions.pod:2792
8704 "This does not return logical volumes. For that you will need to call "
8709 #: ../src/guestfs-actions.pod:2801
8714 #: ../src/guestfs-actions.pod:2803
8718 " guestfs_ll (guestfs_h *g,\n"
8719 " const char *directory);\n"
8724 #: ../src/guestfs-actions.pod:2807 ../fish/guestfish-actions.pod:2107
8726 "List the files in C<directory> (relative to the root directory, there is no "
8727 "cwd) in the format of 'ls -la'."
8731 #: ../src/guestfs-actions.pod:2810 ../fish/guestfish-actions.pod:2110
8733 "This command is mostly useful for interactive sessions. It is I<not> "
8734 "intended that you try to parse the output string."
8738 #: ../src/guestfs-actions.pod:2816
8743 #: ../src/guestfs-actions.pod:2818
8747 " guestfs_ln (guestfs_h *g,\n"
8748 " const char *target,\n"
8749 " const char *linkname);\n"
8754 #: ../src/guestfs-actions.pod:2823 ../fish/guestfish-actions.pod:2117
8755 msgid "This command creates a hard link using the C<ln> command."
8759 #: ../src/guestfs-actions.pod:2827
8760 msgid "guestfs_ln_f"
8764 #: ../src/guestfs-actions.pod:2829
8768 " guestfs_ln_f (guestfs_h *g,\n"
8769 " const char *target,\n"
8770 " const char *linkname);\n"
8775 #: ../src/guestfs-actions.pod:2834 ../fish/guestfish-actions.pod:2123
8777 "This command creates a hard link using the C<ln -f> command. The C<-f> "
8778 "option removes the link (C<linkname>) if it exists already."
8782 #: ../src/guestfs-actions.pod:2839
8783 msgid "guestfs_ln_s"
8787 #: ../src/guestfs-actions.pod:2841
8791 " guestfs_ln_s (guestfs_h *g,\n"
8792 " const char *target,\n"
8793 " const char *linkname);\n"
8798 #: ../src/guestfs-actions.pod:2846 ../fish/guestfish-actions.pod:2130
8799 msgid "This command creates a symbolic link using the C<ln -s> command."
8803 #: ../src/guestfs-actions.pod:2850
8804 msgid "guestfs_ln_sf"
8808 #: ../src/guestfs-actions.pod:2852
8812 " guestfs_ln_sf (guestfs_h *g,\n"
8813 " const char *target,\n"
8814 " const char *linkname);\n"
8819 #: ../src/guestfs-actions.pod:2857 ../fish/guestfish-actions.pod:2136
8821 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
8822 "option removes the link (C<linkname>) if it exists already."
8826 #: ../src/guestfs-actions.pod:2862
8827 msgid "guestfs_lremovexattr"
8831 #: ../src/guestfs-actions.pod:2864
8835 " guestfs_lremovexattr (guestfs_h *g,\n"
8836 " const char *xattr,\n"
8837 " const char *path);\n"
8842 #: ../src/guestfs-actions.pod:2869
8844 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
8845 "link, then it removes an extended attribute of the link itself."
8849 #: ../src/guestfs-actions.pod:2875
8854 #: ../src/guestfs-actions.pod:2877
8858 " guestfs_ls (guestfs_h *g,\n"
8859 " const char *directory);\n"
8864 #: ../src/guestfs-actions.pod:2881 ../fish/guestfish-actions.pod:2151
8866 "List the files in C<directory> (relative to the root directory, there is no "
8867 "cwd). The '.' and '..' entries are not returned, but hidden files are "
8872 #: ../src/guestfs-actions.pod:2885
8874 "This command is mostly useful for interactive sessions. Programs should "
8875 "probably use C<guestfs_readdir> instead."
8879 #: ../src/guestfs-actions.pod:2892
8880 msgid "guestfs_lsetxattr"
8884 #: ../src/guestfs-actions.pod:2894
8888 " guestfs_lsetxattr (guestfs_h *g,\n"
8889 " const char *xattr,\n"
8890 " const char *val,\n"
8892 " const char *path);\n"
8897 #: ../src/guestfs-actions.pod:2901
8899 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
8900 "then it sets an extended attribute of the link itself."
8904 #: ../src/guestfs-actions.pod:2907
8905 msgid "guestfs_lstat"
8909 #: ../src/guestfs-actions.pod:2909
8912 " struct guestfs_stat *\n"
8913 " guestfs_lstat (guestfs_h *g,\n"
8914 " const char *path);\n"
8919 #: ../src/guestfs-actions.pod:2913 ../src/guestfs-actions.pod:5108 ../fish/guestfish-actions.pod:2170 ../fish/guestfish-actions.pod:3752
8920 msgid "Returns file information for the given C<path>."
8924 #: ../src/guestfs-actions.pod:2915
8926 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
8927 "link, then the link is stat-ed, not the file it refers to."
8931 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2176
8932 msgid "This is the same as the C<lstat(2)> system call."
8936 #: ../src/guestfs-actions.pod:2921 ../src/guestfs-actions.pod:5112
8938 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
8939 "error. I<The caller must call C<guestfs_free_stat> after use>."
8943 #: ../src/guestfs-actions.pod:2925
8944 msgid "guestfs_lstatlist"
8948 #: ../src/guestfs-actions.pod:2927
8951 " struct guestfs_stat_list *\n"
8952 " guestfs_lstatlist (guestfs_h *g,\n"
8953 " const char *path,\n"
8954 " char *const *names);\n"
8959 #: ../src/guestfs-actions.pod:2932
8961 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
8962 "files, where all files are in the directory C<path>. C<names> is the list "
8963 "of files from this directory."
8967 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2186
8969 "On return you get a list of stat structs, with a one-to-one correspondence "
8970 "to the C<names> list. If any name did not exist or could not be lstat'd, "
8971 "then the C<ino> field of that structure is set to C<-1>."
8975 #: ../src/guestfs-actions.pod:2941
8977 "This call is intended for programs that want to efficiently list a directory "
8978 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
8979 "for a similarly efficient call for getting extended attributes. Very long "
8980 "directory listings might cause the protocol message size to be exceeded, "
8981 "causing this call to fail. The caller must split up such requests into "
8982 "smaller groups of names."
8986 #: ../src/guestfs-actions.pod:2949
8988 "This function returns a C<struct guestfs_stat_list *> (see "
8989 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
8990 "must call C<guestfs_free_stat_list> after use>."
8994 #: ../src/guestfs-actions.pod:2954
8995 msgid "guestfs_luks_add_key"
8999 #: ../src/guestfs-actions.pod:2956
9003 " guestfs_luks_add_key (guestfs_h *g,\n"
9004 " const char *device,\n"
9005 " const char *key,\n"
9006 " const char *newkey,\n"
9012 #: ../src/guestfs-actions.pod:2963 ../fish/guestfish-actions.pod:2203
9014 "This command adds a new key on LUKS device C<device>. C<key> is any "
9015 "existing key, and is used to access the device. C<newkey> is the new key to "
9016 "add. C<keyslot> is the key slot that will be replaced."
9020 #: ../src/guestfs-actions.pod:2968
9022 "Note that if C<keyslot> already contains a key, then this command will "
9023 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
9027 #: ../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
9029 "This function takes a key or passphrase parameter which could contain "
9030 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
9035 #: ../src/guestfs-actions.pod:2978
9036 msgid "guestfs_luks_close"
9040 #: ../src/guestfs-actions.pod:2980
9044 " guestfs_luks_close (guestfs_h *g,\n"
9045 " const char *device);\n"
9050 #: ../src/guestfs-actions.pod:2984
9052 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
9053 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
9054 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
9055 "underlying block device."
9059 #: ../src/guestfs-actions.pod:2992
9060 msgid "guestfs_luks_format"
9064 #: ../src/guestfs-actions.pod:2994
9068 " guestfs_luks_format (guestfs_h *g,\n"
9069 " const char *device,\n"
9070 " const char *key,\n"
9076 #: ../src/guestfs-actions.pod:3000 ../fish/guestfish-actions.pod:2229
9078 "This command erases existing data on C<device> and formats the device as a "
9079 "LUKS encrypted device. C<key> is the initial key, which is added to key "
9080 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
9084 #: ../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
9086 "B<This command is dangerous. Without careful use you can easily destroy all "
9091 #: ../src/guestfs-actions.pod:3014
9092 msgid "guestfs_luks_format_cipher"
9096 #: ../src/guestfs-actions.pod:3016
9100 " guestfs_luks_format_cipher (guestfs_h *g,\n"
9101 " const char *device,\n"
9102 " const char *key,\n"
9104 " const char *cipher);\n"
9109 #: ../src/guestfs-actions.pod:3023
9111 "This command is the same as C<guestfs_luks_format> but it also allows you to "
9112 "set the C<cipher> used."
9116 #: ../src/guestfs-actions.pod:3035
9117 msgid "guestfs_luks_kill_slot"
9121 #: ../src/guestfs-actions.pod:3037
9125 " guestfs_luks_kill_slot (guestfs_h *g,\n"
9126 " const char *device,\n"
9127 " const char *key,\n"
9133 #: ../src/guestfs-actions.pod:3043 ../fish/guestfish-actions.pod:2257
9135 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
9136 "device C<device>. C<key> must be one of the I<other> keys."
9140 #: ../src/guestfs-actions.pod:3053
9141 msgid "guestfs_luks_open"
9145 #: ../src/guestfs-actions.pod:3055
9149 " guestfs_luks_open (guestfs_h *g,\n"
9150 " const char *device,\n"
9151 " const char *key,\n"
9152 " const char *mapname);\n"
9157 #: ../src/guestfs-actions.pod:3061 ../fish/guestfish-actions.pod:2268
9159 "This command opens a block device which has been encrypted according to the "
9160 "Linux Unified Key Setup (LUKS) standard."
9164 #: ../src/guestfs-actions.pod:3064 ../fish/guestfish-actions.pod:2271
9165 msgid "C<device> is the encrypted block device or partition."
9169 #: ../src/guestfs-actions.pod:3066 ../fish/guestfish-actions.pod:2273
9171 "The caller must supply one of the keys associated with the LUKS block "
9172 "device, in the C<key> parameter."
9176 #: ../src/guestfs-actions.pod:3069 ../fish/guestfish-actions.pod:2276
9178 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
9179 "writes to this block device are decrypted from and encrypted to the "
9180 "underlying C<device> respectively."
9184 #: ../src/guestfs-actions.pod:3073
9186 "If this block device contains LVM volume groups, then calling "
9187 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
9192 #: ../src/guestfs-actions.pod:3083
9193 msgid "guestfs_luks_open_ro"
9197 #: ../src/guestfs-actions.pod:3085
9201 " guestfs_luks_open_ro (guestfs_h *g,\n"
9202 " const char *device,\n"
9203 " const char *key,\n"
9204 " const char *mapname);\n"
9209 #: ../src/guestfs-actions.pod:3091
9211 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
9216 #: ../src/guestfs-actions.pod:3100
9217 msgid "guestfs_lvcreate"
9221 #: ../src/guestfs-actions.pod:3102
9225 " guestfs_lvcreate (guestfs_h *g,\n"
9226 " const char *logvol,\n"
9227 " const char *volgroup,\n"
9233 #: ../src/guestfs-actions.pod:3108 ../fish/guestfish-actions.pod:2301
9235 "This creates an LVM logical volume called C<logvol> on the volume group "
9236 "C<volgroup>, with C<size> megabytes."
9240 #: ../src/guestfs-actions.pod:3113
9241 msgid "guestfs_lvm_canonical_lv_name"
9245 #: ../src/guestfs-actions.pod:3115
9249 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
9250 " const char *lvname);\n"
9255 #: ../src/guestfs-actions.pod:3119 ../fish/guestfish-actions.pod:2308
9257 "This converts alternative naming schemes for LVs that you might find to the "
9258 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
9263 #: ../src/guestfs-actions.pod:3123 ../fish/guestfish-actions.pod:2312
9265 "This command returns an error if the C<lvname> parameter does not refer to a "
9270 #: ../src/guestfs-actions.pod:3126
9271 msgid "See also C<guestfs_is_lv>."
9275 #: ../src/guestfs-actions.pod:3131
9276 msgid "guestfs_lvm_clear_filter"
9280 #: ../src/guestfs-actions.pod:3133
9284 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
9289 #: ../src/guestfs-actions.pod:3136
9291 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
9292 "see every block device."
9296 #: ../src/guestfs-actions.pod:3139 ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2324 ../fish/guestfish-actions.pod:2355
9297 msgid "This command also clears the LVM cache and performs a volume group scan."
9301 #: ../src/guestfs-actions.pod:3144
9302 msgid "guestfs_lvm_remove_all"
9306 #: ../src/guestfs-actions.pod:3146
9310 " guestfs_lvm_remove_all (guestfs_h *g);\n"
9315 #: ../src/guestfs-actions.pod:3149 ../fish/guestfish-actions.pod:2331
9317 "This command removes all LVM logical volumes, volume groups and physical "
9322 #: ../src/guestfs-actions.pod:3157
9323 msgid "guestfs_lvm_set_filter"
9327 #: ../src/guestfs-actions.pod:3159
9331 " guestfs_lvm_set_filter (guestfs_h *g,\n"
9332 " char *const *devices);\n"
9337 #: ../src/guestfs-actions.pod:3163 ../fish/guestfish-actions.pod:2341
9339 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
9340 "block devices in the list C<devices>, and will ignore all other attached "
9345 #: ../src/guestfs-actions.pod:3167 ../fish/guestfish-actions.pod:2345
9347 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
9348 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
9349 "there are two types of duplication possible: either cloned PVs/VGs which "
9350 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
9351 "same name. In normal operation you cannot create this situation, but you "
9352 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
9353 "inside the LVM metadata."
9357 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2358
9358 msgid "You can filter whole block devices or individual partitions."
9362 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2360
9364 "You cannot use this if any VG is currently in use (eg. contains a mounted "
9365 "filesystem), even if you are not filtering out that VG."
9369 #: ../src/guestfs-actions.pod:3188
9370 msgid "guestfs_lvremove"
9374 #: ../src/guestfs-actions.pod:3190
9378 " guestfs_lvremove (guestfs_h *g,\n"
9379 " const char *device);\n"
9384 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2368
9386 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
9387 "LV, such as C</dev/VG/LV>."
9391 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2371
9393 "You can also remove all LVs in a volume group by specifying the VG name, "
9398 #: ../src/guestfs-actions.pod:3202
9399 msgid "guestfs_lvrename"
9403 #: ../src/guestfs-actions.pod:3204
9407 " guestfs_lvrename (guestfs_h *g,\n"
9408 " const char *logvol,\n"
9409 " const char *newlogvol);\n"
9414 #: ../src/guestfs-actions.pod:3209 ../fish/guestfish-actions.pod:2378
9415 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
9419 #: ../src/guestfs-actions.pod:3213
9420 msgid "guestfs_lvresize"
9424 #: ../src/guestfs-actions.pod:3215
9428 " guestfs_lvresize (guestfs_h *g,\n"
9429 " const char *device,\n"
9435 #: ../src/guestfs-actions.pod:3220 ../fish/guestfish-actions.pod:2384
9437 "This resizes (expands or shrinks) an existing LVM logical volume to "
9438 "C<mbytes>. When reducing, data in the reduced part is lost."
9442 #: ../src/guestfs-actions.pod:3226
9443 msgid "guestfs_lvresize_free"
9447 #: ../src/guestfs-actions.pod:3228
9451 " guestfs_lvresize_free (guestfs_h *g,\n"
9452 " const char *lv,\n"
9458 #: ../src/guestfs-actions.pod:3233 ../fish/guestfish-actions.pod:2392
9460 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
9461 "remaining free space in the volume group. Commonly you would call this with "
9462 "pc = 100 which expands the logical volume as much as possible, using all "
9463 "remaining free space in the volume group."
9467 #: ../src/guestfs-actions.pod:3241
9472 #: ../src/guestfs-actions.pod:3243
9476 " guestfs_lvs (guestfs_h *g);\n"
9481 #: ../src/guestfs-actions.pod:3246 ../fish/guestfish-actions.pod:2402
9483 "List all the logical volumes detected. This is the equivalent of the "
9484 "L<lvs(8)> command."
9488 #: ../src/guestfs-actions.pod:3249 ../fish/guestfish-actions.pod:2405
9490 "This returns a list of the logical volume device names "
9491 "(eg. C</dev/VolGroup00/LogVol00>)."
9495 #: ../src/guestfs-actions.pod:3252
9496 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
9500 #: ../src/guestfs-actions.pod:3258
9501 msgid "guestfs_lvs_full"
9505 #: ../src/guestfs-actions.pod:3260
9508 " struct guestfs_lvm_lv_list *\n"
9509 " guestfs_lvs_full (guestfs_h *g);\n"
9514 #: ../src/guestfs-actions.pod:3263 ../fish/guestfish-actions.pod:2414
9516 "List all the logical volumes detected. This is the equivalent of the "
9517 "L<lvs(8)> command. The \"full\" version includes all fields."
9521 #: ../src/guestfs-actions.pod:3266
9523 "This function returns a C<struct guestfs_lvm_lv_list *> (see "
9524 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
9525 "must call C<guestfs_free_lvm_lv_list> after use>."
9529 #: ../src/guestfs-actions.pod:3271
9530 msgid "guestfs_lvuuid"
9534 #: ../src/guestfs-actions.pod:3273
9538 " guestfs_lvuuid (guestfs_h *g,\n"
9539 " const char *device);\n"
9544 #: ../src/guestfs-actions.pod:3277 ../fish/guestfish-actions.pod:2421
9545 msgid "This command returns the UUID of the LVM LV C<device>."
9549 #: ../src/guestfs-actions.pod:3282
9550 msgid "guestfs_lxattrlist"
9554 #: ../src/guestfs-actions.pod:3284
9557 " struct guestfs_xattr_list *\n"
9558 " guestfs_lxattrlist (guestfs_h *g,\n"
9559 " const char *path,\n"
9560 " char *const *names);\n"
9565 #: ../src/guestfs-actions.pod:3289 ../fish/guestfish-actions.pod:2427
9567 "This call allows you to get the extended attributes of multiple files, where "
9568 "all files are in the directory C<path>. C<names> is the list of files from "
9573 #: ../src/guestfs-actions.pod:3293 ../fish/guestfish-actions.pod:2431
9575 "On return you get a flat list of xattr structs which must be interpreted "
9576 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
9577 "C<attrval> in this struct is zero-length to indicate there was an error "
9578 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
9579 "number (the number of following attributes for this file, which could be "
9580 "C<\"0\">). Then after the first xattr struct are the zero or more "
9581 "attributes for the first named file. This repeats for the second and "
9586 #: ../src/guestfs-actions.pod:3303
9588 "This call is intended for programs that want to efficiently list a directory "
9589 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
9590 "a similarly efficient call for getting standard stats. Very long directory "
9591 "listings might cause the protocol message size to be exceeded, causing this "
9592 "call to fail. The caller must split up such requests into smaller groups of "
9597 #: ../src/guestfs-actions.pod:3316
9598 msgid "guestfs_mkdir"
9602 #: ../src/guestfs-actions.pod:3318
9606 " guestfs_mkdir (guestfs_h *g,\n"
9607 " const char *path);\n"
9612 #: ../src/guestfs-actions.pod:3322 ../fish/guestfish-actions.pod:2453
9613 msgid "Create a directory named C<path>."
9617 #: ../src/guestfs-actions.pod:3326
9618 msgid "guestfs_mkdir_mode"
9622 #: ../src/guestfs-actions.pod:3328
9626 " guestfs_mkdir_mode (guestfs_h *g,\n"
9627 " const char *path,\n"
9633 #: ../src/guestfs-actions.pod:3333 ../fish/guestfish-actions.pod:2459
9635 "This command creates a directory, setting the initial permissions of the "
9636 "directory to C<mode>."
9640 #: ../src/guestfs-actions.pod:3336 ../fish/guestfish-actions.pod:2462
9642 "For common Linux filesystems, the actual mode which is set will be C<mode & "
9643 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
9648 #: ../src/guestfs-actions.pod:3340
9649 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
9653 #: ../src/guestfs-actions.pod:3344
9654 msgid "guestfs_mkdir_p"
9658 #: ../src/guestfs-actions.pod:3346
9662 " guestfs_mkdir_p (guestfs_h *g,\n"
9663 " const char *path);\n"
9668 #: ../src/guestfs-actions.pod:3350 ../fish/guestfish-actions.pod:2472
9670 "Create a directory named C<path>, creating any parent directories as "
9671 "necessary. This is like the C<mkdir -p> shell command."
9675 #: ../src/guestfs-actions.pod:3355
9676 msgid "guestfs_mkdtemp"
9680 #: ../src/guestfs-actions.pod:3357
9684 " guestfs_mkdtemp (guestfs_h *g,\n"
9685 " const char *template);\n"
9690 #: ../src/guestfs-actions.pod:3361 ../fish/guestfish-actions.pod:2479
9692 "This command creates a temporary directory. The C<template> parameter "
9693 "should be a full pathname for the temporary directory name with the final "
9694 "six characters being \"XXXXXX\"."
9698 #: ../src/guestfs-actions.pod:3366 ../fish/guestfish-actions.pod:2484
9700 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
9701 "being suitable for Windows filesystems."
9705 #: ../src/guestfs-actions.pod:3369 ../fish/guestfish-actions.pod:2487
9706 msgid "The name of the temporary directory that was created is returned."
9710 #: ../src/guestfs-actions.pod:3372 ../fish/guestfish-actions.pod:2490
9711 msgid "The temporary directory is created with mode 0700 and is owned by root."
9715 #: ../src/guestfs-actions.pod:3375 ../fish/guestfish-actions.pod:2493
9717 "The caller is responsible for deleting the temporary directory and its "
9718 "contents after use."
9722 #: ../src/guestfs-actions.pod:3378 ../fish/guestfish-actions.pod:2496
9723 msgid "See also: L<mkdtemp(3)>"
9727 #: ../src/guestfs-actions.pod:3383
9728 msgid "guestfs_mke2fs_J"
9732 #: ../src/guestfs-actions.pod:3385
9736 " guestfs_mke2fs_J (guestfs_h *g,\n"
9737 " const char *fstype,\n"
9739 " const char *device,\n"
9740 " const char *journal);\n"
9745 #: ../src/guestfs-actions.pod:3392 ../fish/guestfish-actions.pod:2502
9747 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
9748 "C<journal>. It is equivalent to the command:"
9752 #: ../src/guestfs-actions.pod:3396 ../fish/guestfish-actions.pod:2506
9755 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
9760 #: ../src/guestfs-actions.pod:3398
9761 msgid "See also C<guestfs_mke2journal>."
9765 #: ../src/guestfs-actions.pod:3402
9766 msgid "guestfs_mke2fs_JL"
9770 #: ../src/guestfs-actions.pod:3404
9774 " guestfs_mke2fs_JL (guestfs_h *g,\n"
9775 " const char *fstype,\n"
9777 " const char *device,\n"
9778 " const char *label);\n"
9783 #: ../src/guestfs-actions.pod:3411 ../fish/guestfish-actions.pod:2514
9785 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
9786 "the journal labeled C<label>."
9790 #: ../src/guestfs-actions.pod:3414
9791 msgid "See also C<guestfs_mke2journal_L>."
9795 #: ../src/guestfs-actions.pod:3418
9796 msgid "guestfs_mke2fs_JU"
9800 #: ../src/guestfs-actions.pod:3420
9804 " guestfs_mke2fs_JU (guestfs_h *g,\n"
9805 " const char *fstype,\n"
9807 " const char *device,\n"
9808 " const char *uuid);\n"
9813 #: ../src/guestfs-actions.pod:3427 ../fish/guestfish-actions.pod:2523
9815 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
9816 "the journal with UUID C<uuid>."
9820 #: ../src/guestfs-actions.pod:3430
9821 msgid "See also C<guestfs_mke2journal_U>."
9825 #: ../src/guestfs-actions.pod:3434
9826 msgid "guestfs_mke2journal"
9830 #: ../src/guestfs-actions.pod:3436
9834 " guestfs_mke2journal (guestfs_h *g,\n"
9836 " const char *device);\n"
9841 #: ../src/guestfs-actions.pod:3441 ../fish/guestfish-actions.pod:2532
9843 "This creates an ext2 external journal on C<device>. It is equivalent to the "
9848 #: ../src/guestfs-actions.pod:3444 ../fish/guestfish-actions.pod:2535
9851 " mke2fs -O journal_dev -b blocksize device\n"
9856 #: ../src/guestfs-actions.pod:3448
9857 msgid "guestfs_mke2journal_L"
9861 #: ../src/guestfs-actions.pod:3450
9865 " guestfs_mke2journal_L (guestfs_h *g,\n"
9867 " const char *label,\n"
9868 " const char *device);\n"
9873 #: ../src/guestfs-actions.pod:3456 ../fish/guestfish-actions.pod:2541
9874 msgid "This creates an ext2 external journal on C<device> with label C<label>."
9878 #: ../src/guestfs-actions.pod:3460
9879 msgid "guestfs_mke2journal_U"
9883 #: ../src/guestfs-actions.pod:3462
9887 " guestfs_mke2journal_U (guestfs_h *g,\n"
9889 " const char *uuid,\n"
9890 " const char *device);\n"
9895 #: ../src/guestfs-actions.pod:3468 ../fish/guestfish-actions.pod:2547
9896 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
9900 #: ../src/guestfs-actions.pod:3472
9901 msgid "guestfs_mkfifo"
9905 #: ../src/guestfs-actions.pod:3474
9909 " guestfs_mkfifo (guestfs_h *g,\n"
9911 " const char *path);\n"
9916 #: ../src/guestfs-actions.pod:3479
9918 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
9919 "is just a convenient wrapper around C<guestfs_mknod>."
9923 #: ../src/guestfs-actions.pod:3487
9924 msgid "guestfs_mkfs"
9928 #: ../src/guestfs-actions.pod:3489
9932 " guestfs_mkfs (guestfs_h *g,\n"
9933 " const char *fstype,\n"
9934 " const char *device);\n"
9939 #: ../src/guestfs-actions.pod:3494 ../fish/guestfish-actions.pod:2563
9941 "This creates a filesystem on C<device> (usually a partition or LVM logical "
9942 "volume). The filesystem type is C<fstype>, for example C<ext3>."
9946 #: ../src/guestfs-actions.pod:3500
9947 msgid "guestfs_mkfs_b"
9951 #: ../src/guestfs-actions.pod:3502
9955 " guestfs_mkfs_b (guestfs_h *g,\n"
9956 " const char *fstype,\n"
9958 " const char *device);\n"
9963 #: ../src/guestfs-actions.pod:3508
9965 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
9966 "block size of the resulting filesystem. Supported block sizes depend on the "
9967 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
9971 #: ../src/guestfs-actions.pod:3513 ../fish/guestfish-actions.pod:2576
9973 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
9978 #: ../src/guestfs-actions.pod:3518
9979 msgid "guestfs_mkmountpoint"
9983 #: ../src/guestfs-actions.pod:3520
9987 " guestfs_mkmountpoint (guestfs_h *g,\n"
9988 " const char *exemptpath);\n"
9993 #: ../src/guestfs-actions.pod:3524
9995 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
9996 "that can be used to create extra mountpoints before mounting the first "
10001 #: ../src/guestfs-actions.pod:3528 ../fish/guestfish-actions.pod:2587
10003 "These calls are I<only> necessary in some very limited circumstances, mainly "
10004 "the case where you want to mount a mix of unrelated and/or read-only "
10005 "filesystems together."
10009 #: ../src/guestfs-actions.pod:3532 ../fish/guestfish-actions.pod:2591
10011 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10012 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10013 "inside that. You can unpack this as follows in guestfish:"
10017 #: ../src/guestfs-actions.pod:3537 ../fish/guestfish-actions.pod:2596
10020 " add-ro Fedora-11-i686-Live.iso\n"
10022 " mkmountpoint /cd\n"
10023 " mkmountpoint /sqsh\n"
10024 " mkmountpoint /ext3fs\n"
10025 " mount /dev/sda /cd\n"
10026 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10027 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10032 #: ../src/guestfs-actions.pod:3546 ../fish/guestfish-actions.pod:2605
10033 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
10037 #: ../src/guestfs-actions.pod:3548
10039 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
10040 "may get unexpected errors if you try to mix these calls. It is safest to "
10041 "manually unmount filesystems and remove mountpoints after use."
10045 #: ../src/guestfs-actions.pod:3552
10047 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
10048 "first, so for this to work for manual mountpoints, you must ensure that the "
10049 "innermost mountpoints have the longest pathnames, as in the example code "
10054 #: ../src/guestfs-actions.pod:3557 ../fish/guestfish-actions.pod:2616
10055 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
10059 #: ../src/guestfs-actions.pod:3559
10061 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
10062 "means that C<guestfs_umount_all> is called when the handle is closed which "
10063 "can also trigger these issues."
10067 #: ../src/guestfs-actions.pod:3565
10068 msgid "guestfs_mknod"
10072 #: ../src/guestfs-actions.pod:3567
10076 " guestfs_mknod (guestfs_h *g,\n"
10080 " const char *path);\n"
10085 #: ../src/guestfs-actions.pod:3574 ../fish/guestfish-actions.pod:2626
10087 "This call creates block or character special devices, or named pipes "
10092 #: ../src/guestfs-actions.pod:3577 ../fish/guestfish-actions.pod:2629
10094 "The C<mode> parameter should be the mode, using the standard constants. "
10095 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
10096 "used when creating block and character special devices."
10100 #: ../src/guestfs-actions.pod:3582
10102 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
10103 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
10104 "regular file). These constants are available in the standard Linux header "
10105 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
10106 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
10107 "the appropriate constant for you."
10111 #: ../src/guestfs-actions.pod:3594
10112 msgid "guestfs_mknod_b"
10116 #: ../src/guestfs-actions.pod:3596
10120 " guestfs_mknod_b (guestfs_h *g,\n"
10124 " const char *path);\n"
10129 #: ../src/guestfs-actions.pod:3603
10131 "This call creates a block device node called C<path> with mode C<mode> and "
10132 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10133 "wrapper around C<guestfs_mknod>."
10137 #: ../src/guestfs-actions.pod:3611
10138 msgid "guestfs_mknod_c"
10142 #: ../src/guestfs-actions.pod:3613
10146 " guestfs_mknod_c (guestfs_h *g,\n"
10150 " const char *path);\n"
10155 #: ../src/guestfs-actions.pod:3620
10157 "This call creates a char device node called C<path> with mode C<mode> and "
10158 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10159 "wrapper around C<guestfs_mknod>."
10163 #: ../src/guestfs-actions.pod:3628
10164 msgid "guestfs_mkswap"
10168 #: ../src/guestfs-actions.pod:3630
10172 " guestfs_mkswap (guestfs_h *g,\n"
10173 " const char *device);\n"
10178 #: ../src/guestfs-actions.pod:3634 ../fish/guestfish-actions.pod:2668
10179 msgid "Create a swap partition on C<device>."
10183 #: ../src/guestfs-actions.pod:3638
10184 msgid "guestfs_mkswap_L"
10188 #: ../src/guestfs-actions.pod:3640
10192 " guestfs_mkswap_L (guestfs_h *g,\n"
10193 " const char *label,\n"
10194 " const char *device);\n"
10199 #: ../src/guestfs-actions.pod:3645 ../fish/guestfish-actions.pod:2674
10200 msgid "Create a swap partition on C<device> with label C<label>."
10204 #: ../src/guestfs-actions.pod:3647 ../fish/guestfish-actions.pod:2676
10206 "Note that you cannot attach a swap label to a block device "
10207 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
10208 "the kernel or swap tools."
10212 #: ../src/guestfs-actions.pod:3653
10213 msgid "guestfs_mkswap_U"
10217 #: ../src/guestfs-actions.pod:3655
10221 " guestfs_mkswap_U (guestfs_h *g,\n"
10222 " const char *uuid,\n"
10223 " const char *device);\n"
10228 #: ../src/guestfs-actions.pod:3660 ../fish/guestfish-actions.pod:2684
10229 msgid "Create a swap partition on C<device> with UUID C<uuid>."
10233 #: ../src/guestfs-actions.pod:3664
10234 msgid "guestfs_mkswap_file"
10238 #: ../src/guestfs-actions.pod:3666
10242 " guestfs_mkswap_file (guestfs_h *g,\n"
10243 " const char *path);\n"
10248 #: ../src/guestfs-actions.pod:3670 ../fish/guestfish-actions.pod:2690
10249 msgid "Create a swap file."
10253 #: ../src/guestfs-actions.pod:3672
10255 "This command just writes a swap file signature to an existing file. To "
10256 "create the file itself, use something like C<guestfs_fallocate>."
10260 #: ../src/guestfs-actions.pod:3677
10261 msgid "guestfs_modprobe"
10265 #: ../src/guestfs-actions.pod:3679
10269 " guestfs_modprobe (guestfs_h *g,\n"
10270 " const char *modulename);\n"
10275 #: ../src/guestfs-actions.pod:3683 ../fish/guestfish-actions.pod:2699
10276 msgid "This loads a kernel module in the appliance."
10280 #: ../src/guestfs-actions.pod:3685 ../fish/guestfish-actions.pod:2701
10282 "The kernel module must have been whitelisted when libguestfs was built (see "
10283 "C<appliance/kmod.whitelist.in> in the source)."
10287 #: ../src/guestfs-actions.pod:3690
10288 msgid "guestfs_mount"
10292 #: ../src/guestfs-actions.pod:3692
10296 " guestfs_mount (guestfs_h *g,\n"
10297 " const char *device,\n"
10298 " const char *mountpoint);\n"
10303 #: ../src/guestfs-actions.pod:3697 ../fish/guestfish-actions.pod:2708
10305 "Mount a guest disk at a position in the filesystem. Block devices are named "
10306 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
10307 "those block devices contain partitions, they will have the usual names "
10308 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
10312 #: ../src/guestfs-actions.pod:3703 ../fish/guestfish-actions.pod:2714
10314 "The rules are the same as for L<mount(2)>: A filesystem must first be "
10315 "mounted on C</> before others can be mounted. Other filesystems can only be "
10316 "mounted on directories which already exist."
10320 #: ../src/guestfs-actions.pod:3708 ../fish/guestfish-actions.pod:2719
10322 "The mounted filesystem is writable, if we have sufficient permissions on the "
10323 "underlying device."
10327 #: ../src/guestfs-actions.pod:3711
10329 "B<Important note:> When you use this call, the filesystem options C<sync> "
10330 "and C<noatime> are set implicitly. This was originally done because we "
10331 "thought it would improve reliability, but it turns out that I<-o sync> has a "
10332 "very large negative performance impact and negligible effect on "
10333 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
10334 "in any code that needs performance, and instead use C<guestfs_mount_options> "
10335 "(use an empty string for the first parameter if you don't want any options)."
10339 #: ../src/guestfs-actions.pod:3723
10340 msgid "guestfs_mount_loop"
10344 #: ../src/guestfs-actions.pod:3725
10348 " guestfs_mount_loop (guestfs_h *g,\n"
10349 " const char *file,\n"
10350 " const char *mountpoint);\n"
10355 #: ../src/guestfs-actions.pod:3730 ../fish/guestfish-actions.pod:2736
10357 "This command lets you mount C<file> (a filesystem image in a file) on a "
10358 "mount point. It is entirely equivalent to the command C<mount -o loop file "
10363 #: ../src/guestfs-actions.pod:3736
10364 msgid "guestfs_mount_options"
10368 #: ../src/guestfs-actions.pod:3738
10372 " guestfs_mount_options (guestfs_h *g,\n"
10373 " const char *options,\n"
10374 " const char *device,\n"
10375 " const char *mountpoint);\n"
10380 #: ../src/guestfs-actions.pod:3744
10382 "This is the same as the C<guestfs_mount> command, but it allows you to set "
10383 "the mount options as for the L<mount(8)> I<-o> flag."
10387 #: ../src/guestfs-actions.pod:3748 ../fish/guestfish-actions.pod:2748
10389 "If the C<options> parameter is an empty string, then no options are passed "
10390 "(all options default to whatever the filesystem uses)."
10394 #: ../src/guestfs-actions.pod:3754
10395 msgid "guestfs_mount_ro"
10399 #: ../src/guestfs-actions.pod:3756
10403 " guestfs_mount_ro (guestfs_h *g,\n"
10404 " const char *device,\n"
10405 " const char *mountpoint);\n"
10410 #: ../src/guestfs-actions.pod:3761
10412 "This is the same as the C<guestfs_mount> command, but it mounts the "
10413 "filesystem with the read-only (I<-o ro>) flag."
10417 #: ../src/guestfs-actions.pod:3766
10418 msgid "guestfs_mount_vfs"
10422 #: ../src/guestfs-actions.pod:3768
10426 " guestfs_mount_vfs (guestfs_h *g,\n"
10427 " const char *options,\n"
10428 " const char *vfstype,\n"
10429 " const char *device,\n"
10430 " const char *mountpoint);\n"
10435 #: ../src/guestfs-actions.pod:3775
10437 "This is the same as the C<guestfs_mount> command, but it allows you to set "
10438 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
10443 #: ../src/guestfs-actions.pod:3781
10444 msgid "guestfs_mountpoints"
10448 #: ../src/guestfs-actions.pod:3783
10452 " guestfs_mountpoints (guestfs_h *g);\n"
10457 #: ../src/guestfs-actions.pod:3786
10459 "This call is similar to C<guestfs_mounts>. That call returns a list of "
10460 "devices. This one returns a hash table (map) of device name to directory "
10461 "where the device is mounted."
10465 #: ../src/guestfs-actions.pod:3796
10466 msgid "guestfs_mounts"
10470 #: ../src/guestfs-actions.pod:3798
10474 " guestfs_mounts (guestfs_h *g);\n"
10479 #: ../src/guestfs-actions.pod:3801 ../fish/guestfish-actions.pod:2779
10481 "This returns the list of currently mounted filesystems. It returns the list "
10482 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
10486 #: ../src/guestfs-actions.pod:3804 ../fish/guestfish-actions.pod:2782
10487 msgid "Some internal mounts are not shown."
10491 #: ../src/guestfs-actions.pod:3806
10492 msgid "See also: C<guestfs_mountpoints>"
10496 #: ../src/guestfs-actions.pod:3812
10501 #: ../src/guestfs-actions.pod:3814
10505 " guestfs_mv (guestfs_h *g,\n"
10506 " const char *src,\n"
10507 " const char *dest);\n"
10512 #: ../src/guestfs-actions.pod:3819 ../fish/guestfish-actions.pod:2790
10514 "This moves a file from C<src> to C<dest> where C<dest> is either a "
10515 "destination filename or destination directory."
10519 #: ../src/guestfs-actions.pod:3824
10520 msgid "guestfs_ntfs_3g_probe"
10524 #: ../src/guestfs-actions.pod:3826
10528 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
10530 " const char *device);\n"
10535 #: ../src/guestfs-actions.pod:3831 ../fish/guestfish-actions.pod:2797
10537 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
10538 "C<device> for mountability. (Not all NTFS volumes can be mounted "
10539 "read-write, and some cannot be mounted at all)."
10543 #: ../src/guestfs-actions.pod:3835 ../fish/guestfish-actions.pod:2801
10545 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
10546 "can be mounted read-write. Set it to false if you want to test if the "
10547 "volume can be mounted read-only."
10551 #: ../src/guestfs-actions.pod:3839 ../fish/guestfish-actions.pod:2805
10553 "The return value is an integer which C<0> if the operation would succeed, or "
10554 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
10558 #: ../src/guestfs-actions.pod:3845
10559 msgid "guestfs_ntfsresize"
10563 #: ../src/guestfs-actions.pod:3847
10567 " guestfs_ntfsresize (guestfs_h *g,\n"
10568 " const char *device);\n"
10573 #: ../src/guestfs-actions.pod:3851 ../fish/guestfish-actions.pod:2813
10575 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
10576 "size of the underlying device. See also L<ntfsresize(8)>."
10580 #: ../src/guestfs-actions.pod:3857
10581 msgid "guestfs_ntfsresize_size"
10585 #: ../src/guestfs-actions.pod:3859
10589 " guestfs_ntfsresize_size (guestfs_h *g,\n"
10590 " const char *device,\n"
10591 " int64_t size);\n"
10596 #: ../src/guestfs-actions.pod:3864
10598 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
10599 "to specify the new size (in bytes) explicitly."
10603 #: ../src/guestfs-actions.pod:3869
10604 msgid "guestfs_part_add"
10608 #: ../src/guestfs-actions.pod:3871
10612 " guestfs_part_add (guestfs_h *g,\n"
10613 " const char *device,\n"
10614 " const char *prlogex,\n"
10615 " int64_t startsect,\n"
10616 " int64_t endsect);\n"
10621 #: ../src/guestfs-actions.pod:3878
10623 "This command adds a partition to C<device>. If there is no partition table "
10624 "on the device, call C<guestfs_part_init> first."
10628 #: ../src/guestfs-actions.pod:3881 ../fish/guestfish-actions.pod:2831
10630 "The C<prlogex> parameter is the type of partition. Normally you should pass "
10631 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
10632 "C<logical>) and C<e> (or C<extended>) partition types."
10636 #: ../src/guestfs-actions.pod:3886 ../fish/guestfish-actions.pod:2836
10638 "C<startsect> and C<endsect> are the start and end of the partition in "
10639 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
10640 "from the end of the disk (C<-1> is the last sector)."
10644 #: ../src/guestfs-actions.pod:3890
10646 "Creating a partition which covers the whole disk is not so easy. Use "
10647 "C<guestfs_part_disk> to do that."
10651 #: ../src/guestfs-actions.pod:3895
10652 msgid "guestfs_part_del"
10656 #: ../src/guestfs-actions.pod:3897
10660 " guestfs_part_del (guestfs_h *g,\n"
10661 " const char *device,\n"
10667 #: ../src/guestfs-actions.pod:3902 ../fish/guestfish-actions.pod:2847
10668 msgid "This command deletes the partition numbered C<partnum> on C<device>."
10672 #: ../src/guestfs-actions.pod:3904 ../fish/guestfish-actions.pod:2849
10674 "Note that in the case of MBR partitioning, deleting an extended partition "
10675 "also deletes any logical partitions it contains."
10679 #: ../src/guestfs-actions.pod:3910
10680 msgid "guestfs_part_disk"
10684 #: ../src/guestfs-actions.pod:3912
10688 " guestfs_part_disk (guestfs_h *g,\n"
10689 " const char *device,\n"
10690 " const char *parttype);\n"
10695 #: ../src/guestfs-actions.pod:3917
10697 "This command is simply a combination of C<guestfs_part_init> followed by "
10698 "C<guestfs_part_add> to create a single primary partition covering the whole "
10703 #: ../src/guestfs-actions.pod:3921
10705 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
10706 "possible values are described in C<guestfs_part_init>."
10710 #: ../src/guestfs-actions.pod:3929
10711 msgid "guestfs_part_get_bootable"
10715 #: ../src/guestfs-actions.pod:3931
10719 " guestfs_part_get_bootable (guestfs_h *g,\n"
10720 " const char *device,\n"
10726 #: ../src/guestfs-actions.pod:3936 ../fish/guestfish-actions.pod:2871
10728 "This command returns true if the partition C<partnum> on C<device> has the "
10729 "bootable flag set."
10733 #: ../src/guestfs-actions.pod:3939
10734 msgid "See also C<guestfs_part_set_bootable>."
10738 #: ../src/guestfs-actions.pod:3943
10739 msgid "guestfs_part_get_mbr_id"
10743 #: ../src/guestfs-actions.pod:3945
10747 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
10748 " const char *device,\n"
10754 #: ../src/guestfs-actions.pod:3950 ../fish/guestfish-actions.pod:2880
10756 "Returns the MBR type byte (also known as the ID byte) from the numbered "
10757 "partition C<partnum>."
10761 #: ../src/guestfs-actions.pod:3953 ../src/guestfs-actions.pod:4120
10763 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
10764 "undefined results for other partition table types (see "
10765 "C<guestfs_part_get_parttype>)."
10769 #: ../src/guestfs-actions.pod:3959
10770 msgid "guestfs_part_get_parttype"
10774 #: ../src/guestfs-actions.pod:3961
10778 " guestfs_part_get_parttype (guestfs_h *g,\n"
10779 " const char *device);\n"
10784 #: ../src/guestfs-actions.pod:3965 ../fish/guestfish-actions.pod:2891
10786 "This command examines the partition table on C<device> and returns the "
10787 "partition table type (format) being used."
10791 #: ../src/guestfs-actions.pod:3968
10793 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
10794 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
10795 "possible, although unusual. See C<guestfs_part_init> for a full list."
10799 #: ../src/guestfs-actions.pod:3976
10800 msgid "guestfs_part_init"
10804 #: ../src/guestfs-actions.pod:3978
10808 " guestfs_part_init (guestfs_h *g,\n"
10809 " const char *device,\n"
10810 " const char *parttype);\n"
10815 #: ../src/guestfs-actions.pod:3983 ../fish/guestfish-actions.pod:2903
10817 "This creates an empty partition table on C<device> of one of the partition "
10818 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
10819 "(for large disks)."
10823 #: ../src/guestfs-actions.pod:3987
10825 "Initially there are no partitions. Following this, you should call "
10826 "C<guestfs_part_add> for each partition required."
10830 #: ../src/guestfs-actions.pod:3990 ../fish/guestfish-actions.pod:2910
10831 msgid "Possible values for C<parttype> are:"
10835 #: ../src/guestfs-actions.pod:3994 ../fish/guestfish-actions.pod:2914
10836 msgid "B<efi> | B<gpt>"
10840 #: ../src/guestfs-actions.pod:3996 ../fish/guestfish-actions.pod:2916
10841 msgid "Intel EFI / GPT partition table."
10845 #: ../src/guestfs-actions.pod:3998 ../fish/guestfish-actions.pod:2918
10847 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
10848 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
10849 "the C<mbr> format."
10853 #: ../src/guestfs-actions.pod:4002 ../fish/guestfish-actions.pod:2922
10854 msgid "B<mbr> | B<msdos>"
10858 #: ../src/guestfs-actions.pod:4004 ../fish/guestfish-actions.pod:2924
10860 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
10861 "Windows. This partition type will B<only> work for device sizes up to 2 "
10862 "TB. For large disks we recommend using C<gpt>."
10866 #: ../src/guestfs-actions.pod:4011 ../fish/guestfish-actions.pod:2931
10867 msgid "Other partition table types that may work but are not supported include:"
10871 #: ../src/guestfs-actions.pod:4016 ../fish/guestfish-actions.pod:2936
10876 #: ../src/guestfs-actions.pod:4018 ../fish/guestfish-actions.pod:2938
10877 msgid "AIX disk labels."
10881 #: ../src/guestfs-actions.pod:4020 ../fish/guestfish-actions.pod:2940
10882 msgid "B<amiga> | B<rdb>"
10886 #: ../src/guestfs-actions.pod:4022 ../fish/guestfish-actions.pod:2942
10887 msgid "Amiga \"Rigid Disk Block\" format."
10891 #: ../src/guestfs-actions.pod:4024 ../fish/guestfish-actions.pod:2944
10896 #: ../src/guestfs-actions.pod:4026 ../fish/guestfish-actions.pod:2946
10897 msgid "BSD disk labels."
10901 #: ../src/guestfs-actions.pod:4028 ../fish/guestfish-actions.pod:2948
10906 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:2950
10907 msgid "DASD, used on IBM mainframes."
10911 #: ../src/guestfs-actions.pod:4032 ../fish/guestfish-actions.pod:2952
10916 #: ../src/guestfs-actions.pod:4034 ../fish/guestfish-actions.pod:2954
10917 msgid "MIPS/SGI volumes."
10921 #: ../src/guestfs-actions.pod:4036 ../fish/guestfish-actions.pod:2956
10926 #: ../src/guestfs-actions.pod:4038 ../fish/guestfish-actions.pod:2958
10927 msgid "Old Mac partition format. Modern Macs use C<gpt>."
10931 #: ../src/guestfs-actions.pod:4040 ../fish/guestfish-actions.pod:2960
10936 #: ../src/guestfs-actions.pod:4042 ../fish/guestfish-actions.pod:2962
10937 msgid "NEC PC-98 format, common in Japan apparently."
10941 #: ../src/guestfs-actions.pod:4044 ../fish/guestfish-actions.pod:2964
10946 #: ../src/guestfs-actions.pod:4046 ../fish/guestfish-actions.pod:2966
10947 msgid "Sun disk labels."
10951 #: ../src/guestfs-actions.pod:4052
10952 msgid "guestfs_part_list"
10956 #: ../src/guestfs-actions.pod:4054
10959 " struct guestfs_partition_list *\n"
10960 " guestfs_part_list (guestfs_h *g,\n"
10961 " const char *device);\n"
10966 #: ../src/guestfs-actions.pod:4058 ../fish/guestfish-actions.pod:2974
10968 "This command parses the partition table on C<device> and returns the list of "
10969 "partitions found."
10973 #: ../src/guestfs-actions.pod:4061 ../fish/guestfish-actions.pod:2977
10974 msgid "The fields in the returned structure are:"
10978 #: ../src/guestfs-actions.pod:4065 ../fish/guestfish-actions.pod:2981
10979 msgid "B<part_num>"
10983 #: ../src/guestfs-actions.pod:4067 ../fish/guestfish-actions.pod:2983
10984 msgid "Partition number, counting from 1."
10988 #: ../src/guestfs-actions.pod:4069 ../fish/guestfish-actions.pod:2985
10989 msgid "B<part_start>"
10993 #: ../src/guestfs-actions.pod:4071
10995 "Start of the partition I<in bytes>. To get sectors you have to divide by "
10996 "the device's sector size, see C<guestfs_blockdev_getss>."
11000 #: ../src/guestfs-actions.pod:4074 ../fish/guestfish-actions.pod:2990
11001 msgid "B<part_end>"
11005 #: ../src/guestfs-actions.pod:4076 ../fish/guestfish-actions.pod:2992
11006 msgid "End of the partition in bytes."
11010 #: ../src/guestfs-actions.pod:4078 ../fish/guestfish-actions.pod:2994
11011 msgid "B<part_size>"
11015 #: ../src/guestfs-actions.pod:4080 ../fish/guestfish-actions.pod:2996
11016 msgid "Size of the partition in bytes."
11020 #: ../src/guestfs-actions.pod:4084
11022 "This function returns a C<struct guestfs_partition_list *> (see "
11023 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
11024 "must call C<guestfs_free_partition_list> after use>."
11028 #: ../src/guestfs-actions.pod:4089
11029 msgid "guestfs_part_set_bootable"
11033 #: ../src/guestfs-actions.pod:4091
11037 " guestfs_part_set_bootable (guestfs_h *g,\n"
11038 " const char *device,\n"
11040 " int bootable);\n"
11045 #: ../src/guestfs-actions.pod:4097 ../fish/guestfish-actions.pod:3004
11047 "This sets the bootable flag on partition numbered C<partnum> on device "
11048 "C<device>. Note that partitions are numbered from 1."
11052 #: ../src/guestfs-actions.pod:4100 ../fish/guestfish-actions.pod:3007
11054 "The bootable flag is used by some operating systems (notably Windows) to "
11055 "determine which partition to boot from. It is by no means universally "
11060 #: ../src/guestfs-actions.pod:4106
11061 msgid "guestfs_part_set_mbr_id"
11065 #: ../src/guestfs-actions.pod:4108
11069 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
11070 " const char *device,\n"
11077 #: ../src/guestfs-actions.pod:4114 ../fish/guestfish-actions.pod:3015
11079 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
11080 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
11081 "documentation are in fact hexadecimal numbers, but usually documented "
11082 "without any leading \"0x\" which might be confusing."
11086 #: ../src/guestfs-actions.pod:4126
11087 msgid "guestfs_part_set_name"
11091 #: ../src/guestfs-actions.pod:4128
11095 " guestfs_part_set_name (guestfs_h *g,\n"
11096 " const char *device,\n"
11098 " const char *name);\n"
11103 #: ../src/guestfs-actions.pod:4134 ../fish/guestfish-actions.pod:3029
11105 "This sets the partition name on partition numbered C<partnum> on device "
11106 "C<device>. Note that partitions are numbered from 1."
11110 #: ../src/guestfs-actions.pod:4137 ../fish/guestfish-actions.pod:3032
11112 "The partition name can only be set on certain types of partition table. "
11113 "This works on C<gpt> but not on C<mbr> partitions."
11117 #: ../src/guestfs-actions.pod:4142
11118 msgid "guestfs_part_to_dev"
11122 #: ../src/guestfs-actions.pod:4144
11126 " guestfs_part_to_dev (guestfs_h *g,\n"
11127 " const char *partition);\n"
11132 #: ../src/guestfs-actions.pod:4148 ../fish/guestfish-actions.pod:3039
11134 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
11135 "partition number, returning the device name (eg. \"/dev/sdb\")."
11139 #: ../src/guestfs-actions.pod:4152
11141 "The named partition must exist, for example as a string returned from "
11142 "C<guestfs_list_partitions>."
11146 #: ../src/guestfs-actions.pod:4158
11147 msgid "guestfs_ping_daemon"
11151 #: ../src/guestfs-actions.pod:4160
11155 " guestfs_ping_daemon (guestfs_h *g);\n"
11160 #: ../src/guestfs-actions.pod:4163 ../fish/guestfish-actions.pod:3050
11162 "This is a test probe into the guestfs daemon running inside the qemu "
11163 "subprocess. Calling this function checks that the daemon responds to the "
11164 "ping message, without affecting the daemon or attached block device(s) in "
11169 #: ../src/guestfs-actions.pod:4170
11170 msgid "guestfs_pread"
11174 #: ../src/guestfs-actions.pod:4172
11178 " guestfs_pread (guestfs_h *g,\n"
11179 " const char *path,\n"
11181 " int64_t offset,\n"
11182 " size_t *size_r);\n"
11187 #: ../src/guestfs-actions.pod:4179 ../fish/guestfish-actions.pod:3059
11189 "This command lets you read part of a file. It reads C<count> bytes of the "
11190 "file, starting at C<offset>, from file C<path>."
11194 #: ../src/guestfs-actions.pod:4182 ../src/guestfs-actions.pod:4206 ../fish/guestfish-actions.pod:3062 ../fish/guestfish-actions.pod:3077
11196 "This may read fewer bytes than requested. For further details see the "
11197 "L<pread(2)> system call."
11201 #: ../src/guestfs-actions.pod:4185
11202 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
11206 #: ../src/guestfs-actions.pod:4194
11207 msgid "guestfs_pread_device"
11211 #: ../src/guestfs-actions.pod:4196
11215 " guestfs_pread_device (guestfs_h *g,\n"
11216 " const char *device,\n"
11218 " int64_t offset,\n"
11219 " size_t *size_r);\n"
11224 #: ../src/guestfs-actions.pod:4203 ../fish/guestfish-actions.pod:3074
11226 "This command lets you read part of a file. It reads C<count> bytes of "
11227 "C<device>, starting at C<offset>."
11231 #: ../src/guestfs-actions.pod:4209
11232 msgid "See also C<guestfs_pread>."
11236 #: ../src/guestfs-actions.pod:4218
11237 msgid "guestfs_pvcreate"
11241 #: ../src/guestfs-actions.pod:4220
11245 " guestfs_pvcreate (guestfs_h *g,\n"
11246 " const char *device);\n"
11251 #: ../src/guestfs-actions.pod:4224 ../fish/guestfish-actions.pod:3089
11253 "This creates an LVM physical volume on the named C<device>, where C<device> "
11254 "should usually be a partition name such as C</dev/sda1>."
11258 #: ../src/guestfs-actions.pod:4230
11259 msgid "guestfs_pvremove"
11263 #: ../src/guestfs-actions.pod:4232
11267 " guestfs_pvremove (guestfs_h *g,\n"
11268 " const char *device);\n"
11273 #: ../src/guestfs-actions.pod:4236 ../fish/guestfish-actions.pod:3097
11275 "This wipes a physical volume C<device> so that LVM will no longer recognise "
11280 #: ../src/guestfs-actions.pod:4239 ../fish/guestfish-actions.pod:3100
11282 "The implementation uses the C<pvremove> command which refuses to wipe "
11283 "physical volumes that contain any volume groups, so you have to remove those "
11288 #: ../src/guestfs-actions.pod:4245
11289 msgid "guestfs_pvresize"
11293 #: ../src/guestfs-actions.pod:4247
11297 " guestfs_pvresize (guestfs_h *g,\n"
11298 " const char *device);\n"
11303 #: ../src/guestfs-actions.pod:4251 ../fish/guestfish-actions.pod:3108
11305 "This resizes (expands or shrinks) an existing LVM physical volume to match "
11306 "the new size of the underlying device."
11310 #: ../src/guestfs-actions.pod:4256
11311 msgid "guestfs_pvresize_size"
11315 #: ../src/guestfs-actions.pod:4258
11319 " guestfs_pvresize_size (guestfs_h *g,\n"
11320 " const char *device,\n"
11321 " int64_t size);\n"
11326 #: ../src/guestfs-actions.pod:4263
11328 "This command is the same as C<guestfs_pvresize> except that it allows you to "
11329 "specify the new size (in bytes) explicitly."
11333 #: ../src/guestfs-actions.pod:4268
11334 msgid "guestfs_pvs"
11338 #: ../src/guestfs-actions.pod:4270
11342 " guestfs_pvs (guestfs_h *g);\n"
11347 #: ../src/guestfs-actions.pod:4273 ../fish/guestfish-actions.pod:3122
11349 "List all the physical volumes detected. This is the equivalent of the "
11350 "L<pvs(8)> command."
11354 #: ../src/guestfs-actions.pod:4276 ../fish/guestfish-actions.pod:3125
11356 "This returns a list of just the device names that contain PVs "
11357 "(eg. C</dev/sda2>)."
11361 #: ../src/guestfs-actions.pod:4279
11362 msgid "See also C<guestfs_pvs_full>."
11366 #: ../src/guestfs-actions.pod:4285
11367 msgid "guestfs_pvs_full"
11371 #: ../src/guestfs-actions.pod:4287
11374 " struct guestfs_lvm_pv_list *\n"
11375 " guestfs_pvs_full (guestfs_h *g);\n"
11380 #: ../src/guestfs-actions.pod:4290 ../fish/guestfish-actions.pod:3134
11382 "List all the physical volumes detected. This is the equivalent of the "
11383 "L<pvs(8)> command. The \"full\" version includes all fields."
11387 #: ../src/guestfs-actions.pod:4293
11389 "This function returns a C<struct guestfs_lvm_pv_list *> (see "
11390 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
11391 "must call C<guestfs_free_lvm_pv_list> after use>."
11395 #: ../src/guestfs-actions.pod:4298
11396 msgid "guestfs_pvuuid"
11400 #: ../src/guestfs-actions.pod:4300
11404 " guestfs_pvuuid (guestfs_h *g,\n"
11405 " const char *device);\n"
11410 #: ../src/guestfs-actions.pod:4304 ../fish/guestfish-actions.pod:3141
11411 msgid "This command returns the UUID of the LVM PV C<device>."
11415 #: ../src/guestfs-actions.pod:4309
11416 msgid "guestfs_pwrite"
11420 #: ../src/guestfs-actions.pod:4311
11424 " guestfs_pwrite (guestfs_h *g,\n"
11425 " const char *path,\n"
11426 " const char *content,\n"
11427 " size_t content_size,\n"
11428 " int64_t offset);\n"
11433 #: ../src/guestfs-actions.pod:4318 ../fish/guestfish-actions.pod:3147
11435 "This command writes to part of a file. It writes the data buffer C<content> "
11436 "to the file C<path> starting at offset C<offset>."
11440 #: ../src/guestfs-actions.pod:4321 ../fish/guestfish-actions.pod:3150
11442 "This command implements the L<pwrite(2)> system call, and like that system "
11443 "call it may not write the full data requested. The return value is the "
11444 "number of bytes that were actually written to the file. This could even be "
11445 "0, although short writes are unlikely for regular files in ordinary "
11450 #: ../src/guestfs-actions.pod:4327
11451 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
11455 #: ../src/guestfs-actions.pod:4334
11456 msgid "guestfs_pwrite_device"
11460 #: ../src/guestfs-actions.pod:4336
11464 " guestfs_pwrite_device (guestfs_h *g,\n"
11465 " const char *device,\n"
11466 " const char *content,\n"
11467 " size_t content_size,\n"
11468 " int64_t offset);\n"
11473 #: ../src/guestfs-actions.pod:4343 ../fish/guestfish-actions.pod:3165
11475 "This command writes to part of a device. It writes the data buffer "
11476 "C<content> to C<device> starting at offset C<offset>."
11480 #: ../src/guestfs-actions.pod:4346 ../fish/guestfish-actions.pod:3168
11482 "This command implements the L<pwrite(2)> system call, and like that system "
11483 "call it may not write the full data requested (although short writes to disk "
11484 "devices and partitions are probably impossible with standard Linux kernels)."
11488 #: ../src/guestfs-actions.pod:4351
11489 msgid "See also C<guestfs_pwrite>."
11493 #: ../src/guestfs-actions.pod:4358
11494 msgid "guestfs_read_file"
11498 #: ../src/guestfs-actions.pod:4360
11502 " guestfs_read_file (guestfs_h *g,\n"
11503 " const char *path,\n"
11504 " size_t *size_r);\n"
11509 #: ../src/guestfs-actions.pod:4365 ../fish/guestfish-actions.pod:3182
11510 msgid "This calls returns the contents of the file C<path> as a buffer."
11514 #: ../src/guestfs-actions.pod:4368
11516 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
11517 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
11518 "function is limited in the total size of file that can be handled."
11522 #: ../src/guestfs-actions.pod:4380
11523 msgid "guestfs_read_lines"
11527 #: ../src/guestfs-actions.pod:4382
11531 " guestfs_read_lines (guestfs_h *g,\n"
11532 " const char *path);\n"
11537 #: ../src/guestfs-actions.pod:4388 ../fish/guestfish-actions.pod:3199
11539 "The file contents are returned as a list of lines. Trailing C<LF> and "
11540 "C<CRLF> character sequences are I<not> returned."
11544 #: ../src/guestfs-actions.pod:4391
11546 "Note that this function cannot correctly handle binary files (specifically, "
11547 "files containing C<\\0> character which is treated as end of line). For "
11548 "those you need to use the C<guestfs_read_file> function which has a more "
11549 "complex interface."
11553 #: ../src/guestfs-actions.pod:4400
11554 msgid "guestfs_readdir"
11558 #: ../src/guestfs-actions.pod:4402
11561 " struct guestfs_dirent_list *\n"
11562 " guestfs_readdir (guestfs_h *g,\n"
11563 " const char *dir);\n"
11568 #: ../src/guestfs-actions.pod:4406 ../fish/guestfish-actions.pod:3211
11569 msgid "This returns the list of directory entries in directory C<dir>."
11573 #: ../src/guestfs-actions.pod:4408 ../fish/guestfish-actions.pod:3213
11575 "All entries in the directory are returned, including C<.> and C<..>. The "
11576 "entries are I<not> sorted, but returned in the same order as the underlying "
11581 #: ../src/guestfs-actions.pod:4412 ../fish/guestfish-actions.pod:3217
11583 "Also this call returns basic file type information about each file. The "
11584 "C<ftyp> field will contain one of the following characters:"
11588 #: ../src/guestfs-actions.pod:4417 ../fish/guestfish-actions.pod:3222
11593 #: ../src/guestfs-actions.pod:4419 ../fish/guestfish-actions.pod:3224
11594 msgid "Block special"
11598 #: ../src/guestfs-actions.pod:4421 ../fish/guestfish-actions.pod:3226
11603 #: ../src/guestfs-actions.pod:4423 ../fish/guestfish-actions.pod:3228
11604 msgid "Char special"
11608 #: ../src/guestfs-actions.pod:4425 ../fish/guestfish-actions.pod:3230
11613 #: ../src/guestfs-actions.pod:4427 ../fish/guestfish-actions.pod:3232
11618 #: ../src/guestfs-actions.pod:4429 ../fish/guestfish-actions.pod:3234
11623 #: ../src/guestfs-actions.pod:4431 ../fish/guestfish-actions.pod:3236
11624 msgid "FIFO (named pipe)"
11628 #: ../src/guestfs-actions.pod:4433 ../fish/guestfish-actions.pod:3238
11633 #: ../src/guestfs-actions.pod:4435 ../fish/guestfish-actions.pod:3240
11634 msgid "Symbolic link"
11638 #: ../src/guestfs-actions.pod:4437 ../fish/guestfish-actions.pod:3242
11643 #: ../src/guestfs-actions.pod:4439 ../fish/guestfish-actions.pod:3244
11644 msgid "Regular file"
11648 #: ../src/guestfs-actions.pod:4441 ../fish/guestfish-actions.pod:3246
11653 #: ../src/guestfs-actions.pod:4443 ../fish/guestfish-actions.pod:3248
11658 #: ../src/guestfs-actions.pod:4445 ../fish/guestfish-actions.pod:3250
11663 #: ../src/guestfs-actions.pod:4447 ../fish/guestfish-actions.pod:3252
11664 msgid "Unknown file type"
11668 #: ../src/guestfs-actions.pod:4449 ../fish/guestfish-actions.pod:3254
11673 #: ../src/guestfs-actions.pod:4451 ../fish/guestfish-actions.pod:3256
11674 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
11678 #: ../src/guestfs-actions.pod:4456
11680 "This function is primarily intended for use by programs. To get a simple "
11681 "list of names, use C<guestfs_ls>. To get a printable directory for human "
11682 "consumption, use C<guestfs_ll>."
11686 #: ../src/guestfs-actions.pod:4460
11688 "This function returns a C<struct guestfs_dirent_list *> (see "
11689 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
11690 "must call C<guestfs_free_dirent_list> after use>."
11694 #: ../src/guestfs-actions.pod:4465
11695 msgid "guestfs_readlink"
11699 #: ../src/guestfs-actions.pod:4467
11703 " guestfs_readlink (guestfs_h *g,\n"
11704 " const char *path);\n"
11709 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3269
11710 msgid "This command reads the target of a symbolic link."
11714 #: ../src/guestfs-actions.pod:4476
11715 msgid "guestfs_readlinklist"
11719 #: ../src/guestfs-actions.pod:4478
11723 " guestfs_readlinklist (guestfs_h *g,\n"
11724 " const char *path,\n"
11725 " char *const *names);\n"
11730 #: ../src/guestfs-actions.pod:4483 ../fish/guestfish-actions.pod:3275
11732 "This call allows you to do a C<readlink> operation on multiple files, where "
11733 "all files are in the directory C<path>. C<names> is the list of files from "
11738 #: ../src/guestfs-actions.pod:4487 ../fish/guestfish-actions.pod:3279
11740 "On return you get a list of strings, with a one-to-one correspondence to the "
11741 "C<names> list. Each string is the value of the symbolic link."
11745 #: ../src/guestfs-actions.pod:4491 ../fish/guestfish-actions.pod:3283
11747 "If the C<readlink(2)> operation fails on any name, then the corresponding "
11748 "result string is the empty string C<\"\">. However the whole operation is "
11749 "completed even if there were C<readlink(2)> errors, and so you can call this "
11750 "function with names where you don't know if they are symbolic links already "
11751 "(albeit slightly less efficient)."
11755 #: ../src/guestfs-actions.pod:4498 ../fish/guestfish-actions.pod:3290
11757 "This call is intended for programs that want to efficiently list a directory "
11758 "contents without making many round-trips. Very long directory listings "
11759 "might cause the protocol message size to be exceeded, causing this call to "
11760 "fail. The caller must split up such requests into smaller groups of names."
11764 #: ../src/guestfs-actions.pod:4509
11765 msgid "guestfs_realpath"
11769 #: ../src/guestfs-actions.pod:4511
11773 " guestfs_realpath (guestfs_h *g,\n"
11774 " const char *path);\n"
11779 #: ../src/guestfs-actions.pod:4515 ../fish/guestfish-actions.pod:3301
11781 "Return the canonicalized absolute pathname of C<path>. The returned path "
11782 "has no C<.>, C<..> or symbolic link path elements."
11786 #: ../src/guestfs-actions.pod:4521
11787 msgid "guestfs_removexattr"
11791 #: ../src/guestfs-actions.pod:4523
11795 " guestfs_removexattr (guestfs_h *g,\n"
11796 " const char *xattr,\n"
11797 " const char *path);\n"
11802 #: ../src/guestfs-actions.pod:4528 ../fish/guestfish-actions.pod:3308
11803 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
11807 #: ../src/guestfs-actions.pod:4531
11808 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
11812 #: ../src/guestfs-actions.pod:4535
11813 msgid "guestfs_resize2fs"
11817 #: ../src/guestfs-actions.pod:4537
11821 " guestfs_resize2fs (guestfs_h *g,\n"
11822 " const char *device);\n"
11827 #: ../src/guestfs-actions.pod:4541 ../fish/guestfish-actions.pod:3317
11829 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
11830 "underlying device."
11834 #: ../src/guestfs-actions.pod:4544
11836 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
11837 "C<device> before calling this command. For unknown reasons C<resize2fs> "
11838 "sometimes gives an error about this and sometimes not. In any case, it is "
11839 "always safe to call C<guestfs_e2fsck_f> before calling this function."
11843 #: ../src/guestfs-actions.pod:4552
11844 msgid "guestfs_resize2fs_size"
11848 #: ../src/guestfs-actions.pod:4554
11852 " guestfs_resize2fs_size (guestfs_h *g,\n"
11853 " const char *device,\n"
11854 " int64_t size);\n"
11859 #: ../src/guestfs-actions.pod:4559
11861 "This command is the same as C<guestfs_resize2fs> except that it allows you "
11862 "to specify the new size (in bytes) explicitly."
11866 #: ../src/guestfs-actions.pod:4564
11871 #: ../src/guestfs-actions.pod:4566
11875 " guestfs_rm (guestfs_h *g,\n"
11876 " const char *path);\n"
11881 #: ../src/guestfs-actions.pod:4570 ../fish/guestfish-actions.pod:3337
11882 msgid "Remove the single file C<path>."
11886 #: ../src/guestfs-actions.pod:4574
11887 msgid "guestfs_rm_rf"
11891 #: ../src/guestfs-actions.pod:4576
11895 " guestfs_rm_rf (guestfs_h *g,\n"
11896 " const char *path);\n"
11901 #: ../src/guestfs-actions.pod:4580 ../fish/guestfish-actions.pod:3343
11903 "Remove the file or directory C<path>, recursively removing the contents if "
11904 "its a directory. This is like the C<rm -rf> shell command."
11908 #: ../src/guestfs-actions.pod:4586
11909 msgid "guestfs_rmdir"
11913 #: ../src/guestfs-actions.pod:4588
11917 " guestfs_rmdir (guestfs_h *g,\n"
11918 " const char *path);\n"
11923 #: ../src/guestfs-actions.pod:4592 ../fish/guestfish-actions.pod:3351
11924 msgid "Remove the single directory C<path>."
11928 #: ../src/guestfs-actions.pod:4596
11929 msgid "guestfs_rmmountpoint"
11933 #: ../src/guestfs-actions.pod:4598
11937 " guestfs_rmmountpoint (guestfs_h *g,\n"
11938 " const char *exemptpath);\n"
11943 #: ../src/guestfs-actions.pod:4602
11945 "This calls removes a mountpoint that was previously created with "
11946 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
11950 #: ../src/guestfs-actions.pod:4608
11951 msgid "guestfs_scrub_device"
11955 #: ../src/guestfs-actions.pod:4610
11959 " guestfs_scrub_device (guestfs_h *g,\n"
11960 " const char *device);\n"
11965 #: ../src/guestfs-actions.pod:4614 ../fish/guestfish-actions.pod:3365
11967 "This command writes patterns over C<device> to make data retrieval more "
11972 #: ../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
11974 "It is an interface to the L<scrub(1)> program. See that manual page for "
11979 #: ../src/guestfs-actions.pod:4625
11980 msgid "guestfs_scrub_file"
11984 #: ../src/guestfs-actions.pod:4627
11988 " guestfs_scrub_file (guestfs_h *g,\n"
11989 " const char *file);\n"
11994 #: ../src/guestfs-actions.pod:4631 ../fish/guestfish-actions.pod:3378
11996 "This command writes patterns over a file to make data retrieval more "
12001 #: ../src/guestfs-actions.pod:4634 ../fish/guestfish-actions.pod:3381
12002 msgid "The file is I<removed> after scrubbing."
12006 #: ../src/guestfs-actions.pod:4641
12007 msgid "guestfs_scrub_freespace"
12011 #: ../src/guestfs-actions.pod:4643
12015 " guestfs_scrub_freespace (guestfs_h *g,\n"
12016 " const char *dir);\n"
12021 #: ../src/guestfs-actions.pod:4647
12023 "This command creates the directory C<dir> and then fills it with files until "
12024 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
12025 "and deletes them. The intention is to scrub any free space on the partition "
12026 "containing C<dir>."
12030 #: ../src/guestfs-actions.pod:4658
12031 msgid "guestfs_set_append"
12035 #: ../src/guestfs-actions.pod:4660
12039 " guestfs_set_append (guestfs_h *g,\n"
12040 " const char *append);\n"
12045 #: ../src/guestfs-actions.pod:4664 ../fish/guestfish-actions.pod:3405
12047 "This function is used to add additional options to the guest kernel command "
12052 #: ../src/guestfs-actions.pod:4667 ../fish/guestfish-actions.pod:3408
12054 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
12055 "environment variable."
12059 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3411
12061 "Setting C<append> to C<NULL> means I<no> additional options are passed "
12062 "(libguestfs always adds a few of its own)."
12066 #: ../src/guestfs-actions.pod:4675
12067 msgid "guestfs_set_autosync"
12071 #: ../src/guestfs-actions.pod:4677
12075 " guestfs_set_autosync (guestfs_h *g,\n"
12076 " int autosync);\n"
12081 #: ../src/guestfs-actions.pod:4681
12083 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
12084 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
12085 "the handle is closed (also if the program exits without closing handles)."
12089 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3425
12091 "This is enabled by default (since libguestfs 1.5.24, previously it was "
12092 "disabled by default)."
12096 #: ../src/guestfs-actions.pod:4691
12097 msgid "guestfs_set_direct"
12101 #: ../src/guestfs-actions.pod:4693
12105 " guestfs_set_direct (guestfs_h *g,\n"
12111 #: ../src/guestfs-actions.pod:4697 ../fish/guestfish-actions.pod:3434
12113 "If the direct appliance mode flag is enabled, then stdin and stdout are "
12114 "passed directly through to the appliance once it is launched."
12118 #: ../src/guestfs-actions.pod:4701
12120 "One consequence of this is that log messages aren't caught by the library "
12121 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
12126 #: ../src/guestfs-actions.pod:4705 ../fish/guestfish-actions.pod:3442
12127 msgid "You probably don't want to use this unless you know what you are doing."
12131 #: ../src/guestfs-actions.pod:4708 ../fish/guestfish-actions.pod:3445
12132 msgid "The default is disabled."
12136 #: ../src/guestfs-actions.pod:4712
12137 msgid "guestfs_set_e2label"
12141 #: ../src/guestfs-actions.pod:4714
12145 " guestfs_set_e2label (guestfs_h *g,\n"
12146 " const char *device,\n"
12147 " const char *label);\n"
12152 #: ../src/guestfs-actions.pod:4719 ../fish/guestfish-actions.pod:3451
12154 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
12155 "C<label>. Filesystem labels are limited to 16 characters."
12159 #: ../src/guestfs-actions.pod:4723
12161 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
12162 "the existing label on a filesystem."
12166 #: ../src/guestfs-actions.pod:4728
12167 msgid "guestfs_set_e2uuid"
12171 #: ../src/guestfs-actions.pod:4730
12175 " guestfs_set_e2uuid (guestfs_h *g,\n"
12176 " const char *device,\n"
12177 " const char *uuid);\n"
12182 #: ../src/guestfs-actions.pod:4735 ../fish/guestfish-actions.pod:3462
12184 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
12185 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
12186 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
12190 #: ../src/guestfs-actions.pod:4740
12192 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
12193 "the existing UUID of a filesystem."
12197 #: ../src/guestfs-actions.pod:4745
12198 msgid "guestfs_set_memsize"
12202 #: ../src/guestfs-actions.pod:4747
12206 " guestfs_set_memsize (guestfs_h *g,\n"
12212 #: ../src/guestfs-actions.pod:4751
12214 "This sets the memory size in megabytes allocated to the qemu subprocess. "
12215 "This only has any effect if called before C<guestfs_launch>."
12219 #: ../src/guestfs-actions.pod:4755 ../fish/guestfish-actions.pod:3480
12221 "You can also change this by setting the environment variable "
12222 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
12226 #: ../src/guestfs-actions.pod:4764
12227 msgid "guestfs_set_network"
12231 #: ../src/guestfs-actions.pod:4766
12235 " guestfs_set_network (guestfs_h *g,\n"
12241 #: ../src/guestfs-actions.pod:4770 ../fish/guestfish-actions.pod:3493
12243 "If C<network> is true, then the network is enabled in the libguestfs "
12244 "appliance. The default is false."
12248 #: ../src/guestfs-actions.pod:4773 ../fish/guestfish-actions.pod:3496
12250 "This affects whether commands are able to access the network (see "
12251 "L<guestfs(3)/RUNNING COMMANDS>)."
12255 #: ../src/guestfs-actions.pod:4776
12257 "You must call this before calling C<guestfs_launch>, otherwise it has no "
12262 #: ../src/guestfs-actions.pod:4781
12263 msgid "guestfs_set_path"
12267 #: ../src/guestfs-actions.pod:4783
12271 " guestfs_set_path (guestfs_h *g,\n"
12272 " const char *searchpath);\n"
12277 #: ../src/guestfs-actions.pod:4787 ../fish/guestfish-actions.pod:3508
12278 msgid "Set the path that libguestfs searches for kernel and initrd.img."
12282 #: ../src/guestfs-actions.pod:4789 ../fish/guestfish-actions.pod:3510
12284 "The default is C<$libdir/guestfs> unless overridden by setting "
12285 "C<LIBGUESTFS_PATH> environment variable."
12289 #: ../src/guestfs-actions.pod:4792 ../fish/guestfish-actions.pod:3513
12290 msgid "Setting C<path> to C<NULL> restores the default path."
12294 #: ../src/guestfs-actions.pod:4796
12295 msgid "guestfs_set_qemu"
12299 #: ../src/guestfs-actions.pod:4798
12303 " guestfs_set_qemu (guestfs_h *g,\n"
12304 " const char *qemu);\n"
12309 #: ../src/guestfs-actions.pod:4802 ../fish/guestfish-actions.pod:3521
12310 msgid "Set the qemu binary that we will use."
12314 #: ../src/guestfs-actions.pod:4804 ../fish/guestfish-actions.pod:3523
12315 msgid "The default is chosen when the library was compiled by the configure script."
12319 #: ../src/guestfs-actions.pod:4807 ../fish/guestfish-actions.pod:3526
12321 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
12326 #: ../src/guestfs-actions.pod:4810 ../fish/guestfish-actions.pod:3529
12327 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
12331 #: ../src/guestfs-actions.pod:4812 ../fish/guestfish-actions.pod:3531
12333 "Note that you should call this function as early as possible after creating "
12334 "the handle. This is because some pre-launch operations depend on testing "
12335 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
12336 "don't retest features, and so you might see inconsistent results. Using the "
12337 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
12338 "the qemu binary at the same time as the handle is created."
12342 #: ../src/guestfs-actions.pod:4822
12343 msgid "guestfs_set_recovery_proc"
12347 #: ../src/guestfs-actions.pod:4824
12351 " guestfs_set_recovery_proc (guestfs_h *g,\n"
12352 " int recoveryproc);\n"
12357 #: ../src/guestfs-actions.pod:4828
12359 "If this is called with the parameter C<false> then C<guestfs_launch> does "
12360 "not create a recovery process. The purpose of the recovery process is to "
12361 "stop runaway qemu processes in the case where the main program aborts "
12366 #: ../src/guestfs-actions.pod:4833
12368 "This only has any effect if called before C<guestfs_launch>, and the default "
12373 #: ../src/guestfs-actions.pod:4836 ../fish/guestfish-actions.pod:3553
12375 "About the only time when you would want to disable this is if the main "
12376 "process will fork itself into the background (\"daemonize\" itself). In "
12377 "this case the recovery process thinks that the main program has disappeared "
12378 "and so kills qemu, which is not very helpful."
12382 #: ../src/guestfs-actions.pod:4844
12383 msgid "guestfs_set_selinux"
12387 #: ../src/guestfs-actions.pod:4846
12391 " guestfs_set_selinux (guestfs_h *g,\n"
12397 #: ../src/guestfs-actions.pod:4850 ../fish/guestfish-actions.pod:3565
12399 "This sets the selinux flag that is passed to the appliance at boot time. "
12400 "The default is C<selinux=0> (disabled)."
12404 #: ../src/guestfs-actions.pod:4853 ../fish/guestfish-actions.pod:3568
12406 "Note that if SELinux is enabled, it is always in Permissive mode "
12407 "(C<enforcing=0>)."
12411 #: ../src/guestfs-actions.pod:4861
12412 msgid "guestfs_set_trace"
12416 #: ../src/guestfs-actions.pod:4863
12420 " guestfs_set_trace (guestfs_h *g,\n"
12426 #: ../src/guestfs-actions.pod:4867 ../fish/guestfish-actions.pod:3580
12428 "If the command trace flag is set to 1, then commands are printed on stderr "
12429 "before they are executed in a format which is very similar to the one used "
12430 "by guestfish. In other words, you can run a program with this enabled, and "
12431 "you will get out a script which you can feed to guestfish to perform the "
12432 "same set of actions."
12436 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3587
12438 "If you want to trace C API calls into libguestfs (and other libraries) then "
12439 "possibly a better way is to use the external ltrace(1) command."
12443 #: ../src/guestfs-actions.pod:4878 ../fish/guestfish-actions.pod:3591
12445 "Command traces are disabled unless the environment variable "
12446 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
12450 #: ../src/guestfs-actions.pod:4883
12451 msgid "guestfs_set_verbose"
12455 #: ../src/guestfs-actions.pod:4885
12459 " guestfs_set_verbose (guestfs_h *g,\n"
12465 #: ../src/guestfs-actions.pod:4889 ../fish/guestfish-actions.pod:3600
12466 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
12470 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3602
12472 "Verbose messages are disabled unless the environment variable "
12473 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
12477 #: ../src/guestfs-actions.pod:4896
12478 msgid "guestfs_setcon"
12482 #: ../src/guestfs-actions.pod:4898
12486 " guestfs_setcon (guestfs_h *g,\n"
12487 " const char *context);\n"
12492 #: ../src/guestfs-actions.pod:4902 ../fish/guestfish-actions.pod:3609
12494 "This sets the SELinux security context of the daemon to the string "
12499 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3612
12500 msgid "See the documentation about SELINUX in L<guestfs(3)>."
12504 #: ../src/guestfs-actions.pod:4909
12505 msgid "guestfs_setxattr"
12509 #: ../src/guestfs-actions.pod:4911
12513 " guestfs_setxattr (guestfs_h *g,\n"
12514 " const char *xattr,\n"
12515 " const char *val,\n"
12517 " const char *path);\n"
12522 #: ../src/guestfs-actions.pod:4918 ../fish/guestfish-actions.pod:3618
12524 "This call sets the extended attribute named C<xattr> of the file C<path> to "
12525 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
12529 #: ../src/guestfs-actions.pod:4922
12530 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
12534 #: ../src/guestfs-actions.pod:4926
12535 msgid "guestfs_sfdisk"
12539 #: ../src/guestfs-actions.pod:4928
12543 " guestfs_sfdisk (guestfs_h *g,\n"
12544 " const char *device,\n"
12548 " char *const *lines);\n"
12553 #: ../src/guestfs-actions.pod:4936 ../fish/guestfish-actions.pod:3628
12555 "This is a direct interface to the L<sfdisk(8)> program for creating "
12556 "partitions on block devices."
12560 #: ../src/guestfs-actions.pod:4939 ../fish/guestfish-actions.pod:3631
12561 msgid "C<device> should be a block device, for example C</dev/sda>."
12565 #: ../src/guestfs-actions.pod:4941 ../fish/guestfish-actions.pod:3633
12567 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
12568 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
12569 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
12570 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
12571 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
12572 "the kernel) cannot work out the right geometry and you will need to tell it."
12576 #: ../src/guestfs-actions.pod:4949 ../fish/guestfish-actions.pod:3641
12578 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
12579 "refer to the L<sfdisk(8)> manpage."
12583 #: ../src/guestfs-actions.pod:4952 ../fish/guestfish-actions.pod:3644
12585 "To create a single partition occupying the whole disk, you would pass "
12586 "C<lines> as a single element list, when the single element being the string "
12591 #: ../src/guestfs-actions.pod:4956
12592 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
12596 #: ../src/guestfs-actions.pod:4964
12597 msgid "guestfs_sfdiskM"
12601 #: ../src/guestfs-actions.pod:4966
12605 " guestfs_sfdiskM (guestfs_h *g,\n"
12606 " const char *device,\n"
12607 " char *const *lines);\n"
12612 #: ../src/guestfs-actions.pod:4971
12614 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
12615 "partition sizes are specified in megabytes only (rounded to the nearest "
12616 "cylinder) and you don't need to specify the cyls, heads and sectors "
12617 "parameters which were rarely if ever used anyway."
12621 #: ../src/guestfs-actions.pod:4977
12623 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
12624 "C<guestfs_part_disk>"
12628 #: ../src/guestfs-actions.pod:4985
12629 msgid "guestfs_sfdisk_N"
12633 #: ../src/guestfs-actions.pod:4987
12637 " guestfs_sfdisk_N (guestfs_h *g,\n"
12638 " const char *device,\n"
12643 " const char *line);\n"
12648 #: ../src/guestfs-actions.pod:4996 ../fish/guestfish-actions.pod:3674
12650 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
12651 "(note: C<n> counts from 1)."
12655 #: ../src/guestfs-actions.pod:4999
12657 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
12658 "for the cyls/heads/sectors parameters."
12662 #: ../src/guestfs-actions.pod:5002
12663 msgid "See also: C<guestfs_part_add>"
12667 #: ../src/guestfs-actions.pod:5009
12668 msgid "guestfs_sfdisk_disk_geometry"
12672 #: ../src/guestfs-actions.pod:5011
12676 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
12677 " const char *device);\n"
12682 #: ../src/guestfs-actions.pod:5015
12684 "This displays the disk geometry of C<device> read from the partition table. "
12685 "Especially in the case where the underlying block device has been resized, "
12686 "this can be different from the kernel's idea of the geometry (see "
12687 "C<guestfs_sfdisk_kernel_geometry>)."
12691 #: ../src/guestfs-actions.pod:5020 ../src/guestfs-actions.pod:5034 ../fish/guestfish-actions.pod:3694 ../fish/guestfish-actions.pod:3703
12692 msgid "The result is in human-readable format, and not designed to be parsed."
12696 #: ../src/guestfs-actions.pod:5026
12697 msgid "guestfs_sfdisk_kernel_geometry"
12701 #: ../src/guestfs-actions.pod:5028
12705 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
12706 " const char *device);\n"
12711 #: ../src/guestfs-actions.pod:5032 ../fish/guestfish-actions.pod:3701
12712 msgid "This displays the kernel's idea of the geometry of C<device>."
12716 #: ../src/guestfs-actions.pod:5040
12717 msgid "guestfs_sfdisk_l"
12721 #: ../src/guestfs-actions.pod:5042
12725 " guestfs_sfdisk_l (guestfs_h *g,\n"
12726 " const char *device);\n"
12731 #: ../src/guestfs-actions.pod:5046 ../fish/guestfish-actions.pod:3710
12733 "This displays the partition table on C<device>, in the human-readable output "
12734 "of the L<sfdisk(8)> command. It is not intended to be parsed."
12738 #: ../src/guestfs-actions.pod:5050
12739 msgid "See also: C<guestfs_part_list>"
12743 #: ../src/guestfs-actions.pod:5055
12748 #: ../src/guestfs-actions.pod:5057
12752 " guestfs_sh (guestfs_h *g,\n"
12753 " const char *command);\n"
12758 #: ../src/guestfs-actions.pod:5061 ../fish/guestfish-actions.pod:3720
12760 "This call runs a command from the guest filesystem via the guest's "
12765 #: ../src/guestfs-actions.pod:5064
12766 msgid "This is like C<guestfs_command>, but passes the command to:"
12770 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3725
12773 " /bin/sh -c \"command\"\n"
12778 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3727
12780 "Depending on the guest's shell, this usually results in wildcards being "
12781 "expanded, shell expressions being interpolated and so on."
12785 #: ../src/guestfs-actions.pod:5072
12786 msgid "All the provisos about C<guestfs_command> apply to this call."
12790 #: ../src/guestfs-actions.pod:5077
12791 msgid "guestfs_sh_lines"
12795 #: ../src/guestfs-actions.pod:5079
12799 " guestfs_sh_lines (guestfs_h *g,\n"
12800 " const char *command);\n"
12805 #: ../src/guestfs-actions.pod:5083
12807 "This is the same as C<guestfs_sh>, but splits the result into a list of "
12812 #: ../src/guestfs-actions.pod:5086
12813 msgid "See also: C<guestfs_command_lines>"
12817 #: ../src/guestfs-actions.pod:5092
12818 msgid "guestfs_sleep"
12822 #: ../src/guestfs-actions.pod:5094
12826 " guestfs_sleep (guestfs_h *g,\n"
12832 #: ../src/guestfs-actions.pod:5098 ../fish/guestfish-actions.pod:3746
12833 msgid "Sleep for C<secs> seconds."
12837 #: ../src/guestfs-actions.pod:5102 ../src/guestfs-structs.pod:109
12838 msgid "guestfs_stat"
12842 #: ../src/guestfs-actions.pod:5104
12845 " struct guestfs_stat *\n"
12846 " guestfs_stat (guestfs_h *g,\n"
12847 " const char *path);\n"
12852 #: ../src/guestfs-actions.pod:5110 ../fish/guestfish-actions.pod:3754
12853 msgid "This is the same as the C<stat(2)> system call."
12857 #: ../src/guestfs-actions.pod:5116 ../src/guestfs-structs.pod:135
12858 msgid "guestfs_statvfs"
12862 #: ../src/guestfs-actions.pod:5118
12865 " struct guestfs_statvfs *\n"
12866 " guestfs_statvfs (guestfs_h *g,\n"
12867 " const char *path);\n"
12872 #: ../src/guestfs-actions.pod:5122 ../fish/guestfish-actions.pod:3760
12874 "Returns file system statistics for any mounted file system. C<path> should "
12875 "be a file or directory in the mounted file system (typically it is the mount "
12876 "point itself, but it doesn't need to be)."
12880 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3764
12881 msgid "This is the same as the C<statvfs(2)> system call."
12885 #: ../src/guestfs-actions.pod:5128
12887 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
12888 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
12892 #: ../src/guestfs-actions.pod:5132
12893 msgid "guestfs_strings"
12897 #: ../src/guestfs-actions.pod:5134
12901 " guestfs_strings (guestfs_h *g,\n"
12902 " const char *path);\n"
12907 #: ../src/guestfs-actions.pod:5138 ../fish/guestfish-actions.pod:3770
12909 "This runs the L<strings(1)> command on a file and returns the list of "
12910 "printable strings found."
12914 #: ../src/guestfs-actions.pod:5148
12915 msgid "guestfs_strings_e"
12919 #: ../src/guestfs-actions.pod:5150
12923 " guestfs_strings_e (guestfs_h *g,\n"
12924 " const char *encoding,\n"
12925 " const char *path);\n"
12930 #: ../src/guestfs-actions.pod:5155
12932 "This is like the C<guestfs_strings> command, but allows you to specify the "
12933 "encoding of strings that are looked for in the source file C<path>."
12937 #: ../src/guestfs-actions.pod:5159 ../fish/guestfish-actions.pod:3784
12938 msgid "Allowed encodings are:"
12942 #: ../src/guestfs-actions.pod:5163 ../fish/guestfish-actions.pod:3788
12947 #: ../src/guestfs-actions.pod:5165
12949 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
12950 "ISO-8859-X (this is what C<guestfs_strings> uses)."
12954 #: ../src/guestfs-actions.pod:5168 ../fish/guestfish-actions.pod:3793
12959 #: ../src/guestfs-actions.pod:5170 ../fish/guestfish-actions.pod:3795
12960 msgid "Single 8-bit-byte characters."
12964 #: ../src/guestfs-actions.pod:5172 ../fish/guestfish-actions.pod:3797
12969 #: ../src/guestfs-actions.pod:5174 ../fish/guestfish-actions.pod:3799
12970 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
12974 #: ../src/guestfs-actions.pod:5177 ../fish/guestfish-actions.pod:3802
12975 msgid "l (lower case letter L)"
12979 #: ../src/guestfs-actions.pod:5179 ../fish/guestfish-actions.pod:3804
12981 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
12982 "examining binaries in Windows guests."
12986 #: ../src/guestfs-actions.pod:5182 ../fish/guestfish-actions.pod:3807
12991 #: ../src/guestfs-actions.pod:5184 ../fish/guestfish-actions.pod:3809
12992 msgid "32-bit big endian such as UCS-4BE."
12996 #: ../src/guestfs-actions.pod:5186 ../fish/guestfish-actions.pod:3811
13001 #: ../src/guestfs-actions.pod:5188 ../fish/guestfish-actions.pod:3813
13002 msgid "32-bit little endian such as UCS-4LE."
13006 #: ../src/guestfs-actions.pod:5192 ../fish/guestfish-actions.pod:3817
13007 msgid "The returned strings are transcoded to UTF-8."
13011 #: ../src/guestfs-actions.pod:5201
13012 msgid "guestfs_swapoff_device"
13016 #: ../src/guestfs-actions.pod:5203
13020 " guestfs_swapoff_device (guestfs_h *g,\n"
13021 " const char *device);\n"
13026 #: ../src/guestfs-actions.pod:5207
13028 "This command disables the libguestfs appliance swap device or partition "
13029 "named C<device>. See C<guestfs_swapon_device>."
13033 #: ../src/guestfs-actions.pod:5213
13034 msgid "guestfs_swapoff_file"
13038 #: ../src/guestfs-actions.pod:5215
13042 " guestfs_swapoff_file (guestfs_h *g,\n"
13043 " const char *file);\n"
13048 #: ../src/guestfs-actions.pod:5219 ../fish/guestfish-actions.pod:3834
13049 msgid "This command disables the libguestfs appliance swap on file."
13053 #: ../src/guestfs-actions.pod:5223
13054 msgid "guestfs_swapoff_label"
13058 #: ../src/guestfs-actions.pod:5225
13062 " guestfs_swapoff_label (guestfs_h *g,\n"
13063 " const char *label);\n"
13068 #: ../src/guestfs-actions.pod:5229 ../fish/guestfish-actions.pod:3840
13070 "This command disables the libguestfs appliance swap on labeled swap "
13075 #: ../src/guestfs-actions.pod:5234
13076 msgid "guestfs_swapoff_uuid"
13080 #: ../src/guestfs-actions.pod:5236
13084 " guestfs_swapoff_uuid (guestfs_h *g,\n"
13085 " const char *uuid);\n"
13090 #: ../src/guestfs-actions.pod:5240 ../fish/guestfish-actions.pod:3847
13092 "This command disables the libguestfs appliance swap partition with the given "
13097 #: ../src/guestfs-actions.pod:5245
13098 msgid "guestfs_swapon_device"
13102 #: ../src/guestfs-actions.pod:5247
13106 " guestfs_swapon_device (guestfs_h *g,\n"
13107 " const char *device);\n"
13112 #: ../src/guestfs-actions.pod:5251
13114 "This command enables the libguestfs appliance to use the swap device or "
13115 "partition named C<device>. The increased memory is made available for all "
13116 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
13120 #: ../src/guestfs-actions.pod:5256 ../fish/guestfish-actions.pod:3859
13122 "Note that you should not swap to existing guest swap partitions unless you "
13123 "know what you are doing. They may contain hibernation information, or other "
13124 "information that the guest doesn't want you to trash. You also risk leaking "
13125 "information about the host to the guest this way. Instead, attach a new "
13126 "host device to the guest and swap on that."
13130 #: ../src/guestfs-actions.pod:5265
13131 msgid "guestfs_swapon_file"
13135 #: ../src/guestfs-actions.pod:5267
13139 " guestfs_swapon_file (guestfs_h *g,\n"
13140 " const char *file);\n"
13145 #: ../src/guestfs-actions.pod:5271
13147 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
13152 #: ../src/guestfs-actions.pod:5276
13153 msgid "guestfs_swapon_label"
13157 #: ../src/guestfs-actions.pod:5278
13161 " guestfs_swapon_label (guestfs_h *g,\n"
13162 " const char *label);\n"
13167 #: ../src/guestfs-actions.pod:5282
13169 "This command enables swap to a labeled swap partition. See "
13170 "C<guestfs_swapon_device> for other notes."
13174 #: ../src/guestfs-actions.pod:5287
13175 msgid "guestfs_swapon_uuid"
13179 #: ../src/guestfs-actions.pod:5289
13183 " guestfs_swapon_uuid (guestfs_h *g,\n"
13184 " const char *uuid);\n"
13189 #: ../src/guestfs-actions.pod:5293
13191 "This command enables swap to a swap partition with the given UUID. See "
13192 "C<guestfs_swapon_device> for other notes."
13196 #: ../src/guestfs-actions.pod:5298
13197 msgid "guestfs_sync"
13201 #: ../src/guestfs-actions.pod:5300
13205 " guestfs_sync (guestfs_h *g);\n"
13210 #: ../src/guestfs-actions.pod:5303 ../fish/guestfish-actions.pod:3891
13212 "This syncs the disk, so that any writes are flushed through to the "
13213 "underlying disk image."
13217 #: ../src/guestfs-actions.pod:5306 ../fish/guestfish-actions.pod:3894
13219 "You should always call this if you have modified a disk image, before "
13220 "closing the handle."
13224 #: ../src/guestfs-actions.pod:5311
13225 msgid "guestfs_tail"
13229 #: ../src/guestfs-actions.pod:5313
13233 " guestfs_tail (guestfs_h *g,\n"
13234 " const char *path);\n"
13239 #: ../src/guestfs-actions.pod:5317 ../fish/guestfish-actions.pod:3901
13240 msgid "This command returns up to the last 10 lines of a file as a list of strings."
13244 #: ../src/guestfs-actions.pod:5327
13245 msgid "guestfs_tail_n"
13249 #: ../src/guestfs-actions.pod:5329
13253 " guestfs_tail_n (guestfs_h *g,\n"
13255 " const char *path);\n"
13260 #: ../src/guestfs-actions.pod:5334 ../fish/guestfish-actions.pod:3911
13262 "If the parameter C<nrlines> is a positive number, this returns the last "
13263 "C<nrlines> lines of the file C<path>."
13267 #: ../src/guestfs-actions.pod:5337 ../fish/guestfish-actions.pod:3914
13269 "If the parameter C<nrlines> is a negative number, this returns lines from "
13270 "the file C<path>, starting with the C<-nrlines>th line."
13274 #: ../src/guestfs-actions.pod:5349
13275 msgid "guestfs_tar_in"
13279 #: ../src/guestfs-actions.pod:5351
13283 " guestfs_tar_in (guestfs_h *g,\n"
13284 " const char *tarfile,\n"
13285 " const char *directory);\n"
13290 #: ../src/guestfs-actions.pod:5356 ../fish/guestfish-actions.pod:3926
13292 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
13293 "tar file) into C<directory>."
13297 #: ../src/guestfs-actions.pod:5359
13298 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
13302 #: ../src/guestfs-actions.pod:5364
13303 msgid "guestfs_tar_out"
13307 #: ../src/guestfs-actions.pod:5366
13311 " guestfs_tar_out (guestfs_h *g,\n"
13312 " const char *directory,\n"
13313 " const char *tarfile);\n"
13318 #: ../src/guestfs-actions.pod:5371 ../fish/guestfish-actions.pod:3938
13320 "This command packs the contents of C<directory> and downloads it to local "
13325 #: ../src/guestfs-actions.pod:5374
13327 "To download a compressed tarball, use C<guestfs_tgz_out> or "
13328 "C<guestfs_txz_out>."
13332 #: ../src/guestfs-actions.pod:5379
13333 msgid "guestfs_tgz_in"
13337 #: ../src/guestfs-actions.pod:5381
13341 " guestfs_tgz_in (guestfs_h *g,\n"
13342 " const char *tarball,\n"
13343 " const char *directory);\n"
13348 #: ../src/guestfs-actions.pod:5386 ../fish/guestfish-actions.pod:3950
13350 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
13351 "tar file) into C<directory>."
13355 #: ../src/guestfs-actions.pod:5389
13356 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
13360 #: ../src/guestfs-actions.pod:5393
13361 msgid "guestfs_tgz_out"
13365 #: ../src/guestfs-actions.pod:5395
13369 " guestfs_tgz_out (guestfs_h *g,\n"
13370 " const char *directory,\n"
13371 " const char *tarball);\n"
13376 #: ../src/guestfs-actions.pod:5400 ../fish/guestfish-actions.pod:3961
13378 "This command packs the contents of C<directory> and downloads it to local "
13383 #: ../src/guestfs-actions.pod:5403
13384 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
13388 #: ../src/guestfs-actions.pod:5407
13389 msgid "guestfs_touch"
13393 #: ../src/guestfs-actions.pod:5409
13397 " guestfs_touch (guestfs_h *g,\n"
13398 " const char *path);\n"
13403 #: ../src/guestfs-actions.pod:5413 ../fish/guestfish-actions.pod:3972
13405 "Touch acts like the L<touch(1)> command. It can be used to update the "
13406 "timestamps on a file, or, if the file does not exist, to create a new "
13407 "zero-length file."
13411 #: ../src/guestfs-actions.pod:5417 ../fish/guestfish-actions.pod:3976
13413 "This command only works on regular files, and will fail on other file types "
13414 "such as directories, symbolic links, block special etc."
13418 #: ../src/guestfs-actions.pod:5422
13419 msgid "guestfs_truncate"
13423 #: ../src/guestfs-actions.pod:5424
13427 " guestfs_truncate (guestfs_h *g,\n"
13428 " const char *path);\n"
13433 #: ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3983
13435 "This command truncates C<path> to a zero-length file. The file must exist "
13440 #: ../src/guestfs-actions.pod:5433
13441 msgid "guestfs_truncate_size"
13445 #: ../src/guestfs-actions.pod:5435
13449 " guestfs_truncate_size (guestfs_h *g,\n"
13450 " const char *path,\n"
13451 " int64_t size);\n"
13456 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3990
13458 "This command truncates C<path> to size C<size> bytes. The file must exist "
13463 #: ../src/guestfs-actions.pod:5443
13465 "If the current file size is less than C<size> then the file is extended to "
13466 "the required size with zero bytes. This creates a sparse file (ie. disk "
13467 "blocks are not allocated for the file until you write to it). To create a "
13468 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
13472 #: ../src/guestfs-actions.pod:5451
13473 msgid "guestfs_tune2fs_l"
13477 #: ../src/guestfs-actions.pod:5453
13481 " guestfs_tune2fs_l (guestfs_h *g,\n"
13482 " const char *device);\n"
13487 #: ../src/guestfs-actions.pod:5457 ../fish/guestfish-actions.pod:4003
13489 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
13494 #: ../src/guestfs-actions.pod:5460 ../fish/guestfish-actions.pod:4006
13496 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
13497 "for more details. The list of fields returned isn't clearly defined, and "
13498 "depends on both the version of C<tune2fs> that libguestfs was built against, "
13499 "and the filesystem itself."
13503 #: ../src/guestfs-actions.pod:5471
13504 msgid "guestfs_txz_in"
13508 #: ../src/guestfs-actions.pod:5473
13512 " guestfs_txz_in (guestfs_h *g,\n"
13513 " const char *tarball,\n"
13514 " const char *directory);\n"
13519 #: ../src/guestfs-actions.pod:5478 ../fish/guestfish-actions.pod:4015
13521 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
13522 "tar file) into C<directory>."
13526 #: ../src/guestfs-actions.pod:5483
13527 msgid "guestfs_txz_out"
13531 #: ../src/guestfs-actions.pod:5485
13535 " guestfs_txz_out (guestfs_h *g,\n"
13536 " const char *directory,\n"
13537 " const char *tarball);\n"
13542 #: ../src/guestfs-actions.pod:5490 ../fish/guestfish-actions.pod:4024
13544 "This command packs the contents of C<directory> and downloads it to local "
13545 "file C<tarball> (as an xz compressed tar archive)."
13549 #: ../src/guestfs-actions.pod:5495
13550 msgid "guestfs_umask"
13554 #: ../src/guestfs-actions.pod:5497
13558 " guestfs_umask (guestfs_h *g,\n"
13564 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:4033
13566 "This function sets the mask used for creating new files and device nodes to "
13571 #: ../src/guestfs-actions.pod:5504 ../fish/guestfish-actions.pod:4036
13573 "Typical umask values would be C<022> which creates new files with "
13574 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
13575 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
13579 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:4041
13581 "The default umask is C<022>. This is important because it means that "
13582 "directories and device nodes will be created with C<0644> or C<0755> mode "
13583 "even if you specify C<0777>."
13587 #: ../src/guestfs-actions.pod:5513
13589 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
13590 "C<guestfs_mkdir>."
13594 #: ../src/guestfs-actions.pod:5516 ../fish/guestfish-actions.pod:4048
13595 msgid "This call returns the previous umask."
13599 #: ../src/guestfs-actions.pod:5520
13600 msgid "guestfs_umount"
13604 #: ../src/guestfs-actions.pod:5522
13608 " guestfs_umount (guestfs_h *g,\n"
13609 " const char *pathordevice);\n"
13614 #: ../src/guestfs-actions.pod:5526 ../fish/guestfish-actions.pod:4056
13616 "This unmounts the given filesystem. The filesystem may be specified either "
13617 "by its mountpoint (path) or the device which contains the filesystem."
13621 #: ../src/guestfs-actions.pod:5532
13622 msgid "guestfs_umount_all"
13626 #: ../src/guestfs-actions.pod:5534
13630 " guestfs_umount_all (guestfs_h *g);\n"
13635 #: ../src/guestfs-actions.pod:5537 ../fish/guestfish-actions.pod:4066
13636 msgid "This unmounts all mounted filesystems."
13640 #: ../src/guestfs-actions.pod:5539 ../fish/guestfish-actions.pod:4068
13641 msgid "Some internal mounts are not unmounted by this call."
13645 #: ../src/guestfs-actions.pod:5543
13646 msgid "guestfs_upload"
13650 #: ../src/guestfs-actions.pod:5545
13654 " guestfs_upload (guestfs_h *g,\n"
13655 " const char *filename,\n"
13656 " const char *remotefilename);\n"
13661 #: ../src/guestfs-actions.pod:5550 ../src/guestfs-actions.pod:5567 ../fish/guestfish-actions.pod:4074 ../fish/guestfish-actions.pod:4087
13662 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
13666 #: ../src/guestfs-actions.pod:5555
13667 msgid "See also C<guestfs_download>."
13671 #: ../src/guestfs-actions.pod:5559
13672 msgid "guestfs_upload_offset"
13676 #: ../src/guestfs-actions.pod:5561
13680 " guestfs_upload_offset (guestfs_h *g,\n"
13681 " const char *filename,\n"
13682 " const char *remotefilename,\n"
13683 " int64_t offset);\n"
13688 #: ../src/guestfs-actions.pod:5570 ../fish/guestfish-actions.pod:4090
13690 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
13691 "The intention is to overwrite parts of existing files or devices, although "
13692 "if a non-existant file is specified then it is created with a \"hole\" "
13693 "before C<offset>. The size of the data written is implicit in the size of "
13694 "the source C<filename>."
13698 #: ../src/guestfs-actions.pod:5577
13700 "Note that there is no limit on the amount of data that can be uploaded with "
13701 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
13702 "full amount unless an error occurs."
13706 #: ../src/guestfs-actions.pod:5582
13707 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
13711 #: ../src/guestfs-actions.pod:5586
13712 msgid "guestfs_utimens"
13716 #: ../src/guestfs-actions.pod:5588
13720 " guestfs_utimens (guestfs_h *g,\n"
13721 " const char *path,\n"
13722 " int64_t atsecs,\n"
13723 " int64_t atnsecs,\n"
13724 " int64_t mtsecs,\n"
13725 " int64_t mtnsecs);\n"
13730 #: ../src/guestfs-actions.pod:5596 ../fish/guestfish-actions.pod:4110
13731 msgid "This command sets the timestamps of a file with nanosecond precision."
13735 #: ../src/guestfs-actions.pod:5599 ../fish/guestfish-actions.pod:4113
13737 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
13742 #: ../src/guestfs-actions.pod:5602 ../fish/guestfish-actions.pod:4116
13744 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
13745 "nanoseconds from the epoch."
13749 #: ../src/guestfs-actions.pod:5605 ../fish/guestfish-actions.pod:4119
13751 "If the C<*nsecs> field contains the special value C<-1> then the "
13752 "corresponding timestamp is set to the current time. (The C<*secs> field is "
13753 "ignored in this case)."
13757 #: ../src/guestfs-actions.pod:5609 ../fish/guestfish-actions.pod:4123
13759 "If the C<*nsecs> field contains the special value C<-2> then the "
13760 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
13765 #: ../src/guestfs-actions.pod:5615 ../src/guestfs-structs.pod:175
13766 msgid "guestfs_version"
13770 #: ../src/guestfs-actions.pod:5617
13773 " struct guestfs_version *\n"
13774 " guestfs_version (guestfs_h *g);\n"
13779 #: ../src/guestfs-actions.pod:5620 ../fish/guestfish-actions.pod:4131
13780 msgid "Return the libguestfs version number that the program is linked against."
13784 #: ../src/guestfs-actions.pod:5623 ../fish/guestfish-actions.pod:4134
13786 "Note that because of dynamic linking this is not necessarily the version of "
13787 "libguestfs that you compiled against. You can compile the program, and then "
13788 "at runtime dynamically link against a completely different C<libguestfs.so> "
13793 #: ../src/guestfs-actions.pod:5628 ../fish/guestfish-actions.pod:4139
13795 "This call was added in version C<1.0.58>. In previous versions of "
13796 "libguestfs there was no way to get the version number. From C code you can "
13797 "use dynamic linker functions to find out if this symbol exists (if it "
13798 "doesn't, then it's an earlier version)."
13802 #: ../src/guestfs-actions.pod:5634 ../fish/guestfish-actions.pod:4145
13804 "The call returns a structure with four elements. The first three (C<major>, "
13805 "C<minor> and C<release>) are numbers and correspond to the usual version "
13806 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
13807 "but may be used for distro-specific information."
13811 #: ../src/guestfs-actions.pod:5640 ../fish/guestfish-actions.pod:4151
13812 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
13816 #: ../src/guestfs-actions.pod:5643 ../fish/guestfish-actions.pod:4154
13817 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
13821 #: ../src/guestfs-actions.pod:5645
13823 "I<Note:> Don't use this call to test for availability of features. In "
13824 "enterprise distributions we backport features from later versions into "
13825 "earlier versions, making this an unreliable way to test for features. Use "
13826 "C<guestfs_available> instead."
13830 #: ../src/guestfs-actions.pod:5651
13832 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
13833 "error. I<The caller must call C<guestfs_free_version> after use>."
13837 #: ../src/guestfs-actions.pod:5655
13838 msgid "guestfs_vfs_label"
13842 #: ../src/guestfs-actions.pod:5657
13846 " guestfs_vfs_label (guestfs_h *g,\n"
13847 " const char *device);\n"
13852 #: ../src/guestfs-actions.pod:5661 ../fish/guestfish-actions.pod:4166
13853 msgid "This returns the filesystem label of the filesystem on C<device>."
13857 #: ../src/guestfs-actions.pod:5664 ../fish/guestfish-actions.pod:4169
13858 msgid "If the filesystem is unlabeled, this returns the empty string."
13862 #: ../src/guestfs-actions.pod:5666
13863 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
13867 #: ../src/guestfs-actions.pod:5671
13868 msgid "guestfs_vfs_type"
13872 #: ../src/guestfs-actions.pod:5673
13876 " guestfs_vfs_type (guestfs_h *g,\n"
13877 " const char *device);\n"
13882 #: ../src/guestfs-actions.pod:5677 ../fish/guestfish-actions.pod:4177
13884 "This command gets the filesystem type corresponding to the filesystem on "
13889 #: ../src/guestfs-actions.pod:5680 ../fish/guestfish-actions.pod:4180
13891 "For most filesystems, the result is the name of the Linux VFS module which "
13892 "would be used to mount this filesystem if you mounted it without specifying "
13893 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
13897 #: ../src/guestfs-actions.pod:5688
13898 msgid "guestfs_vfs_uuid"
13902 #: ../src/guestfs-actions.pod:5690
13906 " guestfs_vfs_uuid (guestfs_h *g,\n"
13907 " const char *device);\n"
13912 #: ../src/guestfs-actions.pod:5694 ../fish/guestfish-actions.pod:4189
13913 msgid "This returns the filesystem UUID of the filesystem on C<device>."
13917 #: ../src/guestfs-actions.pod:5697 ../fish/guestfish-actions.pod:4192
13918 msgid "If the filesystem does not have a UUID, this returns the empty string."
13922 #: ../src/guestfs-actions.pod:5699
13923 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
13927 #: ../src/guestfs-actions.pod:5704
13928 msgid "guestfs_vg_activate"
13932 #: ../src/guestfs-actions.pod:5706
13936 " guestfs_vg_activate (guestfs_h *g,\n"
13938 " char *const *volgroups);\n"
13943 #: ../src/guestfs-actions.pod:5711 ../fish/guestfish-actions.pod:4200
13945 "This command activates or (if C<activate> is false) deactivates all logical "
13946 "volumes in the listed volume groups C<volgroups>. If activated, then they "
13947 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
13948 "deactivated, then those devices disappear."
13952 #: ../src/guestfs-actions.pod:5717 ../fish/guestfish-actions.pod:4206
13953 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
13957 #: ../src/guestfs-actions.pod:5719 ../fish/guestfish-actions.pod:4208
13959 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
13960 "activated or deactivated."
13964 #: ../src/guestfs-actions.pod:5724
13965 msgid "guestfs_vg_activate_all"
13969 #: ../src/guestfs-actions.pod:5726
13973 " guestfs_vg_activate_all (guestfs_h *g,\n"
13974 " int activate);\n"
13979 #: ../src/guestfs-actions.pod:5730 ../fish/guestfish-actions.pod:4215
13981 "This command activates or (if C<activate> is false) deactivates all logical "
13982 "volumes in all volume groups. If activated, then they are made known to the "
13983 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
13984 "those devices disappear."
13988 #: ../src/guestfs-actions.pod:5736 ../fish/guestfish-actions.pod:4221
13989 msgid "This command is the same as running C<vgchange -a y|n>"
13993 #: ../src/guestfs-actions.pod:5740
13994 msgid "guestfs_vgcreate"
13998 #: ../src/guestfs-actions.pod:5742
14002 " guestfs_vgcreate (guestfs_h *g,\n"
14003 " const char *volgroup,\n"
14004 " char *const *physvols);\n"
14009 #: ../src/guestfs-actions.pod:5747 ../fish/guestfish-actions.pod:4227
14011 "This creates an LVM volume group called C<volgroup> from the non-empty list "
14012 "of physical volumes C<physvols>."
14016 #: ../src/guestfs-actions.pod:5752
14017 msgid "guestfs_vglvuuids"
14021 #: ../src/guestfs-actions.pod:5754
14025 " guestfs_vglvuuids (guestfs_h *g,\n"
14026 " const char *vgname);\n"
14031 #: ../src/guestfs-actions.pod:5758 ../fish/guestfish-actions.pod:4234
14033 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
14034 "volumes created in this volume group."
14038 #: ../src/guestfs-actions.pod:5761
14040 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
14041 "associate logical volumes and volume groups."
14045 #: ../src/guestfs-actions.pod:5764
14046 msgid "See also C<guestfs_vgpvuuids>."
14050 #: ../src/guestfs-actions.pod:5770
14051 msgid "guestfs_vgpvuuids"
14055 #: ../src/guestfs-actions.pod:5772
14059 " guestfs_vgpvuuids (guestfs_h *g,\n"
14060 " const char *vgname);\n"
14065 #: ../src/guestfs-actions.pod:5776 ../fish/guestfish-actions.pod:4246
14067 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
14068 "volumes that this volume group resides on."
14072 #: ../src/guestfs-actions.pod:5779
14074 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
14075 "associate physical volumes and volume groups."
14079 #: ../src/guestfs-actions.pod:5782
14080 msgid "See also C<guestfs_vglvuuids>."
14084 #: ../src/guestfs-actions.pod:5788
14085 msgid "guestfs_vgremove"
14089 #: ../src/guestfs-actions.pod:5790
14093 " guestfs_vgremove (guestfs_h *g,\n"
14094 " const char *vgname);\n"
14099 #: ../src/guestfs-actions.pod:5794 ../fish/guestfish-actions.pod:4258
14100 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
14104 #: ../src/guestfs-actions.pod:5796 ../fish/guestfish-actions.pod:4260
14105 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
14109 #: ../src/guestfs-actions.pod:5801
14110 msgid "guestfs_vgrename"
14114 #: ../src/guestfs-actions.pod:5803
14118 " guestfs_vgrename (guestfs_h *g,\n"
14119 " const char *volgroup,\n"
14120 " const char *newvolgroup);\n"
14125 #: ../src/guestfs-actions.pod:5808 ../fish/guestfish-actions.pod:4267
14126 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
14130 #: ../src/guestfs-actions.pod:5812
14131 msgid "guestfs_vgs"
14135 #: ../src/guestfs-actions.pod:5814
14139 " guestfs_vgs (guestfs_h *g);\n"
14144 #: ../src/guestfs-actions.pod:5817 ../fish/guestfish-actions.pod:4273
14146 "List all the volumes groups detected. This is the equivalent of the "
14147 "L<vgs(8)> command."
14151 #: ../src/guestfs-actions.pod:5820 ../fish/guestfish-actions.pod:4276
14153 "This returns a list of just the volume group names that were detected "
14154 "(eg. C<VolGroup00>)."
14158 #: ../src/guestfs-actions.pod:5823
14159 msgid "See also C<guestfs_vgs_full>."
14163 #: ../src/guestfs-actions.pod:5829
14164 msgid "guestfs_vgs_full"
14168 #: ../src/guestfs-actions.pod:5831
14171 " struct guestfs_lvm_vg_list *\n"
14172 " guestfs_vgs_full (guestfs_h *g);\n"
14177 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:4285
14179 "List all the volumes groups detected. This is the equivalent of the "
14180 "L<vgs(8)> command. The \"full\" version includes all fields."
14184 #: ../src/guestfs-actions.pod:5837
14186 "This function returns a C<struct guestfs_lvm_vg_list *> (see "
14187 "E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
14188 "must call C<guestfs_free_lvm_vg_list> after use>."
14192 #: ../src/guestfs-actions.pod:5842
14193 msgid "guestfs_vgscan"
14197 #: ../src/guestfs-actions.pod:5844
14201 " guestfs_vgscan (guestfs_h *g);\n"
14206 #: ../src/guestfs-actions.pod:5847 ../fish/guestfish-actions.pod:4292
14208 "This rescans all block devices and rebuilds the list of LVM physical "
14209 "volumes, volume groups and logical volumes."
14213 #: ../src/guestfs-actions.pod:5852
14214 msgid "guestfs_vguuid"
14218 #: ../src/guestfs-actions.pod:5854
14222 " guestfs_vguuid (guestfs_h *g,\n"
14223 " const char *vgname);\n"
14228 #: ../src/guestfs-actions.pod:5858 ../fish/guestfish-actions.pod:4299
14229 msgid "This command returns the UUID of the LVM VG named C<vgname>."
14233 #: ../src/guestfs-actions.pod:5863
14234 msgid "guestfs_wait_ready"
14238 #: ../src/guestfs-actions.pod:5865
14242 " guestfs_wait_ready (guestfs_h *g);\n"
14247 #: ../src/guestfs-actions.pod:5868
14248 msgid "This function is a no op."
14252 #: ../src/guestfs-actions.pod:5870
14254 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
14255 "calling C<guestfs_launch> to wait for the launch to complete. However this "
14256 "is no longer necessary because C<guestfs_launch> now does the waiting."
14260 #: ../src/guestfs-actions.pod:5875
14262 "If you see any calls to this function in code then you can just remove them, "
14263 "unless you want to retain compatibility with older versions of the API."
14267 #: ../src/guestfs-actions.pod:5881
14268 msgid "guestfs_wc_c"
14272 #: ../src/guestfs-actions.pod:5883
14276 " guestfs_wc_c (guestfs_h *g,\n"
14277 " const char *path);\n"
14282 #: ../src/guestfs-actions.pod:5887 ../fish/guestfish-actions.pod:4305
14284 "This command counts the characters in a file, using the C<wc -c> external "
14289 #: ../src/guestfs-actions.pod:5892
14290 msgid "guestfs_wc_l"
14294 #: ../src/guestfs-actions.pod:5894
14298 " guestfs_wc_l (guestfs_h *g,\n"
14299 " const char *path);\n"
14304 #: ../src/guestfs-actions.pod:5898 ../fish/guestfish-actions.pod:4312
14306 "This command counts the lines in a file, using the C<wc -l> external "
14311 #: ../src/guestfs-actions.pod:5903
14312 msgid "guestfs_wc_w"
14316 #: ../src/guestfs-actions.pod:5905
14320 " guestfs_wc_w (guestfs_h *g,\n"
14321 " const char *path);\n"
14326 #: ../src/guestfs-actions.pod:5909 ../fish/guestfish-actions.pod:4319
14328 "This command counts the words in a file, using the C<wc -w> external "
14333 #: ../src/guestfs-actions.pod:5914
14334 msgid "guestfs_write"
14338 #: ../src/guestfs-actions.pod:5916
14342 " guestfs_write (guestfs_h *g,\n"
14343 " const char *path,\n"
14344 " const char *content,\n"
14345 " size_t content_size);\n"
14350 #: ../src/guestfs-actions.pod:5922 ../fish/guestfish-actions.pod:4326
14352 "This call creates a file called C<path>. The content of the file is the "
14353 "string C<content> (which can contain any 8 bit data)."
14357 #: ../src/guestfs-actions.pod:5930
14358 msgid "guestfs_write_file"
14362 #: ../src/guestfs-actions.pod:5932
14366 " guestfs_write_file (guestfs_h *g,\n"
14367 " const char *path,\n"
14368 " const char *content,\n"
14374 #: ../src/guestfs-actions.pod:5938 ../fish/guestfish-actions.pod:4336
14376 "This call creates a file called C<path>. The contents of the file is the "
14377 "string C<content> (which can contain any 8 bit data), with length C<size>."
14381 #: ../src/guestfs-actions.pod:5942 ../fish/guestfish-actions.pod:4340
14383 "As a special case, if C<size> is C<0> then the length is calculated using "
14384 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
14388 #: ../src/guestfs-actions.pod:5946 ../fish/guestfish-actions.pod:4344
14390 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
14391 "I<not> work, even if the length is specified."
14395 #: ../src/guestfs-actions.pod:5954 ../fish/guestfish-actions.pod:4350
14396 msgid "This function is deprecated. In new code, use the C<write> call instead."
14400 #: ../src/guestfs-actions.pod:5961
14401 msgid "guestfs_zegrep"
14405 #: ../src/guestfs-actions.pod:5963
14409 " guestfs_zegrep (guestfs_h *g,\n"
14410 " const char *regex,\n"
14411 " const char *path);\n"
14416 #: ../src/guestfs-actions.pod:5968 ../fish/guestfish-actions.pod:4361
14417 msgid "This calls the external C<zegrep> program and returns the matching lines."
14421 #: ../src/guestfs-actions.pod:5978
14422 msgid "guestfs_zegrepi"
14426 #: ../src/guestfs-actions.pod:5980
14430 " guestfs_zegrepi (guestfs_h *g,\n"
14431 " const char *regex,\n"
14432 " const char *path);\n"
14437 #: ../src/guestfs-actions.pod:5985 ../fish/guestfish-actions.pod:4371
14438 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
14442 #: ../src/guestfs-actions.pod:5995
14443 msgid "guestfs_zero"
14447 #: ../src/guestfs-actions.pod:5997
14451 " guestfs_zero (guestfs_h *g,\n"
14452 " const char *device);\n"
14457 #: ../src/guestfs-actions.pod:6001 ../fish/guestfish-actions.pod:4381
14458 msgid "This command writes zeroes over the first few blocks of C<device>."
14462 #: ../src/guestfs-actions.pod:6003 ../fish/guestfish-actions.pod:4383
14464 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
14465 "securely wipe the device). It should be sufficient to remove any partition "
14466 "tables, filesystem superblocks and so on."
14470 #: ../src/guestfs-actions.pod:6007
14471 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
14475 #: ../src/guestfs-actions.pod:6016
14476 msgid "guestfs_zero_device"
14480 #: ../src/guestfs-actions.pod:6018
14484 " guestfs_zero_device (guestfs_h *g,\n"
14485 " const char *device);\n"
14490 #: ../src/guestfs-actions.pod:6022
14492 "This command writes zeroes over the entire C<device>. Compare with "
14493 "C<guestfs_zero> which just zeroes the first few blocks of a device."
14497 #: ../src/guestfs-actions.pod:6036
14498 msgid "guestfs_zerofree"
14502 #: ../src/guestfs-actions.pod:6038
14506 " guestfs_zerofree (guestfs_h *g,\n"
14507 " const char *device);\n"
14512 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:4404
14514 "This runs the I<zerofree> program on C<device>. This program claims to zero "
14515 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
14516 "possible to compress the filesystem more effectively."
14520 #: ../src/guestfs-actions.pod:6047 ../fish/guestfish-actions.pod:4409
14521 msgid "You should B<not> run this program if the filesystem is mounted."
14525 #: ../src/guestfs-actions.pod:6050 ../fish/guestfish-actions.pod:4412
14527 "It is possible that using this program can damage the filesystem or data on "
14532 #: ../src/guestfs-actions.pod:6055
14533 msgid "guestfs_zfgrep"
14537 #: ../src/guestfs-actions.pod:6057
14541 " guestfs_zfgrep (guestfs_h *g,\n"
14542 " const char *pattern,\n"
14543 " const char *path);\n"
14548 #: ../src/guestfs-actions.pod:6062 ../fish/guestfish-actions.pod:4419
14549 msgid "This calls the external C<zfgrep> program and returns the matching lines."
14553 #: ../src/guestfs-actions.pod:6072
14554 msgid "guestfs_zfgrepi"
14558 #: ../src/guestfs-actions.pod:6074
14562 " guestfs_zfgrepi (guestfs_h *g,\n"
14563 " const char *pattern,\n"
14564 " const char *path);\n"
14569 #: ../src/guestfs-actions.pod:6079 ../fish/guestfish-actions.pod:4429
14570 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
14574 #: ../src/guestfs-actions.pod:6089
14575 msgid "guestfs_zfile"
14579 #: ../src/guestfs-actions.pod:6091
14583 " guestfs_zfile (guestfs_h *g,\n"
14584 " const char *meth,\n"
14585 " const char *path);\n"
14590 #: ../src/guestfs-actions.pod:6096 ../fish/guestfish-actions.pod:4439
14591 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
14595 #: ../src/guestfs-actions.pod:6099 ../fish/guestfish-actions.pod:4442
14596 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
14600 #: ../src/guestfs-actions.pod:6101
14602 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
14607 #: ../src/guestfs-actions.pod:6107 ../fish/guestfish-actions.pod:4447
14608 msgid "This function is deprecated. In new code, use the C<file> call instead."
14612 #: ../src/guestfs-actions.pod:6114
14613 msgid "guestfs_zgrep"
14617 #: ../src/guestfs-actions.pod:6116
14621 " guestfs_zgrep (guestfs_h *g,\n"
14622 " const char *regex,\n"
14623 " const char *path);\n"
14628 #: ../src/guestfs-actions.pod:6121 ../fish/guestfish-actions.pod:4458
14629 msgid "This calls the external C<zgrep> program and returns the matching lines."
14633 #: ../src/guestfs-actions.pod:6131
14634 msgid "guestfs_zgrepi"
14638 #: ../src/guestfs-actions.pod:6133
14642 " guestfs_zgrepi (guestfs_h *g,\n"
14643 " const char *regex,\n"
14644 " const char *path);\n"
14649 #: ../src/guestfs-actions.pod:6138 ../fish/guestfish-actions.pod:4468
14650 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
14654 #: ../src/guestfs-availability.pod:3
14659 #: ../src/guestfs-availability.pod:5
14661 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
14662 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
14663 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
14664 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
14665 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
14669 #: ../src/guestfs-availability.pod:21
14674 #: ../src/guestfs-availability.pod:23
14676 "The following functions: L</guestfs_inotify_add_watch> "
14677 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
14678 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
14682 #: ../src/guestfs-availability.pod:31
14683 msgid "B<linuxfsuuid>"
14687 #: ../src/guestfs-availability.pod:33
14689 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
14690 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
14694 #: ../src/guestfs-availability.pod:40
14695 msgid "B<linuxmodules>"
14699 #: ../src/guestfs-availability.pod:42
14700 msgid "The following functions: L</guestfs_modprobe>"
14704 #: ../src/guestfs-availability.pod:45
14705 msgid "B<linuxxattrs>"
14709 #: ../src/guestfs-availability.pod:47
14711 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> "
14712 "L</guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> "
14713 "L</guestfs_removexattr> L</guestfs_setxattr>"
14717 #: ../src/guestfs-availability.pod:56
14722 #: ../src/guestfs-availability.pod:58
14724 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
14725 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
14726 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
14730 #: ../src/guestfs-availability.pod:67
14735 #: ../src/guestfs-availability.pod:69
14737 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
14738 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
14739 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
14740 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
14741 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
14742 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
14743 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
14744 "L</guestfs_vgs_full>"
14748 #: ../src/guestfs-availability.pod:92
14753 #: ../src/guestfs-availability.pod:94
14755 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
14756 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
14760 #: ../src/guestfs-availability.pod:100
14765 #: ../src/guestfs-availability.pod:102
14766 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
14770 #: ../src/guestfs-availability.pod:105
14771 msgid "B<ntfsprogs>"
14775 #: ../src/guestfs-availability.pod:107
14776 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
14780 #: ../src/guestfs-availability.pod:111
14781 msgid "B<realpath>"
14785 #: ../src/guestfs-availability.pod:113
14786 msgid "The following functions: L</guestfs_realpath>"
14790 #: ../src/guestfs-availability.pod:116
14795 #: ../src/guestfs-availability.pod:118
14797 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
14798 "L</guestfs_scrub_freespace>"
14802 #: ../src/guestfs-availability.pod:123
14807 #: ../src/guestfs-availability.pod:125
14808 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
14812 #: ../src/guestfs-availability.pod:129
14817 #: ../src/guestfs-availability.pod:131
14818 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
14822 #: ../src/guestfs-availability.pod:135
14823 msgid "B<zerofree>"
14827 #: ../src/guestfs-availability.pod:137
14828 msgid "The following functions: L</guestfs_zerofree>"
14832 #: ../src/guestfs-structs.pod:1
14833 msgid "guestfs_int_bool"
14837 #: ../src/guestfs-structs.pod:3
14840 " struct guestfs_int_bool {\n"
14848 #: ../src/guestfs-structs.pod:8
14851 " struct guestfs_int_bool_list {\n"
14852 " uint32_t len; /* Number of elements in list. */\n"
14853 " struct guestfs_int_bool *val; /* Elements. */\n"
14859 #: ../src/guestfs-structs.pod:13
14862 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
14863 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
14868 #: ../src/guestfs-structs.pod:16
14869 msgid "guestfs_lvm_pv"
14873 #: ../src/guestfs-structs.pod:18
14876 " struct guestfs_lvm_pv {\n"
14877 " char *pv_name;\n"
14878 " /* The next field is NOT nul-terminated, be careful when printing it: "
14880 " char pv_uuid[32];\n"
14882 " uint64_t pv_size;\n"
14883 " uint64_t dev_size;\n"
14884 " uint64_t pv_free;\n"
14885 " uint64_t pv_used;\n"
14886 " char *pv_attr;\n"
14887 " int64_t pv_pe_count;\n"
14888 " int64_t pv_pe_alloc_count;\n"
14889 " char *pv_tags;\n"
14890 " uint64_t pe_start;\n"
14891 " int64_t pv_mda_count;\n"
14892 " uint64_t pv_mda_free;\n"
14898 #: ../src/guestfs-structs.pod:36
14901 " struct guestfs_lvm_pv_list {\n"
14902 " uint32_t len; /* Number of elements in list. */\n"
14903 " struct guestfs_lvm_pv *val; /* Elements. */\n"
14909 #: ../src/guestfs-structs.pod:41
14912 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
14913 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
14918 #: ../src/guestfs-structs.pod:44
14919 msgid "guestfs_lvm_vg"
14923 #: ../src/guestfs-structs.pod:46
14926 " struct guestfs_lvm_vg {\n"
14927 " char *vg_name;\n"
14928 " /* The next field is NOT nul-terminated, be careful when printing it: "
14930 " char vg_uuid[32];\n"
14932 " char *vg_attr;\n"
14933 " uint64_t vg_size;\n"
14934 " uint64_t vg_free;\n"
14935 " char *vg_sysid;\n"
14936 " uint64_t vg_extent_size;\n"
14937 " int64_t vg_extent_count;\n"
14938 " int64_t vg_free_count;\n"
14939 " int64_t max_lv;\n"
14940 " int64_t max_pv;\n"
14941 " int64_t pv_count;\n"
14942 " int64_t lv_count;\n"
14943 " int64_t snap_count;\n"
14944 " int64_t vg_seqno;\n"
14945 " char *vg_tags;\n"
14946 " int64_t vg_mda_count;\n"
14947 " uint64_t vg_mda_free;\n"
14953 #: ../src/guestfs-structs.pod:69
14956 " struct guestfs_lvm_vg_list {\n"
14957 " uint32_t len; /* Number of elements in list. */\n"
14958 " struct guestfs_lvm_vg *val; /* Elements. */\n"
14964 #: ../src/guestfs-structs.pod:74
14967 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
14968 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
14973 #: ../src/guestfs-structs.pod:77
14974 msgid "guestfs_lvm_lv"
14978 #: ../src/guestfs-structs.pod:79
14981 " struct guestfs_lvm_lv {\n"
14982 " char *lv_name;\n"
14983 " /* The next field is NOT nul-terminated, be careful when printing it: "
14985 " char lv_uuid[32];\n"
14986 " char *lv_attr;\n"
14987 " int64_t lv_major;\n"
14988 " int64_t lv_minor;\n"
14989 " int64_t lv_kernel_major;\n"
14990 " int64_t lv_kernel_minor;\n"
14991 " uint64_t lv_size;\n"
14992 " int64_t seg_count;\n"
14994 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
14995 " float snap_percent;\n"
14996 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
14997 " float copy_percent;\n"
14998 " char *move_pv;\n"
14999 " char *lv_tags;\n"
15000 " char *mirror_log;\n"
15001 " char *modules;\n"
15007 #: ../src/guestfs-structs.pod:101
15010 " struct guestfs_lvm_lv_list {\n"
15011 " uint32_t len; /* Number of elements in list. */\n"
15012 " struct guestfs_lvm_lv *val; /* Elements. */\n"
15018 #: ../src/guestfs-structs.pod:106
15021 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
15022 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
15027 #: ../src/guestfs-structs.pod:111
15030 " struct guestfs_stat {\n"
15034 " int64_t nlink;\n"
15039 " int64_t blksize;\n"
15040 " int64_t blocks;\n"
15041 " int64_t atime;\n"
15042 " int64_t mtime;\n"
15043 " int64_t ctime;\n"
15049 #: ../src/guestfs-structs.pod:127
15052 " struct guestfs_stat_list {\n"
15053 " uint32_t len; /* Number of elements in list. */\n"
15054 " struct guestfs_stat *val; /* Elements. */\n"
15060 #: ../src/guestfs-structs.pod:132
15063 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
15064 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
15069 #: ../src/guestfs-structs.pod:137
15072 " struct guestfs_statvfs {\n"
15073 " int64_t bsize;\n"
15074 " int64_t frsize;\n"
15075 " int64_t blocks;\n"
15076 " int64_t bfree;\n"
15077 " int64_t bavail;\n"
15078 " int64_t files;\n"
15079 " int64_t ffree;\n"
15080 " int64_t favail;\n"
15083 " int64_t namemax;\n"
15089 #: ../src/guestfs-structs.pod:151
15092 " struct guestfs_statvfs_list {\n"
15093 " uint32_t len; /* Number of elements in list. */\n"
15094 " struct guestfs_statvfs *val; /* Elements. */\n"
15100 #: ../src/guestfs-structs.pod:156
15103 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
15104 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
15109 #: ../src/guestfs-structs.pod:159
15110 msgid "guestfs_dirent"
15114 #: ../src/guestfs-structs.pod:161
15117 " struct guestfs_dirent {\n"
15126 #: ../src/guestfs-structs.pod:167
15129 " struct guestfs_dirent_list {\n"
15130 " uint32_t len; /* Number of elements in list. */\n"
15131 " struct guestfs_dirent *val; /* Elements. */\n"
15137 #: ../src/guestfs-structs.pod:172
15140 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
15141 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
15146 #: ../src/guestfs-structs.pod:177
15149 " struct guestfs_version {\n"
15150 " int64_t major;\n"
15151 " int64_t minor;\n"
15152 " int64_t release;\n"
15159 #: ../src/guestfs-structs.pod:184
15162 " struct guestfs_version_list {\n"
15163 " uint32_t len; /* Number of elements in list. */\n"
15164 " struct guestfs_version *val; /* Elements. */\n"
15170 #: ../src/guestfs-structs.pod:189
15173 " void guestfs_free_version (struct guestfs_free_version *);\n"
15174 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
15179 #: ../src/guestfs-structs.pod:192
15180 msgid "guestfs_xattr"
15184 #: ../src/guestfs-structs.pod:194
15187 " struct guestfs_xattr {\n"
15188 " char *attrname;\n"
15189 " /* The next two fields describe a byte array. */\n"
15190 " uint32_t attrval_len;\n"
15191 " char *attrval;\n"
15197 #: ../src/guestfs-structs.pod:201
15200 " struct guestfs_xattr_list {\n"
15201 " uint32_t len; /* Number of elements in list. */\n"
15202 " struct guestfs_xattr *val; /* Elements. */\n"
15208 #: ../src/guestfs-structs.pod:206
15211 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
15212 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
15217 #: ../src/guestfs-structs.pod:209
15218 msgid "guestfs_inotify_event"
15222 #: ../src/guestfs-structs.pod:211
15225 " struct guestfs_inotify_event {\n"
15226 " int64_t in_wd;\n"
15227 " uint32_t in_mask;\n"
15228 " uint32_t in_cookie;\n"
15229 " char *in_name;\n"
15235 #: ../src/guestfs-structs.pod:218
15238 " struct guestfs_inotify_event_list {\n"
15239 " uint32_t len; /* Number of elements in list. */\n"
15240 " struct guestfs_inotify_event *val; /* Elements. */\n"
15246 #: ../src/guestfs-structs.pod:223
15249 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
15250 " void guestfs_free_inotify_event_list (struct "
15251 "guestfs_free_inotify_event_list *);\n"
15256 #: ../src/guestfs-structs.pod:226
15257 msgid "guestfs_partition"
15261 #: ../src/guestfs-structs.pod:228
15264 " struct guestfs_partition {\n"
15265 " int32_t part_num;\n"
15266 " uint64_t part_start;\n"
15267 " uint64_t part_end;\n"
15268 " uint64_t part_size;\n"
15274 #: ../src/guestfs-structs.pod:235
15277 " struct guestfs_partition_list {\n"
15278 " uint32_t len; /* Number of elements in list. */\n"
15279 " struct guestfs_partition *val; /* Elements. */\n"
15285 #: ../src/guestfs-structs.pod:240
15288 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
15289 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
15294 #: ../fish/guestfish.pod:5
15295 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
15299 #: ../fish/guestfish.pod:9
15302 " guestfish [--options] [commands]\n"
15307 #: ../fish/guestfish.pod:11
15315 #: ../fish/guestfish.pod:13
15318 " guestfish -a disk.img\n"
15323 #: ../fish/guestfish.pod:15
15326 " guestfish -a disk.img -m dev[:mountpoint]\n"
15331 #: ../fish/guestfish.pod:17
15334 " guestfish -d libvirt-domain\n"
15339 #: ../fish/guestfish.pod:19
15342 " guestfish -a disk.img -i\n"
15347 #: ../fish/guestfish.pod:21
15350 " guestfish -d libvirt-domain -i\n"
15355 #: ../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
15360 #: ../fish/guestfish.pod:25
15362 "Using guestfish in read/write mode on live virtual machines can be "
15363 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
15364 "option to use guestfish safely if the disk image or virtual machine might be "
15369 #: ../fish/guestfish.pod:32
15371 "Guestfish is a shell and command-line tool for examining and modifying "
15372 "virtual machine filesystems. It uses libguestfs and exposes all of the "
15373 "functionality of the guestfs API, see L<guestfs(3)>."
15377 #: ../fish/guestfish.pod:36
15379 "Guestfish gives you structured access to the libguestfs API, from shell "
15380 "scripts or the command line or interactively. If you want to rescue a "
15381 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
15386 #: ../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
15391 #: ../fish/guestfish.pod:43
15392 msgid "As an interactive shell"
15396 #: ../fish/guestfish.pod:45
15404 #: ../fish/guestfish.pod:47
15407 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
15408 " editing virtual machine filesystems.\n"
15413 #: ../fish/guestfish.pod:50
15416 " Type: 'help' for a list of commands\n"
15417 " 'man' to read the manual\n"
15418 " 'quit' to quit the shell\n"
15423 #: ../fish/guestfish.pod:54
15426 " ><fs> add-ro disk.img\n"
15428 " ><fs> list-filesystems\n"
15429 " /dev/sda1: ext4\n"
15430 " /dev/vg_guest/lv_root: ext4\n"
15431 " /dev/vg_guest/lv_swap: swap\n"
15432 " ><fs> mount /dev/vg_guest/lv_root /\n"
15433 " ><fs> cat /etc/fstab\n"
15435 " # Created by anaconda\n"
15442 #: ../fish/guestfish.pod:67
15443 msgid "From shell scripts"
15447 #: ../fish/guestfish.pod:69
15448 msgid "Create a new C</etc/motd> file in a guest or disk image:"
15452 #: ../fish/guestfish.pod:71
15455 " guestfish <<_EOF_\n"
15458 " mount /dev/vg_guest/lv_root /\n"
15459 " write /etc/motd \"Welcome, new users\"\n"
15465 #: ../fish/guestfish.pod:78
15466 msgid "List the LVM logical volumes in a disk image:"
15470 #: ../fish/guestfish.pod:80
15473 " guestfish -a disk.img --ro <<_EOF_\n"
15481 #: ../fish/guestfish.pod:85
15482 msgid "List all the filesystems in a disk image:"
15486 #: ../fish/guestfish.pod:87
15489 " guestfish -a disk.img --ro <<_EOF_\n"
15491 " list-filesystems\n"
15497 #: ../fish/guestfish.pod:92
15498 msgid "On one command line"
15502 #: ../fish/guestfish.pod:94
15503 msgid "Update C</etc/resolv.conf> in a guest:"
15507 #: ../fish/guestfish.pod:96
15511 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
15512 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
15517 #: ../fish/guestfish.pod:100
15518 msgid "Edit C</boot/grub/grub.conf> interactively:"
15522 #: ../fish/guestfish.pod:102
15525 " guestfish --add disk.img \\\n"
15526 " --mount /dev/vg_guest/lv_root \\\n"
15527 " --mount /dev/sda1:/boot \\\n"
15528 " edit /boot/grub/grub.conf\n"
15533 #: ../fish/guestfish.pod:107
15534 msgid "Mount disks automatically"
15538 #: ../fish/guestfish.pod:109
15540 "Use the I<-i> option to automatically mount the disks from a virtual "
15545 #: ../fish/guestfish.pod:112
15548 " guestfish --ro -a disk.img -i cat /etc/group\n"
15553 #: ../fish/guestfish.pod:114
15556 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
15561 #: ../fish/guestfish.pod:116
15562 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
15566 #: ../fish/guestfish.pod:118
15569 " guestfish -a disk.img -i edit /boot/grub/grub.conf\n"
15574 #: ../fish/guestfish.pod:120
15575 msgid "As a script interpreter"
15579 #: ../fish/guestfish.pod:122
15580 msgid "Create a 100MB disk containing an ext2-formatted partition:"
15584 #: ../fish/guestfish.pod:124
15587 " #!/usr/bin/guestfish -f\n"
15588 " sparse test1.img 100M\n"
15590 " part-disk /dev/sda mbr\n"
15591 " mkfs ext2 /dev/sda1\n"
15596 #: ../fish/guestfish.pod:130
15597 msgid "Start with a prepared disk"
15601 #: ../fish/guestfish.pod:132
15603 "An alternate way to create a 100MB disk called C<test1.img> containing a "
15604 "single ext2-formatted partition:"
15608 #: ../fish/guestfish.pod:135
15611 " guestfish -N fs\n"
15616 #: ../fish/guestfish.pod:137
15617 msgid "To list what is available do:"
15621 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:791
15624 " guestfish -N help | less\n"
15629 #: ../fish/guestfish.pod:141
15630 msgid "Remote control"
15634 #: ../fish/guestfish.pod:143
15637 " eval `guestfish --listen`\n"
15638 " guestfish --remote add-ro disk.img\n"
15639 " guestfish --remote run\n"
15640 " guestfish --remote lvs\n"
15645 #: ../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
15650 #: ../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
15655 #: ../fish/guestfish.pod:154
15656 msgid "Displays general help on options."
15660 #: ../fish/guestfish.pod:156
15661 msgid "B<-h> | B<--cmd-help>"
15665 #: ../fish/guestfish.pod:158
15666 msgid "Lists all available guestfish commands."
15670 #: ../fish/guestfish.pod:160
15671 msgid "B<-h cmd> | B<--cmd-help cmd>"
15675 #: ../fish/guestfish.pod:162
15676 msgid "Displays detailed help on a single command C<cmd>."
15680 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
15681 msgid "B<-a image> | B<--add image>"
15685 #: ../fish/guestfish.pod:166
15686 msgid "Add a block device or virtual machine image to the shell."
15690 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
15692 "The format of the disk image is auto-detected. To override this and force a "
15693 "particular format use the I<--format=..> option."
15697 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
15698 msgid "B<-c URI> | B<--connect URI>"
15702 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
15704 "When used in conjunction with the I<-d> option, this specifies the libvirt "
15705 "URI to use. The default is to use the default libvirt connection."
15709 #: ../fish/guestfish.pod:177 ../fuse/guestmount.pod:90
15710 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
15714 #: ../fish/guestfish.pod:179 ../fuse/guestmount.pod:92
15716 "Add disks from the named libvirt domain. If the I<--ro> option is also "
15717 "used, then any libvirt domain can be used. However in write mode, only "
15718 "libvirt domains which are shut down can be named here."
15722 #: ../fish/guestfish.pod:183
15723 msgid "B<-D> | B<--no-dest-paths>"
15727 #: ../fish/guestfish.pod:185
15729 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
15730 "to hit the tab key to complete paths on the guest filesystem, but this "
15731 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
15732 "allow this feature to be disabled."
15736 #: ../fish/guestfish.pod:190
15737 msgid "B<--echo-keys>"
15741 #: ../fish/guestfish.pod:192
15743 "When prompting for keys and passphrases, guestfish normally turns echoing "
15744 "off so you cannot see what you are typing. If you are not worried about "
15745 "Tempest attacks and there is no one else in the room you can specify this "
15746 "flag to see what you are typing."
15750 #: ../fish/guestfish.pod:197
15751 msgid "B<-f file> | B<--file file>"
15755 #: ../fish/guestfish.pod:199
15756 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
15760 #: ../fish/guestfish.pod:202
15763 " #!/usr/bin/guestfish -f\n"
15768 #: ../fish/guestfish.pod:204 ../fuse/guestmount.pod:108
15769 msgid "B<--format=raw|qcow2|..> | B<--format>"
15773 #: ../fish/guestfish.pod:206 ../fuse/guestmount.pod:110
15775 "The default for the I<-a> option is to auto-detect the format of the disk "
15776 "image. Using this forces the disk format for I<-a> options which follow on "
15777 "the command line. Using I<--format> with no argument switches back to "
15778 "auto-detection for subsequent I<-a> options."
15782 #: ../fish/guestfish.pod:211 ../fish/guestfish.pod:504 ../inspector/virt-inspector.pl:549
15783 msgid "For example:"
15787 #: ../fish/guestfish.pod:213
15790 " guestfish --format=raw -a disk.img\n"
15795 #: ../fish/guestfish.pod:215
15796 msgid "forces raw format (no auto-detection) for C<disk.img>."
15800 #: ../fish/guestfish.pod:217
15803 " guestfish --format=raw -a disk.img --format -a another.img\n"
15808 #: ../fish/guestfish.pod:219
15810 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
15811 "auto-detection for C<another.img>."
15815 #: ../fish/guestfish.pod:222
15817 "If you have untrusted raw-format guest disk images, you should use this "
15818 "option to specify the disk format. This avoids a possible security problem "
15819 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
15823 #: ../fish/guestfish.pod:227 ../fuse/guestmount.pod:128
15824 msgid "B<-i> | B<--inspector>"
15828 #: ../fish/guestfish.pod:229 ../fuse/guestmount.pod:130
15830 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
15831 "system and mount filesystems as they would be mounted on the real virtual "
15836 #: ../fish/guestfish.pod:233
15837 msgid "Typical usage is either:"
15841 #: ../fish/guestfish.pod:235
15844 " guestfish -d myguest -i\n"
15849 #: ../fish/guestfish.pod:237
15850 msgid "(for an inactive libvirt domain called I<myguest>), or:"
15854 #: ../fish/guestfish.pod:239
15857 " guestfish --ro -d myguest -i\n"
15862 #: ../fish/guestfish.pod:241
15863 msgid "(for active domains, readonly), or specify the block device directly:"
15867 #: ../fish/guestfish.pod:243
15870 " guestfish -a /dev/Guests/MyGuest -i\n"
15875 #: ../fish/guestfish.pod:245
15877 "Note that the command line syntax changed slightly over older versions of "
15878 "guestfish. You can still use the old syntax:"
15882 #: ../fish/guestfish.pod:248
15885 " guestfish [--ro] -i disk.img\n"
15890 #: ../fish/guestfish.pod:250
15893 " guestfish [--ro] -i libvirt-domain\n"
15898 #: ../fish/guestfish.pod:252
15899 msgid "B<--keys-from-stdin>"
15903 #: ../fish/guestfish.pod:254
15905 "Read key or passphrase parameters from stdin. The default is to try to read "
15906 "passphrases from the user by opening C</dev/tty>."
15910 #: ../fish/guestfish.pod:257
15911 msgid "B<--listen>"
15915 #: ../fish/guestfish.pod:259
15917 "Fork into the background and listen for remote commands. See section "
15918 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
15922 #: ../fish/guestfish.pod:262
15923 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
15927 #: ../fish/guestfish.pod:264
15928 msgid "Mount the named partition or logical volume on the given mountpoint."
15932 #: ../fish/guestfish.pod:266
15933 msgid "If the mountpoint is omitted, it defaults to C</>."
15937 #: ../fish/guestfish.pod:268
15938 msgid "You have to mount something on C</> before most commands will work."
15942 #: ../fish/guestfish.pod:270
15944 "If any I<-m> or I<--mount> options are given, the guest is automatically "
15949 #: ../fish/guestfish.pod:273
15951 "If you don't know what filesystems a disk image contains, you can either run "
15952 "guestfish without this option, then list the partitions and LVs available "
15953 "(see L</list-partitions> and L</lvs> commands), or you can use the "
15954 "L<virt-list-filesystems(1)> program."
15958 #: ../fish/guestfish.pod:278 ../fuse/guestmount.pod:142
15959 msgid "B<-n> | B<--no-sync>"
15963 #: ../fish/guestfish.pod:280
15965 "Disable autosync. This is enabled by default. See the discussion of "
15966 "autosync in the L<guestfs(3)> manpage."
15970 #: ../fish/guestfish.pod:283
15971 msgid "B<-N type> | B<--new type> | B<-N help>"
15975 #: ../fish/guestfish.pod:285
15977 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
15978 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
15979 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
15984 #: ../fish/guestfish.pod:290
15985 msgid "B<--progress-bars>"
15989 #: ../fish/guestfish.pod:292
15990 msgid "Enable progress bars, even when guestfish is used non-interactively."
15994 #: ../fish/guestfish.pod:294
15996 "Progress bars are enabled by default when guestfish is used as an "
15997 "interactive shell."
16001 #: ../fish/guestfish.pod:297
16002 msgid "B<--no-progress-bars>"
16006 #: ../fish/guestfish.pod:299
16007 msgid "Disable progress bars."
16011 #: ../fish/guestfish.pod:301
16012 msgid "B<--remote[=pid]>"
16016 #: ../fish/guestfish.pod:303
16018 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
16019 "CONTROL GUESTFISH OVER A SOCKET> below."
16023 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:184
16024 msgid "B<-r> | B<--ro>"
16028 #: ../fish/guestfish.pod:308
16030 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
16031 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
16035 #: ../fish/guestfish.pod:311 ../tools/virt-rescue.pl:187
16037 "The option must always be used if the disk image or virtual machine might be "
16038 "running, and is generally recommended in cases where you don't need write "
16039 "access to the disk."
16043 #: ../fish/guestfish.pod:315
16045 "Note that prepared disk images created with I<-N> are not affected by the "
16050 #: ../fish/guestfish.pod:318 ../fuse/guestmount.pod:194 ../tools/virt-rescue.pl:195
16051 msgid "B<--selinux>"
16055 #: ../fish/guestfish.pod:320
16056 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
16060 #: ../fish/guestfish.pod:322 ../fuse/guestmount.pod:198
16061 msgid "B<-v> | B<--verbose>"
16065 #: ../fish/guestfish.pod:324
16067 "Enable very verbose messages. This is particularly useful if you find a "
16072 #: ../fish/guestfish.pod:327 ../fuse/guestmount.pod:202
16073 msgid "B<-V> | B<--version>"
16077 #: ../fish/guestfish.pod:329
16078 msgid "Display the guestfish / libguestfs version number and exit."
16082 #: ../fish/guestfish.pod:331
16087 #: ../fish/guestfish.pod:333
16088 msgid "Echo each command before executing it."
16092 #: ../fish/guestfish.pod:337
16093 msgid "COMMANDS ON COMMAND LINE"
16097 #: ../fish/guestfish.pod:339
16098 msgid "Any additional (non-option) arguments are treated as commands to execute."
16102 #: ../fish/guestfish.pod:342
16104 "Commands to execute should be separated by a colon (C<:>), where the colon "
16105 "is a separate parameter. Thus:"
16109 #: ../fish/guestfish.pod:345
16112 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
16117 #: ../fish/guestfish.pod:347
16119 "If there are no additional arguments, then we enter a shell, either an "
16120 "interactive shell with a prompt (if the input is a terminal) or a "
16121 "non-interactive shell."
16125 #: ../fish/guestfish.pod:351
16127 "In either command line mode or non-interactive shell, the first command that "
16128 "gives an error causes the whole shell to exit. In interactive mode (with a "
16129 "prompt) if a command fails, you can continue to enter commands."
16133 #: ../fish/guestfish.pod:356
16134 msgid "USING launch (OR run)"
16138 #: ../fish/guestfish.pod:358
16140 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
16141 "then launch it, then mount any disks you need, and finally issue "
16142 "actions/commands. So the general order of the day is:"
16146 #: ../fish/guestfish.pod:366
16147 msgid "add or -a/--add"
16151 #: ../fish/guestfish.pod:370
16152 msgid "launch (aka run)"
16156 #: ../fish/guestfish.pod:374
16157 msgid "mount or -m/--mount"
16161 #: ../fish/guestfish.pod:378
16162 msgid "any other commands"
16166 #: ../fish/guestfish.pod:382
16168 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
16169 "guest before mounting or performing any other commands."
16173 #: ../fish/guestfish.pod:385
16175 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
16176 "I<--new> options were given then C<run> is done automatically, simply "
16177 "because guestfish can't perform the action you asked for without doing this."
16181 #: ../fish/guestfish.pod:390
16186 #: ../fish/guestfish.pod:392
16188 "You can quote ordinary parameters using either single or double quotes. For "
16193 #: ../fish/guestfish.pod:395
16196 " add \"file with a space.img\"\n"
16201 #: ../fish/guestfish.pod:397
16204 " rm '/file name'\n"
16209 #: ../fish/guestfish.pod:399
16217 #: ../fish/guestfish.pod:401
16219 "A few commands require a list of strings to be passed. For these, use a "
16220 "whitespace-separated list, enclosed in quotes. Strings containing "
16221 "whitespace to be passed through must be enclosed in single quotes. A "
16222 "literal single quote must be escaped with a backslash."
16226 #: ../fish/guestfish.pod:406
16229 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
16230 " command \"/bin/echo 'foo bar'\"\n"
16231 " command \"/bin/echo \\'foo\\'\"\n"
16236 #: ../fish/guestfish.pod:410
16237 msgid "OPTIONAL ARGUMENTS"
16241 #: ../fish/guestfish.pod:412
16243 "Some commands take optional arguments. These arguments appear in this "
16244 "documentation as C<[argname:..]>. You can use them as in these examples:"
16248 #: ../fish/guestfish.pod:416
16251 " add-drive-opts filename\n"
16256 #: ../fish/guestfish.pod:418
16259 " add-drive-opts filename readonly:true\n"
16264 #: ../fish/guestfish.pod:420
16267 " add-drive-opts filename format:qcow2 readonly:false\n"
16272 #: ../fish/guestfish.pod:422
16274 "Each optional argument can appear at most once. All optional arguments must "
16275 "appear after the required ones."
16279 #: ../fish/guestfish.pod:425
16284 #: ../fish/guestfish.pod:427
16285 msgid "This section applies to all commands which can take integers as parameters."
16289 #: ../fish/guestfish.pod:430
16290 msgid "SIZE SUFFIX"
16294 #: ../fish/guestfish.pod:432
16296 "When the command takes a parameter measured in bytes, you can use one of the "
16297 "following suffixes to specify kilobytes, megabytes and larger sizes:"
16301 #: ../fish/guestfish.pod:438
16302 msgid "B<k> or B<K> or B<KiB>"
16306 #: ../fish/guestfish.pod:440
16307 msgid "The size in kilobytes (multiplied by 1024)."
16311 #: ../fish/guestfish.pod:442
16316 #: ../fish/guestfish.pod:444
16317 msgid "The size in SI 1000 byte units."
16321 #: ../fish/guestfish.pod:446
16322 msgid "B<M> or B<MiB>"
16326 #: ../fish/guestfish.pod:448
16327 msgid "The size in megabytes (multiplied by 1048576)."
16331 #: ../fish/guestfish.pod:450
16336 #: ../fish/guestfish.pod:452
16337 msgid "The size in SI 1000000 byte units."
16341 #: ../fish/guestfish.pod:454
16342 msgid "B<G> or B<GiB>"
16346 #: ../fish/guestfish.pod:456
16347 msgid "The size in gigabytes (multiplied by 2**30)."
16351 #: ../fish/guestfish.pod:458
16356 #: ../fish/guestfish.pod:460
16357 msgid "The size in SI 10**9 byte units."
16361 #: ../fish/guestfish.pod:462
16362 msgid "B<T> or B<TiB>"
16366 #: ../fish/guestfish.pod:464
16367 msgid "The size in terabytes (multiplied by 2**40)."
16371 #: ../fish/guestfish.pod:466
16376 #: ../fish/guestfish.pod:468
16377 msgid "The size in SI 10**12 byte units."
16381 #: ../fish/guestfish.pod:470
16382 msgid "B<P> or B<PiB>"
16386 #: ../fish/guestfish.pod:472
16387 msgid "The size in petabytes (multiplied by 2**50)."
16391 #: ../fish/guestfish.pod:474
16396 #: ../fish/guestfish.pod:476
16397 msgid "The size in SI 10**15 byte units."
16401 #: ../fish/guestfish.pod:478
16402 msgid "B<E> or B<EiB>"
16406 #: ../fish/guestfish.pod:480
16407 msgid "The size in exabytes (multiplied by 2**60)."
16411 #: ../fish/guestfish.pod:482
16416 #: ../fish/guestfish.pod:484
16417 msgid "The size in SI 10**18 byte units."
16421 #: ../fish/guestfish.pod:486
16422 msgid "B<Z> or B<ZiB>"
16426 #: ../fish/guestfish.pod:488
16427 msgid "The size in zettabytes (multiplied by 2**70)."
16431 #: ../fish/guestfish.pod:490
16436 #: ../fish/guestfish.pod:492
16437 msgid "The size in SI 10**21 byte units."
16441 #: ../fish/guestfish.pod:494
16442 msgid "B<Y> or B<YiB>"
16446 #: ../fish/guestfish.pod:496
16447 msgid "The size in yottabytes (multiplied by 2**80)."
16451 #: ../fish/guestfish.pod:498
16456 #: ../fish/guestfish.pod:500
16457 msgid "The size in SI 10**24 byte units."
16461 #: ../fish/guestfish.pod:506
16464 " truncate-size /file 1G\n"
16469 #: ../fish/guestfish.pod:508
16470 msgid "would truncate the file to 1 gigabyte."
16474 #: ../fish/guestfish.pod:510
16476 "Be careful because a few commands take sizes in kilobytes or megabytes "
16477 "(eg. the parameter to L</memsize> is specified in megabytes already). "
16478 "Adding a suffix will probably not do what you expect."
16482 #: ../fish/guestfish.pod:514
16483 msgid "OCTAL AND HEXADECIMAL NUMBERS"
16487 #: ../fish/guestfish.pod:516
16489 "For specifying the radix (base) use the C convention: C<0> to prefix an "
16490 "octal number or C<0x> to prefix a hexadecimal number. For example:"
16494 #: ../fish/guestfish.pod:519
16497 " 1234 decimal number 1234\n"
16498 " 02322 octal number, equivalent to decimal 1234\n"
16499 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
16504 #: ../fish/guestfish.pod:523
16506 "When using the C<chmod> command, you almost always want to specify an octal "
16507 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
16508 "L<chmod(1)> program):"
16512 #: ../fish/guestfish.pod:527
16515 " chmod 0777 /public # OK\n"
16516 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
16521 #: ../fish/guestfish.pod:530
16523 "Commands that return numbers usually print them in decimal, but some "
16524 "commands print numbers in other radices (eg. C<umask> prints the mode in "
16525 "octal, preceeded by C<0>)."
16529 #: ../fish/guestfish.pod:534
16530 msgid "WILDCARDS AND GLOBBING"
16534 #: ../fish/guestfish.pod:536
16536 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
16537 "(globbing) by default. So for example the following will not do what you "
16542 #: ../fish/guestfish.pod:540
16550 #: ../fish/guestfish.pod:542
16552 "Assuming you don't have a directory called literally C</home/*> then the "
16553 "above command will return an error."
16557 #: ../fish/guestfish.pod:545
16558 msgid "To perform wildcard expansion, use the C<glob> command."
16562 #: ../fish/guestfish.pod:547
16565 " glob rm-rf /home/*\n"
16570 #: ../fish/guestfish.pod:549
16572 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
16573 "many times), equivalent to:"
16577 #: ../fish/guestfish.pod:552
16580 " rm-rf /home/jim\n"
16581 " rm-rf /home/joe\n"
16582 " rm-rf /home/mary\n"
16587 #: ../fish/guestfish.pod:556
16588 msgid "C<glob> only works on simple guest paths and not on device names."
16592 #: ../fish/guestfish.pod:558
16594 "If you have several parameters, each containing a wildcard, then glob will "
16595 "perform a Cartesian product."
16599 #: ../fish/guestfish.pod:561
16604 #: ../fish/guestfish.pod:563
16606 "Any line which starts with a I<#> character is treated as a comment and "
16607 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
16608 "a command. For example:"
16612 #: ../fish/guestfish.pod:567
16615 " # this is a comment\n"
16616 " # this is a comment\n"
16617 " foo # NOT a comment\n"
16622 #: ../fish/guestfish.pod:571
16623 msgid "Blank lines are also ignored."
16627 #: ../fish/guestfish.pod:573
16628 msgid "RUNNING COMMANDS LOCALLY"
16632 #: ../fish/guestfish.pod:575
16634 "Any line which starts with a I<!> character is treated as a command sent to "
16635 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
16639 #: ../fish/guestfish.pod:579
16643 " tgz-out /remote local/remote-data.tar.gz\n"
16648 #: ../fish/guestfish.pod:582
16650 "will create a directory C<local> on the host, and then export the contents "
16651 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
16652 "(See C<tgz-out>)."
16656 #: ../fish/guestfish.pod:586
16658 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
16659 "effect, due to the way that subprocesses work in Unix."
16663 #: ../fish/guestfish.pod:589
16668 #: ../fish/guestfish.pod:591
16670 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
16671 "command (a guestfish command) to the second command (any host command). For "
16676 #: ../fish/guestfish.pod:595
16679 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
16684 #: ../fish/guestfish.pod:597
16686 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
16687 "program). The above command would list all accounts in the guest filesystem "
16688 "which have UID 0, ie. root accounts including backdoors. Other examples:"
16692 #: ../fish/guestfish.pod:602
16695 " hexdump /bin/ls | head\n"
16696 " list-devices | tail -1\n"
16697 " tgz-out / - | tar ztf -\n"
16702 #: ../fish/guestfish.pod:606
16704 "The space before the pipe symbol is required, any space after the pipe "
16705 "symbol is optional. Everything after the pipe symbol is just passed "
16706 "straight to the host shell, so it can contain redirections, globs and "
16707 "anything else that makes sense on the host side."
16711 #: ../fish/guestfish.pod:611
16713 "To use a literal argument which begins with a pipe symbol, you have to quote "
16718 #: ../fish/guestfish.pod:614
16726 #: ../fish/guestfish.pod:616
16727 msgid "HOME DIRECTORIES"
16731 #: ../fish/guestfish.pod:618
16733 "If a parameter starts with the character C<~> then the tilde may be expanded "
16734 "as a home directory path (either C<~> for the current user's home directory, "
16735 "or C<~user> for another user)."
16739 #: ../fish/guestfish.pod:622
16741 "Note that home directory expansion happens for users known I<on the host>, "
16742 "not in the guest filesystem."
16746 #: ../fish/guestfish.pod:625
16748 "To use a literal argument which begins with a tilde, you have to quote it, "
16753 #: ../fish/guestfish.pod:628
16761 #: ../fish/guestfish.pod:632
16763 "Libguestfs has some support for Linux guests encrypted according to the "
16764 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
16765 "disk encryption systems used by modern Linux guests. Currently only "
16766 "LVM-on-LUKS is supported."
16770 #: ../fish/guestfish.pod:637
16771 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
16775 #: ../fish/guestfish.pod:639
16778 " ><fs> vfs-type /dev/sda2\n"
16784 #: ../fish/guestfish.pod:642
16786 "Then open those devices using L</luks-open>. This creates a device-mapper "
16787 "device called C</dev/mapper/luksdev>."
16791 #: ../fish/guestfish.pod:645
16794 " ><fs> luks-open /dev/sda2 luksdev\n"
16795 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
16800 #: ../fish/guestfish.pod:648
16802 "Finally you have to tell LVM to scan for volume groups on the newly created "
16807 #: ../fish/guestfish.pod:651
16811 " vg-activate-all true\n"
16816 #: ../fish/guestfish.pod:654
16817 msgid "The logical volume(s) can now be mounted in the usual way."
16821 #: ../fish/guestfish.pod:656
16823 "Before closing a LUKS device you must unmount any logical volumes on it and "
16824 "deactivate the volume groups by calling C<vg-activate false VG> on each "
16825 "one. Then you can close the mapper device:"
16829 #: ../fish/guestfish.pod:660
16832 " vg-activate false /dev/VG\n"
16833 " luks-close /dev/mapper/luksdev\n"
16838 #: ../fish/guestfish.pod:663
16839 msgid "WINDOWS PATHS"
16843 #: ../fish/guestfish.pod:665
16845 "If a path is prefixed with C<win:> then you can use Windows-style paths "
16846 "(with some limitations). The following commands are equivalent:"
16850 #: ../fish/guestfish.pod:668
16853 " file /WINDOWS/system32/config/system.LOG\n"
16858 #: ../fish/guestfish.pod:670
16861 " file win:/windows/system32/config/system.log\n"
16866 #: ../fish/guestfish.pod:672
16869 " file win:\\windows\\system32\\config\\system.log\n"
16874 #: ../fish/guestfish.pod:674
16877 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
16882 #: ../fish/guestfish.pod:676
16884 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
16885 "handles case insensitivity like Windows would. This only works in argument "
16886 "positions that expect a path."
16890 #: ../fish/guestfish.pod:680
16891 msgid "UPLOADING AND DOWNLOADING FILES"
16895 #: ../fish/guestfish.pod:682
16897 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
16898 "others which upload from or download to a local file, you can use the "
16899 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
16903 #: ../fish/guestfish.pod:686
16911 #: ../fish/guestfish.pod:688
16912 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
16916 #: ../fish/guestfish.pod:691
16919 " tar-out /etc - | tar tf -\n"
16924 #: ../fish/guestfish.pod:693
16926 "writes the tarball to stdout and then pipes that into the external \"tar\" "
16927 "command (see L</PIPES>)."
16931 #: ../fish/guestfish.pod:696
16933 "When using C<-> to read from stdin, the input is read up to the end of "
16934 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
16935 "some arbitrary end marker:"
16939 #: ../fish/guestfish.pod:700
16942 " upload -<<END /foo\n"
16951 #: ../fish/guestfish.pod:706
16953 "Any string of characters can be used instead of C<END>. The end marker must "
16954 "appear on a line of its own, without any preceeding or following characters "
16955 "(not even spaces)."
16959 #: ../fish/guestfish.pod:710
16961 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
16962 "upload local files (so-called \"FileIn\" parameters in the generator)."
16966 #: ../fish/guestfish.pod:713
16967 msgid "EXIT ON ERROR BEHAVIOUR"
16971 #: ../fish/guestfish.pod:715
16973 "By default, guestfish will ignore any errors when in interactive mode "
16974 "(ie. taking commands from a human over a tty), and will exit on the first "
16975 "error in non-interactive mode (scripts, commands given on the command line)."
16979 #: ../fish/guestfish.pod:720
16981 "If you prefix a command with a I<-> character, then that command will not "
16982 "cause guestfish to exit, even if that (one) command returns an error."
16986 #: ../fish/guestfish.pod:724
16987 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
16991 #: ../fish/guestfish.pod:726
16993 "Guestfish can be remote-controlled over a socket. This is useful "
16994 "particularly in shell scripts where you want to make several different "
16995 "changes to a filesystem, but you don't want the overhead of starting up a "
16996 "guestfish process each time."
17000 #: ../fish/guestfish.pod:731
17001 msgid "Start a guestfish server process using:"
17005 #: ../fish/guestfish.pod:733
17008 " eval `guestfish --listen`\n"
17013 #: ../fish/guestfish.pod:735
17014 msgid "and then send it commands by doing:"
17018 #: ../fish/guestfish.pod:737
17021 " guestfish --remote cmd [...]\n"
17026 #: ../fish/guestfish.pod:739
17027 msgid "To cause the server to exit, send it the exit command:"
17031 #: ../fish/guestfish.pod:741
17034 " guestfish --remote exit\n"
17039 #: ../fish/guestfish.pod:743
17041 "Note that the server will normally exit if there is an error in a command. "
17042 "You can change this in the usual way. See section L</EXIT ON ERROR "
17047 #: ../fish/guestfish.pod:747
17048 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
17052 #: ../fish/guestfish.pod:749
17054 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
17055 "is how the I<--remote> option knows where to send the commands. You can "
17056 "have several guestfish listener processes running using:"
17060 #: ../fish/guestfish.pod:753
17063 " eval `guestfish --listen`\n"
17064 " pid1=$GUESTFISH_PID\n"
17065 " eval `guestfish --listen`\n"
17066 " pid2=$GUESTFISH_PID\n"
17068 " guestfish --remote=$pid1 cmd\n"
17069 " guestfish --remote=$pid2 cmd\n"
17074 #: ../fish/guestfish.pod:761
17075 msgid "REMOTE CONTROL DETAILS"
17079 #: ../fish/guestfish.pod:763
17081 "Remote control happens over a Unix domain socket called "
17082 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
17083 "of the process, and C<$PID> is the process ID of the server."
17087 #: ../fish/guestfish.pod:767
17088 msgid "Guestfish client and server versions must match exactly."
17092 #: ../fish/guestfish.pod:769
17093 msgid "PREPARED DISK IMAGES"
17097 #: ../fish/guestfish.pod:771
17099 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
17100 "preformatted disk images that guestfish can make for you to save typing. "
17101 "This is particularly useful for testing purposes. This option is used "
17102 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
17103 "can be mixed with I<-a>)."
17107 #: ../fish/guestfish.pod:777
17109 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
17110 "the second and so on. Existing files in the current directory are "
17115 #: ../fish/guestfish.pod:781
17117 "The type briefly describes how the disk should be sized, partitioned, how "
17118 "filesystem(s) should be created, and how content should be added. "
17119 "Optionally the type can be followed by extra parameters, separated by C<:> "
17120 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
17121 "sparsely-allocated disk, containing a single partition, with the partition "
17122 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
17123 "on a 1GB disk instead."
17127 #: ../fish/guestfish.pod:789
17128 msgid "To list the available types and any extra parameters they take, run:"
17132 #: ../fish/guestfish.pod:793
17134 "Note that the prepared filesystem is not mounted. You would usually have to "
17135 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
17139 #: ../fish/guestfish.pod:797
17141 "If any I<-N> or I<--new> options are given, the guest is automatically "
17146 #: ../fish/guestfish.pod:802
17147 msgid "Create a 100MB disk with an ext4-formatted partition:"
17151 #: ../fish/guestfish.pod:804
17154 " guestfish -N fs:ext4\n"
17159 #: ../fish/guestfish.pod:806
17160 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
17164 #: ../fish/guestfish.pod:808
17167 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
17172 #: ../fish/guestfish.pod:810
17173 msgid "Create a blank 200MB disk:"
17177 #: ../fish/guestfish.pod:812
17180 " guestfish -N disk:200M\n"
17185 #: ../fish/guestfish.pod:814
17186 msgid "PROGRESS BARS"
17190 #: ../fish/guestfish.pod:816
17192 "Some (not all) long-running commands send progress notification messages as "
17193 "they are running. Guestfish turns these messages into progress bars."
17197 #: ../fish/guestfish.pod:820
17199 "When a command that supports progress bars takes longer than two seconds to "
17200 "run, and if progress bars are enabled, then you will see one appearing below "
17205 #: ../fish/guestfish.pod:824
17208 " ><fs> copy-size /large-file /another-file 2048M\n"
17209 " / 10% [#####-----------------------------------------] 00:30\n"
17214 #: ../fish/guestfish.pod:827
17216 "The spinner on the left hand side moves round once for every progress "
17217 "notification received from the backend. This is a (reasonably) golden "
17218 "assurance that the command is \"doing something\" even if the progress bar "
17219 "is not moving, because the command is able to send the progress "
17220 "notifications. When the bar reaches 100% and the command finishes, the "
17221 "spinner disappears."
17225 #: ../fish/guestfish.pod:834
17227 "Progress bars are enabled by default when guestfish is used interactively. "
17228 "You can enable them even for non-interactive modes using I<--progress-bars>, "
17229 "and you can disable them completely using I<--no-progress-bars>."
17233 #: ../fish/guestfish.pod:839
17234 msgid "GUESTFISH COMMANDS"
17238 #: ../fish/guestfish.pod:841
17240 "The commands in this section are guestfish convenience commands, in other "
17241 "words, they are not part of the L<guestfs(3)> API."
17245 #: ../fish/guestfish.pod:844
17250 #: ../fish/guestfish.pod:846
17259 #: ../fish/guestfish.pod:849
17261 "Without any parameter, this lists all commands. With a C<cmd> parameter, "
17262 "this displays detailed help for a command."
17266 #: ../fish/guestfish.pod:852
17267 msgid "quit | exit"
17271 #: ../fish/guestfish.pod:854
17272 msgid "This exits guestfish. You can also use C<^D> key."
17276 #: ../fish/guestfish.pod:856
17277 msgid "@FISH_COMMANDS@"
17281 #: ../fish/guestfish.pod:858
17286 #: ../fish/guestfish.pod:862 ../test-tool/libguestfs-test-tool.pod:83
17291 #: ../fish/guestfish.pod:864
17293 "guestfish returns 0 if the commands completed without error, or 1 if there "
17298 #: ../fish/guestfish.pod:871
17303 #: ../fish/guestfish.pod:873
17305 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
17310 #: ../fish/guestfish.pod:876
17311 msgid "GUESTFISH_PID"
17315 #: ../fish/guestfish.pod:878
17317 "Used with the I<--remote> option to specify the remote guestfish process to "
17318 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
17322 #: ../fish/guestfish.pod:882
17327 #: ../fish/guestfish.pod:884
17329 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
17330 "not specified, the external L<hexedit(1)> program is used."
17334 #: ../fish/guestfish.pod:888
17339 #: ../fish/guestfish.pod:890
17341 "If compiled with GNU readline support, various files in the home directory "
17342 "can be used. See L</FILES>."
17346 #: ../fish/guestfish.pod:899
17348 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
17349 "effect as using the B<-v> option."
17353 #: ../fish/guestfish.pod:911
17355 "Set the path that guestfish uses to search for kernel and initrd.img. See "
17356 "the discussion of paths in L<guestfs(3)>."
17360 #: ../fish/guestfish.pod:922
17361 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
17365 #: ../fish/guestfish.pod:924
17370 #: ../fish/guestfish.pod:926
17372 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
17377 #: ../fish/guestfish.pod:941 ../test-tool/libguestfs-test-tool.pod:88
17382 #: ../fish/guestfish.pod:945
17383 msgid "$HOME/.guestfish"
17387 #: ../fish/guestfish.pod:947
17389 "If compiled with GNU readline support, then the command history is saved in "
17394 #: ../fish/guestfish.pod:950
17395 msgid "$HOME/.inputrc"
17399 #: ../fish/guestfish.pod:952
17400 msgid "/etc/inputrc"
17404 #: ../fish/guestfish.pod:954
17406 "If compiled with GNU readline support, then these files can be used to "
17407 "configure readline. For further information, please see "
17408 "L<readline(3)/INITIALIZATION FILE>."
17412 #: ../fish/guestfish.pod:958
17413 msgid "To write rules which only apply to guestfish, use:"
17417 #: ../fish/guestfish.pod:960
17427 #: ../fish/guestfish.pod:964
17429 "Variables that you can set in inputrc that change the behaviour of guestfish "
17430 "in useful ways include:"
17434 #: ../fish/guestfish.pod:969
17435 msgid "completion-ignore-case (default: on)"
17439 #: ../fish/guestfish.pod:971
17441 "By default, guestfish will ignore case when tab-completing paths on the "
17446 #: ../fish/guestfish.pod:974
17449 " set completion-ignore-case off\n"
17454 #: ../fish/guestfish.pod:976
17455 msgid "to make guestfish case sensitive."
17459 #: ../fish/guestfish.pod:980
17464 #: ../fish/guestfish.pod:982
17465 msgid "test2.img (etc)"
17469 #: ../fish/guestfish.pod:984
17471 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
17472 "will be created in the file C<test1.img> in the current directory. The "
17473 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
17474 "the same name will be overwritten."
17478 #: ../fish/guestfish.pod:993
17480 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
17481 "L<virt-edit(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, "
17482 "L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, "
17483 "L<virt-tar(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
17487 #: ../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
17489 "This program is free software; you can redistribute it and/or modify it "
17490 "under the terms of the GNU General Public License as published by the Free "
17491 "Software Foundation; either version 2 of the License, or (at your option) "
17492 "any later version."
17496 #: ../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
17498 "This program is distributed in the hope that it will be useful, but WITHOUT "
17499 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
17500 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
17505 #: ../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
17507 "You should have received a copy of the GNU General Public License along with "
17508 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
17509 "Ave, Cambridge, MA 02139, USA."
17513 #: ../fish/guestfish-actions.pod:1
17518 #: ../fish/guestfish-actions.pod:3
17521 " add-cdrom filename\n"
17526 #: ../fish/guestfish-actions.pod:15
17528 "This call checks for the existence of C<filename>. This stops you from "
17529 "specifying other types of drive which are supported by qemu such as C<nbd:> "
17530 "and C<http:> URLs. To specify those, use the general L</config> call "
17535 #: ../fish/guestfish-actions.pod:22
17537 "If you just want to add an ISO file (often you use this as an efficient way "
17538 "to transfer large files into the guest), then you should probably use "
17539 "L</add-drive-ro> instead."
17543 #: ../fish/guestfish-actions.pod:35
17548 #: ../fish/guestfish-actions.pod:37
17551 " add-drive filename\n"
17556 #: ../fish/guestfish-actions.pod:39
17558 "This function is the equivalent of calling L</add-drive-opts> with no "
17559 "optional parameters, so the disk is added writable, with the format being "
17560 "detected automatically."
17564 #: ../fish/guestfish-actions.pod:43
17566 "Automatic detection of the format opens you up to a potential security hole "
17567 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
17568 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
17569 "you should think about replacing calls to this function with calls to "
17570 "L</add-drive-opts>, and specifying the format."
17574 #: ../fish/guestfish-actions.pod:50
17575 msgid "add-drive-opts"
17579 #: ../fish/guestfish-actions.pod:52
17584 #: ../fish/guestfish-actions.pod:54
17587 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
17592 #: ../fish/guestfish-actions.pod:81
17594 "This forces the image format. If you omit this (or use L</add-drive> or "
17595 "L</add-drive-ro>) then the format is automatically detected. Possible "
17596 "formats include C<raw> and C<qcow2>."
17600 #: ../fish/guestfish-actions.pod:92
17602 "This rarely-used option lets you emulate the behaviour of the deprecated "
17603 "L</add-drive-with-if> call (q.v.)"
17607 #: ../fish/guestfish-actions.pod:97
17609 "This command has one or more optional arguments. See L</OPTIONAL "
17614 #: ../fish/guestfish-actions.pod:99
17615 msgid "add-drive-ro"
17619 #: ../fish/guestfish-actions.pod:101
17624 #: ../fish/guestfish-actions.pod:103
17627 " add-drive-ro filename\n"
17632 #: ../fish/guestfish-actions.pod:105
17634 "This function is the equivalent of calling L</add-drive-opts> with the "
17635 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
17636 "is added read-only, with the format being detected automatically."
17640 #: ../fish/guestfish-actions.pod:110
17641 msgid "add-drive-ro-with-if"
17645 #: ../fish/guestfish-actions.pod:112
17648 " add-drive-ro-with-if filename iface\n"
17653 #: ../fish/guestfish-actions.pod:114
17655 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
17656 "interface emulation to use at run time."
17660 #: ../fish/guestfish-actions.pod:124
17661 msgid "add-drive-with-if"
17665 #: ../fish/guestfish-actions.pod:126
17668 " add-drive-with-if filename iface\n"
17673 #: ../fish/guestfish-actions.pod:128
17675 "This is the same as L</add-drive> but it allows you to specify the QEMU "
17676 "interface emulation to use at run time."
17680 #: ../fish/guestfish-actions.pod:138
17685 #: ../fish/guestfish-actions.pod:140
17688 " aug-clear augpath\n"
17693 #: ../fish/guestfish-actions.pod:145
17698 #: ../fish/guestfish-actions.pod:147
17706 #: ../fish/guestfish-actions.pod:149
17708 "Close the current Augeas handle and free up any resources used by it. After "
17709 "calling this, you have to call L</aug-init> again before you can use any "
17710 "other Augeas functions."
17714 #: ../fish/guestfish-actions.pod:154
17715 msgid "aug-defnode"
17719 #: ../fish/guestfish-actions.pod:156
17722 " aug-defnode name expr val\n"
17727 #: ../fish/guestfish-actions.pod:161
17729 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
17730 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
17731 "containing that single node."
17735 #: ../fish/guestfish-actions.pod:169
17740 #: ../fish/guestfish-actions.pod:171
17743 " aug-defvar name expr\n"
17748 #: ../fish/guestfish-actions.pod:180
17753 #: ../fish/guestfish-actions.pod:182
17756 " aug-get augpath\n"
17761 #: ../fish/guestfish-actions.pod:187
17766 #: ../fish/guestfish-actions.pod:189
17769 " aug-init root flags\n"
17774 #: ../fish/guestfish-actions.pod:195
17775 msgid "You must call this before using any other L</aug-*> commands."
17779 #: ../fish/guestfish-actions.pod:230
17780 msgid "Do not load the tree in L</aug-init>."
17784 #: ../fish/guestfish-actions.pod:234
17785 msgid "To close the handle, you can call L</aug-close>."
17789 #: ../fish/guestfish-actions.pod:238
17794 #: ../fish/guestfish-actions.pod:240
17797 " aug-insert augpath label true|false\n"
17802 #: ../fish/guestfish-actions.pod:250
17807 #: ../fish/guestfish-actions.pod:252
17815 #: ../fish/guestfish-actions.pod:259
17820 #: ../fish/guestfish-actions.pod:261
17823 " aug-ls augpath\n"
17828 #: ../fish/guestfish-actions.pod:263
17830 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
17831 "resulting nodes into alphabetical order."
17835 #: ../fish/guestfish-actions.pod:266
17840 #: ../fish/guestfish-actions.pod:268
17843 " aug-match augpath\n"
17848 #: ../fish/guestfish-actions.pod:274
17853 #: ../fish/guestfish-actions.pod:276
17856 " aug-mv src dest\n"
17861 #: ../fish/guestfish-actions.pod:281
17866 #: ../fish/guestfish-actions.pod:283
17869 " aug-rm augpath\n"
17874 #: ../fish/guestfish-actions.pod:289
17879 #: ../fish/guestfish-actions.pod:291
17887 #: ../fish/guestfish-actions.pod:295
17889 "The flags which were passed to L</aug-init> affect exactly how files are "
17894 #: ../fish/guestfish-actions.pod:298
17899 #: ../fish/guestfish-actions.pod:300
17902 " aug-set augpath val\n"
17907 #: ../fish/guestfish-actions.pod:304
17909 "In the Augeas API, it is possible to clear a node by setting the value to "
17910 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
17911 "this call. Instead you must use the L</aug-clear> call."
17915 #: ../fish/guestfish-actions.pod:309
17920 #: ../fish/guestfish-actions.pod:311
17923 " available 'groups ...'\n"
17928 #: ../fish/guestfish-actions.pod:317
17930 "The libguestfs groups, and the functions that those groups correspond to, "
17931 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
17932 "runtime by calling L</available-all-groups>."
17936 #: ../fish/guestfish-actions.pod:341
17937 msgid "You must call L</launch> before calling this function."
17941 #: ../fish/guestfish-actions.pod:363
17943 "This call was added in version C<1.0.80>. In previous versions of "
17944 "libguestfs all you could do would be to speculatively execute a command to "
17945 "find out if the daemon implemented it. See also L</version>."
17949 #: ../fish/guestfish-actions.pod:370
17950 msgid "available-all-groups"
17954 #: ../fish/guestfish-actions.pod:372
17957 " available-all-groups\n"
17962 #: ../fish/guestfish-actions.pod:374
17964 "This command returns a list of all optional groups that this daemon knows "
17965 "about. Note this returns both supported and unsupported groups. To find "
17966 "out which ones the daemon can actually support you have to call "
17967 "L</available> on each member of the returned list."
17971 #: ../fish/guestfish-actions.pod:380
17972 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
17976 #: ../fish/guestfish-actions.pod:382
17981 #: ../fish/guestfish-actions.pod:384
17984 " base64-in (base64file|-) filename\n"
17989 #: ../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
17990 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
17994 #: ../fish/guestfish-actions.pod:391
17999 #: ../fish/guestfish-actions.pod:393
18002 " base64-out filename (base64file|-)\n"
18007 #: ../fish/guestfish-actions.pod:400
18008 msgid "blockdev-flushbufs"
18012 #: ../fish/guestfish-actions.pod:402
18015 " blockdev-flushbufs device\n"
18020 #: ../fish/guestfish-actions.pod:409
18021 msgid "blockdev-getbsz"
18025 #: ../fish/guestfish-actions.pod:411
18028 " blockdev-getbsz device\n"
18033 #: ../fish/guestfish-actions.pod:420
18034 msgid "blockdev-getro"
18038 #: ../fish/guestfish-actions.pod:422
18041 " blockdev-getro device\n"
18046 #: ../fish/guestfish-actions.pod:429
18047 msgid "blockdev-getsize64"
18051 #: ../fish/guestfish-actions.pod:431
18054 " blockdev-getsize64 device\n"
18059 #: ../fish/guestfish-actions.pod:435
18060 msgid "See also L</blockdev-getsz>."
18064 #: ../fish/guestfish-actions.pod:439
18065 msgid "blockdev-getss"
18069 #: ../fish/guestfish-actions.pod:441
18072 " blockdev-getss device\n"
18077 #: ../fish/guestfish-actions.pod:446
18078 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
18082 #: ../fish/guestfish-actions.pod:451
18083 msgid "blockdev-getsz"
18087 #: ../fish/guestfish-actions.pod:453
18090 " blockdev-getsz device\n"
18095 #: ../fish/guestfish-actions.pod:458
18097 "See also L</blockdev-getss> for the real sector size of the device, and "
18098 "L</blockdev-getsize64> for the more useful I<size in bytes>."
18102 #: ../fish/guestfish-actions.pod:464
18103 msgid "blockdev-rereadpt"
18107 #: ../fish/guestfish-actions.pod:466
18110 " blockdev-rereadpt device\n"
18115 #: ../fish/guestfish-actions.pod:472
18116 msgid "blockdev-setbsz"
18120 #: ../fish/guestfish-actions.pod:474
18123 " blockdev-setbsz device blocksize\n"
18128 #: ../fish/guestfish-actions.pod:483
18129 msgid "blockdev-setro"
18133 #: ../fish/guestfish-actions.pod:485
18136 " blockdev-setro device\n"
18141 #: ../fish/guestfish-actions.pod:491
18142 msgid "blockdev-setrw"
18146 #: ../fish/guestfish-actions.pod:493
18149 " blockdev-setrw device\n"
18154 #: ../fish/guestfish-actions.pod:499
18155 msgid "case-sensitive-path"
18159 #: ../fish/guestfish-actions.pod:501
18162 " case-sensitive-path path\n"
18167 #: ../fish/guestfish-actions.pod:525
18169 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
18170 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
18171 "how the directories were originally created under Windows)."
18175 #: ../fish/guestfish-actions.pod:533
18176 msgid "See also L</realpath>."
18180 #: ../fish/guestfish-actions.pod:535
18185 #: ../fish/guestfish-actions.pod:537
18193 #: ../fish/guestfish-actions.pod:541
18195 "Note that this function cannot correctly handle binary files (specifically, "
18196 "files containing C<\\0> character which is treated as end of string). For "
18197 "those you need to use the L</read-file> or L</download> functions which have "
18198 "a more complex interface."
18202 #: ../fish/guestfish-actions.pod:549
18207 #: ../fish/guestfish-actions.pod:551
18210 " checksum csumtype path\n"
18215 #: ../fish/guestfish-actions.pod:594
18216 msgid "To get the checksum for a device, use L</checksum-device>."
18220 #: ../fish/guestfish-actions.pod:596
18221 msgid "To get the checksums for many files, use L</checksums-out>."
18225 #: ../fish/guestfish-actions.pod:598
18226 msgid "checksum-device"
18230 #: ../fish/guestfish-actions.pod:600
18233 " checksum-device csumtype device\n"
18238 #: ../fish/guestfish-actions.pod:602
18240 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
18241 "device named C<device>. For the types of checksums supported see the "
18242 "L</checksum> command."
18246 #: ../fish/guestfish-actions.pod:606
18247 msgid "checksums-out"
18251 #: ../fish/guestfish-actions.pod:608
18254 " checksums-out csumtype directory (sumsfile|-)\n"
18259 #: ../fish/guestfish-actions.pod:624
18264 #: ../fish/guestfish-actions.pod:626
18267 " chmod mode path\n"
18272 #: ../fish/guestfish-actions.pod:637
18277 #: ../fish/guestfish-actions.pod:639
18280 " chown owner group path\n"
18285 #: ../fish/guestfish-actions.pod:647
18290 #: ../fish/guestfish-actions.pod:649
18293 " command 'arguments ...'\n"
18298 #: ../fish/guestfish-actions.pod:656
18300 "The single parameter is an argv-style list of arguments. The first element "
18301 "is the name of the program to run. Subsequent elements are parameters. The "
18302 "list must be non-empty (ie. must contain a program name). Note that the "
18303 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
18307 #: ../fish/guestfish-actions.pod:684
18308 msgid "command-lines"
18312 #: ../fish/guestfish-actions.pod:686
18315 " command-lines 'arguments ...'\n"
18320 #: ../fish/guestfish-actions.pod:688
18321 msgid "This is the same as L</command>, but splits the result into a list of lines."
18325 #: ../fish/guestfish-actions.pod:691
18326 msgid "See also: L</sh-lines>"
18330 #: ../fish/guestfish-actions.pod:696
18335 #: ../fish/guestfish-actions.pod:698
18338 " config qemuparam qemuvalue\n"
18343 #: ../fish/guestfish-actions.pod:709
18348 #: ../fish/guestfish-actions.pod:711
18351 " copy-size src dest size\n"
18356 #: ../fish/guestfish-actions.pod:719
18361 #: ../fish/guestfish-actions.pod:721
18369 #: ../fish/guestfish-actions.pod:726
18374 #: ../fish/guestfish-actions.pod:728
18382 #: ../fish/guestfish-actions.pod:733
18387 #: ../fish/guestfish-actions.pod:735
18395 #: ../fish/guestfish-actions.pod:742
18397 "If the destination is a device, it must be as large or larger than the "
18398 "source file or device, otherwise the copy will fail. This command cannot do "
18399 "partial copies (see L</copy-size>)."
18403 #: ../fish/guestfish-actions.pod:746
18408 #: ../fish/guestfish-actions.pod:748
18411 " debug subcmd 'extraargs ...'\n"
18416 #: ../fish/guestfish-actions.pod:750
18418 "The L</debug> command exposes some internals of C<guestfsd> (the guestfs "
18419 "daemon) that runs inside the qemu subprocess."
18423 #: ../fish/guestfish-actions.pod:758
18424 msgid "debug-upload"
18428 #: ../fish/guestfish-actions.pod:760
18431 " debug-upload (filename|-) tmpname mode\n"
18436 #: ../fish/guestfish-actions.pod:762
18437 msgid "The L</debug-upload> command uploads a file to the libguestfs appliance."
18441 #: ../fish/guestfish-actions.pod:771
18446 #: ../fish/guestfish-actions.pod:773
18454 #: ../fish/guestfish-actions.pod:781
18459 #: ../fish/guestfish-actions.pod:783
18467 #: ../fish/guestfish-actions.pod:792
18472 #: ../fish/guestfish-actions.pod:794
18480 #: ../fish/guestfish-actions.pod:800
18482 "Another way to get the same information is to enable verbose messages with "
18483 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
18484 "before running the program."
18488 #: ../fish/guestfish-actions.pod:805
18493 #: ../fish/guestfish-actions.pod:807
18496 " download remotefilename (filename|-)\n"
18501 #: ../fish/guestfish-actions.pod:814
18502 msgid "See also L</upload>, L</cat>."
18506 #: ../fish/guestfish-actions.pod:818
18507 msgid "download-offset"
18511 #: ../fish/guestfish-actions.pod:820
18514 " download-offset remotefilename (filename|-) offset size\n"
18519 #: ../fish/guestfish-actions.pod:828
18521 "Note that there is no limit on the amount of data that can be downloaded "
18522 "with this call, unlike with L</pread>, and this call always reads the full "
18523 "amount unless an error occurs."
18527 #: ../fish/guestfish-actions.pod:833
18528 msgid "See also L</download>, L</pread>."
18532 #: ../fish/guestfish-actions.pod:837
18533 msgid "drop-caches"
18537 #: ../fish/guestfish-actions.pod:839
18540 " drop-caches whattodrop\n"
18545 #: ../fish/guestfish-actions.pod:851
18550 #: ../fish/guestfish-actions.pod:853
18558 #: ../fish/guestfish-actions.pod:865
18563 #: ../fish/guestfish-actions.pod:867
18566 " e2fsck-f device\n"
18571 #: ../fish/guestfish-actions.pod:873
18573 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
18574 "should use L</fsck>."
18578 #: ../fish/guestfish-actions.pod:876
18579 msgid "echo-daemon"
18583 #: ../fish/guestfish-actions.pod:878
18586 " echo-daemon 'words ...'\n"
18591 #: ../fish/guestfish-actions.pod:885
18592 msgid "See also L</ping-daemon>."
18596 #: ../fish/guestfish-actions.pod:887
18601 #: ../fish/guestfish-actions.pod:889
18604 " egrep regex path\n"
18609 #: ../fish/guestfish-actions.pod:897
18614 #: ../fish/guestfish-actions.pod:899
18617 " egrepi regex path\n"
18622 #: ../fish/guestfish-actions.pod:907
18627 #: ../fish/guestfish-actions.pod:909
18630 " equal file1 file2\n"
18635 #: ../fish/guestfish-actions.pod:916
18640 #: ../fish/guestfish-actions.pod:918
18648 #: ../fish/guestfish-actions.pod:923
18649 msgid "See also L</is-file>, L</is-dir>, L</stat>."
18653 #: ../fish/guestfish-actions.pod:925
18658 #: ../fish/guestfish-actions.pod:927
18661 " fallocate path len\n"
18666 #: ../fish/guestfish-actions.pod:944
18667 msgid "fallocate64"
18671 #: ../fish/guestfish-actions.pod:946
18674 " fallocate64 path len\n"
18679 #: ../fish/guestfish-actions.pod:952
18681 "Note that this call allocates disk blocks for the file. To create a sparse "
18682 "file use L</truncate-size> instead."
18686 #: ../fish/guestfish-actions.pod:955
18688 "The deprecated call L</fallocate> does the same, but owing to an oversight "
18689 "it only allowed 30 bit lengths to be specified, effectively limiting the "
18690 "maximum size of files created through that call to 1GB."
18694 #: ../fish/guestfish-actions.pod:964
18699 #: ../fish/guestfish-actions.pod:966
18702 " fgrep pattern path\n"
18707 #: ../fish/guestfish-actions.pod:974
18712 #: ../fish/guestfish-actions.pod:976
18715 " fgrepi pattern path\n"
18720 #: ../fish/guestfish-actions.pod:984
18725 #: ../fish/guestfish-actions.pod:986
18733 #: ../fish/guestfish-actions.pod:998
18735 "This command can also be used on C</dev/> devices (and partitions, LV "
18736 "names). You can for example use this to determine if a device contains a "
18737 "filesystem, although it's usually better to use L</vfs-type>."
18741 #: ../fish/guestfish-actions.pod:1008
18742 msgid "file-architecture"
18746 #: ../fish/guestfish-actions.pod:1010
18749 " file-architecture filename\n"
18754 #: ../fish/guestfish-actions.pod:1113
18759 #: ../fish/guestfish-actions.pod:1115
18767 #: ../fish/guestfish-actions.pod:1119
18769 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
18770 "L</is-file> etc. To get the size of block devices, use "
18771 "L</blockdev-getsize64>."
18775 #: ../fish/guestfish-actions.pod:1123
18780 #: ../fish/guestfish-actions.pod:1125
18783 " fill c len path\n"
18788 #: ../fish/guestfish-actions.pod:1131
18790 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
18791 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
18792 "L</fill-pattern>."
18796 #: ../fish/guestfish-actions.pod:1136
18797 msgid "fill-pattern"
18801 #: ../fish/guestfish-actions.pod:1138
18804 " fill-pattern pattern len path\n"
18809 #: ../fish/guestfish-actions.pod:1140
18811 "This function is like L</fill> except that it creates a new file of length "
18812 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
18813 "is truncated if necessary to ensure the length of the file is exactly C<len> "
18818 #: ../fish/guestfish-actions.pod:1145
18823 #: ../fish/guestfish-actions.pod:1147
18826 " find directory\n"
18831 #: ../fish/guestfish-actions.pod:1161
18832 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
18836 #: ../fish/guestfish-actions.pod:1174
18837 msgid "See also L</find0>."
18841 #: ../fish/guestfish-actions.pod:1179
18846 #: ../fish/guestfish-actions.pod:1181
18849 " find0 directory (files|-)\n"
18854 #: ../fish/guestfish-actions.pod:1187
18855 msgid "This command works the same way as L</find> with the following exceptions:"
18859 #: ../fish/guestfish-actions.pod:1214
18860 msgid "findfs-label"
18864 #: ../fish/guestfish-actions.pod:1216
18867 " findfs-label label\n"
18872 #: ../fish/guestfish-actions.pod:1222
18873 msgid "To find the label of a filesystem, use L</vfs-label>."
18877 #: ../fish/guestfish-actions.pod:1224
18878 msgid "findfs-uuid"
18882 #: ../fish/guestfish-actions.pod:1226
18885 " findfs-uuid uuid\n"
18890 #: ../fish/guestfish-actions.pod:1232
18891 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
18895 #: ../fish/guestfish-actions.pod:1234
18900 #: ../fish/guestfish-actions.pod:1236
18903 " fsck fstype device\n"
18908 #: ../fish/guestfish-actions.pod:1266
18913 #: ../fish/guestfish-actions.pod:1268
18921 #: ../fish/guestfish-actions.pod:1275
18922 msgid "get-autosync"
18926 #: ../fish/guestfish-actions.pod:1277
18934 #: ../fish/guestfish-actions.pod:1281
18939 #: ../fish/guestfish-actions.pod:1283
18947 #: ../fish/guestfish-actions.pod:1287
18948 msgid "get-e2label"
18952 #: ../fish/guestfish-actions.pod:1289
18955 " get-e2label device\n"
18960 #: ../fish/guestfish-actions.pod:1301
18965 #: ../fish/guestfish-actions.pod:1303
18968 " get-e2uuid device\n"
18973 #: ../fish/guestfish-actions.pod:1315
18974 msgid "get-memsize"
18978 #: ../fish/guestfish-actions.pod:1317
18986 #: ../fish/guestfish-actions.pod:1322
18988 "If L</set-memsize> was not called on this handle, and if "
18989 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
18990 "value for memsize."
18994 #: ../fish/guestfish-actions.pod:1329
18995 msgid "get-network"
18999 #: ../fish/guestfish-actions.pod:1331
19007 #: ../fish/guestfish-actions.pod:1335
19012 #: ../fish/guestfish-actions.pod:1337
19020 #: ../fish/guestfish-actions.pod:1344
19025 #: ../fish/guestfish-actions.pod:1346
19030 #: ../fish/guestfish-actions.pod:1348
19038 #: ../fish/guestfish-actions.pod:1355
19043 #: ../fish/guestfish-actions.pod:1357
19051 #: ../fish/guestfish-actions.pod:1364
19052 msgid "get-recovery-proc"
19056 #: ../fish/guestfish-actions.pod:1366
19059 " get-recovery-proc\n"
19064 #: ../fish/guestfish-actions.pod:1370
19065 msgid "get-selinux"
19069 #: ../fish/guestfish-actions.pod:1372
19077 #: ../fish/guestfish-actions.pod:1374
19079 "This returns the current setting of the selinux flag which is passed to the "
19080 "appliance at boot time. See L</set-selinux>."
19084 #: ../fish/guestfish-actions.pod:1380
19089 #: ../fish/guestfish-actions.pod:1382
19097 #: ../fish/guestfish-actions.pod:1389
19102 #: ../fish/guestfish-actions.pod:1391
19110 #: ../fish/guestfish-actions.pod:1395
19115 #: ../fish/guestfish-actions.pod:1397
19123 #: ../fish/guestfish-actions.pod:1399
19125 "Return the current umask. By default the umask is C<022> unless it has been "
19126 "set by calling L</umask>."
19130 #: ../fish/guestfish-actions.pod:1402
19131 msgid "get-verbose"
19135 #: ../fish/guestfish-actions.pod:1404
19143 #: ../fish/guestfish-actions.pod:1408
19148 #: ../fish/guestfish-actions.pod:1410
19156 #: ../fish/guestfish-actions.pod:1414
19157 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
19161 #: ../fish/guestfish-actions.pod:1417
19166 #: ../fish/guestfish-actions.pod:1419
19169 " getxattrs path\n"
19174 #: ../fish/guestfish-actions.pod:1427
19175 msgid "See also: L</lgetxattrs>, L<attr(5)>."
19179 #: ../fish/guestfish-actions.pod:1429
19180 msgid "glob-expand"
19184 #: ../fish/guestfish-actions.pod:1431
19187 " glob-expand pattern\n"
19192 #: ../fish/guestfish-actions.pod:1444
19197 #: ../fish/guestfish-actions.pod:1446
19200 " grep regex path\n"
19205 #: ../fish/guestfish-actions.pod:1454
19210 #: ../fish/guestfish-actions.pod:1456
19213 " grepi regex path\n"
19218 #: ../fish/guestfish-actions.pod:1464
19219 msgid "grub-install"
19223 #: ../fish/guestfish-actions.pod:1466
19226 " grub-install root device\n"
19231 #: ../fish/guestfish-actions.pod:1482
19236 #: ../fish/guestfish-actions.pod:1484
19244 #: ../fish/guestfish-actions.pod:1492
19249 #: ../fish/guestfish-actions.pod:1494
19252 " head-n nrlines path\n"
19257 #: ../fish/guestfish-actions.pod:1507
19262 #: ../fish/guestfish-actions.pod:1509
19270 #: ../fish/guestfish-actions.pod:1517
19275 #: ../fish/guestfish-actions.pod:1519
19278 " initrd-cat initrdpath filename\n"
19283 #: ../fish/guestfish-actions.pod:1531
19284 msgid "See also L</initrd-list>."
19288 #: ../fish/guestfish-actions.pod:1536
19289 msgid "initrd-list"
19293 #: ../fish/guestfish-actions.pod:1538
19296 " initrd-list path\n"
19301 #: ../fish/guestfish-actions.pod:1550
19302 msgid "inotify-add-watch"
19306 #: ../fish/guestfish-actions.pod:1552
19309 " inotify-add-watch path mask\n"
19314 #: ../fish/guestfish-actions.pod:1564
19315 msgid "inotify-close"
19319 #: ../fish/guestfish-actions.pod:1566
19327 #: ../fish/guestfish-actions.pod:1572
19328 msgid "inotify-files"
19332 #: ../fish/guestfish-actions.pod:1574
19340 #: ../fish/guestfish-actions.pod:1576
19342 "This function is a helpful wrapper around L</inotify-read> which just "
19343 "returns a list of pathnames of objects that were touched. The returned "
19344 "pathnames are sorted and deduplicated."
19348 #: ../fish/guestfish-actions.pod:1580
19349 msgid "inotify-init"
19353 #: ../fish/guestfish-actions.pod:1582
19356 " inotify-init maxevents\n"
19361 #: ../fish/guestfish-actions.pod:1588
19363 "C<maxevents> is the maximum number of events which will be queued up between "
19364 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
19365 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
19366 "default was 16384 events. Beyond this limit, the kernel throws away events, "
19367 "but records the fact that it threw them away by setting a flag "
19368 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
19372 #: ../fish/guestfish-actions.pod:1598
19374 "Before any events are generated, you have to add some watches to the "
19375 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
19376 "L</inotify-watch-all>."
19380 #: ../fish/guestfish-actions.pod:1604
19382 "Queued up events should be read periodically by calling L</inotify-read> (or "
19383 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
19384 "If you don't read the events out often enough then you risk the internal "
19385 "queue overflowing."
19389 #: ../fish/guestfish-actions.pod:1611
19391 "The handle should be closed after use by calling L</inotify-close>. This "
19392 "also removes any watches automatically."
19396 #: ../fish/guestfish-actions.pod:1620
19397 msgid "inotify-read"
19401 #: ../fish/guestfish-actions.pod:1622
19409 #: ../fish/guestfish-actions.pod:1635
19410 msgid "inotify-rm-watch"
19414 #: ../fish/guestfish-actions.pod:1637
19417 " inotify-rm-watch wd\n"
19422 #: ../fish/guestfish-actions.pod:1639
19423 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
19427 #: ../fish/guestfish-actions.pod:1642
19428 msgid "inspect-get-arch"
19432 #: ../fish/guestfish-actions.pod:1644
19435 " inspect-get-arch root\n"
19440 #: ../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
19442 "This function should only be called with a root device string as returned by "
19447 #: ../fish/guestfish-actions.pod:1649
19449 "This returns the architecture of the inspected operating system. The "
19450 "possible return values are listed under L</file-architecture>."
19454 #: ../fish/guestfish-actions.pod:1658
19455 msgid "inspect-get-distro"
19459 #: ../fish/guestfish-actions.pod:1660
19462 " inspect-get-distro root\n"
19467 #: ../fish/guestfish-actions.pod:1724
19468 msgid "inspect-get-filesystems"
19472 #: ../fish/guestfish-actions.pod:1726
19475 " inspect-get-filesystems root\n"
19480 #: ../fish/guestfish-actions.pod:1739
19482 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
19483 "L</inspect-get-mountpoints>."
19487 #: ../fish/guestfish-actions.pod:1742
19488 msgid "inspect-get-major-version"
19492 #: ../fish/guestfish-actions.pod:1744
19495 " inspect-get-major-version root\n"
19500 #: ../fish/guestfish-actions.pod:1763
19501 msgid "inspect-get-minor-version"
19505 #: ../fish/guestfish-actions.pod:1765
19508 " inspect-get-minor-version root\n"
19513 #: ../fish/guestfish-actions.pod:1775
19515 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
19516 "L</inspect-get-major-version>."
19520 #: ../fish/guestfish-actions.pod:1778
19521 msgid "inspect-get-mountpoints"
19525 #: ../fish/guestfish-actions.pod:1780
19528 " inspect-get-mountpoints root\n"
19533 #: ../fish/guestfish-actions.pod:1798
19535 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
19536 "L</inspect-get-filesystems>."
19540 #: ../fish/guestfish-actions.pod:1801
19541 msgid "inspect-get-product-name"
19545 #: ../fish/guestfish-actions.pod:1803
19548 " inspect-get-product-name root\n"
19553 #: ../fish/guestfish-actions.pod:1818
19554 msgid "inspect-get-type"
19558 #: ../fish/guestfish-actions.pod:1820
19561 " inspect-get-type root\n"
19566 #: ../fish/guestfish-actions.pod:1849
19567 msgid "inspect-get-windows-systemroot"
19571 #: ../fish/guestfish-actions.pod:1851
19574 " inspect-get-windows-systemroot root\n"
19579 #: ../fish/guestfish-actions.pod:1865
19584 #: ../fish/guestfish-actions.pod:1867
19592 #: ../fish/guestfish-actions.pod:1882
19594 "You can pass the root string(s) returned to other L</inspect-get-*> "
19595 "functions in order to query further information about each operating system, "
19596 "such as the name and version."
19600 #: ../fish/guestfish-actions.pod:1887
19602 "This function uses other libguestfs features such as L</mount-ro> and "
19603 "L</umount-all> in order to mount and unmount filesystems and look at the "
19604 "contents. This should be called with no disks currently mounted. The "
19605 "function may also use Augeas, so any existing Augeas handle will be closed."
19609 #: ../fish/guestfish-actions.pod:1899 ../fish/guestfish-actions.pod:2055 ../fish/guestfish-actions.pod:2101
19610 msgid "See also L</list-filesystems>."
19614 #: ../fish/guestfish-actions.pod:1901
19615 msgid "is-blockdev"
19619 #: ../fish/guestfish-actions.pod:1903
19622 " is-blockdev path\n"
19627 #: ../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
19628 msgid "See also L</stat>."
19632 #: ../fish/guestfish-actions.pod:1910
19637 #: ../fish/guestfish-actions.pod:1912
19645 #: ../fish/guestfish-actions.pod:1919
19650 #: ../fish/guestfish-actions.pod:1921
19653 " is-chardev path\n"
19658 #: ../fish/guestfish-actions.pod:1928
19663 #: ../fish/guestfish-actions.pod:1930
19671 #: ../fish/guestfish-actions.pod:1937
19676 #: ../fish/guestfish-actions.pod:1939
19684 #: ../fish/guestfish-actions.pod:1947
19689 #: ../fish/guestfish-actions.pod:1949
19697 #: ../fish/guestfish-actions.pod:1956
19702 #: ../fish/guestfish-actions.pod:1958
19710 #: ../fish/guestfish-actions.pod:1966
19711 msgid "is-launching"
19715 #: ../fish/guestfish-actions.pod:1968
19723 #: ../fish/guestfish-actions.pod:1975
19728 #: ../fish/guestfish-actions.pod:1977
19736 #: ../fish/guestfish-actions.pod:1982
19741 #: ../fish/guestfish-actions.pod:1984
19749 #: ../fish/guestfish-actions.pod:1991
19754 #: ../fish/guestfish-actions.pod:1993
19757 " is-socket path\n"
19762 #: ../fish/guestfish-actions.pod:2000
19767 #: ../fish/guestfish-actions.pod:2002
19770 " is-symlink path\n"
19775 #: ../fish/guestfish-actions.pod:2009
19776 msgid "kill-subprocess"
19780 #: ../fish/guestfish-actions.pod:2011
19783 " kill-subprocess\n"
19788 #: ../fish/guestfish-actions.pod:2015
19793 #: ../fish/guestfish-actions.pod:2017
19798 #: ../fish/guestfish-actions.pod:2019
19806 #: ../fish/guestfish-actions.pod:2027
19811 #: ../fish/guestfish-actions.pod:2029
19814 " lchown owner group path\n"
19819 #: ../fish/guestfish-actions.pod:2031
19821 "Change the file owner to C<owner> and group to C<group>. This is like "
19822 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
19827 #: ../fish/guestfish-actions.pod:2039
19832 #: ../fish/guestfish-actions.pod:2041
19835 " lgetxattrs path\n"
19840 #: ../fish/guestfish-actions.pod:2043
19842 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
19843 "it returns the extended attributes of the link itself."
19847 #: ../fish/guestfish-actions.pod:2047
19848 msgid "list-devices"
19852 #: ../fish/guestfish-actions.pod:2049
19860 #: ../fish/guestfish-actions.pod:2057
19861 msgid "list-filesystems"
19865 #: ../fish/guestfish-actions.pod:2059
19868 " list-filesystems\n"
19873 #: ../fish/guestfish-actions.pod:2078
19875 "This command runs other libguestfs commands, which might include L</mount> "
19876 "and L</umount>, and therefore you should use this soon after launch and only "
19877 "when nothing is mounted."
19881 #: ../fish/guestfish-actions.pod:2082
19883 "Not all of the filesystems returned will be mountable. In particular, swap "
19884 "partitions are returned in the list. Also this command does not check that "
19885 "each filesystem found is valid and mountable, and some filesystems might be "
19886 "mountable but require special options. Filesystems may not all belong to a "
19887 "single logical operating system (use L</inspect-os> to look for OSes)."
19891 #: ../fish/guestfish-actions.pod:2090
19892 msgid "list-partitions"
19896 #: ../fish/guestfish-actions.pod:2092
19899 " list-partitions\n"
19904 #: ../fish/guestfish-actions.pod:2098
19906 "This does not return logical volumes. For that you will need to call "
19911 #: ../fish/guestfish-actions.pod:2103
19916 #: ../fish/guestfish-actions.pod:2105
19924 #: ../fish/guestfish-actions.pod:2113
19929 #: ../fish/guestfish-actions.pod:2115
19932 " ln target linkname\n"
19937 #: ../fish/guestfish-actions.pod:2119
19942 #: ../fish/guestfish-actions.pod:2121
19945 " ln-f target linkname\n"
19950 #: ../fish/guestfish-actions.pod:2126
19955 #: ../fish/guestfish-actions.pod:2128
19958 " ln-s target linkname\n"
19963 #: ../fish/guestfish-actions.pod:2132
19968 #: ../fish/guestfish-actions.pod:2134
19971 " ln-sf target linkname\n"
19976 #: ../fish/guestfish-actions.pod:2139
19977 msgid "lremovexattr"
19981 #: ../fish/guestfish-actions.pod:2141
19984 " lremovexattr xattr path\n"
19989 #: ../fish/guestfish-actions.pod:2143
19991 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
19992 "it removes an extended attribute of the link itself."
19996 #: ../fish/guestfish-actions.pod:2147
20001 #: ../fish/guestfish-actions.pod:2149
20009 #: ../fish/guestfish-actions.pod:2155
20011 "This command is mostly useful for interactive sessions. Programs should "
20012 "probably use L</readdir> instead."
20016 #: ../fish/guestfish-actions.pod:2158
20021 #: ../fish/guestfish-actions.pod:2160
20024 " lsetxattr xattr val vallen path\n"
20029 #: ../fish/guestfish-actions.pod:2162
20031 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
20032 "sets an extended attribute of the link itself."
20036 #: ../fish/guestfish-actions.pod:2166
20041 #: ../fish/guestfish-actions.pod:2168
20049 #: ../fish/guestfish-actions.pod:2172
20051 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
20052 "the link is stat-ed, not the file it refers to."
20056 #: ../fish/guestfish-actions.pod:2178
20061 #: ../fish/guestfish-actions.pod:2180
20064 " lstatlist path 'names ...'\n"
20069 #: ../fish/guestfish-actions.pod:2182
20071 "This call allows you to perform the L</lstat> operation on multiple files, "
20072 "where all files are in the directory C<path>. C<names> is the list of files "
20073 "from this directory."
20077 #: ../fish/guestfish-actions.pod:2191
20079 "This call is intended for programs that want to efficiently list a directory "
20080 "contents without making many round-trips. See also L</lxattrlist> for a "
20081 "similarly efficient call for getting extended attributes. Very long "
20082 "directory listings might cause the protocol message size to be exceeded, "
20083 "causing this call to fail. The caller must split up such requests into "
20084 "smaller groups of names."
20088 #: ../fish/guestfish-actions.pod:2199
20089 msgid "luks-add-key"
20093 #: ../fish/guestfish-actions.pod:2201
20096 " luks-add-key device keyslot\n"
20101 #: ../fish/guestfish-actions.pod:2208
20103 "Note that if C<keyslot> already contains a key, then this command will "
20104 "fail. You have to use L</luks-kill-slot> first to remove that key."
20108 #: ../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
20110 "This command has one or more key or passphrase parameters. Guestfish will "
20111 "prompt for these separately."
20115 #: ../fish/guestfish-actions.pod:2215
20120 #: ../fish/guestfish-actions.pod:2217
20123 " luks-close device\n"
20128 #: ../fish/guestfish-actions.pod:2219
20130 "This closes a LUKS device that was created earlier by L</luks-open> or "
20131 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
20132 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
20133 "underlying block device."
20137 #: ../fish/guestfish-actions.pod:2225
20138 msgid "luks-format"
20142 #: ../fish/guestfish-actions.pod:2227
20145 " luks-format device keyslot\n"
20150 #: ../fish/guestfish-actions.pod:2240
20151 msgid "luks-format-cipher"
20155 #: ../fish/guestfish-actions.pod:2242
20158 " luks-format-cipher device keyslot cipher\n"
20163 #: ../fish/guestfish-actions.pod:2244
20165 "This command is the same as L</luks-format> but it also allows you to set "
20166 "the C<cipher> used."
20170 #: ../fish/guestfish-actions.pod:2253
20171 msgid "luks-kill-slot"
20175 #: ../fish/guestfish-actions.pod:2255
20178 " luks-kill-slot device keyslot\n"
20183 #: ../fish/guestfish-actions.pod:2264
20188 #: ../fish/guestfish-actions.pod:2266
20191 " luks-open device mapname\n"
20196 #: ../fish/guestfish-actions.pod:2280
20198 "If this block device contains LVM volume groups, then calling L</vgscan> "
20199 "followed by L</vg-activate-all> will make them visible."
20203 #: ../fish/guestfish-actions.pod:2287
20204 msgid "luks-open-ro"
20208 #: ../fish/guestfish-actions.pod:2289
20211 " luks-open-ro device mapname\n"
20216 #: ../fish/guestfish-actions.pod:2291
20218 "This is the same as L</luks-open> except that a read-only mapping is "
20223 #: ../fish/guestfish-actions.pod:2297
20228 #: ../fish/guestfish-actions.pod:2299
20231 " lvcreate logvol volgroup mbytes\n"
20236 #: ../fish/guestfish-actions.pod:2304
20237 msgid "lvm-canonical-lv-name"
20241 #: ../fish/guestfish-actions.pod:2306
20244 " lvm-canonical-lv-name lvname\n"
20249 #: ../fish/guestfish-actions.pod:2315
20250 msgid "See also L</is-lv>."
20254 #: ../fish/guestfish-actions.pod:2317
20255 msgid "lvm-clear-filter"
20259 #: ../fish/guestfish-actions.pod:2319
20262 " lvm-clear-filter\n"
20267 #: ../fish/guestfish-actions.pod:2321
20269 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
20274 #: ../fish/guestfish-actions.pod:2327
20275 msgid "lvm-remove-all"
20279 #: ../fish/guestfish-actions.pod:2329
20282 " lvm-remove-all\n"
20287 #: ../fish/guestfish-actions.pod:2337
20288 msgid "lvm-set-filter"
20292 #: ../fish/guestfish-actions.pod:2339
20295 " lvm-set-filter 'devices ...'\n"
20300 #: ../fish/guestfish-actions.pod:2364
20305 #: ../fish/guestfish-actions.pod:2366
20308 " lvremove device\n"
20313 #: ../fish/guestfish-actions.pod:2374
20318 #: ../fish/guestfish-actions.pod:2376
20321 " lvrename logvol newlogvol\n"
20326 #: ../fish/guestfish-actions.pod:2380
20331 #: ../fish/guestfish-actions.pod:2382
20334 " lvresize device mbytes\n"
20339 #: ../fish/guestfish-actions.pod:2388
20340 msgid "lvresize-free"
20344 #: ../fish/guestfish-actions.pod:2390
20347 " lvresize-free lv percent\n"
20352 #: ../fish/guestfish-actions.pod:2398
20357 #: ../fish/guestfish-actions.pod:2400
20365 #: ../fish/guestfish-actions.pod:2408
20366 msgid "See also L</lvs-full>, L</list-filesystems>."
20370 #: ../fish/guestfish-actions.pod:2410
20375 #: ../fish/guestfish-actions.pod:2412
20383 #: ../fish/guestfish-actions.pod:2417
20388 #: ../fish/guestfish-actions.pod:2419
20396 #: ../fish/guestfish-actions.pod:2423
20401 #: ../fish/guestfish-actions.pod:2425
20404 " lxattrlist path 'names ...'\n"
20409 #: ../fish/guestfish-actions.pod:2441
20411 "This call is intended for programs that want to efficiently list a directory "
20412 "contents without making many round-trips. See also L</lstatlist> for a "
20413 "similarly efficient call for getting standard stats. Very long directory "
20414 "listings might cause the protocol message size to be exceeded, causing this "
20415 "call to fail. The caller must split up such requests into smaller groups of "
20420 #: ../fish/guestfish-actions.pod:2449
20425 #: ../fish/guestfish-actions.pod:2451
20433 #: ../fish/guestfish-actions.pod:2455
20438 #: ../fish/guestfish-actions.pod:2457
20441 " mkdir-mode path mode\n"
20446 #: ../fish/guestfish-actions.pod:2466
20447 msgid "See also L</mkdir>, L</umask>"
20451 #: ../fish/guestfish-actions.pod:2468
20456 #: ../fish/guestfish-actions.pod:2470
20464 #: ../fish/guestfish-actions.pod:2475
20469 #: ../fish/guestfish-actions.pod:2477
20472 " mkdtemp template\n"
20477 #: ../fish/guestfish-actions.pod:2498
20482 #: ../fish/guestfish-actions.pod:2500
20485 " mke2fs-J fstype blocksize device journal\n"
20490 #: ../fish/guestfish-actions.pod:2508
20491 msgid "See also L</mke2journal>."
20495 #: ../fish/guestfish-actions.pod:2510
20500 #: ../fish/guestfish-actions.pod:2512
20503 " mke2fs-JL fstype blocksize device label\n"
20508 #: ../fish/guestfish-actions.pod:2517
20509 msgid "See also L</mke2journal-L>."
20513 #: ../fish/guestfish-actions.pod:2519
20518 #: ../fish/guestfish-actions.pod:2521
20521 " mke2fs-JU fstype blocksize device uuid\n"
20526 #: ../fish/guestfish-actions.pod:2526
20527 msgid "See also L</mke2journal-U>."
20531 #: ../fish/guestfish-actions.pod:2528
20532 msgid "mke2journal"
20536 #: ../fish/guestfish-actions.pod:2530
20539 " mke2journal blocksize device\n"
20544 #: ../fish/guestfish-actions.pod:2537
20545 msgid "mke2journal-L"
20549 #: ../fish/guestfish-actions.pod:2539
20552 " mke2journal-L blocksize label device\n"
20557 #: ../fish/guestfish-actions.pod:2543
20558 msgid "mke2journal-U"
20562 #: ../fish/guestfish-actions.pod:2545
20565 " mke2journal-U blocksize uuid device\n"
20570 #: ../fish/guestfish-actions.pod:2549
20575 #: ../fish/guestfish-actions.pod:2551
20578 " mkfifo mode path\n"
20583 #: ../fish/guestfish-actions.pod:2553
20585 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
20586 "is just a convenient wrapper around L</mknod>."
20590 #: ../fish/guestfish-actions.pod:2559
20595 #: ../fish/guestfish-actions.pod:2561
20598 " mkfs fstype device\n"
20603 #: ../fish/guestfish-actions.pod:2567
20608 #: ../fish/guestfish-actions.pod:2569
20611 " mkfs-b fstype blocksize device\n"
20616 #: ../fish/guestfish-actions.pod:2571
20618 "This call is similar to L</mkfs>, but it allows you to control the block "
20619 "size of the resulting filesystem. Supported block sizes depend on the "
20620 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
20624 #: ../fish/guestfish-actions.pod:2579
20625 msgid "mkmountpoint"
20629 #: ../fish/guestfish-actions.pod:2581
20632 " mkmountpoint exemptpath\n"
20637 #: ../fish/guestfish-actions.pod:2583
20639 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
20640 "to create extra mountpoints before mounting the first filesystem."
20644 #: ../fish/guestfish-actions.pod:2607
20646 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
20647 "unexpected errors if you try to mix these calls. It is safest to manually "
20648 "unmount filesystems and remove mountpoints after use."
20652 #: ../fish/guestfish-actions.pod:2611
20654 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
20655 "for this to work for manual mountpoints, you must ensure that the innermost "
20656 "mountpoints have the longest pathnames, as in the example code above."
20660 #: ../fish/guestfish-actions.pod:2618
20662 "Autosync [see L</set-autosync>, this is set by default on handles] means "
20663 "that L</umount-all> is called when the handle is closed which can also "
20664 "trigger these issues."
20668 #: ../fish/guestfish-actions.pod:2622
20673 #: ../fish/guestfish-actions.pod:2624
20676 " mknod mode devmajor devminor path\n"
20681 #: ../fish/guestfish-actions.pod:2634
20683 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
20684 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
20685 "regular file). These constants are available in the standard Linux header "
20686 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
20687 "wrappers around this command which bitwise OR in the appropriate constant "
20692 #: ../fish/guestfish-actions.pod:2644
20697 #: ../fish/guestfish-actions.pod:2646
20700 " mknod-b mode devmajor devminor path\n"
20705 #: ../fish/guestfish-actions.pod:2648
20707 "This call creates a block device node called C<path> with mode C<mode> and "
20708 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
20709 "wrapper around L</mknod>."
20713 #: ../fish/guestfish-actions.pod:2654
20718 #: ../fish/guestfish-actions.pod:2656
20721 " mknod-c mode devmajor devminor path\n"
20726 #: ../fish/guestfish-actions.pod:2658
20728 "This call creates a char device node called C<path> with mode C<mode> and "
20729 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
20730 "wrapper around L</mknod>."
20734 #: ../fish/guestfish-actions.pod:2664
20739 #: ../fish/guestfish-actions.pod:2666
20747 #: ../fish/guestfish-actions.pod:2670
20752 #: ../fish/guestfish-actions.pod:2672
20755 " mkswap-L label device\n"
20760 #: ../fish/guestfish-actions.pod:2680
20765 #: ../fish/guestfish-actions.pod:2682
20768 " mkswap-U uuid device\n"
20773 #: ../fish/guestfish-actions.pod:2686
20774 msgid "mkswap-file"
20778 #: ../fish/guestfish-actions.pod:2688
20781 " mkswap-file path\n"
20786 #: ../fish/guestfish-actions.pod:2692
20788 "This command just writes a swap file signature to an existing file. To "
20789 "create the file itself, use something like L</fallocate>."
20793 #: ../fish/guestfish-actions.pod:2695
20798 #: ../fish/guestfish-actions.pod:2697
20801 " modprobe modulename\n"
20806 #: ../fish/guestfish-actions.pod:2704
20811 #: ../fish/guestfish-actions.pod:2706
20814 " mount device mountpoint\n"
20819 #: ../fish/guestfish-actions.pod:2722
20821 "B<Important note:> When you use this call, the filesystem options C<sync> "
20822 "and C<noatime> are set implicitly. This was originally done because we "
20823 "thought it would improve reliability, but it turns out that I<-o sync> has a "
20824 "very large negative performance impact and negligible effect on "
20825 "reliability. Therefore we recommend that you avoid using L</mount> in any "
20826 "code that needs performance, and instead use L</mount-options> (use an empty "
20827 "string for the first parameter if you don't want any options)."
20831 #: ../fish/guestfish-actions.pod:2732
20836 #: ../fish/guestfish-actions.pod:2734
20839 " mount-loop file mountpoint\n"
20844 #: ../fish/guestfish-actions.pod:2740
20845 msgid "mount-options"
20849 #: ../fish/guestfish-actions.pod:2742
20852 " mount-options options device mountpoint\n"
20857 #: ../fish/guestfish-actions.pod:2744
20859 "This is the same as the L</mount> command, but it allows you to set the "
20860 "mount options as for the L<mount(8)> I<-o> flag."
20864 #: ../fish/guestfish-actions.pod:2752
20869 #: ../fish/guestfish-actions.pod:2754
20872 " mount-ro device mountpoint\n"
20877 #: ../fish/guestfish-actions.pod:2756
20879 "This is the same as the L</mount> command, but it mounts the filesystem with "
20880 "the read-only (I<-o ro>) flag."
20884 #: ../fish/guestfish-actions.pod:2759
20889 #: ../fish/guestfish-actions.pod:2761
20892 " mount-vfs options vfstype device mountpoint\n"
20897 #: ../fish/guestfish-actions.pod:2763
20899 "This is the same as the L</mount> command, but it allows you to set both the "
20900 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
20904 #: ../fish/guestfish-actions.pod:2767
20905 msgid "mountpoints"
20909 #: ../fish/guestfish-actions.pod:2769
20917 #: ../fish/guestfish-actions.pod:2771
20919 "This call is similar to L</mounts>. That call returns a list of devices. "
20920 "This one returns a hash table (map) of device name to directory where the "
20921 "device is mounted."
20925 #: ../fish/guestfish-actions.pod:2775
20930 #: ../fish/guestfish-actions.pod:2777
20938 #: ../fish/guestfish-actions.pod:2784
20939 msgid "See also: L</mountpoints>"
20943 #: ../fish/guestfish-actions.pod:2786
20948 #: ../fish/guestfish-actions.pod:2788
20956 #: ../fish/guestfish-actions.pod:2793
20957 msgid "ntfs-3g-probe"
20961 #: ../fish/guestfish-actions.pod:2795
20964 " ntfs-3g-probe true|false device\n"
20969 #: ../fish/guestfish-actions.pod:2809
20974 #: ../fish/guestfish-actions.pod:2811
20977 " ntfsresize device\n"
20982 #: ../fish/guestfish-actions.pod:2817
20983 msgid "ntfsresize-size"
20987 #: ../fish/guestfish-actions.pod:2819
20990 " ntfsresize-size device size\n"
20995 #: ../fish/guestfish-actions.pod:2821
20997 "This command is the same as L</ntfsresize> except that it allows you to "
20998 "specify the new size (in bytes) explicitly."
21002 #: ../fish/guestfish-actions.pod:2824
21007 #: ../fish/guestfish-actions.pod:2826
21010 " part-add device prlogex startsect endsect\n"
21015 #: ../fish/guestfish-actions.pod:2828
21017 "This command adds a partition to C<device>. If there is no partition table "
21018 "on the device, call L</part-init> first."
21022 #: ../fish/guestfish-actions.pod:2840
21024 "Creating a partition which covers the whole disk is not so easy. Use "
21025 "L</part-disk> to do that."
21029 #: ../fish/guestfish-actions.pod:2843
21034 #: ../fish/guestfish-actions.pod:2845
21037 " part-del device partnum\n"
21042 #: ../fish/guestfish-actions.pod:2853
21047 #: ../fish/guestfish-actions.pod:2855
21050 " part-disk device parttype\n"
21055 #: ../fish/guestfish-actions.pod:2857
21057 "This command is simply a combination of L</part-init> followed by "
21058 "L</part-add> to create a single primary partition covering the whole disk."
21062 #: ../fish/guestfish-actions.pod:2861
21064 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
21065 "possible values are described in L</part-init>."
21069 #: ../fish/guestfish-actions.pod:2867
21070 msgid "part-get-bootable"
21074 #: ../fish/guestfish-actions.pod:2869
21077 " part-get-bootable device partnum\n"
21082 #: ../fish/guestfish-actions.pod:2874
21083 msgid "See also L</part-set-bootable>."
21087 #: ../fish/guestfish-actions.pod:2876
21088 msgid "part-get-mbr-id"
21092 #: ../fish/guestfish-actions.pod:2878
21095 " part-get-mbr-id device partnum\n"
21100 #: ../fish/guestfish-actions.pod:2883 ../fish/guestfish-actions.pod:3021
21102 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
21103 "undefined results for other partition table types (see "
21104 "L</part-get-parttype>)."
21108 #: ../fish/guestfish-actions.pod:2887
21109 msgid "part-get-parttype"
21113 #: ../fish/guestfish-actions.pod:2889
21116 " part-get-parttype device\n"
21121 #: ../fish/guestfish-actions.pod:2894
21123 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
21124 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
21125 "possible, although unusual. See L</part-init> for a full list."
21129 #: ../fish/guestfish-actions.pod:2899
21134 #: ../fish/guestfish-actions.pod:2901
21137 " part-init device parttype\n"
21142 #: ../fish/guestfish-actions.pod:2907
21144 "Initially there are no partitions. Following this, you should call "
21145 "L</part-add> for each partition required."
21149 #: ../fish/guestfish-actions.pod:2970
21154 #: ../fish/guestfish-actions.pod:2972
21157 " part-list device\n"
21162 #: ../fish/guestfish-actions.pod:2987
21164 "Start of the partition I<in bytes>. To get sectors you have to divide by "
21165 "the device's sector size, see L</blockdev-getss>."
21169 #: ../fish/guestfish-actions.pod:3000
21170 msgid "part-set-bootable"
21174 #: ../fish/guestfish-actions.pod:3002
21177 " part-set-bootable device partnum true|false\n"
21182 #: ../fish/guestfish-actions.pod:3011
21183 msgid "part-set-mbr-id"
21187 #: ../fish/guestfish-actions.pod:3013
21190 " part-set-mbr-id device partnum idbyte\n"
21195 #: ../fish/guestfish-actions.pod:3025
21196 msgid "part-set-name"
21200 #: ../fish/guestfish-actions.pod:3027
21203 " part-set-name device partnum name\n"
21208 #: ../fish/guestfish-actions.pod:3035
21209 msgid "part-to-dev"
21213 #: ../fish/guestfish-actions.pod:3037
21216 " part-to-dev partition\n"
21221 #: ../fish/guestfish-actions.pod:3043
21223 "The named partition must exist, for example as a string returned from "
21224 "L</list-partitions>."
21228 #: ../fish/guestfish-actions.pod:3046
21229 msgid "ping-daemon"
21233 #: ../fish/guestfish-actions.pod:3048
21241 #: ../fish/guestfish-actions.pod:3055
21246 #: ../fish/guestfish-actions.pod:3057
21249 " pread path count offset\n"
21254 #: ../fish/guestfish-actions.pod:3065
21255 msgid "See also L</pwrite>, L</pread-device>."
21259 #: ../fish/guestfish-actions.pod:3070
21260 msgid "pread-device"
21264 #: ../fish/guestfish-actions.pod:3072
21267 " pread-device device count offset\n"
21272 #: ../fish/guestfish-actions.pod:3080
21273 msgid "See also L</pread>."
21277 #: ../fish/guestfish-actions.pod:3085
21282 #: ../fish/guestfish-actions.pod:3087
21285 " pvcreate device\n"
21290 #: ../fish/guestfish-actions.pod:3093
21295 #: ../fish/guestfish-actions.pod:3095
21298 " pvremove device\n"
21303 #: ../fish/guestfish-actions.pod:3104
21308 #: ../fish/guestfish-actions.pod:3106
21311 " pvresize device\n"
21316 #: ../fish/guestfish-actions.pod:3111
21317 msgid "pvresize-size"
21321 #: ../fish/guestfish-actions.pod:3113
21324 " pvresize-size device size\n"
21329 #: ../fish/guestfish-actions.pod:3115
21331 "This command is the same as L</pvresize> except that it allows you to "
21332 "specify the new size (in bytes) explicitly."
21336 #: ../fish/guestfish-actions.pod:3118
21341 #: ../fish/guestfish-actions.pod:3120
21349 #: ../fish/guestfish-actions.pod:3128
21350 msgid "See also L</pvs-full>."
21354 #: ../fish/guestfish-actions.pod:3130
21359 #: ../fish/guestfish-actions.pod:3132
21367 #: ../fish/guestfish-actions.pod:3137
21372 #: ../fish/guestfish-actions.pod:3139
21380 #: ../fish/guestfish-actions.pod:3143
21385 #: ../fish/guestfish-actions.pod:3145
21388 " pwrite path content offset\n"
21393 #: ../fish/guestfish-actions.pod:3156
21394 msgid "See also L</pread>, L</pwrite-device>."
21398 #: ../fish/guestfish-actions.pod:3161
21399 msgid "pwrite-device"
21403 #: ../fish/guestfish-actions.pod:3163
21406 " pwrite-device device content offset\n"
21411 #: ../fish/guestfish-actions.pod:3173
21412 msgid "See also L</pwrite>."
21416 #: ../fish/guestfish-actions.pod:3178
21421 #: ../fish/guestfish-actions.pod:3180
21424 " read-file path\n"
21429 #: ../fish/guestfish-actions.pod:3185
21431 "Unlike L</cat>, this function can correctly handle files that contain "
21432 "embedded ASCII NUL characters. However unlike L</download>, this function "
21433 "is limited in the total size of file that can be handled."
21437 #: ../fish/guestfish-actions.pod:3193
21442 #: ../fish/guestfish-actions.pod:3195
21445 " read-lines path\n"
21450 #: ../fish/guestfish-actions.pod:3202
21452 "Note that this function cannot correctly handle binary files (specifically, "
21453 "files containing C<\\0> character which is treated as end of line). For "
21454 "those you need to use the L</read-file> function which has a more complex "
21459 #: ../fish/guestfish-actions.pod:3207
21464 #: ../fish/guestfish-actions.pod:3209
21472 #: ../fish/guestfish-actions.pod:3261
21474 "This function is primarily intended for use by programs. To get a simple "
21475 "list of names, use L</ls>. To get a printable directory for human "
21476 "consumption, use L</ll>."
21480 #: ../fish/guestfish-actions.pod:3265
21485 #: ../fish/guestfish-actions.pod:3267
21493 #: ../fish/guestfish-actions.pod:3271
21494 msgid "readlinklist"
21498 #: ../fish/guestfish-actions.pod:3273
21501 " readlinklist path 'names ...'\n"
21506 #: ../fish/guestfish-actions.pod:3297
21511 #: ../fish/guestfish-actions.pod:3299
21519 #: ../fish/guestfish-actions.pod:3304
21520 msgid "removexattr"
21524 #: ../fish/guestfish-actions.pod:3306
21527 " removexattr xattr path\n"
21532 #: ../fish/guestfish-actions.pod:3311
21533 msgid "See also: L</lremovexattr>, L<attr(5)>."
21537 #: ../fish/guestfish-actions.pod:3313
21542 #: ../fish/guestfish-actions.pod:3315
21545 " resize2fs device\n"
21550 #: ../fish/guestfish-actions.pod:3320
21552 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
21553 "before calling this command. For unknown reasons C<resize2fs> sometimes "
21554 "gives an error about this and sometimes not. In any case, it is always safe "
21555 "to call L</e2fsck-f> before calling this function."
21559 #: ../fish/guestfish-actions.pod:3326
21560 msgid "resize2fs-size"
21564 #: ../fish/guestfish-actions.pod:3328
21567 " resize2fs-size device size\n"
21572 #: ../fish/guestfish-actions.pod:3330
21574 "This command is the same as L</resize2fs> except that it allows you to "
21575 "specify the new size (in bytes) explicitly."
21579 #: ../fish/guestfish-actions.pod:3333
21584 #: ../fish/guestfish-actions.pod:3335
21592 #: ../fish/guestfish-actions.pod:3339
21597 #: ../fish/guestfish-actions.pod:3341
21605 #: ../fish/guestfish-actions.pod:3347
21610 #: ../fish/guestfish-actions.pod:3349
21618 #: ../fish/guestfish-actions.pod:3353
21619 msgid "rmmountpoint"
21623 #: ../fish/guestfish-actions.pod:3355
21626 " rmmountpoint exemptpath\n"
21631 #: ../fish/guestfish-actions.pod:3357
21633 "This calls removes a mountpoint that was previously created with "
21634 "L</mkmountpoint>. See L</mkmountpoint> for full details."
21638 #: ../fish/guestfish-actions.pod:3361
21639 msgid "scrub-device"
21643 #: ../fish/guestfish-actions.pod:3363
21646 " scrub-device device\n"
21651 #: ../fish/guestfish-actions.pod:3374
21656 #: ../fish/guestfish-actions.pod:3376
21659 " scrub-file file\n"
21664 #: ../fish/guestfish-actions.pod:3386
21665 msgid "scrub-freespace"
21669 #: ../fish/guestfish-actions.pod:3388
21672 " scrub-freespace dir\n"
21677 #: ../fish/guestfish-actions.pod:3390
21679 "This command creates the directory C<dir> and then fills it with files until "
21680 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
21681 "deletes them. The intention is to scrub any free space on the partition "
21682 "containing C<dir>."
21686 #: ../fish/guestfish-actions.pod:3399
21691 #: ../fish/guestfish-actions.pod:3401
21696 #: ../fish/guestfish-actions.pod:3403
21699 " set-append append\n"
21704 #: ../fish/guestfish-actions.pod:3414
21705 msgid "set-autosync"
21709 #: ../fish/guestfish-actions.pod:3416
21714 #: ../fish/guestfish-actions.pod:3418
21717 " set-autosync true|false\n"
21722 #: ../fish/guestfish-actions.pod:3420
21724 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
21725 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
21726 "closed (also if the program exits without closing handles)."
21730 #: ../fish/guestfish-actions.pod:3428
21735 #: ../fish/guestfish-actions.pod:3430
21740 #: ../fish/guestfish-actions.pod:3432
21743 " set-direct true|false\n"
21748 #: ../fish/guestfish-actions.pod:3438
21750 "One consequence of this is that log messages aren't caught by the library "
21751 "and handled by L</set-log-message-callback>, but go straight to stdout."
21755 #: ../fish/guestfish-actions.pod:3447
21756 msgid "set-e2label"
21760 #: ../fish/guestfish-actions.pod:3449
21763 " set-e2label device label\n"
21768 #: ../fish/guestfish-actions.pod:3455
21770 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
21771 "label on a filesystem."
21775 #: ../fish/guestfish-actions.pod:3458
21780 #: ../fish/guestfish-actions.pod:3460
21783 " set-e2uuid device uuid\n"
21788 #: ../fish/guestfish-actions.pod:3467
21790 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
21791 "UUID of a filesystem."
21795 #: ../fish/guestfish-actions.pod:3470
21796 msgid "set-memsize"
21800 #: ../fish/guestfish-actions.pod:3472
21805 #: ../fish/guestfish-actions.pod:3474
21808 " set-memsize memsize\n"
21813 #: ../fish/guestfish-actions.pod:3476
21815 "This sets the memory size in megabytes allocated to the qemu subprocess. "
21816 "This only has any effect if called before L</launch>."
21820 #: ../fish/guestfish-actions.pod:3487
21821 msgid "set-network"
21825 #: ../fish/guestfish-actions.pod:3489
21830 #: ../fish/guestfish-actions.pod:3491
21833 " set-network true|false\n"
21838 #: ../fish/guestfish-actions.pod:3499
21839 msgid "You must call this before calling L</launch>, otherwise it has no effect."
21843 #: ../fish/guestfish-actions.pod:3502
21848 #: ../fish/guestfish-actions.pod:3504
21853 #: ../fish/guestfish-actions.pod:3506
21856 " set-path searchpath\n"
21861 #: ../fish/guestfish-actions.pod:3515
21866 #: ../fish/guestfish-actions.pod:3517
21871 #: ../fish/guestfish-actions.pod:3519
21879 #: ../fish/guestfish-actions.pod:3539
21880 msgid "set-recovery-proc"
21884 #: ../fish/guestfish-actions.pod:3541
21885 msgid "recovery-proc"
21889 #: ../fish/guestfish-actions.pod:3543
21892 " set-recovery-proc true|false\n"
21897 #: ../fish/guestfish-actions.pod:3545
21899 "If this is called with the parameter C<false> then L</launch> does not "
21900 "create a recovery process. The purpose of the recovery process is to stop "
21901 "runaway qemu processes in the case where the main program aborts abruptly."
21905 #: ../fish/guestfish-actions.pod:3550
21907 "This only has any effect if called before L</launch>, and the default is "
21912 #: ../fish/guestfish-actions.pod:3559
21913 msgid "set-selinux"
21917 #: ../fish/guestfish-actions.pod:3561
21922 #: ../fish/guestfish-actions.pod:3563
21925 " set-selinux true|false\n"
21930 #: ../fish/guestfish-actions.pod:3574
21935 #: ../fish/guestfish-actions.pod:3576
21940 #: ../fish/guestfish-actions.pod:3578
21943 " set-trace true|false\n"
21948 #: ../fish/guestfish-actions.pod:3594
21949 msgid "set-verbose"
21953 #: ../fish/guestfish-actions.pod:3596
21958 #: ../fish/guestfish-actions.pod:3598
21961 " set-verbose true|false\n"
21966 #: ../fish/guestfish-actions.pod:3605
21971 #: ../fish/guestfish-actions.pod:3607
21974 " setcon context\n"
21979 #: ../fish/guestfish-actions.pod:3614
21984 #: ../fish/guestfish-actions.pod:3616
21987 " setxattr xattr val vallen path\n"
21992 #: ../fish/guestfish-actions.pod:3622
21993 msgid "See also: L</lsetxattr>, L<attr(5)>."
21997 #: ../fish/guestfish-actions.pod:3624
22002 #: ../fish/guestfish-actions.pod:3626
22005 " sfdisk device cyls heads sectors 'lines ...'\n"
22010 #: ../fish/guestfish-actions.pod:3648
22011 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
22015 #: ../fish/guestfish-actions.pod:3654
22020 #: ../fish/guestfish-actions.pod:3656
22023 " sfdiskM device 'lines ...'\n"
22028 #: ../fish/guestfish-actions.pod:3658
22030 "This is a simplified interface to the L</sfdisk> command, where partition "
22031 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
22032 "you don't need to specify the cyls, heads and sectors parameters which were "
22033 "rarely if ever used anyway."
22037 #: ../fish/guestfish-actions.pod:3664
22038 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
22042 #: ../fish/guestfish-actions.pod:3670
22047 #: ../fish/guestfish-actions.pod:3672
22050 " sfdisk-N device partnum cyls heads sectors line\n"
22055 #: ../fish/guestfish-actions.pod:3677
22057 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
22058 "cyls/heads/sectors parameters."
22062 #: ../fish/guestfish-actions.pod:3680
22063 msgid "See also: L</part-add>"
22067 #: ../fish/guestfish-actions.pod:3685
22068 msgid "sfdisk-disk-geometry"
22072 #: ../fish/guestfish-actions.pod:3687
22075 " sfdisk-disk-geometry device\n"
22080 #: ../fish/guestfish-actions.pod:3689
22082 "This displays the disk geometry of C<device> read from the partition table. "
22083 "Especially in the case where the underlying block device has been resized, "
22084 "this can be different from the kernel's idea of the geometry (see "
22085 "L</sfdisk-kernel-geometry>)."
22089 #: ../fish/guestfish-actions.pod:3697
22090 msgid "sfdisk-kernel-geometry"
22094 #: ../fish/guestfish-actions.pod:3699
22097 " sfdisk-kernel-geometry device\n"
22102 #: ../fish/guestfish-actions.pod:3706
22107 #: ../fish/guestfish-actions.pod:3708
22110 " sfdisk-l device\n"
22115 #: ../fish/guestfish-actions.pod:3714
22116 msgid "See also: L</part-list>"
22120 #: ../fish/guestfish-actions.pod:3716
22125 #: ../fish/guestfish-actions.pod:3718
22133 #: ../fish/guestfish-actions.pod:3723
22134 msgid "This is like L</command>, but passes the command to:"
22138 #: ../fish/guestfish-actions.pod:3731
22139 msgid "All the provisos about L</command> apply to this call."
22143 #: ../fish/guestfish-actions.pod:3733
22148 #: ../fish/guestfish-actions.pod:3735
22151 " sh-lines command\n"
22156 #: ../fish/guestfish-actions.pod:3737
22157 msgid "This is the same as L</sh>, but splits the result into a list of lines."
22161 #: ../fish/guestfish-actions.pod:3740
22162 msgid "See also: L</command-lines>"
22166 #: ../fish/guestfish-actions.pod:3742
22171 #: ../fish/guestfish-actions.pod:3744
22179 #: ../fish/guestfish-actions.pod:3748
22184 #: ../fish/guestfish-actions.pod:3750
22192 #: ../fish/guestfish-actions.pod:3756
22197 #: ../fish/guestfish-actions.pod:3758
22205 #: ../fish/guestfish-actions.pod:3766
22210 #: ../fish/guestfish-actions.pod:3768
22218 #: ../fish/guestfish-actions.pod:3776
22223 #: ../fish/guestfish-actions.pod:3778
22226 " strings-e encoding path\n"
22231 #: ../fish/guestfish-actions.pod:3780
22233 "This is like the L</strings> command, but allows you to specify the encoding "
22234 "of strings that are looked for in the source file C<path>."
22238 #: ../fish/guestfish-actions.pod:3790
22240 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
22241 "ISO-8859-X (this is what L</strings> uses)."
22245 #: ../fish/guestfish-actions.pod:3822
22246 msgid "swapoff-device"
22250 #: ../fish/guestfish-actions.pod:3824
22253 " swapoff-device device\n"
22258 #: ../fish/guestfish-actions.pod:3826
22260 "This command disables the libguestfs appliance swap device or partition "
22261 "named C<device>. See L</swapon-device>."
22265 #: ../fish/guestfish-actions.pod:3830
22266 msgid "swapoff-file"
22270 #: ../fish/guestfish-actions.pod:3832
22273 " swapoff-file file\n"
22278 #: ../fish/guestfish-actions.pod:3836
22279 msgid "swapoff-label"
22283 #: ../fish/guestfish-actions.pod:3838
22286 " swapoff-label label\n"
22291 #: ../fish/guestfish-actions.pod:3843
22292 msgid "swapoff-uuid"
22296 #: ../fish/guestfish-actions.pod:3845
22299 " swapoff-uuid uuid\n"
22304 #: ../fish/guestfish-actions.pod:3850
22305 msgid "swapon-device"
22309 #: ../fish/guestfish-actions.pod:3852
22312 " swapon-device device\n"
22317 #: ../fish/guestfish-actions.pod:3854
22319 "This command enables the libguestfs appliance to use the swap device or "
22320 "partition named C<device>. The increased memory is made available for all "
22321 "commands, for example those run using L</command> or L</sh>."
22325 #: ../fish/guestfish-actions.pod:3866
22326 msgid "swapon-file"
22330 #: ../fish/guestfish-actions.pod:3868
22333 " swapon-file file\n"
22338 #: ../fish/guestfish-actions.pod:3870
22339 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
22343 #: ../fish/guestfish-actions.pod:3873
22344 msgid "swapon-label"
22348 #: ../fish/guestfish-actions.pod:3875
22351 " swapon-label label\n"
22356 #: ../fish/guestfish-actions.pod:3877
22358 "This command enables swap to a labeled swap partition. See "
22359 "L</swapon-device> for other notes."
22363 #: ../fish/guestfish-actions.pod:3880
22364 msgid "swapon-uuid"
22368 #: ../fish/guestfish-actions.pod:3882
22371 " swapon-uuid uuid\n"
22376 #: ../fish/guestfish-actions.pod:3884
22378 "This command enables swap to a swap partition with the given UUID. See "
22379 "L</swapon-device> for other notes."
22383 #: ../fish/guestfish-actions.pod:3887
22388 #: ../fish/guestfish-actions.pod:3889
22396 #: ../fish/guestfish-actions.pod:3897
22401 #: ../fish/guestfish-actions.pod:3899
22409 #: ../fish/guestfish-actions.pod:3907
22414 #: ../fish/guestfish-actions.pod:3909
22417 " tail-n nrlines path\n"
22422 #: ../fish/guestfish-actions.pod:3922
22427 #: ../fish/guestfish-actions.pod:3924
22430 " tar-in (tarfile|-) directory\n"
22435 #: ../fish/guestfish-actions.pod:3929
22436 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
22440 #: ../fish/guestfish-actions.pod:3934
22445 #: ../fish/guestfish-actions.pod:3936
22448 " tar-out directory (tarfile|-)\n"
22453 #: ../fish/guestfish-actions.pod:3941
22454 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
22458 #: ../fish/guestfish-actions.pod:3946
22463 #: ../fish/guestfish-actions.pod:3948
22466 " tgz-in (tarball|-) directory\n"
22471 #: ../fish/guestfish-actions.pod:3953
22472 msgid "To upload an uncompressed tarball, use L</tar-in>."
22476 #: ../fish/guestfish-actions.pod:3957
22481 #: ../fish/guestfish-actions.pod:3959
22484 " tgz-out directory (tarball|-)\n"
22489 #: ../fish/guestfish-actions.pod:3964
22490 msgid "To download an uncompressed tarball, use L</tar-out>."
22494 #: ../fish/guestfish-actions.pod:3968
22499 #: ../fish/guestfish-actions.pod:3970
22507 #: ../fish/guestfish-actions.pod:3979
22512 #: ../fish/guestfish-actions.pod:3981
22520 #: ../fish/guestfish-actions.pod:3986
22521 msgid "truncate-size"
22525 #: ../fish/guestfish-actions.pod:3988
22528 " truncate-size path size\n"
22533 #: ../fish/guestfish-actions.pod:3993
22535 "If the current file size is less than C<size> then the file is extended to "
22536 "the required size with zero bytes. This creates a sparse file (ie. disk "
22537 "blocks are not allocated for the file until you write to it). To create a "
22538 "non-sparse file of zeroes, use L</fallocate64> instead."
22542 #: ../fish/guestfish-actions.pod:3999
22547 #: ../fish/guestfish-actions.pod:4001
22550 " tune2fs-l device\n"
22555 #: ../fish/guestfish-actions.pod:4011
22560 #: ../fish/guestfish-actions.pod:4013
22563 " txz-in (tarball|-) directory\n"
22568 #: ../fish/guestfish-actions.pod:4020
22573 #: ../fish/guestfish-actions.pod:4022
22576 " txz-out directory (tarball|-)\n"
22581 #: ../fish/guestfish-actions.pod:4029
22586 #: ../fish/guestfish-actions.pod:4031
22594 #: ../fish/guestfish-actions.pod:4045
22595 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
22599 #: ../fish/guestfish-actions.pod:4050
22604 #: ../fish/guestfish-actions.pod:4052
22609 #: ../fish/guestfish-actions.pod:4054
22612 " umount pathordevice\n"
22617 #: ../fish/guestfish-actions.pod:4060
22622 #: ../fish/guestfish-actions.pod:4062
22623 msgid "unmount-all"
22627 #: ../fish/guestfish-actions.pod:4064
22635 #: ../fish/guestfish-actions.pod:4070
22640 #: ../fish/guestfish-actions.pod:4072
22643 " upload (filename|-) remotefilename\n"
22648 #: ../fish/guestfish-actions.pod:4079
22649 msgid "See also L</download>."
22653 #: ../fish/guestfish-actions.pod:4083
22654 msgid "upload-offset"
22658 #: ../fish/guestfish-actions.pod:4085
22661 " upload-offset (filename|-) remotefilename offset\n"
22666 #: ../fish/guestfish-actions.pod:4097
22668 "Note that there is no limit on the amount of data that can be uploaded with "
22669 "this call, unlike with L</pwrite>, and this call always writes the full "
22670 "amount unless an error occurs."
22674 #: ../fish/guestfish-actions.pod:4102
22675 msgid "See also L</upload>, L</pwrite>."
22679 #: ../fish/guestfish-actions.pod:4106
22684 #: ../fish/guestfish-actions.pod:4108
22687 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
22692 #: ../fish/guestfish-actions.pod:4127
22697 #: ../fish/guestfish-actions.pod:4129
22705 #: ../fish/guestfish-actions.pod:4156
22707 "I<Note:> Don't use this call to test for availability of features. In "
22708 "enterprise distributions we backport features from later versions into "
22709 "earlier versions, making this an unreliable way to test for features. Use "
22710 "L</available> instead."
22714 #: ../fish/guestfish-actions.pod:4162
22719 #: ../fish/guestfish-actions.pod:4164
22722 " vfs-label device\n"
22727 #: ../fish/guestfish-actions.pod:4171
22728 msgid "To find a filesystem from the label, use L</findfs-label>."
22732 #: ../fish/guestfish-actions.pod:4173
22737 #: ../fish/guestfish-actions.pod:4175
22740 " vfs-type device\n"
22745 #: ../fish/guestfish-actions.pod:4185
22750 #: ../fish/guestfish-actions.pod:4187
22753 " vfs-uuid device\n"
22758 #: ../fish/guestfish-actions.pod:4194
22759 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
22763 #: ../fish/guestfish-actions.pod:4196
22764 msgid "vg-activate"
22768 #: ../fish/guestfish-actions.pod:4198
22771 " vg-activate true|false 'volgroups ...'\n"
22776 #: ../fish/guestfish-actions.pod:4211
22777 msgid "vg-activate-all"
22781 #: ../fish/guestfish-actions.pod:4213
22784 " vg-activate-all true|false\n"
22789 #: ../fish/guestfish-actions.pod:4223
22794 #: ../fish/guestfish-actions.pod:4225
22797 " vgcreate volgroup 'physvols ...'\n"
22802 #: ../fish/guestfish-actions.pod:4230
22807 #: ../fish/guestfish-actions.pod:4232
22810 " vglvuuids vgname\n"
22815 #: ../fish/guestfish-actions.pod:4237
22817 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
22818 "logical volumes and volume groups."
22822 #: ../fish/guestfish-actions.pod:4240
22823 msgid "See also L</vgpvuuids>."
22827 #: ../fish/guestfish-actions.pod:4242
22832 #: ../fish/guestfish-actions.pod:4244
22835 " vgpvuuids vgname\n"
22840 #: ../fish/guestfish-actions.pod:4249
22842 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
22843 "physical volumes and volume groups."
22847 #: ../fish/guestfish-actions.pod:4252
22848 msgid "See also L</vglvuuids>."
22852 #: ../fish/guestfish-actions.pod:4254
22857 #: ../fish/guestfish-actions.pod:4256
22860 " vgremove vgname\n"
22865 #: ../fish/guestfish-actions.pod:4263
22870 #: ../fish/guestfish-actions.pod:4265
22873 " vgrename volgroup newvolgroup\n"
22878 #: ../fish/guestfish-actions.pod:4269
22883 #: ../fish/guestfish-actions.pod:4271
22891 #: ../fish/guestfish-actions.pod:4279
22892 msgid "See also L</vgs-full>."
22896 #: ../fish/guestfish-actions.pod:4281
22901 #: ../fish/guestfish-actions.pod:4283
22909 #: ../fish/guestfish-actions.pod:4288
22914 #: ../fish/guestfish-actions.pod:4290
22922 #: ../fish/guestfish-actions.pod:4295
22927 #: ../fish/guestfish-actions.pod:4297
22935 #: ../fish/guestfish-actions.pod:4301
22940 #: ../fish/guestfish-actions.pod:4303
22948 #: ../fish/guestfish-actions.pod:4308
22953 #: ../fish/guestfish-actions.pod:4310
22961 #: ../fish/guestfish-actions.pod:4315
22966 #: ../fish/guestfish-actions.pod:4317
22974 #: ../fish/guestfish-actions.pod:4322
22979 #: ../fish/guestfish-actions.pod:4324
22982 " write path content\n"
22987 #: ../fish/guestfish-actions.pod:4332
22992 #: ../fish/guestfish-actions.pod:4334
22995 " write-file path content size\n"
23000 #: ../fish/guestfish-actions.pod:4357
23005 #: ../fish/guestfish-actions.pod:4359
23008 " zegrep regex path\n"
23013 #: ../fish/guestfish-actions.pod:4367
23018 #: ../fish/guestfish-actions.pod:4369
23021 " zegrepi regex path\n"
23026 #: ../fish/guestfish-actions.pod:4377
23031 #: ../fish/guestfish-actions.pod:4379
23039 #: ../fish/guestfish-actions.pod:4387
23040 msgid "See also: L</zero-device>, L</scrub-device>."
23044 #: ../fish/guestfish-actions.pod:4389
23045 msgid "zero-device"
23049 #: ../fish/guestfish-actions.pod:4391
23052 " zero-device device\n"
23057 #: ../fish/guestfish-actions.pod:4393
23059 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
23060 "which just zeroes the first few blocks of a device."
23064 #: ../fish/guestfish-actions.pod:4400
23069 #: ../fish/guestfish-actions.pod:4402
23072 " zerofree device\n"
23077 #: ../fish/guestfish-actions.pod:4415
23082 #: ../fish/guestfish-actions.pod:4417
23085 " zfgrep pattern path\n"
23090 #: ../fish/guestfish-actions.pod:4425
23095 #: ../fish/guestfish-actions.pod:4427
23098 " zfgrepi pattern path\n"
23103 #: ../fish/guestfish-actions.pod:4435
23108 #: ../fish/guestfish-actions.pod:4437
23111 " zfile meth path\n"
23116 #: ../fish/guestfish-actions.pod:4444
23117 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
23121 #: ../fish/guestfish-actions.pod:4454
23126 #: ../fish/guestfish-actions.pod:4456
23129 " zgrep regex path\n"
23134 #: ../fish/guestfish-actions.pod:4464
23139 #: ../fish/guestfish-actions.pod:4466
23142 " zgrepi regex path\n"
23147 #: ../fish/guestfish-commands.pod:1
23152 #: ../fish/guestfish-commands.pod:3
23157 #: ../fish/guestfish-commands.pod:5
23160 " alloc filename size\n"
23165 #: ../fish/guestfish-commands.pod:7
23167 "This creates an empty (zeroed) file of the given size, and then adds so it "
23168 "can be further examined."
23172 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
23173 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
23177 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
23178 msgid "Size can be specified using standard suffixes, eg. C<1M>."
23182 #: ../fish/guestfish-commands.pod:14
23184 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
23185 "image, see L</PREPARED DISK IMAGES>."
23189 #: ../fish/guestfish-commands.pod:17
23194 #: ../fish/guestfish-commands.pod:19
23197 " copy-in local [local ...] /remotedir\n"
23202 #: ../fish/guestfish-commands.pod:21
23204 "C<copy-in> copies local files or directories recursively into the disk "
23205 "image, placing them in the directory called C</remotedir> (which must "
23206 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
23207 "other commands as necessary."
23211 #: ../fish/guestfish-commands.pod:26
23213 "Multiple local files and directories can be specified, but the last "
23214 "parameter must always be a remote directory. Wildcards cannot be used."
23218 #: ../fish/guestfish-commands.pod:30
23223 #: ../fish/guestfish-commands.pod:32
23226 " copy-out remote [remote ...] localdir\n"
23231 #: ../fish/guestfish-commands.pod:34
23233 "C<copy-out> copies remote files or directories recursively out of the disk "
23234 "image, placing them on the host disk in a local directory called C<localdir> "
23235 "(which must exist). This guestfish meta-command turns into a sequence of "
23236 "L</download>, L</tar-out> and other commands as necessary."
23240 #: ../fish/guestfish-commands.pod:40
23242 "Multiple remote files and directories can be specified, but the last "
23243 "parameter must always be a local directory. To download to the current "
23244 "directory, use C<.> as in:"
23248 #: ../fish/guestfish-commands.pod:44
23251 " copy-out /home .\n"
23256 #: ../fish/guestfish-commands.pod:46
23258 "Wildcards cannot be used in the ordinary command, but you can use them with "
23259 "the help of L</glob> like this:"
23263 #: ../fish/guestfish-commands.pod:49
23266 " glob copy-out /home/* .\n"
23271 #: ../fish/guestfish-commands.pod:51
23276 #: ../fish/guestfish-commands.pod:53
23279 " echo [params ...]\n"
23284 #: ../fish/guestfish-commands.pod:55
23285 msgid "This echos the parameters to the terminal."
23289 #: ../fish/guestfish-commands.pod:57
23294 #: ../fish/guestfish-commands.pod:59
23299 #: ../fish/guestfish-commands.pod:61
23304 #: ../fish/guestfish-commands.pod:63
23312 #: ../fish/guestfish-commands.pod:65
23314 "This is used to edit a file. It downloads the file, edits it locally using "
23315 "your editor, then uploads the result."
23319 #: ../fish/guestfish-commands.pod:68
23321 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
23322 "or C<emacs> you will get those corresponding editors."
23326 #: ../fish/guestfish-commands.pod:72
23331 #: ../fish/guestfish-commands.pod:74
23334 " glob command args...\n"
23339 #: ../fish/guestfish-commands.pod:76
23341 "Expand wildcards in any paths in the args list, and run C<command> "
23342 "repeatedly on each matching path."
23346 #: ../fish/guestfish-commands.pod:79
23347 msgid "See L</WILDCARDS AND GLOBBING>."
23351 #: ../fish/guestfish-commands.pod:81
23356 #: ../fish/guestfish-commands.pod:83
23359 " hexedit <filename|device>\n"
23360 " hexedit <filename|device> <max>\n"
23361 " hexedit <filename|device> <start> <max>\n"
23366 #: ../fish/guestfish-commands.pod:87
23368 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
23373 #: ../fish/guestfish-commands.pod:90
23375 "This command works by downloading potentially the whole file or device, "
23376 "editing it locally, then uploading it. If the file or device is large, you "
23377 "have to specify which part you wish to edit by using C<max> and/or C<start> "
23378 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
23379 "usual modifiers allowed such as C<1M> (1 megabyte)."
23383 #: ../fish/guestfish-commands.pod:97
23384 msgid "For example to edit the first few sectors of a disk you might do:"
23388 #: ../fish/guestfish-commands.pod:100
23391 " hexedit /dev/sda 1M\n"
23396 #: ../fish/guestfish-commands.pod:102
23398 "which would allow you to edit anywhere within the first megabyte of the "
23403 #: ../fish/guestfish-commands.pod:105
23404 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
23408 #: ../fish/guestfish-commands.pod:107
23411 " hexedit /dev/sda1 0x400 0x400\n"
23416 #: ../fish/guestfish-commands.pod:109
23417 msgid "(assuming the superblock is in the standard location)."
23421 #: ../fish/guestfish-commands.pod:111
23423 "This command requires the external L<hexedit(1)> program. You can specify "
23424 "another program to use by setting the C<HEXEDITOR> environment variable."
23428 #: ../fish/guestfish-commands.pod:115
23429 msgid "See also L</hexdump>."
23433 #: ../fish/guestfish-commands.pod:117
23438 #: ../fish/guestfish-commands.pod:119
23446 #: ../fish/guestfish-commands.pod:121
23447 msgid "Change the local directory, ie. the current directory of guestfish itself."
23451 #: ../fish/guestfish-commands.pod:124
23452 msgid "Note that C<!cd> won't do what you might expect."
23456 #: ../fish/guestfish-commands.pod:126
23461 #: ../fish/guestfish-commands.pod:128
23466 #: ../fish/guestfish-commands.pod:130
23474 #: ../fish/guestfish-commands.pod:132
23475 msgid "Opens the manual page for guestfish."
23479 #: ../fish/guestfish-commands.pod:134
23484 #: ../fish/guestfish-commands.pod:136
23489 #: ../fish/guestfish-commands.pod:138
23497 #: ../fish/guestfish-commands.pod:140
23505 #: ../fish/guestfish-commands.pod:142
23506 msgid "This is used to view a file."
23510 #: ../fish/guestfish-commands.pod:144
23512 "The default viewer is C<$PAGER>. However if you use the alternate command "
23513 "C<less> you will get the C<less> command specifically."
23517 #: ../fish/guestfish-commands.pod:147
23522 #: ../fish/guestfish-commands.pod:149
23530 #: ../fish/guestfish-commands.pod:151
23532 "Close and reopen the libguestfs handle. It is not necessary to use this "
23533 "normally, because the handle is closed properly when guestfish exits. "
23534 "However this is occasionally useful for testing."
23538 #: ../fish/guestfish-commands.pod:155
23543 #: ../fish/guestfish-commands.pod:157
23546 " sparse filename size\n"
23551 #: ../fish/guestfish-commands.pod:159
23553 "This creates an empty sparse file of the given size, and then adds so it can "
23554 "be further examined."
23558 #: ../fish/guestfish-commands.pod:162
23560 "In all respects it works the same as the L</alloc> command, except that the "
23561 "image file is allocated sparsely, which means that disk blocks are not "
23562 "assigned to the file until they are needed. Sparse disk files only use "
23563 "space when written to, but they are slower and there is a danger you could "
23564 "run out of real disk space during a write operation."
23568 #: ../fish/guestfish-commands.pod:172
23573 #: ../fish/guestfish-commands.pod:174
23581 #: ../fish/guestfish-commands.pod:176
23583 "This command returns a list of the optional groups known to the daemon, and "
23584 "indicates which ones are supported by this build of the libguestfs "
23589 #: ../fish/guestfish-commands.pod:180
23590 msgid "See also L<guestfs(3)/AVAILABILITY>."
23594 #: ../fish/guestfish-commands.pod:182
23599 #: ../fish/guestfish-commands.pod:184
23602 " time command args...\n"
23607 #: ../fish/guestfish-commands.pod:186
23609 "Run the command as usual, but print the elapsed time afterwards. This can "
23610 "be useful for benchmarking operations."
23614 #: ../test-tool/libguestfs-test-tool.pod:5
23615 msgid "libguestfs-test-tool - End user tests for libguestfs"
23619 #: ../test-tool/libguestfs-test-tool.pod:9
23622 " libguestfs-test-tool [--options]\n"
23627 #: ../test-tool/libguestfs-test-tool.pod:13
23629 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
23630 "and developers, to allow them to check basic libguestfs functionality is "
23631 "working. This is needed because libguestfs occasionally breaks for reasons "
23632 "beyond our control: usually because of changes in the underlying qemu or "
23633 "kernel packages, or the host environment."
23637 #: ../test-tool/libguestfs-test-tool.pod:20
23638 msgid "If you suspect a problem in libguestfs, then just run:"
23642 #: ../test-tool/libguestfs-test-tool.pod:22
23645 " libguestfs-test-tool\n"
23650 #: ../test-tool/libguestfs-test-tool.pod:24
23651 msgid "It will print lots of diagnostic messages."
23655 #: ../test-tool/libguestfs-test-tool.pod:26
23656 msgid "If it runs to completion successfully, you will see this near the end:"
23660 #: ../test-tool/libguestfs-test-tool.pod:28
23663 " ===== TEST FINISHED OK =====\n"
23668 #: ../test-tool/libguestfs-test-tool.pod:30
23669 msgid "and the test tool will exit with code 0."
23673 #: ../test-tool/libguestfs-test-tool.pod:32
23675 "If it fails (and/or exits with non-zero error code), please paste the "
23676 "B<complete, unedited> output of the test tool into a bug report. More "
23677 "information about reporting bugs can be found on the "
23678 "L<http://libguestfs.org/> website."
23682 #: ../test-tool/libguestfs-test-tool.pod:41
23687 #: ../test-tool/libguestfs-test-tool.pod:43
23688 msgid "Display short usage information and exit."
23692 #: ../test-tool/libguestfs-test-tool.pod:45
23693 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
23697 #: ../test-tool/libguestfs-test-tool.pod:47
23699 "Pass an alternate name for the helper program. libguestfs-test-tool will "
23700 "normally look in the C<$libexec> directory that was configured when the tool "
23705 #: ../test-tool/libguestfs-test-tool.pod:51
23706 msgid "I<--qemu qemu_binary>"
23710 #: ../test-tool/libguestfs-test-tool.pod:53
23712 "If you have downloaded another qemu binary, point this option at the full "
23713 "path of the binary to try it."
23717 #: ../test-tool/libguestfs-test-tool.pod:56
23718 msgid "I<--qemudir qemu_source_dir>"
23722 #: ../test-tool/libguestfs-test-tool.pod:58
23724 "If you have compiled qemu from source, point this option at the source "
23725 "directory to try it."
23729 #: ../test-tool/libguestfs-test-tool.pod:61
23730 msgid "I<--timeout N>"
23734 #: ../test-tool/libguestfs-test-tool.pod:63
23736 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
23737 "does not usually need to be adjusted unless your machine is very slow."
23741 #: ../test-tool/libguestfs-test-tool.pod:69
23742 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
23746 #: ../test-tool/libguestfs-test-tool.pod:71
23748 "If you have compiled another version of qemu from source and would like to "
23749 "try that, then you can use the I<--qemudir> option to point to the qemu "
23750 "source directory."
23754 #: ../test-tool/libguestfs-test-tool.pod:75
23756 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
23757 "option to point to the binary."
23761 #: ../test-tool/libguestfs-test-tool.pod:78
23763 "When using an alternate qemu with libguestfs, usually you would need to "
23764 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
23765 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
23766 "when you use either of the I<--qemudir> or I<--qemu> options."
23770 #: ../test-tool/libguestfs-test-tool.pod:85
23772 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
23773 "I<1> if there was an error."
23777 #: ../test-tool/libguestfs-test-tool.pod:92
23778 msgid "/usr/libexec/libguestfs-test-tool-helper"
23782 #: ../test-tool/libguestfs-test-tool.pod:94
23784 "This helper program is run inside the appliance and provides additional "
23789 #: ../test-tool/libguestfs-test-tool.pod:97
23790 msgid "/usr/bin/mkisofs"
23794 #: ../test-tool/libguestfs-test-tool.pod:99
23796 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
23797 "which is used as part of the tests."
23801 #: ../test-tool/libguestfs-test-tool.pod:106
23803 "For the full list of environment variables which may affect libguestfs, "
23804 "please see the L<guestfs(3)> manual page."
23808 #: ../test-tool/libguestfs-test-tool.pod:111
23809 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
23813 #: ../test-tool/libguestfs-test-tool.pod:121
23814 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
23818 #: ../fuse/guestmount.pod:5
23819 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
23823 #: ../fuse/guestmount.pod:9
23826 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
23831 #: ../fuse/guestmount.pod:11
23834 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
23839 #: ../fuse/guestmount.pod:13
23842 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
23847 #: ../fuse/guestmount.pod:17
23849 "You must I<not> use C<guestmount> in read-write mode on live virtual "
23850 "machines. If you do this, you risk disk corruption in the VM."
23854 #: ../fuse/guestmount.pod:22
23856 "The guestmount program can be used to mount virtual machine filesystems and "
23857 "other disk images on the host. It uses libguestfs for access to the guest "
23858 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
23859 "a mountable device."
23863 #: ../fuse/guestmount.pod:27
23865 "Along with other options, you have to give at least one device (I<-a> "
23866 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
23867 "option) or use the I<-i> inspection option. How this works is better "
23868 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
23873 #: ../fuse/guestmount.pod:33
23875 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
23876 "by you, and the filesystem will not be visible to any other users unless you "
23877 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
23878 "the filesystem, use the C<fusermount -u> command."
23882 #: ../fuse/guestmount.pod:41
23884 "For a typical Windows guest which has its main filesystem on the first "
23889 #: ../fuse/guestmount.pod:44
23892 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
23897 #: ../fuse/guestmount.pod:46
23899 "For a typical Linux guest which has a /boot filesystem on the first "
23900 "partition, and the root filesystem on a logical volume:"
23904 #: ../fuse/guestmount.pod:49
23907 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
23912 #: ../fuse/guestmount.pod:51
23913 msgid "To get libguestfs to detect guest mountpoints for you:"
23917 #: ../fuse/guestmount.pod:53
23920 " guestmount -a guest.img -i --ro /mnt\n"
23925 #: ../fuse/guestmount.pod:55
23926 msgid "For a libvirt guest called \"Guest\" you could do:"
23930 #: ../fuse/guestmount.pod:57
23933 " guestmount -d Guest -i --ro /mnt\n"
23938 #: ../fuse/guestmount.pod:59
23940 "If you don't know what filesystems are contained in a guest or disk image, "
23941 "use L<virt-list-filesystems(1)> first:"
23945 #: ../fuse/guestmount.pod:62
23948 " virt-list-filesystems MyGuest\n"
23953 #: ../fuse/guestmount.pod:64
23955 "If you want to trace the libguestfs calls but without excessive debugging "
23956 "information, we recommend:"
23960 #: ../fuse/guestmount.pod:67
23963 " guestmount [...] --trace /mnt\n"
23968 #: ../fuse/guestmount.pod:69
23969 msgid "If you want to debug the program, we recommend:"
23973 #: ../fuse/guestmount.pod:71
23976 " guestmount [...] --trace --verbose /mnt\n"
23981 #: ../fuse/guestmount.pod:79
23982 msgid "Add a block device or virtual machine image."
23986 #: ../fuse/guestmount.pod:96
23987 msgid "B<--dir-cache-timeout N>"
23991 #: ../fuse/guestmount.pod:98
23993 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
23994 "seconds. The readdir cache [actually, there are several semi-independent "
23995 "caches] is populated after a readdir(2) call with the stat and extended "
23996 "attributes of the files in the directory, in anticipation that they will be "
23997 "requested soon after."
24001 #: ../fuse/guestmount.pod:104
24003 "There is also a different attribute cache implemented by FUSE (see the FUSE "
24004 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
24005 "requests, only cache existing ones."
24009 #: ../fuse/guestmount.pod:115
24011 "If you have untrusted raw-format guest disk images, you should use this "
24012 "option to specify the disk format. This avoids a possible security problem "
24013 "with malicious guests (CVE-2010-3851). See also "
24014 "L<guestfs(3)/guestfs_add_drive_opts>."
24018 #: ../fuse/guestmount.pod:120
24019 msgid "B<--fuse-help>"
24023 #: ../fuse/guestmount.pod:122
24024 msgid "Display help on special FUSE options (see I<-o> below)."
24028 #: ../fuse/guestmount.pod:126
24029 msgid "Display brief help and exit."
24033 #: ../fuse/guestmount.pod:134
24034 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
24038 #: ../fuse/guestmount.pod:136
24040 "Mount the named partition or logical volume on the given mountpoint B<in the "
24041 "guest> (this has nothing to do with mountpoints in the host)."
24045 #: ../fuse/guestmount.pod:139
24047 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
24048 "something on C</>."
24052 #: ../fuse/guestmount.pod:144
24054 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
24055 "unmounted. If you specify this option, then we don't attempt to sync the "
24056 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
24060 #: ../fuse/guestmount.pod:149
24061 msgid "B<-o option> | B<--option option>"
24065 #: ../fuse/guestmount.pod:151
24066 msgid "Pass extra options to FUSE."
24070 #: ../fuse/guestmount.pod:153
24072 "To get a list of all the extra options supported by FUSE, use the command "
24073 "below. Note that only the FUSE I<-o> options can be passed, and only some "
24074 "of them are a good idea."
24078 #: ../fuse/guestmount.pod:157
24081 " guestmount --fuse-help\n"
24086 #: ../fuse/guestmount.pod:159
24087 msgid "Some potentially useful FUSE options:"
24091 #: ../fuse/guestmount.pod:163
24092 msgid "B<-o allow_other>"
24096 #: ../fuse/guestmount.pod:165
24097 msgid "Allow other users to see the filesystem."
24101 #: ../fuse/guestmount.pod:167
24102 msgid "B<-o attr_timeout=N>"
24106 #: ../fuse/guestmount.pod:169
24107 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
24111 #: ../fuse/guestmount.pod:171
24112 msgid "B<-o kernel_cache>"
24116 #: ../fuse/guestmount.pod:173
24118 "Allow the kernel to cache files (reduces the number of reads that have to go "
24119 "through the L<guestfs(3)> API). This is generally a good idea if you can "
24120 "afford the extra memory usage."
24124 #: ../fuse/guestmount.pod:177
24125 msgid "B<-o uid=N> B<-o gid=N>"
24129 #: ../fuse/guestmount.pod:179
24131 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
24132 "the chosen values."
24136 #: ../fuse/guestmount.pod:186
24138 "Add devices and mount everything read-only. Also disallow writes and make "
24139 "the disk appear read-only to FUSE."
24143 #: ../fuse/guestmount.pod:189
24145 "This is highly recommended if you are not going to edit the guest disk. If "
24146 "the guest is running and this option is I<not> supplied, then there is a "
24147 "strong risk of disk corruption in the guest. We try to prevent this from "
24148 "happening, but it is not always possible."
24152 #: ../fuse/guestmount.pod:196
24153 msgid "Enable SELinux support for the guest."
24157 #: ../fuse/guestmount.pod:200
24158 msgid "Enable verbose messages from underlying libguestfs."
24162 #: ../fuse/guestmount.pod:204
24163 msgid "Display the program version and exit."
24167 #: ../fuse/guestmount.pod:206
24168 msgid "B<-x> | B<--trace>"
24172 #: ../fuse/guestmount.pod:208
24173 msgid "Trace libguestfs calls."
24177 #: ../fuse/guestmount.pod:210
24178 msgid "This also stops the daemon from forking into the background."
24182 #: ../fuse/guestmount.pod:216
24184 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
24185 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
24186 "L<http://fuse.sf.net/>."
24190 #: ../inspector/virt-inspector.pl:35
24192 "virt-inspector - Display operating system version and other information "
24193 "about a virtual machine"
24197 #: ../inspector/virt-inspector.pl:39
24200 " virt-inspector [--connect URI] domname\n"
24205 #: ../inspector/virt-inspector.pl:41
24208 " virt-inspector guest.img [guest.img ...]\n"
24213 #: ../inspector/virt-inspector.pl:45
24215 "B<virt-inspector> examines a virtual machine or disk image and tries to "
24216 "determine the version of the operating system and other information about "
24217 "the virtual machine."
24221 #: ../inspector/virt-inspector.pl:49
24222 msgid "Virt-inspector produces XML output for feeding into other programs."
24226 #: ../inspector/virt-inspector.pl:51
24228 "In the normal usage, use C<virt-inspector domname> where C<domname> is the "
24229 "libvirt domain (see: C<virsh list --all>)."
24233 #: ../inspector/virt-inspector.pl:54
24235 "You can also run virt-inspector directly on disk images from a single "
24236 "virtual machine. Use C<virt-inspector guest.img>. In rare cases a domain "
24237 "has several block devices, in which case you should list them one after "
24238 "another, with the first corresponding to the guest's C</dev/sda>, the second "
24239 "to the guest's C</dev/sdb> and so on."
24243 #: ../inspector/virt-inspector.pl:60
24245 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
24246 "inspect several virtual machines, you have to run virt-inspector several "
24247 "times (for example, from a shell script for-loop)."
24251 #: ../inspector/virt-inspector.pl:65
24253 "Because virt-inspector needs direct access to guest images, it won't "
24254 "normally work over remote libvirt connections."
24258 #: ../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
24259 msgid "Display brief help."
24263 #: ../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
24264 msgid "B<--version>"
24268 #: ../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
24269 msgid "Display version number and exit."
24273 #: ../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
24274 msgid "B<--connect URI> | B<-c URI>"
24278 #: ../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
24280 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
24281 "to the default libvirt hypervisor."
24285 #: ../inspector/virt-inspector.pl:97
24287 "Libvirt is only used if you specify a C<domname> on the command line. If "
24288 "you specify guest block devices directly, then libvirt is not used at all."
24292 #: ../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
24293 msgid "B<--format> raw"
24297 #: ../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
24299 "Specify the format of disk images given on the command line. If this is "
24300 "omitted then the format is autodetected from the content of the disk image."
24304 #: ../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
24306 "If disk images are requested from libvirt, then this program asks libvirt "
24307 "for this information. In this case, the value of the format parameter is "
24312 #: ../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
24314 "If working with untrusted raw-format guest disk images, you should ensure "
24315 "the format is always specified."
24319 #: ../inspector/virt-inspector.pl:149
24324 #: ../inspector/virt-inspector.pl:151
24326 "The virt-inspector XML is described precisely in a RELAX NG schema which is "
24327 "supplied with libguestfs. This section is just an overview."
24331 #: ../inspector/virt-inspector.pl:154
24333 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
24334 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
24335 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
24336 "which is vanishingly rare in real world VMs."
24340 #: ../inspector/virt-inspector.pl:159
24341 msgid "E<lt>operatingsystemE<gt>"
24345 #: ../inspector/virt-inspector.pl:161
24347 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
24348 "describe the operating system, its architecture, the descriptive \"product "
24349 "name\" string, the type of OS and so on, as in this example:"
24353 #: ../inspector/virt-inspector.pl:165
24356 " <operatingsystems>\n"
24357 " <operatingsystem>\n"
24358 " <root>/dev/sda2</root>\n"
24359 " <name>windows</name>\n"
24360 " <arch>i386</arch>\n"
24361 " <distro>windows</distro>\n"
24362 " <product_name>Windows 7 Enterprise</product_name>\n"
24363 " <major_version>6</major_version>\n"
24364 " <minor_version>1</minor_version>\n"
24365 " <windows_systemroot>/Windows</windows_systemroot>\n"
24370 #: ../inspector/virt-inspector.pl:176
24372 "These fields are derived from the libguestfs inspection API, and you can "
24373 "find more details in L<guestfs(3)/INSPECTION>."
24377 #: ../inspector/virt-inspector.pl:179
24379 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
24380 "of view of libguestfs (block devices may have completely different names "
24381 "inside the VM itself)."
24385 #: ../inspector/virt-inspector.pl:240
24386 msgid "E<lt>mountpointsE<gt>"
24390 #: ../inspector/virt-inspector.pl:242
24392 "Un*x-like guests typically have multiple filesystems which are mounted at "
24393 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
24394 "element which looks like this:"
24398 #: ../inspector/virt-inspector.pl:246
24401 " <operatingsystems>\n"
24402 " <operatingsystem>\n"
24405 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
24406 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
24407 " </mountpoints>\n"
24412 #: ../inspector/virt-inspector.pl:254
24414 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
24415 "and may have completely different names inside the guest. Only mountable "
24416 "filesystems appear in this list, not things like swap devices."
24420 #: ../inspector/virt-inspector.pl:276
24421 msgid "E<lt>filesystemsE<gt>"
24425 #: ../inspector/virt-inspector.pl:278
24427 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
24428 "filesystems belonging to the guest, including swap and empty partitions. "
24429 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
24430 "this OS or shared by this OS and other OSes)."
24434 #: ../inspector/virt-inspector.pl:283
24435 msgid "You might see something like this:"
24439 #: ../inspector/virt-inspector.pl:285
24442 " <operatingsystems>\n"
24443 " <operatingsystem>\n"
24446 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
24447 " <type>ext4</type>\n"
24448 " <label>Fedora-13-x86_64</label>\n"
24449 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
24455 #: ../inspector/virt-inspector.pl:295
24457 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
24458 "the label, and the UUID."
24462 #: ../inspector/virt-inspector.pl:337
24463 msgid "E<lt>applicationsE<gt>"
24467 #: ../inspector/virt-inspector.pl:339
24469 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
24470 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
24471 "machine. At the moment we are only able to list RPMs and Debian packages "
24472 "installed, but in future we will support other Linux distros and Windows."
24476 #: ../inspector/virt-inspector.pl:345
24478 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
24479 "Typical values would be C<rpm> and C<deb>."
24483 #: ../inspector/virt-inspector.pl:348
24485 "E<lt>package_managementE<gt>, if present, describes the package manager. "
24486 "Typical values include C<yum>, C<up2date> and C<apt>"
24490 #: ../inspector/virt-inspector.pl:351
24491 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
24495 #: ../inspector/virt-inspector.pl:354
24498 " <operatingsystems>\n"
24499 " <operatingsystem>\n"
24501 " <applications>\n"
24503 " <name>coreutils</name>\n"
24504 " <version>8.5</version>\n"
24505 " <release>1</release>\n"
24506 " </application>\n"
24511 #: ../inspector/virt-inspector.pl:364
24513 "(The version and release fields may not be available for some package "
24518 #: ../inspector/virt-inspector.pl:544
24519 msgid "USING XPATH"
24523 #: ../inspector/virt-inspector.pl:546
24525 "You can use the XPath query language, and/or the xpath tool, in order to "
24526 "select parts of the XML."
24530 #: ../inspector/virt-inspector.pl:551
24533 " $ virt-inspector Guest | xpath //filesystems\n"
24534 " Found 1 nodes:\n"
24537 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
24538 " <type>ext4</type>\n"
24544 #: ../inspector/virt-inspector.pl:559
24547 " $ virt-inspector Guest | \\\n"
24548 " xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
24549 " Query didn't return a nodeset. Value: ext4\n"
24554 #: ../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
24555 msgid "SHELL QUOTING"
24559 #: ../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
24561 "Libvirt guest names can contain arbitrary characters, some of which have "
24562 "meaning to the shell such as C<#> and space. You may need to quote or "
24563 "escape these characters on the command line. See the shell manual page "
24564 "L<sh(1)> for details."
24568 #: ../inspector/virt-inspector.pl:572
24570 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
24571 "L<Sys::Virt(3)>, L<http://www.w3.org/TR/xpath/>, L<http://libguestfs.org/>."
24575 #: ../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
24576 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
24580 #: ../inspector/virt-inspector.pl:590
24581 msgid "Matthew Booth L<mbooth@redhat.com>"
24585 #: ../inspector/virt-inspector.pl:596 ../tools/virt-win-reg.pl:516 ../tools/virt-resize.pl:1514 ../tools/virt-make-fs.pl:565
24586 msgid "Copyright (C) 2010 Red Hat Inc."
24590 #: ../tools/virt-edit.pl:34
24591 msgid "virt-edit - Edit a file in a virtual machine"
24595 #: ../tools/virt-edit.pl:38
24598 " virt-edit [--options] domname file\n"
24603 #: ../tools/virt-edit.pl:40
24606 " virt-edit [--options] disk.img [disk.img ...] file\n"
24611 #: ../tools/virt-edit.pl:42
24614 " virt-edit [domname|disk.img] file -e 'expr'\n"
24619 #: ../tools/virt-edit.pl:46
24621 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
24622 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
24623 "doing this, but doesn't catch all cases."
24627 #: ../tools/virt-edit.pl:52
24629 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
24630 "the named virtual machine (or disk image)."
24634 #: ../tools/virt-edit.pl:55
24636 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
24637 "you should look at the L<guestfish(1)> tool."
24641 #: ../tools/virt-edit.pl:60
24642 msgid "Edit the named files interactively:"
24646 #: ../tools/virt-edit.pl:62
24649 " virt-edit mydomain /boot/grub/grub.conf\n"
24654 #: ../tools/virt-edit.pl:64
24657 " virt-edit mydomain /etc/passwd\n"
24662 #: ../tools/virt-edit.pl:66
24664 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
24665 "below). To change the init default level to 5:"
24669 #: ../tools/virt-edit.pl:70
24672 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
24677 #: ../tools/virt-edit.pl:96
24678 msgid "B<--backup extension> | B<-b extension>"
24682 #: ../tools/virt-edit.pl:98
24684 "Create a backup of the original file I<in the guest disk image>. The backup "
24685 "has the original filename with C<extension> added."
24689 #: ../tools/virt-edit.pl:101
24691 "Usually the first character of C<extension> would be a dot C<.> so you would "
24696 #: ../tools/virt-edit.pl:104
24699 " virt-edit -b .orig [etc]\n"
24704 #: ../tools/virt-edit.pl:106
24705 msgid "By default, no backup file is made."
24709 #: ../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
24711 "If you specify guest block devices directly, then libvirt is not used at "
24716 #: ../tools/virt-edit.pl:141
24717 msgid "B<--expr EXPR> | B<-e EXPR>"
24721 #: ../tools/virt-edit.pl:143
24723 "Instead of launching the external editor, non-interactively apply the Perl "
24724 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
24729 #: ../tools/virt-edit.pl:147
24731 "Be careful to properly quote the expression to prevent it from being altered "
24736 #: ../tools/virt-edit.pl:268
24737 msgid "NON-INTERACTIVE EDITING"
24741 #: ../tools/virt-edit.pl:270
24743 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
24744 "administrator can interactively edit the file."
24748 #: ../tools/virt-edit.pl:273
24750 "There are two ways also to use C<virt-edit> from scripts in order to make "
24751 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
24752 "like this, it's less error-prone to write scripts directly using the "
24753 "libguestfs API and Augeas for configuration file editing.)"
24757 #: ../tools/virt-edit.pl:279
24759 "The first method is to temporarily set C<$EDITOR> to any script or program "
24760 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
24761 "update C<tmpfile> in place however it likes."
24765 #: ../tools/virt-edit.pl:283
24767 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
24768 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
24769 "instances of C<foo> with C<bar> in a file:"
24773 #: ../tools/virt-edit.pl:287
24776 " virt-edit domname filename -e 's/foo/bar/'\n"
24781 #: ../tools/virt-edit.pl:289
24783 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
24784 "For example to delete root's password you could do:"
24788 #: ../tools/virt-edit.pl:292
24791 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
24796 #: ../tools/virt-edit.pl:294
24798 "What really happens is that the snippet is evaluated as a Perl expression "
24799 "for each line of the file. The line, including the final C<\\n>, is passed "
24800 "in C<$_> and the expression should update C<$_> or leave it unchanged."
24804 #: ../tools/virt-edit.pl:299
24806 "To delete a line, set C<$_> to the empty string. For example, to delete the "
24807 "C<apache> user account from the password file you can do:"
24811 #: ../tools/virt-edit.pl:302
24814 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
24819 #: ../tools/virt-edit.pl:304
24821 "To insert a line, prepend or append it to C<$_>. However appending lines to "
24822 "the end of the file is rather difficult this way since there is no concept "
24823 "of \"last line of the file\" - your expression just doesn't get called "
24824 "again. You might want to use the first method (setting C<$EDITOR>) if you "
24829 #: ../tools/virt-edit.pl:310
24831 "The variable C<$lineno> contains the current line number. As is "
24832 "traditional, the first line in the file is number C<1>."
24836 #: ../tools/virt-edit.pl:313
24838 "The return value from the expression is ignored, but the expression may call "
24839 "C<die> in order to abort the whole program, leaving the original file "
24844 #: ../tools/virt-edit.pl:317
24846 "Remember when matching the end of a line that C<$_> may contain the final "
24847 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
24848 "newline then neither of these. Thus to match or substitute some text at the "
24849 "end of a line, use this regular expression:"
24853 #: ../tools/virt-edit.pl:322
24856 " /some text(\\r?\\n)?$/\n"
24861 #: ../tools/virt-edit.pl:324
24863 "Alternately, use the perl C<chomp> function, being careful not to chomp "
24864 "C<$_> itself (since that would remove all newlines from the file):"
24868 #: ../tools/virt-edit.pl:328
24871 " my $m = $_; chomp $m; $m =~ /some text$/\n"
24876 #: ../tools/virt-edit.pl:334
24881 #: ../tools/virt-edit.pl:336
24883 "If set, this string is used as the editor. It may contain arguments, "
24884 "eg. C<\"emacs -nw\">"
24888 #: ../tools/virt-edit.pl:339
24889 msgid "If not set, C<vi> is used."
24893 #: ../tools/virt-edit.pl:352
24895 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
24896 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, "
24897 "L<perl(1)>, L<perlre(1)>."
24901 #: ../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
24906 #: ../tools/virt-edit.pl:368 ../tools/virt-df.pl:655 ../tools/virt-rescue.pl:283 ../tools/virt-list-partitions.pl:271
24907 msgid "Copyright (C) 2009-2010 Red Hat Inc."
24911 #: ../tools/virt-win-reg.pl:37
24913 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
24918 #: ../tools/virt-win-reg.pl:41
24921 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
24926 #: ../tools/virt-win-reg.pl:43
24929 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
24934 #: ../tools/virt-win-reg.pl:45
24937 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
24942 #: ../tools/virt-win-reg.pl:47
24945 " virt-win-reg --merge domname [input.reg ...]\n"
24950 #: ../tools/virt-win-reg.pl:49
24953 " virt-win-reg [--options] disk.img ... # instead of domname\n"
24958 #: ../tools/virt-win-reg.pl:53
24960 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
24961 "virtual machines. If you do this, you I<will> get irreversible disk "
24962 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
24963 "but doesn't catch all cases."
24967 #: ../tools/virt-win-reg.pl:58
24969 "Modifying the Windows Registry is an inherently risky operation. The format "
24970 "is deliberately obscure and undocumented, and Registry changes can leave the "
24971 "system unbootable. Therefore when using the C<--merge> option, make sure "
24972 "you have a reliable backup first."
24976 #: ../tools/virt-win-reg.pl:65
24978 "This program can export and merge Windows Registry entries from a Windows "
24983 #: ../tools/virt-win-reg.pl:68
24985 "The first parameter is the libvirt guest name or the raw disk image of a "
24990 #: ../tools/virt-win-reg.pl:71
24992 "If C<--merge> is I<not> specified, then the chosen registry key is "
24993 "displayed/exported (recursively). For example:"
24997 #: ../tools/virt-win-reg.pl:74
25000 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
25005 #: ../tools/virt-win-reg.pl:76
25006 msgid "You can also display single values from within registry keys, for example:"
25010 #: ../tools/virt-win-reg.pl:79
25013 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
25014 " $ virt-win-reg Windows7 $cvkey ProductName\n"
25015 " Windows 7 Enterprise\n"
25020 #: ../tools/virt-win-reg.pl:83
25022 "With C<--merge>, you can merge a textual regedit file into the Windows "
25027 #: ../tools/virt-win-reg.pl:86
25030 " $ virt-win-reg --merge Windows7 changes.reg\n"
25035 #: ../tools/virt-win-reg.pl:88
25036 msgid "SUPPORTED SYSTEMS"
25040 #: ../tools/virt-win-reg.pl:90
25042 "The program currently supports Windows NT-derived guests starting with "
25043 "Windows XP through to at least Windows 7."
25047 #: ../tools/virt-win-reg.pl:93
25049 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
25050 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
25051 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
25055 #: ../tools/virt-win-reg.pl:97
25057 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
25062 #: ../tools/virt-win-reg.pl:100
25064 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
25069 #: ../tools/virt-win-reg.pl:103
25074 #: ../tools/virt-win-reg.pl:105
25076 "This program is only meant for simple access to the registry. If you want "
25077 "to do complicated things with the registry, we suggest you download the "
25078 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
25079 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
25080 "L<hivexregedit(1)>."
25084 #: ../tools/virt-win-reg.pl:111
25089 #: ../tools/virt-win-reg.pl:113
25091 "C<virt-win-reg> expects that regedit files have already been reencoded in "
25092 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
25093 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
25094 "with Windows-style line endings, you may need to reencode the whole file "
25095 "before or after processing."
25099 #: ../tools/virt-win-reg.pl:119
25101 "To reencode a file from Windows format to Linux (before processing it with "
25102 "the C<--merge> option), you would do something like this:"
25106 #: ../tools/virt-win-reg.pl:122
25109 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
25114 #: ../tools/virt-win-reg.pl:124
25116 "To go in the opposite direction, after exporting and before sending the file "
25117 "to a Windows user, do something like this:"
25121 #: ../tools/virt-win-reg.pl:127
25124 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
25129 #: ../tools/virt-win-reg.pl:129
25130 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
25134 #: ../tools/virt-win-reg.pl:131
25136 "If you are unsure about the current encoding, use the L<file(1)> command. "
25137 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
25138 "Windows-style (CRLF) line endings, like this:"
25142 #: ../tools/virt-win-reg.pl:135
25145 " $ file software.reg\n"
25146 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
25147 " with CRLF line terminators\n"
25152 #: ../tools/virt-win-reg.pl:139
25153 msgid "This file would need conversion before you could C<--merge> it."
25157 #: ../tools/virt-win-reg.pl:143
25159 "Be careful when passing parameters containing C<\\> (backslash) in the "
25160 "shell. Usually you will have to use 'single quotes' or double backslashes "
25161 "(but not both) to protect them from the shell."
25165 #: ../tools/virt-win-reg.pl:147
25166 msgid "Paths and value names are case-insensitive."
25170 #: ../tools/virt-win-reg.pl:149
25171 msgid "CurrentControlSet etc."
25175 #: ../tools/virt-win-reg.pl:151
25177 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
25178 "Registry at the level of the hive file, and therefore you cannot modify "
25183 #: ../tools/virt-win-reg.pl:155
25185 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
25186 "circumstances it might refer to another control set. The way to find out is "
25187 "to look at the C<HKLM\\SYSTEM\\Select> key:"
25191 #: ../tools/virt-win-reg.pl:159
25194 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
25195 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
25196 " \"Current\"=dword:00000001\n"
25197 " \"Default\"=dword:00000001\n"
25198 " \"Failed\"=dword:00000000\n"
25199 " \"LastKnownGood\"=dword:00000002\n"
25204 #: ../tools/virt-win-reg.pl:166
25205 msgid "\"Default\" is the one which Windows will choose when it boots."
25209 #: ../tools/virt-win-reg.pl:168
25210 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
25214 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
25219 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:501
25220 msgid "Enable debugging messages."
25224 #: ../tools/virt-win-reg.pl:232
25229 #: ../tools/virt-win-reg.pl:234
25231 "In merge mode, this merges a textual regedit file into the Windows Registry "
25232 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
25233 "displays or exports Registry entries instead."
25237 #: ../tools/virt-win-reg.pl:238
25239 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
25240 "result in disk corruption. However exporting (without this flag) is always "
25245 #: ../tools/virt-win-reg.pl:246
25246 msgid "B<--encoding> UTF-16LE|ASCII"
25250 #: ../tools/virt-win-reg.pl:248
25252 "When merging (only), you may need to specify the encoding for strings to be "
25253 "used in the hive file. This is explained in detail in "
25254 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
25258 #: ../tools/virt-win-reg.pl:252
25260 "The default is to use UTF-16LE, which should work with recent versions of "
25265 #: ../tools/virt-win-reg.pl:486
25267 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
25268 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
25269 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
25270 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
25274 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
25276 "When reporting bugs, please enable debugging and capture the I<complete> "
25281 #: ../tools/virt-win-reg.pl:504
25284 " export LIBGUESTFS_DEBUG=1\n"
25285 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
25290 #: ../tools/virt-win-reg.pl:507
25292 "Attach /tmp/virt-win-reg.log to a new bug report at "
25293 "L<https://bugzilla.redhat.com/>"
25297 #: ../tools/virt-df.pl:36
25298 msgid "virt-df - Display free space on virtual filesystems"
25302 #: ../tools/virt-df.pl:40
25305 " virt-df [--options]\n"
25310 #: ../tools/virt-df.pl:42
25313 " virt-df [--options] domname\n"
25318 #: ../tools/virt-df.pl:44
25321 " virt-df [--options] disk.img [disk.img ...]\n"
25326 #: ../tools/virt-df.pl:48
25328 "C<virt-df> is a command line tool to display free space on virtual machine "
25329 "filesystems. Unlike other tools, it doesn't just display the amount of "
25330 "space allocated to a virtual machine, but can look inside the virtual "
25331 "machine to see how much space is really being used."
25335 #: ../tools/virt-df.pl:53
25337 "It is like the L<df(1)> command, but for virtual machines, except that it "
25338 "also works for Windows virtual machines."
25342 #: ../tools/virt-df.pl:56
25344 "If used without any arguments, C<virt-df> checks with libvirt to get a list "
25345 "of all active and inactive guests, and performs a C<df>-type operation on "
25346 "each one in turn, printing out the results."
25350 #: ../tools/virt-df.pl:60
25352 "If used with any argument(s), C<virt-df> performs a C<df>-type operation on "
25353 "either the single named libvirt domain, or on the disk image(s) listed on "
25354 "the command line (which must all belong to a single VM). In this mode (with "
25355 "arguments), C<virt-df> will I<only work for a single guest>. If you want to "
25356 "run on multiple guests, then you have to invoke C<virt-df> multiple times."
25360 #: ../tools/virt-df.pl:67
25362 "Use the C<--csv> option to get a format which can be easily parsed by other "
25363 "programs. Other options are mostly similar to standard C<df> options. See "
25364 "below for the complete list."
25368 #: ../tools/virt-df.pl:107
25373 #: ../tools/virt-df.pl:109
25375 "Write out the results in CSV format (comma-separated values). This format "
25376 "can be imported easily into databases and spreadsheets, but read L</NOTE "
25377 "ABOUT CSV FORMAT> below."
25381 #: ../tools/virt-df.pl:134
25382 msgid "B<--human-readable> | B<-h>"
25386 #: ../tools/virt-df.pl:136
25387 msgid "Print sizes in human-readable format."
25391 #: ../tools/virt-df.pl:138
25392 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
25396 #: ../tools/virt-df.pl:144
25397 msgid "B<--inodes> | B<-i>"
25401 #: ../tools/virt-df.pl:146
25402 msgid "Print inodes instead of blocks."
25406 #: ../tools/virt-df.pl:152
25407 msgid "B<--one-per-guest>"
25411 #: ../tools/virt-df.pl:154
25413 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
25414 "disks from several guests to a single libguestfs appliance."
25418 #: ../tools/virt-df.pl:157
25419 msgid "You might use this option in the following circumstances:"
25423 #: ../tools/virt-df.pl:163
25425 "If you think an untrusted guest might actively try to exploit the libguestfs "
25426 "appliance kernel, then this prevents one guest from interfering with the "
25427 "stats printed for another guest."
25431 #: ../tools/virt-df.pl:169
25433 "If the kernel has a bug which stops it from accessing a filesystem in one "
25434 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
25435 "and report stats for further guests."
25439 #: ../tools/virt-df.pl:180
25444 #: ../tools/virt-df.pl:182
25446 "Print UUIDs instead of names. This is useful for following a guest even "
25447 "when the guest is migrated or renamed, or when two guests happen to have the "
25452 #: ../tools/virt-df.pl:186
25454 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
25455 "images, we still print the disk image name even when this option is "
25460 #: ../tools/virt-df.pl:609
25461 msgid "NOTE ABOUT CSV FORMAT"
25465 #: ../tools/virt-df.pl:611
25467 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
25468 "should be easy to parse, but it is definitely not easy to parse."
25472 #: ../tools/virt-df.pl:614
25474 "Myth: Just split fields at commas. Reality: This does I<not> work "
25475 "reliably. This example has two columns:"
25479 #: ../tools/virt-df.pl:617
25482 " \"foo,bar\",baz\n"
25487 #: ../tools/virt-df.pl:619
25489 "Myth: Read the file one line at a time. Reality: This does I<not> work "
25490 "reliably. This example has one row:"
25494 #: ../tools/virt-df.pl:622
25503 #: ../tools/virt-df.pl:625
25505 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
25506 "packaged in major Linux distributions)."
25510 #: ../tools/virt-df.pl:628
25512 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
25513 "or Python's built-in csv library)."
25517 #: ../tools/virt-df.pl:631
25518 msgid "Most spreadsheets and databases can import CSV directly."
25522 #: ../tools/virt-df.pl:642
25524 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
25525 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
25529 #: ../tools/virt-ls.pl:34
25530 msgid "virt-ls - List files in a virtual machine"
25534 #: ../tools/virt-ls.pl:38
25537 " virt-ls [--options] domname directory\n"
25542 #: ../tools/virt-ls.pl:40
25545 " virt-ls [--options] disk.img [disk.img ...] directory\n"
25550 #: ../tools/virt-ls.pl:44
25552 "C<virt-ls> is a command line tool to list the names of files in a directory "
25553 "inside a virtual machine or disk image."
25557 #: ../tools/virt-ls.pl:47
25559 "C<virt-ls> is just a simple wrapper around L<libguestfs(3)> functionality. "
25560 "For more complex cases you should look at the L<guestfish(1)> tool."
25564 #: ../tools/virt-ls.pl:51
25566 "C<virt-ls> can be used in one of three modes: simple, long and recursive. A "
25567 "simple listing is like the ordinary L<ls(1)> command:"
25571 #: ../tools/virt-ls.pl:54
25574 " $ virt-ls myguest /\n"
25582 #: ../tools/virt-ls.pl:59
25583 msgid "With the C<-l> (C<--long>) option, C<virt-ls> shows more detail:"
25587 #: ../tools/virt-ls.pl:61
25590 " $ virt-ls -l myguest /\n"
25592 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
25593 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
25599 #: ../tools/virt-ls.pl:67
25601 "With the C<-R> (C<--recursive>) option, C<virt-ls> lists the names of files "
25602 "and directories recursively:"
25606 #: ../tools/virt-ls.pl:70
25609 " $ virt-ls -R myguest /tmp\n"
25617 #: ../tools/virt-ls.pl:75
25619 "You I<cannot> combine these options. To do more complicated things, use "
25624 #: ../tools/virt-ls.pl:131 ../tools/virt-list-filesystems.pl:103 ../tools/virt-list-partitions.pl:112
25625 msgid "B<-l> | B<--long>"
25629 #: ../tools/virt-ls.pl:133
25630 msgid "B<-R> | B<--recursive>"
25634 #: ../tools/virt-ls.pl:135
25636 "Select the mode. With neither of these options, C<virt-ls> produces a "
25637 "simple, flat list of the files in the named directory."
25641 #: ../tools/virt-ls.pl:138
25643 "C<virt-ls -l> produces a \"long listing\", which shows more detail (just "
25644 "like the plain C<ls -l> command)."
25648 #: ../tools/virt-ls.pl:141
25650 "C<virt-ls -R> produces a recursive list of files starting at the named "
25651 "directory. See the documentation for L<guestfs(3)/guestfs_find> for precise "
25656 #: ../tools/virt-ls.pl:145
25657 msgid "You cannot combine these options."
25661 #: ../tools/virt-ls.pl:234
25663 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
25664 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
25665 "L<http://libguestfs.org/>."
25669 #: ../tools/virt-ls.pl:249 ../tools/virt-list-filesystems.pl:204 ../tools/virt-cat.pl:201 ../tools/virt-tar.pl:298
25670 msgid "Copyright (C) 2009 Red Hat Inc."
25674 #: ../tools/virt-resize.pl:42
25675 msgid "virt-resize - Resize a virtual machine disk"
25679 #: ../tools/virt-resize.pl:46
25682 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
25683 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
25684 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
25689 #: ../tools/virt-resize.pl:52
25691 "Virt-resize is a tool which can resize a virtual machine disk, making it "
25692 "larger or smaller overall, and resizing or deleting any partitions contained "
25697 #: ../tools/virt-resize.pl:56
25699 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
25700 "not> be used on live virtual machines - for consistent results, shut the "
25701 "virtual machine down before resizing it."
25705 #: ../tools/virt-resize.pl:60
25707 "If you are not familiar with the associated tools: "
25708 "L<virt-list-partitions(1)>, L<virt-list-filesystems(1)> and L<virt-df(1)>, "
25709 "we recommend you go and read those manual pages first."
25713 #: ../tools/virt-resize.pl:68
25715 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
25716 "fill the extra 5GB of space."
25720 #: ../tools/virt-resize.pl:71
25723 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
25724 " virt-list-partitions -lht olddisk\n"
25725 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
25726 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
25731 #: ../tools/virt-resize.pl:76
25733 "As above, but make the /boot partition 200MB bigger, while giving the "
25734 "remaining space to /dev/sda2:"
25738 #: ../tools/virt-resize.pl:79
25741 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
25746 #: ../tools/virt-resize.pl:81
25747 msgid "As above, but the output format will be uncompressed qcow2:"
25751 #: ../tools/virt-resize.pl:83
25754 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
25755 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
25760 #: ../tools/virt-resize.pl:86
25761 msgid "DETAILED USAGE"
25765 #: ../tools/virt-resize.pl:88
25766 msgid "EXPANDING A VIRTUAL MACHINE DISK"
25770 #: ../tools/virt-resize.pl:92
25771 msgid "1. Shut down the virtual machine"
25775 #: ../tools/virt-resize.pl:94
25776 msgid "2. Locate input disk image"
25780 #: ../tools/virt-resize.pl:96
25782 "Locate the input disk image (ie. the file or device on the host containing "
25783 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
25784 "dumpxml> like this to find the disk image name:"
25788 #: ../tools/virt-resize.pl:100
25791 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
25792 " Found 1 nodes:\n"
25794 " <source dev=\"/dev/vg/lv_guest\" />\n"
25799 #: ../tools/virt-resize.pl:105
25800 msgid "3. Look at current sizing"
25804 #: ../tools/virt-resize.pl:107
25805 msgid "Use L<virt-list-partitions(1)> to display the current partitions and sizes:"
25809 #: ../tools/virt-resize.pl:110
25812 " # virt-list-partitions -lht /dev/vg/lv_guest\n"
25813 " /dev/sda1 ext3 101.9M\n"
25814 " /dev/sda2 pv 7.9G\n"
25815 " /dev/sda device 8.0G\n"
25820 #: ../tools/virt-resize.pl:115
25822 "(This example is a virtual machine with an 8 GB disk which we would like to "
25823 "expand up to 10 GB)."
25827 #: ../tools/virt-resize.pl:118
25828 msgid "4. Create output disk"
25832 #: ../tools/virt-resize.pl:120
25834 "Virt-resize cannot do in-place disk modifications. You have to have space "
25835 "to store the resized output disk."
25839 #: ../tools/virt-resize.pl:123
25840 msgid "To store the resized disk image in a file, create a file of a suitable size:"
25844 #: ../tools/virt-resize.pl:126
25847 " # rm -f outdisk\n"
25848 " # truncate -s 10G outdisk\n"
25853 #: ../tools/virt-resize.pl:129
25854 msgid "Or use L<lvcreate(1)> to create a logical volume:"
25858 #: ../tools/virt-resize.pl:131
25861 " # lvcreate -L 10G -n lv_name vg_name\n"
25866 #: ../tools/virt-resize.pl:133
25867 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
25871 #: ../tools/virt-resize.pl:135
25874 " # virsh pool-list\n"
25875 " # virsh vol-create-as poolname newvol 10G\n"
25880 #: ../tools/virt-resize.pl:138
25885 #: ../tools/virt-resize.pl:140
25887 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
25888 "file) and the output disk. The output disk is the one created in the "
25893 #: ../tools/virt-resize.pl:144
25896 " # virt-resize indisk outdisk\n"
25901 #: ../tools/virt-resize.pl:146
25903 "This command just copies disk image C<indisk> to disk image C<outdisk> "
25904 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
25905 "larger, then an extra, empty partition is created at the end of the disk "
25906 "covering the extra space. If C<outdisk> is smaller, then it will give an "
25911 #: ../tools/virt-resize.pl:152
25913 "More realistically you'd want to expand existing partitions in the disk "
25914 "image by passing extra options (for the full list see the L</OPTIONS> "
25919 #: ../tools/virt-resize.pl:156
25921 "L</--expand> is the most useful option. It expands the named partition "
25922 "within the disk to fill any extra space:"
25926 #: ../tools/virt-resize.pl:159
25929 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
25934 #: ../tools/virt-resize.pl:161
25936 "(In this case, an extra partition is I<not> created at the end of the disk, "
25937 "because there will be no unused space)."
25941 #: ../tools/virt-resize.pl:164
25943 "L</--resize> is the other commonly used option. The following would "
25944 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
25945 "rest of the available space:"
25949 #: ../tools/virt-resize.pl:168
25952 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
25953 " indisk outdisk\n"
25958 #: ../tools/virt-resize.pl:171
25960 "If the expanded partition in the image contains a filesystem or LVM PV, then "
25961 "if virt-resize knows how, it will resize the contents, the equivalent of "
25962 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
25963 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
25964 "filesystems, so you would have to online resize them after booting the "
25965 "guest. And virt-resize also does not resize anything inside an LVM PV, it "
25966 "just resizes the PV itself and leaves the user to resize any LVs inside that "
25971 #: ../tools/virt-resize.pl:180
25972 msgid "Other options are covered below."
25976 #: ../tools/virt-resize.pl:182
25981 #: ../tools/virt-resize.pl:184
25982 msgid "Thoroughly test the new disk image I<before> discarding the old one."
25986 #: ../tools/virt-resize.pl:186
25987 msgid "If you are using libvirt, edit the XML to point at the new disk:"
25991 #: ../tools/virt-resize.pl:188
25994 " # virsh edit guestname\n"
25999 #: ../tools/virt-resize.pl:190
26001 "Change E<lt>source ...E<gt>, see "
26002 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
26006 #: ../tools/virt-resize.pl:193
26007 msgid "Then start up the domain with the new, resized disk:"
26011 #: ../tools/virt-resize.pl:195
26014 " # virsh start guestname\n"
26019 #: ../tools/virt-resize.pl:197
26021 "and check that it still works. See also the L</NOTES> section below for "
26022 "additional information."
26026 #: ../tools/virt-resize.pl:200
26027 msgid "7. Resize LVs etc inside the guest"
26031 #: ../tools/virt-resize.pl:202
26032 msgid "(This can also be done offline using L<guestfish(1)>)"
26036 #: ../tools/virt-resize.pl:204
26038 "Once the guest has booted you should see the new space available, at least "
26039 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
26040 "may need to resize LVs inside PVs, and also resize filesystem types that "
26041 "virt-resize does not know how to expand."
26045 #: ../tools/virt-resize.pl:211
26046 msgid "SHRINKING A VIRTUAL MACHINE DISK"
26050 #: ../tools/virt-resize.pl:213
26052 "Shrinking is somewhat more complex than expanding, and only an overview is "
26057 #: ../tools/virt-resize.pl:216
26059 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
26060 "filesystems). The user has to shrink content before passing the disk image "
26061 "to virt-resize, and virt-resize will check that the content has been shrunk "
26066 #: ../tools/virt-resize.pl:221
26067 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
26071 #: ../tools/virt-resize.pl:223
26073 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
26074 "steps 3 and 4 above to allocate a new disk image."
26078 #: ../tools/virt-resize.pl:226
26079 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
26083 #: ../tools/virt-resize.pl:229
26084 msgid "IGNORING OR DELETING PARTITIONS"
26088 #: ../tools/virt-resize.pl:231
26090 "virt-resize also gives a convenient way to ignore or delete partitions when "
26091 "copying from the input disk to the output disk. Ignoring a partition speeds "
26092 "up the copy where you don't care about the existing contents of a "
26093 "partition. Deleting a partition removes it completely, but note that it "
26094 "also renumbers any partitions after the one which is deleted, which can "
26095 "leave some guests unbootable."
26099 #: ../tools/virt-resize.pl:238
26100 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
26104 #: ../tools/virt-resize.pl:240
26106 "If the input disk is in qcow2 format, then you may prefer that the output is "
26107 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
26108 "the fly. The output format is simply determined by the format of the empty "
26109 "output container that you provide. Thus to create qcow2 output, use:"
26113 #: ../tools/virt-resize.pl:246
26116 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
26121 #: ../tools/virt-resize.pl:248
26122 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
26126 #: ../tools/virt-resize.pl:250
26127 msgid "Similarly, to get non-sparse raw output use:"
26131 #: ../tools/virt-resize.pl:252
26134 " fallocate -l size outdisk\n"
26139 #: ../tools/virt-resize.pl:254
26141 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
26142 "if=/dev/zero of=outdisk bs=1M count=..>)"
26146 #: ../tools/virt-resize.pl:267
26147 msgid "Display help."
26151 #: ../tools/virt-resize.pl:281
26152 msgid "B<--resize part=size>"
26156 #: ../tools/virt-resize.pl:283
26158 "Resize the named partition (expanding or shrinking it) so that it has the "
26163 #: ../tools/virt-resize.pl:286
26165 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
26166 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
26167 "Exabytes; or as a percentage of the current size; or as a relative number or "
26168 "percentage. For example:"
26172 #: ../tools/virt-resize.pl:291
26175 " --resize /dev/sda2=10G\n"
26180 #: ../tools/virt-resize.pl:293
26183 " --resize /dev/sda4=90%\n"
26188 #: ../tools/virt-resize.pl:295
26191 " --resize /dev/sda2=+1G\n"
26196 #: ../tools/virt-resize.pl:297
26199 " --resize /dev/sda2=-200M\n"
26204 #: ../tools/virt-resize.pl:299
26207 " --resize /dev/sda1=+128K\n"
26212 #: ../tools/virt-resize.pl:301
26215 " --resize /dev/sda1=+10%\n"
26220 #: ../tools/virt-resize.pl:303
26223 " --resize /dev/sda1=-10%\n"
26228 #: ../tools/virt-resize.pl:305
26230 "You can increase the size of any partition. Virt-resize will expand the "
26231 "direct content of the partition if it knows how (see C<--expand> below)."
26235 #: ../tools/virt-resize.pl:309
26237 "You can only I<decrease> the size of partitions that contain filesystems or "
26238 "PVs which have already been shrunk. Virt-resize will check this has been "
26239 "done before proceeding, or else will print an error (see also "
26240 "C<--resize-force>)."
26244 #: ../tools/virt-resize.pl:314 ../tools/virt-resize.pl:406 ../tools/virt-resize.pl:423
26245 msgid "You can give this option multiple times."
26249 #: ../tools/virt-resize.pl:320
26250 msgid "B<--resize-force part=size>"
26254 #: ../tools/virt-resize.pl:322
26256 "This is the same as C<--resize> except that it will let you decrease the "
26257 "size of any partition. Generally this means you will lose any data which "
26258 "was at the end of the partition you shrink, but you may not care about that "
26259 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
26260 "as a swap partition)."
26264 #: ../tools/virt-resize.pl:328
26265 msgid "See also the C<--ignore> option."
26269 #: ../tools/virt-resize.pl:334
26270 msgid "B<--expand part>"
26274 #: ../tools/virt-resize.pl:336
26276 "Expand the named partition so it uses up all extra space (space left over "
26277 "after any other resize changes that you request have been done)."
26281 #: ../tools/virt-resize.pl:339
26283 "If virt-resize knows how, it will expand the direct content of the "
26284 "partition. For example, if the partition is an LVM PV, it will expand the "
26285 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
26286 "content it doesn't know about alone."
26290 #: ../tools/virt-resize.pl:344
26291 msgid "Currently virt-resize can resize:"
26295 #: ../tools/virt-resize.pl:350
26297 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
26302 #: ../tools/virt-resize.pl:355
26304 "NTFS filesystems contained directly in a partition, if libguestfs was "
26305 "compiled with support for NTFS."
26309 #: ../tools/virt-resize.pl:358
26311 "The filesystem must have been shut down consistently last time it was used. "
26312 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
26313 "consistency check, so at the first boot after resizing Windows will check "
26318 #: ../tools/virt-resize.pl:365
26320 "LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
26321 "inside the PV. The user will have to resize LVs as desired."
26325 #: ../tools/virt-resize.pl:371 ../tools/virt-resize.pl:393
26326 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
26330 #: ../tools/virt-resize.pl:377
26331 msgid "B<--shrink part>"
26335 #: ../tools/virt-resize.pl:379
26337 "Shrink the named partition until the overall disk image fits in the "
26338 "destination. The named partition B<must> contain a filesystem or PV which "
26339 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
26340 "online tools). Virt-resize will check this and give an error if it has not "
26345 #: ../tools/virt-resize.pl:385
26347 "The amount by which the overall disk must be shrunk (after carrying out all "
26348 "other operations requested by the user) is called the \"deficit\". For "
26349 "example, a straight copy (assume no other operations) from a 5GB disk image "
26350 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
26351 "would give an error unless the user specified a partition to shrink and that "
26352 "partition had more than a gigabyte of free space."
26356 #: ../tools/virt-resize.pl:399
26357 msgid "B<--ignore part>"
26361 #: ../tools/virt-resize.pl:401
26363 "Ignore the named partition. Effectively this means the partition is "
26364 "allocated on the destination disk, but the content is not copied across from "
26365 "the source disk. The content of the partition will be blank (all zero "
26370 #: ../tools/virt-resize.pl:412
26371 msgid "B<--delete part>"
26375 #: ../tools/virt-resize.pl:414
26377 "Delete the named partition. It would be more accurate to describe this as "
26378 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
26379 "the original disk image is left intact."
26383 #: ../tools/virt-resize.pl:418
26385 "Note that when you delete a partition, then anything contained in the "
26386 "partition is also deleted. Furthermore, this causes any partitions that "
26387 "come after to be I<renumbered>, which can easily make your guest unbootable."
26391 #: ../tools/virt-resize.pl:429
26392 msgid "B<--LV-expand logvol>"
26396 #: ../tools/virt-resize.pl:431
26398 "This takes the logical volume and, as a final step, expands it to fill all "
26399 "the space available in its volume group. A typical usage, assuming a Linux "
26400 "guest with a single PV C</dev/sda2> and a root device called "
26401 "C</dev/vg_guest/lv_root> would be:"
26405 #: ../tools/virt-resize.pl:436
26408 " virt-resize indisk outdisk \\\n"
26409 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
26414 #: ../tools/virt-resize.pl:439
26416 "This would first expand the partition (and PV), and then expand the root "
26417 "device to fill the extra space in the PV."
26421 #: ../tools/virt-resize.pl:442
26423 "The contents of the LV are also resized if virt-resize knows how to do "
26424 "that. You can stop virt-resize from trying to expand the content by using "
26425 "the option C<--no-expand-content>."
26429 #: ../tools/virt-resize.pl:446
26430 msgid "Use L<virt-list-filesystems(1)> to list the filesystems in the guest."
26434 #: ../tools/virt-resize.pl:449
26436 "You can give this option multiple times, I<but> it doesn't make sense to do "
26437 "this unless the logical volumes you specify are all in different volume "
26442 #: ../tools/virt-resize.pl:457
26443 msgid "B<--no-copy-boot-loader>"
26447 #: ../tools/virt-resize.pl:459
26449 "By default, virt-resize copies over some sectors at the start of the disk "
26450 "(up to the beginning of the first partition). Commonly these sectors "
26451 "contain the Master Boot Record (MBR) and the boot loader, and are required "
26452 "in order for the guest to boot correctly."
26456 #: ../tools/virt-resize.pl:464
26458 "If you specify this flag, then this initial copy is not done. You may need "
26459 "to reinstall the boot loader in this case."
26463 #: ../tools/virt-resize.pl:472
26464 msgid "B<--no-extra-partition>"
26468 #: ../tools/virt-resize.pl:474
26470 "By default, virt-resize creates an extra partition if there is any extra, "
26471 "unused space after all resizing has happened. Use this option to prevent "
26472 "the extra partition from being created. If you do this then the extra space "
26473 "will be inaccessible until you run fdisk, parted, or some other partitioning "
26474 "tool in the guest."
26478 #: ../tools/virt-resize.pl:480
26480 "Note that if the surplus space is smaller than 10 MB, no extra partition "
26485 #: ../tools/virt-resize.pl:487
26486 msgid "B<--no-expand-content>"
26490 #: ../tools/virt-resize.pl:489
26492 "By default, virt-resize will try to expand the direct contents of "
26493 "partitions, if it knows how (see C<--expand> option above)."
26497 #: ../tools/virt-resize.pl:492
26499 "If you give the C<--no-expand-content> option then virt-resize will not "
26504 #: ../tools/virt-resize.pl:499
26505 msgid "B<-d> | B<--debug>"
26509 #: ../tools/virt-resize.pl:507
26510 msgid "B<-n> | B<--dryrun>"
26514 #: ../tools/virt-resize.pl:509
26515 msgid "Print a summary of what would be done, but don't do anything."
26519 #: ../tools/virt-resize.pl:515
26520 msgid "B<-q> | B<--quiet>"
26524 #: ../tools/virt-resize.pl:517
26525 msgid "Don't print the summary."
26529 #: ../tools/virt-resize.pl:525
26531 "Specify the format of the input disk image. If this flag is not given then "
26532 "it is auto-detected from the image itself."
26536 #: ../tools/virt-resize.pl:531
26538 "Note that this option I<does not> affect the output format. See L</QCOW2 "
26539 "AND NON-SPARSE RAW FORMATS>."
26543 #: ../tools/virt-resize.pl:538
26544 msgid "B<--output-format> raw"
26548 #: ../tools/virt-resize.pl:540
26550 "Specify the format of the output disk image. If this flag is not given then "
26551 "it is auto-detected from the image itself."
26555 #: ../tools/virt-resize.pl:546
26557 "Note that you still need to create the output disk with the right format. "
26558 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
26562 #: ../tools/virt-resize.pl:1422 ../tools/virt-rescue.pl:90
26567 #: ../tools/virt-resize.pl:1424
26568 msgid "\"Partition 1 does not end on cylinder boundary.\""
26572 #: ../tools/virt-resize.pl:1426
26574 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
26575 "means the partitions will not be aligned to the ancient CHS geometry. "
26576 "However CHS geometry is meaningless for disks manufactured since the early "
26577 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
26578 "cylinders is not required by any modern operating system."
26582 #: ../tools/virt-resize.pl:1433
26583 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
26587 #: ../tools/virt-resize.pl:1435
26589 "In Windows Vista and later versions, Microsoft switched to using a separate "
26590 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
26591 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
26592 "the boot partition. Doing so seems to break the guest completely. However "
26593 "expanding the second partition (ie. C: drive) should work."
26597 #: ../tools/virt-resize.pl:1442
26599 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
26600 "NTFS partitions have been expanded. This is just a safety check and (unless "
26601 "it find errors) is nothing to worry about."
26605 #: ../tools/virt-resize.pl:1446
26606 msgid "GUEST BOOT STUCK AT \"GRUB\""
26610 #: ../tools/virt-resize.pl:1448
26612 "If a Linux guest does not boot after resizing, and the boot is stuck after "
26613 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
26614 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
26615 "although we think is to do with partition alignment."
26619 #: ../tools/virt-resize.pl:1453
26622 " guestfish -i -a newdisk\n"
26623 " ><fs> cat /boot/grub/device.map\n"
26624 " # check the contents of this file are sensible or\n"
26625 " # edit the file if necessary\n"
26626 " ><fs> grub-install / /dev/vda\n"
26632 #: ../tools/virt-resize.pl:1460
26634 "For more flexible guest reconfiguration, including if you need to specify "
26635 "other parameters to grub-install, use L<virt-rescue(1)>."
26639 #: ../tools/virt-resize.pl:1463
26640 msgid "ALTERNATIVE TOOLS"
26644 #: ../tools/virt-resize.pl:1465
26646 "There are several proprietary tools for resizing partitions. We won't "
26647 "mention any here."
26651 #: ../tools/virt-resize.pl:1468
26653 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
26654 "operations on disk images. They can resize and move partitions, but I don't "
26655 "think they can do anything with the contents, and they certainly don't "
26660 #: ../tools/virt-resize.pl:1473
26662 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
26663 "but at a much lower level. You will probably end up hand-calculating sector "
26664 "offsets, which is something that virt-resize was designed to avoid. If you "
26665 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
26670 #: ../tools/virt-resize.pl:1488
26672 "L<virt-list-partitions(1)>, L<virt-list-filesystems(1)>, L<virt-df(1)>, "
26673 "L<guestfs(3)>, L<guestfish(1)>, L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, "
26674 "L<resize2fs(8)>, L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, "
26675 "L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, "
26676 "L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
26680 #: ../tools/virt-list-filesystems.pl:32
26681 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
26685 #: ../tools/virt-list-filesystems.pl:36
26688 " virt-list-filesystems [--options] domname\n"
26693 #: ../tools/virt-list-filesystems.pl:38
26696 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
26701 #: ../tools/virt-list-filesystems.pl:42
26703 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
26704 "are contained in a virtual machine or disk image."
26708 #: ../tools/virt-list-filesystems.pl:46
26710 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
26711 "functionality. For more complex cases you should look at the "
26712 "L<guestfish(1)> tool."
26716 #: ../tools/virt-list-filesystems.pl:105
26718 "With this option, C<virt-list-filesystems> displays the type of each "
26719 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
26723 #: ../tools/virt-list-filesystems.pl:112
26724 msgid "B<-a> | B<--all>"
26728 #: ../tools/virt-list-filesystems.pl:114
26730 "Normally we only show mountable filesystems. If this option is given then "
26731 "swap devices are shown too."
26735 #: ../tools/virt-list-filesystems.pl:188
26737 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
26738 "L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
26739 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26743 #: ../tools/virt-cat.pl:33
26744 msgid "virt-cat - Display a file in a virtual machine"
26748 #: ../tools/virt-cat.pl:37
26751 " virt-cat [--options] domname file\n"
26756 #: ../tools/virt-cat.pl:39
26759 " virt-cat [--options] disk.img [disk.img ...] file\n"
26764 #: ../tools/virt-cat.pl:43
26766 "C<virt-cat> is a command line tool to display the contents of C<file> where "
26767 "C<file> exists in the named virtual machine (or disk image)."
26771 #: ../tools/virt-cat.pl:46
26773 "C<virt-cat> can be used to quickly view a single file. To edit a file, use "
26774 "C<virt-edit>. For more complex cases you should look at the L<guestfish(1)> "
26779 #: ../tools/virt-cat.pl:52
26780 msgid "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
26784 #: ../tools/virt-cat.pl:55
26787 " virt-cat mydomain /etc/fstab\n"
26792 #: ../tools/virt-cat.pl:57
26793 msgid "List syslog messages from a VM:"
26797 #: ../tools/virt-cat.pl:59
26800 " virt-cat mydomain /var/log/messages | tail\n"
26805 #: ../tools/virt-cat.pl:61
26806 msgid "Find out what DHCP IP address a VM acquired:"
26810 #: ../tools/virt-cat.pl:63
26813 " virt-cat mydomain /var/log/messages | grep 'dhclient: bound to' | tail\n"
26818 #: ../tools/virt-cat.pl:65
26819 msgid "Find out what packages were recently installed:"
26823 #: ../tools/virt-cat.pl:67
26826 " virt-cat mydomain /var/log/yum.log | tail\n"
26831 #: ../tools/virt-cat.pl:69
26832 msgid "Find out who is logged on inside a virtual machine:"
26836 #: ../tools/virt-cat.pl:71
26839 " virt-cat mydomain /var/run/utmp > /tmp/utmp\n"
26845 #: ../tools/virt-cat.pl:74
26846 msgid "or who was logged on:"
26850 #: ../tools/virt-cat.pl:76
26853 " virt-cat mydomain /var/log/wtmp > /tmp/wtmp\n"
26854 " last -f /tmp/wtmp\n"
26859 #: ../tools/virt-cat.pl:187
26861 "L<guestfs(3)>, L<guestfish(1)>, L<virt-edit(1)>, L<Sys::Guestfs(3)>, "
26862 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26866 #: ../tools/virt-tar.pl:33
26867 msgid "virt-tar - Extract or upload files to a virtual machine"
26871 #: ../tools/virt-tar.pl:37
26874 " virt-tar [--options] -x domname directory tarball\n"
26879 #: ../tools/virt-tar.pl:39
26882 " virt-tar [--options] -u domname tarball directory\n"
26887 #: ../tools/virt-tar.pl:41
26890 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
26895 #: ../tools/virt-tar.pl:43
26898 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
26903 #: ../tools/virt-tar.pl:47
26904 msgid "Download C</home> from the VM into a local tarball:"
26908 #: ../tools/virt-tar.pl:49
26911 " virt-tar -x domname /home home.tar\n"
26916 #: ../tools/virt-tar.pl:51
26919 " virt-tar -zx domname /home home.tar.gz\n"
26924 #: ../tools/virt-tar.pl:53
26925 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
26929 #: ../tools/virt-tar.pl:55
26932 " virt-tar -u domname uploadstuff.tar /tmp\n"
26937 #: ../tools/virt-tar.pl:57
26940 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
26945 #: ../tools/virt-tar.pl:61
26947 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
26948 "virtual machines. If you do this, you risk disk corruption in the VM. "
26949 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
26953 #: ../tools/virt-tar.pl:66
26955 "You can use C<-x> (extract) on live virtual machines, but you might get "
26956 "inconsistent results or errors if there is filesystem activity inside the "
26957 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
26958 "work, but the only way to guarantee consistent results is if the virtual "
26959 "machine is shut down."
26963 #: ../tools/virt-tar.pl:74
26965 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
26966 "parts of a guest filesystem. There are many possibilities: making backups, "
26967 "uploading data files, snooping on guest activity, fixing or customizing "
26972 #: ../tools/virt-tar.pl:79
26974 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
26975 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
26976 "should look at the L<guestfish(1)> tool."
26980 #: ../tools/virt-tar.pl:83
26982 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
26983 "its contents (recursively) from the virtual machine into a local tarball. "
26984 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
26985 "virtual machine. You cannot use these two options together."
26989 #: ../tools/virt-tar.pl:89
26991 "In addition, you may need to use the C<-z> (gZip) option to enable "
26992 "compression. When uploading, you have to specify C<-z> if the upload file "
26993 "is compressed because virt-tar won't detect this on its own."
26997 #: ../tools/virt-tar.pl:93
26999 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
27000 "example it cannot do PKZip files or bzip2 compression. If you want that "
27001 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
27002 "the L<libguestfs(3)> API)."
27006 #: ../tools/virt-tar.pl:151
27007 msgid "B<-x> | B<--extract> | B<--download>"
27011 #: ../tools/virt-tar.pl:153
27012 msgid "B<-u> | B<--upload>"
27016 #: ../tools/virt-tar.pl:155
27018 "Use C<-x> to extract (download) a directory from a virtual machine to a "
27023 #: ../tools/virt-tar.pl:158
27025 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
27026 "Please read the L</WARNING> section above before using this option."
27030 #: ../tools/virt-tar.pl:162
27031 msgid "You must specify exactly one of these options."
27035 #: ../tools/virt-tar.pl:168
27036 msgid "B<-z> | B<--gzip>"
27040 #: ../tools/virt-tar.pl:170
27041 msgid "Specify that the input or output tarball is gzip-compressed."
27045 #: ../tools/virt-tar.pl:283
27047 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
27048 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
27049 "L<http://libguestfs.org/>."
27053 #: ../tools/virt-rescue.pl:33
27054 msgid "virt-rescue - Run a rescue shell on a virtual machine"
27058 #: ../tools/virt-rescue.pl:37
27061 " virt-rescue [--options] domname\n"
27066 #: ../tools/virt-rescue.pl:39
27069 " virt-rescue [--options] disk.img [disk.img ...]\n"
27074 #: ../tools/virt-rescue.pl:43
27076 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
27077 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
27078 "you from doing this, but doesn't catch all cases."
27082 #: ../tools/virt-rescue.pl:47
27084 "However if you use the I<--ro> (read only) option, then you can attach a "
27085 "shell to a live virtual machine. The results might be strange or "
27086 "inconsistent at times but you won't get disk corruption."
27090 #: ../tools/virt-rescue.pl:53
27092 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
27093 "need for a CD. virt-rescue gives you a rescue shell and some simple "
27094 "recovery tools which you can use to examine or rescue a virtual machine or "
27099 #: ../tools/virt-rescue.pl:58
27101 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
27102 "on disk image(s):"
27106 #: ../tools/virt-rescue.pl:61
27109 " virt-rescue GuestName\n"
27114 #: ../tools/virt-rescue.pl:63
27117 " virt-rescue --ro /path/to/disk.img\n"
27122 #: ../tools/virt-rescue.pl:65
27125 " virt-rescue /dev/sdc\n"
27130 #: ../tools/virt-rescue.pl:67
27131 msgid "For live VMs you I<must> use the --ro option."
27135 #: ../tools/virt-rescue.pl:69
27137 "When you run virt-rescue on a virtual machine or disk image, you are placed "
27138 "in an interactive bash shell where you can use many ordinary Linux "
27139 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
27140 "appliance. You must mount the virtual machine's filesystems by hand. There "
27141 "is an empty directory called C</sysroot> where you can mount filesystems."
27145 #: ../tools/virt-rescue.pl:76
27147 "In the example below, we list logical volumes, then choose one to mount "
27148 "under C</sysroot>:"
27152 #: ../tools/virt-rescue.pl:79
27156 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
27157 " lv_root vg_f11x64 -wi-a- 8.83G\n"
27158 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
27159 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
27160 " ><rescue> ls /sysroot\n"
27165 #: ../tools/virt-rescue.pl:86
27167 "If you don't know what filesystems are available on the virtual machine then "
27168 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
27172 #: ../tools/virt-rescue.pl:92
27174 "Virt-rescue can be used on I<any> disk image file or device, not just a "
27175 "virtual machine. For example you can use it on a blank file if you want to "
27176 "partition that file (although we would recommend using L<guestfish(1)> "
27177 "instead as it is more suitable for this purpose). You can even use "
27178 "virt-rescue on things like SD cards."
27182 #: ../tools/virt-rescue.pl:98
27184 "This tool is just designed for quick interactive hacking on a virtual "
27185 "machine. For more structured access to a virtual machine disk image, you "
27186 "should use L<guestfs(3)>. To get a structured shell that you can use to "
27187 "make scripted changes to guests, use L<guestfish(1)>."
27191 #: ../tools/virt-rescue.pl:127
27192 msgid "B<--append kernelopts>"
27196 #: ../tools/virt-rescue.pl:129
27197 msgid "Pass additional options to the rescue kernel."
27201 #: ../tools/virt-rescue.pl:164
27202 msgid "B<--memsize MB> | B<-m MB>"
27206 #: ../tools/virt-rescue.pl:166
27208 "Change the amount of memory allocated to the rescue system. The default is "
27209 "set by libguestfs and is small but adequate for running system tools. The "
27210 "occasional program might need more memory. The parameter is specified in "
27215 #: ../tools/virt-rescue.pl:175
27216 msgid "B<--network MB>"
27220 #: ../tools/virt-rescue.pl:177
27221 msgid "Enable QEMU user networking in the guest."
27225 #: ../tools/virt-rescue.pl:183
27226 msgid "B<--ro> | B<-r>"
27230 #: ../tools/virt-rescue.pl:185
27231 msgid "Open the image read-only."
27235 #: ../tools/virt-rescue.pl:197
27237 "Enable SELinux in the rescue appliance. You should read "
27238 "L<guestfs(3)/SELINUX> before using this option."
27242 #: ../tools/virt-rescue.pl:257
27244 "Several environment variables affect virt-rescue. See "
27245 "L<guestfs(3)/ENVIRONMENT VARIABLES> for the complete list."
27249 #: ../tools/virt-rescue.pl:269
27251 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
27252 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27256 #: ../tools/virt-make-fs.pl:37
27257 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
27261 #: ../tools/virt-make-fs.pl:41
27264 " virt-make-fs [--options] input.tar output.img\n"
27269 #: ../tools/virt-make-fs.pl:43
27272 " virt-make-fs [--options] input.tar.gz output.img\n"
27277 #: ../tools/virt-make-fs.pl:45
27280 " virt-make-fs [--options] directory output.img\n"
27285 #: ../tools/virt-make-fs.pl:49
27287 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
27288 "archive or some files in a directory. It is similar to tools like "
27289 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
27290 "it can create common filesystem types like ext2/3 or NTFS, which can be "
27291 "useful if you want to attach these filesystems to existing virtual machines "
27292 "(eg. to import large amounts of read-only data to a VM)."
27296 #: ../tools/virt-make-fs.pl:57
27297 msgid "Basic usage is:"
27301 #: ../tools/virt-make-fs.pl:59
27304 " virt-make-fs input output\n"
27309 #: ../tools/virt-make-fs.pl:61
27311 "where C<input> is either a directory containing files that you want to add, "
27312 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
27313 "C<output> is a disk image. The input type is detected automatically. The "
27314 "output disk image defaults to a raw ext2 image unless you specify extra "
27315 "flags (see L</OPTIONS> below)."
27319 #: ../tools/virt-make-fs.pl:67
27320 msgid "EXTRA SPACE"
27324 #: ../tools/virt-make-fs.pl:69
27326 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
27327 "the files that it contains, but might have extra space. Depending on how "
27328 "you are going to use the output, you might think this extra space is wasted "
27329 "and want to minimize it, or you might want to leave space so that more files "
27330 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
27331 "but you can use the C<--size> flag to leave space in the filesystem if you "
27336 #: ../tools/virt-make-fs.pl:77
27338 "An alternative way to leave extra space but not make the output image any "
27339 "bigger is to use an alternative disk image format (instead of the default "
27340 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
27341 "image format (check your hypervisor supports this before using it). This "
27342 "allows you to choose a large C<--size> but the extra space won't actually be "
27343 "allocated in the image until you try to store something in it."
27347 #: ../tools/virt-make-fs.pl:85
27349 "Don't forget that you can also use local commands including L<resize2fs(8)> "
27350 "and L<virt-resize(1)> to resize existing filesystems, or rerun "
27351 "virt-make-resize to build another image from scratch."
27355 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
27360 #: ../tools/virt-make-fs.pl:91
27363 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
27368 #: ../tools/virt-make-fs.pl:93
27369 msgid "FILESYSTEM TYPE"
27373 #: ../tools/virt-make-fs.pl:95
27375 "The default filesystem type is C<ext2>. Just about any filesystem type that "
27376 "libguestfs supports can be used (but I<not> read-only formats like "
27377 "ISO9660). Here are some of the more common choices:"
27381 #: ../tools/virt-make-fs.pl:101
27386 #: ../tools/virt-make-fs.pl:103
27388 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
27389 "you are not going to use the filesystem in a way that requires the journal, "
27390 "then this is just wasted overhead."
27394 #: ../tools/virt-make-fs.pl:107
27395 msgid "I<ntfs> or I<vfat>"
27399 #: ../tools/virt-make-fs.pl:109
27400 msgid "Useful if exporting data to a Windows guest."
27404 #: ../tools/virt-make-fs.pl:111
27406 "I<Note for vfat>: The tar archive or local directory must only contain files "
27407 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
27408 "program running within libguestfs is unable to change the ownership of "
27409 "non-root files, since vfat itself does not support this."
27413 #: ../tools/virt-make-fs.pl:116
27418 #: ../tools/virt-make-fs.pl:118
27420 "Lower overhead than C<ext2>, but certain limitations on filename length and "
27421 "total filesystem size."
27425 #: ../tools/virt-make-fs.pl:125
27428 " virt-make-fs --type=minix input minixfs.img\n"
27433 #: ../tools/virt-make-fs.pl:127
27434 msgid "TO PARTITION OR NOT TO PARTITION"
27438 #: ../tools/virt-make-fs.pl:129
27439 msgid "Optionally virt-make-fs can add a partition table to the output disk."
27443 #: ../tools/virt-make-fs.pl:131
27445 "Adding a partition can make the disk image more compatible with certain "
27446 "virtualized operating systems which don't expect to see a filesystem "
27447 "directly located on a block device (Linux doesn't care and will happily "
27448 "handle both types)."
27452 #: ../tools/virt-make-fs.pl:136
27454 "On the other hand, if you have a partition table then the output image is no "
27455 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
27456 "directly on a partitioned disk image. (However libguestfs tools such as "
27457 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
27461 #: ../tools/virt-make-fs.pl:144
27462 msgid "Add an MBR partition:"
27466 #: ../tools/virt-make-fs.pl:146
27469 " virt-make-fs --partition -- input disk.img\n"
27474 #: ../tools/virt-make-fs.pl:148
27476 "If the output disk image could be terabyte-sized or larger, it's better to "
27477 "use an EFI/GPT-compatible partition table:"
27481 #: ../tools/virt-make-fs.pl:151
27484 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
27489 #: ../tools/virt-make-fs.pl:179
27490 msgid "Enable debugging information."
27494 #: ../tools/virt-make-fs.pl:185
27495 msgid "B<--size=E<lt>NE<gt>>"
27499 #: ../tools/virt-make-fs.pl:187
27500 msgid "B<--size=+E<lt>NE<gt>>"
27504 #: ../tools/virt-make-fs.pl:189
27505 msgid "B<-s E<lt>NE<gt>>"
27509 #: ../tools/virt-make-fs.pl:191
27510 msgid "B<-s +E<lt>NE<gt>>"
27514 #: ../tools/virt-make-fs.pl:193
27515 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
27519 #: ../tools/virt-make-fs.pl:196
27521 "If this option is I<not> given, then the output image will be just large "
27522 "enough to contain all the files, with not much wasted space."
27526 #: ../tools/virt-make-fs.pl:199
27528 "To choose a fixed size output disk, specify an absolute number followed by "
27529 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
27530 "Petabytes or Exabytes. This must be large enough to contain all the input "
27531 "files, else you will get an error."
27535 #: ../tools/virt-make-fs.pl:204
27537 "To leave extra space, specify C<+> (plus sign) and a number followed by "
27538 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
27539 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
27540 "the input files, and (approximately) an extra 200 MB free space."
27544 #: ../tools/virt-make-fs.pl:210
27546 "Note that virt-make-fs estimates free space, and therefore will not produce "
27547 "filesystems containing precisely the free space requested. (It is much more "
27548 "expensive and time-consuming to produce a filesystem which has precisely the "
27549 "desired free space)."
27553 #: ../tools/virt-make-fs.pl:219
27554 msgid "B<--format=E<lt>fmtE<gt>>"
27558 #: ../tools/virt-make-fs.pl:221
27559 msgid "B<-F E<lt>fmtE<gt>>"
27563 #: ../tools/virt-make-fs.pl:223
27564 msgid "Choose the output disk image format."
27568 #: ../tools/virt-make-fs.pl:225
27569 msgid "The default is C<raw> (raw disk image)."
27573 #: ../tools/virt-make-fs.pl:227
27575 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
27576 "that would really make sense here is C<qcow2>."
27580 #: ../tools/virt-make-fs.pl:234
27581 msgid "B<--type=E<lt>fsE<gt>>"
27585 #: ../tools/virt-make-fs.pl:236
27586 msgid "B<-t E<lt>fsE<gt>>"
27590 #: ../tools/virt-make-fs.pl:238
27591 msgid "Choose the output filesystem type."
27595 #: ../tools/virt-make-fs.pl:240
27596 msgid "The default is C<ext2>."
27600 #: ../tools/virt-make-fs.pl:242
27601 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
27605 #: ../tools/virt-make-fs.pl:249
27606 msgid "B<--partition>"
27610 #: ../tools/virt-make-fs.pl:251
27611 msgid "B<--partition=E<lt>parttypeE<gt>>"
27615 #: ../tools/virt-make-fs.pl:253
27617 "If specified, this flag adds an MBR partition table to the output disk "
27622 #: ../tools/virt-make-fs.pl:256
27624 "You can change the partition table type, eg. C<--partition=gpt> for large "
27629 #: ../tools/virt-make-fs.pl:259
27631 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
27632 "might consider the next parameter to be the partition type. For example:"
27636 #: ../tools/virt-make-fs.pl:263
27639 " virt-make-fs --partition input.tar ...\n"
27644 #: ../tools/virt-make-fs.pl:265
27646 "would cause virt-make-fs to think you wanted to use a partition type of "
27647 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
27648 "dash) between options and the input file argument:"
27652 #: ../tools/virt-make-fs.pl:269
27655 " virt-make-fs --partition -- input.tar ...\n"
27660 #: ../tools/virt-make-fs.pl:536
27662 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
27663 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
27664 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
27668 #: ../tools/virt-make-fs.pl:553
27671 " export LIBGUESTFS_DEBUG=1\n"
27672 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
27677 #: ../tools/virt-make-fs.pl:556
27679 "Attach /tmp/virt-make-fs.log to a new bug report at "
27680 "L<https://bugzilla.redhat.com/>"
27684 #: ../tools/virt-list-partitions.pl:32
27685 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
27689 #: ../tools/virt-list-partitions.pl:36
27692 " virt-list-partitions [--options] domname\n"
27697 #: ../tools/virt-list-partitions.pl:38
27700 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
27705 #: ../tools/virt-list-partitions.pl:42
27707 "C<virt-list-partitions> is a command line tool to list the partitions that "
27708 "are contained in a virtual machine or disk image. It is mainly useful as a "
27709 "first step to using L<virt-resize(1)>."
27713 #: ../tools/virt-list-partitions.pl:47
27715 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
27716 "functionality. For more complex cases you should look at the "
27717 "L<guestfish(1)> tool."
27721 #: ../tools/virt-list-partitions.pl:104
27722 msgid "B<-h> | B<--human-readable>"
27726 #: ../tools/virt-list-partitions.pl:106
27727 msgid "Show sizes in human-readable form (eg. \"1G\")."
27731 #: ../tools/virt-list-partitions.pl:114
27733 "With this option, C<virt-list-partitions> displays the type and size of each "
27734 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
27738 #: ../tools/virt-list-partitions.pl:121
27739 msgid "B<-t> | B<--total>"
27743 #: ../tools/virt-list-partitions.pl:123
27744 msgid "Display the total size of each block device (as a separate row or rows)."
27748 #: ../tools/virt-list-partitions.pl:256
27750 "L<guestfs(3)>, L<guestfish(1)>, L<virt-list-filesystems(1)>, "
27751 "L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
27752 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."