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.
8 "Project-Id-Version: libguestfs\n"
9 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
10 "POT-Creation-Date: 2011-04-05 20:38+0200\n"
11 "PO-Revision-Date: 2011-04-01 15:39+0000\n"
12 "Last-Translator: yurchor <yurchor@ukr.net>\n"
13 "Language-Team: Ukrainian <trans-uk@lists.fedoraproject.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
18 "Plural-Forms: nplurals=3; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && n"
19 "%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2)\n"
22 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
23 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
24 #: ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35
25 #: ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30
26 #: ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35
27 #: ../tools/virt-list-partitions.pl:30
32 #: ../src/guestfs.pod:5
33 msgid "guestfs - Library for accessing and modifying virtual machine images"
35 "guestfs — бібліотека для доступу та внесення змін до образів віртуальних "
39 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
40 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
41 #: ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39
42 #: ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34
43 #: ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39
44 #: ../tools/virt-list-partitions.pl:34
46 msgstr "КОРОТКИЙ ОПИС"
49 #: ../src/guestfs.pod:9
52 " #include <guestfs.h>\n"
55 " #include <guestfs.h>\n"
59 #: ../src/guestfs.pod:11
62 " guestfs_h *g = guestfs_create ();\n"
63 " guestfs_add_drive (g, \"guest.img\");\n"
64 " guestfs_launch (g);\n"
65 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
66 " guestfs_touch (g, \"/hello\");\n"
67 " guestfs_umount (g, \"/\");\n"
68 " guestfs_close (g);\n"
71 " guestfs_h *g = guestfs_create ();\n"
72 " guestfs_add_drive (g, \"guest.img\");\n"
73 " guestfs_launch (g);\n"
74 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
75 " guestfs_touch (g, \"/hello\");\n"
76 " guestfs_umount (g, \"/\");\n"
77 " guestfs_close (g);\n"
81 #: ../src/guestfs.pod:19
84 " cc prog.c -o prog -lguestfs\n"
86 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
89 " cc prog.c -o prog -lguestfs\n"
91 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
95 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30
96 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
97 #: ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63
98 #: ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40
99 #: ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47
100 #: ../tools/virt-list-partitions.pl:40
105 #: ../src/guestfs.pod:25
107 "Libguestfs is a library for accessing and modifying guest disk images. "
108 "Amongst the things this is good for: making batch configuration changes to "
109 "guests, getting disk used/free statistics (see also: virt-df), migrating "
110 "between virtualization systems (see also: virt-p2v), performing partial "
111 "backups, performing partial guest clones, cloning guests and changing "
112 "registry/UUID/hostname info, and much else besides."
116 #: ../src/guestfs.pod:33
118 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
119 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
120 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
125 #: ../src/guestfs.pod:38
127 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
128 "what filesystem is in each LV, etc.). It can also run commands in the "
129 "context of the guest. Also you can access filesystems over FUSE."
133 #: ../src/guestfs.pod:43
135 "Libguestfs is a library that can be linked with C and C++ management "
136 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
137 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
142 #: ../src/guestfs.pod:48
144 "You don't need to be root to use libguestfs, although obviously you do need "
145 "enough permissions to access the disk images."
149 #: ../src/guestfs.pod:51
151 "Libguestfs is a large API because it can do many things. For a gentle "
152 "introduction, please read the L</API OVERVIEW> section next."
156 #: ../src/guestfs.pod:54
158 "There are also some example programs in the L<guestfs-examples(3)> manual "
163 #: ../src/guestfs.pod:57
168 #: ../src/guestfs.pod:59
170 "This section provides a gentler overview of the libguestfs API. We also try "
171 "to group API calls together, where that may not be obvious from reading "
172 "about the individual calls in the main section of this manual."
176 #: ../src/guestfs.pod:64
181 #: ../src/guestfs.pod:66
183 "Before you can use libguestfs calls, you have to create a handle. Then you "
184 "must add at least one disk image to the handle, followed by launching the "
185 "handle, then performing whatever operations you want, and finally closing "
186 "the handle. By convention we use the single letter C<g> for the name of the "
187 "handle variable, although of course you can use any name you want."
191 #: ../src/guestfs.pod:73
192 msgid "The general structure of all libguestfs-using programs looks like this:"
196 #: ../src/guestfs.pod:76
199 " guestfs_h *g = guestfs_create ();\n"
202 " guestfs_h *g = guestfs_create ();\n"
206 #: ../src/guestfs.pod:78
209 " /* Call guestfs_add_drive additional times if there are\n"
210 " * multiple disk images.\n"
212 " guestfs_add_drive (g, \"guest.img\");\n"
217 #: ../src/guestfs.pod:83
220 " /* Most manipulation calls won't work until you've launched\n"
221 " * the handle 'g'. You have to do this _after_ adding drives\n"
222 " * and _before_ other commands.\n"
224 " guestfs_launch (g);\n"
229 #: ../src/guestfs.pod:89
232 " /* Now you can examine what partitions, LVs etc are available.\n"
234 " char **partitions = guestfs_list_partitions (g);\n"
235 " char **logvols = guestfs_lvs (g);\n"
240 #: ../src/guestfs.pod:94
243 " /* To access a filesystem in the image, you must mount it.\n"
245 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
248 " /* Щоб отримати доступ до файлової системи на образі, вам слід його змонтувати.\n"
250 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
254 #: ../src/guestfs.pod:98
257 #| " /* Now you can perform filesystem actions on the guest\n"
258 #| " * disk image.\n"
260 #| " guestfs_touch (g, \"/hello\");\n"
263 " /* Now you can perform filesystem actions on the guest\n"
266 " guestfs_touch (g, \"/hello\");\n"
269 " /* Тепер ви можете виконувати дії з файловою системою на\n"
270 " * образі диска операційної системи.\n"
272 " guestfs_touch (g, \"/hello\");\n"
276 #: ../src/guestfs.pod:103
279 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
280 " * it is done automatically when you close the handle. See\n"
281 " * discussion of autosync in this page.\n"
283 " guestfs_sync (g);\n"
288 #: ../src/guestfs.pod:109
291 " /* Close the handle 'g'. */\n"
292 " guestfs_close (g);\n"
297 #: ../src/guestfs.pod:112
299 "The code above doesn't include any error checking. In real code you should "
300 "check return values carefully for errors. In general all functions that "
301 "return integers return C<-1> on error, and all functions that return "
302 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
303 "how to handle errors, and consult the documentation for each function call "
304 "below to see precisely how they return error indications. See L<guestfs-"
305 "examples(3)> for fully worked examples."
309 #: ../src/guestfs.pod:121
314 #: ../src/guestfs.pod:123
316 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
317 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
318 "actual block device, or simply an empty file of zeroes that you have created "
319 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
324 #: ../src/guestfs.pod:129
326 "The call you should use in modern code for adding drives is L</"
327 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
328 "specifying that the format is raw, do:"
332 #: ../src/guestfs.pod:133
335 " guestfs_add_drive_opts (g, filename,\n"
336 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
342 #: ../src/guestfs.pod:137
343 msgid "You can add a disk read-only using:"
347 #: ../src/guestfs.pod:139
350 " guestfs_add_drive_opts (g, filename,\n"
351 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
352 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
358 #: ../src/guestfs.pod:144
360 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
361 "libguestfs won't modify the file."
365 #: ../src/guestfs.pod:147
367 "Be extremely cautious if the disk image is in use, eg. if it is being used "
368 "by a virtual machine. Adding it read-write will almost certainly cause disk "
369 "corruption, but adding it read-only is safe."
373 #: ../src/guestfs.pod:151
375 "You must add at least one disk image, and you may add multiple disk images. "
376 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
377 "first one you added), C</dev/sdb> (for the second one you added), etc."
381 #: ../src/guestfs.pod:156
383 "Once L</guestfs_launch> has been called you cannot add any more images. You "
384 "can call L</guestfs_list_devices> to get a list of the device names, in the "
385 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
389 #: ../src/guestfs.pod:161
394 #: ../src/guestfs.pod:163
396 "Before you can read or write files, create directories and so on in a disk "
397 "image that contains filesystems, you have to mount those filesystems using "
398 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
399 "a disk image contains (for example) one partition with a filesystem on that "
400 "partition, then you can mount it directly:"
404 #: ../src/guestfs.pod:170
407 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
412 #: ../src/guestfs.pod:172
414 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
415 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
416 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
417 "that these are libguestfs virtual devices, and are nothing to do with host "
422 #: ../src/guestfs.pod:178
424 "If you are given a disk image and you don't know what it contains then you "
425 "have to find out. Libguestfs can do that too: use L</"
426 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
427 "LVs, and either try mounting each to see what is mountable, or else examine "
428 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
429 "filesystems, use L</guestfs_list_filesystems>."
433 #: ../src/guestfs.pod:186
435 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
436 "L</INSPECTION> below). But you might find it easier to look at higher level "
437 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
441 #: ../src/guestfs.pod:191
443 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
444 "several other variations of the C<guestfs_mount_*> call."
448 #: ../src/guestfs.pod:194
449 msgid "FILESYSTEM ACCESS AND MODIFICATION"
453 #: ../src/guestfs.pod:196
455 "The majority of the libguestfs API consists of fairly low-level calls for "
456 "accessing and modifying the files, directories, symlinks etc on mounted "
457 "filesystems. There are over a hundred such calls which you can find listed "
458 "in detail below in this man page, and we don't even pretend to cover them "
459 "all in this overview."
463 #: ../src/guestfs.pod:202
465 "Specify filenames as full paths, starting with C<\"/\"> and including the "
470 #: ../src/guestfs.pod:205
472 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
473 "the file called C<\"etc/passwd\"> then you could do:"
477 #: ../src/guestfs.pod:208
480 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
485 #: ../src/guestfs.pod:210
487 "This would return C<data> as a newly allocated buffer containing the full "
488 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
489 "or C<NULL> if there was an error."
493 #: ../src/guestfs.pod:214
495 "As another example, to create a top-level directory on that filesystem "
496 "called C<\"var\"> you would do:"
500 #: ../src/guestfs.pod:217
503 " guestfs_mkdir (g, \"/var\");\n"
508 #: ../src/guestfs.pod:219
509 msgid "To create a symlink you could do:"
513 #: ../src/guestfs.pod:221
516 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
517 " \"/etc/rc3.d/S30portmap\");\n"
522 #: ../src/guestfs.pod:224
524 "Libguestfs will reject attempts to use relative paths and there is no "
525 "concept of a current working directory."
529 #: ../src/guestfs.pod:227
531 "Libguestfs can return errors in many situations: for example if the "
532 "filesystem isn't writable, or if a file or directory that you requested "
533 "doesn't exist. If you are using the C API (documented here) you have to "
534 "check for those error conditions after each call. (Other language bindings "
535 "turn these errors into exceptions)."
539 #: ../src/guestfs.pod:233
541 "File writes are affected by the per-handle umask, set by calling L</"
542 "guestfs_umask> and defaulting to 022. See L</UMASK>."
546 #: ../src/guestfs.pod:236
548 msgstr "ПОДІЛ НА РОЗДІЛИ"
551 #: ../src/guestfs.pod:238
553 "Libguestfs contains API calls to read, create and modify partition tables on "
558 #: ../src/guestfs.pod:241
560 "In the common case where you want to create a single partition covering the "
561 "whole disk, you should use the L</guestfs_part_disk> call:"
565 #: ../src/guestfs.pod:245
568 " const char *parttype = \"mbr\";\n"
569 " if (disk_is_larger_than_2TB)\n"
570 " parttype = \"gpt\";\n"
571 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
576 #: ../src/guestfs.pod:250
578 "Obviously this effectively wipes anything that was on that disk image before."
582 #: ../src/guestfs.pod:253
587 #: ../src/guestfs.pod:255
589 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
590 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
591 "you familiarize yourself with the concepts of physical volumes, volume "
592 "groups and logical volumes."
596 #: ../src/guestfs.pod:260
598 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
599 "tldp.org/HOWTO/LVM-HOWTO/>."
603 #: ../src/guestfs.pod:263
608 #: ../src/guestfs.pod:265
610 "Use L</guestfs_cat> to download small, text only files. This call is "
611 "limited to files which are less than 2 MB and which cannot contain any ASCII "
612 "NUL (C<\\0>) characters. However the API is very simple to use."
616 #: ../src/guestfs.pod:269
618 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
619 "bit data, since it returns a (pointer, size) pair. However it is still "
620 "limited to \"small\" files, less than 2 MB."
624 #: ../src/guestfs.pod:273
626 "L</guestfs_download> can be used to download any file, with no limits on "
627 "content or size (even files larger than 4 GB)."
631 #: ../src/guestfs.pod:276
633 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
637 #: ../src/guestfs.pod:279
639 msgstr "ВИВАНТАЖЕННЯ"
642 #: ../src/guestfs.pod:281
644 "It's often the case that you want to write a file or files to the disk image."
648 #: ../src/guestfs.pod:284
650 "To write a small file with fixed content, use L</guestfs_write>. To create "
651 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
652 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
653 "of other functions for creating test files, for example L</guestfs_fill> and "
654 "L</guestfs_fill_pattern>."
658 #: ../src/guestfs.pod:290
660 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
661 "file content or size (even files larger than 4 GB)."
665 #: ../src/guestfs.pod:293
667 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
671 #: ../src/guestfs.pod:295
673 "However the fastest way to upload I<large numbers of arbitrary files> is to "
674 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
675 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
676 "in a predictable way (eg. adding it last after all other drives) then you "
677 "can get the device name from L</guestfs_list_devices> and mount it directly "
678 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
679 "portable between kernel versions, and they don't support labels or UUIDs. "
680 "If you want to pre-build an image or you need to mount it using a label or "
681 "UUID, use an ISO image instead."
685 #: ../src/guestfs.pod:306
690 #: ../src/guestfs.pod:308
692 "There are various different commands for copying between files and devices "
693 "and in and out of the guest filesystem. These are summarised in the table "
698 #: ../src/guestfs.pod:314
699 msgid "B<file> to B<file>"
703 #: ../src/guestfs.pod:316
705 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
706 "directories recursively."
710 #: ../src/guestfs.pod:319
711 msgid "B<file or device> to B<file or device>"
715 #: ../src/guestfs.pod:321
717 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
718 "devices in the guest."
722 #: ../src/guestfs.pod:324
723 msgid "Example: duplicate the contents of an LV:"
727 #: ../src/guestfs.pod:326
730 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
735 #: ../src/guestfs.pod:328
737 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
738 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
739 "guestfs_copy_size>."
743 #: ../src/guestfs.pod:332
744 msgid "B<file on the host> to B<file or device>"
748 #: ../src/guestfs.pod:334
749 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
753 #: ../src/guestfs.pod:336
754 msgid "B<file or device> to B<file on the host>"
758 #: ../src/guestfs.pod:338
759 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
763 #: ../src/guestfs.pod:342
764 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
768 #: ../src/guestfs.pod:344
770 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
771 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
772 "appears you can only upload and download to files. However many Un*x-like "
773 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
774 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
775 "and arbitrary file descriptor N."
779 #: ../src/guestfs.pod:352
780 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
784 #: ../src/guestfs.pod:355
787 " guestfs_download (g, filename, \"/dev/stdout\");\n"
792 #: ../src/guestfs.pod:357
793 msgid "and you can write tar output to a pipe C<fd> by doing:"
797 #: ../src/guestfs.pod:359
801 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
802 " guestfs_tar_out (g, \"/\", devfd);\n"
807 #: ../src/guestfs.pod:363
808 msgid "LISTING FILES"
812 #: ../src/guestfs.pod:365
814 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
815 "L<guestfish(1)>-equivalent command C<ll>)."
819 #: ../src/guestfs.pod:368
821 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
822 "programs, as a flat list of strings."
826 #: ../src/guestfs.pod:371
828 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
829 "directory, plus additional information about each one. It is more "
830 "equivalent to using the L<readdir(3)> call on a local filesystem."
834 #: ../src/guestfs.pod:375
836 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
840 #: ../src/guestfs.pod:378
841 msgid "RUNNING COMMANDS"
845 #: ../src/guestfs.pod:380
847 "Although libguestfs is primarily an API for manipulating files inside guest "
848 "images, we also provide some limited facilities for running commands inside "
853 #: ../src/guestfs.pod:384
854 msgid "There are many limitations to this:"
858 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
859 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
860 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1088
861 #: ../src/guestfs.pod:1092 ../src/guestfs.pod:1096 ../src/guestfs.pod:1101
862 #: ../src/guestfs.pod:1109 ../src/guestfs.pod:1128 ../src/guestfs.pod:1136
863 #: ../src/guestfs.pod:1158 ../src/guestfs.pod:1162 ../src/guestfs.pod:1166
864 #: ../src/guestfs.pod:1170 ../src/guestfs.pod:1174 ../src/guestfs.pod:1178
865 #: ../src/guestfs.pod:1660 ../src/guestfs.pod:1665 ../src/guestfs.pod:1669
866 #: ../src/guestfs.pod:1770 ../src/guestfs.pod:1775 ../src/guestfs.pod:1779
867 #: ../src/guestfs.pod:1789 ../src/guestfs.pod:2023 ../src/guestfs.pod:2028
868 #: ../src/guestfs.pod:2034 ../src/guestfs.pod:2042 ../src/guestfs.pod:2396
869 #: ../src/guestfs.pod:2402 ../src/guestfs.pod:2407 ../src/guestfs.pod:2413
870 #: ../src/guestfs.pod:2878 ../src/guestfs.pod:2882 ../src/guestfs.pod:2886
871 #: ../src/guestfs.pod:2890 ../src/guestfs-actions.pod:15
872 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:577
873 #: ../src/guestfs-actions.pod:585 ../src/guestfs-actions.pod:592
874 #: ../src/guestfs-actions.pod:599 ../src/guestfs-actions.pod:1600
875 #: ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1608
876 #: ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1620
877 #: ../src/guestfs-actions.pod:1624 ../src/guestfs-actions.pod:1628
878 #: ../src/guestfs-actions.pod:1638 ../src/guestfs-actions.pod:1642
879 #: ../src/guestfs-actions.pod:1646 ../src/guestfs-actions.pod:1784
880 #: ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:1793
881 #: ../src/guestfs-actions.pod:1798 ../src/guestfs-actions.pod:1859
882 #: ../src/guestfs-actions.pod:1863 ../src/guestfs-actions.pod:1868
883 #: ../fish/guestfish.pod:443 ../fish/guestfish.pod:447
884 #: ../fish/guestfish.pod:451 ../fish/guestfish.pod:455
885 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
886 #: ../fish/guestfish-actions.pod:380 ../fish/guestfish-actions.pod:388
887 #: ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:402
888 #: ../fish/guestfish-actions.pod:1072 ../fish/guestfish-actions.pod:1076
889 #: ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084
890 #: ../fish/guestfish-actions.pod:1092 ../fish/guestfish-actions.pod:1096
891 #: ../fish/guestfish-actions.pod:1100 ../fish/guestfish-actions.pod:1110
892 #: ../fish/guestfish-actions.pod:1114 ../fish/guestfish-actions.pod:1118
893 #: ../fish/guestfish-actions.pod:1208 ../fish/guestfish-actions.pod:1212
894 #: ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1222
895 #: ../fish/guestfish-actions.pod:1264 ../fish/guestfish-actions.pod:1268
896 #: ../fish/guestfish-actions.pod:1273 ../tools/virt-edit.pl:351
897 #: ../tools/virt-edit.pl:356 ../tools/virt-edit.pl:361
898 #: ../tools/virt-edit.pl:372 ../tools/virt-edit.pl:376
899 #: ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542
900 #: ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345
901 #: ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
906 #: ../src/guestfs.pod:390
908 "The kernel version that the command runs under will be different from what "
913 #: ../src/guestfs.pod:395
915 "If the command needs to communicate with daemons, then most likely they "
920 #: ../src/guestfs.pod:400
921 msgid "The command will be running in limited memory."
925 #: ../src/guestfs.pod:404
927 "The network may not be available unless you enable it (see L</"
928 "guestfs_set_network>)."
932 #: ../src/guestfs.pod:409
933 msgid "Only supports Linux guests (not Windows, BSD, etc)."
937 #: ../src/guestfs.pod:413
939 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
943 #: ../src/guestfs.pod:418
945 "For SELinux guests, you may need to enable SELinux and load policy first. "
946 "See L</SELINUX> in this manpage."
950 #: ../src/guestfs.pod:423
952 "I<Security:> It is not safe to run commands from untrusted, possibly "
953 "malicious guests. These commands may attempt to exploit your program by "
954 "sending unexpected output. They could also try to exploit the Linux kernel "
955 "or qemu provided by the libguestfs appliance. They could use the network "
956 "provided by the libguestfs appliance to bypass ordinary network partitions "
957 "and firewalls. They could use the elevated privileges or different SELinux "
958 "context of your program to their advantage."
962 #: ../src/guestfs.pod:432
964 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
965 "(a script which runs when the guest next boots normally), and to have this "
966 "script run the commands you want in the normal context of the running guest, "
967 "network security and so on. For information about other security issues, "
972 #: ../src/guestfs.pod:440
974 "The two main API calls to run commands are L</guestfs_command> and L</"
975 "guestfs_sh> (there are also variations)."
979 #: ../src/guestfs.pod:443
981 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
982 "shell globs, redirections, etc will work."
986 #: ../src/guestfs.pod:446
987 msgid "CONFIGURATION FILES"
988 msgstr "ФАЙЛИ НАЛАШТУВАННЯ"
991 #: ../src/guestfs.pod:448
993 "To read and write configuration files in Linux guest filesystems, we "
994 "strongly recommend using Augeas. For example, Augeas understands how to "
995 "read and write, say, a Linux shadow password file or X.org configuration "
996 "file, and so avoids you having to write that code."
1000 #: ../src/guestfs.pod:453
1002 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
1003 "document Augeas itself here because there is excellent documentation on the "
1004 "L<http://augeas.net/> website."
1008 #: ../src/guestfs.pod:457
1010 "If you don't want to use Augeas (you fool!) then try calling L</"
1011 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1016 #: ../src/guestfs.pod:461
1021 #: ../src/guestfs.pod:463
1023 "We support SELinux guests. To ensure that labeling happens correctly in "
1024 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1028 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1281 ../src/guestfs.pod:1412
1029 #: ../src/guestfs.pod:2441
1034 #: ../src/guestfs.pod:471
1035 msgid "Before launching, do:"
1039 #: ../src/guestfs.pod:473
1042 " guestfs_set_selinux (g, 1);\n"
1047 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1285 ../src/guestfs.pod:1416
1048 #: ../src/guestfs.pod:2466
1053 #: ../src/guestfs.pod:477
1055 "After mounting the guest's filesystem(s), load the policy. This is best "
1056 "done by running the L<load_policy(8)> command in the guest itself:"
1060 #: ../src/guestfs.pod:481
1063 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1068 #: ../src/guestfs.pod:483
1070 "(Older versions of C<load_policy> require you to specify the name of the "
1075 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1422
1080 #: ../src/guestfs.pod:488
1082 "Optionally, set the security context for the API. The correct security "
1083 "context to use can only be known by inspecting the guest. As an example:"
1087 #: ../src/guestfs.pod:492
1090 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1095 #: ../src/guestfs.pod:496
1096 msgid "This will work for running commands and editing existing files."
1100 #: ../src/guestfs.pod:498
1102 "When new files are created, you may need to label them explicitly, for "
1103 "example by running the external command C<restorecon pathname>."
1107 #: ../src/guestfs.pod:502
1112 #: ../src/guestfs.pod:504
1114 "Certain calls are affected by the current file mode creation mask (the "
1115 "\"umask\"). In particular ones which create files or directories, such as "
1116 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1117 "either the default mode that the file is created with or modifies the mode "
1122 #: ../src/guestfs.pod:510
1124 "The default umask is C<022>, so files are created with modes such as C<0644> "
1125 "and directories with C<0755>."
1129 #: ../src/guestfs.pod:513
1131 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1132 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1133 "guestfs_chmod> after creating each file or directory."
1137 #: ../src/guestfs.pod:517
1138 msgid "For more information about umask, see L<umask(2)>."
1142 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:765
1143 msgid "ENCRYPTED DISKS"
1147 #: ../src/guestfs.pod:521
1149 "Libguestfs allows you to access Linux guests which have been encrypted using "
1150 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1151 "standard. This includes nearly all whole disk encryption systems used by "
1152 "modern Linux guests."
1156 #: ../src/guestfs.pod:527
1158 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1159 "returns the string C<crypto_LUKS>)."
1163 #: ../src/guestfs.pod:530
1165 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1166 "will require the passphrase!"
1170 #: ../src/guestfs.pod:533
1172 "Opening a LUKS device creates a new device mapper device called C</dev/"
1173 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1174 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1175 "from and encrypted to the underlying block device respectively."
1179 #: ../src/guestfs.pod:539
1181 "LVM volume groups on the device can be made visible by calling L</"
1182 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1183 "(s) can now be mounted in the usual way."
1187 #: ../src/guestfs.pod:543
1189 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1190 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1191 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1192 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1193 "underlying encrypted block device)."
1197 #: ../src/guestfs.pod:550
1202 #: ../src/guestfs.pod:552
1204 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1205 "contains operating systems, an install CD or a live CD. (These APIs used to "
1206 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1207 "version 1.5.3 the most frequently used part of this library has been "
1208 "rewritten in C and moved into the core code)."
1212 #: ../src/guestfs.pod:559
1214 "Add all disks belonging to the unknown virtual machine and call L</"
1215 "guestfs_launch> in the usual way."
1219 #: ../src/guestfs.pod:562
1221 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1222 "and certain heuristics, and returns a list of operating systems that were "
1223 "found. An empty list means none were found. A single element is the root "
1224 "filesystem of the operating system. For dual- or multi-boot guests, "
1225 "multiple roots can be returned, each one corresponding to a separate "
1226 "operating system. (Multi-boot virtual machines are extremely rare in the "
1227 "world of virtualization, but since this scenario can happen, we have built "
1228 "libguestfs to deal with it.)"
1232 #: ../src/guestfs.pod:571
1234 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1235 "to get additional details about that operating system. For example, call L</"
1236 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1237 "Windows and Linux-based operating systems respectively."
1241 #: ../src/guestfs.pod:577
1243 "Un*x-like and Linux-based operating systems usually consist of several "
1244 "filesystems which are mounted at boot time (for example, a separate boot "
1245 "partition mounted on C</boot>). The inspection rules are able to detect how "
1246 "filesystems correspond to mount points. Call "
1247 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1248 "hash table like this example:"
1252 #: ../src/guestfs.pod:584
1255 " /boot => /dev/sda1\n"
1256 " / => /dev/vg_guest/lv_root\n"
1257 " /usr => /dev/vg_guest/lv_usr\n"
1262 #: ../src/guestfs.pod:588
1264 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1265 "filesystems as suggested."
1269 #: ../src/guestfs.pod:591
1271 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1272 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1276 #: ../src/guestfs.pod:595
1278 "Inspection currently only works for some common operating systems. "
1279 "Contributors are welcome to send patches for other operating systems that we "
1280 "currently cannot detect."
1284 #: ../src/guestfs.pod:599
1286 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1287 "for more details. The L</guestfs_inspect_os> function just ignores any "
1288 "encrypted devices."
1292 #: ../src/guestfs.pod:603
1294 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1295 "inspection and caches the results in the guest handle. Subsequent calls to "
1296 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1297 "read the disks. If you change the content of the guest disks, you can redo "
1298 "inspection by calling L</guestfs_inspect_os> again. (L</"
1299 "guestfs_inspect_list_applications> works a little differently from the other "
1300 "calls and does read the disks. See documentation for that function for "
1305 #: ../src/guestfs.pod:612
1306 msgid "INSPECTING INSTALL DISKS"
1310 #: ../src/guestfs.pod:614
1312 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1317 #: ../src/guestfs.pod:617
1319 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1320 "system, which currently can be C<installed> (a regular operating system) or "
1321 "C<installer> (some sort of install disk)."
1325 #: ../src/guestfs.pod:621
1327 "Further information is available about the operating system that can be "
1328 "installed using the regular inspection APIs like L</"
1329 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1333 #: ../src/guestfs.pod:626
1335 "Some additional information specific to installer disks is also available "
1336 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1337 "guestfs_inspect_is_multipart> calls."
1341 #: ../src/guestfs.pod:631
1342 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1346 #: ../src/guestfs.pod:633
1348 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1349 "ntfs-3g.org/> driver."
1353 #: ../src/guestfs.pod:636
1354 msgid "DRIVE LETTERS AND PATHS"
1358 #: ../src/guestfs.pod:638
1360 "DOS and Windows still use drive letters, and the filesystems are always "
1361 "treated as case insensitive by Windows itself, and therefore you might find "
1362 "a Windows configuration file referring to a path like C<c:\\windows"
1363 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1364 "might be referred to as C</WINDOWS/System32>."
1368 #: ../src/guestfs.pod:644
1370 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1371 "libguestfs to read the appropriate Windows Registry and configuration files, "
1372 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1377 #: ../src/guestfs.pod:649
1379 "Replacing backslash characters with forward slash characters is also outside "
1380 "the scope of libguestfs, but something that you can easily do."
1384 #: ../src/guestfs.pod:652
1386 "Where we can help is in resolving the case insensitivity of paths. For "
1387 "this, call L</guestfs_case_sensitive_path>."
1391 #: ../src/guestfs.pod:655
1392 msgid "ACCESSING THE WINDOWS REGISTRY"
1396 #: ../src/guestfs.pod:657
1398 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1399 "files, through the library C<hivex> which is part of the libguestfs project "
1400 "although ships as a separate tarball. You have to locate and download the "
1401 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1402 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1403 "reg(1)> for more help on this issue."
1407 #: ../src/guestfs.pod:665
1408 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1412 #: ../src/guestfs.pod:667
1414 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1415 "provide something which looks like a Linux symlink. The way it tries to do "
1416 "the rewriting is described here:"
1420 #: ../src/guestfs.pod:671
1422 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1425 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1429 #: ../src/guestfs.pod:673
1431 "The essential problem is that ntfs-3g simply does not have enough "
1432 "information to do a correct job. NTFS links can contain drive letters and "
1433 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1434 "It is almost certainly the case that libguestfs callers should ignore what "
1435 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1439 #: ../src/guestfs.pod:680
1441 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1442 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1443 "attribute, and read the raw reparse data from that (you can find the format "
1444 "documented in various places around the web)."
1448 #: ../src/guestfs.pod:685
1449 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1453 #: ../src/guestfs.pod:687
1455 "There are other useful extended attributes that can be read from ntfs-3g "
1456 "filesystems (using L</guestfs_getxattr>). See:"
1460 #: ../src/guestfs.pod:690
1462 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1464 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1467 #: ../src/guestfs.pod:692
1468 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1472 #: ../src/guestfs.pod:694
1474 "Although we don't want to discourage you from using the C API, we will "
1475 "mention here that the same API is also available in other languages."
1479 #: ../src/guestfs.pod:697
1481 "The API is broadly identical in all supported languages. This means that "
1482 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1483 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1484 "OCaml. In other words, a straightforward, predictable isomorphism between "
1489 #: ../src/guestfs.pod:703
1491 "Error messages are automatically transformed into exceptions if the language "
1496 #: ../src/guestfs.pod:706
1498 "We don't try to \"object orientify\" parts of the API in OO languages, "
1499 "although contributors are welcome to write higher level APIs above what we "
1500 "provide in their favourite languages if they wish."
1504 #: ../src/guestfs.pod:712
1509 #: ../src/guestfs.pod:714
1511 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1512 "identical to the C API. C++ classes and exceptions are not used."
1516 #: ../src/guestfs.pod:718
1521 #: ../src/guestfs.pod:720
1523 "The C# bindings are highly experimental. Please read the warnings at the "
1524 "top of C<csharp/Libguestfs.cs>."
1528 #: ../src/guestfs.pod:723
1533 #: ../src/guestfs.pod:725
1535 "This is the only language binding that is working but incomplete. Only "
1536 "calls which return simple integers have been bound in Haskell, and we are "
1537 "looking for help to complete this binding."
1541 #: ../src/guestfs.pod:729
1546 #: ../src/guestfs.pod:731
1548 "Full documentation is contained in the Javadoc which is distributed with "
1553 #: ../src/guestfs.pod:734
1558 #: ../src/guestfs.pod:736
1559 msgid "See L<guestfs-ocaml(3)>."
1560 msgstr "Див. L<guestfs-ocaml(3)>."
1563 #: ../src/guestfs.pod:738
1568 #: ../src/guestfs.pod:740
1569 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1570 msgstr "Див. L<guestfs-perl(3)> та L<Sys::Guestfs(3)>."
1573 #: ../src/guestfs.pod:742
1578 #: ../src/guestfs.pod:744
1580 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1581 "the php-libguestfs package for your distribution."
1585 #: ../src/guestfs.pod:747
1586 msgid "The PHP binding only works correctly on 64 bit machines."
1590 #: ../src/guestfs.pod:749
1595 #: ../src/guestfs.pod:751
1596 msgid "See L<guestfs-python(3)>."
1597 msgstr "Див. L<guestfs-python(3)>."
1600 #: ../src/guestfs.pod:753
1605 #: ../src/guestfs.pod:755
1606 msgid "See L<guestfs-ruby(3)>."
1607 msgstr "Див. L<guestfs-ruby(3)>."
1610 #: ../src/guestfs.pod:757
1611 msgid "B<shell scripts>"
1612 msgstr "B<скрипти оболонки>"
1615 #: ../src/guestfs.pod:759
1616 msgid "See L<guestfish(1)>."
1617 msgstr "Див. L<guestfish(1)>."
1620 #: ../src/guestfs.pod:763
1621 msgid "LIBGUESTFS GOTCHAS"
1625 #: ../src/guestfs.pod:765
1627 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1628 "system [...] that works in the way it is documented but is counterintuitive "
1629 "and almost invites mistakes.\""
1633 #: ../src/guestfs.pod:769
1635 "Since we developed libguestfs and the associated tools, there are several "
1636 "things we would have designed differently, but are now stuck with for "
1637 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1638 "release, you can expect these to change. Beware of them."
1642 #: ../src/guestfs.pod:777
1643 msgid "Autosync / forgetting to sync."
1647 #: ../src/guestfs.pod:779
1649 "When modifying a filesystem from C or another language, you B<must> unmount "
1650 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1651 "libguestfs handle. You can also call:"
1655 #: ../src/guestfs.pod:783
1658 " guestfs_set_autosync (g, 1);\n"
1663 #: ../src/guestfs.pod:785
1665 "to have the unmount/sync done automatically for you when the handle 'g' is "
1666 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1670 #: ../src/guestfs.pod:789
1672 "If you forget to do this, then it is entirely possible that your changes "
1673 "won't be written out, or will be partially written, or (very rarely) that "
1674 "you'll get disk corruption."
1678 #: ../src/guestfs.pod:793
1680 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1681 "guestfish scripts that forget to sync will work just fine, which can make "
1682 "this very puzzling if you are trying to debug a problem."
1686 #: ../src/guestfs.pod:797
1688 "Update: Autosync is enabled by default for all API users starting from "
1689 "libguestfs 1.5.24."
1693 #: ../src/guestfs.pod:800
1694 msgid "Mount option C<-o sync> should not be the default."
1698 #: ../src/guestfs.pod:802
1700 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1701 "However C<-o sync> does not add any reliability benefit, but does have a "
1702 "very large performance impact."
1706 #: ../src/guestfs.pod:806
1708 "The work around is to use L</guestfs_mount_options> and set the mount "
1709 "options that you actually want to use."
1713 #: ../src/guestfs.pod:809
1714 msgid "Read-only should be the default."
1718 #: ../src/guestfs.pod:811
1720 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1721 "specify I<--rw> if you want to make changes to the image."
1725 #: ../src/guestfs.pod:814
1726 msgid "This would reduce the potential to corrupt live VM images."
1730 #: ../src/guestfs.pod:816
1732 "Note that many filesystems change the disk when you just mount and unmount, "
1733 "even if you didn't perform any writes. You need to use L</"
1734 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1738 #: ../src/guestfs.pod:820
1739 msgid "guestfish command line is hard to use."
1743 #: ../src/guestfs.pod:822
1745 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1746 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1747 "exist, so it fails. In earlier versions of guestfish the error message was "
1748 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1749 "we should have used C<guestfish -c command> to run commands."
1753 #: ../src/guestfs.pod:829
1754 msgid "guestfish megabyte modifiers don't work right on all commands"
1758 #: ../src/guestfs.pod:831
1760 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1761 "other modifiers). What guestfish actually does is to multiply the number "
1762 "part by the modifier part and pass the result to the C API. However this "
1763 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1764 "expecting some other unit (eg. megabytes)."
1768 #: ../src/guestfs.pod:838
1769 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1773 #: ../src/guestfs.pod:840
1776 " lvcreate LV VG 100M\n"
1781 #: ../src/guestfs.pod:842
1783 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1784 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1785 "megabytes * megabytes) logical volume. The error message you get from this "
1786 "is also a little obscure."
1790 #: ../src/guestfs.pod:847
1792 "This could be fixed in the generator by specially marking parameters and "
1793 "return values which take bytes or other units."
1797 #: ../src/guestfs.pod:850
1798 msgid "Ambiguity between devices and paths"
1802 #: ../src/guestfs.pod:852
1804 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1805 "sdb2>) and a similar pathname. A file might just happen to be called "
1806 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1810 #: ../src/guestfs.pod:857
1812 "In the current API we usually resolve this ambiguity by having two separate "
1813 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1814 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1815 "detecting if the path supplied begins with C</dev/>."
1819 #: ../src/guestfs.pod:863
1821 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1822 "make paths/devices into structured names. One way to do this would be to "
1823 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1824 "aspect of grub. Another way would be to use a structured type, equivalent "
1825 "to this OCaml type:"
1829 #: ../src/guestfs.pod:869
1832 " type path = Path of string | Device of int | Partition of int * int\n"
1837 #: ../src/guestfs.pod:871
1838 msgid "which would allow you to pass arguments like:"
1842 #: ../src/guestfs.pod:873
1845 " Path \"/foo/bar\"\n"
1846 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1847 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1848 " Path \"/dev/sdb2\" (* not a device *)\n"
1853 #: ../src/guestfs.pod:878
1855 "As you can see there are still problems to resolve even with this "
1856 "representation. Also consider how it might work in guestfish."
1860 #: ../src/guestfs.pod:883
1861 msgid "PROTOCOL LIMITS"
1865 #: ../src/guestfs.pod:885
1867 "Internally libguestfs uses a message-based protocol to pass API calls and "
1868 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1869 "plenty more detail about this). The maximum message size used by the "
1870 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1871 "aware of this limit. The API calls which may be affected are individually "
1872 "documented, with a link back to this section of the documentation."
1876 #: ../src/guestfs.pod:893
1878 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1879 "a simple string. Because this string is at some point internally encoded as "
1880 "a message, the maximum size that it can return is slightly under 4 MB. If "
1881 "the requested file is larger than this then you will get an error."
1885 #: ../src/guestfs.pod:899
1887 "In order to transfer large files into and out of the guest filesystem, you "
1888 "need to use particular calls that support this. The sections L</UPLOADING> "
1889 "and L</DOWNLOADING> document how to do this."
1893 #: ../src/guestfs.pod:903
1895 "You might also consider mounting the disk image using our FUSE filesystem "
1896 "support (L<guestmount(1)>)."
1900 #: ../src/guestfs.pod:906
1901 msgid "KEYS AND PASSPHRASES"
1905 #: ../src/guestfs.pod:908
1907 "Certain libguestfs calls take a parameter that contains sensitive key "
1908 "material, passed in as a C string."
1912 #: ../src/guestfs.pod:911
1914 "In the future we would hope to change the libguestfs implementation so that "
1915 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1916 "swap. However this is I<not> done at the moment, because of the complexity "
1917 "of such an implementation."
1921 #: ../src/guestfs.pod:916
1923 "Therefore you should be aware that any key parameter you pass to libguestfs "
1924 "might end up being written out to the swap partition. If this is a concern, "
1925 "scrub the swap partition or don't use libguestfs on encrypted devices."
1929 #: ../src/guestfs.pod:921
1930 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1934 #: ../src/guestfs.pod:923
1936 "All high-level libguestfs actions are synchronous. If you want to use "
1937 "libguestfs asynchronously then you must create a thread."
1941 #: ../src/guestfs.pod:926
1943 "Only use the handle from a single thread. Either use the handle exclusively "
1944 "from one thread, or provide your own mutex so that two threads cannot issue "
1945 "calls on the same handle at the same time."
1949 #: ../src/guestfs.pod:930
1951 "See the graphical program guestfs-browser for one possible architecture for "
1952 "multithreaded programs using libvirt and libguestfs."
1956 #: ../src/guestfs.pod:933
1961 #: ../src/guestfs.pod:935
1963 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1968 #: ../src/guestfs.pod:938
1970 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1971 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1975 #: ../src/guestfs.pod:941
1977 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1978 "to change the directories that libguestfs will search in. The value is a "
1979 "colon-separated list of paths. The current directory is I<not> searched "
1980 "unless the path contains an empty element or C<.>. For example "
1981 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1982 "then C</usr/lib/guestfs>."
1986 #: ../src/guestfs.pod:948
1987 msgid "QEMU WRAPPERS"
1991 #: ../src/guestfs.pod:950
1993 "If you want to compile your own qemu, run qemu from a non-standard location, "
1994 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1999 #: ../src/guestfs.pod:954
2001 "There is one important rule to remember: you I<must C<exec qemu>> as the "
2002 "last command in the shell script (so that qemu replaces the shell and "
2003 "becomes the direct child of the libguestfs-using program). If you don't do "
2004 "this, then the qemu process won't be cleaned up correctly."
2008 #: ../src/guestfs.pod:959
2010 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2015 #: ../src/guestfs.pod:962
2019 " qemudir=/home/rjones/d/qemu\n"
2020 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2025 #: ../src/guestfs.pod:966
2027 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2028 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2033 #: ../src/guestfs.pod:970
2036 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2041 #: ../src/guestfs.pod:972
2043 "Note that libguestfs also calls qemu with the -help and -version options in "
2044 "order to determine features."
2048 #: ../src/guestfs.pod:975
2049 msgid "ATTACHING TO RUNNING DAEMONS"
2053 #: ../src/guestfs.pod:977
2055 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2056 "babies. Use with caution."
2060 #: ../src/guestfs.pod:980
2062 "I<Note (2):> This section explains how to attach to a running daemon from a "
2063 "low level perspective. For most users, simply using virt tools such as "
2064 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2068 #: ../src/guestfs.pod:984
2069 msgid "Using guestfs_set_attach_method"
2073 #: ../src/guestfs.pod:986
2075 "By calling L</guestfs_set_attach_method> you can change how the library "
2076 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2077 "ARCHITECTURE> for some background)."
2081 #: ../src/guestfs.pod:990
2083 "The normal attach method is C<appliance>, where a small appliance is created "
2084 "containing the daemon, and then the library connects to this."
2088 #: ../src/guestfs.pod:993
2090 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2091 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2092 "daemon over the Unix domain socket."
2096 #: ../src/guestfs.pod:997
2098 "The normal use for this is to connect to a running virtual machine that "
2099 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2100 "files inside the live virtual machine."
2104 #: ../src/guestfs.pod:1001
2105 msgid "Using guestfs_add_domain with live flag"
2109 #: ../src/guestfs.pod:1003
2111 "L</guestfs_add_domain> provides some help for getting the correct attach "
2112 "method. If you pass the C<live> option to this function, then (if the "
2113 "virtual machine is running) it will examine the libvirt XML looking for a "
2114 "virtio-serial channel to connect to:"
2118 #: ../src/guestfs.pod:1009
2125 " <channel type='unix'>\n"
2126 " <source mode='bind' path='/path/to/socket'/>\n"
2127 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2136 #: ../src/guestfs.pod:1021
2138 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2139 "method to C<unix:/path/to/socket>."
2143 #: ../src/guestfs.pod:1024
2145 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2146 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2147 "to attach to and modify live virtual machines."
2151 #: ../src/guestfs.pod:1028
2153 "The virtual machine needs to have been set up beforehand so that it has the "
2154 "virtio-serial channel and so that guestfsd is running inside it."
2158 #: ../src/guestfs.pod:1032
2159 msgid "ABI GUARANTEE"
2163 #: ../src/guestfs.pod:1034
2165 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2166 "actions as outlined in this section. Although we will deprecate some "
2167 "actions, for example if they get replaced by newer calls, we will keep the "
2168 "old actions forever. This allows you the developer to program in confidence "
2169 "against the libguestfs API."
2173 #: ../src/guestfs.pod:1040
2174 msgid "BLOCK DEVICE NAMING"
2178 #: ../src/guestfs.pod:1042
2180 "In the kernel there is now quite a profusion of schemata for naming block "
2181 "devices (in this context, by I<block device> I mean a physical or virtual "
2182 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2183 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2184 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2185 "for the old IDE driver (particularly for SATA devices) those devices also "
2186 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2187 "paravirtualized drivers. This has created several different naming systems, "
2188 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2192 #: ../src/guestfs.pod:1054
2194 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2195 "Linux kernel to access block devices. We can run a variety of appliances "
2196 "based on a variety of Linux kernels."
2200 #: ../src/guestfs.pod:1058
2202 "This causes a problem for libguestfs because many API calls use device or "
2203 "partition names. Working scripts and the recipe (example) scripts that we "
2204 "make available over the internet could fail if the naming scheme changes."
2208 #: ../src/guestfs.pod:1063
2210 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2211 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2212 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2213 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2217 #: ../src/guestfs.pod:1069
2219 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2220 "L</guestfs_list_partitions> and similar calls return the true names of the "
2221 "devices and partitions as known to the appliance."
2225 #: ../src/guestfs.pod:1074
2226 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2230 #: ../src/guestfs.pod:1076
2232 "Usually this translation is transparent. However in some (very rare) cases "
2233 "you may need to know the exact algorithm. Such cases include where you use "
2234 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2235 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2239 #: ../src/guestfs.pod:1082
2241 "The algorithm is applied only to I<parameters> which are known to be either "
2242 "device or partition names. Return values from functions such as L</"
2243 "guestfs_list_devices> are never changed."
2247 #: ../src/guestfs.pod:1090
2248 msgid "Is the string a parameter which is a device or partition name?"
2252 #: ../src/guestfs.pod:1094
2253 msgid "Does the string begin with C</dev/sd>?"
2257 #: ../src/guestfs.pod:1098
2259 "Does the named device exist? If so, we use that device. However if I<not> "
2260 "then we continue with this algorithm."
2264 #: ../src/guestfs.pod:1103
2265 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2269 #: ../src/guestfs.pod:1105
2270 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2274 #: ../src/guestfs.pod:1107
2275 msgid "If that named device exists, use it. If not, continue."
2279 #: ../src/guestfs.pod:1111
2280 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2284 #: ../src/guestfs.pod:1113
2285 msgid "If that named device exists, use it. If not, return an error."
2289 #: ../src/guestfs.pod:1117
2290 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2294 #: ../src/guestfs.pod:1119
2296 "Although the standard naming scheme and automatic translation is useful for "
2297 "simple programs and guestfish scripts, for larger programs it is best not to "
2298 "rely on this mechanism."
2302 #: ../src/guestfs.pod:1123
2304 "Where possible for maximum future portability programs using libguestfs "
2305 "should use these future-proof techniques:"
2309 #: ../src/guestfs.pod:1130
2311 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2312 "device names, and then use those names directly."
2316 #: ../src/guestfs.pod:1133
2318 "Since those device names exist by definition, they will never be translated."
2322 #: ../src/guestfs.pod:1138
2324 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2325 "filesystem labels."
2329 #: ../src/guestfs.pod:1143
2334 #: ../src/guestfs.pod:1145
2336 "This section discusses security implications of using libguestfs, "
2337 "particularly with untrusted or malicious guests or disk images."
2341 #: ../src/guestfs.pod:1148
2342 msgid "GENERAL SECURITY CONSIDERATIONS"
2346 #: ../src/guestfs.pod:1150
2348 "Be careful with any files or data that you download from a guest (by "
2349 "\"download\" we mean not just the L</guestfs_download> command but any "
2350 "command that reads files, filenames, directories or anything else from a "
2351 "disk image). An attacker could manipulate the data to fool your program "
2352 "into doing the wrong thing. Consider cases such as:"
2356 #: ../src/guestfs.pod:1160
2357 msgid "the data (file etc) not being present"
2361 #: ../src/guestfs.pod:1164
2362 msgid "being present but empty"
2366 #: ../src/guestfs.pod:1168
2367 msgid "being much larger than normal"
2371 #: ../src/guestfs.pod:1172
2372 msgid "containing arbitrary 8 bit data"
2376 #: ../src/guestfs.pod:1176
2377 msgid "being in an unexpected character encoding"
2381 #: ../src/guestfs.pod:1180
2382 msgid "containing homoglyphs."
2386 #: ../src/guestfs.pod:1184
2387 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2391 #: ../src/guestfs.pod:1186
2393 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2394 "(VFS) module can sometimes be escalated into exploits by deliberately "
2395 "creating a malicious, malformed filesystem. These exploits are very severe "
2396 "for two reasons. Firstly there are very many filesystem drivers in the "
2397 "kernel, and many of them are infrequently used and not much developer "
2398 "attention has been paid to the code. Linux userspace helps potential "
2399 "crackers by detecting the filesystem type and automatically choosing the "
2400 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2401 "the administrator. Secondly, a kernel-level exploit is like a local root "
2402 "exploit (worse in some ways), giving immediate and total access to the "
2403 "system right down to the hardware level."
2407 #: ../src/guestfs.pod:1199
2409 "That explains why you should never mount a filesystem from an untrusted "
2410 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2411 "inside a qemu virtual machine, usually running as a non-root user. The "
2412 "attacker would need to write a filesystem which first exploited the kernel, "
2413 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2414 "the libguestfs protocol, and finally to be as serious as the host kernel "
2415 "exploit it would need to escalate its privileges to root. This multi-step "
2416 "escalation, performed by a static piece of data, is thought to be extremely "
2417 "hard to do, although we never say 'never' about security issues."
2421 #: ../src/guestfs.pod:1210
2423 "In any case callers can reduce the attack surface by forcing the filesystem "
2424 "type when mounting (use L</guestfs_mount_vfs>)."
2428 #: ../src/guestfs.pod:1213
2429 msgid "PROTOCOL SECURITY"
2433 #: ../src/guestfs.pod:1215
2435 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2436 "defined upper message size. However a program that uses libguestfs must "
2437 "also take care - for example you can write a program that downloads a binary "
2438 "from a disk image and executes it locally, and no amount of protocol "
2439 "security will save you from the consequences."
2443 #: ../src/guestfs.pod:1221
2444 msgid "INSPECTION SECURITY"
2448 #: ../src/guestfs.pod:1223
2450 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2451 "directly from the guest, and these could contain any 8 bit data. Callers "
2452 "should be careful to escape these before printing them to a structured file "
2453 "(for example, use HTML escaping if creating a web page)."
2457 #: ../src/guestfs.pod:1229
2459 "Guest configuration may be altered in unusual ways by the administrator of "
2460 "the virtual machine, and may not reflect reality (particularly for untrusted "
2461 "or actively malicious guests). For example we parse the hostname from "
2462 "configuration files like C</etc/sysconfig/network> that we find in the "
2463 "guest, but the guest administrator can easily manipulate these files to "
2464 "provide the wrong hostname."
2468 #: ../src/guestfs.pod:1237
2470 "The inspection API parses guest configuration using two external libraries: "
2471 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2472 "designed to be robust in the face of malicious data, although denial of "
2473 "service attacks are still possible, for example with oversized configuration "
2478 #: ../src/guestfs.pod:1243
2479 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2483 #: ../src/guestfs.pod:1245
2485 "Be very cautious about running commands from the guest. By running a "
2486 "command in the guest, you are giving CPU time to a binary that you do not "
2487 "control, under the same user account as the library, albeit wrapped in qemu "
2488 "virtualization. More information and alternatives can be found in the "
2489 "section L</RUNNING COMMANDS>."
2493 #: ../src/guestfs.pod:1251
2494 msgid "CVE-2010-3851"
2495 msgstr "CVE-2010-3851"
2498 #: ../src/guestfs.pod:1253
2499 msgid "https://bugzilla.redhat.com/642934"
2500 msgstr "https://bugzilla.redhat.com/642934"
2503 #: ../src/guestfs.pod:1255
2505 "This security bug concerns the automatic disk format detection that qemu "
2506 "does on disk images."
2510 #: ../src/guestfs.pod:1258
2512 "A raw disk image is just the raw bytes, there is no header. Other disk "
2513 "images like qcow2 contain a special header. Qemu deals with this by looking "
2514 "for one of the known headers, and if none is found then assuming the disk "
2515 "image must be raw."
2519 #: ../src/guestfs.pod:1263
2521 "This allows a guest which has been given a raw disk image to write some "
2522 "other header. At next boot (or when the disk image is accessed by "
2523 "libguestfs) qemu would do autodetection and think the disk image format was, "
2524 "say, qcow2 based on the header written by the guest."
2528 #: ../src/guestfs.pod:1268
2530 "This in itself would not be a problem, but qcow2 offers many features, one "
2531 "of which is to allow a disk image to refer to another image (called the "
2532 "\"backing disk\"). It does this by placing the path to the backing disk "
2533 "into the qcow2 header. This path is not validated and could point to any "
2534 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2535 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2536 "control of the attacker."
2540 #: ../src/guestfs.pod:1276
2542 "In libguestfs this is rather hard to exploit except under two circumstances:"
2546 #: ../src/guestfs.pod:1283
2547 msgid "You have enabled the network or have opened the disk in write mode."
2551 #: ../src/guestfs.pod:1287
2553 "You are also running untrusted code from the guest (see L</RUNNING "
2558 #: ../src/guestfs.pod:1292
2560 "The way to avoid this is to specify the expected disk format when adding "
2561 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2562 "should always do this if the disk is raw format, and it's a good idea for "
2567 #: ../src/guestfs.pod:1297
2569 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2570 "format is fetched from libvirt and passed through."
2574 #: ../src/guestfs.pod:1300
2576 "For libguestfs tools, use the I<--format> command line parameter as "
2581 #: ../src/guestfs.pod:1303
2582 msgid "CONNECTION MANAGEMENT"
2586 #: ../src/guestfs.pod:1305
2591 #: ../src/guestfs.pod:1307
2593 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2594 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2595 "handle and release all resources used."
2599 #: ../src/guestfs.pod:1311
2601 "For information on using multiple handles and threads, see the section L</"
2602 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2606 #: ../src/guestfs.pod:1314
2607 msgid "guestfs_create"
2611 #: ../src/guestfs.pod:1316
2614 " guestfs_h *guestfs_create (void);\n"
2619 #: ../src/guestfs.pod:1318
2620 msgid "Create a connection handle."
2624 #: ../src/guestfs.pod:1320
2626 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2627 "on the handle at least once."
2631 #: ../src/guestfs.pod:1323
2633 "This function returns a non-NULL pointer to a handle on success or NULL on "
2638 #: ../src/guestfs.pod:1326
2639 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2643 #: ../src/guestfs.pod:1328
2645 "You may also want to configure error handling for the handle. See L</ERROR "
2646 "HANDLING> section below."
2650 #: ../src/guestfs.pod:1331
2651 msgid "guestfs_close"
2655 #: ../src/guestfs.pod:1333
2658 " void guestfs_close (guestfs_h *g);\n"
2663 #: ../src/guestfs.pod:1335
2664 msgid "This closes the connection handle and frees up all resources used."
2668 #: ../src/guestfs.pod:1337
2669 msgid "ERROR HANDLING"
2670 msgstr "ОБРОБКА ПОМИЛОК"
2673 #: ../src/guestfs.pod:1339
2675 "API functions can return errors. For example, almost all functions that "
2676 "return C<int> will return C<-1> to indicate an error."
2680 #: ../src/guestfs.pod:1342
2682 "Additional information is available for errors: an error message string and "
2683 "optionally an error number (errno) if the thing that failed was a system "
2688 #: ../src/guestfs.pod:1346
2690 "You can get at the additional information about the last error on the handle "
2691 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2692 "up an error handler with L</guestfs_set_error_handler>."
2696 #: ../src/guestfs.pod:1351
2698 "When the handle is created, a default error handler is installed which "
2699 "prints the error message string to C<stderr>. For small short-running "
2700 "command line programs it is sufficient to do:"
2704 #: ../src/guestfs.pod:1355
2707 " if (guestfs_launch (g) == -1)\n"
2708 " exit (EXIT_FAILURE);\n"
2713 #: ../src/guestfs.pod:1358
2715 "since the default error handler will ensure that an error message has been "
2716 "printed to C<stderr> before the program exits."
2720 #: ../src/guestfs.pod:1361
2722 "For other programs the caller will almost certainly want to install an "
2723 "alternate error handler or do error handling in-line like this:"
2727 #: ../src/guestfs.pod:1364
2730 " g = guestfs_create ();\n"
2735 #: ../src/guestfs.pod:1366
2738 " /* This disables the default behaviour of printing errors\n"
2740 " guestfs_set_error_handler (g, NULL, NULL);\n"
2745 #: ../src/guestfs.pod:1370
2748 " if (guestfs_launch (g) == -1) {\n"
2749 " /* Examine the error message and print it etc. */\n"
2750 " char *msg = guestfs_last_error (g);\n"
2751 " int errnum = guestfs_last_errno (g);\n"
2752 " fprintf (stderr, \"%s\\n\", msg);\n"
2759 #: ../src/guestfs.pod:1378
2761 "Out of memory errors are handled differently. The default action is to call "
2762 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
2763 "guestfs_set_out_of_memory_handler>."
2767 #: ../src/guestfs.pod:1382
2769 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2770 "because there is no handle if this happens there is no way to get additional "
2771 "error information. However L</guestfs_create> is supposed to be a "
2772 "lightweight operation which can only fail because of insufficient memory (it "
2773 "returns NULL in this case)."
2777 #: ../src/guestfs.pod:1388
2778 msgid "guestfs_last_error"
2782 #: ../src/guestfs.pod:1390
2785 " const char *guestfs_last_error (guestfs_h *g);\n"
2790 #: ../src/guestfs.pod:1392
2792 "This returns the last error message that happened on C<g>. If there has not "
2793 "been an error since the handle was created, then this returns C<NULL>."
2797 #: ../src/guestfs.pod:1396
2799 "The lifetime of the returned string is until the next error occurs, or L</"
2800 "guestfs_close> is called."
2804 #: ../src/guestfs.pod:1399
2805 msgid "guestfs_last_errno"
2809 #: ../src/guestfs.pod:1401
2812 " int guestfs_last_errno (guestfs_h *g);\n"
2817 #: ../src/guestfs.pod:1403
2818 msgid "This returns the last error number (errno) that happened on C<g>."
2822 #: ../src/guestfs.pod:1405
2823 msgid "If successful, an errno integer not equal to zero is returned."
2827 #: ../src/guestfs.pod:1407
2829 "If no error, this returns 0. This call can return 0 in three situations:"
2833 #: ../src/guestfs.pod:1414
2834 msgid "There has not been any error on the handle."
2838 #: ../src/guestfs.pod:1418
2840 "There has been an error but the errno was meaningless. This corresponds to "
2841 "the case where the error did not come from a failed system call, but for "
2842 "some other reason."
2846 #: ../src/guestfs.pod:1424
2848 "There was an error from a failed system call, but for some reason the errno "
2849 "was not captured and returned. This usually indicates a bug in libguestfs."
2853 #: ../src/guestfs.pod:1430
2855 "Libguestfs tries to convert the errno from inside the applicance into a "
2856 "corresponding errno for the caller (not entirely trivial: the appliance "
2857 "might be running a completely different operating system from the library "
2858 "and error numbers are not standardized across Un*xen). If this could not be "
2859 "done, then the error is translated to C<EINVAL>. In practice this should "
2860 "only happen in very rare circumstances."
2864 #: ../src/guestfs.pod:1438
2865 msgid "guestfs_set_error_handler"
2869 #: ../src/guestfs.pod:1440
2872 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2874 " const char *msg);\n"
2875 " void guestfs_set_error_handler (guestfs_h *g,\n"
2876 " guestfs_error_handler_cb cb,\n"
2882 #: ../src/guestfs.pod:1447
2884 "The callback C<cb> will be called if there is an error. The parameters "
2885 "passed to the callback are an opaque data pointer and the error message "
2890 #: ../src/guestfs.pod:1451
2892 "C<errno> is not passed to the callback. To get that the callback must call "
2893 "L</guestfs_last_errno>."
2897 #: ../src/guestfs.pod:1454
2899 "Note that the message string C<msg> is freed as soon as the callback "
2900 "function returns, so if you want to stash it somewhere you must make your "
2905 #: ../src/guestfs.pod:1458
2906 msgid "The default handler prints messages on C<stderr>."
2910 #: ../src/guestfs.pod:1460
2911 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2915 #: ../src/guestfs.pod:1462
2916 msgid "guestfs_get_error_handler"
2920 #: ../src/guestfs.pod:1464
2923 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2924 " void **opaque_rtn);\n"
2929 #: ../src/guestfs.pod:1467
2930 msgid "Returns the current error handler callback."
2934 #: ../src/guestfs.pod:1469
2935 msgid "guestfs_set_out_of_memory_handler"
2939 #: ../src/guestfs.pod:1471
2942 " typedef void (*guestfs_abort_cb) (void);\n"
2943 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2944 " guestfs_abort_cb);\n"
2949 #: ../src/guestfs.pod:1475
2951 "The callback C<cb> will be called if there is an out of memory situation. "
2952 "I<Note this callback must not return>."
2956 #: ../src/guestfs.pod:1478
2957 msgid "The default is to call L<abort(3)>."
2961 #: ../src/guestfs.pod:1480
2963 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2967 #: ../src/guestfs.pod:1483
2968 msgid "guestfs_get_out_of_memory_handler"
2972 #: ../src/guestfs.pod:1485
2975 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2980 #: ../src/guestfs.pod:1487
2981 msgid "This returns the current out of memory handler."
2985 #: ../src/guestfs.pod:1489
2990 #: ../src/guestfs.pod:1491 ../fish/guestfish.pod:1003
2995 #: ../src/guestfs.pod:1493
3000 #: ../src/guestfs.pod:1495
3005 #: ../src/guestfs.pod:1497
3006 msgid "AVAILABILITY"
3010 #: ../src/guestfs.pod:1499
3011 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3015 #: ../src/guestfs.pod:1501
3017 "Using L</guestfs_available> you can test availability of the following "
3018 "groups of functions. This test queries the appliance to see if the "
3019 "appliance you are currently using supports the functionality."
3023 #: ../src/guestfs.pod:1506
3024 msgid "@AVAILABILITY@"
3028 #: ../src/guestfs.pod:1508
3029 msgid "GUESTFISH supported COMMAND"
3033 #: ../src/guestfs.pod:1510
3035 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3036 "prints out the available groups and whether they are supported by this build "
3037 "of libguestfs. Note however that you have to do C<run> first."
3041 #: ../src/guestfs.pod:1515
3042 msgid "SINGLE CALLS AT COMPILE TIME"
3046 #: ../src/guestfs.pod:1517
3048 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3049 "function, such as:"
3053 #: ../src/guestfs.pod:1520
3056 " #define LIBGUESTFS_HAVE_DD 1\n"
3061 #: ../src/guestfs.pod:1522
3062 msgid "if L</guestfs_dd> is available."
3066 #: ../src/guestfs.pod:1524
3068 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3069 "function is available at compile time, we recommended using build tools such "
3070 "as autoconf or cmake. For example in autotools you could use:"
3074 #: ../src/guestfs.pod:1529
3077 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3078 " AC_CHECK_FUNCS([guestfs_dd])\n"
3083 #: ../src/guestfs.pod:1532
3085 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3090 #: ../src/guestfs.pod:1535
3091 msgid "SINGLE CALLS AT RUN TIME"
3095 #: ../src/guestfs.pod:1537
3097 "Testing at compile time doesn't guarantee that a function really exists in "
3098 "the library. The reason is that you might be dynamically linked against a "
3099 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3100 "This situation unfortunately results in a segmentation fault, which is a "
3101 "shortcoming of the C dynamic linking system itself."
3105 #: ../src/guestfs.pod:1544
3107 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3108 "in this example program (note that you still need the compile time check as "
3113 #: ../src/guestfs.pod:1548
3116 " #include <stdio.h>\n"
3117 " #include <stdlib.h>\n"
3118 " #include <unistd.h>\n"
3119 " #include <dlfcn.h>\n"
3120 " #include <guestfs.h>\n"
3125 #: ../src/guestfs.pod:1554
3130 " #ifdef LIBGUESTFS_HAVE_DD\n"
3132 " int has_function;\n"
3137 #: ../src/guestfs.pod:1560
3140 " /* Test if the function guestfs_dd is really available. */\n"
3141 " dl = dlopen (NULL, RTLD_LAZY);\n"
3143 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3144 " exit (EXIT_FAILURE);\n"
3146 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3152 #: ../src/guestfs.pod:1569
3155 " if (!has_function)\n"
3156 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3158 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3159 " /* Now it's safe to call\n"
3160 " guestfs_dd (g, \"foo\", \"bar\");\n"
3164 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3171 #: ../src/guestfs.pod:1582
3173 "You may think the above is an awful lot of hassle, and it is. There are "
3174 "other ways outside of the C linking system to ensure that this kind of "
3175 "incompatibility never arises, such as using package versioning:"
3179 #: ../src/guestfs.pod:1587
3182 " Requires: libguestfs >= 1.0.80\n"
3187 #: ../src/guestfs.pod:1589
3188 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3192 #: ../src/guestfs.pod:1591
3194 "A recent feature of the API is the introduction of calls which take optional "
3195 "arguments. In C these are declared 3 ways. The main way is as a call which "
3196 "takes variable arguments (ie. C<...>), as in this example:"
3200 #: ../src/guestfs.pod:1596
3203 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3208 #: ../src/guestfs.pod:1598
3210 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3211 "call with no optional arguments specified:"
3215 #: ../src/guestfs.pod:1601
3218 " guestfs_add_drive_opts (g, filename, -1);\n"
3223 #: ../src/guestfs.pod:1603
3224 msgid "With a single optional argument:"
3228 #: ../src/guestfs.pod:1605
3231 " guestfs_add_drive_opts (g, filename,\n"
3232 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3238 #: ../src/guestfs.pod:1609
3243 #: ../src/guestfs.pod:1611
3246 " guestfs_add_drive_opts (g, filename,\n"
3247 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3248 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3254 #: ../src/guestfs.pod:1616
3256 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3261 #: ../src/guestfs.pod:1619
3262 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3266 #: ../src/guestfs.pod:1621
3268 "The second variant has the same name with the suffix C<_va>, which works the "
3269 "same way but takes a C<va_list>. See the C manual for details. For the "
3270 "example function, this is declared:"
3274 #: ../src/guestfs.pod:1625
3277 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3283 #: ../src/guestfs.pod:1628
3284 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3288 #: ../src/guestfs.pod:1630
3290 "The third variant is useful where you need to construct these calls. You "
3291 "pass in a structure where you fill in the optional fields. The structure "
3292 "has a bitmask as the first element which you must set to indicate which "
3293 "fields you have filled in. For our example function the structure and call "
3298 #: ../src/guestfs.pod:1636
3301 " struct guestfs_add_drive_opts_argv {\n"
3302 " uint64_t bitmask;\n"
3304 " const char *format;\n"
3307 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3308 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3313 #: ../src/guestfs.pod:1645
3314 msgid "You could call it like this:"
3318 #: ../src/guestfs.pod:1647
3321 " struct guestfs_add_drive_opts_argv optargs = {\n"
3322 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3323 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3325 " .format = \"qcow2\"\n"
3331 #: ../src/guestfs.pod:1654
3334 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3339 #: ../src/guestfs.pod:1656 ../src/guestfs-actions.pod:11
3340 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:9
3341 #: ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532
3346 #: ../src/guestfs.pod:1662
3347 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3351 #: ../src/guestfs.pod:1667
3352 msgid "You do not need to fill in all fields of the structure."
3356 #: ../src/guestfs.pod:1671
3358 "There must be a one-to-one correspondence between fields of the structure "
3359 "that are filled in, and bits set in the bitmask."
3363 #: ../src/guestfs.pod:1676
3364 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3368 #: ../src/guestfs.pod:1678
3370 "In other languages, optional arguments are expressed in the way that is "
3371 "natural for that language. We refer you to the language-specific "
3372 "documentation for more details on that."
3376 #: ../src/guestfs.pod:1682
3377 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3381 #: ../src/guestfs.pod:1684
3382 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3386 #: ../src/guestfs.pod:1686
3388 "B<Note:> This section documents the generic event mechanism introduced in "
3389 "libguestfs 1.10, which you should use in new code if possible. The old "
3390 "functions C<guestfs_set_log_message_callback>, "
3391 "C<guestfs_set_subprocess_quit_callback>, "
3392 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3393 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3398 #: ../src/guestfs.pod:1694
3400 "Handles generate events when certain things happen, such as log messages "
3401 "being generated, progress messages during long-running operations, or the "
3402 "handle being closed. The API calls described below let you register a "
3403 "callback to be called when events happen. You can register multiple "
3404 "callbacks (for the same, different or overlapping sets of events), and "
3405 "individually remove callbacks. If callbacks are not removed, then they "
3406 "remain in force until the handle is closed."
3410 #: ../src/guestfs.pod:1702
3412 "In the current implementation, events are only generated synchronously: that "
3413 "means that events (and hence callbacks) can only happen while you are in the "
3414 "middle of making another libguestfs call. The callback is called in the "
3419 #: ../src/guestfs.pod:1707
3421 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3422 "unsigned integers, or a message buffer. Payloads are discussed later on."
3426 #: ../src/guestfs.pod:1711
3427 msgid "CLASSES OF EVENTS"
3431 #: ../src/guestfs.pod:1715
3432 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3436 #: ../src/guestfs.pod:1718
3438 "The callback function will be called while the handle is being closed "
3439 "(synchronously from L</guestfs_close>)."
3443 #: ../src/guestfs.pod:1721
3445 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3446 "handles that are open when the program exits. This means that this callback "
3447 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3448 "problems in higher-level languages (eg. if your HLL interpreter has already "
3449 "been cleaned up by the time this is called, and if your callback then jumps "
3450 "into some HLL function)."
3454 #: ../src/guestfs.pod:1728
3456 "If no callback is registered: the handle is closed without any callback "
3461 #: ../src/guestfs.pod:1731
3462 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3466 #: ../src/guestfs.pod:1734
3468 "The callback function will be called when the child process quits, either "
3469 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3470 "corresponds to a transition from any state to the CONFIG state)."
3474 #: ../src/guestfs.pod:1738 ../src/guestfs.pod:1747
3475 msgid "If no callback is registered: the event is ignored."
3479 #: ../src/guestfs.pod:1740
3480 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3484 #: ../src/guestfs.pod:1743
3486 "The callback function will be called when the child process becomes ready "
3487 "first time after it has been launched. (This corresponds to a transition "
3488 "from LAUNCHING to the READY state)."
3492 #: ../src/guestfs.pod:1749
3493 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3497 #: ../src/guestfs.pod:1752
3499 "Some long-running operations can generate progress messages. If this "
3500 "callback is registered, then it will be called each time a progress message "
3501 "is generated (usually two seconds after the operation started, and three "
3502 "times per second thereafter until it completes, although the frequency may "
3503 "change in future versions)."
3507 #: ../src/guestfs.pod:1758
3509 "The callback receives in the payload four unsigned 64 bit numbers which are "
3510 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3514 #: ../src/guestfs.pod:1761
3516 "The units of C<total> are not defined, although for some operations C<total> "
3517 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3518 "or megabytes), and C<position> may be the portion which has been transferred."
3522 #: ../src/guestfs.pod:1766
3523 msgid "The only defined and stable parts of the API are:"
3527 #: ../src/guestfs.pod:1772
3529 "The callback can display to the user some type of progress bar or indicator "
3530 "which shows the ratio of C<position>:C<total>."
3534 #: ../src/guestfs.pod:1777
3535 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3539 #: ../src/guestfs.pod:1781
3541 "If any progress notification is sent during a call, then a final progress "
3542 "notification is always sent when C<position> = C<total> (I<unless> the call "
3543 "fails with an error)."
3547 #: ../src/guestfs.pod:1785
3549 "This is to simplify caller code, so callers can easily set the progress "
3550 "indicator to \"100%\" at the end of the operation, without requiring special "
3551 "code to detect this case."
3555 #: ../src/guestfs.pod:1791
3557 "For some calls we are unable to estimate the progress of the call, but we "
3558 "can still generate progress messages to indicate activity. This is known as "
3559 "\"pulse mode\", and is directly supported by certain progress bar "
3560 "implementations (eg. GtkProgressBar)."
3564 #: ../src/guestfs.pod:1796
3566 "For these calls, zero or more progress messages are generated with "
3567 "C<position = 0> and C<total = 1>, followed by a final message with "
3568 "C<position = total = 1>."
3572 #: ../src/guestfs.pod:1800
3574 "As noted above, if the call fails with an error then the final message may "
3579 #: ../src/guestfs.pod:1805
3581 "The callback also receives the procedure number (C<proc_nr>) and serial "
3582 "number (C<serial>) of the call. These are only useful for debugging "
3583 "protocol issues, and the callback can normally ignore them. The callback "
3584 "may want to print these numbers in error messages or debugging messages."
3588 #: ../src/guestfs.pod:1811
3589 msgid "If no callback is registered: progress messages are discarded."
3593 #: ../src/guestfs.pod:1813
3594 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3598 #: ../src/guestfs.pod:1816
3600 "The callback function is called whenever a log message is generated by qemu, "
3601 "the appliance kernel, guestfsd (daemon), or utility programs."
3605 #: ../src/guestfs.pod:1819
3607 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3608 "guestfs_launch>) then additional debug messages are generated."
3612 #: ../src/guestfs.pod:1822 ../src/guestfs.pod:1836
3614 "If no callback is registered: the messages are discarded unless the verbose "
3615 "flag is set in which case they are sent to stderr. You can override the "
3616 "printing of verbose messages to stderr by setting up a callback."
3620 #: ../src/guestfs.pod:1827
3621 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3625 #: ../src/guestfs.pod:1830
3627 "The callback function is called whenever a log message is generated by the "
3628 "library part of libguestfs."
3632 #: ../src/guestfs.pod:1833
3634 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3635 "messages are generated."
3639 #: ../src/guestfs.pod:1841
3640 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3644 #: ../src/guestfs.pod:1844
3646 "The callback function is called whenever a trace message is generated. This "
3647 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3651 #: ../src/guestfs.pod:1847
3653 "If no callback is registered: the messages are sent to stderr. You can "
3654 "override the printing of trace messages to stderr by setting up a callback."
3658 #: ../src/guestfs.pod:1853
3659 msgid "guestfs_set_event_callback"
3663 #: ../src/guestfs.pod:1855
3666 " int guestfs_set_event_callback (guestfs_h *g,\n"
3667 " guestfs_event_callback cb,\n"
3668 " uint64_t event_bitmask,\n"
3675 #: ../src/guestfs.pod:1861
3677 "This function registers a callback (C<cb>) for all event classes in the "
3682 #: ../src/guestfs.pod:1864
3684 "For example, to register for all log message events, you could call this "
3685 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
3686 "To register a single callback for all possible classes of events, use "
3687 "C<GUESTFS_EVENT_ALL>."
3691 #: ../src/guestfs.pod:1870
3692 msgid "C<flags> should always be passed as 0."
3696 #: ../src/guestfs.pod:1872
3698 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
3699 "it for any purpose."
3703 #: ../src/guestfs.pod:1875
3705 "The return value is the event handle (an integer) which you can use to "
3706 "delete the callback (see below)."
3710 #: ../src/guestfs.pod:1878
3712 "If there is an error, this function returns C<-1>, and sets the error in the "
3713 "handle in the usual way (see L</guestfs_last_error> etc.)"
3717 #: ../src/guestfs.pod:1881
3719 "Callbacks remain in effect until they are deleted, or until the handle is "
3724 #: ../src/guestfs.pod:1884
3726 "In the case where multiple callbacks are registered for a particular event "
3727 "class, all of the callbacks are called. The order in which multiple "
3728 "callbacks are called is not defined."
3732 #: ../src/guestfs.pod:1888
3733 msgid "guestfs_delete_event_callback"
3737 #: ../src/guestfs.pod:1890
3740 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3745 #: ../src/guestfs.pod:1892
3747 "Delete a callback that was previously registered. C<event_handle> should be "
3748 "the integer that was returned by a previous call to "
3749 "C<guestfs_set_event_callback> on the same handle."
3753 #: ../src/guestfs.pod:1896
3754 msgid "guestfs_event_callback"
3758 #: ../src/guestfs.pod:1898
3761 " typedef void (*guestfs_event_callback) (\n"
3764 " uint64_t event,\n"
3765 " int event_handle,\n"
3767 " const char *buf, size_t buf_len,\n"
3768 " const uint64_t *array, size_t array_len);\n"
3773 #: ../src/guestfs.pod:1907
3775 "This is the type of the event callback function that you have to provide."
3779 #: ../src/guestfs.pod:1910
3781 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3782 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3783 "handle, and C<flags> which in the current API you should ignore."
3787 #: ../src/guestfs.pod:1914
3789 "The remaining parameters contain the event payload (if any). Each event may "
3790 "contain a payload, which usually relates to the event class, but for future "
3791 "proofing your code should be written to handle any payload for any event "
3796 #: ../src/guestfs.pod:1919
3798 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3799 "there is no message buffer). Note that this message buffer can contain "
3800 "arbitrary 8 bit data, including NUL bytes."
3804 #: ../src/guestfs.pod:1923
3806 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3807 "moment this is only used for progress messages."
3811 #: ../src/guestfs.pod:1926
3812 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3816 #: ../src/guestfs.pod:1928
3818 "One motivation for the generic event API was to allow GUI programs to "
3819 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3820 "unconditionally to C<stderr>."
3824 #: ../src/guestfs.pod:1932
3826 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3827 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3828 "messages are not events; you must capture error messages separately)."
3832 #: ../src/guestfs.pod:1937
3834 "Programs have to set up a callback to capture the classes of events of "
3839 #: ../src/guestfs.pod:1940
3843 " guestfs_set_event_callback\n"
3844 " (g, message_callback,\n"
3845 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3846 " GUESTFS_EVENT_TRACE,\n"
3847 " 0, NULL) == -1)\n"
3848 " if (eh == -1) {\n"
3849 " // handle error in the usual way\n"
3855 #: ../src/guestfs.pod:1950
3857 "The callback can then direct messages to the appropriate place. In this "
3858 "example, messages are directed to syslog:"
3862 #: ../src/guestfs.pod:1953
3866 " message_callback (\n"
3869 " uint64_t event,\n"
3870 " int event_handle,\n"
3872 " const char *buf, size_t buf_len,\n"
3873 " const uint64_t *array, size_t array_len)\n"
3875 " const int priority = LOG_USER|LOG_INFO;\n"
3876 " if (buf_len > 0)\n"
3877 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3883 #: ../src/guestfs.pod:1968
3884 msgid "PRIVATE DATA AREA"
3888 #: ../src/guestfs.pod:1970
3890 "You can attach named pieces of private data to the libguestfs handle, fetch "
3891 "them by name, and walk over them, for the lifetime of the handle. This is "
3892 "called the private data area and is only available from the C API."
3896 #: ../src/guestfs.pod:1975
3897 msgid "To attach a named piece of data, use the following call:"
3901 #: ../src/guestfs.pod:1977
3904 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3909 #: ../src/guestfs.pod:1979
3911 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3912 "pointer (which can be C<NULL>). Any previous item with the same name is "
3917 #: ../src/guestfs.pod:1983
3919 "You can use any C<key> you want, but names beginning with an underscore "
3920 "character are reserved for internal libguestfs purposes (for implementing "
3921 "language bindings). It is recommended to prefix the name with some unique "
3922 "string to avoid collisions with other users."
3926 #: ../src/guestfs.pod:1988
3927 msgid "To retrieve the pointer, use:"
3931 #: ../src/guestfs.pod:1990
3934 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3939 #: ../src/guestfs.pod:1992
3941 "This function returns C<NULL> if either no data is found associated with "
3942 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3947 #: ../src/guestfs.pod:1996
3949 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3950 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3951 "all. In particular, libguestfs does I<not> try to free the data when the "
3952 "handle is closed. If the data must be freed, then the caller must either "
3953 "free it before calling L</guestfs_close> or must set up a close callback to "
3954 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3958 #: ../src/guestfs.pod:2003
3959 msgid "To walk over all entries, use these two functions:"
3963 #: ../src/guestfs.pod:2005
3966 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3971 #: ../src/guestfs.pod:2007
3974 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3979 #: ../src/guestfs.pod:2009
3981 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3982 "not have any particular meaning -- keys are not returned in any defined "
3983 "order). A pointer to the key is returned in C<*key_rtn> and the "
3984 "corresponding data pointer is returned from the function. C<NULL> is "
3985 "returned if there are no keys stored in the handle."
3989 #: ../src/guestfs.pod:2015
3991 "C<guestfs_next_private> returns the next key, pointer pair. The return "
3992 "value of this function is also C<NULL> is there are no further entries to "
3997 #: ../src/guestfs.pod:2019
3998 msgid "Notes about walking over entries:"
4002 #: ../src/guestfs.pod:2025
4004 "You must not call C<guestfs_set_private> while walking over the entries."
4008 #: ../src/guestfs.pod:2030
4010 "The handle maintains an internal iterator which is reset when you call "
4011 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4012 "call C<guestfs_set_private>."
4016 #: ../src/guestfs.pod:2036
4017 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4021 #: ../src/guestfs.pod:2038
4024 " guestfs_set_private (g, key, NULL);\n"
4029 #: ../src/guestfs.pod:2040
4030 msgid "then that C<key> is not returned when walking."
4034 #: ../src/guestfs.pod:2044
4036 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4037 "C<guestfs_next_private> or C<guestfs_set_private>."
4041 #: ../src/guestfs.pod:2050
4043 "The following example code shows how to print all keys and data pointers "
4044 "that are associated with the handle C<g>:"
4048 #: ../src/guestfs.pod:2053
4051 " const char *key;\n"
4052 " void *data = guestfs_first_private (g, &key);\n"
4053 " while (data != NULL)\n"
4055 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4056 " data = guestfs_next_private (g, &key);\n"
4062 #: ../src/guestfs.pod:2061
4064 "More commonly you are only interested in keys that begin with an application-"
4065 "specific prefix C<foo_>. Modify the loop like so:"
4069 #: ../src/guestfs.pod:2064
4072 " const char *key;\n"
4073 " void *data = guestfs_first_private (g, &key);\n"
4074 " while (data != NULL)\n"
4076 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4077 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4078 " data = guestfs_next_private (g, &key);\n"
4084 #: ../src/guestfs.pod:2073
4086 "If you need to modify keys while walking, then you have to jump back to the "
4087 "beginning of the loop. For example, to delete all keys prefixed with "
4092 #: ../src/guestfs.pod:2077
4095 " const char *key;\n"
4098 " data = guestfs_first_private (g, &key);\n"
4099 " while (data != NULL)\n"
4101 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4103 " guestfs_set_private (g, key, NULL);\n"
4104 " /* note that 'key' pointer is now invalid, and so is\n"
4105 " the internal iterator */\n"
4108 " data = guestfs_next_private (g, &key);\n"
4114 #: ../src/guestfs.pod:2093
4116 "Note that the above loop is guaranteed to terminate because the keys are "
4117 "being deleted, but other manipulations of keys within the loop might not "
4118 "terminate unless you also maintain an indication of which keys have been "
4123 #: ../src/guestfs.pod:2098 ../src/guestfs.pod:2103
4128 #: ../src/guestfs.pod:2100
4130 "<!-- old anchor for the next section --> <a name="
4131 "\"state_machine_and_low_level_event_api\"/>"
4133 "<!-- old anchor for the next section --> <a name="
4134 "\"state_machine_and_low_level_event_api\"/>"
4137 #: ../src/guestfs.pod:2105
4138 msgid "ARCHITECTURE"
4139 msgstr "АРХІТЕКТУРА"
4142 #: ../src/guestfs.pod:2107
4144 "Internally, libguestfs is implemented by running an appliance (a special "
4145 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4146 "process of the main program."
4150 #: ../src/guestfs.pod:2111
4153 " ___________________\n"
4155 " | main program |\n"
4157 " | | child process / appliance\n"
4158 " | | __________________________\n"
4160 " +-------------------+ RPC | +-----------------+ |\n"
4161 " | libguestfs <--------------------> guestfsd | |\n"
4162 " | | | +-----------------+ |\n"
4163 " \\___________________/ | | Linux kernel | |\n"
4164 " | +--^--------------+ |\n"
4165 " \\_________|________________/\n"
4171 " \\______________/\n"
4176 #: ../src/guestfs.pod:2131
4178 "The library, linked to the main program, creates the child process and hence "
4179 "the appliance in the L</guestfs_launch> function."
4183 #: ../src/guestfs.pod:2134
4185 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4186 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4187 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4188 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4189 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4190 "attached to the qemu process which translates device access by the "
4191 "appliance's Linux kernel into accesses to the image."
4195 #: ../src/guestfs.pod:2143
4197 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4198 "Although the disk image you are attached to might also be used by some "
4199 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4200 "care if both libguestfs's qemu process and your virtual machine are trying "
4201 "to update the disk image at the same time, since these usually results in "
4202 "massive disk corruption)."
4206 #: ../src/guestfs.pod:2150
4207 msgid "STATE MACHINE"
4208 msgstr "СКІНЧЕННИЙ АВТОМАТ"
4211 #: ../src/guestfs.pod:2152
4212 msgid "libguestfs uses a state machine to model the child process:"
4216 #: ../src/guestfs.pod:2154
4228 " / | \\ \\ guestfs_launch\n"
4229 " / | _\\__V______\n"
4231 " / | | LAUNCHING |\n"
4232 " / | \\___________/\n"
4234 " / | guestfs_launch\n"
4236 " ______ / __|____V\n"
4237 " / \\ ------> / \\\n"
4238 " | BUSY | | READY |\n"
4239 " \\______/ <------ \\________/\n"
4244 #: ../src/guestfs.pod:2176
4246 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4247 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4248 "(3) alternating between READY and BUSY as commands are issued to, and "
4249 "carried out by, the child process."
4253 #: ../src/guestfs.pod:2181
4255 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4256 "asynchronously at any time (eg. due to some internal error), and that causes "
4257 "the state to transition back to CONFIG."
4261 #: ../src/guestfs.pod:2185
4263 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4264 "issued when in the CONFIG state."
4268 #: ../src/guestfs.pod:2188
4270 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4271 "L</guestfs_launch> blocks until the child process is READY to accept "
4272 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4273 "moves the state from CONFIG to LAUNCHING while it is running."
4277 #: ../src/guestfs.pod:2194
4279 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4280 "state. These API calls block waiting for the command to be carried out (ie. "
4281 "the state to transition to BUSY and then back to READY). There are no non-"
4282 "blocking versions, and no way to issue more than one command per handle at "
4287 #: ../src/guestfs.pod:2200
4289 "Finally, the child process sends asynchronous messages back to the main "
4290 "program, such as kernel log messages. You can register a callback to "
4291 "receive these messages."
4295 #: ../src/guestfs.pod:2204
4300 #: ../src/guestfs.pod:2206
4301 msgid "COMMUNICATION PROTOCOL"
4305 #: ../src/guestfs.pod:2208
4307 "Don't rely on using this protocol directly. This section documents how it "
4308 "currently works, but it may change at any time."
4312 #: ../src/guestfs.pod:2211
4314 "The protocol used to talk between the library and the daemon running inside "
4315 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4316 "1014, RFC 1832, RFC 4506)."
4320 #: ../src/guestfs.pod:2215
4322 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4323 "this file is automatically generated)."
4327 #: ../src/guestfs.pod:2218
4329 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4330 "and C<FileOut> parameters, which are handled with very simple request/reply "
4331 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4332 "parameters, which use the same request and reply messages, but they may also "
4333 "be followed by files sent using a chunked encoding."
4337 #: ../src/guestfs.pod:2225
4338 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4342 #: ../src/guestfs.pod:2227
4343 msgid "For ordinary functions, the request message is:"
4347 #: ../src/guestfs.pod:2229
4350 " total length (header + arguments,\n"
4351 " but not including the length word itself)\n"
4352 " struct guestfs_message_header (encoded as XDR)\n"
4353 " struct guestfs_<foo>_args (encoded as XDR)\n"
4358 #: ../src/guestfs.pod:2234
4360 "The total length field allows the daemon to allocate a fixed size buffer "
4361 "into which it slurps the rest of the message. As a result, the total length "
4362 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4363 "effective size of any request is limited to somewhere under this size."
4367 #: ../src/guestfs.pod:2240
4369 "Note also that many functions don't take any arguments, in which case the "
4370 "C<guestfs_I<foo>_args> is completely omitted."
4374 #: ../src/guestfs.pod:2243
4376 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4377 "receiver knows what type of args structure to expect, or none at all."
4381 #: ../src/guestfs.pod:2247
4383 "For functions that take optional arguments, the optional arguments are "
4384 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4385 "arguments. A bitmask in the header indicates which optional arguments are "
4386 "meaningful. The bitmask is also checked to see if it contains bits set "
4387 "which the daemon does not know about (eg. if more optional arguments were "
4388 "added in a later version of the library), and this causes the call to be "
4393 #: ../src/guestfs.pod:2255
4394 msgid "The reply message for ordinary functions is:"
4398 #: ../src/guestfs.pod:2257
4401 " total length (header + ret,\n"
4402 " but not including the length word itself)\n"
4403 " struct guestfs_message_header (encoded as XDR)\n"
4404 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4409 #: ../src/guestfs.pod:2262
4411 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4412 "functions that return no formal return values."
4416 #: ../src/guestfs.pod:2265
4418 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4422 #: ../src/guestfs.pod:2268
4424 "In the case of an error, a flag is set in the header, and the reply message "
4425 "is slightly changed:"
4429 #: ../src/guestfs.pod:2271
4432 " total length (header + error,\n"
4433 " but not including the length word itself)\n"
4434 " struct guestfs_message_header (encoded as XDR)\n"
4435 " struct guestfs_message_error (encoded as XDR)\n"
4440 #: ../src/guestfs.pod:2276
4442 "The C<guestfs_message_error> structure contains the error message as a "
4447 #: ../src/guestfs.pod:2279
4448 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4452 #: ../src/guestfs.pod:2281
4454 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4455 "The normal request message is sent (see above). However this is followed by "
4456 "a sequence of file chunks."
4460 #: ../src/guestfs.pod:2285
4463 " total length (header + arguments,\n"
4464 " but not including the length word itself,\n"
4465 " and not including the chunks)\n"
4466 " struct guestfs_message_header (encoded as XDR)\n"
4467 " struct guestfs_<foo>_args (encoded as XDR)\n"
4468 " sequence of chunks for FileIn param #0\n"
4469 " sequence of chunks for FileIn param #1 etc.\n"
4474 #: ../src/guestfs.pod:2293
4475 msgid "The \"sequence of chunks\" is:"
4479 #: ../src/guestfs.pod:2295
4482 " length of chunk (not including length word itself)\n"
4483 " struct guestfs_chunk (encoded as XDR)\n"
4484 " length of chunk\n"
4485 " struct guestfs_chunk (encoded as XDR)\n"
4487 " length of chunk\n"
4488 " struct guestfs_chunk (with data.data_len == 0)\n"
4493 #: ../src/guestfs.pod:2303
4495 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4496 "is set in the final chunk to indicate either successful completion or early "
4501 #: ../src/guestfs.pod:2307
4503 "At time of writing there are no functions that have more than one FileIn "
4504 "parameter. However this is (theoretically) supported, by sending the "
4505 "sequence of chunks for each FileIn parameter one after another (from left to "
4510 #: ../src/guestfs.pod:2312
4512 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4513 "transfer. The library does this by sending a chunk with a special flag set "
4514 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4515 "RPC, does I<not> send any reply, and goes back to reading the next request."
4519 #: ../src/guestfs.pod:2318
4521 "The daemon may also cancel. It does this by writing a special word "
4522 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4523 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4524 "cancel chunk). The special word is chosen so that even if cancellation "
4525 "happens right at the end of the transfer (after the library has finished "
4526 "writing and has started listening for the reply), the \"spurious\" cancel "
4527 "flag will not be confused with the reply message."
4531 #: ../src/guestfs.pod:2327
4533 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4534 "limit), and also files where the size is not known in advance (eg. from "
4535 "pipes or sockets). However the chunks are rather small "
4536 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4537 "to keep much in memory."
4541 #: ../src/guestfs.pod:2333
4542 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4546 #: ../src/guestfs.pod:2335
4548 "The protocol for FileOut parameters is exactly the same as for FileIn "
4549 "parameters, but with the roles of daemon and library reversed."
4553 #: ../src/guestfs.pod:2338
4556 " total length (header + ret,\n"
4557 " but not including the length word itself,\n"
4558 " and not including the chunks)\n"
4559 " struct guestfs_message_header (encoded as XDR)\n"
4560 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4561 " sequence of chunks for FileOut param #0\n"
4562 " sequence of chunks for FileOut param #1 etc.\n"
4567 #: ../src/guestfs.pod:2346
4568 msgid "INITIAL MESSAGE"
4572 #: ../src/guestfs.pod:2348
4574 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4575 "which indicates that the guest and daemon is alive. This is what L</"
4576 "guestfs_launch> waits for."
4580 #: ../src/guestfs.pod:2352
4581 msgid "PROGRESS NOTIFICATION MESSAGES"
4585 #: ../src/guestfs.pod:2354
4587 "The daemon may send progress notification messages at any time. These are "
4588 "distinguished by the normal length word being replaced by "
4589 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4593 #: ../src/guestfs.pod:2358
4595 "The library turns them into progress callbacks (see L</"
4596 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
4601 #: ../src/guestfs.pod:2362
4603 "The daemon self-limits the frequency of progress messages it sends (see "
4604 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4609 #: ../src/guestfs.pod:2366
4610 msgid "LIBGUESTFS VERSION NUMBERS"
4614 #: ../src/guestfs.pod:2368
4616 "Since April 2010, libguestfs has started to make separate development and "
4617 "stable releases, along with corresponding branches in our git repository. "
4618 "These separate releases can be identified by version number:"
4622 #: ../src/guestfs.pod:2373
4625 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4626 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4632 " | `-------- sub-version\n"
4634 " `------ always '1' because we don't change the ABI\n"
4639 #: ../src/guestfs.pod:2384
4640 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4644 #: ../src/guestfs.pod:2386
4646 "As time passes we cherry pick fixes from the development branch and backport "
4647 "those into the stable branch, the effect being that the stable branch should "
4648 "get more stable and less buggy over time. So the stable releases are ideal "
4649 "for people who don't need new features but would just like the software to "
4654 #: ../src/guestfs.pod:2392
4655 msgid "Our criteria for backporting changes are:"
4659 #: ../src/guestfs.pod:2398
4661 "Documentation changes which don't affect any code are backported unless the "
4662 "documentation refers to a future feature which is not in stable."
4666 #: ../src/guestfs.pod:2404
4668 "Bug fixes which are not controversial, fix obvious problems, and have been "
4669 "well tested are backported."
4673 #: ../src/guestfs.pod:2409
4675 "Simple rearrangements of code which shouldn't affect how it works get "
4676 "backported. This is so that the code in the two branches doesn't get too "
4677 "far out of step, allowing us to backport future fixes more easily."
4681 #: ../src/guestfs.pod:2415
4683 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4684 "exceptional case: the new feature is required in order to implement an "
4685 "important bug fix."
4689 #: ../src/guestfs.pod:2421
4691 "A new stable branch starts when we think the new features in development are "
4692 "substantial and compelling enough over the current stable branch to warrant "
4693 "it. When that happens we create new stable and development versions 1.N.0 "
4694 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4695 "stable at this point, but by backporting fixes from development, that branch "
4696 "will stabilize over time."
4700 #: ../src/guestfs.pod:2429
4701 msgid "EXTENDING LIBGUESTFS"
4705 #: ../src/guestfs.pod:2431
4706 msgid "ADDING A NEW API ACTION"
4710 #: ../src/guestfs.pod:2433
4712 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4713 "documentation) are generated, and this makes it easy to extend the "
4718 #: ../src/guestfs.pod:2437
4719 msgid "To add a new API action there are two changes:"
4723 #: ../src/guestfs.pod:2443
4725 "You need to add a description of the call (name, parameters, return type, "
4726 "tests, documentation) to C<generator/generator_actions.ml>."
4730 #: ../src/guestfs.pod:2446
4732 "There are two sorts of API action, depending on whether the call goes "
4733 "through to the daemon in the appliance, or is serviced entirely by the "
4734 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4735 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4736 "an example of the latter, since a trace flag is maintained in the handle and "
4737 "all tracing is done on the library side."
4741 #: ../src/guestfs.pod:2454
4743 "Most new actions are of the first type, and get added to the "
4744 "C<daemon_functions> list. Each function has a unique procedure number used "
4745 "in the RPC protocol which is assigned to that action when we publish "
4746 "libguestfs and cannot be reused. Take the latest procedure number and "
4751 #: ../src/guestfs.pod:2460
4753 "For library-only actions of the second type, add to the "
4754 "C<non_daemon_functions> list. Since these functions are serviced by the "
4755 "library and do not travel over the RPC mechanism to the daemon, these "
4756 "functions do not need a procedure number, and so the procedure number is set "
4761 #: ../src/guestfs.pod:2468
4762 msgid "Implement the action (in C):"
4766 #: ../src/guestfs.pod:2470
4768 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4769 "C<daemon/> directory."
4773 #: ../src/guestfs.pod:2473
4775 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4776 "(note: double underscore) in the C<src/> directory."
4780 #: ../src/guestfs.pod:2476
4781 msgid "In either case, use another function as an example of what to do."
4785 #: ../src/guestfs.pod:2480
4786 msgid "After making these changes, use C<make> to compile."
4790 #: ../src/guestfs.pod:2482
4792 "Note that you don't need to implement the RPC, language bindings, manual "
4793 "pages or anything else. It's all automatically generated from the OCaml "
4798 #: ../src/guestfs.pod:2486
4799 msgid "ADDING TESTS FOR AN API ACTION"
4803 #: ../src/guestfs.pod:2488
4805 "You can supply zero or as many tests as you want per API call. The tests "
4806 "can either be added as part of the API description (C<generator/"
4807 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
4808 "into C<regressions/>. Note that adding a script to C<regressions/> is "
4809 "slower, so if possible use the first method."
4813 #: ../src/guestfs.pod:2494
4815 "The following describes the test environment used when you add an API test "
4816 "in C<generator_actions.ml>."
4820 #: ../src/guestfs.pod:2497
4821 msgid "The test environment has 4 block devices:"
4825 #: ../src/guestfs.pod:2501
4826 msgid "C</dev/sda> 500MB"
4830 #: ../src/guestfs.pod:2503
4831 msgid "General block device for testing."
4835 #: ../src/guestfs.pod:2505
4836 msgid "C</dev/sdb> 50MB"
4840 #: ../src/guestfs.pod:2507
4842 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4847 #: ../src/guestfs.pod:2510
4848 msgid "C</dev/sdc> 10MB"
4852 #: ../src/guestfs.pod:2512
4853 msgid "Used in a few tests where two block devices are needed."
4857 #: ../src/guestfs.pod:2514
4859 msgstr "C</dev/sdd>"
4862 #: ../src/guestfs.pod:2516
4863 msgid "ISO with fixed content (see C<images/test.iso>)."
4867 #: ../src/guestfs.pod:2520
4869 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4870 "appliance and block devices are reused between tests. So don't try testing "
4871 "L</guestfs_kill_subprocess> :-x"
4875 #: ../src/guestfs.pod:2524
4877 "Each test starts with an initial scenario, selected using one of the "
4878 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4879 "initialize the disks mentioned above in a particular way as documented in "
4880 "C<generator_types.ml>. You should not assume anything about the previous "
4881 "contents of other disks that are not initialized."
4885 #: ../src/guestfs.pod:2530
4887 "You can add a prerequisite clause to any individual test. This is a run-"
4888 "time check, which, if it fails, causes the test to be skipped. Useful if "
4889 "testing a command which might not work on all variations of libguestfs "
4890 "builds. A test that has prerequisite of C<Always> means to run "
4895 #: ../src/guestfs.pod:2536
4897 "In addition, packagers can skip individual tests by setting environment "
4898 "variables before running C<make check>."
4902 #: ../src/guestfs.pod:2539
4905 " SKIP_TEST_<CMD>_<NUM>=1\n"
4910 #: ../src/guestfs.pod:2541
4911 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4915 #: ../src/guestfs.pod:2543
4920 #: ../src/guestfs.pod:2545
4923 " SKIP_TEST_<CMD>=1\n"
4928 #: ../src/guestfs.pod:2547
4929 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4933 #: ../src/guestfs.pod:2549
4934 msgid "Packagers can run only certain tests by setting for example:"
4938 #: ../src/guestfs.pod:2551
4941 " TEST_ONLY=\"vfs_type zerofree\"\n"
4946 #: ../src/guestfs.pod:2553
4948 "See C<capitests/tests.c> for more details of how these environment variables "
4953 #: ../src/guestfs.pod:2556
4954 msgid "DEBUGGING NEW API ACTIONS"
4958 #: ../src/guestfs.pod:2558
4959 msgid "Test new actions work before submitting them."
4963 #: ../src/guestfs.pod:2560
4964 msgid "You can use guestfish to try out new commands."
4968 #: ../src/guestfs.pod:2562
4970 "Debugging the daemon is a problem because it runs inside a minimal "
4971 "environment. However you can fprintf messages in the daemon to stderr, and "
4972 "they will show up if you use C<guestfish -v>."
4976 #: ../src/guestfs.pod:2566
4977 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4981 #: ../src/guestfs.pod:2568
4983 "Our C source code generally adheres to some basic code-formatting "
4984 "conventions. The existing code base is not totally consistent on this "
4985 "front, but we do prefer that contributed code be formatted similarly. In "
4986 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4987 "indentation level, and other than that, follow the K&R style."
4991 #: ../src/guestfs.pod:2574
4993 "If you use Emacs, add the following to one of one of your start-up files (e."
4994 "g., ~/.emacs), to help ensure that you get indentation right:"
4998 #: ../src/guestfs.pod:2577
5001 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
5002 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
5003 " (add-hook 'find-file-hook\n"
5004 " '(lambda () (if (and buffer-file-name\n"
5005 " (string-match \"/libguestfs\\\\>\"\n"
5006 " (buffer-file-name))\n"
5007 " (not (string-equal mode-name \"Change Log\"))\n"
5008 " (not (string-equal mode-name \"Makefile\")))\n"
5009 " (setq indent-tabs-mode nil))))\n"
5014 #: ../src/guestfs.pod:2587
5017 " ;;; When editing C sources in libguestfs, use this style.\n"
5018 " (defun libguestfs-c-mode ()\n"
5019 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5021 " (c-set-style \"K&R\")\n"
5022 " (setq c-indent-level 2)\n"
5023 " (setq c-basic-offset 2))\n"
5024 " (add-hook 'c-mode-hook\n"
5025 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5026 " (buffer-file-name))\n"
5027 " (libguestfs-c-mode))))\n"
5032 #: ../src/guestfs.pod:2599
5033 msgid "Enable warnings when compiling (and fix any problems this finds):"
5037 #: ../src/guestfs.pod:2602
5040 " ./configure --enable-gcc-warnings\n"
5045 #: ../src/guestfs.pod:2604
5046 msgid "Useful targets are:"
5050 #: ../src/guestfs.pod:2606
5053 " make syntax-check # checks the syntax of the C code\n"
5054 " make check # runs the test suite\n"
5059 #: ../src/guestfs.pod:2609
5060 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5064 #: ../src/guestfs.pod:2611
5066 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5067 "which are used to do shell quoting."
5071 #: ../src/guestfs.pod:2616
5076 #: ../src/guestfs.pod:2618
5078 "Simple shell quoted string. Any spaces or other shell characters are "
5083 #: ../src/guestfs.pod:2621
5088 #: ../src/guestfs.pod:2623
5090 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5095 #: ../src/guestfs.pod:2628 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
5096 msgid "For example:"
5100 #: ../src/guestfs.pod:2630
5103 " asprintf (&cmd, \"cat %R\", path);\n"
5108 #: ../src/guestfs.pod:2632
5109 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5113 #: ../src/guestfs.pod:2634
5115 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5116 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5117 "they are not passed via the shell (instead, straight to exec). You probably "
5118 "want to use the C<sysroot_path()> function however."
5122 #: ../src/guestfs.pod:2640
5123 msgid "SUBMITTING YOUR NEW API ACTIONS"
5127 #: ../src/guestfs.pod:2642
5129 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5130 "libguestfs> and CC to L<rjones@redhat.com>."
5134 #: ../src/guestfs.pod:2646
5135 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5139 #: ../src/guestfs.pod:2648
5140 msgid "We support i18n (gettext anyhow) in the library."
5144 #: ../src/guestfs.pod:2650
5146 "However many messages come from the daemon, and we don't translate those at "
5147 "the moment. One reason is that the appliance generally has all locale files "
5148 "removed from it, because they take up a lot of space. So we'd have to readd "
5149 "some of those, as well as copying our PO files into the appliance."
5153 #: ../src/guestfs.pod:2656
5155 "Debugging messages are never translated, since they are intended for the "
5160 #: ../src/guestfs.pod:2659
5161 msgid "SOURCE CODE SUBDIRECTORIES"
5165 #: ../src/guestfs.pod:2663 ../src/guestfs-actions.pod:5806
5166 #: ../fish/guestfish-actions.pod:3900
5167 msgid "C<appliance>"
5168 msgstr "C<appliance>"
5171 #: ../src/guestfs.pod:2665
5172 msgid "The libguestfs appliance, build scripts and so on."
5176 #: ../src/guestfs.pod:2667
5177 msgid "C<capitests>"
5178 msgstr "C<capitests>"
5181 #: ../src/guestfs.pod:2669
5182 msgid "Automated tests of the C API."
5186 #: ../src/guestfs.pod:2671
5191 #: ../src/guestfs.pod:2673
5193 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5198 #: ../src/guestfs.pod:2676
5203 #: ../src/guestfs.pod:2678
5204 msgid "Outside contributions, experimental parts."
5208 #: ../src/guestfs.pod:2680
5213 #: ../src/guestfs.pod:2682
5215 "The daemon that runs inside the libguestfs appliance and carries out actions."
5219 #: ../src/guestfs.pod:2685
5224 #: ../src/guestfs.pod:2687
5225 msgid "L<virt-df(1)> command and documentation."
5229 #: ../src/guestfs.pod:2689
5231 msgstr "C<examples>"
5234 #: ../src/guestfs.pod:2691
5235 msgid "C API example code."
5236 msgstr "Код прикладів використання програмного інтерфейсу мовою C."
5239 #: ../src/guestfs.pod:2693
5244 #: ../src/guestfs.pod:2695
5246 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5247 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5248 "L<virt-tar-out(1)>."
5252 #: ../src/guestfs.pod:2699
5257 #: ../src/guestfs.pod:2701
5259 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5263 #: ../src/guestfs.pod:2703
5264 msgid "C<generator>"
5265 msgstr "C<generator>"
5268 #: ../src/guestfs.pod:2705
5270 "The crucially important generator, used to automatically generate large "
5271 "amounts of boilerplate C code for things like RPC and bindings."
5275 #: ../src/guestfs.pod:2708
5280 #: ../src/guestfs.pod:2710
5281 msgid "Files used by the test suite."
5285 #: ../src/guestfs.pod:2712
5286 msgid "Some \"phony\" guest images which we test against."
5290 #: ../src/guestfs.pod:2714
5291 msgid "C<inspector>"
5292 msgstr "C<inspector>"
5295 #: ../src/guestfs.pod:2716
5296 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5300 #: ../src/guestfs.pod:2718
5305 #: ../src/guestfs.pod:2720
5306 msgid "Logo used on the website. The fish is called Arthur by the way."
5310 #: ../src/guestfs.pod:2722
5315 #: ../src/guestfs.pod:2724
5316 msgid "M4 macros used by autoconf."
5320 #: ../src/guestfs.pod:2726
5325 #: ../src/guestfs.pod:2728
5326 msgid "Translations of simple gettext strings."
5327 msgstr "Переклади простих рядків gettext."
5330 #: ../src/guestfs.pod:2730
5335 #: ../src/guestfs.pod:2732
5337 "The build infrastructure and PO files for translations of manpages and POD "
5338 "files. Eventually this will be combined with the C<po> directory, but that "
5339 "is rather complicated."
5343 #: ../src/guestfs.pod:2736
5344 msgid "C<regressions>"
5345 msgstr "C<regressions>"
5348 #: ../src/guestfs.pod:2738
5349 msgid "Regression tests."
5350 msgstr "Тести на регресії."
5353 #: ../src/guestfs.pod:2740
5358 #: ../src/guestfs.pod:2742
5359 msgid "L<virt-rescue(1)> command and documentation."
5363 #: ../src/guestfs.pod:2744
5368 #: ../src/guestfs.pod:2746
5369 msgid "Source code to the C library."
5373 #: ../src/guestfs.pod:2748
5378 #: ../src/guestfs.pod:2750
5379 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5383 #: ../src/guestfs.pod:2752
5384 msgid "C<test-tool>"
5385 msgstr "C<test-tool>"
5388 #: ../src/guestfs.pod:2754
5390 "Test tool for end users to test if their qemu/kernel combination will work "
5395 #: ../src/guestfs.pod:2757
5400 #: ../src/guestfs.pod:2759
5405 #: ../src/guestfs.pod:2761
5410 #: ../src/guestfs.pod:2763
5415 #: ../src/guestfs.pod:2765
5420 #: ../src/guestfs.pod:2767
5425 #: ../src/guestfs.pod:2769
5430 #: ../src/guestfs.pod:2771
5435 #: ../src/guestfs.pod:2773
5436 msgid "Language bindings."
5437 msgstr "Прив’язки до мов програмування."
5440 #: ../src/guestfs.pod:2777 ../fish/guestfish.pod:1010
5441 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:476
5442 msgid "ENVIRONMENT VARIABLES"
5443 msgstr "ЗМІННІ СЕРЕДОВИЩА"
5446 #: ../src/guestfs.pod:2781 ../fish/guestfish.pod:1036
5447 msgid "LIBGUESTFS_APPEND"
5451 #: ../src/guestfs.pod:2783 ../fish/guestfish.pod:1038
5452 msgid "Pass additional options to the guest kernel."
5456 #: ../src/guestfs.pod:2785 ../fish/guestfish.pod:1040
5457 msgid "LIBGUESTFS_DEBUG"
5461 #: ../src/guestfs.pod:2787
5463 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5464 "effect as calling C<guestfs_set_verbose (g, 1)>."
5468 #: ../src/guestfs.pod:2790 ../fish/guestfish.pod:1045
5469 msgid "LIBGUESTFS_MEMSIZE"
5473 #: ../src/guestfs.pod:2792 ../fish/guestfish.pod:1047
5475 "Set the memory allocated to the qemu process, in megabytes. For example:"
5479 #: ../src/guestfs.pod:2795 ../fish/guestfish.pod:1050
5482 " LIBGUESTFS_MEMSIZE=700\n"
5487 #: ../src/guestfs.pod:2797 ../fish/guestfish.pod:1052
5488 msgid "LIBGUESTFS_PATH"
5492 #: ../src/guestfs.pod:2799
5494 "Set the path that libguestfs uses to search for a supermin appliance. See "
5495 "the discussion of paths in section L</PATH> above."
5499 #: ../src/guestfs.pod:2802 ../fish/guestfish.pod:1057
5500 msgid "LIBGUESTFS_QEMU"
5504 #: ../src/guestfs.pod:2804 ../fish/guestfish.pod:1059
5506 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5507 "which was found at compile time by the configure script is used."
5511 #: ../src/guestfs.pod:2808
5512 msgid "See also L</QEMU WRAPPERS> above."
5516 #: ../src/guestfs.pod:2810 ../fish/guestfish.pod:1063
5517 msgid "LIBGUESTFS_TRACE"
5521 #: ../src/guestfs.pod:2812
5523 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5524 "effect as calling C<guestfs_set_trace (g, 1)>."
5528 #: ../src/guestfs.pod:2815 ../fish/guestfish.pod:1072
5533 #: ../src/guestfs.pod:2817 ../fish/guestfish.pod:1074
5535 "Location of temporary directory, defaults to C</tmp> except for the cached "
5536 "supermin appliance which defaults to C</var/tmp>."
5540 #: ../src/guestfs.pod:2820 ../fish/guestfish.pod:1077
5542 "If libguestfs was compiled to use the supermin appliance then the real "
5543 "appliance is cached in this directory, shared between all handles belonging "
5544 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5545 "use in case C</var/tmp> is not large enough."
5549 #: ../src/guestfs.pod:2828 ../fish/guestfish.pod:1144
5550 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:267
5551 #: ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572
5552 #: ../tools/virt-resize.pl:1489 ../tools/virt-list-filesystems.pl:189
5553 #: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539
5554 #: ../tools/virt-list-partitions.pl:257
5556 msgstr "ТАКОЖ ПЕРЕГЛЯНЬТЕ"
5559 #: ../src/guestfs.pod:2830
5561 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
5562 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
5563 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
5564 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
5565 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
5566 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
5567 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
5571 #: ../src/guestfs.pod:2857
5573 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
5574 "(8)>, L<disktype(1)>."
5578 #: ../src/guestfs.pod:2864 ../tools/virt-win-reg.pl:587
5579 #: ../tools/virt-make-fs.pl:553
5584 #: ../src/guestfs.pod:2866
5585 msgid "To get a list of bugs against libguestfs use this link:"
5587 "Щоб переглянути список відомих вад у libguestfs, скористайтеся таким "
5591 #: ../src/guestfs.pod:2868
5593 "L<https://bugzilla.redhat.com/buglist.cgi?"
5594 "component=libguestfs&product=Virtualization+Tools>"
5596 "L<https://bugzilla.redhat.com/buglist.cgi?"
5597 "component=libguestfs&product=Virtualization+Tools>"
5600 #: ../src/guestfs.pod:2870
5601 msgid "To report a new bug against libguestfs use this link:"
5602 msgstr "Для звітування щодо вад у libguestfs скористайтеся цим посиланням:"
5605 #: ../src/guestfs.pod:2872
5607 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5608 "component=libguestfs&product=Virtualization+Tools>"
5610 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5611 "component=libguestfs&product=Virtualization+Tools>"
5614 #: ../src/guestfs.pod:2874
5615 msgid "When reporting a bug, please check:"
5619 #: ../src/guestfs.pod:2880
5620 msgid "That the bug hasn't been reported already."
5624 #: ../src/guestfs.pod:2884
5625 msgid "That you are testing a recent version."
5629 #: ../src/guestfs.pod:2888
5630 msgid "Describe the bug accurately, and give a way to reproduce it."
5634 #: ../src/guestfs.pod:2892
5636 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5641 #: ../src/guestfs.pod:2897 ../fish/guestfish.pod:1167
5642 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:278
5647 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1169
5648 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:280
5649 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5653 #: ../src/guestfs.pod:2901 ../fish/guestfish.pod:1171
5654 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:282
5655 #: ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602
5656 #: ../tools/virt-resize.pl:1514 ../tools/virt-list-filesystems.pl:206
5657 #: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568
5658 #: ../tools/virt-list-partitions.pl:273
5660 msgstr "АВТОРСЬКІ ПРАВА"
5663 #: ../src/guestfs.pod:2903 ../fish/guestfish.pod:1173
5664 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5668 #: ../src/guestfs.pod:2906
5670 "This library is free software; you can redistribute it and/or modify it "
5671 "under the terms of the GNU Lesser General Public License as published by the "
5672 "Free Software Foundation; either version 2 of the License, or (at your "
5673 "option) any later version."
5677 #: ../src/guestfs.pod:2911
5679 "This library is distributed in the hope that it will be useful, but WITHOUT "
5680 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5681 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5686 #: ../src/guestfs.pod:2916
5688 "You should have received a copy of the GNU Lesser General Public License "
5689 "along with this library; if not, write to the Free Software Foundation, "
5690 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5694 #: ../src/guestfs-actions.pod:1
5695 msgid "guestfs_add_cdrom"
5699 #: ../src/guestfs-actions.pod:3
5703 " guestfs_add_cdrom (guestfs_h *g,\n"
5704 " const char *filename);\n"
5709 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5710 msgid "This function adds a virtual CD-ROM disk image to the guest."
5714 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5715 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
5719 #: ../src/guestfs-actions.pod:17
5721 "This call checks for the existence of C<filename>. This stops you from "
5722 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5723 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5728 #: ../src/guestfs-actions.pod:24
5730 "If you just want to add an ISO file (often you use this as an efficient way "
5731 "to transfer large files into the guest), then you should probably use "
5732 "C<guestfs_add_drive_ro> instead."
5736 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
5737 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
5738 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
5739 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
5740 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436
5741 #: ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495
5742 #: ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541
5743 #: ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641
5744 #: ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670
5745 #: ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787
5746 #: ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815
5747 #: ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996
5748 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098
5749 #: ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135
5750 #: ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169
5751 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270
5752 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1337
5753 #: ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1477
5754 #: ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1717
5755 #: ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:2266
5756 #: ../src/guestfs-actions.pod:2410 ../src/guestfs-actions.pod:2471
5757 #: ../src/guestfs-actions.pod:2506 ../src/guestfs-actions.pod:3451
5758 #: ../src/guestfs-actions.pod:3466 ../src/guestfs-actions.pod:3491
5759 #: ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3660
5760 #: ../src/guestfs-actions.pod:3673 ../src/guestfs-actions.pod:3687
5761 #: ../src/guestfs-actions.pod:3702 ../src/guestfs-actions.pod:3738
5762 #: ../src/guestfs-actions.pod:3810 ../src/guestfs-actions.pod:3830
5763 #: ../src/guestfs-actions.pod:3847 ../src/guestfs-actions.pod:3870
5764 #: ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:3925
5765 #: ../src/guestfs-actions.pod:3944 ../src/guestfs-actions.pod:3963
5766 #: ../src/guestfs-actions.pod:3998 ../src/guestfs-actions.pod:4010
5767 #: ../src/guestfs-actions.pod:4046 ../src/guestfs-actions.pod:4062
5768 #: ../src/guestfs-actions.pod:4075 ../src/guestfs-actions.pod:4090
5769 #: ../src/guestfs-actions.pod:4107 ../src/guestfs-actions.pod:4200
5770 #: ../src/guestfs-actions.pod:4220 ../src/guestfs-actions.pod:4233
5771 #: ../src/guestfs-actions.pod:4284 ../src/guestfs-actions.pod:4302
5772 #: ../src/guestfs-actions.pod:4320 ../src/guestfs-actions.pod:4336
5773 #: ../src/guestfs-actions.pod:4350 ../src/guestfs-actions.pod:4364
5774 #: ../src/guestfs-actions.pod:4381 ../src/guestfs-actions.pod:4396
5775 #: ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:4474
5776 #: ../src/guestfs-actions.pod:4547 ../src/guestfs-actions.pod:4578
5777 #: ../src/guestfs-actions.pod:4597 ../src/guestfs-actions.pod:4616
5778 #: ../src/guestfs-actions.pod:4628 ../src/guestfs-actions.pod:4645
5779 #: ../src/guestfs-actions.pod:4658 ../src/guestfs-actions.pod:4673
5780 #: ../src/guestfs-actions.pod:4688 ../src/guestfs-actions.pod:4723
5781 #: ../src/guestfs-actions.pod:4738 ../src/guestfs-actions.pod:4758
5782 #: ../src/guestfs-actions.pod:4772 ../src/guestfs-actions.pod:4789
5783 #: ../src/guestfs-actions.pod:4838 ../src/guestfs-actions.pod:4875
5784 #: ../src/guestfs-actions.pod:4889 ../src/guestfs-actions.pod:4917
5785 #: ../src/guestfs-actions.pod:4934 ../src/guestfs-actions.pod:4952
5786 #: ../src/guestfs-actions.pod:5086 ../src/guestfs-actions.pod:5143
5787 #: ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5183
5788 #: ../src/guestfs-actions.pod:5215 ../src/guestfs-actions.pod:5281
5789 #: ../src/guestfs-actions.pod:5298 ../src/guestfs-actions.pod:5311
5790 #: ../src/guestfs-actions.pod:5325 ../src/guestfs-actions.pod:5614
5791 #: ../src/guestfs-actions.pod:5633 ../src/guestfs-actions.pod:5652
5792 #: ../src/guestfs-actions.pod:5664 ../src/guestfs-actions.pod:5676
5793 #: ../src/guestfs-actions.pod:5690 ../src/guestfs-actions.pod:5702
5794 #: ../src/guestfs-actions.pod:5716 ../src/guestfs-actions.pod:5732
5795 #: ../src/guestfs-actions.pod:5753 ../src/guestfs-actions.pod:5772
5796 #: ../src/guestfs-actions.pod:5791 ../src/guestfs-actions.pod:5821
5797 #: ../src/guestfs-actions.pod:5837 ../src/guestfs-actions.pod:5860
5798 #: ../src/guestfs-actions.pod:5878 ../src/guestfs-actions.pod:5897
5799 #: ../src/guestfs-actions.pod:5918 ../src/guestfs-actions.pod:5937
5800 #: ../src/guestfs-actions.pod:5954 ../src/guestfs-actions.pod:5982
5801 #: ../src/guestfs-actions.pod:6006 ../src/guestfs-actions.pod:6025
5802 #: ../src/guestfs-actions.pod:6049 ../src/guestfs-actions.pod:6068
5803 #: ../src/guestfs-actions.pod:6083 ../src/guestfs-actions.pod:6102
5804 #: ../src/guestfs-actions.pod:6139 ../src/guestfs-actions.pod:6162
5805 #: ../src/guestfs-actions.pod:6188 ../src/guestfs-actions.pod:6296
5806 #: ../src/guestfs-actions.pod:6417 ../src/guestfs-actions.pod:6429
5807 #: ../src/guestfs-actions.pod:6442 ../src/guestfs-actions.pod:6455
5808 #: ../src/guestfs-actions.pod:6477 ../src/guestfs-actions.pod:6490
5809 #: ../src/guestfs-actions.pod:6503 ../src/guestfs-actions.pod:6516
5810 #: ../src/guestfs-actions.pod:6531 ../src/guestfs-actions.pod:6590
5811 #: ../src/guestfs-actions.pod:6607 ../src/guestfs-actions.pod:6623
5812 #: ../src/guestfs-actions.pod:6639 ../src/guestfs-actions.pod:6656
5813 #: ../src/guestfs-actions.pod:6669 ../src/guestfs-actions.pod:6689
5814 #: ../src/guestfs-actions.pod:6725 ../src/guestfs-actions.pod:6739
5815 #: ../src/guestfs-actions.pod:6780 ../src/guestfs-actions.pod:6793
5816 #: ../src/guestfs-actions.pod:6811 ../src/guestfs-actions.pod:6845
5817 #: ../src/guestfs-actions.pod:6881 ../src/guestfs-actions.pod:7000
5818 #: ../src/guestfs-actions.pod:7018 ../src/guestfs-actions.pod:7032
5819 #: ../src/guestfs-actions.pod:7087 ../src/guestfs-actions.pod:7100
5820 #: ../src/guestfs-actions.pod:7145 ../src/guestfs-actions.pod:7178
5821 #: ../src/guestfs-actions.pod:7232 ../src/guestfs-actions.pod:7258
5822 #: ../src/guestfs-actions.pod:7324 ../src/guestfs-actions.pod:7343
5823 #: ../src/guestfs-actions.pod:7372
5824 msgid "This function returns 0 on success or -1 on error."
5828 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
5829 #: ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28
5830 #: ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
5832 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5837 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
5838 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1448
5839 #: ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:1965
5840 #: ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:7266
5841 #: ../src/guestfs-actions.pod:7435 ../fish/guestfish-actions.pod:31
5842 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
5843 #: ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1319
5844 #: ../fish/guestfish-actions.pod:1333 ../fish/guestfish-actions.pod:3000
5845 #: ../fish/guestfish-actions.pod:4858 ../fish/guestfish-actions.pod:4955
5847 "Deprecated functions will not be removed from the API, but the fact that "
5848 "they are deprecated indicates that there are problems with correct use of "
5853 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136
5854 #: ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1916
5855 #: ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2117
5856 #: ../src/guestfs-actions.pod:3453 ../src/guestfs-actions.pod:3473
5857 #: ../src/guestfs-actions.pod:4725 ../src/guestfs-actions.pod:5839
5858 #: ../src/guestfs-actions.pod:5956 ../src/guestfs-actions.pod:6070
5859 #: ../src/guestfs-actions.pod:6533 ../src/guestfs-actions.pod:6658
5860 #: ../src/guestfs-actions.pod:7180
5861 msgid "(Added in 0.3)"
5865 #: ../src/guestfs-actions.pod:41
5866 msgid "guestfs_add_domain"
5870 #: ../src/guestfs-actions.pod:43
5874 " guestfs_add_domain (guestfs_h *g,\n"
5875 " const char *dom,\n"
5881 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145
5882 #: ../src/guestfs-actions.pod:4435
5884 "You may supply a list of optional arguments to this call. Use zero or more "
5885 "of the following pairs of parameters, and terminate the list with C<-1> on "
5886 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5890 #: ../src/guestfs-actions.pod:53
5893 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5894 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5895 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5896 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
5901 #: ../src/guestfs-actions.pod:58
5903 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5904 "It works by connecting to libvirt, requesting the domain and domain XML from "
5905 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5910 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
5912 "The number of disks added is returned. This operation is atomic: if an "
5913 "error is returned, then no disks are added."
5917 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
5919 "This function does some minimal checks to make sure the libvirt domain is "
5920 "not running (unless C<readonly> is true). In a future version we will try "
5921 "to acquire the libvirt lock on each disk."
5925 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
5927 "Disks must be accessible locally. This often means that adding disks from a "
5928 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5929 "unless those disks are accessible via the same device path locally too."
5933 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
5935 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
5936 "libvirt.org/uri.html>). If this is not set then we connect to the default "
5937 "libvirt URI (or one set through an environment variable, see the libvirt "
5938 "documentation for full details)."
5942 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
5944 "The optional C<live> flag controls whether this call will try to connect to "
5945 "a running virtual machine C<guestfsd> process if it sees a suitable "
5946 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5947 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5948 "DAEMONS> for more information."
5952 #: ../src/guestfs-actions.pod:88
5954 "The other optional parameters are passed directly through to "
5955 "C<guestfs_add_drive_opts>."
5959 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
5960 #: ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687
5961 #: ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736
5962 #: ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315
5963 #: ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1877
5964 #: ../src/guestfs-actions.pod:1986 ../src/guestfs-actions.pod:2026
5965 #: ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2104
5966 #: ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2772
5967 #: ../src/guestfs-actions.pod:2793 ../src/guestfs-actions.pod:4861
5968 #: ../src/guestfs-actions.pod:4989 ../src/guestfs-actions.pod:5395
5969 #: ../src/guestfs-actions.pod:5421 ../src/guestfs-actions.pod:6766
5970 #: ../src/guestfs-actions.pod:7191 ../src/guestfs-actions.pod:7204
5971 #: ../src/guestfs-actions.pod:7217
5972 msgid "On error this function returns -1."
5976 #: ../src/guestfs-actions.pod:93
5977 msgid "(Added in 1.7.4)"
5981 #: ../src/guestfs-actions.pod:95
5982 msgid "guestfs_add_domain_va"
5986 #: ../src/guestfs-actions.pod:97
5990 " guestfs_add_domain_va (guestfs_h *g,\n"
5991 " const char *dom,\n"
5997 #: ../src/guestfs-actions.pod:102
5998 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6002 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
6003 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
6004 #: ../src/guestfs-actions.pod:4488 ../src/guestfs-actions.pod:4500
6005 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6009 #: ../src/guestfs-actions.pod:106
6010 msgid "guestfs_add_domain_argv"
6014 #: ../src/guestfs-actions.pod:108
6018 " guestfs_add_domain_argv (guestfs_h *g,\n"
6019 " const char *dom,\n"
6020 " const struct guestfs_add_domain_argv *optargs);\n"
6025 #: ../src/guestfs-actions.pod:113
6026 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6030 #: ../src/guestfs-actions.pod:117
6031 msgid "guestfs_add_drive"
6035 #: ../src/guestfs-actions.pod:119
6039 " guestfs_add_drive (guestfs_h *g,\n"
6040 " const char *filename);\n"
6045 #: ../src/guestfs-actions.pod:123
6047 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6048 "optional parameters, so the disk is added writable, with the format being "
6049 "detected automatically."
6053 #: ../src/guestfs-actions.pod:127
6055 "Automatic detection of the format opens you up to a potential security hole "
6056 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6057 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6058 "you should think about replacing calls to this function with calls to "
6059 "C<guestfs_add_drive_opts>, and specifying the format."
6063 #: ../src/guestfs-actions.pod:138
6064 msgid "guestfs_add_drive_opts"
6068 #: ../src/guestfs-actions.pod:140
6072 " guestfs_add_drive_opts (guestfs_h *g,\n"
6073 " const char *filename,\n"
6079 #: ../src/guestfs-actions.pod:150
6082 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6083 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6084 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6089 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6091 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6092 "The first time you call this function, the disk appears as C</dev/sda>, the "
6093 "second time as C</dev/sdb>, and so on."
6097 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6099 "You don't necessarily need to be root when using libguestfs. However you "
6100 "obviously do need sufficient permissions to access the filename for whatever "
6101 "operations you want to perform (ie. read access if you just want to read the "
6102 "image or write access if you want to modify the image)."
6106 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6107 msgid "This call checks that C<filename> exists."
6111 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4446
6112 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3011
6113 msgid "The optional arguments are:"
6117 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6119 msgstr "C<readonly>"
6122 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6124 "If true then the image is treated as read-only. Writes are still allowed, "
6125 "but they are stored in a temporary snapshot overlay which is discarded at "
6126 "the end. The disk that you add is not modified."
6130 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6135 #: ../src/guestfs-actions.pod:179
6137 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6138 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6139 "Possible formats include C<raw> and C<qcow2>."
6143 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6145 "Automatic detection of the format opens you up to a potential security hole "
6146 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6147 "RHBZ#642934. Specifying the format closes this security hole."
6151 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6156 #: ../src/guestfs-actions.pod:190
6158 "This rarely-used option lets you emulate the behaviour of the deprecated "
6159 "C<guestfs_add_drive_with_if> call (q.v.)"
6163 #: ../src/guestfs-actions.pod:197
6164 msgid "(Added in 1.5.23)"
6168 #: ../src/guestfs-actions.pod:199
6169 msgid "guestfs_add_drive_opts_va"
6173 #: ../src/guestfs-actions.pod:201
6177 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6178 " const char *filename,\n"
6184 #: ../src/guestfs-actions.pod:206
6185 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6189 #: ../src/guestfs-actions.pod:210
6190 msgid "guestfs_add_drive_opts_argv"
6194 #: ../src/guestfs-actions.pod:212
6198 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6199 " const char *filename,\n"
6200 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6205 #: ../src/guestfs-actions.pod:217
6206 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6210 #: ../src/guestfs-actions.pod:221
6211 msgid "guestfs_add_drive_ro"
6215 #: ../src/guestfs-actions.pod:223
6219 " guestfs_add_drive_ro (guestfs_h *g,\n"
6220 " const char *filename);\n"
6225 #: ../src/guestfs-actions.pod:227
6227 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6228 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6229 "disk is added read-only, with the format being detected automatically."
6233 #: ../src/guestfs-actions.pod:234
6234 msgid "(Added in 1.0.38)"
6238 #: ../src/guestfs-actions.pod:236
6239 msgid "guestfs_add_drive_ro_with_if"
6243 #: ../src/guestfs-actions.pod:238
6247 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6248 " const char *filename,\n"
6249 " const char *iface);\n"
6254 #: ../src/guestfs-actions.pod:243
6256 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6257 "QEMU interface emulation to use at run time."
6261 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6262 #: ../src/guestfs-actions.pod:2356
6263 msgid "(Added in 1.0.84)"
6267 #: ../src/guestfs-actions.pod:257
6268 msgid "guestfs_add_drive_with_if"
6272 #: ../src/guestfs-actions.pod:259
6276 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6277 " const char *filename,\n"
6278 " const char *iface);\n"
6283 #: ../src/guestfs-actions.pod:264
6285 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6286 "QEMU interface emulation to use at run time."
6290 #: ../src/guestfs-actions.pod:278
6291 msgid "guestfs_aug_clear"
6295 #: ../src/guestfs-actions.pod:280
6299 " guestfs_aug_clear (guestfs_h *g,\n"
6300 " const char *augpath);\n"
6305 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6307 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6308 "L<augtool(1)> C<clear> command."
6312 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2106
6313 msgid "(Added in 1.3.4)"
6317 #: ../src/guestfs-actions.pod:291
6318 msgid "guestfs_aug_close"
6322 #: ../src/guestfs-actions.pod:293
6326 " guestfs_aug_close (guestfs_h *g);\n"
6331 #: ../src/guestfs-actions.pod:296
6333 "Close the current Augeas handle and free up any resources used by it. After "
6334 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6335 "any other Augeas functions."
6339 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
6340 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
6341 #: ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438
6342 #: ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483
6343 #: ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511
6344 #: ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543
6345 #: ../src/guestfs-actions.pod:5472
6346 msgid "(Added in 0.7)"
6350 #: ../src/guestfs-actions.pod:305
6351 msgid "guestfs_aug_defnode"
6355 #: ../src/guestfs-actions.pod:307
6358 " struct guestfs_int_bool *\n"
6359 " guestfs_aug_defnode (guestfs_h *g,\n"
6360 " const char *name,\n"
6361 " const char *expr,\n"
6362 " const char *val);\n"
6367 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6369 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6373 #: ../src/guestfs-actions.pod:316
6375 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6376 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6377 "containing that single node."
6381 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6383 "On success this returns a pair containing the number of nodes in the "
6384 "nodeset, and a boolean flag if a node was created."
6388 #: ../src/guestfs-actions.pod:324
6390 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6391 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6395 #: ../src/guestfs-actions.pod:330
6396 msgid "guestfs_aug_defvar"
6400 #: ../src/guestfs-actions.pod:332
6404 " guestfs_aug_defvar (guestfs_h *g,\n"
6405 " const char *name,\n"
6406 " const char *expr);\n"
6411 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6413 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6414 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6418 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6420 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6421 "evaluates to something which is not a nodeset."
6425 #: ../src/guestfs-actions.pod:348
6426 msgid "guestfs_aug_get"
6430 #: ../src/guestfs-actions.pod:350
6434 " guestfs_aug_get (guestfs_h *g,\n"
6435 " const char *augpath);\n"
6440 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
6442 "Look up the value associated with C<path>. If C<path> matches exactly one "
6443 "node, the C<value> is returned."
6447 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857
6448 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935
6449 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054
6450 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201
6451 #: ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1354
6452 #: ../src/guestfs-actions.pod:1545 ../src/guestfs-actions.pod:1657
6453 #: ../src/guestfs-actions.pod:1820 ../src/guestfs-actions.pod:1837
6454 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1938
6455 #: ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:2129
6456 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2528
6457 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2724
6458 #: ../src/guestfs-actions.pod:2744 ../src/guestfs-actions.pod:2864
6459 #: ../src/guestfs-actions.pod:2895 ../src/guestfs-actions.pod:2919
6460 #: ../src/guestfs-actions.pod:2956 ../src/guestfs-actions.pod:3016
6461 #: ../src/guestfs-actions.pod:3039 ../src/guestfs-actions.pod:3060
6462 #: ../src/guestfs-actions.pod:3632 ../src/guestfs-actions.pod:3982
6463 #: ../src/guestfs-actions.pod:4152 ../src/guestfs-actions.pod:4262
6464 #: ../src/guestfs-actions.pod:5007 ../src/guestfs-actions.pod:5200
6465 #: ../src/guestfs-actions.pod:5370 ../src/guestfs-actions.pod:5548
6466 #: ../src/guestfs-actions.pod:5597 ../src/guestfs-actions.pod:6209
6467 #: ../src/guestfs-actions.pod:6225 ../src/guestfs-actions.pod:6242
6468 #: ../src/guestfs-actions.pod:6266 ../src/guestfs-actions.pod:6940
6469 #: ../src/guestfs-actions.pod:6959 ../src/guestfs-actions.pod:6977
6470 #: ../src/guestfs-actions.pod:7157 ../src/guestfs-actions.pod:7429
6472 "This function returns a string, or NULL on error. I<The caller must free "
6473 "the returned string after use>."
6477 #: ../src/guestfs-actions.pod:362
6478 msgid "guestfs_aug_init"
6482 #: ../src/guestfs-actions.pod:364
6486 " guestfs_aug_init (guestfs_h *g,\n"
6487 " const char *root,\n"
6493 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
6495 "Create a new Augeas handle for editing configuration files. If there was "
6496 "any previous Augeas handle associated with this guestfs session, then it is "
6501 #: ../src/guestfs-actions.pod:373
6502 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6506 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
6508 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6512 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
6514 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6515 "logical I<or> of the following integers:"
6519 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
6520 msgid "C<AUG_SAVE_BACKUP> = 1"
6521 msgstr "C<AUG_SAVE_BACKUP> = 1"
6524 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
6525 msgid "Keep the original file with a C<.augsave> extension."
6529 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
6530 msgid "C<AUG_SAVE_NEWFILE> = 2"
6531 msgstr "C<AUG_SAVE_NEWFILE> = 2"
6534 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
6536 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6537 "original. Overrides C<AUG_SAVE_BACKUP>."
6541 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
6542 msgid "C<AUG_TYPE_CHECK> = 4"
6543 msgstr "C<AUG_TYPE_CHECK> = 4"
6546 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
6547 msgid "Typecheck lenses (can be expensive)."
6551 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
6552 msgid "C<AUG_NO_STDINC> = 8"
6553 msgstr "C<AUG_NO_STDINC> = 8"
6556 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
6557 msgid "Do not use standard load path for modules."
6561 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
6562 msgid "C<AUG_SAVE_NOOP> = 16"
6563 msgstr "C<AUG_SAVE_NOOP> = 16"
6566 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
6567 msgid "Make save a no-op, just record what would have been changed."
6571 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
6572 msgid "C<AUG_NO_LOAD> = 32"
6573 msgstr "C<AUG_NO_LOAD> = 32"
6576 #: ../src/guestfs-actions.pod:408
6577 msgid "Do not load the tree in C<guestfs_aug_init>."
6581 #: ../src/guestfs-actions.pod:412
6582 msgid "To close the handle, you can call C<guestfs_aug_close>."
6586 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
6587 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6591 #: ../src/guestfs-actions.pod:420
6592 msgid "guestfs_aug_insert"
6596 #: ../src/guestfs-actions.pod:422
6600 " guestfs_aug_insert (guestfs_h *g,\n"
6601 " const char *augpath,\n"
6602 " const char *label,\n"
6608 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
6610 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6611 "or after C<path> (depending on the boolean flag C<before>)."
6615 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
6617 "C<path> must match exactly one existing node in the tree, and C<label> must "
6618 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6622 #: ../src/guestfs-actions.pod:440
6623 msgid "guestfs_aug_load"
6627 #: ../src/guestfs-actions.pod:442
6631 " guestfs_aug_load (guestfs_h *g);\n"
6636 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
6637 msgid "Load files into the tree."
6638 msgstr "Завантажити файли до ієрархії."
6641 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
6642 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6646 #: ../src/guestfs-actions.pod:454
6647 msgid "guestfs_aug_ls"
6651 #: ../src/guestfs-actions.pod:456
6655 " guestfs_aug_ls (guestfs_h *g,\n"
6656 " const char *augpath);\n"
6661 #: ../src/guestfs-actions.pod:460
6663 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6664 "sorting the resulting nodes into alphabetical order."
6668 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479
6669 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073
6670 #: ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1388
6671 #: ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:1510
6672 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:2201
6673 #: ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2236
6674 #: ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2303
6675 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2423
6676 #: ../src/guestfs-actions.pod:2682 ../src/guestfs-actions.pod:2973
6677 #: ../src/guestfs-actions.pod:3262 ../src/guestfs-actions.pod:3552
6678 #: ../src/guestfs-actions.pod:3614 ../src/guestfs-actions.pod:3719
6679 #: ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4822
6680 #: ../src/guestfs-actions.pod:5342 ../src/guestfs-actions.pod:5468
6681 #: ../src/guestfs-actions.pod:5582 ../src/guestfs-actions.pod:6282
6682 #: ../src/guestfs-actions.pod:6343 ../src/guestfs-actions.pod:6398
6683 #: ../src/guestfs-actions.pod:6544 ../src/guestfs-actions.pod:6568
6684 #: ../src/guestfs-actions.pod:7050 ../src/guestfs-actions.pod:7070
6685 #: ../src/guestfs-actions.pod:7117 ../src/guestfs-actions.pod:7282
6686 #: ../src/guestfs-actions.pod:7301 ../src/guestfs-actions.pod:7386
6687 #: ../src/guestfs-actions.pod:7405 ../src/guestfs-actions.pod:7451
6688 #: ../src/guestfs-actions.pod:7470
6690 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6691 ">), or NULL if there was an error. I<The caller must free the strings and "
6692 "the array after use>."
6696 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998
6697 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1426
6698 #: ../src/guestfs-actions.pod:3340 ../src/guestfs-actions.pod:3371
6699 #: ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:4015
6700 #: ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:4235
6701 #: ../src/guestfs-actions.pod:4398 ../src/guestfs-actions.pod:4826
6702 #: ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:5678
6703 #: ../src/guestfs-actions.pod:5692 ../src/guestfs-actions.pod:5704
6704 #: ../src/guestfs-actions.pod:6144 ../src/guestfs-actions.pod:6782
6705 #: ../src/guestfs-actions.pod:6795 ../src/guestfs-actions.pod:7034
6706 #: ../src/guestfs-actions.pod:7270
6707 msgid "(Added in 0.8)"
6711 #: ../src/guestfs-actions.pod:469
6712 msgid "guestfs_aug_match"
6716 #: ../src/guestfs-actions.pod:471
6720 " guestfs_aug_match (guestfs_h *g,\n"
6721 " const char *augpath);\n"
6726 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
6728 "Returns a list of paths which match the path expression C<path>. The "
6729 "returned paths are sufficiently qualified so that they match exactly one "
6730 "node in the current tree."
6734 #: ../src/guestfs-actions.pod:485
6735 msgid "guestfs_aug_mv"
6739 #: ../src/guestfs-actions.pod:487
6743 " guestfs_aug_mv (guestfs_h *g,\n"
6744 " const char *src,\n"
6745 " const char *dest);\n"
6750 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
6752 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6753 "C<dest> is overwritten if it exists."
6757 #: ../src/guestfs-actions.pod:499
6758 msgid "guestfs_aug_rm"
6762 #: ../src/guestfs-actions.pod:501
6766 " guestfs_aug_rm (guestfs_h *g,\n"
6767 " const char *augpath);\n"
6772 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
6773 msgid "Remove C<path> and all of its children."
6777 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
6778 msgid "On success this returns the number of entries which were removed."
6782 #: ../src/guestfs-actions.pod:513
6783 msgid "guestfs_aug_save"
6787 #: ../src/guestfs-actions.pod:515
6791 " guestfs_aug_save (guestfs_h *g);\n"
6796 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
6797 msgid "This writes all pending changes to disk."
6801 #: ../src/guestfs-actions.pod:520
6803 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6808 #: ../src/guestfs-actions.pod:527
6809 msgid "guestfs_aug_set"
6813 #: ../src/guestfs-actions.pod:529
6817 " guestfs_aug_set (guestfs_h *g,\n"
6818 " const char *augpath,\n"
6819 " const char *val);\n"
6824 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
6825 msgid "Set the value associated with C<path> to C<val>."
6829 #: ../src/guestfs-actions.pod:536
6831 "In the Augeas API, it is possible to clear a node by setting the value to "
6832 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6833 "this call. Instead you must use the C<guestfs_aug_clear> call."
6837 #: ../src/guestfs-actions.pod:545
6838 msgid "guestfs_available"
6842 #: ../src/guestfs-actions.pod:547
6846 " guestfs_available (guestfs_h *g,\n"
6847 " char *const *groups);\n"
6852 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
6854 "This command is used to check the availability of some groups of "
6855 "functionality in the appliance, which not all builds of the libguestfs "
6856 "appliance will be able to provide."
6860 #: ../src/guestfs-actions.pod:555
6862 "The libguestfs groups, and the functions that those groups correspond to, "
6863 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6864 "runtime by calling C<guestfs_available_all_groups>."
6868 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
6870 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
6871 "\"]> would check for the availability of the Linux inotify functions and "
6872 "Augeas (configuration file editing) functions."
6876 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
6877 msgid "The command returns no error if I<all> requested groups are available."
6881 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
6883 "It fails with an error if one or more of the requested groups is unavailable "
6888 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
6890 "If an unknown group name is included in the list of groups then an error is "
6895 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
6897 msgstr "I<Нотатки:>"
6900 #: ../src/guestfs-actions.pod:579
6901 msgid "You must call C<guestfs_launch> before calling this function."
6905 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
6907 "The reason is because we don't know what groups are supported by the "
6908 "appliance/daemon until it is running and can be queried."
6912 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
6914 "If a group of functions is available, this does not necessarily mean that "
6915 "they will work. You still have to check for errors when calling individual "
6916 "API functions even if they are available."
6920 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
6922 "It is usually the job of distro packagers to build complete functionality "
6923 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6924 "with all requirements satisfied, will support everything."
6928 #: ../src/guestfs-actions.pod:601
6930 "This call was added in version C<1.0.80>. In previous versions of "
6931 "libguestfs all you could do would be to speculatively execute a command to "
6932 "find out if the daemon implemented it. See also C<guestfs_version>."
6936 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
6937 msgid "(Added in 1.0.80)"
6941 #: ../src/guestfs-actions.pod:612
6942 msgid "guestfs_available_all_groups"
6946 #: ../src/guestfs-actions.pod:614
6950 " guestfs_available_all_groups (guestfs_h *g);\n"
6955 #: ../src/guestfs-actions.pod:617
6957 "This command returns a list of all optional groups that this daemon knows "
6958 "about. Note this returns both supported and unsupported groups. To find "
6959 "out which ones the daemon can actually support you have to call "
6960 "C<guestfs_available> on each member of the returned list."
6964 #: ../src/guestfs-actions.pod:623
6965 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6969 #: ../src/guestfs-actions.pod:629
6970 msgid "(Added in 1.3.15)"
6974 #: ../src/guestfs-actions.pod:631
6975 msgid "guestfs_base64_in"
6979 #: ../src/guestfs-actions.pod:633
6983 " guestfs_base64_in (guestfs_h *g,\n"
6984 " const char *base64file,\n"
6985 " const char *filename);\n"
6990 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
6992 "This command uploads base64-encoded data from C<base64file> to C<filename>."
6996 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
6997 msgid "(Added in 1.3.5)"
7001 #: ../src/guestfs-actions.pod:645
7002 msgid "guestfs_base64_out"
7006 #: ../src/guestfs-actions.pod:647
7010 " guestfs_base64_out (guestfs_h *g,\n"
7011 " const char *filename,\n"
7012 " const char *base64file);\n"
7017 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
7019 "This command downloads the contents of C<filename>, writing it out to local "
7020 "file C<base64file> encoded as base64."
7024 #: ../src/guestfs-actions.pod:659
7025 msgid "guestfs_blockdev_flushbufs"
7029 #: ../src/guestfs-actions.pod:661
7033 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7034 " const char *device);\n"
7039 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
7041 "This tells the kernel to flush internal buffers associated with C<device>."
7045 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685
7046 #: ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716
7047 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753
7048 #: ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785
7049 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813
7050 #: ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459
7051 #: ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478
7052 #: ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503
7053 #: ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522
7054 #: ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
7055 msgid "This uses the L<blockdev(8)> command."
7059 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689
7060 #: ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720
7061 #: ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757
7062 #: ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789
7063 #: ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
7064 msgid "(Added in 0.9.3)"
7068 #: ../src/guestfs-actions.pod:674
7069 msgid "guestfs_blockdev_getbsz"
7073 #: ../src/guestfs-actions.pod:676
7077 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7078 " const char *device);\n"
7083 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
7084 msgid "This returns the block size of a device."
7088 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782
7089 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
7091 "(Note this is different from both I<size in blocks> and I<filesystem block "
7096 #: ../src/guestfs-actions.pod:691
7097 msgid "guestfs_blockdev_getro"
7101 #: ../src/guestfs-actions.pod:693
7105 " guestfs_blockdev_getro (guestfs_h *g,\n"
7106 " const char *device);\n"
7111 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
7113 "Returns a boolean indicating if the block device is read-only (true if read-"
7114 "only, false if not)."
7118 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1409
7119 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1914
7120 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1997
7121 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2067
7122 #: ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2115
7123 #: ../src/guestfs-actions.pod:3080 ../src/guestfs-actions.pod:3097
7124 #: ../src/guestfs-actions.pod:3116 ../src/guestfs-actions.pod:3279
7125 #: ../src/guestfs-actions.pod:3293 ../src/guestfs-actions.pod:3308
7126 #: ../src/guestfs-actions.pod:3322 ../src/guestfs-actions.pod:3338
7127 #: ../src/guestfs-actions.pod:3353 ../src/guestfs-actions.pod:3369
7128 #: ../src/guestfs-actions.pod:3383 ../src/guestfs-actions.pod:3396
7129 #: ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3425
7130 #: ../src/guestfs-actions.pod:3440 ../src/guestfs-actions.pod:4971
7131 msgid "This function returns a C truth value on success or -1 on error."
7135 #: ../src/guestfs-actions.pod:706
7136 msgid "guestfs_blockdev_getsize64"
7140 #: ../src/guestfs-actions.pod:708
7144 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7145 " const char *device);\n"
7150 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
7151 msgid "This returns the size of the device in bytes."
7155 #: ../src/guestfs-actions.pod:714
7156 msgid "See also C<guestfs_blockdev_getsz>."
7160 #: ../src/guestfs-actions.pod:722
7161 msgid "guestfs_blockdev_getss"
7165 #: ../src/guestfs-actions.pod:724
7169 " guestfs_blockdev_getss (guestfs_h *g,\n"
7170 " const char *device);\n"
7175 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
7177 "This returns the size of sectors on a block device. Usually 512, but can be "
7178 "larger for modern devices."
7182 #: ../src/guestfs-actions.pod:731
7184 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7189 #: ../src/guestfs-actions.pod:740
7190 msgid "guestfs_blockdev_getsz"
7194 #: ../src/guestfs-actions.pod:742
7198 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7199 " const char *device);\n"
7204 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
7206 "This returns the size of the device in units of 512-byte sectors (even if "
7207 "the sectorsize isn't 512 bytes ... weird)."
7211 #: ../src/guestfs-actions.pod:749
7213 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7214 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7218 #: ../src/guestfs-actions.pod:759
7219 msgid "guestfs_blockdev_rereadpt"
7223 #: ../src/guestfs-actions.pod:761
7227 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7228 " const char *device);\n"
7233 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
7234 msgid "Reread the partition table on C<device>."
7238 #: ../src/guestfs-actions.pod:773
7239 msgid "guestfs_blockdev_setbsz"
7243 #: ../src/guestfs-actions.pod:775
7247 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7248 " const char *device,\n"
7249 " int blocksize);\n"
7254 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
7255 msgid "This sets the block size of a device."
7259 #: ../src/guestfs-actions.pod:791
7260 msgid "guestfs_blockdev_setro"
7264 #: ../src/guestfs-actions.pod:793
7268 " guestfs_blockdev_setro (guestfs_h *g,\n"
7269 " const char *device);\n"
7274 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
7275 msgid "Sets the block device named C<device> to read-only."
7279 #: ../src/guestfs-actions.pod:805
7280 msgid "guestfs_blockdev_setrw"
7284 #: ../src/guestfs-actions.pod:807
7288 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7289 " const char *device);\n"
7294 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
7295 msgid "Sets the block device named C<device> to read-write."
7299 #: ../src/guestfs-actions.pod:819
7300 msgid "guestfs_case_sensitive_path"
7304 #: ../src/guestfs-actions.pod:821
7308 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7309 " const char *path);\n"
7314 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
7316 "This can be used to resolve case insensitive paths on a filesystem which is "
7317 "case sensitive. The use case is to resolve paths which you have read from "
7318 "Windows configuration files or the Windows Registry, to the true path."
7322 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
7324 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7325 "(and probably others), which is that although the underlying filesystem is "
7326 "case-insensitive, the driver exports the filesystem to Linux as case-"
7331 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
7333 "One consequence of this is that special directories such as C<c:\\windows> "
7334 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7335 "precise details of how they were created. In Windows itself this would not "
7340 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
7342 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7347 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
7349 "This function resolves the true case of each element in the path and returns "
7350 "the case-sensitive path."
7354 #: ../src/guestfs-actions.pod:847
7356 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7357 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7358 "how the directories were originally created under Windows)."
7362 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
7363 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7367 #: ../src/guestfs-actions.pod:855
7368 msgid "See also C<guestfs_realpath>."
7372 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:6962
7373 msgid "(Added in 1.0.75)"
7377 #: ../src/guestfs-actions.pod:862
7382 #: ../src/guestfs-actions.pod:864
7386 " guestfs_cat (guestfs_h *g,\n"
7387 " const char *path);\n"
7392 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5458
7393 #: ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3659
7394 msgid "Return the contents of the file named C<path>."
7398 #: ../src/guestfs-actions.pod:870
7400 "Note that this function cannot correctly handle binary files (specifically, "
7401 "files containing C<\\0> character which is treated as end of string). For "
7402 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7403 "functions which have a more complex interface."
7407 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057
7408 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1373
7409 #: ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:1495
7410 #: ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1763
7411 #: ../src/guestfs-actions.pod:2221 ../src/guestfs-actions.pod:2240
7412 #: ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2307
7413 #: ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:2353
7414 #: ../src/guestfs-actions.pod:5240 ../src/guestfs-actions.pod:5266
7415 #: ../src/guestfs-actions.pod:5397 ../src/guestfs-actions.pod:5423
7416 #: ../src/guestfs-actions.pod:5447 ../src/guestfs-actions.pod:6347
7417 #: ../src/guestfs-actions.pod:6402 ../src/guestfs-actions.pod:6548
7418 #: ../src/guestfs-actions.pod:6572 ../src/guestfs-actions.pod:7234
7419 #: ../src/guestfs-actions.pod:7260 ../src/guestfs-actions.pod:7286
7420 #: ../src/guestfs-actions.pod:7305 ../src/guestfs-actions.pod:7390
7421 #: ../src/guestfs-actions.pod:7409 ../src/guestfs-actions.pod:7455
7422 #: ../src/guestfs-actions.pod:7474 ../fish/guestfish-actions.pod:587
7423 #: ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734
7424 #: ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920
7425 #: ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997
7426 #: ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1493
7427 #: ../fish/guestfish-actions.pod:1503 ../fish/guestfish-actions.pod:1531
7428 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:1556
7429 #: ../fish/guestfish-actions.pod:1575 ../fish/guestfish-actions.pod:3529
7430 #: ../fish/guestfish-actions.pod:3544 ../fish/guestfish-actions.pod:3620
7431 #: ../fish/guestfish-actions.pod:3637 ../fish/guestfish-actions.pod:3652
7432 #: ../fish/guestfish-actions.pod:4278 ../fish/guestfish-actions.pod:4324
7433 #: ../fish/guestfish-actions.pod:4409 ../fish/guestfish-actions.pod:4424
7434 #: ../fish/guestfish-actions.pod:4834 ../fish/guestfish-actions.pod:4852
7435 #: ../fish/guestfish-actions.pod:4869 ../fish/guestfish-actions.pod:4879
7436 #: ../fish/guestfish-actions.pod:4927 ../fish/guestfish-actions.pod:4937
7437 #: ../fish/guestfish-actions.pod:4966 ../fish/guestfish-actions.pod:4976
7439 "Because of the message protocol, there is a transfer limit of somewhere "
7440 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7444 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3556
7445 #: ../src/guestfs-actions.pod:3618 ../src/guestfs-actions.pod:3635
7446 #: ../src/guestfs-actions.pod:3723 ../src/guestfs-actions.pod:4128
7447 #: ../src/guestfs-actions.pod:4142 ../src/guestfs-actions.pod:5346
7448 #: ../src/guestfs-actions.pod:5360 ../src/guestfs-actions.pod:7121
7449 #: ../src/guestfs-actions.pod:7135
7450 msgid "(Added in 0.4)"
7454 #: ../src/guestfs-actions.pod:883
7455 msgid "guestfs_checksum"
7459 #: ../src/guestfs-actions.pod:885
7463 " guestfs_checksum (guestfs_h *g,\n"
7464 " const char *csumtype,\n"
7465 " const char *path);\n"
7470 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
7472 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7476 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
7478 "The type of checksum to compute is given by the C<csumtype> parameter which "
7479 "must have one of the following values:"
7483 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
7488 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
7490 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7495 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
7500 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
7501 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7505 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
7510 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
7511 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7515 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
7520 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
7521 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7525 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
7530 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
7531 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7535 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
7540 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
7541 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7545 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
7550 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
7551 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7555 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
7556 msgid "The checksum is returned as a printable string."
7560 #: ../src/guestfs-actions.pod:931
7561 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7565 #: ../src/guestfs-actions.pod:933
7566 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7570 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246
7571 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:3295
7572 #: ../src/guestfs-actions.pod:3324 ../src/guestfs-actions.pod:3385
7573 #: ../src/guestfs-actions.pod:3412 ../src/guestfs-actions.pod:6818
7574 msgid "(Added in 1.0.2)"
7578 #: ../src/guestfs-actions.pod:940
7579 msgid "guestfs_checksum_device"
7583 #: ../src/guestfs-actions.pod:942
7587 " guestfs_checksum_device (guestfs_h *g,\n"
7588 " const char *csumtype,\n"
7589 " const char *device);\n"
7594 #: ../src/guestfs-actions.pod:947
7596 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7597 "device named C<device>. For the types of checksums supported see the "
7598 "C<guestfs_checksum> command."
7602 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4877
7603 #: ../src/guestfs-actions.pod:4936 ../src/guestfs-actions.pod:4973
7604 #: ../src/guestfs-actions.pod:4991 ../src/guestfs-actions.pod:5167
7605 #: ../src/guestfs-actions.pod:6727 ../src/guestfs-actions.pod:6741
7606 #: ../src/guestfs-actions.pod:7147
7607 msgid "(Added in 1.3.2)"
7611 #: ../src/guestfs-actions.pod:956
7612 msgid "guestfs_checksums_out"
7616 #: ../src/guestfs-actions.pod:958
7620 " guestfs_checksums_out (guestfs_h *g,\n"
7621 " const char *csumtype,\n"
7622 " const char *directory,\n"
7623 " const char *sumsfile);\n"
7628 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
7630 "This command computes the checksums of all regular files in C<directory> and "
7631 "then emits a list of those checksums to the local output file C<sumsfile>."
7635 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
7637 "This can be used for verifying the integrity of a virtual machine. However "
7638 "to be properly secure you should pay attention to the output of the checksum "
7639 "command (it uses the ones from GNU coreutils). In particular when the "
7640 "filename is not printable, coreutils uses a special backslash syntax. For "
7641 "more information, see the GNU coreutils info file."
7645 #: ../src/guestfs-actions.pod:978
7646 msgid "(Added in 1.3.7)"
7650 #: ../src/guestfs-actions.pod:980
7651 msgid "guestfs_chmod"
7655 #: ../src/guestfs-actions.pod:982
7659 " guestfs_chmod (guestfs_h *g,\n"
7661 " const char *path);\n"
7666 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
7668 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7673 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
7675 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7676 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7681 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4379
7682 #: ../src/guestfs-actions.pod:4576 ../src/guestfs-actions.pod:4595
7683 #: ../src/guestfs-actions.pod:4614 ../fish/guestfish-actions.pod:676
7684 #: ../fish/guestfish-actions.pod:2975 ../fish/guestfish-actions.pod:3104
7685 #: ../fish/guestfish-actions.pod:3114 ../fish/guestfish-actions.pod:3124
7686 msgid "The mode actually set is affected by the umask."
7690 #: ../src/guestfs-actions.pod:1000
7691 msgid "guestfs_chown"
7695 #: ../src/guestfs-actions.pod:1002
7699 " guestfs_chown (guestfs_h *g,\n"
7702 " const char *path);\n"
7707 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
7708 msgid "Change the file owner to C<owner> and group to C<group>."
7712 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3487
7713 #: ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2433
7715 "Only numeric uid and gid are supported. If you want to use names, you will "
7716 "need to locate and parse the password file yourself (Augeas support makes "
7717 "this relatively easy)."
7721 #: ../src/guestfs-actions.pod:1018
7722 msgid "guestfs_command"
7726 #: ../src/guestfs-actions.pod:1020
7730 " guestfs_command (guestfs_h *g,\n"
7731 " char *const *arguments);\n"
7736 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
7738 "This call runs a command from the guest filesystem. The filesystem must be "
7739 "mounted, and must contain a compatible operating system (ie. something "
7740 "Linux, with the same or compatible processor architecture)."
7744 #: ../src/guestfs-actions.pod:1029
7746 "The single parameter is an argv-style list of arguments. The first element "
7747 "is the name of the program to run. Subsequent elements are parameters. The "
7748 "list must be non-empty (ie. must contain a program name). Note that the "
7749 "command runs directly, and is I<not> invoked via the shell (see "
7754 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
7755 msgid "The return value is anything printed to I<stdout> by the command."
7759 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
7761 "If the command returns a non-zero exit status, then this function returns an "
7762 "error message. The error message string is the content of I<stderr> from "
7767 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
7769 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7770 "bin>. If you require a program from another location, you should provide "
7771 "the full path in the first parameter."
7775 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
7777 "Shared libraries and data files required by the program must be available on "
7778 "filesystems which are mounted in the correct places. It is the caller's "
7779 "responsibility to ensure all filesystems that are needed are mounted at the "
7784 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080
7785 #: ../src/guestfs-actions.pod:1548
7786 msgid "(Added in 0.9.1)"
7790 #: ../src/guestfs-actions.pod:1062
7791 msgid "guestfs_command_lines"
7795 #: ../src/guestfs-actions.pod:1064
7799 " guestfs_command_lines (guestfs_h *g,\n"
7800 " char *const *arguments);\n"
7805 #: ../src/guestfs-actions.pod:1068
7807 "This is the same as C<guestfs_command>, but splits the result into a list of "
7812 #: ../src/guestfs-actions.pod:1071
7813 msgid "See also: C<guestfs_sh_lines>"
7817 #: ../src/guestfs-actions.pod:1082
7818 msgid "guestfs_config"
7822 #: ../src/guestfs-actions.pod:1084
7826 " guestfs_config (guestfs_h *g,\n"
7827 " const char *qemuparam,\n"
7828 " const char *qemuvalue);\n"
7833 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
7835 "This can be used to add arbitrary qemu command line parameters of the form "
7836 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
7837 "setting some parameters which would interfere with parameters that we use."
7841 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
7842 msgid "The first character of C<param> string must be a C<-> (dash)."
7846 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
7847 msgid "C<value> can be NULL."
7851 #: ../src/guestfs-actions.pod:1102
7852 msgid "guestfs_copy_size"
7856 #: ../src/guestfs-actions.pod:1104
7860 " guestfs_copy_size (guestfs_h *g,\n"
7861 " const char *src,\n"
7862 " const char *dest,\n"
7868 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
7870 "This command copies exactly C<size> bytes from one source device or file "
7871 "C<src> to another destination device or file C<dest>."
7875 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
7877 "Note this will fail if the source is too short or if the destination is not "
7882 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241
7883 #: ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1317
7884 #: ../src/guestfs-actions.pod:1697 ../src/guestfs-actions.pod:1719
7885 #: ../src/guestfs-actions.pod:3468 ../src/guestfs-actions.pod:6813
7886 #: ../src/guestfs-actions.pod:6847 ../src/guestfs-actions.pod:7326
7887 #: ../src/guestfs-actions.pod:7345
7889 "This long-running command can generate progress notification messages so "
7890 "that the caller can display a progress bar or indicator. To receive these "
7891 "messages, the caller must register a progress event callback. See L<guestfs"
7892 "(3)/GUESTFS_EVENT_PROGRESS>."
7896 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4155
7897 #: ../src/guestfs-actions.pod:5373 ../src/guestfs-actions.pod:7054
7898 #: ../src/guestfs-actions.pod:7074 ../src/guestfs-actions.pod:7160
7899 msgid "(Added in 1.0.87)"
7903 #: ../src/guestfs-actions.pod:1125
7908 #: ../src/guestfs-actions.pod:1127
7912 " guestfs_cp (guestfs_h *g,\n"
7913 " const char *src,\n"
7914 " const char *dest);\n"
7919 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
7921 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7922 "destination filename or destination directory."
7926 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151
7927 #: ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297
7928 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:4840
7929 #: ../src/guestfs-actions.pod:5217
7930 msgid "(Added in 1.0.18)"
7934 #: ../src/guestfs-actions.pod:1139
7935 msgid "guestfs_cp_a"
7939 #: ../src/guestfs-actions.pod:1141
7943 " guestfs_cp_a (guestfs_h *g,\n"
7944 " const char *src,\n"
7945 " const char *dest);\n"
7950 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
7952 "This copies a file or directory from C<src> to C<dest> recursively using the "
7957 #: ../src/guestfs-actions.pod:1153
7962 #: ../src/guestfs-actions.pod:1155
7966 " guestfs_dd (guestfs_h *g,\n"
7967 " const char *src,\n"
7968 " const char *dest);\n"
7973 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
7975 "This command copies from one source device or file C<src> to another "
7976 "destination device or file C<dest>. Normally you would use this to copy to "
7977 "or from a device or partition, for example to duplicate a filesystem."
7981 #: ../src/guestfs-actions.pod:1165
7983 "If the destination is a device, it must be as large or larger than the "
7984 "source file or device, otherwise the copy will fail. This command cannot do "
7985 "partial copies (see C<guestfs_copy_size>)."
7989 #: ../src/guestfs-actions.pod:1173
7994 #: ../src/guestfs-actions.pod:1175
7998 " guestfs_df (guestfs_h *g);\n"
8003 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
8004 msgid "This command runs the C<df> command to report disk space used."
8008 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
8010 "This command is mostly useful for interactive sessions. It is I<not> "
8011 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8016 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204
8017 #: ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:2286
8018 #: ../src/guestfs-actions.pod:2310 ../src/guestfs-actions.pod:2378
8019 #: ../src/guestfs-actions.pod:4265 ../src/guestfs-actions.pod:4740
8020 #: ../src/guestfs-actions.pod:6551 ../src/guestfs-actions.pod:6575
8021 #: ../src/guestfs-actions.pod:7193 ../src/guestfs-actions.pod:7206
8022 #: ../src/guestfs-actions.pod:7219
8023 msgid "(Added in 1.0.54)"
8027 #: ../src/guestfs-actions.pod:1189
8028 msgid "guestfs_df_h"
8032 #: ../src/guestfs-actions.pod:1191
8036 " guestfs_df_h (guestfs_h *g);\n"
8041 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
8043 "This command runs the C<df -h> command to report disk space used in human-"
8048 #: ../src/guestfs-actions.pod:1206
8049 msgid "guestfs_dmesg"
8053 #: ../src/guestfs-actions.pod:1208
8057 " guestfs_dmesg (guestfs_h *g);\n"
8062 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
8064 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8065 "This is sometimes useful for extended debugging of problems."
8069 #: ../src/guestfs-actions.pod:1215
8071 "Another way to get the same information is to enable verbose messages with "
8072 "C<guestfs_set_verbose> or by setting the environment variable "
8073 "C<LIBGUESTFS_DEBUG=1> before running the program."
8077 #: ../src/guestfs-actions.pod:1225
8078 msgid "guestfs_download"
8082 #: ../src/guestfs-actions.pod:1227
8086 " guestfs_download (guestfs_h *g,\n"
8087 " const char *remotefilename,\n"
8088 " const char *filename);\n"
8093 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257
8094 #: ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
8096 "Download file C<remotefilename> and save it as C<filename> on the local "
8101 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6807
8102 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4582
8103 msgid "C<filename> can also be a named pipe."
8107 #: ../src/guestfs-actions.pod:1237
8108 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8112 #: ../src/guestfs-actions.pod:1248
8113 msgid "guestfs_download_offset"
8117 #: ../src/guestfs-actions.pod:1250
8121 " guestfs_download_offset (guestfs_h *g,\n"
8122 " const char *remotefilename,\n"
8123 " const char *filename,\n"
8124 " int64_t offset,\n"
8130 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
8132 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8133 "region must be within the file or device)."
8137 #: ../src/guestfs-actions.pod:1263
8139 "Note that there is no limit on the amount of data that can be downloaded "
8140 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8141 "full amount unless an error occurs."
8145 #: ../src/guestfs-actions.pod:1268
8146 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8150 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6852
8151 msgid "(Added in 1.5.17)"
8155 #: ../src/guestfs-actions.pod:1279
8156 msgid "guestfs_drop_caches"
8160 #: ../src/guestfs-actions.pod:1281
8164 " guestfs_drop_caches (guestfs_h *g,\n"
8165 " int whattodrop);\n"
8170 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
8172 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8173 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8174 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8178 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
8179 msgid "Setting C<whattodrop> to 3 should drop everything."
8183 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
8185 "This automatically calls L<sync(2)> before the operation, so that the "
8186 "maximum guest memory is freed."
8190 #: ../src/guestfs-actions.pod:1299
8195 #: ../src/guestfs-actions.pod:1301
8199 " guestfs_du (guestfs_h *g,\n"
8200 " const char *path);\n"
8205 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
8207 "This command runs the C<du -s> command to estimate file space usage for "
8212 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
8214 "C<path> can be a file or a directory. If C<path> is a directory then the "
8215 "estimate includes the contents of the directory and all subdirectories "
8220 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
8222 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8226 #: ../src/guestfs-actions.pod:1324
8227 msgid "guestfs_e2fsck_f"
8231 #: ../src/guestfs-actions.pod:1326
8235 " guestfs_e2fsck_f (guestfs_h *g,\n"
8236 " const char *device);\n"
8241 #: ../src/guestfs-actions.pod:1330 ../fish/guestfish-actions.pod:885
8243 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8244 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
8249 #: ../src/guestfs-actions.pod:1334
8251 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8252 "Normally you should use C<guestfs_fsck>."
8256 #: ../src/guestfs-actions.pod:1339
8257 msgid "(Added in 1.0.29)"
8261 #: ../src/guestfs-actions.pod:1341
8262 msgid "guestfs_echo_daemon"
8266 #: ../src/guestfs-actions.pod:1343
8270 " guestfs_echo_daemon (guestfs_h *g,\n"
8271 " char *const *words);\n"
8276 #: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:896
8278 "This command concatenates the list of C<words> passed with single spaces "
8279 "between them and returns the resulting string."
8283 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:899
8284 msgid "You can use this command to test the connection through to the daemon."
8288 #: ../src/guestfs-actions.pod:1352
8289 msgid "See also C<guestfs_ping_daemon>."
8293 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:2094
8294 #: ../src/guestfs-actions.pod:6051
8295 msgid "(Added in 1.0.69)"
8299 #: ../src/guestfs-actions.pod:1359
8300 msgid "guestfs_egrep"
8304 #: ../src/guestfs-actions.pod:1361
8308 " guestfs_egrep (guestfs_h *g,\n"
8309 " const char *regex,\n"
8310 " const char *path);\n"
8315 #: ../src/guestfs-actions.pod:1366 ../fish/guestfish-actions.pod:907
8317 "This calls the external C<egrep> program and returns the matching lines."
8321 #: ../src/guestfs-actions.pod:1376 ../src/guestfs-actions.pod:1395
8322 #: ../src/guestfs-actions.pod:1452 ../src/guestfs-actions.pod:1498
8323 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:2224
8324 #: ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2399
8325 #: ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2427
8326 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2495
8327 #: ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:3648
8328 #: ../src/guestfs-actions.pod:3662 ../src/guestfs-actions.pod:3675
8329 #: ../src/guestfs-actions.pod:3689 ../src/guestfs-actions.pod:4675
8330 #: ../src/guestfs-actions.pod:5551 ../src/guestfs-actions.pod:5600
8331 #: ../src/guestfs-actions.pod:6419 ../src/guestfs-actions.pod:6431
8332 #: ../src/guestfs-actions.pod:6444 ../src/guestfs-actions.pod:6457
8333 #: ../src/guestfs-actions.pod:6479 ../src/guestfs-actions.pod:6492
8334 #: ../src/guestfs-actions.pod:6505 ../src/guestfs-actions.pod:6518
8335 #: ../src/guestfs-actions.pod:7289 ../src/guestfs-actions.pod:7308
8336 #: ../src/guestfs-actions.pod:7393 ../src/guestfs-actions.pod:7412
8337 #: ../src/guestfs-actions.pod:7458 ../src/guestfs-actions.pod:7477
8338 msgid "(Added in 1.0.66)"
8342 #: ../src/guestfs-actions.pod:1378
8343 msgid "guestfs_egrepi"
8347 #: ../src/guestfs-actions.pod:1380
8351 " guestfs_egrepi (guestfs_h *g,\n"
8352 " const char *regex,\n"
8353 " const char *path);\n"
8358 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:917
8360 "This calls the external C<egrep -i> program and returns the matching lines."
8364 #: ../src/guestfs-actions.pod:1397
8365 msgid "guestfs_equal"
8369 #: ../src/guestfs-actions.pod:1399
8373 " guestfs_equal (guestfs_h *g,\n"
8374 " const char *file1,\n"
8375 " const char *file2);\n"
8380 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:927
8382 "This compares the two files C<file1> and C<file2> and returns true if their "
8383 "content is exactly equal, or false otherwise."
8387 #: ../src/guestfs-actions.pod:1407 ../fish/guestfish-actions.pod:930
8388 msgid "The external L<cmp(1)> program is used for the comparison."
8392 #: ../src/guestfs-actions.pod:1413
8393 msgid "guestfs_exists"
8397 #: ../src/guestfs-actions.pod:1415
8401 " guestfs_exists (guestfs_h *g,\n"
8402 " const char *path);\n"
8407 #: ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:936
8409 "This returns C<true> if and only if there is a file, directory (or anything) "
8410 "with the given C<path> name."
8414 #: ../src/guestfs-actions.pod:1422
8415 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8419 #: ../src/guestfs-actions.pod:1428
8420 msgid "guestfs_fallocate"
8424 #: ../src/guestfs-actions.pod:1430
8428 " guestfs_fallocate (guestfs_h *g,\n"
8429 " const char *path,\n"
8435 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1461
8436 #: ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
8438 "This command preallocates a file (containing zero bytes) named C<path> of "
8439 "size C<len> bytes. If the file exists already, it is overwritten."
8443 #: ../src/guestfs-actions.pod:1439 ../fish/guestfish-actions.pod:949
8445 "Do not confuse this with the guestfish-specific C<alloc> command which "
8446 "allocates a file in the host and attaches it as a device."
8450 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:953
8452 "This function is deprecated. In new code, use the C<fallocate64> call "
8457 #: ../src/guestfs-actions.pod:1454
8458 msgid "guestfs_fallocate64"
8462 #: ../src/guestfs-actions.pod:1456
8466 " guestfs_fallocate64 (guestfs_h *g,\n"
8467 " const char *path,\n"
8473 #: ../src/guestfs-actions.pod:1465
8475 "Note that this call allocates disk blocks for the file. To create a sparse "
8476 "file use C<guestfs_truncate_size> instead."
8480 #: ../src/guestfs-actions.pod:1468
8482 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8483 "oversight it only allowed 30 bit lengths to be specified, effectively "
8484 "limiting the maximum size of files created through that call to 1GB."
8488 #: ../src/guestfs-actions.pod:1473 ../fish/guestfish-actions.pod:976
8490 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8491 "commands which create a file in the host and attach it as a device."
8495 #: ../src/guestfs-actions.pod:1479
8496 msgid "(Added in 1.3.17)"
8500 #: ../src/guestfs-actions.pod:1481
8501 msgid "guestfs_fgrep"
8505 #: ../src/guestfs-actions.pod:1483
8509 " guestfs_fgrep (guestfs_h *g,\n"
8510 " const char *pattern,\n"
8511 " const char *path);\n"
8516 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:984
8518 "This calls the external C<fgrep> program and returns the matching lines."
8522 #: ../src/guestfs-actions.pod:1500
8523 msgid "guestfs_fgrepi"
8527 #: ../src/guestfs-actions.pod:1502
8531 " guestfs_fgrepi (guestfs_h *g,\n"
8532 " const char *pattern,\n"
8533 " const char *path);\n"
8538 #: ../src/guestfs-actions.pod:1507 ../fish/guestfish-actions.pod:994
8540 "This calls the external C<fgrep -i> program and returns the matching lines."
8544 #: ../src/guestfs-actions.pod:1519
8545 msgid "guestfs_file"
8549 #: ../src/guestfs-actions.pod:1521
8553 " guestfs_file (guestfs_h *g,\n"
8554 " const char *path);\n"
8559 #: ../src/guestfs-actions.pod:1525 ../fish/guestfish-actions.pod:1004
8561 "This call uses the standard L<file(1)> command to determine the type or "
8562 "contents of the file."
8566 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1007
8568 "This call will also transparently look inside various types of compressed "
8573 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1010
8575 "The exact command which runs is C<file -zb path>. Note in particular that "
8576 "the filename is not prepended to the output (the C<-b> option)."
8580 #: ../src/guestfs-actions.pod:1535
8582 "This command can also be used on C</dev/> devices (and partitions, LV "
8583 "names). You can for example use this to determine if a device contains a "
8584 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
8588 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1019
8590 "If the C<path> does not begin with C</dev/> then this command only works for "
8591 "the content of regular files. For other file types (directory, symbolic "
8592 "link etc) it will just return the string C<directory> etc."
8596 #: ../src/guestfs-actions.pod:1550
8597 msgid "guestfs_file_architecture"
8601 #: ../src/guestfs-actions.pod:1552
8605 " guestfs_file_architecture (guestfs_h *g,\n"
8606 " const char *filename);\n"
8611 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1028
8613 "This detects the architecture of the binary C<filename>, and returns it if "
8618 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1031
8619 msgid "Currently defined architectures are:"
8623 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1035
8628 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
8630 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8631 "irrespective of the precise processor requirements of the binary."
8635 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1040
8640 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1042
8641 msgid "64 bit x86-64."
8645 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1044
8650 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1046
8651 msgid "32 bit SPARC."
8655 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1048
8660 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1050
8661 msgid "64 bit SPARC V9 and above."
8665 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1052
8670 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1054
8671 msgid "Intel Itanium."
8672 msgstr "Intel Itanium."
8675 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1056
8680 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1058
8681 msgid "32 bit Power PC."
8685 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1060
8690 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1062
8691 msgid "64 bit Power PC."
8695 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1066
8696 msgid "Libguestfs may return other architecture strings in future."
8700 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1068
8701 msgid "The function works on at least the following types of files:"
8705 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1074
8706 msgid "many types of Un*x and Linux binary"
8710 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1078
8711 msgid "many types of Un*x and Linux shared library"
8715 #: ../src/guestfs-actions.pod:1610 ../fish/guestfish-actions.pod:1082
8716 msgid "Windows Win32 and Win64 binaries"
8720 #: ../src/guestfs-actions.pod:1614 ../fish/guestfish-actions.pod:1086
8721 msgid "Windows Win32 and Win64 DLLs"
8725 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1088
8726 msgid "Win32 binaries and DLLs return C<i386>."
8730 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1090
8731 msgid "Win64 binaries and DLLs return C<x86_64>."
8735 #: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1094
8736 msgid "Linux kernel modules"
8740 #: ../src/guestfs-actions.pod:1626 ../fish/guestfish-actions.pod:1098
8741 msgid "Linux new-style initrd images"
8745 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1102
8746 msgid "some non-x86 Linux vmlinuz kernels"
8750 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1106
8751 msgid "What it can't do currently:"
8755 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1112
8756 msgid "static libraries (libfoo.a)"
8760 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1116
8761 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8765 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1120
8766 msgid "x86 Linux vmlinuz kernels"
8770 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1122
8772 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8773 "compressed code, and are horribly hard to unpack. If you want to find the "
8774 "architecture of a kernel, use the architecture of the associated initrd or "
8775 "kernel module(s) instead."
8779 #: ../src/guestfs-actions.pod:1660 ../src/guestfs-actions.pod:1823
8780 #: ../src/guestfs-actions.pod:1840 ../src/guestfs-actions.pod:2531
8781 #: ../src/guestfs-actions.pod:2616 ../src/guestfs-actions.pod:2686
8782 #: ../src/guestfs-actions.pod:2774 ../src/guestfs-actions.pod:2795
8783 #: ../src/guestfs-actions.pod:2838 ../src/guestfs-actions.pod:2922
8784 #: ../src/guestfs-actions.pod:3019 ../src/guestfs-actions.pod:3266
8785 #: ../src/guestfs-actions.pod:3398
8786 msgid "(Added in 1.5.3)"
8790 #: ../src/guestfs-actions.pod:1662
8791 msgid "guestfs_filesize"
8795 #: ../src/guestfs-actions.pod:1664
8799 " guestfs_filesize (guestfs_h *g,\n"
8800 " const char *file);\n"
8805 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1133
8806 msgid "This command returns the size of C<file> in bytes."
8810 #: ../src/guestfs-actions.pod:1670
8812 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
8813 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
8814 "devices, use C<guestfs_blockdev_getsize64>."
8818 #: ../src/guestfs-actions.pod:1676
8819 msgid "(Added in 1.0.82)"
8823 #: ../src/guestfs-actions.pod:1678
8824 msgid "guestfs_fill"
8828 #: ../src/guestfs-actions.pod:1680
8832 " guestfs_fill (guestfs_h *g,\n"
8835 " const char *path);\n"
8840 #: ../src/guestfs-actions.pod:1686 ../fish/guestfish-actions.pod:1143
8842 "This command creates a new file called C<path>. The initial content of the "
8843 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
8848 #: ../src/guestfs-actions.pod:1690
8850 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
8851 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
8852 "bytes use C<guestfs_fill_pattern>."
8856 #: ../src/guestfs-actions.pod:1702
8857 msgid "(Added in 1.0.79)"
8861 #: ../src/guestfs-actions.pod:1704
8862 msgid "guestfs_fill_pattern"
8866 #: ../src/guestfs-actions.pod:1706
8870 " guestfs_fill_pattern (guestfs_h *g,\n"
8871 " const char *pattern,\n"
8873 " const char *path);\n"
8878 #: ../src/guestfs-actions.pod:1712
8880 "This function is like C<guestfs_fill> except that it creates a new file of "
8881 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
8882 "pattern is truncated if necessary to ensure the length of the file is "
8883 "exactly C<len> bytes."
8887 #: ../src/guestfs-actions.pod:1724
8888 msgid "(Added in 1.3.12)"
8892 #: ../src/guestfs-actions.pod:1726
8893 msgid "guestfs_find"
8897 #: ../src/guestfs-actions.pod:1728
8901 " guestfs_find (guestfs_h *g,\n"
8902 " const char *directory);\n"
8907 #: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1165
8909 "This command lists out all files and directories, recursively, starting at "
8910 "C<directory>. It is essentially equivalent to running the shell command "
8911 "C<find directory -print> but some post-processing happens on the output, "
8916 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170
8918 "This returns a list of strings I<without any prefix>. Thus if the directory "
8923 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1173
8933 #: ../src/guestfs-actions.pod:1744
8935 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
8939 #: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1180
8950 #: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185
8951 msgid "If C<directory> is not a directory, then this command returns an error."
8955 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1188
8956 msgid "The returned list is sorted."
8960 #: ../src/guestfs-actions.pod:1757
8961 msgid "See also C<guestfs_find0>."
8965 #: ../src/guestfs-actions.pod:1766 ../src/guestfs-actions.pod:4092
8966 #: ../src/guestfs-actions.pod:5635
8967 msgid "(Added in 1.0.27)"
8971 #: ../src/guestfs-actions.pod:1768
8972 msgid "guestfs_find0"
8976 #: ../src/guestfs-actions.pod:1770
8980 " guestfs_find0 (guestfs_h *g,\n"
8981 " const char *directory,\n"
8982 " const char *files);\n"
8987 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1199
8989 "This command lists out all files and directories, recursively, starting at "
8990 "C<directory>, placing the resulting list in the external file called "
8995 #: ../src/guestfs-actions.pod:1779
8997 "This command works the same way as C<guestfs_find> with the following "
9002 #: ../src/guestfs-actions.pod:1786 ../fish/guestfish-actions.pod:1210
9003 msgid "The resulting list is written to an external file."
9007 #: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1214
9009 "Items (filenames) in the result are separated by C<\\0> characters. See "
9010 "L<find(1)> option I<-print0>."
9014 #: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1219
9015 msgid "This command is not limited in the number of names that it can return."
9019 #: ../src/guestfs-actions.pod:1800 ../fish/guestfish-actions.pod:1224
9020 msgid "The result list is not sorted."
9024 #: ../src/guestfs-actions.pod:1806
9025 msgid "(Added in 1.0.74)"
9029 #: ../src/guestfs-actions.pod:1808
9030 msgid "guestfs_findfs_label"
9034 #: ../src/guestfs-actions.pod:1810
9038 " guestfs_findfs_label (guestfs_h *g,\n"
9039 " const char *label);\n"
9044 #: ../src/guestfs-actions.pod:1814 ../fish/guestfish-actions.pod:1234
9046 "This command searches the filesystems and returns the one which has the "
9047 "given label. An error is returned if no such filesystem can be found."
9051 #: ../src/guestfs-actions.pod:1818
9052 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9056 #: ../src/guestfs-actions.pod:1825
9057 msgid "guestfs_findfs_uuid"
9061 #: ../src/guestfs-actions.pod:1827
9065 " guestfs_findfs_uuid (guestfs_h *g,\n"
9066 " const char *uuid);\n"
9071 #: ../src/guestfs-actions.pod:1831 ../fish/guestfish-actions.pod:1244
9073 "This command searches the filesystems and returns the one which has the "
9074 "given UUID. An error is returned if no such filesystem can be found."
9078 #: ../src/guestfs-actions.pod:1835
9079 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9083 #: ../src/guestfs-actions.pod:1842
9084 msgid "guestfs_fsck"
9088 #: ../src/guestfs-actions.pod:1844
9092 " guestfs_fsck (guestfs_h *g,\n"
9093 " const char *fstype,\n"
9094 " const char *device);\n"
9099 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254
9101 "This runs the filesystem checker (fsck) on C<device> which should have "
9102 "filesystem type C<fstype>."
9106 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1257
9108 "The returned integer is the status. See L<fsck(8)> for the list of status "
9109 "codes from C<fsck>."
9113 #: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:1266
9114 msgid "Multiple status codes can be summed together."
9118 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1270
9120 "A non-zero return code can mean \"success\", for example if errors have been "
9121 "corrected on the filesystem."
9125 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1275
9126 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9130 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1280
9132 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9136 #: ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:7331
9137 msgid "(Added in 1.0.16)"
9141 #: ../src/guestfs-actions.pod:1881
9142 msgid "guestfs_get_append"
9146 #: ../src/guestfs-actions.pod:1883
9150 " guestfs_get_append (guestfs_h *g);\n"
9155 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286
9157 "Return the additional kernel options which are added to the guest kernel "
9162 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1289
9163 msgid "If C<NULL> then no options are added."
9167 #: ../src/guestfs-actions.pod:1891
9169 "This function returns a string which may be NULL. There is no way to return "
9170 "an error from this function. The string is owned by the guest handle and "
9171 "must I<not> be freed."
9175 #: ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:5313
9176 #: ../src/guestfs-actions.pod:5793 ../src/guestfs-actions.pod:6193
9177 #: ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:6228
9178 #: ../src/guestfs-actions.pod:6245 ../src/guestfs-actions.pod:7002
9179 #: ../src/guestfs-actions.pod:7020 ../src/guestfs-actions.pod:7374
9180 msgid "(Added in 1.0.26)"
9184 #: ../src/guestfs-actions.pod:1897
9185 msgid "guestfs_get_attach_method"
9189 #: ../src/guestfs-actions.pod:1899
9193 " guestfs_get_attach_method (guestfs_h *g);\n"
9198 #: ../src/guestfs-actions.pod:1902
9199 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9203 #: ../src/guestfs-actions.pod:1907
9204 msgid "guestfs_get_autosync"
9208 #: ../src/guestfs-actions.pod:1909
9212 " guestfs_get_autosync (guestfs_h *g);\n"
9217 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1301
9218 msgid "Get the autosync flag."
9222 #: ../src/guestfs-actions.pod:1918
9223 msgid "guestfs_get_direct"
9227 #: ../src/guestfs-actions.pod:1920
9231 " guestfs_get_direct (guestfs_h *g);\n"
9236 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1307
9237 msgid "Return the direct appliance mode flag."
9241 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:5862
9242 msgid "(Added in 1.0.72)"
9246 #: ../src/guestfs-actions.pod:1929
9247 msgid "guestfs_get_e2label"
9251 #: ../src/guestfs-actions.pod:1931
9255 " guestfs_get_e2label (guestfs_h *g,\n"
9256 " const char *device);\n"
9261 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1313
9263 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9267 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1316
9269 "This function is deprecated. In new code, use the C<vfs_label> call instead."
9273 #: ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:1969
9274 #: ../src/guestfs-actions.pod:5880 ../src/guestfs-actions.pod:5899
9275 msgid "(Added in 1.0.15)"
9279 #: ../src/guestfs-actions.pod:1950
9280 msgid "guestfs_get_e2uuid"
9284 #: ../src/guestfs-actions.pod:1952
9288 " guestfs_get_e2uuid (guestfs_h *g,\n"
9289 " const char *device);\n"
9294 #: ../src/guestfs-actions.pod:1956 ../fish/guestfish-actions.pod:1327
9296 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9300 #: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1330
9302 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9306 #: ../src/guestfs-actions.pod:1971
9307 msgid "guestfs_get_memsize"
9311 #: ../src/guestfs-actions.pod:1973
9315 " guestfs_get_memsize (guestfs_h *g);\n"
9320 #: ../src/guestfs-actions.pod:1976 ../fish/guestfish-actions.pod:1341
9322 "This gets the memory size in megabytes allocated to the qemu subprocess."
9326 #: ../src/guestfs-actions.pod:1979
9328 "If C<guestfs_set_memsize> was not called on this handle, and if "
9329 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9330 "value for memsize."
9334 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2064
9335 #: ../src/guestfs-actions.pod:5915 ../src/guestfs-actions.pod:6022
9336 #: ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399
9337 #: ../fish/guestfish-actions.pod:3985 ../fish/guestfish-actions.pod:4072
9339 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9343 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:4383
9344 #: ../src/guestfs-actions.pod:4580 ../src/guestfs-actions.pod:4599
9345 #: ../src/guestfs-actions.pod:4618 ../src/guestfs-actions.pod:4630
9346 #: ../src/guestfs-actions.pod:4647 ../src/guestfs-actions.pod:4660
9347 #: ../src/guestfs-actions.pod:5538 ../src/guestfs-actions.pod:5920
9348 #: ../src/guestfs-actions.pod:6167 ../src/guestfs-actions.pod:6768
9349 msgid "(Added in 1.0.55)"
9353 #: ../src/guestfs-actions.pod:1990
9354 msgid "guestfs_get_network"
9358 #: ../src/guestfs-actions.pod:1992
9362 " guestfs_get_network (guestfs_h *g);\n"
9367 #: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1355
9368 msgid "This returns the enable network flag."
9372 #: ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:5939
9373 msgid "(Added in 1.5.4)"
9377 #: ../src/guestfs-actions.pod:2001
9378 msgid "guestfs_get_path"
9382 #: ../src/guestfs-actions.pod:2003
9386 " guestfs_get_path (guestfs_h *g);\n"
9391 #: ../src/guestfs-actions.pod:2006 ../fish/guestfish-actions.pod:1361
9392 msgid "Return the current search path."
9396 #: ../src/guestfs-actions.pod:2008 ../fish/guestfish-actions.pod:1363
9398 "This is always non-NULL. If it wasn't set already, then this will return "
9403 #: ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2040
9405 "This function returns a string, or NULL on error. The string is owned by "
9406 "the guest handle and must I<not> be freed."
9410 #: ../src/guestfs-actions.pod:2016
9411 msgid "guestfs_get_pid"
9415 #: ../src/guestfs-actions.pod:2018
9419 " guestfs_get_pid (guestfs_h *g);\n"
9424 #: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372
9426 "Return the process ID of the qemu subprocess. If there is no qemu "
9427 "subprocess, then this will return an error."
9431 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1375
9432 msgid "This is an internal call used for debugging and testing."
9436 #: ../src/guestfs-actions.pod:2028
9437 msgid "(Added in 1.0.56)"
9441 #: ../src/guestfs-actions.pod:2030
9442 msgid "guestfs_get_qemu"
9446 #: ../src/guestfs-actions.pod:2032
9450 " guestfs_get_qemu (guestfs_h *g);\n"
9455 #: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1381
9456 msgid "Return the current qemu binary."
9460 #: ../src/guestfs-actions.pod:2037 ../fish/guestfish-actions.pod:1383
9462 "This is always non-NULL. If it wasn't set already, then this will return "
9463 "the default qemu binary name."
9467 #: ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5984
9468 msgid "(Added in 1.0.6)"
9472 #: ../src/guestfs-actions.pod:2045
9473 msgid "guestfs_get_recovery_proc"
9477 #: ../src/guestfs-actions.pod:2047
9481 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9486 #: ../src/guestfs-actions.pod:2050 ../fish/guestfish-actions.pod:1390
9487 msgid "Return the recovery process enabled flag."
9491 #: ../src/guestfs-actions.pod:2054 ../src/guestfs-actions.pod:3493
9492 #: ../src/guestfs-actions.pod:3790 ../src/guestfs-actions.pod:4190
9493 #: ../src/guestfs-actions.pod:4222 ../src/guestfs-actions.pod:5243
9494 #: ../src/guestfs-actions.pod:5586 ../src/guestfs-actions.pod:6008
9495 #: ../src/guestfs-actions.pod:6671 ../src/guestfs-actions.pod:6691
9496 #: ../src/guestfs-actions.pod:6883
9497 msgid "(Added in 1.0.77)"
9501 #: ../src/guestfs-actions.pod:2056
9502 msgid "guestfs_get_selinux"
9506 #: ../src/guestfs-actions.pod:2058
9510 " guestfs_get_selinux (guestfs_h *g);\n"
9515 #: ../src/guestfs-actions.pod:2061
9517 "This returns the current setting of the selinux flag which is passed to the "
9518 "appliance at boot time. See C<guestfs_set_selinux>."
9522 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2132
9523 #: ../src/guestfs-actions.pod:6027 ../src/guestfs-actions.pod:6085
9524 msgid "(Added in 1.0.67)"
9528 #: ../src/guestfs-actions.pod:2071
9529 msgid "guestfs_get_state"
9533 #: ../src/guestfs-actions.pod:2073
9537 " guestfs_get_state (guestfs_h *g);\n"
9542 #: ../src/guestfs-actions.pod:2076 ../fish/guestfish-actions.pod:1406
9544 "This returns the current state as an opaque integer. This is only useful "
9545 "for printing debug and internal error messages."
9549 #: ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:3291
9550 #: ../src/guestfs-actions.pod:3320 ../src/guestfs-actions.pod:3381
9551 #: ../src/guestfs-actions.pod:3408 ../fish/guestfish-actions.pod:1409
9552 #: ../fish/guestfish-actions.pod:2315 ../fish/guestfish-actions.pod:2333
9553 #: ../fish/guestfish-actions.pod:2371 ../fish/guestfish-actions.pod:2387
9554 msgid "For more information on states, see L<guestfs(3)>."
9558 #: ../src/guestfs-actions.pod:2085
9559 msgid "guestfs_get_trace"
9563 #: ../src/guestfs-actions.pod:2087
9567 " guestfs_get_trace (guestfs_h *g);\n"
9572 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
9573 msgid "Return the command trace flag."
9577 #: ../src/guestfs-actions.pod:2096
9578 msgid "guestfs_get_umask"
9582 #: ../src/guestfs-actions.pod:2098
9586 " guestfs_get_umask (guestfs_h *g);\n"
9591 #: ../src/guestfs-actions.pod:2101
9593 "Return the current umask. By default the umask is C<022> unless it has been "
9594 "set by calling C<guestfs_umask>."
9598 #: ../src/guestfs-actions.pod:2108
9599 msgid "guestfs_get_verbose"
9603 #: ../src/guestfs-actions.pod:2110
9607 " guestfs_get_verbose (guestfs_h *g);\n"
9612 #: ../src/guestfs-actions.pod:2113 ../fish/guestfish-actions.pod:1428
9613 msgid "This returns the verbose messages flag."
9617 #: ../src/guestfs-actions.pod:2119
9618 msgid "guestfs_getcon"
9622 #: ../src/guestfs-actions.pod:2121
9626 " guestfs_getcon (guestfs_h *g);\n"
9631 #: ../src/guestfs-actions.pod:2124 ../fish/guestfish-actions.pod:1434
9632 msgid "This gets the SELinux security context of the daemon."
9636 #: ../src/guestfs-actions.pod:2126
9638 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9642 #: ../src/guestfs-actions.pod:2134
9643 msgid "guestfs_getxattr"
9647 #: ../src/guestfs-actions.pod:2136
9651 " guestfs_getxattr (guestfs_h *g,\n"
9652 " const char *path,\n"
9653 " const char *name,\n"
9654 " size_t *size_r);\n"
9659 #: ../src/guestfs-actions.pod:2142
9661 "Get a single extended attribute from file C<path> named C<name>. This call "
9662 "follows symlinks. If you want to lookup an extended attribute for the "
9663 "symlink itself, use C<guestfs_lgetxattr>."
9667 #: ../src/guestfs-actions.pod:2146 ../src/guestfs-actions.pod:3507
9669 "Normally it is better to get all extended attributes from a file in one go "
9670 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9671 "implementations are buggy and do not provide a way to list out attributes. "
9672 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9673 "extended attributes you want in advance and call this function."
9677 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:3514
9678 #: ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2452
9680 "Extended attribute values are blobs of binary data. If there is no extended "
9681 "attribute named C<name>, this returns an error."
9685 #: ../src/guestfs-actions.pod:2156
9686 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9690 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:2349
9691 #: ../src/guestfs-actions.pod:3519 ../src/guestfs-actions.pod:5236
9692 #: ../src/guestfs-actions.pod:5262 ../src/guestfs-actions.pod:5443
9694 "This function returns a buffer, or NULL on error. The size of the returned "
9695 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9700 #: ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:3523
9701 msgid "(Added in 1.7.24)"
9705 #: ../src/guestfs-actions.pod:2164
9706 msgid "guestfs_getxattrs"
9710 #: ../src/guestfs-actions.pod:2166
9713 " struct guestfs_xattr_list *\n"
9714 " guestfs_getxattrs (guestfs_h *g,\n"
9715 " const char *path);\n"
9720 #: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463
9722 "This call lists the extended attributes of the file or directory C<path>."
9726 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1466
9728 "At the system call level, this is a combination of the L<listxattr(2)> and "
9729 "L<getxattr(2)> calls."
9733 #: ../src/guestfs-actions.pod:2176
9734 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9738 #: ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:3535
9739 #: ../src/guestfs-actions.pod:4186
9741 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9742 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9746 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:3539
9747 #: ../src/guestfs-actions.pod:3704 ../src/guestfs-actions.pod:3740
9748 #: ../src/guestfs-actions.pod:5616 ../src/guestfs-actions.pod:6104
9749 #: ../src/guestfs-actions.pod:7439
9750 msgid "(Added in 1.0.59)"
9754 #: ../src/guestfs-actions.pod:2184
9755 msgid "guestfs_glob_expand"
9759 #: ../src/guestfs-actions.pod:2186
9763 " guestfs_glob_expand (guestfs_h *g,\n"
9764 " const char *pattern);\n"
9769 #: ../src/guestfs-actions.pod:2190 ../fish/guestfish-actions.pod:1475
9771 "This command searches for all the pathnames matching C<pattern> according to "
9772 "the wildcard expansion rules used by the shell."
9776 #: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479
9778 "If no paths match, then this returns an empty list (note: not an error)."
9782 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1482
9784 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
9785 "GLOB_BRACE>. See that manual page for more details."
9789 #: ../src/guestfs-actions.pod:2205 ../src/guestfs-actions.pod:6269
9790 #: ../src/guestfs-actions.pod:6286
9791 msgid "(Added in 1.0.50)"
9795 #: ../src/guestfs-actions.pod:2207
9796 msgid "guestfs_grep"
9800 #: ../src/guestfs-actions.pod:2209
9804 " guestfs_grep (guestfs_h *g,\n"
9805 " const char *regex,\n"
9806 " const char *path);\n"
9811 #: ../src/guestfs-actions.pod:2214 ../fish/guestfish-actions.pod:1490
9812 msgid "This calls the external C<grep> program and returns the matching lines."
9816 #: ../src/guestfs-actions.pod:2226
9817 msgid "guestfs_grepi"
9821 #: ../src/guestfs-actions.pod:2228
9825 " guestfs_grepi (guestfs_h *g,\n"
9826 " const char *regex,\n"
9827 " const char *path);\n"
9832 #: ../src/guestfs-actions.pod:2233 ../fish/guestfish-actions.pod:1500
9834 "This calls the external C<grep -i> program and returns the matching lines."
9838 #: ../src/guestfs-actions.pod:2245
9839 msgid "guestfs_grub_install"
9843 #: ../src/guestfs-actions.pod:2247
9847 " guestfs_grub_install (guestfs_h *g,\n"
9848 " const char *root,\n"
9849 " const char *device);\n"
9854 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510
9856 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
9857 "the root directory being C<root>."
9861 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1513
9863 "Note: If grub-install reports the error \"No suitable drive was found in the "
9864 "generated device map.\" it may be that you need to create a C</boot/grub/"
9865 "device.map> file first that contains the mapping between grub device names "
9866 "and Linux device names. It is usually sufficient to create a file "
9871 #: ../src/guestfs-actions.pod:2262 ../fish/guestfish-actions.pod:1520
9879 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1522
9880 msgid "replacing C</dev/vda> with the name of the installation device."
9884 #: ../src/guestfs-actions.pod:2268
9885 msgid "(Added in 1.0.17)"
9889 #: ../src/guestfs-actions.pod:2270
9890 msgid "guestfs_head"
9894 #: ../src/guestfs-actions.pod:2272
9898 " guestfs_head (guestfs_h *g,\n"
9899 " const char *path);\n"
9904 #: ../src/guestfs-actions.pod:2276 ../fish/guestfish-actions.pod:1528
9906 "This command returns up to the first 10 lines of a file as a list of strings."
9910 #: ../src/guestfs-actions.pod:2288
9911 msgid "guestfs_head_n"
9915 #: ../src/guestfs-actions.pod:2290
9919 " guestfs_head_n (guestfs_h *g,\n"
9921 " const char *path);\n"
9926 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538
9928 "If the parameter C<nrlines> is a positive number, this returns the first "
9929 "C<nrlines> lines of the file C<path>."
9933 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1541
9935 "If the parameter C<nrlines> is a negative number, this returns lines from "
9936 "the file C<path>, excluding the last C<nrlines> lines."
9940 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:6566
9941 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4422
9942 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9946 #: ../src/guestfs-actions.pod:2312
9947 msgid "guestfs_hexdump"
9951 #: ../src/guestfs-actions.pod:2314
9955 " guestfs_hexdump (guestfs_h *g,\n"
9956 " const char *path);\n"
9961 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1553
9963 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
9964 "readable, canonical hex dump of the file."
9968 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:6350
9969 #: ../src/guestfs-actions.pod:6405
9970 msgid "(Added in 1.0.22)"
9974 #: ../src/guestfs-actions.pod:2329
9975 msgid "guestfs_initrd_cat"
9979 #: ../src/guestfs-actions.pod:2331
9983 " guestfs_initrd_cat (guestfs_h *g,\n"
9984 " const char *initrdpath,\n"
9985 " const char *filename,\n"
9986 " size_t *size_r);\n"
9991 #: ../src/guestfs-actions.pod:2337 ../fish/guestfish-actions.pod:1563
9993 "This command unpacks the file C<filename> from the initrd file called "
9994 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9999 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1567
10001 "For example, in guestfish you could use the following command to examine the "
10002 "boot script (usually called C</init>) contained in a Linux initrd or "
10007 #: ../src/guestfs-actions.pod:2345 ../fish/guestfish-actions.pod:1571
10010 " initrd-cat /boot/initrd-<version>.img init\n"
10015 #: ../src/guestfs-actions.pod:2347
10016 msgid "See also C<guestfs_initrd_list>."
10020 #: ../src/guestfs-actions.pod:2358
10021 msgid "guestfs_initrd_list"
10025 #: ../src/guestfs-actions.pod:2360
10029 " guestfs_initrd_list (guestfs_h *g,\n"
10030 " const char *path);\n"
10035 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1582
10036 msgid "This command lists out files contained in an initrd."
10040 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1584
10042 "The files are listed without any initial C</> character. The files are "
10043 "listed in the order they appear (not necessarily alphabetical). Directory "
10044 "names are listed as separate items."
10048 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1588
10050 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10051 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10056 #: ../src/guestfs-actions.pod:2380
10057 msgid "guestfs_inotify_add_watch"
10061 #: ../src/guestfs-actions.pod:2382
10065 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10066 " const char *path,\n"
10072 #: ../src/guestfs-actions.pod:2387 ../fish/guestfish-actions.pod:1596
10073 msgid "Watch C<path> for the events listed in C<mask>."
10077 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1598
10079 "Note that if C<path> is a directory then events within that directory are "
10080 "watched, but this does I<not> happen recursively (in subdirectories)."
10084 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1602
10086 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10087 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10091 #: ../src/guestfs-actions.pod:2401
10092 msgid "guestfs_inotify_close"
10096 #: ../src/guestfs-actions.pod:2403
10100 " guestfs_inotify_close (guestfs_h *g);\n"
10105 #: ../src/guestfs-actions.pod:2406 ../fish/guestfish-actions.pod:1610
10107 "This closes the inotify handle which was previously opened by inotify_init. "
10108 "It removes all watches, throws away any pending events, and deallocates all "
10113 #: ../src/guestfs-actions.pod:2414
10114 msgid "guestfs_inotify_files"
10118 #: ../src/guestfs-actions.pod:2416
10122 " guestfs_inotify_files (guestfs_h *g);\n"
10127 #: ../src/guestfs-actions.pod:2419
10129 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10130 "returns a list of pathnames of objects that were touched. The returned "
10131 "pathnames are sorted and deduplicated."
10135 #: ../src/guestfs-actions.pod:2429
10136 msgid "guestfs_inotify_init"
10140 #: ../src/guestfs-actions.pod:2431
10144 " guestfs_inotify_init (guestfs_h *g,\n"
10145 " int maxevents);\n"
10150 #: ../src/guestfs-actions.pod:2435 ../fish/guestfish-actions.pod:1626
10152 "This command creates a new inotify handle. The inotify subsystem can be "
10153 "used to notify events which happen to objects in the guest filesystem."
10157 #: ../src/guestfs-actions.pod:2439
10159 "C<maxevents> is the maximum number of events which will be queued up between "
10160 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10161 "passed as C<0>, then the kernel (or previously set) default is used. For "
10162 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10163 "throws away events, but records the fact that it threw them away by setting "
10164 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10165 "C<guestfs_inotify_read>)."
10169 #: ../src/guestfs-actions.pod:2449
10171 "Before any events are generated, you have to add some watches to the "
10172 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10173 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10177 #: ../src/guestfs-actions.pod:2455
10179 "Queued up events should be read periodically by calling "
10180 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10181 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10182 "often enough then you risk the internal queue overflowing."
10186 #: ../src/guestfs-actions.pod:2462
10188 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10189 "This also removes any watches automatically."
10193 #: ../src/guestfs-actions.pod:2466 ../fish/guestfish-actions.pod:1657
10195 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10196 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10197 "that there is one global inotify handle per libguestfs instance."
10201 #: ../src/guestfs-actions.pod:2475
10202 msgid "guestfs_inotify_read"
10206 #: ../src/guestfs-actions.pod:2477
10209 " struct guestfs_inotify_event_list *\n"
10210 " guestfs_inotify_read (guestfs_h *g);\n"
10215 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666
10217 "Return the complete queue of events that have happened since the previous "
10222 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1669
10223 msgid "If no events have happened, this returns an empty list."
10227 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1671
10229 "I<Note>: In order to make sure that all events have been read, you must call "
10230 "this function repeatedly until it returns an empty list. The reason is that "
10231 "the call will read events up to the maximum appliance-to-host message size "
10232 "and leave remaining events in the queue."
10236 #: ../src/guestfs-actions.pod:2491
10238 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10239 "there was an error. I<The caller must call "
10240 "C<guestfs_free_inotify_event_list> after use>."
10244 #: ../src/guestfs-actions.pod:2497
10245 msgid "guestfs_inotify_rm_watch"
10249 #: ../src/guestfs-actions.pod:2499
10253 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10259 #: ../src/guestfs-actions.pod:2503
10261 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10265 #: ../src/guestfs-actions.pod:2510
10266 msgid "guestfs_inspect_get_arch"
10270 #: ../src/guestfs-actions.pod:2512
10274 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10275 " const char *root);\n"
10280 #: ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2539
10281 #: ../src/guestfs-actions.pod:2624 ../src/guestfs-actions.pod:2668
10282 #: ../src/guestfs-actions.pod:2694 ../src/guestfs-actions.pod:2733
10283 #: ../src/guestfs-actions.pod:2755 ../src/guestfs-actions.pod:2782
10284 #: ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2846
10285 #: ../src/guestfs-actions.pod:2875 ../src/guestfs-actions.pod:2906
10286 #: ../src/guestfs-actions.pod:2930 ../src/guestfs-actions.pod:2985
10287 #: ../src/guestfs-actions.pod:3027 ../src/guestfs-actions.pod:3048
10288 #: ../src/guestfs-actions.pod:3071 ../src/guestfs-actions.pod:3088
10289 #: ../src/guestfs-actions.pod:3105 ../src/guestfs-actions.pod:3124
10291 "This function should only be called with a root device string as returned by "
10292 "C<guestfs_inspect_os>."
10296 #: ../src/guestfs-actions.pod:2519
10298 "This returns the architecture of the inspected operating system. The "
10299 "possible return values are listed under C<guestfs_file_architecture>."
10303 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1695
10305 "If the architecture could not be determined, then the string C<unknown> is "
10310 #: ../src/guestfs-actions.pod:2526 ../src/guestfs-actions.pod:2611
10311 #: ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2742
10312 #: ../src/guestfs-actions.pod:2770 ../src/guestfs-actions.pod:2862
10313 #: ../src/guestfs-actions.pod:2893 ../src/guestfs-actions.pod:2917
10314 #: ../src/guestfs-actions.pod:2971 ../src/guestfs-actions.pod:3014
10315 #: ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3058
10316 #: ../src/guestfs-actions.pod:3078 ../src/guestfs-actions.pod:3095
10317 #: ../src/guestfs-actions.pod:3114 ../src/guestfs-actions.pod:3217
10318 #: ../src/guestfs-actions.pod:3258 ../fish/guestfish-actions.pod:1698
10319 #: ../fish/guestfish-actions.pod:1776 ../fish/guestfish-actions.pod:1864
10320 #: ../fish/guestfish-actions.pod:1879 ../fish/guestfish-actions.pod:1900
10321 #: ../fish/guestfish-actions.pod:1970 ../fish/guestfish-actions.pod:1994
10322 #: ../fish/guestfish-actions.pod:2011 ../fish/guestfish-actions.pod:2054
10323 #: ../fish/guestfish-actions.pod:2089 ../fish/guestfish-actions.pod:2105
10324 #: ../fish/guestfish-actions.pod:2121 ../fish/guestfish-actions.pod:2134
10325 #: ../fish/guestfish-actions.pod:2147 ../fish/guestfish-actions.pod:2162
10326 #: ../fish/guestfish-actions.pod:2261 ../fish/guestfish-actions.pod:2295
10327 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10331 #: ../src/guestfs-actions.pod:2533
10332 msgid "guestfs_inspect_get_distro"
10336 #: ../src/guestfs-actions.pod:2535
10340 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10341 " const char *root);\n"
10346 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707
10348 "This returns the distro (distribution) of the inspected operating system."
10352 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1710
10353 msgid "Currently defined distros are:"
10357 #: ../src/guestfs-actions.pod:2549 ../fish/guestfish-actions.pod:1714
10358 msgid "\"archlinux\""
10359 msgstr "\"archlinux\""
10362 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1716
10363 msgid "Arch Linux."
10364 msgstr "Arch Linux."
10367 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1718
10369 msgstr "\"debian\""
10372 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1720
10377 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1722
10379 msgstr "\"fedora\""
10382 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1724
10387 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1726
10389 msgstr "\"gentoo\""
10392 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1728
10397 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1730
10398 msgid "\"linuxmint\""
10399 msgstr "\"linuxmint\""
10402 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1732
10403 msgid "Linux Mint."
10404 msgstr "Linux Mint."
10407 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1734
10408 msgid "\"mandriva\""
10409 msgstr "\"mandriva\""
10412 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1736
10417 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1738
10422 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1740
10427 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1742
10429 msgstr "\"pardus\""
10432 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1744
10437 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1746
10438 msgid "\"redhat-based\""
10439 msgstr "\"redhat-based\""
10442 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1748
10443 msgid "Some Red Hat-derived distro."
10444 msgstr "Дистрибутив, що походить від Red Hat."
10447 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1750
10452 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1752
10453 msgid "Red Hat Enterprise Linux and some derivatives."
10454 msgstr "Red Hat Enterprise Linux та деякі з похідних дистрибутивів."
10457 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1754
10458 msgid "\"slackware\""
10462 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1756
10467 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1758
10469 msgstr "\"ubuntu\""
10472 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1760
10477 #: ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2713
10478 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:1762
10479 #: ../fish/guestfish-actions.pod:1855 ../fish/guestfish-actions.pod:2080
10480 msgid "\"unknown\""
10481 msgstr "\"unknown\""
10484 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1764
10485 msgid "The distro could not be determined."
10486 msgstr "Дистрибутив, тип якого не вдалося визначити."
10489 #: ../src/guestfs-actions.pod:2601 ../src/guestfs-actions.pod:2997
10490 #: ../fish/guestfish-actions.pod:1766 ../fish/guestfish-actions.pod:2072
10491 msgid "\"windows\""
10492 msgstr "\"windows\""
10495 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1768
10497 "Windows does not have distributions. This string is returned if the OS type "
10502 #: ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2719
10503 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:1773
10504 #: ../fish/guestfish-actions.pod:1861 ../fish/guestfish-actions.pod:2086
10506 "Future versions of libguestfs may return other strings here. The caller "
10507 "should be prepared to handle any string."
10511 #: ../src/guestfs-actions.pod:2618
10512 msgid "guestfs_inspect_get_drive_mappings"
10516 #: ../src/guestfs-actions.pod:2620
10520 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10521 " const char *root);\n"
10526 #: ../src/guestfs-actions.pod:2627 ../fish/guestfish-actions.pod:1785
10528 "This call is useful for Windows which uses a primitive system of assigning "
10529 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10530 "Windows Registry to find out how disks/partitions are mapped to drive "
10531 "letters, and returns a hash table as in the example below:"
10535 #: ../src/guestfs-actions.pod:2633 ../fish/guestfish-actions.pod:1791
10538 " C => /dev/vda2\n"
10539 " E => /dev/vdb1\n"
10540 " F => /dev/vdc1\n"
10545 #: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1795
10547 "Note that keys are drive letters. For Windows, the key is case insensitive "
10548 "and just contains the drive letter, without the customary colon separator "
10553 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1799
10555 "In future we may support other operating systems that also used drive "
10556 "letters, but the keys for those might not be case insensitive and might be "
10557 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10562 #: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1804
10564 "For Windows guests, currently only hard drive mappings are returned. "
10565 "Removable disks (eg. DVD-ROMs) are ignored."
10569 #: ../src/guestfs-actions.pod:2649 ../fish/guestfish-actions.pod:1807
10571 "For guests that do not use drive mappings, or if the drive mappings could "
10572 "not be determined, this returns an empty hash table."
10576 #: ../src/guestfs-actions.pod:2652
10578 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10579 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10583 #: ../src/guestfs-actions.pod:2656 ../src/guestfs-actions.pod:2832
10584 #: ../src/guestfs-actions.pod:3592 ../src/guestfs-actions.pod:4802
10585 #: ../src/guestfs-actions.pod:6707
10587 "This function returns a NULL-terminated array of strings, or NULL if there "
10588 "was an error. The array of strings will always have length C<2n+1>, where "
10589 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10590 "caller must free the strings and the array after use>."
10594 #: ../src/guestfs-actions.pod:2662
10595 msgid "guestfs_inspect_get_filesystems"
10599 #: ../src/guestfs-actions.pod:2664
10603 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10604 " const char *root);\n"
10609 #: ../src/guestfs-actions.pod:2671 ../fish/guestfish-actions.pod:1821
10611 "This returns a list of all the filesystems that we think are associated with "
10612 "this operating system. This includes the root filesystem, other ordinary "
10613 "filesystems, and non-mounted devices like swap partitions."
10617 #: ../src/guestfs-actions.pod:2676 ../fish/guestfish-actions.pod:1826
10619 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10620 "to be shared between operating systems."
10624 #: ../src/guestfs-actions.pod:2679
10626 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10627 "C<guestfs_inspect_get_mountpoints>."
10631 #: ../src/guestfs-actions.pod:2688
10632 msgid "guestfs_inspect_get_format"
10636 #: ../src/guestfs-actions.pod:2690
10640 " guestfs_inspect_get_format (guestfs_h *g,\n"
10641 " const char *root);\n"
10646 #: ../src/guestfs-actions.pod:2697 ../fish/guestfish-actions.pod:1839
10648 "This returns the format of the inspected operating system. You can use it "
10649 "to detect install images, live CDs and similar."
10653 #: ../src/guestfs-actions.pod:2700 ../fish/guestfish-actions.pod:1842
10654 msgid "Currently defined formats are:"
10658 #: ../src/guestfs-actions.pod:2704 ../fish/guestfish-actions.pod:1846
10659 msgid "\"installed\""
10660 msgstr "\"installed\""
10663 #: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1848
10664 msgid "This is an installed operating system."
10665 msgstr "Це встановлена операційна система."
10668 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1850
10669 msgid "\"installer\""
10673 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1852
10675 "The disk image being inspected is not an installed operating system, but a "
10676 "I<bootable> install disk, live CD, or similar."
10680 #: ../src/guestfs-actions.pod:2715 ../fish/guestfish-actions.pod:1857
10681 msgid "The format of this disk image is not known."
10685 #: ../src/guestfs-actions.pod:2727
10686 msgid "guestfs_inspect_get_hostname"
10690 #: ../src/guestfs-actions.pod:2729
10694 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10695 " const char *root);\n"
10700 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1873
10702 "This function returns the hostname of the operating system as found by "
10703 "inspection of the guest's configuration files."
10707 #: ../src/guestfs-actions.pod:2739 ../fish/guestfish-actions.pod:1876
10709 "If the hostname could not be determined, then the string C<unknown> is "
10714 #: ../src/guestfs-actions.pod:2747
10715 msgid "(Added in 1.7.9)"
10719 #: ../src/guestfs-actions.pod:2749
10720 msgid "guestfs_inspect_get_major_version"
10724 #: ../src/guestfs-actions.pod:2751
10728 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10729 " const char *root);\n"
10734 #: ../src/guestfs-actions.pod:2758 ../fish/guestfish-actions.pod:1888
10736 "This returns the major version number of the inspected operating system."
10740 #: ../src/guestfs-actions.pod:2761 ../fish/guestfish-actions.pod:1891
10742 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10743 "popular public names used by the operating system. Notably the operating "
10744 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10745 "1). You can find out the real versions corresponding to releases of Windows "
10746 "by consulting Wikipedia or MSDN."
10750 #: ../src/guestfs-actions.pod:2768 ../src/guestfs-actions.pod:2788
10751 #: ../fish/guestfish-actions.pod:1898 ../fish/guestfish-actions.pod:1912
10752 msgid "If the version could not be determined, then C<0> is returned."
10756 #: ../src/guestfs-actions.pod:2776
10757 msgid "guestfs_inspect_get_minor_version"
10761 #: ../src/guestfs-actions.pod:2778
10765 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10766 " const char *root);\n"
10771 #: ../src/guestfs-actions.pod:2785 ../fish/guestfish-actions.pod:1909
10773 "This returns the minor version number of the inspected operating system."
10777 #: ../src/guestfs-actions.pod:2790
10779 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10780 "C<guestfs_inspect_get_major_version>."
10784 #: ../src/guestfs-actions.pod:2797
10785 msgid "guestfs_inspect_get_mountpoints"
10789 #: ../src/guestfs-actions.pod:2799
10793 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10794 " const char *root);\n"
10799 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1924
10801 "This returns a hash of where we think the filesystems associated with this "
10802 "operating system should be mounted. Callers should note that this is at "
10803 "best an educated guess made by reading configuration files such as C</etc/"
10804 "fstab>. I<In particular note> that this may return filesystems which are "
10805 "non-existent or not mountable and callers should be prepared to handle or "
10806 "ignore failures if they try to mount them."
10810 #: ../src/guestfs-actions.pod:2815 ../fish/guestfish-actions.pod:1933
10812 "Each element in the returned hashtable has a key which is the path of the "
10813 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
10814 "mounted there (eg. C</dev/sda1>)."
10818 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1938
10820 "Non-mounted devices such as swap devices are I<not> returned in this list."
10824 #: ../src/guestfs-actions.pod:2823
10826 "For operating systems like Windows which still use drive letters, this call "
10827 "will only return an entry for the first drive \"mounted on\" C</>. For "
10828 "information about the mapping of drive letters to partitions, see "
10829 "C<guestfs_inspect_get_drive_mappings>."
10833 #: ../src/guestfs-actions.pod:2829
10835 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10836 "C<guestfs_inspect_get_filesystems>."
10840 #: ../src/guestfs-actions.pod:2840
10841 msgid "guestfs_inspect_get_package_format"
10845 #: ../src/guestfs-actions.pod:2842
10849 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
10850 " const char *root);\n"
10855 #: ../src/guestfs-actions.pod:2849
10857 "This function and C<guestfs_inspect_get_package_management> return the "
10858 "package format and package management tool used by the inspected operating "
10859 "system. For example for Fedora these functions would return C<rpm> (package "
10860 "format) and C<yum> (package management)."
10864 #: ../src/guestfs-actions.pod:2855 ../fish/guestfish-actions.pod:1963
10866 "This returns the string C<unknown> if we could not determine the package "
10867 "format I<or> if the operating system does not have a real packaging system "
10872 #: ../src/guestfs-actions.pod:2859 ../fish/guestfish-actions.pod:1967
10874 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
10875 "Future versions of libguestfs may return other strings."
10879 #: ../src/guestfs-actions.pod:2867 ../src/guestfs-actions.pod:2898
10880 msgid "(Added in 1.7.5)"
10884 #: ../src/guestfs-actions.pod:2869
10885 msgid "guestfs_inspect_get_package_management"
10889 #: ../src/guestfs-actions.pod:2871
10893 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
10894 " const char *root);\n"
10899 #: ../src/guestfs-actions.pod:2878
10901 "C<guestfs_inspect_get_package_format> and this function return the package "
10902 "format and package management tool used by the inspected operating system. "
10903 "For example for Fedora these functions would return C<rpm> (package format) "
10904 "and C<yum> (package management)."
10908 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1985
10910 "This returns the string C<unknown> if we could not determine the package "
10911 "management tool I<or> if the operating system does not have a real packaging "
10912 "system (eg. Windows)."
10916 #: ../src/guestfs-actions.pod:2888 ../fish/guestfish-actions.pod:1989
10918 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
10919 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
10920 "libguestfs may return other strings."
10924 #: ../src/guestfs-actions.pod:2900
10925 msgid "guestfs_inspect_get_product_name"
10929 #: ../src/guestfs-actions.pod:2902
10933 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
10934 " const char *root);\n"
10939 #: ../src/guestfs-actions.pod:2909 ../fish/guestfish-actions.pod:2003
10941 "This returns the product name of the inspected operating system. The "
10942 "product name is generally some freeform string which can be displayed to the "
10943 "user, but should not be parsed by programs."
10947 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2008
10949 "If the product name could not be determined, then the string C<unknown> is "
10954 #: ../src/guestfs-actions.pod:2924
10955 msgid "guestfs_inspect_get_product_variant"
10959 #: ../src/guestfs-actions.pod:2926
10963 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
10964 " const char *root);\n"
10969 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2020
10971 #| msgid "This is an installed operating system."
10972 msgid "This returns the product variant of the inspected operating system."
10973 msgstr "Це встановлена операційна система."
10976 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2023
10978 "For Windows guests, this returns the contents of the Registry key C<HKLM"
10979 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
10980 "is usually a string such as C<Client> or C<Server> (other values are "
10981 "possible). This can be used to distinguish consumer and enterprise versions "
10982 "of Windows that have the same version number (for example, Windows 7 and "
10983 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
10984 "the latter is C<Server>)."
10988 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2032
10990 "For enterprise Linux guests, in future we intend this to return the product "
10991 "variant such as C<Desktop>, C<Server> and so on. But this is not "
10992 "implemented at present."
10996 #: ../src/guestfs-actions.pod:2949 ../fish/guestfish-actions.pod:2036
10998 "If the product variant could not be determined, then the string C<unknown> "
11003 #: ../src/guestfs-actions.pod:2952
11005 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11006 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
11010 #: ../src/guestfs-actions.pod:2959
11011 msgid "guestfs_inspect_get_roots"
11015 #: ../src/guestfs-actions.pod:2961
11019 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11024 #: ../src/guestfs-actions.pod:2964
11026 "This function is a convenient way to get the list of root devices, as "
11027 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11028 "the whole inspection process."
11032 #: ../src/guestfs-actions.pod:2968
11034 "This returns an empty list if either no root devices were found or the "
11035 "caller has not called C<guestfs_inspect_os>."
11039 #: ../src/guestfs-actions.pod:2977
11040 msgid "(Added in 1.7.3)"
11044 #: ../src/guestfs-actions.pod:2979
11045 msgid "guestfs_inspect_get_type"
11049 #: ../src/guestfs-actions.pod:2981
11053 " guestfs_inspect_get_type (guestfs_h *g,\n"
11054 " const char *root);\n"
11059 #: ../src/guestfs-actions.pod:2988 ../fish/guestfish-actions.pod:2063
11061 "This returns the type of the inspected operating system. Currently defined "
11066 #: ../src/guestfs-actions.pod:2993 ../fish/guestfish-actions.pod:2068
11071 #: ../src/guestfs-actions.pod:2995 ../fish/guestfish-actions.pod:2070
11072 msgid "Any Linux-based operating system."
11076 #: ../src/guestfs-actions.pod:2999 ../fish/guestfish-actions.pod:2074
11077 msgid "Any Microsoft Windows operating system."
11081 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2076
11082 msgid "\"freebsd\""
11083 msgstr "\"freebsd\""
11086 #: ../src/guestfs-actions.pod:3003 ../fish/guestfish-actions.pod:2078
11091 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2082
11092 msgid "The operating system type could not be determined."
11096 #: ../src/guestfs-actions.pod:3021
11097 msgid "guestfs_inspect_get_windows_current_control_set"
11101 #: ../src/guestfs-actions.pod:3023
11105 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11106 " const char *root);\n"
11111 #: ../src/guestfs-actions.pod:3030 ../fish/guestfish-actions.pod:2098
11113 "This returns the Windows CurrentControlSet of the inspected guest. The "
11114 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11118 #: ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:2101
11120 "This call assumes that the guest is Windows and that the Registry could be "
11121 "examined by inspection. If this is not the case then an error is returned."
11125 #: ../src/guestfs-actions.pod:3042
11126 msgid "guestfs_inspect_get_windows_systemroot"
11130 #: ../src/guestfs-actions.pod:3044
11134 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11135 " const char *root);\n"
11140 #: ../src/guestfs-actions.pod:3051 ../fish/guestfish-actions.pod:2114
11142 "This returns the Windows systemroot of the inspected guest. The systemroot "
11143 "is a directory path such as C</WINDOWS>."
11147 #: ../src/guestfs-actions.pod:3054 ../fish/guestfish-actions.pod:2117
11149 "This call assumes that the guest is Windows and that the systemroot could be "
11150 "determined by inspection. If this is not the case then an error is returned."
11154 #: ../src/guestfs-actions.pod:3063
11155 msgid "(Added in 1.5.25)"
11159 #: ../src/guestfs-actions.pod:3065
11160 msgid "guestfs_inspect_is_live"
11164 #: ../src/guestfs-actions.pod:3067
11168 " guestfs_inspect_is_live (guestfs_h *g,\n"
11169 " const char *root);\n"
11174 #: ../src/guestfs-actions.pod:3074
11176 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11177 "disk), then this returns true if a live image was detected on the disk."
11181 #: ../src/guestfs-actions.pod:3082
11182 msgid "guestfs_inspect_is_multipart"
11186 #: ../src/guestfs-actions.pod:3084
11190 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11191 " const char *root);\n"
11196 #: ../src/guestfs-actions.pod:3091
11198 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11199 "disk), then this returns true if the disk is part of a set."
11203 #: ../src/guestfs-actions.pod:3099
11204 msgid "guestfs_inspect_is_netinst"
11208 #: ../src/guestfs-actions.pod:3101
11212 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11213 " const char *root);\n"
11218 #: ../src/guestfs-actions.pod:3108
11220 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11221 "disk), then this returns true if the disk is a network installer, ie. not a "
11222 "self-contained install CD but one which is likely to require network access "
11223 "to complete the install."
11227 #: ../src/guestfs-actions.pod:3118
11228 msgid "guestfs_inspect_list_applications"
11232 #: ../src/guestfs-actions.pod:3120
11235 " struct guestfs_application_list *\n"
11236 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11237 " const char *root);\n"
11242 #: ../src/guestfs-actions.pod:3127 ../fish/guestfish-actions.pod:2171
11243 msgid "Return the list of applications installed in the operating system."
11247 #: ../src/guestfs-actions.pod:3129
11249 "I<Note:> This call works differently from other parts of the inspection "
11250 "API. You have to call C<guestfs_inspect_os>, then "
11251 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11252 "this. Listing applications is a significantly more difficult operation "
11253 "which requires access to the full filesystem. Also note that unlike the "
11254 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11255 "the libguestfs handle, this call actually reads parts of the mounted "
11256 "filesystems during the call."
11260 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2183
11262 "This returns an empty list if the inspection code was not able to determine "
11263 "the list of applications."
11267 #: ../src/guestfs-actions.pod:3142 ../fish/guestfish-actions.pod:2186
11268 msgid "The application structure contains the following fields:"
11272 #: ../src/guestfs-actions.pod:3146 ../fish/guestfish-actions.pod:2190
11273 msgid "C<app_name>"
11274 msgstr "C<app_name>"
11277 #: ../src/guestfs-actions.pod:3148 ../fish/guestfish-actions.pod:2192
11279 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11280 "guests, this is the package name."
11284 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2195
11285 msgid "C<app_display_name>"
11286 msgstr "C<app_display_name>"
11289 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2197
11291 "The display name of the application, sometimes localized to the install "
11292 "language of the guest operating system."
11296 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
11298 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11299 "to display something can use C<app_name> instead."
11303 #: ../src/guestfs-actions.pod:3159 ../fish/guestfish-actions.pod:2203
11304 msgid "C<app_epoch>"
11305 msgstr "C<app_epoch>"
11308 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
11310 "For package managers which use epochs, this contains the epoch of the "
11311 "package (an integer). If unavailable, this is returned as C<0>."
11315 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2208
11316 msgid "C<app_version>"
11317 msgstr "C<app_version>"
11320 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2210
11322 "The version string of the application or package. If unavailable this is "
11323 "returned as an empty string C<\"\">."
11327 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
11328 msgid "C<app_release>"
11329 msgstr "C<app_release>"
11332 #: ../src/guestfs-actions.pod:3171 ../fish/guestfish-actions.pod:2215
11334 "The release string of the application or package, for package managers that "
11335 "use this. If unavailable this is returned as an empty string C<\"\">."
11339 #: ../src/guestfs-actions.pod:3175 ../fish/guestfish-actions.pod:2219
11340 msgid "C<app_install_path>"
11341 msgstr "C<app_install_path>"
11344 #: ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2221
11346 "The installation path of the application (on operating systems such as "
11347 "Windows which use installation paths). This path is in the format used by "
11348 "the guest operating system, it is not a libguestfs path."
11352 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2226
11353 msgid "If unavailable this is returned as an empty string C<\"\">."
11357 #: ../src/guestfs-actions.pod:3184 ../fish/guestfish-actions.pod:2228
11358 msgid "C<app_trans_path>"
11359 msgstr "C<app_trans_path>"
11362 #: ../src/guestfs-actions.pod:3186 ../fish/guestfish-actions.pod:2230
11364 "The install path translated into a libguestfs path. If unavailable this is "
11365 "returned as an empty string C<\"\">."
11369 #: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2233
11370 msgid "C<app_publisher>"
11371 msgstr "C<app_publisher>"
11374 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2235
11376 "The name of the publisher of the application, for package managers that use "
11377 "this. If unavailable this is returned as an empty string C<\"\">."
11381 #: ../src/guestfs-actions.pod:3195 ../fish/guestfish-actions.pod:2239
11383 msgstr "C<app_url>"
11386 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2241
11388 "The URL (eg. upstream URL) of the application. If unavailable this is "
11389 "returned as an empty string C<\"\">."
11393 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2244
11394 msgid "C<app_source_package>"
11398 #: ../src/guestfs-actions.pod:3202 ../fish/guestfish-actions.pod:2246
11400 "For packaging systems which support this, the name of the source package. "
11401 "If unavailable this is returned as an empty string C<\"\">."
11405 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
11406 msgid "C<app_summary>"
11410 #: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2251
11412 "A short (usually one line) description of the application or package. If "
11413 "unavailable this is returned as an empty string C<\"\">."
11417 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
11418 msgid "C<app_description>"
11422 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2256
11424 "A longer description of the application or package. If unavailable this is "
11425 "returned as an empty string C<\"\">."
11429 #: ../src/guestfs-actions.pod:3219
11431 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11432 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11437 #: ../src/guestfs-actions.pod:3223
11438 msgid "(Added in 1.7.8)"
11442 #: ../src/guestfs-actions.pod:3225
11443 msgid "guestfs_inspect_os"
11447 #: ../src/guestfs-actions.pod:3227
11451 " guestfs_inspect_os (guestfs_h *g);\n"
11456 #: ../src/guestfs-actions.pod:3230 ../fish/guestfish-actions.pod:2267
11458 "This function uses other libguestfs functions and certain heuristics to "
11459 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11460 "for operating systems."
11464 #: ../src/guestfs-actions.pod:3234 ../fish/guestfish-actions.pod:2271
11465 msgid "The list returned is empty if no operating systems were found."
11469 #: ../src/guestfs-actions.pod:3236 ../fish/guestfish-actions.pod:2273
11471 "If one operating system was found, then this returns a list with a single "
11472 "element, which is the name of the root filesystem of this operating system. "
11473 "It is also possible for this function to return a list containing more than "
11474 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11475 "element being the root filesystem of one of the operating systems."
11479 #: ../src/guestfs-actions.pod:3243
11481 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11482 "functions in order to query further information about each operating system, "
11483 "such as the name and version."
11487 #: ../src/guestfs-actions.pod:3248
11489 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11490 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11491 "the contents. This should be called with no disks currently mounted. The "
11492 "function may also use Augeas, so any existing Augeas handle will be closed."
11496 #: ../src/guestfs-actions.pod:3254 ../fish/guestfish-actions.pod:2291
11498 "This function cannot decrypt encrypted disks. The caller must do that first "
11499 "(supplying the necessary keys) if the disk is encrypted."
11503 #: ../src/guestfs-actions.pod:3260 ../src/guestfs-actions.pod:3550
11504 #: ../src/guestfs-actions.pod:3612
11505 msgid "See also C<guestfs_list_filesystems>."
11509 #: ../src/guestfs-actions.pod:3268
11510 msgid "guestfs_is_blockdev"
11514 #: ../src/guestfs-actions.pod:3270
11518 " guestfs_is_blockdev (guestfs_h *g,\n"
11519 " const char *path);\n"
11524 #: ../src/guestfs-actions.pod:3274 ../fish/guestfish-actions.pod:2303
11526 "This returns C<true> if and only if there is a block device with the given "
11531 #: ../src/guestfs-actions.pod:3277 ../src/guestfs-actions.pod:3306
11532 #: ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:3351
11533 #: ../src/guestfs-actions.pod:3367 ../src/guestfs-actions.pod:3423
11534 #: ../src/guestfs-actions.pod:3438
11535 msgid "See also C<guestfs_stat>."
11539 #: ../src/guestfs-actions.pod:3281 ../src/guestfs-actions.pod:3310
11540 #: ../src/guestfs-actions.pod:3355 ../src/guestfs-actions.pod:3427
11541 #: ../src/guestfs-actions.pod:3442
11542 msgid "(Added in 1.5.10)"
11546 #: ../src/guestfs-actions.pod:3283
11547 msgid "guestfs_is_busy"
11551 #: ../src/guestfs-actions.pod:3285
11555 " guestfs_is_busy (guestfs_h *g);\n"
11560 #: ../src/guestfs-actions.pod:3288 ../fish/guestfish-actions.pod:2312
11562 "This returns true iff this handle is busy processing a command (in the "
11567 #: ../src/guestfs-actions.pod:3297
11568 msgid "guestfs_is_chardev"
11572 #: ../src/guestfs-actions.pod:3299
11576 " guestfs_is_chardev (guestfs_h *g,\n"
11577 " const char *path);\n"
11582 #: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2321
11584 "This returns C<true> if and only if there is a character device with the "
11585 "given C<path> name."
11589 #: ../src/guestfs-actions.pod:3312
11590 msgid "guestfs_is_config"
11594 #: ../src/guestfs-actions.pod:3314
11598 " guestfs_is_config (guestfs_h *g);\n"
11603 #: ../src/guestfs-actions.pod:3317 ../fish/guestfish-actions.pod:2330
11605 "This returns true iff this handle is being configured (in the C<CONFIG> "
11610 #: ../src/guestfs-actions.pod:3326
11611 msgid "guestfs_is_dir"
11615 #: ../src/guestfs-actions.pod:3328
11619 " guestfs_is_dir (guestfs_h *g,\n"
11620 " const char *path);\n"
11625 #: ../src/guestfs-actions.pod:3332 ../fish/guestfish-actions.pod:2339
11627 "This returns C<true> if and only if there is a directory with the given "
11628 "C<path> name. Note that it returns false for other objects like files."
11632 #: ../src/guestfs-actions.pod:3342
11633 msgid "guestfs_is_fifo"
11637 #: ../src/guestfs-actions.pod:3344
11641 " guestfs_is_fifo (guestfs_h *g,\n"
11642 " const char *path);\n"
11647 #: ../src/guestfs-actions.pod:3348 ../fish/guestfish-actions.pod:2349
11649 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11650 "given C<path> name."
11654 #: ../src/guestfs-actions.pod:3357
11655 msgid "guestfs_is_file"
11659 #: ../src/guestfs-actions.pod:3359
11663 " guestfs_is_file (guestfs_h *g,\n"
11664 " const char *path);\n"
11669 #: ../src/guestfs-actions.pod:3363 ../fish/guestfish-actions.pod:2358
11671 "This returns C<true> if and only if there is a regular file with the given "
11672 "C<path> name. Note that it returns false for other objects like directories."
11676 #: ../src/guestfs-actions.pod:3373
11677 msgid "guestfs_is_launching"
11681 #: ../src/guestfs-actions.pod:3375
11685 " guestfs_is_launching (guestfs_h *g);\n"
11690 #: ../src/guestfs-actions.pod:3378 ../fish/guestfish-actions.pod:2368
11692 "This returns true iff this handle is launching the subprocess (in the "
11693 "C<LAUNCHING> state)."
11697 #: ../src/guestfs-actions.pod:3387
11698 msgid "guestfs_is_lv"
11702 #: ../src/guestfs-actions.pod:3389
11706 " guestfs_is_lv (guestfs_h *g,\n"
11707 " const char *device);\n"
11712 #: ../src/guestfs-actions.pod:3393 ../fish/guestfish-actions.pod:2377
11714 "This command tests whether C<device> is a logical volume, and returns true "
11715 "iff this is the case."
11719 #: ../src/guestfs-actions.pod:3400
11720 msgid "guestfs_is_ready"
11724 #: ../src/guestfs-actions.pod:3402
11728 " guestfs_is_ready (guestfs_h *g);\n"
11733 #: ../src/guestfs-actions.pod:3405 ../fish/guestfish-actions.pod:2384
11735 "This returns true iff this handle is ready to accept commands (in the "
11740 #: ../src/guestfs-actions.pod:3414
11741 msgid "guestfs_is_socket"
11745 #: ../src/guestfs-actions.pod:3416
11749 " guestfs_is_socket (guestfs_h *g,\n"
11750 " const char *path);\n"
11755 #: ../src/guestfs-actions.pod:3420 ../fish/guestfish-actions.pod:2393
11757 "This returns C<true> if and only if there is a Unix domain socket with the "
11758 "given C<path> name."
11762 #: ../src/guestfs-actions.pod:3429
11763 msgid "guestfs_is_symlink"
11767 #: ../src/guestfs-actions.pod:3431
11771 " guestfs_is_symlink (guestfs_h *g,\n"
11772 " const char *path);\n"
11777 #: ../src/guestfs-actions.pod:3435 ../fish/guestfish-actions.pod:2402
11779 "This returns C<true> if and only if there is a symbolic link with the given "
11784 #: ../src/guestfs-actions.pod:3444
11785 msgid "guestfs_kill_subprocess"
11789 #: ../src/guestfs-actions.pod:3446
11793 " guestfs_kill_subprocess (guestfs_h *g);\n"
11798 #: ../src/guestfs-actions.pod:3449 ../fish/guestfish-actions.pod:2411
11799 msgid "This kills the qemu subprocess. You should never need to call this."
11803 #: ../src/guestfs-actions.pod:3455
11804 msgid "guestfs_launch"
11808 #: ../src/guestfs-actions.pod:3457
11812 " guestfs_launch (guestfs_h *g);\n"
11817 #: ../src/guestfs-actions.pod:3460 ../fish/guestfish-actions.pod:2419
11819 "Internally libguestfs is implemented by running a virtual machine using "
11824 #: ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:2422
11826 "You should call this after configuring the handle (eg. adding drives) but "
11827 "before performing any actions."
11831 #: ../src/guestfs-actions.pod:3475
11832 msgid "guestfs_lchown"
11836 #: ../src/guestfs-actions.pod:3477
11840 " guestfs_lchown (guestfs_h *g,\n"
11843 " const char *path);\n"
11848 #: ../src/guestfs-actions.pod:3483
11850 "Change the file owner to C<owner> and group to C<group>. This is like "
11851 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
11852 "changed, not the target."
11856 #: ../src/guestfs-actions.pod:3495
11857 msgid "guestfs_lgetxattr"
11861 #: ../src/guestfs-actions.pod:3497
11865 " guestfs_lgetxattr (guestfs_h *g,\n"
11866 " const char *path,\n"
11867 " const char *name,\n"
11868 " size_t *size_r);\n"
11873 #: ../src/guestfs-actions.pod:3503 ../fish/guestfish-actions.pod:2441
11875 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
11876 "is a symlink, then this call returns an extended attribute from the symlink."
11880 #: ../src/guestfs-actions.pod:3517
11881 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
11885 #: ../src/guestfs-actions.pod:3525
11886 msgid "guestfs_lgetxattrs"
11890 #: ../src/guestfs-actions.pod:3527
11893 " struct guestfs_xattr_list *\n"
11894 " guestfs_lgetxattrs (guestfs_h *g,\n"
11895 " const char *path);\n"
11900 #: ../src/guestfs-actions.pod:3531
11902 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
11903 "then it returns the extended attributes of the link itself."
11907 #: ../src/guestfs-actions.pod:3541
11908 msgid "guestfs_list_devices"
11912 #: ../src/guestfs-actions.pod:3543
11916 " guestfs_list_devices (guestfs_h *g);\n"
11921 #: ../src/guestfs-actions.pod:3546 ../fish/guestfish-actions.pod:2469
11922 msgid "List all the block devices."
11926 #: ../src/guestfs-actions.pod:3548 ../fish/guestfish-actions.pod:2471
11927 msgid "The full block device names are returned, eg. C</dev/sda>."
11931 #: ../src/guestfs-actions.pod:3558
11932 msgid "guestfs_list_filesystems"
11936 #: ../src/guestfs-actions.pod:3560
11940 " guestfs_list_filesystems (guestfs_h *g);\n"
11945 #: ../src/guestfs-actions.pod:3563 ../fish/guestfish-actions.pod:2479
11947 "This inspection command looks for filesystems on partitions, block devices "
11948 "and logical volumes, returning a list of devices containing filesystems and "
11953 #: ../src/guestfs-actions.pod:3567 ../fish/guestfish-actions.pod:2483
11955 "The return value is a hash, where the keys are the devices containing "
11956 "filesystems, and the values are the filesystem types. For example:"
11960 #: ../src/guestfs-actions.pod:3571 ../fish/guestfish-actions.pod:2487
11963 " \"/dev/sda1\" => \"ntfs\"\n"
11964 " \"/dev/sda2\" => \"ext2\"\n"
11965 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
11966 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
11971 #: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2492
11973 "The value can have the special value \"unknown\", meaning the content of the "
11974 "device is undetermined or empty. \"swap\" means a Linux swap partition."
11978 #: ../src/guestfs-actions.pod:3580
11980 "This command runs other libguestfs commands, which might include "
11981 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
11982 "soon after launch and only when nothing is mounted."
11986 #: ../src/guestfs-actions.pod:3584
11988 "Not all of the filesystems returned will be mountable. In particular, swap "
11989 "partitions are returned in the list. Also this command does not check that "
11990 "each filesystem found is valid and mountable, and some filesystems might be "
11991 "mountable but require special options. Filesystems may not all belong to a "
11992 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
11996 #: ../src/guestfs-actions.pod:3598 ../src/guestfs-actions.pod:5203
11997 msgid "(Added in 1.5.15)"
12001 #: ../src/guestfs-actions.pod:3600
12002 msgid "guestfs_list_partitions"
12006 #: ../src/guestfs-actions.pod:3602
12010 " guestfs_list_partitions (guestfs_h *g);\n"
12015 #: ../src/guestfs-actions.pod:3605 ../fish/guestfish-actions.pod:2512
12016 msgid "List all the partitions detected on all block devices."
12020 #: ../src/guestfs-actions.pod:3607 ../fish/guestfish-actions.pod:2514
12021 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12025 #: ../src/guestfs-actions.pod:3609
12027 "This does not return logical volumes. For that you will need to call "
12032 #: ../src/guestfs-actions.pod:3620
12037 #: ../src/guestfs-actions.pod:3622
12041 " guestfs_ll (guestfs_h *g,\n"
12042 " const char *directory);\n"
12047 #: ../src/guestfs-actions.pod:3626 ../fish/guestfish-actions.pod:2525
12049 "List the files in C<directory> (relative to the root directory, there is no "
12050 "cwd) in the format of 'ls -la'."
12054 #: ../src/guestfs-actions.pod:3629 ../fish/guestfish-actions.pod:2528
12056 "This command is mostly useful for interactive sessions. It is I<not> "
12057 "intended that you try to parse the output string."
12061 #: ../src/guestfs-actions.pod:3637
12066 #: ../src/guestfs-actions.pod:3639
12070 " guestfs_ln (guestfs_h *g,\n"
12071 " const char *target,\n"
12072 " const char *linkname);\n"
12077 #: ../src/guestfs-actions.pod:3644 ../fish/guestfish-actions.pod:2535
12078 msgid "This command creates a hard link using the C<ln> command."
12082 #: ../src/guestfs-actions.pod:3650
12083 msgid "guestfs_ln_f"
12087 #: ../src/guestfs-actions.pod:3652
12091 " guestfs_ln_f (guestfs_h *g,\n"
12092 " const char *target,\n"
12093 " const char *linkname);\n"
12098 #: ../src/guestfs-actions.pod:3657 ../fish/guestfish-actions.pod:2541
12100 "This command creates a hard link using the C<ln -f> command. The C<-f> "
12101 "option removes the link (C<linkname>) if it exists already."
12105 #: ../src/guestfs-actions.pod:3664
12106 msgid "guestfs_ln_s"
12110 #: ../src/guestfs-actions.pod:3666
12114 " guestfs_ln_s (guestfs_h *g,\n"
12115 " const char *target,\n"
12116 " const char *linkname);\n"
12121 #: ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:2548
12122 msgid "This command creates a symbolic link using the C<ln -s> command."
12126 #: ../src/guestfs-actions.pod:3677
12127 msgid "guestfs_ln_sf"
12131 #: ../src/guestfs-actions.pod:3679
12135 " guestfs_ln_sf (guestfs_h *g,\n"
12136 " const char *target,\n"
12137 " const char *linkname);\n"
12142 #: ../src/guestfs-actions.pod:3684 ../fish/guestfish-actions.pod:2554
12144 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
12145 "option removes the link (C<linkname>) if it exists already."
12149 #: ../src/guestfs-actions.pod:3691
12150 msgid "guestfs_lremovexattr"
12154 #: ../src/guestfs-actions.pod:3693
12158 " guestfs_lremovexattr (guestfs_h *g,\n"
12159 " const char *xattr,\n"
12160 " const char *path);\n"
12165 #: ../src/guestfs-actions.pod:3698
12167 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12168 "link, then it removes an extended attribute of the link itself."
12172 #: ../src/guestfs-actions.pod:3706
12177 #: ../src/guestfs-actions.pod:3708
12181 " guestfs_ls (guestfs_h *g,\n"
12182 " const char *directory);\n"
12187 #: ../src/guestfs-actions.pod:3712 ../fish/guestfish-actions.pod:2569
12189 "List the files in C<directory> (relative to the root directory, there is no "
12190 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12194 #: ../src/guestfs-actions.pod:3716
12196 "This command is mostly useful for interactive sessions. Programs should "
12197 "probably use C<guestfs_readdir> instead."
12201 #: ../src/guestfs-actions.pod:3725
12202 msgid "guestfs_lsetxattr"
12206 #: ../src/guestfs-actions.pod:3727
12210 " guestfs_lsetxattr (guestfs_h *g,\n"
12211 " const char *xattr,\n"
12212 " const char *val,\n"
12214 " const char *path);\n"
12219 #: ../src/guestfs-actions.pod:3734
12221 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12222 "then it sets an extended attribute of the link itself."
12226 #: ../src/guestfs-actions.pod:3742
12227 msgid "guestfs_lstat"
12231 #: ../src/guestfs-actions.pod:3744
12234 " struct guestfs_stat *\n"
12235 " guestfs_lstat (guestfs_h *g,\n"
12236 " const char *path);\n"
12241 #: ../src/guestfs-actions.pod:3748 ../src/guestfs-actions.pod:6306
12242 #: ../fish/guestfish-actions.pod:2588 ../fish/guestfish-actions.pod:4257
12243 msgid "Returns file information for the given C<path>."
12247 #: ../src/guestfs-actions.pod:3750
12249 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12250 "link, then the link is stat-ed, not the file it refers to."
12254 #: ../src/guestfs-actions.pod:3754 ../fish/guestfish-actions.pod:2594
12255 msgid "This is the same as the C<lstat(2)> system call."
12259 #: ../src/guestfs-actions.pod:3756 ../src/guestfs-actions.pod:6310
12261 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12262 "error. I<The caller must call C<guestfs_free_stat> after use>."
12266 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:6314
12267 #: ../src/guestfs-actions.pod:6332 ../src/guestfs-actions.pod:6713
12268 msgid "(Added in 0.9.2)"
12272 #: ../src/guestfs-actions.pod:3762
12273 msgid "guestfs_lstatlist"
12277 #: ../src/guestfs-actions.pod:3764
12280 " struct guestfs_stat_list *\n"
12281 " guestfs_lstatlist (guestfs_h *g,\n"
12282 " const char *path,\n"
12283 " char *const *names);\n"
12288 #: ../src/guestfs-actions.pod:3769
12290 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12291 "files, where all files are in the directory C<path>. C<names> is the list "
12292 "of files from this directory."
12296 #: ../src/guestfs-actions.pod:3773 ../fish/guestfish-actions.pod:2604
12298 "On return you get a list of stat structs, with a one-to-one correspondence "
12299 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12300 "then the C<ino> field of that structure is set to C<-1>."
12304 #: ../src/guestfs-actions.pod:3778
12306 "This call is intended for programs that want to efficiently list a directory "
12307 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12308 "for a similarly efficient call for getting extended attributes. Very long "
12309 "directory listings might cause the protocol message size to be exceeded, "
12310 "causing this call to fail. The caller must split up such requests into "
12311 "smaller groups of names."
12315 #: ../src/guestfs-actions.pod:3786
12317 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12318 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12322 #: ../src/guestfs-actions.pod:3792
12323 msgid "guestfs_luks_add_key"
12327 #: ../src/guestfs-actions.pod:3794
12331 " guestfs_luks_add_key (guestfs_h *g,\n"
12332 " const char *device,\n"
12333 " const char *key,\n"
12334 " const char *newkey,\n"
12340 #: ../src/guestfs-actions.pod:3801 ../fish/guestfish-actions.pod:2621
12342 "This command adds a new key on LUKS device C<device>. C<key> is any "
12343 "existing key, and is used to access the device. C<newkey> is the new key to "
12344 "add. C<keyslot> is the key slot that will be replaced."
12348 #: ../src/guestfs-actions.pod:3806
12350 "Note that if C<keyslot> already contains a key, then this command will "
12351 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12355 #: ../src/guestfs-actions.pod:3812 ../src/guestfs-actions.pod:3852
12356 #: ../src/guestfs-actions.pod:3875 ../src/guestfs-actions.pod:3895
12357 #: ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:3946
12359 "This function takes a key or passphrase parameter which could contain "
12360 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12365 #: ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3856
12366 #: ../src/guestfs-actions.pod:3879 ../src/guestfs-actions.pod:3899
12367 msgid "(Added in 1.5.2)"
12371 #: ../src/guestfs-actions.pod:3818
12372 msgid "guestfs_luks_close"
12376 #: ../src/guestfs-actions.pod:3820
12380 " guestfs_luks_close (guestfs_h *g,\n"
12381 " const char *device);\n"
12386 #: ../src/guestfs-actions.pod:3824
12388 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12389 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12390 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12391 "underlying block device."
12395 #: ../src/guestfs-actions.pod:3832 ../src/guestfs-actions.pod:3931
12396 #: ../src/guestfs-actions.pod:3950 ../src/guestfs-actions.pod:4000
12397 #: ../src/guestfs-actions.pod:4048
12398 msgid "(Added in 1.5.1)"
12402 #: ../src/guestfs-actions.pod:3834
12403 msgid "guestfs_luks_format"
12407 #: ../src/guestfs-actions.pod:3836
12411 " guestfs_luks_format (guestfs_h *g,\n"
12412 " const char *device,\n"
12413 " const char *key,\n"
12419 #: ../src/guestfs-actions.pod:3842 ../fish/guestfish-actions.pod:2647
12421 "This command erases existing data on C<device> and formats the device as a "
12422 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12423 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12427 #: ../src/guestfs-actions.pod:3849 ../src/guestfs-actions.pod:3872
12428 #: ../src/guestfs-actions.pod:4012 ../src/guestfs-actions.pod:4954
12429 #: ../src/guestfs-actions.pod:5734 ../src/guestfs-actions.pod:6141
12430 #: ../src/guestfs-actions.pod:6164 ../src/guestfs-actions.pod:6190
12431 #: ../src/guestfs-actions.pod:7350 ../fish/guestfish-actions.pod:2655
12432 #: ../fish/guestfish-actions.pod:2668 ../fish/guestfish-actions.pod:2752
12433 #: ../fish/guestfish-actions.pod:3326 ../fish/guestfish-actions.pod:3846
12434 #: ../fish/guestfish-actions.pod:4156 ../fish/guestfish-actions.pod:4172
12435 #: ../fish/guestfish-actions.pod:4187 ../fish/guestfish-actions.pod:4902
12437 "B<This command is dangerous. Without careful use you can easily destroy all "
12442 #: ../src/guestfs-actions.pod:3858
12443 msgid "guestfs_luks_format_cipher"
12447 #: ../src/guestfs-actions.pod:3860
12451 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12452 " const char *device,\n"
12453 " const char *key,\n"
12455 " const char *cipher);\n"
12460 #: ../src/guestfs-actions.pod:3867
12462 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12463 "set the C<cipher> used."
12467 #: ../src/guestfs-actions.pod:3881
12468 msgid "guestfs_luks_kill_slot"
12472 #: ../src/guestfs-actions.pod:3883
12476 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12477 " const char *device,\n"
12478 " const char *key,\n"
12484 #: ../src/guestfs-actions.pod:3889 ../fish/guestfish-actions.pod:2675
12486 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12487 "device C<device>. C<key> must be one of the I<other> keys."
12491 #: ../src/guestfs-actions.pod:3901
12492 msgid "guestfs_luks_open"
12496 #: ../src/guestfs-actions.pod:3903
12500 " guestfs_luks_open (guestfs_h *g,\n"
12501 " const char *device,\n"
12502 " const char *key,\n"
12503 " const char *mapname);\n"
12508 #: ../src/guestfs-actions.pod:3909 ../fish/guestfish-actions.pod:2686
12510 "This command opens a block device which has been encrypted according to the "
12511 "Linux Unified Key Setup (LUKS) standard."
12515 #: ../src/guestfs-actions.pod:3912 ../fish/guestfish-actions.pod:2689
12516 msgid "C<device> is the encrypted block device or partition."
12520 #: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:2691
12522 "The caller must supply one of the keys associated with the LUKS block "
12523 "device, in the C<key> parameter."
12527 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2694
12529 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12530 "writes to this block device are decrypted from and encrypted to the "
12531 "underlying C<device> respectively."
12535 #: ../src/guestfs-actions.pod:3921
12537 "If this block device contains LVM volume groups, then calling "
12538 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12543 #: ../src/guestfs-actions.pod:3933
12544 msgid "guestfs_luks_open_ro"
12548 #: ../src/guestfs-actions.pod:3935
12552 " guestfs_luks_open_ro (guestfs_h *g,\n"
12553 " const char *device,\n"
12554 " const char *key,\n"
12555 " const char *mapname);\n"
12560 #: ../src/guestfs-actions.pod:3941
12562 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12567 #: ../src/guestfs-actions.pod:3952
12568 msgid "guestfs_lvcreate"
12572 #: ../src/guestfs-actions.pod:3954
12576 " guestfs_lvcreate (guestfs_h *g,\n"
12577 " const char *logvol,\n"
12578 " const char *volgroup,\n"
12584 #: ../src/guestfs-actions.pod:3960 ../fish/guestfish-actions.pod:2719
12586 "This creates an LVM logical volume called C<logvol> on the volume group "
12587 "C<volgroup>, with C<size> megabytes."
12591 #: ../src/guestfs-actions.pod:3967
12592 msgid "guestfs_lvm_canonical_lv_name"
12596 #: ../src/guestfs-actions.pod:3969
12600 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12601 " const char *lvname);\n"
12606 #: ../src/guestfs-actions.pod:3973 ../fish/guestfish-actions.pod:2726
12608 "This converts alternative naming schemes for LVs that you might find to the "
12609 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
12614 #: ../src/guestfs-actions.pod:3977 ../fish/guestfish-actions.pod:2730
12616 "This command returns an error if the C<lvname> parameter does not refer to a "
12621 #: ../src/guestfs-actions.pod:3980
12622 msgid "See also C<guestfs_is_lv>."
12626 #: ../src/guestfs-actions.pod:3985
12627 msgid "(Added in 1.5.24)"
12631 #: ../src/guestfs-actions.pod:3987
12632 msgid "guestfs_lvm_clear_filter"
12636 #: ../src/guestfs-actions.pod:3989
12640 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12645 #: ../src/guestfs-actions.pod:3992
12647 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12648 "see every block device."
12652 #: ../src/guestfs-actions.pod:3995 ../src/guestfs-actions.pod:4037
12653 #: ../fish/guestfish-actions.pod:2742 ../fish/guestfish-actions.pod:2773
12655 "This command also clears the LVM cache and performs a volume group scan."
12659 #: ../src/guestfs-actions.pod:4002
12660 msgid "guestfs_lvm_remove_all"
12664 #: ../src/guestfs-actions.pod:4004
12668 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12673 #: ../src/guestfs-actions.pod:4007 ../fish/guestfish-actions.pod:2749
12675 "This command removes all LVM logical volumes, volume groups and physical "
12680 #: ../src/guestfs-actions.pod:4017
12681 msgid "guestfs_lvm_set_filter"
12685 #: ../src/guestfs-actions.pod:4019
12689 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12690 " char *const *devices);\n"
12695 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2759
12697 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12698 "block devices in the list C<devices>, and will ignore all other attached "
12703 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2763
12705 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12706 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12707 "there are two types of duplication possible: either cloned PVs/VGs which "
12708 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12709 "same name. In normal operation you cannot create this situation, but you "
12710 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12711 "inside the LVM metadata."
12715 #: ../src/guestfs-actions.pod:4040 ../fish/guestfish-actions.pod:2776
12716 msgid "You can filter whole block devices or individual partitions."
12720 #: ../src/guestfs-actions.pod:4042 ../fish/guestfish-actions.pod:2778
12722 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12723 "filesystem), even if you are not filtering out that VG."
12727 #: ../src/guestfs-actions.pod:4050
12728 msgid "guestfs_lvremove"
12732 #: ../src/guestfs-actions.pod:4052
12736 " guestfs_lvremove (guestfs_h *g,\n"
12737 " const char *device);\n"
12742 #: ../src/guestfs-actions.pod:4056 ../fish/guestfish-actions.pod:2786
12744 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12745 "LV, such as C</dev/VG/LV>."
12749 #: ../src/guestfs-actions.pod:4059 ../fish/guestfish-actions.pod:2789
12751 "You can also remove all LVs in a volume group by specifying the VG name, C</"
12756 #: ../src/guestfs-actions.pod:4064 ../src/guestfs-actions.pod:5300
12757 #: ../src/guestfs-actions.pod:7089
12758 msgid "(Added in 1.0.13)"
12762 #: ../src/guestfs-actions.pod:4066
12763 msgid "guestfs_lvrename"
12767 #: ../src/guestfs-actions.pod:4068
12771 " guestfs_lvrename (guestfs_h *g,\n"
12772 " const char *logvol,\n"
12773 " const char *newlogvol);\n"
12778 #: ../src/guestfs-actions.pod:4073 ../fish/guestfish-actions.pod:2796
12779 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12783 #: ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:7102
12784 msgid "(Added in 1.0.83)"
12788 #: ../src/guestfs-actions.pod:4079
12789 msgid "guestfs_lvresize"
12793 #: ../src/guestfs-actions.pod:4081
12797 " guestfs_lvresize (guestfs_h *g,\n"
12798 " const char *device,\n"
12804 #: ../src/guestfs-actions.pod:4086 ../fish/guestfish-actions.pod:2802
12806 "This resizes (expands or shrinks) an existing LVM logical volume to "
12807 "C<mbytes>. When reducing, data in the reduced part is lost."
12811 #: ../src/guestfs-actions.pod:4094
12812 msgid "guestfs_lvresize_free"
12816 #: ../src/guestfs-actions.pod:4096
12820 " guestfs_lvresize_free (guestfs_h *g,\n"
12821 " const char *lv,\n"
12827 #: ../src/guestfs-actions.pod:4101 ../fish/guestfish-actions.pod:2810
12829 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
12830 "remaining free space in the volume group. Commonly you would call this with "
12831 "pc = 100 which expands the logical volume as much as possible, using all "
12832 "remaining free space in the volume group."
12836 #: ../src/guestfs-actions.pod:4109
12837 msgid "(Added in 1.3.3)"
12841 #: ../src/guestfs-actions.pod:4111
12842 msgid "guestfs_lvs"
12846 #: ../src/guestfs-actions.pod:4113
12850 " guestfs_lvs (guestfs_h *g);\n"
12855 #: ../src/guestfs-actions.pod:4116 ../fish/guestfish-actions.pod:2820
12857 "List all the logical volumes detected. This is the equivalent of the L<lvs"
12862 #: ../src/guestfs-actions.pod:4119 ../fish/guestfish-actions.pod:2823
12864 "This returns a list of the logical volume device names (eg. C</dev/"
12865 "VolGroup00/LogVol00>)."
12869 #: ../src/guestfs-actions.pod:4122
12870 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
12874 #: ../src/guestfs-actions.pod:4130
12875 msgid "guestfs_lvs_full"
12879 #: ../src/guestfs-actions.pod:4132
12882 " struct guestfs_lvm_lv_list *\n"
12883 " guestfs_lvs_full (guestfs_h *g);\n"
12888 #: ../src/guestfs-actions.pod:4135 ../fish/guestfish-actions.pod:2832
12890 "List all the logical volumes detected. This is the equivalent of the L<lvs"
12891 "(8)> command. The \"full\" version includes all fields."
12895 #: ../src/guestfs-actions.pod:4138
12897 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
12898 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
12902 #: ../src/guestfs-actions.pod:4144
12903 msgid "guestfs_lvuuid"
12907 #: ../src/guestfs-actions.pod:4146
12911 " guestfs_lvuuid (guestfs_h *g,\n"
12912 " const char *device);\n"
12917 #: ../src/guestfs-actions.pod:4150 ../fish/guestfish-actions.pod:2839
12918 msgid "This command returns the UUID of the LVM LV C<device>."
12922 #: ../src/guestfs-actions.pod:4157
12923 msgid "guestfs_lxattrlist"
12927 #: ../src/guestfs-actions.pod:4159
12930 " struct guestfs_xattr_list *\n"
12931 " guestfs_lxattrlist (guestfs_h *g,\n"
12932 " const char *path,\n"
12933 " char *const *names);\n"
12938 #: ../src/guestfs-actions.pod:4164 ../fish/guestfish-actions.pod:2845
12940 "This call allows you to get the extended attributes of multiple files, where "
12941 "all files are in the directory C<path>. C<names> is the list of files from "
12946 #: ../src/guestfs-actions.pod:4168 ../fish/guestfish-actions.pod:2849
12948 "On return you get a flat list of xattr structs which must be interpreted "
12949 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
12950 "C<attrval> in this struct is zero-length to indicate there was an error "
12951 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
12952 "number (the number of following attributes for this file, which could be C<"
12953 "\"0\">). Then after the first xattr struct are the zero or more attributes "
12954 "for the first named file. This repeats for the second and subsequent files."
12958 #: ../src/guestfs-actions.pod:4178
12960 "This call is intended for programs that want to efficiently list a directory "
12961 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
12962 "a similarly efficient call for getting standard stats. Very long directory "
12963 "listings might cause the protocol message size to be exceeded, causing this "
12964 "call to fail. The caller must split up such requests into smaller groups of "
12969 #: ../src/guestfs-actions.pod:4192
12970 msgid "guestfs_mkdir"
12974 #: ../src/guestfs-actions.pod:4194
12978 " guestfs_mkdir (guestfs_h *g,\n"
12979 " const char *path);\n"
12984 #: ../src/guestfs-actions.pod:4198 ../fish/guestfish-actions.pod:2871
12985 msgid "Create a directory named C<path>."
12989 #: ../src/guestfs-actions.pod:4204
12990 msgid "guestfs_mkdir_mode"
12994 #: ../src/guestfs-actions.pod:4206
12998 " guestfs_mkdir_mode (guestfs_h *g,\n"
12999 " const char *path,\n"
13005 #: ../src/guestfs-actions.pod:4211 ../fish/guestfish-actions.pod:2877
13007 "This command creates a directory, setting the initial permissions of the "
13008 "directory to C<mode>."
13012 #: ../src/guestfs-actions.pod:4214 ../fish/guestfish-actions.pod:2880
13014 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13015 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13020 #: ../src/guestfs-actions.pod:4218
13021 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13025 #: ../src/guestfs-actions.pod:4224
13026 msgid "guestfs_mkdir_p"
13030 #: ../src/guestfs-actions.pod:4226
13034 " guestfs_mkdir_p (guestfs_h *g,\n"
13035 " const char *path);\n"
13040 #: ../src/guestfs-actions.pod:4230 ../fish/guestfish-actions.pod:2890
13042 "Create a directory named C<path>, creating any parent directories as "
13043 "necessary. This is like the C<mkdir -p> shell command."
13047 #: ../src/guestfs-actions.pod:4237
13048 msgid "guestfs_mkdtemp"
13052 #: ../src/guestfs-actions.pod:4239
13056 " guestfs_mkdtemp (guestfs_h *g,\n"
13057 " const char *template);\n"
13062 #: ../src/guestfs-actions.pod:4243 ../fish/guestfish-actions.pod:2897
13064 "This command creates a temporary directory. The C<template> parameter "
13065 "should be a full pathname for the temporary directory name with the final "
13066 "six characters being \"XXXXXX\"."
13070 #: ../src/guestfs-actions.pod:4248 ../fish/guestfish-actions.pod:2902
13072 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13073 "being suitable for Windows filesystems."
13077 #: ../src/guestfs-actions.pod:4251 ../fish/guestfish-actions.pod:2905
13078 msgid "The name of the temporary directory that was created is returned."
13082 #: ../src/guestfs-actions.pod:4254 ../fish/guestfish-actions.pod:2908
13083 msgid "The temporary directory is created with mode 0700 and is owned by root."
13087 #: ../src/guestfs-actions.pod:4257 ../fish/guestfish-actions.pod:2911
13089 "The caller is responsible for deleting the temporary directory and its "
13090 "contents after use."
13094 #: ../src/guestfs-actions.pod:4260 ../fish/guestfish-actions.pod:2914
13095 msgid "See also: L<mkdtemp(3)>"
13099 #: ../src/guestfs-actions.pod:4267
13100 msgid "guestfs_mke2fs_J"
13104 #: ../src/guestfs-actions.pod:4269
13108 " guestfs_mke2fs_J (guestfs_h *g,\n"
13109 " const char *fstype,\n"
13110 " int blocksize,\n"
13111 " const char *device,\n"
13112 " const char *journal);\n"
13117 #: ../src/guestfs-actions.pod:4276 ../fish/guestfish-actions.pod:2920
13119 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13120 "C<journal>. It is equivalent to the command:"
13124 #: ../src/guestfs-actions.pod:4280 ../fish/guestfish-actions.pod:2924
13127 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13132 #: ../src/guestfs-actions.pod:4282
13133 msgid "See also C<guestfs_mke2journal>."
13137 #: ../src/guestfs-actions.pod:4286 ../src/guestfs-actions.pod:4304
13138 #: ../src/guestfs-actions.pod:4322 ../src/guestfs-actions.pod:4338
13139 #: ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:4366
13140 #: ../src/guestfs-actions.pod:4425 ../src/guestfs-actions.pod:4690
13141 msgid "(Added in 1.0.68)"
13145 #: ../src/guestfs-actions.pod:4288
13146 msgid "guestfs_mke2fs_JL"
13150 #: ../src/guestfs-actions.pod:4290
13154 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13155 " const char *fstype,\n"
13156 " int blocksize,\n"
13157 " const char *device,\n"
13158 " const char *label);\n"
13163 #: ../src/guestfs-actions.pod:4297 ../fish/guestfish-actions.pod:2932
13165 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13166 "the journal labeled C<label>."
13170 #: ../src/guestfs-actions.pod:4300
13171 msgid "See also C<guestfs_mke2journal_L>."
13175 #: ../src/guestfs-actions.pod:4306
13176 msgid "guestfs_mke2fs_JU"
13180 #: ../src/guestfs-actions.pod:4308
13184 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13185 " const char *fstype,\n"
13186 " int blocksize,\n"
13187 " const char *device,\n"
13188 " const char *uuid);\n"
13193 #: ../src/guestfs-actions.pod:4315 ../fish/guestfish-actions.pod:2941
13195 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13196 "the journal with UUID C<uuid>."
13200 #: ../src/guestfs-actions.pod:4318
13201 msgid "See also C<guestfs_mke2journal_U>."
13205 #: ../src/guestfs-actions.pod:4324
13206 msgid "guestfs_mke2journal"
13210 #: ../src/guestfs-actions.pod:4326
13214 " guestfs_mke2journal (guestfs_h *g,\n"
13215 " int blocksize,\n"
13216 " const char *device);\n"
13221 #: ../src/guestfs-actions.pod:4331 ../fish/guestfish-actions.pod:2950
13223 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13228 #: ../src/guestfs-actions.pod:4334 ../fish/guestfish-actions.pod:2953
13231 " mke2fs -O journal_dev -b blocksize device\n"
13236 #: ../src/guestfs-actions.pod:4340
13237 msgid "guestfs_mke2journal_L"
13241 #: ../src/guestfs-actions.pod:4342
13245 " guestfs_mke2journal_L (guestfs_h *g,\n"
13246 " int blocksize,\n"
13247 " const char *label,\n"
13248 " const char *device);\n"
13253 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2959
13254 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13258 #: ../src/guestfs-actions.pod:4354
13259 msgid "guestfs_mke2journal_U"
13263 #: ../src/guestfs-actions.pod:4356
13267 " guestfs_mke2journal_U (guestfs_h *g,\n"
13268 " int blocksize,\n"
13269 " const char *uuid,\n"
13270 " const char *device);\n"
13275 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2965
13276 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13280 #: ../src/guestfs-actions.pod:4368
13281 msgid "guestfs_mkfifo"
13285 #: ../src/guestfs-actions.pod:4370
13289 " guestfs_mkfifo (guestfs_h *g,\n"
13291 " const char *path);\n"
13296 #: ../src/guestfs-actions.pod:4375
13298 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13299 "is just a convenient wrapper around C<guestfs_mknod>."
13303 #: ../src/guestfs-actions.pod:4385
13304 msgid "guestfs_mkfs"
13308 #: ../src/guestfs-actions.pod:4387
13312 " guestfs_mkfs (guestfs_h *g,\n"
13313 " const char *fstype,\n"
13314 " const char *device);\n"
13319 #: ../src/guestfs-actions.pod:4392 ../fish/guestfish-actions.pod:2981
13321 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13322 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13326 #: ../src/guestfs-actions.pod:4400
13327 msgid "guestfs_mkfs_b"
13331 #: ../src/guestfs-actions.pod:4402
13335 " guestfs_mkfs_b (guestfs_h *g,\n"
13336 " const char *fstype,\n"
13337 " int blocksize,\n"
13338 " const char *device);\n"
13343 #: ../src/guestfs-actions.pod:4408
13345 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13346 "block size of the resulting filesystem. Supported block sizes depend on the "
13347 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13351 #: ../src/guestfs-actions.pod:4413 ../src/guestfs-actions.pod:4456
13352 #: ../fish/guestfish-actions.pod:2994 ../fish/guestfish-actions.pod:3021
13354 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13359 #: ../src/guestfs-actions.pod:4418 ../fish/guestfish-actions.pod:2997
13361 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
13365 #: ../src/guestfs-actions.pod:4427
13366 msgid "guestfs_mkfs_opts"
13370 #: ../src/guestfs-actions.pod:4429
13374 " guestfs_mkfs_opts (guestfs_h *g,\n"
13375 " const char *fstype,\n"
13376 " const char *device,\n"
13382 #: ../src/guestfs-actions.pod:4440
13385 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13386 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13391 #: ../src/guestfs-actions.pod:4443 ../fish/guestfish-actions.pod:3008
13393 "This function creates a filesystem on C<device>. The filesystem type is "
13394 "C<fstype>, for example C<ext3>."
13398 #: ../src/guestfs-actions.pod:4450 ../fish/guestfish-actions.pod:3015
13399 msgid "C<blocksize>"
13403 #: ../src/guestfs-actions.pod:4452 ../fish/guestfish-actions.pod:3017
13405 "The filesystem block size. Supported block sizes depend on the filesystem "
13406 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13411 #: ../src/guestfs-actions.pod:4459 ../fish/guestfish-actions.pod:3024
13412 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13416 #: ../src/guestfs-actions.pod:4461 ../fish/guestfish-actions.pod:3026
13417 msgid "C<features>"
13421 #: ../src/guestfs-actions.pod:4463 ../fish/guestfish-actions.pod:3028
13422 msgid "This passes the C<-O> parameter to the external mkfs program."
13426 #: ../src/guestfs-actions.pod:4465 ../fish/guestfish-actions.pod:3030
13428 "For certain filesystem types, this allows extra filesystem features to be "
13429 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13433 #: ../src/guestfs-actions.pod:4469 ../fish/guestfish-actions.pod:3034
13435 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13440 #: ../src/guestfs-actions.pod:4476
13441 msgid "(Added in 1.7.19)"
13445 #: ../src/guestfs-actions.pod:4478
13446 msgid "guestfs_mkfs_opts_va"
13450 #: ../src/guestfs-actions.pod:4480
13454 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13455 " const char *fstype,\n"
13456 " const char *device,\n"
13457 " va_list args);\n"
13462 #: ../src/guestfs-actions.pod:4486
13463 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13467 #: ../src/guestfs-actions.pod:4490
13468 msgid "guestfs_mkfs_opts_argv"
13472 #: ../src/guestfs-actions.pod:4492
13476 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13477 " const char *fstype,\n"
13478 " const char *device,\n"
13479 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13484 #: ../src/guestfs-actions.pod:4498
13485 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13489 #: ../src/guestfs-actions.pod:4502
13490 msgid "guestfs_mkmountpoint"
13494 #: ../src/guestfs-actions.pod:4504
13498 " guestfs_mkmountpoint (guestfs_h *g,\n"
13499 " const char *exemptpath);\n"
13504 #: ../src/guestfs-actions.pod:4508
13506 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13507 "that can be used to create extra mountpoints before mounting the first "
13512 #: ../src/guestfs-actions.pod:4512 ../fish/guestfish-actions.pod:3049
13514 "These calls are I<only> necessary in some very limited circumstances, mainly "
13515 "the case where you want to mount a mix of unrelated and/or read-only "
13516 "filesystems together."
13520 #: ../src/guestfs-actions.pod:4516 ../fish/guestfish-actions.pod:3053
13522 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13523 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13524 "inside that. You can unpack this as follows in guestfish:"
13528 #: ../src/guestfs-actions.pod:4521 ../fish/guestfish-actions.pod:3058
13531 " add-ro Fedora-11-i686-Live.iso\n"
13533 " mkmountpoint /cd\n"
13534 " mkmountpoint /sqsh\n"
13535 " mkmountpoint /ext3fs\n"
13536 " mount /dev/sda /cd\n"
13537 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13538 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13543 #: ../src/guestfs-actions.pod:4530 ../fish/guestfish-actions.pod:3067
13544 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13548 #: ../src/guestfs-actions.pod:4532
13550 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13551 "may get unexpected errors if you try to mix these calls. It is safest to "
13552 "manually unmount filesystems and remove mountpoints after use."
13556 #: ../src/guestfs-actions.pod:4536
13558 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13559 "first, so for this to work for manual mountpoints, you must ensure that the "
13560 "innermost mountpoints have the longest pathnames, as in the example code "
13565 #: ../src/guestfs-actions.pod:4541 ../fish/guestfish-actions.pod:3078
13567 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13571 #: ../src/guestfs-actions.pod:4543
13573 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13574 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13575 "can also trigger these issues."
13579 #: ../src/guestfs-actions.pod:4549 ../src/guestfs-actions.pod:4808
13580 #: ../src/guestfs-actions.pod:5718
13581 msgid "(Added in 1.0.62)"
13585 #: ../src/guestfs-actions.pod:4551
13586 msgid "guestfs_mknod"
13590 #: ../src/guestfs-actions.pod:4553
13594 " guestfs_mknod (guestfs_h *g,\n"
13598 " const char *path);\n"
13603 #: ../src/guestfs-actions.pod:4560 ../fish/guestfish-actions.pod:3088
13605 "This call creates block or character special devices, or named pipes (FIFOs)."
13609 #: ../src/guestfs-actions.pod:4563 ../fish/guestfish-actions.pod:3091
13611 "The C<mode> parameter should be the mode, using the standard constants. "
13612 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13613 "used when creating block and character special devices."
13617 #: ../src/guestfs-actions.pod:4568
13619 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13620 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13621 "regular file). These constants are available in the standard Linux header "
13622 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13623 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13624 "the appropriate constant for you."
13628 #: ../src/guestfs-actions.pod:4582
13629 msgid "guestfs_mknod_b"
13633 #: ../src/guestfs-actions.pod:4584
13637 " guestfs_mknod_b (guestfs_h *g,\n"
13641 " const char *path);\n"
13646 #: ../src/guestfs-actions.pod:4591
13648 "This call creates a block device node called C<path> with mode C<mode> and "
13649 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13650 "wrapper around C<guestfs_mknod>."
13654 #: ../src/guestfs-actions.pod:4601
13655 msgid "guestfs_mknod_c"
13659 #: ../src/guestfs-actions.pod:4603
13663 " guestfs_mknod_c (guestfs_h *g,\n"
13667 " const char *path);\n"
13672 #: ../src/guestfs-actions.pod:4610
13674 "This call creates a char device node called C<path> with mode C<mode> and "
13675 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13676 "wrapper around C<guestfs_mknod>."
13680 #: ../src/guestfs-actions.pod:4620
13681 msgid "guestfs_mkswap"
13685 #: ../src/guestfs-actions.pod:4622
13689 " guestfs_mkswap (guestfs_h *g,\n"
13690 " const char *device);\n"
13695 #: ../src/guestfs-actions.pod:4626 ../fish/guestfish-actions.pod:3130
13696 msgid "Create a swap partition on C<device>."
13700 #: ../src/guestfs-actions.pod:4632
13701 msgid "guestfs_mkswap_L"
13705 #: ../src/guestfs-actions.pod:4634
13709 " guestfs_mkswap_L (guestfs_h *g,\n"
13710 " const char *label,\n"
13711 " const char *device);\n"
13716 #: ../src/guestfs-actions.pod:4639 ../fish/guestfish-actions.pod:3136
13717 msgid "Create a swap partition on C<device> with label C<label>."
13721 #: ../src/guestfs-actions.pod:4641 ../fish/guestfish-actions.pod:3138
13723 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
13724 "sda>), just to a partition. This appears to be a limitation of the kernel "
13729 #: ../src/guestfs-actions.pod:4649
13730 msgid "guestfs_mkswap_U"
13734 #: ../src/guestfs-actions.pod:4651
13738 " guestfs_mkswap_U (guestfs_h *g,\n"
13739 " const char *uuid,\n"
13740 " const char *device);\n"
13745 #: ../src/guestfs-actions.pod:4656 ../fish/guestfish-actions.pod:3146
13746 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13750 #: ../src/guestfs-actions.pod:4662
13751 msgid "guestfs_mkswap_file"
13755 #: ../src/guestfs-actions.pod:4664
13759 " guestfs_mkswap_file (guestfs_h *g,\n"
13760 " const char *path);\n"
13765 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3152
13766 msgid "Create a swap file."
13770 #: ../src/guestfs-actions.pod:4670
13772 "This command just writes a swap file signature to an existing file. To "
13773 "create the file itself, use something like C<guestfs_fallocate>."
13777 #: ../src/guestfs-actions.pod:4677
13778 msgid "guestfs_modprobe"
13782 #: ../src/guestfs-actions.pod:4679
13786 " guestfs_modprobe (guestfs_h *g,\n"
13787 " const char *modulename);\n"
13792 #: ../src/guestfs-actions.pod:4683 ../fish/guestfish-actions.pod:3161
13793 msgid "This loads a kernel module in the appliance."
13797 #: ../src/guestfs-actions.pod:4685 ../fish/guestfish-actions.pod:3163
13799 "The kernel module must have been whitelisted when libguestfs was built (see "
13800 "C<appliance/kmod.whitelist.in> in the source)."
13804 #: ../src/guestfs-actions.pod:4692
13805 msgid "guestfs_mount"
13809 #: ../src/guestfs-actions.pod:4694
13813 " guestfs_mount (guestfs_h *g,\n"
13814 " const char *device,\n"
13815 " const char *mountpoint);\n"
13820 #: ../src/guestfs-actions.pod:4699 ../fish/guestfish-actions.pod:3170
13822 "Mount a guest disk at a position in the filesystem. Block devices are named "
13823 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
13824 "those block devices contain partitions, they will have the usual names (eg. "
13825 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
13829 #: ../src/guestfs-actions.pod:4705 ../fish/guestfish-actions.pod:3176
13831 "The rules are the same as for L<mount(2)>: A filesystem must first be "
13832 "mounted on C</> before others can be mounted. Other filesystems can only be "
13833 "mounted on directories which already exist."
13837 #: ../src/guestfs-actions.pod:4710 ../fish/guestfish-actions.pod:3181
13839 "The mounted filesystem is writable, if we have sufficient permissions on the "
13840 "underlying device."
13844 #: ../src/guestfs-actions.pod:4713
13846 "B<Important note:> When you use this call, the filesystem options C<sync> "
13847 "and C<noatime> are set implicitly. This was originally done because we "
13848 "thought it would improve reliability, but it turns out that I<-o sync> has a "
13849 "very large negative performance impact and negligible effect on "
13850 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
13851 "in any code that needs performance, and instead use C<guestfs_mount_options> "
13852 "(use an empty string for the first parameter if you don't want any options)."
13856 #: ../src/guestfs-actions.pod:4727
13857 msgid "guestfs_mount_loop"
13861 #: ../src/guestfs-actions.pod:4729
13865 " guestfs_mount_loop (guestfs_h *g,\n"
13866 " const char *file,\n"
13867 " const char *mountpoint);\n"
13872 #: ../src/guestfs-actions.pod:4734 ../fish/guestfish-actions.pod:3198
13874 "This command lets you mount C<file> (a filesystem image in a file) on a "
13875 "mount point. It is entirely equivalent to the command C<mount -o loop file "
13880 #: ../src/guestfs-actions.pod:4742
13881 msgid "guestfs_mount_options"
13885 #: ../src/guestfs-actions.pod:4744
13889 " guestfs_mount_options (guestfs_h *g,\n"
13890 " const char *options,\n"
13891 " const char *device,\n"
13892 " const char *mountpoint);\n"
13897 #: ../src/guestfs-actions.pod:4750
13899 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13900 "the mount options as for the L<mount(8)> I<-o> flag."
13904 #: ../src/guestfs-actions.pod:4754 ../fish/guestfish-actions.pod:3210
13906 "If the C<options> parameter is an empty string, then no options are passed "
13907 "(all options default to whatever the filesystem uses)."
13911 #: ../src/guestfs-actions.pod:4760 ../src/guestfs-actions.pod:4774
13912 #: ../src/guestfs-actions.pod:4791
13913 msgid "(Added in 1.0.10)"
13917 #: ../src/guestfs-actions.pod:4762
13918 msgid "guestfs_mount_ro"
13922 #: ../src/guestfs-actions.pod:4764
13926 " guestfs_mount_ro (guestfs_h *g,\n"
13927 " const char *device,\n"
13928 " const char *mountpoint);\n"
13933 #: ../src/guestfs-actions.pod:4769
13935 "This is the same as the C<guestfs_mount> command, but it mounts the "
13936 "filesystem with the read-only (I<-o ro>) flag."
13940 #: ../src/guestfs-actions.pod:4776
13941 msgid "guestfs_mount_vfs"
13945 #: ../src/guestfs-actions.pod:4778
13949 " guestfs_mount_vfs (guestfs_h *g,\n"
13950 " const char *options,\n"
13951 " const char *vfstype,\n"
13952 " const char *device,\n"
13953 " const char *mountpoint);\n"
13958 #: ../src/guestfs-actions.pod:4785
13960 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13961 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
13966 #: ../src/guestfs-actions.pod:4793
13967 msgid "guestfs_mountpoints"
13971 #: ../src/guestfs-actions.pod:4795
13975 " guestfs_mountpoints (guestfs_h *g);\n"
13980 #: ../src/guestfs-actions.pod:4798
13982 "This call is similar to C<guestfs_mounts>. That call returns a list of "
13983 "devices. This one returns a hash table (map) of device name to directory "
13984 "where the device is mounted."
13988 #: ../src/guestfs-actions.pod:4810
13989 msgid "guestfs_mounts"
13993 #: ../src/guestfs-actions.pod:4812
13997 " guestfs_mounts (guestfs_h *g);\n"
14002 #: ../src/guestfs-actions.pod:4815 ../fish/guestfish-actions.pod:3241
14004 "This returns the list of currently mounted filesystems. It returns the list "
14005 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14009 #: ../src/guestfs-actions.pod:4818 ../fish/guestfish-actions.pod:3244
14010 msgid "Some internal mounts are not shown."
14014 #: ../src/guestfs-actions.pod:4820
14015 msgid "See also: C<guestfs_mountpoints>"
14019 #: ../src/guestfs-actions.pod:4828
14024 #: ../src/guestfs-actions.pod:4830
14028 " guestfs_mv (guestfs_h *g,\n"
14029 " const char *src,\n"
14030 " const char *dest);\n"
14035 #: ../src/guestfs-actions.pod:4835 ../fish/guestfish-actions.pod:3252
14037 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14038 "destination filename or destination directory."
14042 #: ../src/guestfs-actions.pod:4842
14043 msgid "guestfs_ntfs_3g_probe"
14047 #: ../src/guestfs-actions.pod:4844
14051 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14053 " const char *device);\n"
14058 #: ../src/guestfs-actions.pod:4849 ../fish/guestfish-actions.pod:3259
14060 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14061 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14062 "write, and some cannot be mounted at all)."
14066 #: ../src/guestfs-actions.pod:4853 ../fish/guestfish-actions.pod:3263
14068 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14069 "can be mounted read-write. Set it to false if you want to test if the "
14070 "volume can be mounted read-only."
14074 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3267
14076 "The return value is an integer which C<0> if the operation would succeed, or "
14077 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14081 #: ../src/guestfs-actions.pod:4863
14082 msgid "(Added in 1.0.43)"
14086 #: ../src/guestfs-actions.pod:4865
14087 msgid "guestfs_ntfsresize"
14091 #: ../src/guestfs-actions.pod:4867
14095 " guestfs_ntfsresize (guestfs_h *g,\n"
14096 " const char *device);\n"
14101 #: ../src/guestfs-actions.pod:4871 ../fish/guestfish-actions.pod:3275
14103 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14104 "size of the underlying device. See also L<ntfsresize(8)>."
14108 #: ../src/guestfs-actions.pod:4879
14109 msgid "guestfs_ntfsresize_size"
14113 #: ../src/guestfs-actions.pod:4881
14117 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14118 " const char *device,\n"
14119 " int64_t size);\n"
14124 #: ../src/guestfs-actions.pod:4886
14126 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14127 "to specify the new size (in bytes) explicitly."
14131 #: ../src/guestfs-actions.pod:4891 ../src/guestfs-actions.pod:5327
14132 #: ../src/guestfs-actions.pod:5400 ../src/guestfs-actions.pod:5666
14133 #: ../src/guestfs-actions.pod:7237
14134 msgid "(Added in 1.3.14)"
14138 #: ../src/guestfs-actions.pod:4893
14139 msgid "guestfs_part_add"
14143 #: ../src/guestfs-actions.pod:4895
14147 " guestfs_part_add (guestfs_h *g,\n"
14148 " const char *device,\n"
14149 " const char *prlogex,\n"
14150 " int64_t startsect,\n"
14151 " int64_t endsect);\n"
14156 #: ../src/guestfs-actions.pod:4902
14158 "This command adds a partition to C<device>. If there is no partition table "
14159 "on the device, call C<guestfs_part_init> first."
14163 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3293
14165 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14166 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14167 "C<logical>) and C<e> (or C<extended>) partition types."
14171 #: ../src/guestfs-actions.pod:4910 ../fish/guestfish-actions.pod:3298
14173 "C<startsect> and C<endsect> are the start and end of the partition in "
14174 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14175 "from the end of the disk (C<-1> is the last sector)."
14179 #: ../src/guestfs-actions.pod:4914
14181 "Creating a partition which covers the whole disk is not so easy. Use "
14182 "C<guestfs_part_disk> to do that."
14186 #: ../src/guestfs-actions.pod:4919 ../src/guestfs-actions.pod:4957
14187 #: ../src/guestfs-actions.pod:5010 ../src/guestfs-actions.pod:5088
14188 #: ../src/guestfs-actions.pod:5126 ../src/guestfs-actions.pod:5145
14189 #: ../src/guestfs-actions.pod:5185
14190 msgid "(Added in 1.0.78)"
14194 #: ../src/guestfs-actions.pod:4921
14195 msgid "guestfs_part_del"
14199 #: ../src/guestfs-actions.pod:4923
14203 " guestfs_part_del (guestfs_h *g,\n"
14204 " const char *device,\n"
14210 #: ../src/guestfs-actions.pod:4928 ../fish/guestfish-actions.pod:3309
14211 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14215 #: ../src/guestfs-actions.pod:4930 ../fish/guestfish-actions.pod:3311
14217 "Note that in the case of MBR partitioning, deleting an extended partition "
14218 "also deletes any logical partitions it contains."
14222 #: ../src/guestfs-actions.pod:4938
14223 msgid "guestfs_part_disk"
14227 #: ../src/guestfs-actions.pod:4940
14231 " guestfs_part_disk (guestfs_h *g,\n"
14232 " const char *device,\n"
14233 " const char *parttype);\n"
14238 #: ../src/guestfs-actions.pod:4945
14240 "This command is simply a combination of C<guestfs_part_init> followed by "
14241 "C<guestfs_part_add> to create a single primary partition covering the whole "
14246 #: ../src/guestfs-actions.pod:4949
14248 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14249 "possible values are described in C<guestfs_part_init>."
14253 #: ../src/guestfs-actions.pod:4959
14254 msgid "guestfs_part_get_bootable"
14258 #: ../src/guestfs-actions.pod:4961
14262 " guestfs_part_get_bootable (guestfs_h *g,\n"
14263 " const char *device,\n"
14269 #: ../src/guestfs-actions.pod:4966 ../fish/guestfish-actions.pod:3333
14271 "This command returns true if the partition C<partnum> on C<device> has the "
14272 "bootable flag set."
14276 #: ../src/guestfs-actions.pod:4969
14277 msgid "See also C<guestfs_part_set_bootable>."
14281 #: ../src/guestfs-actions.pod:4975
14282 msgid "guestfs_part_get_mbr_id"
14286 #: ../src/guestfs-actions.pod:4977
14290 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14291 " const char *device,\n"
14297 #: ../src/guestfs-actions.pod:4982 ../fish/guestfish-actions.pod:3342
14299 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14300 "partition C<partnum>."
14304 #: ../src/guestfs-actions.pod:4985 ../src/guestfs-actions.pod:5161
14306 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14307 "undefined results for other partition table types (see "
14308 "C<guestfs_part_get_parttype>)."
14312 #: ../src/guestfs-actions.pod:4993
14313 msgid "guestfs_part_get_parttype"
14317 #: ../src/guestfs-actions.pod:4995
14321 " guestfs_part_get_parttype (guestfs_h *g,\n"
14322 " const char *device);\n"
14327 #: ../src/guestfs-actions.pod:4999 ../fish/guestfish-actions.pod:3353
14329 "This command examines the partition table on C<device> and returns the "
14330 "partition table type (format) being used."
14334 #: ../src/guestfs-actions.pod:5002
14336 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14337 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14338 "possible, although unusual. See C<guestfs_part_init> for a full list."
14342 #: ../src/guestfs-actions.pod:5012
14343 msgid "guestfs_part_init"
14347 #: ../src/guestfs-actions.pod:5014
14351 " guestfs_part_init (guestfs_h *g,\n"
14352 " const char *device,\n"
14353 " const char *parttype);\n"
14358 #: ../src/guestfs-actions.pod:5019 ../fish/guestfish-actions.pod:3365
14360 "This creates an empty partition table on C<device> of one of the partition "
14361 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14362 "(for large disks)."
14366 #: ../src/guestfs-actions.pod:5023
14368 "Initially there are no partitions. Following this, you should call "
14369 "C<guestfs_part_add> for each partition required."
14373 #: ../src/guestfs-actions.pod:5026 ../fish/guestfish-actions.pod:3372
14374 msgid "Possible values for C<parttype> are:"
14378 #: ../src/guestfs-actions.pod:5030 ../fish/guestfish-actions.pod:3376
14379 msgid "B<efi> | B<gpt>"
14383 #: ../src/guestfs-actions.pod:5032 ../fish/guestfish-actions.pod:3378
14384 msgid "Intel EFI / GPT partition table."
14388 #: ../src/guestfs-actions.pod:5034 ../fish/guestfish-actions.pod:3380
14390 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14391 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14392 "the C<mbr> format."
14396 #: ../src/guestfs-actions.pod:5038 ../fish/guestfish-actions.pod:3384
14397 msgid "B<mbr> | B<msdos>"
14401 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3386
14403 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14404 "Windows. This partition type will B<only> work for device sizes up to 2 "
14405 "TB. For large disks we recommend using C<gpt>."
14409 #: ../src/guestfs-actions.pod:5047 ../fish/guestfish-actions.pod:3393
14411 "Other partition table types that may work but are not supported include:"
14415 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3398
14420 #: ../src/guestfs-actions.pod:5054 ../fish/guestfish-actions.pod:3400
14421 msgid "AIX disk labels."
14425 #: ../src/guestfs-actions.pod:5056 ../fish/guestfish-actions.pod:3402
14426 msgid "B<amiga> | B<rdb>"
14430 #: ../src/guestfs-actions.pod:5058 ../fish/guestfish-actions.pod:3404
14431 msgid "Amiga \"Rigid Disk Block\" format."
14435 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3406
14440 #: ../src/guestfs-actions.pod:5062 ../fish/guestfish-actions.pod:3408
14441 msgid "BSD disk labels."
14445 #: ../src/guestfs-actions.pod:5064 ../fish/guestfish-actions.pod:3410
14450 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3412
14451 msgid "DASD, used on IBM mainframes."
14455 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3414
14460 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3416
14461 msgid "MIPS/SGI volumes."
14465 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3418
14470 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3420
14471 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14475 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3422
14480 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3424
14481 msgid "NEC PC-98 format, common in Japan apparently."
14485 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3426
14490 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3428
14491 msgid "Sun disk labels."
14495 #: ../src/guestfs-actions.pod:5090
14496 msgid "guestfs_part_list"
14500 #: ../src/guestfs-actions.pod:5092
14503 " struct guestfs_partition_list *\n"
14504 " guestfs_part_list (guestfs_h *g,\n"
14505 " const char *device);\n"
14510 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3436
14512 "This command parses the partition table on C<device> and returns the list of "
14513 "partitions found."
14517 #: ../src/guestfs-actions.pod:5099 ../fish/guestfish-actions.pod:3439
14518 msgid "The fields in the returned structure are:"
14522 #: ../src/guestfs-actions.pod:5103 ../fish/guestfish-actions.pod:3443
14523 msgid "B<part_num>"
14527 #: ../src/guestfs-actions.pod:5105 ../fish/guestfish-actions.pod:3445
14528 msgid "Partition number, counting from 1."
14532 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3447
14533 msgid "B<part_start>"
14537 #: ../src/guestfs-actions.pod:5109
14539 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14540 "the device's sector size, see C<guestfs_blockdev_getss>."
14544 #: ../src/guestfs-actions.pod:5112 ../fish/guestfish-actions.pod:3452
14545 msgid "B<part_end>"
14549 #: ../src/guestfs-actions.pod:5114 ../fish/guestfish-actions.pod:3454
14550 msgid "End of the partition in bytes."
14554 #: ../src/guestfs-actions.pod:5116 ../fish/guestfish-actions.pod:3456
14555 msgid "B<part_size>"
14559 #: ../src/guestfs-actions.pod:5118 ../fish/guestfish-actions.pod:3458
14560 msgid "Size of the partition in bytes."
14564 #: ../src/guestfs-actions.pod:5122
14566 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14567 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14572 #: ../src/guestfs-actions.pod:5128
14573 msgid "guestfs_part_set_bootable"
14577 #: ../src/guestfs-actions.pod:5130
14581 " guestfs_part_set_bootable (guestfs_h *g,\n"
14582 " const char *device,\n"
14584 " int bootable);\n"
14589 #: ../src/guestfs-actions.pod:5136 ../fish/guestfish-actions.pod:3466
14591 "This sets the bootable flag on partition numbered C<partnum> on device "
14592 "C<device>. Note that partitions are numbered from 1."
14596 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3469
14598 "The bootable flag is used by some operating systems (notably Windows) to "
14599 "determine which partition to boot from. It is by no means universally "
14604 #: ../src/guestfs-actions.pod:5147
14605 msgid "guestfs_part_set_mbr_id"
14609 #: ../src/guestfs-actions.pod:5149
14613 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14614 " const char *device,\n"
14621 #: ../src/guestfs-actions.pod:5155 ../fish/guestfish-actions.pod:3477
14623 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14624 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14625 "documentation are in fact hexadecimal numbers, but usually documented "
14626 "without any leading \"0x\" which might be confusing."
14630 #: ../src/guestfs-actions.pod:5169
14631 msgid "guestfs_part_set_name"
14635 #: ../src/guestfs-actions.pod:5171
14639 " guestfs_part_set_name (guestfs_h *g,\n"
14640 " const char *device,\n"
14642 " const char *name);\n"
14647 #: ../src/guestfs-actions.pod:5177 ../fish/guestfish-actions.pod:3491
14649 "This sets the partition name on partition numbered C<partnum> on device "
14650 "C<device>. Note that partitions are numbered from 1."
14654 #: ../src/guestfs-actions.pod:5180 ../fish/guestfish-actions.pod:3494
14656 "The partition name can only be set on certain types of partition table. "
14657 "This works on C<gpt> but not on C<mbr> partitions."
14661 #: ../src/guestfs-actions.pod:5187
14662 msgid "guestfs_part_to_dev"
14666 #: ../src/guestfs-actions.pod:5189
14670 " guestfs_part_to_dev (guestfs_h *g,\n"
14671 " const char *partition);\n"
14676 #: ../src/guestfs-actions.pod:5193 ../fish/guestfish-actions.pod:3501
14678 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14679 "partition number, returning the device name (eg. \"/dev/sdb\")."
14683 #: ../src/guestfs-actions.pod:5197
14685 "The named partition must exist, for example as a string returned from "
14686 "C<guestfs_list_partitions>."
14690 #: ../src/guestfs-actions.pod:5205
14691 msgid "guestfs_ping_daemon"
14695 #: ../src/guestfs-actions.pod:5207
14699 " guestfs_ping_daemon (guestfs_h *g);\n"
14704 #: ../src/guestfs-actions.pod:5210 ../fish/guestfish-actions.pod:3512
14706 "This is a test probe into the guestfs daemon running inside the qemu "
14707 "subprocess. Calling this function checks that the daemon responds to the "
14708 "ping message, without affecting the daemon or attached block device(s) in "
14713 #: ../src/guestfs-actions.pod:5219
14714 msgid "guestfs_pread"
14718 #: ../src/guestfs-actions.pod:5221
14722 " guestfs_pread (guestfs_h *g,\n"
14723 " const char *path,\n"
14725 " int64_t offset,\n"
14726 " size_t *size_r);\n"
14731 #: ../src/guestfs-actions.pod:5228 ../fish/guestfish-actions.pod:3521
14733 "This command lets you read part of a file. It reads C<count> bytes of the "
14734 "file, starting at C<offset>, from file C<path>."
14738 #: ../src/guestfs-actions.pod:5231 ../src/guestfs-actions.pod:5257
14739 #: ../fish/guestfish-actions.pod:3524 ../fish/guestfish-actions.pod:3539
14741 "This may read fewer bytes than requested. For further details see the "
14742 "L<pread(2)> system call."
14746 #: ../src/guestfs-actions.pod:5234
14747 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14751 #: ../src/guestfs-actions.pod:5245
14752 msgid "guestfs_pread_device"
14756 #: ../src/guestfs-actions.pod:5247
14760 " guestfs_pread_device (guestfs_h *g,\n"
14761 " const char *device,\n"
14763 " int64_t offset,\n"
14764 " size_t *size_r);\n"
14769 #: ../src/guestfs-actions.pod:5254 ../fish/guestfish-actions.pod:3536
14771 "This command lets you read part of a file. It reads C<count> bytes of "
14772 "C<device>, starting at C<offset>."
14776 #: ../src/guestfs-actions.pod:5260
14777 msgid "See also C<guestfs_pread>."
14781 #: ../src/guestfs-actions.pod:5269
14782 msgid "(Added in 1.5.21)"
14786 #: ../src/guestfs-actions.pod:5271
14787 msgid "guestfs_pvcreate"
14791 #: ../src/guestfs-actions.pod:5273
14795 " guestfs_pvcreate (guestfs_h *g,\n"
14796 " const char *device);\n"
14801 #: ../src/guestfs-actions.pod:5277 ../fish/guestfish-actions.pod:3551
14803 "This creates an LVM physical volume on the named C<device>, where C<device> "
14804 "should usually be a partition name such as C</dev/sda1>."
14808 #: ../src/guestfs-actions.pod:5285
14809 msgid "guestfs_pvremove"
14813 #: ../src/guestfs-actions.pod:5287
14817 " guestfs_pvremove (guestfs_h *g,\n"
14818 " const char *device);\n"
14823 #: ../src/guestfs-actions.pod:5291 ../fish/guestfish-actions.pod:3559
14825 "This wipes a physical volume C<device> so that LVM will no longer recognise "
14830 #: ../src/guestfs-actions.pod:5294 ../fish/guestfish-actions.pod:3562
14832 "The implementation uses the C<pvremove> command which refuses to wipe "
14833 "physical volumes that contain any volume groups, so you have to remove those "
14838 #: ../src/guestfs-actions.pod:5302
14839 msgid "guestfs_pvresize"
14843 #: ../src/guestfs-actions.pod:5304
14847 " guestfs_pvresize (guestfs_h *g,\n"
14848 " const char *device);\n"
14853 #: ../src/guestfs-actions.pod:5308 ../fish/guestfish-actions.pod:3570
14855 "This resizes (expands or shrinks) an existing LVM physical volume to match "
14856 "the new size of the underlying device."
14860 #: ../src/guestfs-actions.pod:5315
14861 msgid "guestfs_pvresize_size"
14865 #: ../src/guestfs-actions.pod:5317
14869 " guestfs_pvresize_size (guestfs_h *g,\n"
14870 " const char *device,\n"
14871 " int64_t size);\n"
14876 #: ../src/guestfs-actions.pod:5322
14878 "This command is the same as C<guestfs_pvresize> except that it allows you to "
14879 "specify the new size (in bytes) explicitly."
14883 #: ../src/guestfs-actions.pod:5329
14884 msgid "guestfs_pvs"
14888 #: ../src/guestfs-actions.pod:5331
14892 " guestfs_pvs (guestfs_h *g);\n"
14897 #: ../src/guestfs-actions.pod:5334 ../fish/guestfish-actions.pod:3584
14899 "List all the physical volumes detected. This is the equivalent of the L<pvs"
14904 #: ../src/guestfs-actions.pod:5337 ../fish/guestfish-actions.pod:3587
14906 "This returns a list of just the device names that contain PVs (eg. C</dev/"
14911 #: ../src/guestfs-actions.pod:5340
14912 msgid "See also C<guestfs_pvs_full>."
14916 #: ../src/guestfs-actions.pod:5348
14917 msgid "guestfs_pvs_full"
14921 #: ../src/guestfs-actions.pod:5350
14924 " struct guestfs_lvm_pv_list *\n"
14925 " guestfs_pvs_full (guestfs_h *g);\n"
14930 #: ../src/guestfs-actions.pod:5353 ../fish/guestfish-actions.pod:3596
14932 "List all the physical volumes detected. This is the equivalent of the L<pvs"
14933 "(8)> command. The \"full\" version includes all fields."
14937 #: ../src/guestfs-actions.pod:5356
14939 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
14940 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
14944 #: ../src/guestfs-actions.pod:5362
14945 msgid "guestfs_pvuuid"
14949 #: ../src/guestfs-actions.pod:5364
14953 " guestfs_pvuuid (guestfs_h *g,\n"
14954 " const char *device);\n"
14959 #: ../src/guestfs-actions.pod:5368 ../fish/guestfish-actions.pod:3603
14960 msgid "This command returns the UUID of the LVM PV C<device>."
14964 #: ../src/guestfs-actions.pod:5375
14965 msgid "guestfs_pwrite"
14969 #: ../src/guestfs-actions.pod:5377
14973 " guestfs_pwrite (guestfs_h *g,\n"
14974 " const char *path,\n"
14975 " const char *content,\n"
14976 " size_t content_size,\n"
14977 " int64_t offset);\n"
14982 #: ../src/guestfs-actions.pod:5384 ../fish/guestfish-actions.pod:3609
14984 "This command writes to part of a file. It writes the data buffer C<content> "
14985 "to the file C<path> starting at offset C<offset>."
14989 #: ../src/guestfs-actions.pod:5387 ../fish/guestfish-actions.pod:3612
14991 "This command implements the L<pwrite(2)> system call, and like that system "
14992 "call it may not write the full data requested. The return value is the "
14993 "number of bytes that were actually written to the file. This could even be "
14994 "0, although short writes are unlikely for regular files in ordinary "
14999 #: ../src/guestfs-actions.pod:5393
15000 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15004 #: ../src/guestfs-actions.pod:5402
15005 msgid "guestfs_pwrite_device"
15009 #: ../src/guestfs-actions.pod:5404
15013 " guestfs_pwrite_device (guestfs_h *g,\n"
15014 " const char *device,\n"
15015 " const char *content,\n"
15016 " size_t content_size,\n"
15017 " int64_t offset);\n"
15022 #: ../src/guestfs-actions.pod:5411 ../fish/guestfish-actions.pod:3627
15024 "This command writes to part of a device. It writes the data buffer "
15025 "C<content> to C<device> starting at offset C<offset>."
15029 #: ../src/guestfs-actions.pod:5414 ../fish/guestfish-actions.pod:3630
15031 "This command implements the L<pwrite(2)> system call, and like that system "
15032 "call it may not write the full data requested (although short writes to disk "
15033 "devices and partitions are probably impossible with standard Linux kernels)."
15037 #: ../src/guestfs-actions.pod:5419
15038 msgid "See also C<guestfs_pwrite>."
15042 #: ../src/guestfs-actions.pod:5426
15043 msgid "(Added in 1.5.20)"
15047 #: ../src/guestfs-actions.pod:5428
15048 msgid "guestfs_read_file"
15052 #: ../src/guestfs-actions.pod:5430
15056 " guestfs_read_file (guestfs_h *g,\n"
15057 " const char *path,\n"
15058 " size_t *size_r);\n"
15063 #: ../src/guestfs-actions.pod:5435 ../fish/guestfish-actions.pod:3644
15064 msgid "This calls returns the contents of the file C<path> as a buffer."
15068 #: ../src/guestfs-actions.pod:5438
15070 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15071 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15072 "function is limited in the total size of file that can be handled."
15076 #: ../src/guestfs-actions.pod:5450
15077 msgid "(Added in 1.0.63)"
15081 #: ../src/guestfs-actions.pod:5452
15082 msgid "guestfs_read_lines"
15086 #: ../src/guestfs-actions.pod:5454
15090 " guestfs_read_lines (guestfs_h *g,\n"
15091 " const char *path);\n"
15096 #: ../src/guestfs-actions.pod:5460 ../fish/guestfish-actions.pod:3661
15098 "The file contents are returned as a list of lines. Trailing C<LF> and "
15099 "C<CRLF> character sequences are I<not> returned."
15103 #: ../src/guestfs-actions.pod:5463
15105 "Note that this function cannot correctly handle binary files (specifically, "
15106 "files containing C<\\0> character which is treated as end of line). For "
15107 "those you need to use the C<guestfs_read_file> function which has a more "
15108 "complex interface."
15112 #: ../src/guestfs-actions.pod:5474
15113 msgid "guestfs_readdir"
15117 #: ../src/guestfs-actions.pod:5476
15120 " struct guestfs_dirent_list *\n"
15121 " guestfs_readdir (guestfs_h *g,\n"
15122 " const char *dir);\n"
15127 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:3673
15128 msgid "This returns the list of directory entries in directory C<dir>."
15132 #: ../src/guestfs-actions.pod:5482 ../fish/guestfish-actions.pod:3675
15134 "All entries in the directory are returned, including C<.> and C<..>. The "
15135 "entries are I<not> sorted, but returned in the same order as the underlying "
15140 #: ../src/guestfs-actions.pod:5486 ../fish/guestfish-actions.pod:3679
15142 "Also this call returns basic file type information about each file. The "
15143 "C<ftyp> field will contain one of the following characters:"
15147 #: ../src/guestfs-actions.pod:5491 ../fish/guestfish-actions.pod:3684
15152 #: ../src/guestfs-actions.pod:5493 ../fish/guestfish-actions.pod:3686
15153 msgid "Block special"
15157 #: ../src/guestfs-actions.pod:5495 ../fish/guestfish-actions.pod:3688
15162 #: ../src/guestfs-actions.pod:5497 ../fish/guestfish-actions.pod:3690
15163 msgid "Char special"
15167 #: ../src/guestfs-actions.pod:5499 ../fish/guestfish-actions.pod:3692
15172 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:3694
15177 #: ../src/guestfs-actions.pod:5503 ../fish/guestfish-actions.pod:3696
15182 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3698
15183 msgid "FIFO (named pipe)"
15187 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3700
15192 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3702
15193 msgid "Symbolic link"
15197 #: ../src/guestfs-actions.pod:5511 ../fish/guestfish-actions.pod:3704
15202 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3706
15203 msgid "Regular file"
15207 #: ../src/guestfs-actions.pod:5515 ../fish/guestfish-actions.pod:3708
15212 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3710
15217 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3712
15222 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3714
15223 msgid "Unknown file type"
15227 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3716
15232 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3718
15234 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15238 #: ../src/guestfs-actions.pod:5530
15240 "This function is primarily intended for use by programs. To get a simple "
15241 "list of names, use C<guestfs_ls>. To get a printable directory for human "
15242 "consumption, use C<guestfs_ll>."
15246 #: ../src/guestfs-actions.pod:5534
15248 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
15249 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
15253 #: ../src/guestfs-actions.pod:5540
15254 msgid "guestfs_readlink"
15258 #: ../src/guestfs-actions.pod:5542
15262 " guestfs_readlink (guestfs_h *g,\n"
15263 " const char *path);\n"
15268 #: ../src/guestfs-actions.pod:5546 ../fish/guestfish-actions.pod:3731
15269 msgid "This command reads the target of a symbolic link."
15273 #: ../src/guestfs-actions.pod:5553
15274 msgid "guestfs_readlinklist"
15278 #: ../src/guestfs-actions.pod:5555
15282 " guestfs_readlinklist (guestfs_h *g,\n"
15283 " const char *path,\n"
15284 " char *const *names);\n"
15289 #: ../src/guestfs-actions.pod:5560 ../fish/guestfish-actions.pod:3737
15291 "This call allows you to do a C<readlink> operation on multiple files, where "
15292 "all files are in the directory C<path>. C<names> is the list of files from "
15297 #: ../src/guestfs-actions.pod:5564 ../fish/guestfish-actions.pod:3741
15299 "On return you get a list of strings, with a one-to-one correspondence to the "
15300 "C<names> list. Each string is the value of the symbolic link."
15304 #: ../src/guestfs-actions.pod:5568 ../fish/guestfish-actions.pod:3745
15306 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15307 "result string is the empty string C<\"\">. However the whole operation is "
15308 "completed even if there were C<readlink(2)> errors, and so you can call this "
15309 "function with names where you don't know if they are symbolic links already "
15310 "(albeit slightly less efficient)."
15314 #: ../src/guestfs-actions.pod:5575 ../fish/guestfish-actions.pod:3752
15316 "This call is intended for programs that want to efficiently list a directory "
15317 "contents without making many round-trips. Very long directory listings "
15318 "might cause the protocol message size to be exceeded, causing this call to "
15319 "fail. The caller must split up such requests into smaller groups of names."
15323 #: ../src/guestfs-actions.pod:5588
15324 msgid "guestfs_realpath"
15328 #: ../src/guestfs-actions.pod:5590
15332 " guestfs_realpath (guestfs_h *g,\n"
15333 " const char *path);\n"
15338 #: ../src/guestfs-actions.pod:5594 ../fish/guestfish-actions.pod:3763
15340 "Return the canonicalized absolute pathname of C<path>. The returned path "
15341 "has no C<.>, C<..> or symbolic link path elements."
15345 #: ../src/guestfs-actions.pod:5602
15346 msgid "guestfs_removexattr"
15350 #: ../src/guestfs-actions.pod:5604
15354 " guestfs_removexattr (guestfs_h *g,\n"
15355 " const char *xattr,\n"
15356 " const char *path);\n"
15361 #: ../src/guestfs-actions.pod:5609 ../fish/guestfish-actions.pod:3770
15363 "This call removes the extended attribute named C<xattr> of the file C<path>."
15367 #: ../src/guestfs-actions.pod:5612
15368 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15372 #: ../src/guestfs-actions.pod:5618
15373 msgid "guestfs_resize2fs"
15377 #: ../src/guestfs-actions.pod:5620
15381 " guestfs_resize2fs (guestfs_h *g,\n"
15382 " const char *device);\n"
15387 #: ../src/guestfs-actions.pod:5624 ../fish/guestfish-actions.pod:3779
15389 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15390 "underlying device."
15394 #: ../src/guestfs-actions.pod:5627
15396 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15397 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15398 "sometimes gives an error about this and sometimes not. In any case, it is "
15399 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15403 #: ../src/guestfs-actions.pod:5637
15404 msgid "guestfs_resize2fs_M"
15408 #: ../src/guestfs-actions.pod:5639
15412 " guestfs_resize2fs_M (guestfs_h *g,\n"
15413 " const char *device);\n"
15418 #: ../src/guestfs-actions.pod:5643
15420 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15421 "resized to its minimum size. This works like the C<-M> option to the "
15422 "C<resize2fs> command."
15426 #: ../src/guestfs-actions.pod:5647
15428 "To get the resulting size of the filesystem you should call "
15429 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15430 "These two numbers, multiplied together, give the resulting size of the "
15431 "minimal filesystem in bytes."
15435 #: ../src/guestfs-actions.pod:5654
15436 msgid "guestfs_resize2fs_size"
15440 #: ../src/guestfs-actions.pod:5656
15444 " guestfs_resize2fs_size (guestfs_h *g,\n"
15445 " const char *device,\n"
15446 " int64_t size);\n"
15451 #: ../src/guestfs-actions.pod:5661
15453 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15454 "to specify the new size (in bytes) explicitly."
15458 #: ../src/guestfs-actions.pod:5668
15463 #: ../src/guestfs-actions.pod:5670
15467 " guestfs_rm (guestfs_h *g,\n"
15468 " const char *path);\n"
15473 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3812
15474 msgid "Remove the single file C<path>."
15478 #: ../src/guestfs-actions.pod:5680
15479 msgid "guestfs_rm_rf"
15483 #: ../src/guestfs-actions.pod:5682
15487 " guestfs_rm_rf (guestfs_h *g,\n"
15488 " const char *path);\n"
15493 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3818
15495 "Remove the file or directory C<path>, recursively removing the contents if "
15496 "its a directory. This is like the C<rm -rf> shell command."
15500 #: ../src/guestfs-actions.pod:5694
15501 msgid "guestfs_rmdir"
15505 #: ../src/guestfs-actions.pod:5696
15509 " guestfs_rmdir (guestfs_h *g,\n"
15510 " const char *path);\n"
15515 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3826
15516 msgid "Remove the single directory C<path>."
15520 #: ../src/guestfs-actions.pod:5706
15521 msgid "guestfs_rmmountpoint"
15525 #: ../src/guestfs-actions.pod:5708
15529 " guestfs_rmmountpoint (guestfs_h *g,\n"
15530 " const char *exemptpath);\n"
15535 #: ../src/guestfs-actions.pod:5712
15537 "This calls removes a mountpoint that was previously created with "
15538 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15542 #: ../src/guestfs-actions.pod:5720
15543 msgid "guestfs_scrub_device"
15547 #: ../src/guestfs-actions.pod:5722
15551 " guestfs_scrub_device (guestfs_h *g,\n"
15552 " const char *device);\n"
15557 #: ../src/guestfs-actions.pod:5726 ../fish/guestfish-actions.pod:3840
15559 "This command writes patterns over C<device> to make data retrieval more "
15564 #: ../src/guestfs-actions.pod:5729 ../src/guestfs-actions.pod:5750
15565 #: ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3843
15566 #: ../fish/guestfish-actions.pod:3858 ../fish/guestfish-actions.pod:3871
15568 "It is an interface to the L<scrub(1)> program. See that manual page for "
15573 #: ../src/guestfs-actions.pod:5737 ../src/guestfs-actions.pod:5755
15574 #: ../src/guestfs-actions.pod:5774
15575 msgid "(Added in 1.0.52)"
15579 #: ../src/guestfs-actions.pod:5739
15580 msgid "guestfs_scrub_file"
15584 #: ../src/guestfs-actions.pod:5741
15588 " guestfs_scrub_file (guestfs_h *g,\n"
15589 " const char *file);\n"
15594 #: ../src/guestfs-actions.pod:5745 ../fish/guestfish-actions.pod:3853
15596 "This command writes patterns over a file to make data retrieval more "
15601 #: ../src/guestfs-actions.pod:5748 ../fish/guestfish-actions.pod:3856
15602 msgid "The file is I<removed> after scrubbing."
15606 #: ../src/guestfs-actions.pod:5757
15607 msgid "guestfs_scrub_freespace"
15611 #: ../src/guestfs-actions.pod:5759
15615 " guestfs_scrub_freespace (guestfs_h *g,\n"
15616 " const char *dir);\n"
15621 #: ../src/guestfs-actions.pod:5763
15623 "This command creates the directory C<dir> and then fills it with files until "
15624 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15625 "and deletes them. The intention is to scrub any free space on the partition "
15626 "containing C<dir>."
15630 #: ../src/guestfs-actions.pod:5776
15631 msgid "guestfs_set_append"
15635 #: ../src/guestfs-actions.pod:5778
15639 " guestfs_set_append (guestfs_h *g,\n"
15640 " const char *append);\n"
15645 #: ../src/guestfs-actions.pod:5782 ../fish/guestfish-actions.pod:3880
15647 "This function is used to add additional options to the guest kernel command "
15652 #: ../src/guestfs-actions.pod:5785 ../fish/guestfish-actions.pod:3883
15654 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15655 "environment variable."
15659 #: ../src/guestfs-actions.pod:5788 ../fish/guestfish-actions.pod:3886
15661 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15662 "(libguestfs always adds a few of its own)."
15666 #: ../src/guestfs-actions.pod:5795
15667 msgid "guestfs_set_attach_method"
15671 #: ../src/guestfs-actions.pod:5797
15675 " guestfs_set_attach_method (guestfs_h *g,\n"
15676 " const char *attachmethod);\n"
15681 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3895
15683 "Set the method that libguestfs uses to connect to the back end guestfsd "
15684 "daemon. Possible methods are:"
15688 #: ../src/guestfs-actions.pod:5808 ../fish/guestfish-actions.pod:3902
15690 "Launch an appliance and connect to it. This is the ordinary method and the "
15695 #: ../src/guestfs-actions.pod:5811 ../fish/guestfish-actions.pod:3905
15696 msgid "C<unix:I<path>>"
15700 #: ../src/guestfs-actions.pod:5813 ../fish/guestfish-actions.pod:3907
15701 msgid "Connect to the Unix domain socket I<path>."
15705 #: ../src/guestfs-actions.pod:5815 ../fish/guestfish-actions.pod:3909
15707 "This method lets you connect to an existing daemon or (using virtio-serial) "
15708 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15709 "RUNNING DAEMONS>."
15713 #: ../src/guestfs-actions.pod:5823
15714 msgid "guestfs_set_autosync"
15718 #: ../src/guestfs-actions.pod:5825
15722 " guestfs_set_autosync (guestfs_h *g,\n"
15723 " int autosync);\n"
15728 #: ../src/guestfs-actions.pod:5829 ../fish/guestfish-actions.pod:3921
15730 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15731 "effort attempt to make filesystems consistent and synchronized when the "
15732 "handle is closed (also if the program exits without closing handles)."
15736 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:3926
15738 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15739 "disabled by default)."
15743 #: ../src/guestfs-actions.pod:5841
15744 msgid "guestfs_set_direct"
15748 #: ../src/guestfs-actions.pod:5843
15752 " guestfs_set_direct (guestfs_h *g,\n"
15758 #: ../src/guestfs-actions.pod:5847 ../fish/guestfish-actions.pod:3935
15760 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15761 "passed directly through to the appliance once it is launched."
15765 #: ../src/guestfs-actions.pod:5851
15767 "One consequence of this is that log messages aren't caught by the library "
15768 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
15773 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3943
15774 msgid "You probably don't want to use this unless you know what you are doing."
15778 #: ../src/guestfs-actions.pod:5858 ../fish/guestfish-actions.pod:3946
15779 msgid "The default is disabled."
15783 #: ../src/guestfs-actions.pod:5864
15784 msgid "guestfs_set_e2label"
15788 #: ../src/guestfs-actions.pod:5866
15792 " guestfs_set_e2label (guestfs_h *g,\n"
15793 " const char *device,\n"
15794 " const char *label);\n"
15799 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3952
15801 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
15802 "C<label>. Filesystem labels are limited to 16 characters."
15806 #: ../src/guestfs-actions.pod:5875
15808 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
15809 "the existing label on a filesystem."
15813 #: ../src/guestfs-actions.pod:5882
15814 msgid "guestfs_set_e2uuid"
15818 #: ../src/guestfs-actions.pod:5884
15822 " guestfs_set_e2uuid (guestfs_h *g,\n"
15823 " const char *device,\n"
15824 " const char *uuid);\n"
15829 #: ../src/guestfs-actions.pod:5889 ../fish/guestfish-actions.pod:3963
15831 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
15832 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
15833 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
15837 #: ../src/guestfs-actions.pod:5894
15839 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
15840 "the existing UUID of a filesystem."
15844 #: ../src/guestfs-actions.pod:5901
15845 msgid "guestfs_set_memsize"
15849 #: ../src/guestfs-actions.pod:5903
15853 " guestfs_set_memsize (guestfs_h *g,\n"
15859 #: ../src/guestfs-actions.pod:5907
15861 "This sets the memory size in megabytes allocated to the qemu subprocess. "
15862 "This only has any effect if called before C<guestfs_launch>."
15866 #: ../src/guestfs-actions.pod:5911 ../fish/guestfish-actions.pod:3981
15868 "You can also change this by setting the environment variable "
15869 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
15873 #: ../src/guestfs-actions.pod:5922
15874 msgid "guestfs_set_network"
15878 #: ../src/guestfs-actions.pod:5924
15882 " guestfs_set_network (guestfs_h *g,\n"
15888 #: ../src/guestfs-actions.pod:5928 ../fish/guestfish-actions.pod:3994
15890 "If C<network> is true, then the network is enabled in the libguestfs "
15891 "appliance. The default is false."
15895 #: ../src/guestfs-actions.pod:5931 ../fish/guestfish-actions.pod:3997
15897 "This affects whether commands are able to access the network (see L<guestfs"
15898 "(3)/RUNNING COMMANDS>)."
15902 #: ../src/guestfs-actions.pod:5934
15904 "You must call this before calling C<guestfs_launch>, otherwise it has no "
15909 #: ../src/guestfs-actions.pod:5941
15910 msgid "guestfs_set_path"
15914 #: ../src/guestfs-actions.pod:5943
15918 " guestfs_set_path (guestfs_h *g,\n"
15919 " const char *searchpath);\n"
15924 #: ../src/guestfs-actions.pod:5947 ../fish/guestfish-actions.pod:4009
15925 msgid "Set the path that libguestfs searches for kernel and initrd.img."
15929 #: ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:4011
15931 "The default is C<$libdir/guestfs> unless overridden by setting "
15932 "C<LIBGUESTFS_PATH> environment variable."
15936 #: ../src/guestfs-actions.pod:5952 ../fish/guestfish-actions.pod:4014
15937 msgid "Setting C<path> to C<NULL> restores the default path."
15941 #: ../src/guestfs-actions.pod:5958
15942 msgid "guestfs_set_qemu"
15946 #: ../src/guestfs-actions.pod:5960
15950 " guestfs_set_qemu (guestfs_h *g,\n"
15951 " const char *qemu);\n"
15956 #: ../src/guestfs-actions.pod:5964 ../fish/guestfish-actions.pod:4022
15957 msgid "Set the qemu binary that we will use."
15961 #: ../src/guestfs-actions.pod:5966 ../fish/guestfish-actions.pod:4024
15963 "The default is chosen when the library was compiled by the configure script."
15967 #: ../src/guestfs-actions.pod:5969 ../fish/guestfish-actions.pod:4027
15969 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
15974 #: ../src/guestfs-actions.pod:5972 ../fish/guestfish-actions.pod:4030
15975 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
15979 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:4032
15981 "Note that you should call this function as early as possible after creating "
15982 "the handle. This is because some pre-launch operations depend on testing "
15983 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
15984 "don't retest features, and so you might see inconsistent results. Using the "
15985 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
15986 "the qemu binary at the same time as the handle is created."
15990 #: ../src/guestfs-actions.pod:5986
15991 msgid "guestfs_set_recovery_proc"
15995 #: ../src/guestfs-actions.pod:5988
15999 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16000 " int recoveryproc);\n"
16005 #: ../src/guestfs-actions.pod:5992
16007 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16008 "not create a recovery process. The purpose of the recovery process is to "
16009 "stop runaway qemu processes in the case where the main program aborts "
16014 #: ../src/guestfs-actions.pod:5997
16016 "This only has any effect if called before C<guestfs_launch>, and the default "
16021 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:4054
16023 "About the only time when you would want to disable this is if the main "
16024 "process will fork itself into the background (\"daemonize\" itself). In "
16025 "this case the recovery process thinks that the main program has disappeared "
16026 "and so kills qemu, which is not very helpful."
16030 #: ../src/guestfs-actions.pod:6010
16031 msgid "guestfs_set_selinux"
16035 #: ../src/guestfs-actions.pod:6012
16039 " guestfs_set_selinux (guestfs_h *g,\n"
16045 #: ../src/guestfs-actions.pod:6016 ../fish/guestfish-actions.pod:4066
16047 "This sets the selinux flag that is passed to the appliance at boot time. "
16048 "The default is C<selinux=0> (disabled)."
16052 #: ../src/guestfs-actions.pod:6019 ../fish/guestfish-actions.pod:4069
16054 "Note that if SELinux is enabled, it is always in Permissive mode "
16055 "(C<enforcing=0>)."
16059 #: ../src/guestfs-actions.pod:6029
16060 msgid "guestfs_set_trace"
16064 #: ../src/guestfs-actions.pod:6031
16068 " guestfs_set_trace (guestfs_h *g,\n"
16074 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4081
16076 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16077 "return values are traced."
16081 #: ../src/guestfs-actions.pod:6038 ../fish/guestfish-actions.pod:4084
16083 "If you want to trace C API calls into libguestfs (and other libraries) then "
16084 "possibly a better way is to use the external ltrace(1) command."
16088 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:4088
16090 "Command traces are disabled unless the environment variable "
16091 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16095 #: ../src/guestfs-actions.pod:6045
16097 "Trace messages are normally sent to C<stderr>, unless you register a "
16098 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16102 #: ../src/guestfs-actions.pod:6053
16103 msgid "guestfs_set_verbose"
16107 #: ../src/guestfs-actions.pod:6055
16111 " guestfs_set_verbose (guestfs_h *g,\n"
16117 #: ../src/guestfs-actions.pod:6059 ../fish/guestfish-actions.pod:4101
16118 msgid "If C<verbose> is true, this turns on verbose messages."
16122 #: ../src/guestfs-actions.pod:6061 ../fish/guestfish-actions.pod:4103
16124 "Verbose messages are disabled unless the environment variable "
16125 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16129 #: ../src/guestfs-actions.pod:6064
16131 "Verbose messages are normally sent to C<stderr>, unless you register a "
16132 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16136 #: ../src/guestfs-actions.pod:6072
16137 msgid "guestfs_setcon"
16141 #: ../src/guestfs-actions.pod:6074
16145 " guestfs_setcon (guestfs_h *g,\n"
16146 " const char *context);\n"
16151 #: ../src/guestfs-actions.pod:6078 ../fish/guestfish-actions.pod:4114
16153 "This sets the SELinux security context of the daemon to the string "
16158 #: ../src/guestfs-actions.pod:6081 ../fish/guestfish-actions.pod:4117
16159 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16163 #: ../src/guestfs-actions.pod:6087
16164 msgid "guestfs_setxattr"
16168 #: ../src/guestfs-actions.pod:6089
16172 " guestfs_setxattr (guestfs_h *g,\n"
16173 " const char *xattr,\n"
16174 " const char *val,\n"
16176 " const char *path);\n"
16181 #: ../src/guestfs-actions.pod:6096 ../fish/guestfish-actions.pod:4123
16183 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16184 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16188 #: ../src/guestfs-actions.pod:6100
16189 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
16193 #: ../src/guestfs-actions.pod:6106
16194 msgid "guestfs_sfdisk"
16198 #: ../src/guestfs-actions.pod:6108
16202 " guestfs_sfdisk (guestfs_h *g,\n"
16203 " const char *device,\n"
16207 " char *const *lines);\n"
16212 #: ../src/guestfs-actions.pod:6116 ../fish/guestfish-actions.pod:4133
16214 "This is a direct interface to the L<sfdisk(8)> program for creating "
16215 "partitions on block devices."
16219 #: ../src/guestfs-actions.pod:6119 ../fish/guestfish-actions.pod:4136
16220 msgid "C<device> should be a block device, for example C</dev/sda>."
16224 #: ../src/guestfs-actions.pod:6121 ../fish/guestfish-actions.pod:4138
16226 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16227 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
16228 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16229 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16230 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16231 "the kernel) cannot work out the right geometry and you will need to tell it."
16235 #: ../src/guestfs-actions.pod:6129 ../fish/guestfish-actions.pod:4146
16237 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16238 "refer to the L<sfdisk(8)> manpage."
16242 #: ../src/guestfs-actions.pod:6132 ../fish/guestfish-actions.pod:4149
16244 "To create a single partition occupying the whole disk, you would pass "
16245 "C<lines> as a single element list, when the single element being the string "
16250 #: ../src/guestfs-actions.pod:6136
16252 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
16256 #: ../src/guestfs-actions.pod:6146
16257 msgid "guestfs_sfdiskM"
16261 #: ../src/guestfs-actions.pod:6148
16265 " guestfs_sfdiskM (guestfs_h *g,\n"
16266 " const char *device,\n"
16267 " char *const *lines);\n"
16272 #: ../src/guestfs-actions.pod:6153
16274 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
16275 "partition sizes are specified in megabytes only (rounded to the nearest "
16276 "cylinder) and you don't need to specify the cyls, heads and sectors "
16277 "parameters which were rarely if ever used anyway."
16281 #: ../src/guestfs-actions.pod:6159
16283 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
16284 "C<guestfs_part_disk>"
16288 #: ../src/guestfs-actions.pod:6169
16289 msgid "guestfs_sfdisk_N"
16293 #: ../src/guestfs-actions.pod:6171
16297 " guestfs_sfdisk_N (guestfs_h *g,\n"
16298 " const char *device,\n"
16303 " const char *line);\n"
16308 #: ../src/guestfs-actions.pod:6180 ../fish/guestfish-actions.pod:4179
16310 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16311 "(note: C<n> counts from 1)."
16315 #: ../src/guestfs-actions.pod:6183
16317 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16318 "for the cyls/heads/sectors parameters."
16322 #: ../src/guestfs-actions.pod:6186
16323 msgid "See also: C<guestfs_part_add>"
16327 #: ../src/guestfs-actions.pod:6195
16328 msgid "guestfs_sfdisk_disk_geometry"
16332 #: ../src/guestfs-actions.pod:6197
16336 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16337 " const char *device);\n"
16342 #: ../src/guestfs-actions.pod:6201
16344 "This displays the disk geometry of C<device> read from the partition table. "
16345 "Especially in the case where the underlying block device has been resized, "
16346 "this can be different from the kernel's idea of the geometry (see "
16347 "C<guestfs_sfdisk_kernel_geometry>)."
16351 #: ../src/guestfs-actions.pod:6206 ../src/guestfs-actions.pod:6222
16352 #: ../fish/guestfish-actions.pod:4199 ../fish/guestfish-actions.pod:4208
16353 msgid "The result is in human-readable format, and not designed to be parsed."
16357 #: ../src/guestfs-actions.pod:6214
16358 msgid "guestfs_sfdisk_kernel_geometry"
16362 #: ../src/guestfs-actions.pod:6216
16366 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16367 " const char *device);\n"
16372 #: ../src/guestfs-actions.pod:6220 ../fish/guestfish-actions.pod:4206
16373 msgid "This displays the kernel's idea of the geometry of C<device>."
16377 #: ../src/guestfs-actions.pod:6230
16378 msgid "guestfs_sfdisk_l"
16382 #: ../src/guestfs-actions.pod:6232
16386 " guestfs_sfdisk_l (guestfs_h *g,\n"
16387 " const char *device);\n"
16392 #: ../src/guestfs-actions.pod:6236 ../fish/guestfish-actions.pod:4215
16394 "This displays the partition table on C<device>, in the human-readable output "
16395 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16399 #: ../src/guestfs-actions.pod:6240
16400 msgid "See also: C<guestfs_part_list>"
16404 #: ../src/guestfs-actions.pod:6247
16409 #: ../src/guestfs-actions.pod:6249
16413 " guestfs_sh (guestfs_h *g,\n"
16414 " const char *command);\n"
16419 #: ../src/guestfs-actions.pod:6253 ../fish/guestfish-actions.pod:4225
16421 "This call runs a command from the guest filesystem via the guest's C</bin/"
16426 #: ../src/guestfs-actions.pod:6256
16427 msgid "This is like C<guestfs_command>, but passes the command to:"
16431 #: ../src/guestfs-actions.pod:6258 ../fish/guestfish-actions.pod:4230
16434 " /bin/sh -c \"command\"\n"
16439 #: ../src/guestfs-actions.pod:6260 ../fish/guestfish-actions.pod:4232
16441 "Depending on the guest's shell, this usually results in wildcards being "
16442 "expanded, shell expressions being interpolated and so on."
16446 #: ../src/guestfs-actions.pod:6264
16447 msgid "All the provisos about C<guestfs_command> apply to this call."
16451 #: ../src/guestfs-actions.pod:6271
16452 msgid "guestfs_sh_lines"
16456 #: ../src/guestfs-actions.pod:6273
16460 " guestfs_sh_lines (guestfs_h *g,\n"
16461 " const char *command);\n"
16466 #: ../src/guestfs-actions.pod:6277
16468 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16473 #: ../src/guestfs-actions.pod:6280
16474 msgid "See also: C<guestfs_command_lines>"
16478 #: ../src/guestfs-actions.pod:6288
16479 msgid "guestfs_sleep"
16483 #: ../src/guestfs-actions.pod:6290
16487 " guestfs_sleep (guestfs_h *g,\n"
16493 #: ../src/guestfs-actions.pod:6294 ../fish/guestfish-actions.pod:4251
16494 msgid "Sleep for C<secs> seconds."
16498 #: ../src/guestfs-actions.pod:6298
16499 msgid "(Added in 1.0.41)"
16503 #: ../src/guestfs-actions.pod:6300 ../src/guestfs-structs.pod:109
16504 msgid "guestfs_stat"
16508 #: ../src/guestfs-actions.pod:6302
16511 " struct guestfs_stat *\n"
16512 " guestfs_stat (guestfs_h *g,\n"
16513 " const char *path);\n"
16518 #: ../src/guestfs-actions.pod:6308 ../fish/guestfish-actions.pod:4259
16519 msgid "This is the same as the C<stat(2)> system call."
16523 #: ../src/guestfs-actions.pod:6316 ../src/guestfs-structs.pod:135
16524 msgid "guestfs_statvfs"
16528 #: ../src/guestfs-actions.pod:6318
16531 " struct guestfs_statvfs *\n"
16532 " guestfs_statvfs (guestfs_h *g,\n"
16533 " const char *path);\n"
16538 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4265
16540 "Returns file system statistics for any mounted file system. C<path> should "
16541 "be a file or directory in the mounted file system (typically it is the mount "
16542 "point itself, but it doesn't need to be)."
16546 #: ../src/guestfs-actions.pod:6326 ../fish/guestfish-actions.pod:4269
16547 msgid "This is the same as the C<statvfs(2)> system call."
16551 #: ../src/guestfs-actions.pod:6328
16553 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16554 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16558 #: ../src/guestfs-actions.pod:6334
16559 msgid "guestfs_strings"
16563 #: ../src/guestfs-actions.pod:6336
16567 " guestfs_strings (guestfs_h *g,\n"
16568 " const char *path);\n"
16573 #: ../src/guestfs-actions.pod:6340 ../fish/guestfish-actions.pod:4275
16575 "This runs the L<strings(1)> command on a file and returns the list of "
16576 "printable strings found."
16580 #: ../src/guestfs-actions.pod:6352
16581 msgid "guestfs_strings_e"
16585 #: ../src/guestfs-actions.pod:6354
16589 " guestfs_strings_e (guestfs_h *g,\n"
16590 " const char *encoding,\n"
16591 " const char *path);\n"
16596 #: ../src/guestfs-actions.pod:6359
16598 "This is like the C<guestfs_strings> command, but allows you to specify the "
16599 "encoding of strings that are looked for in the source file C<path>."
16603 #: ../src/guestfs-actions.pod:6363 ../fish/guestfish-actions.pod:4289
16604 msgid "Allowed encodings are:"
16608 #: ../src/guestfs-actions.pod:6367 ../fish/guestfish-actions.pod:4293
16613 #: ../src/guestfs-actions.pod:6369
16615 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16616 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16620 #: ../src/guestfs-actions.pod:6372 ../fish/guestfish-actions.pod:4298
16625 #: ../src/guestfs-actions.pod:6374 ../fish/guestfish-actions.pod:4300
16626 msgid "Single 8-bit-byte characters."
16630 #: ../src/guestfs-actions.pod:6376 ../fish/guestfish-actions.pod:4302
16635 #: ../src/guestfs-actions.pod:6378 ../fish/guestfish-actions.pod:4304
16636 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16640 #: ../src/guestfs-actions.pod:6381 ../fish/guestfish-actions.pod:4307
16641 msgid "l (lower case letter L)"
16645 #: ../src/guestfs-actions.pod:6383 ../fish/guestfish-actions.pod:4309
16647 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16648 "examining binaries in Windows guests."
16652 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4312
16657 #: ../src/guestfs-actions.pod:6388 ../fish/guestfish-actions.pod:4314
16658 msgid "32-bit big endian such as UCS-4BE."
16662 #: ../src/guestfs-actions.pod:6390 ../fish/guestfish-actions.pod:4316
16667 #: ../src/guestfs-actions.pod:6392 ../fish/guestfish-actions.pod:4318
16668 msgid "32-bit little endian such as UCS-4LE."
16672 #: ../src/guestfs-actions.pod:6396 ../fish/guestfish-actions.pod:4322
16673 msgid "The returned strings are transcoded to UTF-8."
16677 #: ../src/guestfs-actions.pod:6407
16678 msgid "guestfs_swapoff_device"
16682 #: ../src/guestfs-actions.pod:6409
16686 " guestfs_swapoff_device (guestfs_h *g,\n"
16687 " const char *device);\n"
16692 #: ../src/guestfs-actions.pod:6413
16694 "This command disables the libguestfs appliance swap device or partition "
16695 "named C<device>. See C<guestfs_swapon_device>."
16699 #: ../src/guestfs-actions.pod:6421
16700 msgid "guestfs_swapoff_file"
16704 #: ../src/guestfs-actions.pod:6423
16708 " guestfs_swapoff_file (guestfs_h *g,\n"
16709 " const char *file);\n"
16714 #: ../src/guestfs-actions.pod:6427 ../fish/guestfish-actions.pod:4339
16715 msgid "This command disables the libguestfs appliance swap on file."
16719 #: ../src/guestfs-actions.pod:6433
16720 msgid "guestfs_swapoff_label"
16724 #: ../src/guestfs-actions.pod:6435
16728 " guestfs_swapoff_label (guestfs_h *g,\n"
16729 " const char *label);\n"
16734 #: ../src/guestfs-actions.pod:6439 ../fish/guestfish-actions.pod:4345
16736 "This command disables the libguestfs appliance swap on labeled swap "
16741 #: ../src/guestfs-actions.pod:6446
16742 msgid "guestfs_swapoff_uuid"
16746 #: ../src/guestfs-actions.pod:6448
16750 " guestfs_swapoff_uuid (guestfs_h *g,\n"
16751 " const char *uuid);\n"
16756 #: ../src/guestfs-actions.pod:6452 ../fish/guestfish-actions.pod:4352
16758 "This command disables the libguestfs appliance swap partition with the given "
16763 #: ../src/guestfs-actions.pod:6459
16764 msgid "guestfs_swapon_device"
16768 #: ../src/guestfs-actions.pod:6461
16772 " guestfs_swapon_device (guestfs_h *g,\n"
16773 " const char *device);\n"
16778 #: ../src/guestfs-actions.pod:6465
16780 "This command enables the libguestfs appliance to use the swap device or "
16781 "partition named C<device>. The increased memory is made available for all "
16782 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
16786 #: ../src/guestfs-actions.pod:6470 ../fish/guestfish-actions.pod:4364
16788 "Note that you should not swap to existing guest swap partitions unless you "
16789 "know what you are doing. They may contain hibernation information, or other "
16790 "information that the guest doesn't want you to trash. You also risk leaking "
16791 "information about the host to the guest this way. Instead, attach a new "
16792 "host device to the guest and swap on that."
16796 #: ../src/guestfs-actions.pod:6481
16797 msgid "guestfs_swapon_file"
16801 #: ../src/guestfs-actions.pod:6483
16805 " guestfs_swapon_file (guestfs_h *g,\n"
16806 " const char *file);\n"
16811 #: ../src/guestfs-actions.pod:6487
16813 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
16818 #: ../src/guestfs-actions.pod:6494
16819 msgid "guestfs_swapon_label"
16823 #: ../src/guestfs-actions.pod:6496
16827 " guestfs_swapon_label (guestfs_h *g,\n"
16828 " const char *label);\n"
16833 #: ../src/guestfs-actions.pod:6500
16835 "This command enables swap to a labeled swap partition. See "
16836 "C<guestfs_swapon_device> for other notes."
16840 #: ../src/guestfs-actions.pod:6507
16841 msgid "guestfs_swapon_uuid"
16845 #: ../src/guestfs-actions.pod:6509
16849 " guestfs_swapon_uuid (guestfs_h *g,\n"
16850 " const char *uuid);\n"
16855 #: ../src/guestfs-actions.pod:6513
16857 "This command enables swap to a swap partition with the given UUID. See "
16858 "C<guestfs_swapon_device> for other notes."
16862 #: ../src/guestfs-actions.pod:6520
16863 msgid "guestfs_sync"
16867 #: ../src/guestfs-actions.pod:6522
16871 " guestfs_sync (guestfs_h *g);\n"
16876 #: ../src/guestfs-actions.pod:6525 ../fish/guestfish-actions.pod:4396
16878 "This syncs the disk, so that any writes are flushed through to the "
16879 "underlying disk image."
16883 #: ../src/guestfs-actions.pod:6528 ../fish/guestfish-actions.pod:4399
16885 "You should always call this if you have modified a disk image, before "
16886 "closing the handle."
16890 #: ../src/guestfs-actions.pod:6535
16891 msgid "guestfs_tail"
16895 #: ../src/guestfs-actions.pod:6537
16899 " guestfs_tail (guestfs_h *g,\n"
16900 " const char *path);\n"
16905 #: ../src/guestfs-actions.pod:6541 ../fish/guestfish-actions.pod:4406
16907 "This command returns up to the last 10 lines of a file as a list of strings."
16911 #: ../src/guestfs-actions.pod:6553
16912 msgid "guestfs_tail_n"
16916 #: ../src/guestfs-actions.pod:6555
16920 " guestfs_tail_n (guestfs_h *g,\n"
16922 " const char *path);\n"
16927 #: ../src/guestfs-actions.pod:6560 ../fish/guestfish-actions.pod:4416
16929 "If the parameter C<nrlines> is a positive number, this returns the last "
16930 "C<nrlines> lines of the file C<path>."
16934 #: ../src/guestfs-actions.pod:6563 ../fish/guestfish-actions.pod:4419
16936 "If the parameter C<nrlines> is a negative number, this returns lines from "
16937 "the file C<path>, starting with the C<-nrlines>th line."
16941 #: ../src/guestfs-actions.pod:6577
16942 msgid "guestfs_tar_in"
16946 #: ../src/guestfs-actions.pod:6579
16950 " guestfs_tar_in (guestfs_h *g,\n"
16951 " const char *tarfile,\n"
16952 " const char *directory);\n"
16957 #: ../src/guestfs-actions.pod:6584 ../fish/guestfish-actions.pod:4431
16959 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
16960 "tar file) into C<directory>."
16964 #: ../src/guestfs-actions.pod:6587
16966 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
16970 #: ../src/guestfs-actions.pod:6592 ../src/guestfs-actions.pod:6609
16971 #: ../src/guestfs-actions.pod:6625 ../src/guestfs-actions.pod:6641
16972 msgid "(Added in 1.0.3)"
16976 #: ../src/guestfs-actions.pod:6594
16977 msgid "guestfs_tar_out"
16981 #: ../src/guestfs-actions.pod:6596
16985 " guestfs_tar_out (guestfs_h *g,\n"
16986 " const char *directory,\n"
16987 " const char *tarfile);\n"
16992 #: ../src/guestfs-actions.pod:6601 ../fish/guestfish-actions.pod:4443
16994 "This command packs the contents of C<directory> and downloads it to local "
16999 #: ../src/guestfs-actions.pod:6604
17001 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17002 "C<guestfs_txz_out>."
17006 #: ../src/guestfs-actions.pod:6611
17007 msgid "guestfs_tgz_in"
17011 #: ../src/guestfs-actions.pod:6613
17015 " guestfs_tgz_in (guestfs_h *g,\n"
17016 " const char *tarball,\n"
17017 " const char *directory);\n"
17022 #: ../src/guestfs-actions.pod:6618 ../fish/guestfish-actions.pod:4455
17024 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17025 "tar file) into C<directory>."
17029 #: ../src/guestfs-actions.pod:6621
17030 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17034 #: ../src/guestfs-actions.pod:6627
17035 msgid "guestfs_tgz_out"
17039 #: ../src/guestfs-actions.pod:6629
17043 " guestfs_tgz_out (guestfs_h *g,\n"
17044 " const char *directory,\n"
17045 " const char *tarball);\n"
17050 #: ../src/guestfs-actions.pod:6634 ../fish/guestfish-actions.pod:4466
17052 "This command packs the contents of C<directory> and downloads it to local "
17057 #: ../src/guestfs-actions.pod:6637
17058 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
17062 #: ../src/guestfs-actions.pod:6643
17063 msgid "guestfs_touch"
17067 #: ../src/guestfs-actions.pod:6645
17071 " guestfs_touch (guestfs_h *g,\n"
17072 " const char *path);\n"
17077 #: ../src/guestfs-actions.pod:6649 ../fish/guestfish-actions.pod:4477
17079 "Touch acts like the L<touch(1)> command. It can be used to update the "
17080 "timestamps on a file, or, if the file does not exist, to create a new zero-"
17085 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4481
17087 "This command only works on regular files, and will fail on other file types "
17088 "such as directories, symbolic links, block special etc."
17092 #: ../src/guestfs-actions.pod:6660
17093 msgid "guestfs_truncate"
17097 #: ../src/guestfs-actions.pod:6662
17101 " guestfs_truncate (guestfs_h *g,\n"
17102 " const char *path);\n"
17107 #: ../src/guestfs-actions.pod:6666 ../fish/guestfish-actions.pod:4488
17109 "This command truncates C<path> to a zero-length file. The file must exist "
17114 #: ../src/guestfs-actions.pod:6673
17115 msgid "guestfs_truncate_size"
17119 #: ../src/guestfs-actions.pod:6675
17123 " guestfs_truncate_size (guestfs_h *g,\n"
17124 " const char *path,\n"
17125 " int64_t size);\n"
17130 #: ../src/guestfs-actions.pod:6680 ../fish/guestfish-actions.pod:4495
17132 "This command truncates C<path> to size C<size> bytes. The file must exist "
17137 #: ../src/guestfs-actions.pod:6683
17139 "If the current file size is less than C<size> then the file is extended to "
17140 "the required size with zero bytes. This creates a sparse file (ie. disk "
17141 "blocks are not allocated for the file until you write to it). To create a "
17142 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
17146 #: ../src/guestfs-actions.pod:6693
17147 msgid "guestfs_tune2fs_l"
17151 #: ../src/guestfs-actions.pod:6695
17155 " guestfs_tune2fs_l (guestfs_h *g,\n"
17156 " const char *device);\n"
17161 #: ../src/guestfs-actions.pod:6699 ../fish/guestfish-actions.pod:4508
17163 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17168 #: ../src/guestfs-actions.pod:6702 ../fish/guestfish-actions.pod:4511
17170 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17171 "for more details. The list of fields returned isn't clearly defined, and "
17172 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17173 "and the filesystem itself."
17177 #: ../src/guestfs-actions.pod:6715
17178 msgid "guestfs_txz_in"
17182 #: ../src/guestfs-actions.pod:6717
17186 " guestfs_txz_in (guestfs_h *g,\n"
17187 " const char *tarball,\n"
17188 " const char *directory);\n"
17193 #: ../src/guestfs-actions.pod:6722 ../fish/guestfish-actions.pod:4520
17195 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17196 "tar file) into C<directory>."
17200 #: ../src/guestfs-actions.pod:6729
17201 msgid "guestfs_txz_out"
17205 #: ../src/guestfs-actions.pod:6731
17209 " guestfs_txz_out (guestfs_h *g,\n"
17210 " const char *directory,\n"
17211 " const char *tarball);\n"
17216 #: ../src/guestfs-actions.pod:6736 ../fish/guestfish-actions.pod:4529
17218 "This command packs the contents of C<directory> and downloads it to local "
17219 "file C<tarball> (as an xz compressed tar archive)."
17223 #: ../src/guestfs-actions.pod:6743
17224 msgid "guestfs_umask"
17228 #: ../src/guestfs-actions.pod:6745
17232 " guestfs_umask (guestfs_h *g,\n"
17238 #: ../src/guestfs-actions.pod:6749 ../fish/guestfish-actions.pod:4538
17240 "This function sets the mask used for creating new files and device nodes to "
17245 #: ../src/guestfs-actions.pod:6752 ../fish/guestfish-actions.pod:4541
17247 "Typical umask values would be C<022> which creates new files with "
17248 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17249 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17253 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4546
17255 "The default umask is C<022>. This is important because it means that "
17256 "directories and device nodes will be created with C<0644> or C<0755> mode "
17257 "even if you specify C<0777>."
17261 #: ../src/guestfs-actions.pod:6761
17263 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
17264 "C<guestfs_mkdir>."
17268 #: ../src/guestfs-actions.pod:6764 ../fish/guestfish-actions.pod:4553
17269 msgid "This call returns the previous umask."
17273 #: ../src/guestfs-actions.pod:6770
17274 msgid "guestfs_umount"
17278 #: ../src/guestfs-actions.pod:6772
17282 " guestfs_umount (guestfs_h *g,\n"
17283 " const char *pathordevice);\n"
17288 #: ../src/guestfs-actions.pod:6776 ../fish/guestfish-actions.pod:4561
17290 "This unmounts the given filesystem. The filesystem may be specified either "
17291 "by its mountpoint (path) or the device which contains the filesystem."
17295 #: ../src/guestfs-actions.pod:6784
17296 msgid "guestfs_umount_all"
17300 #: ../src/guestfs-actions.pod:6786
17304 " guestfs_umount_all (guestfs_h *g);\n"
17309 #: ../src/guestfs-actions.pod:6789 ../fish/guestfish-actions.pod:4571
17310 msgid "This unmounts all mounted filesystems."
17314 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4573
17315 msgid "Some internal mounts are not unmounted by this call."
17319 #: ../src/guestfs-actions.pod:6797
17320 msgid "guestfs_upload"
17324 #: ../src/guestfs-actions.pod:6799
17328 " guestfs_upload (guestfs_h *g,\n"
17329 " const char *filename,\n"
17330 " const char *remotefilename);\n"
17335 #: ../src/guestfs-actions.pod:6804 ../src/guestfs-actions.pod:6828
17336 #: ../fish/guestfish-actions.pod:4579 ../fish/guestfish-actions.pod:4592
17337 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17341 #: ../src/guestfs-actions.pod:6809
17342 msgid "See also C<guestfs_download>."
17346 #: ../src/guestfs-actions.pod:6820
17347 msgid "guestfs_upload_offset"
17351 #: ../src/guestfs-actions.pod:6822
17355 " guestfs_upload_offset (guestfs_h *g,\n"
17356 " const char *filename,\n"
17357 " const char *remotefilename,\n"
17358 " int64_t offset);\n"
17363 #: ../src/guestfs-actions.pod:6831 ../fish/guestfish-actions.pod:4595
17365 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17366 "The intention is to overwrite parts of existing files or devices, although "
17367 "if a non-existant file is specified then it is created with a \"hole\" "
17368 "before C<offset>. The size of the data written is implicit in the size of "
17369 "the source C<filename>."
17373 #: ../src/guestfs-actions.pod:6838
17375 "Note that there is no limit on the amount of data that can be uploaded with "
17376 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17377 "full amount unless an error occurs."
17381 #: ../src/guestfs-actions.pod:6843
17382 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17386 #: ../src/guestfs-actions.pod:6854
17387 msgid "guestfs_utimens"
17391 #: ../src/guestfs-actions.pod:6856
17395 " guestfs_utimens (guestfs_h *g,\n"
17396 " const char *path,\n"
17397 " int64_t atsecs,\n"
17398 " int64_t atnsecs,\n"
17399 " int64_t mtsecs,\n"
17400 " int64_t mtnsecs);\n"
17405 #: ../src/guestfs-actions.pod:6864 ../fish/guestfish-actions.pod:4615
17406 msgid "This command sets the timestamps of a file with nanosecond precision."
17410 #: ../src/guestfs-actions.pod:6867 ../fish/guestfish-actions.pod:4618
17412 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17417 #: ../src/guestfs-actions.pod:6870 ../fish/guestfish-actions.pod:4621
17419 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17420 "nanoseconds from the epoch."
17424 #: ../src/guestfs-actions.pod:6873 ../fish/guestfish-actions.pod:4624
17426 "If the C<*nsecs> field contains the special value C<-1> then the "
17427 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17428 "ignored in this case)."
17432 #: ../src/guestfs-actions.pod:6877 ../fish/guestfish-actions.pod:4628
17434 "If the C<*nsecs> field contains the special value C<-2> then the "
17435 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17440 #: ../src/guestfs-actions.pod:6885 ../src/guestfs-structs.pod:175
17441 msgid "guestfs_version"
17445 #: ../src/guestfs-actions.pod:6887
17448 " struct guestfs_version *\n"
17449 " guestfs_version (guestfs_h *g);\n"
17454 #: ../src/guestfs-actions.pod:6890 ../fish/guestfish-actions.pod:4636
17456 "Return the libguestfs version number that the program is linked against."
17460 #: ../src/guestfs-actions.pod:6893 ../fish/guestfish-actions.pod:4639
17462 "Note that because of dynamic linking this is not necessarily the version of "
17463 "libguestfs that you compiled against. You can compile the program, and then "
17464 "at runtime dynamically link against a completely different C<libguestfs.so> "
17469 #: ../src/guestfs-actions.pod:6898 ../fish/guestfish-actions.pod:4644
17471 "This call was added in version C<1.0.58>. In previous versions of "
17472 "libguestfs there was no way to get the version number. From C code you can "
17473 "use dynamic linker functions to find out if this symbol exists (if it "
17474 "doesn't, then it's an earlier version)."
17478 #: ../src/guestfs-actions.pod:6904 ../fish/guestfish-actions.pod:4650
17480 "The call returns a structure with four elements. The first three (C<major>, "
17481 "C<minor> and C<release>) are numbers and correspond to the usual version "
17482 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17483 "but may be used for distro-specific information."
17487 #: ../src/guestfs-actions.pod:6910 ../fish/guestfish-actions.pod:4656
17489 "To construct the original version string: C<$major.$minor.$release$extra>"
17493 #: ../src/guestfs-actions.pod:6913 ../fish/guestfish-actions.pod:4659
17494 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17498 #: ../src/guestfs-actions.pod:6915
17500 "I<Note:> Don't use this call to test for availability of features. In "
17501 "enterprise distributions we backport features from later versions into "
17502 "earlier versions, making this an unreliable way to test for features. Use "
17503 "C<guestfs_available> instead."
17507 #: ../src/guestfs-actions.pod:6921
17509 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17510 "error. I<The caller must call C<guestfs_free_version> after use>."
17514 #: ../src/guestfs-actions.pod:6925
17515 msgid "(Added in 1.0.58)"
17519 #: ../src/guestfs-actions.pod:6927
17520 msgid "guestfs_vfs_label"
17524 #: ../src/guestfs-actions.pod:6929
17528 " guestfs_vfs_label (guestfs_h *g,\n"
17529 " const char *device);\n"
17534 #: ../src/guestfs-actions.pod:6933 ../fish/guestfish-actions.pod:4671
17535 msgid "This returns the filesystem label of the filesystem on C<device>."
17539 #: ../src/guestfs-actions.pod:6936 ../fish/guestfish-actions.pod:4674
17540 msgid "If the filesystem is unlabeled, this returns the empty string."
17544 #: ../src/guestfs-actions.pod:6938
17545 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17549 #: ../src/guestfs-actions.pod:6943 ../src/guestfs-actions.pod:6980
17550 msgid "(Added in 1.3.18)"
17554 #: ../src/guestfs-actions.pod:6945
17555 msgid "guestfs_vfs_type"
17559 #: ../src/guestfs-actions.pod:6947
17563 " guestfs_vfs_type (guestfs_h *g,\n"
17564 " const char *device);\n"
17569 #: ../src/guestfs-actions.pod:6951 ../fish/guestfish-actions.pod:4682
17571 "This command gets the filesystem type corresponding to the filesystem on "
17576 #: ../src/guestfs-actions.pod:6954 ../fish/guestfish-actions.pod:4685
17578 "For most filesystems, the result is the name of the Linux VFS module which "
17579 "would be used to mount this filesystem if you mounted it without specifying "
17580 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17584 #: ../src/guestfs-actions.pod:6964
17585 msgid "guestfs_vfs_uuid"
17589 #: ../src/guestfs-actions.pod:6966
17593 " guestfs_vfs_uuid (guestfs_h *g,\n"
17594 " const char *device);\n"
17599 #: ../src/guestfs-actions.pod:6970 ../fish/guestfish-actions.pod:4694
17600 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17604 #: ../src/guestfs-actions.pod:6973 ../fish/guestfish-actions.pod:4697
17605 msgid "If the filesystem does not have a UUID, this returns the empty string."
17609 #: ../src/guestfs-actions.pod:6975
17610 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17614 #: ../src/guestfs-actions.pod:6982
17615 msgid "guestfs_vg_activate"
17619 #: ../src/guestfs-actions.pod:6984
17623 " guestfs_vg_activate (guestfs_h *g,\n"
17625 " char *const *volgroups);\n"
17630 #: ../src/guestfs-actions.pod:6989 ../fish/guestfish-actions.pod:4705
17632 "This command activates or (if C<activate> is false) deactivates all logical "
17633 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17634 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17635 "deactivated, then those devices disappear."
17639 #: ../src/guestfs-actions.pod:6995 ../fish/guestfish-actions.pod:4711
17640 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17644 #: ../src/guestfs-actions.pod:6997 ../fish/guestfish-actions.pod:4713
17646 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17647 "activated or deactivated."
17651 #: ../src/guestfs-actions.pod:7004
17652 msgid "guestfs_vg_activate_all"
17656 #: ../src/guestfs-actions.pod:7006
17660 " guestfs_vg_activate_all (guestfs_h *g,\n"
17661 " int activate);\n"
17666 #: ../src/guestfs-actions.pod:7010 ../fish/guestfish-actions.pod:4720
17668 "This command activates or (if C<activate> is false) deactivates all logical "
17669 "volumes in all volume groups. If activated, then they are made known to the "
17670 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17671 "those devices disappear."
17675 #: ../src/guestfs-actions.pod:7016 ../fish/guestfish-actions.pod:4726
17676 msgid "This command is the same as running C<vgchange -a y|n>"
17680 #: ../src/guestfs-actions.pod:7022
17681 msgid "guestfs_vgcreate"
17685 #: ../src/guestfs-actions.pod:7024
17689 " guestfs_vgcreate (guestfs_h *g,\n"
17690 " const char *volgroup,\n"
17691 " char *const *physvols);\n"
17696 #: ../src/guestfs-actions.pod:7029 ../fish/guestfish-actions.pod:4732
17698 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17699 "of physical volumes C<physvols>."
17703 #: ../src/guestfs-actions.pod:7036
17704 msgid "guestfs_vglvuuids"
17708 #: ../src/guestfs-actions.pod:7038
17712 " guestfs_vglvuuids (guestfs_h *g,\n"
17713 " const char *vgname);\n"
17718 #: ../src/guestfs-actions.pod:7042 ../fish/guestfish-actions.pod:4739
17720 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17721 "volumes created in this volume group."
17725 #: ../src/guestfs-actions.pod:7045
17727 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17728 "associate logical volumes and volume groups."
17732 #: ../src/guestfs-actions.pod:7048
17733 msgid "See also C<guestfs_vgpvuuids>."
17737 #: ../src/guestfs-actions.pod:7056
17738 msgid "guestfs_vgpvuuids"
17742 #: ../src/guestfs-actions.pod:7058
17746 " guestfs_vgpvuuids (guestfs_h *g,\n"
17747 " const char *vgname);\n"
17752 #: ../src/guestfs-actions.pod:7062 ../fish/guestfish-actions.pod:4751
17754 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17755 "volumes that this volume group resides on."
17759 #: ../src/guestfs-actions.pod:7065
17761 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
17762 "associate physical volumes and volume groups."
17766 #: ../src/guestfs-actions.pod:7068
17767 msgid "See also C<guestfs_vglvuuids>."
17771 #: ../src/guestfs-actions.pod:7076
17772 msgid "guestfs_vgremove"
17776 #: ../src/guestfs-actions.pod:7078
17780 " guestfs_vgremove (guestfs_h *g,\n"
17781 " const char *vgname);\n"
17786 #: ../src/guestfs-actions.pod:7082 ../fish/guestfish-actions.pod:4763
17787 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
17791 #: ../src/guestfs-actions.pod:7084 ../fish/guestfish-actions.pod:4765
17793 "This also forcibly removes all logical volumes in the volume group (if any)."
17797 #: ../src/guestfs-actions.pod:7091
17798 msgid "guestfs_vgrename"
17802 #: ../src/guestfs-actions.pod:7093
17806 " guestfs_vgrename (guestfs_h *g,\n"
17807 " const char *volgroup,\n"
17808 " const char *newvolgroup);\n"
17813 #: ../src/guestfs-actions.pod:7098 ../fish/guestfish-actions.pod:4772
17814 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
17818 #: ../src/guestfs-actions.pod:7104
17819 msgid "guestfs_vgs"
17823 #: ../src/guestfs-actions.pod:7106
17827 " guestfs_vgs (guestfs_h *g);\n"
17832 #: ../src/guestfs-actions.pod:7109 ../fish/guestfish-actions.pod:4778
17834 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
17839 #: ../src/guestfs-actions.pod:7112 ../fish/guestfish-actions.pod:4781
17841 "This returns a list of just the volume group names that were detected (eg. "
17846 #: ../src/guestfs-actions.pod:7115
17847 msgid "See also C<guestfs_vgs_full>."
17851 #: ../src/guestfs-actions.pod:7123
17852 msgid "guestfs_vgs_full"
17856 #: ../src/guestfs-actions.pod:7125
17859 " struct guestfs_lvm_vg_list *\n"
17860 " guestfs_vgs_full (guestfs_h *g);\n"
17865 #: ../src/guestfs-actions.pod:7128 ../fish/guestfish-actions.pod:4790
17867 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
17868 "> command. The \"full\" version includes all fields."
17872 #: ../src/guestfs-actions.pod:7131
17874 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
17875 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
17879 #: ../src/guestfs-actions.pod:7137
17880 msgid "guestfs_vgscan"
17884 #: ../src/guestfs-actions.pod:7139
17888 " guestfs_vgscan (guestfs_h *g);\n"
17893 #: ../src/guestfs-actions.pod:7142 ../fish/guestfish-actions.pod:4797
17895 "This rescans all block devices and rebuilds the list of LVM physical "
17896 "volumes, volume groups and logical volumes."
17900 #: ../src/guestfs-actions.pod:7149
17901 msgid "guestfs_vguuid"
17905 #: ../src/guestfs-actions.pod:7151
17909 " guestfs_vguuid (guestfs_h *g,\n"
17910 " const char *vgname);\n"
17915 #: ../src/guestfs-actions.pod:7155 ../fish/guestfish-actions.pod:4804
17916 msgid "This command returns the UUID of the LVM VG named C<vgname>."
17920 #: ../src/guestfs-actions.pod:7162
17921 msgid "guestfs_wait_ready"
17925 #: ../src/guestfs-actions.pod:7164
17929 " guestfs_wait_ready (guestfs_h *g);\n"
17934 #: ../src/guestfs-actions.pod:7167
17935 msgid "This function is a no op."
17939 #: ../src/guestfs-actions.pod:7169
17941 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
17942 "calling C<guestfs_launch> to wait for the launch to complete. However this "
17943 "is no longer necessary because C<guestfs_launch> now does the waiting."
17947 #: ../src/guestfs-actions.pod:7174
17949 "If you see any calls to this function in code then you can just remove them, "
17950 "unless you want to retain compatibility with older versions of the API."
17954 #: ../src/guestfs-actions.pod:7182
17955 msgid "guestfs_wc_c"
17959 #: ../src/guestfs-actions.pod:7184
17963 " guestfs_wc_c (guestfs_h *g,\n"
17964 " const char *path);\n"
17969 #: ../src/guestfs-actions.pod:7188 ../fish/guestfish-actions.pod:4810
17971 "This command counts the characters in a file, using the C<wc -c> external "
17976 #: ../src/guestfs-actions.pod:7195
17977 msgid "guestfs_wc_l"
17981 #: ../src/guestfs-actions.pod:7197
17985 " guestfs_wc_l (guestfs_h *g,\n"
17986 " const char *path);\n"
17991 #: ../src/guestfs-actions.pod:7201 ../fish/guestfish-actions.pod:4817
17993 "This command counts the lines in a file, using the C<wc -l> external command."
17997 #: ../src/guestfs-actions.pod:7208
17998 msgid "guestfs_wc_w"
18002 #: ../src/guestfs-actions.pod:7210
18006 " guestfs_wc_w (guestfs_h *g,\n"
18007 " const char *path);\n"
18012 #: ../src/guestfs-actions.pod:7214 ../fish/guestfish-actions.pod:4824
18014 "This command counts the words in a file, using the C<wc -w> external command."
18018 #: ../src/guestfs-actions.pod:7221
18019 msgid "guestfs_write"
18023 #: ../src/guestfs-actions.pod:7223
18027 " guestfs_write (guestfs_h *g,\n"
18028 " const char *path,\n"
18029 " const char *content,\n"
18030 " size_t content_size);\n"
18035 #: ../src/guestfs-actions.pod:7229 ../fish/guestfish-actions.pod:4831
18037 "This call creates a file called C<path>. The content of the file is the "
18038 "string C<content> (which can contain any 8 bit data)."
18042 #: ../src/guestfs-actions.pod:7239
18043 msgid "guestfs_write_file"
18047 #: ../src/guestfs-actions.pod:7241
18051 " guestfs_write_file (guestfs_h *g,\n"
18052 " const char *path,\n"
18053 " const char *content,\n"
18059 #: ../src/guestfs-actions.pod:7247 ../fish/guestfish-actions.pod:4841
18061 "This call creates a file called C<path>. The contents of the file is the "
18062 "string C<content> (which can contain any 8 bit data), with length C<size>."
18066 #: ../src/guestfs-actions.pod:7251 ../fish/guestfish-actions.pod:4845
18068 "As a special case, if C<size> is C<0> then the length is calculated using "
18069 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18073 #: ../src/guestfs-actions.pod:7255 ../fish/guestfish-actions.pod:4849
18075 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18076 "I<not> work, even if the length is specified."
18080 #: ../src/guestfs-actions.pod:7263 ../fish/guestfish-actions.pod:4855
18082 "This function is deprecated. In new code, use the C<write> call instead."
18086 #: ../src/guestfs-actions.pod:7272
18087 msgid "guestfs_zegrep"
18091 #: ../src/guestfs-actions.pod:7274
18095 " guestfs_zegrep (guestfs_h *g,\n"
18096 " const char *regex,\n"
18097 " const char *path);\n"
18102 #: ../src/guestfs-actions.pod:7279 ../fish/guestfish-actions.pod:4866
18104 "This calls the external C<zegrep> program and returns the matching lines."
18108 #: ../src/guestfs-actions.pod:7291
18109 msgid "guestfs_zegrepi"
18113 #: ../src/guestfs-actions.pod:7293
18117 " guestfs_zegrepi (guestfs_h *g,\n"
18118 " const char *regex,\n"
18119 " const char *path);\n"
18124 #: ../src/guestfs-actions.pod:7298 ../fish/guestfish-actions.pod:4876
18126 "This calls the external C<zegrep -i> program and returns the matching lines."
18130 #: ../src/guestfs-actions.pod:7310
18131 msgid "guestfs_zero"
18135 #: ../src/guestfs-actions.pod:7312
18139 " guestfs_zero (guestfs_h *g,\n"
18140 " const char *device);\n"
18145 #: ../src/guestfs-actions.pod:7316 ../fish/guestfish-actions.pod:4886
18146 msgid "This command writes zeroes over the first few blocks of C<device>."
18150 #: ../src/guestfs-actions.pod:7318 ../fish/guestfish-actions.pod:4888
18152 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18153 "securely wipe the device). It should be sufficient to remove any partition "
18154 "tables, filesystem superblocks and so on."
18158 #: ../src/guestfs-actions.pod:7322
18159 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
18163 #: ../src/guestfs-actions.pod:7333
18164 msgid "guestfs_zero_device"
18168 #: ../src/guestfs-actions.pod:7335
18172 " guestfs_zero_device (guestfs_h *g,\n"
18173 " const char *device);\n"
18178 #: ../src/guestfs-actions.pod:7339
18180 "This command writes zeroes over the entire C<device>. Compare with "
18181 "C<guestfs_zero> which just zeroes the first few blocks of a device."
18185 #: ../src/guestfs-actions.pod:7353
18186 msgid "(Added in 1.3.1)"
18190 #: ../src/guestfs-actions.pod:7355
18191 msgid "guestfs_zerofree"
18195 #: ../src/guestfs-actions.pod:7357
18199 " guestfs_zerofree (guestfs_h *g,\n"
18200 " const char *device);\n"
18205 #: ../src/guestfs-actions.pod:7361 ../fish/guestfish-actions.pod:4909
18207 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18208 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18209 "possible to compress the filesystem more effectively."
18213 #: ../src/guestfs-actions.pod:7366 ../fish/guestfish-actions.pod:4914
18214 msgid "You should B<not> run this program if the filesystem is mounted."
18218 #: ../src/guestfs-actions.pod:7369 ../fish/guestfish-actions.pod:4917
18220 "It is possible that using this program can damage the filesystem or data on "
18225 #: ../src/guestfs-actions.pod:7376
18226 msgid "guestfs_zfgrep"
18230 #: ../src/guestfs-actions.pod:7378
18234 " guestfs_zfgrep (guestfs_h *g,\n"
18235 " const char *pattern,\n"
18236 " const char *path);\n"
18241 #: ../src/guestfs-actions.pod:7383 ../fish/guestfish-actions.pod:4924
18243 "This calls the external C<zfgrep> program and returns the matching lines."
18247 #: ../src/guestfs-actions.pod:7395
18248 msgid "guestfs_zfgrepi"
18252 #: ../src/guestfs-actions.pod:7397
18256 " guestfs_zfgrepi (guestfs_h *g,\n"
18257 " const char *pattern,\n"
18258 " const char *path);\n"
18263 #: ../src/guestfs-actions.pod:7402 ../fish/guestfish-actions.pod:4934
18265 "This calls the external C<zfgrep -i> program and returns the matching lines."
18269 #: ../src/guestfs-actions.pod:7414
18270 msgid "guestfs_zfile"
18274 #: ../src/guestfs-actions.pod:7416
18278 " guestfs_zfile (guestfs_h *g,\n"
18279 " const char *meth,\n"
18280 " const char *path);\n"
18285 #: ../src/guestfs-actions.pod:7421 ../fish/guestfish-actions.pod:4944
18287 "This command runs C<file> after first decompressing C<path> using C<method>."
18291 #: ../src/guestfs-actions.pod:7424 ../fish/guestfish-actions.pod:4947
18292 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18296 #: ../src/guestfs-actions.pod:7426
18298 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18303 #: ../src/guestfs-actions.pod:7432 ../fish/guestfish-actions.pod:4952
18305 "This function is deprecated. In new code, use the C<file> call instead."
18309 #: ../src/guestfs-actions.pod:7441
18310 msgid "guestfs_zgrep"
18314 #: ../src/guestfs-actions.pod:7443
18318 " guestfs_zgrep (guestfs_h *g,\n"
18319 " const char *regex,\n"
18320 " const char *path);\n"
18325 #: ../src/guestfs-actions.pod:7448 ../fish/guestfish-actions.pod:4963
18327 "This calls the external C<zgrep> program and returns the matching lines."
18331 #: ../src/guestfs-actions.pod:7460
18332 msgid "guestfs_zgrepi"
18336 #: ../src/guestfs-actions.pod:7462
18340 " guestfs_zgrepi (guestfs_h *g,\n"
18341 " const char *regex,\n"
18342 " const char *path);\n"
18347 #: ../src/guestfs-actions.pod:7467 ../fish/guestfish-actions.pod:4973
18349 "This calls the external C<zgrep -i> program and returns the matching lines."
18353 #: ../src/guestfs-availability.pod:3
18358 #: ../src/guestfs-availability.pod:5
18360 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
18361 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
18362 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
18363 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
18364 "L</guestfs_aug_save> L</guestfs_aug_set>"
18368 #: ../src/guestfs-availability.pod:21
18373 #: ../src/guestfs-availability.pod:23
18375 "The following functions: L</guestfs_inotify_add_watch> L</"
18376 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
18377 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18381 #: ../src/guestfs-availability.pod:31
18382 msgid "B<linuxfsuuid>"
18386 #: ../src/guestfs-availability.pod:33
18388 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
18389 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18393 #: ../src/guestfs-availability.pod:40
18394 msgid "B<linuxmodules>"
18398 #: ../src/guestfs-availability.pod:42
18399 msgid "The following functions: L</guestfs_modprobe>"
18403 #: ../src/guestfs-availability.pod:45
18404 msgid "B<linuxxattrs>"
18408 #: ../src/guestfs-availability.pod:47
18410 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
18411 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
18412 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
18413 "guestfs_setxattr>"
18417 #: ../src/guestfs-availability.pod:58
18422 #: ../src/guestfs-availability.pod:60
18424 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
18425 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
18426 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18430 #: ../src/guestfs-availability.pod:69
18435 #: ../src/guestfs-availability.pod:71
18437 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
18438 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
18439 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
18440 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
18441 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
18442 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
18443 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
18447 #: ../src/guestfs-availability.pod:94
18452 #: ../src/guestfs-availability.pod:96
18454 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
18455 "guestfs_mknod_b> L</guestfs_mknod_c>"
18459 #: ../src/guestfs-availability.pod:102
18464 #: ../src/guestfs-availability.pod:104
18465 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18469 #: ../src/guestfs-availability.pod:107
18470 msgid "B<ntfsprogs>"
18474 #: ../src/guestfs-availability.pod:109
18476 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
18480 #: ../src/guestfs-availability.pod:113
18481 msgid "B<realpath>"
18485 #: ../src/guestfs-availability.pod:115
18486 msgid "The following functions: L</guestfs_realpath>"
18490 #: ../src/guestfs-availability.pod:118
18495 #: ../src/guestfs-availability.pod:120
18497 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
18498 "guestfs_scrub_freespace>"
18502 #: ../src/guestfs-availability.pod:125
18507 #: ../src/guestfs-availability.pod:127
18508 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18512 #: ../src/guestfs-availability.pod:131
18517 #: ../src/guestfs-availability.pod:133
18518 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18522 #: ../src/guestfs-availability.pod:137
18523 msgid "B<zerofree>"
18527 #: ../src/guestfs-availability.pod:139
18528 msgid "The following functions: L</guestfs_zerofree>"
18532 #: ../src/guestfs-structs.pod:1
18533 msgid "guestfs_int_bool"
18537 #: ../src/guestfs-structs.pod:3
18540 " struct guestfs_int_bool {\n"
18548 #: ../src/guestfs-structs.pod:8
18551 " struct guestfs_int_bool_list {\n"
18552 " uint32_t len; /* Number of elements in list. */\n"
18553 " struct guestfs_int_bool *val; /* Elements. */\n"
18559 #: ../src/guestfs-structs.pod:13
18562 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18563 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18568 #: ../src/guestfs-structs.pod:16
18569 msgid "guestfs_lvm_pv"
18573 #: ../src/guestfs-structs.pod:18
18576 " struct guestfs_lvm_pv {\n"
18577 " char *pv_name;\n"
18578 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18579 " char pv_uuid[32];\n"
18581 " uint64_t pv_size;\n"
18582 " uint64_t dev_size;\n"
18583 " uint64_t pv_free;\n"
18584 " uint64_t pv_used;\n"
18585 " char *pv_attr;\n"
18586 " int64_t pv_pe_count;\n"
18587 " int64_t pv_pe_alloc_count;\n"
18588 " char *pv_tags;\n"
18589 " uint64_t pe_start;\n"
18590 " int64_t pv_mda_count;\n"
18591 " uint64_t pv_mda_free;\n"
18597 #: ../src/guestfs-structs.pod:36
18600 " struct guestfs_lvm_pv_list {\n"
18601 " uint32_t len; /* Number of elements in list. */\n"
18602 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18608 #: ../src/guestfs-structs.pod:41
18611 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18612 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18617 #: ../src/guestfs-structs.pod:44
18618 msgid "guestfs_lvm_vg"
18622 #: ../src/guestfs-structs.pod:46
18625 " struct guestfs_lvm_vg {\n"
18626 " char *vg_name;\n"
18627 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18628 " char vg_uuid[32];\n"
18630 " char *vg_attr;\n"
18631 " uint64_t vg_size;\n"
18632 " uint64_t vg_free;\n"
18633 " char *vg_sysid;\n"
18634 " uint64_t vg_extent_size;\n"
18635 " int64_t vg_extent_count;\n"
18636 " int64_t vg_free_count;\n"
18637 " int64_t max_lv;\n"
18638 " int64_t max_pv;\n"
18639 " int64_t pv_count;\n"
18640 " int64_t lv_count;\n"
18641 " int64_t snap_count;\n"
18642 " int64_t vg_seqno;\n"
18643 " char *vg_tags;\n"
18644 " int64_t vg_mda_count;\n"
18645 " uint64_t vg_mda_free;\n"
18651 #: ../src/guestfs-structs.pod:69
18654 " struct guestfs_lvm_vg_list {\n"
18655 " uint32_t len; /* Number of elements in list. */\n"
18656 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18662 #: ../src/guestfs-structs.pod:74
18665 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18666 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18671 #: ../src/guestfs-structs.pod:77
18672 msgid "guestfs_lvm_lv"
18676 #: ../src/guestfs-structs.pod:79
18679 " struct guestfs_lvm_lv {\n"
18680 " char *lv_name;\n"
18681 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18682 " char lv_uuid[32];\n"
18683 " char *lv_attr;\n"
18684 " int64_t lv_major;\n"
18685 " int64_t lv_minor;\n"
18686 " int64_t lv_kernel_major;\n"
18687 " int64_t lv_kernel_minor;\n"
18688 " uint64_t lv_size;\n"
18689 " int64_t seg_count;\n"
18691 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18692 " float snap_percent;\n"
18693 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18694 " float copy_percent;\n"
18695 " char *move_pv;\n"
18696 " char *lv_tags;\n"
18697 " char *mirror_log;\n"
18698 " char *modules;\n"
18704 #: ../src/guestfs-structs.pod:101
18707 " struct guestfs_lvm_lv_list {\n"
18708 " uint32_t len; /* Number of elements in list. */\n"
18709 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18715 #: ../src/guestfs-structs.pod:106
18718 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18719 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18724 #: ../src/guestfs-structs.pod:111
18727 " struct guestfs_stat {\n"
18731 " int64_t nlink;\n"
18736 " int64_t blksize;\n"
18737 " int64_t blocks;\n"
18738 " int64_t atime;\n"
18739 " int64_t mtime;\n"
18740 " int64_t ctime;\n"
18746 #: ../src/guestfs-structs.pod:127
18749 " struct guestfs_stat_list {\n"
18750 " uint32_t len; /* Number of elements in list. */\n"
18751 " struct guestfs_stat *val; /* Elements. */\n"
18757 #: ../src/guestfs-structs.pod:132
18760 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
18761 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
18766 #: ../src/guestfs-structs.pod:137
18769 " struct guestfs_statvfs {\n"
18770 " int64_t bsize;\n"
18771 " int64_t frsize;\n"
18772 " int64_t blocks;\n"
18773 " int64_t bfree;\n"
18774 " int64_t bavail;\n"
18775 " int64_t files;\n"
18776 " int64_t ffree;\n"
18777 " int64_t favail;\n"
18780 " int64_t namemax;\n"
18786 #: ../src/guestfs-structs.pod:151
18789 " struct guestfs_statvfs_list {\n"
18790 " uint32_t len; /* Number of elements in list. */\n"
18791 " struct guestfs_statvfs *val; /* Elements. */\n"
18797 #: ../src/guestfs-structs.pod:156
18800 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
18801 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
18806 #: ../src/guestfs-structs.pod:159
18807 msgid "guestfs_dirent"
18811 #: ../src/guestfs-structs.pod:161
18814 " struct guestfs_dirent {\n"
18823 #: ../src/guestfs-structs.pod:167
18826 " struct guestfs_dirent_list {\n"
18827 " uint32_t len; /* Number of elements in list. */\n"
18828 " struct guestfs_dirent *val; /* Elements. */\n"
18834 #: ../src/guestfs-structs.pod:172
18837 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
18838 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
18843 #: ../src/guestfs-structs.pod:177
18846 " struct guestfs_version {\n"
18847 " int64_t major;\n"
18848 " int64_t minor;\n"
18849 " int64_t release;\n"
18856 #: ../src/guestfs-structs.pod:184
18859 " struct guestfs_version_list {\n"
18860 " uint32_t len; /* Number of elements in list. */\n"
18861 " struct guestfs_version *val; /* Elements. */\n"
18867 #: ../src/guestfs-structs.pod:189
18870 " void guestfs_free_version (struct guestfs_free_version *);\n"
18871 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
18876 #: ../src/guestfs-structs.pod:192
18877 msgid "guestfs_xattr"
18881 #: ../src/guestfs-structs.pod:194
18884 " struct guestfs_xattr {\n"
18885 " char *attrname;\n"
18886 " /* The next two fields describe a byte array. */\n"
18887 " uint32_t attrval_len;\n"
18888 " char *attrval;\n"
18894 #: ../src/guestfs-structs.pod:201
18897 " struct guestfs_xattr_list {\n"
18898 " uint32_t len; /* Number of elements in list. */\n"
18899 " struct guestfs_xattr *val; /* Elements. */\n"
18905 #: ../src/guestfs-structs.pod:206
18908 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
18909 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
18914 #: ../src/guestfs-structs.pod:209
18915 msgid "guestfs_inotify_event"
18919 #: ../src/guestfs-structs.pod:211
18922 " struct guestfs_inotify_event {\n"
18923 " int64_t in_wd;\n"
18924 " uint32_t in_mask;\n"
18925 " uint32_t in_cookie;\n"
18926 " char *in_name;\n"
18932 #: ../src/guestfs-structs.pod:218
18935 " struct guestfs_inotify_event_list {\n"
18936 " uint32_t len; /* Number of elements in list. */\n"
18937 " struct guestfs_inotify_event *val; /* Elements. */\n"
18943 #: ../src/guestfs-structs.pod:223
18946 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
18947 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
18952 #: ../src/guestfs-structs.pod:226
18953 msgid "guestfs_partition"
18957 #: ../src/guestfs-structs.pod:228
18960 " struct guestfs_partition {\n"
18961 " int32_t part_num;\n"
18962 " uint64_t part_start;\n"
18963 " uint64_t part_end;\n"
18964 " uint64_t part_size;\n"
18970 #: ../src/guestfs-structs.pod:235
18973 " struct guestfs_partition_list {\n"
18974 " uint32_t len; /* Number of elements in list. */\n"
18975 " struct guestfs_partition *val; /* Elements. */\n"
18981 #: ../src/guestfs-structs.pod:240
18984 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
18985 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
18990 #: ../src/guestfs-structs.pod:243
18991 msgid "guestfs_application"
18995 #: ../src/guestfs-structs.pod:245
18998 " struct guestfs_application {\n"
18999 " char *app_name;\n"
19000 " char *app_display_name;\n"
19001 " int32_t app_epoch;\n"
19002 " char *app_version;\n"
19003 " char *app_release;\n"
19004 " char *app_install_path;\n"
19005 " char *app_trans_path;\n"
19006 " char *app_publisher;\n"
19007 " char *app_url;\n"
19008 " char *app_source_package;\n"
19009 " char *app_summary;\n"
19010 " char *app_description;\n"
19016 #: ../src/guestfs-structs.pod:260
19019 " struct guestfs_application_list {\n"
19020 " uint32_t len; /* Number of elements in list. */\n"
19021 " struct guestfs_application *val; /* Elements. */\n"
19027 #: ../src/guestfs-structs.pod:265
19030 " void guestfs_free_application (struct guestfs_free_application *);\n"
19031 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
19036 #: ../fish/guestfish.pod:5
19037 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19041 #: ../fish/guestfish.pod:9
19044 " guestfish [--options] [commands]\n"
19049 #: ../fish/guestfish.pod:11
19057 #: ../fish/guestfish.pod:13
19060 " guestfish [--ro|--rw] -a disk.img\n"
19065 #: ../fish/guestfish.pod:15
19068 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19073 #: ../fish/guestfish.pod:17
19076 " guestfish -d libvirt-domain\n"
19081 #: ../fish/guestfish.pod:19
19084 " guestfish [--ro|--rw] -a disk.img -i\n"
19089 #: ../fish/guestfish.pod:21
19092 " guestfish -d libvirt-domain -i\n"
19097 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
19098 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
19103 #: ../fish/guestfish.pod:25
19105 "Using guestfish in read/write mode on live virtual machines can be "
19106 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
19107 "option to use guestfish safely if the disk image or virtual machine might be "
19112 #: ../fish/guestfish.pod:32
19114 "Guestfish is a shell and command-line tool for examining and modifying "
19115 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19116 "functionality of the guestfs API, see L<guestfs(3)>."
19120 #: ../fish/guestfish.pod:36
19122 "Guestfish gives you structured access to the libguestfs API, from shell "
19123 "scripts or the command line or interactively. If you want to rescue a "
19124 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19129 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:942
19130 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63
19131 #: ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:50
19136 #: ../fish/guestfish.pod:43
19137 msgid "As an interactive shell"
19141 #: ../fish/guestfish.pod:45
19149 #: ../fish/guestfish.pod:47
19152 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19153 " editing virtual machine filesystems.\n"
19158 #: ../fish/guestfish.pod:50
19161 " Type: 'help' for a list of commands\n"
19162 " 'man' to read the manual\n"
19163 " 'quit' to quit the shell\n"
19168 #: ../fish/guestfish.pod:54
19171 " ><fs> add-ro disk.img\n"
19173 " ><fs> list-filesystems\n"
19174 " /dev/sda1: ext4\n"
19175 " /dev/vg_guest/lv_root: ext4\n"
19176 " /dev/vg_guest/lv_swap: swap\n"
19177 " ><fs> mount /dev/vg_guest/lv_root /\n"
19178 " ><fs> cat /etc/fstab\n"
19180 " # Created by anaconda\n"
19187 #: ../fish/guestfish.pod:67
19188 msgid "From shell scripts"
19192 #: ../fish/guestfish.pod:69
19193 msgid "Create a new C</etc/motd> file in a guest or disk image:"
19197 #: ../fish/guestfish.pod:71
19200 " guestfish <<_EOF_\n"
19203 " mount /dev/vg_guest/lv_root /\n"
19204 " write /etc/motd \"Welcome, new users\"\n"
19210 #: ../fish/guestfish.pod:78
19211 msgid "List the LVM logical volumes in a disk image:"
19215 #: ../fish/guestfish.pod:80
19218 " guestfish -a disk.img --ro <<_EOF_\n"
19226 #: ../fish/guestfish.pod:85
19227 msgid "List all the filesystems in a disk image:"
19231 #: ../fish/guestfish.pod:87
19234 " guestfish -a disk.img --ro <<_EOF_\n"
19236 " list-filesystems\n"
19242 #: ../fish/guestfish.pod:92
19243 msgid "On one command line"
19247 #: ../fish/guestfish.pod:94
19248 msgid "Update C</etc/resolv.conf> in a guest:"
19252 #: ../fish/guestfish.pod:96
19256 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19257 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19262 #: ../fish/guestfish.pod:100
19263 msgid "Edit C</boot/grub/grub.conf> interactively:"
19267 #: ../fish/guestfish.pod:102
19270 " guestfish --rw --add disk.img \\\n"
19271 " --mount /dev/vg_guest/lv_root \\\n"
19272 " --mount /dev/sda1:/boot \\\n"
19273 " edit /boot/grub/grub.conf\n"
19278 #: ../fish/guestfish.pod:107
19279 msgid "Mount disks automatically"
19283 #: ../fish/guestfish.pod:109
19285 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
19289 #: ../fish/guestfish.pod:112
19292 " guestfish --ro -a disk.img -i cat /etc/group\n"
19297 #: ../fish/guestfish.pod:114
19300 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19305 #: ../fish/guestfish.pod:116
19306 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19310 #: ../fish/guestfish.pod:118
19313 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19318 #: ../fish/guestfish.pod:120
19319 msgid "As a script interpreter"
19323 #: ../fish/guestfish.pod:122
19324 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19328 #: ../fish/guestfish.pod:124
19331 " #!/usr/bin/guestfish -f\n"
19332 " sparse test1.img 100M\n"
19334 " part-disk /dev/sda mbr\n"
19335 " mkfs ext2 /dev/sda1\n"
19340 #: ../fish/guestfish.pod:130
19341 msgid "Start with a prepared disk"
19345 #: ../fish/guestfish.pod:132
19347 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19348 "single ext2-formatted partition:"
19352 #: ../fish/guestfish.pod:135
19355 " guestfish -N fs\n"
19360 #: ../fish/guestfish.pod:137
19361 msgid "To list what is available do:"
19365 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:933
19368 " guestfish -N help | less\n"
19373 #: ../fish/guestfish.pod:141
19374 msgid "Remote control"
19378 #: ../fish/guestfish.pod:143
19381 " eval \"`guestfish --listen`\"\n"
19382 " guestfish --remote add-ro disk.img\n"
19383 " guestfish --remote run\n"
19384 " guestfish --remote lvs\n"
19389 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
19390 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:81
19391 #: ../tools/virt-win-reg.pl:96 ../tools/virt-resize.pl:254
19392 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
19393 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
19398 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
19399 #: ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104
19400 #: ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61
19401 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
19402 #: ../tools/virt-list-partitions.pl:62
19407 #: ../fish/guestfish.pod:154
19408 msgid "Displays general help on options."
19412 #: ../fish/guestfish.pod:156
19417 #: ../fish/guestfish.pod:158
19418 msgid "B<--cmd-help>"
19422 #: ../fish/guestfish.pod:160
19423 msgid "Lists all available guestfish commands."
19427 #: ../fish/guestfish.pod:162
19432 #: ../fish/guestfish.pod:164
19433 msgid "B<--cmd-help cmd>"
19437 #: ../fish/guestfish.pod:166
19438 msgid "Displays detailed help on a single command C<cmd>."
19442 #: ../fish/guestfish.pod:168
19443 msgid "B<-a image>"
19447 #: ../fish/guestfish.pod:170
19448 msgid "B<--add image>"
19452 #: ../fish/guestfish.pod:172
19453 msgid "Add a block device or virtual machine image to the shell."
19457 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
19459 "The format of the disk image is auto-detected. To override this and force a "
19460 "particular format use the I<--format=..> option."
19464 #: ../fish/guestfish.pod:177
19466 "Using this flag is mostly equivalent to using the C<add> command, with "
19467 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19468 "the I<--format:...> flag was given."
19472 #: ../fish/guestfish.pod:181
19477 #: ../fish/guestfish.pod:183
19478 msgid "B<--connect URI>"
19482 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
19484 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19485 "URI to use. The default is to use the default libvirt connection."
19489 #: ../fish/guestfish.pod:189
19494 #: ../fish/guestfish.pod:191
19496 "If using the I<--listen> option and a csh-like shell, use this option. See "
19497 "section L</REMOTE CONTROL AND CSH> below."
19501 #: ../fish/guestfish.pod:194
19502 msgid "B<-d libvirt-domain>"
19506 #: ../fish/guestfish.pod:196
19507 msgid "B<--domain libvirt-domain>"
19511 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
19513 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19514 "used, then any libvirt domain can be used. However in write mode, only "
19515 "libvirt domains which are shut down can be named here."
19519 #: ../fish/guestfish.pod:202
19521 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19522 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19523 "if the I<--format:...> flag was given."
19527 #: ../fish/guestfish.pod:206
19532 #: ../fish/guestfish.pod:208
19533 msgid "B<--no-dest-paths>"
19537 #: ../fish/guestfish.pod:210
19539 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19540 "to hit the tab key to complete paths on the guest filesystem, but this "
19541 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19542 "allow this feature to be disabled."
19546 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
19547 msgid "B<--echo-keys>"
19551 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
19553 "When prompting for keys and passphrases, guestfish normally turns echoing "
19554 "off so you cannot see what you are typing. If you are not worried about "
19555 "Tempest attacks and there is no one else in the room you can specify this "
19556 "flag to see what you are typing."
19560 #: ../fish/guestfish.pod:222
19565 #: ../fish/guestfish.pod:224
19566 msgid "B<--file file>"
19570 #: ../fish/guestfish.pod:226
19571 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19575 #: ../fish/guestfish.pod:229
19578 " #!/usr/bin/guestfish -f\n"
19583 #: ../fish/guestfish.pod:231
19584 msgid "B<--format=raw|qcow2|..>"
19588 #: ../fish/guestfish.pod:233
19589 msgid "B<--format>"
19593 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
19595 "The default for the I<-a> option is to auto-detect the format of the disk "
19596 "image. Using this forces the disk format for I<-a> options which follow on "
19597 "the command line. Using I<--format> with no argument switches back to auto-"
19598 "detection for subsequent I<-a> options."
19602 #: ../fish/guestfish.pod:242
19605 " guestfish --format=raw -a disk.img\n"
19610 #: ../fish/guestfish.pod:244
19611 msgid "forces raw format (no auto-detection) for C<disk.img>."
19615 #: ../fish/guestfish.pod:246
19618 " guestfish --format=raw -a disk.img --format -a another.img\n"
19623 #: ../fish/guestfish.pod:248
19625 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
19626 "detection for C<another.img>."
19630 #: ../fish/guestfish.pod:251
19632 "If you have untrusted raw-format guest disk images, you should use this "
19633 "option to specify the disk format. This avoids a possible security problem "
19634 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19638 #: ../fish/guestfish.pod:256
19643 #: ../fish/guestfish.pod:258
19644 msgid "B<--inspector>"
19648 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
19650 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19651 "system and mount filesystems as they would be mounted on the real virtual "
19656 #: ../fish/guestfish.pod:264
19657 msgid "Typical usage is either:"
19661 #: ../fish/guestfish.pod:266
19664 " guestfish -d myguest -i\n"
19669 #: ../fish/guestfish.pod:268
19670 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19674 #: ../fish/guestfish.pod:270
19677 " guestfish --ro -d myguest -i\n"
19682 #: ../fish/guestfish.pod:272
19683 msgid "(for active domains, readonly), or specify the block device directly:"
19687 #: ../fish/guestfish.pod:274
19690 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19695 #: ../fish/guestfish.pod:276
19697 "Note that the command line syntax changed slightly over older versions of "
19698 "guestfish. You can still use the old syntax:"
19702 #: ../fish/guestfish.pod:279
19705 " guestfish [--ro] -i disk.img\n"
19710 #: ../fish/guestfish.pod:281
19713 " guestfish [--ro] -i libvirt-domain\n"
19718 #: ../fish/guestfish.pod:283
19720 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19721 "then using other commands to mount the filesystems that were found."
19725 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
19726 msgid "B<--keys-from-stdin>"
19730 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
19732 "Read key or passphrase parameters from stdin. The default is to try to read "
19733 "passphrases from the user by opening C</dev/tty>."
19737 #: ../fish/guestfish.pod:292
19738 msgid "B<--listen>"
19742 #: ../fish/guestfish.pod:294
19744 "Fork into the background and listen for remote commands. See section L</"
19745 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19749 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:146
19754 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
19756 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
19757 "ATTACHING TO RUNNING DAEMONS>)."
19761 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:151
19762 msgid "B<-m dev[:mountpoint[:options]]>"
19766 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
19767 msgid "B<--mount dev[:mountpoint[:options]]>"
19771 #: ../fish/guestfish.pod:306
19772 msgid "Mount the named partition or logical volume on the given mountpoint."
19776 #: ../fish/guestfish.pod:308
19777 msgid "If the mountpoint is omitted, it defaults to C</>."
19781 #: ../fish/guestfish.pod:310
19782 msgid "You have to mount something on C</> before most commands will work."
19786 #: ../fish/guestfish.pod:312
19788 "If any I<-m> or I<--mount> options are given, the guest is automatically "
19793 #: ../fish/guestfish.pod:315
19795 "If you don't know what filesystems a disk image contains, you can either run "
19796 "guestfish without this option, then list the partitions, filesystems and LVs "
19797 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
19798 "commands), or you can use the L<virt-filesystems(1)> program."
19802 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:161
19804 "The third (and rarely used) part of the mount parameter is the list of mount "
19805 "options used to mount the underlying filesystem. If this is not given, then "
19806 "the mount options are either the empty string or C<ro> (the latter if the "
19807 "I<--ro> flag is used). By specifying the mount options, you override this "
19808 "default choice. Probably the only time you would use this is to enable ACLs "
19809 "and/or extended attributes if the filesystem can support them:"
19813 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:169
19816 " -m /dev/sda1:/:acl,user_xattr\n"
19821 #: ../fish/guestfish.pod:331
19822 msgid "Using this flag is equivalent to using the C<mount-options> command."
19826 #: ../fish/guestfish.pod:333
19831 #: ../fish/guestfish.pod:335
19832 msgid "B<--no-sync>"
19836 #: ../fish/guestfish.pod:337
19838 "Disable autosync. This is enabled by default. See the discussion of "
19839 "autosync in the L<guestfs(3)> manpage."
19843 #: ../fish/guestfish.pod:340
19848 #: ../fish/guestfish.pod:342
19849 msgid "B<--new type>"
19853 #: ../fish/guestfish.pod:344
19858 #: ../fish/guestfish.pod:346
19860 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
19861 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
19862 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
19867 #: ../fish/guestfish.pod:351
19868 msgid "B<--progress-bars>"
19872 #: ../fish/guestfish.pod:353
19873 msgid "Enable progress bars, even when guestfish is used non-interactively."
19877 #: ../fish/guestfish.pod:355
19879 "Progress bars are enabled by default when guestfish is used as an "
19880 "interactive shell."
19884 #: ../fish/guestfish.pod:358
19885 msgid "B<--no-progress-bars>"
19889 #: ../fish/guestfish.pod:360
19890 msgid "Disable progress bars."
19894 #: ../fish/guestfish.pod:362
19895 msgid "B<--remote[=pid]>"
19899 #: ../fish/guestfish.pod:364
19901 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
19902 "CONTROL GUESTFISH OVER A SOCKET> below."
19906 #: ../fish/guestfish.pod:367
19911 #: ../fish/guestfish.pod:369
19916 #: ../fish/guestfish.pod:371
19918 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19919 "mounts are done read-only."
19923 #: ../fish/guestfish.pod:374
19925 "The option must always be used if the disk image or virtual machine might be "
19926 "running, and is generally recommended in cases where you don't need write "
19927 "access to the disk."
19931 #: ../fish/guestfish.pod:378
19933 "Note that prepared disk images created with I<-N> are not affected by this "
19934 "option. Also commands like C<add> are not affected - you have to specify "
19935 "the C<readonly:true> option explicitly if you need it."
19939 #: ../fish/guestfish.pod:382
19940 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
19944 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:225
19945 msgid "B<--selinux>"
19949 #: ../fish/guestfish.pod:386
19950 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
19954 #: ../fish/guestfish.pod:388
19959 #: ../fish/guestfish.pod:390
19960 msgid "B<--verbose>"
19964 #: ../fish/guestfish.pod:392
19966 "Enable very verbose messages. This is particularly useful if you find a bug."
19970 #: ../fish/guestfish.pod:395
19975 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:97
19976 #: ../tools/virt-win-reg.pl:112 ../tools/virt-resize.pl:270
19977 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
19978 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
19979 msgid "B<--version>"
19983 #: ../fish/guestfish.pod:399
19984 msgid "Display the guestfish / libguestfs version number and exit."
19988 #: ../fish/guestfish.pod:401
19993 #: ../fish/guestfish.pod:403
19998 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:239
20000 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20001 "mounts are done read-write."
20005 #: ../fish/guestfish.pod:408
20006 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
20010 #: ../fish/guestfish.pod:410
20015 #: ../fish/guestfish.pod:412
20016 msgid "Echo each command before executing it."
20020 #: ../fish/guestfish.pod:416
20021 msgid "COMMANDS ON COMMAND LINE"
20025 #: ../fish/guestfish.pod:418
20027 "Any additional (non-option) arguments are treated as commands to execute."
20031 #: ../fish/guestfish.pod:421
20033 "Commands to execute should be separated by a colon (C<:>), where the colon "
20034 "is a separate parameter. Thus:"
20038 #: ../fish/guestfish.pod:424
20041 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20046 #: ../fish/guestfish.pod:426
20048 "If there are no additional arguments, then we enter a shell, either an "
20049 "interactive shell with a prompt (if the input is a terminal) or a non-"
20050 "interactive shell."
20054 #: ../fish/guestfish.pod:430
20056 "In either command line mode or non-interactive shell, the first command that "
20057 "gives an error causes the whole shell to exit. In interactive mode (with a "
20058 "prompt) if a command fails, you can continue to enter commands."
20062 #: ../fish/guestfish.pod:435
20063 msgid "USING launch (OR run)"
20067 #: ../fish/guestfish.pod:437
20069 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20070 "then launch it, then mount any disks you need, and finally issue actions/"
20071 "commands. So the general order of the day is:"
20075 #: ../fish/guestfish.pod:445
20076 msgid "add or -a/--add"
20080 #: ../fish/guestfish.pod:449
20081 msgid "launch (aka run)"
20085 #: ../fish/guestfish.pod:453
20086 msgid "mount or -m/--mount"
20090 #: ../fish/guestfish.pod:457
20091 msgid "any other commands"
20095 #: ../fish/guestfish.pod:461
20097 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
20098 "guest before mounting or performing any other commands."
20102 #: ../fish/guestfish.pod:464
20104 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
20105 "I<--new> options were given then C<run> is done automatically, simply "
20106 "because guestfish can't perform the action you asked for without doing this."
20110 #: ../fish/guestfish.pod:469
20111 msgid "OPENING DISKS FOR READ AND WRITE"
20115 #: ../fish/guestfish.pod:471
20117 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20118 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20119 "I<-i> and I<-m> open disk images read-only or for writing."
20123 #: ../fish/guestfish.pod:476
20125 "In libguestfs E<le> 1.8, guestfish, guestmount and virt-rescue defaulted to "
20126 "opening disk images supplied on the command line for write. To open a disk "
20127 "image read-only you have to do I<-a image --ro>."
20131 #: ../fish/guestfish.pod:480
20133 "This matters: If you accidentally open a live VM disk image writable then "
20134 "you will cause irreversible disk corruption."
20138 #: ../fish/guestfish.pod:483
20140 "By libguestfs 1.10 we intend to change the default the other way. Disk "
20141 "images will be opened read-only. You will have to either specify "
20142 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20143 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20144 "access for disk images specified by those other command line options."
20148 #: ../fish/guestfish.pod:490
20150 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20151 "which does nothing (it is already the default). However it is highly "
20152 "recommended that you use this option to indicate that you need write access, "
20153 "and prepare your scripts for the day when this option will be required for "
20158 #: ../fish/guestfish.pod:496
20160 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20161 "other libguestfs program apart from guestfish and guestmount."
20165 #: ../fish/guestfish.pod:499
20170 #: ../fish/guestfish.pod:501
20172 "You can quote ordinary parameters using either single or double quotes. For "
20177 #: ../fish/guestfish.pod:504
20180 " add \"file with a space.img\"\n"
20185 #: ../fish/guestfish.pod:506
20188 " rm '/file name'\n"
20193 #: ../fish/guestfish.pod:508
20201 #: ../fish/guestfish.pod:510
20203 "A few commands require a list of strings to be passed. For these, use a "
20204 "whitespace-separated list, enclosed in quotes. Strings containing "
20205 "whitespace to be passed through must be enclosed in single quotes. A "
20206 "literal single quote must be escaped with a backslash."
20210 #: ../fish/guestfish.pod:515
20213 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
20214 " command \"/bin/echo 'foo bar'\"\n"
20215 " command \"/bin/echo \\'foo\\'\"\n"
20220 #: ../fish/guestfish.pod:519
20221 msgid "OPTIONAL ARGUMENTS"
20225 #: ../fish/guestfish.pod:521
20227 "Some commands take optional arguments. These arguments appear in this "
20228 "documentation as C<[argname:..]>. You can use them as in these examples:"
20232 #: ../fish/guestfish.pod:525
20235 " add-drive-opts filename\n"
20240 #: ../fish/guestfish.pod:527
20243 " add-drive-opts filename readonly:true\n"
20248 #: ../fish/guestfish.pod:529
20251 " add-drive-opts filename format:qcow2 readonly:false\n"
20256 #: ../fish/guestfish.pod:531
20258 "Each optional argument can appear at most once. All optional arguments must "
20259 "appear after the required ones."
20263 #: ../fish/guestfish.pod:534
20268 #: ../fish/guestfish.pod:536
20270 "This section applies to all commands which can take integers as parameters."
20274 #: ../fish/guestfish.pod:539
20275 msgid "SIZE SUFFIX"
20279 #: ../fish/guestfish.pod:541
20281 "When the command takes a parameter measured in bytes, you can use one of the "
20282 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20286 #: ../fish/guestfish.pod:547
20287 msgid "B<k> or B<K> or B<KiB>"
20291 #: ../fish/guestfish.pod:549
20292 msgid "The size in kilobytes (multiplied by 1024)."
20296 #: ../fish/guestfish.pod:551
20301 #: ../fish/guestfish.pod:553
20302 msgid "The size in SI 1000 byte units."
20306 #: ../fish/guestfish.pod:555
20307 msgid "B<M> or B<MiB>"
20311 #: ../fish/guestfish.pod:557
20312 msgid "The size in megabytes (multiplied by 1048576)."
20316 #: ../fish/guestfish.pod:559
20321 #: ../fish/guestfish.pod:561
20322 msgid "The size in SI 1000000 byte units."
20326 #: ../fish/guestfish.pod:563
20327 msgid "B<G> or B<GiB>"
20331 #: ../fish/guestfish.pod:565
20332 msgid "The size in gigabytes (multiplied by 2**30)."
20336 #: ../fish/guestfish.pod:567
20341 #: ../fish/guestfish.pod:569
20342 msgid "The size in SI 10**9 byte units."
20346 #: ../fish/guestfish.pod:571
20347 msgid "B<T> or B<TiB>"
20351 #: ../fish/guestfish.pod:573
20352 msgid "The size in terabytes (multiplied by 2**40)."
20356 #: ../fish/guestfish.pod:575
20361 #: ../fish/guestfish.pod:577
20362 msgid "The size in SI 10**12 byte units."
20366 #: ../fish/guestfish.pod:579
20367 msgid "B<P> or B<PiB>"
20371 #: ../fish/guestfish.pod:581
20372 msgid "The size in petabytes (multiplied by 2**50)."
20376 #: ../fish/guestfish.pod:583
20381 #: ../fish/guestfish.pod:585
20382 msgid "The size in SI 10**15 byte units."
20386 #: ../fish/guestfish.pod:587
20387 msgid "B<E> or B<EiB>"
20391 #: ../fish/guestfish.pod:589
20392 msgid "The size in exabytes (multiplied by 2**60)."
20396 #: ../fish/guestfish.pod:591
20401 #: ../fish/guestfish.pod:593
20402 msgid "The size in SI 10**18 byte units."
20406 #: ../fish/guestfish.pod:595
20407 msgid "B<Z> or B<ZiB>"
20411 #: ../fish/guestfish.pod:597
20412 msgid "The size in zettabytes (multiplied by 2**70)."
20416 #: ../fish/guestfish.pod:599
20421 #: ../fish/guestfish.pod:601
20422 msgid "The size in SI 10**21 byte units."
20426 #: ../fish/guestfish.pod:603
20427 msgid "B<Y> or B<YiB>"
20431 #: ../fish/guestfish.pod:605
20432 msgid "The size in yottabytes (multiplied by 2**80)."
20436 #: ../fish/guestfish.pod:607
20441 #: ../fish/guestfish.pod:609
20442 msgid "The size in SI 10**24 byte units."
20446 #: ../fish/guestfish.pod:615
20449 " truncate-size /file 1G\n"
20454 #: ../fish/guestfish.pod:617
20455 msgid "would truncate the file to 1 gigabyte."
20459 #: ../fish/guestfish.pod:619
20461 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
20462 "the parameter to L</memsize> is specified in megabytes already). Adding a "
20463 "suffix will probably not do what you expect."
20467 #: ../fish/guestfish.pod:623
20468 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20472 #: ../fish/guestfish.pod:625
20474 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20475 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20479 #: ../fish/guestfish.pod:628
20482 " 1234 decimal number 1234\n"
20483 " 02322 octal number, equivalent to decimal 1234\n"
20484 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20489 #: ../fish/guestfish.pod:632
20491 "When using the C<chmod> command, you almost always want to specify an octal "
20492 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20493 "L<chmod(1)> program):"
20497 #: ../fish/guestfish.pod:636
20500 " chmod 0777 /public # OK\n"
20501 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20506 #: ../fish/guestfish.pod:639
20508 "Commands that return numbers usually print them in decimal, but some "
20509 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20510 "octal, preceeded by C<0>)."
20514 #: ../fish/guestfish.pod:643
20515 msgid "WILDCARDS AND GLOBBING"
20519 #: ../fish/guestfish.pod:645
20521 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20522 "(globbing) by default. So for example the following will not do what you "
20527 #: ../fish/guestfish.pod:649
20535 #: ../fish/guestfish.pod:651
20537 "Assuming you don't have a directory called literally C</home/*> then the "
20538 "above command will return an error."
20542 #: ../fish/guestfish.pod:654
20543 msgid "To perform wildcard expansion, use the C<glob> command."
20547 #: ../fish/guestfish.pod:656
20550 " glob rm-rf /home/*\n"
20555 #: ../fish/guestfish.pod:658
20557 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20558 "many times), equivalent to:"
20562 #: ../fish/guestfish.pod:661
20565 " rm-rf /home/jim\n"
20566 " rm-rf /home/joe\n"
20567 " rm-rf /home/mary\n"
20572 #: ../fish/guestfish.pod:665
20573 msgid "C<glob> only works on simple guest paths and not on device names."
20577 #: ../fish/guestfish.pod:667
20579 "If you have several parameters, each containing a wildcard, then glob will "
20580 "perform a Cartesian product."
20584 #: ../fish/guestfish.pod:670
20589 #: ../fish/guestfish.pod:672
20591 "Any line which starts with a I<#> character is treated as a comment and "
20592 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20593 "a command. For example:"
20597 #: ../fish/guestfish.pod:676
20600 " # this is a comment\n"
20601 " # this is a comment\n"
20602 " foo # NOT a comment\n"
20607 #: ../fish/guestfish.pod:680
20608 msgid "Blank lines are also ignored."
20612 #: ../fish/guestfish.pod:682
20613 msgid "RUNNING COMMANDS LOCALLY"
20617 #: ../fish/guestfish.pod:684
20619 "Any line which starts with a I<!> character is treated as a command sent to "
20620 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20624 #: ../fish/guestfish.pod:688
20628 " tgz-out /remote local/remote-data.tar.gz\n"
20633 #: ../fish/guestfish.pod:691
20635 "will create a directory C<local> on the host, and then export the contents "
20636 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20637 "(See C<tgz-out>)."
20641 #: ../fish/guestfish.pod:695
20643 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20644 "effect, due to the way that subprocesses work in Unix."
20648 #: ../fish/guestfish.pod:698
20649 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20653 #: ../fish/guestfish.pod:700
20655 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20656 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20657 "and executed as guestfish commands."
20661 #: ../fish/guestfish.pod:704
20663 "Thus you can use shell script to construct arbitrary guestfish commands "
20664 "which are then parsed by guestfish."
20668 #: ../fish/guestfish.pod:707
20670 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20671 "through C</foo.100>) using guestfish commands alone. However this is simple "
20672 "if we use a shell script to create the guestfish commands for us:"
20676 #: ../fish/guestfish.pod:712
20679 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20684 #: ../fish/guestfish.pod:714
20685 msgid "or with names like C</foo.001>:"
20689 #: ../fish/guestfish.pod:716
20692 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20697 #: ../fish/guestfish.pod:718
20699 "When using guestfish interactively it can be helpful to just run the shell "
20700 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20701 "ordinary I<!> local command), see what guestfish commands it would run, and "
20702 "when you are happy with those prepend the C<E<lt>> character to run the "
20703 "guestfish commands for real."
20707 #: ../fish/guestfish.pod:724
20712 #: ../fish/guestfish.pod:726
20714 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20715 "command (a guestfish command) to the second command (any host command). For "
20720 #: ../fish/guestfish.pod:730
20723 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20728 #: ../fish/guestfish.pod:732
20730 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20731 "program). The above command would list all accounts in the guest filesystem "
20732 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20736 #: ../fish/guestfish.pod:737
20739 " hexdump /bin/ls | head\n"
20740 " list-devices | tail -1\n"
20741 " tgz-out / - | tar ztf -\n"
20746 #: ../fish/guestfish.pod:741
20748 "The space before the pipe symbol is required, any space after the pipe "
20749 "symbol is optional. Everything after the pipe symbol is just passed "
20750 "straight to the host shell, so it can contain redirections, globs and "
20751 "anything else that makes sense on the host side."
20755 #: ../fish/guestfish.pod:746
20757 "To use a literal argument which begins with a pipe symbol, you have to quote "
20762 #: ../fish/guestfish.pod:749
20770 #: ../fish/guestfish.pod:751
20771 msgid "HOME DIRECTORIES"
20775 #: ../fish/guestfish.pod:753
20777 "If a parameter starts with the character C<~> then the tilde may be expanded "
20778 "as a home directory path (either C<~> for the current user's home directory, "
20779 "or C<~user> for another user)."
20783 #: ../fish/guestfish.pod:757
20785 "Note that home directory expansion happens for users known I<on the host>, "
20786 "not in the guest filesystem."
20790 #: ../fish/guestfish.pod:760
20792 "To use a literal argument which begins with a tilde, you have to quote it, "
20797 #: ../fish/guestfish.pod:763
20805 #: ../fish/guestfish.pod:767
20807 "Libguestfs has some support for Linux guests encrypted according to the "
20808 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
20809 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
20810 "LUKS is supported."
20814 #: ../fish/guestfish.pod:772
20815 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
20819 #: ../fish/guestfish.pod:774
20822 " ><fs> vfs-type /dev/sda2\n"
20828 #: ../fish/guestfish.pod:777
20830 "Then open those devices using L</luks-open>. This creates a device-mapper "
20831 "device called C</dev/mapper/luksdev>."
20835 #: ../fish/guestfish.pod:780
20838 " ><fs> luks-open /dev/sda2 luksdev\n"
20839 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
20844 #: ../fish/guestfish.pod:783
20846 "Finally you have to tell LVM to scan for volume groups on the newly created "
20851 #: ../fish/guestfish.pod:786
20855 " vg-activate-all true\n"
20860 #: ../fish/guestfish.pod:789
20861 msgid "The logical volume(s) can now be mounted in the usual way."
20865 #: ../fish/guestfish.pod:791
20867 "Before closing a LUKS device you must unmount any logical volumes on it and "
20868 "deactivate the volume groups by calling C<vg-activate false VG> on each "
20869 "one. Then you can close the mapper device:"
20873 #: ../fish/guestfish.pod:795
20876 " vg-activate false /dev/VG\n"
20877 " luks-close /dev/mapper/luksdev\n"
20882 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
20883 msgid "WINDOWS PATHS"
20887 #: ../fish/guestfish.pod:800
20889 "If a path is prefixed with C<win:> then you can use Windows-style paths "
20890 "(with some limitations). The following commands are equivalent:"
20894 #: ../fish/guestfish.pod:803
20897 " file /WINDOWS/system32/config/system.LOG\n"
20902 #: ../fish/guestfish.pod:805
20905 " file win:/windows/system32/config/system.log\n"
20910 #: ../fish/guestfish.pod:807
20913 " file win:\\windows\\system32\\config\\system.log\n"
20918 #: ../fish/guestfish.pod:809
20921 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
20926 #: ../fish/guestfish.pod:811
20928 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
20929 "handles case insensitivity like Windows would. This only works in argument "
20930 "positions that expect a path."
20934 #: ../fish/guestfish.pod:815
20935 msgid "UPLOADING AND DOWNLOADING FILES"
20939 #: ../fish/guestfish.pod:817
20941 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
20942 "others which upload from or download to a local file, you can use the "
20943 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
20947 #: ../fish/guestfish.pod:821
20955 #: ../fish/guestfish.pod:823
20957 "reads stdin and creates from that a file C</foo> in the disk image, and:"
20961 #: ../fish/guestfish.pod:826
20964 " tar-out /etc - | tar tf -\n"
20969 #: ../fish/guestfish.pod:828
20971 "writes the tarball to stdout and then pipes that into the external \"tar\" "
20972 "command (see L</PIPES>)."
20976 #: ../fish/guestfish.pod:831
20978 "When using C<-> to read from stdin, the input is read up to the end of "
20979 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
20980 "some arbitrary end marker:"
20984 #: ../fish/guestfish.pod:835
20987 " upload -<<END /foo\n"
20996 #: ../fish/guestfish.pod:841
20998 "Any string of characters can be used instead of C<END>. The end marker must "
20999 "appear on a line of its own, without any preceeding or following characters "
21000 "(not even spaces)."
21004 #: ../fish/guestfish.pod:845
21006 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
21007 "upload local files (so-called \"FileIn\" parameters in the generator)."
21011 #: ../fish/guestfish.pod:848
21012 msgid "EXIT ON ERROR BEHAVIOUR"
21016 #: ../fish/guestfish.pod:850
21018 "By default, guestfish will ignore any errors when in interactive mode (ie. "
21019 "taking commands from a human over a tty), and will exit on the first error "
21020 "in non-interactive mode (scripts, commands given on the command line)."
21024 #: ../fish/guestfish.pod:855
21026 "If you prefix a command with a I<-> character, then that command will not "
21027 "cause guestfish to exit, even if that (one) command returns an error."
21031 #: ../fish/guestfish.pod:859
21032 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21036 #: ../fish/guestfish.pod:861
21038 "Guestfish can be remote-controlled over a socket. This is useful "
21039 "particularly in shell scripts where you want to make several different "
21040 "changes to a filesystem, but you don't want the overhead of starting up a "
21041 "guestfish process each time."
21045 #: ../fish/guestfish.pod:866
21046 msgid "Start a guestfish server process using:"
21050 #: ../fish/guestfish.pod:868
21053 " eval \"`guestfish --listen`\"\n"
21058 #: ../fish/guestfish.pod:870
21059 msgid "and then send it commands by doing:"
21063 #: ../fish/guestfish.pod:872
21066 " guestfish --remote cmd [...]\n"
21071 #: ../fish/guestfish.pod:874
21072 msgid "To cause the server to exit, send it the exit command:"
21076 #: ../fish/guestfish.pod:876
21079 " guestfish --remote exit\n"
21084 #: ../fish/guestfish.pod:878
21086 "Note that the server will normally exit if there is an error in a command. "
21087 "You can change this in the usual way. See section L</EXIT ON ERROR "
21092 #: ../fish/guestfish.pod:882
21093 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
21097 #: ../fish/guestfish.pod:884
21099 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
21100 "is how the I<--remote> option knows where to send the commands. You can "
21101 "have several guestfish listener processes running using:"
21105 #: ../fish/guestfish.pod:888
21108 " eval \"`guestfish --listen`\"\n"
21109 " pid1=$GUESTFISH_PID\n"
21110 " eval \"`guestfish --listen`\"\n"
21111 " pid2=$GUESTFISH_PID\n"
21113 " guestfish --remote=$pid1 cmd\n"
21114 " guestfish --remote=$pid2 cmd\n"
21119 #: ../fish/guestfish.pod:896
21120 msgid "REMOTE CONTROL AND CSH"
21124 #: ../fish/guestfish.pod:898
21126 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21131 #: ../fish/guestfish.pod:901
21134 " eval \"`guestfish --listen --csh`\"\n"
21139 #: ../fish/guestfish.pod:903
21140 msgid "REMOTE CONTROL DETAILS"
21144 #: ../fish/guestfish.pod:905
21146 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
21147 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
21148 "and C<$PID> is the process ID of the server."
21152 #: ../fish/guestfish.pod:909
21153 msgid "Guestfish client and server versions must match exactly."
21157 #: ../fish/guestfish.pod:911
21158 msgid "PREPARED DISK IMAGES"
21162 #: ../fish/guestfish.pod:913
21164 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21165 "preformatted disk images that guestfish can make for you to save typing. "
21166 "This is particularly useful for testing purposes. This option is used "
21167 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21168 "can be mixed with I<-a>)."
21172 #: ../fish/guestfish.pod:919
21174 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21175 "the second and so on. Existing files in the current directory are "
21180 #: ../fish/guestfish.pod:923
21182 "The type briefly describes how the disk should be sized, partitioned, how "
21183 "filesystem(s) should be created, and how content should be added. "
21184 "Optionally the type can be followed by extra parameters, separated by C<:> "
21185 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
21186 "allocated disk, containing a single partition, with the partition formatted "
21187 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
21192 #: ../fish/guestfish.pod:931
21193 msgid "To list the available types and any extra parameters they take, run:"
21197 #: ../fish/guestfish.pod:935
21199 "Note that the prepared filesystem is not mounted. You would usually have to "
21200 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21204 #: ../fish/guestfish.pod:939
21206 "If any I<-N> or I<--new> options are given, the guest is automatically "
21211 #: ../fish/guestfish.pod:944
21212 msgid "Create a 100MB disk with an ext4-formatted partition:"
21216 #: ../fish/guestfish.pod:946
21219 " guestfish -N fs:ext4\n"
21224 #: ../fish/guestfish.pod:948
21225 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21229 #: ../fish/guestfish.pod:950
21232 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21237 #: ../fish/guestfish.pod:952
21238 msgid "Create a blank 200MB disk:"
21242 #: ../fish/guestfish.pod:954
21245 " guestfish -N disk:200M\n"
21250 #: ../fish/guestfish.pod:956
21251 msgid "PROGRESS BARS"
21255 #: ../fish/guestfish.pod:958
21257 "Some (not all) long-running commands send progress notification messages as "
21258 "they are running. Guestfish turns these messages into progress bars."
21262 #: ../fish/guestfish.pod:962
21264 "When a command that supports progress bars takes longer than two seconds to "
21265 "run, and if progress bars are enabled, then you will see one appearing below "
21270 #: ../fish/guestfish.pod:966
21273 " ><fs> copy-size /large-file /another-file 2048M\n"
21274 " / 10% [#####-----------------------------------------] 00:30\n"
21279 #: ../fish/guestfish.pod:969
21281 "The spinner on the left hand side moves round once for every progress "
21282 "notification received from the backend. This is a (reasonably) golden "
21283 "assurance that the command is \"doing something\" even if the progress bar "
21284 "is not moving, because the command is able to send the progress "
21285 "notifications. When the bar reaches 100% and the command finishes, the "
21286 "spinner disappears."
21290 #: ../fish/guestfish.pod:976
21292 "Progress bars are enabled by default when guestfish is used interactively. "
21293 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21294 "and you can disable them completely using I<--no-progress-bars>."
21298 #: ../fish/guestfish.pod:981
21299 msgid "GUESTFISH COMMANDS"
21303 #: ../fish/guestfish.pod:983
21305 "The commands in this section are guestfish convenience commands, in other "
21306 "words, they are not part of the L<guestfs(3)> API."
21310 #: ../fish/guestfish.pod:986
21315 #: ../fish/guestfish.pod:988
21324 #: ../fish/guestfish.pod:991
21325 msgid "Without any parameter, this provides general help."
21329 #: ../fish/guestfish.pod:993
21330 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21334 #: ../fish/guestfish.pod:995
21335 msgid "quit | exit"
21339 #: ../fish/guestfish.pod:997
21340 msgid "This exits guestfish. You can also use C<^D> key."
21344 #: ../fish/guestfish.pod:999
21345 msgid "@FISH_COMMANDS@"
21349 #: ../fish/guestfish.pod:1001
21354 #: ../fish/guestfish.pod:1005 ../test-tool/libguestfs-test-tool.pod:83
21359 #: ../fish/guestfish.pod:1007
21361 "guestfish returns 0 if the commands completed without error, or 1 if there "
21366 #: ../fish/guestfish.pod:1014
21371 #: ../fish/guestfish.pod:1016
21373 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21378 #: ../fish/guestfish.pod:1019
21379 msgid "GUESTFISH_PID"
21383 #: ../fish/guestfish.pod:1021
21385 "Used with the I<--remote> option to specify the remote guestfish process to "
21386 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21390 #: ../fish/guestfish.pod:1025
21395 #: ../fish/guestfish.pod:1027
21397 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21398 "not specified, the external L<hexedit(1)> program is used."
21402 #: ../fish/guestfish.pod:1031
21407 #: ../fish/guestfish.pod:1033
21409 "If compiled with GNU readline support, various files in the home directory "
21410 "can be used. See L</FILES>."
21414 #: ../fish/guestfish.pod:1042
21416 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21417 "effect as using the B<-v> option."
21421 #: ../fish/guestfish.pod:1054
21423 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21424 "the discussion of paths in L<guestfs(3)>."
21428 #: ../fish/guestfish.pod:1065
21429 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21433 #: ../fish/guestfish.pod:1067
21438 #: ../fish/guestfish.pod:1069
21440 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21445 #: ../fish/guestfish.pod:1085 ../test-tool/libguestfs-test-tool.pod:88
21446 #: ../fuse/guestmount.pod:252
21451 #: ../fish/guestfish.pod:1089 ../fuse/guestmount.pod:256
21452 msgid "$HOME/.libguestfs-tools.rc"
21456 #: ../fish/guestfish.pod:1091 ../fuse/guestmount.pod:258
21457 msgid "/etc/libguestfs-tools.conf"
21461 #: ../fish/guestfish.pod:1093 ../fuse/guestmount.pod:260
21463 "This configuration file controls the default read-only or read-write mode "
21464 "(I<--ro> or I<--rw>)."
21468 #: ../fish/guestfish.pod:1096
21469 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21473 #: ../fish/guestfish.pod:1098
21474 msgid "$HOME/.guestfish"
21478 #: ../fish/guestfish.pod:1100
21480 "If compiled with GNU readline support, then the command history is saved in "
21485 #: ../fish/guestfish.pod:1103
21486 msgid "$HOME/.inputrc"
21490 #: ../fish/guestfish.pod:1105
21491 msgid "/etc/inputrc"
21495 #: ../fish/guestfish.pod:1107
21497 "If compiled with GNU readline support, then these files can be used to "
21498 "configure readline. For further information, please see L<readline(3)/"
21499 "INITIALIZATION FILE>."
21503 #: ../fish/guestfish.pod:1111
21504 msgid "To write rules which only apply to guestfish, use:"
21508 #: ../fish/guestfish.pod:1113
21518 #: ../fish/guestfish.pod:1117
21520 "Variables that you can set in inputrc that change the behaviour of guestfish "
21521 "in useful ways include:"
21525 #: ../fish/guestfish.pod:1122
21526 msgid "completion-ignore-case (default: on)"
21530 #: ../fish/guestfish.pod:1124
21532 "By default, guestfish will ignore case when tab-completing paths on the "
21537 #: ../fish/guestfish.pod:1127
21540 " set completion-ignore-case off\n"
21545 #: ../fish/guestfish.pod:1129
21546 msgid "to make guestfish case sensitive."
21550 #: ../fish/guestfish.pod:1133
21555 #: ../fish/guestfish.pod:1135
21556 msgid "test2.img (etc)"
21560 #: ../fish/guestfish.pod:1137
21562 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
21563 "will be created in the file C<test1.img> in the current directory. The "
21564 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
21565 "the same name will be overwritten."
21569 #: ../fish/guestfish.pod:1146
21571 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
21572 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
21573 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
21574 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
21575 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
21576 ">, L<hexedit(1)>."
21580 #: ../fish/guestfish.pod:1176 ../test-tool/libguestfs-test-tool.pod:124
21581 #: ../fuse/guestmount.pod:287 ../tools/virt-edit.pl:518
21582 #: ../tools/virt-win-reg.pl:606 ../tools/virt-resize.pl:1518
21583 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
21584 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
21586 "This program is free software; you can redistribute it and/or modify it "
21587 "under the terms of the GNU General Public License as published by the Free "
21588 "Software Foundation; either version 2 of the License, or (at your option) "
21589 "any later version."
21593 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:129
21594 #: ../fuse/guestmount.pod:292 ../tools/virt-edit.pl:523
21595 #: ../tools/virt-win-reg.pl:611 ../tools/virt-resize.pl:1523
21596 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
21597 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
21599 "This program is distributed in the hope that it will be useful, but WITHOUT "
21600 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21601 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21606 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:134
21607 #: ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:528
21608 #: ../tools/virt-win-reg.pl:616 ../tools/virt-resize.pl:1528
21609 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
21610 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
21612 "You should have received a copy of the GNU General Public License along with "
21613 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21614 "Ave, Cambridge, MA 02139, USA."
21618 #: ../fish/guestfish-actions.pod:1
21623 #: ../fish/guestfish-actions.pod:3
21626 " add-cdrom filename\n"
21631 #: ../fish/guestfish-actions.pod:15
21633 "This call checks for the existence of C<filename>. This stops you from "
21634 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21635 "and C<http:> URLs. To specify those, use the general L</config> call "
21640 #: ../fish/guestfish-actions.pod:22
21642 "If you just want to add an ISO file (often you use this as an efficient way "
21643 "to transfer large files into the guest), then you should probably use L</add-"
21644 "drive-ro> instead."
21648 #: ../fish/guestfish-actions.pod:35
21653 #: ../fish/guestfish-actions.pod:37
21658 #: ../fish/guestfish-actions.pod:39
21661 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
21666 #: ../fish/guestfish-actions.pod:41
21668 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21669 "It works by connecting to libvirt, requesting the domain and domain XML from "
21670 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21674 #: ../fish/guestfish-actions.pod:71
21676 "The other optional parameters are passed directly through to L</add-drive-"
21681 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
21682 #: ../fish/guestfish-actions.pod:3039
21684 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
21688 #: ../fish/guestfish-actions.pod:76
21693 #: ../fish/guestfish-actions.pod:78
21696 " add-drive filename\n"
21701 #: ../fish/guestfish-actions.pod:80
21703 "This function is the equivalent of calling L</add-drive-opts> with no "
21704 "optional parameters, so the disk is added writable, with the format being "
21705 "detected automatically."
21709 #: ../fish/guestfish-actions.pod:84
21711 "Automatic detection of the format opens you up to a potential security hole "
21712 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21713 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21714 "you should think about replacing calls to this function with calls to L</add-"
21715 "drive-opts>, and specifying the format."
21719 #: ../fish/guestfish-actions.pod:91
21720 msgid "add-drive-opts"
21724 #: ../fish/guestfish-actions.pod:93
21729 #: ../fish/guestfish-actions.pod:95
21732 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
21737 #: ../fish/guestfish-actions.pod:122
21739 "This forces the image format. If you omit this (or use L</add-drive> or L</"
21740 "add-drive-ro>) then the format is automatically detected. Possible formats "
21741 "include C<raw> and C<qcow2>."
21745 #: ../fish/guestfish-actions.pod:133
21747 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
21748 "add-drive-with-if> call (q.v.)"
21752 #: ../fish/guestfish-actions.pod:140
21753 msgid "add-drive-ro"
21757 #: ../fish/guestfish-actions.pod:142
21762 #: ../fish/guestfish-actions.pod:144
21765 " add-drive-ro filename\n"
21770 #: ../fish/guestfish-actions.pod:146
21772 "This function is the equivalent of calling L</add-drive-opts> with the "
21773 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
21774 "is added read-only, with the format being detected automatically."
21778 #: ../fish/guestfish-actions.pod:151
21779 msgid "add-drive-ro-with-if"
21783 #: ../fish/guestfish-actions.pod:153
21786 " add-drive-ro-with-if filename iface\n"
21791 #: ../fish/guestfish-actions.pod:155
21793 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
21794 "interface emulation to use at run time."
21798 #: ../fish/guestfish-actions.pod:165
21799 msgid "add-drive-with-if"
21803 #: ../fish/guestfish-actions.pod:167
21806 " add-drive-with-if filename iface\n"
21811 #: ../fish/guestfish-actions.pod:169
21813 "This is the same as L</add-drive> but it allows you to specify the QEMU "
21814 "interface emulation to use at run time."
21818 #: ../fish/guestfish-actions.pod:179
21823 #: ../fish/guestfish-actions.pod:181
21826 " aug-clear augpath\n"
21831 #: ../fish/guestfish-actions.pod:186
21836 #: ../fish/guestfish-actions.pod:188
21844 #: ../fish/guestfish-actions.pod:190
21846 "Close the current Augeas handle and free up any resources used by it. After "
21847 "calling this, you have to call L</aug-init> again before you can use any "
21848 "other Augeas functions."
21852 #: ../fish/guestfish-actions.pod:195
21853 msgid "aug-defnode"
21857 #: ../fish/guestfish-actions.pod:197
21860 " aug-defnode name expr val\n"
21865 #: ../fish/guestfish-actions.pod:202
21867 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21868 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
21869 "containing that single node."
21873 #: ../fish/guestfish-actions.pod:210
21878 #: ../fish/guestfish-actions.pod:212
21881 " aug-defvar name expr\n"
21886 #: ../fish/guestfish-actions.pod:221
21891 #: ../fish/guestfish-actions.pod:223
21894 " aug-get augpath\n"
21899 #: ../fish/guestfish-actions.pod:228
21904 #: ../fish/guestfish-actions.pod:230
21907 " aug-init root flags\n"
21912 #: ../fish/guestfish-actions.pod:236
21913 msgid "You must call this before using any other L</aug-*> commands."
21917 #: ../fish/guestfish-actions.pod:271
21918 msgid "Do not load the tree in L</aug-init>."
21922 #: ../fish/guestfish-actions.pod:275
21923 msgid "To close the handle, you can call L</aug-close>."
21927 #: ../fish/guestfish-actions.pod:279
21932 #: ../fish/guestfish-actions.pod:281
21935 " aug-insert augpath label true|false\n"
21940 #: ../fish/guestfish-actions.pod:291
21945 #: ../fish/guestfish-actions.pod:293
21953 #: ../fish/guestfish-actions.pod:300
21958 #: ../fish/guestfish-actions.pod:302
21961 " aug-ls augpath\n"
21966 #: ../fish/guestfish-actions.pod:304
21968 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
21969 "resulting nodes into alphabetical order."
21973 #: ../fish/guestfish-actions.pod:307
21978 #: ../fish/guestfish-actions.pod:309
21981 " aug-match augpath\n"
21986 #: ../fish/guestfish-actions.pod:315
21991 #: ../fish/guestfish-actions.pod:317
21994 " aug-mv src dest\n"
21999 #: ../fish/guestfish-actions.pod:322
22004 #: ../fish/guestfish-actions.pod:324
22007 " aug-rm augpath\n"
22012 #: ../fish/guestfish-actions.pod:330
22017 #: ../fish/guestfish-actions.pod:332
22025 #: ../fish/guestfish-actions.pod:336
22027 "The flags which were passed to L</aug-init> affect exactly how files are "
22032 #: ../fish/guestfish-actions.pod:339
22037 #: ../fish/guestfish-actions.pod:341
22040 " aug-set augpath val\n"
22045 #: ../fish/guestfish-actions.pod:345
22047 "In the Augeas API, it is possible to clear a node by setting the value to "
22048 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22049 "this call. Instead you must use the L</aug-clear> call."
22053 #: ../fish/guestfish-actions.pod:350
22058 #: ../fish/guestfish-actions.pod:352
22061 " available 'groups ...'\n"
22066 #: ../fish/guestfish-actions.pod:358
22068 "The libguestfs groups, and the functions that those groups correspond to, "
22069 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22070 "runtime by calling L</available-all-groups>."
22074 #: ../fish/guestfish-actions.pod:382
22075 msgid "You must call L</launch> before calling this function."
22079 #: ../fish/guestfish-actions.pod:404
22081 "This call was added in version C<1.0.80>. In previous versions of "
22082 "libguestfs all you could do would be to speculatively execute a command to "
22083 "find out if the daemon implemented it. See also L</version>."
22087 #: ../fish/guestfish-actions.pod:411
22088 msgid "available-all-groups"
22092 #: ../fish/guestfish-actions.pod:413
22095 " available-all-groups\n"
22100 #: ../fish/guestfish-actions.pod:415
22102 "This command returns a list of all optional groups that this daemon knows "
22103 "about. Note this returns both supported and unsupported groups. To find "
22104 "out which ones the daemon can actually support you have to call L</"
22105 "available> on each member of the returned list."
22109 #: ../fish/guestfish-actions.pod:421
22110 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
22114 #: ../fish/guestfish-actions.pod:423
22119 #: ../fish/guestfish-actions.pod:425
22122 " base64-in (base64file|-) filename\n"
22127 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439
22128 #: ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832
22129 #: ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1228
22130 #: ../fish/guestfish-actions.pod:4437 ../fish/guestfish-actions.pod:4449
22131 #: ../fish/guestfish-actions.pod:4460 ../fish/guestfish-actions.pod:4471
22132 #: ../fish/guestfish-actions.pod:4523 ../fish/guestfish-actions.pod:4532
22133 #: ../fish/guestfish-actions.pod:4586 ../fish/guestfish-actions.pod:4609
22134 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
22138 #: ../fish/guestfish-actions.pod:432
22143 #: ../fish/guestfish-actions.pod:434
22146 " base64-out filename (base64file|-)\n"
22151 #: ../fish/guestfish-actions.pod:441
22152 msgid "blockdev-flushbufs"
22156 #: ../fish/guestfish-actions.pod:443
22159 " blockdev-flushbufs device\n"
22164 #: ../fish/guestfish-actions.pod:450
22165 msgid "blockdev-getbsz"
22169 #: ../fish/guestfish-actions.pod:452
22172 " blockdev-getbsz device\n"
22177 #: ../fish/guestfish-actions.pod:461
22178 msgid "blockdev-getro"
22182 #: ../fish/guestfish-actions.pod:463
22185 " blockdev-getro device\n"
22190 #: ../fish/guestfish-actions.pod:470
22191 msgid "blockdev-getsize64"
22195 #: ../fish/guestfish-actions.pod:472
22198 " blockdev-getsize64 device\n"
22203 #: ../fish/guestfish-actions.pod:476
22204 msgid "See also L</blockdev-getsz>."
22208 #: ../fish/guestfish-actions.pod:480
22209 msgid "blockdev-getss"
22213 #: ../fish/guestfish-actions.pod:482
22216 " blockdev-getss device\n"
22221 #: ../fish/guestfish-actions.pod:487
22223 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
22227 #: ../fish/guestfish-actions.pod:492
22228 msgid "blockdev-getsz"
22232 #: ../fish/guestfish-actions.pod:494
22235 " blockdev-getsz device\n"
22240 #: ../fish/guestfish-actions.pod:499
22242 "See also L</blockdev-getss> for the real sector size of the device, and L</"
22243 "blockdev-getsize64> for the more useful I<size in bytes>."
22247 #: ../fish/guestfish-actions.pod:505
22248 msgid "blockdev-rereadpt"
22252 #: ../fish/guestfish-actions.pod:507
22255 " blockdev-rereadpt device\n"
22260 #: ../fish/guestfish-actions.pod:513
22261 msgid "blockdev-setbsz"
22265 #: ../fish/guestfish-actions.pod:515
22268 " blockdev-setbsz device blocksize\n"
22273 #: ../fish/guestfish-actions.pod:524
22274 msgid "blockdev-setro"
22278 #: ../fish/guestfish-actions.pod:526
22281 " blockdev-setro device\n"
22286 #: ../fish/guestfish-actions.pod:532
22287 msgid "blockdev-setrw"
22291 #: ../fish/guestfish-actions.pod:534
22294 " blockdev-setrw device\n"
22299 #: ../fish/guestfish-actions.pod:540
22300 msgid "case-sensitive-path"
22304 #: ../fish/guestfish-actions.pod:542
22307 " case-sensitive-path path\n"
22312 #: ../fish/guestfish-actions.pod:566
22314 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
22315 "WINDOWS/system32\"> (the exact return value would depend on details of how "
22316 "the directories were originally created under Windows)."
22320 #: ../fish/guestfish-actions.pod:574
22321 msgid "See also L</realpath>."
22325 #: ../fish/guestfish-actions.pod:576
22330 #: ../fish/guestfish-actions.pod:578
22338 #: ../fish/guestfish-actions.pod:582
22340 "Note that this function cannot correctly handle binary files (specifically, "
22341 "files containing C<\\0> character which is treated as end of string). For "
22342 "those you need to use the L</read-file> or L</download> functions which have "
22343 "a more complex interface."
22347 #: ../fish/guestfish-actions.pod:590
22352 #: ../fish/guestfish-actions.pod:592
22355 " checksum csumtype path\n"
22360 #: ../fish/guestfish-actions.pod:635
22361 msgid "To get the checksum for a device, use L</checksum-device>."
22365 #: ../fish/guestfish-actions.pod:637
22366 msgid "To get the checksums for many files, use L</checksums-out>."
22370 #: ../fish/guestfish-actions.pod:639
22371 msgid "checksum-device"
22375 #: ../fish/guestfish-actions.pod:641
22378 " checksum-device csumtype device\n"
22383 #: ../fish/guestfish-actions.pod:643
22385 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22386 "device named C<device>. For the types of checksums supported see the L</"
22387 "checksum> command."
22391 #: ../fish/guestfish-actions.pod:647
22392 msgid "checksums-out"
22396 #: ../fish/guestfish-actions.pod:649
22399 " checksums-out csumtype directory (sumsfile|-)\n"
22404 #: ../fish/guestfish-actions.pod:665
22409 #: ../fish/guestfish-actions.pod:667
22412 " chmod mode path\n"
22417 #: ../fish/guestfish-actions.pod:678
22422 #: ../fish/guestfish-actions.pod:680
22425 " chown owner group path\n"
22430 #: ../fish/guestfish-actions.pod:688
22435 #: ../fish/guestfish-actions.pod:690
22438 " command 'arguments ...'\n"
22443 #: ../fish/guestfish-actions.pod:697
22445 "The single parameter is an argv-style list of arguments. The first element "
22446 "is the name of the program to run. Subsequent elements are parameters. The "
22447 "list must be non-empty (ie. must contain a program name). Note that the "
22448 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22452 #: ../fish/guestfish-actions.pod:725
22453 msgid "command-lines"
22457 #: ../fish/guestfish-actions.pod:727
22460 " command-lines 'arguments ...'\n"
22465 #: ../fish/guestfish-actions.pod:729
22467 "This is the same as L</command>, but splits the result into a list of lines."
22471 #: ../fish/guestfish-actions.pod:732
22472 msgid "See also: L</sh-lines>"
22476 #: ../fish/guestfish-actions.pod:737
22481 #: ../fish/guestfish-actions.pod:739
22484 " config qemuparam qemuvalue\n"
22489 #: ../fish/guestfish-actions.pod:750
22494 #: ../fish/guestfish-actions.pod:752
22497 " copy-size src dest size\n"
22502 #: ../fish/guestfish-actions.pod:760
22507 #: ../fish/guestfish-actions.pod:762
22515 #: ../fish/guestfish-actions.pod:767
22520 #: ../fish/guestfish-actions.pod:769
22528 #: ../fish/guestfish-actions.pod:774
22533 #: ../fish/guestfish-actions.pod:776
22541 #: ../fish/guestfish-actions.pod:783
22543 "If the destination is a device, it must be as large or larger than the "
22544 "source file or device, otherwise the copy will fail. This command cannot do "
22545 "partial copies (see L</copy-size>)."
22549 #: ../fish/guestfish-actions.pod:787
22554 #: ../fish/guestfish-actions.pod:789
22562 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
22564 "This command is mostly useful for interactive sessions. It is I<not> "
22565 "intended that you try to parse the output string. Use L</statvfs> from "
22570 #: ../fish/guestfish-actions.pod:797
22575 #: ../fish/guestfish-actions.pod:799
22583 #: ../fish/guestfish-actions.pod:808
22588 #: ../fish/guestfish-actions.pod:810
22596 #: ../fish/guestfish-actions.pod:816
22598 "Another way to get the same information is to enable verbose messages with "
22599 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22600 "before running the program."
22604 #: ../fish/guestfish-actions.pod:821
22609 #: ../fish/guestfish-actions.pod:823
22612 " download remotefilename (filename|-)\n"
22617 #: ../fish/guestfish-actions.pod:830
22618 msgid "See also L</upload>, L</cat>."
22622 #: ../fish/guestfish-actions.pod:834
22623 msgid "download-offset"
22627 #: ../fish/guestfish-actions.pod:836
22630 " download-offset remotefilename (filename|-) offset size\n"
22635 #: ../fish/guestfish-actions.pod:844
22637 "Note that there is no limit on the amount of data that can be downloaded "
22638 "with this call, unlike with L</pread>, and this call always reads the full "
22639 "amount unless an error occurs."
22643 #: ../fish/guestfish-actions.pod:849
22644 msgid "See also L</download>, L</pread>."
22648 #: ../fish/guestfish-actions.pod:853
22649 msgid "drop-caches"
22653 #: ../fish/guestfish-actions.pod:855
22656 " drop-caches whattodrop\n"
22661 #: ../fish/guestfish-actions.pod:867
22666 #: ../fish/guestfish-actions.pod:869
22674 #: ../fish/guestfish-actions.pod:881
22679 #: ../fish/guestfish-actions.pod:883
22682 " e2fsck-f device\n"
22687 #: ../fish/guestfish-actions.pod:889
22689 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
22690 "should use L</fsck>."
22694 #: ../fish/guestfish-actions.pod:892
22695 msgid "echo-daemon"
22699 #: ../fish/guestfish-actions.pod:894
22702 " echo-daemon 'words ...'\n"
22707 #: ../fish/guestfish-actions.pod:901
22708 msgid "See also L</ping-daemon>."
22712 #: ../fish/guestfish-actions.pod:903
22717 #: ../fish/guestfish-actions.pod:905
22720 " egrep regex path\n"
22725 #: ../fish/guestfish-actions.pod:913
22730 #: ../fish/guestfish-actions.pod:915
22733 " egrepi regex path\n"
22738 #: ../fish/guestfish-actions.pod:923
22743 #: ../fish/guestfish-actions.pod:925
22746 " equal file1 file2\n"
22751 #: ../fish/guestfish-actions.pod:932
22756 #: ../fish/guestfish-actions.pod:934
22764 #: ../fish/guestfish-actions.pod:939
22765 msgid "See also L</is-file>, L</is-dir>, L</stat>."
22769 #: ../fish/guestfish-actions.pod:941
22774 #: ../fish/guestfish-actions.pod:943
22777 " fallocate path len\n"
22782 #: ../fish/guestfish-actions.pod:960
22783 msgid "fallocate64"
22787 #: ../fish/guestfish-actions.pod:962
22790 " fallocate64 path len\n"
22795 #: ../fish/guestfish-actions.pod:968
22797 "Note that this call allocates disk blocks for the file. To create a sparse "
22798 "file use L</truncate-size> instead."
22802 #: ../fish/guestfish-actions.pod:971
22804 "The deprecated call L</fallocate> does the same, but owing to an oversight "
22805 "it only allowed 30 bit lengths to be specified, effectively limiting the "
22806 "maximum size of files created through that call to 1GB."
22810 #: ../fish/guestfish-actions.pod:980
22815 #: ../fish/guestfish-actions.pod:982
22818 " fgrep pattern path\n"
22823 #: ../fish/guestfish-actions.pod:990
22828 #: ../fish/guestfish-actions.pod:992
22831 " fgrepi pattern path\n"
22836 #: ../fish/guestfish-actions.pod:1000
22841 #: ../fish/guestfish-actions.pod:1002
22849 #: ../fish/guestfish-actions.pod:1014
22851 "This command can also be used on C</dev/> devices (and partitions, LV "
22852 "names). You can for example use this to determine if a device contains a "
22853 "filesystem, although it's usually better to use L</vfs-type>."
22857 #: ../fish/guestfish-actions.pod:1024
22858 msgid "file-architecture"
22862 #: ../fish/guestfish-actions.pod:1026
22865 " file-architecture filename\n"
22870 #: ../fish/guestfish-actions.pod:1129
22875 #: ../fish/guestfish-actions.pod:1131
22883 #: ../fish/guestfish-actions.pod:1135
22885 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
22886 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
22890 #: ../fish/guestfish-actions.pod:1139
22895 #: ../fish/guestfish-actions.pod:1141
22898 " fill c len path\n"
22903 #: ../fish/guestfish-actions.pod:1147
22905 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
22906 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
22907 "L</fill-pattern>."
22911 #: ../fish/guestfish-actions.pod:1152
22912 msgid "fill-pattern"
22916 #: ../fish/guestfish-actions.pod:1154
22919 " fill-pattern pattern len path\n"
22924 #: ../fish/guestfish-actions.pod:1156
22926 "This function is like L</fill> except that it creates a new file of length "
22927 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
22928 "is truncated if necessary to ensure the length of the file is exactly C<len> "
22933 #: ../fish/guestfish-actions.pod:1161
22938 #: ../fish/guestfish-actions.pod:1163
22941 " find directory\n"
22946 #: ../fish/guestfish-actions.pod:1177
22947 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
22951 #: ../fish/guestfish-actions.pod:1190
22952 msgid "See also L</find0>."
22956 #: ../fish/guestfish-actions.pod:1195
22961 #: ../fish/guestfish-actions.pod:1197
22964 " find0 directory (files|-)\n"
22969 #: ../fish/guestfish-actions.pod:1203
22971 "This command works the same way as L</find> with the following exceptions:"
22975 #: ../fish/guestfish-actions.pod:1230
22976 msgid "findfs-label"
22980 #: ../fish/guestfish-actions.pod:1232
22983 " findfs-label label\n"
22988 #: ../fish/guestfish-actions.pod:1238
22989 msgid "To find the label of a filesystem, use L</vfs-label>."
22993 #: ../fish/guestfish-actions.pod:1240
22994 msgid "findfs-uuid"
22998 #: ../fish/guestfish-actions.pod:1242
23001 " findfs-uuid uuid\n"
23006 #: ../fish/guestfish-actions.pod:1248
23007 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
23011 #: ../fish/guestfish-actions.pod:1250
23016 #: ../fish/guestfish-actions.pod:1252
23019 " fsck fstype device\n"
23024 #: ../fish/guestfish-actions.pod:1282
23029 #: ../fish/guestfish-actions.pod:1284
23037 #: ../fish/guestfish-actions.pod:1291
23038 msgid "get-attach-method"
23042 #: ../fish/guestfish-actions.pod:1293
23045 " get-attach-method\n"
23050 #: ../fish/guestfish-actions.pod:1295
23051 msgid "Return the current attach method. See L</set-attach-method>."
23055 #: ../fish/guestfish-actions.pod:1297
23056 msgid "get-autosync"
23060 #: ../fish/guestfish-actions.pod:1299
23068 #: ../fish/guestfish-actions.pod:1303
23073 #: ../fish/guestfish-actions.pod:1305
23081 #: ../fish/guestfish-actions.pod:1309
23082 msgid "get-e2label"
23086 #: ../fish/guestfish-actions.pod:1311
23089 " get-e2label device\n"
23094 #: ../fish/guestfish-actions.pod:1323
23099 #: ../fish/guestfish-actions.pod:1325
23102 " get-e2uuid device\n"
23107 #: ../fish/guestfish-actions.pod:1337
23108 msgid "get-memsize"
23112 #: ../fish/guestfish-actions.pod:1339
23120 #: ../fish/guestfish-actions.pod:1344
23122 "If L</set-memsize> was not called on this handle, and if "
23123 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23124 "value for memsize."
23128 #: ../fish/guestfish-actions.pod:1351
23129 msgid "get-network"
23133 #: ../fish/guestfish-actions.pod:1353
23141 #: ../fish/guestfish-actions.pod:1357
23146 #: ../fish/guestfish-actions.pod:1359
23154 #: ../fish/guestfish-actions.pod:1366
23159 #: ../fish/guestfish-actions.pod:1368
23164 #: ../fish/guestfish-actions.pod:1370
23172 #: ../fish/guestfish-actions.pod:1377
23177 #: ../fish/guestfish-actions.pod:1379
23185 #: ../fish/guestfish-actions.pod:1386
23186 msgid "get-recovery-proc"
23190 #: ../fish/guestfish-actions.pod:1388
23193 " get-recovery-proc\n"
23198 #: ../fish/guestfish-actions.pod:1392
23199 msgid "get-selinux"
23203 #: ../fish/guestfish-actions.pod:1394
23211 #: ../fish/guestfish-actions.pod:1396
23213 "This returns the current setting of the selinux flag which is passed to the "
23214 "appliance at boot time. See L</set-selinux>."
23218 #: ../fish/guestfish-actions.pod:1402
23223 #: ../fish/guestfish-actions.pod:1404
23231 #: ../fish/guestfish-actions.pod:1411
23236 #: ../fish/guestfish-actions.pod:1413
23244 #: ../fish/guestfish-actions.pod:1417
23249 #: ../fish/guestfish-actions.pod:1419
23257 #: ../fish/guestfish-actions.pod:1421
23259 "Return the current umask. By default the umask is C<022> unless it has been "
23260 "set by calling L</umask>."
23264 #: ../fish/guestfish-actions.pod:1424
23265 msgid "get-verbose"
23269 #: ../fish/guestfish-actions.pod:1426
23277 #: ../fish/guestfish-actions.pod:1430
23282 #: ../fish/guestfish-actions.pod:1432
23290 #: ../fish/guestfish-actions.pod:1436
23291 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
23295 #: ../fish/guestfish-actions.pod:1439
23300 #: ../fish/guestfish-actions.pod:1441
23303 " getxattr path name\n"
23308 #: ../fish/guestfish-actions.pod:1443
23310 "Get a single extended attribute from file C<path> named C<name>. This call "
23311 "follows symlinks. If you want to lookup an extended attribute for the "
23312 "symlink itself, use L</lgetxattr>."
23316 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2445
23318 "Normally it is better to get all extended attributes from a file in one go "
23319 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23320 "buggy and do not provide a way to list out attributes. For these "
23321 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23322 "attributes you want in advance and call this function."
23326 #: ../fish/guestfish-actions.pod:1457
23327 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23331 #: ../fish/guestfish-actions.pod:1459
23336 #: ../fish/guestfish-actions.pod:1461
23339 " getxattrs path\n"
23344 #: ../fish/guestfish-actions.pod:1469
23345 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23349 #: ../fish/guestfish-actions.pod:1471
23350 msgid "glob-expand"
23354 #: ../fish/guestfish-actions.pod:1473
23357 " glob-expand pattern\n"
23362 #: ../fish/guestfish-actions.pod:1486
23367 #: ../fish/guestfish-actions.pod:1488
23370 " grep regex path\n"
23375 #: ../fish/guestfish-actions.pod:1496
23380 #: ../fish/guestfish-actions.pod:1498
23383 " grepi regex path\n"
23388 #: ../fish/guestfish-actions.pod:1506
23389 msgid "grub-install"
23393 #: ../fish/guestfish-actions.pod:1508
23396 " grub-install root device\n"
23401 #: ../fish/guestfish-actions.pod:1524
23406 #: ../fish/guestfish-actions.pod:1526
23414 #: ../fish/guestfish-actions.pod:1534
23419 #: ../fish/guestfish-actions.pod:1536
23422 " head-n nrlines path\n"
23427 #: ../fish/guestfish-actions.pod:1549
23432 #: ../fish/guestfish-actions.pod:1551
23440 #: ../fish/guestfish-actions.pod:1559
23445 #: ../fish/guestfish-actions.pod:1561
23448 " initrd-cat initrdpath filename\n"
23453 #: ../fish/guestfish-actions.pod:1573
23454 msgid "See also L</initrd-list>."
23458 #: ../fish/guestfish-actions.pod:1578
23459 msgid "initrd-list"
23463 #: ../fish/guestfish-actions.pod:1580
23466 " initrd-list path\n"
23471 #: ../fish/guestfish-actions.pod:1592
23472 msgid "inotify-add-watch"
23476 #: ../fish/guestfish-actions.pod:1594
23479 " inotify-add-watch path mask\n"
23484 #: ../fish/guestfish-actions.pod:1606
23485 msgid "inotify-close"
23489 #: ../fish/guestfish-actions.pod:1608
23497 #: ../fish/guestfish-actions.pod:1614
23498 msgid "inotify-files"
23502 #: ../fish/guestfish-actions.pod:1616
23510 #: ../fish/guestfish-actions.pod:1618
23512 "This function is a helpful wrapper around L</inotify-read> which just "
23513 "returns a list of pathnames of objects that were touched. The returned "
23514 "pathnames are sorted and deduplicated."
23518 #: ../fish/guestfish-actions.pod:1622
23519 msgid "inotify-init"
23523 #: ../fish/guestfish-actions.pod:1624
23526 " inotify-init maxevents\n"
23531 #: ../fish/guestfish-actions.pod:1630
23533 "C<maxevents> is the maximum number of events which will be queued up between "
23534 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23535 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23536 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23537 "but records the fact that it threw them away by setting a flag "
23538 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23542 #: ../fish/guestfish-actions.pod:1640
23544 "Before any events are generated, you have to add some watches to the "
23545 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23546 "L</inotify-watch-all>."
23550 #: ../fish/guestfish-actions.pod:1646
23552 "Queued up events should be read periodically by calling L</inotify-read> (or "
23553 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23554 "If you don't read the events out often enough then you risk the internal "
23555 "queue overflowing."
23559 #: ../fish/guestfish-actions.pod:1653
23561 "The handle should be closed after use by calling L</inotify-close>. This "
23562 "also removes any watches automatically."
23566 #: ../fish/guestfish-actions.pod:1662
23567 msgid "inotify-read"
23571 #: ../fish/guestfish-actions.pod:1664
23579 #: ../fish/guestfish-actions.pod:1677
23580 msgid "inotify-rm-watch"
23584 #: ../fish/guestfish-actions.pod:1679
23587 " inotify-rm-watch wd\n"
23592 #: ../fish/guestfish-actions.pod:1681
23593 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23597 #: ../fish/guestfish-actions.pod:1684
23598 msgid "inspect-get-arch"
23602 #: ../fish/guestfish-actions.pod:1686
23605 " inspect-get-arch root\n"
23610 #: ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1704
23611 #: ../fish/guestfish-actions.pod:1782 ../fish/guestfish-actions.pod:1818
23612 #: ../fish/guestfish-actions.pod:1836 ../fish/guestfish-actions.pod:1870
23613 #: ../fish/guestfish-actions.pod:1885 ../fish/guestfish-actions.pod:1906
23614 #: ../fish/guestfish-actions.pod:1921 ../fish/guestfish-actions.pod:1954
23615 #: ../fish/guestfish-actions.pod:1976 ../fish/guestfish-actions.pod:2000
23616 #: ../fish/guestfish-actions.pod:2017 ../fish/guestfish-actions.pod:2060
23617 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2111
23618 #: ../fish/guestfish-actions.pod:2127 ../fish/guestfish-actions.pod:2140
23619 #: ../fish/guestfish-actions.pod:2153 ../fish/guestfish-actions.pod:2168
23621 "This function should only be called with a root device string as returned by "
23626 #: ../fish/guestfish-actions.pod:1691
23628 "This returns the architecture of the inspected operating system. The "
23629 "possible return values are listed under L</file-architecture>."
23633 #: ../fish/guestfish-actions.pod:1700
23634 msgid "inspect-get-distro"
23638 #: ../fish/guestfish-actions.pod:1702
23641 " inspect-get-distro root\n"
23646 #: ../fish/guestfish-actions.pod:1778
23647 msgid "inspect-get-drive-mappings"
23651 #: ../fish/guestfish-actions.pod:1780
23654 " inspect-get-drive-mappings root\n"
23659 #: ../fish/guestfish-actions.pod:1810
23661 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23662 "get-mountpoints>, L</inspect-get-filesystems>."
23666 #: ../fish/guestfish-actions.pod:1814
23667 msgid "inspect-get-filesystems"
23671 #: ../fish/guestfish-actions.pod:1816
23674 " inspect-get-filesystems root\n"
23679 #: ../fish/guestfish-actions.pod:1829
23681 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23682 "get-mountpoints>."
23686 #: ../fish/guestfish-actions.pod:1832
23687 msgid "inspect-get-format"
23691 #: ../fish/guestfish-actions.pod:1834
23694 " inspect-get-format root\n"
23699 #: ../fish/guestfish-actions.pod:1866
23700 msgid "inspect-get-hostname"
23704 #: ../fish/guestfish-actions.pod:1868
23707 " inspect-get-hostname root\n"
23712 #: ../fish/guestfish-actions.pod:1881
23713 msgid "inspect-get-major-version"
23717 #: ../fish/guestfish-actions.pod:1883
23720 " inspect-get-major-version root\n"
23725 #: ../fish/guestfish-actions.pod:1902
23726 msgid "inspect-get-minor-version"
23730 #: ../fish/guestfish-actions.pod:1904
23733 " inspect-get-minor-version root\n"
23738 #: ../fish/guestfish-actions.pod:1914
23740 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23741 "get-major-version>."
23745 #: ../fish/guestfish-actions.pod:1917
23746 msgid "inspect-get-mountpoints"
23750 #: ../fish/guestfish-actions.pod:1919
23753 " inspect-get-mountpoints root\n"
23758 #: ../fish/guestfish-actions.pod:1941
23760 "For operating systems like Windows which still use drive letters, this call "
23761 "will only return an entry for the first drive \"mounted on\" C</>. For "
23762 "information about the mapping of drive letters to partitions, see L</inspect-"
23763 "get-drive-mappings>."
23767 #: ../fish/guestfish-actions.pod:1947
23769 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23770 "get-filesystems>."
23774 #: ../fish/guestfish-actions.pod:1950
23775 msgid "inspect-get-package-format"
23779 #: ../fish/guestfish-actions.pod:1952
23782 " inspect-get-package-format root\n"
23787 #: ../fish/guestfish-actions.pod:1957
23789 "This function and L</inspect-get-package-management> return the package "
23790 "format and package management tool used by the inspected operating system. "
23791 "For example for Fedora these functions would return C<rpm> (package format) "
23792 "and C<yum> (package management)."
23796 #: ../fish/guestfish-actions.pod:1972
23797 msgid "inspect-get-package-management"
23801 #: ../fish/guestfish-actions.pod:1974
23804 " inspect-get-package-management root\n"
23809 #: ../fish/guestfish-actions.pod:1979
23811 "L</inspect-get-package-format> and this function return the package format "
23812 "and package management tool used by the inspected operating system. For "
23813 "example for Fedora these functions would return C<rpm> (package format) and "
23814 "C<yum> (package management)."
23818 #: ../fish/guestfish-actions.pod:1996
23819 msgid "inspect-get-product-name"
23823 #: ../fish/guestfish-actions.pod:1998
23826 " inspect-get-product-name root\n"
23831 #: ../fish/guestfish-actions.pod:2013
23832 msgid "inspect-get-product-variant"
23836 #: ../fish/guestfish-actions.pod:2015
23839 " inspect-get-product-variant root\n"
23844 #: ../fish/guestfish-actions.pod:2039
23846 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23847 "get-product-name>, L</inspect-get-major-version>."
23851 #: ../fish/guestfish-actions.pod:2043
23852 msgid "inspect-get-roots"
23856 #: ../fish/guestfish-actions.pod:2045
23859 " inspect-get-roots\n"
23864 #: ../fish/guestfish-actions.pod:2047
23866 "This function is a convenient way to get the list of root devices, as "
23867 "returned from a previous call to L</inspect-os>, but without redoing the "
23868 "whole inspection process."
23872 #: ../fish/guestfish-actions.pod:2051
23874 "This returns an empty list if either no root devices were found or the "
23875 "caller has not called L</inspect-os>."
23879 #: ../fish/guestfish-actions.pod:2056
23880 msgid "inspect-get-type"
23884 #: ../fish/guestfish-actions.pod:2058
23887 " inspect-get-type root\n"
23892 #: ../fish/guestfish-actions.pod:2091
23893 msgid "inspect-get-windows-current-control-set"
23897 #: ../fish/guestfish-actions.pod:2093
23900 " inspect-get-windows-current-control-set root\n"
23905 #: ../fish/guestfish-actions.pod:2107
23906 msgid "inspect-get-windows-systemroot"
23910 #: ../fish/guestfish-actions.pod:2109
23913 " inspect-get-windows-systemroot root\n"
23918 #: ../fish/guestfish-actions.pod:2123
23919 msgid "inspect-is-live"
23923 #: ../fish/guestfish-actions.pod:2125
23926 " inspect-is-live root\n"
23931 #: ../fish/guestfish-actions.pod:2130
23933 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23934 "then this returns true if a live image was detected on the disk."
23938 #: ../fish/guestfish-actions.pod:2136
23939 msgid "inspect-is-multipart"
23943 #: ../fish/guestfish-actions.pod:2138
23946 " inspect-is-multipart root\n"
23951 #: ../fish/guestfish-actions.pod:2143
23953 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23954 "then this returns true if the disk is part of a set."
23958 #: ../fish/guestfish-actions.pod:2149
23959 msgid "inspect-is-netinst"
23963 #: ../fish/guestfish-actions.pod:2151
23966 " inspect-is-netinst root\n"
23971 #: ../fish/guestfish-actions.pod:2156
23973 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23974 "then this returns true if the disk is a network installer, ie. not a self-"
23975 "contained install CD but one which is likely to require network access to "
23976 "complete the install."
23980 #: ../fish/guestfish-actions.pod:2164
23981 msgid "inspect-list-applications"
23985 #: ../fish/guestfish-actions.pod:2166
23988 " inspect-list-applications root\n"
23993 #: ../fish/guestfish-actions.pod:2173
23995 "I<Note:> This call works differently from other parts of the inspection "
23996 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
23997 "then mount up the disks, before calling this. Listing applications is a "
23998 "significantly more difficult operation which requires access to the full "
23999 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
24000 "are just returning data cached in the libguestfs handle, this call actually "
24001 "reads parts of the mounted filesystems during the call."
24005 #: ../fish/guestfish-actions.pod:2263
24010 #: ../fish/guestfish-actions.pod:2265
24018 #: ../fish/guestfish-actions.pod:2280
24020 "You can pass the root string(s) returned to other L</inspect-get-*> "
24021 "functions in order to query further information about each operating system, "
24022 "such as the name and version."
24026 #: ../fish/guestfish-actions.pod:2285
24028 "This function uses other libguestfs features such as L</mount-ro> and L</"
24029 "umount-all> in order to mount and unmount filesystems and look at the "
24030 "contents. This should be called with no disks currently mounted. The "
24031 "function may also use Augeas, so any existing Augeas handle will be closed."
24035 #: ../fish/guestfish-actions.pod:2297 ../fish/guestfish-actions.pod:2473
24036 #: ../fish/guestfish-actions.pod:2519
24037 msgid "See also L</list-filesystems>."
24041 #: ../fish/guestfish-actions.pod:2299
24042 msgid "is-blockdev"
24046 #: ../fish/guestfish-actions.pod:2301
24049 " is-blockdev path\n"
24054 #: ../fish/guestfish-actions.pod:2306 ../fish/guestfish-actions.pod:2324
24055 #: ../fish/guestfish-actions.pod:2343 ../fish/guestfish-actions.pod:2352
24056 #: ../fish/guestfish-actions.pod:2362 ../fish/guestfish-actions.pod:2396
24057 #: ../fish/guestfish-actions.pod:2405
24058 msgid "See also L</stat>."
24062 #: ../fish/guestfish-actions.pod:2308
24067 #: ../fish/guestfish-actions.pod:2310
24075 #: ../fish/guestfish-actions.pod:2317
24080 #: ../fish/guestfish-actions.pod:2319
24083 " is-chardev path\n"
24088 #: ../fish/guestfish-actions.pod:2326
24093 #: ../fish/guestfish-actions.pod:2328
24101 #: ../fish/guestfish-actions.pod:2335
24106 #: ../fish/guestfish-actions.pod:2337
24114 #: ../fish/guestfish-actions.pod:2345
24119 #: ../fish/guestfish-actions.pod:2347
24127 #: ../fish/guestfish-actions.pod:2354
24132 #: ../fish/guestfish-actions.pod:2356
24140 #: ../fish/guestfish-actions.pod:2364
24141 msgid "is-launching"
24145 #: ../fish/guestfish-actions.pod:2366
24153 #: ../fish/guestfish-actions.pod:2373
24158 #: ../fish/guestfish-actions.pod:2375
24166 #: ../fish/guestfish-actions.pod:2380
24171 #: ../fish/guestfish-actions.pod:2382
24179 #: ../fish/guestfish-actions.pod:2389
24184 #: ../fish/guestfish-actions.pod:2391
24187 " is-socket path\n"
24192 #: ../fish/guestfish-actions.pod:2398
24197 #: ../fish/guestfish-actions.pod:2400
24200 " is-symlink path\n"
24205 #: ../fish/guestfish-actions.pod:2407
24206 msgid "kill-subprocess"
24210 #: ../fish/guestfish-actions.pod:2409
24213 " kill-subprocess\n"
24218 #: ../fish/guestfish-actions.pod:2413
24223 #: ../fish/guestfish-actions.pod:2415
24228 #: ../fish/guestfish-actions.pod:2417
24236 #: ../fish/guestfish-actions.pod:2425
24241 #: ../fish/guestfish-actions.pod:2427
24244 " lchown owner group path\n"
24249 #: ../fish/guestfish-actions.pod:2429
24251 "Change the file owner to C<owner> and group to C<group>. This is like L</"
24252 "chown> but if C<path> is a symlink then the link itself is changed, not the "
24257 #: ../fish/guestfish-actions.pod:2437
24262 #: ../fish/guestfish-actions.pod:2439
24265 " lgetxattr path name\n"
24270 #: ../fish/guestfish-actions.pod:2455
24271 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
24275 #: ../fish/guestfish-actions.pod:2457
24280 #: ../fish/guestfish-actions.pod:2459
24283 " lgetxattrs path\n"
24288 #: ../fish/guestfish-actions.pod:2461
24290 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24291 "it returns the extended attributes of the link itself."
24295 #: ../fish/guestfish-actions.pod:2465
24296 msgid "list-devices"
24300 #: ../fish/guestfish-actions.pod:2467
24308 #: ../fish/guestfish-actions.pod:2475
24309 msgid "list-filesystems"
24313 #: ../fish/guestfish-actions.pod:2477
24316 " list-filesystems\n"
24321 #: ../fish/guestfish-actions.pod:2496
24323 "This command runs other libguestfs commands, which might include L</mount> "
24324 "and L</umount>, and therefore you should use this soon after launch and only "
24325 "when nothing is mounted."
24329 #: ../fish/guestfish-actions.pod:2500
24331 "Not all of the filesystems returned will be mountable. In particular, swap "
24332 "partitions are returned in the list. Also this command does not check that "
24333 "each filesystem found is valid and mountable, and some filesystems might be "
24334 "mountable but require special options. Filesystems may not all belong to a "
24335 "single logical operating system (use L</inspect-os> to look for OSes)."
24339 #: ../fish/guestfish-actions.pod:2508
24340 msgid "list-partitions"
24344 #: ../fish/guestfish-actions.pod:2510
24347 " list-partitions\n"
24352 #: ../fish/guestfish-actions.pod:2516
24354 "This does not return logical volumes. For that you will need to call L</"
24359 #: ../fish/guestfish-actions.pod:2521
24364 #: ../fish/guestfish-actions.pod:2523
24372 #: ../fish/guestfish-actions.pod:2531
24377 #: ../fish/guestfish-actions.pod:2533
24380 " ln target linkname\n"
24385 #: ../fish/guestfish-actions.pod:2537
24390 #: ../fish/guestfish-actions.pod:2539
24393 " ln-f target linkname\n"
24398 #: ../fish/guestfish-actions.pod:2544
24403 #: ../fish/guestfish-actions.pod:2546
24406 " ln-s target linkname\n"
24411 #: ../fish/guestfish-actions.pod:2550
24416 #: ../fish/guestfish-actions.pod:2552
24419 " ln-sf target linkname\n"
24424 #: ../fish/guestfish-actions.pod:2557
24425 msgid "lremovexattr"
24429 #: ../fish/guestfish-actions.pod:2559
24432 " lremovexattr xattr path\n"
24437 #: ../fish/guestfish-actions.pod:2561
24439 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24440 "it removes an extended attribute of the link itself."
24444 #: ../fish/guestfish-actions.pod:2565
24449 #: ../fish/guestfish-actions.pod:2567
24457 #: ../fish/guestfish-actions.pod:2573
24459 "This command is mostly useful for interactive sessions. Programs should "
24460 "probably use L</readdir> instead."
24464 #: ../fish/guestfish-actions.pod:2576
24469 #: ../fish/guestfish-actions.pod:2578
24472 " lsetxattr xattr val vallen path\n"
24477 #: ../fish/guestfish-actions.pod:2580
24479 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24480 "sets an extended attribute of the link itself."
24484 #: ../fish/guestfish-actions.pod:2584
24489 #: ../fish/guestfish-actions.pod:2586
24497 #: ../fish/guestfish-actions.pod:2590
24499 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24500 "the link is stat-ed, not the file it refers to."
24504 #: ../fish/guestfish-actions.pod:2596
24509 #: ../fish/guestfish-actions.pod:2598
24512 " lstatlist path 'names ...'\n"
24517 #: ../fish/guestfish-actions.pod:2600
24519 "This call allows you to perform the L</lstat> operation on multiple files, "
24520 "where all files are in the directory C<path>. C<names> is the list of files "
24521 "from this directory."
24525 #: ../fish/guestfish-actions.pod:2609
24527 "This call is intended for programs that want to efficiently list a directory "
24528 "contents without making many round-trips. See also L</lxattrlist> for a "
24529 "similarly efficient call for getting extended attributes. Very long "
24530 "directory listings might cause the protocol message size to be exceeded, "
24531 "causing this call to fail. The caller must split up such requests into "
24532 "smaller groups of names."
24536 #: ../fish/guestfish-actions.pod:2617
24537 msgid "luks-add-key"
24541 #: ../fish/guestfish-actions.pod:2619
24544 " luks-add-key device keyslot\n"
24549 #: ../fish/guestfish-actions.pod:2626
24551 "Note that if C<keyslot> already contains a key, then this command will "
24552 "fail. You have to use L</luks-kill-slot> first to remove that key."
24556 #: ../fish/guestfish-actions.pod:2630 ../fish/guestfish-actions.pod:2652
24557 #: ../fish/guestfish-actions.pod:2665 ../fish/guestfish-actions.pod:2679
24558 #: ../fish/guestfish-actions.pod:2702 ../fish/guestfish-actions.pod:2712
24560 "This command has one or more key or passphrase parameters. Guestfish will "
24561 "prompt for these separately."
24565 #: ../fish/guestfish-actions.pod:2633
24570 #: ../fish/guestfish-actions.pod:2635
24573 " luks-close device\n"
24578 #: ../fish/guestfish-actions.pod:2637
24580 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
24581 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
24582 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
24587 #: ../fish/guestfish-actions.pod:2643
24588 msgid "luks-format"
24592 #: ../fish/guestfish-actions.pod:2645
24595 " luks-format device keyslot\n"
24600 #: ../fish/guestfish-actions.pod:2658
24601 msgid "luks-format-cipher"
24605 #: ../fish/guestfish-actions.pod:2660
24608 " luks-format-cipher device keyslot cipher\n"
24613 #: ../fish/guestfish-actions.pod:2662
24615 "This command is the same as L</luks-format> but it also allows you to set "
24616 "the C<cipher> used."
24620 #: ../fish/guestfish-actions.pod:2671
24621 msgid "luks-kill-slot"
24625 #: ../fish/guestfish-actions.pod:2673
24628 " luks-kill-slot device keyslot\n"
24633 #: ../fish/guestfish-actions.pod:2682
24638 #: ../fish/guestfish-actions.pod:2684
24641 " luks-open device mapname\n"
24646 #: ../fish/guestfish-actions.pod:2698
24648 "If this block device contains LVM volume groups, then calling L</vgscan> "
24649 "followed by L</vg-activate-all> will make them visible."
24653 #: ../fish/guestfish-actions.pod:2705
24654 msgid "luks-open-ro"
24658 #: ../fish/guestfish-actions.pod:2707
24661 " luks-open-ro device mapname\n"
24666 #: ../fish/guestfish-actions.pod:2709
24668 "This is the same as L</luks-open> except that a read-only mapping is created."
24672 #: ../fish/guestfish-actions.pod:2715
24677 #: ../fish/guestfish-actions.pod:2717
24680 " lvcreate logvol volgroup mbytes\n"
24685 #: ../fish/guestfish-actions.pod:2722
24686 msgid "lvm-canonical-lv-name"
24690 #: ../fish/guestfish-actions.pod:2724
24693 " lvm-canonical-lv-name lvname\n"
24698 #: ../fish/guestfish-actions.pod:2733
24699 msgid "See also L</is-lv>."
24703 #: ../fish/guestfish-actions.pod:2735
24704 msgid "lvm-clear-filter"
24708 #: ../fish/guestfish-actions.pod:2737
24711 " lvm-clear-filter\n"
24716 #: ../fish/guestfish-actions.pod:2739
24718 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
24723 #: ../fish/guestfish-actions.pod:2745
24724 msgid "lvm-remove-all"
24728 #: ../fish/guestfish-actions.pod:2747
24731 " lvm-remove-all\n"
24736 #: ../fish/guestfish-actions.pod:2755
24737 msgid "lvm-set-filter"
24741 #: ../fish/guestfish-actions.pod:2757
24744 " lvm-set-filter 'devices ...'\n"
24749 #: ../fish/guestfish-actions.pod:2782
24754 #: ../fish/guestfish-actions.pod:2784
24757 " lvremove device\n"
24762 #: ../fish/guestfish-actions.pod:2792
24767 #: ../fish/guestfish-actions.pod:2794
24770 " lvrename logvol newlogvol\n"
24775 #: ../fish/guestfish-actions.pod:2798
24780 #: ../fish/guestfish-actions.pod:2800
24783 " lvresize device mbytes\n"
24788 #: ../fish/guestfish-actions.pod:2806
24789 msgid "lvresize-free"
24793 #: ../fish/guestfish-actions.pod:2808
24796 " lvresize-free lv percent\n"
24801 #: ../fish/guestfish-actions.pod:2816
24806 #: ../fish/guestfish-actions.pod:2818
24814 #: ../fish/guestfish-actions.pod:2826
24815 msgid "See also L</lvs-full>, L</list-filesystems>."
24819 #: ../fish/guestfish-actions.pod:2828
24824 #: ../fish/guestfish-actions.pod:2830
24832 #: ../fish/guestfish-actions.pod:2835
24837 #: ../fish/guestfish-actions.pod:2837
24845 #: ../fish/guestfish-actions.pod:2841
24850 #: ../fish/guestfish-actions.pod:2843
24853 " lxattrlist path 'names ...'\n"
24858 #: ../fish/guestfish-actions.pod:2859
24860 "This call is intended for programs that want to efficiently list a directory "
24861 "contents without making many round-trips. See also L</lstatlist> for a "
24862 "similarly efficient call for getting standard stats. Very long directory "
24863 "listings might cause the protocol message size to be exceeded, causing this "
24864 "call to fail. The caller must split up such requests into smaller groups of "
24869 #: ../fish/guestfish-actions.pod:2867
24874 #: ../fish/guestfish-actions.pod:2869
24882 #: ../fish/guestfish-actions.pod:2873
24887 #: ../fish/guestfish-actions.pod:2875
24890 " mkdir-mode path mode\n"
24895 #: ../fish/guestfish-actions.pod:2884
24896 msgid "See also L</mkdir>, L</umask>"
24900 #: ../fish/guestfish-actions.pod:2886
24905 #: ../fish/guestfish-actions.pod:2888
24913 #: ../fish/guestfish-actions.pod:2893
24918 #: ../fish/guestfish-actions.pod:2895
24921 " mkdtemp template\n"
24926 #: ../fish/guestfish-actions.pod:2916
24931 #: ../fish/guestfish-actions.pod:2918
24934 " mke2fs-J fstype blocksize device journal\n"
24939 #: ../fish/guestfish-actions.pod:2926
24940 msgid "See also L</mke2journal>."
24944 #: ../fish/guestfish-actions.pod:2928
24949 #: ../fish/guestfish-actions.pod:2930
24952 " mke2fs-JL fstype blocksize device label\n"
24957 #: ../fish/guestfish-actions.pod:2935
24958 msgid "See also L</mke2journal-L>."
24962 #: ../fish/guestfish-actions.pod:2937
24967 #: ../fish/guestfish-actions.pod:2939
24970 " mke2fs-JU fstype blocksize device uuid\n"
24975 #: ../fish/guestfish-actions.pod:2944
24976 msgid "See also L</mke2journal-U>."
24980 #: ../fish/guestfish-actions.pod:2946
24981 msgid "mke2journal"
24985 #: ../fish/guestfish-actions.pod:2948
24988 " mke2journal blocksize device\n"
24993 #: ../fish/guestfish-actions.pod:2955
24994 msgid "mke2journal-L"
24998 #: ../fish/guestfish-actions.pod:2957
25001 " mke2journal-L blocksize label device\n"
25006 #: ../fish/guestfish-actions.pod:2961
25007 msgid "mke2journal-U"
25011 #: ../fish/guestfish-actions.pod:2963
25014 " mke2journal-U blocksize uuid device\n"
25019 #: ../fish/guestfish-actions.pod:2967
25024 #: ../fish/guestfish-actions.pod:2969
25027 " mkfifo mode path\n"
25032 #: ../fish/guestfish-actions.pod:2971
25034 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25035 "is just a convenient wrapper around L</mknod>."
25039 #: ../fish/guestfish-actions.pod:2977
25044 #: ../fish/guestfish-actions.pod:2979
25047 " mkfs fstype device\n"
25052 #: ../fish/guestfish-actions.pod:2985
25057 #: ../fish/guestfish-actions.pod:2987
25060 " mkfs-b fstype blocksize device\n"
25065 #: ../fish/guestfish-actions.pod:2989
25067 "This call is similar to L</mkfs>, but it allows you to control the block "
25068 "size of the resulting filesystem. Supported block sizes depend on the "
25069 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25073 #: ../fish/guestfish-actions.pod:3004
25078 #: ../fish/guestfish-actions.pod:3006
25081 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
25086 #: ../fish/guestfish-actions.pod:3041
25087 msgid "mkmountpoint"
25091 #: ../fish/guestfish-actions.pod:3043
25094 " mkmountpoint exemptpath\n"
25099 #: ../fish/guestfish-actions.pod:3045
25101 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
25102 "to create extra mountpoints before mounting the first filesystem."
25106 #: ../fish/guestfish-actions.pod:3069
25108 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
25109 "unexpected errors if you try to mix these calls. It is safest to manually "
25110 "unmount filesystems and remove mountpoints after use."
25114 #: ../fish/guestfish-actions.pod:3073
25116 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
25117 "for this to work for manual mountpoints, you must ensure that the innermost "
25118 "mountpoints have the longest pathnames, as in the example code above."
25122 #: ../fish/guestfish-actions.pod:3080
25124 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
25125 "L</umount-all> to be called when the handle is closed which can also trigger "
25130 #: ../fish/guestfish-actions.pod:3084
25135 #: ../fish/guestfish-actions.pod:3086
25138 " mknod mode devmajor devminor path\n"
25143 #: ../fish/guestfish-actions.pod:3096
25145 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
25146 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
25147 "regular file). These constants are available in the standard Linux header "
25148 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
25149 "wrappers around this command which bitwise OR in the appropriate constant "
25154 #: ../fish/guestfish-actions.pod:3106
25159 #: ../fish/guestfish-actions.pod:3108
25162 " mknod-b mode devmajor devminor path\n"
25167 #: ../fish/guestfish-actions.pod:3110
25169 "This call creates a block device node called C<path> with mode C<mode> and "
25170 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25171 "wrapper around L</mknod>."
25175 #: ../fish/guestfish-actions.pod:3116
25180 #: ../fish/guestfish-actions.pod:3118
25183 " mknod-c mode devmajor devminor path\n"
25188 #: ../fish/guestfish-actions.pod:3120
25190 "This call creates a char device node called C<path> with mode C<mode> and "
25191 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25192 "wrapper around L</mknod>."
25196 #: ../fish/guestfish-actions.pod:3126
25201 #: ../fish/guestfish-actions.pod:3128
25209 #: ../fish/guestfish-actions.pod:3132
25214 #: ../fish/guestfish-actions.pod:3134
25217 " mkswap-L label device\n"
25222 #: ../fish/guestfish-actions.pod:3142
25227 #: ../fish/guestfish-actions.pod:3144
25230 " mkswap-U uuid device\n"
25235 #: ../fish/guestfish-actions.pod:3148
25236 msgid "mkswap-file"
25240 #: ../fish/guestfish-actions.pod:3150
25243 " mkswap-file path\n"
25248 #: ../fish/guestfish-actions.pod:3154
25250 "This command just writes a swap file signature to an existing file. To "
25251 "create the file itself, use something like L</fallocate>."
25255 #: ../fish/guestfish-actions.pod:3157
25260 #: ../fish/guestfish-actions.pod:3159
25263 " modprobe modulename\n"
25268 #: ../fish/guestfish-actions.pod:3166
25273 #: ../fish/guestfish-actions.pod:3168
25276 " mount device mountpoint\n"
25281 #: ../fish/guestfish-actions.pod:3184
25283 "B<Important note:> When you use this call, the filesystem options C<sync> "
25284 "and C<noatime> are set implicitly. This was originally done because we "
25285 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25286 "very large negative performance impact and negligible effect on "
25287 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25288 "code that needs performance, and instead use L</mount-options> (use an empty "
25289 "string for the first parameter if you don't want any options)."
25293 #: ../fish/guestfish-actions.pod:3194
25298 #: ../fish/guestfish-actions.pod:3196
25301 " mount-loop file mountpoint\n"
25306 #: ../fish/guestfish-actions.pod:3202
25307 msgid "mount-options"
25311 #: ../fish/guestfish-actions.pod:3204
25314 " mount-options options device mountpoint\n"
25319 #: ../fish/guestfish-actions.pod:3206
25321 "This is the same as the L</mount> command, but it allows you to set the "
25322 "mount options as for the L<mount(8)> I<-o> flag."
25326 #: ../fish/guestfish-actions.pod:3214
25331 #: ../fish/guestfish-actions.pod:3216
25334 " mount-ro device mountpoint\n"
25339 #: ../fish/guestfish-actions.pod:3218
25341 "This is the same as the L</mount> command, but it mounts the filesystem with "
25342 "the read-only (I<-o ro>) flag."
25346 #: ../fish/guestfish-actions.pod:3221
25351 #: ../fish/guestfish-actions.pod:3223
25354 " mount-vfs options vfstype device mountpoint\n"
25359 #: ../fish/guestfish-actions.pod:3225
25361 "This is the same as the L</mount> command, but it allows you to set both the "
25362 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25366 #: ../fish/guestfish-actions.pod:3229
25367 msgid "mountpoints"
25371 #: ../fish/guestfish-actions.pod:3231
25379 #: ../fish/guestfish-actions.pod:3233
25381 "This call is similar to L</mounts>. That call returns a list of devices. "
25382 "This one returns a hash table (map) of device name to directory where the "
25383 "device is mounted."
25387 #: ../fish/guestfish-actions.pod:3237
25392 #: ../fish/guestfish-actions.pod:3239
25400 #: ../fish/guestfish-actions.pod:3246
25401 msgid "See also: L</mountpoints>"
25405 #: ../fish/guestfish-actions.pod:3248
25410 #: ../fish/guestfish-actions.pod:3250
25418 #: ../fish/guestfish-actions.pod:3255
25419 msgid "ntfs-3g-probe"
25423 #: ../fish/guestfish-actions.pod:3257
25426 " ntfs-3g-probe true|false device\n"
25431 #: ../fish/guestfish-actions.pod:3271
25436 #: ../fish/guestfish-actions.pod:3273
25439 " ntfsresize device\n"
25444 #: ../fish/guestfish-actions.pod:3279
25445 msgid "ntfsresize-size"
25449 #: ../fish/guestfish-actions.pod:3281
25452 " ntfsresize-size device size\n"
25457 #: ../fish/guestfish-actions.pod:3283
25459 "This command is the same as L</ntfsresize> except that it allows you to "
25460 "specify the new size (in bytes) explicitly."
25464 #: ../fish/guestfish-actions.pod:3286
25469 #: ../fish/guestfish-actions.pod:3288
25472 " part-add device prlogex startsect endsect\n"
25477 #: ../fish/guestfish-actions.pod:3290
25479 "This command adds a partition to C<device>. If there is no partition table "
25480 "on the device, call L</part-init> first."
25484 #: ../fish/guestfish-actions.pod:3302
25486 "Creating a partition which covers the whole disk is not so easy. Use L</"
25487 "part-disk> to do that."
25491 #: ../fish/guestfish-actions.pod:3305
25496 #: ../fish/guestfish-actions.pod:3307
25499 " part-del device partnum\n"
25504 #: ../fish/guestfish-actions.pod:3315
25509 #: ../fish/guestfish-actions.pod:3317
25512 " part-disk device parttype\n"
25517 #: ../fish/guestfish-actions.pod:3319
25519 "This command is simply a combination of L</part-init> followed by L</part-"
25520 "add> to create a single primary partition covering the whole disk."
25524 #: ../fish/guestfish-actions.pod:3323
25526 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25527 "possible values are described in L</part-init>."
25531 #: ../fish/guestfish-actions.pod:3329
25532 msgid "part-get-bootable"
25536 #: ../fish/guestfish-actions.pod:3331
25539 " part-get-bootable device partnum\n"
25544 #: ../fish/guestfish-actions.pod:3336
25545 msgid "See also L</part-set-bootable>."
25549 #: ../fish/guestfish-actions.pod:3338
25550 msgid "part-get-mbr-id"
25554 #: ../fish/guestfish-actions.pod:3340
25557 " part-get-mbr-id device partnum\n"
25562 #: ../fish/guestfish-actions.pod:3345 ../fish/guestfish-actions.pod:3483
25564 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25565 "undefined results for other partition table types (see L</part-get-"
25570 #: ../fish/guestfish-actions.pod:3349
25571 msgid "part-get-parttype"
25575 #: ../fish/guestfish-actions.pod:3351
25578 " part-get-parttype device\n"
25583 #: ../fish/guestfish-actions.pod:3356
25585 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
25586 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
25587 "possible, although unusual. See L</part-init> for a full list."
25591 #: ../fish/guestfish-actions.pod:3361
25596 #: ../fish/guestfish-actions.pod:3363
25599 " part-init device parttype\n"
25604 #: ../fish/guestfish-actions.pod:3369
25606 "Initially there are no partitions. Following this, you should call L</part-"
25607 "add> for each partition required."
25611 #: ../fish/guestfish-actions.pod:3432
25616 #: ../fish/guestfish-actions.pod:3434
25619 " part-list device\n"
25624 #: ../fish/guestfish-actions.pod:3449
25626 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25627 "the device's sector size, see L</blockdev-getss>."
25631 #: ../fish/guestfish-actions.pod:3462
25632 msgid "part-set-bootable"
25636 #: ../fish/guestfish-actions.pod:3464
25639 " part-set-bootable device partnum true|false\n"
25644 #: ../fish/guestfish-actions.pod:3473
25645 msgid "part-set-mbr-id"
25649 #: ../fish/guestfish-actions.pod:3475
25652 " part-set-mbr-id device partnum idbyte\n"
25657 #: ../fish/guestfish-actions.pod:3487
25658 msgid "part-set-name"
25662 #: ../fish/guestfish-actions.pod:3489
25665 " part-set-name device partnum name\n"
25670 #: ../fish/guestfish-actions.pod:3497
25671 msgid "part-to-dev"
25675 #: ../fish/guestfish-actions.pod:3499
25678 " part-to-dev partition\n"
25683 #: ../fish/guestfish-actions.pod:3505
25685 "The named partition must exist, for example as a string returned from L</"
25686 "list-partitions>."
25690 #: ../fish/guestfish-actions.pod:3508
25691 msgid "ping-daemon"
25695 #: ../fish/guestfish-actions.pod:3510
25703 #: ../fish/guestfish-actions.pod:3517
25708 #: ../fish/guestfish-actions.pod:3519
25711 " pread path count offset\n"
25716 #: ../fish/guestfish-actions.pod:3527
25717 msgid "See also L</pwrite>, L</pread-device>."
25721 #: ../fish/guestfish-actions.pod:3532
25722 msgid "pread-device"
25726 #: ../fish/guestfish-actions.pod:3534
25729 " pread-device device count offset\n"
25734 #: ../fish/guestfish-actions.pod:3542
25735 msgid "See also L</pread>."
25739 #: ../fish/guestfish-actions.pod:3547
25744 #: ../fish/guestfish-actions.pod:3549
25747 " pvcreate device\n"
25752 #: ../fish/guestfish-actions.pod:3555
25757 #: ../fish/guestfish-actions.pod:3557
25760 " pvremove device\n"
25765 #: ../fish/guestfish-actions.pod:3566
25770 #: ../fish/guestfish-actions.pod:3568
25773 " pvresize device\n"
25778 #: ../fish/guestfish-actions.pod:3573
25779 msgid "pvresize-size"
25783 #: ../fish/guestfish-actions.pod:3575
25786 " pvresize-size device size\n"
25791 #: ../fish/guestfish-actions.pod:3577
25793 "This command is the same as L</pvresize> except that it allows you to "
25794 "specify the new size (in bytes) explicitly."
25798 #: ../fish/guestfish-actions.pod:3580
25803 #: ../fish/guestfish-actions.pod:3582
25811 #: ../fish/guestfish-actions.pod:3590
25812 msgid "See also L</pvs-full>."
25816 #: ../fish/guestfish-actions.pod:3592
25821 #: ../fish/guestfish-actions.pod:3594
25829 #: ../fish/guestfish-actions.pod:3599
25834 #: ../fish/guestfish-actions.pod:3601
25842 #: ../fish/guestfish-actions.pod:3605
25847 #: ../fish/guestfish-actions.pod:3607
25850 " pwrite path content offset\n"
25855 #: ../fish/guestfish-actions.pod:3618
25856 msgid "See also L</pread>, L</pwrite-device>."
25860 #: ../fish/guestfish-actions.pod:3623
25861 msgid "pwrite-device"
25865 #: ../fish/guestfish-actions.pod:3625
25868 " pwrite-device device content offset\n"
25873 #: ../fish/guestfish-actions.pod:3635
25874 msgid "See also L</pwrite>."
25878 #: ../fish/guestfish-actions.pod:3640
25883 #: ../fish/guestfish-actions.pod:3642
25886 " read-file path\n"
25891 #: ../fish/guestfish-actions.pod:3647
25893 "Unlike L</cat>, this function can correctly handle files that contain "
25894 "embedded ASCII NUL characters. However unlike L</download>, this function "
25895 "is limited in the total size of file that can be handled."
25899 #: ../fish/guestfish-actions.pod:3655
25904 #: ../fish/guestfish-actions.pod:3657
25907 " read-lines path\n"
25912 #: ../fish/guestfish-actions.pod:3664
25914 "Note that this function cannot correctly handle binary files (specifically, "
25915 "files containing C<\\0> character which is treated as end of line). For "
25916 "those you need to use the L</read-file> function which has a more complex "
25921 #: ../fish/guestfish-actions.pod:3669
25926 #: ../fish/guestfish-actions.pod:3671
25934 #: ../fish/guestfish-actions.pod:3723
25936 "This function is primarily intended for use by programs. To get a simple "
25937 "list of names, use L</ls>. To get a printable directory for human "
25938 "consumption, use L</ll>."
25942 #: ../fish/guestfish-actions.pod:3727
25947 #: ../fish/guestfish-actions.pod:3729
25955 #: ../fish/guestfish-actions.pod:3733
25956 msgid "readlinklist"
25960 #: ../fish/guestfish-actions.pod:3735
25963 " readlinklist path 'names ...'\n"
25968 #: ../fish/guestfish-actions.pod:3759
25973 #: ../fish/guestfish-actions.pod:3761
25981 #: ../fish/guestfish-actions.pod:3766
25982 msgid "removexattr"
25986 #: ../fish/guestfish-actions.pod:3768
25989 " removexattr xattr path\n"
25994 #: ../fish/guestfish-actions.pod:3773
25995 msgid "See also: L</lremovexattr>, L<attr(5)>."
25999 #: ../fish/guestfish-actions.pod:3775
26004 #: ../fish/guestfish-actions.pod:3777
26007 " resize2fs device\n"
26012 #: ../fish/guestfish-actions.pod:3782
26014 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
26015 "before calling this command. For unknown reasons C<resize2fs> sometimes "
26016 "gives an error about this and sometimes not. In any case, it is always safe "
26017 "to call L</e2fsck-f> before calling this function."
26021 #: ../fish/guestfish-actions.pod:3788
26022 msgid "resize2fs-M"
26026 #: ../fish/guestfish-actions.pod:3790
26029 " resize2fs-M device\n"
26034 #: ../fish/guestfish-actions.pod:3792
26036 "This command is the same as L</resize2fs>, but the filesystem is resized to "
26037 "its minimum size. This works like the C<-M> option to the C<resize2fs> "
26042 #: ../fish/guestfish-actions.pod:3796
26044 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
26045 "and read the C<Block size> and C<Block count> values. These two numbers, "
26046 "multiplied together, give the resulting size of the minimal filesystem in "
26051 #: ../fish/guestfish-actions.pod:3801
26052 msgid "resize2fs-size"
26056 #: ../fish/guestfish-actions.pod:3803
26059 " resize2fs-size device size\n"
26064 #: ../fish/guestfish-actions.pod:3805
26066 "This command is the same as L</resize2fs> except that it allows you to "
26067 "specify the new size (in bytes) explicitly."
26071 #: ../fish/guestfish-actions.pod:3808
26076 #: ../fish/guestfish-actions.pod:3810
26084 #: ../fish/guestfish-actions.pod:3814
26089 #: ../fish/guestfish-actions.pod:3816
26097 #: ../fish/guestfish-actions.pod:3822
26102 #: ../fish/guestfish-actions.pod:3824
26110 #: ../fish/guestfish-actions.pod:3828
26111 msgid "rmmountpoint"
26115 #: ../fish/guestfish-actions.pod:3830
26118 " rmmountpoint exemptpath\n"
26123 #: ../fish/guestfish-actions.pod:3832
26125 "This calls removes a mountpoint that was previously created with L</"
26126 "mkmountpoint>. See L</mkmountpoint> for full details."
26130 #: ../fish/guestfish-actions.pod:3836
26131 msgid "scrub-device"
26135 #: ../fish/guestfish-actions.pod:3838
26138 " scrub-device device\n"
26143 #: ../fish/guestfish-actions.pod:3849
26148 #: ../fish/guestfish-actions.pod:3851
26151 " scrub-file file\n"
26156 #: ../fish/guestfish-actions.pod:3861
26157 msgid "scrub-freespace"
26161 #: ../fish/guestfish-actions.pod:3863
26164 " scrub-freespace dir\n"
26169 #: ../fish/guestfish-actions.pod:3865
26171 "This command creates the directory C<dir> and then fills it with files until "
26172 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
26173 "deletes them. The intention is to scrub any free space on the partition "
26174 "containing C<dir>."
26178 #: ../fish/guestfish-actions.pod:3874
26183 #: ../fish/guestfish-actions.pod:3876
26188 #: ../fish/guestfish-actions.pod:3878
26191 " set-append append\n"
26196 #: ../fish/guestfish-actions.pod:3889
26197 msgid "set-attach-method"
26201 #: ../fish/guestfish-actions.pod:3891
26202 msgid "attach-method"
26206 #: ../fish/guestfish-actions.pod:3893
26209 " set-attach-method attachmethod\n"
26214 #: ../fish/guestfish-actions.pod:3915
26215 msgid "set-autosync"
26219 #: ../fish/guestfish-actions.pod:3917
26224 #: ../fish/guestfish-actions.pod:3919
26227 " set-autosync true|false\n"
26232 #: ../fish/guestfish-actions.pod:3929
26237 #: ../fish/guestfish-actions.pod:3931
26242 #: ../fish/guestfish-actions.pod:3933
26245 " set-direct true|false\n"
26250 #: ../fish/guestfish-actions.pod:3939
26252 "One consequence of this is that log messages aren't caught by the library "
26253 "and handled by L</set-log-message-callback>, but go straight to stdout."
26257 #: ../fish/guestfish-actions.pod:3948
26258 msgid "set-e2label"
26262 #: ../fish/guestfish-actions.pod:3950
26265 " set-e2label device label\n"
26270 #: ../fish/guestfish-actions.pod:3956
26272 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
26273 "label on a filesystem."
26277 #: ../fish/guestfish-actions.pod:3959
26282 #: ../fish/guestfish-actions.pod:3961
26285 " set-e2uuid device uuid\n"
26290 #: ../fish/guestfish-actions.pod:3968
26292 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
26293 "UUID of a filesystem."
26297 #: ../fish/guestfish-actions.pod:3971
26298 msgid "set-memsize"
26302 #: ../fish/guestfish-actions.pod:3973
26307 #: ../fish/guestfish-actions.pod:3975
26310 " set-memsize memsize\n"
26315 #: ../fish/guestfish-actions.pod:3977
26317 "This sets the memory size in megabytes allocated to the qemu subprocess. "
26318 "This only has any effect if called before L</launch>."
26322 #: ../fish/guestfish-actions.pod:3988
26323 msgid "set-network"
26327 #: ../fish/guestfish-actions.pod:3990
26332 #: ../fish/guestfish-actions.pod:3992
26335 " set-network true|false\n"
26340 #: ../fish/guestfish-actions.pod:4000
26342 "You must call this before calling L</launch>, otherwise it has no effect."
26346 #: ../fish/guestfish-actions.pod:4003
26351 #: ../fish/guestfish-actions.pod:4005
26356 #: ../fish/guestfish-actions.pod:4007
26359 " set-path searchpath\n"
26364 #: ../fish/guestfish-actions.pod:4016
26369 #: ../fish/guestfish-actions.pod:4018
26374 #: ../fish/guestfish-actions.pod:4020
26382 #: ../fish/guestfish-actions.pod:4040
26383 msgid "set-recovery-proc"
26387 #: ../fish/guestfish-actions.pod:4042
26388 msgid "recovery-proc"
26392 #: ../fish/guestfish-actions.pod:4044
26395 " set-recovery-proc true|false\n"
26400 #: ../fish/guestfish-actions.pod:4046
26402 "If this is called with the parameter C<false> then L</launch> does not "
26403 "create a recovery process. The purpose of the recovery process is to stop "
26404 "runaway qemu processes in the case where the main program aborts abruptly."
26408 #: ../fish/guestfish-actions.pod:4051
26410 "This only has any effect if called before L</launch>, and the default is "
26415 #: ../fish/guestfish-actions.pod:4060
26416 msgid "set-selinux"
26420 #: ../fish/guestfish-actions.pod:4062
26425 #: ../fish/guestfish-actions.pod:4064
26428 " set-selinux true|false\n"
26433 #: ../fish/guestfish-actions.pod:4075
26438 #: ../fish/guestfish-actions.pod:4077
26443 #: ../fish/guestfish-actions.pod:4079
26446 " set-trace true|false\n"
26451 #: ../fish/guestfish-actions.pod:4091
26453 "Trace messages are normally sent to C<stderr>, unless you register a "
26454 "callback to send them somewhere else (see L</set-event-callback>)."
26458 #: ../fish/guestfish-actions.pod:4095
26459 msgid "set-verbose"
26463 #: ../fish/guestfish-actions.pod:4097
26468 #: ../fish/guestfish-actions.pod:4099
26471 " set-verbose true|false\n"
26476 #: ../fish/guestfish-actions.pod:4106
26478 "Verbose messages are normally sent to C<stderr>, unless you register a "
26479 "callback to send them somewhere else (see L</set-event-callback>)."
26483 #: ../fish/guestfish-actions.pod:4110
26488 #: ../fish/guestfish-actions.pod:4112
26491 " setcon context\n"
26496 #: ../fish/guestfish-actions.pod:4119
26501 #: ../fish/guestfish-actions.pod:4121
26504 " setxattr xattr val vallen path\n"
26509 #: ../fish/guestfish-actions.pod:4127
26510 msgid "See also: L</lsetxattr>, L<attr(5)>."
26514 #: ../fish/guestfish-actions.pod:4129
26519 #: ../fish/guestfish-actions.pod:4131
26522 " sfdisk device cyls heads sectors 'lines ...'\n"
26527 #: ../fish/guestfish-actions.pod:4153
26528 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26532 #: ../fish/guestfish-actions.pod:4159
26537 #: ../fish/guestfish-actions.pod:4161
26540 " sfdiskM device 'lines ...'\n"
26545 #: ../fish/guestfish-actions.pod:4163
26547 "This is a simplified interface to the L</sfdisk> command, where partition "
26548 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26549 "you don't need to specify the cyls, heads and sectors parameters which were "
26550 "rarely if ever used anyway."
26554 #: ../fish/guestfish-actions.pod:4169
26555 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26559 #: ../fish/guestfish-actions.pod:4175
26564 #: ../fish/guestfish-actions.pod:4177
26567 " sfdisk-N device partnum cyls heads sectors line\n"
26572 #: ../fish/guestfish-actions.pod:4182
26574 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26575 "cyls/heads/sectors parameters."
26579 #: ../fish/guestfish-actions.pod:4185
26580 msgid "See also: L</part-add>"
26584 #: ../fish/guestfish-actions.pod:4190
26585 msgid "sfdisk-disk-geometry"
26589 #: ../fish/guestfish-actions.pod:4192
26592 " sfdisk-disk-geometry device\n"
26597 #: ../fish/guestfish-actions.pod:4194
26599 "This displays the disk geometry of C<device> read from the partition table. "
26600 "Especially in the case where the underlying block device has been resized, "
26601 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
26602 "kernel-geometry>)."
26606 #: ../fish/guestfish-actions.pod:4202
26607 msgid "sfdisk-kernel-geometry"
26611 #: ../fish/guestfish-actions.pod:4204
26614 " sfdisk-kernel-geometry device\n"
26619 #: ../fish/guestfish-actions.pod:4211
26624 #: ../fish/guestfish-actions.pod:4213
26627 " sfdisk-l device\n"
26632 #: ../fish/guestfish-actions.pod:4219
26633 msgid "See also: L</part-list>"
26637 #: ../fish/guestfish-actions.pod:4221
26642 #: ../fish/guestfish-actions.pod:4223
26650 #: ../fish/guestfish-actions.pod:4228
26651 msgid "This is like L</command>, but passes the command to:"
26655 #: ../fish/guestfish-actions.pod:4236
26656 msgid "All the provisos about L</command> apply to this call."
26660 #: ../fish/guestfish-actions.pod:4238
26665 #: ../fish/guestfish-actions.pod:4240
26668 " sh-lines command\n"
26673 #: ../fish/guestfish-actions.pod:4242
26674 msgid "This is the same as L</sh>, but splits the result into a list of lines."
26678 #: ../fish/guestfish-actions.pod:4245
26679 msgid "See also: L</command-lines>"
26683 #: ../fish/guestfish-actions.pod:4247
26688 #: ../fish/guestfish-actions.pod:4249
26696 #: ../fish/guestfish-actions.pod:4253
26701 #: ../fish/guestfish-actions.pod:4255
26709 #: ../fish/guestfish-actions.pod:4261
26714 #: ../fish/guestfish-actions.pod:4263
26722 #: ../fish/guestfish-actions.pod:4271
26727 #: ../fish/guestfish-actions.pod:4273
26735 #: ../fish/guestfish-actions.pod:4281
26740 #: ../fish/guestfish-actions.pod:4283
26743 " strings-e encoding path\n"
26748 #: ../fish/guestfish-actions.pod:4285
26750 "This is like the L</strings> command, but allows you to specify the encoding "
26751 "of strings that are looked for in the source file C<path>."
26755 #: ../fish/guestfish-actions.pod:4295
26757 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
26758 "ISO-8859-X (this is what L</strings> uses)."
26762 #: ../fish/guestfish-actions.pod:4327
26763 msgid "swapoff-device"
26767 #: ../fish/guestfish-actions.pod:4329
26770 " swapoff-device device\n"
26775 #: ../fish/guestfish-actions.pod:4331
26777 "This command disables the libguestfs appliance swap device or partition "
26778 "named C<device>. See L</swapon-device>."
26782 #: ../fish/guestfish-actions.pod:4335
26783 msgid "swapoff-file"
26787 #: ../fish/guestfish-actions.pod:4337
26790 " swapoff-file file\n"
26795 #: ../fish/guestfish-actions.pod:4341
26796 msgid "swapoff-label"
26800 #: ../fish/guestfish-actions.pod:4343
26803 " swapoff-label label\n"
26808 #: ../fish/guestfish-actions.pod:4348
26809 msgid "swapoff-uuid"
26813 #: ../fish/guestfish-actions.pod:4350
26816 " swapoff-uuid uuid\n"
26821 #: ../fish/guestfish-actions.pod:4355
26822 msgid "swapon-device"
26826 #: ../fish/guestfish-actions.pod:4357
26829 " swapon-device device\n"
26834 #: ../fish/guestfish-actions.pod:4359
26836 "This command enables the libguestfs appliance to use the swap device or "
26837 "partition named C<device>. The increased memory is made available for all "
26838 "commands, for example those run using L</command> or L</sh>."
26842 #: ../fish/guestfish-actions.pod:4371
26843 msgid "swapon-file"
26847 #: ../fish/guestfish-actions.pod:4373
26850 " swapon-file file\n"
26855 #: ../fish/guestfish-actions.pod:4375
26857 "This command enables swap to a file. See L</swapon-device> for other notes."
26861 #: ../fish/guestfish-actions.pod:4378
26862 msgid "swapon-label"
26866 #: ../fish/guestfish-actions.pod:4380
26869 " swapon-label label\n"
26874 #: ../fish/guestfish-actions.pod:4382
26876 "This command enables swap to a labeled swap partition. See L</swapon-"
26877 "device> for other notes."
26881 #: ../fish/guestfish-actions.pod:4385
26882 msgid "swapon-uuid"
26886 #: ../fish/guestfish-actions.pod:4387
26889 " swapon-uuid uuid\n"
26894 #: ../fish/guestfish-actions.pod:4389
26896 "This command enables swap to a swap partition with the given UUID. See L</"
26897 "swapon-device> for other notes."
26901 #: ../fish/guestfish-actions.pod:4392
26906 #: ../fish/guestfish-actions.pod:4394
26914 #: ../fish/guestfish-actions.pod:4402
26919 #: ../fish/guestfish-actions.pod:4404
26927 #: ../fish/guestfish-actions.pod:4412
26932 #: ../fish/guestfish-actions.pod:4414
26935 " tail-n nrlines path\n"
26940 #: ../fish/guestfish-actions.pod:4427
26945 #: ../fish/guestfish-actions.pod:4429
26948 " tar-in (tarfile|-) directory\n"
26953 #: ../fish/guestfish-actions.pod:4434
26954 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
26958 #: ../fish/guestfish-actions.pod:4439
26963 #: ../fish/guestfish-actions.pod:4441
26966 " tar-out directory (tarfile|-)\n"
26971 #: ../fish/guestfish-actions.pod:4446
26972 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
26976 #: ../fish/guestfish-actions.pod:4451
26981 #: ../fish/guestfish-actions.pod:4453
26984 " tgz-in (tarball|-) directory\n"
26989 #: ../fish/guestfish-actions.pod:4458
26990 msgid "To upload an uncompressed tarball, use L</tar-in>."
26994 #: ../fish/guestfish-actions.pod:4462
26999 #: ../fish/guestfish-actions.pod:4464
27002 " tgz-out directory (tarball|-)\n"
27007 #: ../fish/guestfish-actions.pod:4469
27008 msgid "To download an uncompressed tarball, use L</tar-out>."
27012 #: ../fish/guestfish-actions.pod:4473
27017 #: ../fish/guestfish-actions.pod:4475
27025 #: ../fish/guestfish-actions.pod:4484
27030 #: ../fish/guestfish-actions.pod:4486
27038 #: ../fish/guestfish-actions.pod:4491
27039 msgid "truncate-size"
27043 #: ../fish/guestfish-actions.pod:4493
27046 " truncate-size path size\n"
27051 #: ../fish/guestfish-actions.pod:4498
27053 "If the current file size is less than C<size> then the file is extended to "
27054 "the required size with zero bytes. This creates a sparse file (ie. disk "
27055 "blocks are not allocated for the file until you write to it). To create a "
27056 "non-sparse file of zeroes, use L</fallocate64> instead."
27060 #: ../fish/guestfish-actions.pod:4504
27065 #: ../fish/guestfish-actions.pod:4506
27068 " tune2fs-l device\n"
27073 #: ../fish/guestfish-actions.pod:4516
27078 #: ../fish/guestfish-actions.pod:4518
27081 " txz-in (tarball|-) directory\n"
27086 #: ../fish/guestfish-actions.pod:4525
27091 #: ../fish/guestfish-actions.pod:4527
27094 " txz-out directory (tarball|-)\n"
27099 #: ../fish/guestfish-actions.pod:4534
27104 #: ../fish/guestfish-actions.pod:4536
27112 #: ../fish/guestfish-actions.pod:4550
27113 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
27117 #: ../fish/guestfish-actions.pod:4555
27122 #: ../fish/guestfish-actions.pod:4557
27127 #: ../fish/guestfish-actions.pod:4559
27130 " umount pathordevice\n"
27135 #: ../fish/guestfish-actions.pod:4565
27140 #: ../fish/guestfish-actions.pod:4567
27141 msgid "unmount-all"
27145 #: ../fish/guestfish-actions.pod:4569
27153 #: ../fish/guestfish-actions.pod:4575
27158 #: ../fish/guestfish-actions.pod:4577
27161 " upload (filename|-) remotefilename\n"
27166 #: ../fish/guestfish-actions.pod:4584
27167 msgid "See also L</download>."
27171 #: ../fish/guestfish-actions.pod:4588
27172 msgid "upload-offset"
27176 #: ../fish/guestfish-actions.pod:4590
27179 " upload-offset (filename|-) remotefilename offset\n"
27184 #: ../fish/guestfish-actions.pod:4602
27186 "Note that there is no limit on the amount of data that can be uploaded with "
27187 "this call, unlike with L</pwrite>, and this call always writes the full "
27188 "amount unless an error occurs."
27192 #: ../fish/guestfish-actions.pod:4607
27193 msgid "See also L</upload>, L</pwrite>."
27197 #: ../fish/guestfish-actions.pod:4611
27202 #: ../fish/guestfish-actions.pod:4613
27205 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
27210 #: ../fish/guestfish-actions.pod:4632
27215 #: ../fish/guestfish-actions.pod:4634
27223 #: ../fish/guestfish-actions.pod:4661
27225 "I<Note:> Don't use this call to test for availability of features. In "
27226 "enterprise distributions we backport features from later versions into "
27227 "earlier versions, making this an unreliable way to test for features. Use "
27228 "L</available> instead."
27232 #: ../fish/guestfish-actions.pod:4667
27237 #: ../fish/guestfish-actions.pod:4669
27240 " vfs-label device\n"
27245 #: ../fish/guestfish-actions.pod:4676
27246 msgid "To find a filesystem from the label, use L</findfs-label>."
27250 #: ../fish/guestfish-actions.pod:4678
27255 #: ../fish/guestfish-actions.pod:4680
27258 " vfs-type device\n"
27263 #: ../fish/guestfish-actions.pod:4690
27268 #: ../fish/guestfish-actions.pod:4692
27271 " vfs-uuid device\n"
27276 #: ../fish/guestfish-actions.pod:4699
27277 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
27281 #: ../fish/guestfish-actions.pod:4701
27282 msgid "vg-activate"
27286 #: ../fish/guestfish-actions.pod:4703
27289 " vg-activate true|false 'volgroups ...'\n"
27294 #: ../fish/guestfish-actions.pod:4716
27295 msgid "vg-activate-all"
27299 #: ../fish/guestfish-actions.pod:4718
27302 " vg-activate-all true|false\n"
27307 #: ../fish/guestfish-actions.pod:4728
27312 #: ../fish/guestfish-actions.pod:4730
27315 " vgcreate volgroup 'physvols ...'\n"
27320 #: ../fish/guestfish-actions.pod:4735
27325 #: ../fish/guestfish-actions.pod:4737
27328 " vglvuuids vgname\n"
27333 #: ../fish/guestfish-actions.pod:4742
27335 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
27336 "logical volumes and volume groups."
27340 #: ../fish/guestfish-actions.pod:4745
27341 msgid "See also L</vgpvuuids>."
27345 #: ../fish/guestfish-actions.pod:4747
27350 #: ../fish/guestfish-actions.pod:4749
27353 " vgpvuuids vgname\n"
27358 #: ../fish/guestfish-actions.pod:4754
27360 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27361 "physical volumes and volume groups."
27365 #: ../fish/guestfish-actions.pod:4757
27366 msgid "See also L</vglvuuids>."
27370 #: ../fish/guestfish-actions.pod:4759
27375 #: ../fish/guestfish-actions.pod:4761
27378 " vgremove vgname\n"
27383 #: ../fish/guestfish-actions.pod:4768
27388 #: ../fish/guestfish-actions.pod:4770
27391 " vgrename volgroup newvolgroup\n"
27396 #: ../fish/guestfish-actions.pod:4774
27401 #: ../fish/guestfish-actions.pod:4776
27409 #: ../fish/guestfish-actions.pod:4784
27410 msgid "See also L</vgs-full>."
27414 #: ../fish/guestfish-actions.pod:4786
27419 #: ../fish/guestfish-actions.pod:4788
27427 #: ../fish/guestfish-actions.pod:4793
27432 #: ../fish/guestfish-actions.pod:4795
27440 #: ../fish/guestfish-actions.pod:4800
27445 #: ../fish/guestfish-actions.pod:4802
27453 #: ../fish/guestfish-actions.pod:4806
27458 #: ../fish/guestfish-actions.pod:4808
27466 #: ../fish/guestfish-actions.pod:4813
27471 #: ../fish/guestfish-actions.pod:4815
27479 #: ../fish/guestfish-actions.pod:4820
27484 #: ../fish/guestfish-actions.pod:4822
27492 #: ../fish/guestfish-actions.pod:4827
27497 #: ../fish/guestfish-actions.pod:4829
27500 " write path content\n"
27505 #: ../fish/guestfish-actions.pod:4837
27510 #: ../fish/guestfish-actions.pod:4839
27513 " write-file path content size\n"
27518 #: ../fish/guestfish-actions.pod:4862
27523 #: ../fish/guestfish-actions.pod:4864
27526 " zegrep regex path\n"
27531 #: ../fish/guestfish-actions.pod:4872
27536 #: ../fish/guestfish-actions.pod:4874
27539 " zegrepi regex path\n"
27544 #: ../fish/guestfish-actions.pod:4882
27549 #: ../fish/guestfish-actions.pod:4884
27557 #: ../fish/guestfish-actions.pod:4892
27558 msgid "See also: L</zero-device>, L</scrub-device>."
27562 #: ../fish/guestfish-actions.pod:4894
27563 msgid "zero-device"
27567 #: ../fish/guestfish-actions.pod:4896
27570 " zero-device device\n"
27575 #: ../fish/guestfish-actions.pod:4898
27577 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27578 "which just zeroes the first few blocks of a device."
27582 #: ../fish/guestfish-actions.pod:4905
27587 #: ../fish/guestfish-actions.pod:4907
27590 " zerofree device\n"
27595 #: ../fish/guestfish-actions.pod:4920
27600 #: ../fish/guestfish-actions.pod:4922
27603 " zfgrep pattern path\n"
27608 #: ../fish/guestfish-actions.pod:4930
27613 #: ../fish/guestfish-actions.pod:4932
27616 " zfgrepi pattern path\n"
27621 #: ../fish/guestfish-actions.pod:4940
27626 #: ../fish/guestfish-actions.pod:4942
27629 " zfile meth path\n"
27634 #: ../fish/guestfish-actions.pod:4949
27636 "Since 1.0.63, use L</file> instead which can now process compressed files."
27640 #: ../fish/guestfish-actions.pod:4959
27645 #: ../fish/guestfish-actions.pod:4961
27648 " zgrep regex path\n"
27653 #: ../fish/guestfish-actions.pod:4969
27658 #: ../fish/guestfish-actions.pod:4971
27661 " zgrepi regex path\n"
27666 #: ../fish/guestfish-commands.pod:1
27671 #: ../fish/guestfish-commands.pod:3
27676 #: ../fish/guestfish-commands.pod:5
27679 " alloc filename size\n"
27684 #: ../fish/guestfish-commands.pod:7
27686 "This creates an empty (zeroed) file of the given size, and then adds so it "
27687 "can be further examined."
27691 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
27692 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
27696 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
27697 msgid "Size can be specified using standard suffixes, eg. C<1M>."
27701 #: ../fish/guestfish-commands.pod:14
27703 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
27704 "image, see L</PREPARED DISK IMAGES>."
27708 #: ../fish/guestfish-commands.pod:17
27713 #: ../fish/guestfish-commands.pod:19
27716 " copy-in local [local ...] /remotedir\n"
27721 #: ../fish/guestfish-commands.pod:21
27723 "C<copy-in> copies local files or directories recursively into the disk "
27724 "image, placing them in the directory called C</remotedir> (which must "
27725 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
27726 "other commands as necessary."
27730 #: ../fish/guestfish-commands.pod:26
27732 "Multiple local files and directories can be specified, but the last "
27733 "parameter must always be a remote directory. Wildcards cannot be used."
27737 #: ../fish/guestfish-commands.pod:30
27742 #: ../fish/guestfish-commands.pod:32
27745 " copy-out remote [remote ...] localdir\n"
27750 #: ../fish/guestfish-commands.pod:34
27752 "C<copy-out> copies remote files or directories recursively out of the disk "
27753 "image, placing them on the host disk in a local directory called C<localdir> "
27754 "(which must exist). This guestfish meta-command turns into a sequence of L</"
27755 "download>, L</tar-out> and other commands as necessary."
27759 #: ../fish/guestfish-commands.pod:40
27761 "Multiple remote files and directories can be specified, but the last "
27762 "parameter must always be a local directory. To download to the current "
27763 "directory, use C<.> as in:"
27767 #: ../fish/guestfish-commands.pod:44
27770 " copy-out /home .\n"
27775 #: ../fish/guestfish-commands.pod:46
27777 "Wildcards cannot be used in the ordinary command, but you can use them with "
27778 "the help of L</glob> like this:"
27782 #: ../fish/guestfish-commands.pod:49
27785 " glob copy-out /home/* .\n"
27790 #: ../fish/guestfish-commands.pod:51
27795 #: ../fish/guestfish-commands.pod:53
27798 " echo [params ...]\n"
27803 #: ../fish/guestfish-commands.pod:55
27804 msgid "This echos the parameters to the terminal."
27808 #: ../fish/guestfish-commands.pod:57
27813 #: ../fish/guestfish-commands.pod:59
27818 #: ../fish/guestfish-commands.pod:61
27823 #: ../fish/guestfish-commands.pod:63
27831 #: ../fish/guestfish-commands.pod:65
27833 "This is used to edit a file. It downloads the file, edits it locally using "
27834 "your editor, then uploads the result."
27838 #: ../fish/guestfish-commands.pod:68
27840 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
27841 "or C<emacs> you will get those corresponding editors."
27845 #: ../fish/guestfish-commands.pod:72
27850 #: ../fish/guestfish-commands.pod:74
27853 " glob command args...\n"
27858 #: ../fish/guestfish-commands.pod:76
27860 "Expand wildcards in any paths in the args list, and run C<command> "
27861 "repeatedly on each matching path."
27865 #: ../fish/guestfish-commands.pod:79
27866 msgid "See L</WILDCARDS AND GLOBBING>."
27870 #: ../fish/guestfish-commands.pod:81
27875 #: ../fish/guestfish-commands.pod:83
27878 " hexedit <filename|device>\n"
27879 " hexedit <filename|device> <max>\n"
27880 " hexedit <filename|device> <start> <max>\n"
27885 #: ../fish/guestfish-commands.pod:87
27887 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
27892 #: ../fish/guestfish-commands.pod:90
27894 "This command works by downloading potentially the whole file or device, "
27895 "editing it locally, then uploading it. If the file or device is large, you "
27896 "have to specify which part you wish to edit by using C<max> and/or C<start> "
27897 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
27898 "usual modifiers allowed such as C<1M> (1 megabyte)."
27902 #: ../fish/guestfish-commands.pod:97
27903 msgid "For example to edit the first few sectors of a disk you might do:"
27907 #: ../fish/guestfish-commands.pod:100
27910 " hexedit /dev/sda 1M\n"
27915 #: ../fish/guestfish-commands.pod:102
27917 "which would allow you to edit anywhere within the first megabyte of the disk."
27921 #: ../fish/guestfish-commands.pod:105
27922 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
27926 #: ../fish/guestfish-commands.pod:107
27929 " hexedit /dev/sda1 0x400 0x400\n"
27934 #: ../fish/guestfish-commands.pod:109
27935 msgid "(assuming the superblock is in the standard location)."
27939 #: ../fish/guestfish-commands.pod:111
27941 "This command requires the external L<hexedit(1)> program. You can specify "
27942 "another program to use by setting the C<HEXEDITOR> environment variable."
27946 #: ../fish/guestfish-commands.pod:115
27947 msgid "See also L</hexdump>."
27951 #: ../fish/guestfish-commands.pod:117
27956 #: ../fish/guestfish-commands.pod:119
27964 #: ../fish/guestfish-commands.pod:121
27966 "Change the local directory, ie. the current directory of guestfish itself."
27970 #: ../fish/guestfish-commands.pod:124
27971 msgid "Note that C<!cd> won't do what you might expect."
27975 #: ../fish/guestfish-commands.pod:126
27980 #: ../fish/guestfish-commands.pod:128
27985 #: ../fish/guestfish-commands.pod:130
27993 #: ../fish/guestfish-commands.pod:132
27994 msgid "Opens the manual page for guestfish."
27998 #: ../fish/guestfish-commands.pod:134
28003 #: ../fish/guestfish-commands.pod:136
28008 #: ../fish/guestfish-commands.pod:138
28016 #: ../fish/guestfish-commands.pod:140
28024 #: ../fish/guestfish-commands.pod:142
28025 msgid "This is used to view a file."
28029 #: ../fish/guestfish-commands.pod:144
28031 "The default viewer is C<$PAGER>. However if you use the alternate command "
28032 "C<less> you will get the C<less> command specifically."
28036 #: ../fish/guestfish-commands.pod:147
28041 #: ../fish/guestfish-commands.pod:149
28049 #: ../fish/guestfish-commands.pod:151
28051 "Close and reopen the libguestfs handle. It is not necessary to use this "
28052 "normally, because the handle is closed properly when guestfish exits. "
28053 "However this is occasionally useful for testing."
28057 #: ../fish/guestfish-commands.pod:155
28062 #: ../fish/guestfish-commands.pod:157
28065 " sparse filename size\n"
28070 #: ../fish/guestfish-commands.pod:159
28072 "This creates an empty sparse file of the given size, and then adds so it can "
28073 "be further examined."
28077 #: ../fish/guestfish-commands.pod:162
28079 "In all respects it works the same as the L</alloc> command, except that the "
28080 "image file is allocated sparsely, which means that disk blocks are not "
28081 "assigned to the file until they are needed. Sparse disk files only use "
28082 "space when written to, but they are slower and there is a danger you could "
28083 "run out of real disk space during a write operation."
28087 #: ../fish/guestfish-commands.pod:172
28092 #: ../fish/guestfish-commands.pod:174
28100 #: ../fish/guestfish-commands.pod:176
28102 "This command returns a list of the optional groups known to the daemon, and "
28103 "indicates which ones are supported by this build of the libguestfs appliance."
28107 #: ../fish/guestfish-commands.pod:180
28108 msgid "See also L<guestfs(3)/AVAILABILITY>."
28112 #: ../fish/guestfish-commands.pod:182
28117 #: ../fish/guestfish-commands.pod:184
28120 " time command args...\n"
28125 #: ../fish/guestfish-commands.pod:186
28127 "Run the command as usual, but print the elapsed time afterwards. This can "
28128 "be useful for benchmarking operations."
28132 #: ../test-tool/libguestfs-test-tool.pod:5
28133 msgid "libguestfs-test-tool - End user tests for libguestfs"
28137 #: ../test-tool/libguestfs-test-tool.pod:9
28140 " libguestfs-test-tool [--options]\n"
28145 #: ../test-tool/libguestfs-test-tool.pod:13
28147 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
28148 "and developers, to allow them to check basic libguestfs functionality is "
28149 "working. This is needed because libguestfs occasionally breaks for reasons "
28150 "beyond our control: usually because of changes in the underlying qemu or "
28151 "kernel packages, or the host environment."
28155 #: ../test-tool/libguestfs-test-tool.pod:20
28156 msgid "If you suspect a problem in libguestfs, then just run:"
28160 #: ../test-tool/libguestfs-test-tool.pod:22
28163 " libguestfs-test-tool\n"
28168 #: ../test-tool/libguestfs-test-tool.pod:24
28169 msgid "It will print lots of diagnostic messages."
28173 #: ../test-tool/libguestfs-test-tool.pod:26
28174 msgid "If it runs to completion successfully, you will see this near the end:"
28178 #: ../test-tool/libguestfs-test-tool.pod:28
28181 " ===== TEST FINISHED OK =====\n"
28186 #: ../test-tool/libguestfs-test-tool.pod:30
28187 msgid "and the test tool will exit with code 0."
28191 #: ../test-tool/libguestfs-test-tool.pod:32
28193 "If it fails (and/or exits with non-zero error code), please paste the "
28194 "B<complete, unedited> output of the test tool into a bug report. More "
28195 "information about reporting bugs can be found on the L<http://libguestfs.org/"
28200 #: ../test-tool/libguestfs-test-tool.pod:41
28205 #: ../test-tool/libguestfs-test-tool.pod:43
28206 msgid "Display short usage information and exit."
28210 #: ../test-tool/libguestfs-test-tool.pod:45
28211 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
28215 #: ../test-tool/libguestfs-test-tool.pod:47
28217 "Pass an alternate name for the helper program. libguestfs-test-tool will "
28218 "normally look in the C<$libexec> directory that was configured when the tool "
28223 #: ../test-tool/libguestfs-test-tool.pod:51
28224 msgid "I<--qemu qemu_binary>"
28228 #: ../test-tool/libguestfs-test-tool.pod:53
28230 "If you have downloaded another qemu binary, point this option at the full "
28231 "path of the binary to try it."
28235 #: ../test-tool/libguestfs-test-tool.pod:56
28236 msgid "I<--qemudir qemu_source_dir>"
28240 #: ../test-tool/libguestfs-test-tool.pod:58
28242 "If you have compiled qemu from source, point this option at the source "
28243 "directory to try it."
28247 #: ../test-tool/libguestfs-test-tool.pod:61
28248 msgid "I<--timeout N>"
28252 #: ../test-tool/libguestfs-test-tool.pod:63
28254 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
28255 "does not usually need to be adjusted unless your machine is very slow."
28259 #: ../test-tool/libguestfs-test-tool.pod:69
28260 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
28264 #: ../test-tool/libguestfs-test-tool.pod:71
28266 "If you have compiled another version of qemu from source and would like to "
28267 "try that, then you can use the I<--qemudir> option to point to the qemu "
28268 "source directory."
28272 #: ../test-tool/libguestfs-test-tool.pod:75
28274 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
28275 "option to point to the binary."
28279 #: ../test-tool/libguestfs-test-tool.pod:78
28281 "When using an alternate qemu with libguestfs, usually you would need to "
28282 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
28283 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
28284 "use either of the I<--qemudir> or I<--qemu> options."
28288 #: ../test-tool/libguestfs-test-tool.pod:85
28290 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
28291 "I<1> if there was an error."
28295 #: ../test-tool/libguestfs-test-tool.pod:92
28296 msgid "/usr/libexec/libguestfs-test-tool-helper"
28300 #: ../test-tool/libguestfs-test-tool.pod:94
28302 "This helper program is run inside the appliance and provides additional "
28307 #: ../test-tool/libguestfs-test-tool.pod:97
28308 msgid "/usr/bin/mkisofs"
28312 #: ../test-tool/libguestfs-test-tool.pod:99
28314 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
28315 "which is used as part of the tests."
28319 #: ../test-tool/libguestfs-test-tool.pod:106
28321 "For the full list of environment variables which may affect libguestfs, "
28322 "please see the L<guestfs(3)> manual page."
28326 #: ../test-tool/libguestfs-test-tool.pod:111
28327 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
28331 #: ../test-tool/libguestfs-test-tool.pod:121
28332 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
28336 #: ../fuse/guestmount.pod:5
28338 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
28342 #: ../fuse/guestmount.pod:9
28345 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
28350 #: ../fuse/guestmount.pod:11
28353 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
28358 #: ../fuse/guestmount.pod:13
28361 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
28366 #: ../fuse/guestmount.pod:17
28368 "You must I<not> use C<guestmount> in read-write mode on live virtual "
28369 "machines. If you do this, you risk disk corruption in the VM."
28373 #: ../fuse/guestmount.pod:22
28375 "The guestmount program can be used to mount virtual machine filesystems and "
28376 "other disk images on the host. It uses libguestfs for access to the guest "
28377 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
28378 "a mountable device."
28382 #: ../fuse/guestmount.pod:27
28384 "Along with other options, you have to give at least one device (I<-a> "
28385 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
28386 "option) or use the I<-i> inspection option. How this works is better "
28387 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
28392 #: ../fuse/guestmount.pod:33
28394 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
28395 "by you, and the filesystem will not be visible to any other users unless you "
28396 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
28397 "the filesystem, use the C<fusermount -u> command."
28401 #: ../fuse/guestmount.pod:41
28403 "For a typical Windows guest which has its main filesystem on the first "
28408 #: ../fuse/guestmount.pod:44
28411 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
28416 #: ../fuse/guestmount.pod:46
28418 "For a typical Linux guest which has a /boot filesystem on the first "
28419 "partition, and the root filesystem on a logical volume:"
28423 #: ../fuse/guestmount.pod:49
28426 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
28431 #: ../fuse/guestmount.pod:51
28432 msgid "To get libguestfs to detect guest mountpoints for you:"
28436 #: ../fuse/guestmount.pod:53
28439 " guestmount -a guest.img -i --ro /mnt\n"
28444 #: ../fuse/guestmount.pod:55
28445 msgid "For a libvirt guest called \"Guest\" you could do:"
28449 #: ../fuse/guestmount.pod:57
28452 " guestmount -d Guest -i --ro /mnt\n"
28457 #: ../fuse/guestmount.pod:59
28459 "If you don't know what filesystems are contained in a guest or disk image, "
28460 "use L<virt-filesystems(1)> first:"
28464 #: ../fuse/guestmount.pod:62
28467 " virt-filesystems MyGuest\n"
28472 #: ../fuse/guestmount.pod:64
28474 "If you want to trace the libguestfs calls but without excessive debugging "
28475 "information, we recommend:"
28479 #: ../fuse/guestmount.pod:67
28482 " guestmount [...] --trace /mnt\n"
28487 #: ../fuse/guestmount.pod:69
28488 msgid "If you want to debug the program, we recommend:"
28492 #: ../fuse/guestmount.pod:71
28495 " guestmount [...] --trace --verbose /mnt\n"
28500 #: ../fuse/guestmount.pod:77
28501 msgid "B<-a image> | B<--add image>"
28505 #: ../fuse/guestmount.pod:79
28506 msgid "Add a block device or virtual machine image."
28510 #: ../fuse/guestmount.pod:84
28511 msgid "B<-c URI> | B<--connect URI>"
28515 #: ../fuse/guestmount.pod:90
28516 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28520 #: ../fuse/guestmount.pod:96
28521 msgid "B<--dir-cache-timeout N>"
28525 #: ../fuse/guestmount.pod:98
28527 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28528 "seconds. The readdir cache [actually, there are several semi-independent "
28529 "caches] is populated after a readdir(2) call with the stat and extended "
28530 "attributes of the files in the directory, in anticipation that they will be "
28531 "requested soon after."
28535 #: ../fuse/guestmount.pod:104
28537 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28538 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28539 "requests, only cache existing ones."
28543 #: ../fuse/guestmount.pod:115
28544 msgid "B<--format=raw|qcow2|..> | B<--format>"
28548 #: ../fuse/guestmount.pod:122
28550 "If you have untrusted raw-format guest disk images, you should use this "
28551 "option to specify the disk format. This avoids a possible security problem "
28552 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
28553 "guestfs_add_drive_opts>."
28557 #: ../fuse/guestmount.pod:127
28558 msgid "B<--fuse-help>"
28562 #: ../fuse/guestmount.pod:129
28563 msgid "Display help on special FUSE options (see I<-o> below)."
28567 #: ../fuse/guestmount.pod:133
28568 msgid "Display brief help and exit."
28572 #: ../fuse/guestmount.pod:135
28573 msgid "B<-i> | B<--inspector>"
28577 #: ../fuse/guestmount.pod:155
28579 "Mount the named partition or logical volume on the given mountpoint B<in the "
28580 "guest> (this has nothing to do with mountpoints in the host)."
28584 #: ../fuse/guestmount.pod:158
28586 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
28587 "something on C</>."
28591 #: ../fuse/guestmount.pod:171
28592 msgid "B<-n> | B<--no-sync>"
28596 #: ../fuse/guestmount.pod:173
28598 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
28599 "unmounted. If you specify this option, then we don't attempt to sync the "
28600 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
28604 #: ../fuse/guestmount.pod:178
28605 msgid "B<-o option> | B<--option option>"
28609 #: ../fuse/guestmount.pod:180
28610 msgid "Pass extra options to FUSE."
28614 #: ../fuse/guestmount.pod:182
28616 "To get a list of all the extra options supported by FUSE, use the command "
28617 "below. Note that only the FUSE I<-o> options can be passed, and only some "
28618 "of them are a good idea."
28622 #: ../fuse/guestmount.pod:186
28625 " guestmount --fuse-help\n"
28630 #: ../fuse/guestmount.pod:188
28631 msgid "Some potentially useful FUSE options:"
28635 #: ../fuse/guestmount.pod:192
28636 msgid "B<-o allow_other>"
28640 #: ../fuse/guestmount.pod:194
28641 msgid "Allow other users to see the filesystem."
28645 #: ../fuse/guestmount.pod:196
28646 msgid "B<-o attr_timeout=N>"
28650 #: ../fuse/guestmount.pod:198
28651 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
28655 #: ../fuse/guestmount.pod:200
28656 msgid "B<-o kernel_cache>"
28660 #: ../fuse/guestmount.pod:202
28662 "Allow the kernel to cache files (reduces the number of reads that have to go "
28663 "through the L<guestfs(3)> API). This is generally a good idea if you can "
28664 "afford the extra memory usage."
28668 #: ../fuse/guestmount.pod:206
28669 msgid "B<-o uid=N> B<-o gid=N>"
28673 #: ../fuse/guestmount.pod:208
28675 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
28676 "the chosen values."
28680 #: ../fuse/guestmount.pod:213
28681 msgid "B<-r> | B<--ro>"
28685 #: ../fuse/guestmount.pod:215
28687 "Add devices and mount everything read-only. Also disallow writes and make "
28688 "the disk appear read-only to FUSE."
28692 #: ../fuse/guestmount.pod:218
28694 "This is highly recommended if you are not going to edit the guest disk. If "
28695 "the guest is running and this option is I<not> supplied, then there is a "
28696 "strong risk of disk corruption in the guest. We try to prevent this from "
28697 "happening, but it is not always possible."
28701 #: ../fuse/guestmount.pod:223
28702 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28706 #: ../fuse/guestmount.pod:227
28707 msgid "Enable SELinux support for the guest."
28711 #: ../fuse/guestmount.pod:229
28712 msgid "B<-v> | B<--verbose>"
28716 #: ../fuse/guestmount.pod:231
28717 msgid "Enable verbose messages from underlying libguestfs."
28721 #: ../fuse/guestmount.pod:233
28722 msgid "B<-V> | B<--version>"
28726 #: ../fuse/guestmount.pod:235
28727 msgid "Display the program version and exit."
28731 #: ../fuse/guestmount.pod:237
28732 msgid "B<-w> | B<--rw>"
28736 #: ../fuse/guestmount.pod:242 ../fuse/guestmount.pod:263
28737 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28741 #: ../fuse/guestmount.pod:244
28742 msgid "B<-x> | B<--trace>"
28746 #: ../fuse/guestmount.pod:246
28747 msgid "Trace libguestfs calls and entry into each FUSE function."
28751 #: ../fuse/guestmount.pod:248
28752 msgid "This also stops the daemon from forking into the background."
28756 #: ../fuse/guestmount.pod:269
28758 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28759 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
28764 #: ../fuse/guestmount.pod:284
28765 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
28769 #: ../tools/virt-edit.pl:34
28770 msgid "virt-edit - Edit a file in a virtual machine"
28774 #: ../tools/virt-edit.pl:38
28777 " virt-edit [--options] domname file\n"
28782 #: ../tools/virt-edit.pl:40
28785 " virt-edit [--options] disk.img [disk.img ...] file\n"
28790 #: ../tools/virt-edit.pl:42
28793 " virt-edit [domname|disk.img] file -e 'expr'\n"
28798 #: ../tools/virt-edit.pl:46
28800 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
28801 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
28802 "doing this, but doesn't catch all cases."
28806 #: ../tools/virt-edit.pl:52
28808 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
28809 "the named virtual machine (or disk image)."
28813 #: ../tools/virt-edit.pl:55
28814 msgid "If you want to just view a file, use L<virt-cat(1)>."
28818 #: ../tools/virt-edit.pl:57
28820 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
28821 "USING GUESTFISH> below)."
28825 #: ../tools/virt-edit.pl:60
28827 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
28828 "files. L<guestfish(1)> can do that and much more."
28832 #: ../tools/virt-edit.pl:65
28833 msgid "Edit the named files interactively:"
28837 #: ../tools/virt-edit.pl:67
28840 " virt-edit mydomain /boot/grub/grub.conf\n"
28845 #: ../tools/virt-edit.pl:69
28848 " virt-edit mydomain /etc/passwd\n"
28853 #: ../tools/virt-edit.pl:71
28854 msgid "For Windows guests, some Windows paths are understood:"
28858 #: ../tools/virt-edit.pl:73
28861 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
28866 #: ../tools/virt-edit.pl:75
28868 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
28869 "below). To change the init default level to 5:"
28873 #: ../tools/virt-edit.pl:79
28876 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
28881 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106
28882 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
28883 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
28884 msgid "Display brief help."
28888 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114
28889 #: ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71
28890 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
28891 #: ../tools/virt-list-partitions.pl:72
28892 msgid "Display version number and exit."
28896 #: ../tools/virt-edit.pl:105
28897 msgid "B<--backup extension> | B<-b extension>"
28901 #: ../tools/virt-edit.pl:107
28903 "Create a backup of the original file I<in the guest disk image>. The backup "
28904 "has the original filename with C<extension> added."
28908 #: ../tools/virt-edit.pl:110
28910 "Usually the first character of C<extension> would be a dot C<.> so you would "
28915 #: ../tools/virt-edit.pl:113
28918 " virt-edit -b .orig [etc]\n"
28923 #: ../tools/virt-edit.pl:115
28924 msgid "By default, no backup file is made."
28928 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128
28929 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
28930 #: ../tools/virt-list-partitions.pl:78
28931 msgid "B<--connect URI> | B<-c URI>"
28935 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130
28936 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
28937 #: ../tools/virt-list-partitions.pl:80
28939 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
28940 "to the default libvirt hypervisor."
28944 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133
28945 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
28946 #: ../tools/virt-list-partitions.pl:83
28948 "If you specify guest block devices directly, then libvirt is not used at all."
28952 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140
28953 #: ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89
28954 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
28955 msgid "B<--format> raw"
28959 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142
28960 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
28961 #: ../tools/virt-list-partitions.pl:92
28963 "Specify the format of disk images given on the command line. If this is "
28964 "omitted then the format is autodetected from the content of the disk image."
28968 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146
28969 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
28970 #: ../tools/virt-list-partitions.pl:96
28972 "If disk images are requested from libvirt, then this program asks libvirt "
28973 "for this information. In this case, the value of the format parameter is "
28978 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150
28979 #: ../tools/virt-resize.pl:525 ../tools/virt-resize.pl:540
28980 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
28981 #: ../tools/virt-list-partitions.pl:100
28983 "If working with untrusted raw-format guest disk images, you should ensure "
28984 "the format is always specified."
28988 #: ../tools/virt-edit.pl:150
28989 msgid "B<--expr EXPR> | B<-e EXPR>"
28993 #: ../tools/virt-edit.pl:152
28995 "Instead of launching the external editor, non-interactively apply the Perl "
28996 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
29001 #: ../tools/virt-edit.pl:156
29003 "Be careful to properly quote the expression to prevent it from being altered "
29008 #: ../tools/virt-edit.pl:280
29009 msgid "NON-INTERACTIVE EDITING"
29013 #: ../tools/virt-edit.pl:282
29015 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
29016 "administrator can interactively edit the file."
29020 #: ../tools/virt-edit.pl:285
29022 "There are two ways also to use C<virt-edit> from scripts in order to make "
29023 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
29024 "like this, it's less error-prone to write scripts directly using the "
29025 "libguestfs API and Augeas for configuration file editing.)"
29029 #: ../tools/virt-edit.pl:291
29031 "The first method is to temporarily set C<$EDITOR> to any script or program "
29032 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
29033 "update C<tmpfile> in place however it likes."
29037 #: ../tools/virt-edit.pl:295
29039 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
29040 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
29041 "instances of C<foo> with C<bar> in a file:"
29045 #: ../tools/virt-edit.pl:299
29048 " virt-edit domname filename -e 's/foo/bar/'\n"
29053 #: ../tools/virt-edit.pl:301
29055 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
29056 "For example to delete root's password you could do:"
29060 #: ../tools/virt-edit.pl:304
29063 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
29068 #: ../tools/virt-edit.pl:306
29070 "What really happens is that the snippet is evaluated as a Perl expression "
29071 "for each line of the file. The line, including the final C<\\n>, is passed "
29072 "in C<$_> and the expression should update C<$_> or leave it unchanged."
29076 #: ../tools/virt-edit.pl:311
29078 "To delete a line, set C<$_> to the empty string. For example, to delete the "
29079 "C<apache> user account from the password file you can do:"
29083 #: ../tools/virt-edit.pl:314
29086 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
29091 #: ../tools/virt-edit.pl:316
29093 "To insert a line, prepend or append it to C<$_>. However appending lines to "
29094 "the end of the file is rather difficult this way since there is no concept "
29095 "of \"last line of the file\" - your expression just doesn't get called "
29096 "again. You might want to use the first method (setting C<$EDITOR>) if you "
29101 #: ../tools/virt-edit.pl:322
29103 "The variable C<$lineno> contains the current line number. As is "
29104 "traditional, the first line in the file is number C<1>."
29108 #: ../tools/virt-edit.pl:325
29110 "The return value from the expression is ignored, but the expression may call "
29111 "C<die> in order to abort the whole program, leaving the original file "
29116 #: ../tools/virt-edit.pl:329
29118 "Remember when matching the end of a line that C<$_> may contain the final C<"
29119 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
29120 "newline then neither of these. Thus to match or substitute some text at the "
29121 "end of a line, use this regular expression:"
29125 #: ../tools/virt-edit.pl:334
29128 " /some text(\\r?\\n)?$/\n"
29133 #: ../tools/virt-edit.pl:336
29135 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
29136 "$_> itself (since that would remove all newlines from the file):"
29140 #: ../tools/virt-edit.pl:340
29143 " my $m = $_; chomp $m; $m =~ /some text$/\n"
29148 #: ../tools/virt-edit.pl:344
29150 "C<virt-edit> has a limited ability to understand Windows drive letters and "
29151 "paths (eg. C<E:\\foo\\bar.txt>)."
29155 #: ../tools/virt-edit.pl:347
29156 msgid "If and only if the guest is running Windows then:"
29160 #: ../tools/virt-edit.pl:353
29162 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
29163 "to the correct filesystem."
29167 #: ../tools/virt-edit.pl:358
29169 "Any backslash (C<\\>) characters in the path are replaced with forward "
29170 "slashes so that libguestfs can process it."
29174 #: ../tools/virt-edit.pl:363
29176 "The path is resolved case insensitively to locate the file that should be "
29181 #: ../tools/virt-edit.pl:368
29182 msgid "There are some known shortcomings:"
29186 #: ../tools/virt-edit.pl:374
29187 msgid "Some NTFS symbolic links may not be followed correctly."
29191 #: ../tools/virt-edit.pl:378
29192 msgid "NTFS junction points that cross filesystems are not followed."
29196 #: ../tools/virt-edit.pl:435
29197 msgid "USING GUESTFISH"
29201 #: ../tools/virt-edit.pl:437
29203 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
29204 "C<virt-edit> doesn't work."
29208 #: ../tools/virt-edit.pl:440
29209 msgid "Using C<virt-edit> is approximately equivalent to doing:"
29213 #: ../tools/virt-edit.pl:442
29216 " guestfish --rw -i -d domname edit /file\n"
29221 #: ../tools/virt-edit.pl:444
29223 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
29224 "path to the file."
29228 #: ../tools/virt-edit.pl:447
29230 "The command above uses libguestfs's guest inspection feature and so does not "
29231 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
29232 "disk images that don't contain guests. To edit a file on a disk image "
29237 #: ../tools/virt-edit.pl:452
29240 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
29245 #: ../tools/virt-edit.pl:454
29247 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
29248 "the disk image to edit, and C</file> is the full path to the file."
29252 #: ../tools/virt-edit.pl:458
29254 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
29255 "C<write> or C<upload> instead:"
29259 #: ../tools/virt-edit.pl:461
29262 " guestfish --rw -i -d domname touch /newfile\n"
29267 #: ../tools/virt-edit.pl:463
29270 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
29275 #: ../tools/virt-edit.pl:465
29278 " guestfish --rw -i -d domname upload localfile /newfile\n"
29283 #: ../tools/virt-edit.pl:467
29285 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
29289 #: ../tools/virt-edit.pl:470
29292 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
29297 #: ../tools/virt-edit.pl:480
29302 #: ../tools/virt-edit.pl:482
29304 "If set, this string is used as the editor. It may contain arguments, eg. C<"
29309 #: ../tools/virt-edit.pl:485
29310 msgid "If not set, C<vi> is used."
29314 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559
29315 #: ../tools/virt-resize.pl:1482 ../tools/virt-list-filesystems.pl:182
29316 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
29317 #: ../tools/virt-list-partitions.pl:250
29318 msgid "SHELL QUOTING"
29322 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567
29323 #: ../tools/virt-resize.pl:1484 ../tools/virt-list-filesystems.pl:184
29324 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
29325 #: ../tools/virt-list-partitions.pl:252
29327 "Libvirt guest names can contain arbitrary characters, some of which have "
29328 "meaning to the shell such as C<#> and space. You may need to quote or "
29329 "escape these characters on the command line. See the shell manual page L<sh"
29330 "(1)> for details."
29334 #: ../tools/virt-edit.pl:498
29336 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
29337 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
29338 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
29342 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598
29343 #: ../tools/virt-resize.pl:1510 ../tools/virt-list-filesystems.pl:202
29344 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
29345 #: ../tools/virt-list-partitions.pl:269
29350 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600
29351 #: ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:204
29352 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
29353 #: ../tools/virt-list-partitions.pl:271
29354 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
29358 #: ../tools/virt-edit.pl:516
29359 msgid "Copyright (C) 2009-2011 Red Hat Inc."
29363 #: ../tools/virt-win-reg.pl:37
29365 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
29369 #: ../tools/virt-win-reg.pl:41
29372 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
29377 #: ../tools/virt-win-reg.pl:43
29380 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
29385 #: ../tools/virt-win-reg.pl:45
29388 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
29393 #: ../tools/virt-win-reg.pl:47
29396 " virt-win-reg --merge domname [input.reg ...]\n"
29401 #: ../tools/virt-win-reg.pl:49
29404 " virt-win-reg [--options] disk.img ... # instead of domname\n"
29409 #: ../tools/virt-win-reg.pl:53
29411 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
29412 "virtual machines. If you do this, you I<will> get irreversible disk "
29413 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
29414 "but doesn't catch all cases."
29418 #: ../tools/virt-win-reg.pl:58
29420 "Modifying the Windows Registry is an inherently risky operation. The format "
29421 "is deliberately obscure and undocumented, and Registry changes can leave the "
29422 "system unbootable. Therefore when using the C<--merge> option, make sure "
29423 "you have a reliable backup first."
29427 #: ../tools/virt-win-reg.pl:65
29429 "This program can export and merge Windows Registry entries from a Windows "
29434 #: ../tools/virt-win-reg.pl:68
29436 "The first parameter is the libvirt guest name or the raw disk image of a "
29441 #: ../tools/virt-win-reg.pl:71
29443 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
29444 "exported (recursively). For example:"
29448 #: ../tools/virt-win-reg.pl:74
29451 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29456 #: ../tools/virt-win-reg.pl:76
29458 "You can also display single values from within registry keys, for example:"
29462 #: ../tools/virt-win-reg.pl:79
29465 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29466 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29467 " Windows 7 Enterprise\n"
29472 #: ../tools/virt-win-reg.pl:83
29474 "With C<--merge>, you can merge a textual regedit file into the Windows "
29479 #: ../tools/virt-win-reg.pl:86
29482 " $ virt-win-reg --merge Windows7 changes.reg\n"
29487 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29492 #: ../tools/virt-win-reg.pl:90
29494 "This program is only meant for simple access to the registry. If you want "
29495 "to do complicated things with the registry, we suggest you download the "
29496 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29497 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29498 "L<hivexregedit(1)>."
29502 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29507 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
29508 msgid "Enable debugging messages."
29512 #: ../tools/virt-win-reg.pl:157
29517 #: ../tools/virt-win-reg.pl:159
29519 "In merge mode, this merges a textual regedit file into the Windows Registry "
29520 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29521 "displays or exports Registry entries instead."
29525 #: ../tools/virt-win-reg.pl:163
29527 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
29528 "result in disk corruption. However exporting (without this flag) is always "
29533 #: ../tools/virt-win-reg.pl:171
29534 msgid "B<--encoding> UTF-16LE|ASCII"
29538 #: ../tools/virt-win-reg.pl:173
29540 "When merging (only), you may need to specify the encoding for strings to be "
29541 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
29542 "(3)/ENCODING STRINGS>."
29546 #: ../tools/virt-win-reg.pl:177
29548 "The default is to use UTF-16LE, which should work with recent versions of "
29553 #: ../tools/virt-win-reg.pl:402
29554 msgid "SUPPORTED SYSTEMS"
29558 #: ../tools/virt-win-reg.pl:404
29560 "The program currently supports Windows NT-derived guests starting with "
29561 "Windows XP through to at least Windows 7."
29565 #: ../tools/virt-win-reg.pl:407
29567 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
29568 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
29569 "and C<HKEY_USERS\\.DEFAULT>."
29573 #: ../tools/virt-win-reg.pl:411
29575 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29580 #: ../tools/virt-win-reg.pl:414
29582 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
29587 #: ../tools/virt-win-reg.pl:417
29592 #: ../tools/virt-win-reg.pl:419
29594 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29595 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
29596 "style line endings. Since Windows regedit files are often in UTF-16LE with "
29597 "Windows-style line endings, you may need to reencode the whole file before "
29598 "or after processing."
29602 #: ../tools/virt-win-reg.pl:425
29604 "To reencode a file from Windows format to Linux (before processing it with "
29605 "the C<--merge> option), you would do something like this:"
29609 #: ../tools/virt-win-reg.pl:428
29612 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29617 #: ../tools/virt-win-reg.pl:430
29619 "To go in the opposite direction, after exporting and before sending the file "
29620 "to a Windows user, do something like this:"
29624 #: ../tools/virt-win-reg.pl:433
29627 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29632 #: ../tools/virt-win-reg.pl:435
29633 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29637 #: ../tools/virt-win-reg.pl:437
29639 "If you are unsure about the current encoding, use the L<file(1)> command. "
29640 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
29641 "style (CRLF) line endings, like this:"
29645 #: ../tools/virt-win-reg.pl:441
29648 " $ file software.reg\n"
29649 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
29650 " with CRLF line terminators\n"
29655 #: ../tools/virt-win-reg.pl:445
29656 msgid "This file would need conversion before you could C<--merge> it."
29660 #: ../tools/virt-win-reg.pl:447
29661 msgid "CurrentControlSet etc."
29665 #: ../tools/virt-win-reg.pl:449
29667 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
29668 "Registry at the level of the hive file, and therefore you cannot modify "
29673 #: ../tools/virt-win-reg.pl:453
29675 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
29676 "circumstances it might refer to another control set. The way to find out is "
29677 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29681 #: ../tools/virt-win-reg.pl:457
29684 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29685 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
29686 " \"Current\"=dword:00000001\n"
29687 " \"Default\"=dword:00000001\n"
29688 " \"Failed\"=dword:00000000\n"
29689 " \"LastKnownGood\"=dword:00000002\n"
29694 #: ../tools/virt-win-reg.pl:464
29695 msgid "\"Current\" is the one which Windows will choose when it boots."
29699 #: ../tools/virt-win-reg.pl:466
29701 "Similarly, other C<Current...> keys in the path may need to be replaced."
29705 #: ../tools/virt-win-reg.pl:469
29706 msgid "WINDOWS TIPS"
29710 #: ../tools/virt-win-reg.pl:471
29712 "Note that some of these tips modify the guest disk image. The guest I<must> "
29713 "be shut off, else you will get disk corruption."
29717 #: ../tools/virt-win-reg.pl:474
29718 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
29722 #: ../tools/virt-win-reg.pl:476
29724 "Prepare a DOS batch script, VBScript or executable. Upload this using "
29725 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
29726 "is uploaded into C<C:\\>:"
29730 #: ../tools/virt-win-reg.pl:480
29733 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
29738 #: ../tools/virt-win-reg.pl:482
29739 msgid "Prepare a regedit file containing the registry change:"
29743 #: ../tools/virt-win-reg.pl:484
29746 " cat > test.reg <<'EOF'\n"
29747 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
29748 " \"Test\"=\"c:\\\\test.bat\"\n"
29754 #: ../tools/virt-win-reg.pl:489
29756 "In this example we use the key C<RunOnce> which means that the script will "
29757 "run precisely once when the first user logs in. If you want it to run every "
29758 "time a user logs in, replace C<RunOnce> with C<Run>."
29762 #: ../tools/virt-win-reg.pl:493
29763 msgid "Now update the registry:"
29767 #: ../tools/virt-win-reg.pl:495
29770 " virt-win-reg --merge WindowsGuest test.reg\n"
29775 #: ../tools/virt-win-reg.pl:497
29776 msgid "INSTALLING A SERVICE"
29780 #: ../tools/virt-win-reg.pl:499
29782 "This section assumes you are familiar with Windows services, and you either "
29783 "have a program which handles the Windows Service Control Protocol directly "
29784 "or you want to run any program using a service wrapper like SrvAny or the "
29789 #: ../tools/virt-win-reg.pl:504
29791 "First upload the program and optionally the service wrapper. In this case "
29792 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
29796 #: ../tools/virt-win-reg.pl:508
29799 " guestfish -i -d WindowsGuest <<EOF\n"
29800 " upload rhsrvany.exe /rhsrvany.exe\n"
29801 " upload test.exe /test.exe\n"
29807 #: ../tools/virt-win-reg.pl:513
29809 "Prepare a regedit file containing the registry changes. In this example, "
29810 "the first registry change is needed for the service itself or the service "
29811 "wrapper (if used). The second registry change is only needed because I am "
29812 "using the RHSrvAny service wrapper."
29816 #: ../tools/virt-win-reg.pl:518
29819 " cat > service.reg <<'EOF'\n"
29820 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
29821 " \"Type\"=dword:00000010\n"
29822 " \"Start\"=dword:00000002\n"
29823 " \"ErrorControl\"=dword:00000001\n"
29824 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
29825 " \"DisplayName\"=\"RHSrvAny\"\n"
29826 " \"ObjectName\"=\"NetworkService\"\n"
29831 #: ../tools/virt-win-reg.pl:527
29834 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
29835 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
29836 " \"PWD\"=\"c:\\\\Temp\"\n"
29842 #: ../tools/virt-win-reg.pl:538
29844 "For use of C<ControlSet001> see the section above in this manual page. You "
29845 "may need to adjust this according to the control set that is in use by the "
29850 #: ../tools/virt-win-reg.pl:544
29852 "C<\"ObjectName\"> controls the privileges that the service will have. An "
29853 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
29854 "privileged account."
29858 #: ../tools/virt-win-reg.pl:550
29860 "For the meaning of the magic numbers, see this Microsoft KB article: "
29861 "L<http://support.microsoft.com/kb/103000>."
29865 #: ../tools/virt-win-reg.pl:555
29866 msgid "Update the registry:"
29870 #: ../tools/virt-win-reg.pl:557
29873 " virt-win-reg --merge WindowsGuest service.reg\n"
29878 #: ../tools/virt-win-reg.pl:561
29880 "Be careful when passing parameters containing C<\\> (backslash) in the "
29881 "shell. Usually you will have to use 'single quotes' or double backslashes "
29882 "(but not both) to protect them from the shell."
29886 #: ../tools/virt-win-reg.pl:565
29887 msgid "Paths and value names are case-insensitive."
29891 #: ../tools/virt-win-reg.pl:574
29893 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
29894 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
29895 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29899 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
29901 "When reporting bugs, please enable debugging and capture the I<complete> "
29906 #: ../tools/virt-win-reg.pl:592
29909 " export LIBGUESTFS_DEBUG=1\n"
29910 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
29915 #: ../tools/virt-win-reg.pl:595
29917 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
29922 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1516
29923 #: ../tools/virt-make-fs.pl:570
29924 msgid "Copyright (C) 2010 Red Hat Inc."
29928 #: ../tools/virt-resize.pl:42
29929 msgid "virt-resize - Resize a virtual machine disk"
29933 #: ../tools/virt-resize.pl:46
29936 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
29937 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
29938 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
29943 #: ../tools/virt-resize.pl:52
29945 "Virt-resize is a tool which can resize a virtual machine disk, making it "
29946 "larger or smaller overall, and resizing or deleting any partitions contained "
29951 #: ../tools/virt-resize.pl:56
29953 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
29954 "not> be used on live virtual machines - for consistent results, shut the "
29955 "virtual machine down before resizing it."
29959 #: ../tools/virt-resize.pl:60
29961 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
29962 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
29966 #: ../tools/virt-resize.pl:66
29968 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
29969 "fill the extra 5GB of space."
29973 #: ../tools/virt-resize.pl:69
29976 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
29977 " virt-filesystems --long -h --all -a olddisk\n"
29978 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
29979 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
29984 #: ../tools/virt-resize.pl:74
29986 "As above, but make the /boot partition 200MB bigger, while giving the "
29987 "remaining space to /dev/sda2:"
29991 #: ../tools/virt-resize.pl:77
29994 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
29999 #: ../tools/virt-resize.pl:79
30000 msgid "As above, but the output format will be uncompressed qcow2:"
30004 #: ../tools/virt-resize.pl:81
30007 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
30008 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
30013 #: ../tools/virt-resize.pl:84
30014 msgid "DETAILED USAGE"
30018 #: ../tools/virt-resize.pl:86
30019 msgid "EXPANDING A VIRTUAL MACHINE DISK"
30023 #: ../tools/virt-resize.pl:90
30024 msgid "1. Shut down the virtual machine"
30028 #: ../tools/virt-resize.pl:92
30029 msgid "2. Locate input disk image"
30033 #: ../tools/virt-resize.pl:94
30035 "Locate the input disk image (ie. the file or device on the host containing "
30036 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
30037 "dumpxml> like this to find the disk image name:"
30041 #: ../tools/virt-resize.pl:98
30044 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
30045 " Found 1 nodes:\n"
30047 " <source dev=\"/dev/vg/lv_guest\" />\n"
30052 #: ../tools/virt-resize.pl:103
30053 msgid "3. Look at current sizing"
30057 #: ../tools/virt-resize.pl:105
30058 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
30062 #: ../tools/virt-resize.pl:108
30065 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
30066 " Name Type Size Parent\n"
30067 " /dev/sda1 partition 101M /dev/sda\n"
30068 " /dev/sda2 partition 7.9G /dev/sda\n"
30069 " /dev/sda device 8.0G -\n"
30074 #: ../tools/virt-resize.pl:114
30076 "(This example is a virtual machine with an 8 GB disk which we would like to "
30077 "expand up to 10 GB)."
30081 #: ../tools/virt-resize.pl:117
30082 msgid "4. Create output disk"
30086 #: ../tools/virt-resize.pl:119
30088 "Virt-resize cannot do in-place disk modifications. You have to have space "
30089 "to store the resized output disk."
30093 #: ../tools/virt-resize.pl:122
30095 "To store the resized disk image in a file, create a file of a suitable size:"
30099 #: ../tools/virt-resize.pl:125
30102 " # rm -f outdisk\n"
30103 " # truncate -s 10G outdisk\n"
30108 #: ../tools/virt-resize.pl:128
30109 msgid "Or use L<lvcreate(1)> to create a logical volume:"
30113 #: ../tools/virt-resize.pl:130
30116 " # lvcreate -L 10G -n lv_name vg_name\n"
30121 #: ../tools/virt-resize.pl:132
30122 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
30126 #: ../tools/virt-resize.pl:134
30129 " # virsh pool-list\n"
30130 " # virsh vol-create-as poolname newvol 10G\n"
30135 #: ../tools/virt-resize.pl:137
30140 #: ../tools/virt-resize.pl:139
30142 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
30143 "file) and the output disk. The output disk is the one created in the "
30148 #: ../tools/virt-resize.pl:143
30151 " # virt-resize indisk outdisk\n"
30156 #: ../tools/virt-resize.pl:145
30158 "This command just copies disk image C<indisk> to disk image C<outdisk> "
30159 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
30160 "larger, then an extra, empty partition is created at the end of the disk "
30161 "covering the extra space. If C<outdisk> is smaller, then it will give an "
30166 #: ../tools/virt-resize.pl:151
30168 "More realistically you'd want to expand existing partitions in the disk "
30169 "image by passing extra options (for the full list see the L</OPTIONS> "
30174 #: ../tools/virt-resize.pl:155
30176 "L</--expand> is the most useful option. It expands the named partition "
30177 "within the disk to fill any extra space:"
30181 #: ../tools/virt-resize.pl:158
30184 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
30189 #: ../tools/virt-resize.pl:160
30191 "(In this case, an extra partition is I<not> created at the end of the disk, "
30192 "because there will be no unused space)."
30196 #: ../tools/virt-resize.pl:163
30198 "L</--resize> is the other commonly used option. The following would "
30199 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
30200 "rest of the available space:"
30204 #: ../tools/virt-resize.pl:167
30207 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
30208 " indisk outdisk\n"
30213 #: ../tools/virt-resize.pl:170
30215 "If the expanded partition in the image contains a filesystem or LVM PV, then "
30216 "if virt-resize knows how, it will resize the contents, the equivalent of "
30217 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
30218 ">. However virt-resize does not know how to resize some filesystems, so you "
30219 "would have to online resize them after booting the guest."
30223 #: ../tools/virt-resize.pl:177
30224 msgid "Other options are covered below."
30228 #: ../tools/virt-resize.pl:179
30233 #: ../tools/virt-resize.pl:181
30234 msgid "Thoroughly test the new disk image I<before> discarding the old one."
30238 #: ../tools/virt-resize.pl:183
30239 msgid "If you are using libvirt, edit the XML to point at the new disk:"
30243 #: ../tools/virt-resize.pl:185
30246 " # virsh edit guestname\n"
30251 #: ../tools/virt-resize.pl:187
30253 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
30254 "html#elementsDisks>"
30258 #: ../tools/virt-resize.pl:190
30259 msgid "Then start up the domain with the new, resized disk:"
30263 #: ../tools/virt-resize.pl:192
30266 " # virsh start guestname\n"
30271 #: ../tools/virt-resize.pl:194
30273 "and check that it still works. See also the L</NOTES> section below for "
30274 "additional information."
30278 #: ../tools/virt-resize.pl:197
30279 msgid "7. Resize LVs etc inside the guest"
30283 #: ../tools/virt-resize.pl:199
30284 msgid "(This can also be done offline using L<guestfish(1)>)"
30288 #: ../tools/virt-resize.pl:201
30290 "Once the guest has booted you should see the new space available, at least "
30291 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
30292 "may need to resize LVs inside PVs, and also resize filesystem types that "
30293 "virt-resize does not know how to expand."
30297 #: ../tools/virt-resize.pl:208
30298 msgid "SHRINKING A VIRTUAL MACHINE DISK"
30302 #: ../tools/virt-resize.pl:210
30304 "Shrinking is somewhat more complex than expanding, and only an overview is "
30309 #: ../tools/virt-resize.pl:213
30311 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
30312 "filesystems). The user has to shrink content before passing the disk image "
30313 "to virt-resize, and virt-resize will check that the content has been shrunk "
30318 #: ../tools/virt-resize.pl:218
30319 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
30323 #: ../tools/virt-resize.pl:220
30325 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
30326 "steps 3 and 4 above to allocate a new disk image."
30330 #: ../tools/virt-resize.pl:223
30332 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
30336 #: ../tools/virt-resize.pl:226
30337 msgid "IGNORING OR DELETING PARTITIONS"
30341 #: ../tools/virt-resize.pl:228
30343 "virt-resize also gives a convenient way to ignore or delete partitions when "
30344 "copying from the input disk to the output disk. Ignoring a partition speeds "
30345 "up the copy where you don't care about the existing contents of a "
30346 "partition. Deleting a partition removes it completely, but note that it "
30347 "also renumbers any partitions after the one which is deleted, which can "
30348 "leave some guests unbootable."
30352 #: ../tools/virt-resize.pl:235
30353 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
30357 #: ../tools/virt-resize.pl:237
30359 "If the input disk is in qcow2 format, then you may prefer that the output is "
30360 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
30361 "the fly. The output format is simply determined by the format of the empty "
30362 "output container that you provide. Thus to create qcow2 output, use:"
30366 #: ../tools/virt-resize.pl:243
30369 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
30374 #: ../tools/virt-resize.pl:245
30375 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
30379 #: ../tools/virt-resize.pl:247
30380 msgid "Similarly, to get non-sparse raw output use:"
30384 #: ../tools/virt-resize.pl:249
30387 " fallocate -l size outdisk\n"
30392 #: ../tools/virt-resize.pl:251
30394 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
30395 "dev/zero of=outdisk bs=1M count=..>)"
30399 #: ../tools/virt-resize.pl:264
30400 msgid "Display help."
30404 #: ../tools/virt-resize.pl:278
30405 msgid "B<--resize part=size>"
30409 #: ../tools/virt-resize.pl:280
30411 "Resize the named partition (expanding or shrinking it) so that it has the "
30416 #: ../tools/virt-resize.pl:283
30418 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
30419 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
30420 "Exabytes; or as a percentage of the current size; or as a relative number or "
30421 "percentage. For example:"
30425 #: ../tools/virt-resize.pl:288
30428 " --resize /dev/sda2=10G\n"
30433 #: ../tools/virt-resize.pl:290
30436 " --resize /dev/sda4=90%\n"
30441 #: ../tools/virt-resize.pl:292
30444 " --resize /dev/sda2=+1G\n"
30449 #: ../tools/virt-resize.pl:294
30452 " --resize /dev/sda2=-200M\n"
30457 #: ../tools/virt-resize.pl:296
30460 " --resize /dev/sda1=+128K\n"
30465 #: ../tools/virt-resize.pl:298
30468 " --resize /dev/sda1=+10%\n"
30473 #: ../tools/virt-resize.pl:300
30476 " --resize /dev/sda1=-10%\n"
30481 #: ../tools/virt-resize.pl:302
30483 "You can increase the size of any partition. Virt-resize will expand the "
30484 "direct content of the partition if it knows how (see C<--expand> below)."
30488 #: ../tools/virt-resize.pl:306
30490 "You can only I<decrease> the size of partitions that contain filesystems or "
30491 "PVs which have already been shrunk. Virt-resize will check this has been "
30492 "done before proceeding, or else will print an error (see also C<--resize-"
30497 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403
30498 #: ../tools/virt-resize.pl:420
30499 msgid "You can give this option multiple times."
30503 #: ../tools/virt-resize.pl:317
30504 msgid "B<--resize-force part=size>"
30508 #: ../tools/virt-resize.pl:319
30510 "This is the same as C<--resize> except that it will let you decrease the "
30511 "size of any partition. Generally this means you will lose any data which "
30512 "was at the end of the partition you shrink, but you may not care about that "
30513 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
30514 "as a swap partition)."
30518 #: ../tools/virt-resize.pl:325
30519 msgid "See also the C<--ignore> option."
30523 #: ../tools/virt-resize.pl:331
30524 msgid "B<--expand part>"
30528 #: ../tools/virt-resize.pl:333
30530 "Expand the named partition so it uses up all extra space (space left over "
30531 "after any other resize changes that you request have been done)."
30535 #: ../tools/virt-resize.pl:336
30537 "If virt-resize knows how, it will expand the direct content of the "
30538 "partition. For example, if the partition is an LVM PV, it will expand the "
30539 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
30540 "content it doesn't know about alone."
30544 #: ../tools/virt-resize.pl:341
30545 msgid "Currently virt-resize can resize:"
30549 #: ../tools/virt-resize.pl:347
30551 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
30556 #: ../tools/virt-resize.pl:352
30558 "NTFS filesystems contained directly in a partition, if libguestfs was "
30559 "compiled with support for NTFS."
30563 #: ../tools/virt-resize.pl:355
30565 "The filesystem must have been shut down consistently last time it was used. "
30566 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
30567 "consistency check, so at the first boot after resizing Windows will check "
30572 #: ../tools/virt-resize.pl:362
30574 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
30575 "inside the PV, but see the C<--LV-expand> option. The user could also "
30576 "resize LVs as desired after boot."
30580 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
30581 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
30585 #: ../tools/virt-resize.pl:374
30586 msgid "B<--shrink part>"
30590 #: ../tools/virt-resize.pl:376
30592 "Shrink the named partition until the overall disk image fits in the "
30593 "destination. The named partition B<must> contain a filesystem or PV which "
30594 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
30595 "online tools). Virt-resize will check this and give an error if it has not "
30600 #: ../tools/virt-resize.pl:382
30602 "The amount by which the overall disk must be shrunk (after carrying out all "
30603 "other operations requested by the user) is called the \"deficit\". For "
30604 "example, a straight copy (assume no other operations) from a 5GB disk image "
30605 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
30606 "would give an error unless the user specified a partition to shrink and that "
30607 "partition had more than a gigabyte of free space."
30611 #: ../tools/virt-resize.pl:396
30612 msgid "B<--ignore part>"
30616 #: ../tools/virt-resize.pl:398
30618 "Ignore the named partition. Effectively this means the partition is "
30619 "allocated on the destination disk, but the content is not copied across from "
30620 "the source disk. The content of the partition will be blank (all zero "
30625 #: ../tools/virt-resize.pl:409
30626 msgid "B<--delete part>"
30630 #: ../tools/virt-resize.pl:411
30632 "Delete the named partition. It would be more accurate to describe this as "
30633 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
30634 "the original disk image is left intact."
30638 #: ../tools/virt-resize.pl:415
30640 "Note that when you delete a partition, then anything contained in the "
30641 "partition is also deleted. Furthermore, this causes any partitions that "
30642 "come after to be I<renumbered>, which can easily make your guest unbootable."
30646 #: ../tools/virt-resize.pl:426
30647 msgid "B<--LV-expand logvol>"
30651 #: ../tools/virt-resize.pl:428
30653 "This takes the logical volume and, as a final step, expands it to fill all "
30654 "the space available in its volume group. A typical usage, assuming a Linux "
30655 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
30656 "lv_root> would be:"
30660 #: ../tools/virt-resize.pl:433
30663 " virt-resize indisk outdisk \\\n"
30664 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
30669 #: ../tools/virt-resize.pl:436
30671 "This would first expand the partition (and PV), and then expand the root "
30672 "device to fill the extra space in the PV."
30676 #: ../tools/virt-resize.pl:439
30678 "The contents of the LV are also resized if virt-resize knows how to do "
30679 "that. You can stop virt-resize from trying to expand the content by using "
30680 "the option C<--no-expand-content>."
30684 #: ../tools/virt-resize.pl:443
30685 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
30689 #: ../tools/virt-resize.pl:446
30691 "You can give this option multiple times, I<but> it doesn't make sense to do "
30692 "this unless the logical volumes you specify are all in different volume "
30697 #: ../tools/virt-resize.pl:454
30698 msgid "B<--no-copy-boot-loader>"
30702 #: ../tools/virt-resize.pl:456
30704 "By default, virt-resize copies over some sectors at the start of the disk "
30705 "(up to the beginning of the first partition). Commonly these sectors "
30706 "contain the Master Boot Record (MBR) and the boot loader, and are required "
30707 "in order for the guest to boot correctly."
30711 #: ../tools/virt-resize.pl:461
30713 "If you specify this flag, then this initial copy is not done. You may need "
30714 "to reinstall the boot loader in this case."
30718 #: ../tools/virt-resize.pl:469
30719 msgid "B<--no-extra-partition>"
30723 #: ../tools/virt-resize.pl:471
30725 "By default, virt-resize creates an extra partition if there is any extra, "
30726 "unused space after all resizing has happened. Use this option to prevent "
30727 "the extra partition from being created. If you do this then the extra space "
30728 "will be inaccessible until you run fdisk, parted, or some other partitioning "
30729 "tool in the guest."
30733 #: ../tools/virt-resize.pl:477
30735 "Note that if the surplus space is smaller than 10 MB, no extra partition "
30740 #: ../tools/virt-resize.pl:484
30741 msgid "B<--no-expand-content>"
30745 #: ../tools/virt-resize.pl:486
30747 "By default, virt-resize will try to expand the direct contents of "
30748 "partitions, if it knows how (see C<--expand> option above)."
30752 #: ../tools/virt-resize.pl:489
30754 "If you give the C<--no-expand-content> option then virt-resize will not "
30759 #: ../tools/virt-resize.pl:496
30760 msgid "B<-d> | B<--debug>"
30764 #: ../tools/virt-resize.pl:504
30765 msgid "B<-n> | B<--dryrun>"
30769 #: ../tools/virt-resize.pl:506
30770 msgid "Print a summary of what would be done, but don't do anything."
30774 #: ../tools/virt-resize.pl:512
30775 msgid "B<-q> | B<--quiet>"
30779 #: ../tools/virt-resize.pl:514
30780 msgid "Don't print the summary."
30784 #: ../tools/virt-resize.pl:522
30786 "Specify the format of the input disk image. If this flag is not given then "
30787 "it is auto-detected from the image itself."
30791 #: ../tools/virt-resize.pl:528
30793 "Note that this option I<does not> affect the output format. See L</QCOW2 "
30794 "AND NON-SPARSE RAW FORMATS>."
30798 #: ../tools/virt-resize.pl:535
30799 msgid "B<--output-format> raw"
30803 #: ../tools/virt-resize.pl:537
30805 "Specify the format of the output disk image. If this flag is not given then "
30806 "it is auto-detected from the image itself."
30810 #: ../tools/virt-resize.pl:543
30812 "Note that you still need to create the output disk with the right format. "
30813 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
30817 #: ../tools/virt-resize.pl:1425
30822 #: ../tools/virt-resize.pl:1427
30823 msgid "\"Partition 1 does not end on cylinder boundary.\""
30827 #: ../tools/virt-resize.pl:1429
30829 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
30830 "means the partitions will not be aligned to the ancient CHS geometry. "
30831 "However CHS geometry is meaningless for disks manufactured since the early "
30832 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
30833 "cylinders is not required by any modern operating system."
30837 #: ../tools/virt-resize.pl:1436
30838 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
30842 #: ../tools/virt-resize.pl:1438
30844 "In Windows Vista and later versions, Microsoft switched to using a separate "
30845 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
30846 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
30847 "the boot partition. Doing so seems to break the guest completely. However "
30848 "expanding the second partition (ie. C: drive) should work."
30852 #: ../tools/virt-resize.pl:1445
30854 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
30855 "NTFS partitions have been expanded. This is just a safety check and (unless "
30856 "it find errors) is nothing to worry about."
30860 #: ../tools/virt-resize.pl:1449
30861 msgid "GUEST BOOT STUCK AT \"GRUB\""
30865 #: ../tools/virt-resize.pl:1451
30867 "If a Linux guest does not boot after resizing, and the boot is stuck after "
30868 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
30869 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
30870 "although we think is to do with partition alignment."
30874 #: ../tools/virt-resize.pl:1456
30877 " guestfish -i -a newdisk\n"
30878 " ><fs> cat /boot/grub/device.map\n"
30879 " # check the contents of this file are sensible or\n"
30880 " # edit the file if necessary\n"
30881 " ><fs> grub-install / /dev/vda\n"
30887 #: ../tools/virt-resize.pl:1463
30889 "For more flexible guest reconfiguration, including if you need to specify "
30890 "other parameters to grub-install, use L<virt-rescue(1)>."
30894 #: ../tools/virt-resize.pl:1466
30895 msgid "ALTERNATIVE TOOLS"
30899 #: ../tools/virt-resize.pl:1468
30901 "There are several proprietary tools for resizing partitions. We won't "
30902 "mention any here."
30906 #: ../tools/virt-resize.pl:1471
30908 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
30909 "operations on disk images. They can resize and move partitions, but I don't "
30910 "think they can do anything with the contents, and they certainly don't "
30915 #: ../tools/virt-resize.pl:1476
30917 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
30918 "but at a much lower level. You will probably end up hand-calculating sector "
30919 "offsets, which is something that virt-resize was designed to avoid. If you "
30920 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
30925 #: ../tools/virt-resize.pl:1491
30927 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
30928 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
30929 "L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, "
30930 "L<grub-install(8)>, L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://"
30931 "libguestfs.org/>."
30935 #: ../tools/virt-list-filesystems.pl:32
30937 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
30941 #: ../tools/virt-list-filesystems.pl:36
30944 " virt-list-filesystems [--options] domname\n"
30949 #: ../tools/virt-list-filesystems.pl:38
30952 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
30957 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
30959 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
30964 #: ../tools/virt-list-filesystems.pl:45
30966 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
30967 "are contained in a virtual machine or disk image."
30971 #: ../tools/virt-list-filesystems.pl:49
30973 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
30974 "functionality. For more complex cases you should look at the L<guestfish(1)"
30979 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
30980 msgid "B<-l> | B<--long>"
30984 #: ../tools/virt-list-filesystems.pl:108
30986 "With this option, C<virt-list-filesystems> displays the type of each "
30987 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
30991 #: ../tools/virt-list-filesystems.pl:115
30992 msgid "B<-a> | B<--all>"
30996 #: ../tools/virt-list-filesystems.pl:117
30998 "Normally we only show mountable filesystems. If this option is given then "
30999 "swap devices are shown too."
31003 #: ../tools/virt-list-filesystems.pl:191
31005 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
31006 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
31007 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
31011 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
31012 msgid "Copyright (C) 2009 Red Hat Inc."
31016 #: ../tools/virt-tar.pl:33
31017 msgid "virt-tar - Extract or upload files to a virtual machine"
31021 #: ../tools/virt-tar.pl:37
31024 " virt-tar [--options] -x domname directory tarball\n"
31029 #: ../tools/virt-tar.pl:39
31032 " virt-tar [--options] -u domname tarball directory\n"
31037 #: ../tools/virt-tar.pl:41
31040 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
31045 #: ../tools/virt-tar.pl:43
31048 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
31053 #: ../tools/virt-tar.pl:47
31055 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
31056 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
31060 #: ../tools/virt-tar.pl:52
31061 msgid "Download C</home> from the VM into a local tarball:"
31065 #: ../tools/virt-tar.pl:54
31068 " virt-tar -x domname /home home.tar\n"
31073 #: ../tools/virt-tar.pl:56
31076 " virt-tar -zx domname /home home.tar.gz\n"
31081 #: ../tools/virt-tar.pl:58
31082 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
31086 #: ../tools/virt-tar.pl:60
31089 " virt-tar -u domname uploadstuff.tar /tmp\n"
31094 #: ../tools/virt-tar.pl:62
31097 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
31102 #: ../tools/virt-tar.pl:66
31104 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
31105 "virtual machines. If you do this, you risk disk corruption in the VM. "
31106 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
31110 #: ../tools/virt-tar.pl:71
31112 "You can use C<-x> (extract) on live virtual machines, but you might get "
31113 "inconsistent results or errors if there is filesystem activity inside the "
31114 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
31115 "work, but the only way to guarantee consistent results is if the virtual "
31116 "machine is shut down."
31120 #: ../tools/virt-tar.pl:79
31122 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
31123 "parts of a guest filesystem. There are many possibilities: making backups, "
31124 "uploading data files, snooping on guest activity, fixing or customizing "
31129 #: ../tools/virt-tar.pl:84
31131 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
31132 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
31133 "should look at the L<guestfish(1)> tool."
31137 #: ../tools/virt-tar.pl:88
31139 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
31140 "its contents (recursively) from the virtual machine into a local tarball. "
31141 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
31142 "virtual machine. You cannot use these two options together."
31146 #: ../tools/virt-tar.pl:94
31148 "In addition, you may need to use the C<-z> (gZip) option to enable "
31149 "compression. When uploading, you have to specify C<-z> if the upload file "
31150 "is compressed because virt-tar won't detect this on its own."
31154 #: ../tools/virt-tar.pl:98
31156 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
31157 "example it cannot do PKZip files or bzip2 compression. If you want that "
31158 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
31159 "the L<libguestfs(3)> API)."
31163 #: ../tools/virt-tar.pl:156
31164 msgid "B<-x> | B<--extract> | B<--download>"
31168 #: ../tools/virt-tar.pl:158
31169 msgid "B<-u> | B<--upload>"
31173 #: ../tools/virt-tar.pl:160
31175 "Use C<-x> to extract (download) a directory from a virtual machine to a "
31180 #: ../tools/virt-tar.pl:163
31182 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
31183 "Please read the L</WARNING> section above before using this option."
31187 #: ../tools/virt-tar.pl:167
31188 msgid "You must specify exactly one of these options."
31192 #: ../tools/virt-tar.pl:173
31193 msgid "B<-z> | B<--gzip>"
31197 #: ../tools/virt-tar.pl:175
31198 msgid "Specify that the input or output tarball is gzip-compressed."
31202 #: ../tools/virt-tar.pl:288
31204 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
31205 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
31206 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
31211 #: ../tools/virt-make-fs.pl:37
31212 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
31216 #: ../tools/virt-make-fs.pl:41
31219 " virt-make-fs [--options] input.tar output.img\n"
31224 #: ../tools/virt-make-fs.pl:43
31227 " virt-make-fs [--options] input.tar.gz output.img\n"
31232 #: ../tools/virt-make-fs.pl:45
31235 " virt-make-fs [--options] directory output.img\n"
31240 #: ../tools/virt-make-fs.pl:49
31242 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
31243 "archive or some files in a directory. It is similar to tools like L<mkisofs"
31244 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
31245 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
31246 "you want to attach these filesystems to existing virtual machines (eg. to "
31247 "import large amounts of read-only data to a VM)."
31251 #: ../tools/virt-make-fs.pl:57
31252 msgid "Basic usage is:"
31256 #: ../tools/virt-make-fs.pl:59
31259 " virt-make-fs input output\n"
31264 #: ../tools/virt-make-fs.pl:61
31266 "where C<input> is either a directory containing files that you want to add, "
31267 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
31268 "C<output> is a disk image. The input type is detected automatically. The "
31269 "output disk image defaults to a raw ext2 image unless you specify extra "
31270 "flags (see L</OPTIONS> below)."
31274 #: ../tools/virt-make-fs.pl:67
31275 msgid "EXTRA SPACE"
31279 #: ../tools/virt-make-fs.pl:69
31281 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
31282 "the files that it contains, but might have extra space. Depending on how "
31283 "you are going to use the output, you might think this extra space is wasted "
31284 "and want to minimize it, or you might want to leave space so that more files "
31285 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
31286 "but you can use the C<--size> flag to leave space in the filesystem if you "
31291 #: ../tools/virt-make-fs.pl:77
31293 "An alternative way to leave extra space but not make the output image any "
31294 "bigger is to use an alternative disk image format (instead of the default "
31295 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
31296 "image format (check your hypervisor supports this before using it). This "
31297 "allows you to choose a large C<--size> but the extra space won't actually be "
31298 "allocated in the image until you try to store something in it."
31302 #: ../tools/virt-make-fs.pl:85
31304 "Don't forget that you can also use local commands including L<resize2fs(8)> "
31305 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
31306 "to build another image from scratch."
31310 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
31311 #: ../tools/virt-make-fs.pl:142
31316 #: ../tools/virt-make-fs.pl:91
31319 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
31324 #: ../tools/virt-make-fs.pl:93
31325 msgid "FILESYSTEM TYPE"
31329 #: ../tools/virt-make-fs.pl:95
31331 "The default filesystem type is C<ext2>. Just about any filesystem type that "
31332 "libguestfs supports can be used (but I<not> read-only formats like "
31333 "ISO9660). Here are some of the more common choices:"
31337 #: ../tools/virt-make-fs.pl:101
31342 #: ../tools/virt-make-fs.pl:103
31344 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
31345 "you are not going to use the filesystem in a way that requires the journal, "
31346 "then this is just wasted overhead."
31350 #: ../tools/virt-make-fs.pl:107
31351 msgid "I<ntfs> or I<vfat>"
31355 #: ../tools/virt-make-fs.pl:109
31356 msgid "Useful if exporting data to a Windows guest."
31360 #: ../tools/virt-make-fs.pl:111
31362 "I<Note for vfat>: The tar archive or local directory must only contain files "
31363 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
31364 "program running within libguestfs is unable to change the ownership of non-"
31365 "root files, since vfat itself does not support this."
31369 #: ../tools/virt-make-fs.pl:116
31374 #: ../tools/virt-make-fs.pl:118
31376 "Lower overhead than C<ext2>, but certain limitations on filename length and "
31377 "total filesystem size."
31381 #: ../tools/virt-make-fs.pl:125
31384 " virt-make-fs --type=minix input minixfs.img\n"
31389 #: ../tools/virt-make-fs.pl:127
31390 msgid "TO PARTITION OR NOT TO PARTITION"
31394 #: ../tools/virt-make-fs.pl:129
31395 msgid "Optionally virt-make-fs can add a partition table to the output disk."
31399 #: ../tools/virt-make-fs.pl:131
31401 "Adding a partition can make the disk image more compatible with certain "
31402 "virtualized operating systems which don't expect to see a filesystem "
31403 "directly located on a block device (Linux doesn't care and will happily "
31404 "handle both types)."
31408 #: ../tools/virt-make-fs.pl:136
31410 "On the other hand, if you have a partition table then the output image is no "
31411 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
31412 "directly on a partitioned disk image. (However libguestfs tools such as "
31413 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
31417 #: ../tools/virt-make-fs.pl:144
31418 msgid "Add an MBR partition:"
31422 #: ../tools/virt-make-fs.pl:146
31425 " virt-make-fs --partition -- input disk.img\n"
31430 #: ../tools/virt-make-fs.pl:148
31432 "If the output disk image could be terabyte-sized or larger, it's better to "
31433 "use an EFI/GPT-compatible partition table:"
31437 #: ../tools/virt-make-fs.pl:151
31440 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
31445 #: ../tools/virt-make-fs.pl:179
31446 msgid "Enable debugging information."
31450 #: ../tools/virt-make-fs.pl:185
31451 msgid "B<--size=E<lt>NE<gt>>"
31455 #: ../tools/virt-make-fs.pl:187
31456 msgid "B<--size=+E<lt>NE<gt>>"
31460 #: ../tools/virt-make-fs.pl:189
31461 msgid "B<-s E<lt>NE<gt>>"
31465 #: ../tools/virt-make-fs.pl:191
31466 msgid "B<-s +E<lt>NE<gt>>"
31470 #: ../tools/virt-make-fs.pl:193
31472 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
31476 #: ../tools/virt-make-fs.pl:196
31478 "If this option is I<not> given, then the output image will be just large "
31479 "enough to contain all the files, with not much wasted space."
31483 #: ../tools/virt-make-fs.pl:199
31485 "To choose a fixed size output disk, specify an absolute number followed by b/"
31486 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
31487 "Petabytes or Exabytes. This must be large enough to contain all the input "
31488 "files, else you will get an error."
31492 #: ../tools/virt-make-fs.pl:204
31494 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
31495 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
31496 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
31497 "the input files, and (approximately) an extra 200 MB free space."
31501 #: ../tools/virt-make-fs.pl:210
31503 "Note that virt-make-fs estimates free space, and therefore will not produce "
31504 "filesystems containing precisely the free space requested. (It is much more "
31505 "expensive and time-consuming to produce a filesystem which has precisely the "
31506 "desired free space)."
31510 #: ../tools/virt-make-fs.pl:219
31511 msgid "B<--format=E<lt>fmtE<gt>>"
31515 #: ../tools/virt-make-fs.pl:221
31516 msgid "B<-F E<lt>fmtE<gt>>"
31520 #: ../tools/virt-make-fs.pl:223
31521 msgid "Choose the output disk image format."
31525 #: ../tools/virt-make-fs.pl:225
31526 msgid "The default is C<raw> (raw disk image)."
31530 #: ../tools/virt-make-fs.pl:227
31532 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
31533 "that would really make sense here is C<qcow2>."
31537 #: ../tools/virt-make-fs.pl:234
31538 msgid "B<--type=E<lt>fsE<gt>>"
31542 #: ../tools/virt-make-fs.pl:236
31543 msgid "B<-t E<lt>fsE<gt>>"
31547 #: ../tools/virt-make-fs.pl:238
31548 msgid "Choose the output filesystem type."
31552 #: ../tools/virt-make-fs.pl:240
31553 msgid "The default is C<ext2>."
31557 #: ../tools/virt-make-fs.pl:242
31559 "Any filesystem which is supported read-write by libguestfs can be used here."
31563 #: ../tools/virt-make-fs.pl:249
31564 msgid "B<--partition>"
31568 #: ../tools/virt-make-fs.pl:251
31569 msgid "B<--partition=E<lt>parttypeE<gt>>"
31573 #: ../tools/virt-make-fs.pl:253
31575 "If specified, this flag adds an MBR partition table to the output disk image."
31579 #: ../tools/virt-make-fs.pl:256
31581 "You can change the partition table type, eg. C<--partition=gpt> for large "
31586 #: ../tools/virt-make-fs.pl:259
31588 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
31589 "might consider the next parameter to be the partition type. For example:"
31593 #: ../tools/virt-make-fs.pl:263
31596 " virt-make-fs --partition input.tar ...\n"
31601 #: ../tools/virt-make-fs.pl:265
31603 "would cause virt-make-fs to think you wanted to use a partition type of "
31604 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
31605 "dash) between options and the input file argument:"
31609 #: ../tools/virt-make-fs.pl:269
31612 " virt-make-fs --partition -- input.tar ...\n"
31617 #: ../tools/virt-make-fs.pl:541
31619 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
31620 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
31621 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
31625 #: ../tools/virt-make-fs.pl:558
31628 " export LIBGUESTFS_DEBUG=1\n"
31629 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
31634 #: ../tools/virt-make-fs.pl:561
31636 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
31641 #: ../tools/virt-list-partitions.pl:32
31643 "virt-list-partitions - List partitions in a virtual machine or disk image"
31647 #: ../tools/virt-list-partitions.pl:36
31650 " virt-list-partitions [--options] domname\n"
31655 #: ../tools/virt-list-partitions.pl:38
31658 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
31663 #: ../tools/virt-list-partitions.pl:45
31665 "C<virt-list-partitions> is a command line tool to list the partitions that "
31666 "are contained in a virtual machine or disk image. It is mainly useful as a "
31667 "first step to using L<virt-resize(1)>."
31671 #: ../tools/virt-list-partitions.pl:50
31673 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
31674 "functionality. For more complex cases you should look at the L<guestfish(1)"
31679 #: ../tools/virt-list-partitions.pl:107
31680 msgid "B<-h> | B<--human-readable>"
31684 #: ../tools/virt-list-partitions.pl:109
31685 msgid "Show sizes in human-readable form (eg. \"1G\")."
31689 #: ../tools/virt-list-partitions.pl:117
31691 "With this option, C<virt-list-partitions> displays the type and size of each "
31692 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
31696 #: ../tools/virt-list-partitions.pl:124
31697 msgid "B<-t> | B<--total>"
31701 #: ../tools/virt-list-partitions.pl:126
31703 "Display the total size of each block device (as a separate row or rows)."
31707 #: ../tools/virt-list-partitions.pl:259
31709 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
31710 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
31711 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
31715 #: ../tools/virt-list-partitions.pl:275
31716 msgid "Copyright (C) 2009-2010 Red Hat Inc."